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"
39 #include "mg_decoration.h"
40 #include "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);
60 // Requires queue mutex held
61 bool pushBlock(v3s16 pos);
63 void cancelPendingItems();
65 static void runCompletionCallbacks(
66 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 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;
92 EmergeManager::EmergeManager(Server *server)
94 this->ndef = server->getNodeDefManager();
95 this->biomemgr = new BiomeManager(server);
96 this->oremgr = new OreManager(server);
97 this->decomgr = new DecorationManager(server);
98 this->schemmgr = new SchematicManager(server);
99 this->gen_notify_on = 0;
101 // Note that accesses to this variable are not synchronized.
102 // This is because the *only* thread ever starting or stopping
103 // EmergeThreads should be the ServerThread.
104 this->m_threads_active = false;
106 enable_mapgen_debug_info = g_settings->getBool("enable_mapgen_debug_info");
108 // If unspecified, leave a proc for the main thread and one for
109 // some other misc thread
111 if (!g_settings->getS16NoEx("num_emerge_threads", nthreads))
112 nthreads = Thread::getNumberOfProcessors() - 2;
116 m_qlimit_total = g_settings->getU16("emergequeue_limit_total");
117 if (!g_settings->getU16NoEx("emergequeue_limit_diskonly", m_qlimit_diskonly))
118 m_qlimit_diskonly = nthreads * 5 + 1;
119 if (!g_settings->getU16NoEx("emergequeue_limit_generate", m_qlimit_generate))
120 m_qlimit_generate = nthreads + 1;
122 // don't trust user input for something very important like this
123 if (m_qlimit_total < 1)
125 if (m_qlimit_diskonly < 1)
126 m_qlimit_diskonly = 1;
127 if (m_qlimit_generate < 1)
128 m_qlimit_generate = 1;
130 for (s16 i = 0; i < nthreads; i++)
131 m_threads.push_back(new EmergeThread(server, i));
133 infostream << "EmergeManager: using " << nthreads << " threads" << std::endl;
137 EmergeManager::~EmergeManager()
139 for (u32 i = 0; i != m_threads.size(); i++) {
140 EmergeThread *thread = m_threads[i];
142 if (m_threads_active) {
159 bool EmergeManager::initMapgens(MapgenParams *params)
161 if (m_mapgens.size())
164 this->mgparams = params;
166 for (u32 i = 0; i != m_threads.size(); i++) {
167 Mapgen *mg = Mapgen::createMapgen(params->mgtype, i, params, this);
168 m_mapgens.push_back(mg);
175 Mapgen *EmergeManager::getCurrentMapgen()
177 if (!m_threads_active)
180 for (u32 i = 0; i != m_threads.size(); i++) {
181 if (m_threads[i]->isCurrentThread())
182 return m_threads[i]->m_mapgen;
189 void EmergeManager::startThreads()
191 if (m_threads_active)
194 for (u32 i = 0; i != m_threads.size(); i++)
195 m_threads[i]->start();
197 m_threads_active = true;
201 void EmergeManager::stopThreads()
203 if (!m_threads_active)
206 // Request thread stop in parallel
207 for (u32 i = 0; i != m_threads.size(); i++) {
208 m_threads[i]->stop();
209 m_threads[i]->signal();
212 // Then do the waiting for each
213 for (u32 i = 0; i != m_threads.size(); i++)
214 m_threads[i]->wait();
216 m_threads_active = false;
220 bool EmergeManager::isRunning()
222 return m_threads_active;
226 bool EmergeManager::enqueueBlockEmerge(
230 bool ignore_queue_limits)
234 flags |= BLOCK_EMERGE_ALLOW_GEN;
235 if (ignore_queue_limits)
236 flags |= BLOCK_EMERGE_FORCE_QUEUE;
238 return enqueueBlockEmergeEx(blockpos, peer_id, flags, NULL, NULL);
242 bool EmergeManager::enqueueBlockEmergeEx(
246 EmergeCompletionCallback callback,
247 void *callback_param)
249 EmergeThread *thread = NULL;
250 bool entry_already_exists = false;
253 MutexAutoLock queuelock(m_queue_mutex);
255 if (!pushBlockEmergeData(blockpos, peer_id, flags,
256 callback, callback_param, &entry_already_exists))
259 if (entry_already_exists)
262 thread = getOptimalThread();
263 thread->pushBlock(blockpos);
273 // Mapgen-related helper functions
277 // TODO(hmmmm): Move this to ServerMap
278 v3s16 EmergeManager::getContainingChunk(v3s16 blockpos)
280 return getContainingChunk(blockpos, mgparams->chunksize);
283 // TODO(hmmmm): Move this to ServerMap
284 v3s16 EmergeManager::getContainingChunk(v3s16 blockpos, s16 chunksize)
286 s16 coff = -chunksize / 2;
287 v3s16 chunk_offset(coff, coff, coff);
289 return getContainerPos(blockpos - chunk_offset, chunksize)
290 * chunksize + chunk_offset;
294 int EmergeManager::getSpawnLevelAtPoint(v2s16 p)
296 if (m_mapgens.size() == 0 || !m_mapgens[0]) {
297 errorstream << "EmergeManager: getSpawnLevelAtPoint() called"
298 " before mapgen init" << std::endl;
302 return m_mapgens[0]->getSpawnLevelAtPoint(p);
306 int EmergeManager::getGroundLevelAtPoint(v2s16 p)
308 if (m_mapgens.size() == 0 || !m_mapgens[0]) {
309 errorstream << "EmergeManager: getGroundLevelAtPoint() called"
310 " before mapgen init" << std::endl;
314 return m_mapgens[0]->getGroundLevelAtPoint(p);
317 // TODO(hmmmm): Move this to ServerMap
318 bool EmergeManager::isBlockUnderground(v3s16 blockpos)
321 v2s16 p = v2s16((blockpos.X * MAP_BLOCKSIZE) + MAP_BLOCKSIZE / 2,
322 (blockpos.Y * MAP_BLOCKSIZE) + MAP_BLOCKSIZE / 2);
323 int ground_level = getGroundLevelAtPoint(p);
324 return blockpos.Y * (MAP_BLOCKSIZE + 1) <= min(water_level, ground_level);
327 // Use a simple heuristic; the above method is wildly inaccurate anyway.
328 return blockpos.Y * (MAP_BLOCKSIZE + 1) <= mgparams->water_level;
331 bool EmergeManager::pushBlockEmergeData(
335 EmergeCompletionCallback callback,
336 void *callback_param,
337 bool *entry_already_exists)
339 u16 &count_peer = m_peer_queue_count[peer_requested];
341 if ((flags & BLOCK_EMERGE_FORCE_QUEUE) == 0) {
342 if (m_blocks_enqueued.size() >= m_qlimit_total)
345 if (peer_requested != PEER_ID_INEXISTENT) {
346 u16 qlimit_peer = (flags & BLOCK_EMERGE_ALLOW_GEN) ?
347 m_qlimit_generate : m_qlimit_diskonly;
348 if (count_peer >= qlimit_peer)
353 std::pair<std::map<v3s16, BlockEmergeData>::iterator, bool> findres;
354 findres = m_blocks_enqueued.insert(std::make_pair(pos, BlockEmergeData()));
356 BlockEmergeData &bedata = findres.first->second;
357 *entry_already_exists = !findres.second;
360 bedata.callbacks.push_back(std::make_pair(callback, callback_param));
362 if (*entry_already_exists) {
363 bedata.flags |= flags;
365 bedata.flags = flags;
366 bedata.peer_requested = peer_requested;
375 bool EmergeManager::popBlockEmergeData(v3s16 pos, BlockEmergeData *bedata)
377 std::map<v3s16, BlockEmergeData>::iterator it;
378 UNORDERED_MAP<u16, u16>::iterator it2;
380 it = m_blocks_enqueued.find(pos);
381 if (it == m_blocks_enqueued.end())
384 *bedata = it->second;
386 it2 = m_peer_queue_count.find(bedata->peer_requested);
387 if (it2 == m_peer_queue_count.end())
390 u16 &count_peer = it2->second;
391 assert(count_peer != 0);
394 m_blocks_enqueued.erase(it);
400 EmergeThread *EmergeManager::getOptimalThread()
402 size_t nthreads = m_threads.size();
404 FATAL_ERROR_IF(nthreads == 0, "No emerge threads!");
407 size_t nitems_lowest = m_threads[0]->m_block_queue.size();
409 for (size_t i = 1; i < nthreads; i++) {
410 size_t nitems = m_threads[i]->m_block_queue.size();
411 if (nitems < nitems_lowest) {
413 nitems_lowest = nitems;
417 return m_threads[index];
425 EmergeThread::EmergeThread(Server *server, int ethreadid) :
426 enable_mapgen_debug_info(false),
433 m_name = "Emerge-" + itos(ethreadid);
437 EmergeThread::~EmergeThread()
439 //cancelPendingItems();
443 void EmergeThread::signal()
445 m_queue_event.signal();
449 bool EmergeThread::pushBlock(v3s16 pos)
451 m_block_queue.push(pos);
456 void EmergeThread::cancelPendingItems()
458 MutexAutoLock queuelock(m_emerge->m_queue_mutex);
460 while (!m_block_queue.empty()) {
461 BlockEmergeData bedata;
464 pos = m_block_queue.front();
467 m_emerge->popBlockEmergeData(pos, &bedata);
469 runCompletionCallbacks(pos, EMERGE_CANCELLED, bedata.callbacks);
474 void EmergeThread::runCompletionCallbacks(
477 const EmergeCallbackList &callbacks)
479 for (size_t i = 0; i != callbacks.size(); i++) {
480 EmergeCompletionCallback callback;
483 callback = callbacks[i].first;
484 param = callbacks[i].second;
486 callback(pos, action, param);
491 bool EmergeThread::popBlockEmerge(v3s16 *pos, BlockEmergeData *bedata)
493 MutexAutoLock queuelock(m_emerge->m_queue_mutex);
495 if (m_block_queue.empty())
498 *pos = m_block_queue.front();
501 m_emerge->popBlockEmergeData(*pos, bedata);
507 EmergeAction EmergeThread::getBlockOrStartGen(
508 v3s16 pos, bool allow_gen, MapBlock **block, BlockMakeData *bmdata)
510 MutexAutoLock envlock(m_server->m_env_mutex);
512 // 1). Attempt to fetch block from memory
513 *block = m_map->getBlockNoCreateNoEx(pos);
514 if (*block && !(*block)->isDummy()) {
515 if ((*block)->isGenerated())
516 return EMERGE_FROM_MEMORY;
518 // 2). Attempt to load block from disk if it was not in the memory
519 *block = m_map->loadBlock(pos);
520 if (*block && (*block)->isGenerated())
521 return EMERGE_FROM_DISK;
524 // 3). Attempt to start generation
525 if (allow_gen && m_map->initBlockMake(pos, bmdata))
526 return EMERGE_GENERATED;
528 // All attempts failed; cancel this block emerge
529 return EMERGE_CANCELLED;
533 MapBlock *EmergeThread::finishGen(v3s16 pos, BlockMakeData *bmdata,
534 std::map<v3s16, MapBlock *> *modified_blocks)
536 MutexAutoLock envlock(m_server->m_env_mutex);
537 ScopeProfiler sp(g_profiler,
538 "EmergeThread: after Mapgen::makeChunk", SPT_AVG);
541 Perform post-processing on blocks (invalidate lighting, queue liquid
542 transforms, etc.) to finish block make
544 m_map->finishBlockMake(bmdata, modified_blocks);
546 MapBlock *block = m_map->getBlockNoCreateNoEx(pos);
548 errorstream << "EmergeThread::finishGen: Couldn't grab block we "
549 "just generated: " << PP(pos) << std::endl;
553 v3s16 minp = bmdata->blockpos_min * MAP_BLOCKSIZE;
554 v3s16 maxp = bmdata->blockpos_max * MAP_BLOCKSIZE +
555 v3s16(1,1,1) * (MAP_BLOCKSIZE - 1);
557 // Ignore map edit events, they will not need to be sent
558 // to anybody because the block hasn't been sent to anybody
559 MapEditEventAreaIgnorer ign(
560 &m_server->m_ignore_map_edit_events_area,
561 VoxelArea(minp, maxp));
564 Run Lua on_generated callbacks
567 m_server->getScriptIface()->environment_OnGenerated(
568 minp, maxp, m_mapgen->blockseed);
569 } catch (LuaError &e) {
570 m_server->setAsyncFatalError("Lua: finishGen" + std::string(e.what()));
573 EMERGE_DBG_OUT("ended up with: " << analyze_block(block));
578 m_server->m_env->activateBlock(block, 0);
584 void *EmergeThread::run()
586 DSTACK(FUNCTION_NAME);
587 BEGIN_DEBUG_EXCEPTION_HANDLER
591 m_map = (ServerMap *)&(m_server->m_env->getMap());
592 m_emerge = m_server->m_emerge;
593 m_mapgen = m_emerge->m_mapgens[id];
594 enable_mapgen_debug_info = m_emerge->enable_mapgen_debug_info;
597 while (!stopRequested()) {
598 std::map<v3s16, MapBlock *> modified_blocks;
599 BlockEmergeData bedata;
600 BlockMakeData bmdata;
604 if (!popBlockEmerge(&pos, &bedata)) {
605 m_queue_event.wait();
609 if (blockpos_over_max_limit(pos))
612 bool allow_gen = bedata.flags & BLOCK_EMERGE_ALLOW_GEN;
613 EMERGE_DBG_OUT("pos=" PP(pos) " allow_gen=" << allow_gen);
615 action = getBlockOrStartGen(pos, allow_gen, &block, &bmdata);
616 if (action == EMERGE_GENERATED) {
618 ScopeProfiler sp(g_profiler,
619 "EmergeThread: Mapgen::makeChunk", SPT_AVG);
620 TimeTaker t("mapgen::make_block()");
622 m_mapgen->makeChunk(&bmdata);
624 if (enable_mapgen_debug_info == false)
625 t.stop(true); // Hide output
628 block = finishGen(pos, &bmdata, &modified_blocks);
631 runCompletionCallbacks(pos, action, bedata.callbacks);
634 modified_blocks[pos] = block;
636 if (modified_blocks.size() > 0)
637 m_server->SetBlocksNotSent(modified_blocks);
639 } catch (VersionMismatchException &e) {
640 std::ostringstream err;
641 err << "World data version mismatch in MapBlock " << PP(pos) << std::endl
642 << "----" << std::endl
643 << "\"" << e.what() << "\"" << std::endl
644 << "See debug.txt." << std::endl
645 << "World probably saved by a newer version of " PROJECT_NAME_C "."
647 m_server->setAsyncFatalError(err.str());
648 } catch (SerializationError &e) {
649 std::ostringstream err;
650 err << "Invalid data in MapBlock " << PP(pos) << std::endl
651 << "----" << std::endl
652 << "\"" << e.what() << "\"" << std::endl
653 << "See debug.txt." << std::endl
654 << "You can ignore this using [ignore_world_load_errors = true]."
656 m_server->setAsyncFatalError(err.str());
659 END_DEBUG_EXCEPTION_HANDLER