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