Move biome calculation to BiomeGen
[oweals/minetest.git] / 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 "emerge.h"
23
24 #include <iostream>
25 #include <queue>
26
27 #include "util/container.h"
28 #include "util/thread.h"
29 #include "threading/event.h"
30
31 #include "config.h"
32 #include "constants.h"
33 #include "environment.h"
34 #include "log.h"
35 #include "map.h"
36 #include "mapblock.h"
37 #include "mapgen_flat.h"
38 #include "mapgen_fractal.h"
39 #include "mapgen_v5.h"
40 #include "mapgen_v6.h"
41 #include "mapgen_v7.h"
42 #include "mapgen_valleys.h"
43 #include "mapgen_singlenode.h"
44 #include "mg_biome.h"
45 #include "mg_ore.h"
46 #include "mg_decoration.h"
47 #include "mg_schematic.h"
48 #include "nodedef.h"
49 #include "profiler.h"
50 #include "scripting_game.h"
51 #include "server.h"
52 #include "serverobject.h"
53 #include "settings.h"
54 #include "voxel.h"
55
56
57 struct MapgenDesc {
58         const char *name;
59         MapgenFactory *factory;
60         bool is_user_visible;
61 };
62
63 class EmergeThread : public Thread {
64 public:
65         bool enable_mapgen_debug_info;
66         int id;
67
68         EmergeThread(Server *server, int ethreadid);
69         ~EmergeThread();
70
71         void *run();
72         void signal();
73
74         // Requires queue mutex held
75         bool pushBlock(v3s16 pos);
76
77         void cancelPendingItems();
78
79         static void runCompletionCallbacks(
80                 v3s16 pos, EmergeAction action,
81                 const EmergeCallbackList &callbacks);
82
83 private:
84         Server *m_server;
85         ServerMap *m_map;
86         EmergeManager *m_emerge;
87         Mapgen *m_mapgen;
88
89         Event m_queue_event;
90         std::queue<v3s16> m_block_queue;
91
92         bool popBlockEmerge(v3s16 *pos, BlockEmergeData *bedata);
93
94         EmergeAction getBlockOrStartGen(
95                 v3s16 pos, bool allow_gen, MapBlock **block, BlockMakeData *data);
96         MapBlock *finishGen(v3s16 pos, BlockMakeData *bmdata,
97                 std::map<v3s16, MapBlock *> *modified_blocks);
98
99         friend class EmergeManager;
100 };
101
102 ////
103 //// Built-in mapgens
104 ////
105
106 MapgenDesc g_reg_mapgens[] = {
107         {"v5",         new MapgenFactoryV5,         true},
108         {"v6",         new MapgenFactoryV6,         true},
109         {"v7",         new MapgenFactoryV7,         true},
110         {"flat",       new MapgenFactoryFlat,       true},
111         {"fractal",    new MapgenFactoryFractal,    true},
112         {"valleys",    new MapgenFactoryValleys,    true},
113         {"singlenode", new MapgenFactorySinglenode, false},
114 };
115
116 ////
117 //// EmergeManager
118 ////
119
120 EmergeManager::EmergeManager(IGameDef *gamedef)
121 {
122         this->ndef      = gamedef->getNodeDefManager();
123         this->biomemgr  = new BiomeManager(gamedef);
124         this->oremgr    = new OreManager(gamedef);
125         this->decomgr   = new DecorationManager(gamedef);
126         this->schemmgr  = new SchematicManager(gamedef);
127         this->gen_notify_on = 0;
128
129         // Note that accesses to this variable are not synchronized.
130         // This is because the *only* thread ever starting or stopping
131         // EmergeThreads should be the ServerThread.
132         this->m_threads_active = false;
133
134         enable_mapgen_debug_info = g_settings->getBool("enable_mapgen_debug_info");
135
136         // If unspecified, leave a proc for the main thread and one for
137         // some other misc thread
138         s16 nthreads = 0;
139         if (!g_settings->getS16NoEx("num_emerge_threads", nthreads))
140                 nthreads = Thread::getNumberOfProcessors() - 2;
141         if (nthreads < 1)
142                 nthreads = 1;
143
144         m_qlimit_total = g_settings->getU16("emergequeue_limit_total");
145         if (!g_settings->getU16NoEx("emergequeue_limit_diskonly", m_qlimit_diskonly))
146                 m_qlimit_diskonly = nthreads * 5 + 1;
147         if (!g_settings->getU16NoEx("emergequeue_limit_generate", m_qlimit_generate))
148                 m_qlimit_generate = nthreads + 1;
149
150         // don't trust user input for something very important like this
151         if (m_qlimit_total < 1)
152                 m_qlimit_total = 1;
153         if (m_qlimit_diskonly < 1)
154                 m_qlimit_diskonly = 1;
155         if (m_qlimit_generate < 1)
156                 m_qlimit_generate = 1;
157
158         for (s16 i = 0; i < nthreads; i++)
159                 m_threads.push_back(new EmergeThread((Server *)gamedef, i));
160
161         infostream << "EmergeManager: using " << nthreads << " threads" << std::endl;
162 }
163
164
165 EmergeManager::~EmergeManager()
166 {
167         for (u32 i = 0; i != m_threads.size(); i++) {
168                 EmergeThread *thread = m_threads[i];
169
170                 if (m_threads_active) {
171                         thread->stop();
172                         thread->signal();
173                         thread->wait();
174                 }
175
176                 delete thread;
177                 delete m_mapgens[i];
178         }
179
180         delete biomemgr;
181         delete oremgr;
182         delete decomgr;
183         delete schemmgr;
184 }
185
186
187 void EmergeManager::loadMapgenParams()
188 {
189         params.load(*g_settings);
190 }
191
192
193 void EmergeManager::initMapgens()
194 {
195         if (m_mapgens.size())
196                 return;
197
198         MapgenFactory *mgfactory = getMapgenFactory(params.mg_name);
199         if (!mgfactory) {
200                 errorstream << "EmergeManager: mapgen " << params.mg_name <<
201                         " not registered; falling back to " << DEFAULT_MAPGEN << std::endl;
202
203                 params.mg_name = DEFAULT_MAPGEN;
204
205                 mgfactory = getMapgenFactory(params.mg_name);
206                 FATAL_ERROR_IF(mgfactory == NULL, "Couldn't use any mapgen!");
207         }
208
209         if (!params.sparams) {
210                 params.sparams = mgfactory->createMapgenParams();
211                 params.sparams->readParams(g_settings);
212         }
213
214         for (u32 i = 0; i != m_threads.size(); i++) {
215                 Mapgen *mg = mgfactory->createMapgen(i, &params, this);
216                 m_mapgens.push_back(mg);
217         }
218 }
219
220
221 Mapgen *EmergeManager::getCurrentMapgen()
222 {
223         for (u32 i = 0; i != m_threads.size(); i++) {
224                 if (m_threads[i]->isCurrentThread())
225                         return m_threads[i]->m_mapgen;
226         }
227
228         return NULL;
229 }
230
231
232 void EmergeManager::startThreads()
233 {
234         if (m_threads_active)
235                 return;
236
237         for (u32 i = 0; i != m_threads.size(); i++)
238                 m_threads[i]->start();
239
240         m_threads_active = true;
241 }
242
243
244 void EmergeManager::stopThreads()
245 {
246         if (!m_threads_active)
247                 return;
248
249         // Request thread stop in parallel
250         for (u32 i = 0; i != m_threads.size(); i++) {
251                 m_threads[i]->stop();
252                 m_threads[i]->signal();
253         }
254
255         // Then do the waiting for each
256         for (u32 i = 0; i != m_threads.size(); i++)
257                 m_threads[i]->wait();
258
259         m_threads_active = false;
260 }
261
262
263 bool EmergeManager::isRunning()
264 {
265         return m_threads_active;
266 }
267
268
269 bool EmergeManager::enqueueBlockEmerge(
270         u16 peer_id,
271         v3s16 blockpos,
272         bool allow_generate,
273         bool ignore_queue_limits)
274 {
275         u16 flags = 0;
276         if (allow_generate)
277                 flags |= BLOCK_EMERGE_ALLOW_GEN;
278         if (ignore_queue_limits)
279                 flags |= BLOCK_EMERGE_FORCE_QUEUE;
280
281         return enqueueBlockEmergeEx(blockpos, peer_id, flags, NULL, NULL);
282 }
283
284
285 bool EmergeManager::enqueueBlockEmergeEx(
286         v3s16 blockpos,
287         u16 peer_id,
288         u16 flags,
289         EmergeCompletionCallback callback,
290         void *callback_param)
291 {
292         EmergeThread *thread = NULL;
293         bool entry_already_exists = false;
294
295         {
296                 MutexAutoLock queuelock(m_queue_mutex);
297
298                 if (!pushBlockEmergeData(blockpos, peer_id, flags,
299                                 callback, callback_param, &entry_already_exists))
300                         return false;
301
302                 if (entry_already_exists)
303                         return true;
304
305                 thread = getOptimalThread();
306                 thread->pushBlock(blockpos);
307         }
308
309         thread->signal();
310
311         return true;
312 }
313
314
315 //
316 // Mapgen-related helper functions
317 //
318
319 v3s16 EmergeManager::getContainingChunk(v3s16 blockpos)
320 {
321         return getContainingChunk(blockpos, params.chunksize);
322 }
323
324
325 v3s16 EmergeManager::getContainingChunk(v3s16 blockpos, s16 chunksize)
326 {
327         s16 coff = -chunksize / 2;
328         v3s16 chunk_offset(coff, coff, coff);
329
330         return getContainerPos(blockpos - chunk_offset, chunksize)
331                 * chunksize + chunk_offset;
332 }
333
334
335 int EmergeManager::getSpawnLevelAtPoint(v2s16 p)
336 {
337         if (m_mapgens.size() == 0 || !m_mapgens[0]) {
338                 errorstream << "EmergeManager: getSpawnLevelAtPoint() called"
339                         " before mapgen init" << std::endl;
340                 return 0;
341         }
342
343         return m_mapgens[0]->getSpawnLevelAtPoint(p);
344 }
345
346
347 int EmergeManager::getGroundLevelAtPoint(v2s16 p)
348 {
349         if (m_mapgens.size() == 0 || !m_mapgens[0]) {
350                 errorstream << "EmergeManager: getGroundLevelAtPoint() called"
351                         " before mapgen init" << std::endl;
352                 return 0;
353         }
354
355         return m_mapgens[0]->getGroundLevelAtPoint(p);
356 }
357
358
359 bool EmergeManager::isBlockUnderground(v3s16 blockpos)
360 {
361 #if 0
362         v2s16 p = v2s16((blockpos.X * MAP_BLOCKSIZE) + MAP_BLOCKSIZE / 2,
363                                         (blockpos.Y * MAP_BLOCKSIZE) + MAP_BLOCKSIZE / 2);
364         int ground_level = getGroundLevelAtPoint(p);
365         return blockpos.Y * (MAP_BLOCKSIZE + 1) <= min(water_level, ground_level);
366 #endif
367
368         // Use a simple heuristic; the above method is wildly inaccurate anyway.
369         return blockpos.Y * (MAP_BLOCKSIZE + 1) <= params.water_level;
370 }
371
372
373 void EmergeManager::getMapgenNames(
374         std::vector<const char *> *mgnames, bool include_hidden)
375 {
376         for (u32 i = 0; i != ARRLEN(g_reg_mapgens); i++) {
377                 if (include_hidden || g_reg_mapgens[i].is_user_visible)
378                         mgnames->push_back(g_reg_mapgens[i].name);
379         }
380 }
381
382
383 MapgenFactory *EmergeManager::getMapgenFactory(const std::string &mgname)
384 {
385         for (u32 i = 0; i != ARRLEN(g_reg_mapgens); i++) {
386                 if (mgname == g_reg_mapgens[i].name)
387                         return g_reg_mapgens[i].factory;
388         }
389
390         return NULL;
391 }
392
393
394 bool EmergeManager::pushBlockEmergeData(
395         v3s16 pos,
396         u16 peer_requested,
397         u16 flags,
398         EmergeCompletionCallback callback,
399         void *callback_param,
400         bool *entry_already_exists)
401 {
402         u16 &count_peer = m_peer_queue_count[peer_requested];
403
404         if ((flags & BLOCK_EMERGE_FORCE_QUEUE) == 0) {
405                 if (m_blocks_enqueued.size() >= m_qlimit_total)
406                         return false;
407
408                 if (peer_requested != PEER_ID_INEXISTENT) {
409                         u16 qlimit_peer = (flags & BLOCK_EMERGE_ALLOW_GEN) ?
410                                 m_qlimit_generate : m_qlimit_diskonly;
411                         if (count_peer >= qlimit_peer)
412                                 return false;
413                 }
414         }
415
416         std::pair<std::map<v3s16, BlockEmergeData>::iterator, bool> findres;
417         findres = m_blocks_enqueued.insert(std::make_pair(pos, BlockEmergeData()));
418
419         BlockEmergeData &bedata = findres.first->second;
420         *entry_already_exists   = !findres.second;
421
422         if (callback)
423                 bedata.callbacks.push_back(std::make_pair(callback, callback_param));
424
425         if (*entry_already_exists) {
426                 bedata.flags |= flags;
427         } else {
428                 bedata.flags = flags;
429                 bedata.peer_requested = peer_requested;
430
431                 count_peer++;
432         }
433
434         return true;
435 }
436
437
438 bool EmergeManager::popBlockEmergeData(
439         v3s16 pos,
440         BlockEmergeData *bedata)
441 {
442         std::map<v3s16, BlockEmergeData>::iterator it;
443         std::map<u16, u16>::iterator it2;
444
445         it = m_blocks_enqueued.find(pos);
446         if (it == m_blocks_enqueued.end())
447                 return false;
448
449         *bedata = it->second;
450
451         it2 = m_peer_queue_count.find(bedata->peer_requested);
452         if (it2 == m_peer_queue_count.end())
453                 return false;
454
455         u16 &count_peer = it2->second;
456         assert(count_peer != 0);
457         count_peer--;
458
459         m_blocks_enqueued.erase(it);
460
461         return true;
462 }
463
464
465 EmergeThread *EmergeManager::getOptimalThread()
466 {
467         size_t nthreads = m_threads.size();
468
469         FATAL_ERROR_IF(nthreads == 0, "No emerge threads!");
470
471         size_t index = 0;
472         size_t nitems_lowest = m_threads[0]->m_block_queue.size();
473
474         for (size_t i = 1; i < nthreads; i++) {
475                 size_t nitems = m_threads[i]->m_block_queue.size();
476                 if (nitems < nitems_lowest) {
477                         index = i;
478                         nitems_lowest = nitems;
479                 }
480         }
481
482         return m_threads[index];
483 }
484
485
486 ////
487 //// EmergeThread
488 ////
489
490 EmergeThread::EmergeThread(Server *server, int ethreadid) :
491         enable_mapgen_debug_info(false),
492         id(ethreadid),
493         m_server(server),
494         m_map(NULL),
495         m_emerge(NULL),
496         m_mapgen(NULL)
497 {
498         m_name = "Emerge-" + itos(ethreadid);
499 }
500
501
502 EmergeThread::~EmergeThread()
503 {
504         //cancelPendingItems();
505 }
506
507
508 void EmergeThread::signal()
509 {
510         m_queue_event.signal();
511 }
512
513
514 bool EmergeThread::pushBlock(v3s16 pos)
515 {
516         m_block_queue.push(pos);
517         return true;
518 }
519
520
521 void EmergeThread::cancelPendingItems()
522 {
523         MutexAutoLock queuelock(m_emerge->m_queue_mutex);
524
525         while (!m_block_queue.empty()) {
526                 BlockEmergeData bedata;
527                 v3s16 pos;
528
529                 pos = m_block_queue.front();
530                 m_block_queue.pop();
531
532                 m_emerge->popBlockEmergeData(pos, &bedata);
533
534                 runCompletionCallbacks(pos, EMERGE_CANCELLED, bedata.callbacks);
535         }
536 }
537
538
539 void EmergeThread::runCompletionCallbacks(
540         v3s16 pos,
541         EmergeAction action,
542         const EmergeCallbackList &callbacks)
543 {
544         for (size_t i = 0; i != callbacks.size(); i++) {
545                 EmergeCompletionCallback callback;
546                 void *param;
547
548                 callback = callbacks[i].first;
549                 param    = callbacks[i].second;
550
551                 callback(pos, action, param);
552         }
553 }
554
555
556 bool EmergeThread::popBlockEmerge(v3s16 *pos, BlockEmergeData *bedata)
557 {
558         MutexAutoLock queuelock(m_emerge->m_queue_mutex);
559
560         if (m_block_queue.empty())
561                 return false;
562
563         *pos = m_block_queue.front();
564         m_block_queue.pop();
565
566         m_emerge->popBlockEmergeData(*pos, bedata);
567
568         return true;
569 }
570
571
572 EmergeAction EmergeThread::getBlockOrStartGen(
573         v3s16 pos, bool allow_gen, MapBlock **block, BlockMakeData *bmdata)
574 {
575         MutexAutoLock envlock(m_server->m_env_mutex);
576
577         // 1). Attempt to fetch block from memory
578         *block = m_map->getBlockNoCreateNoEx(pos);
579         if (*block && !(*block)->isDummy() && (*block)->isGenerated())
580                 return EMERGE_FROM_MEMORY;
581
582         // 2). Attempt to load block from disk
583         *block = m_map->loadBlock(pos);
584         if (*block && (*block)->isGenerated())
585                 return EMERGE_FROM_DISK;
586
587         // 3). Attempt to start generation
588         if (allow_gen && m_map->initBlockMake(pos, bmdata))
589                 return EMERGE_GENERATED;
590
591         // All attempts failed; cancel this block emerge
592         return EMERGE_CANCELLED;
593 }
594
595
596 MapBlock *EmergeThread::finishGen(v3s16 pos, BlockMakeData *bmdata,
597         std::map<v3s16, MapBlock *> *modified_blocks)
598 {
599         MutexAutoLock envlock(m_server->m_env_mutex);
600         ScopeProfiler sp(g_profiler,
601                 "EmergeThread: after Mapgen::makeChunk", SPT_AVG);
602
603         /*
604                 Perform post-processing on blocks (invalidate lighting, queue liquid
605                 transforms, etc.) to finish block make
606         */
607         m_map->finishBlockMake(bmdata, modified_blocks);
608
609         MapBlock *block = m_map->getBlockNoCreateNoEx(pos);
610         if (!block) {
611                 errorstream << "EmergeThread::finishGen: Couldn't grab block we "
612                         "just generated: " << PP(pos) << std::endl;
613                 return NULL;
614         }
615
616         v3s16 minp = bmdata->blockpos_min * MAP_BLOCKSIZE;
617         v3s16 maxp = bmdata->blockpos_max * MAP_BLOCKSIZE +
618                                  v3s16(1,1,1) * (MAP_BLOCKSIZE - 1);
619
620         // Ignore map edit events, they will not need to be sent
621         // to anybody because the block hasn't been sent to anybody
622         MapEditEventAreaIgnorer ign(
623                 &m_server->m_ignore_map_edit_events_area,
624                 VoxelArea(minp, maxp));
625
626         /*
627                 Run Lua on_generated callbacks
628         */
629         try {
630                 m_server->getScriptIface()->environment_OnGenerated(
631                         minp, maxp, m_mapgen->blockseed);
632         } catch (LuaError &e) {
633                 m_server->setAsyncFatalError("Lua: " + std::string(e.what()));
634         }
635
636         EMERGE_DBG_OUT("ended up with: " << analyze_block(block));
637
638         /*
639                 Activate the block
640         */
641         m_server->m_env->activateBlock(block, 0);
642
643         return block;
644 }
645
646
647 void *EmergeThread::run()
648 {
649         DSTACK(FUNCTION_NAME);
650         BEGIN_DEBUG_EXCEPTION_HANDLER
651
652         v3s16 pos;
653
654         m_map    = (ServerMap *)&(m_server->m_env->getMap());
655         m_emerge = m_server->m_emerge;
656         m_mapgen = m_emerge->m_mapgens[id];
657         enable_mapgen_debug_info = m_emerge->enable_mapgen_debug_info;
658
659         try {
660         while (!stopRequested()) {
661                 std::map<v3s16, MapBlock *> modified_blocks;
662                 BlockEmergeData bedata;
663                 BlockMakeData bmdata;
664                 EmergeAction action;
665                 MapBlock *block;
666
667                 if (!popBlockEmerge(&pos, &bedata)) {
668                         m_queue_event.wait();
669                         continue;
670                 }
671
672                 if (blockpos_over_limit(pos))
673                         continue;
674
675                 bool allow_gen = bedata.flags & BLOCK_EMERGE_ALLOW_GEN;
676                 EMERGE_DBG_OUT("pos=" PP(pos) " allow_gen=" << allow_gen);
677
678                 action = getBlockOrStartGen(pos, allow_gen, &block, &bmdata);
679                 if (action == EMERGE_GENERATED) {
680                         {
681                                 ScopeProfiler sp(g_profiler,
682                                         "EmergeThread: Mapgen::makeChunk", SPT_AVG);
683                                 TimeTaker t("mapgen::make_block()");
684
685                                 m_mapgen->makeChunk(&bmdata);
686
687                                 if (enable_mapgen_debug_info == false)
688                                         t.stop(true); // Hide output
689                         }
690
691                         block = finishGen(pos, &bmdata, &modified_blocks);
692                 }
693
694                 runCompletionCallbacks(pos, action, bedata.callbacks);
695
696                 if (block)
697                         modified_blocks[pos] = block;
698
699                 if (modified_blocks.size() > 0)
700                         m_server->SetBlocksNotSent(modified_blocks);
701         }
702         } catch (VersionMismatchException &e) {
703                 std::ostringstream err;
704                 err << "World data version mismatch in MapBlock " << PP(pos) << std::endl
705                         << "----" << std::endl
706                         << "\"" << e.what() << "\"" << std::endl
707                         << "See debug.txt." << std::endl
708                         << "World probably saved by a newer version of " PROJECT_NAME_C "."
709                         << std::endl;
710                 m_server->setAsyncFatalError(err.str());
711         } catch (SerializationError &e) {
712                 std::ostringstream err;
713                 err << "Invalid data in MapBlock " << PP(pos) << std::endl
714                         << "----" << std::endl
715                         << "\"" << e.what() << "\"" << std::endl
716                         << "See debug.txt." << std::endl
717                         << "You can ignore this using [ignore_world_load_errors = true]."
718                         << std::endl;
719                 m_server->setAsyncFatalError(err.str());
720         }
721
722         END_DEBUG_EXCEPTION_HANDLER
723         return NULL;
724 }