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