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