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 "server.h"
  23 #include <iostream>
  24 #include <queue>
  25 #include "clientserver.h"
  26 #include "map.h"
  27 #include "jmutexautolock.h"
  28 #include "main.h"
  29 #include "constants.h"
  30 #include "voxel.h"
  31 #include "config.h"
  32 #include "mapblock.h"
  33 #include "serverobject.h"
  34 #include "settings.h"
  35 #include "cpp_api/scriptapi.h"
  36 #include "profiler.h"
  37 #include "log.h"
  38 #include "nodedef.h"
  39 #include "biome.h"
  40 #include "emerge.h"
  41 #include "mapgen_v6.h"
  42 #include "mapgen_v7.h"
  43 #include "mapgen_indev.h"
  44 #include "mapgen_singlenode.h"
  45
  46
  47 /////////////////////////////// Emerge Manager ////////////////////////////////
  48
  49 EmergeManager::EmergeManager(IGameDef *gamedef) {
  50         //register built-in mapgens
  51         registerMapgen("v6", new MapgenFactoryV6());
  52         registerMapgen("v7", new MapgenFactoryV7());
  53         registerMapgen("indev", new MapgenFactoryIndev());
  54         registerMapgen("singlenode", new MapgenFactorySinglenode());
  55
  56         this->ndef     = gamedef->getNodeDefManager();
  57         this->biomedef = new BiomeDefManager();
  58         this->params   = NULL;
  59
  60         mapgen_debug_info = g_settings->getBool("enable_mapgen_debug_info");
  61
  62         queuemutex.Init();
  63
  64         int nthreads;
  65         if (g_settings->get("num_emerge_threads").empty()) {
  66                 int nprocs = porting::getNumberOfProcessors();
  67                 // leave a proc for the main thread and one for some other misc threads
  68                 nthreads = (nprocs > 2) ? nprocs - 2 : 1;
  69         } else {
  70                 nthreads = g_settings->getU16("num_emerge_threads");
  71         }
  72         if (nthreads < 1)
  73                 nthreads = 1;
  74
  75         qlimit_total    = g_settings->getU16("emergequeue_limit_total");
  76         qlimit_diskonly = g_settings->get("emergequeue_limit_diskonly").empty() ?
  77                 nthreads * 5 + 1 :
  78                 g_settings->getU16("emergequeue_limit_diskonly");
  79         qlimit_generate = g_settings->get("emergequeue_limit_generate").empty() ?
  80                 nthreads + 1 :
  81                 g_settings->getU16("emergequeue_limit_generate");
  82
  83         for (int i = 0; i != nthreads; i++)
  84                 emergethread.push_back(new EmergeThread((Server *)gamedef, i));
  85
  86         infostream << "EmergeManager: using " << nthreads << " threads" << std::endl;
  87 }
  88
  89
  90 EmergeManager::~EmergeManager() {
  91         for (unsigned int i = 0; i != emergethread.size(); i++) {
  92                 emergethread[i]->setRun(false);
  93                 emergethread[i]->qevent.signal();
  94                 emergethread[i]->stop();
  95                 delete emergethread[i];
  96                 delete mapgen[i];
  97         }
  98         emergethread.clear();
  99         mapgen.clear();
 100
 101         for (unsigned int i = 0; i < ores.size(); i++)
 102                 delete ores[i];
 103         ores.clear();
 104
 105         for (std::map<std::string, MapgenFactory *>::iterator iter = mglist.begin();
 106                         iter != mglist.end(); iter ++) {
 107                 delete iter->second;
 108         }
 109         mglist.clear();
 110
 111         delete biomedef;
 112 }
 113
 114
 115 void EmergeManager::initMapgens(MapgenParams *mgparams) {
 116         Mapgen *mg;
 117
 118         if (mapgen.size())
 119                 return;
 120
 121         biomedef->resolveNodeNames(ndef);
 122
 123         this->params = mgparams;
 124         for (unsigned int i = 0; i != emergethread.size(); i++) {
 125                 mg = createMapgen(params->mg_name, 0, params);
 126                 if (!mg) {
 127                         infostream << "EmergeManager: falling back to mapgen v6" << std::endl;
 128                         delete params;
 129                         params = createMapgenParams("v6");
 130                         mg = createMapgen("v6", 0, params);
 131                 }
 132                 mapgen.push_back(mg);
 133         }
 134 }
 135
 136
 137 bool EmergeManager::enqueueBlockEmerge(u16 peer_id, v3s16 p, bool allow_generate) {
 138         std::map<v3s16, BlockEmergeData *>::const_iterator iter;
 139         BlockEmergeData *bedata;
 140         u16 count;
 141         u8 flags = 0;
 142         int idx = 0;
 143
 144         if (allow_generate)
 145                 flags |= BLOCK_EMERGE_ALLOWGEN;
 146
 147         {
 148                 JMutexAutoLock queuelock(queuemutex);
 149
 150                 count = blocks_enqueued.size();
 151                 if (count >= qlimit_total)
 152                         return false;
 153
 154                 count = peer_queue_count[peer_id];
 155                 u16 qlimit_peer = allow_generate ? qlimit_generate : qlimit_diskonly;
 156                 if (count >= qlimit_peer)
 157                         return false;
 158
 159                 iter = blocks_enqueued.find(p);
 160                 if (iter != blocks_enqueued.end()) {
 161                         bedata = iter->second;
 162                         bedata->flags |= flags;
 163                         return true;
 164                 }
 165
 166                 bedata = new BlockEmergeData;
 167                 bedata->flags = flags;
 168                 bedata->peer_requested = peer_id;
 169                 blocks_enqueued.insert(std::make_pair(p, bedata));
 170
 171                 peer_queue_count[peer_id] = count + 1;
 172
 173                 // insert into the EmergeThread queue with the least items
 174                 int lowestitems = emergethread[0]->blockqueue.size();
 175                 for (unsigned int i = 1; i != emergethread.size(); i++) {
 176                         int nitems = emergethread[i]->blockqueue.size();
 177                         if (nitems < lowestitems) {
 178                                 idx = i;
 179                                 lowestitems = nitems;
 180                         }
 181                 }
 182
 183                 emergethread[idx]->blockqueue.push(p);
 184         }
 185         emergethread[idx]->qevent.signal();
 186
 187         return true;
 188 }
 189
 190
 191 int EmergeManager::getGroundLevelAtPoint(v2s16 p) {
 192         if (mapgen.size() == 0 || !mapgen[0]) {
 193                 errorstream << "EmergeManager: getGroundLevelAtPoint() called"
 194                 " before mapgen initialized" << std::endl;
 195                 return 0;
 196         }
 197
 198         return mapgen[0]->getGroundLevelAtPoint(p);
 199 }
 200
 201
 202 bool EmergeManager::isBlockUnderground(v3s16 blockpos) {
 203         /*
 204         v2s16 p = v2s16((blockpos.X * MAP_BLOCKSIZE) + MAP_BLOCKSIZE / 2,
 205                                         (blockpos.Y * MAP_BLOCKSIZE) + MAP_BLOCKSIZE / 2);
 206         int ground_level = getGroundLevelAtPoint(p);
 207         return blockpos.Y * (MAP_BLOCKSIZE + 1) <= min(water_level, ground_level);
 208         */
 209
 210         //yuck, but then again, should i bother being accurate?
 211         //the height of the nodes in a single block is quite variable
 212         return blockpos.Y * (MAP_BLOCKSIZE + 1) <= params->water_level;
 213 }
 214
 215
 216 u32 EmergeManager::getBlockSeed(v3s16 p) {
 217         return (u32)(params->seed & 0xFFFFFFFF) +
 218                 p.Z * 38134234 +
 219                 p.Y * 42123 +
 220                 p.X * 23;
 221 }
 222
 223
 224 Mapgen *EmergeManager::createMapgen(std::string mgname, int mgid,
 225                                                                          MapgenParams *mgparams) {
 226         std::map<std::string, MapgenFactory *>::const_iterator iter;
 227         iter = mglist.find(mgname);
 228         if (iter == mglist.end()) {
 229                 errorstream << "EmergeManager; mapgen " << mgname <<
 230                  " not registered" << std::endl;
 231                 return NULL;
 232         }
 233
 234         MapgenFactory *mgfactory = iter->second;
 235         return mgfactory->createMapgen(mgid, mgparams, this);
 236 }
 237
 238
 239 MapgenParams *EmergeManager::createMapgenParams(std::string mgname) {
 240         std::map<std::string, MapgenFactory *>::const_iterator iter;
 241         iter = mglist.find(mgname);
 242         if (iter == mglist.end()) {
 243                 errorstream << "EmergeManager: mapgen " << mgname <<
 244                  " not registered" << std::endl;
 245                 return NULL;
 246         }
 247
 248         MapgenFactory *mgfactory = iter->second;
 249         return mgfactory->createMapgenParams();
 250 }
 251
 252
 253 MapgenParams *EmergeManager::getParamsFromSettings(Settings *settings) {
 254         std::string mg_name = settings->get("mg_name");
 255         MapgenParams *mgparams = createMapgenParams(mg_name);
 256         if (!mgparams)
 257                 return NULL;
 258
 259         mgparams->mg_name     = mg_name;
 260         mgparams->seed        = settings->getU64(settings == g_settings ? "fixed_map_seed" : "seed");
 261         mgparams->water_level = settings->getS16("water_level");
 262         mgparams->chunksize   = settings->getS16("chunksize");
 263         mgparams->flags       = settings->getFlagStr("mg_flags", flagdesc_mapgen);
 264
 265         if (!mgparams->readParams(settings)) {
 266                 delete mgparams;
 267                 return NULL;
 268         }
 269         return mgparams;
 270 }
 271
 272
 273 void EmergeManager::setParamsToSettings(Settings *settings) {
 274         settings->set("mg_name",         params->mg_name);
 275         settings->setU64("seed",         params->seed);
 276         settings->setS16("water_level",  params->water_level);
 277         settings->setS16("chunksize",    params->chunksize);
 278         settings->setFlagStr("mg_flags", params->flags, flagdesc_mapgen);
 279
 280         params->writeParams(settings);
 281 }
 282
 283
 284 void EmergeManager::registerMapgen(std::string mgname, MapgenFactory *mgfactory) {
 285         mglist.insert(std::make_pair(mgname, mgfactory));
 286         infostream << "EmergeManager: registered mapgen " << mgname << std::endl;
 287 }
 288
 289
 290 ////////////////////////////// Emerge Thread //////////////////////////////////
 291
 292 bool EmergeThread::popBlockEmerge(v3s16 *pos, u8 *flags) {
 293         std::map<v3s16, BlockEmergeData *>::iterator iter;
 294         JMutexAutoLock queuelock(emerge->queuemutex);
 295
 296         if (blockqueue.empty())
 297                 return false;
 298         v3s16 p = blockqueue.front();
 299         blockqueue.pop();
 300
 301         *pos = p;
 302
 303         iter = emerge->blocks_enqueued.find(p);
 304         if (iter == emerge->blocks_enqueued.end())
 305                 return false; //uh oh, queue and map out of sync!!
 306
 307         BlockEmergeData *bedata = iter->second;
 308         *flags = bedata->flags;
 309
 310         emerge->peer_queue_count[bedata->peer_requested]--;
 311
 312         delete bedata;
 313         emerge->blocks_enqueued.erase(iter);
 314
 315         return true;
 316 }
 317
 318
 319 bool EmergeThread::getBlockOrStartGen(v3s16 p, MapBlock **b,
 320                                                                         BlockMakeData *data, bool allow_gen) {
 321         v2s16 p2d(p.X, p.Z);
 322         //envlock: usually takes <=1ms, sometimes 90ms or ~400ms to acquire
 323         JMutexAutoLock envlock(m_server->m_env_mutex);
 324
 325         // Load sector if it isn't loaded
 326         if (map->getSectorNoGenerateNoEx(p2d) == NULL)
 327                 map->loadSectorMeta(p2d);
 328
 329         // Attempt to load block
 330         MapBlock *block = map->getBlockNoCreateNoEx(p);
 331         if (!block || block->isDummy() || !block->isGenerated()) {
 332                 EMERGE_DBG_OUT("not in memory, attempting to load from disk");
 333                 block = map->loadBlock(p);
 334         }
 335
 336         // If could not load and allowed to generate,
 337         // start generation inside this same envlock
 338         if (allow_gen && (block == NULL || !block->isGenerated())) {
 339                 EMERGE_DBG_OUT("generating");
 340                 *b = block;
 341                 return map->initBlockMake(data, p);
 342         }
 343
 344         *b = block;
 345         return false;
 346 }
 347
 348
 349 void *EmergeThread::Thread() {
 350         ThreadStarted();
 351         log_register_thread("EmergeThread" + itos(id));
 352         DSTACK(__FUNCTION_NAME);
 353         BEGIN_DEBUG_EXCEPTION_HANDLER
 354
 355         v3s16 last_tried_pos(-32768,-32768,-32768); // For error output
 356         v3s16 p;
 357         u8 flags;
 358
 359         map    = (ServerMap *)&(m_server->m_env->getMap());
 360         emerge = m_server->m_emerge;
 361         mapgen = emerge->mapgen[id];
 362         enable_mapgen_debug_info = emerge->mapgen_debug_info;
 363
 364         while (getRun())
 365         try {
 366                 if (!popBlockEmerge(&p, &flags)) {
 367                         qevent.wait();
 368                         continue;
 369                 }
 370
 371                 last_tried_pos = p;
 372                 if (blockpos_over_limit(p))
 373                         continue;
 374
 375                 bool allow_generate = flags & BLOCK_EMERGE_ALLOWGEN;
 376                 EMERGE_DBG_OUT("p=" PP(p) " allow_generate=" << allow_generate);
 377
 378                 /*
 379                         Try to fetch block from memory or disk.
 380                         If not found and asked to generate, initialize generator.
 381                 */
 382                 BlockMakeData data;
 383                 MapBlock *block = NULL;
 384                 std::map<v3s16, MapBlock *> modified_blocks;
 385
 386                 if (getBlockOrStartGen(p, &block, &data, allow_generate)) {
 387                         {
 388                                 ScopeProfiler sp(g_profiler, "EmergeThread: Mapgen::makeChunk", SPT_AVG);
 389                                 TimeTaker t("mapgen::make_block()");
 390
 391                                 mapgen->makeChunk(&data);
 392
 393                                 if (enable_mapgen_debug_info == false)
 394                                         t.stop(true); // Hide output
 395                         }
 396
 397                         {
 398                                 //envlock: usually 0ms, but can take either 30 or 400ms to acquire
 399                                 JMutexAutoLock envlock(m_server->m_env_mutex);
 400                                 ScopeProfiler sp(g_profiler, "EmergeThread: after "
 401                                                 "Mapgen::makeChunk (envlock)", SPT_AVG);
 402
 403                                 map->finishBlockMake(&data, modified_blocks);
 404
 405                                 block = map->getBlockNoCreateNoEx(p);
 406                                 if (block) {
 407                                         /*
 408                                                 Do some post-generate stuff
 409                                         */
 410                                         v3s16 minp = data.blockpos_min * MAP_BLOCKSIZE;
 411                                         v3s16 maxp = data.blockpos_max * MAP_BLOCKSIZE +
 412                                                                  v3s16(1,1,1) * (MAP_BLOCKSIZE - 1);
 413
 414                                         // Ignore map edit events, they will not need to be sent
 415                                         // to anybody because the block hasn't been sent to anybody
 416                                         MapEditEventAreaIgnorer
 417                                                 ign(&m_server->m_ignore_map_edit_events_area,
 418                                                 VoxelArea(minp, maxp));
 419                                         {  // takes about 90ms with -O1 on an e3-1230v2
 420                                                 SERVER_TO_SA(m_server)->environment_OnGenerated(
 421                                                                 minp, maxp, emerge->getBlockSeed(minp));
 422                                         }
 423
 424                                         EMERGE_DBG_OUT("ended up with: " << analyze_block(block));
 425
 426                                         m_server->m_env->activateBlock(block, 0);
 427                                 }
 428                         }
 429                 }
 430
 431                 /*
 432                         Set sent status of modified blocks on clients
 433                 */
 434
 435                 // NOTE: Server's clients are also behind the connection mutex
 436                 //conlock: consistently takes 30-40ms to acquire
 437                 JMutexAutoLock lock(m_server->m_con_mutex);
 438                 // Add the originally fetched block to the modified list
 439                 if (block)
 440                         modified_blocks[p] = block;
 441
 442                 // Set the modified blocks unsent for all the clients
 443                 for (std::map<u16, RemoteClient*>::iterator
 444                          i = m_server->m_clients.begin();
 445                          i != m_server->m_clients.end(); ++i) {
 446                         RemoteClient *client = i->second;
 447                         if (modified_blocks.size() > 0) {
 448                                 // Remove block from sent history
 449                                 client->SetBlocksNotSent(modified_blocks);
 450                         }
 451                 }
 452         }
 453         catch (VersionMismatchException &e) {
 454                 std::ostringstream err;
 455                 err << "World data version mismatch in MapBlock "<<PP(last_tried_pos)<<std::endl;
 456                 err << "----"<<std::endl;
 457                 err << "\""<<e.what()<<"\""<<std::endl;
 458                 err << "See debug.txt."<<std::endl;
 459                 err << "World probably saved by a newer version of Minetest."<<std::endl;
 460                 m_server->setAsyncFatalError(err.str());
 461         }
 462         catch (SerializationError &e) {
 463                 std::ostringstream err;
 464                 err << "Invalid data in MapBlock "<<PP(last_tried_pos)<<std::endl;
 465                 err << "----"<<std::endl;
 466                 err << "\""<<e.what()<<"\""<<std::endl;
 467                 err << "See debug.txt."<<std::endl;
 468                 err << "You can ignore this using [ignore_world_load_errors = true]."<<std::endl;
 469                 m_server->setAsyncFatalError(err.str());
 470         }
 471
 472         END_DEBUG_EXCEPTION_HANDLER(errorstream)
 473         log_deregister_thread();
 474         return NULL;
 475 }