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