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"
44 #include "mg_decoration.h"
45 #include "mg_schematic.h"
46 #include "mapgen_v5.h"
47 #include "mapgen_v6.h"
48 #include "mapgen_v7.h"
49 #include "mapgen_singlenode.h"
52 class EmergeThread : public JThread
57 EmergeManager *emerge;
59 bool enable_mapgen_debug_info;
63 std::queue<v3s16> blockqueue;
65 EmergeThread(Server *server, int ethreadid):
71 enable_mapgen_debug_info(false),
77 bool popBlockEmerge(v3s16 *pos, u8 *flags);
78 bool getBlockOrStartGen(v3s16 p, MapBlock **b,
79 BlockMakeData *data, bool allow_generate);
83 /////////////////////////////// Emerge Manager ////////////////////////////////
85 EmergeManager::EmergeManager(IGameDef *gamedef) {
86 //register built-in mapgens
87 registerMapgen("v5", new MapgenFactoryV5());
88 registerMapgen("v6", new MapgenFactoryV6());
89 registerMapgen("v7", new MapgenFactoryV7());
90 registerMapgen("singlenode", new MapgenFactorySinglenode());
92 this->ndef = gamedef->getNodeDefManager();
93 this->biomemgr = new BiomeManager(gamedef);
94 this->oremgr = new OreManager(gamedef);
95 this->decomgr = new DecorationManager(gamedef);
96 this->schemmgr = new SchematicManager(gamedef);
97 this->gen_notify_on = 0;
99 // Note that accesses to this variable are not synchronized.
100 // This is because the *only* thread ever starting or stopping
101 // EmergeThreads should be the ServerThread.
102 this->threads_active = false;
104 mapgen_debug_info = g_settings->getBool("enable_mapgen_debug_info");
106 // if unspecified, leave a proc for the main thread and one for
107 // some other misc thread
109 if (!g_settings->getS16NoEx("num_emerge_threads", nthreads))
110 nthreads = porting::getNumberOfProcessors() - 2;
114 qlimit_total = g_settings->getU16("emergequeue_limit_total");
115 if (!g_settings->getU16NoEx("emergequeue_limit_diskonly", qlimit_diskonly))
116 qlimit_diskonly = nthreads * 5 + 1;
117 if (!g_settings->getU16NoEx("emergequeue_limit_generate", qlimit_generate))
118 qlimit_generate = nthreads + 1;
120 // don't trust user input for something very important like this
121 if (qlimit_total < 1)
123 if (qlimit_diskonly < 1)
125 if (qlimit_generate < 1)
128 for (s16 i = 0; i < nthreads; i++)
129 emergethread.push_back(new EmergeThread((Server *) gamedef, i));
131 infostream << "EmergeManager: using " << nthreads << " threads" << std::endl;
135 EmergeManager::~EmergeManager() {
136 for (unsigned int i = 0; i != emergethread.size(); i++) {
137 if (threads_active) {
138 emergethread[i]->Stop();
139 emergethread[i]->qevent.signal();
140 emergethread[i]->Wait();
142 delete emergethread[i];
145 emergethread.clear();
148 std::map<std::string, MapgenFactory *>::iterator it;
149 for (it = mglist.begin(); it != mglist.end(); ++it)
158 if (params.sparams) {
159 delete params.sparams;
160 params.sparams = NULL;
165 void EmergeManager::loadMapgenParams() {
166 loadParamsFromSettings(g_settings);
168 if (g_settings->get("fixed_map_seed").empty()) {
169 params.seed = (((u64)(myrand() & 0xffff) << 0)
170 | ((u64)(myrand() & 0xffff) << 16)
171 | ((u64)(myrand() & 0xffff) << 32)
172 | ((u64)(myrand() & 0xffff) << 48));
177 void EmergeManager::initMapgens() {
181 if (!params.sparams) {
182 params.sparams = createMapgenParams(params.mg_name);
183 if (!params.sparams) {
184 params.mg_name = DEFAULT_MAPGEN;
185 params.sparams = createMapgenParams(params.mg_name);
186 assert(params.sparams);
188 params.sparams->readParams(g_settings);
191 // Create the mapgens
192 for (size_t i = 0; i != emergethread.size(); i++) {
193 Mapgen *mg = createMapgen(params.mg_name, i, ¶ms);
195 mapgen.push_back(mg);
200 Mapgen *EmergeManager::getCurrentMapgen() {
201 for (unsigned int i = 0; i != emergethread.size(); i++) {
202 if (emergethread[i]->IsSameThread())
203 return emergethread[i]->mapgen;
210 void EmergeManager::startThreads() {
214 for (unsigned int i = 0; i != emergethread.size(); i++)
215 emergethread[i]->Start();
217 threads_active = true;
221 void EmergeManager::stopThreads() {
225 // Request thread stop in parallel
226 for (unsigned int i = 0; i != emergethread.size(); i++) {
227 emergethread[i]->Stop();
228 emergethread[i]->qevent.signal();
231 // Then do the waiting for each
232 for (unsigned int i = 0; i != emergethread.size(); i++)
233 emergethread[i]->Wait();
235 threads_active = false;
239 bool EmergeManager::enqueueBlockEmerge(u16 peer_id, v3s16 p, bool allow_generate) {
240 std::map<v3s16, BlockEmergeData *>::const_iterator iter;
241 BlockEmergeData *bedata;
247 flags |= BLOCK_EMERGE_ALLOWGEN;
250 JMutexAutoLock queuelock(queuemutex);
252 count = blocks_enqueued.size();
253 if (count >= qlimit_total)
256 count = peer_queue_count[peer_id];
257 u16 qlimit_peer = allow_generate ? qlimit_generate : qlimit_diskonly;
258 if (count >= qlimit_peer)
261 iter = blocks_enqueued.find(p);
262 if (iter != blocks_enqueued.end()) {
263 bedata = iter->second;
264 bedata->flags |= flags;
268 bedata = new BlockEmergeData;
269 bedata->flags = flags;
270 bedata->peer_requested = peer_id;
271 blocks_enqueued.insert(std::make_pair(p, bedata));
273 peer_queue_count[peer_id] = count + 1;
275 // insert into the EmergeThread queue with the least items
276 int lowestitems = emergethread[0]->blockqueue.size();
277 for (unsigned int i = 1; i != emergethread.size(); i++) {
278 int nitems = emergethread[i]->blockqueue.size();
279 if (nitems < lowestitems) {
281 lowestitems = nitems;
285 emergethread[idx]->blockqueue.push(p);
287 emergethread[idx]->qevent.signal();
293 int EmergeManager::getGroundLevelAtPoint(v2s16 p) {
294 if (mapgen.size() == 0 || !mapgen[0]) {
295 errorstream << "EmergeManager: getGroundLevelAtPoint() called"
296 " before mapgen initialized" << std::endl;
300 return mapgen[0]->getGroundLevelAtPoint(p);
304 bool EmergeManager::isBlockUnderground(v3s16 blockpos) {
306 v2s16 p = v2s16((blockpos.X * MAP_BLOCKSIZE) + MAP_BLOCKSIZE / 2,
307 (blockpos.Y * MAP_BLOCKSIZE) + MAP_BLOCKSIZE / 2);
308 int ground_level = getGroundLevelAtPoint(p);
309 return blockpos.Y * (MAP_BLOCKSIZE + 1) <= min(water_level, ground_level);
312 //yuck, but then again, should i bother being accurate?
313 //the height of the nodes in a single block is quite variable
314 return blockpos.Y * (MAP_BLOCKSIZE + 1) <= params.water_level;
318 u32 EmergeManager::getBlockSeed(v3s16 p) {
319 return (u32)(params.seed & 0xFFFFFFFF) +
326 Mapgen *EmergeManager::createMapgen(std::string mgname, int mgid,
327 MapgenParams *mgparams) {
328 std::map<std::string, MapgenFactory *>::const_iterator iter;
329 iter = mglist.find(mgname);
330 if (iter == mglist.end()) {
331 errorstream << "EmergeManager; mapgen " << mgname <<
332 " not registered" << std::endl;
336 MapgenFactory *mgfactory = iter->second;
337 return mgfactory->createMapgen(mgid, mgparams, this);
341 MapgenSpecificParams *EmergeManager::createMapgenParams(std::string mgname) {
342 std::map<std::string, MapgenFactory *>::const_iterator iter;
343 iter = mglist.find(mgname);
344 if (iter == mglist.end()) {
345 errorstream << "EmergeManager: mapgen " << mgname <<
346 " not registered" << std::endl;
350 MapgenFactory *mgfactory = iter->second;
351 return mgfactory->createMapgenParams();
355 void EmergeManager::loadParamsFromSettings(Settings *settings) {
356 std::string seed_str;
357 const char *setname = (settings == g_settings) ? "fixed_map_seed" : "seed";
359 if (settings->getNoEx(setname, seed_str))
360 params.seed = read_seed(seed_str.c_str());
362 settings->getNoEx("mg_name", params.mg_name);
363 settings->getS16NoEx("water_level", params.water_level);
364 settings->getS16NoEx("chunksize", params.chunksize);
365 settings->getFlagStrNoEx("mg_flags", params.flags, flagdesc_mapgen);
367 delete params.sparams;
368 params.sparams = createMapgenParams(params.mg_name);
370 params.sparams->readParams(settings);
374 void EmergeManager::saveParamsToSettings(Settings *settings) {
375 settings->set("mg_name", params.mg_name);
376 settings->setU64("seed", params.seed);
377 settings->setS16("water_level", params.water_level);
378 settings->setS16("chunksize", params.chunksize);
379 settings->setFlagStr("mg_flags", params.flags, flagdesc_mapgen, (u32)-1);
382 params.sparams->writeParams(settings);
386 void EmergeManager::registerMapgen(std::string mgname, MapgenFactory *mgfactory) {
387 mglist.insert(std::make_pair(mgname, mgfactory));
388 infostream << "EmergeManager: registered mapgen " << mgname << std::endl;
392 ////////////////////////////// Emerge Thread //////////////////////////////////
394 bool EmergeThread::popBlockEmerge(v3s16 *pos, u8 *flags) {
395 std::map<v3s16, BlockEmergeData *>::iterator iter;
396 JMutexAutoLock queuelock(emerge->queuemutex);
398 if (blockqueue.empty())
400 v3s16 p = blockqueue.front();
405 iter = emerge->blocks_enqueued.find(p);
406 if (iter == emerge->blocks_enqueued.end())
407 return false; //uh oh, queue and map out of sync!!
409 BlockEmergeData *bedata = iter->second;
410 *flags = bedata->flags;
412 emerge->peer_queue_count[bedata->peer_requested]--;
415 emerge->blocks_enqueued.erase(iter);
421 bool EmergeThread::getBlockOrStartGen(v3s16 p, MapBlock **b,
422 BlockMakeData *data, bool allow_gen) {
424 //envlock: usually takes <=1ms, sometimes 90ms or ~400ms to acquire
425 JMutexAutoLock envlock(m_server->m_env_mutex);
427 // Load sector if it isn't loaded
428 if (map->getSectorNoGenerateNoEx(p2d) == NULL)
429 map->loadSectorMeta(p2d);
431 // Attempt to load block
432 MapBlock *block = map->getBlockNoCreateNoEx(p);
433 if (!block || block->isDummy() || !block->isGenerated()) {
434 EMERGE_DBG_OUT("not in memory, attempting to load from disk");
435 block = map->loadBlock(p);
436 if (block && block->isGenerated())
437 map->prepareBlock(block);
440 // If could not load and allowed to generate,
441 // start generation inside this same envlock
442 if (allow_gen && (block == NULL || !block->isGenerated())) {
443 EMERGE_DBG_OUT("generating");
445 return map->initBlockMake(data, p);
453 void *EmergeThread::Thread() {
455 log_register_thread("EmergeThread" + itos(id));
456 DSTACK(__FUNCTION_NAME);
457 BEGIN_DEBUG_EXCEPTION_HANDLER
459 v3s16 last_tried_pos(-32768,-32768,-32768); // For error output
463 map = (ServerMap *)&(m_server->m_env->getMap());
464 emerge = m_server->m_emerge;
465 mapgen = emerge->mapgen[id];
466 enable_mapgen_debug_info = emerge->mapgen_debug_info;
468 porting::setThreadName("EmergeThread");
470 while (!StopRequested())
472 if (!popBlockEmerge(&p, &flags)) {
478 if (blockpos_over_limit(p))
481 bool allow_generate = flags & BLOCK_EMERGE_ALLOWGEN;
482 EMERGE_DBG_OUT("p=" PP(p) " allow_generate=" << allow_generate);
485 Try to fetch block from memory or disk.
486 If not found and asked to generate, initialize generator.
489 MapBlock *block = NULL;
490 std::map<v3s16, MapBlock *> modified_blocks;
492 if (getBlockOrStartGen(p, &block, &data, allow_generate) && mapgen) {
494 ScopeProfiler sp(g_profiler, "EmergeThread: Mapgen::makeChunk", SPT_AVG);
495 TimeTaker t("mapgen::make_block()");
497 mapgen->makeChunk(&data);
499 if (enable_mapgen_debug_info == false)
500 t.stop(true); // Hide output
504 //envlock: usually 0ms, but can take either 30 or 400ms to acquire
505 JMutexAutoLock envlock(m_server->m_env_mutex);
506 ScopeProfiler sp(g_profiler, "EmergeThread: after "
507 "Mapgen::makeChunk (envlock)", SPT_AVG);
509 map->finishBlockMake(&data, modified_blocks);
511 block = map->getBlockNoCreateNoEx(p);
514 Do some post-generate stuff
516 v3s16 minp = data.blockpos_min * MAP_BLOCKSIZE;
517 v3s16 maxp = data.blockpos_max * MAP_BLOCKSIZE +
518 v3s16(1,1,1) * (MAP_BLOCKSIZE - 1);
520 // Ignore map edit events, they will not need to be sent
521 // to anybody because the block hasn't been sent to anybody
522 MapEditEventAreaIgnorer
523 ign(&m_server->m_ignore_map_edit_events_area,
524 VoxelArea(minp, maxp));
525 try { // takes about 90ms with -O1 on an e3-1230v2
526 m_server->getScriptIface()->environment_OnGenerated(
527 minp, maxp, emerge->getBlockSeed(minp));
528 } catch(LuaError &e) {
529 m_server->setAsyncFatalError(e.what());
532 EMERGE_DBG_OUT("ended up with: " << analyze_block(block));
534 m_server->m_env->activateBlock(block, 0);
540 Set sent status of modified blocks on clients
542 // Add the originally fetched block to the modified list
544 modified_blocks[p] = block;
546 if (modified_blocks.size() > 0) {
547 m_server->SetBlocksNotSent(modified_blocks);
550 catch (VersionMismatchException &e) {
551 std::ostringstream err;
552 err << "World data version mismatch in MapBlock "<<PP(last_tried_pos)<<std::endl;
553 err << "----"<<std::endl;
554 err << "\""<<e.what()<<"\""<<std::endl;
555 err << "See debug.txt."<<std::endl;
556 err << "World probably saved by a newer version of Minetest."<<std::endl;
557 m_server->setAsyncFatalError(err.str());
559 catch (SerializationError &e) {
560 std::ostringstream err;
561 err << "Invalid data in MapBlock "<<PP(last_tried_pos)<<std::endl;
562 err << "----"<<std::endl;
563 err << "\""<<e.what()<<"\""<<std::endl;
564 err << "See debug.txt."<<std::endl;
565 err << "You can ignore this using [ignore_world_load_errors = true]."<<std::endl;
566 m_server->setAsyncFatalError(err.str());
569 END_DEBUG_EXCEPTION_HANDLER(errorstream)
570 log_deregister_thread();