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 {
  87         //register built-in mapgens
  88         registerMapgen("v5",         new MapgenFactoryV5());
  89         registerMapgen("v6",         new MapgenFactoryV6());
  90         registerMapgen("v7",         new MapgenFactoryV7());
  91         registerMapgen("singlenode", new MapgenFactorySinglenode());
  92
  93         this->ndef      = gamedef->getNodeDefManager();
  94         this->biomemgr  = new BiomeManager(gamedef);
  95         this->oremgr    = new OreManager(gamedef);
  96         this->decomgr   = new DecorationManager(gamedef);
  97         this->schemmgr  = new SchematicManager(gamedef);
  98         this->gen_notify_on = 0;
  99
 100         // Note that accesses to this variable are not synchronized.
 101         // This is because the *only* thread ever starting or stopping
 102         // EmergeThreads should be the ServerThread.
 103         this->threads_active = false;
 104
 105         mapgen_debug_info = g_settings->getBool("enable_mapgen_debug_info");
 106
 107         // if unspecified, leave a proc for the main thread and one for
 108         // some other misc thread
 109         s16 nthreads = 0;
 110         if (!g_settings->getS16NoEx("num_emerge_threads", nthreads))
 111                 nthreads = porting::getNumberOfProcessors() - 2;
 112         if (nthreads < 1)
 113                 nthreads = 1;
 114
 115         qlimit_total = g_settings->getU16("emergequeue_limit_total");
 116         if (!g_settings->getU16NoEx("emergequeue_limit_diskonly", qlimit_diskonly))
 117                 qlimit_diskonly = nthreads * 5 + 1;
 118         if (!g_settings->getU16NoEx("emergequeue_limit_generate", qlimit_generate))
 119                 qlimit_generate = nthreads + 1;
 120
 121         // don't trust user input for something very important like this
 122         if (qlimit_total < 1)
 123                 qlimit_total = 1;
 124         if (qlimit_diskonly < 1)
 125                 qlimit_diskonly = 1;
 126         if (qlimit_generate < 1)
 127                 qlimit_generate = 1;
 128
 129         for (s16 i = 0; i < nthreads; i++)
 130                 emergethread.push_back(new EmergeThread((Server *) gamedef, i));
 131
 132         infostream << "EmergeManager: using " << nthreads << " threads" << std::endl;
 133 }
 134
 135
 136 EmergeManager::~EmergeManager()
 137 {
 138         for (unsigned int i = 0; i != emergethread.size(); i++) {
 139                 if (threads_active) {
 140                         emergethread[i]->Stop();
 141                         emergethread[i]->qevent.signal();
 142                         emergethread[i]->Wait();
 143                 }
 144                 delete emergethread[i];
 145                 delete mapgen[i];
 146         }
 147         emergethread.clear();
 148         mapgen.clear();
 149
 150         std::map<std::string, MapgenFactory *>::iterator it;
 151         for (it = mglist.begin(); it != mglist.end(); ++it)
 152                 delete it->second;
 153         mglist.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 (size_t 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 (unsigned int 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 (unsigned int 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 (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 {
 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 {
 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 u32 EmergeManager::getBlockSeed(v3s16 p)
 329 {
 330         return (u32)(params.seed & 0xFFFFFFFF) +
 331                 p.Z * 38134234 +
 332                 p.Y * 42123 +
 333                 p.X * 23;
 334 }
 335
 336
 337 Mapgen *EmergeManager::createMapgen(std::string mgname, int mgid,
 338         MapgenParams *mgparams)
 339 {
 340         std::map<std::string, MapgenFactory *>::const_iterator iter;
 341         iter = mglist.find(mgname);
 342         if (iter == mglist.end()) {
 343                 errorstream << "EmergeManager; mapgen " << mgname <<
 344                         " not registered" << std::endl;
 345                 return NULL;
 346         }
 347
 348         MapgenFactory *mgfactory = iter->second;
 349         return mgfactory->createMapgen(mgid, mgparams, this);
 350 }
 351
 352
 353 MapgenSpecificParams *EmergeManager::createMapgenParams(std::string mgname)
 354 {
 355         std::map<std::string, MapgenFactory *>::const_iterator iter;
 356         iter = mglist.find(mgname);
 357         if (iter == mglist.end()) {
 358                 errorstream << "EmergeManager: mapgen " << mgname <<
 359                         " not registered" << std::endl;
 360                 return NULL;
 361         }
 362
 363         MapgenFactory *mgfactory = iter->second;
 364         return mgfactory->createMapgenParams();
 365 }
 366
 367
 368 void EmergeManager::loadParamsFromSettings(Settings *settings)
 369 {
 370         std::string seed_str;
 371         const char *setname = (settings == g_settings) ? "fixed_map_seed" : "seed";
 372
 373         if (settings->getNoEx(setname, seed_str))
 374                 params.seed = read_seed(seed_str.c_str());
 375
 376         settings->getNoEx("mg_name",         params.mg_name);
 377         settings->getS16NoEx("water_level",  params.water_level);
 378         settings->getS16NoEx("chunksize",    params.chunksize);
 379         settings->getFlagStrNoEx("mg_flags", params.flags, flagdesc_mapgen);
 380         settings->getNoiseParams("mg_biome_np_heat",     params.np_biome_heat);
 381         settings->getNoiseParams("mg_biome_np_humidity", params.np_biome_humidity);
 382
 383         delete params.sparams;
 384         params.sparams = createMapgenParams(params.mg_name);
 385         if (params.sparams)
 386                 params.sparams->readParams(settings);
 387 }
 388
 389
 390 void EmergeManager::saveParamsToSettings(Settings *settings)
 391 {
 392         settings->set("mg_name",         params.mg_name);
 393         settings->setU64("seed",         params.seed);
 394         settings->setS16("water_level",  params.water_level);
 395         settings->setS16("chunksize",    params.chunksize);
 396         settings->setFlagStr("mg_flags", params.flags, flagdesc_mapgen, (u32)-1);
 397         settings->setNoiseParams("mg_biome_np_heat",     params.np_biome_heat);
 398         settings->setNoiseParams("mg_biome_np_humidity", params.np_biome_humidity);
 399
 400         if (params.sparams)
 401                 params.sparams->writeParams(settings);
 402 }
 403
 404
 405 void EmergeManager::registerMapgen(std::string mgname, MapgenFactory *mgfactory)
 406 {
 407         mglist.insert(std::make_pair(mgname, mgfactory));
 408         infostream << "EmergeManager: registered mapgen " << mgname << std::endl;
 409 }
 410
 411
 412 ////////////////////////////// Emerge Thread //////////////////////////////////
 413
 414 bool EmergeThread::popBlockEmerge(v3s16 *pos, u8 *flags)
 415 {
 416         std::map<v3s16, BlockEmergeData *>::iterator iter;
 417         JMutexAutoLock queuelock(emerge->queuemutex);
 418
 419         if (blockqueue.empty())
 420                 return false;
 421         v3s16 p = blockqueue.front();
 422         blockqueue.pop();
 423
 424         *pos = p;
 425
 426         iter = emerge->blocks_enqueued.find(p);
 427         if (iter == emerge->blocks_enqueued.end())
 428                 return false; //uh oh, queue and map out of sync!!
 429
 430         BlockEmergeData *bedata = iter->second;
 431         *flags = bedata->flags;
 432
 433         emerge->peer_queue_count[bedata->peer_requested]--;
 434
 435         delete bedata;
 436         emerge->blocks_enqueued.erase(iter);
 437
 438         return true;
 439 }
 440
 441
 442 bool EmergeThread::getBlockOrStartGen(v3s16 p, MapBlock **b,
 443         BlockMakeData *data, bool allow_gen)
 444 {
 445         v2s16 p2d(p.X, p.Z);
 446         //envlock: usually takes <=1ms, sometimes 90ms or ~400ms to acquire
 447         JMutexAutoLock envlock(m_server->m_env_mutex);
 448
 449         // Load sector if it isn't loaded
 450         if (map->getSectorNoGenerateNoEx(p2d) == NULL)
 451                 map->loadSectorMeta(p2d);
 452
 453         // Attempt to load block
 454         MapBlock *block = map->getBlockNoCreateNoEx(p);
 455         if (!block || block->isDummy() || !block->isGenerated()) {
 456                 EMERGE_DBG_OUT("not in memory, attempting to load from disk");
 457                 block = map->loadBlock(p);
 458                 if (block && block->isGenerated())
 459                         map->prepareBlock(block);
 460         }
 461
 462         // If could not load and allowed to generate,
 463         // start generation inside this same envlock
 464         if (allow_gen && (block == NULL || !block->isGenerated())) {
 465                 EMERGE_DBG_OUT("generating");
 466                 *b = block;
 467                 return map->initBlockMake(data, p);
 468         }
 469
 470         *b = block;
 471         return false;
 472 }
 473
 474
 475 void *EmergeThread::Thread()
 476 {
 477         ThreadStarted();
 478         log_register_thread("EmergeThread" + itos(id));
 479         DSTACK(__FUNCTION_NAME);
 480         BEGIN_DEBUG_EXCEPTION_HANDLER
 481
 482         v3s16 last_tried_pos(-32768,-32768,-32768); // For error output
 483         v3s16 p;
 484         u8 flags = 0;
 485
 486         map    = (ServerMap *)&(m_server->m_env->getMap());
 487         emerge = m_server->m_emerge;
 488         mapgen = emerge->mapgen[id];
 489         enable_mapgen_debug_info = emerge->mapgen_debug_info;
 490
 491         porting::setThreadName("EmergeThread");
 492
 493         while (!StopRequested())
 494         try {
 495                 if (!popBlockEmerge(&p, &flags)) {
 496                         qevent.wait();
 497                         continue;
 498                 }
 499
 500                 last_tried_pos = p;
 501                 if (blockpos_over_limit(p))
 502                         continue;
 503
 504                 bool allow_generate = flags & BLOCK_EMERGE_ALLOWGEN;
 505                 EMERGE_DBG_OUT("p=" PP(p) " allow_generate=" << allow_generate);
 506
 507                 /*
 508                         Try to fetch block from memory or disk.
 509                         If not found and asked to generate, initialize generator.
 510                 */
 511                 BlockMakeData data;
 512                 MapBlock *block = NULL;
 513                 std::map<v3s16, MapBlock *> modified_blocks;
 514
 515                 if (getBlockOrStartGen(p, &block, &data, allow_generate) && mapgen) {
 516                         {
 517                                 ScopeProfiler sp(g_profiler, "EmergeThread: Mapgen::makeChunk", SPT_AVG);
 518                                 TimeTaker t("mapgen::make_block()");
 519
 520                                 mapgen->makeChunk(&data);
 521
 522                                 if (enable_mapgen_debug_info == false)
 523                                         t.stop(true); // Hide output
 524                         }
 525
 526                         {
 527                                 //envlock: usually 0ms, but can take either 30 or 400ms to acquire
 528                                 JMutexAutoLock envlock(m_server->m_env_mutex);
 529                                 ScopeProfiler sp(g_profiler, "EmergeThread: after "
 530                                                 "Mapgen::makeChunk (envlock)", SPT_AVG);
 531
 532                                 map->finishBlockMake(&data, modified_blocks);
 533
 534                                 block = map->getBlockNoCreateNoEx(p);
 535                                 if (block) {
 536                                         /*
 537                                                 Do some post-generate stuff
 538                                         */
 539                                         v3s16 minp = data.blockpos_min * MAP_BLOCKSIZE;
 540                                         v3s16 maxp = data.blockpos_max * MAP_BLOCKSIZE +
 541                                                                  v3s16(1,1,1) * (MAP_BLOCKSIZE - 1);
 542
 543                                         // Ignore map edit events, they will not need to be sent
 544                                         // to anybody because the block hasn't been sent to anybody
 545                                         MapEditEventAreaIgnorer
 546                                                 ign(&m_server->m_ignore_map_edit_events_area,
 547                                                 VoxelArea(minp, maxp));
 548                                         try {  // takes about 90ms with -O1 on an e3-1230v2
 549                                                 m_server->getScriptIface()->environment_OnGenerated(
 550                                                                 minp, maxp, emerge->getBlockSeed(minp));
 551                                         } catch(LuaError &e) {
 552                                                 m_server->setAsyncFatalError(e.what());
 553                                         }
 554
 555                                         EMERGE_DBG_OUT("ended up with: " << analyze_block(block));
 556
 557                                         m_server->m_env->activateBlock(block, 0);
 558                                 }
 559                         }
 560                 }
 561
 562                 /*
 563                         Set sent status of modified blocks on clients
 564                 */
 565                 // Add the originally fetched block to the modified list
 566                 if (block)
 567                         modified_blocks[p] = block;
 568
 569                 if (modified_blocks.size() > 0) {
 570                         m_server->SetBlocksNotSent(modified_blocks);
 571                 }
 572         }
 573         catch (VersionMismatchException &e) {
 574                 std::ostringstream err;
 575                 err << "World data version mismatch 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 << "World probably saved by a newer version of Minetest."<<std::endl;
 580                 m_server->setAsyncFatalError(err.str());
 581         }
 582         catch (SerializationError &e) {
 583                 std::ostringstream err;
 584                 err << "Invalid data in MapBlock "<<PP(last_tried_pos)<<std::endl;
 585                 err << "----"<<std::endl;
 586                 err << "\""<<e.what()<<"\""<<std::endl;
 587                 err << "See debug.txt."<<std::endl;
 588                 err << "You can ignore this using [ignore_world_load_errors = true]."<<std::endl;
 589                 m_server->setAsyncFatalError(err.str());
 590         }
 591
 592         END_DEBUG_EXCEPTION_HANDLER(errorstream)
 593         log_deregister_thread();
 594         return NULL;
 595 }