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