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 JThread
55 EmergeManager *emerge;
57 bool enable_mapgen_debug_info;
61 std::queue<v3s16> blockqueue;
63 EmergeThread(Server *server, int ethreadid):
69 enable_mapgen_debug_info(false),
75 bool popBlockEmerge(v3s16 *pos, u8 *flags);
76 bool getBlockOrStartGen(v3s16 p, MapBlock **b,
77 BlockMakeData *data, bool allow_generate);
81 /////////////////////////////// Emerge Manager ////////////////////////////////
83 EmergeManager::EmergeManager(IGameDef *gamedef) {
84 //register built-in mapgens
85 registerMapgen("v6", new MapgenFactoryV6());
86 registerMapgen("v7", new MapgenFactoryV7());
87 registerMapgen("indev", new MapgenFactoryIndev());
88 registerMapgen("singlenode", new MapgenFactorySinglenode());
89 registerMapgen("math", new MapgenFactoryMath());
91 this->ndef = gamedef->getNodeDefManager();
92 this->biomedef = new BiomeDefManager();
95 // Note that accesses to this variable are not synchronized.
96 // This is because the *only* thread ever starting or stopping
97 // EmergeThreads should be the ServerThread.
98 this->threads_active = false;
100 this->luaoverride_params = NULL;
101 this->luaoverride_params_modified = 0;
102 this->luaoverride_flagmask = 0;
106 mapgen_debug_info = g_settings->getBool("enable_mapgen_debug_info");
109 if (g_settings->get("num_emerge_threads").empty()) {
110 int nprocs = porting::getNumberOfProcessors();
111 // leave a proc for the main thread and one for some other misc threads
112 nthreads = (nprocs > 2) ? nprocs - 2 : 1;
114 nthreads = g_settings->getU16("num_emerge_threads");
119 qlimit_total = g_settings->getU16("emergequeue_limit_total");
120 qlimit_diskonly = g_settings->get("emergequeue_limit_diskonly").empty() ?
122 g_settings->getU16("emergequeue_limit_diskonly");
123 qlimit_generate = g_settings->get("emergequeue_limit_generate").empty() ?
125 g_settings->getU16("emergequeue_limit_generate");
127 for (int i = 0; i != nthreads; i++)
128 emergethread.push_back(new EmergeThread((Server *)gamedef, i));
130 infostream << "EmergeManager: using " << nthreads << " threads" << std::endl;
134 EmergeManager::~EmergeManager() {
135 for (unsigned int i = 0; i != emergethread.size(); i++) {
136 if (threads_active) {
137 emergethread[i]->Stop();
138 emergethread[i]->qevent.signal();
139 emergethread[i]->Wait();
141 delete emergethread[i];
144 emergethread.clear();
147 for (unsigned int i = 0; i < ores.size(); i++)
151 for (unsigned int i = 0; i < decorations.size(); i++)
152 delete decorations[i];
155 for (std::map<std::string, MapgenFactory *>::iterator iter = mglist.begin();
156 iter != mglist.end(); iter ++) {
165 void EmergeManager::initMapgens(MapgenParams *mgparams) {
171 // Resolve names of nodes for things that were registered
172 // (at this point, the registration period is over)
173 biomedef->resolveNodeNames(ndef);
175 for (size_t i = 0; i != ores.size(); i++)
176 ores[i]->resolveNodeNames(ndef);
178 for (size_t i = 0; i != decorations.size(); i++)
179 decorations[i]->resolveNodeNames(ndef);
181 // Apply mapgen parameter overrides from Lua
182 if (luaoverride_params) {
183 if (luaoverride_params_modified & MGPARAMS_SET_MGNAME) {
184 MapgenParams *mgp = setMapgenType(mgparams, luaoverride_params->mg_name);
186 errorstream << "EmergeManager: Failed to set new mapgen name"
193 if (luaoverride_params_modified & MGPARAMS_SET_SEED)
194 mgparams->seed = luaoverride_params->seed;
196 if (luaoverride_params_modified & MGPARAMS_SET_WATER_LEVEL)
197 mgparams->water_level = luaoverride_params->water_level;
199 if (luaoverride_params_modified & MGPARAMS_SET_FLAGS) {
200 mgparams->flags &= ~luaoverride_flagmask;
201 mgparams->flags |= luaoverride_params->flags;
204 delete luaoverride_params;
205 luaoverride_params = NULL;
208 // Create the mapgens
209 this->params = mgparams;
210 for (size_t i = 0; i != emergethread.size(); i++) {
211 mg = createMapgen(params->mg_name, i, params);
213 infostream << "EmergeManager: Falling back to Mapgen V6" << std::endl;
215 params = setMapgenType(params, "v6");
216 mg = createMapgen(params->mg_name, i, params);
218 errorstream << "EmergeManager: CRITICAL ERROR: Failed to fall"
219 "back to Mapgen V6, not generating map" << std::endl;
222 mapgen.push_back(mg);
227 MapgenParams *EmergeManager::setMapgenType(MapgenParams *mgparams,
228 std::string newname) {
229 MapgenParams *newparams = createMapgenParams(newname);
231 errorstream << "EmergeManager: Mapgen override failed" << std::endl;
235 newparams->mg_name = newname;
236 newparams->seed = mgparams->seed;
237 newparams->water_level = mgparams->water_level;
238 newparams->chunksize = mgparams->chunksize;
239 newparams->flags = mgparams->flags;
241 if (!newparams->readParams(g_settings)) {
242 errorstream << "EmergeManager: Mapgen override failed" << std::endl;
252 Mapgen *EmergeManager::getCurrentMapgen() {
253 for (unsigned int i = 0; i != emergethread.size(); i++) {
254 if (emergethread[i]->IsSameThread())
255 return emergethread[i]->mapgen;
262 void EmergeManager::startThreads() {
266 for (unsigned int i = 0; i != emergethread.size(); i++)
267 emergethread[i]->Start();
269 threads_active = true;
273 void EmergeManager::stopThreads() {
277 // Request thread stop in parallel
278 for (unsigned int i = 0; i != emergethread.size(); i++) {
279 emergethread[i]->Stop();
280 emergethread[i]->qevent.signal();
283 // Then do the waiting for each
284 for (unsigned int i = 0; i != emergethread.size(); i++)
285 emergethread[i]->Wait();
287 threads_active = false;
291 bool EmergeManager::enqueueBlockEmerge(u16 peer_id, v3s16 p, bool allow_generate) {
292 std::map<v3s16, BlockEmergeData *>::const_iterator iter;
293 BlockEmergeData *bedata;
299 flags |= BLOCK_EMERGE_ALLOWGEN;
302 JMutexAutoLock queuelock(queuemutex);
304 count = blocks_enqueued.size();
305 if (count >= qlimit_total)
308 count = peer_queue_count[peer_id];
309 u16 qlimit_peer = allow_generate ? qlimit_generate : qlimit_diskonly;
310 if (count >= qlimit_peer)
313 iter = blocks_enqueued.find(p);
314 if (iter != blocks_enqueued.end()) {
315 bedata = iter->second;
316 bedata->flags |= flags;
320 bedata = new BlockEmergeData;
321 bedata->flags = flags;
322 bedata->peer_requested = peer_id;
323 blocks_enqueued.insert(std::make_pair(p, bedata));
325 peer_queue_count[peer_id] = count + 1;
327 // insert into the EmergeThread queue with the least items
328 int lowestitems = emergethread[0]->blockqueue.size();
329 for (unsigned int i = 1; i != emergethread.size(); i++) {
330 int nitems = emergethread[i]->blockqueue.size();
331 if (nitems < lowestitems) {
333 lowestitems = nitems;
337 emergethread[idx]->blockqueue.push(p);
339 emergethread[idx]->qevent.signal();
345 int EmergeManager::getGroundLevelAtPoint(v2s16 p) {
346 if (mapgen.size() == 0 || !mapgen[0]) {
347 errorstream << "EmergeManager: getGroundLevelAtPoint() called"
348 " before mapgen initialized" << std::endl;
352 return mapgen[0]->getGroundLevelAtPoint(p);
356 bool EmergeManager::isBlockUnderground(v3s16 blockpos) {
358 v2s16 p = v2s16((blockpos.X * MAP_BLOCKSIZE) + MAP_BLOCKSIZE / 2,
359 (blockpos.Y * MAP_BLOCKSIZE) + MAP_BLOCKSIZE / 2);
360 int ground_level = getGroundLevelAtPoint(p);
361 return blockpos.Y * (MAP_BLOCKSIZE + 1) <= min(water_level, ground_level);
364 //yuck, but then again, should i bother being accurate?
365 //the height of the nodes in a single block is quite variable
366 return blockpos.Y * (MAP_BLOCKSIZE + 1) <= params->water_level;
370 u32 EmergeManager::getBlockSeed(v3s16 p) {
371 return (u32)(params->seed & 0xFFFFFFFF) +
378 Mapgen *EmergeManager::createMapgen(std::string mgname, int mgid,
379 MapgenParams *mgparams) {
380 std::map<std::string, MapgenFactory *>::const_iterator iter;
381 iter = mglist.find(mgname);
382 if (iter == mglist.end()) {
383 errorstream << "EmergeManager; mapgen " << mgname <<
384 " not registered" << std::endl;
388 MapgenFactory *mgfactory = iter->second;
389 return mgfactory->createMapgen(mgid, mgparams, this);
393 MapgenParams *EmergeManager::createMapgenParams(std::string mgname) {
394 std::map<std::string, MapgenFactory *>::const_iterator iter;
395 iter = mglist.find(mgname);
396 if (iter == mglist.end()) {
397 errorstream << "EmergeManager: mapgen " << mgname <<
398 " not registered" << std::endl;
402 MapgenFactory *mgfactory = iter->second;
403 return mgfactory->createMapgenParams();
407 MapgenParams *EmergeManager::getParamsFromSettings(Settings *settings) {
408 std::string mg_name = settings->get("mg_name");
409 MapgenParams *mgparams = createMapgenParams(mg_name);
413 std::string seedstr = settings->get(settings == g_settings ?
414 "fixed_map_seed" : "seed");
416 mgparams->mg_name = mg_name;
417 mgparams->seed = read_seed(seedstr.c_str());
418 mgparams->water_level = settings->getS16("water_level");
419 mgparams->chunksize = settings->getS16("chunksize");
420 mgparams->flags = settings->getFlagStr("mg_flags", flagdesc_mapgen);
422 if (!mgparams->readParams(settings)) {
430 void EmergeManager::setParamsToSettings(Settings *settings) {
431 settings->set("mg_name", params->mg_name);
432 settings->setU64("seed", params->seed);
433 settings->setS16("water_level", params->water_level);
434 settings->setS16("chunksize", params->chunksize);
435 settings->setFlagStr("mg_flags", params->flags, flagdesc_mapgen);
437 params->writeParams(settings);
441 void EmergeManager::registerMapgen(std::string mgname, MapgenFactory *mgfactory) {
442 mglist.insert(std::make_pair(mgname, mgfactory));
443 infostream << "EmergeManager: registered mapgen " << mgname << std::endl;
447 ////////////////////////////// Emerge Thread //////////////////////////////////
449 bool EmergeThread::popBlockEmerge(v3s16 *pos, u8 *flags) {
450 std::map<v3s16, BlockEmergeData *>::iterator iter;
451 JMutexAutoLock queuelock(emerge->queuemutex);
453 if (blockqueue.empty())
455 v3s16 p = blockqueue.front();
460 iter = emerge->blocks_enqueued.find(p);
461 if (iter == emerge->blocks_enqueued.end())
462 return false; //uh oh, queue and map out of sync!!
464 BlockEmergeData *bedata = iter->second;
465 *flags = bedata->flags;
467 emerge->peer_queue_count[bedata->peer_requested]--;
470 emerge->blocks_enqueued.erase(iter);
476 bool EmergeThread::getBlockOrStartGen(v3s16 p, MapBlock **b,
477 BlockMakeData *data, bool allow_gen) {
479 //envlock: usually takes <=1ms, sometimes 90ms or ~400ms to acquire
480 JMutexAutoLock envlock(m_server->m_env_mutex);
482 // Load sector if it isn't loaded
483 if (map->getSectorNoGenerateNoEx(p2d) == NULL)
484 map->loadSectorMeta(p2d);
486 // Attempt to load block
487 MapBlock *block = map->getBlockNoCreateNoEx(p);
488 if (!block || block->isDummy() || !block->isGenerated()) {
489 EMERGE_DBG_OUT("not in memory, attempting to load from disk");
490 block = map->loadBlock(p);
491 if (block && block->isGenerated())
492 map->prepareBlock(block);
495 // If could not load and allowed to generate,
496 // start generation inside this same envlock
497 if (allow_gen && (block == NULL || !block->isGenerated())) {
498 EMERGE_DBG_OUT("generating");
500 return map->initBlockMake(data, p);
508 void *EmergeThread::Thread() {
510 log_register_thread("EmergeThread" + itos(id));
511 DSTACK(__FUNCTION_NAME);
512 BEGIN_DEBUG_EXCEPTION_HANDLER
514 v3s16 last_tried_pos(-32768,-32768,-32768); // For error output
518 map = (ServerMap *)&(m_server->m_env->getMap());
519 emerge = m_server->m_emerge;
520 mapgen = emerge->mapgen[id];
521 enable_mapgen_debug_info = emerge->mapgen_debug_info;
523 while (!StopRequested())
525 if (!popBlockEmerge(&p, &flags)) {
531 if (blockpos_over_limit(p))
534 bool allow_generate = flags & BLOCK_EMERGE_ALLOWGEN;
535 EMERGE_DBG_OUT("p=" PP(p) " allow_generate=" << allow_generate);
538 Try to fetch block from memory or disk.
539 If not found and asked to generate, initialize generator.
542 MapBlock *block = NULL;
543 std::map<v3s16, MapBlock *> modified_blocks;
545 if (getBlockOrStartGen(p, &block, &data, allow_generate) && mapgen) {
547 ScopeProfiler sp(g_profiler, "EmergeThread: Mapgen::makeChunk", SPT_AVG);
548 TimeTaker t("mapgen::make_block()");
550 mapgen->makeChunk(&data);
552 if (enable_mapgen_debug_info == false)
553 t.stop(true); // Hide output
557 //envlock: usually 0ms, but can take either 30 or 400ms to acquire
558 JMutexAutoLock envlock(m_server->m_env_mutex);
559 ScopeProfiler sp(g_profiler, "EmergeThread: after "
560 "Mapgen::makeChunk (envlock)", SPT_AVG);
562 map->finishBlockMake(&data, modified_blocks);
564 block = map->getBlockNoCreateNoEx(p);
567 Do some post-generate stuff
569 v3s16 minp = data.blockpos_min * MAP_BLOCKSIZE;
570 v3s16 maxp = data.blockpos_max * MAP_BLOCKSIZE +
571 v3s16(1,1,1) * (MAP_BLOCKSIZE - 1);
573 // Ignore map edit events, they will not need to be sent
574 // to anybody because the block hasn't been sent to anybody
575 MapEditEventAreaIgnorer
576 ign(&m_server->m_ignore_map_edit_events_area,
577 VoxelArea(minp, maxp));
578 try { // takes about 90ms with -O1 on an e3-1230v2
579 m_server->getScriptIface()->environment_OnGenerated(
580 minp, maxp, emerge->getBlockSeed(minp));
581 } catch(LuaError &e) {
582 m_server->setAsyncFatalError(e.what());
585 EMERGE_DBG_OUT("ended up with: " << analyze_block(block));
587 m_server->m_env->activateBlock(block, 0);
593 Set sent status of modified blocks on clients
596 // NOTE: Server's clients are also behind the connection mutex
597 //conlock: consistently takes 30-40ms to acquire
598 JMutexAutoLock lock(m_server->m_con_mutex);
599 // Add the originally fetched block to the modified list
601 modified_blocks[p] = block;
603 // Set the modified blocks unsent for all the clients
604 for (std::map<u16, RemoteClient*>::iterator
605 i = m_server->m_clients.begin();
606 i != m_server->m_clients.end(); ++i) {
607 RemoteClient *client = i->second;
608 if (modified_blocks.size() > 0) {
609 // Remove block from sent history
610 client->SetBlocksNotSent(modified_blocks);
614 catch (VersionMismatchException &e) {
615 std::ostringstream err;
616 err << "World data version mismatch in MapBlock "<<PP(last_tried_pos)<<std::endl;
617 err << "----"<<std::endl;
618 err << "\""<<e.what()<<"\""<<std::endl;
619 err << "See debug.txt."<<std::endl;
620 err << "World probably saved by a newer version of Minetest."<<std::endl;
621 m_server->setAsyncFatalError(err.str());
623 catch (SerializationError &e) {
624 std::ostringstream err;
625 err << "Invalid data in MapBlock "<<PP(last_tried_pos)<<std::endl;
626 err << "----"<<std::endl;
627 err << "\""<<e.what()<<"\""<<std::endl;
628 err << "See debug.txt."<<std::endl;
629 err << "You can ignore this using [ignore_world_load_errors = true]."<<std::endl;
630 m_server->setAsyncFatalError(err.str());
633 END_DEBUG_EXCEPTION_HANDLER(errorstream)
634 log_deregister_thread();