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