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);
68 void EmergeManager::initMapgens(MapgenParams *mgparams) {
72 this->params = mgparams;
73 this->mapgen = getMapgen(); //only one mapgen for now!
77 Mapgen *EmergeManager::getMapgen() {
79 mapgen = createMapgen(params->mg_name, 0, params, this);
81 infostream << "EmergeManager: falling back to mapgen v6" << std::endl;
83 params = createMapgenParams("v6");
84 mapgen = createMapgen("v6", 0, params, this);
91 bool EmergeManager::enqueueBlockEmerge(u16 peer_id, v3s16 p, bool allow_generate) {
92 std::map<v3s16, BlockEmergeData *>::const_iterator iter;
93 BlockEmergeData *bedata;
98 flags |= BLOCK_EMERGE_ALLOWGEN;
101 // add logic to select which emergethread to add it to
102 // - one with the least queue contents?
103 // - if a queue is too full, move onto another one
104 // - use the peer id sometime
107 JMutexAutoLock queuelock(queuemutex);
109 count = blocks_enqueued.size();
110 u16 queuelimit_total = 256;
111 if (count >= queuelimit_total)
114 count = peer_queue_count[peer_id];
115 u16 queuelimit_peer = allow_generate ? 1 : 5;
116 if (count >= queuelimit_peer)
119 iter = blocks_enqueued.find(p);
120 if (iter != blocks_enqueued.end()) {
121 bedata = iter->second;
122 bedata->flags |= flags;
126 bedata = new BlockEmergeData;
127 bedata->flags = flags;
128 bedata->peer_requested = peer_id;
129 blocks_enqueued.insert(std::make_pair(p, bedata));
131 peer_queue_count[peer_id] = count + 1;
133 emergethread->blockqueue.push(p);
135 emergethread->qevent.signal();
141 bool EmergeManager::popBlockEmerge(v3s16 *pos, u8 *flags) {
142 std::map<v3s16, BlockEmergeData *>::iterator iter;
143 JMutexAutoLock queuelock(queuemutex);
145 if (emergethread->blockqueue.empty())
147 v3s16 p = emergethread->blockqueue.front();
148 emergethread->blockqueue.pop();
152 iter = blocks_enqueued.find(p);
153 if (iter == blocks_enqueued.end())
154 return false; //uh oh, queue and map out of sync!!
156 BlockEmergeData *bedata = iter->second;
157 *flags = bedata->flags;
159 peer_queue_count[bedata->peer_requested]--;
162 blocks_enqueued.erase(iter);
168 int EmergeManager::getGroundLevelAtPoint(v2s16 p) {
171 return mapgen->getGroundLevelAtPoint(p);
175 bool EmergeManager::isBlockUnderground(v3s16 blockpos) {
177 v2s16 p = v2s16((blockpos.X * MAP_BLOCKSIZE) + MAP_BLOCKSIZE / 2,
178 (blockpos.Y * MAP_BLOCKSIZE) + MAP_BLOCKSIZE / 2);
179 int ground_level = getGroundLevelAtPoint(p);
180 return blockpos.Y * (MAP_BLOCKSIZE + 1) <= min(water_level, ground_level);
183 //yuck, but then again, should i bother being accurate?
184 //the height of the nodes in a single block is quite variable
185 return blockpos.Y * (MAP_BLOCKSIZE + 1) <= params->water_level;
189 u32 EmergeManager::getBlockSeed(v3s16 p) {
190 return (u32)(params->seed & 0xFFFFFFFF) +
197 Mapgen *EmergeManager::createMapgen(std::string mgname, int mgid,
198 MapgenParams *mgparams, EmergeManager *emerge) {
199 std::map<std::string, MapgenFactory *>::const_iterator iter = mglist.find(mgname);
200 if (iter == mglist.end()) {
201 errorstream << "EmergeManager; mapgen " << mgname <<
202 " not registered" << std::endl;
206 MapgenFactory *mgfactory = iter->second;
207 return mgfactory->createMapgen(mgid, mgparams, emerge);
211 MapgenParams *EmergeManager::createMapgenParams(std::string mgname) {
212 std::map<std::string, MapgenFactory *>::const_iterator iter = mglist.find(mgname);
213 if (iter == mglist.end()) {
214 errorstream << "EmergeManager: mapgen " << mgname <<
215 " not registered" << std::endl;
219 MapgenFactory *mgfactory = iter->second;
220 return mgfactory->createMapgenParams();
224 MapgenParams *EmergeManager::getParamsFromSettings(Settings *settings) {
225 std::string mg_name = settings->get("mg_name");
226 MapgenParams *mgparams = createMapgenParams(mg_name);
228 mgparams->mg_name = mg_name;
229 mgparams->seed = settings->getU64(settings == g_settings ? "fixed_map_seed" : "seed");
230 mgparams->water_level = settings->getS16("water_level");
231 mgparams->chunksize = settings->getS16("chunksize");
232 mgparams->flags = settings->getS32("mg_flags");
234 if (!mgparams->readParams(settings)) {
242 void EmergeManager::setParamsToSettings(Settings *settings) {
243 settings->set("mg_name", params->mg_name);
244 settings->setU64("seed", params->seed);
245 settings->setS16("water_level", params->water_level);
246 settings->setS16("chunksize", params->chunksize);
247 settings->setFlagStr("mg_flags", params->flags, flagdesc_mapgen);
249 params->writeParams(settings);
253 bool EmergeManager::registerMapgen(std::string mgname, MapgenFactory *mgfactory) {
254 mglist.insert(std::make_pair(mgname, mgfactory));
255 infostream << "EmergeManager: registered mapgen " << mgname << std::endl;
260 class MapEditEventIgnorer
263 MapEditEventIgnorer(bool *flag):
272 ~MapEditEventIgnorer()
285 class MapEditEventAreaIgnorer
288 MapEditEventAreaIgnorer(VoxelArea *ignorevariable, const VoxelArea &a):
289 m_ignorevariable(ignorevariable)
291 if(m_ignorevariable->getVolume() == 0)
292 *m_ignorevariable = a;
294 m_ignorevariable = NULL;
297 ~MapEditEventAreaIgnorer()
301 assert(m_ignorevariable->getVolume() != 0);
302 *m_ignorevariable = VoxelArea();
307 VoxelArea *m_ignorevariable;
313 #define EMERGE_DBG_OUT(x) \
314 { if (enable_mapgen_debug_info) \
315 infostream << "EmergeThread: " x << std::endl; }
317 bool EmergeThread::getBlockOrStartGen(v3s16 p, MapBlock **b,
318 BlockMakeData *data, bool allow_gen) {
320 //envlock: usually takes <=1ms, sometimes 90ms or ~400ms to acquire
321 JMutexAutoLock envlock(m_server->m_env_mutex);
323 // Load sector if it isn't loaded
324 if (map->getSectorNoGenerateNoEx(p2d) == NULL)
325 map->loadSectorMeta(p2d);
327 // Attempt to load block
328 MapBlock *block = map->getBlockNoCreateNoEx(p);
329 if (!block || block->isDummy() || !block->isGenerated()) {
330 EMERGE_DBG_OUT("not in memory, attempting to load from disk");
331 block = map->loadBlock(p);
334 // If could not load and allowed to generate,
335 // start generation inside this same envlock
336 if (allow_gen && (block == NULL || !block->isGenerated())) {
337 EMERGE_DBG_OUT("generating");
338 map->initBlockMake(data, p);
347 void *EmergeThread::Thread() {
349 log_register_thread("EmergeThread");
350 DSTACK(__FUNCTION_NAME);
351 BEGIN_DEBUG_EXCEPTION_HANDLER
353 v3s16 last_tried_pos(-32768,-32768,-32768); // For error output
357 map = (ServerMap *)&(m_server->m_env->getMap());
358 emerge = m_server->m_emerge;
359 mapgen = emerge->getMapgen();
363 while (!emerge->popBlockEmerge(&p, &flags))
367 if (blockpos_over_limit(p))
370 bool allow_generate = flags & BLOCK_EMERGE_ALLOWGEN;
371 EMERGE_DBG_OUT("p=" PP(p) " allow_generate=" << allow_generate);
374 Try to fetch block from memory or disk.
375 If not found and asked to generate, initialize generator.
378 MapBlock *block = NULL;
379 core::map<v3s16, MapBlock *> modified_blocks;
381 if (getBlockOrStartGen(p, &block, &data, allow_generate)) {
383 ScopeProfiler sp(g_profiler, "EmergeThread: Mapgen::makeChunk", SPT_AVG);
384 TimeTaker t("mapgen::make_block()");
386 mapgen->makeChunk(&data);
388 if (enable_mapgen_debug_info == false)
389 t.stop(true); // Hide output
393 //envlock: usually 0ms, but can take either 30 or 400ms to acquire
394 JMutexAutoLock envlock(m_server->m_env_mutex);
395 ScopeProfiler sp(g_profiler, "EmergeThread: after "
396 "mapgen::make_block (envlock)", SPT_AVG);
398 map->finishBlockMake(&data, modified_blocks);
400 block = map->getBlockNoCreateNoEx(p);
403 Do some post-generate stuff
405 v3s16 minp = data.blockpos_min * MAP_BLOCKSIZE;
406 v3s16 maxp = data.blockpos_max * MAP_BLOCKSIZE +
407 v3s16(1,1,1) * (MAP_BLOCKSIZE - 1);
409 // Ignore map edit events, they will not need to be sent
410 // to anybody because the block hasn't been sent to anybody
411 MapEditEventAreaIgnorer
412 ign(&m_server->m_ignore_map_edit_events_area,
413 VoxelArea(minp, maxp));
414 { // takes about 90ms with -O1 on an e3-1230v2
415 scriptapi_environment_on_generated(m_server->m_lua,
416 minp, maxp, emerge->getBlockSeed(minp));
419 EMERGE_DBG_OUT("ended up with: " << analyze_block(block));
421 m_server->m_env->activateBlock(block, 0);
427 Set sent status of modified blocks on clients
430 // NOTE: Server's clients are also behind the connection mutex
431 //conlock: consistently takes 30-40ms to acquire
432 JMutexAutoLock lock(m_server->m_con_mutex);
433 // Add the originally fetched block to the modified list
435 modified_blocks.insert(p, block);
437 // Set the modified blocks unsent for all the clients
438 for (core::map<u16, RemoteClient*>::Iterator
439 i = m_server->m_clients.getIterator();
440 i.atEnd() == false; i++) {
441 RemoteClient *client = i.getNode()->getValue();
442 if (modified_blocks.size() > 0) {
443 // Remove block from sent history
444 client->SetBlocksNotSent(modified_blocks);
448 catch (VersionMismatchException &e) {
449 std::ostringstream err;
450 err << "World data version mismatch in MapBlock "<<PP(last_tried_pos)<<std::endl;
451 err << "----"<<std::endl;
452 err << "\""<<e.what()<<"\""<<std::endl;
453 err << "See debug.txt."<<std::endl;
454 err << "World probably saved by a newer version of Minetest."<<std::endl;
455 m_server->setAsyncFatalError(err.str());
457 catch (SerializationError &e) {
458 std::ostringstream err;
459 err << "Invalid data in MapBlock "<<PP(last_tried_pos)<<std::endl;
460 err << "----"<<std::endl;
461 err << "\""<<e.what()<<"\""<<std::endl;
462 err << "See debug.txt."<<std::endl;
463 err << "You can ignore this using [ignore_world_load_errors = true]."<<std::endl;
464 m_server->setAsyncFatalError(err.str());
467 END_DEBUG_EXCEPTION_HANDLER(errorstream)
468 log_deregister_thread();
474 void *EmergeThread::Thread() {
476 log_register_thread("EmergeThread");
477 DSTACK(__FUNCTION_NAME);
478 BEGIN_DEBUG_EXCEPTION_HANDLER
480 bool enable_mapgen_debug_info = g_settings->getBool("enable_mapgen_debug_info");
482 v3s16 last_tried_pos(-32768,-32768,-32768); // For error output
483 ServerMap &map = ((ServerMap&)m_server->m_env->getMap());
484 EmergeManager *emerge = m_server->m_emerge;
485 Mapgen *mapgen = emerge->getMapgen();
489 QueuedBlockEmerge *qptr = m_server->m_emerge_queue.pop();
492 SharedPtr<QueuedBlockEmerge> q(qptr);
500 Do not generate over-limit
502 if (blockpos_over_limit(p))
505 //infostream<<"EmergeThread::Thread(): running"<<std::endl;
507 //TimeTaker timer("block emerge");
510 Try to emerge it from somewhere.
512 If it is only wanted as optional, only loading from disk
517 Check if any peer wants it as non-optional. In that case it
520 Also decrement the emerge queue count in clients.
523 bool only_from_disk = true;
525 core::map<u16, u8>::Iterator i;
526 for (i=q->s.getIterator(); !i.atEnd(); i++) {
527 u8 flags = i.getNode()->getValue();
528 if (!(flags & BLOCK_EMERGE_FLAG_FROMDISK)) {
529 only_from_disk = false;
535 if (enable_mapgen_debug_info)
536 infostream<<"EmergeThread: p="
537 <<"("<<p.X<<","<<p.Y<<","<<p.Z<<") "
538 <<"only_from_disk="<<only_from_disk<<std::endl;
540 MapBlock *block = NULL;
541 bool got_block = true;
542 core::map<v3s16, MapBlock*> modified_blocks;
545 Try to fetch block from memory or disk.
546 If not found and asked to generate, initialize generator.
549 bool started_generate = false;
552 JMutexAutoLock envlock(m_server->m_env_mutex);
554 // Load sector if it isn't loaded
555 if(map.getSectorNoGenerateNoEx(p2d) == NULL)
556 map.loadSectorMeta(p2d);
558 // Attempt to load block
559 block = map.getBlockNoCreateNoEx(p);
560 if(!block || block->isDummy() || !block->isGenerated()) {
561 if(enable_mapgen_debug_info)
562 infostream<<"EmergeThread: not in memory, "
563 <<"attempting to load from disk"<<std::endl;
565 block = map.loadBlock(p);
568 // If could not load and allowed to generate, start generation
569 // inside this same envlock
570 if(only_from_disk == false &&
571 (block == NULL || block->isGenerated() == false)){
572 if(enable_mapgen_debug_info)
573 infostream<<"EmergeThread: generating"<<std::endl;
574 started_generate = true;
576 map.initBlockMake(&data, p);
581 If generator was initialized, generate now when envlock is free.
583 if(started_generate) {
585 ScopeProfiler sp(g_profiler, "EmergeThread: mapgen::make_block",
587 TimeTaker t("mapgen::make_block()");
589 mapgen->makeChunk(&data);
591 if (enable_mapgen_debug_info == false)
592 t.stop(true); // Hide output
596 // Lock environment again to access the map
597 JMutexAutoLock envlock(m_server->m_env_mutex);
599 ScopeProfiler sp(g_profiler, "EmergeThread: after "
600 "mapgen::make_block (envlock)", SPT_AVG);
602 // Blit data back on map, update lighting, add mobs and
603 // whatever this does
604 map.finishBlockMake(&data, modified_blocks);
607 block = map.getBlockNoCreateNoEx(p);
609 // If block doesn't exist, don't try doing anything with it
610 // This happens if the block is not in generation boundaries
615 Do some post-generate stuff
617 v3s16 minp = data.blockpos_min * MAP_BLOCKSIZE;
618 v3s16 maxp = data.blockpos_max * MAP_BLOCKSIZE +
619 v3s16(1,1,1) * (MAP_BLOCKSIZE - 1);
622 Ignore map edit events, they will not need to be
623 sent to anybody because the block hasn't been sent
626 MapEditEventAreaIgnorer ign(
627 &m_server->m_ignore_map_edit_events_area,
628 VoxelArea(minp, maxp));
630 TimeTaker timer("on_generated");
631 scriptapi_environment_on_generated(m_server->m_lua,
632 minp, maxp, emerge->getBlockSeed(minp));
633 //int t = timer.stop(true);
634 //dstream<<"on_generated took "<<t<<"ms"<<std::endl;
637 if (enable_mapgen_debug_info)
638 infostream << "EmergeThread: ended up with: "
639 << analyze_block(block) << std::endl;
641 // Activate objects and stuff
642 m_server->m_env->activateBlock(block, 0);
650 Set sent status of modified blocks on clients
653 // NOTE: Server's clients are also behind the connection mutex
654 JMutexAutoLock lock(m_server->m_con_mutex);
657 Add the originally fetched block to the modified list
660 modified_blocks.insert(p, block);
663 Set the modified blocks unsent for all the clients
665 for(core::map<u16, RemoteClient*>::Iterator
666 i = m_server->m_clients.getIterator();
667 i.atEnd() == false; i++) {
668 RemoteClient *client = i.getNode()->getValue();
669 if(modified_blocks.size() > 0) {
670 // Remove block from sent history
671 client->SetBlocksNotSent(modified_blocks);
678 catch (VersionMismatchException &e) {
679 std::ostringstream err;
680 err << "World data version mismatch in MapBlock "<<PP(last_tried_pos)<<std::endl;
681 err << "----"<<std::endl;
682 err << "\""<<e.what()<<"\""<<std::endl;
683 err << "See debug.txt."<<std::endl;
684 err << "World probably saved by a newer version of Minetest."<<std::endl;
685 m_server->setAsyncFatalError(err.str());
687 catch (SerializationError &e) {
688 std::ostringstream err;
689 err << "Invalid data in MapBlock "<<PP(last_tried_pos)<<std::endl;
690 err << "----"<<std::endl;
691 err << "\""<<e.what()<<"\""<<std::endl;
692 err << "See debug.txt."<<std::endl;
693 err << "You can ignore this using [ignore_world_load_errors = true]."<<std::endl;
694 m_server->setAsyncFatalError(err.str());
696 printf("emergethread iterated %d times\n", niters);
697 END_DEBUG_EXCEPTION_HANDLER(errorstream)
698 log_deregister_thread();