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_singlenode.h"
48 class EmergeThread : public JThread
53 EmergeManager *emerge;
55 bool enable_mapgen_debug_info;
59 std::queue<v3s16> blockqueue;
61 EmergeThread(Server *server, int ethreadid):
67 enable_mapgen_debug_info(false),
73 bool popBlockEmerge(v3s16 *pos, u8 *flags);
74 bool getBlockOrStartGen(v3s16 p, MapBlock **b,
75 BlockMakeData *data, bool allow_generate);
79 /////////////////////////////// Emerge Manager ////////////////////////////////
81 EmergeManager::EmergeManager(IGameDef *gamedef) {
82 //register built-in mapgens
83 registerMapgen("v6", new MapgenFactoryV6());
84 registerMapgen("v7", new MapgenFactoryV7());
85 registerMapgen("singlenode", new MapgenFactorySinglenode());
87 this->ndef = gamedef->getNodeDefManager();
88 this->biomedef = new BiomeDefManager(gamedef->getNodeDefManager()->getResolver());
91 // Note that accesses to this variable are not synchronized.
92 // This is because the *only* thread ever starting or stopping
93 // EmergeThreads should be the ServerThread.
94 this->threads_active = false;
96 mapgen_debug_info = g_settings->getBool("enable_mapgen_debug_info");
98 // if unspecified, leave a proc for the main thread and one for
99 // some other misc thread
101 if (!g_settings->getS16NoEx("num_emerge_threads", nthreads))
102 nthreads = porting::getNumberOfProcessors() - 2;
106 qlimit_total = g_settings->getU16("emergequeue_limit_total");
107 if (!g_settings->getU16NoEx("emergequeue_limit_diskonly", qlimit_diskonly))
108 qlimit_diskonly = nthreads * 5 + 1;
109 if (!g_settings->getU16NoEx("emergequeue_limit_generate", qlimit_generate))
110 qlimit_generate = nthreads + 1;
112 // don't trust user input for something very important like this
113 if (qlimit_total < 1)
115 if (qlimit_diskonly < 1)
117 if (qlimit_generate < 1)
120 for (s16 i = 0; i < nthreads; i++)
121 emergethread.push_back(new EmergeThread((Server *) gamedef, i));
123 infostream << "EmergeManager: using " << nthreads << " threads" << std::endl;
127 EmergeManager::~EmergeManager() {
128 for (unsigned int i = 0; i != emergethread.size(); i++) {
129 if (threads_active) {
130 emergethread[i]->Stop();
131 emergethread[i]->qevent.signal();
132 emergethread[i]->Wait();
134 delete emergethread[i];
137 emergethread.clear();
140 for (unsigned int i = 0; i < ores.size(); i++)
144 for (unsigned int i = 0; i < decorations.size(); i++)
145 delete decorations[i];
148 for (std::map<std::string, MapgenFactory *>::iterator it = mglist.begin();
149 it != mglist.end(); ++it) {
156 if (params.sparams) {
157 delete params.sparams;
158 params.sparams = NULL;
163 void EmergeManager::loadMapgenParams() {
164 loadParamsFromSettings(g_settings);
166 if (g_settings->get("fixed_map_seed").empty()) {
167 params.seed = (((u64)(myrand() & 0xffff) << 0)
168 | ((u64)(myrand() & 0xffff) << 16)
169 | ((u64)(myrand() & 0xffff) << 32)
170 | ((u64)(myrand() & 0xffff) << 48));
175 void EmergeManager::initMapgens() {
179 if (!params.sparams) {
180 params.sparams = createMapgenParams(params.mg_name);
181 if (!params.sparams) {
182 params.mg_name = DEFAULT_MAPGEN;
183 params.sparams = createMapgenParams(params.mg_name);
184 assert(params.sparams);
186 params.sparams->readParams(g_settings);
189 // Create the mapgens
190 for (size_t i = 0; i != emergethread.size(); i++) {
191 Mapgen *mg = createMapgen(params.mg_name, i, ¶ms);
193 mapgen.push_back(mg);
198 Mapgen *EmergeManager::getCurrentMapgen() {
199 for (unsigned int i = 0; i != emergethread.size(); i++) {
200 if (emergethread[i]->IsSameThread())
201 return emergethread[i]->mapgen;
208 void EmergeManager::startThreads() {
212 for (unsigned int i = 0; i != emergethread.size(); i++)
213 emergethread[i]->Start();
215 threads_active = true;
219 void EmergeManager::stopThreads() {
223 // Request thread stop in parallel
224 for (unsigned int i = 0; i != emergethread.size(); i++) {
225 emergethread[i]->Stop();
226 emergethread[i]->qevent.signal();
229 // Then do the waiting for each
230 for (unsigned int i = 0; i != emergethread.size(); i++)
231 emergethread[i]->Wait();
233 threads_active = false;
237 bool EmergeManager::enqueueBlockEmerge(u16 peer_id, v3s16 p, bool allow_generate) {
238 std::map<v3s16, BlockEmergeData *>::const_iterator iter;
239 BlockEmergeData *bedata;
245 flags |= BLOCK_EMERGE_ALLOWGEN;
248 JMutexAutoLock queuelock(queuemutex);
250 count = blocks_enqueued.size();
251 if (count >= qlimit_total)
254 count = peer_queue_count[peer_id];
255 u16 qlimit_peer = allow_generate ? qlimit_generate : qlimit_diskonly;
256 if (count >= qlimit_peer)
259 iter = blocks_enqueued.find(p);
260 if (iter != blocks_enqueued.end()) {
261 bedata = iter->second;
262 bedata->flags |= flags;
266 bedata = new BlockEmergeData;
267 bedata->flags = flags;
268 bedata->peer_requested = peer_id;
269 blocks_enqueued.insert(std::make_pair(p, bedata));
271 peer_queue_count[peer_id] = count + 1;
273 // insert into the EmergeThread queue with the least items
274 int lowestitems = emergethread[0]->blockqueue.size();
275 for (unsigned int i = 1; i != emergethread.size(); i++) {
276 int nitems = emergethread[i]->blockqueue.size();
277 if (nitems < lowestitems) {
279 lowestitems = nitems;
283 emergethread[idx]->blockqueue.push(p);
285 emergethread[idx]->qevent.signal();
291 int EmergeManager::getGroundLevelAtPoint(v2s16 p) {
292 if (mapgen.size() == 0 || !mapgen[0]) {
293 errorstream << "EmergeManager: getGroundLevelAtPoint() called"
294 " before mapgen initialized" << std::endl;
298 return mapgen[0]->getGroundLevelAtPoint(p);
302 bool EmergeManager::isBlockUnderground(v3s16 blockpos) {
304 v2s16 p = v2s16((blockpos.X * MAP_BLOCKSIZE) + MAP_BLOCKSIZE / 2,
305 (blockpos.Y * MAP_BLOCKSIZE) + MAP_BLOCKSIZE / 2);
306 int ground_level = getGroundLevelAtPoint(p);
307 return blockpos.Y * (MAP_BLOCKSIZE + 1) <= min(water_level, ground_level);
310 //yuck, but then again, should i bother being accurate?
311 //the height of the nodes in a single block is quite variable
312 return blockpos.Y * (MAP_BLOCKSIZE + 1) <= params.water_level;
316 u32 EmergeManager::getBlockSeed(v3s16 p) {
317 return (u32)(params.seed & 0xFFFFFFFF) +
324 Mapgen *EmergeManager::createMapgen(std::string mgname, int mgid,
325 MapgenParams *mgparams) {
326 std::map<std::string, MapgenFactory *>::const_iterator iter;
327 iter = mglist.find(mgname);
328 if (iter == mglist.end()) {
329 errorstream << "EmergeManager; mapgen " << mgname <<
330 " not registered" << std::endl;
334 MapgenFactory *mgfactory = iter->second;
335 return mgfactory->createMapgen(mgid, mgparams, this);
339 MapgenSpecificParams *EmergeManager::createMapgenParams(std::string mgname) {
340 std::map<std::string, MapgenFactory *>::const_iterator iter;
341 iter = mglist.find(mgname);
342 if (iter == mglist.end()) {
343 errorstream << "EmergeManager: mapgen " << mgname <<
344 " not registered" << std::endl;
348 MapgenFactory *mgfactory = iter->second;
349 return mgfactory->createMapgenParams();
353 void EmergeManager::loadParamsFromSettings(Settings *settings) {
354 std::string seed_str;
355 const char *setname = (settings == g_settings) ? "fixed_map_seed" : "seed";
357 if (settings->getNoEx(setname, seed_str))
358 params.seed = read_seed(seed_str.c_str());
360 settings->getNoEx("mg_name", params.mg_name);
361 settings->getS16NoEx("water_level", params.water_level);
362 settings->getS16NoEx("chunksize", params.chunksize);
363 settings->getFlagStrNoEx("mg_flags", params.flags, flagdesc_mapgen);
365 delete params.sparams;
366 params.sparams = createMapgenParams(params.mg_name);
368 params.sparams->readParams(settings);
372 void EmergeManager::saveParamsToSettings(Settings *settings) {
373 settings->set("mg_name", params.mg_name);
374 settings->setU64("seed", params.seed);
375 settings->setS16("water_level", params.water_level);
376 settings->setS16("chunksize", params.chunksize);
377 settings->setFlagStr("mg_flags", params.flags, flagdesc_mapgen, (u32)-1);
380 params.sparams->writeParams(settings);
384 void EmergeManager::registerMapgen(std::string mgname, MapgenFactory *mgfactory) {
385 mglist.insert(std::make_pair(mgname, mgfactory));
386 infostream << "EmergeManager: registered mapgen " << mgname << std::endl;
390 ////////////////////////////// Emerge Thread //////////////////////////////////
392 bool EmergeThread::popBlockEmerge(v3s16 *pos, u8 *flags) {
393 std::map<v3s16, BlockEmergeData *>::iterator iter;
394 JMutexAutoLock queuelock(emerge->queuemutex);
396 if (blockqueue.empty())
398 v3s16 p = blockqueue.front();
403 iter = emerge->blocks_enqueued.find(p);
404 if (iter == emerge->blocks_enqueued.end())
405 return false; //uh oh, queue and map out of sync!!
407 BlockEmergeData *bedata = iter->second;
408 *flags = bedata->flags;
410 emerge->peer_queue_count[bedata->peer_requested]--;
413 emerge->blocks_enqueued.erase(iter);
419 bool EmergeThread::getBlockOrStartGen(v3s16 p, MapBlock **b,
420 BlockMakeData *data, bool allow_gen) {
422 //envlock: usually takes <=1ms, sometimes 90ms or ~400ms to acquire
423 JMutexAutoLock envlock(m_server->m_env_mutex);
425 // Load sector if it isn't loaded
426 if (map->getSectorNoGenerateNoEx(p2d) == NULL)
427 map->loadSectorMeta(p2d);
429 // Attempt to load block
430 MapBlock *block = map->getBlockNoCreateNoEx(p);
431 if (!block || block->isDummy() || !block->isGenerated()) {
432 EMERGE_DBG_OUT("not in memory, attempting to load from disk");
433 block = map->loadBlock(p);
434 if (block && block->isGenerated())
435 map->prepareBlock(block);
438 // If could not load and allowed to generate,
439 // start generation inside this same envlock
440 if (allow_gen && (block == NULL || !block->isGenerated())) {
441 EMERGE_DBG_OUT("generating");
443 return map->initBlockMake(data, p);
451 void *EmergeThread::Thread() {
453 log_register_thread("EmergeThread" + itos(id));
454 DSTACK(__FUNCTION_NAME);
455 BEGIN_DEBUG_EXCEPTION_HANDLER
457 v3s16 last_tried_pos(-32768,-32768,-32768); // For error output
461 map = (ServerMap *)&(m_server->m_env->getMap());
462 emerge = m_server->m_emerge;
463 mapgen = emerge->mapgen[id];
464 enable_mapgen_debug_info = emerge->mapgen_debug_info;
466 porting::setThreadName("EmergeThread");
468 while (!StopRequested())
470 if (!popBlockEmerge(&p, &flags)) {
476 if (blockpos_over_limit(p))
479 bool allow_generate = flags & BLOCK_EMERGE_ALLOWGEN;
480 EMERGE_DBG_OUT("p=" PP(p) " allow_generate=" << allow_generate);
483 Try to fetch block from memory or disk.
484 If not found and asked to generate, initialize generator.
487 MapBlock *block = NULL;
488 std::map<v3s16, MapBlock *> modified_blocks;
490 if (getBlockOrStartGen(p, &block, &data, allow_generate) && mapgen) {
492 ScopeProfiler sp(g_profiler, "EmergeThread: Mapgen::makeChunk", SPT_AVG);
493 TimeTaker t("mapgen::make_block()");
495 mapgen->makeChunk(&data);
497 if (enable_mapgen_debug_info == false)
498 t.stop(true); // Hide output
502 //envlock: usually 0ms, but can take either 30 or 400ms to acquire
503 JMutexAutoLock envlock(m_server->m_env_mutex);
504 ScopeProfiler sp(g_profiler, "EmergeThread: after "
505 "Mapgen::makeChunk (envlock)", SPT_AVG);
507 map->finishBlockMake(&data, modified_blocks);
509 block = map->getBlockNoCreateNoEx(p);
512 Do some post-generate stuff
514 v3s16 minp = data.blockpos_min * MAP_BLOCKSIZE;
515 v3s16 maxp = data.blockpos_max * MAP_BLOCKSIZE +
516 v3s16(1,1,1) * (MAP_BLOCKSIZE - 1);
518 // Ignore map edit events, they will not need to be sent
519 // to anybody because the block hasn't been sent to anybody
520 MapEditEventAreaIgnorer
521 ign(&m_server->m_ignore_map_edit_events_area,
522 VoxelArea(minp, maxp));
523 try { // takes about 90ms with -O1 on an e3-1230v2
524 m_server->getScriptIface()->environment_OnGenerated(
525 minp, maxp, emerge->getBlockSeed(minp));
526 } catch(LuaError &e) {
527 m_server->setAsyncFatalError(e.what());
530 EMERGE_DBG_OUT("ended up with: " << analyze_block(block));
532 m_server->m_env->activateBlock(block, 0);
538 Set sent status of modified blocks on clients
540 // Add the originally fetched block to the modified list
542 modified_blocks[p] = block;
544 if (modified_blocks.size() > 0) {
545 m_server->SetBlocksNotSent(modified_blocks);
548 catch (VersionMismatchException &e) {
549 std::ostringstream err;
550 err << "World data version mismatch in MapBlock "<<PP(last_tried_pos)<<std::endl;
551 err << "----"<<std::endl;
552 err << "\""<<e.what()<<"\""<<std::endl;
553 err << "See debug.txt."<<std::endl;
554 err << "World probably saved by a newer version of Minetest."<<std::endl;
555 m_server->setAsyncFatalError(err.str());
557 catch (SerializationError &e) {
558 std::ostringstream err;
559 err << "Invalid data in MapBlock "<<PP(last_tried_pos)<<std::endl;
560 err << "----"<<std::endl;
561 err << "\""<<e.what()<<"\""<<std::endl;
562 err << "See debug.txt."<<std::endl;
563 err << "You can ignore this using [ignore_world_load_errors = true]."<<std::endl;
564 m_server->setAsyncFatalError(err.str());
567 END_DEBUG_EXCEPTION_HANDLER(errorstream)
568 log_deregister_thread();