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();
66 void runCompletionCallbacks(
67 const v3s16 &pos, EmergeAction action,
68 const EmergeCallbackList &callbacks);
73 EmergeManager *m_emerge;
77 std::queue<v3s16> m_block_queue;
79 bool popBlockEmerge(v3s16 *pos, BlockEmergeData *bedata);
81 EmergeAction getBlockOrStartGen(
82 const v3s16 &pos, bool allow_gen, MapBlock **block, BlockMakeData *data);
83 MapBlock *finishGen(v3s16 pos, BlockMakeData *bmdata,
84 std::map<v3s16, MapBlock *> *modified_blocks);
86 friend class EmergeManager;
89 class MapEditEventAreaIgnorer
92 MapEditEventAreaIgnorer(VoxelArea *ignorevariable, const VoxelArea &a):
93 m_ignorevariable(ignorevariable)
95 if(m_ignorevariable->getVolume() == 0)
96 *m_ignorevariable = a;
98 m_ignorevariable = NULL;
101 ~MapEditEventAreaIgnorer()
105 assert(m_ignorevariable->getVolume() != 0);
106 *m_ignorevariable = VoxelArea();
111 VoxelArea *m_ignorevariable;
114 EmergeParams::~EmergeParams()
116 infostream << "EmergeParams: destroying " << this << std::endl;
117 // Delete everything that was cloned on creation of EmergeParams
125 EmergeParams::EmergeParams(EmergeManager *parent, const BiomeGen *biomegen,
126 const BiomeManager *biomemgr,
127 const OreManager *oremgr, const DecorationManager *decomgr,
128 const SchematicManager *schemmgr) :
130 enable_mapgen_debug_info(parent->enable_mapgen_debug_info),
131 gen_notify_on(parent->gen_notify_on),
132 gen_notify_on_deco_ids(&parent->gen_notify_on_deco_ids),
133 biomemgr(biomemgr->clone()), oremgr(oremgr->clone()),
134 decomgr(decomgr->clone()), schemmgr(schemmgr->clone())
136 this->biomegen = biomegen->clone(this->biomemgr);
143 EmergeManager::EmergeManager(Server *server, MetricsBackend *mb)
145 this->ndef = server->getNodeDefManager();
146 this->biomemgr = new BiomeManager(server);
147 this->oremgr = new OreManager(server);
148 this->decomgr = new DecorationManager(server);
149 this->schemmgr = new SchematicManager(server);
152 this->mgparams = nullptr;
153 this->biomegen = nullptr;
155 // Note that accesses to this variable are not synchronized.
156 // This is because the *only* thread ever starting or stopping
157 // EmergeThreads should be the ServerThread.
159 enable_mapgen_debug_info = g_settings->getBool("enable_mapgen_debug_info");
161 STATIC_ASSERT(ARRLEN(emergeActionStrs) == ARRLEN(m_completed_emerge_counter),
162 enum_size_mismatches);
163 for (u32 i = 0; i < ARRLEN(m_completed_emerge_counter); i++) {
164 std::string help_str("Number of completed emerges with status ");
165 help_str.append(emergeActionStrs[i]);
166 m_completed_emerge_counter[i] = mb->addCounter(
167 "minetest_emerge_completed", help_str,
168 {{"status", emergeActionStrs[i]}}
173 g_settings->getS16NoEx("num_emerge_threads", nthreads);
174 // If automatic, leave a proc for the main thread and one for
175 // some other misc thread
177 nthreads = Thread::getNumberOfProcessors() - 2;
181 m_qlimit_total = g_settings->getU32("emergequeue_limit_total");
182 // FIXME: these fallback values are probably not good
183 if (!g_settings->getU32NoEx("emergequeue_limit_diskonly", m_qlimit_diskonly))
184 m_qlimit_diskonly = nthreads * 5 + 1;
185 if (!g_settings->getU32NoEx("emergequeue_limit_generate", m_qlimit_generate))
186 m_qlimit_generate = nthreads + 1;
188 // don't trust user input for something very important like this
189 m_qlimit_total = rangelim(m_qlimit_total, 1, 1000000);
190 m_qlimit_diskonly = rangelim(m_qlimit_diskonly, 1, 1000000);
191 m_qlimit_generate = rangelim(m_qlimit_generate, 1, 1000000);
193 for (s16 i = 0; i < nthreads; i++)
194 m_threads.push_back(new EmergeThread(server, i));
196 infostream << "EmergeManager: using " << nthreads << " threads" << std::endl;
200 EmergeManager::~EmergeManager()
202 for (u32 i = 0; i != m_threads.size(); i++) {
203 EmergeThread *thread = m_threads[i];
205 if (m_threads_active) {
213 // Mapgen init might not be finished if there is an error during startup.
214 if (m_mapgens.size() > i)
226 BiomeManager *EmergeManager::getWritableBiomeManager()
228 FATAL_ERROR_IF(!m_mapgens.empty(),
229 "Writable managers can only be returned before mapgen init");
233 OreManager *EmergeManager::getWritableOreManager()
235 FATAL_ERROR_IF(!m_mapgens.empty(),
236 "Writable managers can only be returned before mapgen init");
240 DecorationManager *EmergeManager::getWritableDecorationManager()
242 FATAL_ERROR_IF(!m_mapgens.empty(),
243 "Writable managers can only be returned before mapgen init");
247 SchematicManager *EmergeManager::getWritableSchematicManager()
249 FATAL_ERROR_IF(!m_mapgens.empty(),
250 "Writable managers can only be returned before mapgen init");
255 void EmergeManager::initMapgens(MapgenParams *params)
257 FATAL_ERROR_IF(!m_mapgens.empty(), "Mapgen already initialised.");
261 v3s16 csize = v3s16(1, 1, 1) * (params->chunksize * MAP_BLOCKSIZE);
262 biomegen = biomemgr->createBiomeGen(BIOMEGEN_ORIGINAL, params->bparams, csize);
264 for (u32 i = 0; i != m_threads.size(); i++) {
265 EmergeParams *p = new EmergeParams(this, biomegen,
266 biomemgr, oremgr, decomgr, schemmgr);
267 infostream << "EmergeManager: Created params " << p
268 << " for thread " << i << std::endl;
269 m_mapgens.push_back(Mapgen::createMapgen(params->mgtype, params, p));
274 Mapgen *EmergeManager::getCurrentMapgen()
276 if (!m_threads_active)
279 for (u32 i = 0; i != m_threads.size(); i++) {
280 EmergeThread *t = m_threads[i];
281 if (t->isRunning() && t->isCurrentThread())
289 void EmergeManager::startThreads()
291 if (m_threads_active)
294 for (u32 i = 0; i != m_threads.size(); i++)
295 m_threads[i]->start();
297 m_threads_active = true;
301 void EmergeManager::stopThreads()
303 if (!m_threads_active)
306 // Request thread stop in parallel
307 for (u32 i = 0; i != m_threads.size(); i++) {
308 m_threads[i]->stop();
309 m_threads[i]->signal();
312 // Then do the waiting for each
313 for (u32 i = 0; i != m_threads.size(); i++)
314 m_threads[i]->wait();
316 m_threads_active = false;
320 bool EmergeManager::isRunning()
322 return m_threads_active;
326 bool EmergeManager::enqueueBlockEmerge(
330 bool ignore_queue_limits)
334 flags |= BLOCK_EMERGE_ALLOW_GEN;
335 if (ignore_queue_limits)
336 flags |= BLOCK_EMERGE_FORCE_QUEUE;
338 return enqueueBlockEmergeEx(blockpos, peer_id, flags, NULL, NULL);
342 bool EmergeManager::enqueueBlockEmergeEx(
346 EmergeCompletionCallback callback,
347 void *callback_param)
349 EmergeThread *thread = NULL;
350 bool entry_already_exists = false;
353 MutexAutoLock queuelock(m_queue_mutex);
355 if (!pushBlockEmergeData(blockpos, peer_id, flags,
356 callback, callback_param, &entry_already_exists))
359 if (entry_already_exists)
362 thread = getOptimalThread();
363 thread->pushBlock(blockpos);
372 bool EmergeManager::isBlockInQueue(v3s16 pos)
374 MutexAutoLock queuelock(m_queue_mutex);
375 return m_blocks_enqueued.find(pos) != m_blocks_enqueued.end();
380 // Mapgen-related helper functions
384 // TODO(hmmmm): Move this to ServerMap
385 v3s16 EmergeManager::getContainingChunk(v3s16 blockpos, s16 chunksize)
387 s16 coff = -chunksize / 2;
388 v3s16 chunk_offset(coff, coff, coff);
390 return getContainerPos(blockpos - chunk_offset, chunksize)
391 * chunksize + chunk_offset;
395 int EmergeManager::getSpawnLevelAtPoint(v2s16 p)
397 if (m_mapgens.empty() || !m_mapgens[0]) {
398 errorstream << "EmergeManager: getSpawnLevelAtPoint() called"
399 " before mapgen init" << std::endl;
403 return m_mapgens[0]->getSpawnLevelAtPoint(p);
407 // TODO(hmmmm): Move this to ServerMap
408 bool EmergeManager::isBlockUnderground(v3s16 blockpos)
410 // Use a simple heuristic
411 return blockpos.Y * (MAP_BLOCKSIZE + 1) <= mgparams->water_level;
414 bool EmergeManager::pushBlockEmergeData(
418 EmergeCompletionCallback callback,
419 void *callback_param,
420 bool *entry_already_exists)
422 u32 &count_peer = m_peer_queue_count[peer_requested];
424 if ((flags & BLOCK_EMERGE_FORCE_QUEUE) == 0) {
425 if (m_blocks_enqueued.size() >= m_qlimit_total)
428 if (peer_requested != PEER_ID_INEXISTENT) {
429 u32 qlimit_peer = (flags & BLOCK_EMERGE_ALLOW_GEN) ?
430 m_qlimit_generate : m_qlimit_diskonly;
431 if (count_peer >= qlimit_peer)
434 // limit block enqueue requests for active blocks to 1/2 of total
435 if (count_peer * 2 >= m_qlimit_total)
440 std::pair<std::map<v3s16, BlockEmergeData>::iterator, bool> findres;
441 findres = m_blocks_enqueued.insert(std::make_pair(pos, BlockEmergeData()));
443 BlockEmergeData &bedata = findres.first->second;
444 *entry_already_exists = !findres.second;
447 bedata.callbacks.emplace_back(callback, callback_param);
449 if (*entry_already_exists) {
450 bedata.flags |= flags;
452 bedata.flags = flags;
453 bedata.peer_requested = peer_requested;
462 bool EmergeManager::popBlockEmergeData(v3s16 pos, BlockEmergeData *bedata)
464 auto it = m_blocks_enqueued.find(pos);
465 if (it == m_blocks_enqueued.end())
468 *bedata = it->second;
470 auto it2 = m_peer_queue_count.find(bedata->peer_requested);
471 if (it2 == m_peer_queue_count.end())
474 u32 &count_peer = it2->second;
476 assert(count_peer != 0);
479 m_blocks_enqueued.erase(it);
485 EmergeThread *EmergeManager::getOptimalThread()
487 size_t nthreads = m_threads.size();
489 FATAL_ERROR_IF(nthreads == 0, "No emerge threads!");
492 size_t nitems_lowest = m_threads[0]->m_block_queue.size();
494 for (size_t i = 1; i < nthreads; i++) {
495 size_t nitems = m_threads[i]->m_block_queue.size();
496 if (nitems < nitems_lowest) {
498 nitems_lowest = nitems;
502 return m_threads[index];
505 void EmergeManager::reportCompletedEmerge(EmergeAction action)
507 assert((int)action < ARRLEN(m_completed_emerge_counter));
508 m_completed_emerge_counter[(int)action]->increment();
516 EmergeThread::EmergeThread(Server *server, int ethreadid) :
517 enable_mapgen_debug_info(false),
524 m_name = "Emerge-" + itos(ethreadid);
528 void EmergeThread::signal()
530 m_queue_event.signal();
534 bool EmergeThread::pushBlock(const v3s16 &pos)
536 m_block_queue.push(pos);
541 void EmergeThread::cancelPendingItems()
543 MutexAutoLock queuelock(m_emerge->m_queue_mutex);
545 while (!m_block_queue.empty()) {
546 BlockEmergeData bedata;
549 pos = m_block_queue.front();
552 m_emerge->popBlockEmergeData(pos, &bedata);
554 runCompletionCallbacks(pos, EMERGE_CANCELLED, bedata.callbacks);
559 void EmergeThread::runCompletionCallbacks(const v3s16 &pos, EmergeAction action,
560 const EmergeCallbackList &callbacks)
562 m_emerge->reportCompletedEmerge(action);
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(e);
658 EMERGE_DBG_OUT("ended up with: " << analyze_block(block));
663 assert(!m_mapgen->generating);
664 m_mapgen->gennotify.clearEvents();
665 m_mapgen->vm = nullptr;
670 m_server->m_env->activateBlock(block, 0);
676 void *EmergeThread::run()
678 BEGIN_DEBUG_EXCEPTION_HANDLER
681 std::map<v3s16, MapBlock *> modified_blocks;
683 m_map = &m_server->m_env->getServerMap();
684 m_emerge = m_server->m_emerge;
685 m_mapgen = m_emerge->m_mapgens[id];
686 enable_mapgen_debug_info = m_emerge->enable_mapgen_debug_info;
689 while (!stopRequested()) {
690 BlockEmergeData bedata;
691 BlockMakeData bmdata;
693 MapBlock *block = nullptr;
695 if (!popBlockEmerge(&pos, &bedata)) {
696 m_queue_event.wait();
700 if (blockpos_over_max_limit(pos))
703 bool allow_gen = bedata.flags & BLOCK_EMERGE_ALLOW_GEN;
704 EMERGE_DBG_OUT("pos=" PP(pos) " allow_gen=" << allow_gen);
706 action = getBlockOrStartGen(pos, allow_gen, &block, &bmdata);
707 if (action == EMERGE_GENERATED) {
709 ScopeProfiler sp(g_profiler,
710 "EmergeThread: Mapgen::makeChunk", SPT_AVG);
712 m_mapgen->makeChunk(&bmdata);
715 block = finishGen(pos, &bmdata, &modified_blocks);
717 action = EMERGE_ERRORED;
720 runCompletionCallbacks(pos, action, bedata.callbacks);
723 modified_blocks[pos] = block;
725 if (!modified_blocks.empty())
726 m_server->SetBlocksNotSent(modified_blocks);
727 modified_blocks.clear();
729 } catch (VersionMismatchException &e) {
730 std::ostringstream err;
731 err << "World data version mismatch in MapBlock " << PP(pos) << std::endl
732 << "----" << std::endl
733 << "\"" << e.what() << "\"" << std::endl
734 << "See debug.txt." << std::endl
735 << "World probably saved by a newer version of " PROJECT_NAME_C "."
737 m_server->setAsyncFatalError(err.str());
738 } catch (SerializationError &e) {
739 std::ostringstream err;
740 err << "Invalid data in MapBlock " << PP(pos) << std::endl
741 << "----" << std::endl
742 << "\"" << e.what() << "\"" << std::endl
743 << "See debug.txt." << std::endl
744 << "You can ignore this using [ignore_world_load_errors = true]."
746 m_server->setAsyncFatalError(err.str());
749 cancelPendingItems();
751 END_DEBUG_EXCEPTION_HANDLER