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