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