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 "jthread/jevent.h"
28 #include "environment.h"
29 #include "util/container.h"
30 #include "util/thread.h"
32 #include "constants.h"
36 #include "serverobject.h"
38 #include "scripting_game.h"
44 #include "mg_decoration.h"
45 #include "mg_schematic.h"
46 #include "mapgen_v5.h"
47 #include "mapgen_v6.h"
48 #include "mapgen_v7.h"
49 #include "mapgen_singlenode.h"
53 MapgenFactory *factory;
56 MapgenDesc reg_mapgens[] = {
57 {"v5", new MapgenFactoryV5},
58 {"v6", new MapgenFactoryV6},
59 {"v7", new MapgenFactoryV7},
60 {"singlenode", new MapgenFactorySinglenode},
63 class EmergeThread : public JThread
68 EmergeManager *emerge;
70 bool enable_mapgen_debug_info;
74 std::queue<v3s16> blockqueue;
76 EmergeThread(Server *server, int ethreadid):
82 enable_mapgen_debug_info(false),
88 bool popBlockEmerge(v3s16 *pos, u8 *flags);
89 bool getBlockOrStartGen(v3s16 p, MapBlock **b,
90 BlockMakeData *data, bool allow_generate);
94 /////////////////////////////// Emerge Manager ////////////////////////////////
96 EmergeManager::EmergeManager(IGameDef *gamedef)
98 this->ndef = gamedef->getNodeDefManager();
99 this->biomemgr = new BiomeManager(gamedef);
100 this->oremgr = new OreManager(gamedef);
101 this->decomgr = new DecorationManager(gamedef);
102 this->schemmgr = new SchematicManager(gamedef);
103 this->gen_notify_on = 0;
105 // Note that accesses to this variable are not synchronized.
106 // This is because the *only* thread ever starting or stopping
107 // EmergeThreads should be the ServerThread.
108 this->threads_active = false;
110 mapgen_debug_info = g_settings->getBool("enable_mapgen_debug_info");
112 // if unspecified, leave a proc for the main thread and one for
113 // some other misc thread
115 if (!g_settings->getS16NoEx("num_emerge_threads", nthreads))
116 nthreads = porting::getNumberOfProcessors() - 2;
120 qlimit_total = g_settings->getU16("emergequeue_limit_total");
121 if (!g_settings->getU16NoEx("emergequeue_limit_diskonly", qlimit_diskonly))
122 qlimit_diskonly = nthreads * 5 + 1;
123 if (!g_settings->getU16NoEx("emergequeue_limit_generate", qlimit_generate))
124 qlimit_generate = nthreads + 1;
126 // don't trust user input for something very important like this
127 if (qlimit_total < 1)
129 if (qlimit_diskonly < 1)
131 if (qlimit_generate < 1)
134 for (s16 i = 0; i < nthreads; i++)
135 emergethread.push_back(new EmergeThread((Server *) gamedef, i));
137 infostream << "EmergeManager: using " << nthreads << " threads" << std::endl;
141 EmergeManager::~EmergeManager()
143 for (u32 i = 0; i != emergethread.size(); i++) {
144 if (threads_active) {
145 emergethread[i]->Stop();
146 emergethread[i]->qevent.signal();
147 emergethread[i]->Wait();
149 delete emergethread[i];
152 emergethread.clear();
160 if (params.sparams) {
161 delete params.sparams;
162 params.sparams = NULL;
167 void EmergeManager::loadMapgenParams()
169 params.load(*g_settings);
173 void EmergeManager::initMapgens()
178 if (!params.sparams) {
179 params.sparams = createMapgenParams(params.mg_name);
180 if (!params.sparams) {
181 params.mg_name = DEFAULT_MAPGEN;
182 params.sparams = createMapgenParams(params.mg_name);
183 assert(params.sparams);
185 params.sparams->readParams(g_settings);
188 // Create the mapgens
189 for (u32 i = 0; i != emergethread.size(); i++) {
190 Mapgen *mg = createMapgen(params.mg_name, i, ¶ms);
192 mapgen.push_back(mg);
197 Mapgen *EmergeManager::getCurrentMapgen()
199 for (u32 i = 0; i != emergethread.size(); i++) {
200 if (emergethread[i]->IsSameThread())
201 return emergethread[i]->mapgen;
208 void EmergeManager::startThreads()
213 for (u32 i = 0; i != emergethread.size(); i++)
214 emergethread[i]->Start();
216 threads_active = true;
220 void EmergeManager::stopThreads()
225 // Request thread stop in parallel
226 for (u32 i = 0; i != emergethread.size(); i++) {
227 emergethread[i]->Stop();
228 emergethread[i]->qevent.signal();
231 // Then do the waiting for each
232 for (u32 i = 0; i != emergethread.size(); i++)
233 emergethread[i]->Wait();
235 threads_active = false;
239 bool EmergeManager::enqueueBlockEmerge(u16 peer_id, v3s16 p, bool allow_generate)
241 std::map<v3s16, BlockEmergeData *>::const_iterator iter;
242 BlockEmergeData *bedata;
248 flags |= BLOCK_EMERGE_ALLOWGEN;
251 JMutexAutoLock queuelock(queuemutex);
253 count = blocks_enqueued.size();
254 if (count >= qlimit_total)
257 count = peer_queue_count[peer_id];
258 u16 qlimit_peer = allow_generate ? qlimit_generate : qlimit_diskonly;
259 if (count >= qlimit_peer)
262 iter = blocks_enqueued.find(p);
263 if (iter != blocks_enqueued.end()) {
264 bedata = iter->second;
265 bedata->flags |= flags;
269 bedata = new BlockEmergeData;
270 bedata->flags = flags;
271 bedata->peer_requested = peer_id;
272 blocks_enqueued.insert(std::make_pair(p, bedata));
274 peer_queue_count[peer_id] = count + 1;
276 // insert into the EmergeThread queue with the least items
277 int lowestitems = emergethread[0]->blockqueue.size();
278 for (u32 i = 1; i != emergethread.size(); i++) {
279 int nitems = emergethread[i]->blockqueue.size();
280 if (nitems < lowestitems) {
282 lowestitems = nitems;
286 emergethread[idx]->blockqueue.push(p);
288 emergethread[idx]->qevent.signal();
294 int EmergeManager::getGroundLevelAtPoint(v2s16 p)
296 if (mapgen.size() == 0 || !mapgen[0]) {
297 errorstream << "EmergeManager: getGroundLevelAtPoint() called"
298 " before mapgen initialized" << std::endl;
302 return mapgen[0]->getGroundLevelAtPoint(p);
306 bool EmergeManager::isBlockUnderground(v3s16 blockpos)
309 v2s16 p = v2s16((blockpos.X * MAP_BLOCKSIZE) + MAP_BLOCKSIZE / 2,
310 (blockpos.Y * MAP_BLOCKSIZE) + MAP_BLOCKSIZE / 2);
311 int ground_level = getGroundLevelAtPoint(p);
312 return blockpos.Y * (MAP_BLOCKSIZE + 1) <= min(water_level, ground_level);
315 //yuck, but then again, should i bother being accurate?
316 //the height of the nodes in a single block is quite variable
317 return blockpos.Y * (MAP_BLOCKSIZE + 1) <= params.water_level;
321 void EmergeManager::getMapgenNames(std::list<const char *> &mgnames)
323 for (u32 i = 0; i != ARRLEN(reg_mapgens); i++)
324 mgnames.push_back(reg_mapgens[i].name);
328 Mapgen *EmergeManager::createMapgen(const std::string &mgname, int mgid,
329 MapgenParams *mgparams)
332 for (i = 0; i != ARRLEN(reg_mapgens) && mgname != reg_mapgens[i].name; i++);
333 if (i == ARRLEN(reg_mapgens)) {
334 errorstream << "EmergeManager; mapgen " << mgname <<
335 " not registered" << std::endl;
339 MapgenFactory *mgfactory = reg_mapgens[i].factory;
340 return mgfactory->createMapgen(mgid, mgparams, this);
344 MapgenSpecificParams *EmergeManager::createMapgenParams(const std::string &mgname)
347 for (i = 0; i < ARRLEN(reg_mapgens) && mgname != reg_mapgens[i].name; i++);
348 if (i == ARRLEN(reg_mapgens)) {
349 errorstream << "EmergeManager: Mapgen " << mgname <<
350 " not registered" << std::endl;
354 MapgenFactory *mgfactory = reg_mapgens[i].factory;
355 return mgfactory->createMapgenParams();
359 ////////////////////////////// Emerge Thread //////////////////////////////////
361 bool EmergeThread::popBlockEmerge(v3s16 *pos, u8 *flags)
363 std::map<v3s16, BlockEmergeData *>::iterator iter;
364 JMutexAutoLock queuelock(emerge->queuemutex);
366 if (blockqueue.empty())
368 v3s16 p = blockqueue.front();
373 iter = emerge->blocks_enqueued.find(p);
374 if (iter == emerge->blocks_enqueued.end())
375 return false; //uh oh, queue and map out of sync!!
377 BlockEmergeData *bedata = iter->second;
378 *flags = bedata->flags;
380 emerge->peer_queue_count[bedata->peer_requested]--;
383 emerge->blocks_enqueued.erase(iter);
389 bool EmergeThread::getBlockOrStartGen(v3s16 p, MapBlock **b,
390 BlockMakeData *data, bool allow_gen)
393 //envlock: usually takes <=1ms, sometimes 90ms or ~400ms to acquire
394 JMutexAutoLock envlock(m_server->m_env_mutex);
396 // Load sector if it isn't loaded
397 if (map->getSectorNoGenerateNoEx(p2d) == NULL)
398 map->loadSectorMeta(p2d);
400 // Attempt to load block
401 MapBlock *block = map->getBlockNoCreateNoEx(p);
402 if (!block || block->isDummy() || !block->isGenerated()) {
403 EMERGE_DBG_OUT("not in memory, attempting to load from disk");
404 block = map->loadBlock(p);
405 if (block && block->isGenerated())
406 map->prepareBlock(block);
409 // If could not load and allowed to generate,
410 // start generation inside this same envlock
411 if (allow_gen && (block == NULL || !block->isGenerated())) {
412 EMERGE_DBG_OUT("generating");
414 return map->initBlockMake(data, p);
422 void *EmergeThread::Thread()
425 log_register_thread("EmergeThread" + itos(id));
426 DSTACK(__FUNCTION_NAME);
427 BEGIN_DEBUG_EXCEPTION_HANDLER
429 v3s16 last_tried_pos(-32768,-32768,-32768); // For error output
433 map = (ServerMap *)&(m_server->m_env->getMap());
434 emerge = m_server->m_emerge;
435 mapgen = emerge->mapgen[id];
436 enable_mapgen_debug_info = emerge->mapgen_debug_info;
438 porting::setThreadName("EmergeThread");
440 while (!StopRequested())
442 if (!popBlockEmerge(&p, &flags)) {
448 if (blockpos_over_limit(p))
451 bool allow_generate = flags & BLOCK_EMERGE_ALLOWGEN;
452 EMERGE_DBG_OUT("p=" PP(p) " allow_generate=" << allow_generate);
455 Try to fetch block from memory or disk.
456 If not found and asked to generate, initialize generator.
459 MapBlock *block = NULL;
460 std::map<v3s16, MapBlock *> modified_blocks;
462 if (getBlockOrStartGen(p, &block, &data, allow_generate) && mapgen) {
464 ScopeProfiler sp(g_profiler, "EmergeThread: Mapgen::makeChunk", SPT_AVG);
465 TimeTaker t("mapgen::make_block()");
467 mapgen->makeChunk(&data);
469 if (enable_mapgen_debug_info == false)
470 t.stop(true); // Hide output
474 //envlock: usually 0ms, but can take either 30 or 400ms to acquire
475 JMutexAutoLock envlock(m_server->m_env_mutex);
476 ScopeProfiler sp(g_profiler, "EmergeThread: after "
477 "Mapgen::makeChunk (envlock)", SPT_AVG);
479 map->finishBlockMake(&data, modified_blocks);
481 block = map->getBlockNoCreateNoEx(p);
484 Do some post-generate stuff
486 v3s16 minp = data.blockpos_min * MAP_BLOCKSIZE;
487 v3s16 maxp = data.blockpos_max * MAP_BLOCKSIZE +
488 v3s16(1,1,1) * (MAP_BLOCKSIZE - 1);
490 // Ignore map edit events, they will not need to be sent
491 // to anybody because the block hasn't been sent to anybody
492 MapEditEventAreaIgnorer
493 ign(&m_server->m_ignore_map_edit_events_area,
494 VoxelArea(minp, maxp));
495 try { // takes about 90ms with -O1 on an e3-1230v2
496 m_server->getScriptIface()->environment_OnGenerated(
497 minp, maxp, mapgen->blockseed);
498 } catch(LuaError &e) {
499 m_server->setAsyncFatalError(e.what());
502 EMERGE_DBG_OUT("ended up with: " << analyze_block(block));
504 m_server->m_env->activateBlock(block, 0);
510 Set sent status of modified blocks on clients
512 // Add the originally fetched block to the modified list
514 modified_blocks[p] = block;
516 if (modified_blocks.size() > 0) {
517 m_server->SetBlocksNotSent(modified_blocks);
520 catch (VersionMismatchException &e) {
521 std::ostringstream err;
522 err << "World data version mismatch in MapBlock " << PP(last_tried_pos) << std::endl
523 << "----" << std::endl
524 << "\"" << e.what() << "\"" << std::endl
525 << "See debug.txt." << std::endl
526 << "World probably saved by a newer version of " PROJECT_NAME "."
528 m_server->setAsyncFatalError(err.str());
530 catch (SerializationError &e) {
531 std::ostringstream err;
532 err << "Invalid data in MapBlock " << PP(last_tried_pos) << std::endl
533 << "----" << std::endl
534 << "\"" << e.what() << "\"" << std::endl
535 << "See debug.txt." << std::endl
536 << "You can ignore this using [ignore_world_load_errors = true]."
538 m_server->setAsyncFatalError(err.str());
542 JMutexAutoLock queuelock(emerge->queuemutex);
543 while (!blockqueue.empty())
545 v3s16 p = blockqueue.front();
548 std::map<v3s16, BlockEmergeData *>::iterator iter;
549 iter = emerge->blocks_enqueued.find(p);
550 if (iter == emerge->blocks_enqueued.end())
551 continue; //uh oh, queue and map out of sync!!
553 BlockEmergeData *bedata = iter->second;
558 END_DEBUG_EXCEPTION_HANDLER(errorstream)
559 log_deregister_thread();