3 Copyright (C) 2010 celeron55, Perttu Ahola <celeron55@gmail.com>
5 This program is free software; you can redistribute it and/or modify
6 it under the terms of the GNU General Public License as published by
7 the Free Software Foundation; either version 2 of the License, or
8 (at your option) any later version.
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 General Public License for more details.
15 You should have received a copy of the GNU 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.
21 (c) 2010 Perttu Ahola <celeron55@gmail.com>
27 #include "connection.h"
28 #include "environment.h"
29 #include "common_irrlicht.h"
34 #include "inventory.h"
39 v3f findSpawnPos(ServerMap &map);
42 A structure containing the data needed for queueing the fetching
45 struct QueuedBlockEmerge
48 // key = peer_id, value = flags
49 core::map<u16, u8> peer_ids;
53 This is a thread-safe class.
55 class BlockEmergeQueue
65 JMutexAutoLock lock(m_mutex);
67 core::list<QueuedBlockEmerge*>::Iterator i;
68 for(i=m_queue.begin(); i!=m_queue.end(); i++)
70 QueuedBlockEmerge *q = *i;
76 peer_id=0 adds with nobody to send to
78 void addBlock(u16 peer_id, v3s16 pos, u8 flags)
80 DSTACK(__FUNCTION_NAME);
82 JMutexAutoLock lock(m_mutex);
87 Find if block is already in queue.
88 If it is, update the peer to it and quit.
90 core::list<QueuedBlockEmerge*>::Iterator i;
91 for(i=m_queue.begin(); i!=m_queue.end(); i++)
93 QueuedBlockEmerge *q = *i;
96 q->peer_ids[peer_id] = flags;
105 QueuedBlockEmerge *q = new QueuedBlockEmerge;
108 q->peer_ids[peer_id] = flags;
109 m_queue.push_back(q);
112 // Returned pointer must be deleted
113 // Returns NULL if queue is empty
114 QueuedBlockEmerge * pop()
116 JMutexAutoLock lock(m_mutex);
118 core::list<QueuedBlockEmerge*>::Iterator i = m_queue.begin();
119 if(i == m_queue.end())
121 QueuedBlockEmerge *q = *i;
128 JMutexAutoLock lock(m_mutex);
129 return m_queue.size();
132 u32 peerItemCount(u16 peer_id)
134 JMutexAutoLock lock(m_mutex);
138 core::list<QueuedBlockEmerge*>::Iterator i;
139 for(i=m_queue.begin(); i!=m_queue.end(); i++)
141 QueuedBlockEmerge *q = *i;
142 if(q->peer_ids.find(peer_id) != NULL)
150 core::list<QueuedBlockEmerge*> m_queue;
156 class ServerThread : public SimpleThread
162 ServerThread(Server *server):
171 class EmergeThread : public SimpleThread
177 EmergeThread(Server *server):
188 if(IsRunning() == false)
198 char name[PLAYERNAME_SIZE];
204 void PrintLine(std::ostream *s);
207 u32 PIChecksum(core::list<PlayerInfo> &l);
210 Used for queueing and sorting block transfers in containers
212 Lower priority number means higher priority.
214 struct PrioritySortedBlockTransfer
216 PrioritySortedBlockTransfer(float a_priority, v3s16 a_pos, u16 a_peer_id)
218 priority = a_priority;
222 bool operator < (PrioritySortedBlockTransfer &other)
224 return priority < other.priority;
234 // peer_id=0 means this client has no associated peer
235 // NOTE: If client is made allowed to exist while peer doesn't,
236 // this has to be set to 0 when there is no peer.
237 // Also, the client must be moved to some other container.
239 // The serialization version to use with the client
240 u8 serialization_version;
241 // Version is stored in here after INIT before INIT2
242 u8 pending_serialization_version;
245 m_time_from_building(9999),
246 m_excess_gotblocks(0)
249 serialization_version = SER_FMT_VER_INVALID;
250 pending_serialization_version = SER_FMT_VER_INVALID;
251 m_nearest_unsent_d = 0;
252 m_nearest_unsent_reset_timer = 0.0;
253 m_nothing_to_send_counter = 0;
254 m_nothing_to_send_pause_timer = 0;
261 Finds block that should be sent next to the client.
262 Environment should be locked when this is called.
263 dtime is used for resetting send radius at slow interval
265 void GetNextBlocks(Server *server, float dtime,
266 core::array<PrioritySortedBlockTransfer> &dest);
269 Connection and environment should be locked when this is called.
270 steps() objects of blocks not found in active_blocks, then
271 adds those blocks to active_blocks
276 core::map<v3s16, bool> &stepped_blocks
279 void GotBlock(v3s16 p);
281 void SentBlock(v3s16 p);
283 void SetBlockNotSent(v3s16 p);
284 void SetBlocksNotSent(core::map<v3s16, MapBlock*> &blocks);
288 return m_blocks_sending.size();
291 // Increments timeouts and removes timed-out blocks from list
292 // NOTE: This doesn't fix the server-not-sending-block bug
293 // because it is related to emerging, not sending.
294 //void RunSendingTimeouts(float dtime, float timeout);
296 void PrintInfo(std::ostream &o)
298 o<<"RemoteClient "<<peer_id<<": "
299 <<"m_blocks_sent.size()="<<m_blocks_sent.size()
300 <<", m_blocks_sending.size()="<<m_blocks_sending.size()
301 <<", m_nearest_unsent_d="<<m_nearest_unsent_d
302 <<", m_excess_gotblocks="<<m_excess_gotblocks
304 m_excess_gotblocks = 0;
307 // Time from last placing or removing blocks
308 float m_time_from_building;
310 /*JMutex m_dig_mutex;
311 float m_dig_time_remaining;
314 v3s16 m_dig_position;*/
317 List of active objects that the client knows of.
320 core::map<u16, bool> m_known_objects;
324 Blocks that have been sent to client.
325 - These don't have to be sent again.
326 - A block is cleared from here when client says it has
327 deleted it from it's memory
329 Key is position, value is dummy.
330 No MapBlock* is stored here because the blocks can get deleted.
332 core::map<v3s16, bool> m_blocks_sent;
333 s16 m_nearest_unsent_d;
335 float m_nearest_unsent_reset_timer;
338 Blocks that are currently on the line.
339 This is used for throttling the sending of blocks.
340 - The size of this list is limited to some value
341 Block is added when it is sent with BLOCKDATA.
342 Block is removed when GOTBLOCKS is received.
343 Value is time from sending. (not used at the moment)
345 core::map<v3s16, float> m_blocks_sending;
348 Count of excess GotBlocks().
349 There is an excess amount because the client sometimes
350 gets a block so late that the server sends it again,
351 and the client then sends two GOTBLOCKs.
352 This is resetted by PrintInfo()
354 u32 m_excess_gotblocks;
356 // CPU usage optimization
357 u32 m_nothing_to_send_counter;
358 float m_nothing_to_send_pause_timer;
361 class Server : public con::PeerHandler, public MapEventReceiver,
362 public InventoryManager
366 NOTE: Every public method should be thread-safe
370 std::string mapsavedir
373 void start(unsigned short port);
375 // This is mainly a way to pass the time to the server.
376 // Actual processing is done in an another thread.
377 void step(float dtime);
378 // This is run by ServerThread and does the actual processing
381 void ProcessData(u8 *data, u32 datasize, u16 peer_id);
383 core::list<PlayerInfo> getPlayerInfo();
385 u32 getDayNightRatio()
387 return time_to_daynight_ratio(m_time_of_day.get());
390 bool getShutdownRequested()
392 return m_shutdown_requested.get();
396 Shall be called with the environment locked.
397 This is accessed by the map, which is inside the environment,
398 so it shouldn't be a problem.
400 void onMapEditEvent(MapEditEvent *event);
403 Shall be called with the environment and the connection locked.
405 Inventory* getInventory(InventoryContext *c, std::string id);
406 void inventoryModified(InventoryContext *c, std::string id);
410 // Virtual methods from con::PeerHandler.
411 // As of now, these create and remove clients and players.
412 void peerAdded(con::Peer *peer);
413 void deletingPeer(con::Peer *peer, bool timeout);
419 static void SendHP(con::Connection &con, u16 peer_id, u8 hp);
422 Non-static send methods
425 // Envlock and conlock should be locked when calling these
426 void SendObjectData(float dtime);
427 void SendPlayerInfos();
428 void SendInventory(u16 peer_id);
429 void SendChatMessage(u16 peer_id, const std::wstring &message);
430 void BroadcastChatMessage(const std::wstring &message);
431 void SendPlayerHP(Player *player);
432 void SendMovePlayer(Player *player);
434 Send a node removal/addition event to all clients except ignore_id.
435 Additionally, if far_players!=NULL, players further away than
436 far_d_nodes are ignored and their peer_ids are added to far_players
438 void sendRemoveNode(v3s16 p, u16 ignore_id=0,
439 core::list<u16> *far_players=NULL, float far_d_nodes=100);
440 void sendAddNode(v3s16 p, MapNode n, u16 ignore_id=0,
441 core::list<u16> *far_players=NULL, float far_d_nodes=100);
443 // Environment and Connection must be locked when called
444 void SendBlockNoLock(u16 peer_id, MapBlock *block, u8 ver);
446 // Sends blocks to clients
447 void SendBlocks(float dtime);
453 void UpdateCrafting(u16 peer_id);
455 // When called, connection mutex should be locked
456 RemoteClient* getClient(u16 peer_id);
458 // Connection must be locked when called
459 std::wstring getStatusString();
462 Get a player from memory or creates one.
463 If player is already connected, return NULL
465 Call with env and con locked.
467 Player *emergePlayer(const char *name, const char *password,
471 Update water pressure.
472 This also adds suitable nodes to active_nodes.
474 environment has to be locked when calling.
476 /*void UpdateBlockWaterPressure(MapBlock *block,
477 core::map<v3s16, MapBlock*> &modified_blocks);*/
479 // Locks environment and connection by its own
481 void handlePeerChange(PeerChange &c);
482 void handlePeerChanges();
484 //float m_flowwater_timer;
485 float m_liquid_transform_timer;
486 float m_print_info_timer;
487 float m_objectdata_timer;
488 float m_emergethread_trigger_timer;
489 float m_savemap_timer;
491 // NOTE: If connection and environment are both to be locked,
492 // environment shall be locked first.
494 ServerEnvironment m_env;
497 con::Connection m_con;
498 core::map<u16, RemoteClient*> m_clients; // Behind the con mutex
501 JMutex m_step_dtime_mutex;
503 ServerThread m_thread;
504 EmergeThread m_emergethread;
506 BlockEmergeQueue m_emerge_queue;
508 // Nodes that are destinations of flowing liquid at the moment
509 //core::map<v3s16, u8> m_flow_active_nodes;
512 MutexedVariable<u32> m_time_of_day;
513 // Used to buffer dtime for adding to m_time_of_day
514 float m_time_counter;
515 float m_time_of_day_send_timer;
517 MutexedVariable<double> m_uptime;
532 Queue<PeerChange> m_peer_change_queue;
534 std::string m_mapsavedir;
536 MutexedVariable<bool> m_shutdown_requested;
539 Queue of map edits from the environment for sending to the clients
540 This is behind m_env_mutex
542 Queue<MapEditEvent*> m_unsent_map_edit_queue;
544 Set to true when the server itself is modifying the map and does
545 all sending of information by itself.
546 This is behind m_env_mutex
548 bool m_ignore_map_edit_events;
550 If set to !=0, the incoming MapEditEvents are modified to have
551 this peed id as the disabled recipient
552 This is behind m_env_mutex
554 u16 m_ignore_map_edit_events_peer_id;
556 friend class EmergeThread;
557 friend class RemoteClient;
561 Runs a simple dedicated server loop.
563 Shuts down when run is set to false.
565 void dedicated_server_loop(Server &server, bool &run);