src/emerge.cpp

   1 /*
   2 Minetest
   3 Copyright (C) 2010-2013 celeron55, Perttu Ahola <celeron55@gmail.com>
   4 Copyright (C) 2010-2013 kwolekr, Ryan Kwolek <kwolekr@minetest.net>
   5
   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.
  10
  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.
  15
  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.
  19 */
  20
  21
  22 #include "server.h"
  23 #include <iostream>
  24 #include <queue>
  25 #include "clientserver.h"
  26 #include "map.h"
  27 #include "jmutexautolock.h"
  28 #include "main.h"
  29 #include "constants.h"
  30 #include "voxel.h"
  31 #include "config.h"
  32 #include "mapblock.h"
  33 #include "serverobject.h"
  34 #include "settings.h"
  35 #include "cpp_api/scriptapi.h"
  36 #include "profiler.h"
  37 #include "log.h"
  38 #include "nodedef.h"
  39 #include "biome.h"
  40 #include "emerge.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"
  46
  47
  48 /////////////////////////////// Emerge Manager ////////////////////////////////
  49
  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());
  57
  58         this->ndef     = gamedef->getNodeDefManager();
  59         this->biomedef = new BiomeDefManager();
  60         this->params   = NULL;
  61
  62         this->luaoverride_params          = NULL;
  63         this->luaoverride_params_modified = 0;
  64         this->luaoverride_flagmask        = 0;
  65
  66         mapgen_debug_info = g_settings->getBool("enable_mapgen_debug_info");
  67
  68         queuemutex.Init();
  69
  70         int nthreads;
  71         if (g_settings->get("num_emerge_threads").empty()) {
  72                 int nprocs = porting::getNumberOfProcessors();
  73                 // leave a proc for the main thread and one for some other misc threads
  74                 nthreads = (nprocs > 2) ? nprocs - 2 : 1;
  75         } else {
  76                 nthreads = g_settings->getU16("num_emerge_threads");
  77         }
  78         if (nthreads < 1)
  79                 nthreads = 1;
  80
  81         qlimit_total    = g_settings->getU16("emergequeue_limit_total");
  82         qlimit_diskonly = g_settings->get("emergequeue_limit_diskonly").empty() ?
  83                 nthreads * 5 + 1 :
  84                 g_settings->getU16("emergequeue_limit_diskonly");
  85         qlimit_generate = g_settings->get("emergequeue_limit_generate").empty() ?
  86                 nthreads + 1 :
  87                 g_settings->getU16("emergequeue_limit_generate");
  88
  89         for (int i = 0; i != nthreads; i++)
  90                 emergethread.push_back(new EmergeThread((Server *)gamedef, i));
  91
  92         infostream << "EmergeManager: using " << nthreads << " threads" << std::endl;
  93 }
  94
  95
  96 EmergeManager::~EmergeManager() {
  97         for (unsigned int i = 0; i != emergethread.size(); i++) {
  98                 emergethread[i]->setRun(false);
  99                 emergethread[i]->qevent.signal();
 100                 emergethread[i]->stop();
 101                 delete emergethread[i];
 102                 delete mapgen[i];
 103         }
 104         emergethread.clear();
 105         mapgen.clear();
 106
 107         for (unsigned int i = 0; i < ores.size(); i++)
 108                 delete ores[i];
 109         ores.clear();
 110
 111         for (unsigned int i = 0; i < decorations.size(); i++)
 112                 delete decorations[i];
 113         decorations.clear();
 114
 115         for (std::map<std::string, MapgenFactory *>::iterator iter = mglist.begin();
 116                         iter != mglist.end(); iter ++) {
 117                 delete iter->second;
 118         }
 119         mglist.clear();
 120
 121         delete biomedef;
 122 }
 123
 124
 125 void EmergeManager::initMapgens(MapgenParams *mgparams) {
 126         Mapgen *mg;
 127
 128         if (mapgen.size())
 129                 return;
 130
 131         // Resolve names of nodes for things that were registered
 132         // (at this point, the registration period is over)
 133         biomedef->resolveNodeNames(ndef);
 134
 135         for (size_t i = 0; i != ores.size(); i++)
 136                 ores[i]->resolveNodeNames(ndef);
 137
 138         for (size_t i = 0; i != decorations.size(); i++)
 139                 decorations[i]->resolveNodeNames(ndef);
 140
 141         // Apply mapgen parameter overrides from Lua
 142         if (luaoverride_params) {
 143                 if (luaoverride_params_modified & MGPARAMS_SET_MGNAME)
 144                         mgparams->mg_name = luaoverride_params->mg_name;
 145
 146                 if (luaoverride_params_modified & MGPARAMS_SET_SEED)
 147                         mgparams->seed = luaoverride_params->seed;
 148
 149                 if (luaoverride_params_modified & MGPARAMS_SET_WATER_LEVEL)
 150                         mgparams->water_level = luaoverride_params->water_level;
 151
 152                 if (luaoverride_params_modified & MGPARAMS_SET_FLAGS) {
 153                         mgparams->flags &= ~luaoverride_flagmask;
 154                         mgparams->flags |= luaoverride_params->flags;
 155                 }
 156
 157                 delete luaoverride_params;
 158                 luaoverride_params = NULL;
 159         }
 160
 161         // Create the mapgens
 162         this->params = mgparams;
 163         for (size_t i = 0; i != emergethread.size(); i++) {
 164                 mg = createMapgen(params->mg_name, 0, params);
 165                 if (!mg) {
 166                         infostream << "EmergeManager: falling back to mapgen v6" << std::endl;
 167                         delete params;
 168                         params = createMapgenParams("v6");
 169                         mg = createMapgen("v6", 0, params);
 170                 }
 171                 mapgen.push_back(mg);
 172         }
 173 }
 174
 175
 176 Mapgen *EmergeManager::getCurrentMapgen() {
 177         for (unsigned int i = 0; i != emergethread.size(); i++) {
 178                 if (emergethread[i]->IsSameThread())
 179                         return emergethread[i]->mapgen;
 180         }
 181
 182         return NULL;
 183 }
 184
 185
 186 bool EmergeManager::enqueueBlockEmerge(u16 peer_id, v3s16 p, bool allow_generate) {
 187         std::map<v3s16, BlockEmergeData *>::const_iterator iter;
 188         BlockEmergeData *bedata;
 189         u16 count;
 190         u8 flags = 0;
 191         int idx = 0;
 192
 193         if (allow_generate)
 194                 flags |= BLOCK_EMERGE_ALLOWGEN;
 195
 196         {
 197                 JMutexAutoLock queuelock(queuemutex);
 198
 199                 count = blocks_enqueued.size();
 200                 if (count >= qlimit_total)
 201                         return false;
 202
 203                 count = peer_queue_count[peer_id];
 204                 u16 qlimit_peer = allow_generate ? qlimit_generate : qlimit_diskonly;
 205                 if (count >= qlimit_peer)
 206                         return false;
 207
 208                 iter = blocks_enqueued.find(p);
 209                 if (iter != blocks_enqueued.end()) {
 210                         bedata = iter->second;
 211                         bedata->flags |= flags;
 212                         return true;
 213                 }
 214
 215                 bedata = new BlockEmergeData;
 216                 bedata->flags = flags;
 217                 bedata->peer_requested = peer_id;
 218                 blocks_enqueued.insert(std::make_pair(p, bedata));
 219
 220                 peer_queue_count[peer_id] = count + 1;
 221
 222                 // insert into the EmergeThread queue with the least items
 223                 int lowestitems = emergethread[0]->blockqueue.size();
 224                 for (unsigned int i = 1; i != emergethread.size(); i++) {
 225                         int nitems = emergethread[i]->blockqueue.size();
 226                         if (nitems < lowestitems) {
 227                                 idx = i;
 228                                 lowestitems = nitems;
 229                         }
 230                 }
 231
 232                 emergethread[idx]->blockqueue.push(p);
 233         }
 234         emergethread[idx]->qevent.signal();
 235
 236         return true;
 237 }
 238
 239
 240 int EmergeManager::getGroundLevelAtPoint(v2s16 p) {
 241         if (mapgen.size() == 0 || !mapgen[0]) {
 242                 errorstream << "EmergeManager: getGroundLevelAtPoint() called"
 243                 " before mapgen initialized" << std::endl;
 244                 return 0;
 245         }
 246
 247         return mapgen[0]->getGroundLevelAtPoint(p);
 248 }
 249
 250
 251 bool EmergeManager::isBlockUnderground(v3s16 blockpos) {
 252         /*
 253         v2s16 p = v2s16((blockpos.X * MAP_BLOCKSIZE) + MAP_BLOCKSIZE / 2,
 254                                         (blockpos.Y * MAP_BLOCKSIZE) + MAP_BLOCKSIZE / 2);
 255         int ground_level = getGroundLevelAtPoint(p);
 256         return blockpos.Y * (MAP_BLOCKSIZE + 1) <= min(water_level, ground_level);
 257         */
 258
 259         //yuck, but then again, should i bother being accurate?
 260         //the height of the nodes in a single block is quite variable
 261         return blockpos.Y * (MAP_BLOCKSIZE + 1) <= params->water_level;
 262 }
 263
 264
 265 u32 EmergeManager::getBlockSeed(v3s16 p) {
 266         return (u32)(params->seed & 0xFFFFFFFF) +
 267                 p.Z * 38134234 +
 268                 p.Y * 42123 +
 269                 p.X * 23;
 270 }
 271
 272
 273 Mapgen *EmergeManager::createMapgen(std::string mgname, int mgid,
 274                                                                          MapgenParams *mgparams) {
 275         std::map<std::string, MapgenFactory *>::const_iterator iter;
 276         iter = mglist.find(mgname);
 277         if (iter == mglist.end()) {
 278                 errorstream << "EmergeManager; mapgen " << mgname <<
 279                  " not registered" << std::endl;
 280                 return NULL;
 281         }
 282
 283         MapgenFactory *mgfactory = iter->second;
 284         return mgfactory->createMapgen(mgid, mgparams, this);
 285 }
 286
 287
 288 MapgenParams *EmergeManager::createMapgenParams(std::string mgname) {
 289         std::map<std::string, MapgenFactory *>::const_iterator iter;
 290         iter = mglist.find(mgname);
 291         if (iter == mglist.end()) {
 292                 errorstream << "EmergeManager: mapgen " << mgname <<
 293                  " not registered" << std::endl;
 294                 return NULL;
 295         }
 296
 297         MapgenFactory *mgfactory = iter->second;
 298         return mgfactory->createMapgenParams();
 299 }
 300
 301
 302 MapgenParams *EmergeManager::getParamsFromSettings(Settings *settings) {
 303         std::string mg_name = settings->get("mg_name");
 304         MapgenParams *mgparams = createMapgenParams(mg_name);
 305         if (!mgparams)
 306                 return NULL;
 307
 308         mgparams->mg_name     = mg_name;
 309         mgparams->seed        = settings->getU64(settings == g_settings ? "fixed_map_seed" : "seed");
 310         mgparams->water_level = settings->getS16("water_level");
 311         mgparams->chunksize   = settings->getS16("chunksize");
 312         mgparams->flags       = settings->getFlagStr("mg_flags", flagdesc_mapgen);
 313
 314         if (!mgparams->readParams(settings)) {
 315                 delete mgparams;
 316                 return NULL;
 317         }
 318         return mgparams;
 319 }
 320
 321
 322 void EmergeManager::setParamsToSettings(Settings *settings) {
 323         settings->set("mg_name",         params->mg_name);
 324         settings->setU64("seed",         params->seed);
 325         settings->setS16("water_level",  params->water_level);
 326         settings->setS16("chunksize",    params->chunksize);
 327         settings->setFlagStr("mg_flags", params->flags, flagdesc_mapgen);
 328
 329         params->writeParams(settings);
 330 }
 331
 332
 333 void EmergeManager::registerMapgen(std::string mgname, MapgenFactory *mgfactory) {
 334         mglist.insert(std::make_pair(mgname, mgfactory));
 335         infostream << "EmergeManager: registered mapgen " << mgname << std::endl;
 336 }
 337
 338
 339 ////////////////////////////// Emerge Thread //////////////////////////////////
 340
 341 bool EmergeThread::popBlockEmerge(v3s16 *pos, u8 *flags) {
 342         std::map<v3s16, BlockEmergeData *>::iterator iter;
 343         JMutexAutoLock queuelock(emerge->queuemutex);
 344
 345         if (blockqueue.empty())
 346                 return false;
 347         v3s16 p = blockqueue.front();
 348         blockqueue.pop();
 349
 350         *pos = p;
 351
 352         iter = emerge->blocks_enqueued.find(p);
 353         if (iter == emerge->blocks_enqueued.end())
 354                 return false; //uh oh, queue and map out of sync!!
 355
 356         BlockEmergeData *bedata = iter->second;
 357         *flags = bedata->flags;
 358
 359         emerge->peer_queue_count[bedata->peer_requested]--;
 360
 361         delete bedata;
 362         emerge->blocks_enqueued.erase(iter);
 363
 364         return true;
 365 }
 366
 367
 368 bool EmergeThread::getBlockOrStartGen(v3s16 p, MapBlock **b,
 369                                                                         BlockMakeData *data, bool allow_gen) {
 370         v2s16 p2d(p.X, p.Z);
 371         //envlock: usually takes <=1ms, sometimes 90ms or ~400ms to acquire
 372         JMutexAutoLock envlock(m_server->m_env_mutex);
 373
 374         // Load sector if it isn't loaded
 375         if (map->getSectorNoGenerateNoEx(p2d) == NULL)
 376                 map->loadSectorMeta(p2d);
 377
 378         // Attempt to load block
 379         MapBlock *block = map->getBlockNoCreateNoEx(p);
 380         if (!block || block->isDummy() || !block->isGenerated()) {
 381                 EMERGE_DBG_OUT("not in memory, attempting to load from disk");
 382                 block = map->loadBlock(p);
 383         }
 384
 385         // If could not load and allowed to generate,
 386         // start generation inside this same envlock
 387         if (allow_gen && (block == NULL || !block->isGenerated())) {
 388                 EMERGE_DBG_OUT("generating");
 389                 *b = block;
 390                 return map->initBlockMake(data, p);
 391         }
 392
 393         *b = block;
 394         return false;
 395 }
 396
 397
 398 void *EmergeThread::Thread() {
 399         ThreadStarted();
 400         log_register_thread("EmergeThread" + itos(id));
 401         DSTACK(__FUNCTION_NAME);
 402         BEGIN_DEBUG_EXCEPTION_HANDLER
 403
 404         v3s16 last_tried_pos(-32768,-32768,-32768); // For error output
 405         v3s16 p;
 406         u8 flags;
 407
 408         map    = (ServerMap *)&(m_server->m_env->getMap());
 409         emerge = m_server->m_emerge;
 410         mapgen = emerge->mapgen[id];
 411         enable_mapgen_debug_info = emerge->mapgen_debug_info;
 412
 413         while (getRun())
 414         try {
 415                 if (!popBlockEmerge(&p, &flags)) {
 416                         qevent.wait();
 417                         continue;
 418                 }
 419
 420                 last_tried_pos = p;
 421                 if (blockpos_over_limit(p))
 422                         continue;
 423
 424                 bool allow_generate = flags & BLOCK_EMERGE_ALLOWGEN;
 425                 EMERGE_DBG_OUT("p=" PP(p) " allow_generate=" << allow_generate);
 426
 427                 /*
 428                         Try to fetch block from memory or disk.
 429                         If not found and asked to generate, initialize generator.
 430                 */
 431                 BlockMakeData data;
 432                 MapBlock *block = NULL;
 433                 std::map<v3s16, MapBlock *> modified_blocks;
 434
 435                 if (getBlockOrStartGen(p, &block, &data, allow_generate)) {
 436                         {
 437                                 ScopeProfiler sp(g_profiler, "EmergeThread: Mapgen::makeChunk", SPT_AVG);
 438                                 TimeTaker t("mapgen::make_block()");
 439
 440                                 mapgen->makeChunk(&data);
 441
 442                                 if (enable_mapgen_debug_info == false)
 443                                         t.stop(true); // Hide output
 444                         }
 445
 446                         {
 447                                 //envlock: usually 0ms, but can take either 30 or 400ms to acquire
 448                                 JMutexAutoLock envlock(m_server->m_env_mutex);
 449                                 ScopeProfiler sp(g_profiler, "EmergeThread: after "
 450                                                 "Mapgen::makeChunk (envlock)", SPT_AVG);
 451
 452                                 map->finishBlockMake(&data, modified_blocks);
 453
 454                                 block = map->getBlockNoCreateNoEx(p);
 455                                 if (block) {
 456                                         /*
 457                                                 Do some post-generate stuff
 458                                         */
 459                                         v3s16 minp = data.blockpos_min * MAP_BLOCKSIZE;
 460                                         v3s16 maxp = data.blockpos_max * MAP_BLOCKSIZE +
 461                                                                  v3s16(1,1,1) * (MAP_BLOCKSIZE - 1);
 462
 463                                         // Ignore map edit events, they will not need to be sent
 464                                         // to anybody because the block hasn't been sent to anybody
 465                                         MapEditEventAreaIgnorer
 466                                                 ign(&m_server->m_ignore_map_edit_events_area,
 467                                                 VoxelArea(minp, maxp));
 468                                         {  // takes about 90ms with -O1 on an e3-1230v2
 469                                                 SERVER_TO_SA(m_server)->environment_OnGenerated(
 470                                                                 minp, maxp, emerge->getBlockSeed(minp));
 471                                         }
 472
 473                                         EMERGE_DBG_OUT("ended up with: " << analyze_block(block));
 474
 475                                         m_server->m_env->activateBlock(block, 0);
 476                                 }
 477                         }
 478                 }
 479
 480                 /*
 481                         Set sent status of modified blocks on clients
 482                 */
 483
 484                 // NOTE: Server's clients are also behind the connection mutex
 485                 //conlock: consistently takes 30-40ms to acquire
 486                 JMutexAutoLock lock(m_server->m_con_mutex);
 487                 // Add the originally fetched block to the modified list
 488                 if (block)
 489                         modified_blocks[p] = block;
 490
 491                 // Set the modified blocks unsent for all the clients
 492                 for (std::map<u16, RemoteClient*>::iterator
 493                          i = m_server->m_clients.begin();
 494                          i != m_server->m_clients.end(); ++i) {
 495                         RemoteClient *client = i->second;
 496                         if (modified_blocks.size() > 0) {
 497                                 // Remove block from sent history
 498                                 client->SetBlocksNotSent(modified_blocks);
 499                         }
 500                 }
 501         }
 502         catch (VersionMismatchException &e) {
 503                 std::ostringstream err;
 504                 err << "World data version mismatch in MapBlock "<<PP(last_tried_pos)<<std::endl;
 505                 err << "----"<<std::endl;
 506                 err << "\""<<e.what()<<"\""<<std::endl;
 507                 err << "See debug.txt."<<std::endl;
 508                 err << "World probably saved by a newer version of Minetest."<<std::endl;
 509                 m_server->setAsyncFatalError(err.str());
 510         }
 511         catch (SerializationError &e) {
 512                 std::ostringstream err;
 513                 err << "Invalid data in MapBlock "<<PP(last_tried_pos)<<std::endl;
 514                 err << "----"<<std::endl;
 515                 err << "\""<<e.what()<<"\""<<std::endl;
 516                 err << "See debug.txt."<<std::endl;
 517                 err << "You can ignore this using [ignore_world_load_errors = true]."<<std::endl;
 518                 m_server->setAsyncFatalError(err.str());
 519         }
 520
 521         END_DEBUG_EXCEPTION_HANDLER(errorstream)
 522         log_deregister_thread();
 523         return NULL;
 524 }