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