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 mapgen_debug_info = g_settings->getBool("enable_mapgen_debug_info");
102 // if unspecified, leave a proc for the main thread and one for
103 // some other misc thread
105 if (!g_settings->getS16NoEx("num_emerge_threads", nthreads))
106 nthreads = porting::getNumberOfProcessors() - 2;
110 qlimit_total = g_settings->getU16("emergequeue_limit_total");
111 if (!g_settings->getU16NoEx("emergequeue_limit_diskonly", qlimit_diskonly))
112 qlimit_diskonly = nthreads * 5 + 1;
113 if (!g_settings->getU16NoEx("emergequeue_limit_generate", qlimit_generate))
114 qlimit_generate = nthreads + 1;
116 // don't trust user input for something very important like this
117 if (qlimit_total < 1)
119 if (qlimit_diskonly < 1)
121 if (qlimit_generate < 1)
124 for (int i = 0; i != nthreads; i++)
125 emergethread.push_back(new EmergeThread((Server *)gamedef, i));
127 infostream << "EmergeManager: using " << nthreads << " threads" << std::endl;
131 EmergeManager::~EmergeManager() {
132 for (unsigned int i = 0; i != emergethread.size(); i++) {
133 if (threads_active) {
134 emergethread[i]->Stop();
135 emergethread[i]->qevent.signal();
136 emergethread[i]->Wait();
138 delete emergethread[i];
141 emergethread.clear();
144 for (unsigned int i = 0; i < ores.size(); i++)
148 for (unsigned int i = 0; i < decorations.size(); i++)
149 delete decorations[i];
152 for (std::map<std::string, MapgenFactory *>::iterator iter = mglist.begin();
153 iter != mglist.end(); iter ++) {
162 void EmergeManager::loadMapgenParams() {
163 loadParamsFromSettings(g_settings);
165 if (g_settings->get("fixed_map_seed").empty()) {
166 params.seed = (((u64)(myrand() & 0xffff) << 0)
167 | ((u64)(myrand() & 0xffff) << 16)
168 | ((u64)(myrand() & 0xffff) << 32)
169 | ((u64)(myrand() & 0xffff) << 48));
174 void EmergeManager::initMapgens() {
178 // Resolve names of nodes for things that were registered
179 // (at this point, the registration period is over)
180 biomedef->resolveNodeNames(ndef);
182 for (size_t i = 0; i != ores.size(); i++)
183 ores[i]->resolveNodeNames(ndef);
185 for (size_t i = 0; i != decorations.size(); i++)
186 decorations[i]->resolveNodeNames(ndef);
188 if (!params.sparams) {
189 params.sparams = createMapgenParams(params.mg_name);
190 if (!params.sparams) {
191 params.mg_name = DEFAULT_MAPGEN;
192 params.sparams = createMapgenParams(params.mg_name);
193 assert(params.sparams);
195 params.sparams->readParams(g_settings);
198 // Create the mapgens
199 for (size_t i = 0; i != emergethread.size(); i++) {
200 Mapgen *mg = createMapgen(params.mg_name, i, ¶ms);
202 mapgen.push_back(mg);
207 Mapgen *EmergeManager::getCurrentMapgen() {
208 for (unsigned int i = 0; i != emergethread.size(); i++) {
209 if (emergethread[i]->IsSameThread())
210 return emergethread[i]->mapgen;
217 void EmergeManager::startThreads() {
221 for (unsigned int i = 0; i != emergethread.size(); i++)
222 emergethread[i]->Start();
224 threads_active = true;
228 void EmergeManager::stopThreads() {
232 // Request thread stop in parallel
233 for (unsigned int i = 0; i != emergethread.size(); i++) {
234 emergethread[i]->Stop();
235 emergethread[i]->qevent.signal();
238 // Then do the waiting for each
239 for (unsigned int i = 0; i != emergethread.size(); i++)
240 emergethread[i]->Wait();
242 threads_active = false;
246 bool EmergeManager::enqueueBlockEmerge(u16 peer_id, v3s16 p, bool allow_generate) {
247 std::map<v3s16, BlockEmergeData *>::const_iterator iter;
248 BlockEmergeData *bedata;
254 flags |= BLOCK_EMERGE_ALLOWGEN;
257 JMutexAutoLock queuelock(queuemutex);
259 count = blocks_enqueued.size();
260 if (count >= qlimit_total)
263 count = peer_queue_count[peer_id];
264 u16 qlimit_peer = allow_generate ? qlimit_generate : qlimit_diskonly;
265 if (count >= qlimit_peer)
268 iter = blocks_enqueued.find(p);
269 if (iter != blocks_enqueued.end()) {
270 bedata = iter->second;
271 bedata->flags |= flags;
275 bedata = new BlockEmergeData;
276 bedata->flags = flags;
277 bedata->peer_requested = peer_id;
278 blocks_enqueued.insert(std::make_pair(p, bedata));
280 peer_queue_count[peer_id] = count + 1;
282 // insert into the EmergeThread queue with the least items
283 int lowestitems = emergethread[0]->blockqueue.size();
284 for (unsigned int i = 1; i != emergethread.size(); i++) {
285 int nitems = emergethread[i]->blockqueue.size();
286 if (nitems < lowestitems) {
288 lowestitems = nitems;
292 emergethread[idx]->blockqueue.push(p);
294 emergethread[idx]->qevent.signal();
300 int EmergeManager::getGroundLevelAtPoint(v2s16 p) {
301 if (mapgen.size() == 0 || !mapgen[0]) {
302 errorstream << "EmergeManager: getGroundLevelAtPoint() called"
303 " before mapgen initialized" << std::endl;
307 return mapgen[0]->getGroundLevelAtPoint(p);
311 bool EmergeManager::isBlockUnderground(v3s16 blockpos) {
313 v2s16 p = v2s16((blockpos.X * MAP_BLOCKSIZE) + MAP_BLOCKSIZE / 2,
314 (blockpos.Y * MAP_BLOCKSIZE) + MAP_BLOCKSIZE / 2);
315 int ground_level = getGroundLevelAtPoint(p);
316 return blockpos.Y * (MAP_BLOCKSIZE + 1) <= min(water_level, ground_level);
319 //yuck, but then again, should i bother being accurate?
320 //the height of the nodes in a single block is quite variable
321 return blockpos.Y * (MAP_BLOCKSIZE + 1) <= params.water_level;
325 u32 EmergeManager::getBlockSeed(v3s16 p) {
326 return (u32)(params.seed & 0xFFFFFFFF) +
333 Mapgen *EmergeManager::createMapgen(std::string mgname, int mgid,
334 MapgenParams *mgparams) {
335 std::map<std::string, MapgenFactory *>::const_iterator iter;
336 iter = mglist.find(mgname);
337 if (iter == mglist.end()) {
338 errorstream << "EmergeManager; mapgen " << mgname <<
339 " not registered" << std::endl;
343 MapgenFactory *mgfactory = iter->second;
344 return mgfactory->createMapgen(mgid, mgparams, this);
348 MapgenSpecificParams *EmergeManager::createMapgenParams(std::string mgname) {
349 std::map<std::string, MapgenFactory *>::const_iterator iter;
350 iter = mglist.find(mgname);
351 if (iter == mglist.end()) {
352 errorstream << "EmergeManager: mapgen " << mgname <<
353 " not registered" << std::endl;
357 MapgenFactory *mgfactory = iter->second;
358 return mgfactory->createMapgenParams();
362 void EmergeManager::loadParamsFromSettings(Settings *settings) {
363 std::string seed_str;
364 const char *setname = (settings == g_settings) ? "fixed_map_seed" : "seed";
366 if (settings->getNoEx(setname, seed_str))
367 params.seed = read_seed(seed_str.c_str());
369 settings->getNoEx("mg_name", params.mg_name);
370 settings->getS16NoEx("water_level", params.water_level);
371 settings->getS16NoEx("chunksize", params.chunksize);
372 settings->getFlagStrNoEx("mg_flags", params.flags, flagdesc_mapgen);
374 delete params.sparams;
375 params.sparams = createMapgenParams(params.mg_name);
377 params.sparams->readParams(settings);
381 void EmergeManager::saveParamsToSettings(Settings *settings) {
382 settings->set("mg_name", params.mg_name);
383 settings->setU64("seed", params.seed);
384 settings->setS16("water_level", params.water_level);
385 settings->setS16("chunksize", params.chunksize);
386 settings->setFlagStr("mg_flags", params.flags, flagdesc_mapgen, (u32)-1);
389 params.sparams->writeParams(settings);
393 void EmergeManager::registerMapgen(std::string mgname, MapgenFactory *mgfactory) {
394 mglist.insert(std::make_pair(mgname, mgfactory));
395 infostream << "EmergeManager: registered mapgen " << mgname << std::endl;
399 ////////////////////////////// Emerge Thread //////////////////////////////////
401 bool EmergeThread::popBlockEmerge(v3s16 *pos, u8 *flags) {
402 std::map<v3s16, BlockEmergeData *>::iterator iter;
403 JMutexAutoLock queuelock(emerge->queuemutex);
405 if (blockqueue.empty())
407 v3s16 p = blockqueue.front();
412 iter = emerge->blocks_enqueued.find(p);
413 if (iter == emerge->blocks_enqueued.end())
414 return false; //uh oh, queue and map out of sync!!
416 BlockEmergeData *bedata = iter->second;
417 *flags = bedata->flags;
419 emerge->peer_queue_count[bedata->peer_requested]--;
422 emerge->blocks_enqueued.erase(iter);
428 bool EmergeThread::getBlockOrStartGen(v3s16 p, MapBlock **b,
429 BlockMakeData *data, bool allow_gen) {
431 //envlock: usually takes <=1ms, sometimes 90ms or ~400ms to acquire
432 JMutexAutoLock envlock(m_server->m_env_mutex);
434 // Load sector if it isn't loaded
435 if (map->getSectorNoGenerateNoEx(p2d) == NULL)
436 map->loadSectorMeta(p2d);
438 // Attempt to load block
439 MapBlock *block = map->getBlockNoCreateNoEx(p);
440 if (!block || block->isDummy() || !block->isGenerated()) {
441 EMERGE_DBG_OUT("not in memory, attempting to load from disk");
442 block = map->loadBlock(p);
443 if (block && block->isGenerated())
444 map->prepareBlock(block);
447 // If could not load and allowed to generate,
448 // start generation inside this same envlock
449 if (allow_gen && (block == NULL || !block->isGenerated())) {
450 EMERGE_DBG_OUT("generating");
452 return map->initBlockMake(data, p);
460 void *EmergeThread::Thread() {
462 log_register_thread("EmergeThread" + itos(id));
463 DSTACK(__FUNCTION_NAME);
464 BEGIN_DEBUG_EXCEPTION_HANDLER
466 v3s16 last_tried_pos(-32768,-32768,-32768); // For error output
470 map = (ServerMap *)&(m_server->m_env->getMap());
471 emerge = m_server->m_emerge;
472 mapgen = emerge->mapgen[id];
473 enable_mapgen_debug_info = emerge->mapgen_debug_info;
475 while (!StopRequested())
477 if (!popBlockEmerge(&p, &flags)) {
483 if (blockpos_over_limit(p))
486 bool allow_generate = flags & BLOCK_EMERGE_ALLOWGEN;
487 EMERGE_DBG_OUT("p=" PP(p) " allow_generate=" << allow_generate);
490 Try to fetch block from memory or disk.
491 If not found and asked to generate, initialize generator.
494 MapBlock *block = NULL;
495 std::map<v3s16, MapBlock *> modified_blocks;
497 if (getBlockOrStartGen(p, &block, &data, allow_generate) && mapgen) {
499 ScopeProfiler sp(g_profiler, "EmergeThread: Mapgen::makeChunk", SPT_AVG);
500 TimeTaker t("mapgen::make_block()");
502 mapgen->makeChunk(&data);
504 if (enable_mapgen_debug_info == false)
505 t.stop(true); // Hide output
509 //envlock: usually 0ms, but can take either 30 or 400ms to acquire
510 JMutexAutoLock envlock(m_server->m_env_mutex);
511 ScopeProfiler sp(g_profiler, "EmergeThread: after "
512 "Mapgen::makeChunk (envlock)", SPT_AVG);
514 map->finishBlockMake(&data, modified_blocks);
516 block = map->getBlockNoCreateNoEx(p);
519 Do some post-generate stuff
521 v3s16 minp = data.blockpos_min * MAP_BLOCKSIZE;
522 v3s16 maxp = data.blockpos_max * MAP_BLOCKSIZE +
523 v3s16(1,1,1) * (MAP_BLOCKSIZE - 1);
525 // Ignore map edit events, they will not need to be sent
526 // to anybody because the block hasn't been sent to anybody
527 MapEditEventAreaIgnorer
528 ign(&m_server->m_ignore_map_edit_events_area,
529 VoxelArea(minp, maxp));
530 try { // takes about 90ms with -O1 on an e3-1230v2
531 m_server->getScriptIface()->environment_OnGenerated(
532 minp, maxp, emerge->getBlockSeed(minp));
533 } catch(LuaError &e) {
534 m_server->setAsyncFatalError(e.what());
537 EMERGE_DBG_OUT("ended up with: " << analyze_block(block));
539 m_server->m_env->activateBlock(block, 0);
545 Set sent status of modified blocks on clients
547 // Add the originally fetched block to the modified list
549 modified_blocks[p] = block;
551 if (modified_blocks.size() > 0) {
552 m_server->SetBlocksNotSent(modified_blocks);
555 catch (VersionMismatchException &e) {
556 std::ostringstream err;
557 err << "World data version mismatch in MapBlock "<<PP(last_tried_pos)<<std::endl;
558 err << "----"<<std::endl;
559 err << "\""<<e.what()<<"\""<<std::endl;
560 err << "See debug.txt."<<std::endl;
561 err << "World probably saved by a newer version of Minetest."<<std::endl;
562 m_server->setAsyncFatalError(err.str());
564 catch (SerializationError &e) {
565 std::ostringstream err;
566 err << "Invalid data in MapBlock "<<PP(last_tried_pos)<<std::endl;
567 err << "----"<<std::endl;
568 err << "\""<<e.what()<<"\""<<std::endl;
569 err << "See debug.txt."<<std::endl;
570 err << "You can ignore this using [ignore_world_load_errors = true]."<<std::endl;
571 m_server->setAsyncFatalError(err.str());
574 END_DEBUG_EXCEPTION_HANDLER(errorstream)
575 log_deregister_thread();