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