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