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