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