src/emerge.cpp

   1 /*
   2 Minetest
   3 Copyright (C) 2010-2013 celeron55, Perttu Ahola <celeron55@gmail.com>
   4 Copyright (C) 2010-2013 kwolekr, Ryan Kwolek <kwolekr@minetest.net>
   5
   6 This program is free software; you can redistribute it and/or modify
   7 it under the terms of the GNU Lesser General Public License as published by
   8 the Free Software Foundation; either version 2.1 of the License, or
   9 (at your option) any later version.
  10
  11 This program is distributed in the hope that it will be useful,
  12 but WITHOUT ANY WARRANTY; without even the implied warranty of
  13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14 GNU Lesser General Public License for more details.
  15
  16 You should have received a copy of the GNU Lesser General Public License along
  17 with this program; if not, write to the Free Software Foundation, Inc.,
  18 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  19 */
  20
  21
  22 #include "emerge.h"
  23 #include "server.h"
  24 #include <iostream>
  25 #include <queue>
  26 #include "jthread/jevent.h"
  27 #include "map.h"
  28 #include "environment.h"
  29 #include "util/container.h"
  30 #include "util/thread.h"
  31 #include "main.h"
  32 #include "constants.h"
  33 #include "voxel.h"
  34 #include "config.h"
  35 #include "mapblock.h"
  36 #include "serverobject.h"
  37 #include "settings.h"
  38 #include "scripting_game.h"
  39 #include "profiler.h"
  40 #include "log.h"
  41 #include "nodedef.h"
  42 #include "biome.h"
  43 #include "mapgen_v6.h"
  44 #include "mapgen_v7.h"
  45 #include "mapgen_indev.h"
  46 #include "mapgen_singlenode.h"
  47 #include "mapgen_math.h"
  48
  49
  50 class EmergeThread : public JThread
  51 {
  52 public:
  53         Server *m_server;
  54         ServerMap *map;
  55         EmergeManager *emerge;
  56         Mapgen *mapgen;
  57         bool enable_mapgen_debug_info;
  58         int id;
  59
  60         Event qevent;
  61         std::queue<v3s16> blockqueue;
  62
  63         EmergeThread(Server *server, int ethreadid):
  64                 JThread(),
  65                 m_server(server),
  66                 map(NULL),
  67                 emerge(NULL),
  68                 mapgen(NULL),
  69                 enable_mapgen_debug_info(false),
  70                 id(ethreadid)
  71         {
  72         }
  73
  74         void *Thread();
  75         bool popBlockEmerge(v3s16 *pos, u8 *flags);
  76         bool getBlockOrStartGen(v3s16 p, MapBlock **b,
  77                         BlockMakeData *data, bool allow_generate);
  78 };
  79
  80
  81 /////////////////////////////// Emerge Manager ////////////////////////////////
  82
  83 EmergeManager::EmergeManager(IGameDef *gamedef) {
  84         //register built-in mapgens
  85         registerMapgen("v6",         new MapgenFactoryV6());
  86         registerMapgen("v7",         new MapgenFactoryV7());
  87         registerMapgen("indev",      new MapgenFactoryIndev());
  88         registerMapgen("singlenode", new MapgenFactorySinglenode());
  89         registerMapgen("math",       new MapgenFactoryMath());
  90
  91         this->ndef     = gamedef->getNodeDefManager();
  92         this->biomedef = new BiomeDefManager();
  93         this->gennotify = 0;
  94
  95         // Note that accesses to this variable are not synchronized.
  96         // This is because the *only* thread ever starting or stopping
  97         // EmergeThreads should be the ServerThread.
  98         this->threads_active = false;
  99
 100         mapgen_debug_info = g_settings->getBool("enable_mapgen_debug_info");
 101
 102         // if unspecified, leave a proc for the main thread and one for
 103         // some other misc thread
 104         int nthreads = 0;
 105         if (!g_settings->tryGetS16("num_emerge_threads", nthreads))
 106                 nthreads = porting::getNumberOfProcessors() - 2;
 107         if (nthreads < 1)
 108                 nthreads = 1;
 109
 110         qlimit_total = g_settings->getU16("emergequeue_limit_total");
 111         if (!g_settings->tryGetU16("emergequeue_limit_diskonly", qlimit_diskonly))
 112                 qlimit_diskonly = nthreads * 5 + 1;
 113         if (!g_settings->tryGetU16("emergequeue_limit_generate", qlimit_generate))
 114                 qlimit_generate = nthreads + 1;
 115
 116         for (int i = 0; i != nthreads; i++)
 117                 emergethread.push_back(new EmergeThread((Server *)gamedef, i));
 118
 119         infostream << "EmergeManager: using " << nthreads << " threads" << std::endl;
 120
 121         loadParamsFromSettings(g_settings);
 122
 123         if (g_settings->get("fixed_map_seed").empty()) {
 124                 params.seed = (((u64)(myrand() & 0xffff) << 0)
 125                                          | ((u64)(myrand() & 0xffff) << 16)
 126                                          | ((u64)(myrand() & 0xffff) << 32)
 127                                          | ((u64)(myrand() & 0xffff) << 48));
 128         }
 129 }
 130
 131
 132 EmergeManager::~EmergeManager() {
 133         for (unsigned int i = 0; i != emergethread.size(); i++) {
 134                 if (threads_active) {
 135                         emergethread[i]->Stop();
 136                         emergethread[i]->qevent.signal();
 137                         emergethread[i]->Wait();
 138                 }
 139                 delete emergethread[i];
 140                 delete mapgen[i];
 141         }
 142         emergethread.clear();
 143         mapgen.clear();
 144
 145         for (unsigned int i = 0; i < ores.size(); i++)
 146                 delete ores[i];
 147         ores.clear();
 148
 149         for (unsigned int i = 0; i < decorations.size(); i++)
 150                 delete decorations[i];
 151         decorations.clear();
 152
 153         for (std::map<std::string, MapgenFactory *>::iterator iter = mglist.begin();
 154                         iter != mglist.end(); iter ++) {
 155                 delete iter->second;
 156         }
 157         mglist.clear();
 158
 159         delete biomedef;
 160 }
 161
 162
 163 void EmergeManager::initMapgens() {
 164         if (mapgen.size())
 165                 return;
 166
 167         // Resolve names of nodes for things that were registered
 168         // (at this point, the registration period is over)
 169         biomedef->resolveNodeNames(ndef);
 170
 171         for (size_t i = 0; i != ores.size(); i++)
 172                 ores[i]->resolveNodeNames(ndef);
 173
 174         for (size_t i = 0; i != decorations.size(); i++)
 175                 decorations[i]->resolveNodeNames(ndef);
 176
 177         if (!params.sparams) {
 178                 params.sparams = createMapgenParams(params.mg_name);
 179                 if (!params.sparams) {
 180                         params.mg_name = DEFAULT_MAPGEN;
 181                         params.sparams = createMapgenParams(params.mg_name);
 182                         assert(params.sparams);
 183                 }
 184                 params.sparams->readParams(g_settings);
 185         }
 186
 187         // Create the mapgens
 188         for (size_t i = 0; i != emergethread.size(); i++) {
 189                 Mapgen *mg = createMapgen(params.mg_name, i, &params);
 190                 assert(mg);
 191                 mapgen.push_back(mg);
 192         }
 193 }
 194
 195
 196 Mapgen *EmergeManager::getCurrentMapgen() {
 197         for (unsigned int i = 0; i != emergethread.size(); i++) {
 198                 if (emergethread[i]->IsSameThread())
 199                         return emergethread[i]->mapgen;
 200         }
 201
 202         return NULL;
 203 }
 204
 205
 206 void EmergeManager::startThreads() {
 207         if (threads_active)
 208                 return;
 209
 210         for (unsigned int i = 0; i != emergethread.size(); i++)
 211                 emergethread[i]->Start();
 212
 213         threads_active = true;
 214 }
 215
 216
 217 void EmergeManager::stopThreads() {
 218         if (!threads_active)
 219                 return;
 220
 221         // Request thread stop in parallel
 222         for (unsigned int i = 0; i != emergethread.size(); i++) {
 223                 emergethread[i]->Stop();
 224                 emergethread[i]->qevent.signal();
 225         }
 226
 227         // Then do the waiting for each
 228         for (unsigned int i = 0; i != emergethread.size(); i++)
 229                 emergethread[i]->Wait();
 230
 231         threads_active = false;
 232 }
 233
 234
 235 bool EmergeManager::enqueueBlockEmerge(u16 peer_id, v3s16 p, bool allow_generate) {
 236         std::map<v3s16, BlockEmergeData *>::const_iterator iter;
 237         BlockEmergeData *bedata;
 238         u16 count;
 239         u8 flags = 0;
 240         int idx = 0;
 241
 242         if (allow_generate)
 243                 flags |= BLOCK_EMERGE_ALLOWGEN;
 244
 245         {
 246                 JMutexAutoLock queuelock(queuemutex);
 247
 248                 count = blocks_enqueued.size();
 249                 if (count >= qlimit_total)
 250                         return false;
 251
 252                 count = peer_queue_count[peer_id];
 253                 u16 qlimit_peer = allow_generate ? qlimit_generate : qlimit_diskonly;
 254                 if (count >= qlimit_peer)
 255                         return false;
 256
 257                 iter = blocks_enqueued.find(p);
 258                 if (iter != blocks_enqueued.end()) {
 259                         bedata = iter->second;
 260                         bedata->flags |= flags;
 261                         return true;
 262                 }
 263
 264                 bedata = new BlockEmergeData;
 265                 bedata->flags = flags;
 266                 bedata->peer_requested = peer_id;
 267                 blocks_enqueued.insert(std::make_pair(p, bedata));
 268
 269                 peer_queue_count[peer_id] = count + 1;
 270
 271                 // insert into the EmergeThread queue with the least items
 272                 int lowestitems = emergethread[0]->blockqueue.size();
 273                 for (unsigned int i = 1; i != emergethread.size(); i++) {
 274                         int nitems = emergethread[i]->blockqueue.size();
 275                         if (nitems < lowestitems) {
 276                                 idx = i;
 277                                 lowestitems = nitems;
 278                         }
 279                 }
 280
 281                 emergethread[idx]->blockqueue.push(p);
 282         }
 283         emergethread[idx]->qevent.signal();
 284
 285         return true;
 286 }
 287
 288
 289 int EmergeManager::getGroundLevelAtPoint(v2s16 p) {
 290         if (mapgen.size() == 0 || !mapgen[0]) {
 291                 errorstream << "EmergeManager: getGroundLevelAtPoint() called"
 292                         " before mapgen initialized" << std::endl;
 293                 return 0;
 294         }
 295
 296         return mapgen[0]->getGroundLevelAtPoint(p);
 297 }
 298
 299
 300 bool EmergeManager::isBlockUnderground(v3s16 blockpos) {
 301         /*
 302         v2s16 p = v2s16((blockpos.X * MAP_BLOCKSIZE) + MAP_BLOCKSIZE / 2,
 303                                         (blockpos.Y * MAP_BLOCKSIZE) + MAP_BLOCKSIZE / 2);
 304         int ground_level = getGroundLevelAtPoint(p);
 305         return blockpos.Y * (MAP_BLOCKSIZE + 1) <= min(water_level, ground_level);
 306         */
 307
 308         //yuck, but then again, should i bother being accurate?
 309         //the height of the nodes in a single block is quite variable
 310         return blockpos.Y * (MAP_BLOCKSIZE + 1) <= params.water_level;
 311 }
 312
 313
 314 u32 EmergeManager::getBlockSeed(v3s16 p) {
 315         return (u32)(params.seed & 0xFFFFFFFF) +
 316                 p.Z * 38134234 +
 317                 p.Y * 42123 +
 318                 p.X * 23;
 319 }
 320
 321
 322 Mapgen *EmergeManager::createMapgen(std::string mgname, int mgid,
 323                                                                          MapgenParams *mgparams) {
 324         std::map<std::string, MapgenFactory *>::const_iterator iter;
 325         iter = mglist.find(mgname);
 326         if (iter == mglist.end()) {
 327                 errorstream << "EmergeManager; mapgen " << mgname <<
 328                  " not registered" << std::endl;
 329                 return NULL;
 330         }
 331
 332         MapgenFactory *mgfactory = iter->second;
 333         return mgfactory->createMapgen(mgid, mgparams, this);
 334 }
 335
 336
 337 MapgenSpecificParams *EmergeManager::createMapgenParams(std::string mgname) {
 338         std::map<std::string, MapgenFactory *>::const_iterator iter;
 339         iter = mglist.find(mgname);
 340         if (iter == mglist.end()) {
 341                 errorstream << "EmergeManager: mapgen " << mgname <<
 342                  " not registered" << std::endl;
 343                 return NULL;
 344         }
 345
 346         MapgenFactory *mgfactory = iter->second;
 347         return mgfactory->createMapgenParams();
 348 }
 349
 350
 351 void EmergeManager::loadParamsFromSettings(Settings *settings) {
 352         std::string seed_str;
 353         const char *setname = (settings == g_settings) ? "fixed_map_seed" : "seed";
 354
 355         if (settings->tryGet(setname, seed_str))
 356                 params.seed = read_seed(seed_str.c_str());
 357
 358         settings->tryGet("mg_name",         params.mg_name);
 359         settings->tryGetS16("water_level",  params.water_level);
 360         settings->tryGetS16("chunksize",    params.chunksize);
 361         settings->tryGetFlagStr("mg_flags", params.flags, flagdesc_mapgen);
 362
 363         delete params.sparams;
 364         params.sparams = createMapgenParams(params.mg_name);
 365         if (params.sparams)
 366                 params.sparams->readParams(settings);
 367
 368 }
 369
 370
 371 void EmergeManager::saveParamsToSettings(Settings *settings) {
 372         settings->set("mg_name",         params.mg_name);
 373         settings->setU64("seed",         params.seed);
 374         settings->setS16("water_level",  params.water_level);
 375         settings->setS16("chunksize",    params.chunksize);
 376         settings->setFlagStr("mg_flags", params.flags, flagdesc_mapgen);
 377
 378         if (params.sparams)
 379                 params.sparams->writeParams(settings);
 380 }
 381
 382
 383 void EmergeManager::registerMapgen(std::string mgname, MapgenFactory *mgfactory) {
 384         mglist.insert(std::make_pair(mgname, mgfactory));
 385         infostream << "EmergeManager: registered mapgen " << mgname << std::endl;
 386 }
 387
 388
 389 ////////////////////////////// Emerge Thread //////////////////////////////////
 390
 391 bool EmergeThread::popBlockEmerge(v3s16 *pos, u8 *flags) {
 392         std::map<v3s16, BlockEmergeData *>::iterator iter;
 393         JMutexAutoLock queuelock(emerge->queuemutex);
 394
 395         if (blockqueue.empty())
 396                 return false;
 397         v3s16 p = blockqueue.front();
 398         blockqueue.pop();
 399
 400         *pos = p;
 401
 402         iter = emerge->blocks_enqueued.find(p);
 403         if (iter == emerge->blocks_enqueued.end())
 404                 return false; //uh oh, queue and map out of sync!!
 405
 406         BlockEmergeData *bedata = iter->second;
 407         *flags = bedata->flags;
 408
 409         emerge->peer_queue_count[bedata->peer_requested]--;
 410
 411         delete bedata;
 412         emerge->blocks_enqueued.erase(iter);
 413
 414         return true;
 415 }
 416
 417
 418 bool EmergeThread::getBlockOrStartGen(v3s16 p, MapBlock **b,
 419                                                                         BlockMakeData *data, bool allow_gen) {
 420         v2s16 p2d(p.X, p.Z);
 421         //envlock: usually takes <=1ms, sometimes 90ms or ~400ms to acquire
 422         JMutexAutoLock envlock(m_server->m_env_mutex);
 423
 424         // Load sector if it isn't loaded
 425         if (map->getSectorNoGenerateNoEx(p2d) == NULL)
 426                 map->loadSectorMeta(p2d);
 427
 428         // Attempt to load block
 429         MapBlock *block = map->getBlockNoCreateNoEx(p);
 430         if (!block || block->isDummy() || !block->isGenerated()) {
 431                 EMERGE_DBG_OUT("not in memory, attempting to load from disk");
 432                 block = map->loadBlock(p);
 433                 if (block && block->isGenerated())
 434                         map->prepareBlock(block);
 435         }
 436
 437         // If could not load and allowed to generate,
 438         // start generation inside this same envlock
 439         if (allow_gen && (block == NULL || !block->isGenerated())) {
 440                 EMERGE_DBG_OUT("generating");
 441                 *b = block;
 442                 return map->initBlockMake(data, p);
 443         }
 444
 445         *b = block;
 446         return false;
 447 }
 448
 449
 450 void *EmergeThread::Thread() {
 451         ThreadStarted();
 452         log_register_thread("EmergeThread" + itos(id));
 453         DSTACK(__FUNCTION_NAME);
 454         BEGIN_DEBUG_EXCEPTION_HANDLER
 455
 456         v3s16 last_tried_pos(-32768,-32768,-32768); // For error output
 457         v3s16 p;
 458         u8 flags;
 459
 460         map    = (ServerMap *)&(m_server->m_env->getMap());
 461         emerge = m_server->m_emerge;
 462         mapgen = emerge->mapgen[id];
 463         enable_mapgen_debug_info = emerge->mapgen_debug_info;
 464
 465         while (!StopRequested())
 466         try {
 467                 if (!popBlockEmerge(&p, &flags)) {
 468                         qevent.wait();
 469                         continue;
 470                 }
 471
 472                 last_tried_pos = p;
 473                 if (blockpos_over_limit(p))
 474                         continue;
 475
 476                 bool allow_generate = flags & BLOCK_EMERGE_ALLOWGEN;
 477                 EMERGE_DBG_OUT("p=" PP(p) " allow_generate=" << allow_generate);
 478
 479                 /*
 480                         Try to fetch block from memory or disk.
 481                         If not found and asked to generate, initialize generator.
 482                 */
 483                 BlockMakeData data;
 484                 MapBlock *block = NULL;
 485                 std::map<v3s16, MapBlock *> modified_blocks;
 486
 487                 if (getBlockOrStartGen(p, &block, &data, allow_generate) && mapgen) {
 488                         {
 489                                 ScopeProfiler sp(g_profiler, "EmergeThread: Mapgen::makeChunk", SPT_AVG);
 490                                 TimeTaker t("mapgen::make_block()");
 491
 492                                 mapgen->makeChunk(&data);
 493
 494                                 if (enable_mapgen_debug_info == false)
 495                                         t.stop(true); // Hide output
 496                         }
 497
 498                         {
 499                                 //envlock: usually 0ms, but can take either 30 or 400ms to acquire
 500                                 JMutexAutoLock envlock(m_server->m_env_mutex);
 501                                 ScopeProfiler sp(g_profiler, "EmergeThread: after "
 502                                                 "Mapgen::makeChunk (envlock)", SPT_AVG);
 503
 504                                 map->finishBlockMake(&data, modified_blocks);
 505
 506                                 block = map->getBlockNoCreateNoEx(p);
 507                                 if (block) {
 508                                         /*
 509                                                 Do some post-generate stuff
 510                                         */
 511                                         v3s16 minp = data.blockpos_min * MAP_BLOCKSIZE;
 512                                         v3s16 maxp = data.blockpos_max * MAP_BLOCKSIZE +
 513                                                                  v3s16(1,1,1) * (MAP_BLOCKSIZE - 1);
 514
 515                                         // Ignore map edit events, they will not need to be sent
 516                                         // to anybody because the block hasn't been sent to anybody
 517                                         MapEditEventAreaIgnorer
 518                                                 ign(&m_server->m_ignore_map_edit_events_area,
 519                                                 VoxelArea(minp, maxp));
 520                                         try {  // takes about 90ms with -O1 on an e3-1230v2
 521                                                 m_server->getScriptIface()->environment_OnGenerated(
 522                                                                 minp, maxp, emerge->getBlockSeed(minp));
 523                                         } catch(LuaError &e) {
 524                                                 m_server->setAsyncFatalError(e.what());
 525                                         }
 526
 527                                         EMERGE_DBG_OUT("ended up with: " << analyze_block(block));
 528
 529                                         m_server->m_env->activateBlock(block, 0);
 530                                 }
 531                         }
 532                 }
 533
 534                 /*
 535                         Set sent status of modified blocks on clients
 536                 */
 537                 // Add the originally fetched block to the modified list
 538                 if (block)
 539                         modified_blocks[p] = block;
 540
 541                 if (modified_blocks.size() > 0) {
 542                         m_server->SetBlocksNotSent(modified_blocks);
 543                 }
 544         }
 545         catch (VersionMismatchException &e) {
 546                 std::ostringstream err;
 547                 err << "World data version mismatch in MapBlock "<<PP(last_tried_pos)<<std::endl;
 548                 err << "----"<<std::endl;
 549                 err << "\""<<e.what()<<"\""<<std::endl;
 550                 err << "See debug.txt."<<std::endl;
 551                 err << "World probably saved by a newer version of Minetest."<<std::endl;
 552                 m_server->setAsyncFatalError(err.str());
 553         }
 554         catch (SerializationError &e) {
 555                 std::ostringstream err;
 556                 err << "Invalid data in MapBlock "<<PP(last_tried_pos)<<std::endl;
 557                 err << "----"<<std::endl;
 558                 err << "\""<<e.what()<<"\""<<std::endl;
 559                 err << "See debug.txt."<<std::endl;
 560                 err << "You can ignore this using [ignore_world_load_errors = true]."<<std::endl;
 561                 m_server->setAsyncFatalError(err.str());
 562         }
 563
 564         END_DEBUG_EXCEPTION_HANDLER(errorstream)
 565         log_deregister_thread();
 566         return NULL;
 567 }