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"
45 #include "serverobject.h"
49 class EmergeThread : public Thread {
51 bool enable_mapgen_debug_info;
54 EmergeThread(Server *server, int ethreadid);
55 ~EmergeThread() = default;
60 // Requires queue mutex held
61 bool pushBlock(const v3s16 &pos);
63 void cancelPendingItems();
65 static void runCompletionCallbacks(
66 const v3s16 &pos, EmergeAction action,
67 const EmergeCallbackList &callbacks);
72 EmergeManager *m_emerge;
76 std::queue<v3s16> m_block_queue;
78 bool popBlockEmerge(v3s16 *pos, BlockEmergeData *bedata);
80 EmergeAction getBlockOrStartGen(
81 const v3s16 &pos, bool allow_gen, MapBlock **block, BlockMakeData *data);
82 MapBlock *finishGen(v3s16 pos, BlockMakeData *bmdata,
83 std::map<v3s16, MapBlock *> *modified_blocks);
85 friend class EmergeManager;
88 class MapEditEventAreaIgnorer
91 MapEditEventAreaIgnorer(VoxelArea *ignorevariable, const VoxelArea &a):
92 m_ignorevariable(ignorevariable)
94 if(m_ignorevariable->getVolume() == 0)
95 *m_ignorevariable = a;
97 m_ignorevariable = NULL;
100 ~MapEditEventAreaIgnorer()
104 assert(m_ignorevariable->getVolume() != 0);
105 *m_ignorevariable = VoxelArea();
110 VoxelArea *m_ignorevariable;
117 EmergeManager::EmergeManager(Server *server)
119 this->ndef = server->getNodeDefManager();
120 this->biomemgr = new BiomeManager(server);
121 this->oremgr = new OreManager(server);
122 this->decomgr = new DecorationManager(server);
123 this->schemmgr = new SchematicManager(server);
125 // Note that accesses to this variable are not synchronized.
126 // This is because the *only* thread ever starting or stopping
127 // EmergeThreads should be the ServerThread.
129 enable_mapgen_debug_info = g_settings->getBool("enable_mapgen_debug_info");
131 // If unspecified, leave a proc for the main thread and one for
132 // some other misc thread
134 if (!g_settings->getS16NoEx("num_emerge_threads", nthreads))
135 nthreads = Thread::getNumberOfProcessors() - 2;
139 m_qlimit_total = g_settings->getU16("emergequeue_limit_total");
140 if (!g_settings->getU16NoEx("emergequeue_limit_diskonly", m_qlimit_diskonly))
141 m_qlimit_diskonly = nthreads * 5 + 1;
142 if (!g_settings->getU16NoEx("emergequeue_limit_generate", m_qlimit_generate))
143 m_qlimit_generate = nthreads + 1;
145 // don't trust user input for something very important like this
146 if (m_qlimit_total < 1)
148 if (m_qlimit_diskonly < 1)
149 m_qlimit_diskonly = 1;
150 if (m_qlimit_generate < 1)
151 m_qlimit_generate = 1;
153 for (s16 i = 0; i < nthreads; i++)
154 m_threads.push_back(new EmergeThread(server, i));
156 infostream << "EmergeManager: using " << nthreads << " threads" << std::endl;
160 EmergeManager::~EmergeManager()
162 for (u32 i = 0; i != m_threads.size(); i++) {
163 EmergeThread *thread = m_threads[i];
165 if (m_threads_active) {
173 // Mapgen init might not be finished if there is an error during startup.
174 if (m_mapgens.size() > i)
185 bool EmergeManager::initMapgens(MapgenParams *params)
187 if (!m_mapgens.empty())
190 this->mgparams = params;
192 for (u32 i = 0; i != m_threads.size(); i++) {
193 Mapgen *mg = Mapgen::createMapgen(params->mgtype, i, params, this);
194 m_mapgens.push_back(mg);
201 Mapgen *EmergeManager::getCurrentMapgen()
203 if (!m_threads_active)
206 for (u32 i = 0; i != m_threads.size(); i++) {
207 if (m_threads[i]->isCurrentThread())
208 return m_threads[i]->m_mapgen;
215 void EmergeManager::startThreads()
217 if (m_threads_active)
220 for (u32 i = 0; i != m_threads.size(); i++)
221 m_threads[i]->start();
223 m_threads_active = true;
227 void EmergeManager::stopThreads()
229 if (!m_threads_active)
232 // Request thread stop in parallel
233 for (u32 i = 0; i != m_threads.size(); i++) {
234 m_threads[i]->stop();
235 m_threads[i]->signal();
238 // Then do the waiting for each
239 for (u32 i = 0; i != m_threads.size(); i++)
240 m_threads[i]->wait();
242 m_threads_active = false;
246 bool EmergeManager::isRunning()
248 return m_threads_active;
252 bool EmergeManager::enqueueBlockEmerge(
256 bool ignore_queue_limits)
260 flags |= BLOCK_EMERGE_ALLOW_GEN;
261 if (ignore_queue_limits)
262 flags |= BLOCK_EMERGE_FORCE_QUEUE;
264 return enqueueBlockEmergeEx(blockpos, peer_id, flags, NULL, NULL);
268 bool EmergeManager::enqueueBlockEmergeEx(
272 EmergeCompletionCallback callback,
273 void *callback_param)
275 EmergeThread *thread = NULL;
276 bool entry_already_exists = false;
279 MutexAutoLock queuelock(m_queue_mutex);
281 if (!pushBlockEmergeData(blockpos, peer_id, flags,
282 callback, callback_param, &entry_already_exists))
285 if (entry_already_exists)
288 thread = getOptimalThread();
289 thread->pushBlock(blockpos);
299 // Mapgen-related helper functions
303 // TODO(hmmmm): Move this to ServerMap
304 v3s16 EmergeManager::getContainingChunk(v3s16 blockpos)
306 return getContainingChunk(blockpos, mgparams->chunksize);
309 // TODO(hmmmm): Move this to ServerMap
310 v3s16 EmergeManager::getContainingChunk(v3s16 blockpos, s16 chunksize)
312 s16 coff = -chunksize / 2;
313 v3s16 chunk_offset(coff, coff, coff);
315 return getContainerPos(blockpos - chunk_offset, chunksize)
316 * chunksize + chunk_offset;
320 int EmergeManager::getSpawnLevelAtPoint(v2s16 p)
322 if (m_mapgens.empty() || !m_mapgens[0]) {
323 errorstream << "EmergeManager: getSpawnLevelAtPoint() called"
324 " before mapgen init" << std::endl;
328 return m_mapgens[0]->getSpawnLevelAtPoint(p);
332 int EmergeManager::getGroundLevelAtPoint(v2s16 p)
334 if (m_mapgens.empty() || !m_mapgens[0]) {
335 errorstream << "EmergeManager: getGroundLevelAtPoint() called"
336 " before mapgen init" << std::endl;
340 return m_mapgens[0]->getGroundLevelAtPoint(p);
343 // TODO(hmmmm): Move this to ServerMap
344 bool EmergeManager::isBlockUnderground(v3s16 blockpos)
347 v2s16 p = v2s16((blockpos.X * MAP_BLOCKSIZE) + MAP_BLOCKSIZE / 2,
348 (blockpos.Y * MAP_BLOCKSIZE) + MAP_BLOCKSIZE / 2);
349 int ground_level = getGroundLevelAtPoint(p);
350 return blockpos.Y * (MAP_BLOCKSIZE + 1) <= min(water_level, ground_level);
353 // Use a simple heuristic; the above method is wildly inaccurate anyway.
354 return blockpos.Y * (MAP_BLOCKSIZE + 1) <= mgparams->water_level;
357 bool EmergeManager::pushBlockEmergeData(
361 EmergeCompletionCallback callback,
362 void *callback_param,
363 bool *entry_already_exists)
365 u16 &count_peer = m_peer_queue_count[peer_requested];
367 if ((flags & BLOCK_EMERGE_FORCE_QUEUE) == 0) {
368 if (m_blocks_enqueued.size() >= m_qlimit_total)
371 if (peer_requested != PEER_ID_INEXISTENT) {
372 u16 qlimit_peer = (flags & BLOCK_EMERGE_ALLOW_GEN) ?
373 m_qlimit_generate : m_qlimit_diskonly;
374 if (count_peer >= qlimit_peer)
379 std::pair<std::map<v3s16, BlockEmergeData>::iterator, bool> findres;
380 findres = m_blocks_enqueued.insert(std::make_pair(pos, BlockEmergeData()));
382 BlockEmergeData &bedata = findres.first->second;
383 *entry_already_exists = !findres.second;
386 bedata.callbacks.emplace_back(callback, callback_param);
388 if (*entry_already_exists) {
389 bedata.flags |= flags;
391 bedata.flags = flags;
392 bedata.peer_requested = peer_requested;
401 bool EmergeManager::popBlockEmergeData(v3s16 pos, BlockEmergeData *bedata)
403 std::map<v3s16, BlockEmergeData>::iterator it;
404 std::unordered_map<u16, u16>::iterator it2;
406 it = m_blocks_enqueued.find(pos);
407 if (it == m_blocks_enqueued.end())
410 *bedata = it->second;
412 it2 = m_peer_queue_count.find(bedata->peer_requested);
413 if (it2 == m_peer_queue_count.end())
416 u16 &count_peer = it2->second;
417 assert(count_peer != 0);
420 m_blocks_enqueued.erase(it);
426 EmergeThread *EmergeManager::getOptimalThread()
428 size_t nthreads = m_threads.size();
430 FATAL_ERROR_IF(nthreads == 0, "No emerge threads!");
433 size_t nitems_lowest = m_threads[0]->m_block_queue.size();
435 for (size_t i = 1; i < nthreads; i++) {
436 size_t nitems = m_threads[i]->m_block_queue.size();
437 if (nitems < nitems_lowest) {
439 nitems_lowest = nitems;
443 return m_threads[index];
451 EmergeThread::EmergeThread(Server *server, int ethreadid) :
452 enable_mapgen_debug_info(false),
459 m_name = "Emerge-" + itos(ethreadid);
463 void EmergeThread::signal()
465 m_queue_event.signal();
469 bool EmergeThread::pushBlock(const v3s16 &pos)
471 m_block_queue.push(pos);
476 void EmergeThread::cancelPendingItems()
478 MutexAutoLock queuelock(m_emerge->m_queue_mutex);
480 while (!m_block_queue.empty()) {
481 BlockEmergeData bedata;
484 pos = m_block_queue.front();
487 m_emerge->popBlockEmergeData(pos, &bedata);
489 runCompletionCallbacks(pos, EMERGE_CANCELLED, bedata.callbacks);
494 void EmergeThread::runCompletionCallbacks(const v3s16 &pos, EmergeAction action,
495 const EmergeCallbackList &callbacks)
497 for (size_t i = 0; i != callbacks.size(); i++) {
498 EmergeCompletionCallback callback;
501 callback = callbacks[i].first;
502 param = callbacks[i].second;
504 callback(pos, action, param);
509 bool EmergeThread::popBlockEmerge(v3s16 *pos, BlockEmergeData *bedata)
511 MutexAutoLock queuelock(m_emerge->m_queue_mutex);
513 if (m_block_queue.empty())
516 *pos = m_block_queue.front();
519 m_emerge->popBlockEmergeData(*pos, bedata);
525 EmergeAction EmergeThread::getBlockOrStartGen(
526 const v3s16 &pos, bool allow_gen, MapBlock **block, BlockMakeData *bmdata)
528 MutexAutoLock envlock(m_server->m_env_mutex);
530 // 1). Attempt to fetch block from memory
531 *block = m_map->getBlockNoCreateNoEx(pos);
532 if (*block && !(*block)->isDummy()) {
533 if ((*block)->isGenerated())
534 return EMERGE_FROM_MEMORY;
536 // 2). Attempt to load block from disk if it was not in the memory
537 *block = m_map->loadBlock(pos);
538 if (*block && (*block)->isGenerated())
539 return EMERGE_FROM_DISK;
542 // 3). Attempt to start generation
543 if (allow_gen && m_map->initBlockMake(pos, bmdata))
544 return EMERGE_GENERATED;
546 // All attempts failed; cancel this block emerge
547 return EMERGE_CANCELLED;
551 MapBlock *EmergeThread::finishGen(v3s16 pos, BlockMakeData *bmdata,
552 std::map<v3s16, MapBlock *> *modified_blocks)
554 MutexAutoLock envlock(m_server->m_env_mutex);
555 ScopeProfiler sp(g_profiler,
556 "EmergeThread: after Mapgen::makeChunk", SPT_AVG);
559 Perform post-processing on blocks (invalidate lighting, queue liquid
560 transforms, etc.) to finish block make
562 m_map->finishBlockMake(bmdata, modified_blocks);
564 MapBlock *block = m_map->getBlockNoCreateNoEx(pos);
566 errorstream << "EmergeThread::finishGen: Couldn't grab block we "
567 "just generated: " << PP(pos) << std::endl;
571 v3s16 minp = bmdata->blockpos_min * MAP_BLOCKSIZE;
572 v3s16 maxp = bmdata->blockpos_max * MAP_BLOCKSIZE +
573 v3s16(1,1,1) * (MAP_BLOCKSIZE - 1);
575 // Ignore map edit events, they will not need to be sent
576 // to anybody because the block hasn't been sent to anybody
577 MapEditEventAreaIgnorer ign(
578 &m_server->m_ignore_map_edit_events_area,
579 VoxelArea(minp, maxp));
582 Run Lua on_generated callbacks
585 m_server->getScriptIface()->environment_OnGenerated(
586 minp, maxp, m_mapgen->blockseed);
587 } catch (LuaError &e) {
588 m_server->setAsyncFatalError("Lua: finishGen" + std::string(e.what()));
592 Clear generate notifier events
594 Mapgen *mg = m_emerge->getCurrentMapgen();
595 mg->gennotify.clearEvents();
597 EMERGE_DBG_OUT("ended up with: " << analyze_block(block));
602 m_server->m_env->activateBlock(block, 0);
608 void *EmergeThread::run()
610 BEGIN_DEBUG_EXCEPTION_HANDLER
614 m_map = (ServerMap *)&(m_server->m_env->getMap());
615 m_emerge = m_server->m_emerge;
616 m_mapgen = m_emerge->m_mapgens[id];
617 enable_mapgen_debug_info = m_emerge->enable_mapgen_debug_info;
620 while (!stopRequested()) {
621 std::map<v3s16, MapBlock *> modified_blocks;
622 BlockEmergeData bedata;
623 BlockMakeData bmdata;
627 if (!popBlockEmerge(&pos, &bedata)) {
628 m_queue_event.wait();
632 if (blockpos_over_max_limit(pos))
635 bool allow_gen = bedata.flags & BLOCK_EMERGE_ALLOW_GEN;
636 EMERGE_DBG_OUT("pos=" PP(pos) " allow_gen=" << allow_gen);
638 action = getBlockOrStartGen(pos, allow_gen, &block, &bmdata);
639 if (action == EMERGE_GENERATED) {
641 ScopeProfiler sp(g_profiler,
642 "EmergeThread: Mapgen::makeChunk", SPT_AVG);
643 TimeTaker t("mapgen::make_block()");
645 m_mapgen->makeChunk(&bmdata);
647 if (!enable_mapgen_debug_info)
648 t.stop(true); // Hide output
651 block = finishGen(pos, &bmdata, &modified_blocks);
654 runCompletionCallbacks(pos, action, bedata.callbacks);
657 modified_blocks[pos] = block;
659 if (!modified_blocks.empty())
660 m_server->SetBlocksNotSent(modified_blocks);
662 } catch (VersionMismatchException &e) {
663 std::ostringstream err;
664 err << "World data version mismatch in MapBlock " << PP(pos) << std::endl
665 << "----" << std::endl
666 << "\"" << e.what() << "\"" << std::endl
667 << "See debug.txt." << std::endl
668 << "World probably saved by a newer version of " PROJECT_NAME_C "."
670 m_server->setAsyncFatalError(err.str());
671 } catch (SerializationError &e) {
672 std::ostringstream err;
673 err << "Invalid data in MapBlock " << PP(pos) << std::endl
674 << "----" << std::endl
675 << "\"" << e.what() << "\"" << std::endl
676 << "See debug.txt." << std::endl
677 << "You can ignore this using [ignore_world_load_errors = true]."
679 m_server->setAsyncFatalError(err.str());
682 END_DEBUG_EXCEPTION_HANDLER