server/socket/loop.C

/*
 * This file is part of Crossfire TRT, the Roguelike Realtime MORPG.
 * 
 * Copyright (©) 2005,2006,2007 Marc Alexander Lehmann / Robin Redeker / the Crossfire TRT team
 * Copyright (©) 2002-2003,2007 Mark Wedel & The Crossfire Development Team
 * Copyright (©) 1992,2007 Frank Tore Johansen
 * 
 * Crossfire TRT is free software: you can redistribute it and/or modify
 * it under the terms of the 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 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 <crossfire@schmorp.de>
 */

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

// disconnect a socket after this many seconds without an ack
#define SOCKET_TIMEOUT 8.

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.push_back (command ());
      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 ();
          send_packet_printf ("drawinfo %d ignoring delayed commands.", NDI_RED);
        }
      else
        execute (cmd.handler, cmd.data, cmd.datalen);

      cmd_queue.pop_front ();
      return true;
    }
  else
    return false;
}

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

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

  if (last_weight != -1 && last_weight != WEIGHT (pl->ob))
    {
      esrv_update_item (UPD_WEIGHT, pl->ob, pl->ob);
      if (last_weight != WEIGHT (pl->ob))
        LOG (llevError, "esrv_update_item(UPD_WEIGHT) did not set player weight: is %lu, should be %lu\n",
             (unsigned long) last_weight, WEIGHT (pl->ob));
    }

  draw_client_map (pl);

  if (update_look)
    esrv_draw_look (pl);

#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

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

  // if we can split images, round to next-lowest mss
  if (fxix) max_send -= max_send % mss;

  if (ixface.empty ())
    {
      // regularly send a new face when queue is empty
      if (bg_scrub && !--bg_scrub && enable_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))
            {
              if (fxix)
                {
                  // 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
                {
                  send_image (ix.idx);
                  ix.ofs = 0;
                }
            }
          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.67
Committed:	Tue Jul 31 20:10:31 2007 UTC (16 years, 10 months ago) by root
Content type:	text/plain
Branch:	MAIN
Changes since 1.66:	+1 -1 lines
Log Message:	bg-scrub sounds, too
#	User	Rev	Content
1	elmex	1.1	/*
2	root	1.55	* This file is part of Crossfire TRT, the Roguelike Realtime MORPG.
3	pippijn	1.39	*
4	root	1.49	* Copyright (©) 2005,2006,2007 Marc Alexander Lehmann / Robin Redeker / the Crossfire TRT team
5			* Copyright (©) 2002-2003,2007 Mark Wedel & The Crossfire Development Team
6			* Copyright (©) 1992,2007 Frank Tore Johansen
7			*
8	root	1.55	* Crossfire TRT is free software: you can redistribute it and/or modify
9			* it under the terms of the GNU General Public License as published by
10			* the Free Software Foundation, either version 3 of the License, or
11			* (at your 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 GNU General Public License
19			* along with this program. If not, see <http://www.gnu.org/licenses/>.
20	root	1.49	*
21			* The authors can be reached via e-mail to <crossfire@schmorp.de>
22	pippijn	1.39	*/
23	elmex	1.1
24			/**
25			* \file
26			* Main client/server loops.
27			*
28			* \date 2003-12-02
29			*
30			* loop.c mainly deals with initialization and higher level socket
31	root	1.26	* maintanance (checking for lost connections and if data has arrived.)
32	elmex	1.1	*/
33
34			#include <global.h>
35	root	1.10	#include <sproto.h>
36			#include <sockproto.h>
37	elmex	1.1
38	pippijn	1.8	#include <sys/types.h>
39			#include <sys/time.h>
40			#include <sys/socket.h>
41			#include <netinet/in.h>
42			#include <netdb.h>
43	elmex	1.1
44	root	1.16	#include <unistd.h>
45			#include <arpa/inet.h>
46	elmex	1.1
47			#include <loader.h>
48
49	root	1.51	#define BG_SCRUB_RATE 4 // how often to send a face in the background
50
51	root	1.65	#define MAX_QUEUE_DEPTH 50
52	root	1.51	#define MAX_QUEUE_BACKLOG 3.
53	elmex	1.1
54	root	1.66	// disconnect a socket after this many seconds without an ack
55			#define SOCKET_TIMEOUT 8.
56
57	root	1.21	void
58			client::reset_state ()
59			{
60			if (!pl)
61			return;
62
63			pl->run_on = 0;
64			pl->fire_on = 0;
65			}
66	elmex	1.1
67	root	1.20	void
68			client::queue_command (packet_type handler, char data, int datalen)
69	root	1.6	{
70	root	1.51	tstamp stamp = NOW;
71	elmex	1.1
72	root	1.20	if (cmd_queue.size () >= MAX_QUEUE_DEPTH)
73	root	1.21	{
74			//TODO: just disconnect here?
75			reset_state ();
76			send_packet_printf ("drawinfo %d command queue overflow, ignoring.", NDI_RED);
77			}
78	root	1.20	else
79	root	1.24	{
80			cmd_queue.push_back (command ());
81			command &cmd = cmd_queue.back ();
82			cmd.stamp = stamp;
83			cmd.handler = handler;
84	root	1.25	cmd.data = salloc<char> (datalen + 1, data);
85	root	1.24	cmd.datalen = datalen;
86			}
87	root	1.20	}
88	elmex	1.1
89	root	1.20	bool
90			client::handle_command ()
91	elmex	1.1	{
92	root	1.48	if (!cmd_queue.empty ()
93			&& state == ST_PLAYING
94			&& pl->ob->speed_left > 0.f)
95	root	1.26	{
96			command &cmd = cmd_queue.front ();
97	root	1.6
98	root	1.51	if (cmd.stamp + MAX_QUEUE_BACKLOG < NOW)
99	root	1.26	{
100	root	1.48	reset_state ();
101			send_packet_printf ("drawinfo %d ignoring delayed commands.", NDI_RED);
102	root	1.26	}
103			else
104	root	1.48	execute (cmd.handler, cmd.data, cmd.datalen);
105
106			cmd_queue.pop_front ();
107			return true;
108	root	1.21	}
109	root	1.48	else
110			return false;
111	elmex	1.1	}
112
113	root	1.6	void
114	root	1.42	client::tick ()
115			{
116			if (!pl \|\| destroyed ())
117			return;
118	root	1.37
119	root	1.42	/* Update the players stats once per tick. More efficient than
120			* sending them whenever they change, and probably just as useful
121			*/
122			esrv_update_stats (pl);
123	root	1.20
124	root	1.42	if (last_weight != -1 && last_weight != WEIGHT (pl->ob))
125			{
126			esrv_update_item (UPD_WEIGHT, pl->ob, pl->ob);
127			if (last_weight != WEIGHT (pl->ob))
128			LOG (llevError, "esrv_update_item(UPD_WEIGHT) did not set player weight: is %lu, should be %lu\n",
129			(unsigned long) last_weight, WEIGHT (pl->ob));
130			}
131	root	1.6
132	root	1.50	draw_client_map (pl);
133	root	1.20
134	root	1.42	if (update_look)
135	root	1.50	esrv_draw_look (pl);
136	root	1.41
137	root	1.66	#if HAVE_TCP_INFO
138			// check time of last ack, and, if too old, kill connection
139			socklen_t len = sizeof (tcpi);
140
141			if (!getsockopt (fd, IPPROTO_TCP, TCP_INFO, &tcpi, &len) && len == sizeof (tcpi))
142			{
143			if (tcpi.tcpi_snd_mss)
144			mss = tcpi.tcpi_snd_mss;
145
146			#if 0
147			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",
148			tcpi.tcpi_unacked,
149			tcpi.tcpi_sacked,
150			tcpi.tcpi_lost,
151			tcpi.tcpi_retrans,
152			tcpi.tcpi_fackets,
153			tcpi.tcpi_snd_ssthresh, tcpi.tcpi_snd_cwnd, tcpi.tcpi_advmss, tcpi.tcpi_pmtu, tcpi.tcpi_advmss,
154
155			tcpi.tcpi_snd_cwnd - (tcpi.tcpi_unacked - tcpi.tcpi_sacked));
156			#endif
157
158			// do this only when player is active
159			if (pl && pl->active
160			&& tcpi.tcpi_last_ack_recv > int (SOCKET_TIMEOUT * 1000))
161			{
162			send_msg (NDI_RED \| NDI_REPLY, "connection-timeout", "safety disconnect due to tcp/ip timeout (no packets received)");
163			write_outputbuffer ();
164
165			LOG (llevDebug, "connection on fd %d closed due to ack timeout (%u/%u/%u)\n", fd,
166			(unsigned)tcpi.tcpi_last_ack_recv, (unsigned)tcpi.tcpi_last_data_sent, (unsigned)tcpi.tcpi_unacked);
167			destroy ();
168			}
169			}
170			#endif
171
172			rate_avail = min (max_rate + mss, rate_avail + max_rate);
173
174			int max_send = rate_avail;
175
176			#if HAVE_TCP_INFO
177			// further restrict the available bandwidth by the excess bandwidth available
178			max_send = min (max_send, (tcpi.tcpi_snd_cwnd - tcpi.tcpi_unacked + tcpi.tcpi_sacked) * mss);
179			#endif
180
181			// if we can split images, round to next-lowest mss
182			if (fxix) max_send -= max_send % mss;
183
184	root	1.65	if (ixface.empty ())
185			{
186			// regularly send a new face when queue is empty
187			if (bg_scrub && !--bg_scrub && enable_bg_scrub)
188			while (scrub_idx < faces.size () - 1)
189			{
190			++scrub_idx;
191
192			if (!faces_sent [scrub_idx])
193			if (faceinfo *f = face_info (scrub_idx))
194	root	1.67	if (f->type == FT_FACE \|\| f->type == FT_SOUND) // only scrub faces and sounds for now
195	root	1.65	{
196			send_face (scrub_idx, -120);
197			flush_fx ();
198
199	root	1.66	bg_scrub = 1; // send up to one fx per tick, unless an image was requested
200	root	1.65	break;
201			}
202			}
203			}
204			else
205			{
206	root	1.66	bg_scrub = BG_SCRUB_RATE;
207	root	1.65
208	root	1.66	for (;;)
209			{
210			int avail = max_send - outputbuffer_len ();
211	root	1.64
212	root	1.66	if (avail <= 0)
213			break;
214	root	1.65
215			ixsend &ix = ixface.back ();
216	root	1.44
217	root	1.65	if (facedata *d = face_data (ix.idx, faceset))
218			{
219			if (fxix)
220			{
221			// estimate the packet header overhead "ix " + idx + (new)ofs
222			int pktlen = 3 + ber32::encoded_size (ix.idx) + ber32::encoded_size (ix.ofs);
223			int chunk = min (avail - packet::hdrlen, MAXSOCKBUF) - pktlen;
224
225			// only transfer something if the amount of data transferred
226			// has a healthy relation to the header overhead
227			if (chunk < 64)
228			break;
229	root	1.46
230	root	1.65	chunk = min (chunk, (int)ix.ofs);
231	root	1.46
232	root	1.65	ix.ofs -= chunk;
233	root	1.46
234	root	1.65	//fprintf (stderr, "i%dx %6d: %5d+%4d (%4d)\n", fxix, ix.idx,ix.ofs,chunk, ixface.size());//D
235	root	1.59
236	root	1.65	packet sl ("ix");
237	root	1.46
238	root	1.65	sl << ber32 (ix.idx)
239			<< ber32 (ix.ofs)
240			<< data (d->data.data () + ix.ofs, chunk);
241	root	1.46
242	root	1.65	send_packet (sl);
243			}
244			else
245	root	1.63	{
246	root	1.65	send_image (ix.idx);
247			ix.ofs = 0;
248	root	1.46	}
249	root	1.65	}
250			else
251			ix.ofs = 0;
252	root	1.44
253	root	1.65	if (!ix.ofs)
254			{
255			ixface.pop_back ();
256	root	1.56
257	root	1.65	if (ixface.empty ())
258			break;
259	root	1.54	}
260	root	1.44	}
261			}
262	root	1.66
263			rate_avail -= outputbuffer_len ();
264			}
265
266			void
267			client::flush_sockets (void)
268			{
269			for (sockvec::iterator i = clients.begin (); i != clients.end (); ++i)
270			(*i)->flush ();
271			}
272
273			void
274			client::clock (void)
275			{
276			for (sockvec::iterator i = clients.begin (); i != clients.end (); ++i)
277			(*i)->tick ();
278
279			// give them all the same chances
280			flush_sockets ();
281
282			//TODO: should not be done here, either
283			for (unsigned i = 0; i < clients.size (); ++i)
284			clients[i]->refcnt_chk ();
285	elmex	1.1	}
286	root	1.43