aboutsummaryrefslogtreecommitdiff
path: root/src/util/areastore.h
blob: bebecfd78d4d332967b7f98bf69c658455bd4c14 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
/*
Minetest
Copyright (C) 2015 est31 <mtest31@outlook.com>

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.
*/

#ifndef AREA_STORE_H_
#define AREA_STORE_H_

#include "irr_v3d.h"
#include "noise.h" // for PcgRandom
#include <map>
#include <list>
#include <vector>
#include <istream>
#include "util/container.h"
#include "util/numeric.h"
#ifndef ANDROID
	#include "cmake_config.h"
#endif
#if USE_SPATIAL
	#include <spatialindex/SpatialIndex.h>
	#include "util/serialize.h"
#endif


struct Area {
	Area() : id(U32_MAX) {}
	Area(const v3s16 &mine, const v3s16 &maxe) :
		id(U32_MAX), minedge(mine), maxedge(maxe)
	{
		sortBoxVerticies(minedge, maxedge);
	}

	u32 id;
	v3s16 minedge, maxedge;
	std::string data;
};


class AreaStore {
public:
	AreaStore() :
		m_cache_enabled(true),
		m_cacheblock_radius(64),
		m_res_cache(1000, &cacheMiss, this),
		m_next_id(0)
	{}

	virtual ~AreaStore() {}

	static AreaStore *getOptimalImplementation();

	virtual void reserve(size_t count) {};
	size_t size() const { return areas_map.size(); }

	/// Add an area to the store.
	/// Updates the area's ID if it hasn't already been set.
	/// @return Whether the area insertion was successful.
	virtual bool insertArea(Area *a) = 0;

	/// Removes an area from the store by ID.
	/// @return Whether the area was in the store and removed.
	virtual bool removeArea(u32 id) = 0;

	/// Finds areas that the passed position is contained in.
	/// Stores output in passed vector.
	void getAreasForPos(std::vector<Area *> *result, v3s16 pos);

	/// Finds areas that are completely contained inside the area defined
	/// by the passed edges.  If @p accept_overlap is true this finds any
	/// areas that intersect with the passed area at any point.
	virtual void getAreasInArea(std::vector<Area *> *result,
		v3s16 minedge, v3s16 maxedge, bool accept_overlap) = 0;

	/// Sets cache parameters.
	void setCacheParams(bool enabled, u8 block_radius, size_t limit);

	/// Returns a pointer to the area coresponding to the passed ID,
	/// or NULL if it doesn't exist.
	const Area *getArea(u32 id) const;

	/// Serializes the store's areas to a binary ostream.
	void serialize(std::ostream &is) const;

	/// Deserializes the Areas from a binary istream.
	/// This does not currently clear the AreaStore before adding the
	/// areas, making it possible to deserialize multiple serialized
	/// AreaStores.
	void deserialize(std::istream &is);

protected:
	/// Invalidates the getAreasForPos cache.
	/// Call after adding or removing an area.
	void invalidateCache();

	/// Implementation of getAreasForPos.
	/// getAreasForPos calls this if the cache is disabled.
	virtual void getAreasForPosImpl(std::vector<Area *> *result, v3s16 pos) = 0;

	/// Returns the next area ID and increments it.
	u32 getNextId() { return m_next_id++; }

	// Note: This can't be an unordered_map, since all
	// references would be invalidated on rehash.
	typedef std::map<u32, Area> AreaMap;
	AreaMap areas_map;

private:
	/// Called by the cache when a value isn't found in the cache.
	static void cacheMiss(void *data, const v3s16 &mpos, std::vector<Area *> *dest);

	bool m_cache_enabled;
	/// Range, in nodes, of the getAreasForPos cache.
	/// If you modify this, call invalidateCache()
	u8 m_cacheblock_radius;
	LRUCache<v3s16, std::vector<Area *> > m_res_cache;

	u32 m_next_id;
};


class VectorAreaStore : public AreaStore {
public:
	virtual void reserve(size_t count) { m_areas.reserve(count); }
	virtual bool insertArea(Area *a);
	virtual bool removeArea(u32 id);
	virtual void getAreasInArea(std::vector<Area *> *result,
		v3s16 minedge, v3s16 maxedge, bool accept_overlap);

protected:
	virtual void getAreasForPosImpl(std::vector<Area *> *result, v3s16 pos);

private:
	std::vector<Area *> m_areas;
};


#if USE_SPATIAL

class SpatialAreaStore : public AreaStore {
public:
	SpatialAreaStore();
	virtual ~SpatialAreaStore();

	virtual bool insertArea(Area *a);
	virtual bool removeArea(u32 id);
	virtual void getAreasInArea(std::vector<Area *> *result,
		v3s16 minedge, v3s16 maxedge, bool accept_overlap);

protected:
	virtual void getAreasForPosImpl(std::vector<Area *> *result, v3s16 pos);

private:
	SpatialIndex::ISpatialIndex *m_tree;
	SpatialIndex::IStorageManager *m_storagemanager;

	class VectorResultVisitor : public SpatialIndex::IVisitor {
	public:
		VectorResultVisitor(std::vector<Area *> *result, SpatialAreaStore *store) :
			m_store(store),
			m_result(result)
		{}
		~VectorResultVisitor() {}

		virtual void visitNode(const SpatialIndex::INode &in) {}

		virtual void visitData(const SpatialIndex::IData &in)
		{
			u32 id = in.getIdentifier();

			std::map<u32, Area>::iterator itr = m_store->areas_map.find(id);
			assert(itr != m_store->areas_map.end());
			m_result->push_back(&itr->second);
		}

		virtual void visitData(std::vector<const SpatialIndex::IData *> &v)
		{
			for (size_t i = 0; i < v.size(); i++)
				visitData(*(v[i]));
		}

	private:
		SpatialAreaStore *m_store;
		std::vector<Area *> *m_result;
	};
};

#endif // USE_SPATIAL

#endif // AREA_STORE_H_
): SimpleThread(), m_server(server) { } void * Thread(); }; class EmergeThread : public SimpleThread { Server *m_server; public: EmergeThread(Server *server): SimpleThread(), m_server(server) { } void * Thread(); void trigger() { setRun(true); if(IsRunning() == false) { Start(); } } }; struct PlayerInfo { u16 id; char name[PLAYERNAME_SIZE]; v3f position; Address address; float avg_rtt; PlayerInfo(); void PrintLine(std::ostream *s); }; u32 PIChecksum(core::list<PlayerInfo> &l); /* Used for queueing and sorting block transfers in containers Lower priority number means higher priority. */ struct PrioritySortedBlockTransfer { PrioritySortedBlockTransfer(float a_priority, v3s16 a_pos, u16 a_peer_id) { priority = a_priority; pos = a_pos; peer_id = a_peer_id; } bool operator < (PrioritySortedBlockTransfer &other) { return priority < other.priority; } float priority; v3s16 pos; u16 peer_id; }; class RemoteClient { public: // peer_id=0 means this client has no associated peer // NOTE: If client is made allowed to exist while peer doesn't, // this has to be set to 0 when there is no peer. // Also, the client must be moved to some other container. u16 peer_id; // The serialization version to use with the client u8 serialization_version; // Version is stored in here after INIT before INIT2 u8 pending_serialization_version; RemoteClient(): m_time_from_building(9999) { peer_id = 0; serialization_version = SER_FMT_VER_INVALID; pending_serialization_version = SER_FMT_VER_INVALID; m_nearest_unsent_d = 0; m_nearest_unsent_reset_timer = 0.0; m_blocks_sent_mutex.Init(); m_blocks_sending_mutex.Init(); /*m_dig_mutex.Init(); m_dig_time_remaining = 0; m_dig_tool_item = -1;*/ } ~RemoteClient() { } /* Finds block that should be sent next to the client. Environment should be locked when this is called. dtime is used for resetting send radius at slow interval */ void GetNextBlocks(Server *server, float dtime, core::array<PrioritySortedBlockTransfer> &dest); /* Connection and environment should be locked when this is called. steps() objects of blocks not found in active_blocks, then adds those blocks to active_blocks */ void SendObjectData( Server *server, float dtime, core::map<v3s16, bool> &stepped_blocks ); void GotBlock(v3s16 p); void SentBlock(v3s16 p); void SetBlockNotSent(v3s16 p); void SetBlocksNotSent(core::map<v3s16, MapBlock*> &blocks); s32 SendingCount() { JMutexAutoLock lock(m_blocks_sending_mutex); return m_blocks_sending.size(); } // Increments timeouts and removes timed-out blocks from list // NOTE: This doesn't fix the server-not-sending-block bug // because it is related to emerging, not sending. //void RunSendingTimeouts(float dtime, float timeout); void PrintInfo(std::ostream &o) { JMutexAutoLock l2(m_blocks_sent_mutex); JMutexAutoLock l3(m_blocks_sending_mutex); o<<"RemoteClient "<<peer_id<<": " <<", m_blocks_sent.size()="<<m_blocks_sent.size() <<", m_blocks_sending.size()="<<m_blocks_sending.size() <<", m_nearest_unsent_d="<<m_nearest_unsent_d <<std::endl; } // Time from last placing or removing blocks MutexedVariable<float> m_time_from_building; /*JMutex m_dig_mutex; float m_dig_time_remaining; // -1 = not digging s16 m_dig_tool_item; v3s16 m_dig_position;*/ private: /* All members that are accessed by many threads should obviously be behind a mutex. The threads include: - main thread (calls step()) - server thread (calls AsyncRunStep() and Receive()) - emerge thread */ //TODO: core::map<v3s16, MapBlock*> m_active_blocks //NOTE: Not here, it should be server-wide! // Number of blocks in the emerge queue that have this client as // a receiver. Used for throttling network usage. //MutexedVariable<s16> m_num_blocks_in_emerge_queue; /* Blocks that have been sent to client. - These don't have to be sent again. - A block is cleared from here when client says it has deleted it from it's memory Key is position, value is dummy. No MapBlock* is stored here because the blocks can get deleted. */ core::map<v3s16, bool> m_blocks_sent; s16 m_nearest_unsent_d; v3s16 m_last_center; float m_nearest_unsent_reset_timer; JMutex m_blocks_sent_mutex; /* Blocks that are currently on the line. This is used for throttling the sending of blocks. - The size of this list is limited to some value Block is added when it is sent with BLOCKDATA. Block is removed when GOTBLOCKS is received. Value is time from sending. (not used at the moment) */ core::map<v3s16, float> m_blocks_sending; JMutex m_blocks_sending_mutex; }; /*struct ServerSettings { ServerSettings() { creative_mode = false; } bool creative_mode; };*/ class Server : public con::PeerHandler { public: /* NOTE: Every public method should be thread-safe */ Server( std::string mapsavedir, HMParams hm_params, MapParams map_params ); ~Server(); void start(unsigned short port); void stop(); // This is mainly a way to pass the time to the server. // Actual processing is done in an another thread. void step(float dtime); // This is run by ServerThread and does the actual processing void AsyncRunStep(); void Receive(); void ProcessData(u8 *data, u32 datasize, u16 peer_id); /*void Send(u16 peer_id, u16 channelnum, SharedBuffer<u8> data, bool reliable);*/ // Environment and Connection must be locked when called void SendBlockNoLock(u16 peer_id, MapBlock *block, u8 ver); //TODO: Sending of many blocks in a single packet // Environment and Connection must be locked when called //void SendSectorMeta(u16 peer_id, core::list<v2s16> ps, u8 ver); core::list<PlayerInfo> getPlayerInfo(); u32 getDayNightRatio() { s32 d = 8; s32 t = (((m_time_of_day.get() + 24000/d/2)%24000)/(24000/d)); if(t == d/4 || t == (d-d/4)) return 600; else if(t < d/4 || t > (d-d/4)) return 300; else return 1000; } private: // Virtual methods from con::PeerHandler. // As of now, these create and remove clients and players. // TODO: Make it possible to leave players on server. void peerAdded(con::Peer *peer); void deletingPeer(con::Peer *peer, bool timeout); // Envlock and conlock should be locked when calling these void SendObjectData(float dtime); void SendPlayerInfos(); void SendInventory(u16 peer_id); void SendChatMessage(u16 peer_id, const std::wstring &message); void BroadcastChatMessage(const std::wstring &message); // Sends blocks to clients void SendBlocks(float dtime); // When called, connection mutex should be locked RemoteClient* getClient(u16 peer_id); /* Update water pressure. This also adds suitable nodes to active_nodes. environment has to be locked when calling. */ void UpdateBlockWaterPressure(MapBlock *block, core::map<v3s16, MapBlock*> &modified_blocks); // Locks environment and connection by its own struct PeerChange; void handlePeerChange(PeerChange &c); void handlePeerChanges(); float m_flowwater_timer; float m_print_info_timer; float m_objectdata_timer; float m_emergethread_trigger_timer; float m_savemap_timer; // NOTE: If connection and environment are both to be locked, // environment shall be locked first. JMutex m_env_mutex; Environment m_env; JMutex m_con_mutex; con::Connection m_con; core::map<u16, RemoteClient*> m_clients; // Behind the con mutex float m_step_dtime; JMutex m_step_dtime_mutex; ServerThread m_thread; EmergeThread m_emergethread; BlockEmergeQueue m_emerge_queue; // Nodes that are destinations of flowing liquid at the moment core::map<v3s16, u8> m_flow_active_nodes; // 0-23999 MutexedVariable<u32> m_time_of_day; // Used to buffer dtime for adding to m_time_of_day float m_time_counter; float m_time_of_day_send_timer; MutexedVariable<float> m_uptime; enum PeerChangeType { PEER_ADDED, PEER_REMOVED }; struct PeerChange { PeerChangeType type; u16 peer_id; bool timeout; }; Queue<PeerChange> m_peer_change_queue; friend class EmergeThread; friend class RemoteClient; }; #endif