3 Copyright (C) 2010-2011 celeron55, Perttu Ahola <celeron55@gmail.com>
5 This program is free software; you can redistribute it and/or modify
6 it under the terms of the GNU Lesser General Public License as published by
7 the Free Software Foundation; either version 2.1 of the License, or
8 (at your option) any later version.
10 This program is distributed in the hope that it will be useful,
11 but WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 GNU Lesser General Public License for more details.
15 You should have received a copy of the GNU Lesser General Public License along
16 with this program; if not, write to the Free Software Foundation, Inc.,
17 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
24 #include "clientserver.h"
26 #include "jmutexautolock.h"
28 #include "constants.h"
32 #include "serverobject.h"
35 #include "scriptapi.h"
41 #include "mapgen_v6.h"
44 EmergeManager::EmergeManager(IGameDef *gamedef, BiomeDefManager *bdef) {
45 //register built-in mapgens
46 registerMapgen("v6", new MapgenFactoryV6());
48 this->biomedef = bdef ? bdef : new BiomeDefManager(gamedef);
51 mapgen_debug_info = g_settings->getBool("enable_mapgen_debug_info");
53 qlimit_total = g_settings->getU16("emergequeue_limit_total");
54 qlimit_diskonly = g_settings->getU16("emergequeue_limit_diskonly");
55 qlimit_generate = g_settings->getU16("emergequeue_limit_generate");
58 int nthreads = g_settings->get("num_emerge_threads").empty() ?
59 porting::getNumberOfProcessors() :
60 g_settings->getU16("num_emerge_threads");
64 for (int i = 0; i != nthreads; i++)
65 emergethread.push_back(new EmergeThread((Server *)gamedef, i));
67 infostream << "EmergeManager: using " << nthreads << " threads" << std::endl;
71 EmergeManager::~EmergeManager() {
72 for (int i = 0; i != emergethread.size(); i++) {
73 emergethread[i]->setRun(false);
74 emergethread[i]->qevent.signal();
75 emergethread[i]->stop();
76 delete emergethread[i];
85 void EmergeManager::initMapgens(MapgenParams *mgparams) {
91 this->params = mgparams;
92 for (int i = 0; i != emergethread.size(); i++) {
93 mg = createMapgen(params->mg_name, 0, params);
95 infostream << "EmergeManager: falling back to mapgen v6" << std::endl;
97 params = createMapgenParams("v6");
98 mg = createMapgen("v6", 0, params);
100 mapgen.push_back(mg);
105 bool EmergeManager::enqueueBlockEmerge(u16 peer_id, v3s16 p, bool allow_generate) {
106 std::map<v3s16, BlockEmergeData *>::const_iterator iter;
107 BlockEmergeData *bedata;
113 flags |= BLOCK_EMERGE_ALLOWGEN;
116 JMutexAutoLock queuelock(queuemutex);
118 count = blocks_enqueued.size();
119 if (count >= qlimit_total)
122 count = peer_queue_count[peer_id];
123 u16 qlimit_peer = allow_generate ? qlimit_generate : qlimit_diskonly;
124 if (count >= qlimit_peer)
127 iter = blocks_enqueued.find(p);
128 if (iter != blocks_enqueued.end()) {
129 bedata = iter->second;
130 bedata->flags |= flags;
134 bedata = new BlockEmergeData;
135 bedata->flags = flags;
136 bedata->peer_requested = peer_id;
137 blocks_enqueued.insert(std::make_pair(p, bedata));
139 peer_queue_count[peer_id] = count + 1;
141 int lowestitems = emergethread[0]->blockqueue.size();
142 for (int i = 1; i != emergethread.size(); i++) {
143 int nitems = emergethread[i]->blockqueue.size();
144 if (nitems < lowestitems) {
146 lowestitems = nitems;
150 emergethread[idx]->blockqueue.push(p);
152 emergethread[idx]->qevent.signal();
158 bool EmergeThread::popBlockEmerge(v3s16 *pos, u8 *flags) {
159 std::map<v3s16, BlockEmergeData *>::iterator iter;
160 JMutexAutoLock queuelock(emerge->queuemutex);
162 if (blockqueue.empty())
164 v3s16 p = blockqueue.front();
169 iter = emerge->blocks_enqueued.find(p);
170 if (iter == emerge->blocks_enqueued.end())
171 return false; //uh oh, queue and map out of sync!!
173 BlockEmergeData *bedata = iter->second;
174 *flags = bedata->flags;
176 emerge->peer_queue_count[bedata->peer_requested]--;
179 emerge->blocks_enqueued.erase(iter);
185 int EmergeManager::getGroundLevelAtPoint(v2s16 p) {
187 errorstream << "EmergeManager: getGroundLevelAtPoint() called"
188 " before mapgen initialized" << std::endl;
192 return mapgen[0]->getGroundLevelAtPoint(p);
196 bool EmergeManager::isBlockUnderground(v3s16 blockpos) {
198 v2s16 p = v2s16((blockpos.X * MAP_BLOCKSIZE) + MAP_BLOCKSIZE / 2,
199 (blockpos.Y * MAP_BLOCKSIZE) + MAP_BLOCKSIZE / 2);
200 int ground_level = getGroundLevelAtPoint(p);
201 return blockpos.Y * (MAP_BLOCKSIZE + 1) <= min(water_level, ground_level);
204 //yuck, but then again, should i bother being accurate?
205 //the height of the nodes in a single block is quite variable
206 return blockpos.Y * (MAP_BLOCKSIZE + 1) <= params->water_level;
210 u32 EmergeManager::getBlockSeed(v3s16 p) {
211 return (u32)(params->seed & 0xFFFFFFFF) +
218 Mapgen *EmergeManager::createMapgen(std::string mgname, int mgid,
219 MapgenParams *mgparams) {
220 std::map<std::string, MapgenFactory *>::const_iterator iter;
221 iter = mglist.find(mgname);
222 if (iter == mglist.end()) {
223 errorstream << "EmergeManager; mapgen " << mgname <<
224 " not registered" << std::endl;
228 MapgenFactory *mgfactory = iter->second;
229 return mgfactory->createMapgen(mgid, mgparams, this);
233 MapgenParams *EmergeManager::createMapgenParams(std::string mgname) {
234 std::map<std::string, MapgenFactory *>::const_iterator iter;
235 iter = mglist.find(mgname);
236 if (iter == mglist.end()) {
237 errorstream << "EmergeManager: mapgen " << mgname <<
238 " not registered" << std::endl;
242 MapgenFactory *mgfactory = iter->second;
243 return mgfactory->createMapgenParams();
247 MapgenParams *EmergeManager::getParamsFromSettings(Settings *settings) {
248 std::string mg_name = settings->get("mg_name");
249 MapgenParams *mgparams = createMapgenParams(mg_name);
251 mgparams->mg_name = mg_name;
252 mgparams->seed = settings->getU64(settings == g_settings ? "fixed_map_seed" : "seed");
253 mgparams->water_level = settings->getS16("water_level");
254 mgparams->chunksize = settings->getS16("chunksize");
255 mgparams->flags = settings->getFlagStr("mg_flags", flagdesc_mapgen);
257 if (!mgparams->readParams(settings)) {
265 void EmergeManager::setParamsToSettings(Settings *settings) {
266 settings->set("mg_name", params->mg_name);
267 settings->setU64("seed", params->seed);
268 settings->setS16("water_level", params->water_level);
269 settings->setS16("chunksize", params->chunksize);
270 settings->setFlagStr("mg_flags", params->flags, flagdesc_mapgen);
272 params->writeParams(settings);
276 bool EmergeManager::registerMapgen(std::string mgname, MapgenFactory *mgfactory) {
277 mglist.insert(std::make_pair(mgname, mgfactory));
278 infostream << "EmergeManager: registered mapgen " << mgname << std::endl;
283 class MapEditEventIgnorer
286 MapEditEventIgnorer(bool *flag):
295 ~MapEditEventIgnorer()
308 class MapEditEventAreaIgnorer
311 MapEditEventAreaIgnorer(VoxelArea *ignorevariable, const VoxelArea &a):
312 m_ignorevariable(ignorevariable)
314 if(m_ignorevariable->getVolume() == 0)
315 *m_ignorevariable = a;
317 m_ignorevariable = NULL;
320 ~MapEditEventAreaIgnorer()
324 assert(m_ignorevariable->getVolume() != 0);
325 *m_ignorevariable = VoxelArea();
330 VoxelArea *m_ignorevariable;
336 bool EmergeThread::getBlockOrStartGen(v3s16 p, MapBlock **b,
337 BlockMakeData *data, bool allow_gen) {
339 //envlock: usually takes <=1ms, sometimes 90ms or ~400ms to acquire
340 JMutexAutoLock envlock(m_server->m_env_mutex);
342 // Load sector if it isn't loaded
343 if (map->getSectorNoGenerateNoEx(p2d) == NULL)
344 map->loadSectorMeta(p2d);
346 // Attempt to load block
347 MapBlock *block = map->getBlockNoCreateNoEx(p);
348 if (!block || block->isDummy() || !block->isGenerated()) {
349 EMERGE_DBG_OUT("not in memory, attempting to load from disk");
350 block = map->loadBlock(p);
353 // If could not load and allowed to generate,
354 // start generation inside this same envlock
355 if (allow_gen && (block == NULL || !block->isGenerated())) {
356 EMERGE_DBG_OUT("generating");
358 return map->initBlockMake(data, p);
366 void *EmergeThread::Thread() {
368 log_register_thread("EmergeThread");
369 DSTACK(__FUNCTION_NAME);
370 BEGIN_DEBUG_EXCEPTION_HANDLER
372 v3s16 last_tried_pos(-32768,-32768,-32768); // For error output
376 map = (ServerMap *)&(m_server->m_env->getMap());
377 emerge = m_server->m_emerge;
378 mapgen = emerge->mapgen[id];
379 enable_mapgen_debug_info = emerge->mapgen_debug_info;
383 if (!popBlockEmerge(&p, &flags)) {
389 if (blockpos_over_limit(p))
392 bool allow_generate = flags & BLOCK_EMERGE_ALLOWGEN;
393 EMERGE_DBG_OUT("p=" PP(p) " allow_generate=" << allow_generate);
396 Try to fetch block from memory or disk.
397 If not found and asked to generate, initialize generator.
400 MapBlock *block = NULL;
401 core::map<v3s16, MapBlock *> modified_blocks;
403 if (getBlockOrStartGen(p, &block, &data, allow_generate)) {
405 ScopeProfiler sp(g_profiler, "EmergeThread: Mapgen::makeChunk", SPT_AVG);
406 TimeTaker t("mapgen::make_block()");
408 mapgen->makeChunk(&data);
410 if (enable_mapgen_debug_info == false)
411 t.stop(true); // Hide output
415 //envlock: usually 0ms, but can take either 30 or 400ms to acquire
416 JMutexAutoLock envlock(m_server->m_env_mutex);
417 ScopeProfiler sp(g_profiler, "EmergeThread: after "
418 "Mapgen::makeChunk (envlock)", SPT_AVG);
420 map->finishBlockMake(&data, modified_blocks);
422 block = map->getBlockNoCreateNoEx(p);
425 Do some post-generate stuff
427 v3s16 minp = data.blockpos_min * MAP_BLOCKSIZE;
428 v3s16 maxp = data.blockpos_max * MAP_BLOCKSIZE +
429 v3s16(1,1,1) * (MAP_BLOCKSIZE - 1);
431 // Ignore map edit events, they will not need to be sent
432 // to anybody because the block hasn't been sent to anybody
433 MapEditEventAreaIgnorer
434 ign(&m_server->m_ignore_map_edit_events_area,
435 VoxelArea(minp, maxp));
436 { // takes about 90ms with -O1 on an e3-1230v2
437 scriptapi_environment_on_generated(m_server->m_lua,
438 minp, maxp, emerge->getBlockSeed(minp));
441 EMERGE_DBG_OUT("ended up with: " << analyze_block(block));
443 m_server->m_env->activateBlock(block, 0);
449 Set sent status of modified blocks on clients
452 // NOTE: Server's clients are also behind the connection mutex
453 //conlock: consistently takes 30-40ms to acquire
454 JMutexAutoLock lock(m_server->m_con_mutex);
455 // Add the originally fetched block to the modified list
457 modified_blocks.insert(p, block);
459 // Set the modified blocks unsent for all the clients
460 for (core::map<u16, RemoteClient*>::Iterator
461 i = m_server->m_clients.getIterator();
462 i.atEnd() == false; i++) {
463 RemoteClient *client = i.getNode()->getValue();
464 if (modified_blocks.size() > 0) {
465 // Remove block from sent history
466 client->SetBlocksNotSent(modified_blocks);
470 catch (VersionMismatchException &e) {
471 std::ostringstream err;
472 err << "World data version mismatch in MapBlock "<<PP(last_tried_pos)<<std::endl;
473 err << "----"<<std::endl;
474 err << "\""<<e.what()<<"\""<<std::endl;
475 err << "See debug.txt."<<std::endl;
476 err << "World probably saved by a newer version of Minetest."<<std::endl;
477 m_server->setAsyncFatalError(err.str());
479 catch (SerializationError &e) {
480 std::ostringstream err;
481 err << "Invalid data in MapBlock "<<PP(last_tried_pos)<<std::endl;
482 err << "----"<<std::endl;
483 err << "\""<<e.what()<<"\""<<std::endl;
484 err << "See debug.txt."<<std::endl;
485 err << "You can ignore this using [ignore_world_load_errors = true]."<<std::endl;
486 m_server->setAsyncFatalError(err.str());
489 END_DEBUG_EXCEPTION_HANDLER(errorstream)
490 log_deregister_thread();
496 void *EmergeThread::Thread() {
498 log_register_thread("EmergeThread");
499 DSTACK(__FUNCTION_NAME);
500 BEGIN_DEBUG_EXCEPTION_HANDLER
502 bool enable_mapgen_debug_info = g_settings->getBool("enable_mapgen_debug_info");
504 v3s16 last_tried_pos(-32768,-32768,-32768); // For error output
505 ServerMap &map = ((ServerMap&)m_server->m_env->getMap());
506 EmergeManager *emerge = m_server->m_emerge;
507 Mapgen *mapgen = emerge->getMapgen();
511 QueuedBlockEmerge *qptr = m_server->m_emerge_queue.pop();
514 SharedPtr<QueuedBlockEmerge> q(qptr);
522 Do not generate over-limit
524 if (blockpos_over_limit(p))
527 //infostream<<"EmergeThread::Thread(): running"<<std::endl;
529 //TimeTaker timer("block emerge");
532 Try to emerge it from somewhere.
534 If it is only wanted as optional, only loading from disk
539 Check if any peer wants it as non-optional. In that case it
542 Also decrement the emerge queue count in clients.
545 bool only_from_disk = true;
547 core::map<u16, u8>::Iterator i;
548 for (i=q->s.getIterator(); !i.atEnd(); i++) {
549 u8 flags = i.getNode()->getValue();
550 if (!(flags & BLOCK_EMERGE_FLAG_FROMDISK)) {
551 only_from_disk = false;
557 if (enable_mapgen_debug_info)
558 infostream<<"EmergeThread: p="
559 <<"("<<p.X<<","<<p.Y<<","<<p.Z<<") "
560 <<"only_from_disk="<<only_from_disk<<std::endl;
562 MapBlock *block = NULL;
563 bool got_block = true;
564 core::map<v3s16, MapBlock*> modified_blocks;
567 Try to fetch block from memory or disk.
568 If not found and asked to generate, initialize generator.
571 bool started_generate = false;
574 JMutexAutoLock envlock(m_server->m_env_mutex);
576 // Load sector if it isn't loaded
577 if(map.getSectorNoGenerateNoEx(p2d) == NULL)
578 map.loadSectorMeta(p2d);
580 // Attempt to load block
581 block = map.getBlockNoCreateNoEx(p);
582 if(!block || block->isDummy() || !block->isGenerated()) {
583 if(enable_mapgen_debug_info)
584 infostream<<"EmergeThread: not in memory, "
585 <<"attempting to load from disk"<<std::endl;
587 block = map.loadBlock(p);
590 // If could not load and allowed to generate, start generation
591 // inside this same envlock
592 if(only_from_disk == false &&
593 (block == NULL || block->isGenerated() == false)){
594 if(enable_mapgen_debug_info)
595 infostream<<"EmergeThread: generating"<<std::endl;
596 started_generate = true;
598 map.initBlockMake(&data, p);
603 If generator was initialized, generate now when envlock is free.
605 if(started_generate) {
607 ScopeProfiler sp(g_profiler, "EmergeThread: mapgen::make_block",
609 TimeTaker t("mapgen::make_block()");
611 mapgen->makeChunk(&data);
613 if (enable_mapgen_debug_info == false)
614 t.stop(true); // Hide output
618 // Lock environment again to access the map
619 JMutexAutoLock envlock(m_server->m_env_mutex);
621 ScopeProfiler sp(g_profiler, "EmergeThread: after "
622 "mapgen::make_block (envlock)", SPT_AVG);
624 // Blit data back on map, update lighting, add mobs and
625 // whatever this does
626 map.finishBlockMake(&data, modified_blocks);
629 block = map.getBlockNoCreateNoEx(p);
631 // If block doesn't exist, don't try doing anything with it
632 // This happens if the block is not in generation boundaries
637 Do some post-generate stuff
639 v3s16 minp = data.blockpos_min * MAP_BLOCKSIZE;
640 v3s16 maxp = data.blockpos_max * MAP_BLOCKSIZE +
641 v3s16(1,1,1) * (MAP_BLOCKSIZE - 1);
644 Ignore map edit events, they will not need to be
645 sent to anybody because the block hasn't been sent
648 MapEditEventAreaIgnorer ign(
649 &m_server->m_ignore_map_edit_events_area,
650 VoxelArea(minp, maxp));
652 TimeTaker timer("on_generated");
653 scriptapi_environment_on_generated(m_server->m_lua,
654 minp, maxp, emerge->getBlockSeed(minp));
655 //int t = timer.stop(true);
656 //dstream<<"on_generated took "<<t<<"ms"<<std::endl;
659 if (enable_mapgen_debug_info)
660 infostream << "EmergeThread: ended up with: "
661 << analyze_block(block) << std::endl;
663 // Activate objects and stuff
664 m_server->m_env->activateBlock(block, 0);
672 Set sent status of modified blocks on clients
675 // NOTE: Server's clients are also behind the connection mutex
676 JMutexAutoLock lock(m_server->m_con_mutex);
679 Add the originally fetched block to the modified list
682 modified_blocks.insert(p, block);
685 Set the modified blocks unsent for all the clients
687 for(core::map<u16, RemoteClient*>::Iterator
688 i = m_server->m_clients.getIterator();
689 i.atEnd() == false; i++) {
690 RemoteClient *client = i.getNode()->getValue();
691 if(modified_blocks.size() > 0) {
692 // Remove block from sent history
693 client->SetBlocksNotSent(modified_blocks);
700 catch (VersionMismatchException &e) {
701 std::ostringstream err;
702 err << "World data version mismatch in MapBlock "<<PP(last_tried_pos)<<std::endl;
703 err << "----"<<std::endl;
704 err << "\""<<e.what()<<"\""<<std::endl;
705 err << "See debug.txt."<<std::endl;
706 err << "World probably saved by a newer version of Minetest."<<std::endl;
707 m_server->setAsyncFatalError(err.str());
709 catch (SerializationError &e) {
710 std::ostringstream err;
711 err << "Invalid data in MapBlock "<<PP(last_tried_pos)<<std::endl;
712 err << "----"<<std::endl;
713 err << "\""<<e.what()<<"\""<<std::endl;
714 err << "See debug.txt."<<std::endl;
715 err << "You can ignore this using [ignore_world_load_errors = true]."<<std::endl;
716 m_server->setAsyncFatalError(err.str());
718 printf("emergethread iterated %d times\n", niters);
719 END_DEBUG_EXCEPTION_HANDLER(errorstream)
720 log_deregister_thread();