3 Copyright (C) 2010-2013 celeron55, Perttu Ahola <celeron55@gmail.com>
4 Copyright (C) 2010-2013 kwolekr, Ryan Kwolek <kwolekr@minetest.net>
6 This program is free software; you can redistribute it and/or modify
7 it under the terms of the GNU Lesser General Public License as published by
8 the Free Software Foundation; either version 2.1 of the License, or
9 (at your option) any later version.
11 This program is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU Lesser General Public License for more details.
16 You should have received a copy of the GNU Lesser General Public License along
17 with this program; if not, write to the Free Software Foundation, Inc.,
18 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
25 #include "clientserver.h"
27 #include "jmutexautolock.h"
29 #include "constants.h"
33 #include "serverobject.h"
35 #include "cpp_api/scriptapi.h"
41 #include "mapgen_v6.h"
42 #include "mapgen_v7.h"
43 #include "mapgen_indev.h"
44 #include "mapgen_singlenode.h"
47 /////////////////////////////// Emerge Manager ////////////////////////////////
49 EmergeManager::EmergeManager(IGameDef *gamedef) {
50 //register built-in mapgens
51 registerMapgen("v6", new MapgenFactoryV6());
52 registerMapgen("v7", new MapgenFactoryV7());
53 registerMapgen("indev", new MapgenFactoryIndev());
54 registerMapgen("singlenode", new MapgenFactorySinglenode());
56 this->ndef = gamedef->getNodeDefManager();
57 this->biomedef = new BiomeDefManager();
60 mapgen_debug_info = g_settings->getBool("enable_mapgen_debug_info");
65 if (g_settings->get("num_emerge_threads").empty()) {
66 int nprocs = porting::getNumberOfProcessors();
67 // leave a proc for the main thread and one for some other misc threads
68 nthreads = (nprocs > 2) ? nprocs - 2 : 1;
70 nthreads = g_settings->getU16("num_emerge_threads");
75 qlimit_total = g_settings->getU16("emergequeue_limit_total");
76 qlimit_diskonly = g_settings->get("emergequeue_limit_diskonly").empty() ?
78 g_settings->getU16("emergequeue_limit_diskonly");
79 qlimit_generate = g_settings->get("emergequeue_limit_generate").empty() ?
81 g_settings->getU16("emergequeue_limit_generate");
83 for (int i = 0; i != nthreads; i++)
84 emergethread.push_back(new EmergeThread((Server *)gamedef, i));
86 infostream << "EmergeManager: using " << nthreads << " threads" << std::endl;
90 EmergeManager::~EmergeManager() {
91 for (unsigned int i = 0; i != emergethread.size(); i++) {
92 emergethread[i]->setRun(false);
93 emergethread[i]->qevent.signal();
94 emergethread[i]->stop();
95 delete emergethread[i];
101 for (unsigned int i = 0; i < ores.size(); i++)
105 for (unsigned int i = 0; i < decorations.size(); i++)
106 delete decorations[i];
109 for (std::map<std::string, MapgenFactory *>::iterator iter = mglist.begin();
110 iter != mglist.end(); iter ++) {
119 void EmergeManager::initMapgens(MapgenParams *mgparams) {
125 biomedef->resolveNodeNames(ndef);
127 this->params = mgparams;
128 for (unsigned int i = 0; i != emergethread.size(); i++) {
129 mg = createMapgen(params->mg_name, 0, params);
131 infostream << "EmergeManager: falling back to mapgen v6" << std::endl;
133 params = createMapgenParams("v6");
134 mg = createMapgen("v6", 0, params);
136 mapgen.push_back(mg);
141 bool EmergeManager::enqueueBlockEmerge(u16 peer_id, v3s16 p, bool allow_generate) {
142 std::map<v3s16, BlockEmergeData *>::const_iterator iter;
143 BlockEmergeData *bedata;
149 flags |= BLOCK_EMERGE_ALLOWGEN;
152 JMutexAutoLock queuelock(queuemutex);
154 count = blocks_enqueued.size();
155 if (count >= qlimit_total)
158 count = peer_queue_count[peer_id];
159 u16 qlimit_peer = allow_generate ? qlimit_generate : qlimit_diskonly;
160 if (count >= qlimit_peer)
163 iter = blocks_enqueued.find(p);
164 if (iter != blocks_enqueued.end()) {
165 bedata = iter->second;
166 bedata->flags |= flags;
170 bedata = new BlockEmergeData;
171 bedata->flags = flags;
172 bedata->peer_requested = peer_id;
173 blocks_enqueued.insert(std::make_pair(p, bedata));
175 peer_queue_count[peer_id] = count + 1;
177 // insert into the EmergeThread queue with the least items
178 int lowestitems = emergethread[0]->blockqueue.size();
179 for (unsigned int i = 1; i != emergethread.size(); i++) {
180 int nitems = emergethread[i]->blockqueue.size();
181 if (nitems < lowestitems) {
183 lowestitems = nitems;
187 emergethread[idx]->blockqueue.push(p);
189 emergethread[idx]->qevent.signal();
195 int EmergeManager::getGroundLevelAtPoint(v2s16 p) {
196 if (mapgen.size() == 0 || !mapgen[0]) {
197 errorstream << "EmergeManager: getGroundLevelAtPoint() called"
198 " before mapgen initialized" << std::endl;
202 return mapgen[0]->getGroundLevelAtPoint(p);
206 bool EmergeManager::isBlockUnderground(v3s16 blockpos) {
208 v2s16 p = v2s16((blockpos.X * MAP_BLOCKSIZE) + MAP_BLOCKSIZE / 2,
209 (blockpos.Y * MAP_BLOCKSIZE) + MAP_BLOCKSIZE / 2);
210 int ground_level = getGroundLevelAtPoint(p);
211 return blockpos.Y * (MAP_BLOCKSIZE + 1) <= min(water_level, ground_level);
214 //yuck, but then again, should i bother being accurate?
215 //the height of the nodes in a single block is quite variable
216 return blockpos.Y * (MAP_BLOCKSIZE + 1) <= params->water_level;
220 u32 EmergeManager::getBlockSeed(v3s16 p) {
221 return (u32)(params->seed & 0xFFFFFFFF) +
228 Mapgen *EmergeManager::createMapgen(std::string mgname, int mgid,
229 MapgenParams *mgparams) {
230 std::map<std::string, MapgenFactory *>::const_iterator iter;
231 iter = mglist.find(mgname);
232 if (iter == mglist.end()) {
233 errorstream << "EmergeManager; mapgen " << mgname <<
234 " not registered" << std::endl;
238 MapgenFactory *mgfactory = iter->second;
239 return mgfactory->createMapgen(mgid, mgparams, this);
243 MapgenParams *EmergeManager::createMapgenParams(std::string mgname) {
244 std::map<std::string, MapgenFactory *>::const_iterator iter;
245 iter = mglist.find(mgname);
246 if (iter == mglist.end()) {
247 errorstream << "EmergeManager: mapgen " << mgname <<
248 " not registered" << std::endl;
252 MapgenFactory *mgfactory = iter->second;
253 return mgfactory->createMapgenParams();
257 MapgenParams *EmergeManager::getParamsFromSettings(Settings *settings) {
258 std::string mg_name = settings->get("mg_name");
259 MapgenParams *mgparams = createMapgenParams(mg_name);
263 mgparams->mg_name = mg_name;
264 mgparams->seed = settings->getU64(settings == g_settings ? "fixed_map_seed" : "seed");
265 mgparams->water_level = settings->getS16("water_level");
266 mgparams->chunksize = settings->getS16("chunksize");
267 mgparams->flags = settings->getFlagStr("mg_flags", flagdesc_mapgen);
269 if (!mgparams->readParams(settings)) {
277 void EmergeManager::setParamsToSettings(Settings *settings) {
278 settings->set("mg_name", params->mg_name);
279 settings->setU64("seed", params->seed);
280 settings->setS16("water_level", params->water_level);
281 settings->setS16("chunksize", params->chunksize);
282 settings->setFlagStr("mg_flags", params->flags, flagdesc_mapgen);
284 params->writeParams(settings);
288 void EmergeManager::registerMapgen(std::string mgname, MapgenFactory *mgfactory) {
289 mglist.insert(std::make_pair(mgname, mgfactory));
290 infostream << "EmergeManager: registered mapgen " << mgname << std::endl;
294 ////////////////////////////// Emerge Thread //////////////////////////////////
296 bool EmergeThread::popBlockEmerge(v3s16 *pos, u8 *flags) {
297 std::map<v3s16, BlockEmergeData *>::iterator iter;
298 JMutexAutoLock queuelock(emerge->queuemutex);
300 if (blockqueue.empty())
302 v3s16 p = blockqueue.front();
307 iter = emerge->blocks_enqueued.find(p);
308 if (iter == emerge->blocks_enqueued.end())
309 return false; //uh oh, queue and map out of sync!!
311 BlockEmergeData *bedata = iter->second;
312 *flags = bedata->flags;
314 emerge->peer_queue_count[bedata->peer_requested]--;
317 emerge->blocks_enqueued.erase(iter);
323 bool EmergeThread::getBlockOrStartGen(v3s16 p, MapBlock **b,
324 BlockMakeData *data, bool allow_gen) {
326 //envlock: usually takes <=1ms, sometimes 90ms or ~400ms to acquire
327 JMutexAutoLock envlock(m_server->m_env_mutex);
329 // Load sector if it isn't loaded
330 if (map->getSectorNoGenerateNoEx(p2d) == NULL)
331 map->loadSectorMeta(p2d);
333 // Attempt to load block
334 MapBlock *block = map->getBlockNoCreateNoEx(p);
335 if (!block || block->isDummy() || !block->isGenerated()) {
336 EMERGE_DBG_OUT("not in memory, attempting to load from disk");
337 block = map->loadBlock(p);
340 // If could not load and allowed to generate,
341 // start generation inside this same envlock
342 if (allow_gen && (block == NULL || !block->isGenerated())) {
343 EMERGE_DBG_OUT("generating");
345 return map->initBlockMake(data, p);
353 void *EmergeThread::Thread() {
355 log_register_thread("EmergeThread" + itos(id));
356 DSTACK(__FUNCTION_NAME);
357 BEGIN_DEBUG_EXCEPTION_HANDLER
359 v3s16 last_tried_pos(-32768,-32768,-32768); // For error output
363 map = (ServerMap *)&(m_server->m_env->getMap());
364 emerge = m_server->m_emerge;
365 mapgen = emerge->mapgen[id];
366 enable_mapgen_debug_info = emerge->mapgen_debug_info;
370 if (!popBlockEmerge(&p, &flags)) {
376 if (blockpos_over_limit(p))
379 bool allow_generate = flags & BLOCK_EMERGE_ALLOWGEN;
380 EMERGE_DBG_OUT("p=" PP(p) " allow_generate=" << allow_generate);
383 Try to fetch block from memory or disk.
384 If not found and asked to generate, initialize generator.
387 MapBlock *block = NULL;
388 std::map<v3s16, MapBlock *> modified_blocks;
390 if (getBlockOrStartGen(p, &block, &data, allow_generate)) {
392 ScopeProfiler sp(g_profiler, "EmergeThread: Mapgen::makeChunk", SPT_AVG);
393 TimeTaker t("mapgen::make_block()");
395 mapgen->makeChunk(&data);
397 if (enable_mapgen_debug_info == false)
398 t.stop(true); // Hide output
402 //envlock: usually 0ms, but can take either 30 or 400ms to acquire
403 JMutexAutoLock envlock(m_server->m_env_mutex);
404 ScopeProfiler sp(g_profiler, "EmergeThread: after "
405 "Mapgen::makeChunk (envlock)", SPT_AVG);
407 map->finishBlockMake(&data, modified_blocks);
409 block = map->getBlockNoCreateNoEx(p);
412 Do some post-generate stuff
414 v3s16 minp = data.blockpos_min * MAP_BLOCKSIZE;
415 v3s16 maxp = data.blockpos_max * MAP_BLOCKSIZE +
416 v3s16(1,1,1) * (MAP_BLOCKSIZE - 1);
418 // Ignore map edit events, they will not need to be sent
419 // to anybody because the block hasn't been sent to anybody
420 MapEditEventAreaIgnorer
421 ign(&m_server->m_ignore_map_edit_events_area,
422 VoxelArea(minp, maxp));
423 { // takes about 90ms with -O1 on an e3-1230v2
424 SERVER_TO_SA(m_server)->environment_OnGenerated(
425 minp, maxp, emerge->getBlockSeed(minp));
428 EMERGE_DBG_OUT("ended up with: " << analyze_block(block));
430 m_server->m_env->activateBlock(block, 0);
436 Set sent status of modified blocks on clients
439 // NOTE: Server's clients are also behind the connection mutex
440 //conlock: consistently takes 30-40ms to acquire
441 JMutexAutoLock lock(m_server->m_con_mutex);
442 // Add the originally fetched block to the modified list
444 modified_blocks[p] = block;
446 // Set the modified blocks unsent for all the clients
447 for (std::map<u16, RemoteClient*>::iterator
448 i = m_server->m_clients.begin();
449 i != m_server->m_clients.end(); ++i) {
450 RemoteClient *client = i->second;
451 if (modified_blocks.size() > 0) {
452 // Remove block from sent history
453 client->SetBlocksNotSent(modified_blocks);
457 catch (VersionMismatchException &e) {
458 std::ostringstream err;
459 err << "World data version mismatch 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 << "World probably saved by a newer version of Minetest."<<std::endl;
464 m_server->setAsyncFatalError(err.str());
466 catch (SerializationError &e) {
467 std::ostringstream err;
468 err << "Invalid data in MapBlock "<<PP(last_tried_pos)<<std::endl;
469 err << "----"<<std::endl;
470 err << "\""<<e.what()<<"\""<<std::endl;
471 err << "See debug.txt."<<std::endl;
472 err << "You can ignore this using [ignore_world_load_errors = true]."<<std::endl;
473 m_server->setAsyncFatalError(err.str());
476 END_DEBUG_EXCEPTION_HANDLER(errorstream)
477 log_deregister_thread();