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);
52 qlimit_total = g_settings->getU16("emergequeue_limit_total");
53 qlimit_diskonly = g_settings->getU16("emergequeue_limit_diskonly");
54 qlimit_generate = g_settings->getU16("emergequeue_limit_generate");
57 emergethread = new EmergeThread((Server *)gamedef);
61 EmergeManager::~EmergeManager() {
62 emergethread->setRun(false);
63 emergethread->qevent.signal();
73 void EmergeManager::initMapgens(MapgenParams *mgparams) {
77 this->params = mgparams;
78 this->mapgen = getMapgen(); //only one mapgen for now!
82 Mapgen *EmergeManager::getMapgen() {
84 mapgen = createMapgen(params->mg_name, 0, params, this);
86 infostream << "EmergeManager: falling back to mapgen v6" << std::endl;
88 params = createMapgenParams("v6");
89 mapgen = createMapgen("v6", 0, params, this);
96 bool EmergeManager::enqueueBlockEmerge(u16 peer_id, v3s16 p, bool allow_generate) {
97 std::map<v3s16, BlockEmergeData *>::const_iterator iter;
98 BlockEmergeData *bedata;
103 flags |= BLOCK_EMERGE_ALLOWGEN;
106 JMutexAutoLock queuelock(queuemutex);
108 count = blocks_enqueued.size();
109 if (count >= qlimit_total)
112 count = peer_queue_count[peer_id];
113 u16 qlimit_peer = allow_generate ? qlimit_generate : qlimit_diskonly;
114 if (count >= qlimit_peer)
117 iter = blocks_enqueued.find(p);
118 if (iter != blocks_enqueued.end()) {
119 bedata = iter->second;
120 bedata->flags |= flags;
124 bedata = new BlockEmergeData;
125 bedata->flags = flags;
126 bedata->peer_requested = peer_id;
127 blocks_enqueued.insert(std::make_pair(p, bedata));
129 peer_queue_count[peer_id] = count + 1;
131 emergethread->blockqueue.push(p);
133 emergethread->qevent.signal();
139 bool EmergeManager::popBlockEmerge(v3s16 *pos, u8 *flags) {
140 std::map<v3s16, BlockEmergeData *>::iterator iter;
141 JMutexAutoLock queuelock(queuemutex);
143 if (emergethread->blockqueue.empty())
145 v3s16 p = emergethread->blockqueue.front();
146 emergethread->blockqueue.pop();
150 iter = blocks_enqueued.find(p);
151 if (iter == blocks_enqueued.end())
152 return false; //uh oh, queue and map out of sync!!
154 BlockEmergeData *bedata = iter->second;
155 *flags = bedata->flags;
157 peer_queue_count[bedata->peer_requested]--;
160 blocks_enqueued.erase(iter);
166 int EmergeManager::getGroundLevelAtPoint(v2s16 p) {
169 return mapgen->getGroundLevelAtPoint(p);
173 bool EmergeManager::isBlockUnderground(v3s16 blockpos) {
175 v2s16 p = v2s16((blockpos.X * MAP_BLOCKSIZE) + MAP_BLOCKSIZE / 2,
176 (blockpos.Y * MAP_BLOCKSIZE) + MAP_BLOCKSIZE / 2);
177 int ground_level = getGroundLevelAtPoint(p);
178 return blockpos.Y * (MAP_BLOCKSIZE + 1) <= min(water_level, ground_level);
181 //yuck, but then again, should i bother being accurate?
182 //the height of the nodes in a single block is quite variable
183 return blockpos.Y * (MAP_BLOCKSIZE + 1) <= params->water_level;
187 u32 EmergeManager::getBlockSeed(v3s16 p) {
188 return (u32)(params->seed & 0xFFFFFFFF) +
195 Mapgen *EmergeManager::createMapgen(std::string mgname, int mgid,
196 MapgenParams *mgparams, EmergeManager *emerge) {
197 std::map<std::string, MapgenFactory *>::const_iterator iter = mglist.find(mgname);
198 if (iter == mglist.end()) {
199 errorstream << "EmergeManager; mapgen " << mgname <<
200 " not registered" << std::endl;
204 MapgenFactory *mgfactory = iter->second;
205 return mgfactory->createMapgen(mgid, mgparams, emerge);
209 MapgenParams *EmergeManager::createMapgenParams(std::string mgname) {
210 std::map<std::string, MapgenFactory *>::const_iterator iter = mglist.find(mgname);
211 if (iter == mglist.end()) {
212 errorstream << "EmergeManager: mapgen " << mgname <<
213 " not registered" << std::endl;
217 MapgenFactory *mgfactory = iter->second;
218 return mgfactory->createMapgenParams();
222 MapgenParams *EmergeManager::getParamsFromSettings(Settings *settings) {
223 std::string mg_name = settings->get("mg_name");
224 MapgenParams *mgparams = createMapgenParams(mg_name);
226 mgparams->mg_name = mg_name;
227 mgparams->seed = settings->getU64(settings == g_settings ? "fixed_map_seed" : "seed");
228 mgparams->water_level = settings->getS16("water_level");
229 mgparams->chunksize = settings->getS16("chunksize");
230 mgparams->flags = settings->getS32("mg_flags");
232 if (!mgparams->readParams(settings)) {
240 void EmergeManager::setParamsToSettings(Settings *settings) {
241 settings->set("mg_name", params->mg_name);
242 settings->setU64("seed", params->seed);
243 settings->setS16("water_level", params->water_level);
244 settings->setS16("chunksize", params->chunksize);
245 settings->setFlagStr("mg_flags", params->flags, flagdesc_mapgen);
247 params->writeParams(settings);
251 bool EmergeManager::registerMapgen(std::string mgname, MapgenFactory *mgfactory) {
252 mglist.insert(std::make_pair(mgname, mgfactory));
253 infostream << "EmergeManager: registered mapgen " << mgname << std::endl;
258 class MapEditEventIgnorer
261 MapEditEventIgnorer(bool *flag):
270 ~MapEditEventIgnorer()
283 class MapEditEventAreaIgnorer
286 MapEditEventAreaIgnorer(VoxelArea *ignorevariable, const VoxelArea &a):
287 m_ignorevariable(ignorevariable)
289 if(m_ignorevariable->getVolume() == 0)
290 *m_ignorevariable = a;
292 m_ignorevariable = NULL;
295 ~MapEditEventAreaIgnorer()
299 assert(m_ignorevariable->getVolume() != 0);
300 *m_ignorevariable = VoxelArea();
305 VoxelArea *m_ignorevariable;
311 #define EMERGE_DBG_OUT(x) \
312 { if (enable_mapgen_debug_info) \
313 infostream << "EmergeThread: " x << std::endl; }
315 bool EmergeThread::getBlockOrStartGen(v3s16 p, MapBlock **b,
316 BlockMakeData *data, bool allow_gen) {
318 //envlock: usually takes <=1ms, sometimes 90ms or ~400ms to acquire
319 JMutexAutoLock envlock(m_server->m_env_mutex);
321 // Load sector if it isn't loaded
322 if (map->getSectorNoGenerateNoEx(p2d) == NULL)
323 map->loadSectorMeta(p2d);
325 // Attempt to load block
326 MapBlock *block = map->getBlockNoCreateNoEx(p);
327 if (!block || block->isDummy() || !block->isGenerated()) {
328 EMERGE_DBG_OUT("not in memory, attempting to load from disk");
329 block = map->loadBlock(p);
332 // If could not load and allowed to generate,
333 // start generation inside this same envlock
334 if (allow_gen && (block == NULL || !block->isGenerated())) {
335 EMERGE_DBG_OUT("generating");
336 map->initBlockMake(data, p);
345 void *EmergeThread::Thread() {
347 log_register_thread("EmergeThread");
348 DSTACK(__FUNCTION_NAME);
349 BEGIN_DEBUG_EXCEPTION_HANDLER
351 v3s16 last_tried_pos(-32768,-32768,-32768); // For error output
355 map = (ServerMap *)&(m_server->m_env->getMap());
356 emerge = m_server->m_emerge;
357 mapgen = emerge->getMapgen();
361 while (!emerge->popBlockEmerge(&p, &flags)) {
364 goto exit_emerge_loop;
368 if (blockpos_over_limit(p))
371 bool allow_generate = flags & BLOCK_EMERGE_ALLOWGEN;
372 EMERGE_DBG_OUT("p=" PP(p) " allow_generate=" << allow_generate);
375 Try to fetch block from memory or disk.
376 If not found and asked to generate, initialize generator.
379 MapBlock *block = NULL;
380 core::map<v3s16, MapBlock *> modified_blocks;
382 if (getBlockOrStartGen(p, &block, &data, allow_generate)) {
384 ScopeProfiler sp(g_profiler, "EmergeThread: Mapgen::makeChunk", SPT_AVG);
385 TimeTaker t("mapgen::make_block()");
387 mapgen->makeChunk(&data);
389 if (enable_mapgen_debug_info == false)
390 t.stop(true); // Hide output
394 //envlock: usually 0ms, but can take either 30 or 400ms to acquire
395 JMutexAutoLock envlock(m_server->m_env_mutex);
396 ScopeProfiler sp(g_profiler, "EmergeThread: after "
397 "Mapgen::makeChunk (envlock)", SPT_AVG);
399 map->finishBlockMake(&data, modified_blocks);
401 block = map->getBlockNoCreateNoEx(p);
404 Do some post-generate stuff
406 v3s16 minp = data.blockpos_min * MAP_BLOCKSIZE;
407 v3s16 maxp = data.blockpos_max * MAP_BLOCKSIZE +
408 v3s16(1,1,1) * (MAP_BLOCKSIZE - 1);
410 // Ignore map edit events, they will not need to be sent
411 // to anybody because the block hasn't been sent to anybody
412 MapEditEventAreaIgnorer
413 ign(&m_server->m_ignore_map_edit_events_area,
414 VoxelArea(minp, maxp));
415 { // takes about 90ms with -O1 on an e3-1230v2
416 scriptapi_environment_on_generated(m_server->m_lua,
417 minp, maxp, emerge->getBlockSeed(minp));
420 EMERGE_DBG_OUT("ended up with: " << analyze_block(block));
422 m_server->m_env->activateBlock(block, 0);
428 Set sent status of modified blocks on clients
431 // NOTE: Server's clients are also behind the connection mutex
432 //conlock: consistently takes 30-40ms to acquire
433 JMutexAutoLock lock(m_server->m_con_mutex);
434 // Add the originally fetched block to the modified list
436 modified_blocks.insert(p, block);
438 // Set the modified blocks unsent for all the clients
439 for (core::map<u16, RemoteClient*>::Iterator
440 i = m_server->m_clients.getIterator();
441 i.atEnd() == false; i++) {
442 RemoteClient *client = i.getNode()->getValue();
443 if (modified_blocks.size() > 0) {
444 // Remove block from sent history
445 client->SetBlocksNotSent(modified_blocks);
449 catch (VersionMismatchException &e) {
450 std::ostringstream err;
451 err << "World data version mismatch in MapBlock "<<PP(last_tried_pos)<<std::endl;
452 err << "----"<<std::endl;
453 err << "\""<<e.what()<<"\""<<std::endl;
454 err << "See debug.txt."<<std::endl;
455 err << "World probably saved by a newer version of Minetest."<<std::endl;
456 m_server->setAsyncFatalError(err.str());
458 catch (SerializationError &e) {
459 std::ostringstream err;
460 err << "Invalid data in MapBlock "<<PP(last_tried_pos)<<std::endl;
461 err << "----"<<std::endl;
462 err << "\""<<e.what()<<"\""<<std::endl;
463 err << "See debug.txt."<<std::endl;
464 err << "You can ignore this using [ignore_world_load_errors = true]."<<std::endl;
465 m_server->setAsyncFatalError(err.str());
468 END_DEBUG_EXCEPTION_HANDLER(errorstream)
470 log_deregister_thread();
476 void *EmergeThread::Thread() {
478 log_register_thread("EmergeThread");
479 DSTACK(__FUNCTION_NAME);
480 BEGIN_DEBUG_EXCEPTION_HANDLER
482 bool enable_mapgen_debug_info = g_settings->getBool("enable_mapgen_debug_info");
484 v3s16 last_tried_pos(-32768,-32768,-32768); // For error output
485 ServerMap &map = ((ServerMap&)m_server->m_env->getMap());
486 EmergeManager *emerge = m_server->m_emerge;
487 Mapgen *mapgen = emerge->getMapgen();
491 QueuedBlockEmerge *qptr = m_server->m_emerge_queue.pop();
494 SharedPtr<QueuedBlockEmerge> q(qptr);
502 Do not generate over-limit
504 if (blockpos_over_limit(p))
507 //infostream<<"EmergeThread::Thread(): running"<<std::endl;
509 //TimeTaker timer("block emerge");
512 Try to emerge it from somewhere.
514 If it is only wanted as optional, only loading from disk
519 Check if any peer wants it as non-optional. In that case it
522 Also decrement the emerge queue count in clients.
525 bool only_from_disk = true;
527 core::map<u16, u8>::Iterator i;
528 for (i=q->s.getIterator(); !i.atEnd(); i++) {
529 u8 flags = i.getNode()->getValue();
530 if (!(flags & BLOCK_EMERGE_FLAG_FROMDISK)) {
531 only_from_disk = false;
537 if (enable_mapgen_debug_info)
538 infostream<<"EmergeThread: p="
539 <<"("<<p.X<<","<<p.Y<<","<<p.Z<<") "
540 <<"only_from_disk="<<only_from_disk<<std::endl;
542 MapBlock *block = NULL;
543 bool got_block = true;
544 core::map<v3s16, MapBlock*> modified_blocks;
547 Try to fetch block from memory or disk.
548 If not found and asked to generate, initialize generator.
551 bool started_generate = false;
554 JMutexAutoLock envlock(m_server->m_env_mutex);
556 // Load sector if it isn't loaded
557 if(map.getSectorNoGenerateNoEx(p2d) == NULL)
558 map.loadSectorMeta(p2d);
560 // Attempt to load block
561 block = map.getBlockNoCreateNoEx(p);
562 if(!block || block->isDummy() || !block->isGenerated()) {
563 if(enable_mapgen_debug_info)
564 infostream<<"EmergeThread: not in memory, "
565 <<"attempting to load from disk"<<std::endl;
567 block = map.loadBlock(p);
570 // If could not load and allowed to generate, start generation
571 // inside this same envlock
572 if(only_from_disk == false &&
573 (block == NULL || block->isGenerated() == false)){
574 if(enable_mapgen_debug_info)
575 infostream<<"EmergeThread: generating"<<std::endl;
576 started_generate = true;
578 map.initBlockMake(&data, p);
583 If generator was initialized, generate now when envlock is free.
585 if(started_generate) {
587 ScopeProfiler sp(g_profiler, "EmergeThread: mapgen::make_block",
589 TimeTaker t("mapgen::make_block()");
591 mapgen->makeChunk(&data);
593 if (enable_mapgen_debug_info == false)
594 t.stop(true); // Hide output
598 // Lock environment again to access the map
599 JMutexAutoLock envlock(m_server->m_env_mutex);
601 ScopeProfiler sp(g_profiler, "EmergeThread: after "
602 "mapgen::make_block (envlock)", SPT_AVG);
604 // Blit data back on map, update lighting, add mobs and
605 // whatever this does
606 map.finishBlockMake(&data, modified_blocks);
609 block = map.getBlockNoCreateNoEx(p);
611 // If block doesn't exist, don't try doing anything with it
612 // This happens if the block is not in generation boundaries
617 Do some post-generate stuff
619 v3s16 minp = data.blockpos_min * MAP_BLOCKSIZE;
620 v3s16 maxp = data.blockpos_max * MAP_BLOCKSIZE +
621 v3s16(1,1,1) * (MAP_BLOCKSIZE - 1);
624 Ignore map edit events, they will not need to be
625 sent to anybody because the block hasn't been sent
628 MapEditEventAreaIgnorer ign(
629 &m_server->m_ignore_map_edit_events_area,
630 VoxelArea(minp, maxp));
632 TimeTaker timer("on_generated");
633 scriptapi_environment_on_generated(m_server->m_lua,
634 minp, maxp, emerge->getBlockSeed(minp));
635 //int t = timer.stop(true);
636 //dstream<<"on_generated took "<<t<<"ms"<<std::endl;
639 if (enable_mapgen_debug_info)
640 infostream << "EmergeThread: ended up with: "
641 << analyze_block(block) << std::endl;
643 // Activate objects and stuff
644 m_server->m_env->activateBlock(block, 0);
652 Set sent status of modified blocks on clients
655 // NOTE: Server's clients are also behind the connection mutex
656 JMutexAutoLock lock(m_server->m_con_mutex);
659 Add the originally fetched block to the modified list
662 modified_blocks.insert(p, block);
665 Set the modified blocks unsent for all the clients
667 for(core::map<u16, RemoteClient*>::Iterator
668 i = m_server->m_clients.getIterator();
669 i.atEnd() == false; i++) {
670 RemoteClient *client = i.getNode()->getValue();
671 if(modified_blocks.size() > 0) {
672 // Remove block from sent history
673 client->SetBlocksNotSent(modified_blocks);
680 catch (VersionMismatchException &e) {
681 std::ostringstream err;
682 err << "World data version mismatch in MapBlock "<<PP(last_tried_pos)<<std::endl;
683 err << "----"<<std::endl;
684 err << "\""<<e.what()<<"\""<<std::endl;
685 err << "See debug.txt."<<std::endl;
686 err << "World probably saved by a newer version of Minetest."<<std::endl;
687 m_server->setAsyncFatalError(err.str());
689 catch (SerializationError &e) {
690 std::ostringstream err;
691 err << "Invalid data in MapBlock "<<PP(last_tried_pos)<<std::endl;
692 err << "----"<<std::endl;
693 err << "\""<<e.what()<<"\""<<std::endl;
694 err << "See debug.txt."<<std::endl;
695 err << "You can ignore this using [ignore_world_load_errors = true]."<<std::endl;
696 m_server->setAsyncFatalError(err.str());
698 printf("emergethread iterated %d times\n", niters);
699 END_DEBUG_EXCEPTION_HANDLER(errorstream)
700 log_deregister_thread();