3 Copyright (C) 2010-2013 celeron55, Perttu Ahola <celeron55@gmail.com>
4 Copyright (C) 2010-2013 kwolekr, Ryan Kwolek <kwolekr@minetest.net>
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.
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.
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.
27 #include "util/container.h"
28 #include "util/thread.h"
29 #include "threading/event.h"
32 #include "constants.h"
33 #include "environment.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"
46 #include "mg_decoration.h"
47 #include "mg_schematic.h"
50 #include "scripting_game.h"
52 #include "serverobject.h"
59 MapgenFactory *factory;
63 class EmergeThread : public Thread {
65 bool enable_mapgen_debug_info;
68 EmergeThread(Server *server, int ethreadid);
74 // Requires queue mutex held
75 bool pushBlock(v3s16 pos);
77 void cancelPendingItems();
79 static void runCompletionCallbacks(
80 v3s16 pos, EmergeAction action,
81 const EmergeCallbackList &callbacks);
86 EmergeManager *m_emerge;
90 std::queue<v3s16> m_block_queue;
92 bool popBlockEmerge(v3s16 *pos, BlockEmergeData *bedata);
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);
99 friend class EmergeManager;
103 //// Built-in mapgens
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},
120 EmergeManager::EmergeManager(IGameDef *gamedef)
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;
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;
134 enable_mapgen_debug_info = g_settings->getBool("enable_mapgen_debug_info");
136 // If unspecified, leave a proc for the main thread and one for
137 // some other misc thread
139 if (!g_settings->getS16NoEx("num_emerge_threads", nthreads))
140 nthreads = Thread::getNumberOfProcessors() - 2;
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;
150 // don't trust user input for something very important like this
151 if (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;
158 for (s16 i = 0; i < nthreads; i++)
159 m_threads.push_back(new EmergeThread((Server *)gamedef, i));
161 infostream << "EmergeManager: using " << nthreads << " threads" << std::endl;
165 EmergeManager::~EmergeManager()
167 for (u32 i = 0; i != m_threads.size(); i++) {
168 EmergeThread *thread = m_threads[i];
170 if (m_threads_active) {
187 void EmergeManager::loadMapgenParams()
189 params.load(*g_settings);
193 void EmergeManager::initMapgens()
195 if (m_mapgens.size())
198 MapgenFactory *mgfactory = getMapgenFactory(params.mg_name);
200 errorstream << "EmergeManager: mapgen " << params.mg_name <<
201 " not registered; falling back to " << DEFAULT_MAPGEN << std::endl;
203 params.mg_name = DEFAULT_MAPGEN;
205 mgfactory = getMapgenFactory(params.mg_name);
206 FATAL_ERROR_IF(mgfactory == NULL, "Couldn't use any mapgen!");
209 if (!params.sparams) {
210 params.sparams = mgfactory->createMapgenParams();
211 params.sparams->readParams(g_settings);
214 for (u32 i = 0; i != m_threads.size(); i++) {
215 Mapgen *mg = mgfactory->createMapgen(i, ¶ms, this);
216 m_mapgens.push_back(mg);
221 Mapgen *EmergeManager::getCurrentMapgen()
223 for (u32 i = 0; i != m_threads.size(); i++) {
224 if (m_threads[i]->isCurrentThread())
225 return m_threads[i]->m_mapgen;
232 void EmergeManager::startThreads()
234 if (m_threads_active)
237 for (u32 i = 0; i != m_threads.size(); i++)
238 m_threads[i]->start();
240 m_threads_active = true;
244 void EmergeManager::stopThreads()
246 if (!m_threads_active)
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();
255 // Then do the waiting for each
256 for (u32 i = 0; i != m_threads.size(); i++)
257 m_threads[i]->wait();
259 m_threads_active = false;
263 bool EmergeManager::isRunning()
265 return m_threads_active;
269 bool EmergeManager::enqueueBlockEmerge(
273 bool ignore_queue_limits)
277 flags |= BLOCK_EMERGE_ALLOW_GEN;
278 if (ignore_queue_limits)
279 flags |= BLOCK_EMERGE_FORCE_QUEUE;
281 return enqueueBlockEmergeEx(blockpos, peer_id, flags, NULL, NULL);
285 bool EmergeManager::enqueueBlockEmergeEx(
289 EmergeCompletionCallback callback,
290 void *callback_param)
292 EmergeThread *thread = NULL;
293 bool entry_already_exists = false;
296 MutexAutoLock queuelock(m_queue_mutex);
298 if (!pushBlockEmergeData(blockpos, peer_id, flags,
299 callback, callback_param, &entry_already_exists))
302 if (entry_already_exists)
305 thread = getOptimalThread();
306 thread->pushBlock(blockpos);
316 // Mapgen-related helper functions
319 v3s16 EmergeManager::getContainingChunk(v3s16 blockpos)
321 return getContainingChunk(blockpos, params.chunksize);
325 v3s16 EmergeManager::getContainingChunk(v3s16 blockpos, s16 chunksize)
327 s16 coff = -chunksize / 2;
328 v3s16 chunk_offset(coff, coff, coff);
330 return getContainerPos(blockpos - chunk_offset, chunksize)
331 * chunksize + chunk_offset;
335 int EmergeManager::getSpawnLevelAtPoint(v2s16 p)
337 if (m_mapgens.size() == 0 || !m_mapgens[0]) {
338 errorstream << "EmergeManager: getSpawnLevelAtPoint() called"
339 " before mapgen init" << std::endl;
343 return m_mapgens[0]->getSpawnLevelAtPoint(p);
347 int EmergeManager::getGroundLevelAtPoint(v2s16 p)
349 if (m_mapgens.size() == 0 || !m_mapgens[0]) {
350 errorstream << "EmergeManager: getGroundLevelAtPoint() called"
351 " before mapgen init" << std::endl;
355 return m_mapgens[0]->getGroundLevelAtPoint(p);
359 bool EmergeManager::isBlockUnderground(v3s16 blockpos)
362 v2s16 p = v2s16((blockpos.X * MAP_BLOCKSIZE) + MAP_BLOCKSIZE / 2,
363 (blockpos.Y * MAP_BLOCKSIZE) + MAP_BLOCKSIZE / 2);
364 int ground_level = getGroundLevelAtPoint(p);
365 return blockpos.Y * (MAP_BLOCKSIZE + 1) <= min(water_level, ground_level);
368 // Use a simple heuristic; the above method is wildly inaccurate anyway.
369 return blockpos.Y * (MAP_BLOCKSIZE + 1) <= params.water_level;
373 void EmergeManager::getMapgenNames(
374 std::vector<const char *> *mgnames, bool include_hidden)
376 for (u32 i = 0; i != ARRLEN(g_reg_mapgens); i++) {
377 if (include_hidden || g_reg_mapgens[i].is_user_visible)
378 mgnames->push_back(g_reg_mapgens[i].name);
383 MapgenFactory *EmergeManager::getMapgenFactory(const std::string &mgname)
385 for (u32 i = 0; i != ARRLEN(g_reg_mapgens); i++) {
386 if (mgname == g_reg_mapgens[i].name)
387 return g_reg_mapgens[i].factory;
394 bool EmergeManager::pushBlockEmergeData(
398 EmergeCompletionCallback callback,
399 void *callback_param,
400 bool *entry_already_exists)
402 u16 &count_peer = m_peer_queue_count[peer_requested];
404 if ((flags & BLOCK_EMERGE_FORCE_QUEUE) == 0) {
405 if (m_blocks_enqueued.size() >= m_qlimit_total)
408 if (peer_requested != PEER_ID_INEXISTENT) {
409 u16 qlimit_peer = (flags & BLOCK_EMERGE_ALLOW_GEN) ?
410 m_qlimit_generate : m_qlimit_diskonly;
411 if (count_peer >= qlimit_peer)
416 std::pair<std::map<v3s16, BlockEmergeData>::iterator, bool> findres;
417 findres = m_blocks_enqueued.insert(std::make_pair(pos, BlockEmergeData()));
419 BlockEmergeData &bedata = findres.first->second;
420 *entry_already_exists = !findres.second;
423 bedata.callbacks.push_back(std::make_pair(callback, callback_param));
425 if (*entry_already_exists) {
426 bedata.flags |= flags;
428 bedata.flags = flags;
429 bedata.peer_requested = peer_requested;
438 bool EmergeManager::popBlockEmergeData(
440 BlockEmergeData *bedata)
442 std::map<v3s16, BlockEmergeData>::iterator it;
443 std::map<u16, u16>::iterator it2;
445 it = m_blocks_enqueued.find(pos);
446 if (it == m_blocks_enqueued.end())
449 *bedata = it->second;
451 it2 = m_peer_queue_count.find(bedata->peer_requested);
452 if (it2 == m_peer_queue_count.end())
455 u16 &count_peer = it2->second;
456 assert(count_peer != 0);
459 m_blocks_enqueued.erase(it);
465 EmergeThread *EmergeManager::getOptimalThread()
467 size_t nthreads = m_threads.size();
469 FATAL_ERROR_IF(nthreads == 0, "No emerge threads!");
472 size_t nitems_lowest = m_threads[0]->m_block_queue.size();
474 for (size_t i = 1; i < nthreads; i++) {
475 size_t nitems = m_threads[i]->m_block_queue.size();
476 if (nitems < nitems_lowest) {
478 nitems_lowest = nitems;
482 return m_threads[index];
490 EmergeThread::EmergeThread(Server *server, int ethreadid) :
491 enable_mapgen_debug_info(false),
498 m_name = "Emerge-" + itos(ethreadid);
502 EmergeThread::~EmergeThread()
504 //cancelPendingItems();
508 void EmergeThread::signal()
510 m_queue_event.signal();
514 bool EmergeThread::pushBlock(v3s16 pos)
516 m_block_queue.push(pos);
521 void EmergeThread::cancelPendingItems()
523 MutexAutoLock queuelock(m_emerge->m_queue_mutex);
525 while (!m_block_queue.empty()) {
526 BlockEmergeData bedata;
529 pos = m_block_queue.front();
532 m_emerge->popBlockEmergeData(pos, &bedata);
534 runCompletionCallbacks(pos, EMERGE_CANCELLED, bedata.callbacks);
539 void EmergeThread::runCompletionCallbacks(
542 const EmergeCallbackList &callbacks)
544 for (size_t i = 0; i != callbacks.size(); i++) {
545 EmergeCompletionCallback callback;
548 callback = callbacks[i].first;
549 param = callbacks[i].second;
551 callback(pos, action, param);
556 bool EmergeThread::popBlockEmerge(v3s16 *pos, BlockEmergeData *bedata)
558 MutexAutoLock queuelock(m_emerge->m_queue_mutex);
560 if (m_block_queue.empty())
563 *pos = m_block_queue.front();
566 m_emerge->popBlockEmergeData(*pos, bedata);
572 EmergeAction EmergeThread::getBlockOrStartGen(
573 v3s16 pos, bool allow_gen, MapBlock **block, BlockMakeData *bmdata)
575 MutexAutoLock envlock(m_server->m_env_mutex);
577 // 1). Attempt to fetch block from memory
578 *block = m_map->getBlockNoCreateNoEx(pos);
579 if (*block && !(*block)->isDummy() && (*block)->isGenerated())
580 return EMERGE_FROM_MEMORY;
582 // 2). Attempt to load block from disk
583 *block = m_map->loadBlock(pos);
584 if (*block && (*block)->isGenerated())
585 return EMERGE_FROM_DISK;
587 // 3). Attempt to start generation
588 if (allow_gen && m_map->initBlockMake(pos, bmdata))
589 return EMERGE_GENERATED;
591 // All attempts failed; cancel this block emerge
592 return EMERGE_CANCELLED;
596 MapBlock *EmergeThread::finishGen(v3s16 pos, BlockMakeData *bmdata,
597 std::map<v3s16, MapBlock *> *modified_blocks)
599 MutexAutoLock envlock(m_server->m_env_mutex);
600 ScopeProfiler sp(g_profiler,
601 "EmergeThread: after Mapgen::makeChunk", SPT_AVG);
604 Perform post-processing on blocks (invalidate lighting, queue liquid
605 transforms, etc.) to finish block make
607 m_map->finishBlockMake(bmdata, modified_blocks);
609 MapBlock *block = m_map->getBlockNoCreateNoEx(pos);
611 errorstream << "EmergeThread::finishGen: Couldn't grab block we "
612 "just generated: " << PP(pos) << std::endl;
616 v3s16 minp = bmdata->blockpos_min * MAP_BLOCKSIZE;
617 v3s16 maxp = bmdata->blockpos_max * MAP_BLOCKSIZE +
618 v3s16(1,1,1) * (MAP_BLOCKSIZE - 1);
620 // Ignore map edit events, they will not need to be sent
621 // to anybody because the block hasn't been sent to anybody
622 MapEditEventAreaIgnorer ign(
623 &m_server->m_ignore_map_edit_events_area,
624 VoxelArea(minp, maxp));
627 Run Lua on_generated callbacks
630 m_server->getScriptIface()->environment_OnGenerated(
631 minp, maxp, m_mapgen->blockseed);
632 } catch (LuaError &e) {
633 m_server->setAsyncFatalError("Lua: " + std::string(e.what()));
636 EMERGE_DBG_OUT("ended up with: " << analyze_block(block));
641 m_server->m_env->activateBlock(block, 0);
647 void *EmergeThread::run()
649 DSTACK(FUNCTION_NAME);
650 BEGIN_DEBUG_EXCEPTION_HANDLER
654 m_map = (ServerMap *)&(m_server->m_env->getMap());
655 m_emerge = m_server->m_emerge;
656 m_mapgen = m_emerge->m_mapgens[id];
657 enable_mapgen_debug_info = m_emerge->enable_mapgen_debug_info;
660 while (!stopRequested()) {
661 std::map<v3s16, MapBlock *> modified_blocks;
662 BlockEmergeData bedata;
663 BlockMakeData bmdata;
667 if (!popBlockEmerge(&pos, &bedata)) {
668 m_queue_event.wait();
672 if (blockpos_over_limit(pos))
675 bool allow_gen = bedata.flags & BLOCK_EMERGE_ALLOW_GEN;
676 EMERGE_DBG_OUT("pos=" PP(pos) " allow_gen=" << allow_gen);
678 action = getBlockOrStartGen(pos, allow_gen, &block, &bmdata);
679 if (action == EMERGE_GENERATED) {
681 ScopeProfiler sp(g_profiler,
682 "EmergeThread: Mapgen::makeChunk", SPT_AVG);
683 TimeTaker t("mapgen::make_block()");
685 m_mapgen->makeChunk(&bmdata);
687 if (enable_mapgen_debug_info == false)
688 t.stop(true); // Hide output
691 block = finishGen(pos, &bmdata, &modified_blocks);
694 runCompletionCallbacks(pos, action, bedata.callbacks);
697 modified_blocks[pos] = block;
699 if (modified_blocks.size() > 0)
700 m_server->SetBlocksNotSent(modified_blocks);
702 } catch (VersionMismatchException &e) {
703 std::ostringstream err;
704 err << "World data version mismatch in MapBlock " << PP(pos) << std::endl
705 << "----" << std::endl
706 << "\"" << e.what() << "\"" << std::endl
707 << "See debug.txt." << std::endl
708 << "World probably saved by a newer version of " PROJECT_NAME_C "."
710 m_server->setAsyncFatalError(err.str());
711 } catch (SerializationError &e) {
712 std::ostringstream err;
713 err << "Invalid data in MapBlock " << PP(pos) << std::endl
714 << "----" << std::endl
715 << "\"" << e.what() << "\"" << std::endl
716 << "See debug.txt." << std::endl
717 << "You can ignore this using [ignore_world_load_errors = true]."
719 m_server->setAsyncFatalError(err.str());
722 END_DEBUG_EXCEPTION_HANDLER