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