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