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