X-Git-Url: https://git.lizzy.rs/?a=blobdiff_plain;f=src%2Femerge.h;h=1bac4b70830d968156be7b636d214541dcde3f5a;hb=8fded9d990d1e1142b630b24c96f1a2c959fef36;hp=d5bb72f85d0303f2fc4282522f18530e6ec09de9;hpb=c3708b456e90bccf19e7c82c54a93c8cb7c8896c;p=minetest.git diff --git a/src/emerge.h b/src/emerge.h index d5bb72f85..1bac4b708 100644 --- a/src/emerge.h +++ b/src/emerge.h @@ -17,120 +17,220 @@ with this program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. */ -#ifndef EMERGE_HEADER -#define EMERGE_HEADER +#pragma once #include +#include +#include "network/networkprotocol.h" #include "irr_v3d.h" #include "util/container.h" -#include "map.h" // for ManualMapVoxelManipulator +#include "util/metricsbackend.h" +#include "mapgen/mapgen.h" // for MapgenParams +#include "map.h" -#define MGPARAMS_SET_MGNAME 1 -#define MGPARAMS_SET_SEED 2 -#define MGPARAMS_SET_WATER_LEVEL 4 -#define MGPARAMS_SET_FLAGS 8 +#define BLOCK_EMERGE_ALLOW_GEN (1 << 0) +#define BLOCK_EMERGE_FORCE_QUEUE (1 << 1) -#define BLOCK_EMERGE_ALLOWGEN (1<<0) - -#define EMERGE_DBG_OUT(x) \ - { if (enable_mapgen_debug_info) \ - infostream << "EmergeThread: " x << std::endl; } +#define EMERGE_DBG_OUT(x) { \ + if (enable_mapgen_debug_info) \ + infostream << "EmergeThread: " x << std::endl; \ +} class EmergeThread; -class Mapgen; -struct MapgenParams; -struct MapgenFactory; -class Biome; -class BiomeDefManager; -class Decoration; -class Ore; -class INodeDefManager; +class NodeDefManager; class Settings; +class BiomeManager; +class OreManager; +class DecorationManager; +class SchematicManager; +class Server; +class ModApiMapgen; + +// Structure containing inputs/outputs for chunk generation struct BlockMakeData { - ManualMapVoxelManipulator *vmanip; - u64 seed; + MMVManip *vmanip = nullptr; + u64 seed = 0; v3s16 blockpos_min; v3s16 blockpos_max; - v3s16 blockpos_requested; UniqueQueue transforming_liquid; - INodeDefManager *nodedef; + const NodeDefManager *nodedef = nullptr; - BlockMakeData(): - vmanip(NULL), - seed(0), - nodedef(NULL) - {} + BlockMakeData() = default; ~BlockMakeData() { delete vmanip; } }; +// Result from processing an item on the emerge queue +enum EmergeAction { + EMERGE_CANCELLED, + EMERGE_ERRORED, + EMERGE_FROM_MEMORY, + EMERGE_FROM_DISK, + EMERGE_GENERATED, +}; + +const static std::string emergeActionStrs[] = { + "cancelled", + "errored", + "from_memory", + "from_disk", + "generated", +}; + +// Callback +typedef void (*EmergeCompletionCallback)( + v3s16 blockpos, EmergeAction action, void *param); + +typedef std::vector< + std::pair< + EmergeCompletionCallback, + void * + > +> EmergeCallbackList; + struct BlockEmergeData { u16 peer_requested; - u8 flags; + u16 flags; + EmergeCallbackList callbacks; }; -class IBackgroundBlockEmerger -{ +class EmergeParams { + friend class EmergeManager; public: - virtual bool enqueueBlockEmerge(u16 peer_id, v3s16 p, - bool allow_generate) = 0; - virtual ~IBackgroundBlockEmerger() {} + EmergeParams() = delete; + ~EmergeParams(); + DISABLE_CLASS_COPY(EmergeParams); + + const NodeDefManager *ndef; // shared + bool enable_mapgen_debug_info; + + u32 gen_notify_on; + const std::set *gen_notify_on_deco_ids; // shared + + BiomeGen *biomegen; + BiomeManager *biomemgr; + OreManager *oremgr; + DecorationManager *decomgr; + SchematicManager *schemmgr; + +private: + EmergeParams(EmergeManager *parent, const BiomeGen *biomegen, + const BiomeManager *biomemgr, + const OreManager *oremgr, const DecorationManager *decomgr, + const SchematicManager *schemmgr); }; -class EmergeManager : public IBackgroundBlockEmerger { +class EmergeManager { + /* The mod API needs unchecked access to allow: + * - using decomgr or oremgr to place decos/ores + * - using schemmgr to load and place schematics + */ + friend class ModApiMapgen; public: - INodeDefManager *ndef; - - std::map mglist; + const NodeDefManager *ndef; + bool enable_mapgen_debug_info; + + // Generation Notify + u32 gen_notify_on = 0; + std::set gen_notify_on_deco_ids; + + // Parameters passed to mapgens owned by ServerMap + // TODO(hmmmm): Remove this after mapgen helper methods using them + // are moved to ServerMap + MapgenParams *mgparams; + + // Hackish workaround: + // For now, EmergeManager must hold onto a ptr to the Map's setting manager + // since the Map can only be accessed through the Environment, and the + // Environment is not created until after script initialization. + MapSettingsManager *map_settings_mgr; + + // Methods + EmergeManager(Server *server, MetricsBackend *mb); + ~EmergeManager(); + DISABLE_CLASS_COPY(EmergeManager); - std::vector mapgen; - std::vector emergethread; + const BiomeGen *getBiomeGen() const { return biomegen; } - //settings - MapgenParams *params; - bool mapgen_debug_info; - u16 qlimit_total; - u16 qlimit_diskonly; - u16 qlimit_generate; + // no usage restrictions + const BiomeManager *getBiomeManager() const { return biomemgr; } + const OreManager *getOreManager() const { return oremgr; } + const DecorationManager *getDecorationManager() const { return decomgr; } + const SchematicManager *getSchematicManager() const { return schemmgr; } + // only usable before mapgen init + BiomeManager *getWritableBiomeManager(); + OreManager *getWritableOreManager(); + DecorationManager *getWritableDecorationManager(); + SchematicManager *getWritableSchematicManager(); - u32 gennotify; + void initMapgens(MapgenParams *mgparams); - MapgenParams *luaoverride_params; - u32 luaoverride_params_modified; - u32 luaoverride_flagmask; + void startThreads(); + void stopThreads(); + bool isRunning(); - //block emerge queue data structures - JMutex queuemutex; - std::map blocks_enqueued; - std::map peer_queue_count; + bool enqueueBlockEmerge( + session_t peer_id, + v3s16 blockpos, + bool allow_generate, + bool ignore_queue_limits=false); - //Mapgen-related structures - BiomeDefManager *biomedef; - std::vector ores; - std::vector decorations; + bool enqueueBlockEmergeEx( + v3s16 blockpos, + session_t peer_id, + u16 flags, + EmergeCompletionCallback callback, + void *callback_param); - EmergeManager(IGameDef *gamedef); - ~EmergeManager(); + bool isBlockInQueue(v3s16 pos); - void initMapgens(MapgenParams *mgparams); - MapgenParams *setMapgenType(MapgenParams *mgparams, std::string newname); Mapgen *getCurrentMapgen(); - Mapgen *createMapgen(std::string mgname, int mgid, - MapgenParams *mgparams); - MapgenParams *createMapgenParams(std::string mgname); - void triggerAllThreads(); - bool enqueueBlockEmerge(u16 peer_id, v3s16 p, bool allow_generate); - - void registerMapgen(std::string name, MapgenFactory *mgfactory); - MapgenParams *getParamsFromSettings(Settings *settings); - void setParamsToSettings(Settings *settings); - - //mapgen helper methods - Biome *getBiomeAtPoint(v3s16 p); - int getGroundLevelAtPoint(v2s16 p); + + // Mapgen helpers methods + int getSpawnLevelAtPoint(v2s16 p); bool isBlockUnderground(v3s16 blockpos); - u32 getBlockSeed(v3s16 p); -}; -#endif + static v3s16 getContainingChunk(v3s16 blockpos, s16 chunksize); + +private: + std::vector m_mapgens; + std::vector m_threads; + bool m_threads_active = false; + + std::mutex m_queue_mutex; + std::map m_blocks_enqueued; + std::unordered_map m_peer_queue_count; + + u32 m_qlimit_total; + u32 m_qlimit_diskonly; + u32 m_qlimit_generate; + + // Emerge metrics + MetricCounterPtr m_completed_emerge_counter[5]; + + // Managers of various map generation-related components + // Note that each Mapgen gets a copy(!) of these to work with + BiomeGen *biomegen; + BiomeManager *biomemgr; + OreManager *oremgr; + DecorationManager *decomgr; + SchematicManager *schemmgr; + + // Requires m_queue_mutex held + EmergeThread *getOptimalThread(); + + bool pushBlockEmergeData( + v3s16 pos, + u16 peer_requested, + u16 flags, + EmergeCompletionCallback callback, + void *callback_param, + bool *entry_already_exists); + + bool popBlockEmergeData(v3s16 pos, BlockEmergeData *bedata); + + void reportCompletedEmerge(EmergeAction action); + + friend class EmergeThread; +};