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