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