src/emerge.h

   1 /*
   2 Minetest
   3 Copyright (C) 2010-2013 kwolekr, Ryan Kwolek <kwolekr@minetest.net>
   4
   5 This program is free software; you can redistribute it and/or modify
   6 it under the terms of the GNU Lesser General Public License as published by
   7 the Free Software Foundation; either version 2.1 of the License, or
   8 (at your option) any later version.
   9
  10 This program is distributed in the hope that it will be useful,
  11 but WITHOUT ANY WARRANTY; without even the implied warranty of
  12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13 GNU Lesser General Public License for more details.
  14
  15 You should have received a copy of the GNU Lesser General Public License along
  16 with this program; if not, write to the Free Software Foundation, Inc.,
  17 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  18 */
  19
  20 #pragma once
  21
  22 #include <map>
  23 #include <mutex>
  24 #include "network/networkprotocol.h"
  25 #include "irr_v3d.h"
  26 #include "util/container.h"
  27 #include "mapgen/mapgen.h" // for MapgenParams
  28 #include "map.h"
  29
  30 #define BLOCK_EMERGE_ALLOW_GEN   (1 << 0)
  31 #define BLOCK_EMERGE_FORCE_QUEUE (1 << 1)
  32
  33 #define EMERGE_DBG_OUT(x) {                            \
  34         if (enable_mapgen_debug_info)                      \
  35                 infostream << "EmergeThread: " x << std::endl; \
  36 }
  37
  38 class EmergeThread;
  39 class NodeDefManager;
  40 class Settings;
  41
  42 class BiomeManager;
  43 class OreManager;
  44 class DecorationManager;
  45 class SchematicManager;
  46 class Server;
  47 class ModApiMapgen;
  48
  49 // Structure containing inputs/outputs for chunk generation
  50 struct BlockMakeData {
  51         MMVManip *vmanip = nullptr;
  52         u64 seed = 0;
  53         v3s16 blockpos_min;
  54         v3s16 blockpos_max;
  55         UniqueQueue<v3s16> transforming_liquid;
  56         const NodeDefManager *nodedef = nullptr;
  57
  58         BlockMakeData() = default;
  59
  60         ~BlockMakeData() { delete vmanip; }
  61 };
  62
  63 // Result from processing an item on the emerge queue
  64 enum EmergeAction {
  65         EMERGE_CANCELLED,
  66         EMERGE_ERRORED,
  67         EMERGE_FROM_MEMORY,
  68         EMERGE_FROM_DISK,
  69         EMERGE_GENERATED,
  70 };
  71
  72 // Callback
  73 typedef void (*EmergeCompletionCallback)(
  74         v3s16 blockpos, EmergeAction action, void *param);
  75
  76 typedef std::vector<
  77         std::pair<
  78                 EmergeCompletionCallback,
  79                 void *
  80         >
  81 > EmergeCallbackList;
  82
  83 struct BlockEmergeData {
  84         u16 peer_requested;
  85         u16 flags;
  86         EmergeCallbackList callbacks;
  87 };
  88
  89 class EmergeParams {
  90         friend class EmergeManager;
  91 public:
  92         EmergeParams() = delete;
  93         ~EmergeParams();
  94         DISABLE_CLASS_COPY(EmergeParams);
  95
  96         const NodeDefManager *ndef; // shared
  97         bool enable_mapgen_debug_info;
  98
  99         u32 gen_notify_on;
 100         const std::set<u32> *gen_notify_on_deco_ids; // shared
 101
 102         BiomeGen *biomegen;
 103         BiomeManager *biomemgr;
 104         OreManager *oremgr;
 105         DecorationManager *decomgr;
 106         SchematicManager *schemmgr;
 107
 108 private:
 109         EmergeParams(EmergeManager *parent, const BiomeGen *biomegen,
 110                 const BiomeManager *biomemgr,
 111                 const OreManager *oremgr, const DecorationManager *decomgr,
 112                 const SchematicManager *schemmgr);
 113 };
 114
 115 class EmergeManager {
 116         /* The mod API needs unchecked access to allow:
 117          * - using decomgr or oremgr to place decos/ores
 118          * - using schemmgr to load and place schematics
 119          */
 120         friend class ModApiMapgen;
 121 public:
 122         const NodeDefManager *ndef;
 123         bool enable_mapgen_debug_info;
 124
 125         // Generation Notify
 126         u32 gen_notify_on = 0;
 127         std::set<u32> gen_notify_on_deco_ids;
 128
 129         // Parameters passed to mapgens owned by ServerMap
 130         // TODO(hmmmm): Remove this after mapgen helper methods using them
 131         // are moved to ServerMap
 132         MapgenParams *mgparams;
 133
 134         // Hackish workaround:
 135         // For now, EmergeManager must hold onto a ptr to the Map's setting manager
 136         // since the Map can only be accessed through the Environment, and the
 137         // Environment is not created until after script initialization.
 138         MapSettingsManager *map_settings_mgr;
 139
 140         // Methods
 141         EmergeManager(Server *server);
 142         ~EmergeManager();
 143         DISABLE_CLASS_COPY(EmergeManager);
 144
 145         const BiomeGen *getBiomeGen() const { return biomegen; }
 146
 147         // no usage restrictions
 148         const BiomeManager *getBiomeManager() const { return biomemgr; }
 149         const OreManager *getOreManager() const { return oremgr; }
 150         const DecorationManager *getDecorationManager() const { return decomgr; }
 151         const SchematicManager *getSchematicManager() const { return schemmgr; }
 152         // only usable before mapgen init
 153         BiomeManager *getWritableBiomeManager();
 154         OreManager *getWritableOreManager();
 155         DecorationManager *getWritableDecorationManager();
 156         SchematicManager *getWritableSchematicManager();
 157
 158         void initMapgens(MapgenParams *mgparams);
 159
 160         void startThreads();
 161         void stopThreads();
 162         bool isRunning();
 163
 164         bool enqueueBlockEmerge(
 165                 session_t peer_id,
 166                 v3s16 blockpos,
 167                 bool allow_generate,
 168                 bool ignore_queue_limits=false);
 169
 170         bool enqueueBlockEmergeEx(
 171                 v3s16 blockpos,
 172                 session_t peer_id,
 173                 u16 flags,
 174                 EmergeCompletionCallback callback,
 175                 void *callback_param);
 176
 177         bool isBlockInQueue(v3s16 pos);
 178
 179         Mapgen *getCurrentMapgen();
 180
 181         // Mapgen helpers methods
 182         int getSpawnLevelAtPoint(v2s16 p);
 183         bool isBlockUnderground(v3s16 blockpos);
 184
 185         static v3s16 getContainingChunk(v3s16 blockpos, s16 chunksize);
 186
 187 private:
 188         std::vector<Mapgen *> m_mapgens;
 189         std::vector<EmergeThread *> m_threads;
 190         bool m_threads_active = false;
 191
 192         std::mutex m_queue_mutex;
 193         std::map<v3s16, BlockEmergeData> m_blocks_enqueued;
 194         std::unordered_map<u16, u32> m_peer_queue_count;
 195
 196         u32 m_qlimit_total;
 197         u32 m_qlimit_diskonly;
 198         u32 m_qlimit_generate;
 199
 200         // Managers of various map generation-related components
 201         // Note that each Mapgen gets a copy(!) of these to work with
 202         BiomeGen *biomegen;
 203         BiomeManager *biomemgr;
 204         OreManager *oremgr;
 205         DecorationManager *decomgr;
 206         SchematicManager *schemmgr;
 207
 208         // Requires m_queue_mutex held
 209         EmergeThread *getOptimalThread();
 210
 211         bool pushBlockEmergeData(
 212                 v3s16 pos,
 213                 u16 peer_requested,
 214                 u16 flags,
 215                 EmergeCompletionCallback callback,
 216                 void *callback_param,
 217                 bool *entry_already_exists);
 218
 219         bool popBlockEmergeData(v3s16 pos, BlockEmergeData *bedata);
 220
 221         friend class EmergeThread;
 222 };