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         if (params.sparams) {
 161                 delete params.sparams;
 162                 params.sparams = NULL;
 163         }
 164 }
 165
 166
 167 void EmergeManager::loadMapgenParams() {
 168         loadParamsFromSettings(g_settings);
 169
 170         if (g_settings->get("fixed_map_seed").empty()) {
 171                 params.seed = (((u64)(myrand() & 0xffff) << 0)
 172                                          | ((u64)(myrand() & 0xffff) << 16)
 173                                          | ((u64)(myrand() & 0xffff) << 32)
 174                                          | ((u64)(myrand() & 0xffff) << 48));
 175         }
 176 }
 177
 178
 179 void EmergeManager::initMapgens() {
 180         if (mapgen.size())
 181                 return;
 182
 183         // Resolve names of nodes for things that were registered
 184         // (at this point, the registration period is over)
 185         biomedef->resolveNodeNames(ndef);
 186
 187         for (size_t i = 0; i != ores.size(); i++)
 188                 ores[i]->resolveNodeNames(ndef);
 189
 190         for (size_t i = 0; i != decorations.size(); i++)
 191                 decorations[i]->resolveNodeNames(ndef);
 192
 193         if (!params.sparams) {
 194                 params.sparams = createMapgenParams(params.mg_name);
 195                 if (!params.sparams) {
 196                         params.mg_name = DEFAULT_MAPGEN;
 197                         params.sparams = createMapgenParams(params.mg_name);
 198                         assert(params.sparams);
 199                 }
 200                 params.sparams->readParams(g_settings);
 201         }
 202
 203         // Create the mapgens
 204         for (size_t i = 0; i != emergethread.size(); i++) {
 205                 Mapgen *mg = createMapgen(params.mg_name, i, &params);
 206                 assert(mg);
 207                 mapgen.push_back(mg);
 208         }
 209 }
 210
 211
 212 Mapgen *EmergeManager::getCurrentMapgen() {
 213         for (unsigned int i = 0; i != emergethread.size(); i++) {
 214                 if (emergethread[i]->IsSameThread())
 215                         return emergethread[i]->mapgen;
 216         }
 217
 218         return NULL;
 219 }
 220
 221
 222 void EmergeManager::startThreads() {
 223         if (threads_active)
 224                 return;
 225
 226         for (unsigned int i = 0; i != emergethread.size(); i++)
 227                 emergethread[i]->Start();
 228
 229         threads_active = true;
 230 }
 231
 232
 233 void EmergeManager::stopThreads() {
 234         if (!threads_active)
 235                 return;
 236
 237         // Request thread stop in parallel
 238         for (unsigned int i = 0; i != emergethread.size(); i++) {
 239                 emergethread[i]->Stop();
 240                 emergethread[i]->qevent.signal();
 241         }
 242
 243         // Then do the waiting for each
 244         for (unsigned int i = 0; i != emergethread.size(); i++)
 245                 emergethread[i]->Wait();
 246
 247         threads_active = false;
 248 }
 249
 250
 251 bool EmergeManager::enqueueBlockEmerge(u16 peer_id, v3s16 p, bool allow_generate) {
 252         std::map<v3s16, BlockEmergeData *>::const_iterator iter;
 253         BlockEmergeData *bedata;
 254         u16 count;
 255         u8 flags = 0;
 256         int idx = 0;
 257
 258         if (allow_generate)
 259                 flags |= BLOCK_EMERGE_ALLOWGEN;
 260
 261         {
 262                 JMutexAutoLock queuelock(queuemutex);
 263
 264                 count = blocks_enqueued.size();
 265                 if (count >= qlimit_total)
 266                         return false;
 267
 268                 count = peer_queue_count[peer_id];
 269                 u16 qlimit_peer = allow_generate ? qlimit_generate : qlimit_diskonly;
 270                 if (count >= qlimit_peer)
 271                         return false;
 272
 273                 iter = blocks_enqueued.find(p);
 274                 if (iter != blocks_enqueued.end()) {
 275                         bedata = iter->second;
 276                         bedata->flags |= flags;
 277                         return true;
 278                 }
 279
 280                 bedata = new BlockEmergeData;
 281                 bedata->flags = flags;
 282                 bedata->peer_requested = peer_id;
 283                 blocks_enqueued.insert(std::make_pair(p, bedata));
 284
 285                 peer_queue_count[peer_id] = count + 1;
 286
 287                 // insert into the EmergeThread queue with the least items
 288                 int lowestitems = emergethread[0]->blockqueue.size();
 289                 for (unsigned int i = 1; i != emergethread.size(); i++) {
 290                         int nitems = emergethread[i]->blockqueue.size();
 291                         if (nitems < lowestitems) {
 292                                 idx = i;
 293                                 lowestitems = nitems;
 294                         }
 295                 }
 296
 297                 emergethread[idx]->blockqueue.push(p);
 298         }
 299         emergethread[idx]->qevent.signal();
 300
 301         return true;
 302 }
 303
 304
 305 int EmergeManager::getGroundLevelAtPoint(v2s16 p) {
 306         if (mapgen.size() == 0 || !mapgen[0]) {
 307                 errorstream << "EmergeManager: getGroundLevelAtPoint() called"
 308                         " before mapgen initialized" << std::endl;
 309                 return 0;
 310         }
 311
 312         return mapgen[0]->getGroundLevelAtPoint(p);
 313 }
 314
 315
 316 bool EmergeManager::isBlockUnderground(v3s16 blockpos) {
 317         /*
 318         v2s16 p = v2s16((blockpos.X * MAP_BLOCKSIZE) + MAP_BLOCKSIZE / 2,
 319                                         (blockpos.Y * MAP_BLOCKSIZE) + MAP_BLOCKSIZE / 2);
 320         int ground_level = getGroundLevelAtPoint(p);
 321         return blockpos.Y * (MAP_BLOCKSIZE + 1) <= min(water_level, ground_level);
 322         */
 323
 324         //yuck, but then again, should i bother being accurate?
 325         //the height of the nodes in a single block is quite variable
 326         return blockpos.Y * (MAP_BLOCKSIZE + 1) <= params.water_level;
 327 }
 328
 329
 330 u32 EmergeManager::getBlockSeed(v3s16 p) {
 331         return (u32)(params.seed & 0xFFFFFFFF) +
 332                 p.Z * 38134234 +
 333                 p.Y * 42123 +
 334                 p.X * 23;
 335 }
 336
 337
 338 Mapgen *EmergeManager::createMapgen(std::string mgname, int mgid,
 339                                                                          MapgenParams *mgparams) {
 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         std::map<std::string, MapgenFactory *>::const_iterator iter;
 355         iter = mglist.find(mgname);
 356         if (iter == mglist.end()) {
 357                 errorstream << "EmergeManager: mapgen " << mgname <<
 358                  " not registered" << std::endl;
 359                 return NULL;
 360         }
 361
 362         MapgenFactory *mgfactory = iter->second;
 363         return mgfactory->createMapgenParams();
 364 }
 365
 366
 367 void EmergeManager::loadParamsFromSettings(Settings *settings) {
 368         std::string seed_str;
 369         const char *setname = (settings == g_settings) ? "fixed_map_seed" : "seed";
 370
 371         if (settings->getNoEx(setname, seed_str))
 372                 params.seed = read_seed(seed_str.c_str());
 373
 374         settings->getNoEx("mg_name",         params.mg_name);
 375         settings->getS16NoEx("water_level",  params.water_level);
 376         settings->getS16NoEx("chunksize",    params.chunksize);
 377         settings->getFlagStrNoEx("mg_flags", params.flags, flagdesc_mapgen);
 378
 379         delete params.sparams;
 380         params.sparams = createMapgenParams(params.mg_name);
 381         if (params.sparams)
 382                 params.sparams->readParams(settings);
 383 }
 384
 385
 386 void EmergeManager::saveParamsToSettings(Settings *settings) {
 387         settings->set("mg_name",         params.mg_name);
 388         settings->setU64("seed",         params.seed);
 389         settings->setS16("water_level",  params.water_level);
 390         settings->setS16("chunksize",    params.chunksize);
 391         settings->setFlagStr("mg_flags", params.flags, flagdesc_mapgen, (u32)-1);
 392
 393         if (params.sparams)
 394                 params.sparams->writeParams(settings);
 395 }
 396
 397
 398 void EmergeManager::registerMapgen(std::string mgname, MapgenFactory *mgfactory) {
 399         mglist.insert(std::make_pair(mgname, mgfactory));
 400         infostream << "EmergeManager: registered mapgen " << mgname << std::endl;
 401 }
 402
 403
 404 ////////////////////////////// Emerge Thread //////////////////////////////////
 405
 406 bool EmergeThread::popBlockEmerge(v3s16 *pos, u8 *flags) {
 407         std::map<v3s16, BlockEmergeData *>::iterator iter;
 408         JMutexAutoLock queuelock(emerge->queuemutex);
 409
 410         if (blockqueue.empty())
 411                 return false;
 412         v3s16 p = blockqueue.front();
 413         blockqueue.pop();
 414
 415         *pos = p;
 416
 417         iter = emerge->blocks_enqueued.find(p);
 418         if (iter == emerge->blocks_enqueued.end())
 419                 return false; //uh oh, queue and map out of sync!!
 420
 421         BlockEmergeData *bedata = iter->second;
 422         *flags = bedata->flags;
 423
 424         emerge->peer_queue_count[bedata->peer_requested]--;
 425
 426         delete bedata;
 427         emerge->blocks_enqueued.erase(iter);
 428
 429         return true;
 430 }
 431
 432
 433 bool EmergeThread::getBlockOrStartGen(v3s16 p, MapBlock **b,
 434                                                                         BlockMakeData *data, bool allow_gen) {
 435         v2s16 p2d(p.X, p.Z);
 436         //envlock: usually takes <=1ms, sometimes 90ms or ~400ms to acquire
 437         JMutexAutoLock envlock(m_server->m_env_mutex);
 438
 439         // Load sector if it isn't loaded
 440         if (map->getSectorNoGenerateNoEx(p2d) == NULL)
 441                 map->loadSectorMeta(p2d);
 442
 443         // Attempt to load block
 444         MapBlock *block = map->getBlockNoCreateNoEx(p);
 445         if (!block || block->isDummy() || !block->isGenerated()) {
 446                 EMERGE_DBG_OUT("not in memory, attempting to load from disk");
 447                 block = map->loadBlock(p);
 448                 if (block && block->isGenerated())
 449                         map->prepareBlock(block);
 450         }
 451
 452         // If could not load and allowed to generate,
 453         // start generation inside this same envlock
 454         if (allow_gen && (block == NULL || !block->isGenerated())) {
 455                 EMERGE_DBG_OUT("generating");
 456                 *b = block;
 457                 return map->initBlockMake(data, p);
 458         }
 459
 460         *b = block;
 461         return false;
 462 }
 463
 464
 465 void *EmergeThread::Thread() {
 466         ThreadStarted();
 467         log_register_thread("EmergeThread" + itos(id));
 468         DSTACK(__FUNCTION_NAME);
 469         BEGIN_DEBUG_EXCEPTION_HANDLER
 470
 471         v3s16 last_tried_pos(-32768,-32768,-32768); // For error output
 472         v3s16 p;
 473         u8 flags = 0;
 474
 475         map    = (ServerMap *)&(m_server->m_env->getMap());
 476         emerge = m_server->m_emerge;
 477         mapgen = emerge->mapgen[id];
 478         enable_mapgen_debug_info = emerge->mapgen_debug_info;
 479
 480         porting::setThreadName("EmergeThread");
 481
 482         while (!StopRequested())
 483         try {
 484                 if (!popBlockEmerge(&p, &flags)) {
 485                         qevent.wait();
 486                         continue;
 487                 }
 488
 489                 last_tried_pos = p;
 490                 if (blockpos_over_limit(p))
 491                         continue;
 492
 493                 bool allow_generate = flags & BLOCK_EMERGE_ALLOWGEN;
 494                 EMERGE_DBG_OUT("p=" PP(p) " allow_generate=" << allow_generate);
 495
 496                 /*
 497                         Try to fetch block from memory or disk.
 498                         If not found and asked to generate, initialize generator.
 499                 */
 500                 BlockMakeData data;
 501                 MapBlock *block = NULL;
 502                 std::map<v3s16, MapBlock *> modified_blocks;
 503
 504                 if (getBlockOrStartGen(p, &block, &data, allow_generate) && mapgen) {
 505                         {
 506                                 ScopeProfiler sp(g_profiler, "EmergeThread: Mapgen::makeChunk", SPT_AVG);
 507                                 TimeTaker t("mapgen::make_block()");
 508
 509                                 mapgen->makeChunk(&data);
 510
 511                                 if (enable_mapgen_debug_info == false)
 512                                         t.stop(true); // Hide output
 513                         }
 514
 515                         {
 516                                 //envlock: usually 0ms, but can take either 30 or 400ms to acquire
 517                                 JMutexAutoLock envlock(m_server->m_env_mutex);
 518                                 ScopeProfiler sp(g_profiler, "EmergeThread: after "
 519                                                 "Mapgen::makeChunk (envlock)", SPT_AVG);
 520
 521                                 map->finishBlockMake(&data, modified_blocks);
 522
 523                                 block = map->getBlockNoCreateNoEx(p);
 524                                 if (block) {
 525                                         /*
 526                                                 Do some post-generate stuff
 527                                         */
 528                                         v3s16 minp = data.blockpos_min * MAP_BLOCKSIZE;
 529                                         v3s16 maxp = data.blockpos_max * MAP_BLOCKSIZE +
 530                                                                  v3s16(1,1,1) * (MAP_BLOCKSIZE - 1);
 531
 532                                         // Ignore map edit events, they will not need to be sent
 533                                         // to anybody because the block hasn't been sent to anybody
 534                                         MapEditEventAreaIgnorer
 535                                                 ign(&m_server->m_ignore_map_edit_events_area,
 536                                                 VoxelArea(minp, maxp));
 537                                         try {  // takes about 90ms with -O1 on an e3-1230v2
 538                                                 m_server->getScriptIface()->environment_OnGenerated(
 539                                                                 minp, maxp, emerge->getBlockSeed(minp));
 540                                         } catch(LuaError &e) {
 541                                                 m_server->setAsyncFatalError(e.what());
 542                                         }
 543
 544                                         EMERGE_DBG_OUT("ended up with: " << analyze_block(block));
 545
 546                                         m_server->m_env->activateBlock(block, 0);
 547                                 }
 548                         }
 549                 }
 550
 551                 /*
 552                         Set sent status of modified blocks on clients
 553                 */
 554                 // Add the originally fetched block to the modified list
 555                 if (block)
 556                         modified_blocks[p] = block;
 557
 558                 if (modified_blocks.size() > 0) {
 559                         m_server->SetBlocksNotSent(modified_blocks);
 560                 }
 561         }
 562         catch (VersionMismatchException &e) {
 563                 std::ostringstream err;
 564                 err << "World data version mismatch in MapBlock "<<PP(last_tried_pos)<<std::endl;
 565                 err << "----"<<std::endl;
 566                 err << "\""<<e.what()<<"\""<<std::endl;
 567                 err << "See debug.txt."<<std::endl;
 568                 err << "World probably saved by a newer version of Minetest."<<std::endl;
 569                 m_server->setAsyncFatalError(err.str());
 570         }
 571         catch (SerializationError &e) {
 572                 std::ostringstream err;
 573                 err << "Invalid data in MapBlock "<<PP(last_tried_pos)<<std::endl;
 574                 err << "----"<<std::endl;
 575                 err << "\""<<e.what()<<"\""<<std::endl;
 576                 err << "See debug.txt."<<std::endl;
 577                 err << "You can ignore this using [ignore_world_load_errors = true]."<<std::endl;
 578                 m_server->setAsyncFatalError(err.str());
 579         }
 580
 581         END_DEBUG_EXCEPTION_HANDLER(errorstream)
 582         log_deregister_thread();
 583         return NULL;
 584 }