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