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 for (int i = 0; i != nthreads; i++)
117 emergethread.push_back(new EmergeThread((Server *)gamedef, i));
119 infostream << "EmergeManager: using " << nthreads << " threads" << std::endl;
121 loadParamsFromSettings(g_settings);
123 if (g_settings->get("fixed_map_seed").empty()) {
124 params.seed = (((u64)(myrand() & 0xffff) << 0)
125 | ((u64)(myrand() & 0xffff) << 16)
126 | ((u64)(myrand() & 0xffff) << 32)
127 | ((u64)(myrand() & 0xffff) << 48));
132 EmergeManager::~EmergeManager() {
133 for (unsigned int i = 0; i != emergethread.size(); i++) {
134 if (threads_active) {
135 emergethread[i]->Stop();
136 emergethread[i]->qevent.signal();
137 emergethread[i]->Wait();
139 delete emergethread[i];
142 emergethread.clear();
145 for (unsigned int i = 0; i < ores.size(); i++)
149 for (unsigned int i = 0; i < decorations.size(); i++)
150 delete decorations[i];
153 for (std::map<std::string, MapgenFactory *>::iterator iter = mglist.begin();
154 iter != mglist.end(); iter ++) {
163 void EmergeManager::initMapgens() {
167 // Resolve names of nodes for things that were registered
168 // (at this point, the registration period is over)
169 biomedef->resolveNodeNames(ndef);
171 for (size_t i = 0; i != ores.size(); i++)
172 ores[i]->resolveNodeNames(ndef);
174 for (size_t i = 0; i != decorations.size(); i++)
175 decorations[i]->resolveNodeNames(ndef);
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 (size_t i = 0; i != emergethread.size(); i++) {
189 Mapgen *mg = createMapgen(params.mg_name, i, ¶ms);
191 mapgen.push_back(mg);
196 Mapgen *EmergeManager::getCurrentMapgen() {
197 for (unsigned int i = 0; i != emergethread.size(); i++) {
198 if (emergethread[i]->IsSameThread())
199 return emergethread[i]->mapgen;
206 void EmergeManager::startThreads() {
210 for (unsigned int i = 0; i != emergethread.size(); i++)
211 emergethread[i]->Start();
213 threads_active = true;
217 void EmergeManager::stopThreads() {
221 // Request thread stop in parallel
222 for (unsigned int i = 0; i != emergethread.size(); i++) {
223 emergethread[i]->Stop();
224 emergethread[i]->qevent.signal();
227 // Then do the waiting for each
228 for (unsigned int i = 0; i != emergethread.size(); i++)
229 emergethread[i]->Wait();
231 threads_active = false;
235 bool EmergeManager::enqueueBlockEmerge(u16 peer_id, v3s16 p, bool allow_generate) {
236 std::map<v3s16, BlockEmergeData *>::const_iterator iter;
237 BlockEmergeData *bedata;
243 flags |= BLOCK_EMERGE_ALLOWGEN;
246 JMutexAutoLock queuelock(queuemutex);
248 count = blocks_enqueued.size();
249 if (count >= qlimit_total)
252 count = peer_queue_count[peer_id];
253 u16 qlimit_peer = allow_generate ? qlimit_generate : qlimit_diskonly;
254 if (count >= qlimit_peer)
257 iter = blocks_enqueued.find(p);
258 if (iter != blocks_enqueued.end()) {
259 bedata = iter->second;
260 bedata->flags |= flags;
264 bedata = new BlockEmergeData;
265 bedata->flags = flags;
266 bedata->peer_requested = peer_id;
267 blocks_enqueued.insert(std::make_pair(p, bedata));
269 peer_queue_count[peer_id] = count + 1;
271 // insert into the EmergeThread queue with the least items
272 int lowestitems = emergethread[0]->blockqueue.size();
273 for (unsigned int i = 1; i != emergethread.size(); i++) {
274 int nitems = emergethread[i]->blockqueue.size();
275 if (nitems < lowestitems) {
277 lowestitems = nitems;
281 emergethread[idx]->blockqueue.push(p);
283 emergethread[idx]->qevent.signal();
289 int EmergeManager::getGroundLevelAtPoint(v2s16 p) {
290 if (mapgen.size() == 0 || !mapgen[0]) {
291 errorstream << "EmergeManager: getGroundLevelAtPoint() called"
292 " before mapgen initialized" << std::endl;
296 return mapgen[0]->getGroundLevelAtPoint(p);
300 bool EmergeManager::isBlockUnderground(v3s16 blockpos) {
302 v2s16 p = v2s16((blockpos.X * MAP_BLOCKSIZE) + MAP_BLOCKSIZE / 2,
303 (blockpos.Y * MAP_BLOCKSIZE) + MAP_BLOCKSIZE / 2);
304 int ground_level = getGroundLevelAtPoint(p);
305 return blockpos.Y * (MAP_BLOCKSIZE + 1) <= min(water_level, ground_level);
308 //yuck, but then again, should i bother being accurate?
309 //the height of the nodes in a single block is quite variable
310 return blockpos.Y * (MAP_BLOCKSIZE + 1) <= params.water_level;
314 u32 EmergeManager::getBlockSeed(v3s16 p) {
315 return (u32)(params.seed & 0xFFFFFFFF) +
322 Mapgen *EmergeManager::createMapgen(std::string mgname, int mgid,
323 MapgenParams *mgparams) {
324 std::map<std::string, MapgenFactory *>::const_iterator iter;
325 iter = mglist.find(mgname);
326 if (iter == mglist.end()) {
327 errorstream << "EmergeManager; mapgen " << mgname <<
328 " not registered" << std::endl;
332 MapgenFactory *mgfactory = iter->second;
333 return mgfactory->createMapgen(mgid, mgparams, this);
337 MapgenSpecificParams *EmergeManager::createMapgenParams(std::string mgname) {
338 std::map<std::string, MapgenFactory *>::const_iterator iter;
339 iter = mglist.find(mgname);
340 if (iter == mglist.end()) {
341 errorstream << "EmergeManager: mapgen " << mgname <<
342 " not registered" << std::endl;
346 MapgenFactory *mgfactory = iter->second;
347 return mgfactory->createMapgenParams();
351 void EmergeManager::loadParamsFromSettings(Settings *settings) {
352 std::string seed_str;
353 const char *setname = (settings == g_settings) ? "fixed_map_seed" : "seed";
355 if (settings->getNoEx(setname, seed_str))
356 params.seed = read_seed(seed_str.c_str());
358 settings->getNoEx("mg_name", params.mg_name);
359 settings->getS16NoEx("water_level", params.water_level);
360 settings->getS16NoEx("chunksize", params.chunksize);
361 settings->getFlagStrNoEx("mg_flags", params.flags, flagdesc_mapgen);
363 delete params.sparams;
364 params.sparams = createMapgenParams(params.mg_name);
366 params.sparams->readParams(settings);
371 void EmergeManager::saveParamsToSettings(Settings *settings) {
372 settings->set("mg_name", params.mg_name);
373 settings->setU64("seed", params.seed);
374 settings->setS16("water_level", params.water_level);
375 settings->setS16("chunksize", params.chunksize);
376 settings->setFlagStr("mg_flags", params.flags, flagdesc_mapgen);
379 params.sparams->writeParams(settings);
383 void EmergeManager::registerMapgen(std::string mgname, MapgenFactory *mgfactory) {
384 mglist.insert(std::make_pair(mgname, mgfactory));
385 infostream << "EmergeManager: registered mapgen " << mgname << std::endl;
389 ////////////////////////////// Emerge Thread //////////////////////////////////
391 bool EmergeThread::popBlockEmerge(v3s16 *pos, u8 *flags) {
392 std::map<v3s16, BlockEmergeData *>::iterator iter;
393 JMutexAutoLock queuelock(emerge->queuemutex);
395 if (blockqueue.empty())
397 v3s16 p = blockqueue.front();
402 iter = emerge->blocks_enqueued.find(p);
403 if (iter == emerge->blocks_enqueued.end())
404 return false; //uh oh, queue and map out of sync!!
406 BlockEmergeData *bedata = iter->second;
407 *flags = bedata->flags;
409 emerge->peer_queue_count[bedata->peer_requested]--;
412 emerge->blocks_enqueued.erase(iter);
418 bool EmergeThread::getBlockOrStartGen(v3s16 p, MapBlock **b,
419 BlockMakeData *data, bool allow_gen) {
421 //envlock: usually takes <=1ms, sometimes 90ms or ~400ms to acquire
422 JMutexAutoLock envlock(m_server->m_env_mutex);
424 // Load sector if it isn't loaded
425 if (map->getSectorNoGenerateNoEx(p2d) == NULL)
426 map->loadSectorMeta(p2d);
428 // Attempt to load block
429 MapBlock *block = map->getBlockNoCreateNoEx(p);
430 if (!block || block->isDummy() || !block->isGenerated()) {
431 EMERGE_DBG_OUT("not in memory, attempting to load from disk");
432 block = map->loadBlock(p);
433 if (block && block->isGenerated())
434 map->prepareBlock(block);
437 // If could not load and allowed to generate,
438 // start generation inside this same envlock
439 if (allow_gen && (block == NULL || !block->isGenerated())) {
440 EMERGE_DBG_OUT("generating");
442 return map->initBlockMake(data, p);
450 void *EmergeThread::Thread() {
452 log_register_thread("EmergeThread" + itos(id));
453 DSTACK(__FUNCTION_NAME);
454 BEGIN_DEBUG_EXCEPTION_HANDLER
456 v3s16 last_tried_pos(-32768,-32768,-32768); // For error output
460 map = (ServerMap *)&(m_server->m_env->getMap());
461 emerge = m_server->m_emerge;
462 mapgen = emerge->mapgen[id];
463 enable_mapgen_debug_info = emerge->mapgen_debug_info;
465 while (!StopRequested())
467 if (!popBlockEmerge(&p, &flags)) {
473 if (blockpos_over_limit(p))
476 bool allow_generate = flags & BLOCK_EMERGE_ALLOWGEN;
477 EMERGE_DBG_OUT("p=" PP(p) " allow_generate=" << allow_generate);
480 Try to fetch block from memory or disk.
481 If not found and asked to generate, initialize generator.
484 MapBlock *block = NULL;
485 std::map<v3s16, MapBlock *> modified_blocks;
487 if (getBlockOrStartGen(p, &block, &data, allow_generate) && mapgen) {
489 ScopeProfiler sp(g_profiler, "EmergeThread: Mapgen::makeChunk", SPT_AVG);
490 TimeTaker t("mapgen::make_block()");
492 mapgen->makeChunk(&data);
494 if (enable_mapgen_debug_info == false)
495 t.stop(true); // Hide output
499 //envlock: usually 0ms, but can take either 30 or 400ms to acquire
500 JMutexAutoLock envlock(m_server->m_env_mutex);
501 ScopeProfiler sp(g_profiler, "EmergeThread: after "
502 "Mapgen::makeChunk (envlock)", SPT_AVG);
504 map->finishBlockMake(&data, modified_blocks);
506 block = map->getBlockNoCreateNoEx(p);
509 Do some post-generate stuff
511 v3s16 minp = data.blockpos_min * MAP_BLOCKSIZE;
512 v3s16 maxp = data.blockpos_max * MAP_BLOCKSIZE +
513 v3s16(1,1,1) * (MAP_BLOCKSIZE - 1);
515 // Ignore map edit events, they will not need to be sent
516 // to anybody because the block hasn't been sent to anybody
517 MapEditEventAreaIgnorer
518 ign(&m_server->m_ignore_map_edit_events_area,
519 VoxelArea(minp, maxp));
520 try { // takes about 90ms with -O1 on an e3-1230v2
521 m_server->getScriptIface()->environment_OnGenerated(
522 minp, maxp, emerge->getBlockSeed(minp));
523 } catch(LuaError &e) {
524 m_server->setAsyncFatalError(e.what());
527 EMERGE_DBG_OUT("ended up with: " << analyze_block(block));
529 m_server->m_env->activateBlock(block, 0);
535 Set sent status of modified blocks on clients
537 // Add the originally fetched block to the modified list
539 modified_blocks[p] = block;
541 if (modified_blocks.size() > 0) {
542 m_server->SetBlocksNotSent(modified_blocks);
545 catch (VersionMismatchException &e) {
546 std::ostringstream err;
547 err << "World data version mismatch in MapBlock "<<PP(last_tried_pos)<<std::endl;
548 err << "----"<<std::endl;
549 err << "\""<<e.what()<<"\""<<std::endl;
550 err << "See debug.txt."<<std::endl;
551 err << "World probably saved by a newer version of Minetest."<<std::endl;
552 m_server->setAsyncFatalError(err.str());
554 catch (SerializationError &e) {
555 std::ostringstream err;
556 err << "Invalid data in MapBlock "<<PP(last_tried_pos)<<std::endl;
557 err << "----"<<std::endl;
558 err << "\""<<e.what()<<"\""<<std::endl;
559 err << "See debug.txt."<<std::endl;
560 err << "You can ignore this using [ignore_world_load_errors = true]."<<std::endl;
561 m_server->setAsyncFatalError(err.str());
564 END_DEBUG_EXCEPTION_HANDLER(errorstream)
565 log_deregister_thread();