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