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.
26 #include "util/container.h"
27 #include "util/thread.h"
28 #include "threading/event.h"
31 #include "constants.h"
32 #include "environment.h"
36 #include "mapgen/mg_biome.h"
37 #include "mapgen/mg_ore.h"
38 #include "mapgen/mg_decoration.h"
39 #include "mapgen/mg_schematic.h"
42 #include "scripting_server.h"
47 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(const v3s16 &pos, EmergeAction action,
65 const EmergeCallbackList &callbacks);
70 EmergeManager *m_emerge;
74 std::queue<v3s16> m_block_queue;
76 bool popBlockEmerge(v3s16 *pos, BlockEmergeData *bedata);
78 EmergeAction getBlockOrStartGen(const v3s16 &pos, bool allow_gen,
79 MapBlock **block, BlockMakeData *data);
80 MapBlock *finishGen(v3s16 pos, BlockMakeData *bmdata,
81 std::map<v3s16, MapBlock *> *modified_blocks);
83 friend class EmergeManager;
86 class MapEditEventAreaIgnorer
89 MapEditEventAreaIgnorer(VoxelArea *ignorevariable, const VoxelArea &a) :
90 m_ignorevariable(ignorevariable)
92 if (m_ignorevariable->getVolume() == 0)
93 *m_ignorevariable = a;
95 m_ignorevariable = NULL;
98 ~MapEditEventAreaIgnorer()
100 if (m_ignorevariable) {
101 assert(m_ignorevariable->getVolume() != 0);
102 *m_ignorevariable = VoxelArea();
107 VoxelArea *m_ignorevariable;
110 EmergeParams::~EmergeParams()
112 infostream << "EmergeParams: destroying " << this << std::endl;
113 // Delete everything that was cloned on creation of EmergeParams
120 EmergeParams::EmergeParams(EmergeManager *parent, const BiomeManager *biomemgr,
121 const OreManager *oremgr, const DecorationManager *decomgr,
122 const SchematicManager *schemmgr) :
124 enable_mapgen_debug_info(parent->enable_mapgen_debug_info),
125 gen_notify_on(parent->gen_notify_on),
126 gen_notify_on_deco_ids(&parent->gen_notify_on_deco_ids),
127 biomemgr(biomemgr->clone()), oremgr(oremgr->clone()),
128 decomgr(decomgr->clone()), schemmgr(schemmgr->clone())
136 EmergeManager::EmergeManager(Server *server)
138 this->ndef = server->getNodeDefManager();
139 this->biomemgr = new BiomeManager(server);
140 this->oremgr = new OreManager(server);
141 this->decomgr = new DecorationManager(server);
142 this->schemmgr = new SchematicManager(server);
144 // Note that accesses to this variable are not synchronized.
145 // This is because the *only* thread ever starting or stopping
146 // EmergeThreads should be the ServerThread.
148 enable_mapgen_debug_info = g_settings->getBool("enable_mapgen_debug_info");
151 g_settings->getS16NoEx("num_emerge_threads", nthreads);
152 // If automatic, leave a proc for the main thread and one for
153 // some other misc thread
155 nthreads = Thread::getNumberOfProcessors() - 2;
159 m_qlimit_total = g_settings->getU16("emergequeue_limit_total");
160 // FIXME: these fallback values are probably not good
161 if (!g_settings->getU16NoEx("emergequeue_limit_diskonly", m_qlimit_diskonly))
162 m_qlimit_diskonly = nthreads * 5 + 1;
163 if (!g_settings->getU16NoEx("emergequeue_limit_generate", m_qlimit_generate))
164 m_qlimit_generate = nthreads + 1;
166 // don't trust user input for something very important like this
167 if (m_qlimit_total < 1)
169 if (m_qlimit_diskonly < 1)
170 m_qlimit_diskonly = 1;
171 if (m_qlimit_generate < 1)
172 m_qlimit_generate = 1;
174 for (s16 i = 0; i < nthreads; i++)
175 m_threads.push_back(new EmergeThread(server, i));
177 infostream << "EmergeManager: using " << nthreads << " threads" << std::endl;
180 EmergeManager::~EmergeManager()
182 for (u32 i = 0; i != m_threads.size(); i++) {
183 EmergeThread *thread = m_threads[i];
185 if (m_threads_active) {
193 // Mapgen init might not be finished if there is an error during startup.
194 if (m_mapgens.size() > i)
204 BiomeManager *EmergeManager::getWritableBiomeManager()
206 FATAL_ERROR_IF(!m_mapgens.empty(),
207 "Writable managers can only be returned before mapgen init");
211 OreManager *EmergeManager::getWritableOreManager()
213 FATAL_ERROR_IF(!m_mapgens.empty(),
214 "Writable managers can only be returned before mapgen init");
218 DecorationManager *EmergeManager::getWritableDecorationManager()
220 FATAL_ERROR_IF(!m_mapgens.empty(),
221 "Writable managers can only be returned before mapgen init");
225 SchematicManager *EmergeManager::getWritableSchematicManager()
227 FATAL_ERROR_IF(!m_mapgens.empty(),
228 "Writable managers can only be returned before mapgen init");
232 void EmergeManager::initMapgens(MapgenParams *params)
234 FATAL_ERROR_IF(!m_mapgens.empty(), "Mapgen already initialised.");
238 for (u32 i = 0; i != m_threads.size(); i++) {
239 EmergeParams *p = new EmergeParams(
240 this, biomemgr, oremgr, decomgr, schemmgr);
241 infostream << "EmergeManager: Created params " << p << " for thread " << i
243 m_mapgens.push_back(Mapgen::createMapgen(params->mgtype, params, p));
247 Mapgen *EmergeManager::getCurrentMapgen()
249 if (!m_threads_active)
252 for (u32 i = 0; i != m_threads.size(); i++) {
253 EmergeThread *t = m_threads[i];
254 if (t->isRunning() && t->isCurrentThread())
261 void EmergeManager::startThreads()
263 if (m_threads_active)
266 for (u32 i = 0; i != m_threads.size(); i++)
267 m_threads[i]->start();
269 m_threads_active = true;
272 void EmergeManager::stopThreads()
274 if (!m_threads_active)
277 // Request thread stop in parallel
278 for (u32 i = 0; i != m_threads.size(); i++) {
279 m_threads[i]->stop();
280 m_threads[i]->signal();
283 // Then do the waiting for each
284 for (u32 i = 0; i != m_threads.size(); i++)
285 m_threads[i]->wait();
287 m_threads_active = false;
290 bool EmergeManager::isRunning()
292 return m_threads_active;
295 bool EmergeManager::enqueueBlockEmerge(session_t peer_id, v3s16 blockpos,
296 bool allow_generate, bool ignore_queue_limits)
300 flags |= BLOCK_EMERGE_ALLOW_GEN;
301 if (ignore_queue_limits)
302 flags |= BLOCK_EMERGE_FORCE_QUEUE;
304 return enqueueBlockEmergeEx(blockpos, peer_id, flags, NULL, NULL);
307 bool EmergeManager::enqueueBlockEmergeEx(v3s16 blockpos, session_t peer_id, u16 flags,
308 EmergeCompletionCallback callback, void *callback_param)
310 EmergeThread *thread = NULL;
311 bool entry_already_exists = false;
314 MutexAutoLock queuelock(m_queue_mutex);
316 if (!pushBlockEmergeData(blockpos, peer_id, flags, callback,
317 callback_param, &entry_already_exists))
320 if (entry_already_exists)
323 thread = getOptimalThread();
324 thread->pushBlock(blockpos);
333 // Mapgen-related helper functions
336 // TODO(hmmmm): Move this to ServerMap
337 v3s16 EmergeManager::getContainingChunk(v3s16 blockpos)
339 return getContainingChunk(blockpos, mgparams->chunksize);
342 // TODO(hmmmm): Move this to ServerMap
343 v3s16 EmergeManager::getContainingChunk(v3s16 blockpos, s16 chunksize)
345 s16 coff = -chunksize / 2;
346 v3s16 chunk_offset(coff, coff, coff);
348 return getContainerPos(blockpos - chunk_offset, chunksize) * chunksize +
352 int EmergeManager::getSpawnLevelAtPoint(v2s16 p)
354 if (m_mapgens.empty() || !m_mapgens[0]) {
355 errorstream << "EmergeManager: getSpawnLevelAtPoint() called"
356 " before mapgen init"
361 return m_mapgens[0]->getSpawnLevelAtPoint(p);
364 int EmergeManager::getGroundLevelAtPoint(v2s16 p)
366 if (m_mapgens.empty() || !m_mapgens[0]) {
367 errorstream << "EmergeManager: getGroundLevelAtPoint() called"
368 " before mapgen init"
373 return m_mapgens[0]->getGroundLevelAtPoint(p);
376 // TODO(hmmmm): Move this to ServerMap
377 bool EmergeManager::isBlockUnderground(v3s16 blockpos)
380 v2s16 p = v2s16((blockpos.X * MAP_BLOCKSIZE) + MAP_BLOCKSIZE / 2,
381 (blockpos.Y * MAP_BLOCKSIZE) + MAP_BLOCKSIZE / 2);
382 int ground_level = getGroundLevelAtPoint(p);
383 return blockpos.Y * (MAP_BLOCKSIZE + 1) <= min(water_level, ground_level);
386 // Use a simple heuristic; the above method is wildly inaccurate anyway.
387 return blockpos.Y * (MAP_BLOCKSIZE + 1) <= mgparams->water_level;
390 bool EmergeManager::pushBlockEmergeData(v3s16 pos, u16 peer_requested, u16 flags,
391 EmergeCompletionCallback callback, void *callback_param,
392 bool *entry_already_exists)
394 u16 &count_peer = m_peer_queue_count[peer_requested];
396 if ((flags & BLOCK_EMERGE_FORCE_QUEUE) == 0) {
397 if (m_blocks_enqueued.size() >= m_qlimit_total)
400 if (peer_requested != PEER_ID_INEXISTENT) {
401 u16 qlimit_peer = (flags & BLOCK_EMERGE_ALLOW_GEN)
404 if (count_peer >= qlimit_peer)
409 std::pair<std::map<v3s16, BlockEmergeData>::iterator, bool> findres;
410 findres = m_blocks_enqueued.insert(std::make_pair(pos, BlockEmergeData()));
412 BlockEmergeData &bedata = findres.first->second;
413 *entry_already_exists = !findres.second;
416 bedata.callbacks.emplace_back(callback, callback_param);
418 if (*entry_already_exists) {
419 bedata.flags |= flags;
421 bedata.flags = flags;
422 bedata.peer_requested = peer_requested;
430 bool EmergeManager::popBlockEmergeData(v3s16 pos, BlockEmergeData *bedata)
432 std::map<v3s16, BlockEmergeData>::iterator it;
433 std::unordered_map<u16, u16>::iterator it2;
435 it = m_blocks_enqueued.find(pos);
436 if (it == m_blocks_enqueued.end())
439 *bedata = it->second;
441 it2 = m_peer_queue_count.find(bedata->peer_requested);
442 if (it2 == m_peer_queue_count.end())
445 u16 &count_peer = it2->second;
446 assert(count_peer != 0);
449 m_blocks_enqueued.erase(it);
454 EmergeThread *EmergeManager::getOptimalThread()
456 size_t nthreads = m_threads.size();
458 FATAL_ERROR_IF(nthreads == 0, "No emerge threads!");
461 size_t nitems_lowest = m_threads[0]->m_block_queue.size();
463 for (size_t i = 1; i < nthreads; i++) {
464 size_t nitems = m_threads[i]->m_block_queue.size();
465 if (nitems < nitems_lowest) {
467 nitems_lowest = nitems;
471 return m_threads[index];
478 EmergeThread::EmergeThread(Server *server, int ethreadid) :
479 enable_mapgen_debug_info(false), id(ethreadid), m_server(server),
480 m_map(NULL), m_emerge(NULL), m_mapgen(NULL)
482 m_name = "Emerge-" + itos(ethreadid);
485 void EmergeThread::signal()
487 m_queue_event.signal();
490 bool EmergeThread::pushBlock(const v3s16 &pos)
492 m_block_queue.push(pos);
496 void EmergeThread::cancelPendingItems()
498 MutexAutoLock queuelock(m_emerge->m_queue_mutex);
500 while (!m_block_queue.empty()) {
501 BlockEmergeData bedata;
504 pos = m_block_queue.front();
507 m_emerge->popBlockEmergeData(pos, &bedata);
509 runCompletionCallbacks(pos, EMERGE_CANCELLED, bedata.callbacks);
513 void EmergeThread::runCompletionCallbacks(const v3s16 &pos, EmergeAction action,
514 const EmergeCallbackList &callbacks)
516 for (size_t i = 0; i != callbacks.size(); i++) {
517 EmergeCompletionCallback callback;
520 callback = callbacks[i].first;
521 param = callbacks[i].second;
523 callback(pos, action, param);
527 bool EmergeThread::popBlockEmerge(v3s16 *pos, BlockEmergeData *bedata)
529 MutexAutoLock queuelock(m_emerge->m_queue_mutex);
531 if (m_block_queue.empty())
534 *pos = m_block_queue.front();
537 m_emerge->popBlockEmergeData(*pos, bedata);
542 EmergeAction EmergeThread::getBlockOrStartGen(
543 const v3s16 &pos, bool allow_gen, MapBlock **block, BlockMakeData *bmdata)
545 MutexAutoLock envlock(m_server->m_env_mutex);
547 // 1). Attempt to fetch block from memory
548 *block = m_map->getBlockNoCreateNoEx(pos);
549 if (*block && !(*block)->isDummy()) {
550 if ((*block)->isGenerated())
551 return EMERGE_FROM_MEMORY;
553 // 2). Attempt to load block from disk if it was not in the memory
554 *block = m_map->loadBlock(pos);
555 if (*block && (*block)->isGenerated())
556 return EMERGE_FROM_DISK;
559 // 3). Attempt to start generation
560 if (allow_gen && m_map->initBlockMake(pos, bmdata))
561 return EMERGE_GENERATED;
563 // All attempts failed; cancel this block emerge
564 return EMERGE_CANCELLED;
567 MapBlock *EmergeThread::finishGen(v3s16 pos, BlockMakeData *bmdata,
568 std::map<v3s16, MapBlock *> *modified_blocks)
570 MutexAutoLock envlock(m_server->m_env_mutex);
571 ScopeProfiler sp(g_profiler, "EmergeThread: after Mapgen::makeChunk", SPT_AVG);
574 Perform post-processing on blocks (invalidate lighting, queue liquid
575 transforms, etc.) to finish block make
577 m_map->finishBlockMake(bmdata, modified_blocks);
579 MapBlock *block = m_map->getBlockNoCreateNoEx(pos);
581 errorstream << "EmergeThread::finishGen: Couldn't grab block we "
583 << PP(pos) << std::endl;
587 v3s16 minp = bmdata->blockpos_min * MAP_BLOCKSIZE;
588 v3s16 maxp = bmdata->blockpos_max * MAP_BLOCKSIZE +
589 v3s16(1, 1, 1) * (MAP_BLOCKSIZE - 1);
591 // Ignore map edit events, they will not need to be sent
592 // to anybody because the block hasn't been sent to anybody
593 MapEditEventAreaIgnorer ign(
594 &m_server->m_ignore_map_edit_events_area, VoxelArea(minp, maxp));
597 Run Lua on_generated callbacks
600 m_server->getScriptIface()->environment_OnGenerated(
601 minp, maxp, m_mapgen->blockseed);
602 } catch (LuaError &e) {
603 m_server->setAsyncFatalError("Lua: finishGen" + std::string(e.what()));
607 Clear generate notifier events
609 m_mapgen->gennotify.clearEvents();
611 EMERGE_DBG_OUT("ended up with: " << analyze_block(block));
616 m_server->m_env->activateBlock(block, 0);
621 void *EmergeThread::run()
623 BEGIN_DEBUG_EXCEPTION_HANDLER
627 m_map = (ServerMap *)&(m_server->m_env->getMap());
628 m_emerge = m_server->m_emerge;
629 m_mapgen = m_emerge->m_mapgens[id];
630 enable_mapgen_debug_info = m_emerge->enable_mapgen_debug_info;
633 while (!stopRequested()) {
634 std::map<v3s16, MapBlock *> modified_blocks;
635 BlockEmergeData bedata;
636 BlockMakeData bmdata;
640 if (!popBlockEmerge(&pos, &bedata)) {
641 m_queue_event.wait();
645 if (blockpos_over_max_limit(pos))
648 bool allow_gen = bedata.flags & BLOCK_EMERGE_ALLOW_GEN;
649 EMERGE_DBG_OUT("pos=" PP(pos) " allow_gen=" << allow_gen);
651 action = getBlockOrStartGen(pos, allow_gen, &block, &bmdata);
652 if (action == EMERGE_GENERATED) {
654 ScopeProfiler sp(g_profiler,
655 "EmergeThread: Mapgen::makeChunk",
658 m_mapgen->makeChunk(&bmdata);
661 block = finishGen(pos, &bmdata, &modified_blocks);
664 runCompletionCallbacks(pos, action, bedata.callbacks);
667 modified_blocks[pos] = block;
669 if (!modified_blocks.empty())
670 m_server->SetBlocksNotSent(modified_blocks);
672 } catch (VersionMismatchException &e) {
673 std::ostringstream err;
674 err << "World data version mismatch in MapBlock " << PP(pos) << std::endl
675 << "----" << std::endl
676 << "\"" << e.what() << "\"" << std::endl
677 << "See debug.txt." << std::endl
678 << "World probably saved by a newer version of " PROJECT_NAME_C "."
680 m_server->setAsyncFatalError(err.str());
681 } catch (SerializationError &e) {
682 std::ostringstream err;
683 err << "Invalid data in MapBlock " << PP(pos) << std::endl
684 << "----" << std::endl
685 << "\"" << e.what() << "\"" << std::endl
686 << "See debug.txt." << std::endl
687 << "You can ignore this using [ignore_world_load_errors = true]."
689 m_server->setAsyncFatalError(err.str());
692 END_DEBUG_EXCEPTION_HANDLER