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
59 nthreads = (nprocs > 2) ? nthreads = nprocs - 2 : 1;
61 nthreads = g_settings->getU16("num_emerge_threads");
66 qlimit_total = g_settings->getU16("emergequeue_limit_total");
67 qlimit_diskonly = g_settings->get("emergequeue_limit_diskonly").empty() ?
69 g_settings->getU16("emergequeue_limit_diskonly");
70 qlimit_generate = g_settings->get("emergequeue_limit_generate").empty() ?
72 g_settings->getU16("emergequeue_limit_generate");
74 for (int i = 0; i != nthreads; i++)
75 emergethread.push_back(new EmergeThread((Server *)gamedef, i));
77 infostream << "EmergeManager: using " << nthreads << " threads" << std::endl;
81 EmergeManager::~EmergeManager() {
82 for (int i = 0; i != emergethread.size(); i++) {
83 emergethread[i]->setRun(false);
84 emergethread[i]->qevent.signal();
85 emergethread[i]->stop();
86 delete emergethread[i];
95 void EmergeManager::initMapgens(MapgenParams *mgparams) {
101 this->params = mgparams;
102 for (int i = 0; i != emergethread.size(); i++) {
103 mg = createMapgen(params->mg_name, 0, params);
105 infostream << "EmergeManager: falling back to mapgen v6" << std::endl;
107 params = createMapgenParams("v6");
108 mg = createMapgen("v6", 0, params);
110 mapgen.push_back(mg);
115 bool EmergeManager::enqueueBlockEmerge(u16 peer_id, v3s16 p, bool allow_generate) {
116 std::map<v3s16, BlockEmergeData *>::const_iterator iter;
117 BlockEmergeData *bedata;
123 flags |= BLOCK_EMERGE_ALLOWGEN;
126 JMutexAutoLock queuelock(queuemutex);
128 count = blocks_enqueued.size();
129 if (count >= qlimit_total)
132 count = peer_queue_count[peer_id];
133 u16 qlimit_peer = allow_generate ? qlimit_generate : qlimit_diskonly;
134 if (count >= qlimit_peer)
137 iter = blocks_enqueued.find(p);
138 if (iter != blocks_enqueued.end()) {
139 bedata = iter->second;
140 bedata->flags |= flags;
144 bedata = new BlockEmergeData;
145 bedata->flags = flags;
146 bedata->peer_requested = peer_id;
147 blocks_enqueued.insert(std::make_pair(p, bedata));
149 peer_queue_count[peer_id] = count + 1;
151 // insert into the EmergeThread queue with the least items
152 int lowestitems = emergethread[0]->blockqueue.size();
153 for (int i = 1; i != emergethread.size(); i++) {
154 int nitems = emergethread[i]->blockqueue.size();
155 if (nitems < lowestitems) {
157 lowestitems = nitems;
161 emergethread[idx]->blockqueue.push(p);
163 emergethread[idx]->qevent.signal();
169 bool EmergeThread::popBlockEmerge(v3s16 *pos, u8 *flags) {
170 std::map<v3s16, BlockEmergeData *>::iterator iter;
171 JMutexAutoLock queuelock(emerge->queuemutex);
173 if (blockqueue.empty())
175 v3s16 p = blockqueue.front();
180 iter = emerge->blocks_enqueued.find(p);
181 if (iter == emerge->blocks_enqueued.end())
182 return false; //uh oh, queue and map out of sync!!
184 BlockEmergeData *bedata = iter->second;
185 *flags = bedata->flags;
187 emerge->peer_queue_count[bedata->peer_requested]--;
190 emerge->blocks_enqueued.erase(iter);
196 int EmergeManager::getGroundLevelAtPoint(v2s16 p) {
197 if (mapgen.size() == 0 || !mapgen[0]) {
198 errorstream << "EmergeManager: getGroundLevelAtPoint() called"
199 " before mapgen initialized" << std::endl;
203 return mapgen[0]->getGroundLevelAtPoint(p);
207 bool EmergeManager::isBlockUnderground(v3s16 blockpos) {
209 v2s16 p = v2s16((blockpos.X * MAP_BLOCKSIZE) + MAP_BLOCKSIZE / 2,
210 (blockpos.Y * MAP_BLOCKSIZE) + MAP_BLOCKSIZE / 2);
211 int ground_level = getGroundLevelAtPoint(p);
212 return blockpos.Y * (MAP_BLOCKSIZE + 1) <= min(water_level, ground_level);
215 //yuck, but then again, should i bother being accurate?
216 //the height of the nodes in a single block is quite variable
217 return blockpos.Y * (MAP_BLOCKSIZE + 1) <= params->water_level;
221 u32 EmergeManager::getBlockSeed(v3s16 p) {
222 return (u32)(params->seed & 0xFFFFFFFF) +
229 Mapgen *EmergeManager::createMapgen(std::string mgname, int mgid,
230 MapgenParams *mgparams) {
231 std::map<std::string, MapgenFactory *>::const_iterator iter;
232 iter = mglist.find(mgname);
233 if (iter == mglist.end()) {
234 errorstream << "EmergeManager; mapgen " << mgname <<
235 " not registered" << std::endl;
239 MapgenFactory *mgfactory = iter->second;
240 return mgfactory->createMapgen(mgid, mgparams, this);
244 MapgenParams *EmergeManager::createMapgenParams(std::string mgname) {
245 std::map<std::string, MapgenFactory *>::const_iterator iter;
246 iter = mglist.find(mgname);
247 if (iter == mglist.end()) {
248 errorstream << "EmergeManager: mapgen " << mgname <<
249 " not registered" << std::endl;
253 MapgenFactory *mgfactory = iter->second;
254 return mgfactory->createMapgenParams();
258 MapgenParams *EmergeManager::getParamsFromSettings(Settings *settings) {
259 std::string mg_name = settings->get("mg_name");
260 MapgenParams *mgparams = createMapgenParams(mg_name);
262 mgparams->mg_name = mg_name;
263 mgparams->seed = settings->getU64(settings == g_settings ? "fixed_map_seed" : "seed");
264 mgparams->water_level = settings->getS16("water_level");
265 mgparams->chunksize = settings->getS16("chunksize");
266 mgparams->flags = settings->getFlagStr("mg_flags", flagdesc_mapgen);
268 if (!mgparams->readParams(settings)) {
276 void EmergeManager::setParamsToSettings(Settings *settings) {
277 settings->set("mg_name", params->mg_name);
278 settings->setU64("seed", params->seed);
279 settings->setS16("water_level", params->water_level);
280 settings->setS16("chunksize", params->chunksize);
281 settings->setFlagStr("mg_flags", params->flags, flagdesc_mapgen);
283 params->writeParams(settings);
287 bool EmergeManager::registerMapgen(std::string mgname, MapgenFactory *mgfactory) {
288 mglist.insert(std::make_pair(mgname, mgfactory));
289 infostream << "EmergeManager: registered mapgen " << mgname << std::endl;
294 class MapEditEventIgnorer
297 MapEditEventIgnorer(bool *flag):
306 ~MapEditEventIgnorer()
319 class MapEditEventAreaIgnorer
322 MapEditEventAreaIgnorer(VoxelArea *ignorevariable, const VoxelArea &a):
323 m_ignorevariable(ignorevariable)
325 if(m_ignorevariable->getVolume() == 0)
326 *m_ignorevariable = a;
328 m_ignorevariable = NULL;
331 ~MapEditEventAreaIgnorer()
335 assert(m_ignorevariable->getVolume() != 0);
336 *m_ignorevariable = VoxelArea();
341 VoxelArea *m_ignorevariable;
347 bool EmergeThread::getBlockOrStartGen(v3s16 p, MapBlock **b,
348 BlockMakeData *data, bool allow_gen) {
350 //envlock: usually takes <=1ms, sometimes 90ms or ~400ms to acquire
351 JMutexAutoLock envlock(m_server->m_env_mutex);
353 // Load sector if it isn't loaded
354 if (map->getSectorNoGenerateNoEx(p2d) == NULL)
355 map->loadSectorMeta(p2d);
357 // Attempt to load block
358 MapBlock *block = map->getBlockNoCreateNoEx(p);
359 if (!block || block->isDummy() || !block->isGenerated()) {
360 EMERGE_DBG_OUT("not in memory, attempting to load from disk");
361 block = map->loadBlock(p);
364 // If could not load and allowed to generate,
365 // start generation inside this same envlock
366 if (allow_gen && (block == NULL || !block->isGenerated())) {
367 EMERGE_DBG_OUT("generating");
369 return map->initBlockMake(data, p);
377 void *EmergeThread::Thread() {
379 log_register_thread("EmergeThread" + id);
380 DSTACK(__FUNCTION_NAME);
381 BEGIN_DEBUG_EXCEPTION_HANDLER
383 v3s16 last_tried_pos(-32768,-32768,-32768); // For error output
387 map = (ServerMap *)&(m_server->m_env->getMap());
388 emerge = m_server->m_emerge;
389 mapgen = emerge->mapgen[id];
390 enable_mapgen_debug_info = emerge->mapgen_debug_info;
394 if (!popBlockEmerge(&p, &flags)) {
400 if (blockpos_over_limit(p))
403 bool allow_generate = flags & BLOCK_EMERGE_ALLOWGEN;
404 EMERGE_DBG_OUT("p=" PP(p) " allow_generate=" << allow_generate);
407 Try to fetch block from memory or disk.
408 If not found and asked to generate, initialize generator.
411 MapBlock *block = NULL;
412 core::map<v3s16, MapBlock *> modified_blocks;
414 if (getBlockOrStartGen(p, &block, &data, allow_generate)) {
416 ScopeProfiler sp(g_profiler, "EmergeThread: Mapgen::makeChunk", SPT_AVG);
417 TimeTaker t("mapgen::make_block()");
419 mapgen->makeChunk(&data);
421 if (enable_mapgen_debug_info == false)
422 t.stop(true); // Hide output
426 //envlock: usually 0ms, but can take either 30 or 400ms to acquire
427 JMutexAutoLock envlock(m_server->m_env_mutex);
428 ScopeProfiler sp(g_profiler, "EmergeThread: after "
429 "Mapgen::makeChunk (envlock)", SPT_AVG);
431 map->finishBlockMake(&data, modified_blocks);
433 block = map->getBlockNoCreateNoEx(p);
436 Do some post-generate stuff
438 v3s16 minp = data.blockpos_min * MAP_BLOCKSIZE;
439 v3s16 maxp = data.blockpos_max * MAP_BLOCKSIZE +
440 v3s16(1,1,1) * (MAP_BLOCKSIZE - 1);
442 // Ignore map edit events, they will not need to be sent
443 // to anybody because the block hasn't been sent to anybody
444 MapEditEventAreaIgnorer
445 ign(&m_server->m_ignore_map_edit_events_area,
446 VoxelArea(minp, maxp));
447 { // takes about 90ms with -O1 on an e3-1230v2
448 scriptapi_environment_on_generated(m_server->m_lua,
449 minp, maxp, emerge->getBlockSeed(minp));
452 EMERGE_DBG_OUT("ended up with: " << analyze_block(block));
454 m_server->m_env->activateBlock(block, 0);
460 Set sent status of modified blocks on clients
463 // NOTE: Server's clients are also behind the connection mutex
464 //conlock: consistently takes 30-40ms to acquire
465 JMutexAutoLock lock(m_server->m_con_mutex);
466 // Add the originally fetched block to the modified list
468 modified_blocks.insert(p, block);
470 // Set the modified blocks unsent for all the clients
471 for (core::map<u16, RemoteClient*>::Iterator
472 i = m_server->m_clients.getIterator();
473 i.atEnd() == false; i++) {
474 RemoteClient *client = i.getNode()->getValue();
475 if (modified_blocks.size() > 0) {
476 // Remove block from sent history
477 client->SetBlocksNotSent(modified_blocks);
481 catch (VersionMismatchException &e) {
482 std::ostringstream err;
483 err << "World data version mismatch in MapBlock "<<PP(last_tried_pos)<<std::endl;
484 err << "----"<<std::endl;
485 err << "\""<<e.what()<<"\""<<std::endl;
486 err << "See debug.txt."<<std::endl;
487 err << "World probably saved by a newer version of Minetest."<<std::endl;
488 m_server->setAsyncFatalError(err.str());
490 catch (SerializationError &e) {
491 std::ostringstream err;
492 err << "Invalid data in MapBlock "<<PP(last_tried_pos)<<std::endl;
493 err << "----"<<std::endl;
494 err << "\""<<e.what()<<"\""<<std::endl;
495 err << "See debug.txt."<<std::endl;
496 err << "You can ignore this using [ignore_world_load_errors = true]."<<std::endl;
497 m_server->setAsyncFatalError(err.str());
500 END_DEBUG_EXCEPTION_HANDLER(errorstream)
501 log_deregister_thread();
507 void *EmergeThread::Thread() {
509 log_register_thread("EmergeThread");
510 DSTACK(__FUNCTION_NAME);
511 BEGIN_DEBUG_EXCEPTION_HANDLER
513 bool enable_mapgen_debug_info = g_settings->getBool("enable_mapgen_debug_info");
515 v3s16 last_tried_pos(-32768,-32768,-32768); // For error output
516 ServerMap &map = ((ServerMap&)m_server->m_env->getMap());
517 EmergeManager *emerge = m_server->m_emerge;
518 Mapgen *mapgen = emerge->getMapgen();
522 QueuedBlockEmerge *qptr = m_server->m_emerge_queue.pop();
525 SharedPtr<QueuedBlockEmerge> q(qptr);
533 Do not generate over-limit
535 if (blockpos_over_limit(p))
538 //infostream<<"EmergeThread::Thread(): running"<<std::endl;
540 //TimeTaker timer("block emerge");
543 Try to emerge it from somewhere.
545 If it is only wanted as optional, only loading from disk
550 Check if any peer wants it as non-optional. In that case it
553 Also decrement the emerge queue count in clients.
556 bool only_from_disk = true;
558 core::map<u16, u8>::Iterator i;
559 for (i=q->s.getIterator(); !i.atEnd(); i++) {
560 u8 flags = i.getNode()->getValue();
561 if (!(flags & BLOCK_EMERGE_FLAG_FROMDISK)) {
562 only_from_disk = false;
568 if (enable_mapgen_debug_info)
569 infostream<<"EmergeThread: p="
570 <<"("<<p.X<<","<<p.Y<<","<<p.Z<<") "
571 <<"only_from_disk="<<only_from_disk<<std::endl;
573 MapBlock *block = NULL;
574 bool got_block = true;
575 core::map<v3s16, MapBlock*> modified_blocks;
578 Try to fetch block from memory or disk.
579 If not found and asked to generate, initialize generator.
582 bool started_generate = false;
585 JMutexAutoLock envlock(m_server->m_env_mutex);
587 // Load sector if it isn't loaded
588 if(map.getSectorNoGenerateNoEx(p2d) == NULL)
589 map.loadSectorMeta(p2d);
591 // Attempt to load block
592 block = map.getBlockNoCreateNoEx(p);
593 if(!block || block->isDummy() || !block->isGenerated()) {
594 if(enable_mapgen_debug_info)
595 infostream<<"EmergeThread: not in memory, "
596 <<"attempting to load from disk"<<std::endl;
598 block = map.loadBlock(p);
601 // If could not load and allowed to generate, start generation
602 // inside this same envlock
603 if(only_from_disk == false &&
604 (block == NULL || block->isGenerated() == false)){
605 if(enable_mapgen_debug_info)
606 infostream<<"EmergeThread: generating"<<std::endl;
607 started_generate = true;
609 map.initBlockMake(&data, p);
614 If generator was initialized, generate now when envlock is free.
616 if(started_generate) {
618 ScopeProfiler sp(g_profiler, "EmergeThread: mapgen::make_block",
620 TimeTaker t("mapgen::make_block()");
622 mapgen->makeChunk(&data);
624 if (enable_mapgen_debug_info == false)
625 t.stop(true); // Hide output
629 // Lock environment again to access the map
630 JMutexAutoLock envlock(m_server->m_env_mutex);
632 ScopeProfiler sp(g_profiler, "EmergeThread: after "
633 "mapgen::make_block (envlock)", SPT_AVG);
635 // Blit data back on map, update lighting, add mobs and
636 // whatever this does
637 map.finishBlockMake(&data, modified_blocks);
640 block = map.getBlockNoCreateNoEx(p);
642 // If block doesn't exist, don't try doing anything with it
643 // This happens if the block is not in generation boundaries
648 Do some post-generate stuff
650 v3s16 minp = data.blockpos_min * MAP_BLOCKSIZE;
651 v3s16 maxp = data.blockpos_max * MAP_BLOCKSIZE +
652 v3s16(1,1,1) * (MAP_BLOCKSIZE - 1);
655 Ignore map edit events, they will not need to be
656 sent to anybody because the block hasn't been sent
659 MapEditEventAreaIgnorer ign(
660 &m_server->m_ignore_map_edit_events_area,
661 VoxelArea(minp, maxp));
663 TimeTaker timer("on_generated");
664 scriptapi_environment_on_generated(m_server->m_lua,
665 minp, maxp, emerge->getBlockSeed(minp));
666 //int t = timer.stop(true);
667 //dstream<<"on_generated took "<<t<<"ms"<<std::endl;
670 if (enable_mapgen_debug_info)
671 infostream << "EmergeThread: ended up with: "
672 << analyze_block(block) << std::endl;
674 // Activate objects and stuff
675 m_server->m_env->activateBlock(block, 0);
683 Set sent status of modified blocks on clients
686 // NOTE: Server's clients are also behind the connection mutex
687 JMutexAutoLock lock(m_server->m_con_mutex);
690 Add the originally fetched block to the modified list
693 modified_blocks.insert(p, block);
696 Set the modified blocks unsent for all the clients
698 for(core::map<u16, RemoteClient*>::Iterator
699 i = m_server->m_clients.getIterator();
700 i.atEnd() == false; i++) {
701 RemoteClient *client = i.getNode()->getValue();
702 if(modified_blocks.size() > 0) {
703 // Remove block from sent history
704 client->SetBlocksNotSent(modified_blocks);
711 catch (VersionMismatchException &e) {
712 std::ostringstream err;
713 err << "World data version mismatch in MapBlock "<<PP(last_tried_pos)<<std::endl;
714 err << "----"<<std::endl;
715 err << "\""<<e.what()<<"\""<<std::endl;
716 err << "See debug.txt."<<std::endl;
717 err << "World probably saved by a newer version of Minetest."<<std::endl;
718 m_server->setAsyncFatalError(err.str());
720 catch (SerializationError &e) {
721 std::ostringstream err;
722 err << "Invalid data in MapBlock "<<PP(last_tried_pos)<<std::endl;
723 err << "----"<<std::endl;
724 err << "\""<<e.what()<<"\""<<std::endl;
725 err << "See debug.txt."<<std::endl;
726 err << "You can ignore this using [ignore_world_load_errors = true]."<<std::endl;
727 m_server->setAsyncFatalError(err.str());
729 printf("emergethread iterated %d times\n", niters);
730 END_DEBUG_EXCEPTION_HANDLER(errorstream)
731 log_deregister_thread();