51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
*/
-#ifndef MAP_HEADER
-#define MAP_HEADER
+#pragma once
#include <iostream>
#include <sstream>
#include <list>
#include "irrlichttypes_bloated.h"
+#include "mapblock.h"
#include "mapnode.h"
#include "constants.h"
#include "voxel.h"
#include "modifiedstate.h"
#include "util/container.h"
-#include "util/cpp11_container.h"
+#include "util/metricsbackend.h"
+#include "util/numeric.h"
#include "nodetimer.h"
#include "map_settings_manager.h"
+#include "debug.h"
class Settings;
class MapDatabase;
class IGameDef;
class IRollbackManager;
class EmergeManager;
+class MetricsBackend;
class ServerEnvironment;
struct BlockMakeData;
MapEditEvent
*/
-#define MAPTYPE_BASE 0
-#define MAPTYPE_SERVER 1
-#define MAPTYPE_CLIENT 2
-
enum MapEditEventType{
// Node added (changed from air or something else to something)
MEET_ADDNODE,
MEET_REMOVENODE,
// Node swapped (changed without metadata change)
MEET_SWAPNODE,
- // Node metadata of block changed (not knowing which node exactly)
- // p stores block coordinate
+ // Node metadata changed
MEET_BLOCK_NODE_METADATA_CHANGED,
// Anything else (modified_blocks are set unsent)
MEET_OTHER
struct MapEditEvent
{
- MapEditEventType type;
+ MapEditEventType type = MEET_OTHER;
v3s16 p;
- MapNode n;
- std::set<v3s16> modified_blocks;
- u16 already_known_by_peer;
+ MapNode n = CONTENT_AIR;
+ std::vector<v3s16> modified_blocks; // Represents a set
+ bool is_private_change = false;
+
+ MapEditEvent() = default;
- MapEditEvent():
- type(MEET_OTHER),
- n(CONTENT_AIR),
- already_known_by_peer(0)
- { }
+ // Sets the event's position and marks the block as modified.
+ void setPositionModified(v3s16 pos)
+ {
+ assert(modified_blocks.empty()); // only meant for initialization (once)
+ p = pos;
+ modified_blocks.push_back(getNodeBlockPos(pos));
+ }
- MapEditEvent * clone()
+ void setModifiedBlocks(const std::map<v3s16, MapBlock *> blocks)
{
- MapEditEvent *event = new MapEditEvent();
- event->type = type;
- event->p = p;
- event->n = n;
- event->modified_blocks = modified_blocks;
- return event;
+ assert(modified_blocks.empty()); // only meant for initialization (once)
+ modified_blocks.reserve(blocks.size());
+ for (const auto &block : blocks)
+ modified_blocks.push_back(block.first);
}
- VoxelArea getArea()
+ VoxelArea getArea() const
{
switch(type){
case MEET_ADDNODE:
- return VoxelArea(p);
case MEET_REMOVENODE:
- return VoxelArea(p);
case MEET_SWAPNODE:
- return VoxelArea(p);
case MEET_BLOCK_NODE_METADATA_CHANGED:
- {
- v3s16 np1 = p*MAP_BLOCKSIZE;
- v3s16 np2 = np1 + v3s16(1,1,1)*MAP_BLOCKSIZE - v3s16(1,1,1);
- return VoxelArea(np1, np2);
- }
+ return VoxelArea(p);
case MEET_OTHER:
{
VoxelArea a;
- for(std::set<v3s16>::iterator
- i = modified_blocks.begin();
- i != modified_blocks.end(); ++i)
- {
- v3s16 p = *i;
+ for (v3s16 p : modified_blocks) {
v3s16 np1 = p*MAP_BLOCKSIZE;
v3s16 np2 = np1 + v3s16(1,1,1)*MAP_BLOCKSIZE - v3s16(1,1,1);
a.addPoint(np1);
{
public:
// event shall be deleted by caller after the call.
- virtual void onMapEditEvent(MapEditEvent *event) = 0;
+ virtual void onMapEditEvent(const MapEditEvent &event) = 0;
};
class Map /*: public NodeContainer*/
{
public:
- Map(std::ostream &dout, IGameDef *gamedef);
+ Map(IGameDef *gamedef);
virtual ~Map();
-
- /*virtual u16 nodeContainerId() const
- {
- return NODECONTAINER_ID_MAP;
- }*/
-
- virtual s32 mapType() const
- {
- return MAPTYPE_BASE;
- }
+ DISABLE_CLASS_COPY(Map);
/*
Drop (client) or delete (server) the map.
void addEventReceiver(MapEventReceiver *event_receiver);
void removeEventReceiver(MapEventReceiver *event_receiver);
// event shall be deleted by caller after the call.
- void dispatchEvent(MapEditEvent *event);
+ void dispatchEvent(const MapEditEvent &event);
// On failure returns NULL
- MapSector * getSectorNoGenerateNoExNoLock(v2s16 p2d);
+ MapSector * getSectorNoGenerateNoLock(v2s16 p2d);
// Same as the above (there exists no lock anymore)
- MapSector * getSectorNoGenerateNoEx(v2s16 p2d);
- // On failure throws InvalidPositionException
MapSector * getSectorNoGenerate(v2s16 p2d);
- // Gets an existing sector or creates an empty one
- //MapSector * getSectorCreate(v2s16 p2d);
/*
This is overloaded by ClientMap and ServerMap to allow
their differing fetch methods.
*/
virtual MapSector * emergeSector(v2s16 p){ return NULL; }
- virtual MapSector * emergeSector(v2s16 p,
- std::map<v3s16, MapBlock*> &changed_blocks){ return NULL; }
// Returns InvalidPositionException if not found
MapBlock * getBlockNoCreate(v3s16 p);
virtual MapBlock * emergeBlock(v3s16 p, bool create_blank=true)
{ return getBlockNoCreateNoEx(p); }
- inline INodeDefManager * getNodeDefManager() { return m_nodedef; }
-
- // Returns InvalidPositionException if not found
- bool isNodeUnderground(v3s16 p);
+ inline const NodeDefManager * getNodeDefManager() { return m_nodedef; }
bool isValidPosition(v3s16 p);
// throws InvalidPositionException if not found
- void setNode(v3s16 p, MapNode & n);
+ void setNode(v3s16 p, MapNode n);
// Returns a CONTENT_IGNORE node if not found
// If is_valid_position is not NULL then this will be set to true if the
// position is valid, otherwise false
- MapNode getNodeNoEx(v3s16 p, bool *is_valid_position = NULL);
+ MapNode getNode(v3s16 p, bool *is_valid_position = NULL);
/*
These handle lighting but not faces.
*/
- void addNodeAndUpdate(v3s16 p, MapNode n,
+ virtual void addNodeAndUpdate(v3s16 p, MapNode n,
std::map<v3s16, MapBlock*> &modified_blocks,
bool remove_metadata = true);
void removeNodeAndUpdate(v3s16 p,
bool addNodeWithEvent(v3s16 p, MapNode n, bool remove_metadata = true);
bool removeNodeWithEvent(v3s16 p);
- /*
- Takes the blocks at the edges into account
- */
- bool getDayNightDiff(v3s16 blockpos);
-
- //core::aabbox3d<s16> getDisplayedBlockArea();
-
- //bool updateChangedVisibleArea();
-
// Call these before and after saving of many blocks
- virtual void beginSave() { return; }
- virtual void endSave() { return; }
+ virtual void beginSave() {}
+ virtual void endSave() {}
virtual void save(ModifiedState save_level) { FATAL_ERROR("FIXME"); }
+ /*
+ Return true unless the map definitely cannot save blocks.
+ */
+ virtual bool maySaveBlocks() { return true; }
+
// Server implements these.
// Client leaves them as no-op.
virtual bool saveBlock(MapBlock *block) { return false; }
/*
Updates usage timers and unloads unused blocks and sectors.
- Saves modified blocks before unloading on MAPTYPE_SERVER.
+ Saves modified blocks before unloading if possible.
*/
- void timerUpdate(float dtime, float unload_timeout, u32 max_loaded_blocks,
+ void timerUpdate(float dtime, float unload_timeout, s32 max_loaded_blocks,
std::vector<v3s16> *unloaded_blocks=NULL);
/*
Unloads all blocks with a zero refCount().
- Saves modified blocks before unloading on MAPTYPE_SERVER.
+ Saves modified blocks before unloading if possible.
*/
void unloadUnreferencedBlocks(std::vector<v3s16> *unloaded_blocks=NULL);
// For debug printing. Prints "Map: ", "ServerMap: " or "ClientMap: "
virtual void PrintInfo(std::ostream &out);
- void transformLiquids(std::map<v3s16, MapBlock*> & modified_blocks,
- ServerEnvironment *env);
-
/*
Node metadata
These are basically coordinate wrappers to MapBlock
void removeNodeTimer(v3s16 p);
/*
- Misc.
- */
- std::map<v2s16, MapSector*> *getSectorsPtr(){return &m_sectors;}
-
- /*
- Variables
+ Utilities
*/
- void transforming_liquid_add(v3s16 p);
- s32 transforming_liquid_size();
+ // Iterates through all nodes in the area in an unspecified order.
+ // The given callback takes the position as its first argument and the node
+ // as its second. If it returns false, forEachNodeInArea returns early.
+ template<typename F>
+ void forEachNodeInArea(v3s16 minp, v3s16 maxp, F func)
+ {
+ v3s16 bpmin = getNodeBlockPos(minp);
+ v3s16 bpmax = getNodeBlockPos(maxp);
+ for (s16 bz = bpmin.Z; bz <= bpmax.Z; bz++)
+ for (s16 bx = bpmin.X; bx <= bpmax.X; bx++)
+ for (s16 by = bpmin.Y; by <= bpmax.Y; by++) {
+ // y is iterated innermost to make use of the sector cache.
+ v3s16 bp(bx, by, bz);
+ MapBlock *block = getBlockNoCreateNoEx(bp);
+ v3s16 basep = bp * MAP_BLOCKSIZE;
+ s16 minx_block = rangelim(minp.X - basep.X, 0, MAP_BLOCKSIZE - 1);
+ s16 miny_block = rangelim(minp.Y - basep.Y, 0, MAP_BLOCKSIZE - 1);
+ s16 minz_block = rangelim(minp.Z - basep.Z, 0, MAP_BLOCKSIZE - 1);
+ s16 maxx_block = rangelim(maxp.X - basep.X, 0, MAP_BLOCKSIZE - 1);
+ s16 maxy_block = rangelim(maxp.Y - basep.Y, 0, MAP_BLOCKSIZE - 1);
+ s16 maxz_block = rangelim(maxp.Z - basep.Z, 0, MAP_BLOCKSIZE - 1);
+ for (s16 z_block = minz_block; z_block <= maxz_block; z_block++)
+ for (s16 y_block = miny_block; y_block <= maxy_block; y_block++)
+ for (s16 x_block = minx_block; x_block <= maxx_block; x_block++) {
+ v3s16 p = basep + v3s16(x_block, y_block, z_block);
+ MapNode n = block ?
+ block->getNodeNoCheck(x_block, y_block, z_block) :
+ MapNode(CONTENT_IGNORE);
+ if (!func(p, n))
+ return;
+ }
+ }
+ }
bool isBlockOccluded(MapBlock *block, v3s16 cam_pos_nodes);
protected:
- friend class LuaVoxelManip;
-
- std::ostream &m_dout; // A bit deprecated, could be removed
-
IGameDef *m_gamedef;
std::set<MapEventReceiver*> m_event_receivers;
- std::map<v2s16, MapSector*> m_sectors;
+ std::unordered_map<v2s16, MapSector*> m_sectors;
// Be sure to set this to NULL when the cached sector is deleted
- MapSector *m_sector_cache;
+ MapSector *m_sector_cache = nullptr;
v2s16 m_sector_cache_p;
- // Queued transforming water nodes
- UniqueQueue<v3s16> m_transforming_liquid;
-
// This stores the properties of the nodes on the map.
- INodeDefManager *m_nodedef;
+ const NodeDefManager *m_nodedef;
- bool isOccluded(v3s16 p0, v3s16 p1, float step, float stepfac,
- float start_off, float end_off, u32 needed_count);
+ // Can be implemented by child class
+ virtual void reportMetrics(u64 save_time_us, u32 saved_blocks, u32 all_blocks) {}
-private:
- f32 m_transforming_liquid_loop_count_multiplier;
- u32 m_unprocessed_count;
- u64 m_inc_trending_up_start_time; // milliseconds
- bool m_queue_size_timer_started;
-
- DISABLE_CLASS_COPY(Map);
+ bool determineAdditionalOcclusionCheck(const v3s16 &pos_camera,
+ const core::aabbox3d<s16> &block_bounds, v3s16 &check);
+ bool isOccluded(const v3s16 &pos_camera, const v3s16 &pos_target,
+ float step, float stepfac, float start_offset, float end_offset,
+ u32 needed_count);
};
/*
/*
savedir: directory to which map data should be saved
*/
- ServerMap(const std::string &savedir, IGameDef *gamedef, EmergeManager *emerge);
+ ServerMap(const std::string &savedir, IGameDef *gamedef, EmergeManager *emerge, MetricsBackend *mb);
~ServerMap();
- s32 mapType() const
- {
- return MAPTYPE_SERVER;
- }
-
/*
Get a sector from somewhere.
- Check memory
- Check disk (doesn't load blocks)
- Create blank one
*/
- ServerMapSector *createSector(v2s16 p);
+ MapSector *createSector(v2s16 p);
/*
Blocks are generated by using these and makeBlock().
- Create blank filled with CONTENT_IGNORE
*/
- MapBlock *emergeBlock(v3s16 p, bool create_blank=true);
+ MapBlock *emergeBlock(v3s16 p, bool create_blank=true) override;
/*
Try to get a block.
*/
MapBlock *getBlockOrEmerge(v3s16 p3d);
- // Carries out any initialization necessary before block is sent
- void prepareBlock(MapBlock *block);
+ bool isBlockInQueue(v3s16 pos);
- // Helper for placing objects on ground level
- s16 findGroundLevel(v2s16 p2d);
-
- /*
- Misc. helper functions for fiddling with directory and file
- names when saving
- */
- void createDirs(std::string path);
- // returns something like "map/sectors/xxxxxxxx"
- std::string getSectorDir(v2s16 pos, int layout = 2);
- // dirname: final directory name
- v2s16 getSectorPos(const std::string &dirname);
- v3s16 getBlockPos(const std::string §ordir, const std::string &blockfile);
- static std::string getBlockFilename(v3s16 p);
+ void addNodeAndUpdate(v3s16 p, MapNode n,
+ std::map<v3s16, MapBlock*> &modified_blocks,
+ bool remove_metadata) override;
/*
Database functions
*/
static MapDatabase *createDatabase(const std::string &name, const std::string &savedir, Settings &conf);
- // Returns true if the database file does not exist
- bool loadFromFolders();
-
// Call these before and after saving of blocks
- void beginSave();
- void endSave();
+ void beginSave() override;
+ void endSave() override;
- void save(ModifiedState save_level);
+ void save(ModifiedState save_level) override;
void listAllLoadableBlocks(std::vector<v3s16> &dst);
void listAllLoadedBlocks(std::vector<v3s16> &dst);
MapgenParams *getMapgenParams();
- /*void saveChunkMeta();
- void loadChunkMeta();*/
-
- // The sector mutex should be locked when calling most of these
-
- // This only saves sector-specific data such as the heightmap
- // (no MapBlocks)
- // DEPRECATED? Sectors have no metadata anymore.
- void saveSectorMeta(ServerMapSector *sector);
- MapSector* loadSectorMeta(std::string dirname, bool save_after_load);
- bool loadSectorMeta(v2s16 p2d);
-
- bool saveBlock(MapBlock *block);
- static bool saveBlock(MapBlock *block, MapDatabase *db);
- // This will generate a sector with getSector if not found.
- void loadBlock(const std::string §ordir, const std::string &blockfile,
- MapSector *sector, bool save_after_load=false);
+ bool saveBlock(MapBlock *block) override;
+ static bool saveBlock(MapBlock *block, MapDatabase *db, int compression_level = -1);
MapBlock* loadBlock(v3s16 p);
// Database version
void loadBlock(std::string *blob, v3s16 p3d, MapSector *sector, bool save_after_load=false);
- bool deleteBlock(v3s16 blockpos);
+ bool deleteBlock(v3s16 blockpos) override;
void updateVManip(v3s16 pos);
// For debug printing
- virtual void PrintInfo(std::ostream &out);
+ void PrintInfo(std::ostream &out) override;
bool isSavingEnabled(){ return m_map_saving_enabled; }
u64 getSeed();
- s16 getWaterLevel();
/*!
* Fixes lighting in one map block.
bool repairBlockLight(v3s16 blockpos,
std::map<v3s16, MapBlock *> *modified_blocks);
+ void transformLiquids(std::map<v3s16, MapBlock*> & modified_blocks,
+ ServerEnvironment *env);
+
+ void transforming_liquid_add(v3s16 p);
+
MapSettingsManager settings_mgr;
+protected:
+
+ void reportMetrics(u64 save_time_us, u32 saved_blocks, u32 all_blocks) override;
+
private:
+ friend class LuaVoxelManip;
+
// Emerge manager
EmergeManager *m_emerge;
std::string m_savedir;
bool m_map_saving_enabled;
-#if 0
- // Chunk size in MapSectors
- // If 0, chunks are disabled.
- s16 m_chunksize;
- // Chunks
- core::map<v2s16, MapChunk*> m_chunks;
-#endif
+ int m_map_compression_level;
+
+ std::set<v3s16> m_chunks_in_progress;
+
+ // Queued transforming water nodes
+ UniqueQueue<v3s16> m_transforming_liquid;
+ f32 m_transforming_liquid_loop_count_multiplier = 1.0f;
+ u32 m_unprocessed_count = 0;
+ u64 m_inc_trending_up_start_time = 0; // milliseconds
+ bool m_queue_size_timer_started = false;
/*
Metadata is re-written on disk only if this is true.
This is reset to false when written on disk.
*/
- bool m_map_metadata_changed;
- MapDatabase *dbase;
+ bool m_map_metadata_changed = true;
+ MapDatabase *dbase = nullptr;
+ MapDatabase *dbase_ro = nullptr;
+
+ // Map metrics
+ MetricGaugePtr m_loaded_blocks_gauge;
+ MetricCounterPtr m_save_time_counter;
+ MetricCounterPtr m_save_count_counter;
};
{
public:
MMVManip(Map *map);
- virtual ~MMVManip();
+ virtual ~MMVManip() = default;
virtual void clear()
{
m_loaded_blocks.clear();
}
- void setMap(Map *map)
- {m_map = map;}
-
void initialEmerge(v3s16 blockpos_min, v3s16 blockpos_max,
bool load_if_inexistent = true);
void blitBackAll(std::map<v3s16, MapBlock*> * modified_blocks,
bool overwrite_generated = true);
- bool m_is_dirty;
+ /*
+ Creates a copy of this VManip including contents, the copy will not be
+ associated with a Map.
+ */
+ MMVManip *clone() const;
+
+ // Reassociates a copied VManip to a map
+ void reparent(Map *map);
+
+ // Is it impossible to call initialEmerge / blitBackAll?
+ inline bool isOrphan() const { return !m_map; }
+
+ bool m_is_dirty = false;
protected:
- bool m_create_area;
- Map *m_map;
+ MMVManip() {};
+
+ // may be null
+ Map *m_map = nullptr;
/*
key = blockpos
value = flags describing the block
*/
std::map<v3s16, u8> m_loaded_blocks;
};
-
-#endif
projects / minetest.git / blobdiff