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