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"
43 #include "mapgen_v6.h"
44 #include "mapgen_v7.h"
45 #include "mapgen_indev.h"
46 #include "mapgen_singlenode.h"
47 #include "mapgen_math.h"
50 class EmergeThread : public SimpleThread
55 EmergeManager *emerge;
57 bool enable_mapgen_debug_info;
61 std::queue<v3s16> blockqueue;
63 EmergeThread(Server *server, int ethreadid):
78 if(IsRunning() == false)
84 bool popBlockEmerge(v3s16 *pos, u8 *flags);
85 bool getBlockOrStartGen(v3s16 p, MapBlock **b,
86 BlockMakeData *data, bool allow_generate);
90 /////////////////////////////// Emerge Manager ////////////////////////////////
92 EmergeManager::EmergeManager(IGameDef *gamedef) {
93 //register built-in mapgens
94 registerMapgen("v6", new MapgenFactoryV6());
95 registerMapgen("v7", new MapgenFactoryV7());
96 registerMapgen("indev", new MapgenFactoryIndev());
97 registerMapgen("singlenode", new MapgenFactorySinglenode());
98 registerMapgen("math", new MapgenFactoryMath());
100 this->ndef = gamedef->getNodeDefManager();
101 this->biomedef = new BiomeDefManager();
104 this->luaoverride_params = NULL;
105 this->luaoverride_params_modified = 0;
106 this->luaoverride_flagmask = 0;
110 mapgen_debug_info = g_settings->getBool("enable_mapgen_debug_info");
113 if (g_settings->get("num_emerge_threads").empty()) {
114 int nprocs = porting::getNumberOfProcessors();
115 // leave a proc for the main thread and one for some other misc threads
116 nthreads = (nprocs > 2) ? nprocs - 2 : 1;
118 nthreads = g_settings->getU16("num_emerge_threads");
123 qlimit_total = g_settings->getU16("emergequeue_limit_total");
124 qlimit_diskonly = g_settings->get("emergequeue_limit_diskonly").empty() ?
126 g_settings->getU16("emergequeue_limit_diskonly");
127 qlimit_generate = g_settings->get("emergequeue_limit_generate").empty() ?
129 g_settings->getU16("emergequeue_limit_generate");
131 for (int i = 0; i != nthreads; i++)
132 emergethread.push_back(new EmergeThread((Server *)gamedef, i));
134 infostream << "EmergeManager: using " << nthreads << " threads" << std::endl;
138 EmergeManager::~EmergeManager() {
139 for (unsigned int i = 0; i != emergethread.size(); i++) {
140 emergethread[i]->setRun(false);
141 emergethread[i]->qevent.signal();
142 emergethread[i]->stop();
143 delete emergethread[i];
146 emergethread.clear();
149 for (unsigned int i = 0; i < ores.size(); i++)
153 for (unsigned int i = 0; i < decorations.size(); i++)
154 delete decorations[i];
157 for (std::map<std::string, MapgenFactory *>::iterator iter = mglist.begin();
158 iter != mglist.end(); iter ++) {
167 void EmergeManager::initMapgens(MapgenParams *mgparams) {
173 // Resolve names of nodes for things that were registered
174 // (at this point, the registration period is over)
175 biomedef->resolveNodeNames(ndef);
177 for (size_t i = 0; i != ores.size(); i++)
178 ores[i]->resolveNodeNames(ndef);
180 for (size_t i = 0; i != decorations.size(); i++)
181 decorations[i]->resolveNodeNames(ndef);
183 // Apply mapgen parameter overrides from Lua
184 if (luaoverride_params) {
185 if (luaoverride_params_modified & MGPARAMS_SET_MGNAME) {
186 MapgenParams *mgp = setMapgenType(mgparams, luaoverride_params->mg_name);
188 errorstream << "EmergeManager: Failed to set new mapgen name"
195 if (luaoverride_params_modified & MGPARAMS_SET_SEED)
196 mgparams->seed = luaoverride_params->seed;
198 if (luaoverride_params_modified & MGPARAMS_SET_WATER_LEVEL)
199 mgparams->water_level = luaoverride_params->water_level;
201 if (luaoverride_params_modified & MGPARAMS_SET_FLAGS) {
202 mgparams->flags &= ~luaoverride_flagmask;
203 mgparams->flags |= luaoverride_params->flags;
206 delete luaoverride_params;
207 luaoverride_params = NULL;
210 // Create the mapgens
211 this->params = mgparams;
212 for (size_t i = 0; i != emergethread.size(); i++) {
213 mg = createMapgen(params->mg_name, i, params);
215 infostream << "EmergeManager: Falling back to Mapgen V6" << std::endl;
217 params = setMapgenType(params, "v6");
218 mg = createMapgen(params->mg_name, i, params);
220 errorstream << "EmergeManager: CRITICAL ERROR: Failed to fall"
221 "back to Mapgen V6, not generating map" << std::endl;
224 mapgen.push_back(mg);
229 MapgenParams *EmergeManager::setMapgenType(MapgenParams *mgparams,
230 std::string newname) {
231 MapgenParams *newparams = createMapgenParams(newname);
233 errorstream << "EmergeManager: Mapgen override failed" << std::endl;
237 newparams->mg_name = newname;
238 newparams->seed = mgparams->seed;
239 newparams->water_level = mgparams->water_level;
240 newparams->chunksize = mgparams->chunksize;
241 newparams->flags = mgparams->flags;
243 if (!newparams->readParams(g_settings)) {
244 errorstream << "EmergeManager: Mapgen override failed" << std::endl;
254 Mapgen *EmergeManager::getCurrentMapgen() {
255 for (unsigned int i = 0; i != emergethread.size(); i++) {
256 if (emergethread[i]->IsSameThread())
257 return emergethread[i]->mapgen;
264 void EmergeManager::triggerAllThreads() {
265 for (unsigned int i = 0; i != emergethread.size(); i++)
266 emergethread[i]->trigger();
270 bool EmergeManager::enqueueBlockEmerge(u16 peer_id, v3s16 p, bool allow_generate) {
271 std::map<v3s16, BlockEmergeData *>::const_iterator iter;
272 BlockEmergeData *bedata;
278 flags |= BLOCK_EMERGE_ALLOWGEN;
281 JMutexAutoLock queuelock(queuemutex);
283 count = blocks_enqueued.size();
284 if (count >= qlimit_total)
287 count = peer_queue_count[peer_id];
288 u16 qlimit_peer = allow_generate ? qlimit_generate : qlimit_diskonly;
289 if (count >= qlimit_peer)
292 iter = blocks_enqueued.find(p);
293 if (iter != blocks_enqueued.end()) {
294 bedata = iter->second;
295 bedata->flags |= flags;
299 bedata = new BlockEmergeData;
300 bedata->flags = flags;
301 bedata->peer_requested = peer_id;
302 blocks_enqueued.insert(std::make_pair(p, bedata));
304 peer_queue_count[peer_id] = count + 1;
306 // insert into the EmergeThread queue with the least items
307 int lowestitems = emergethread[0]->blockqueue.size();
308 for (unsigned int i = 1; i != emergethread.size(); i++) {
309 int nitems = emergethread[i]->blockqueue.size();
310 if (nitems < lowestitems) {
312 lowestitems = nitems;
316 emergethread[idx]->blockqueue.push(p);
318 emergethread[idx]->qevent.signal();
324 int EmergeManager::getGroundLevelAtPoint(v2s16 p) {
325 if (mapgen.size() == 0 || !mapgen[0]) {
326 errorstream << "EmergeManager: getGroundLevelAtPoint() called"
327 " before mapgen initialized" << std::endl;
331 return mapgen[0]->getGroundLevelAtPoint(p);
335 bool EmergeManager::isBlockUnderground(v3s16 blockpos) {
337 v2s16 p = v2s16((blockpos.X * MAP_BLOCKSIZE) + MAP_BLOCKSIZE / 2,
338 (blockpos.Y * MAP_BLOCKSIZE) + MAP_BLOCKSIZE / 2);
339 int ground_level = getGroundLevelAtPoint(p);
340 return blockpos.Y * (MAP_BLOCKSIZE + 1) <= min(water_level, ground_level);
343 //yuck, but then again, should i bother being accurate?
344 //the height of the nodes in a single block is quite variable
345 return blockpos.Y * (MAP_BLOCKSIZE + 1) <= params->water_level;
349 u32 EmergeManager::getBlockSeed(v3s16 p) {
350 return (u32)(params->seed & 0xFFFFFFFF) +
357 Mapgen *EmergeManager::createMapgen(std::string mgname, int mgid,
358 MapgenParams *mgparams) {
359 std::map<std::string, MapgenFactory *>::const_iterator iter;
360 iter = mglist.find(mgname);
361 if (iter == mglist.end()) {
362 errorstream << "EmergeManager; mapgen " << mgname <<
363 " not registered" << std::endl;
367 MapgenFactory *mgfactory = iter->second;
368 return mgfactory->createMapgen(mgid, mgparams, this);
372 MapgenParams *EmergeManager::createMapgenParams(std::string mgname) {
373 std::map<std::string, MapgenFactory *>::const_iterator iter;
374 iter = mglist.find(mgname);
375 if (iter == mglist.end()) {
376 errorstream << "EmergeManager: mapgen " << mgname <<
377 " not registered" << std::endl;
381 MapgenFactory *mgfactory = iter->second;
382 return mgfactory->createMapgenParams();
386 MapgenParams *EmergeManager::getParamsFromSettings(Settings *settings) {
387 std::string mg_name = settings->get("mg_name");
388 MapgenParams *mgparams = createMapgenParams(mg_name);
392 std::string seedstr = settings->get(settings == g_settings ?
393 "fixed_map_seed" : "seed");
395 mgparams->mg_name = mg_name;
396 mgparams->seed = read_seed(seedstr.c_str());
397 mgparams->water_level = settings->getS16("water_level");
398 mgparams->chunksize = settings->getS16("chunksize");
399 mgparams->flags = settings->getFlagStr("mg_flags", flagdesc_mapgen);
401 if (!mgparams->readParams(settings)) {
409 void EmergeManager::setParamsToSettings(Settings *settings) {
410 settings->set("mg_name", params->mg_name);
411 settings->setU64("seed", params->seed);
412 settings->setS16("water_level", params->water_level);
413 settings->setS16("chunksize", params->chunksize);
414 settings->setFlagStr("mg_flags", params->flags, flagdesc_mapgen);
416 params->writeParams(settings);
420 void EmergeManager::registerMapgen(std::string mgname, MapgenFactory *mgfactory) {
421 mglist.insert(std::make_pair(mgname, mgfactory));
422 infostream << "EmergeManager: registered mapgen " << mgname << std::endl;
426 ////////////////////////////// Emerge Thread //////////////////////////////////
428 bool EmergeThread::popBlockEmerge(v3s16 *pos, u8 *flags) {
429 std::map<v3s16, BlockEmergeData *>::iterator iter;
430 JMutexAutoLock queuelock(emerge->queuemutex);
432 if (blockqueue.empty())
434 v3s16 p = blockqueue.front();
439 iter = emerge->blocks_enqueued.find(p);
440 if (iter == emerge->blocks_enqueued.end())
441 return false; //uh oh, queue and map out of sync!!
443 BlockEmergeData *bedata = iter->second;
444 *flags = bedata->flags;
446 emerge->peer_queue_count[bedata->peer_requested]--;
449 emerge->blocks_enqueued.erase(iter);
455 bool EmergeThread::getBlockOrStartGen(v3s16 p, MapBlock **b,
456 BlockMakeData *data, bool allow_gen) {
458 //envlock: usually takes <=1ms, sometimes 90ms or ~400ms to acquire
459 JMutexAutoLock envlock(m_server->m_env_mutex);
461 // Load sector if it isn't loaded
462 if (map->getSectorNoGenerateNoEx(p2d) == NULL)
463 map->loadSectorMeta(p2d);
465 // Attempt to load block
466 MapBlock *block = map->getBlockNoCreateNoEx(p);
467 if (!block || block->isDummy() || !block->isGenerated()) {
468 EMERGE_DBG_OUT("not in memory, attempting to load from disk");
469 block = map->loadBlock(p);
470 if (block && block->isGenerated())
471 map->prepareBlock(block);
474 // If could not load and allowed to generate,
475 // start generation inside this same envlock
476 if (allow_gen && (block == NULL || !block->isGenerated())) {
477 EMERGE_DBG_OUT("generating");
479 return map->initBlockMake(data, p);
487 void *EmergeThread::Thread() {
489 log_register_thread("EmergeThread" + itos(id));
490 DSTACK(__FUNCTION_NAME);
491 BEGIN_DEBUG_EXCEPTION_HANDLER
493 v3s16 last_tried_pos(-32768,-32768,-32768); // For error output
497 map = (ServerMap *)&(m_server->m_env->getMap());
498 emerge = m_server->m_emerge;
499 mapgen = emerge->mapgen[id];
500 enable_mapgen_debug_info = emerge->mapgen_debug_info;
504 if (!popBlockEmerge(&p, &flags)) {
510 if (blockpos_over_limit(p))
513 bool allow_generate = flags & BLOCK_EMERGE_ALLOWGEN;
514 EMERGE_DBG_OUT("p=" PP(p) " allow_generate=" << allow_generate);
517 Try to fetch block from memory or disk.
518 If not found and asked to generate, initialize generator.
521 MapBlock *block = NULL;
522 std::map<v3s16, MapBlock *> modified_blocks;
524 if (getBlockOrStartGen(p, &block, &data, allow_generate) && mapgen) {
526 ScopeProfiler sp(g_profiler, "EmergeThread: Mapgen::makeChunk", SPT_AVG);
527 TimeTaker t("mapgen::make_block()");
529 mapgen->makeChunk(&data);
531 if (enable_mapgen_debug_info == false)
532 t.stop(true); // Hide output
536 //envlock: usually 0ms, but can take either 30 or 400ms to acquire
537 JMutexAutoLock envlock(m_server->m_env_mutex);
538 ScopeProfiler sp(g_profiler, "EmergeThread: after "
539 "Mapgen::makeChunk (envlock)", SPT_AVG);
541 map->finishBlockMake(&data, modified_blocks);
543 block = map->getBlockNoCreateNoEx(p);
546 Do some post-generate stuff
548 v3s16 minp = data.blockpos_min * MAP_BLOCKSIZE;
549 v3s16 maxp = data.blockpos_max * MAP_BLOCKSIZE +
550 v3s16(1,1,1) * (MAP_BLOCKSIZE - 1);
552 // Ignore map edit events, they will not need to be sent
553 // to anybody because the block hasn't been sent to anybody
554 MapEditEventAreaIgnorer
555 ign(&m_server->m_ignore_map_edit_events_area,
556 VoxelArea(minp, maxp));
557 try { // takes about 90ms with -O1 on an e3-1230v2
558 m_server->getScriptIface()->environment_OnGenerated(
559 minp, maxp, emerge->getBlockSeed(minp));
560 } catch(LuaError &e) {
561 m_server->setAsyncFatalError(e.what());
564 EMERGE_DBG_OUT("ended up with: " << analyze_block(block));
566 m_server->m_env->activateBlock(block, 0);
572 Set sent status of modified blocks on clients
575 // NOTE: Server's clients are also behind the connection mutex
576 //conlock: consistently takes 30-40ms to acquire
577 JMutexAutoLock lock(m_server->m_con_mutex);
578 // Add the originally fetched block to the modified list
580 modified_blocks[p] = block;
582 // Set the modified blocks unsent for all the clients
583 for (std::map<u16, RemoteClient*>::iterator
584 i = m_server->m_clients.begin();
585 i != m_server->m_clients.end(); ++i) {
586 RemoteClient *client = i->second;
587 if (modified_blocks.size() > 0) {
588 // Remove block from sent history
589 client->SetBlocksNotSent(modified_blocks);
593 catch (VersionMismatchException &e) {
594 std::ostringstream err;
595 err << "World data version mismatch in MapBlock "<<PP(last_tried_pos)<<std::endl;
596 err << "----"<<std::endl;
597 err << "\""<<e.what()<<"\""<<std::endl;
598 err << "See debug.txt."<<std::endl;
599 err << "World probably saved by a newer version of Minetest."<<std::endl;
600 m_server->setAsyncFatalError(err.str());
602 catch (SerializationError &e) {
603 std::ostringstream err;
604 err << "Invalid data in MapBlock "<<PP(last_tried_pos)<<std::endl;
605 err << "----"<<std::endl;
606 err << "\""<<e.what()<<"\""<<std::endl;
607 err << "See debug.txt."<<std::endl;
608 err << "You can ignore this using [ignore_world_load_errors = true]."<<std::endl;
609 m_server->setAsyncFatalError(err.str());
612 END_DEBUG_EXCEPTION_HANDLER(errorstream)
613 log_deregister_thread();