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"
45 #include "mapgen_math.h"
48 /////////////////////////////// Emerge Manager ////////////////////////////////
50 EmergeManager::EmergeManager(IGameDef *gamedef) {
51 //register built-in mapgens
52 registerMapgen("v6", new MapgenFactoryV6());
53 registerMapgen("v7", new MapgenFactoryV7());
54 registerMapgen("indev", new MapgenFactoryIndev());
55 registerMapgen("singlenode", new MapgenFactorySinglenode());
56 registerMapgen("math", new MapgenFactoryMath());
58 this->ndef = gamedef->getNodeDefManager();
59 this->biomedef = new BiomeDefManager();
62 mapgen_debug_info = g_settings->getBool("enable_mapgen_debug_info");
67 if (g_settings->get("num_emerge_threads").empty()) {
68 int nprocs = porting::getNumberOfProcessors();
69 // leave a proc for the main thread and one for some other misc threads
70 nthreads = (nprocs > 2) ? nprocs - 2 : 1;
72 nthreads = g_settings->getU16("num_emerge_threads");
77 qlimit_total = g_settings->getU16("emergequeue_limit_total");
78 qlimit_diskonly = g_settings->get("emergequeue_limit_diskonly").empty() ?
80 g_settings->getU16("emergequeue_limit_diskonly");
81 qlimit_generate = g_settings->get("emergequeue_limit_generate").empty() ?
83 g_settings->getU16("emergequeue_limit_generate");
85 for (int i = 0; i != nthreads; i++)
86 emergethread.push_back(new EmergeThread((Server *)gamedef, i));
88 infostream << "EmergeManager: using " << nthreads << " threads" << std::endl;
92 EmergeManager::~EmergeManager() {
93 for (unsigned int i = 0; i != emergethread.size(); i++) {
94 emergethread[i]->setRun(false);
95 emergethread[i]->qevent.signal();
96 emergethread[i]->stop();
97 delete emergethread[i];
100 emergethread.clear();
103 for (unsigned int i = 0; i < ores.size(); i++)
107 for (unsigned int i = 0; i < decorations.size(); i++)
108 delete decorations[i];
111 for (std::map<std::string, MapgenFactory *>::iterator iter = mglist.begin();
112 iter != mglist.end(); iter ++) {
121 void EmergeManager::initMapgens(MapgenParams *mgparams) {
127 biomedef->resolveNodeNames(ndef);
128 for (size_t i = 0; i != ores.size(); i++)
129 ores[i]->resolveNodeNames(ndef);
130 for (size_t i = 0; i != decorations.size(); i++)
131 decorations[i]->resolveNodeNames(ndef);
133 this->params = mgparams;
134 for (size_t i = 0; i != emergethread.size(); i++) {
135 mg = createMapgen(params->mg_name, 0, params);
137 infostream << "EmergeManager: falling back to mapgen v6" << std::endl;
139 params = createMapgenParams("v6");
140 mg = createMapgen("v6", 0, params);
142 mapgen.push_back(mg);
147 bool EmergeManager::enqueueBlockEmerge(u16 peer_id, v3s16 p, bool allow_generate) {
148 std::map<v3s16, BlockEmergeData *>::const_iterator iter;
149 BlockEmergeData *bedata;
155 flags |= BLOCK_EMERGE_ALLOWGEN;
158 JMutexAutoLock queuelock(queuemutex);
160 count = blocks_enqueued.size();
161 if (count >= qlimit_total)
164 count = peer_queue_count[peer_id];
165 u16 qlimit_peer = allow_generate ? qlimit_generate : qlimit_diskonly;
166 if (count >= qlimit_peer)
169 iter = blocks_enqueued.find(p);
170 if (iter != blocks_enqueued.end()) {
171 bedata = iter->second;
172 bedata->flags |= flags;
176 bedata = new BlockEmergeData;
177 bedata->flags = flags;
178 bedata->peer_requested = peer_id;
179 blocks_enqueued.insert(std::make_pair(p, bedata));
181 peer_queue_count[peer_id] = count + 1;
183 // insert into the EmergeThread queue with the least items
184 int lowestitems = emergethread[0]->blockqueue.size();
185 for (unsigned int i = 1; i != emergethread.size(); i++) {
186 int nitems = emergethread[i]->blockqueue.size();
187 if (nitems < lowestitems) {
189 lowestitems = nitems;
193 emergethread[idx]->blockqueue.push(p);
195 emergethread[idx]->qevent.signal();
201 int EmergeManager::getGroundLevelAtPoint(v2s16 p) {
202 if (mapgen.size() == 0 || !mapgen[0]) {
203 errorstream << "EmergeManager: getGroundLevelAtPoint() called"
204 " before mapgen initialized" << std::endl;
208 return mapgen[0]->getGroundLevelAtPoint(p);
212 bool EmergeManager::isBlockUnderground(v3s16 blockpos) {
214 v2s16 p = v2s16((blockpos.X * MAP_BLOCKSIZE) + MAP_BLOCKSIZE / 2,
215 (blockpos.Y * MAP_BLOCKSIZE) + MAP_BLOCKSIZE / 2);
216 int ground_level = getGroundLevelAtPoint(p);
217 return blockpos.Y * (MAP_BLOCKSIZE + 1) <= min(water_level, ground_level);
220 //yuck, but then again, should i bother being accurate?
221 //the height of the nodes in a single block is quite variable
222 return blockpos.Y * (MAP_BLOCKSIZE + 1) <= params->water_level;
226 u32 EmergeManager::getBlockSeed(v3s16 p) {
227 return (u32)(params->seed & 0xFFFFFFFF) +
234 Mapgen *EmergeManager::createMapgen(std::string mgname, int mgid,
235 MapgenParams *mgparams) {
236 std::map<std::string, MapgenFactory *>::const_iterator iter;
237 iter = mglist.find(mgname);
238 if (iter == mglist.end()) {
239 errorstream << "EmergeManager; mapgen " << mgname <<
240 " not registered" << std::endl;
244 MapgenFactory *mgfactory = iter->second;
245 return mgfactory->createMapgen(mgid, mgparams, this);
249 MapgenParams *EmergeManager::createMapgenParams(std::string mgname) {
250 std::map<std::string, MapgenFactory *>::const_iterator iter;
251 iter = mglist.find(mgname);
252 if (iter == mglist.end()) {
253 errorstream << "EmergeManager: mapgen " << mgname <<
254 " not registered" << std::endl;
258 MapgenFactory *mgfactory = iter->second;
259 return mgfactory->createMapgenParams();
263 MapgenParams *EmergeManager::getParamsFromSettings(Settings *settings) {
264 std::string mg_name = settings->get("mg_name");
265 MapgenParams *mgparams = createMapgenParams(mg_name);
269 mgparams->mg_name = mg_name;
270 mgparams->seed = settings->getU64(settings == g_settings ? "fixed_map_seed" : "seed");
271 mgparams->water_level = settings->getS16("water_level");
272 mgparams->chunksize = settings->getS16("chunksize");
273 mgparams->flags = settings->getFlagStr("mg_flags", flagdesc_mapgen);
275 if (!mgparams->readParams(settings)) {
283 void EmergeManager::setParamsToSettings(Settings *settings) {
284 settings->set("mg_name", params->mg_name);
285 settings->setU64("seed", params->seed);
286 settings->setS16("water_level", params->water_level);
287 settings->setS16("chunksize", params->chunksize);
288 settings->setFlagStr("mg_flags", params->flags, flagdesc_mapgen);
290 params->writeParams(settings);
294 void EmergeManager::registerMapgen(std::string mgname, MapgenFactory *mgfactory) {
295 mglist.insert(std::make_pair(mgname, mgfactory));
296 infostream << "EmergeManager: registered mapgen " << mgname << std::endl;
300 ////////////////////////////// Emerge Thread //////////////////////////////////
302 bool EmergeThread::popBlockEmerge(v3s16 *pos, u8 *flags) {
303 std::map<v3s16, BlockEmergeData *>::iterator iter;
304 JMutexAutoLock queuelock(emerge->queuemutex);
306 if (blockqueue.empty())
308 v3s16 p = blockqueue.front();
313 iter = emerge->blocks_enqueued.find(p);
314 if (iter == emerge->blocks_enqueued.end())
315 return false; //uh oh, queue and map out of sync!!
317 BlockEmergeData *bedata = iter->second;
318 *flags = bedata->flags;
320 emerge->peer_queue_count[bedata->peer_requested]--;
323 emerge->blocks_enqueued.erase(iter);
329 bool EmergeThread::getBlockOrStartGen(v3s16 p, MapBlock **b,
330 BlockMakeData *data, bool allow_gen) {
332 //envlock: usually takes <=1ms, sometimes 90ms or ~400ms to acquire
333 JMutexAutoLock envlock(m_server->m_env_mutex);
335 // Load sector if it isn't loaded
336 if (map->getSectorNoGenerateNoEx(p2d) == NULL)
337 map->loadSectorMeta(p2d);
339 // Attempt to load block
340 MapBlock *block = map->getBlockNoCreateNoEx(p);
341 if (!block || block->isDummy() || !block->isGenerated()) {
342 EMERGE_DBG_OUT("not in memory, attempting to load from disk");
343 block = map->loadBlock(p);
346 // If could not load and allowed to generate,
347 // start generation inside this same envlock
348 if (allow_gen && (block == NULL || !block->isGenerated())) {
349 EMERGE_DBG_OUT("generating");
351 return map->initBlockMake(data, p);
359 void *EmergeThread::Thread() {
361 log_register_thread("EmergeThread" + itos(id));
362 DSTACK(__FUNCTION_NAME);
363 BEGIN_DEBUG_EXCEPTION_HANDLER
365 v3s16 last_tried_pos(-32768,-32768,-32768); // For error output
369 map = (ServerMap *)&(m_server->m_env->getMap());
370 emerge = m_server->m_emerge;
371 mapgen = emerge->mapgen[id];
372 enable_mapgen_debug_info = emerge->mapgen_debug_info;
376 if (!popBlockEmerge(&p, &flags)) {
382 if (blockpos_over_limit(p))
385 bool allow_generate = flags & BLOCK_EMERGE_ALLOWGEN;
386 EMERGE_DBG_OUT("p=" PP(p) " allow_generate=" << allow_generate);
389 Try to fetch block from memory or disk.
390 If not found and asked to generate, initialize generator.
393 MapBlock *block = NULL;
394 std::map<v3s16, MapBlock *> modified_blocks;
396 if (getBlockOrStartGen(p, &block, &data, allow_generate)) {
398 ScopeProfiler sp(g_profiler, "EmergeThread: Mapgen::makeChunk", SPT_AVG);
399 TimeTaker t("mapgen::make_block()");
401 mapgen->makeChunk(&data);
403 if (enable_mapgen_debug_info == false)
404 t.stop(true); // Hide output
408 //envlock: usually 0ms, but can take either 30 or 400ms to acquire
409 JMutexAutoLock envlock(m_server->m_env_mutex);
410 ScopeProfiler sp(g_profiler, "EmergeThread: after "
411 "Mapgen::makeChunk (envlock)", SPT_AVG);
413 map->finishBlockMake(&data, modified_blocks);
415 block = map->getBlockNoCreateNoEx(p);
418 Do some post-generate stuff
420 v3s16 minp = data.blockpos_min * MAP_BLOCKSIZE;
421 v3s16 maxp = data.blockpos_max * MAP_BLOCKSIZE +
422 v3s16(1,1,1) * (MAP_BLOCKSIZE - 1);
424 // Ignore map edit events, they will not need to be sent
425 // to anybody because the block hasn't been sent to anybody
426 MapEditEventAreaIgnorer
427 ign(&m_server->m_ignore_map_edit_events_area,
428 VoxelArea(minp, maxp));
429 { // takes about 90ms with -O1 on an e3-1230v2
430 SERVER_TO_SA(m_server)->environment_OnGenerated(
431 minp, maxp, emerge->getBlockSeed(minp));
434 EMERGE_DBG_OUT("ended up with: " << analyze_block(block));
436 m_server->m_env->activateBlock(block, 0);
442 Set sent status of modified blocks on clients
445 // NOTE: Server's clients are also behind the connection mutex
446 //conlock: consistently takes 30-40ms to acquire
447 JMutexAutoLock lock(m_server->m_con_mutex);
448 // Add the originally fetched block to the modified list
450 modified_blocks[p] = block;
452 // Set the modified blocks unsent for all the clients
453 for (std::map<u16, RemoteClient*>::iterator
454 i = m_server->m_clients.begin();
455 i != m_server->m_clients.end(); ++i) {
456 RemoteClient *client = i->second;
457 if (modified_blocks.size() > 0) {
458 // Remove block from sent history
459 client->SetBlocksNotSent(modified_blocks);
463 catch (VersionMismatchException &e) {
464 std::ostringstream err;
465 err << "World data version mismatch in MapBlock "<<PP(last_tried_pos)<<std::endl;
466 err << "----"<<std::endl;
467 err << "\""<<e.what()<<"\""<<std::endl;
468 err << "See debug.txt."<<std::endl;
469 err << "World probably saved by a newer version of Minetest."<<std::endl;
470 m_server->setAsyncFatalError(err.str());
472 catch (SerializationError &e) {
473 std::ostringstream err;
474 err << "Invalid data 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 << "You can ignore this using [ignore_world_load_errors = true]."<<std::endl;
479 m_server->setAsyncFatalError(err.str());
482 END_DEBUG_EXCEPTION_HANDLER(errorstream)
483 log_deregister_thread();