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/mg_biome.h"
38 #include "mapgen/mg_ore.h"
39 #include "mapgen/mg_decoration.h"
40 #include "mapgen/mg_schematic.h"
43 #include "scripting_server.h"
48 class EmergeThread : public Thread {
50 bool enable_mapgen_debug_info;
53 EmergeThread(Server *server, int ethreadid);
54 ~EmergeThread() = default;
59 // Requires queue mutex held
60 bool pushBlock(const v3s16 &pos);
62 void cancelPendingItems();
64 static void runCompletionCallbacks(
65 const v3s16 &pos, EmergeAction action,
66 const EmergeCallbackList &callbacks);
71 EmergeManager *m_emerge;
75 std::queue<v3s16> m_block_queue;
77 bool popBlockEmerge(v3s16 *pos, BlockEmergeData *bedata);
79 EmergeAction getBlockOrStartGen(
80 const v3s16 &pos, bool allow_gen, MapBlock **block, BlockMakeData *data);
81 MapBlock *finishGen(v3s16 pos, BlockMakeData *bmdata,
82 std::map<v3s16, MapBlock *> *modified_blocks);
84 friend class EmergeManager;
87 class MapEditEventAreaIgnorer
90 MapEditEventAreaIgnorer(VoxelArea *ignorevariable, const VoxelArea &a):
91 m_ignorevariable(ignorevariable)
93 if(m_ignorevariable->getVolume() == 0)
94 *m_ignorevariable = a;
96 m_ignorevariable = NULL;
99 ~MapEditEventAreaIgnorer()
103 assert(m_ignorevariable->getVolume() != 0);
104 *m_ignorevariable = VoxelArea();
109 VoxelArea *m_ignorevariable;
112 EmergeParams::~EmergeParams()
114 infostream << "EmergeParams: destroying " << this << std::endl;
115 // Delete everything that was cloned on creation of EmergeParams
123 EmergeParams::EmergeParams(EmergeManager *parent, const BiomeGen *biomegen,
124 const BiomeManager *biomemgr,
125 const OreManager *oremgr, const DecorationManager *decomgr,
126 const SchematicManager *schemmgr) :
128 enable_mapgen_debug_info(parent->enable_mapgen_debug_info),
129 gen_notify_on(parent->gen_notify_on),
130 gen_notify_on_deco_ids(&parent->gen_notify_on_deco_ids),
131 biomemgr(biomemgr->clone()), oremgr(oremgr->clone()),
132 decomgr(decomgr->clone()), schemmgr(schemmgr->clone())
134 this->biomegen = biomegen->clone(this->biomemgr);
141 EmergeManager::EmergeManager(Server *server)
143 this->ndef = server->getNodeDefManager();
144 this->biomemgr = new BiomeManager(server);
145 this->oremgr = new OreManager(server);
146 this->decomgr = new DecorationManager(server);
147 this->schemmgr = new SchematicManager(server);
150 this->mgparams = nullptr;
151 this->biomegen = nullptr;
153 // Note that accesses to this variable are not synchronized.
154 // This is because the *only* thread ever starting or stopping
155 // EmergeThreads should be the ServerThread.
157 enable_mapgen_debug_info = g_settings->getBool("enable_mapgen_debug_info");
160 g_settings->getS16NoEx("num_emerge_threads", nthreads);
161 // If automatic, leave a proc for the main thread and one for
162 // some other misc thread
164 nthreads = Thread::getNumberOfProcessors() - 2;
168 m_qlimit_total = g_settings->getU16("emergequeue_limit_total");
169 // FIXME: these fallback values are probably not good
170 if (!g_settings->getU16NoEx("emergequeue_limit_diskonly", m_qlimit_diskonly))
171 m_qlimit_diskonly = nthreads * 5 + 1;
172 if (!g_settings->getU16NoEx("emergequeue_limit_generate", m_qlimit_generate))
173 m_qlimit_generate = nthreads + 1;
175 // don't trust user input for something very important like this
176 if (m_qlimit_total < 1)
178 if (m_qlimit_diskonly < 1)
179 m_qlimit_diskonly = 1;
180 if (m_qlimit_generate < 1)
181 m_qlimit_generate = 1;
183 for (s16 i = 0; i < nthreads; i++)
184 m_threads.push_back(new EmergeThread(server, i));
186 infostream << "EmergeManager: using " << nthreads << " threads" << std::endl;
190 EmergeManager::~EmergeManager()
192 for (u32 i = 0; i != m_threads.size(); i++) {
193 EmergeThread *thread = m_threads[i];
195 if (m_threads_active) {
203 // Mapgen init might not be finished if there is an error during startup.
204 if (m_mapgens.size() > i)
215 BiomeManager *EmergeManager::getWritableBiomeManager()
217 FATAL_ERROR_IF(!m_mapgens.empty(),
218 "Writable managers can only be returned before mapgen init");
222 OreManager *EmergeManager::getWritableOreManager()
224 FATAL_ERROR_IF(!m_mapgens.empty(),
225 "Writable managers can only be returned before mapgen init");
229 DecorationManager *EmergeManager::getWritableDecorationManager()
231 FATAL_ERROR_IF(!m_mapgens.empty(),
232 "Writable managers can only be returned before mapgen init");
236 SchematicManager *EmergeManager::getWritableSchematicManager()
238 FATAL_ERROR_IF(!m_mapgens.empty(),
239 "Writable managers can only be returned before mapgen init");
244 void EmergeManager::initMapgens(MapgenParams *params)
246 FATAL_ERROR_IF(!m_mapgens.empty(), "Mapgen already initialised.");
250 v3s16 csize = v3s16(1, 1, 1) * (params->chunksize * MAP_BLOCKSIZE);
251 biomegen = biomemgr->createBiomeGen(BIOMEGEN_ORIGINAL, params->bparams, csize);
253 for (u32 i = 0; i != m_threads.size(); i++) {
254 EmergeParams *p = new EmergeParams(this, biomegen,
255 biomemgr, oremgr, decomgr, schemmgr);
256 infostream << "EmergeManager: Created params " << p
257 << " for thread " << i << std::endl;
258 m_mapgens.push_back(Mapgen::createMapgen(params->mgtype, params, p));
263 Mapgen *EmergeManager::getCurrentMapgen()
265 if (!m_threads_active)
268 for (u32 i = 0; i != m_threads.size(); i++) {
269 EmergeThread *t = m_threads[i];
270 if (t->isRunning() && t->isCurrentThread())
278 void EmergeManager::startThreads()
280 if (m_threads_active)
283 for (u32 i = 0; i != m_threads.size(); i++)
284 m_threads[i]->start();
286 m_threads_active = true;
290 void EmergeManager::stopThreads()
292 if (!m_threads_active)
295 // Request thread stop in parallel
296 for (u32 i = 0; i != m_threads.size(); i++) {
297 m_threads[i]->stop();
298 m_threads[i]->signal();
301 // Then do the waiting for each
302 for (u32 i = 0; i != m_threads.size(); i++)
303 m_threads[i]->wait();
305 m_threads_active = false;
309 bool EmergeManager::isRunning()
311 return m_threads_active;
315 bool EmergeManager::enqueueBlockEmerge(
319 bool ignore_queue_limits)
323 flags |= BLOCK_EMERGE_ALLOW_GEN;
324 if (ignore_queue_limits)
325 flags |= BLOCK_EMERGE_FORCE_QUEUE;
327 return enqueueBlockEmergeEx(blockpos, peer_id, flags, NULL, NULL);
331 bool EmergeManager::enqueueBlockEmergeEx(
335 EmergeCompletionCallback callback,
336 void *callback_param)
338 EmergeThread *thread = NULL;
339 bool entry_already_exists = false;
342 MutexAutoLock queuelock(m_queue_mutex);
344 if (!pushBlockEmergeData(blockpos, peer_id, flags,
345 callback, callback_param, &entry_already_exists))
348 if (entry_already_exists)
351 thread = getOptimalThread();
352 thread->pushBlock(blockpos);
361 bool EmergeManager::isBlockInQueue(v3s16 pos)
363 MutexAutoLock queuelock(m_queue_mutex);
364 return m_blocks_enqueued.find(pos) != m_blocks_enqueued.end();
369 // Mapgen-related helper functions
373 // TODO(hmmmm): Move this to ServerMap
374 v3s16 EmergeManager::getContainingChunk(v3s16 blockpos)
376 return getContainingChunk(blockpos, mgparams->chunksize);
379 // TODO(hmmmm): Move this to ServerMap
380 v3s16 EmergeManager::getContainingChunk(v3s16 blockpos, s16 chunksize)
382 s16 coff = -chunksize / 2;
383 v3s16 chunk_offset(coff, coff, coff);
385 return getContainerPos(blockpos - chunk_offset, chunksize)
386 * chunksize + chunk_offset;
390 int EmergeManager::getSpawnLevelAtPoint(v2s16 p)
392 if (m_mapgens.empty() || !m_mapgens[0]) {
393 errorstream << "EmergeManager: getSpawnLevelAtPoint() called"
394 " before mapgen init" << std::endl;
398 return m_mapgens[0]->getSpawnLevelAtPoint(p);
402 int EmergeManager::getGroundLevelAtPoint(v2s16 p)
404 if (m_mapgens.empty() || !m_mapgens[0]) {
405 errorstream << "EmergeManager: getGroundLevelAtPoint() called"
406 " before mapgen init" << std::endl;
410 return m_mapgens[0]->getGroundLevelAtPoint(p);
413 // TODO(hmmmm): Move this to ServerMap
414 bool EmergeManager::isBlockUnderground(v3s16 blockpos)
416 // Use a simple heuristic
417 return blockpos.Y * (MAP_BLOCKSIZE + 1) <= mgparams->water_level;
420 bool EmergeManager::pushBlockEmergeData(
424 EmergeCompletionCallback callback,
425 void *callback_param,
426 bool *entry_already_exists)
428 u16 &count_peer = m_peer_queue_count[peer_requested];
430 if ((flags & BLOCK_EMERGE_FORCE_QUEUE) == 0) {
431 if (m_blocks_enqueued.size() >= m_qlimit_total)
434 if (peer_requested != PEER_ID_INEXISTENT) {
435 u16 qlimit_peer = (flags & BLOCK_EMERGE_ALLOW_GEN) ?
436 m_qlimit_generate : m_qlimit_diskonly;
437 if (count_peer >= qlimit_peer)
440 // limit block enqueue requests for active blocks to 1/2 of total
441 if (count_peer * 2 >= m_qlimit_total)
446 std::pair<std::map<v3s16, BlockEmergeData>::iterator, bool> findres;
447 findres = m_blocks_enqueued.insert(std::make_pair(pos, BlockEmergeData()));
449 BlockEmergeData &bedata = findres.first->second;
450 *entry_already_exists = !findres.second;
453 bedata.callbacks.emplace_back(callback, callback_param);
455 if (*entry_already_exists) {
456 bedata.flags |= flags;
458 bedata.flags = flags;
459 bedata.peer_requested = peer_requested;
468 bool EmergeManager::popBlockEmergeData(v3s16 pos, BlockEmergeData *bedata)
470 std::map<v3s16, BlockEmergeData>::iterator it;
471 std::unordered_map<u16, u16>::iterator it2;
473 it = m_blocks_enqueued.find(pos);
474 if (it == m_blocks_enqueued.end())
477 *bedata = it->second;
479 it2 = m_peer_queue_count.find(bedata->peer_requested);
480 if (it2 == m_peer_queue_count.end())
483 u16 &count_peer = it2->second;
484 assert(count_peer != 0);
487 m_blocks_enqueued.erase(it);
493 EmergeThread *EmergeManager::getOptimalThread()
495 size_t nthreads = m_threads.size();
497 FATAL_ERROR_IF(nthreads == 0, "No emerge threads!");
500 size_t nitems_lowest = m_threads[0]->m_block_queue.size();
502 for (size_t i = 1; i < nthreads; i++) {
503 size_t nitems = m_threads[i]->m_block_queue.size();
504 if (nitems < nitems_lowest) {
506 nitems_lowest = nitems;
510 return m_threads[index];
518 EmergeThread::EmergeThread(Server *server, int ethreadid) :
519 enable_mapgen_debug_info(false),
526 m_name = "Emerge-" + itos(ethreadid);
530 void EmergeThread::signal()
532 m_queue_event.signal();
536 bool EmergeThread::pushBlock(const v3s16 &pos)
538 m_block_queue.push(pos);
543 void EmergeThread::cancelPendingItems()
545 MutexAutoLock queuelock(m_emerge->m_queue_mutex);
547 while (!m_block_queue.empty()) {
548 BlockEmergeData bedata;
551 pos = m_block_queue.front();
554 m_emerge->popBlockEmergeData(pos, &bedata);
556 runCompletionCallbacks(pos, EMERGE_CANCELLED, bedata.callbacks);
561 void EmergeThread::runCompletionCallbacks(const v3s16 &pos, EmergeAction action,
562 const EmergeCallbackList &callbacks)
564 for (size_t i = 0; i != callbacks.size(); i++) {
565 EmergeCompletionCallback callback;
568 callback = callbacks[i].first;
569 param = callbacks[i].second;
571 callback(pos, action, param);
576 bool EmergeThread::popBlockEmerge(v3s16 *pos, BlockEmergeData *bedata)
578 MutexAutoLock queuelock(m_emerge->m_queue_mutex);
580 if (m_block_queue.empty())
583 *pos = m_block_queue.front();
586 m_emerge->popBlockEmergeData(*pos, bedata);
592 EmergeAction EmergeThread::getBlockOrStartGen(
593 const v3s16 &pos, bool allow_gen, MapBlock **block, BlockMakeData *bmdata)
595 MutexAutoLock envlock(m_server->m_env_mutex);
597 // 1). Attempt to fetch block from memory
598 *block = m_map->getBlockNoCreateNoEx(pos);
599 if (*block && !(*block)->isDummy()) {
600 if ((*block)->isGenerated())
601 return EMERGE_FROM_MEMORY;
603 // 2). Attempt to load block from disk if it was not in the memory
604 *block = m_map->loadBlock(pos);
605 if (*block && (*block)->isGenerated())
606 return EMERGE_FROM_DISK;
609 // 3). Attempt to start generation
610 if (allow_gen && m_map->initBlockMake(pos, bmdata))
611 return EMERGE_GENERATED;
613 // All attempts failed; cancel this block emerge
614 return EMERGE_CANCELLED;
618 MapBlock *EmergeThread::finishGen(v3s16 pos, BlockMakeData *bmdata,
619 std::map<v3s16, MapBlock *> *modified_blocks)
621 MutexAutoLock envlock(m_server->m_env_mutex);
622 ScopeProfiler sp(g_profiler,
623 "EmergeThread: after Mapgen::makeChunk", SPT_AVG);
626 Perform post-processing on blocks (invalidate lighting, queue liquid
627 transforms, etc.) to finish block make
629 m_map->finishBlockMake(bmdata, modified_blocks);
631 MapBlock *block = m_map->getBlockNoCreateNoEx(pos);
633 errorstream << "EmergeThread::finishGen: Couldn't grab block we "
634 "just generated: " << PP(pos) << std::endl;
638 v3s16 minp = bmdata->blockpos_min * MAP_BLOCKSIZE;
639 v3s16 maxp = bmdata->blockpos_max * MAP_BLOCKSIZE +
640 v3s16(1,1,1) * (MAP_BLOCKSIZE - 1);
642 // Ignore map edit events, they will not need to be sent
643 // to anybody because the block hasn't been sent to anybody
644 MapEditEventAreaIgnorer ign(
645 &m_server->m_ignore_map_edit_events_area,
646 VoxelArea(minp, maxp));
649 Run Lua on_generated callbacks
652 m_server->getScriptIface()->environment_OnGenerated(
653 minp, maxp, m_mapgen->blockseed);
654 } catch (LuaError &e) {
655 m_server->setAsyncFatalError("Lua: finishGen" + std::string(e.what()));
659 Clear generate notifier events
661 m_mapgen->gennotify.clearEvents();
663 EMERGE_DBG_OUT("ended up with: " << analyze_block(block));
668 m_server->m_env->activateBlock(block, 0);
674 void *EmergeThread::run()
676 BEGIN_DEBUG_EXCEPTION_HANDLER
680 m_map = (ServerMap *)&(m_server->m_env->getMap());
681 m_emerge = m_server->m_emerge;
682 m_mapgen = m_emerge->m_mapgens[id];
683 enable_mapgen_debug_info = m_emerge->enable_mapgen_debug_info;
686 while (!stopRequested()) {
687 std::map<v3s16, MapBlock *> modified_blocks;
688 BlockEmergeData bedata;
689 BlockMakeData bmdata;
693 if (!popBlockEmerge(&pos, &bedata)) {
694 m_queue_event.wait();
698 if (blockpos_over_max_limit(pos))
701 bool allow_gen = bedata.flags & BLOCK_EMERGE_ALLOW_GEN;
702 EMERGE_DBG_OUT("pos=" PP(pos) " allow_gen=" << allow_gen);
704 action = getBlockOrStartGen(pos, allow_gen, &block, &bmdata);
705 if (action == EMERGE_GENERATED) {
707 ScopeProfiler sp(g_profiler,
708 "EmergeThread: Mapgen::makeChunk", SPT_AVG);
710 m_mapgen->makeChunk(&bmdata);
713 block = finishGen(pos, &bmdata, &modified_blocks);
716 runCompletionCallbacks(pos, action, bedata.callbacks);
719 modified_blocks[pos] = block;
721 if (!modified_blocks.empty())
722 m_server->SetBlocksNotSent(modified_blocks);
724 } catch (VersionMismatchException &e) {
725 std::ostringstream err;
726 err << "World data version mismatch in MapBlock " << PP(pos) << std::endl
727 << "----" << std::endl
728 << "\"" << e.what() << "\"" << std::endl
729 << "See debug.txt." << std::endl
730 << "World probably saved by a newer version of " PROJECT_NAME_C "."
732 m_server->setAsyncFatalError(err.str());
733 } catch (SerializationError &e) {
734 std::ostringstream err;
735 err << "Invalid data in MapBlock " << PP(pos) << std::endl
736 << "----" << std::endl
737 << "\"" << e.what() << "\"" << std::endl
738 << "See debug.txt." << std::endl
739 << "You can ignore this using [ignore_world_load_errors = true]."
741 m_server->setAsyncFatalError(err.str());
744 END_DEBUG_EXCEPTION_HANDLER