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