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"
42 #include "mapgen_indev.h"
43 #include "mapgen_singlenode.h"
46 /////////////////////////////// Emerge Manager ////////////////////////////////
48 EmergeManager::EmergeManager(IGameDef *gamedef, BiomeDefManager *bdef) {
49 //register built-in mapgens
50 registerMapgen("v6", new MapgenFactoryV6());
51 registerMapgen("indev", new MapgenFactoryIndev());
52 registerMapgen("singlenode", new MapgenFactorySinglenode());
54 this->biomedef = bdef ? bdef : new BiomeDefManager(gamedef);
57 mapgen_debug_info = g_settings->getBool("enable_mapgen_debug_info");
62 if (g_settings->get("num_emerge_threads").empty()) {
63 int nprocs = porting::getNumberOfProcessors();
64 // leave a proc for the main thread and one for some other misc threads
65 nthreads = (nprocs > 2) ? nprocs - 2 : 1;
67 nthreads = g_settings->getU16("num_emerge_threads");
72 qlimit_total = g_settings->getU16("emergequeue_limit_total");
73 qlimit_diskonly = g_settings->get("emergequeue_limit_diskonly").empty() ?
75 g_settings->getU16("emergequeue_limit_diskonly");
76 qlimit_generate = g_settings->get("emergequeue_limit_generate").empty() ?
78 g_settings->getU16("emergequeue_limit_generate");
80 for (int i = 0; i != nthreads; i++)
81 emergethread.push_back(new EmergeThread((Server *)gamedef, i));
83 infostream << "EmergeManager: using " << nthreads << " threads" << std::endl;
87 EmergeManager::~EmergeManager() {
88 for (unsigned int i = 0; i != emergethread.size(); i++) {
89 emergethread[i]->setRun(false);
90 emergethread[i]->qevent.signal();
91 emergethread[i]->stop();
92 delete emergethread[i];
101 void EmergeManager::initMapgens(MapgenParams *mgparams) {
107 this->params = mgparams;
108 for (unsigned int i = 0; i != emergethread.size(); i++) {
109 mg = createMapgen(params->mg_name, 0, params);
111 infostream << "EmergeManager: falling back to mapgen v6" << std::endl;
113 params = createMapgenParams("v6");
114 mg = createMapgen("v6", 0, params);
116 mapgen.push_back(mg);
121 bool EmergeManager::enqueueBlockEmerge(u16 peer_id, v3s16 p, bool allow_generate) {
122 std::map<v3s16, BlockEmergeData *>::const_iterator iter;
123 BlockEmergeData *bedata;
129 flags |= BLOCK_EMERGE_ALLOWGEN;
132 JMutexAutoLock queuelock(queuemutex);
134 count = blocks_enqueued.size();
135 if (count >= qlimit_total)
138 count = peer_queue_count[peer_id];
139 u16 qlimit_peer = allow_generate ? qlimit_generate : qlimit_diskonly;
140 if (count >= qlimit_peer)
143 iter = blocks_enqueued.find(p);
144 if (iter != blocks_enqueued.end()) {
145 bedata = iter->second;
146 bedata->flags |= flags;
150 bedata = new BlockEmergeData;
151 bedata->flags = flags;
152 bedata->peer_requested = peer_id;
153 blocks_enqueued.insert(std::make_pair(p, bedata));
155 peer_queue_count[peer_id] = count + 1;
157 // insert into the EmergeThread queue with the least items
158 int lowestitems = emergethread[0]->blockqueue.size();
159 for (unsigned int i = 1; i != emergethread.size(); i++) {
160 int nitems = emergethread[i]->blockqueue.size();
161 if (nitems < lowestitems) {
163 lowestitems = nitems;
167 emergethread[idx]->blockqueue.push(p);
169 emergethread[idx]->qevent.signal();
175 int EmergeManager::getGroundLevelAtPoint(v2s16 p) {
176 if (mapgen.size() == 0 || !mapgen[0]) {
177 errorstream << "EmergeManager: getGroundLevelAtPoint() called"
178 " before mapgen initialized" << std::endl;
182 return mapgen[0]->getGroundLevelAtPoint(p);
186 bool EmergeManager::isBlockUnderground(v3s16 blockpos) {
188 v2s16 p = v2s16((blockpos.X * MAP_BLOCKSIZE) + MAP_BLOCKSIZE / 2,
189 (blockpos.Y * MAP_BLOCKSIZE) + MAP_BLOCKSIZE / 2);
190 int ground_level = getGroundLevelAtPoint(p);
191 return blockpos.Y * (MAP_BLOCKSIZE + 1) <= min(water_level, ground_level);
194 //yuck, but then again, should i bother being accurate?
195 //the height of the nodes in a single block is quite variable
196 return blockpos.Y * (MAP_BLOCKSIZE + 1) <= params->water_level;
200 u32 EmergeManager::getBlockSeed(v3s16 p) {
201 return (u32)(params->seed & 0xFFFFFFFF) +
208 Mapgen *EmergeManager::createMapgen(std::string mgname, int mgid,
209 MapgenParams *mgparams) {
210 std::map<std::string, MapgenFactory *>::const_iterator iter;
211 iter = mglist.find(mgname);
212 if (iter == mglist.end()) {
213 errorstream << "EmergeManager; mapgen " << mgname <<
214 " not registered" << std::endl;
218 MapgenFactory *mgfactory = iter->second;
219 return mgfactory->createMapgen(mgid, mgparams, this);
223 MapgenParams *EmergeManager::createMapgenParams(std::string mgname) {
224 std::map<std::string, MapgenFactory *>::const_iterator iter;
225 iter = mglist.find(mgname);
226 if (iter == mglist.end()) {
227 errorstream << "EmergeManager: mapgen " << mgname <<
228 " not registered" << std::endl;
232 MapgenFactory *mgfactory = iter->second;
233 return mgfactory->createMapgenParams();
237 MapgenParams *EmergeManager::getParamsFromSettings(Settings *settings) {
238 std::string mg_name = settings->get("mg_name");
239 MapgenParams *mgparams = createMapgenParams(mg_name);
241 mgparams->mg_name = mg_name;
242 mgparams->seed = settings->getU64(settings == g_settings ? "fixed_map_seed" : "seed");
243 mgparams->water_level = settings->getS16("water_level");
244 mgparams->chunksize = settings->getS16("chunksize");
245 mgparams->flags = settings->getFlagStr("mg_flags", flagdesc_mapgen);
247 if (!mgparams->readParams(settings)) {
255 void EmergeManager::setParamsToSettings(Settings *settings) {
256 settings->set("mg_name", params->mg_name);
257 settings->setU64("seed", params->seed);
258 settings->setS16("water_level", params->water_level);
259 settings->setS16("chunksize", params->chunksize);
260 settings->setFlagStr("mg_flags", params->flags, flagdesc_mapgen);
262 params->writeParams(settings);
266 void EmergeManager::registerMapgen(std::string mgname, MapgenFactory *mgfactory) {
267 mglist.insert(std::make_pair(mgname, mgfactory));
268 infostream << "EmergeManager: registered mapgen " << mgname << std::endl;
272 ////////////////////////////// Emerge Thread //////////////////////////////////
274 bool EmergeThread::popBlockEmerge(v3s16 *pos, u8 *flags) {
275 std::map<v3s16, BlockEmergeData *>::iterator iter;
276 JMutexAutoLock queuelock(emerge->queuemutex);
278 if (blockqueue.empty())
280 v3s16 p = blockqueue.front();
285 iter = emerge->blocks_enqueued.find(p);
286 if (iter == emerge->blocks_enqueued.end())
287 return false; //uh oh, queue and map out of sync!!
289 BlockEmergeData *bedata = iter->second;
290 *flags = bedata->flags;
292 emerge->peer_queue_count[bedata->peer_requested]--;
295 emerge->blocks_enqueued.erase(iter);
301 bool EmergeThread::getBlockOrStartGen(v3s16 p, MapBlock **b,
302 BlockMakeData *data, bool allow_gen) {
304 //envlock: usually takes <=1ms, sometimes 90ms or ~400ms to acquire
305 JMutexAutoLock envlock(m_server->m_env_mutex);
307 // Load sector if it isn't loaded
308 if (map->getSectorNoGenerateNoEx(p2d) == NULL)
309 map->loadSectorMeta(p2d);
311 // Attempt to load block
312 MapBlock *block = map->getBlockNoCreateNoEx(p);
313 if (!block || block->isDummy() || !block->isGenerated()) {
314 EMERGE_DBG_OUT("not in memory, attempting to load from disk");
315 block = map->loadBlock(p);
318 // If could not load and allowed to generate,
319 // start generation inside this same envlock
320 if (allow_gen && (block == NULL || !block->isGenerated())) {
321 EMERGE_DBG_OUT("generating");
323 return map->initBlockMake(data, p);
331 void *EmergeThread::Thread() {
333 log_register_thread("EmergeThread" + id);
334 DSTACK(__FUNCTION_NAME);
335 BEGIN_DEBUG_EXCEPTION_HANDLER
337 v3s16 last_tried_pos(-32768,-32768,-32768); // For error output
341 map = (ServerMap *)&(m_server->m_env->getMap());
342 emerge = m_server->m_emerge;
343 mapgen = emerge->mapgen[id];
344 enable_mapgen_debug_info = emerge->mapgen_debug_info;
348 if (!popBlockEmerge(&p, &flags)) {
354 if (blockpos_over_limit(p))
357 bool allow_generate = flags & BLOCK_EMERGE_ALLOWGEN;
358 EMERGE_DBG_OUT("p=" PP(p) " allow_generate=" << allow_generate);
361 Try to fetch block from memory or disk.
362 If not found and asked to generate, initialize generator.
365 MapBlock *block = NULL;
366 std::map<v3s16, MapBlock *> modified_blocks;
368 if (getBlockOrStartGen(p, &block, &data, allow_generate)) {
370 ScopeProfiler sp(g_profiler, "EmergeThread: Mapgen::makeChunk", SPT_AVG);
371 TimeTaker t("mapgen::make_block()");
373 mapgen->makeChunk(&data);
375 if (enable_mapgen_debug_info == false)
376 t.stop(true); // Hide output
380 //envlock: usually 0ms, but can take either 30 or 400ms to acquire
381 JMutexAutoLock envlock(m_server->m_env_mutex);
382 ScopeProfiler sp(g_profiler, "EmergeThread: after "
383 "Mapgen::makeChunk (envlock)", SPT_AVG);
385 map->finishBlockMake(&data, modified_blocks);
387 block = map->getBlockNoCreateNoEx(p);
390 Do some post-generate stuff
392 v3s16 minp = data.blockpos_min * MAP_BLOCKSIZE;
393 v3s16 maxp = data.blockpos_max * MAP_BLOCKSIZE +
394 v3s16(1,1,1) * (MAP_BLOCKSIZE - 1);
396 // Ignore map edit events, they will not need to be sent
397 // to anybody because the block hasn't been sent to anybody
398 MapEditEventAreaIgnorer
399 ign(&m_server->m_ignore_map_edit_events_area,
400 VoxelArea(minp, maxp));
401 { // takes about 90ms with -O1 on an e3-1230v2
402 scriptapi_environment_on_generated(m_server->m_lua,
403 minp, maxp, emerge->getBlockSeed(minp));
406 EMERGE_DBG_OUT("ended up with: " << analyze_block(block));
408 m_server->m_env->activateBlock(block, 0);
414 Set sent status of modified blocks on clients
417 // NOTE: Server's clients are also behind the connection mutex
418 //conlock: consistently takes 30-40ms to acquire
419 JMutexAutoLock lock(m_server->m_con_mutex);
420 // Add the originally fetched block to the modified list
422 modified_blocks[p] = block;
424 // Set the modified blocks unsent for all the clients
425 for (std::map<u16, RemoteClient*>::iterator
426 i = m_server->m_clients.begin();
427 i != m_server->m_clients.end(); ++i) {
428 RemoteClient *client = i->second;
429 if (modified_blocks.size() > 0) {
430 // Remove block from sent history
431 client->SetBlocksNotSent(modified_blocks);
435 catch (VersionMismatchException &e) {
436 std::ostringstream err;
437 err << "World data version mismatch in MapBlock "<<PP(last_tried_pos)<<std::endl;
438 err << "----"<<std::endl;
439 err << "\""<<e.what()<<"\""<<std::endl;
440 err << "See debug.txt."<<std::endl;
441 err << "World probably saved by a newer version of Minetest."<<std::endl;
442 m_server->setAsyncFatalError(err.str());
444 catch (SerializationError &e) {
445 std::ostringstream err;
446 err << "Invalid data in MapBlock "<<PP(last_tried_pos)<<std::endl;
447 err << "----"<<std::endl;
448 err << "\""<<e.what()<<"\""<<std::endl;
449 err << "See debug.txt."<<std::endl;
450 err << "You can ignore this using [ignore_world_load_errors = true]."<<std::endl;
451 m_server->setAsyncFatalError(err.str());
454 END_DEBUG_EXCEPTION_HANDLER(errorstream)
455 log_deregister_thread();