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
  24 #include <iostream>
  25 #include <queue>
  26
  27 #include "util/container.h"
  28 #include "util/thread.h"
  29 #include "threading/event.h"
  30
  31 #include "config.h"
  32 #include "constants.h"
  33 #include "environment.h"
  34 #include "log.h"
  35 #include "map.h"
  36 #include "mapblock.h"
  37 #include "mapgen_fractal.h"
  38 #include "mapgen_v5.h"
  39 #include "mapgen_v6.h"
  40 #include "mapgen_v7.h"
  41 #include "mapgen_singlenode.h"
  42 #include "mg_biome.h"
  43 #include "mg_ore.h"
  44 #include "mg_decoration.h"
  45 #include "mg_schematic.h"
  46 #include "nodedef.h"
  47 #include "profiler.h"
  48 #include "scripting_game.h"
  49 #include "server.h"
  50 #include "serverobject.h"
  51 #include "settings.h"
  52 #include "voxel.h"
  53
  54
  55 struct MapgenDesc {
  56         const char *name;
  57         MapgenFactory *factory;
  58         bool is_user_visible;
  59 };
  60
  61 class EmergeThread : public Thread {
  62 public:
  63         bool enable_mapgen_debug_info;
  64         int id;
  65
  66         EmergeThread(Server *server, int ethreadid);
  67         ~EmergeThread();
  68
  69         void *run();
  70         void signal();
  71
  72         // Requires queue mutex held
  73         bool pushBlock(v3s16 pos);
  74
  75         void cancelPendingItems();
  76
  77         static void runCompletionCallbacks(
  78                 v3s16 pos, EmergeAction action,
  79                 const EmergeCallbackList &callbacks);
  80
  81 private:
  82         Server *m_server;
  83         ServerMap *m_map;
  84         EmergeManager *m_emerge;
  85         Mapgen *m_mapgen;
  86
  87         Event m_queue_event;
  88         std::queue<v3s16> m_block_queue;
  89
  90         bool popBlockEmerge(v3s16 *pos, BlockEmergeData *bedata);
  91
  92         EmergeAction getBlockOrStartGen(
  93                 v3s16 pos, bool allow_gen, MapBlock **block, BlockMakeData *data);
  94         MapBlock *finishGen(v3s16 pos, BlockMakeData *bmdata,
  95                 std::map<v3s16, MapBlock *> *modified_blocks);
  96
  97         friend class EmergeManager;
  98 };
  99
 100 ////
 101 //// Built-in mapgens
 102 ////
 103
 104 MapgenDesc g_reg_mapgens[] = {
 105         {"v5",         new MapgenFactoryV5,         true},
 106         {"v6",         new MapgenFactoryV6,         true},
 107         {"v7",         new MapgenFactoryV7,         true},
 108         {"fractal",    new MapgenFactoryFractal,    false},
 109         {"singlenode", new MapgenFactorySinglenode, false},
 110 };
 111
 112 ////
 113 //// EmergeManager
 114 ////
 115
 116 EmergeManager::EmergeManager(IGameDef *gamedef)
 117 {
 118         this->ndef      = gamedef->getNodeDefManager();
 119         this->biomemgr  = new BiomeManager(gamedef);
 120         this->oremgr    = new OreManager(gamedef);
 121         this->decomgr   = new DecorationManager(gamedef);
 122         this->schemmgr  = new SchematicManager(gamedef);
 123         this->gen_notify_on = 0;
 124
 125         // Note that accesses to this variable are not synchronized.
 126         // This is because the *only* thread ever starting or stopping
 127         // EmergeThreads should be the ServerThread.
 128         this->m_threads_active = false;
 129
 130         enable_mapgen_debug_info = g_settings->getBool("enable_mapgen_debug_info");
 131
 132         // If unspecified, leave a proc for the main thread and one for
 133         // some other misc thread
 134         s16 nthreads = 0;
 135         if (!g_settings->getS16NoEx("num_emerge_threads", nthreads))
 136                 nthreads = Thread::getNumberOfProcessors() - 2;
 137         if (nthreads < 1)
 138                 nthreads = 1;
 139
 140         m_qlimit_total = g_settings->getU16("emergequeue_limit_total");
 141         if (!g_settings->getU16NoEx("emergequeue_limit_diskonly", m_qlimit_diskonly))
 142                 m_qlimit_diskonly = nthreads * 5 + 1;
 143         if (!g_settings->getU16NoEx("emergequeue_limit_generate", m_qlimit_generate))
 144                 m_qlimit_generate = nthreads + 1;
 145
 146         // don't trust user input for something very important like this
 147         if (m_qlimit_total < 1)
 148                 m_qlimit_total = 1;
 149         if (m_qlimit_diskonly < 1)
 150                 m_qlimit_diskonly = 1;
 151         if (m_qlimit_generate < 1)
 152                 m_qlimit_generate = 1;
 153
 154         for (s16 i = 0; i < nthreads; i++)
 155                 m_threads.push_back(new EmergeThread((Server *)gamedef, i));
 156
 157         infostream << "EmergeManager: using " << nthreads << " threads" << std::endl;
 158 }
 159
 160
 161 EmergeManager::~EmergeManager()
 162 {
 163         for (u32 i = 0; i != m_threads.size(); i++) {
 164                 EmergeThread *thread = m_threads[i];
 165
 166                 if (m_threads_active) {
 167                         thread->stop();
 168                         thread->signal();
 169                         thread->wait();
 170                 }
 171
 172                 delete thread;
 173                 delete m_mapgens[i];
 174         }
 175
 176         delete biomemgr;
 177         delete oremgr;
 178         delete decomgr;
 179         delete schemmgr;
 180
 181         delete params.sparams;
 182 }
 183
 184
 185 void EmergeManager::loadMapgenParams()
 186 {
 187         params.load(*g_settings);
 188 }
 189
 190
 191 void EmergeManager::initMapgens()
 192 {
 193         if (m_mapgens.size())
 194                 return;
 195
 196         MapgenFactory *mgfactory = getMapgenFactory(params.mg_name);
 197         if (!mgfactory) {
 198                 errorstream << "EmergeManager: mapgen " << params.mg_name <<
 199                         " not registered; falling back to " << DEFAULT_MAPGEN << std::endl;
 200
 201                 params.mg_name = DEFAULT_MAPGEN;
 202
 203                 mgfactory = getMapgenFactory(params.mg_name);
 204                 FATAL_ERROR_IF(mgfactory == NULL, "Couldn't use any mapgen!");
 205         }
 206
 207         if (!params.sparams) {
 208                 params.sparams = mgfactory->createMapgenParams();
 209                 params.sparams->readParams(g_settings);
 210         }
 211
 212         for (u32 i = 0; i != m_threads.size(); i++) {
 213                 Mapgen *mg = mgfactory->createMapgen(i, &params, this);
 214                 m_mapgens.push_back(mg);
 215         }
 216 }
 217
 218
 219 Mapgen *EmergeManager::getCurrentMapgen()
 220 {
 221         for (u32 i = 0; i != m_threads.size(); i++) {
 222                 if (m_threads[i]->isCurrentThread())
 223                         return m_threads[i]->m_mapgen;
 224         }
 225
 226         return NULL;
 227 }
 228
 229
 230 void EmergeManager::startThreads()
 231 {
 232         if (m_threads_active)
 233                 return;
 234
 235         for (u32 i = 0; i != m_threads.size(); i++)
 236                 m_threads[i]->start();
 237
 238         m_threads_active = true;
 239 }
 240
 241
 242 void EmergeManager::stopThreads()
 243 {
 244         if (!m_threads_active)
 245                 return;
 246
 247         // Request thread stop in parallel
 248         for (u32 i = 0; i != m_threads.size(); i++) {
 249                 m_threads[i]->stop();
 250                 m_threads[i]->signal();
 251         }
 252
 253         // Then do the waiting for each
 254         for (u32 i = 0; i != m_threads.size(); i++)
 255                 m_threads[i]->wait();
 256
 257         m_threads_active = false;
 258 }
 259
 260
 261 bool EmergeManager::isRunning()
 262 {
 263         return m_threads_active;
 264 }
 265
 266
 267 bool EmergeManager::enqueueBlockEmerge(
 268         u16 peer_id,
 269         v3s16 blockpos,
 270         bool allow_generate,
 271         bool ignore_queue_limits)
 272 {
 273         u16 flags = 0;
 274         if (allow_generate)
 275                 flags |= BLOCK_EMERGE_ALLOW_GEN;
 276         if (ignore_queue_limits)
 277                 flags |= BLOCK_EMERGE_FORCE_QUEUE;
 278
 279         return enqueueBlockEmergeEx(blockpos, peer_id, flags, NULL, NULL);
 280 }
 281
 282
 283 bool EmergeManager::enqueueBlockEmergeEx(
 284         v3s16 blockpos,
 285         u16 peer_id,
 286         u16 flags,
 287         EmergeCompletionCallback callback,
 288         void *callback_param)
 289 {
 290         EmergeThread *thread = NULL;
 291
 292         {
 293                 MutexAutoLock queuelock(m_queue_mutex);
 294
 295                 if (!pushBlockEmergeData(blockpos, peer_id, flags,
 296                                 callback, callback_param))
 297                         return false;
 298
 299                 thread = getOptimalThread();
 300                 thread->pushBlock(blockpos);
 301         }
 302
 303         thread->signal();
 304
 305         return true;
 306 }
 307
 308
 309 //
 310 // Mapgen-related helper functions
 311 //
 312
 313 v3s16 EmergeManager::getContainingChunk(v3s16 blockpos)
 314 {
 315         return getContainingChunk(blockpos, params.chunksize);
 316 }
 317
 318
 319 v3s16 EmergeManager::getContainingChunk(v3s16 blockpos, s16 chunksize)
 320 {
 321         s16 coff = -chunksize / 2;
 322         v3s16 chunk_offset(coff, coff, coff);
 323
 324         return getContainerPos(blockpos - chunk_offset, chunksize)
 325                 * chunksize + chunk_offset;
 326 }
 327
 328
 329 int EmergeManager::getGroundLevelAtPoint(v2s16 p)
 330 {
 331         if (m_mapgens.size() == 0 || !m_mapgens[0]) {
 332                 errorstream << "EmergeManager: getGroundLevelAtPoint() called"
 333                         " before mapgen init" << std::endl;
 334                 return 0;
 335         }
 336
 337         return m_mapgens[0]->getGroundLevelAtPoint(p);
 338 }
 339
 340
 341 bool EmergeManager::isBlockUnderground(v3s16 blockpos)
 342 {
 343 #if 0
 344         v2s16 p = v2s16((blockpos.X * MAP_BLOCKSIZE) + MAP_BLOCKSIZE / 2,
 345                                         (blockpos.Y * MAP_BLOCKSIZE) + MAP_BLOCKSIZE / 2);
 346         int ground_level = getGroundLevelAtPoint(p);
 347         return blockpos.Y * (MAP_BLOCKSIZE + 1) <= min(water_level, ground_level);
 348 #endif
 349
 350         // Use a simple heuristic; the above method is wildly inaccurate anyway.
 351         return blockpos.Y * (MAP_BLOCKSIZE + 1) <= params.water_level;
 352 }
 353
 354
 355 void EmergeManager::getMapgenNames(
 356         std::vector<const char *> *mgnames, bool include_hidden)
 357 {
 358         for (u32 i = 0; i != ARRLEN(g_reg_mapgens); i++) {
 359                 if (include_hidden || g_reg_mapgens[i].is_user_visible)
 360                         mgnames->push_back(g_reg_mapgens[i].name);
 361         }
 362 }
 363
 364
 365 MapgenFactory *EmergeManager::getMapgenFactory(const std::string &mgname)
 366 {
 367         for (u32 i = 0; i != ARRLEN(g_reg_mapgens); i++) {
 368                 if (mgname == g_reg_mapgens[i].name)
 369                         return g_reg_mapgens[i].factory;
 370         }
 371
 372         return NULL;
 373 }
 374
 375
 376 bool EmergeManager::pushBlockEmergeData(
 377         v3s16 pos,
 378         u16 peer_requested,
 379         u16 flags,
 380         EmergeCompletionCallback callback,
 381         void *callback_param)
 382 {
 383         u16 &count_peer = m_peer_queue_count[peer_requested];
 384
 385         if ((flags & BLOCK_EMERGE_FORCE_QUEUE) == 0) {
 386                 if (m_blocks_enqueued.size() >= m_qlimit_total)
 387                         return false;
 388
 389                 if (peer_requested != PEER_ID_INEXISTENT) {
 390                         u16 qlimit_peer = (flags & BLOCK_EMERGE_ALLOW_GEN) ?
 391                                 m_qlimit_generate : m_qlimit_diskonly;
 392                         if (count_peer >= qlimit_peer)
 393                                 return false;
 394                 }
 395         }
 396
 397         std::pair<std::map<v3s16, BlockEmergeData>::iterator, bool> findres;
 398         findres = m_blocks_enqueued.insert(std::make_pair(pos, BlockEmergeData()));
 399
 400         BlockEmergeData &bedata = findres.first->second;
 401         bool update_existing    = !findres.second;
 402
 403         if (callback)
 404                 bedata.callbacks.push_back(std::make_pair(callback, callback_param));
 405
 406         if (update_existing) {
 407                 bedata.flags |= flags;
 408         } else {
 409                 bedata.flags = flags;
 410                 bedata.peer_requested = peer_requested;
 411
 412                 count_peer++;
 413         }
 414
 415         return true;
 416 }
 417
 418
 419 bool EmergeManager::popBlockEmergeData(
 420         v3s16 pos,
 421         BlockEmergeData *bedata)
 422 {
 423         std::map<v3s16, BlockEmergeData>::iterator it;
 424         std::map<u16, u16>::iterator it2;
 425
 426         it = m_blocks_enqueued.find(pos);
 427         if (it == m_blocks_enqueued.end())
 428                 return false;
 429
 430         *bedata = it->second;
 431
 432         it2 = m_peer_queue_count.find(bedata->peer_requested);
 433         if (it2 == m_peer_queue_count.end())
 434                 return false;
 435
 436         u16 &count_peer = it2->second;
 437         assert(count_peer != 0);
 438         count_peer--;
 439
 440         m_blocks_enqueued.erase(it);
 441
 442         return true;
 443 }
 444
 445
 446 EmergeThread *EmergeManager::getOptimalThread()
 447 {
 448         size_t nthreads = m_threads.size();
 449
 450         FATAL_ERROR_IF(nthreads == 0, "No emerge threads!");
 451
 452         size_t index = 0;
 453         size_t nitems_lowest = m_threads[0]->m_block_queue.size();
 454
 455         for (size_t i = 1; i < nthreads; i++) {
 456                 size_t nitems = m_threads[i]->m_block_queue.size();
 457                 if (nitems < nitems_lowest) {
 458                         index = i;
 459                         nitems_lowest = nitems;
 460                 }
 461         }
 462
 463         return m_threads[index];
 464 }
 465
 466
 467 ////
 468 //// EmergeThread
 469 ////
 470
 471 EmergeThread::EmergeThread(Server *server, int ethreadid) :
 472         enable_mapgen_debug_info(false),
 473         id(ethreadid),
 474         m_server(server),
 475         m_map(NULL),
 476         m_emerge(NULL),
 477         m_mapgen(NULL)
 478 {
 479         m_name = "Emerge-" + itos(ethreadid);
 480 }
 481
 482
 483 EmergeThread::~EmergeThread()
 484 {
 485         //cancelPendingItems();
 486 }
 487
 488
 489 void EmergeThread::signal()
 490 {
 491         m_queue_event.signal();
 492 }
 493
 494
 495 bool EmergeThread::pushBlock(v3s16 pos)
 496 {
 497         m_block_queue.push(pos);
 498         return true;
 499 }
 500
 501
 502 void EmergeThread::cancelPendingItems()
 503 {
 504         MutexAutoLock queuelock(m_emerge->m_queue_mutex);
 505
 506         while (!m_block_queue.empty()) {
 507                 BlockEmergeData bedata;
 508                 v3s16 pos;
 509
 510                 pos = m_block_queue.front();
 511                 m_block_queue.pop();
 512
 513                 m_emerge->popBlockEmergeData(pos, &bedata);
 514
 515                 runCompletionCallbacks(pos, EMERGE_CANCELLED, bedata.callbacks);
 516         }
 517 }
 518
 519
 520 void EmergeThread::runCompletionCallbacks(
 521         v3s16 pos,
 522         EmergeAction action,
 523         const EmergeCallbackList &callbacks)
 524 {
 525         for (size_t i = 0; i != callbacks.size(); i++) {
 526                 EmergeCompletionCallback callback;
 527                 void *param;
 528
 529                 callback = callbacks[i].first;
 530                 param    = callbacks[i].second;
 531
 532                 callback(pos, action, param);
 533         }
 534 }
 535
 536
 537 bool EmergeThread::popBlockEmerge(v3s16 *pos, BlockEmergeData *bedata)
 538 {
 539         MutexAutoLock queuelock(m_emerge->m_queue_mutex);
 540
 541         if (m_block_queue.empty())
 542                 return false;
 543
 544         *pos = m_block_queue.front();
 545         m_block_queue.pop();
 546
 547         m_emerge->popBlockEmergeData(*pos, bedata);
 548
 549         return true;
 550 }
 551
 552
 553 EmergeAction EmergeThread::getBlockOrStartGen(
 554         v3s16 pos, bool allow_gen, MapBlock **block, BlockMakeData *bmdata)
 555 {
 556         MutexAutoLock envlock(m_server->m_env_mutex);
 557
 558         // 1). Attempt to fetch block from memory
 559         *block = m_map->getBlockNoCreateNoEx(pos);
 560         if (*block && !(*block)->isDummy() && (*block)->isGenerated())
 561                 return EMERGE_FROM_MEMORY;
 562
 563         // 2). Attempt to load block from disk
 564         *block = m_map->loadBlock(pos);
 565         if (*block && (*block)->isGenerated())
 566                 return EMERGE_FROM_DISK;
 567
 568         // 3). Attempt to start generation
 569         if (allow_gen && m_map->initBlockMake(pos, bmdata))
 570                 return EMERGE_GENERATED;
 571
 572         // All attempts failed; cancel this block emerge
 573         return EMERGE_CANCELLED;
 574 }
 575
 576
 577 MapBlock *EmergeThread::finishGen(v3s16 pos, BlockMakeData *bmdata,
 578         std::map<v3s16, MapBlock *> *modified_blocks)
 579 {
 580         MutexAutoLock envlock(m_server->m_env_mutex);
 581         ScopeProfiler sp(g_profiler,
 582                 "EmergeThread: after Mapgen::makeChunk", SPT_AVG);
 583
 584         /*
 585                 Perform post-processing on blocks (invalidate lighting, queue liquid
 586                 transforms, etc.) to finish block make
 587         */
 588         m_map->finishBlockMake(bmdata, modified_blocks);
 589
 590         MapBlock *block = m_map->getBlockNoCreateNoEx(pos);
 591         if (!block) {
 592                 errorstream << "EmergeThread::finishGen: Couldn't grab block we "
 593                         "just generated: " << PP(pos) << std::endl;
 594                 return NULL;
 595         }
 596
 597         v3s16 minp = bmdata->blockpos_min * MAP_BLOCKSIZE;
 598         v3s16 maxp = bmdata->blockpos_max * MAP_BLOCKSIZE +
 599                                  v3s16(1,1,1) * (MAP_BLOCKSIZE - 1);
 600
 601         // Ignore map edit events, they will not need to be sent
 602         // to anybody because the block hasn't been sent to anybody
 603         MapEditEventAreaIgnorer ign(
 604                 &m_server->m_ignore_map_edit_events_area,
 605                 VoxelArea(minp, maxp));
 606
 607         /*
 608                 Run Lua on_generated callbacks
 609         */
 610         try {
 611                 m_server->getScriptIface()->environment_OnGenerated(
 612                         minp, maxp, m_mapgen->blockseed);
 613         } catch (LuaError &e) {
 614                 m_server->setAsyncFatalError("Lua: " + std::string(e.what()));
 615         }
 616
 617         EMERGE_DBG_OUT("ended up with: " << analyze_block(block));
 618
 619         /*
 620                 Activate the block
 621         */
 622         m_server->m_env->activateBlock(block, 0);
 623
 624         return block;
 625 }
 626
 627
 628 void *EmergeThread::run()
 629 {
 630         DSTACK(FUNCTION_NAME);
 631         BEGIN_DEBUG_EXCEPTION_HANDLER
 632
 633         v3s16 pos;
 634
 635         m_map    = (ServerMap *)&(m_server->m_env->getMap());
 636         m_emerge = m_server->m_emerge;
 637         m_mapgen = m_emerge->m_mapgens[id];
 638         enable_mapgen_debug_info = m_emerge->enable_mapgen_debug_info;
 639
 640         try {
 641         while (!stopRequested()) {
 642                 std::map<v3s16, MapBlock *> modified_blocks;
 643                 BlockEmergeData bedata;
 644                 BlockMakeData bmdata;
 645                 EmergeAction action;
 646                 MapBlock *block;
 647
 648                 if (!popBlockEmerge(&pos, &bedata)) {
 649                         m_queue_event.wait();
 650                         continue;
 651                 }
 652
 653                 if (blockpos_over_limit(pos))
 654                         continue;
 655
 656                 bool allow_gen = bedata.flags & BLOCK_EMERGE_ALLOW_GEN;
 657                 EMERGE_DBG_OUT("pos=" PP(pos) " allow_gen=" << allow_gen);
 658
 659                 action = getBlockOrStartGen(pos, allow_gen, &block, &bmdata);
 660                 if (action == EMERGE_GENERATED) {
 661                         {
 662                                 ScopeProfiler sp(g_profiler,
 663                                         "EmergeThread: Mapgen::makeChunk", SPT_AVG);
 664                                 TimeTaker t("mapgen::make_block()");
 665
 666                                 m_mapgen->makeChunk(&bmdata);
 667
 668                                 if (enable_mapgen_debug_info == false)
 669                                         t.stop(true); // Hide output
 670                         }
 671
 672                         block = finishGen(pos, &bmdata, &modified_blocks);
 673                 }
 674
 675                 runCompletionCallbacks(pos, action, bedata.callbacks);
 676
 677                 if (block)
 678                         modified_blocks[pos] = block;
 679
 680                 if (modified_blocks.size() > 0)
 681                         m_server->SetBlocksNotSent(modified_blocks);
 682         }
 683         } catch (VersionMismatchException &e) {
 684                 std::ostringstream err;
 685                 err << "World data version mismatch in MapBlock " << PP(pos) << std::endl
 686                         << "----" << std::endl
 687                         << "\"" << e.what() << "\"" << std::endl
 688                         << "See debug.txt." << std::endl
 689                         << "World probably saved by a newer version of " PROJECT_NAME_C "."
 690                         << std::endl;
 691                 m_server->setAsyncFatalError(err.str());
 692         } catch (SerializationError &e) {
 693                 std::ostringstream err;
 694                 err << "Invalid data in MapBlock " << PP(pos) << std::endl
 695                         << "----" << std::endl
 696                         << "\"" << e.what() << "\"" << std::endl
 697                         << "See debug.txt." << std::endl
 698                         << "You can ignore this using [ignore_world_load_errors = true]."
 699                         << std::endl;
 700                 m_server->setAsyncFatalError(err.str());
 701         }
 702
 703         END_DEBUG_EXCEPTION_HANDLER
 704         return NULL;
 705 }