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"
31 #include "constants.h"
35 #include "serverobject.h"
37 #include "scripting_game.h"
43 #include "mg_decoration.h"
44 #include "mg_schematic.h"
45 #include "mapgen_v5.h"
46 #include "mapgen_v6.h"
47 #include "mapgen_v7.h"
48 #include "mapgen_singlenode.h"
52 MapgenFactory *factory;
55 MapgenDesc reg_mapgens[] = {
56 {"v5", new MapgenFactoryV5},
57 {"v6", new MapgenFactoryV6},
58 {"v7", new MapgenFactoryV7},
59 {"singlenode", new MapgenFactorySinglenode},
62 class EmergeThread : public JThread
67 EmergeManager *emerge;
69 bool enable_mapgen_debug_info;
73 std::queue<v3s16> blockqueue;
75 EmergeThread(Server *server, int ethreadid):
81 enable_mapgen_debug_info(false),
87 bool popBlockEmerge(v3s16 *pos, u8 *flags);
88 bool getBlockOrStartGen(v3s16 p, MapBlock **b,
89 BlockMakeData *data, bool allow_generate);
93 /////////////////////////////// Emerge Manager ////////////////////////////////
95 EmergeManager::EmergeManager(IGameDef *gamedef)
97 this->ndef = gamedef->getNodeDefManager();
98 this->biomemgr = new BiomeManager(gamedef);
99 this->oremgr = new OreManager(gamedef);
100 this->decomgr = new DecorationManager(gamedef);
101 this->schemmgr = new SchematicManager(gamedef);
102 this->gen_notify_on = 0;
104 // Note that accesses to this variable are not synchronized.
105 // This is because the *only* thread ever starting or stopping
106 // EmergeThreads should be the ServerThread.
107 this->threads_active = false;
109 mapgen_debug_info = g_settings->getBool("enable_mapgen_debug_info");
111 // if unspecified, leave a proc for the main thread and one for
112 // some other misc thread
114 if (!g_settings->getS16NoEx("num_emerge_threads", nthreads))
115 nthreads = porting::getNumberOfProcessors() - 2;
119 qlimit_total = g_settings->getU16("emergequeue_limit_total");
120 if (!g_settings->getU16NoEx("emergequeue_limit_diskonly", qlimit_diskonly))
121 qlimit_diskonly = nthreads * 5 + 1;
122 if (!g_settings->getU16NoEx("emergequeue_limit_generate", qlimit_generate))
123 qlimit_generate = nthreads + 1;
125 // don't trust user input for something very important like this
126 if (qlimit_total < 1)
128 if (qlimit_diskonly < 1)
130 if (qlimit_generate < 1)
133 for (s16 i = 0; i < nthreads; i++)
134 emergethread.push_back(new EmergeThread((Server *) gamedef, i));
136 infostream << "EmergeManager: using " << nthreads << " threads" << std::endl;
140 EmergeManager::~EmergeManager()
142 for (u32 i = 0; i != emergethread.size(); i++) {
143 if (threads_active) {
144 emergethread[i]->Stop();
145 emergethread[i]->qevent.signal();
146 emergethread[i]->Wait();
148 delete emergethread[i];
151 emergethread.clear();
159 if (params.sparams) {
160 delete params.sparams;
161 params.sparams = NULL;
166 void EmergeManager::loadMapgenParams()
168 params.load(*g_settings);
172 void EmergeManager::initMapgens()
177 if (!params.sparams) {
178 params.sparams = createMapgenParams(params.mg_name);
179 if (!params.sparams) {
180 params.mg_name = DEFAULT_MAPGEN;
181 params.sparams = createMapgenParams(params.mg_name);
182 assert(params.sparams);
184 params.sparams->readParams(g_settings);
187 // Create the mapgens
188 for (u32 i = 0; i != emergethread.size(); i++) {
189 Mapgen *mg = createMapgen(params.mg_name, i, ¶ms);
191 mapgen.push_back(mg);
196 Mapgen *EmergeManager::getCurrentMapgen()
198 for (u32 i = 0; i != emergethread.size(); i++) {
199 if (emergethread[i]->IsSameThread())
200 return emergethread[i]->mapgen;
207 void EmergeManager::startThreads()
212 for (u32 i = 0; i != emergethread.size(); i++)
213 emergethread[i]->Start();
215 threads_active = true;
219 void EmergeManager::stopThreads()
224 // Request thread stop in parallel
225 for (u32 i = 0; i != emergethread.size(); i++) {
226 emergethread[i]->Stop();
227 emergethread[i]->qevent.signal();
230 // Then do the waiting for each
231 for (u32 i = 0; i != emergethread.size(); i++)
232 emergethread[i]->Wait();
234 threads_active = false;
238 bool EmergeManager::enqueueBlockEmerge(u16 peer_id, v3s16 p, bool allow_generate)
240 std::map<v3s16, BlockEmergeData *>::const_iterator iter;
241 BlockEmergeData *bedata;
247 flags |= BLOCK_EMERGE_ALLOWGEN;
250 JMutexAutoLock queuelock(queuemutex);
252 count = blocks_enqueued.size();
253 if (count >= qlimit_total)
256 count = peer_queue_count[peer_id];
257 u16 qlimit_peer = allow_generate ? qlimit_generate : qlimit_diskonly;
258 if (count >= qlimit_peer)
261 iter = blocks_enqueued.find(p);
262 if (iter != blocks_enqueued.end()) {
263 bedata = iter->second;
264 bedata->flags |= flags;
268 bedata = new BlockEmergeData;
269 bedata->flags = flags;
270 bedata->peer_requested = peer_id;
271 blocks_enqueued.insert(std::make_pair(p, bedata));
273 peer_queue_count[peer_id] = count + 1;
275 // insert into the EmergeThread queue with the least items
276 int lowestitems = emergethread[0]->blockqueue.size();
277 for (u32 i = 1; i != emergethread.size(); i++) {
278 int nitems = emergethread[i]->blockqueue.size();
279 if (nitems < lowestitems) {
281 lowestitems = nitems;
285 emergethread[idx]->blockqueue.push(p);
287 emergethread[idx]->qevent.signal();
293 int EmergeManager::getGroundLevelAtPoint(v2s16 p)
295 if (mapgen.size() == 0 || !mapgen[0]) {
296 errorstream << "EmergeManager: getGroundLevelAtPoint() called"
297 " before mapgen initialized" << std::endl;
301 return mapgen[0]->getGroundLevelAtPoint(p);
305 bool EmergeManager::isBlockUnderground(v3s16 blockpos)
308 v2s16 p = v2s16((blockpos.X * MAP_BLOCKSIZE) + MAP_BLOCKSIZE / 2,
309 (blockpos.Y * MAP_BLOCKSIZE) + MAP_BLOCKSIZE / 2);
310 int ground_level = getGroundLevelAtPoint(p);
311 return blockpos.Y * (MAP_BLOCKSIZE + 1) <= min(water_level, ground_level);
314 //yuck, but then again, should i bother being accurate?
315 //the height of the nodes in a single block is quite variable
316 return blockpos.Y * (MAP_BLOCKSIZE + 1) <= params.water_level;
320 void EmergeManager::getMapgenNames(std::list<const char *> &mgnames)
322 for (u32 i = 0; i != ARRLEN(reg_mapgens); i++)
323 mgnames.push_back(reg_mapgens[i].name);
327 Mapgen *EmergeManager::createMapgen(const std::string &mgname, int mgid,
328 MapgenParams *mgparams)
331 for (i = 0; i != ARRLEN(reg_mapgens) && mgname != reg_mapgens[i].name; i++);
332 if (i == ARRLEN(reg_mapgens)) {
333 errorstream << "EmergeManager; mapgen " << mgname <<
334 " not registered" << std::endl;
338 MapgenFactory *mgfactory = reg_mapgens[i].factory;
339 return mgfactory->createMapgen(mgid, mgparams, this);
343 MapgenSpecificParams *EmergeManager::createMapgenParams(const std::string &mgname)
346 for (i = 0; i < ARRLEN(reg_mapgens) && mgname != reg_mapgens[i].name; i++);
347 if (i == ARRLEN(reg_mapgens)) {
348 errorstream << "EmergeManager: Mapgen " << mgname <<
349 " not registered" << std::endl;
353 MapgenFactory *mgfactory = reg_mapgens[i].factory;
354 return mgfactory->createMapgenParams();
358 ////////////////////////////// Emerge Thread //////////////////////////////////
360 bool EmergeThread::popBlockEmerge(v3s16 *pos, u8 *flags)
362 std::map<v3s16, BlockEmergeData *>::iterator iter;
363 JMutexAutoLock queuelock(emerge->queuemutex);
365 if (blockqueue.empty())
367 v3s16 p = blockqueue.front();
372 iter = emerge->blocks_enqueued.find(p);
373 if (iter == emerge->blocks_enqueued.end())
374 return false; //uh oh, queue and map out of sync!!
376 BlockEmergeData *bedata = iter->second;
377 *flags = bedata->flags;
379 emerge->peer_queue_count[bedata->peer_requested]--;
382 emerge->blocks_enqueued.erase(iter);
388 bool EmergeThread::getBlockOrStartGen(v3s16 p, MapBlock **b,
389 BlockMakeData *data, bool allow_gen)
392 //envlock: usually takes <=1ms, sometimes 90ms or ~400ms to acquire
393 JMutexAutoLock envlock(m_server->m_env_mutex);
395 // Load sector if it isn't loaded
396 if (map->getSectorNoGenerateNoEx(p2d) == NULL)
397 map->loadSectorMeta(p2d);
399 // Attempt to load block
400 MapBlock *block = map->getBlockNoCreateNoEx(p);
401 if (!block || block->isDummy() || !block->isGenerated()) {
402 EMERGE_DBG_OUT("not in memory, attempting to load from disk");
403 block = map->loadBlock(p);
404 if (block && block->isGenerated())
405 map->prepareBlock(block);
408 // If could not load and allowed to generate,
409 // start generation inside this same envlock
410 if (allow_gen && (block == NULL || !block->isGenerated())) {
411 EMERGE_DBG_OUT("generating");
413 return map->initBlockMake(data, p);
421 void *EmergeThread::Thread()
424 log_register_thread("EmergeThread" + itos(id));
425 DSTACK(__FUNCTION_NAME);
426 BEGIN_DEBUG_EXCEPTION_HANDLER
428 v3s16 last_tried_pos(-32768,-32768,-32768); // For error output
432 map = (ServerMap *)&(m_server->m_env->getMap());
433 emerge = m_server->m_emerge;
434 mapgen = emerge->mapgen[id];
435 enable_mapgen_debug_info = emerge->mapgen_debug_info;
437 porting::setThreadName("EmergeThread");
439 while (!StopRequested())
441 if (!popBlockEmerge(&p, &flags)) {
447 if (blockpos_over_limit(p))
450 bool allow_generate = flags & BLOCK_EMERGE_ALLOWGEN;
451 EMERGE_DBG_OUT("p=" PP(p) " allow_generate=" << allow_generate);
454 Try to fetch block from memory or disk.
455 If not found and asked to generate, initialize generator.
458 MapBlock *block = NULL;
459 std::map<v3s16, MapBlock *> modified_blocks;
461 if (getBlockOrStartGen(p, &block, &data, allow_generate) && mapgen) {
463 ScopeProfiler sp(g_profiler, "EmergeThread: Mapgen::makeChunk", SPT_AVG);
464 TimeTaker t("mapgen::make_block()");
466 mapgen->makeChunk(&data);
468 if (enable_mapgen_debug_info == false)
469 t.stop(true); // Hide output
473 //envlock: usually 0ms, but can take either 30 or 400ms to acquire
474 JMutexAutoLock envlock(m_server->m_env_mutex);
475 ScopeProfiler sp(g_profiler, "EmergeThread: after "
476 "Mapgen::makeChunk (envlock)", SPT_AVG);
478 map->finishBlockMake(&data, modified_blocks);
480 block = map->getBlockNoCreateNoEx(p);
483 Do some post-generate stuff
485 v3s16 minp = data.blockpos_min * MAP_BLOCKSIZE;
486 v3s16 maxp = data.blockpos_max * MAP_BLOCKSIZE +
487 v3s16(1,1,1) * (MAP_BLOCKSIZE - 1);
489 // Ignore map edit events, they will not need to be sent
490 // to anybody because the block hasn't been sent to anybody
491 MapEditEventAreaIgnorer
492 ign(&m_server->m_ignore_map_edit_events_area,
493 VoxelArea(minp, maxp));
494 try { // takes about 90ms with -O1 on an e3-1230v2
495 m_server->getScriptIface()->environment_OnGenerated(
496 minp, maxp, mapgen->blockseed);
497 } catch (LuaError &e) {
498 m_server->setAsyncFatalError("Lua: " + std::string(e.what()));
501 EMERGE_DBG_OUT("ended up with: " << analyze_block(block));
503 m_server->m_env->activateBlock(block, 0);
509 Set sent status of modified blocks on clients
511 // Add the originally fetched block to the modified list
513 modified_blocks[p] = block;
515 if (modified_blocks.size() > 0) {
516 m_server->SetBlocksNotSent(modified_blocks);
519 catch (VersionMismatchException &e) {
520 std::ostringstream err;
521 err << "World data version mismatch in MapBlock " << PP(last_tried_pos) << std::endl
522 << "----" << std::endl
523 << "\"" << e.what() << "\"" << std::endl
524 << "See debug.txt." << std::endl
525 << "World probably saved by a newer version of " PROJECT_NAME_C "."
527 m_server->setAsyncFatalError(err.str());
529 catch (SerializationError &e) {
530 std::ostringstream err;
531 err << "Invalid data in MapBlock " << PP(last_tried_pos) << std::endl
532 << "----" << std::endl
533 << "\"" << e.what() << "\"" << std::endl
534 << "See debug.txt." << std::endl
535 << "You can ignore this using [ignore_world_load_errors = true]."
537 m_server->setAsyncFatalError(err.str());
541 JMutexAutoLock queuelock(emerge->queuemutex);
542 while (!blockqueue.empty())
544 v3s16 p = blockqueue.front();
547 std::map<v3s16, BlockEmergeData *>::iterator iter;
548 iter = emerge->blocks_enqueued.find(p);
549 if (iter == emerge->blocks_enqueued.end())
550 continue; //uh oh, queue and map out of sync!!
552 BlockEmergeData *bedata = iter->second;
557 END_DEBUG_EXCEPTION_HANDLER(errorstream)
558 log_deregister_thread();