server/socket/loop.C

/*
 * This file is part of Deliantra, the Roguelike Realtime MMORPG.
 * 
 * Copyright (©) 2005,2006,2007,2008 Marc Alexander Lehmann / Robin Redeker / the Deliantra team
 * Copyright (©) 2002-2003,2007 Mark Wedel & The Crossfire Development Team
 * Copyright (©) 1992,2007 Frank Tore Johansen
 * 
 * Deliantra is free software: you can redistribute it and/or modify it under
 * the terms of the Affero GNU General Public License as published by the
 * Free Software Foundation, either version 3 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 General Public License for more details.
 * 
 * You should have received a copy of the Affero GNU General Public License
 * and the GNU General Public License along with this program. If not, see
 * <http://www.gnu.org/licenses/>.
 * 
 * The authors can be reached via e-mail to <support@deliantra.net>
 */

/**
 * \file
 * Main client/server loops.
 *
 * \date 2003-12-02
 *
 * loop.c mainly deals with initialization and higher level socket
 * maintanance (checking for lost connections and if data has arrived.)
 */

#include <global.h>
#include <sproto.h>
#include <sockproto.h>

#include <sys/types.h>
#include <sys/time.h>
#include <sys/socket.h>
#include <netinet/in.h>
#include <netdb.h>

#include <unistd.h>
#include <arpa/inet.h>

#include <loader.h>

#define BG_SCRUB_RATE 4 // how often to send a face in the background

#define MAX_QUEUE_DEPTH   50
#define MAX_QUEUE_BACKLOG 3.

void
client::reset_state ()
{
  if (!pl)
    return;

  pl->run_on  = 0;
  pl->fire_on = 0;
}

void
client::queue_command (packet_type *handler, char *data, int datalen)
{
  tstamp stamp = NOW;

  if (cmd_queue.size () >= MAX_QUEUE_DEPTH)
    {
      //TODO: just disconnect here?
      reset_state ();
      send_packet_printf ("drawinfo %d command queue overflow, ignoring.", NDI_RED);
    }
  else
    {
      cmd_queue.resize (cmd_queue.size () + 1);
      command &cmd = cmd_queue.back ();
      cmd.stamp   = stamp;
      cmd.handler = handler;
      cmd.data    = salloc<char> (datalen + 1, data);
      cmd.datalen = datalen;
    }
}

bool
client::handle_command ()
{
  if (!cmd_queue.empty ()
      && state == ST_PLAYING
      && pl->ob->speed_left > 0.f)
    {
      command &cmd = cmd_queue.front ();

      if (cmd.stamp + MAX_QUEUE_BACKLOG < NOW)
        {
          reset_state (); // the command might actually reset some movement state etc.

          if (pl)
            pl->failmsg (
               "Cannot keep up with your commands, ignoring them! "
               "H<Your character cannot keep up with the instructions you give G<him|her>. "
               "Try issuing commands slower, or, if G<he|she> is incapacitated (paralyzed and so on), "
               "wait till your character can act again.\n\nIf G<he|she> is permanently stuck, then "
               "try the B<suicide> command (or use B<chat> to ask somebody to B<invite> you out).>"
            );
        }
      else
        execute (cmd.handler, cmd.data, cmd.datalen);

      sfree<char> (cmd.data, cmd.datalen + 1);
      cmd_queue.pop_front ();
      return true;
    }
  else
    return false;
}

void
client::tick ()
{
  if (!pl || destroyed ())
    return;

  pl->dirty = true;

  /* Update the players stats once per tick.  More efficient than
   * sending them whenever they change, and probably just as useful
   */
  esrv_update_stats (pl);

  sint32 weight = pl->ob->client_weight ();

  if (last_weight != weight)
    {
      pl->ob->update_stats ();
      esrv_update_item (UPD_WEIGHT, pl->ob, pl->ob);
    }

  draw_client_map (pl);

  if (update_look)
    esrv_draw_look (pl);

  mapinfo_queue_run ();

#if HAVE_TCP_INFO
  // check time of last ack, and, if too old, kill connection
  socklen_t len = sizeof (tcpi);

  if (!getsockopt (fd, IPPROTO_TCP, TCP_INFO, &tcpi, &len) && len == sizeof (tcpi))
    {
      if (tcpi.tcpi_snd_mss)
        mss = tcpi.tcpi_snd_mss;

#if 0
      fprintf (stderr, "uack %d ack %d lost %d ret %d fack %d sst %d cwnd %d mss %d pmtu %d advmss %d EXC %d\n",
               tcpi.tcpi_unacked,
               tcpi.tcpi_sacked,
               tcpi.tcpi_lost,
               tcpi.tcpi_retrans,
               tcpi.tcpi_fackets,
               tcpi.tcpi_snd_ssthresh, tcpi.tcpi_snd_cwnd, tcpi.tcpi_advmss, tcpi.tcpi_pmtu, tcpi.tcpi_advmss,
               
               tcpi.tcpi_snd_cwnd - (tcpi.tcpi_unacked - tcpi.tcpi_sacked));
#endif

      // fast-time-out a player by checking for missing acks
      // do this only when player is active
      if (pl && pl->active
          && tcpi.tcpi_last_ack_recv > int (socket_timeout * 1000))
        {
          send_msg (NDI_RED | NDI_REPLY, "connection-timeout", "safety disconnect due to tcp/ip timeout (no packets received)");
          write_outputbuffer ();

          LOG (llevDebug, "connection on fd %d closed due to ack timeout (%u/%u/%u)\n", fd,
               (unsigned)tcpi.tcpi_last_ack_recv, (unsigned)tcpi.tcpi_last_data_sent, (unsigned)tcpi.tcpi_unacked);
          destroy ();
        }
    }
#endif

  rate_avail = min (max_rate + mss, rate_avail + max_rate);

  int max_send = rate_avail;

#if HAVE_TCP_INFO
  // further restrict the available bandwidth by the excess bandwidth available
  max_send = min (max_send, (tcpi.tcpi_snd_cwnd - tcpi.tcpi_unacked + tcpi.tcpi_sacked) * mss);
#endif

  // round to next-lowest mss
  max_send -= max_send % mss;

  if (ixface.empty ())
    {
      // regularly send a new face when queue is empty
      if (bg_scrub && !--bg_scrub)
        while (scrub_idx < faces.size () - 1)
          {
            ++scrub_idx;

            if (!faces_sent [scrub_idx])
              if (faceinfo *f = face_info (scrub_idx))
                if (f->type == FT_FACE || f->type == FT_SOUND) // only scrub faces and sounds for now
                  {
                    send_face (scrub_idx, -120);
                    flush_fx ();

                    bg_scrub = 1; // send up to one fx per tick, unless an image was requested
                    break;
                  }
          }
    }
  else
    {
      bg_scrub = BG_SCRUB_RATE;

      for (;;)
        {
          int avail = max_send - outputbuffer_len ();

          if (avail <= 0)
            break;

          ixsend &ix = ixface.back ();

          if (facedata *d = face_data (ix.idx, faceset))
            {
              // estimate the packet header overhead "ix " + idx + (new)ofs
              int pktlen = 3 + ber32::encoded_size (ix.idx) + ber32::encoded_size (ix.ofs);
              int chunk = min (avail - packet::hdrlen, MAXSOCKBUF) - pktlen;

              // only transfer something if the amount of data transferred
              // has a healthy relation to the header overhead
              if (chunk < 64)
                break;

              chunk = min (chunk, (int)ix.ofs);

              ix.ofs -= chunk;

              //fprintf (stderr, "i%dx %6d: %5d+%4d   (%4d)\n", fxix, ix.idx,ix.ofs,chunk, ixface.size());//D

              packet sl ("ix");

              sl << ber32 (ix.idx)
                 << ber32 (ix.ofs)
                 << data (d->data.data () + ix.ofs, chunk);

              send_packet (sl);
            }
          else
            ix.ofs = 0;

          if (!ix.ofs)
            {
              ixface.pop_back ();

              if (ixface.empty ())
                break;
            }
        }
    }

  rate_avail -= outputbuffer_len ();
}

void
client::flush_sockets (void)
{
  for (sockvec::iterator i = clients.begin (); i != clients.end (); ++i)
    (*i)->flush ();
}

void
client::clock (void)
{
  for (sockvec::iterator i = clients.begin (); i != clients.end (); ++i)
    (*i)->tick ();

  // give them all the same chances
  flush_sockets ();

  //TODO: should not be done here, either
  for (unsigned i = 0; i < clients.size (); ++i)
    clients[i]->refcnt_chk ();
}

Revision:	1.82
Committed:	Mon Oct 12 14:00:59 2009 UTC (14 years, 8 months ago) by root
Content type:	text/plain
Branch:	MAIN
CVS Tags:	rel-2_82, rel-2_81
Changes since 1.81:	+7 -6 lines
Log Message:	clarify license
#	Content
1	/*
2	* This file is part of Deliantra, the Roguelike Realtime MMORPG.
3	*
4	* Copyright (©) 2005,2006,2007,2008 Marc Alexander Lehmann / Robin Redeker / the Deliantra team
5	* Copyright (©) 2002-2003,2007 Mark Wedel & The Crossfire Development Team
6	* Copyright (©) 1992,2007 Frank Tore Johansen
7	*
8	* Deliantra is free software: you can redistribute it and/or modify it under
9	* the terms of the Affero GNU General Public License as published by the
10	* Free Software Foundation, either version 3 of the License, or (at your
11	* option) any later version.
12	*
13	* This program is distributed in the hope that it will be useful,
14	* but WITHOUT ANY WARRANTY; without even the implied warranty of
15	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16	* GNU General Public License for more details.
17	*
18	* You should have received a copy of the Affero GNU General Public License
19	* and the GNU General Public License along with this program. If not, see
20	* <http://www.gnu.org/licenses/>.
21	*
22	* The authors can be reached via e-mail to <support@deliantra.net>
23	*/
24
25	/**
26	* \file
27	* Main client/server loops.
28	*
29	* \date 2003-12-02
30	*
31	* loop.c mainly deals with initialization and higher level socket
32	* maintanance (checking for lost connections and if data has arrived.)
33	*/
34
35	#include <global.h>
36	#include <sproto.h>
37	#include <sockproto.h>
38
39	#include <sys/types.h>
40	#include <sys/time.h>
41	#include <sys/socket.h>
42	#include <netinet/in.h>
43	#include <netdb.h>
44
45	#include <unistd.h>
46	#include <arpa/inet.h>
47
48	#include <loader.h>
49
50	#define BG_SCRUB_RATE 4 // how often to send a face in the background
51
52	#define MAX_QUEUE_DEPTH 50
53	#define MAX_QUEUE_BACKLOG 3.
54
55	void
56	client::reset_state ()
57	{
58	if (!pl)
59	return;
60
61	pl->run_on = 0;
62	pl->fire_on = 0;
63	}
64
65	void
66	client::queue_command (packet_type handler, char data, int datalen)
67	{
68	tstamp stamp = NOW;
69
70	if (cmd_queue.size () >= MAX_QUEUE_DEPTH)
71	{
72	//TODO: just disconnect here?
73	reset_state ();
74	send_packet_printf ("drawinfo %d command queue overflow, ignoring.", NDI_RED);
75	}
76	else
77	{
78	cmd_queue.resize (cmd_queue.size () + 1);
79	command &cmd = cmd_queue.back ();
80	cmd.stamp = stamp;
81	cmd.handler = handler;
82	cmd.data = salloc<char> (datalen + 1, data);
83	cmd.datalen = datalen;
84	}
85	}
86
87	bool
88	client::handle_command ()
89	{
90	if (!cmd_queue.empty ()
91	&& state == ST_PLAYING
92	&& pl->ob->speed_left > 0.f)
93	{
94	command &cmd = cmd_queue.front ();
95
96	if (cmd.stamp + MAX_QUEUE_BACKLOG < NOW)
97	{
98	reset_state (); // the command might actually reset some movement state etc.
99
100	if (pl)
101	pl->failmsg (
102	"Cannot keep up with your commands, ignoring them! "
103	"H<Your character cannot keep up with the instructions you give G<him\|her>. "
104	"Try issuing commands slower, or, if G<he\|she> is incapacitated (paralyzed and so on), "
105	"wait till your character can act again.\n\nIf G<he\|she> is permanently stuck, then "
106	"try the B<suicide> command (or use B<chat> to ask somebody to B<invite> you out).>"
107	);
108	}
109	else
110	execute (cmd.handler, cmd.data, cmd.datalen);
111
112	sfree<char> (cmd.data, cmd.datalen + 1);
113	cmd_queue.pop_front ();
114	return true;
115	}
116	else
117	return false;
118	}
119
120	void
121	client::tick ()
122	{
123	if (!pl \|\| destroyed ())
124	return;
125
126	pl->dirty = true;
127
128	/* Update the players stats once per tick. More efficient than
129	* sending them whenever they change, and probably just as useful
130	*/
131	esrv_update_stats (pl);
132
133	sint32 weight = pl->ob->client_weight ();
134
135	if (last_weight != weight)
136	{
137	pl->ob->update_stats ();
138	esrv_update_item (UPD_WEIGHT, pl->ob, pl->ob);
139	}
140
141	draw_client_map (pl);
142
143	if (update_look)
144	esrv_draw_look (pl);
145
146	mapinfo_queue_run ();
147
148	#if HAVE_TCP_INFO
149	// check time of last ack, and, if too old, kill connection
150	socklen_t len = sizeof (tcpi);
151
152	if (!getsockopt (fd, IPPROTO_TCP, TCP_INFO, &tcpi, &len) && len == sizeof (tcpi))
153	{
154	if (tcpi.tcpi_snd_mss)
155	mss = tcpi.tcpi_snd_mss;
156
157	#if 0
158	fprintf (stderr, "uack %d ack %d lost %d ret %d fack %d sst %d cwnd %d mss %d pmtu %d advmss %d EXC %d\n",
159	tcpi.tcpi_unacked,
160	tcpi.tcpi_sacked,
161	tcpi.tcpi_lost,
162	tcpi.tcpi_retrans,
163	tcpi.tcpi_fackets,
164	tcpi.tcpi_snd_ssthresh, tcpi.tcpi_snd_cwnd, tcpi.tcpi_advmss, tcpi.tcpi_pmtu, tcpi.tcpi_advmss,
165
166	tcpi.tcpi_snd_cwnd - (tcpi.tcpi_unacked - tcpi.tcpi_sacked));
167	#endif
168
169	// fast-time-out a player by checking for missing acks
170	// do this only when player is active
171	if (pl && pl->active
172	&& tcpi.tcpi_last_ack_recv > int (socket_timeout * 1000))
173	{
174	send_msg (NDI_RED \| NDI_REPLY, "connection-timeout", "safety disconnect due to tcp/ip timeout (no packets received)");
175	write_outputbuffer ();
176
177	LOG (llevDebug, "connection on fd %d closed due to ack timeout (%u/%u/%u)\n", fd,
178	(unsigned)tcpi.tcpi_last_ack_recv, (unsigned)tcpi.tcpi_last_data_sent, (unsigned)tcpi.tcpi_unacked);
179	destroy ();
180	}
181	}
182	#endif
183
184	rate_avail = min (max_rate + mss, rate_avail + max_rate);
185
186	int max_send = rate_avail;
187
188	#if HAVE_TCP_INFO
189	// further restrict the available bandwidth by the excess bandwidth available
190	max_send = min (max_send, (tcpi.tcpi_snd_cwnd - tcpi.tcpi_unacked + tcpi.tcpi_sacked) * mss);
191	#endif
192
193	// round to next-lowest mss
194	max_send -= max_send % mss;
195
196	if (ixface.empty ())
197	{
198	// regularly send a new face when queue is empty
199	if (bg_scrub && !--bg_scrub)
200	while (scrub_idx < faces.size () - 1)
201	{
202	++scrub_idx;
203
204	if (!faces_sent [scrub_idx])
205	if (faceinfo *f = face_info (scrub_idx))
206	if (f->type == FT_FACE \|\| f->type == FT_SOUND) // only scrub faces and sounds for now
207	{
208	send_face (scrub_idx, -120);
209	flush_fx ();
210
211	bg_scrub = 1; // send up to one fx per tick, unless an image was requested
212	break;
213	}
214	}
215	}
216	else
217	{
218	bg_scrub = BG_SCRUB_RATE;
219
220	for (;;)
221	{
222	int avail = max_send - outputbuffer_len ();
223
224	if (avail <= 0)
225	break;
226
227	ixsend &ix = ixface.back ();
228
229	if (facedata *d = face_data (ix.idx, faceset))
230	{
231	// estimate the packet header overhead "ix " + idx + (new)ofs
232	int pktlen = 3 + ber32::encoded_size (ix.idx) + ber32::encoded_size (ix.ofs);
233	int chunk = min (avail - packet::hdrlen, MAXSOCKBUF) - pktlen;
234
235	// only transfer something if the amount of data transferred
236	// has a healthy relation to the header overhead
237	if (chunk < 64)
238	break;
239
240	chunk = min (chunk, (int)ix.ofs);
241
242	ix.ofs -= chunk;
243
244	//fprintf (stderr, "i%dx %6d: %5d+%4d (%4d)\n", fxix, ix.idx,ix.ofs,chunk, ixface.size());//D
245
246	packet sl ("ix");
247
248	sl << ber32 (ix.idx)
249	<< ber32 (ix.ofs)
250	<< data (d->data.data () + ix.ofs, chunk);
251
252	send_packet (sl);
253	}
254	else
255	ix.ofs = 0;
256
257	if (!ix.ofs)
258	{
259	ixface.pop_back ();
260
261	if (ixface.empty ())
262	break;
263	}
264	}
265	}
266
267	rate_avail -= outputbuffer_len ();
268	}
269
270	void
271	client::flush_sockets (void)
272	{
273	for (sockvec::iterator i = clients.begin (); i != clients.end (); ++i)
274	(*i)->flush ();
275	}
276
277	void
278	client::clock (void)
279	{
280	for (sockvec::iterator i = clients.begin (); i != clients.end (); ++i)
281	(*i)->tick ();
282
283	// give them all the same chances
284	flush_sockets ();
285
286	//TODO: should not be done here, either
287	for (unsigned i = 0; i < clients.size (); ++i)
288	clients[i]->refcnt_chk ();
289	}
290