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