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