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