-#ifndef EMERGE_HEADER
-#define EMERGE_HEADER
+/*
+Minetest
+Copyright (C) 2010-2013 kwolekr, Ryan Kwolek <kwolekr@minetest.net>
+
+This program is free software; you can redistribute it and/or modify
+it under the terms of the GNU Lesser General Public License as published by
+the Free Software Foundation; either version 2.1 of the License, or
+(at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+GNU Lesser General Public License for more details.
+
+You should have received a copy of the GNU Lesser General Public License along
+with this program; if not, write to the Free Software Foundation, Inc.,
+51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+*/
+
+#pragma once
#include <map>
-#include <queue>
-#include "util/thread.h"
+#include <mutex>
+#include "network/networkprotocol.h"
+#include "irr_v3d.h"
+#include "util/container.h"
+#include "mapgen/mapgen.h" // for MapgenParams
+#include "map.h"
-#define BLOCK_EMERGE_ALLOWGEN (1<<0)
+#define BLOCK_EMERGE_ALLOW_GEN (1 << 0)
+#define BLOCK_EMERGE_FORCE_QUEUE (1 << 1)
-#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 Mapgen;
-class MapgenParams;
-class MapgenFactory;
-class Biome;
-class BiomeDefManager;
class EmergeThread;
-class ManualMapVoxelManipulator;
+class NodeDefManager;
+class Settings;
-#include "server.h"
+class BiomeManager;
+class OreManager;
+class DecorationManager;
+class SchematicManager;
+class Server;
+// 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<v3s16> 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,
+};
+
+// 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 EmergeManager {
public:
- std::map<std::string, MapgenFactory *> mglist;
-
- std::vector<Mapgen *> mapgen;
- std::vector<EmergeThread *> emergethread;
-
- //settings
- MapgenParams *params;
- bool mapgen_debug_info;
- u16 qlimit_total;
- u16 qlimit_diskonly;
- u16 qlimit_generate;
-
- //block emerge queue data structures
- JMutex queuemutex;
- std::map<v3s16, BlockEmergeData *> blocks_enqueued;
- std::map<u16, u16> peer_queue_count;
-
- //biome manager
- BiomeDefManager *biomedef;
-
- EmergeManager(IGameDef *gamedef, BiomeDefManager *bdef);
+ const NodeDefManager *ndef;
+ bool enable_mapgen_debug_info;
+
+ // Generation Notify
+ u32 gen_notify_on = 0;
+ std::set<u32> 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;
+
+ // Managers of various map generation-related components
+ BiomeManager *biomemgr;
+ OreManager *oremgr;
+ DecorationManager *decomgr;
+ SchematicManager *schemmgr;
+
+ // Methods
+ EmergeManager(Server *server);
~EmergeManager();
+ DISABLE_CLASS_COPY(EmergeManager);
void initMapgens(MapgenParams *mgparams);
- Mapgen *createMapgen(std::string mgname, int mgid,
- MapgenParams *mgparams);
- MapgenParams *createMapgenParams(std::string mgname);
- 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);
+
+ void startThreads();
+ void stopThreads();
+ bool isRunning();
+
+ bool enqueueBlockEmerge(
+ session_t peer_id,
+ v3s16 blockpos,
+ bool allow_generate,
+ bool ignore_queue_limits=false);
+
+ bool enqueueBlockEmergeEx(
+ v3s16 blockpos,
+ session_t peer_id,
+ u16 flags,
+ EmergeCompletionCallback callback,
+ void *callback_param);
+
+ v3s16 getContainingChunk(v3s16 blockpos);
+
+ Mapgen *getCurrentMapgen();
+
+ // Mapgen helpers methods
+ int getSpawnLevelAtPoint(v2s16 p);
int getGroundLevelAtPoint(v2s16 p);
bool isBlockUnderground(v3s16 blockpos);
- u32 getBlockSeed(v3s16 p);
-};
-class EmergeThread : public SimpleThread
-{
- Server *m_server;
- ServerMap *map;
- EmergeManager *emerge;
- Mapgen *mapgen;
- bool enable_mapgen_debug_info;
- int id;
-
-public:
- Event qevent;
- std::queue<v3s16> blockqueue;
-
- EmergeThread(Server *server, int ethreadid):
- SimpleThread(),
- m_server(server),
- map(NULL),
- emerge(NULL),
- mapgen(NULL),
- id(ethreadid)
- {
- }
-
- void *Thread();
-
- void trigger()
- {
- setRun(true);
- if(IsRunning() == false)
- {
- Start();
- }
- }
-
- bool popBlockEmerge(v3s16 *pos, u8 *flags);
- bool getBlockOrStartGen(v3s16 p, MapBlock **b,
- BlockMakeData *data, bool allow_generate);
-};
+ static v3s16 getContainingChunk(v3s16 blockpos, s16 chunksize);
+
+private:
+ std::vector<Mapgen *> m_mapgens;
+ std::vector<EmergeThread *> m_threads;
+ bool m_threads_active = false;
-#endif
+ std::mutex m_queue_mutex;
+ std::map<v3s16, BlockEmergeData> m_blocks_enqueued;
+ std::unordered_map<u16, u16> m_peer_queue_count;
+
+ u16 m_qlimit_total;
+ u16 m_qlimit_diskonly;
+ u16 m_qlimit_generate;
+
+ // 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);
+
+ friend class EmergeThread;
+};