ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/deliantra/server/socket/lowlevel.C
Revision: 1.25
Committed: Sun Dec 17 19:14:00 2006 UTC (17 years, 5 months ago) by root
Content type: text/plain
Branch: MAIN
Changes since 1.24: +1 -1 lines
Log Message:
re-enable async command execution

File Contents

# Content
1 /*
2 CrossFire, A Multiplayer game for X-windows
3
4 Copyright (C) 1992 Frank Tore Johansen
5
6 This program is free software; you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation; either version 2 of the License, or
9 (at your option) any later version.
10
11 This program is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU General Public License for more details.
15
16 You should have received a copy of the GNU General Public License
17 along with this program; if not, write to the Free Software
18 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
19
20 The author can be reached via e-mail to mark@pyramid.com
21 */
22
23 /**
24 * \file
25 * Low-level socket-related functions.
26 *
27 * \date 2003-12-02
28 *
29 * Contains some base functions that both the client and server
30 * can use. As such, depending what we are being compiled for will
31 * determine what we can include. the client is designed have
32 * CFCLIENT defined as part of its compile flags.
33 */
34
35 using namespace std;
36
37 #include <global.h>
38 #include <sproto.h>
39 #include <cstdarg>
40
41 #ifdef __linux__
42 # include <sys/types.h>
43 # include <sys/socket.h>
44 # include <netinet/in.h>
45 # define TCP_HZ 1000 // sorry...
46 # include <netinet/tcp.h>
47 #endif
48
49 // use a really low timeout, as it doesn't cost any bandwidth, and you can
50 // easily die in 20 seconds...
51 #define SOCKET_TIMEOUT1 10
52 #define SOCKET_TIMEOUT2 20
53
54 void
55 client::flush ()
56 {
57 #ifdef __linux__
58 // check time of last ack, and, if too old, kill connection
59 struct tcp_info tcpi;
60 socklen_t len = sizeof (tcpi);
61
62 if (!getsockopt (fd, IPPROTO_TCP, TCP_INFO, &tcpi, &len) && len == sizeof (tcpi))
63 {
64 unsigned int diff = tcpi.tcpi_last_ack_recv - tcpi.tcpi_last_data_sent;
65
66 rtt = tcpi.tcpi_rtt;
67 rttvar = tcpi.tcpi_rttvar;
68
69 if (tcpi.tcpi_unacked && SOCKET_TIMEOUT1 * TCP_HZ < diff && diff < 0x80000000UL // ack delayed for 20s
70 && SOCKET_TIMEOUT2 * TCP_HZ < tcpi.tcpi_last_data_sent) // no data sent for 10s
71 {
72 LOG (llevDebug, "Connection on fd %d closed due to ack timeout (%u/%u/%u)\n", fd,
73 (unsigned) tcpi.tcpi_last_ack_recv, (unsigned) tcpi.tcpi_last_data_sent, (unsigned) tcpi.tcpi_unacked);
74 destroy ();
75 }
76 }
77 #endif
78
79 /**
80 * Writes data to socket.
81 *
82 * When the socket is clear to write, and we have backlogged data, this
83 * is called to write it out.
84 */
85
86 if (!outputbuffer.len || socket_ev.poll () & PE_W)
87 return;
88
89 write_outputbuffer ();
90 }
91
92 void
93 client::write_outputbuffer ()
94 {
95 while (outputbuffer.len)
96 {
97 int res = write (fd, outputbuffer.data + outputbuffer.start,
98 min (outputbuffer.len, SOCKETBUFSIZE - outputbuffer.start));
99
100 if (res > 0)
101 {
102 outputbuffer.start += res;
103 /* wrap back to start of buffer */
104 if (outputbuffer.start == SOCKETBUFSIZE)
105 outputbuffer.start = 0;
106
107 outputbuffer.len -= res;
108 #ifdef CS_LOGSTATS
109 cst_tot.obytes += res;
110 cst_lst.obytes += res;
111 #endif
112 }
113 else if (res == 0)
114 {
115 LOG (llevError, "socket write failed, connection closed.\n");
116 destroy ();
117 return;
118 }
119 else if (errno == EINTR)
120 {
121 // just retry
122 }
123 else if (errno == EAGAIN)
124 {
125 // delay till ready
126 socket_ev.poll (socket_ev.poll () | PE_W);
127 socket_ev.start ();
128 return;
129 }
130 else
131 {
132 LOG (llevError, "socket write failed: %s\n", strerror (errno));
133 destroy ();
134 return;
135 }
136 }
137
138 socket_ev.poll (socket_ev.poll () & ~PE_W);
139 }
140
141 /******************************************************************************
142 *
143 * Start of read routines.
144 *
145 ******************************************************************************/
146
147 int
148 client::next_packet ()
149 {
150 if (inbuf_len >= 2)
151 {
152 int pkt_len = (inbuf [0] << 8) | inbuf [1];
153
154 if (inbuf_len >= 2 + pkt_len)
155 return 2 + pkt_len;
156
157 if (inbuf_len == sizeof (inbuf))
158 {
159 send_packet_printf ("drawinfo %d input buffer overflow - closing connection.", NDI_RED);
160 destroy ();
161 return -1;
162 }
163 }
164
165 return 0;
166 }
167
168 void
169 client::skip_packet (int len)
170 {
171 inbuf_len -= len;
172 memmove (inbuf, inbuf + len, inbuf_len);
173 }
174
175 /*****************************************************************************
176 * Start of command dispatch area.
177 * The commands here are protocol commands.
178 ****************************************************************************/
179
180 // SocketCommand, PlayingCommand, should not exist with those ugly casts
181 #define SC(cb) (void *)static_cast<void (*)(char *, int, client *)>(cb),
182 #define PC(cb) (void *)static_cast<void (*)(char *, int, player *)>(cb), PF_PLAYER |
183
184 /**
185 * Dispatch table for the server.
186 */
187 static struct packet_type packets[] = {
188 {"ncom", PC(NewPlayerCmd) PF_PLAYING },
189 {"command", PC(PlayerCmd) PF_PLAYING },
190
191 {"examine", PC(ExamineCmd) PF_PLAYING },
192 {"apply", PC(ApplyCmd) PF_PLAYING },
193 {"reply", PC(ReplyCmd) PF_IMMEDIATE },
194 {"lookat", PC(LookAt) PF_PLAYING },
195 {"lock", PC(LockItem) PF_PLAYING },
196 {"mark", PC(MarkItem) PF_PLAYING },
197 {"move", PC(MoveCmd) PF_PLAYING },
198 {"exti", PC(ExtCmd) PF_IMMEDIATE }, /* CF+ */
199 {"ext", PC(ExtCmd) 0 }, /* CF+ */
200 {"mapredraw", PC(MapRedrawCmd) PF_IMMEDIATE }, /* Added: phil */
201 {"mapinfo", PC(MapInfoCmd) 0 }, /* CF+ */
202
203 {"addme", SC(AddMeCmd) PF_IMMEDIATE },
204 {"askface", SC(SendFaceCmd) PF_IMMEDIATE }, /* Added: phil */
205 {"requestinfo", SC(RequestInfo) PF_IMMEDIATE },
206 {"setfacemode", SC(SetFaceMode) PF_IMMEDIATE },
207 {"setsound", SC(SetSound) PF_IMMEDIATE },
208 {"setup", SC(SetUp) PF_IMMEDIATE },
209 {"version", SC(VersionCmd) PF_IMMEDIATE },
210 {"toggleextendedinfos", SC(ToggleExtendedInfos) PF_IMMEDIATE }, /*Added: tchize */
211 {"toggleextendedtext", SC(ToggleExtendedText) PF_IMMEDIATE }, /*Added: tchize */
212 {"asksmooth", SC(AskSmooth) PF_IMMEDIATE }, /*Added: tchize (smoothing technologies) */
213 };
214
215 bool
216 client::may_execute (const packet_type *pkt) const
217 {
218 return (!(pkt->flags & PF_PLAYER) || pl)
219 && (!(pkt->flags & PF_PLAYING) || (pl && pl->state == ST_PLAYING));
220 }
221
222 void
223 client::execute (const packet_type *pkt, char *data, int datalen)
224 {
225 if (may_execute (pkt))
226 {
227 //TODO: only one format
228 if (pkt->flags & PF_PLAYER)
229 ((void (*)(char *, int, player *))pkt->cb)((char *)data, datalen, pl);
230 else
231 ((void (*)(char *, int, client *))pkt->cb)((char *)data, datalen, this);
232 }
233 else
234 send_packet_printf ("drawinfo %d ERROR: you cannot execute '%s' now.", NDI_RED, pkt->name);
235 }
236
237 bool
238 client::handle_packet ()
239 {
240 int pkt_len = next_packet ();
241
242 if (!pkt_len)
243 return false;
244 else if (pkt_len < 0)
245 {
246 LOG (llevError, "read error on player %s\n",
247 pl && pl->ob ? &pl->ob->name : "[anonymous]");
248 destroy ();
249 return false;
250 }
251
252 inbuf [pkt_len] = 0; /* Terminate buffer - useful for string data */
253
254 /* First, break out beginning word. There are at least
255 * a few commands that do not have any paremeters. If
256 * we get such a command, don't worry about trying
257 * to break it up.
258 */
259 int datalen;
260 char *data = strchr ((char *)inbuf + 2, ' ');
261
262 if (data)
263 {
264 *data++ = 0;
265 datalen = pkt_len - (data - (char *)inbuf);
266 }
267 else
268 {
269 data = (char *)inbuf + 2; // better read garbage than segfault
270 datalen = 0;
271 }
272
273 for (packet_type *pkt = packets; pkt < packets + (sizeof (packets) / sizeof (packets[0])); ++pkt)
274 if (!strcmp ((char *)inbuf + 2, pkt->name))
275 {
276 if (pkt->flags & PF_IMMEDIATE)
277 execute (pkt, data, datalen);
278 else
279 queue_command (pkt, data, datalen);
280
281 goto next_packet;
282 }
283
284 /* If we get here, we didn't find a valid command. Logging
285 * this might be questionable, because a broken client/malicious
286 * user could certainly send a whole bunch of invalid commands.
287 */
288 send_packet_printf ("drawinfo %d ERROR: command '%s' not supported.", NDI_RED, (char *)inbuf + 2);
289 next_packet:
290 skip_packet (pkt_len);
291
292 // input buffer has space again
293 socket_ev.poll (socket_ev.poll () | PE_R);
294
295 return true;
296 }
297
298 // callback called when socket is either readable or writable
299 void
300 client::socket_cb (iow &w, int got)
301 {
302 //TODO remove when we have better socket cleanup logic
303 if (status == Ns_Dead)
304 {
305 socket_ev.poll (0);
306 return;
307 }
308
309 if (got & PE_W)
310 {
311 write_outputbuffer ();
312
313 if (!outputbuffer.len)
314 socket_ev.poll (socket_ev.poll () & ~PE_W);
315 }
316
317 if (got & PE_R)
318 {
319 //TODO: rate-limit tcp connection in better ways, important
320
321 int amount = sizeof (inbuf) - inbuf_len;
322
323 if (!amount)
324 {
325 // input buffer full
326 socket_ev.poll (socket_ev.poll () & ~PE_R);
327 return;
328 }
329
330 amount = read (fd, inbuf + inbuf_len, amount);
331
332 if (!amount)
333 {
334 destroy ();
335 return;
336 }
337 else if (amount < 0)
338 {
339 if (errno != EAGAIN && errno != EINTR)
340 {
341 LOG (llevError, "read error: %s\n", strerror (errno));
342 destroy ();
343 return;
344 }
345
346 // should not be here, normally
347 }
348 else
349 {
350 inbuf_len += amount;
351
352 cst_tot.ibytes += amount;
353 cst_lst.ibytes += amount;
354
355 cmd_ev.start ();
356 }
357 }
358 }
359
360 // called whenever we have additional commands to process
361 void
362 client::cmd_cb (iw &w)
363 {
364 if (handle_packet () || handle_command ())
365 w.start ();
366 else
367 flush ();
368 }
369
370 /*******************************************************************************
371 *
372 * Start of write related routines.
373 *
374 ******************************************************************************/
375
376 /**
377 * Adds data to a socket buffer for whatever reason.
378 *
379 * ns is the socket we are adding the data to, buf is the start of the
380 * data, and len is the number of bytes to add.
381 */
382 void
383 client::send (void *buf_, int len)
384 {
385 char *buf = (char *)buf_;
386 char *pos = buf;
387 int amt = 0;
388
389 if (status == Ns_Dead || !buf)
390 return;
391
392 if ((len + outputbuffer.len) > SOCKETBUFSIZE)
393 {
394 LOG (llevDebug, "socket on fd %d has overrun internal buffer - marking as dead\n", fd);
395 destroy ();
396 return;
397 }
398
399 int avail, end;
400
401 /* data + end is where we start putting the new data. The last byte
402 * currently in use is actually data + end -1
403 */
404 end = outputbuffer.start + outputbuffer.len;
405 /* The buffer is already in a wrapped state, so adjust end */
406 if (end >= SOCKETBUFSIZE)
407 end -= SOCKETBUFSIZE;
408
409 avail = SOCKETBUFSIZE - end;
410
411 /* We can all fit it behind the current data without wrapping */
412 if (avail >= len)
413 memcpy (outputbuffer.data + end, buf, len);
414 else
415 {
416 memcpy (outputbuffer.data + end, buf, avail);
417 memcpy (outputbuffer.data, buf + avail, len - avail);
418 }
419
420 outputbuffer.len += len;
421 }
422
423 /**
424 * Takes a string of data, and writes it out to the socket. A very handy
425 * shortcut function.
426 */
427 void
428 client::send_packet (packet &sl)
429 {
430 if (status == Ns_Dead)
431 return;
432
433 if (sl.length () >= MAXSOCKBUF)
434 {
435 LOG (llevError, "Trying to send a buffer beyond properly size, len =%d\n", sl.length ());
436 /* Almost certainly we've overflowed a buffer, so quit now to make
437 * it easier to debug.
438 */
439 abort ();
440 }
441
442 if (!sl.length ())
443 return;
444
445 assert (sl.hdrlen == 2);
446
447 sl.buf_ [0] = sl.length () >> 8;
448 sl.buf_ [1] = sl.length () ;
449
450 send (sl.buf_, sl.length () + sl.hdrlen);
451 }
452
453 void
454 client::send_packet (const char *buf, int len)
455 {
456 packet sl;
457
458 sl << data (buf, len);
459 send_packet (sl);
460 }
461
462 void
463 client::send_packet (const char *buf)
464 {
465 send_packet (buf, strlen (buf));
466 }
467
468 void
469 client::send_packet_printf (const char *format, ...)
470 {
471 packet sl;
472
473 va_list ap;
474 va_start (ap, format);
475 sl.vprintf (format, ap);
476 va_end (ap);
477
478 send_packet (sl);
479 }
480
481 /***********************************************************************
482 *
483 * packet functions/utilities
484 *
485 **********************************************************************/
486
487 packet &packet::operator <<(const data &v)
488 {
489 if (room () < v.len)
490 reset ();
491 else
492 {
493 if (v.len)
494 {
495 memcpy (cur, v.ptr, v.len);
496 cur += v.len;
497 }
498 }
499
500 return *this;
501 }
502
503 packet &packet::operator <<(const data8 &v)
504 {
505 unsigned int len = min (v.len, 0x00FF);
506 return *this << uint8 (len) << data (v.ptr, len);
507 }
508
509 packet &packet::operator <<(const data16 &v)
510 {
511 unsigned int len = min (v.len, 0xFFFF);
512 return *this << uint16 (len) << data (v.ptr, len);
513 }
514
515 packet &packet::operator <<(const char *v)
516 {
517 return *this << data (v, strlen (v ? v : 0));
518 }
519
520 void
521 packet::vprintf (const char *format, va_list ap)
522 {
523 int size = room ();
524
525 int len = vsnprintf ((char *)cur, size, format, ap);
526
527 if (len >= size)
528 return reset ();
529
530 cur += len;
531 }
532
533 /******************************************************************************
534 *
535 * statistics logging functions.
536 *
537 ******************************************************************************/
538
539 #ifdef CS_LOGSTATS
540
541 /* cst_tot is for the life of the server, cst_last is for the last series of
542 * stats
543 */
544 CS_Stats cst_tot, cst_lst;
545
546 /**
547 * Writes out the gathered stats. We clear cst_lst.
548 */
549 void
550 write_cs_stats (void)
551 {
552 time_t now = time (NULL);
553
554 /* If no connections recently, don't both to log anything */
555 if (cst_lst.ibytes == 0 && cst_lst.obytes == 0)
556 return;
557
558 /* CSSTAT is put in so scripts can easily find the line */
559 LOG (llevInfo, "CSSTAT: %.16s tot %d %d %d %d inc %d %d %d %d\n",
560 ctime (&now), cst_tot.ibytes, cst_tot.obytes, cst_tot.max_conn,
561 now - cst_tot.time_start, cst_lst.ibytes, cst_lst.obytes, cst_lst.max_conn, now - cst_lst.time_start);
562 cst_lst.ibytes = 0;
563 cst_lst.obytes = 0;
564 cst_lst.time_start = now;
565 }
566 #endif
567