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");
56 if (g_settings->get("num_emerge_threads").empty()) {
57 int nprocs = porting::getNumberOfProcessors();
58 // leave a proc for the main thread and one for some other misc threads
60 nthreads = nprocs - 2;
62 nthreads = g_settings->getU16("num_emerge_threads");
67 qlimit_total = g_settings->getU16("emergequeue_limit_total");
68 qlimit_diskonly = g_settings->get("emergequeue_limit_diskonly").empty() ?
70 g_settings->getU16("emergequeue_limit_diskonly");
71 qlimit_generate = g_settings->get("emergequeue_limit_generate").empty() ?
73 g_settings->getU16("emergequeue_limit_generate");
75 for (int i = 0; i != nthreads; i++)
76 emergethread.push_back(new EmergeThread((Server *)gamedef, i));
78 infostream << "EmergeManager: using " << nthreads << " threads" << std::endl;
82 EmergeManager::~EmergeManager() {
83 for (int i = 0; i != emergethread.size(); i++) {
84 emergethread[i]->setRun(false);
85 emergethread[i]->qevent.signal();
86 emergethread[i]->stop();
87 delete emergethread[i];
96 void EmergeManager::initMapgens(MapgenParams *mgparams) {
102 this->params = mgparams;
103 for (int i = 0; i != emergethread.size(); i++) {
104 mg = createMapgen(params->mg_name, 0, params);
106 infostream << "EmergeManager: falling back to mapgen v6" << std::endl;
108 params = createMapgenParams("v6");
109 mg = createMapgen("v6", 0, params);
111 mapgen.push_back(mg);
116 bool EmergeManager::enqueueBlockEmerge(u16 peer_id, v3s16 p, bool allow_generate) {
117 std::map<v3s16, BlockEmergeData *>::const_iterator iter;
118 BlockEmergeData *bedata;
124 flags |= BLOCK_EMERGE_ALLOWGEN;
127 JMutexAutoLock queuelock(queuemutex);
129 count = blocks_enqueued.size();
130 if (count >= qlimit_total)
133 count = peer_queue_count[peer_id];
134 u16 qlimit_peer = allow_generate ? qlimit_generate : qlimit_diskonly;
135 if (count >= qlimit_peer)
138 iter = blocks_enqueued.find(p);
139 if (iter != blocks_enqueued.end()) {
140 bedata = iter->second;
141 bedata->flags |= flags;
145 bedata = new BlockEmergeData;
146 bedata->flags = flags;
147 bedata->peer_requested = peer_id;
148 blocks_enqueued.insert(std::make_pair(p, bedata));
150 peer_queue_count[peer_id] = count + 1;
152 // insert into the EmergeThread queue with the least items
153 int lowestitems = emergethread[0]->blockqueue.size();
154 for (int i = 1; i != emergethread.size(); i++) {
155 int nitems = emergethread[i]->blockqueue.size();
156 if (nitems < lowestitems) {
158 lowestitems = nitems;
162 emergethread[idx]->blockqueue.push(p);
164 emergethread[idx]->qevent.signal();
170 bool EmergeThread::popBlockEmerge(v3s16 *pos, u8 *flags) {
171 std::map<v3s16, BlockEmergeData *>::iterator iter;
172 JMutexAutoLock queuelock(emerge->queuemutex);
174 if (blockqueue.empty())
176 v3s16 p = blockqueue.front();
181 iter = emerge->blocks_enqueued.find(p);
182 if (iter == emerge->blocks_enqueued.end())
183 return false; //uh oh, queue and map out of sync!!
185 BlockEmergeData *bedata = iter->second;
186 *flags = bedata->flags;
188 emerge->peer_queue_count[bedata->peer_requested]--;
191 emerge->blocks_enqueued.erase(iter);
197 int EmergeManager::getGroundLevelAtPoint(v2s16 p) {
198 if (mapgen.size() == 0 || !mapgen[0]) {
199 errorstream << "EmergeManager: getGroundLevelAtPoint() called"
200 " before mapgen initialized" << std::endl;
204 return mapgen[0]->getGroundLevelAtPoint(p);
208 bool EmergeManager::isBlockUnderground(v3s16 blockpos) {
210 v2s16 p = v2s16((blockpos.X * MAP_BLOCKSIZE) + MAP_BLOCKSIZE / 2,
211 (blockpos.Y * MAP_BLOCKSIZE) + MAP_BLOCKSIZE / 2);
212 int ground_level = getGroundLevelAtPoint(p);
213 return blockpos.Y * (MAP_BLOCKSIZE + 1) <= min(water_level, ground_level);
216 //yuck, but then again, should i bother being accurate?
217 //the height of the nodes in a single block is quite variable
218 return blockpos.Y * (MAP_BLOCKSIZE + 1) <= params->water_level;
222 u32 EmergeManager::getBlockSeed(v3s16 p) {
223 return (u32)(params->seed & 0xFFFFFFFF) +
230 Mapgen *EmergeManager::createMapgen(std::string mgname, int mgid,
231 MapgenParams *mgparams) {
232 std::map<std::string, MapgenFactory *>::const_iterator iter;
233 iter = mglist.find(mgname);
234 if (iter == mglist.end()) {
235 errorstream << "EmergeManager; mapgen " << mgname <<
236 " not registered" << std::endl;
240 MapgenFactory *mgfactory = iter->second;
241 return mgfactory->createMapgen(mgid, mgparams, this);
245 MapgenParams *EmergeManager::createMapgenParams(std::string mgname) {
246 std::map<std::string, MapgenFactory *>::const_iterator iter;
247 iter = mglist.find(mgname);
248 if (iter == mglist.end()) {
249 errorstream << "EmergeManager: mapgen " << mgname <<
250 " not registered" << std::endl;
254 MapgenFactory *mgfactory = iter->second;
255 return mgfactory->createMapgenParams();
259 MapgenParams *EmergeManager::getParamsFromSettings(Settings *settings) {
260 std::string mg_name = settings->get("mg_name");
261 MapgenParams *mgparams = createMapgenParams(mg_name);
263 mgparams->mg_name = mg_name;
264 mgparams->seed = settings->getU64(settings == g_settings ? "fixed_map_seed" : "seed");
265 mgparams->water_level = settings->getS16("water_level");
266 mgparams->chunksize = settings->getS16("chunksize");
267 mgparams->flags = settings->getFlagStr("mg_flags", flagdesc_mapgen);
269 if (!mgparams->readParams(settings)) {
277 void EmergeManager::setParamsToSettings(Settings *settings) {
278 settings->set("mg_name", params->mg_name);
279 settings->setU64("seed", params->seed);
280 settings->setS16("water_level", params->water_level);
281 settings->setS16("chunksize", params->chunksize);
282 settings->setFlagStr("mg_flags", params->flags, flagdesc_mapgen);
284 params->writeParams(settings);
288 bool EmergeManager::registerMapgen(std::string mgname, MapgenFactory *mgfactory) {
289 mglist.insert(std::make_pair(mgname, mgfactory));
290 infostream << "EmergeManager: registered mapgen " << mgname << std::endl;
295 class MapEditEventIgnorer
298 MapEditEventIgnorer(bool *flag):
307 ~MapEditEventIgnorer()
320 class MapEditEventAreaIgnorer
323 MapEditEventAreaIgnorer(VoxelArea *ignorevariable, const VoxelArea &a):
324 m_ignorevariable(ignorevariable)
326 if(m_ignorevariable->getVolume() == 0)
327 *m_ignorevariable = a;
329 m_ignorevariable = NULL;
332 ~MapEditEventAreaIgnorer()
336 assert(m_ignorevariable->getVolume() != 0);
337 *m_ignorevariable = VoxelArea();
342 VoxelArea *m_ignorevariable;
348 bool EmergeThread::getBlockOrStartGen(v3s16 p, MapBlock **b,
349 BlockMakeData *data, bool allow_gen) {
351 //envlock: usually takes <=1ms, sometimes 90ms or ~400ms to acquire
352 JMutexAutoLock envlock(m_server->m_env_mutex);
354 // Load sector if it isn't loaded
355 if (map->getSectorNoGenerateNoEx(p2d) == NULL)
356 map->loadSectorMeta(p2d);
358 // Attempt to load block
359 MapBlock *block = map->getBlockNoCreateNoEx(p);
360 if (!block || block->isDummy() || !block->isGenerated()) {
361 EMERGE_DBG_OUT("not in memory, attempting to load from disk");
362 block = map->loadBlock(p);
365 // If could not load and allowed to generate,
366 // start generation inside this same envlock
367 if (allow_gen && (block == NULL || !block->isGenerated())) {
368 EMERGE_DBG_OUT("generating");
370 return map->initBlockMake(data, p);
378 void *EmergeThread::Thread() {
380 log_register_thread("EmergeThread" + id);
381 DSTACK(__FUNCTION_NAME);
382 BEGIN_DEBUG_EXCEPTION_HANDLER
384 v3s16 last_tried_pos(-32768,-32768,-32768); // For error output
388 map = (ServerMap *)&(m_server->m_env->getMap());
389 emerge = m_server->m_emerge;
390 mapgen = emerge->mapgen[id];
391 enable_mapgen_debug_info = emerge->mapgen_debug_info;
395 if (!popBlockEmerge(&p, &flags)) {
401 if (blockpos_over_limit(p))
404 bool allow_generate = flags & BLOCK_EMERGE_ALLOWGEN;
405 EMERGE_DBG_OUT("p=" PP(p) " allow_generate=" << allow_generate);
408 Try to fetch block from memory or disk.
409 If not found and asked to generate, initialize generator.
412 MapBlock *block = NULL;
413 core::map<v3s16, MapBlock *> modified_blocks;
415 if (getBlockOrStartGen(p, &block, &data, allow_generate)) {
417 ScopeProfiler sp(g_profiler, "EmergeThread: Mapgen::makeChunk", SPT_AVG);
418 TimeTaker t("mapgen::make_block()");
420 mapgen->makeChunk(&data);
422 if (enable_mapgen_debug_info == false)
423 t.stop(true); // Hide output
427 //envlock: usually 0ms, but can take either 30 or 400ms to acquire
428 JMutexAutoLock envlock(m_server->m_env_mutex);
429 ScopeProfiler sp(g_profiler, "EmergeThread: after "
430 "Mapgen::makeChunk (envlock)", SPT_AVG);
432 map->finishBlockMake(&data, modified_blocks);
434 block = map->getBlockNoCreateNoEx(p);
437 Do some post-generate stuff
439 v3s16 minp = data.blockpos_min * MAP_BLOCKSIZE;
440 v3s16 maxp = data.blockpos_max * MAP_BLOCKSIZE +
441 v3s16(1,1,1) * (MAP_BLOCKSIZE - 1);
443 // Ignore map edit events, they will not need to be sent
444 // to anybody because the block hasn't been sent to anybody
445 MapEditEventAreaIgnorer
446 ign(&m_server->m_ignore_map_edit_events_area,
447 VoxelArea(minp, maxp));
448 { // takes about 90ms with -O1 on an e3-1230v2
449 scriptapi_environment_on_generated(m_server->m_lua,
450 minp, maxp, emerge->getBlockSeed(minp));
453 EMERGE_DBG_OUT("ended up with: " << analyze_block(block));
455 m_server->m_env->activateBlock(block, 0);
461 Set sent status of modified blocks on clients
464 // NOTE: Server's clients are also behind the connection mutex
465 //conlock: consistently takes 30-40ms to acquire
466 JMutexAutoLock lock(m_server->m_con_mutex);
467 // Add the originally fetched block to the modified list
469 modified_blocks.insert(p, block);
471 // Set the modified blocks unsent for all the clients
472 for (core::map<u16, RemoteClient*>::Iterator
473 i = m_server->m_clients.getIterator();
474 i.atEnd() == false; i++) {
475 RemoteClient *client = i.getNode()->getValue();
476 if (modified_blocks.size() > 0) {
477 // Remove block from sent history
478 client->SetBlocksNotSent(modified_blocks);
482 catch (VersionMismatchException &e) {
483 std::ostringstream err;
484 err << "World data version mismatch in MapBlock "<<PP(last_tried_pos)<<std::endl;
485 err << "----"<<std::endl;
486 err << "\""<<e.what()<<"\""<<std::endl;
487 err << "See debug.txt."<<std::endl;
488 err << "World probably saved by a newer version of Minetest."<<std::endl;
489 m_server->setAsyncFatalError(err.str());
491 catch (SerializationError &e) {
492 std::ostringstream err;
493 err << "Invalid data in MapBlock "<<PP(last_tried_pos)<<std::endl;
494 err << "----"<<std::endl;
495 err << "\""<<e.what()<<"\""<<std::endl;
496 err << "See debug.txt."<<std::endl;
497 err << "You can ignore this using [ignore_world_load_errors = true]."<<std::endl;
498 m_server->setAsyncFatalError(err.str());
501 END_DEBUG_EXCEPTION_HANDLER(errorstream)
502 log_deregister_thread();
508 void *EmergeThread::Thread() {
510 log_register_thread("EmergeThread");
511 DSTACK(__FUNCTION_NAME);
512 BEGIN_DEBUG_EXCEPTION_HANDLER
514 bool enable_mapgen_debug_info = g_settings->getBool("enable_mapgen_debug_info");
516 v3s16 last_tried_pos(-32768,-32768,-32768); // For error output
517 ServerMap &map = ((ServerMap&)m_server->m_env->getMap());
518 EmergeManager *emerge = m_server->m_emerge;
519 Mapgen *mapgen = emerge->getMapgen();
523 QueuedBlockEmerge *qptr = m_server->m_emerge_queue.pop();
526 SharedPtr<QueuedBlockEmerge> q(qptr);
534 Do not generate over-limit
536 if (blockpos_over_limit(p))
539 //infostream<<"EmergeThread::Thread(): running"<<std::endl;
541 //TimeTaker timer("block emerge");
544 Try to emerge it from somewhere.
546 If it is only wanted as optional, only loading from disk
551 Check if any peer wants it as non-optional. In that case it
554 Also decrement the emerge queue count in clients.
557 bool only_from_disk = true;
559 core::map<u16, u8>::Iterator i;
560 for (i=q->s.getIterator(); !i.atEnd(); i++) {
561 u8 flags = i.getNode()->getValue();
562 if (!(flags & BLOCK_EMERGE_FLAG_FROMDISK)) {
563 only_from_disk = false;
569 if (enable_mapgen_debug_info)
570 infostream<<"EmergeThread: p="
571 <<"("<<p.X<<","<<p.Y<<","<<p.Z<<") "
572 <<"only_from_disk="<<only_from_disk<<std::endl;
574 MapBlock *block = NULL;
575 bool got_block = true;
576 core::map<v3s16, MapBlock*> modified_blocks;
579 Try to fetch block from memory or disk.
580 If not found and asked to generate, initialize generator.
583 bool started_generate = false;
586 JMutexAutoLock envlock(m_server->m_env_mutex);
588 // Load sector if it isn't loaded
589 if(map.getSectorNoGenerateNoEx(p2d) == NULL)
590 map.loadSectorMeta(p2d);
592 // Attempt to load block
593 block = map.getBlockNoCreateNoEx(p);
594 if(!block || block->isDummy() || !block->isGenerated()) {
595 if(enable_mapgen_debug_info)
596 infostream<<"EmergeThread: not in memory, "
597 <<"attempting to load from disk"<<std::endl;
599 block = map.loadBlock(p);
602 // If could not load and allowed to generate, start generation
603 // inside this same envlock
604 if(only_from_disk == false &&
605 (block == NULL || block->isGenerated() == false)){
606 if(enable_mapgen_debug_info)
607 infostream<<"EmergeThread: generating"<<std::endl;
608 started_generate = true;
610 map.initBlockMake(&data, p);
615 If generator was initialized, generate now when envlock is free.
617 if(started_generate) {
619 ScopeProfiler sp(g_profiler, "EmergeThread: mapgen::make_block",
621 TimeTaker t("mapgen::make_block()");
623 mapgen->makeChunk(&data);
625 if (enable_mapgen_debug_info == false)
626 t.stop(true); // Hide output
630 // Lock environment again to access the map
631 JMutexAutoLock envlock(m_server->m_env_mutex);
633 ScopeProfiler sp(g_profiler, "EmergeThread: after "
634 "mapgen::make_block (envlock)", SPT_AVG);
636 // Blit data back on map, update lighting, add mobs and
637 // whatever this does
638 map.finishBlockMake(&data, modified_blocks);
641 block = map.getBlockNoCreateNoEx(p);
643 // If block doesn't exist, don't try doing anything with it
644 // This happens if the block is not in generation boundaries
649 Do some post-generate stuff
651 v3s16 minp = data.blockpos_min * MAP_BLOCKSIZE;
652 v3s16 maxp = data.blockpos_max * MAP_BLOCKSIZE +
653 v3s16(1,1,1) * (MAP_BLOCKSIZE - 1);
656 Ignore map edit events, they will not need to be
657 sent to anybody because the block hasn't been sent
660 MapEditEventAreaIgnorer ign(
661 &m_server->m_ignore_map_edit_events_area,
662 VoxelArea(minp, maxp));
664 TimeTaker timer("on_generated");
665 scriptapi_environment_on_generated(m_server->m_lua,
666 minp, maxp, emerge->getBlockSeed(minp));
667 //int t = timer.stop(true);
668 //dstream<<"on_generated took "<<t<<"ms"<<std::endl;
671 if (enable_mapgen_debug_info)
672 infostream << "EmergeThread: ended up with: "
673 << analyze_block(block) << std::endl;
675 // Activate objects and stuff
676 m_server->m_env->activateBlock(block, 0);
684 Set sent status of modified blocks on clients
687 // NOTE: Server's clients are also behind the connection mutex
688 JMutexAutoLock lock(m_server->m_con_mutex);
691 Add the originally fetched block to the modified list
694 modified_blocks.insert(p, block);
697 Set the modified blocks unsent for all the clients
699 for(core::map<u16, RemoteClient*>::Iterator
700 i = m_server->m_clients.getIterator();
701 i.atEnd() == false; i++) {
702 RemoteClient *client = i.getNode()->getValue();
703 if(modified_blocks.size() > 0) {
704 // Remove block from sent history
705 client->SetBlocksNotSent(modified_blocks);
712 catch (VersionMismatchException &e) {
713 std::ostringstream err;
714 err << "World data version mismatch in MapBlock "<<PP(last_tried_pos)<<std::endl;
715 err << "----"<<std::endl;
716 err << "\""<<e.what()<<"\""<<std::endl;
717 err << "See debug.txt."<<std::endl;
718 err << "World probably saved by a newer version of Minetest."<<std::endl;
719 m_server->setAsyncFatalError(err.str());
721 catch (SerializationError &e) {
722 std::ostringstream err;
723 err << "Invalid data in MapBlock "<<PP(last_tried_pos)<<std::endl;
724 err << "----"<<std::endl;
725 err << "\""<<e.what()<<"\""<<std::endl;
726 err << "See debug.txt."<<std::endl;
727 err << "You can ignore this using [ignore_world_load_errors = true]."<<std::endl;
728 m_server->setAsyncFatalError(err.str());
730 printf("emergethread iterated %d times\n", niters);
731 END_DEBUG_EXCEPTION_HANDLER(errorstream)
732 log_deregister_thread();