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);
53 emergethread = new EmergeThread((Server *)gamedef);
57 EmergeManager::~EmergeManager() {
58 emergethread->setRun(false);
59 emergethread->qevent.signal();
69 void EmergeManager::initMapgens(MapgenParams *mgparams) {
73 this->params = mgparams;
74 this->mapgen = getMapgen(); //only one mapgen for now!
78 Mapgen *EmergeManager::getMapgen() {
80 mapgen = createMapgen(params->mg_name, 0, params, this);
82 infostream << "EmergeManager: falling back to mapgen v6" << std::endl;
84 params = createMapgenParams("v6");
85 mapgen = createMapgen("v6", 0, params, this);
92 bool EmergeManager::enqueueBlockEmerge(u16 peer_id, v3s16 p, bool allow_generate) {
93 std::map<v3s16, BlockEmergeData *>::const_iterator iter;
94 BlockEmergeData *bedata;
99 flags |= BLOCK_EMERGE_ALLOWGEN;
102 // add logic to select which emergethread to add it to
103 // - one with the least queue contents?
104 // - if a queue is too full, move onto another one
105 // - use the peer id sometime
108 JMutexAutoLock queuelock(queuemutex);
110 count = blocks_enqueued.size();
111 u16 queuelimit_total = 256;
112 if (count >= queuelimit_total)
115 count = peer_queue_count[peer_id];
116 u16 queuelimit_peer = allow_generate ? 1 : 5;
117 if (count >= queuelimit_peer)
120 iter = blocks_enqueued.find(p);
121 if (iter != blocks_enqueued.end()) {
122 bedata = iter->second;
123 bedata->flags |= flags;
127 bedata = new BlockEmergeData;
128 bedata->flags = flags;
129 bedata->peer_requested = peer_id;
130 blocks_enqueued.insert(std::make_pair(p, bedata));
132 peer_queue_count[peer_id] = count + 1;
134 emergethread->blockqueue.push(p);
136 emergethread->qevent.signal();
142 bool EmergeManager::popBlockEmerge(v3s16 *pos, u8 *flags) {
143 std::map<v3s16, BlockEmergeData *>::iterator iter;
144 JMutexAutoLock queuelock(queuemutex);
146 if (emergethread->blockqueue.empty())
148 v3s16 p = emergethread->blockqueue.front();
149 emergethread->blockqueue.pop();
153 iter = blocks_enqueued.find(p);
154 if (iter == blocks_enqueued.end())
155 return false; //uh oh, queue and map out of sync!!
157 BlockEmergeData *bedata = iter->second;
158 *flags = bedata->flags;
160 peer_queue_count[bedata->peer_requested]--;
163 blocks_enqueued.erase(iter);
169 int EmergeManager::getGroundLevelAtPoint(v2s16 p) {
172 return mapgen->getGroundLevelAtPoint(p);
176 bool EmergeManager::isBlockUnderground(v3s16 blockpos) {
178 v2s16 p = v2s16((blockpos.X * MAP_BLOCKSIZE) + MAP_BLOCKSIZE / 2,
179 (blockpos.Y * MAP_BLOCKSIZE) + MAP_BLOCKSIZE / 2);
180 int ground_level = getGroundLevelAtPoint(p);
181 return blockpos.Y * (MAP_BLOCKSIZE + 1) <= min(water_level, ground_level);
184 //yuck, but then again, should i bother being accurate?
185 //the height of the nodes in a single block is quite variable
186 return blockpos.Y * (MAP_BLOCKSIZE + 1) <= params->water_level;
190 u32 EmergeManager::getBlockSeed(v3s16 p) {
191 return (u32)(params->seed & 0xFFFFFFFF) +
198 Mapgen *EmergeManager::createMapgen(std::string mgname, int mgid,
199 MapgenParams *mgparams, EmergeManager *emerge) {
200 std::map<std::string, MapgenFactory *>::const_iterator iter = mglist.find(mgname);
201 if (iter == mglist.end()) {
202 errorstream << "EmergeManager; mapgen " << mgname <<
203 " not registered" << std::endl;
207 MapgenFactory *mgfactory = iter->second;
208 return mgfactory->createMapgen(mgid, mgparams, emerge);
212 MapgenParams *EmergeManager::createMapgenParams(std::string mgname) {
213 std::map<std::string, MapgenFactory *>::const_iterator iter = mglist.find(mgname);
214 if (iter == mglist.end()) {
215 errorstream << "EmergeManager: mapgen " << mgname <<
216 " not registered" << std::endl;
220 MapgenFactory *mgfactory = iter->second;
221 return mgfactory->createMapgenParams();
225 MapgenParams *EmergeManager::getParamsFromSettings(Settings *settings) {
226 std::string mg_name = settings->get("mg_name");
227 MapgenParams *mgparams = createMapgenParams(mg_name);
229 mgparams->mg_name = mg_name;
230 mgparams->seed = settings->getU64(settings == g_settings ? "fixed_map_seed" : "seed");
231 mgparams->water_level = settings->getS16("water_level");
232 mgparams->chunksize = settings->getS16("chunksize");
233 mgparams->flags = settings->getS32("mg_flags");
235 if (!mgparams->readParams(settings)) {
243 void EmergeManager::setParamsToSettings(Settings *settings) {
244 settings->set("mg_name", params->mg_name);
245 settings->setU64("seed", params->seed);
246 settings->setS16("water_level", params->water_level);
247 settings->setS16("chunksize", params->chunksize);
248 settings->setFlagStr("mg_flags", params->flags, flagdesc_mapgen);
250 params->writeParams(settings);
254 bool EmergeManager::registerMapgen(std::string mgname, MapgenFactory *mgfactory) {
255 mglist.insert(std::make_pair(mgname, mgfactory));
256 infostream << "EmergeManager: registered mapgen " << mgname << std::endl;
261 class MapEditEventIgnorer
264 MapEditEventIgnorer(bool *flag):
273 ~MapEditEventIgnorer()
286 class MapEditEventAreaIgnorer
289 MapEditEventAreaIgnorer(VoxelArea *ignorevariable, const VoxelArea &a):
290 m_ignorevariable(ignorevariable)
292 if(m_ignorevariable->getVolume() == 0)
293 *m_ignorevariable = a;
295 m_ignorevariable = NULL;
298 ~MapEditEventAreaIgnorer()
302 assert(m_ignorevariable->getVolume() != 0);
303 *m_ignorevariable = VoxelArea();
308 VoxelArea *m_ignorevariable;
314 #define EMERGE_DBG_OUT(x) \
315 { if (enable_mapgen_debug_info) \
316 infostream << "EmergeThread: " x << std::endl; }
318 bool EmergeThread::getBlockOrStartGen(v3s16 p, MapBlock **b,
319 BlockMakeData *data, bool allow_gen) {
321 //envlock: usually takes <=1ms, sometimes 90ms or ~400ms to acquire
322 JMutexAutoLock envlock(m_server->m_env_mutex);
324 // Load sector if it isn't loaded
325 if (map->getSectorNoGenerateNoEx(p2d) == NULL)
326 map->loadSectorMeta(p2d);
328 // Attempt to load block
329 MapBlock *block = map->getBlockNoCreateNoEx(p);
330 if (!block || block->isDummy() || !block->isGenerated()) {
331 EMERGE_DBG_OUT("not in memory, attempting to load from disk");
332 block = map->loadBlock(p);
335 // If could not load and allowed to generate,
336 // start generation inside this same envlock
337 if (allow_gen && (block == NULL || !block->isGenerated())) {
338 EMERGE_DBG_OUT("generating");
339 map->initBlockMake(data, p);
348 void *EmergeThread::Thread() {
350 log_register_thread("EmergeThread");
351 DSTACK(__FUNCTION_NAME);
352 BEGIN_DEBUG_EXCEPTION_HANDLER
354 v3s16 last_tried_pos(-32768,-32768,-32768); // For error output
358 map = (ServerMap *)&(m_server->m_env->getMap());
359 emerge = m_server->m_emerge;
360 mapgen = emerge->getMapgen();
364 while (!emerge->popBlockEmerge(&p, &flags)) {
367 goto exit_emerge_loop;
371 if (blockpos_over_limit(p))
374 bool allow_generate = flags & BLOCK_EMERGE_ALLOWGEN;
375 EMERGE_DBG_OUT("p=" PP(p) " allow_generate=" << allow_generate);
378 Try to fetch block from memory or disk.
379 If not found and asked to generate, initialize generator.
382 MapBlock *block = NULL;
383 core::map<v3s16, MapBlock *> modified_blocks;
385 if (getBlockOrStartGen(p, &block, &data, allow_generate)) {
387 ScopeProfiler sp(g_profiler, "EmergeThread: Mapgen::makeChunk", SPT_AVG);
388 TimeTaker t("mapgen::make_block()");
390 mapgen->makeChunk(&data);
392 if (enable_mapgen_debug_info == false)
393 t.stop(true); // Hide output
397 //envlock: usually 0ms, but can take either 30 or 400ms to acquire
398 JMutexAutoLock envlock(m_server->m_env_mutex);
399 ScopeProfiler sp(g_profiler, "EmergeThread: after "
400 "Mapgen::makeChunk (envlock)", SPT_AVG);
402 map->finishBlockMake(&data, modified_blocks);
404 block = map->getBlockNoCreateNoEx(p);
407 Do some post-generate stuff
409 v3s16 minp = data.blockpos_min * MAP_BLOCKSIZE;
410 v3s16 maxp = data.blockpos_max * MAP_BLOCKSIZE +
411 v3s16(1,1,1) * (MAP_BLOCKSIZE - 1);
413 // Ignore map edit events, they will not need to be sent
414 // to anybody because the block hasn't been sent to anybody
415 MapEditEventAreaIgnorer
416 ign(&m_server->m_ignore_map_edit_events_area,
417 VoxelArea(minp, maxp));
418 { // takes about 90ms with -O1 on an e3-1230v2
419 scriptapi_environment_on_generated(m_server->m_lua,
420 minp, maxp, emerge->getBlockSeed(minp));
423 EMERGE_DBG_OUT("ended up with: " << analyze_block(block));
425 m_server->m_env->activateBlock(block, 0);
431 Set sent status of modified blocks on clients
434 // NOTE: Server's clients are also behind the connection mutex
435 //conlock: consistently takes 30-40ms to acquire
436 JMutexAutoLock lock(m_server->m_con_mutex);
437 // Add the originally fetched block to the modified list
439 modified_blocks.insert(p, block);
441 // Set the modified blocks unsent for all the clients
442 for (core::map<u16, RemoteClient*>::Iterator
443 i = m_server->m_clients.getIterator();
444 i.atEnd() == false; i++) {
445 RemoteClient *client = i.getNode()->getValue();
446 if (modified_blocks.size() > 0) {
447 // Remove block from sent history
448 client->SetBlocksNotSent(modified_blocks);
452 catch (VersionMismatchException &e) {
453 std::ostringstream err;
454 err << "World data version mismatch in MapBlock "<<PP(last_tried_pos)<<std::endl;
455 err << "----"<<std::endl;
456 err << "\""<<e.what()<<"\""<<std::endl;
457 err << "See debug.txt."<<std::endl;
458 err << "World probably saved by a newer version of Minetest."<<std::endl;
459 m_server->setAsyncFatalError(err.str());
461 catch (SerializationError &e) {
462 std::ostringstream err;
463 err << "Invalid data in MapBlock "<<PP(last_tried_pos)<<std::endl;
464 err << "----"<<std::endl;
465 err << "\""<<e.what()<<"\""<<std::endl;
466 err << "See debug.txt."<<std::endl;
467 err << "You can ignore this using [ignore_world_load_errors = true]."<<std::endl;
468 m_server->setAsyncFatalError(err.str());
471 END_DEBUG_EXCEPTION_HANDLER(errorstream)
473 log_deregister_thread();
479 void *EmergeThread::Thread() {
481 log_register_thread("EmergeThread");
482 DSTACK(__FUNCTION_NAME);
483 BEGIN_DEBUG_EXCEPTION_HANDLER
485 bool enable_mapgen_debug_info = g_settings->getBool("enable_mapgen_debug_info");
487 v3s16 last_tried_pos(-32768,-32768,-32768); // For error output
488 ServerMap &map = ((ServerMap&)m_server->m_env->getMap());
489 EmergeManager *emerge = m_server->m_emerge;
490 Mapgen *mapgen = emerge->getMapgen();
494 QueuedBlockEmerge *qptr = m_server->m_emerge_queue.pop();
497 SharedPtr<QueuedBlockEmerge> q(qptr);
505 Do not generate over-limit
507 if (blockpos_over_limit(p))
510 //infostream<<"EmergeThread::Thread(): running"<<std::endl;
512 //TimeTaker timer("block emerge");
515 Try to emerge it from somewhere.
517 If it is only wanted as optional, only loading from disk
522 Check if any peer wants it as non-optional. In that case it
525 Also decrement the emerge queue count in clients.
528 bool only_from_disk = true;
530 core::map<u16, u8>::Iterator i;
531 for (i=q->s.getIterator(); !i.atEnd(); i++) {
532 u8 flags = i.getNode()->getValue();
533 if (!(flags & BLOCK_EMERGE_FLAG_FROMDISK)) {
534 only_from_disk = false;
540 if (enable_mapgen_debug_info)
541 infostream<<"EmergeThread: p="
542 <<"("<<p.X<<","<<p.Y<<","<<p.Z<<") "
543 <<"only_from_disk="<<only_from_disk<<std::endl;
545 MapBlock *block = NULL;
546 bool got_block = true;
547 core::map<v3s16, MapBlock*> modified_blocks;
550 Try to fetch block from memory or disk.
551 If not found and asked to generate, initialize generator.
554 bool started_generate = false;
557 JMutexAutoLock envlock(m_server->m_env_mutex);
559 // Load sector if it isn't loaded
560 if(map.getSectorNoGenerateNoEx(p2d) == NULL)
561 map.loadSectorMeta(p2d);
563 // Attempt to load block
564 block = map.getBlockNoCreateNoEx(p);
565 if(!block || block->isDummy() || !block->isGenerated()) {
566 if(enable_mapgen_debug_info)
567 infostream<<"EmergeThread: not in memory, "
568 <<"attempting to load from disk"<<std::endl;
570 block = map.loadBlock(p);
573 // If could not load and allowed to generate, start generation
574 // inside this same envlock
575 if(only_from_disk == false &&
576 (block == NULL || block->isGenerated() == false)){
577 if(enable_mapgen_debug_info)
578 infostream<<"EmergeThread: generating"<<std::endl;
579 started_generate = true;
581 map.initBlockMake(&data, p);
586 If generator was initialized, generate now when envlock is free.
588 if(started_generate) {
590 ScopeProfiler sp(g_profiler, "EmergeThread: mapgen::make_block",
592 TimeTaker t("mapgen::make_block()");
594 mapgen->makeChunk(&data);
596 if (enable_mapgen_debug_info == false)
597 t.stop(true); // Hide output
601 // Lock environment again to access the map
602 JMutexAutoLock envlock(m_server->m_env_mutex);
604 ScopeProfiler sp(g_profiler, "EmergeThread: after "
605 "mapgen::make_block (envlock)", SPT_AVG);
607 // Blit data back on map, update lighting, add mobs and
608 // whatever this does
609 map.finishBlockMake(&data, modified_blocks);
612 block = map.getBlockNoCreateNoEx(p);
614 // If block doesn't exist, don't try doing anything with it
615 // This happens if the block is not in generation boundaries
620 Do some post-generate stuff
622 v3s16 minp = data.blockpos_min * MAP_BLOCKSIZE;
623 v3s16 maxp = data.blockpos_max * MAP_BLOCKSIZE +
624 v3s16(1,1,1) * (MAP_BLOCKSIZE - 1);
627 Ignore map edit events, they will not need to be
628 sent to anybody because the block hasn't been sent
631 MapEditEventAreaIgnorer ign(
632 &m_server->m_ignore_map_edit_events_area,
633 VoxelArea(minp, maxp));
635 TimeTaker timer("on_generated");
636 scriptapi_environment_on_generated(m_server->m_lua,
637 minp, maxp, emerge->getBlockSeed(minp));
638 //int t = timer.stop(true);
639 //dstream<<"on_generated took "<<t<<"ms"<<std::endl;
642 if (enable_mapgen_debug_info)
643 infostream << "EmergeThread: ended up with: "
644 << analyze_block(block) << std::endl;
646 // Activate objects and stuff
647 m_server->m_env->activateBlock(block, 0);
655 Set sent status of modified blocks on clients
658 // NOTE: Server's clients are also behind the connection mutex
659 JMutexAutoLock lock(m_server->m_con_mutex);
662 Add the originally fetched block to the modified list
665 modified_blocks.insert(p, block);
668 Set the modified blocks unsent for all the clients
670 for(core::map<u16, RemoteClient*>::Iterator
671 i = m_server->m_clients.getIterator();
672 i.atEnd() == false; i++) {
673 RemoteClient *client = i.getNode()->getValue();
674 if(modified_blocks.size() > 0) {
675 // Remove block from sent history
676 client->SetBlocksNotSent(modified_blocks);
683 catch (VersionMismatchException &e) {
684 std::ostringstream err;
685 err << "World data version mismatch in MapBlock "<<PP(last_tried_pos)<<std::endl;
686 err << "----"<<std::endl;
687 err << "\""<<e.what()<<"\""<<std::endl;
688 err << "See debug.txt."<<std::endl;
689 err << "World probably saved by a newer version of Minetest."<<std::endl;
690 m_server->setAsyncFatalError(err.str());
692 catch (SerializationError &e) {
693 std::ostringstream err;
694 err << "Invalid data in MapBlock "<<PP(last_tried_pos)<<std::endl;
695 err << "----"<<std::endl;
696 err << "\""<<e.what()<<"\""<<std::endl;
697 err << "See debug.txt."<<std::endl;
698 err << "You can ignore this using [ignore_world_load_errors = true]."<<std::endl;
699 m_server->setAsyncFatalError(err.str());
701 printf("emergethread iterated %d times\n", niters);
702 END_DEBUG_EXCEPTION_HANDLER(errorstream)
703 log_deregister_thread();