src/emerge.cpp

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