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