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