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->params   = NULL;
  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         this->luaoverride_params          = NULL;
 101         this->luaoverride_params_modified = 0;
 102         this->luaoverride_flagmask        = 0;
 103
 104         this->gennotify = 0;
 105
 106         mapgen_debug_info = g_settings->getBool("enable_mapgen_debug_info");
 107
 108         int nthreads;
 109         if (g_settings->get("num_emerge_threads").empty()) {
 110                 int nprocs = porting::getNumberOfProcessors();
 111                 // leave a proc for the main thread and one for some other misc threads
 112                 nthreads = (nprocs > 2) ? nprocs - 2 : 1;
 113         } else {
 114                 nthreads = g_settings->getU16("num_emerge_threads");
 115         }
 116         if (nthreads < 1)
 117                 nthreads = 1;
 118
 119         qlimit_total    = g_settings->getU16("emergequeue_limit_total");
 120         qlimit_diskonly = g_settings->get("emergequeue_limit_diskonly").empty() ?
 121                 nthreads * 5 + 1 :
 122                 g_settings->getU16("emergequeue_limit_diskonly");
 123         qlimit_generate = g_settings->get("emergequeue_limit_generate").empty() ?
 124                 nthreads + 1 :
 125                 g_settings->getU16("emergequeue_limit_generate");
 126
 127         for (int i = 0; i != nthreads; i++)
 128                 emergethread.push_back(new EmergeThread((Server *)gamedef, i));
 129
 130         infostream << "EmergeManager: using " << nthreads << " threads" << std::endl;
 131 }
 132
 133
 134 EmergeManager::~EmergeManager() {
 135         for (unsigned int i = 0; i != emergethread.size(); i++) {
 136                 if (threads_active) {
 137                         emergethread[i]->Stop();
 138                         emergethread[i]->qevent.signal();
 139                         emergethread[i]->Wait();
 140                 }
 141                 delete emergethread[i];
 142                 delete mapgen[i];
 143         }
 144         emergethread.clear();
 145         mapgen.clear();
 146
 147         for (unsigned int i = 0; i < ores.size(); i++)
 148                 delete ores[i];
 149         ores.clear();
 150
 151         for (unsigned int i = 0; i < decorations.size(); i++)
 152                 delete decorations[i];
 153         decorations.clear();
 154
 155         for (std::map<std::string, MapgenFactory *>::iterator iter = mglist.begin();
 156                         iter != mglist.end(); iter ++) {
 157                 delete iter->second;
 158         }
 159         mglist.clear();
 160
 161         delete biomedef;
 162 }
 163
 164
 165 void EmergeManager::initMapgens(MapgenParams *mgparams) {
 166         Mapgen *mg;
 167
 168         if (mapgen.size())
 169                 return;
 170
 171         // Resolve names of nodes for things that were registered
 172         // (at this point, the registration period is over)
 173         biomedef->resolveNodeNames(ndef);
 174
 175         for (size_t i = 0; i != ores.size(); i++)
 176                 ores[i]->resolveNodeNames(ndef);
 177
 178         for (size_t i = 0; i != decorations.size(); i++)
 179                 decorations[i]->resolveNodeNames(ndef);
 180
 181         // Apply mapgen parameter overrides from Lua
 182         if (luaoverride_params) {
 183                 if (luaoverride_params_modified & MGPARAMS_SET_MGNAME) {
 184                         MapgenParams *mgp = setMapgenType(mgparams, luaoverride_params->mg_name);
 185                         if (!mgp) {
 186                                 errorstream << "EmergeManager: Failed to set new mapgen name"
 187                                                         << std::endl;
 188                         } else {
 189                                 mgparams = mgp;
 190                         }
 191                 }
 192
 193                 if (luaoverride_params_modified & MGPARAMS_SET_SEED)
 194                         mgparams->seed = luaoverride_params->seed;
 195
 196                 if (luaoverride_params_modified & MGPARAMS_SET_WATER_LEVEL)
 197                         mgparams->water_level = luaoverride_params->water_level;
 198
 199                 if (luaoverride_params_modified & MGPARAMS_SET_FLAGS) {
 200                         mgparams->flags &= ~luaoverride_flagmask;
 201                         mgparams->flags |= luaoverride_params->flags;
 202                 }
 203
 204                 delete luaoverride_params;
 205                 luaoverride_params = NULL;
 206         }
 207
 208         // Create the mapgens
 209         this->params = mgparams;
 210         for (size_t i = 0; i != emergethread.size(); i++) {
 211                 mg = createMapgen(params->mg_name, i, params);
 212                 if (!mg) {
 213                         infostream << "EmergeManager: Falling back to Mapgen V6" << std::endl;
 214
 215                         params = setMapgenType(params, "v6");
 216                         mg = createMapgen(params->mg_name, i, params);
 217                         if (!mg) {
 218                                 errorstream << "EmergeManager: CRITICAL ERROR: Failed to fall"
 219                                         "back to Mapgen V6, not generating map" << std::endl;
 220                         }
 221                 }
 222                 mapgen.push_back(mg);
 223         }
 224 }
 225
 226
 227 MapgenParams *EmergeManager::setMapgenType(MapgenParams *mgparams,
 228         std::string newname) {
 229         MapgenParams *newparams = createMapgenParams(newname);
 230         if (!newparams) {
 231                 errorstream << "EmergeManager: Mapgen override failed" << std::endl;
 232                 return NULL;
 233         }
 234
 235         newparams->mg_name     = newname;
 236         newparams->seed        = mgparams->seed;
 237         newparams->water_level = mgparams->water_level;
 238         newparams->chunksize   = mgparams->chunksize;
 239         newparams->flags       = mgparams->flags;
 240
 241         if (!newparams->readParams(g_settings)) {
 242                 errorstream << "EmergeManager: Mapgen override failed" << std::endl;
 243                 delete newparams;
 244                 return NULL;
 245         }
 246
 247         delete mgparams;
 248         return newparams;
 249 }
 250
 251
 252 Mapgen *EmergeManager::getCurrentMapgen() {
 253         for (unsigned int i = 0; i != emergethread.size(); i++) {
 254                 if (emergethread[i]->IsSameThread())
 255                         return emergethread[i]->mapgen;
 256         }
 257
 258         return NULL;
 259 }
 260
 261
 262 void EmergeManager::startThreads() {
 263         if (threads_active)
 264                 return;
 265
 266         for (unsigned int i = 0; i != emergethread.size(); i++)
 267                 emergethread[i]->Start();
 268
 269         threads_active = true;
 270 }
 271
 272
 273 void EmergeManager::stopThreads() {
 274         if (!threads_active)
 275                 return;
 276
 277         // Request thread stop in parallel
 278         for (unsigned int i = 0; i != emergethread.size(); i++) {
 279                 emergethread[i]->Stop();
 280                 emergethread[i]->qevent.signal();
 281         }
 282
 283         // Then do the waiting for each
 284         for (unsigned int i = 0; i != emergethread.size(); i++)
 285                 emergethread[i]->Wait();
 286
 287         threads_active = false;
 288 }
 289
 290
 291 bool EmergeManager::enqueueBlockEmerge(u16 peer_id, v3s16 p, bool allow_generate) {
 292         std::map<v3s16, BlockEmergeData *>::const_iterator iter;
 293         BlockEmergeData *bedata;
 294         u16 count;
 295         u8 flags = 0;
 296         int idx = 0;
 297
 298         if (allow_generate)
 299                 flags |= BLOCK_EMERGE_ALLOWGEN;
 300
 301         {
 302                 JMutexAutoLock queuelock(queuemutex);
 303
 304                 count = blocks_enqueued.size();
 305                 if (count >= qlimit_total)
 306                         return false;
 307
 308                 count = peer_queue_count[peer_id];
 309                 u16 qlimit_peer = allow_generate ? qlimit_generate : qlimit_diskonly;
 310                 if (count >= qlimit_peer)
 311                         return false;
 312
 313                 iter = blocks_enqueued.find(p);
 314                 if (iter != blocks_enqueued.end()) {
 315                         bedata = iter->second;
 316                         bedata->flags |= flags;
 317                         return true;
 318                 }
 319
 320                 bedata = new BlockEmergeData;
 321                 bedata->flags = flags;
 322                 bedata->peer_requested = peer_id;
 323                 blocks_enqueued.insert(std::make_pair(p, bedata));
 324
 325                 peer_queue_count[peer_id] = count + 1;
 326
 327                 // insert into the EmergeThread queue with the least items
 328                 int lowestitems = emergethread[0]->blockqueue.size();
 329                 for (unsigned int i = 1; i != emergethread.size(); i++) {
 330                         int nitems = emergethread[i]->blockqueue.size();
 331                         if (nitems < lowestitems) {
 332                                 idx = i;
 333                                 lowestitems = nitems;
 334                         }
 335                 }
 336
 337                 emergethread[idx]->blockqueue.push(p);
 338         }
 339         emergethread[idx]->qevent.signal();
 340
 341         return true;
 342 }
 343
 344
 345 int EmergeManager::getGroundLevelAtPoint(v2s16 p) {
 346         if (mapgen.size() == 0 || !mapgen[0]) {
 347                 errorstream << "EmergeManager: getGroundLevelAtPoint() called"
 348                         " before mapgen initialized" << std::endl;
 349                 return 0;
 350         }
 351
 352         return mapgen[0]->getGroundLevelAtPoint(p);
 353 }
 354
 355
 356 bool EmergeManager::isBlockUnderground(v3s16 blockpos) {
 357         /*
 358         v2s16 p = v2s16((blockpos.X * MAP_BLOCKSIZE) + MAP_BLOCKSIZE / 2,
 359                                         (blockpos.Y * MAP_BLOCKSIZE) + MAP_BLOCKSIZE / 2);
 360         int ground_level = getGroundLevelAtPoint(p);
 361         return blockpos.Y * (MAP_BLOCKSIZE + 1) <= min(water_level, ground_level);
 362         */
 363
 364         //yuck, but then again, should i bother being accurate?
 365         //the height of the nodes in a single block is quite variable
 366         return blockpos.Y * (MAP_BLOCKSIZE + 1) <= params->water_level;
 367 }
 368
 369
 370 u32 EmergeManager::getBlockSeed(v3s16 p) {
 371         return (u32)(params->seed & 0xFFFFFFFF) +
 372                 p.Z * 38134234 +
 373                 p.Y * 42123 +
 374                 p.X * 23;
 375 }
 376
 377
 378 Mapgen *EmergeManager::createMapgen(std::string mgname, int mgid,
 379                                                                          MapgenParams *mgparams) {
 380         std::map<std::string, MapgenFactory *>::const_iterator iter;
 381         iter = mglist.find(mgname);
 382         if (iter == mglist.end()) {
 383                 errorstream << "EmergeManager; mapgen " << mgname <<
 384                  " not registered" << std::endl;
 385                 return NULL;
 386         }
 387
 388         MapgenFactory *mgfactory = iter->second;
 389         return mgfactory->createMapgen(mgid, mgparams, this);
 390 }
 391
 392
 393 MapgenParams *EmergeManager::createMapgenParams(std::string mgname) {
 394         std::map<std::string, MapgenFactory *>::const_iterator iter;
 395         iter = mglist.find(mgname);
 396         if (iter == mglist.end()) {
 397                 errorstream << "EmergeManager: mapgen " << mgname <<
 398                  " not registered" << std::endl;
 399                 return NULL;
 400         }
 401
 402         MapgenFactory *mgfactory = iter->second;
 403         return mgfactory->createMapgenParams();
 404 }
 405
 406
 407 MapgenParams *EmergeManager::getParamsFromSettings(Settings *settings) {
 408         std::string mg_name = settings->get("mg_name");
 409         MapgenParams *mgparams = createMapgenParams(mg_name);
 410         if (!mgparams)
 411                 return NULL;
 412
 413         std::string seedstr = settings->get(settings == g_settings ?
 414                                                                         "fixed_map_seed" : "seed");
 415
 416         mgparams->mg_name     = mg_name;
 417         mgparams->seed        = read_seed(seedstr.c_str());
 418         mgparams->water_level = settings->getS16("water_level");
 419         mgparams->chunksize   = settings->getS16("chunksize");
 420         mgparams->flags       = settings->getFlagStr("mg_flags", flagdesc_mapgen);
 421
 422         if (!mgparams->readParams(settings)) {
 423                 delete mgparams;
 424                 return NULL;
 425         }
 426         return mgparams;
 427 }
 428
 429
 430 void EmergeManager::setParamsToSettings(Settings *settings) {
 431         settings->set("mg_name",         params->mg_name);
 432         settings->setU64("seed",         params->seed);
 433         settings->setS16("water_level",  params->water_level);
 434         settings->setS16("chunksize",    params->chunksize);
 435         settings->setFlagStr("mg_flags", params->flags, flagdesc_mapgen);
 436
 437         params->writeParams(settings);
 438 }
 439
 440
 441 void EmergeManager::registerMapgen(std::string mgname, MapgenFactory *mgfactory) {
 442         mglist.insert(std::make_pair(mgname, mgfactory));
 443         infostream << "EmergeManager: registered mapgen " << mgname << std::endl;
 444 }
 445
 446
 447 ////////////////////////////// Emerge Thread //////////////////////////////////
 448
 449 bool EmergeThread::popBlockEmerge(v3s16 *pos, u8 *flags) {
 450         std::map<v3s16, BlockEmergeData *>::iterator iter;
 451         JMutexAutoLock queuelock(emerge->queuemutex);
 452
 453         if (blockqueue.empty())
 454                 return false;
 455         v3s16 p = blockqueue.front();
 456         blockqueue.pop();
 457
 458         *pos = p;
 459
 460         iter = emerge->blocks_enqueued.find(p);
 461         if (iter == emerge->blocks_enqueued.end())
 462                 return false; //uh oh, queue and map out of sync!!
 463
 464         BlockEmergeData *bedata = iter->second;
 465         *flags = bedata->flags;
 466
 467         emerge->peer_queue_count[bedata->peer_requested]--;
 468
 469         delete bedata;
 470         emerge->blocks_enqueued.erase(iter);
 471
 472         return true;
 473 }
 474
 475
 476 bool EmergeThread::getBlockOrStartGen(v3s16 p, MapBlock **b,
 477                                                                         BlockMakeData *data, bool allow_gen) {
 478         v2s16 p2d(p.X, p.Z);
 479         //envlock: usually takes <=1ms, sometimes 90ms or ~400ms to acquire
 480         JMutexAutoLock envlock(m_server->m_env_mutex);
 481
 482         // Load sector if it isn't loaded
 483         if (map->getSectorNoGenerateNoEx(p2d) == NULL)
 484                 map->loadSectorMeta(p2d);
 485
 486         // Attempt to load block
 487         MapBlock *block = map->getBlockNoCreateNoEx(p);
 488         if (!block || block->isDummy() || !block->isGenerated()) {
 489                 EMERGE_DBG_OUT("not in memory, attempting to load from disk");
 490                 block = map->loadBlock(p);
 491                 if (block && block->isGenerated())
 492                         map->prepareBlock(block);
 493         }
 494
 495         // If could not load and allowed to generate,
 496         // start generation inside this same envlock
 497         if (allow_gen && (block == NULL || !block->isGenerated())) {
 498                 EMERGE_DBG_OUT("generating");
 499                 *b = block;
 500                 return map->initBlockMake(data, p);
 501         }
 502
 503         *b = block;
 504         return false;
 505 }
 506
 507
 508 void *EmergeThread::Thread() {
 509         ThreadStarted();
 510         log_register_thread("EmergeThread" + itos(id));
 511         DSTACK(__FUNCTION_NAME);
 512         BEGIN_DEBUG_EXCEPTION_HANDLER
 513
 514         v3s16 last_tried_pos(-32768,-32768,-32768); // For error output
 515         v3s16 p;
 516         u8 flags;
 517
 518         map    = (ServerMap *)&(m_server->m_env->getMap());
 519         emerge = m_server->m_emerge;
 520         mapgen = emerge->mapgen[id];
 521         enable_mapgen_debug_info = emerge->mapgen_debug_info;
 522
 523         while (!StopRequested())
 524         try {
 525                 if (!popBlockEmerge(&p, &flags)) {
 526                         qevent.wait();
 527                         continue;
 528                 }
 529
 530                 last_tried_pos = p;
 531                 if (blockpos_over_limit(p))
 532                         continue;
 533
 534                 bool allow_generate = flags & BLOCK_EMERGE_ALLOWGEN;
 535                 EMERGE_DBG_OUT("p=" PP(p) " allow_generate=" << allow_generate);
 536
 537                 /*
 538                         Try to fetch block from memory or disk.
 539                         If not found and asked to generate, initialize generator.
 540                 */
 541                 BlockMakeData data;
 542                 MapBlock *block = NULL;
 543                 std::map<v3s16, MapBlock *> modified_blocks;
 544
 545                 if (getBlockOrStartGen(p, &block, &data, allow_generate) && mapgen) {
 546                         {
 547                                 ScopeProfiler sp(g_profiler, "EmergeThread: Mapgen::makeChunk", SPT_AVG);
 548                                 TimeTaker t("mapgen::make_block()");
 549
 550                                 mapgen->makeChunk(&data);
 551
 552                                 if (enable_mapgen_debug_info == false)
 553                                         t.stop(true); // Hide output
 554                         }
 555
 556                         {
 557                                 //envlock: usually 0ms, but can take either 30 or 400ms to acquire
 558                                 JMutexAutoLock envlock(m_server->m_env_mutex);
 559                                 ScopeProfiler sp(g_profiler, "EmergeThread: after "
 560                                                 "Mapgen::makeChunk (envlock)", SPT_AVG);
 561
 562                                 map->finishBlockMake(&data, modified_blocks);
 563
 564                                 block = map->getBlockNoCreateNoEx(p);
 565                                 if (block) {
 566                                         /*
 567                                                 Do some post-generate stuff
 568                                         */
 569                                         v3s16 minp = data.blockpos_min * MAP_BLOCKSIZE;
 570                                         v3s16 maxp = data.blockpos_max * MAP_BLOCKSIZE +
 571                                                                  v3s16(1,1,1) * (MAP_BLOCKSIZE - 1);
 572
 573                                         // Ignore map edit events, they will not need to be sent
 574                                         // to anybody because the block hasn't been sent to anybody
 575                                         MapEditEventAreaIgnorer
 576                                                 ign(&m_server->m_ignore_map_edit_events_area,
 577                                                 VoxelArea(minp, maxp));
 578                                         try {  // takes about 90ms with -O1 on an e3-1230v2
 579                                                 m_server->getScriptIface()->environment_OnGenerated(
 580                                                                 minp, maxp, emerge->getBlockSeed(minp));
 581                                         } catch(LuaError &e) {
 582                                                 m_server->setAsyncFatalError(e.what());
 583                                         }
 584
 585                                         EMERGE_DBG_OUT("ended up with: " << analyze_block(block));
 586
 587                                         m_server->m_env->activateBlock(block, 0);
 588                                 }
 589                         }
 590                 }
 591
 592                 /*
 593                         Set sent status of modified blocks on clients
 594                 */
 595                 // Add the originally fetched block to the modified list
 596                 if (block)
 597                         modified_blocks[p] = block;
 598
 599                 if (modified_blocks.size() > 0) {
 600                         m_server->SetBlocksNotSent(modified_blocks);
 601                 }
 602         }
 603         catch (VersionMismatchException &e) {
 604                 std::ostringstream err;
 605                 err << "World data version mismatch in MapBlock "<<PP(last_tried_pos)<<std::endl;
 606                 err << "----"<<std::endl;
 607                 err << "\""<<e.what()<<"\""<<std::endl;
 608                 err << "See debug.txt."<<std::endl;
 609                 err << "World probably saved by a newer version of Minetest."<<std::endl;
 610                 m_server->setAsyncFatalError(err.str());
 611         }
 612         catch (SerializationError &e) {
 613                 std::ostringstream err;
 614                 err << "Invalid data in MapBlock "<<PP(last_tried_pos)<<std::endl;
 615                 err << "----"<<std::endl;
 616                 err << "\""<<e.what()<<"\""<<std::endl;
 617                 err << "See debug.txt."<<std::endl;
 618                 err << "You can ignore this using [ignore_world_load_errors = true]."<<std::endl;
 619                 m_server->setAsyncFatalError(err.str());
 620         }
 621
 622         END_DEBUG_EXCEPTION_HANDLER(errorstream)
 623         log_deregister_thread();
 624         return NULL;
 625 }