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->getU32("emergequeue_limit_total");
169 // FIXME: these fallback values are probably not good
170 if (!g_settings->getU32NoEx("emergequeue_limit_diskonly", m_qlimit_diskonly))
171 m_qlimit_diskonly = nthreads * 5 + 1;
172 if (!g_settings->getU32NoEx("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 m_qlimit_total = rangelim(m_qlimit_total, 1, 1000000);
177 m_qlimit_diskonly = rangelim(m_qlimit_diskonly, 1, 1000000);
178 m_qlimit_generate = rangelim(m_qlimit_generate, 1, 1000000);
180 for (s16 i = 0; i < nthreads; i++)
181 m_threads.push_back(new EmergeThread(server, i));
183 infostream << "EmergeManager: using " << nthreads << " threads" << std::endl;
187 EmergeManager::~EmergeManager()
189 for (u32 i = 0; i != m_threads.size(); i++) {
190 EmergeThread *thread = m_threads[i];
192 if (m_threads_active) {
200 // Mapgen init might not be finished if there is an error during startup.
201 if (m_mapgens.size() > i)
213 BiomeManager *EmergeManager::getWritableBiomeManager()
215 FATAL_ERROR_IF(!m_mapgens.empty(),
216 "Writable managers can only be returned before mapgen init");
220 OreManager *EmergeManager::getWritableOreManager()
222 FATAL_ERROR_IF(!m_mapgens.empty(),
223 "Writable managers can only be returned before mapgen init");
227 DecorationManager *EmergeManager::getWritableDecorationManager()
229 FATAL_ERROR_IF(!m_mapgens.empty(),
230 "Writable managers can only be returned before mapgen init");
234 SchematicManager *EmergeManager::getWritableSchematicManager()
236 FATAL_ERROR_IF(!m_mapgens.empty(),
237 "Writable managers can only be returned before mapgen init");
242 void EmergeManager::initMapgens(MapgenParams *params)
244 FATAL_ERROR_IF(!m_mapgens.empty(), "Mapgen already initialised.");
248 v3s16 csize = v3s16(1, 1, 1) * (params->chunksize * MAP_BLOCKSIZE);
249 biomegen = biomemgr->createBiomeGen(BIOMEGEN_ORIGINAL, params->bparams, csize);
251 for (u32 i = 0; i != m_threads.size(); i++) {
252 EmergeParams *p = new EmergeParams(this, biomegen,
253 biomemgr, oremgr, decomgr, schemmgr);
254 infostream << "EmergeManager: Created params " << p
255 << " for thread " << i << std::endl;
256 m_mapgens.push_back(Mapgen::createMapgen(params->mgtype, params, p));
261 Mapgen *EmergeManager::getCurrentMapgen()
263 if (!m_threads_active)
266 for (u32 i = 0; i != m_threads.size(); i++) {
267 EmergeThread *t = m_threads[i];
268 if (t->isRunning() && t->isCurrentThread())
276 void EmergeManager::startThreads()
278 if (m_threads_active)
281 for (u32 i = 0; i != m_threads.size(); i++)
282 m_threads[i]->start();
284 m_threads_active = true;
288 void EmergeManager::stopThreads()
290 if (!m_threads_active)
293 // Request thread stop in parallel
294 for (u32 i = 0; i != m_threads.size(); i++) {
295 m_threads[i]->stop();
296 m_threads[i]->signal();
299 // Then do the waiting for each
300 for (u32 i = 0; i != m_threads.size(); i++)
301 m_threads[i]->wait();
303 m_threads_active = false;
307 bool EmergeManager::isRunning()
309 return m_threads_active;
313 bool EmergeManager::enqueueBlockEmerge(
317 bool ignore_queue_limits)
321 flags |= BLOCK_EMERGE_ALLOW_GEN;
322 if (ignore_queue_limits)
323 flags |= BLOCK_EMERGE_FORCE_QUEUE;
325 return enqueueBlockEmergeEx(blockpos, peer_id, flags, NULL, NULL);
329 bool EmergeManager::enqueueBlockEmergeEx(
333 EmergeCompletionCallback callback,
334 void *callback_param)
336 EmergeThread *thread = NULL;
337 bool entry_already_exists = false;
340 MutexAutoLock queuelock(m_queue_mutex);
342 if (!pushBlockEmergeData(blockpos, peer_id, flags,
343 callback, callback_param, &entry_already_exists))
346 if (entry_already_exists)
349 thread = getOptimalThread();
350 thread->pushBlock(blockpos);
359 bool EmergeManager::isBlockInQueue(v3s16 pos)
361 MutexAutoLock queuelock(m_queue_mutex);
362 return m_blocks_enqueued.find(pos) != m_blocks_enqueued.end();
367 // Mapgen-related helper functions
371 // TODO(hmmmm): Move this to ServerMap
372 v3s16 EmergeManager::getContainingChunk(v3s16 blockpos, s16 chunksize)
374 s16 coff = -chunksize / 2;
375 v3s16 chunk_offset(coff, coff, coff);
377 return getContainerPos(blockpos - chunk_offset, chunksize)
378 * chunksize + chunk_offset;
382 int EmergeManager::getSpawnLevelAtPoint(v2s16 p)
384 if (m_mapgens.empty() || !m_mapgens[0]) {
385 errorstream << "EmergeManager: getSpawnLevelAtPoint() called"
386 " before mapgen init" << std::endl;
390 return m_mapgens[0]->getSpawnLevelAtPoint(p);
394 // TODO(hmmmm): Move this to ServerMap
395 bool EmergeManager::isBlockUnderground(v3s16 blockpos)
397 // Use a simple heuristic
398 return blockpos.Y * (MAP_BLOCKSIZE + 1) <= mgparams->water_level;
401 bool EmergeManager::pushBlockEmergeData(
405 EmergeCompletionCallback callback,
406 void *callback_param,
407 bool *entry_already_exists)
409 u32 &count_peer = m_peer_queue_count[peer_requested];
411 if ((flags & BLOCK_EMERGE_FORCE_QUEUE) == 0) {
412 if (m_blocks_enqueued.size() >= m_qlimit_total)
415 if (peer_requested != PEER_ID_INEXISTENT) {
416 u32 qlimit_peer = (flags & BLOCK_EMERGE_ALLOW_GEN) ?
417 m_qlimit_generate : m_qlimit_diskonly;
418 if (count_peer >= qlimit_peer)
421 // limit block enqueue requests for active blocks to 1/2 of total
422 if (count_peer * 2 >= m_qlimit_total)
427 std::pair<std::map<v3s16, BlockEmergeData>::iterator, bool> findres;
428 findres = m_blocks_enqueued.insert(std::make_pair(pos, BlockEmergeData()));
430 BlockEmergeData &bedata = findres.first->second;
431 *entry_already_exists = !findres.second;
434 bedata.callbacks.emplace_back(callback, callback_param);
436 if (*entry_already_exists) {
437 bedata.flags |= flags;
439 bedata.flags = flags;
440 bedata.peer_requested = peer_requested;
449 bool EmergeManager::popBlockEmergeData(v3s16 pos, BlockEmergeData *bedata)
451 auto it = m_blocks_enqueued.find(pos);
452 if (it == m_blocks_enqueued.end())
455 *bedata = it->second;
457 auto it2 = m_peer_queue_count.find(bedata->peer_requested);
458 if (it2 == m_peer_queue_count.end())
461 u32 &count_peer = it2->second;
463 assert(count_peer != 0);
466 m_blocks_enqueued.erase(it);
472 EmergeThread *EmergeManager::getOptimalThread()
474 size_t nthreads = m_threads.size();
476 FATAL_ERROR_IF(nthreads == 0, "No emerge threads!");
479 size_t nitems_lowest = m_threads[0]->m_block_queue.size();
481 for (size_t i = 1; i < nthreads; i++) {
482 size_t nitems = m_threads[i]->m_block_queue.size();
483 if (nitems < nitems_lowest) {
485 nitems_lowest = nitems;
489 return m_threads[index];
497 EmergeThread::EmergeThread(Server *server, int ethreadid) :
498 enable_mapgen_debug_info(false),
505 m_name = "Emerge-" + itos(ethreadid);
509 void EmergeThread::signal()
511 m_queue_event.signal();
515 bool EmergeThread::pushBlock(const v3s16 &pos)
517 m_block_queue.push(pos);
522 void EmergeThread::cancelPendingItems()
524 MutexAutoLock queuelock(m_emerge->m_queue_mutex);
526 while (!m_block_queue.empty()) {
527 BlockEmergeData bedata;
530 pos = m_block_queue.front();
533 m_emerge->popBlockEmergeData(pos, &bedata);
535 runCompletionCallbacks(pos, EMERGE_CANCELLED, bedata.callbacks);
540 void EmergeThread::runCompletionCallbacks(const v3s16 &pos, EmergeAction action,
541 const EmergeCallbackList &callbacks)
543 for (size_t i = 0; i != callbacks.size(); i++) {
544 EmergeCompletionCallback callback;
547 callback = callbacks[i].first;
548 param = callbacks[i].second;
550 callback(pos, action, param);
555 bool EmergeThread::popBlockEmerge(v3s16 *pos, BlockEmergeData *bedata)
557 MutexAutoLock queuelock(m_emerge->m_queue_mutex);
559 if (m_block_queue.empty())
562 *pos = m_block_queue.front();
565 m_emerge->popBlockEmergeData(*pos, bedata);
571 EmergeAction EmergeThread::getBlockOrStartGen(
572 const v3s16 &pos, bool allow_gen, MapBlock **block, BlockMakeData *bmdata)
574 MutexAutoLock envlock(m_server->m_env_mutex);
576 // 1). Attempt to fetch block from memory
577 *block = m_map->getBlockNoCreateNoEx(pos);
578 if (*block && !(*block)->isDummy()) {
579 if ((*block)->isGenerated())
580 return EMERGE_FROM_MEMORY;
582 // 2). Attempt to load block from disk if it was not in the memory
583 *block = m_map->loadBlock(pos);
584 if (*block && (*block)->isGenerated())
585 return EMERGE_FROM_DISK;
588 // 3). Attempt to start generation
589 if (allow_gen && m_map->initBlockMake(pos, bmdata))
590 return EMERGE_GENERATED;
592 // All attempts failed; cancel this block emerge
593 return EMERGE_CANCELLED;
597 MapBlock *EmergeThread::finishGen(v3s16 pos, BlockMakeData *bmdata,
598 std::map<v3s16, MapBlock *> *modified_blocks)
600 MutexAutoLock envlock(m_server->m_env_mutex);
601 ScopeProfiler sp(g_profiler,
602 "EmergeThread: after Mapgen::makeChunk", SPT_AVG);
605 Perform post-processing on blocks (invalidate lighting, queue liquid
606 transforms, etc.) to finish block make
608 m_map->finishBlockMake(bmdata, modified_blocks);
610 MapBlock *block = m_map->getBlockNoCreateNoEx(pos);
612 errorstream << "EmergeThread::finishGen: Couldn't grab block we "
613 "just generated: " << PP(pos) << std::endl;
617 v3s16 minp = bmdata->blockpos_min * MAP_BLOCKSIZE;
618 v3s16 maxp = bmdata->blockpos_max * MAP_BLOCKSIZE +
619 v3s16(1,1,1) * (MAP_BLOCKSIZE - 1);
621 // Ignore map edit events, they will not need to be sent
622 // to anybody because the block hasn't been sent to anybody
623 MapEditEventAreaIgnorer ign(
624 &m_server->m_ignore_map_edit_events_area,
625 VoxelArea(minp, maxp));
628 Run Lua on_generated callbacks
631 m_server->getScriptIface()->environment_OnGenerated(
632 minp, maxp, m_mapgen->blockseed);
633 } catch (LuaError &e) {
634 m_server->setAsyncFatalError(e);
637 EMERGE_DBG_OUT("ended up with: " << analyze_block(block));
642 assert(!m_mapgen->generating);
643 m_mapgen->gennotify.clearEvents();
644 m_mapgen->vm = nullptr;
649 m_server->m_env->activateBlock(block, 0);
655 void *EmergeThread::run()
657 BEGIN_DEBUG_EXCEPTION_HANDLER
660 std::map<v3s16, MapBlock *> modified_blocks;
662 m_map = &m_server->m_env->getServerMap();
663 m_emerge = m_server->m_emerge;
664 m_mapgen = m_emerge->m_mapgens[id];
665 enable_mapgen_debug_info = m_emerge->enable_mapgen_debug_info;
668 while (!stopRequested()) {
669 BlockEmergeData bedata;
670 BlockMakeData bmdata;
672 MapBlock *block = nullptr;
674 if (!popBlockEmerge(&pos, &bedata)) {
675 m_queue_event.wait();
679 if (blockpos_over_max_limit(pos))
682 bool allow_gen = bedata.flags & BLOCK_EMERGE_ALLOW_GEN;
683 EMERGE_DBG_OUT("pos=" PP(pos) " allow_gen=" << allow_gen);
685 action = getBlockOrStartGen(pos, allow_gen, &block, &bmdata);
686 if (action == EMERGE_GENERATED) {
688 ScopeProfiler sp(g_profiler,
689 "EmergeThread: Mapgen::makeChunk", SPT_AVG);
691 m_mapgen->makeChunk(&bmdata);
694 block = finishGen(pos, &bmdata, &modified_blocks);
696 action = EMERGE_ERRORED;
699 runCompletionCallbacks(pos, action, bedata.callbacks);
702 modified_blocks[pos] = block;
704 if (!modified_blocks.empty())
705 m_server->SetBlocksNotSent(modified_blocks);
706 modified_blocks.clear();
708 } catch (VersionMismatchException &e) {
709 std::ostringstream err;
710 err << "World data version mismatch in MapBlock " << PP(pos) << std::endl
711 << "----" << std::endl
712 << "\"" << e.what() << "\"" << std::endl
713 << "See debug.txt." << std::endl
714 << "World probably saved by a newer version of " PROJECT_NAME_C "."
716 m_server->setAsyncFatalError(err.str());
717 } catch (SerializationError &e) {
718 std::ostringstream err;
719 err << "Invalid data in MapBlock " << PP(pos) << std::endl
720 << "----" << std::endl
721 << "\"" << e.what() << "\"" << std::endl
722 << "See debug.txt." << std::endl
723 << "You can ignore this using [ignore_world_load_errors = true]."
725 m_server->setAsyncFatalError(err.str());
728 cancelPendingItems();
730 END_DEBUG_EXCEPTION_HANDLER