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"
36 #include "scriptapi.h"
42 #include "mapgen_v6.h"
43 #include "mapgen_v7.h"
44 #include "mapgen_indev.h"
45 #include "mapgen_singlenode.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());
57 this->ndef = gamedef->getNodeDefManager();
58 this->biomedef = new BiomeDefManager();
61 mapgen_debug_info = g_settings->getBool("enable_mapgen_debug_info");
66 if (g_settings->get("num_emerge_threads").empty()) {
67 int nprocs = porting::getNumberOfProcessors();
68 // leave a proc for the main thread and one for some other misc threads
69 nthreads = (nprocs > 2) ? nprocs - 2 : 1;
71 nthreads = g_settings->getU16("num_emerge_threads");
76 qlimit_total = g_settings->getU16("emergequeue_limit_total");
77 qlimit_diskonly = g_settings->get("emergequeue_limit_diskonly").empty() ?
79 g_settings->getU16("emergequeue_limit_diskonly");
80 qlimit_generate = g_settings->get("emergequeue_limit_generate").empty() ?
82 g_settings->getU16("emergequeue_limit_generate");
84 for (int i = 0; i != nthreads; i++)
85 emergethread.push_back(new EmergeThread((Server *)gamedef, i));
87 infostream << "EmergeManager: using " << nthreads << " threads" << std::endl;
91 EmergeManager::~EmergeManager() {
92 for (unsigned int i = 0; i != emergethread.size(); i++) {
93 emergethread[i]->setRun(false);
94 emergethread[i]->qevent.signal();
95 emergethread[i]->stop();
96 delete emergethread[i];
105 void EmergeManager::initMapgens(MapgenParams *mgparams) {
111 biomedef->resolveNodeNames(ndef);
113 this->params = mgparams;
114 for (unsigned int i = 0; i != emergethread.size(); i++) {
115 mg = createMapgen(params->mg_name, 0, params);
117 infostream << "EmergeManager: falling back to mapgen v6" << std::endl;
119 params = createMapgenParams("v6");
120 mg = createMapgen("v6", 0, params);
122 mapgen.push_back(mg);
127 bool EmergeManager::enqueueBlockEmerge(u16 peer_id, v3s16 p, bool allow_generate) {
128 std::map<v3s16, BlockEmergeData *>::const_iterator iter;
129 BlockEmergeData *bedata;
135 flags |= BLOCK_EMERGE_ALLOWGEN;
138 JMutexAutoLock queuelock(queuemutex);
140 count = blocks_enqueued.size();
141 if (count >= qlimit_total)
144 count = peer_queue_count[peer_id];
145 u16 qlimit_peer = allow_generate ? qlimit_generate : qlimit_diskonly;
146 if (count >= qlimit_peer)
149 iter = blocks_enqueued.find(p);
150 if (iter != blocks_enqueued.end()) {
151 bedata = iter->second;
152 bedata->flags |= flags;
156 bedata = new BlockEmergeData;
157 bedata->flags = flags;
158 bedata->peer_requested = peer_id;
159 blocks_enqueued.insert(std::make_pair(p, bedata));
161 peer_queue_count[peer_id] = count + 1;
163 // insert into the EmergeThread queue with the least items
164 int lowestitems = emergethread[0]->blockqueue.size();
165 for (unsigned int i = 1; i != emergethread.size(); i++) {
166 int nitems = emergethread[i]->blockqueue.size();
167 if (nitems < lowestitems) {
169 lowestitems = nitems;
173 emergethread[idx]->blockqueue.push(p);
175 emergethread[idx]->qevent.signal();
181 int EmergeManager::getGroundLevelAtPoint(v2s16 p) {
182 if (mapgen.size() == 0 || !mapgen[0]) {
183 errorstream << "EmergeManager: getGroundLevelAtPoint() called"
184 " before mapgen initialized" << std::endl;
188 return mapgen[0]->getGroundLevelAtPoint(p);
192 bool EmergeManager::isBlockUnderground(v3s16 blockpos) {
194 v2s16 p = v2s16((blockpos.X * MAP_BLOCKSIZE) + MAP_BLOCKSIZE / 2,
195 (blockpos.Y * MAP_BLOCKSIZE) + MAP_BLOCKSIZE / 2);
196 int ground_level = getGroundLevelAtPoint(p);
197 return blockpos.Y * (MAP_BLOCKSIZE + 1) <= min(water_level, ground_level);
200 //yuck, but then again, should i bother being accurate?
201 //the height of the nodes in a single block is quite variable
202 return blockpos.Y * (MAP_BLOCKSIZE + 1) <= params->water_level;
206 u32 EmergeManager::getBlockSeed(v3s16 p) {
207 return (u32)(params->seed & 0xFFFFFFFF) +
214 Mapgen *EmergeManager::createMapgen(std::string mgname, int mgid,
215 MapgenParams *mgparams) {
216 std::map<std::string, MapgenFactory *>::const_iterator iter;
217 iter = mglist.find(mgname);
218 if (iter == mglist.end()) {
219 errorstream << "EmergeManager; mapgen " << mgname <<
220 " not registered" << std::endl;
224 MapgenFactory *mgfactory = iter->second;
225 return mgfactory->createMapgen(mgid, mgparams, this);
229 MapgenParams *EmergeManager::createMapgenParams(std::string mgname) {
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->createMapgenParams();
243 MapgenParams *EmergeManager::getParamsFromSettings(Settings *settings) {
244 std::string mg_name = settings->get("mg_name");
245 MapgenParams *mgparams = createMapgenParams(mg_name);
247 mgparams->mg_name = mg_name;
248 mgparams->seed = settings->getU64(settings == g_settings ? "fixed_map_seed" : "seed");
249 mgparams->water_level = settings->getS16("water_level");
250 mgparams->chunksize = settings->getS16("chunksize");
251 mgparams->flags = settings->getFlagStr("mg_flags", flagdesc_mapgen);
253 if (!mgparams->readParams(settings)) {
261 void EmergeManager::setParamsToSettings(Settings *settings) {
262 settings->set("mg_name", params->mg_name);
263 settings->setU64("seed", params->seed);
264 settings->setS16("water_level", params->water_level);
265 settings->setS16("chunksize", params->chunksize);
266 settings->setFlagStr("mg_flags", params->flags, flagdesc_mapgen);
268 params->writeParams(settings);
272 void EmergeManager::registerMapgen(std::string mgname, MapgenFactory *mgfactory) {
273 mglist.insert(std::make_pair(mgname, mgfactory));
274 infostream << "EmergeManager: registered mapgen " << mgname << std::endl;
278 ////////////////////////////// Emerge Thread //////////////////////////////////
280 bool EmergeThread::popBlockEmerge(v3s16 *pos, u8 *flags) {
281 std::map<v3s16, BlockEmergeData *>::iterator iter;
282 JMutexAutoLock queuelock(emerge->queuemutex);
284 if (blockqueue.empty())
286 v3s16 p = blockqueue.front();
291 iter = emerge->blocks_enqueued.find(p);
292 if (iter == emerge->blocks_enqueued.end())
293 return false; //uh oh, queue and map out of sync!!
295 BlockEmergeData *bedata = iter->second;
296 *flags = bedata->flags;
298 emerge->peer_queue_count[bedata->peer_requested]--;
301 emerge->blocks_enqueued.erase(iter);
307 bool EmergeThread::getBlockOrStartGen(v3s16 p, MapBlock **b,
308 BlockMakeData *data, bool allow_gen) {
310 //envlock: usually takes <=1ms, sometimes 90ms or ~400ms to acquire
311 JMutexAutoLock envlock(m_server->m_env_mutex);
313 // Load sector if it isn't loaded
314 if (map->getSectorNoGenerateNoEx(p2d) == NULL)
315 map->loadSectorMeta(p2d);
317 // Attempt to load block
318 MapBlock *block = map->getBlockNoCreateNoEx(p);
319 if (!block || block->isDummy() || !block->isGenerated()) {
320 EMERGE_DBG_OUT("not in memory, attempting to load from disk");
321 block = map->loadBlock(p);
324 // If could not load and allowed to generate,
325 // start generation inside this same envlock
326 if (allow_gen && (block == NULL || !block->isGenerated())) {
327 EMERGE_DBG_OUT("generating");
329 return map->initBlockMake(data, p);
337 void *EmergeThread::Thread() {
339 log_register_thread("EmergeThread" + id);
340 DSTACK(__FUNCTION_NAME);
341 BEGIN_DEBUG_EXCEPTION_HANDLER
343 v3s16 last_tried_pos(-32768,-32768,-32768); // For error output
347 map = (ServerMap *)&(m_server->m_env->getMap());
348 emerge = m_server->m_emerge;
349 mapgen = emerge->mapgen[id];
350 enable_mapgen_debug_info = emerge->mapgen_debug_info;
354 if (!popBlockEmerge(&p, &flags)) {
360 if (blockpos_over_limit(p))
363 bool allow_generate = flags & BLOCK_EMERGE_ALLOWGEN;
364 EMERGE_DBG_OUT("p=" PP(p) " allow_generate=" << allow_generate);
367 Try to fetch block from memory or disk.
368 If not found and asked to generate, initialize generator.
371 MapBlock *block = NULL;
372 std::map<v3s16, MapBlock *> modified_blocks;
374 if (getBlockOrStartGen(p, &block, &data, allow_generate)) {
376 ScopeProfiler sp(g_profiler, "EmergeThread: Mapgen::makeChunk", SPT_AVG);
377 TimeTaker t("mapgen::make_block()");
379 mapgen->makeChunk(&data);
381 if (enable_mapgen_debug_info == false)
382 t.stop(true); // Hide output
386 //envlock: usually 0ms, but can take either 30 or 400ms to acquire
387 JMutexAutoLock envlock(m_server->m_env_mutex);
388 ScopeProfiler sp(g_profiler, "EmergeThread: after "
389 "Mapgen::makeChunk (envlock)", SPT_AVG);
391 map->finishBlockMake(&data, modified_blocks);
393 block = map->getBlockNoCreateNoEx(p);
396 Do some post-generate stuff
398 v3s16 minp = data.blockpos_min * MAP_BLOCKSIZE;
399 v3s16 maxp = data.blockpos_max * MAP_BLOCKSIZE +
400 v3s16(1,1,1) * (MAP_BLOCKSIZE - 1);
402 // Ignore map edit events, they will not need to be sent
403 // to anybody because the block hasn't been sent to anybody
404 MapEditEventAreaIgnorer
405 ign(&m_server->m_ignore_map_edit_events_area,
406 VoxelArea(minp, maxp));
407 { // takes about 90ms with -O1 on an e3-1230v2
408 scriptapi_environment_on_generated(m_server->m_lua,
409 minp, maxp, emerge->getBlockSeed(minp));
412 EMERGE_DBG_OUT("ended up with: " << analyze_block(block));
414 m_server->m_env->activateBlock(block, 0);
420 Set sent status of modified blocks on clients
423 // NOTE: Server's clients are also behind the connection mutex
424 //conlock: consistently takes 30-40ms to acquire
425 JMutexAutoLock lock(m_server->m_con_mutex);
426 // Add the originally fetched block to the modified list
428 modified_blocks[p] = block;
430 // Set the modified blocks unsent for all the clients
431 for (std::map<u16, RemoteClient*>::iterator
432 i = m_server->m_clients.begin();
433 i != m_server->m_clients.end(); ++i) {
434 RemoteClient *client = i->second;
435 if (modified_blocks.size() > 0) {
436 // Remove block from sent history
437 client->SetBlocksNotSent(modified_blocks);
441 catch (VersionMismatchException &e) {
442 std::ostringstream err;
443 err << "World data version mismatch in MapBlock "<<PP(last_tried_pos)<<std::endl;
444 err << "----"<<std::endl;
445 err << "\""<<e.what()<<"\""<<std::endl;
446 err << "See debug.txt."<<std::endl;
447 err << "World probably saved by a newer version of Minetest."<<std::endl;
448 m_server->setAsyncFatalError(err.str());
450 catch (SerializationError &e) {
451 std::ostringstream err;
452 err << "Invalid data in MapBlock "<<PP(last_tried_pos)<<std::endl;
453 err << "----"<<std::endl;
454 err << "\""<<e.what()<<"\""<<std::endl;
455 err << "See debug.txt."<<std::endl;
456 err << "You can ignore this using [ignore_world_load_errors = true]."<<std::endl;
457 m_server->setAsyncFatalError(err.str());
460 END_DEBUG_EXCEPTION_HANDLER(errorstream)
461 log_deregister_thread();