src/emerge.cpp

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