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 qlimit_total = g_settings->getU16("emergequeue_limit_total");
52 qlimit_diskonly = g_settings->getU16("emergequeue_limit_diskonly");
53 qlimit_generate = g_settings->getU16("emergequeue_limit_generate");
56 int nthreads = g_settings->get("num_emerge_threads").empty() ?
57 porting::getNumberOfProcessors() :
58 g_settings->getU16("num_emerge_threads");
62 for (int i = 0; i != nthreads; i++)
63 emergethread.push_back(new EmergeThread((Server *)gamedef, i));
65 infostream << "EmergeManager: using " << nthreads << " threads" << std::endl;
69 EmergeManager::~EmergeManager() {
70 for (int i = 0; i != emergethread.size(); i++) {
71 emergethread[i]->setRun(false);
72 emergethread[i]->qevent.signal();
73 emergethread[i]->stop();
74 delete emergethread[i];
83 void EmergeManager::initMapgens(MapgenParams *mgparams) {
89 this->params = mgparams;
90 for (int i = 0; i != emergethread.size(); i++) {
91 mg = createMapgen(params->mg_name, 0, params);
93 infostream << "EmergeManager: falling back to mapgen v6" << std::endl;
95 params = createMapgenParams("v6");
96 mg = createMapgen("v6", 0, params);
103 bool EmergeManager::enqueueBlockEmerge(u16 peer_id, v3s16 p, bool allow_generate) {
104 std::map<v3s16, BlockEmergeData *>::const_iterator iter;
105 BlockEmergeData *bedata;
111 flags |= BLOCK_EMERGE_ALLOWGEN;
114 JMutexAutoLock queuelock(queuemutex);
116 count = blocks_enqueued.size();
117 if (count >= qlimit_total)
120 count = peer_queue_count[peer_id];
121 u16 qlimit_peer = allow_generate ? qlimit_generate : qlimit_diskonly;
122 if (count >= qlimit_peer)
125 iter = blocks_enqueued.find(p);
126 if (iter != blocks_enqueued.end()) {
127 bedata = iter->second;
128 bedata->flags |= flags;
132 bedata = new BlockEmergeData;
133 bedata->flags = flags;
134 bedata->peer_requested = peer_id;
135 blocks_enqueued.insert(std::make_pair(p, bedata));
137 peer_queue_count[peer_id] = count + 1;
139 int lowestitems = emergethread[0]->blockqueue.size();
140 for (int i = 1; i != emergethread.size(); i++) {
141 int nitems = emergethread[i]->blockqueue.size();
142 if (nitems < lowestitems) {
144 lowestitems = nitems;
148 emergethread[idx]->blockqueue.push(p);
150 emergethread[idx]->qevent.signal();
156 bool EmergeThread::popBlockEmerge(v3s16 *pos, u8 *flags) {
157 std::map<v3s16, BlockEmergeData *>::iterator iter;
158 JMutexAutoLock queuelock(emerge->queuemutex);
160 if (blockqueue.empty())
162 v3s16 p = blockqueue.front();
167 iter = emerge->blocks_enqueued.find(p);
168 if (iter == emerge->blocks_enqueued.end())
169 return false; //uh oh, queue and map out of sync!!
171 BlockEmergeData *bedata = iter->second;
172 *flags = bedata->flags;
174 emerge->peer_queue_count[bedata->peer_requested]--;
177 emerge->blocks_enqueued.erase(iter);
183 int EmergeManager::getGroundLevelAtPoint(v2s16 p) {
185 errorstream << "EmergeManager: getGroundLevelAtPoint() called"
186 " before mapgen initialized" << std::endl;
190 return mapgen[0]->getGroundLevelAtPoint(p);
194 bool EmergeManager::isBlockUnderground(v3s16 blockpos) {
196 v2s16 p = v2s16((blockpos.X * MAP_BLOCKSIZE) + MAP_BLOCKSIZE / 2,
197 (blockpos.Y * MAP_BLOCKSIZE) + MAP_BLOCKSIZE / 2);
198 int ground_level = getGroundLevelAtPoint(p);
199 return blockpos.Y * (MAP_BLOCKSIZE + 1) <= min(water_level, ground_level);
202 //yuck, but then again, should i bother being accurate?
203 //the height of the nodes in a single block is quite variable
204 return blockpos.Y * (MAP_BLOCKSIZE + 1) <= params->water_level;
208 u32 EmergeManager::getBlockSeed(v3s16 p) {
209 return (u32)(params->seed & 0xFFFFFFFF) +
216 Mapgen *EmergeManager::createMapgen(std::string mgname, int mgid,
217 MapgenParams *mgparams) {
218 std::map<std::string, MapgenFactory *>::const_iterator iter;
219 iter = mglist.find(mgname);
220 if (iter == mglist.end()) {
221 errorstream << "EmergeManager; mapgen " << mgname <<
222 " not registered" << std::endl;
226 MapgenFactory *mgfactory = iter->second;
227 return mgfactory->createMapgen(mgid, mgparams, this);
231 MapgenParams *EmergeManager::createMapgenParams(std::string mgname) {
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->createMapgenParams();
245 MapgenParams *EmergeManager::getParamsFromSettings(Settings *settings) {
246 std::string mg_name = settings->get("mg_name");
247 MapgenParams *mgparams = createMapgenParams(mg_name);
249 mgparams->mg_name = mg_name;
250 mgparams->seed = settings->getU64(settings == g_settings ? "fixed_map_seed" : "seed");
251 mgparams->water_level = settings->getS16("water_level");
252 mgparams->chunksize = settings->getS16("chunksize");
253 mgparams->flags = settings->getFlagStr("mg_flags", flagdesc_mapgen);
255 if (!mgparams->readParams(settings)) {
263 void EmergeManager::setParamsToSettings(Settings *settings) {
264 settings->set("mg_name", params->mg_name);
265 settings->setU64("seed", params->seed);
266 settings->setS16("water_level", params->water_level);
267 settings->setS16("chunksize", params->chunksize);
268 settings->setFlagStr("mg_flags", params->flags, flagdesc_mapgen);
270 params->writeParams(settings);
274 bool EmergeManager::registerMapgen(std::string mgname, MapgenFactory *mgfactory) {
275 mglist.insert(std::make_pair(mgname, mgfactory));
276 infostream << "EmergeManager: registered mapgen " << mgname << std::endl;
281 class MapEditEventIgnorer
284 MapEditEventIgnorer(bool *flag):
293 ~MapEditEventIgnorer()
306 class MapEditEventAreaIgnorer
309 MapEditEventAreaIgnorer(VoxelArea *ignorevariable, const VoxelArea &a):
310 m_ignorevariable(ignorevariable)
312 if(m_ignorevariable->getVolume() == 0)
313 *m_ignorevariable = a;
315 m_ignorevariable = NULL;
318 ~MapEditEventAreaIgnorer()
322 assert(m_ignorevariable->getVolume() != 0);
323 *m_ignorevariable = VoxelArea();
328 VoxelArea *m_ignorevariable;
334 #define EMERGE_DBG_OUT(x) \
335 { if (enable_mapgen_debug_info) \
336 infostream << "EmergeThread: " x << std::endl; }
338 bool EmergeThread::getBlockOrStartGen(v3s16 p, MapBlock **b,
339 BlockMakeData *data, bool allow_gen) {
341 //envlock: usually takes <=1ms, sometimes 90ms or ~400ms to acquire
342 JMutexAutoLock envlock(m_server->m_env_mutex);
344 // Load sector if it isn't loaded
345 if (map->getSectorNoGenerateNoEx(p2d) == NULL)
346 map->loadSectorMeta(p2d);
348 // Attempt to load block
349 MapBlock *block = map->getBlockNoCreateNoEx(p);
350 if (!block || block->isDummy() || !block->isGenerated()) {
351 EMERGE_DBG_OUT("not in memory, attempting to load from disk");
352 block = map->loadBlock(p);
355 // If could not load and allowed to generate,
356 // start generation inside this same envlock
357 if (allow_gen && (block == NULL || !block->isGenerated())) {
358 EMERGE_DBG_OUT("generating");
359 map->initBlockMake(data, p);
368 void *EmergeThread::Thread() {
370 log_register_thread("EmergeThread");
371 DSTACK(__FUNCTION_NAME);
372 BEGIN_DEBUG_EXCEPTION_HANDLER
374 v3s16 last_tried_pos(-32768,-32768,-32768); // For error output
378 map = (ServerMap *)&(m_server->m_env->getMap());
379 emerge = m_server->m_emerge;
380 mapgen = emerge->mapgen[id]; //emerge->getMapgen();
384 while (!popBlockEmerge(&p, &flags)) {
387 goto exit_emerge_loop;
391 if (blockpos_over_limit(p))
394 bool allow_generate = flags & BLOCK_EMERGE_ALLOWGEN;
395 EMERGE_DBG_OUT("p=" PP(p) " allow_generate=" << allow_generate);
398 Try to fetch block from memory or disk.
399 If not found and asked to generate, initialize generator.
402 MapBlock *block = NULL;
403 core::map<v3s16, MapBlock *> modified_blocks;
405 if (getBlockOrStartGen(p, &block, &data, allow_generate)) {
407 ScopeProfiler sp(g_profiler, "EmergeThread: Mapgen::makeChunk", SPT_AVG);
408 TimeTaker t("mapgen::make_block()");
410 mapgen->makeChunk(&data);
412 if (enable_mapgen_debug_info == false)
413 t.stop(true); // Hide output
417 //envlock: usually 0ms, but can take either 30 or 400ms to acquire
418 JMutexAutoLock envlock(m_server->m_env_mutex);
419 ScopeProfiler sp(g_profiler, "EmergeThread: after "
420 "Mapgen::makeChunk (envlock)", SPT_AVG);
422 map->finishBlockMake(&data, modified_blocks);
424 block = map->getBlockNoCreateNoEx(p);
427 Do some post-generate stuff
429 v3s16 minp = data.blockpos_min * MAP_BLOCKSIZE;
430 v3s16 maxp = data.blockpos_max * MAP_BLOCKSIZE +
431 v3s16(1,1,1) * (MAP_BLOCKSIZE - 1);
433 // Ignore map edit events, they will not need to be sent
434 // to anybody because the block hasn't been sent to anybody
435 MapEditEventAreaIgnorer
436 ign(&m_server->m_ignore_map_edit_events_area,
437 VoxelArea(minp, maxp));
438 { // takes about 90ms with -O1 on an e3-1230v2
439 scriptapi_environment_on_generated(m_server->m_lua,
440 minp, maxp, emerge->getBlockSeed(minp));
443 EMERGE_DBG_OUT("ended up with: " << analyze_block(block));
445 m_server->m_env->activateBlock(block, 0);
451 Set sent status of modified blocks on clients
454 // NOTE: Server's clients are also behind the connection mutex
455 //conlock: consistently takes 30-40ms to acquire
456 JMutexAutoLock lock(m_server->m_con_mutex);
457 // Add the originally fetched block to the modified list
459 modified_blocks.insert(p, block);
461 // Set the modified blocks unsent for all the clients
462 for (core::map<u16, RemoteClient*>::Iterator
463 i = m_server->m_clients.getIterator();
464 i.atEnd() == false; i++) {
465 RemoteClient *client = i.getNode()->getValue();
466 if (modified_blocks.size() > 0) {
467 // Remove block from sent history
468 client->SetBlocksNotSent(modified_blocks);
472 catch (VersionMismatchException &e) {
473 std::ostringstream err;
474 err << "World data version mismatch in MapBlock "<<PP(last_tried_pos)<<std::endl;
475 err << "----"<<std::endl;
476 err << "\""<<e.what()<<"\""<<std::endl;
477 err << "See debug.txt."<<std::endl;
478 err << "World probably saved by a newer version of Minetest."<<std::endl;
479 m_server->setAsyncFatalError(err.str());
481 catch (SerializationError &e) {
482 std::ostringstream err;
483 err << "Invalid data 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 << "You can ignore this using [ignore_world_load_errors = true]."<<std::endl;
488 m_server->setAsyncFatalError(err.str());
491 END_DEBUG_EXCEPTION_HANDLER(errorstream)
493 log_deregister_thread();
499 void *EmergeThread::Thread() {
501 log_register_thread("EmergeThread");
502 DSTACK(__FUNCTION_NAME);
503 BEGIN_DEBUG_EXCEPTION_HANDLER
505 bool enable_mapgen_debug_info = g_settings->getBool("enable_mapgen_debug_info");
507 v3s16 last_tried_pos(-32768,-32768,-32768); // For error output
508 ServerMap &map = ((ServerMap&)m_server->m_env->getMap());
509 EmergeManager *emerge = m_server->m_emerge;
510 Mapgen *mapgen = emerge->getMapgen();
514 QueuedBlockEmerge *qptr = m_server->m_emerge_queue.pop();
517 SharedPtr<QueuedBlockEmerge> q(qptr);
525 Do not generate over-limit
527 if (blockpos_over_limit(p))
530 //infostream<<"EmergeThread::Thread(): running"<<std::endl;
532 //TimeTaker timer("block emerge");
535 Try to emerge it from somewhere.
537 If it is only wanted as optional, only loading from disk
542 Check if any peer wants it as non-optional. In that case it
545 Also decrement the emerge queue count in clients.
548 bool only_from_disk = true;
550 core::map<u16, u8>::Iterator i;
551 for (i=q->s.getIterator(); !i.atEnd(); i++) {
552 u8 flags = i.getNode()->getValue();
553 if (!(flags & BLOCK_EMERGE_FLAG_FROMDISK)) {
554 only_from_disk = false;
560 if (enable_mapgen_debug_info)
561 infostream<<"EmergeThread: p="
562 <<"("<<p.X<<","<<p.Y<<","<<p.Z<<") "
563 <<"only_from_disk="<<only_from_disk<<std::endl;
565 MapBlock *block = NULL;
566 bool got_block = true;
567 core::map<v3s16, MapBlock*> modified_blocks;
570 Try to fetch block from memory or disk.
571 If not found and asked to generate, initialize generator.
574 bool started_generate = false;
577 JMutexAutoLock envlock(m_server->m_env_mutex);
579 // Load sector if it isn't loaded
580 if(map.getSectorNoGenerateNoEx(p2d) == NULL)
581 map.loadSectorMeta(p2d);
583 // Attempt to load block
584 block = map.getBlockNoCreateNoEx(p);
585 if(!block || block->isDummy() || !block->isGenerated()) {
586 if(enable_mapgen_debug_info)
587 infostream<<"EmergeThread: not in memory, "
588 <<"attempting to load from disk"<<std::endl;
590 block = map.loadBlock(p);
593 // If could not load and allowed to generate, start generation
594 // inside this same envlock
595 if(only_from_disk == false &&
596 (block == NULL || block->isGenerated() == false)){
597 if(enable_mapgen_debug_info)
598 infostream<<"EmergeThread: generating"<<std::endl;
599 started_generate = true;
601 map.initBlockMake(&data, p);
606 If generator was initialized, generate now when envlock is free.
608 if(started_generate) {
610 ScopeProfiler sp(g_profiler, "EmergeThread: mapgen::make_block",
612 TimeTaker t("mapgen::make_block()");
614 mapgen->makeChunk(&data);
616 if (enable_mapgen_debug_info == false)
617 t.stop(true); // Hide output
621 // Lock environment again to access the map
622 JMutexAutoLock envlock(m_server->m_env_mutex);
624 ScopeProfiler sp(g_profiler, "EmergeThread: after "
625 "mapgen::make_block (envlock)", SPT_AVG);
627 // Blit data back on map, update lighting, add mobs and
628 // whatever this does
629 map.finishBlockMake(&data, modified_blocks);
632 block = map.getBlockNoCreateNoEx(p);
634 // If block doesn't exist, don't try doing anything with it
635 // This happens if the block is not in generation boundaries
640 Do some post-generate stuff
642 v3s16 minp = data.blockpos_min * MAP_BLOCKSIZE;
643 v3s16 maxp = data.blockpos_max * MAP_BLOCKSIZE +
644 v3s16(1,1,1) * (MAP_BLOCKSIZE - 1);
647 Ignore map edit events, they will not need to be
648 sent to anybody because the block hasn't been sent
651 MapEditEventAreaIgnorer ign(
652 &m_server->m_ignore_map_edit_events_area,
653 VoxelArea(minp, maxp));
655 TimeTaker timer("on_generated");
656 scriptapi_environment_on_generated(m_server->m_lua,
657 minp, maxp, emerge->getBlockSeed(minp));
658 //int t = timer.stop(true);
659 //dstream<<"on_generated took "<<t<<"ms"<<std::endl;
662 if (enable_mapgen_debug_info)
663 infostream << "EmergeThread: ended up with: "
664 << analyze_block(block) << std::endl;
666 // Activate objects and stuff
667 m_server->m_env->activateBlock(block, 0);
675 Set sent status of modified blocks on clients
678 // NOTE: Server's clients are also behind the connection mutex
679 JMutexAutoLock lock(m_server->m_con_mutex);
682 Add the originally fetched block to the modified list
685 modified_blocks.insert(p, block);
688 Set the modified blocks unsent for all the clients
690 for(core::map<u16, RemoteClient*>::Iterator
691 i = m_server->m_clients.getIterator();
692 i.atEnd() == false; i++) {
693 RemoteClient *client = i.getNode()->getValue();
694 if(modified_blocks.size() > 0) {
695 // Remove block from sent history
696 client->SetBlocksNotSent(modified_blocks);
703 catch (VersionMismatchException &e) {
704 std::ostringstream err;
705 err << "World data version mismatch in MapBlock "<<PP(last_tried_pos)<<std::endl;
706 err << "----"<<std::endl;
707 err << "\""<<e.what()<<"\""<<std::endl;
708 err << "See debug.txt."<<std::endl;
709 err << "World probably saved by a newer version of Minetest."<<std::endl;
710 m_server->setAsyncFatalError(err.str());
712 catch (SerializationError &e) {
713 std::ostringstream err;
714 err << "Invalid data 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 << "You can ignore this using [ignore_world_load_errors = true]."<<std::endl;
719 m_server->setAsyncFatalError(err.str());
721 printf("emergethread iterated %d times\n", niters);
722 END_DEBUG_EXCEPTION_HANDLER(errorstream)
723 log_deregister_thread();