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