ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/deliantra/server/socket/lowlevel.C
(Generate patch)

Comparing deliantra/server/socket/lowlevel.C (file contents):
Revision 1.26 by root, Tue Dec 19 04:58:05 2006 UTC vs.
Revision 1.64 by root, Tue May 6 16:55:26 2008 UTC

1/* 1/*
2 CrossFire, A Multiplayer game for X-windows 2 * This file is part of Deliantra, the Roguelike Realtime MMORPG.
3 3 *
4 * Copyright (©) 2005,2006,2007,2008 Marc Alexander Lehmann / Robin Redeker / the Deliantra team
4 Copyright (C) 1992 Frank Tore Johansen 5 * Copyright (©) 1992,2007 Frank Tore Johansen
5 6 *
6 This program is free software; you can redistribute it and/or modify 7 * Deliantra 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 * 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 * the Free Software Foundation, either version 3 of the License, or
9 (at your option) any later version. 10 * (at your option) any later version.
10 11 *
11 This program is distributed in the hope that it will be useful, 12 * This program is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of 13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU General Public License for more details. 15 * GNU General Public License for more details.
15 16 *
16 You should have received a copy of the GNU General Public License 17 * 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 * along with this program. If not, see <http://www.gnu.org/licenses/>.
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 * 19 *
27 * \date 2003-12-02 20 * The authors can be reached via e-mail to <support@deliantra.net>
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 */ 21 */
34 22
35using namespace std; 23using namespace std;
36 24
37#include <global.h> 25#include <global.h>
38#include <sproto.h> 26#include <sproto.h>
39#include <cstdarg> 27#include <cstdarg>
40 28
41#ifdef __linux__ 29#if HAVE_TCP_INFO
42# include <sys/types.h> 30# include <sys/types.h>
43# include <sys/socket.h> 31# include <sys/socket.h>
44# include <netinet/in.h> 32# include <netinet/in.h>
45# include <netinet/tcp.h> 33# include <netinet/tcp.h>
46#endif 34#endif
47 35
48// use a really low timeout, as it doesn't cost any bandwidth, and you can 36// force a packet when idle for more than this many seconds,
49// easily die in 20 seconds... 37// forcing an ack regularly.
50#define SOCKET_TIMEOUT1 10 * 1000 38#define IDLE_PING 2.
51#define SOCKET_TIMEOUT2 20 * 1000
52 39
53void 40void
54client::flush () 41client::flush ()
55{ 42{
56#ifdef __linux__ 43 if (destroyed ())
57 // check time of last ack, and, if too old, kill connection 44 return;
58 struct tcp_info tcpi;
59 socklen_t len = sizeof (tcpi);
60
61 if (!getsockopt (fd, IPPROTO_TCP, TCP_INFO, &tcpi, &len) && len == sizeof (tcpi))
62 {
63 unsigned int diff = tcpi.tcpi_last_ack_recv - tcpi.tcpi_last_data_sent;
64
65 rtt = tcpi.tcpi_rtt;
66 rttvar = tcpi.tcpi_rttvar;
67
68 if (tcpi.tcpi_unacked && SOCKET_TIMEOUT1 < diff && diff < 0x80000000UL // ack delayed for 20s
69 && SOCKET_TIMEOUT2 < tcpi.tcpi_last_data_sent) // no data sent for 10s
70 {
71 LOG (llevDebug, "Connection on fd %d closed due to ack timeout (%u/%u/%u)\n", fd,
72 (unsigned) tcpi.tcpi_last_ack_recv, (unsigned) tcpi.tcpi_last_data_sent, (unsigned) tcpi.tcpi_unacked);
73 destroy ();
74 }
75 }
76#endif
77 45
78 /** 46 /**
79 * Writes data to socket. 47 * Writes data to socket.
80 * 48 *
81 * When the socket is clear to write, and we have backlogged data, this 49 * When the socket is clear to write, and we have backlogged data, this
82 * is called to write it out. 50 * is called to write it out.
83 */ 51 */
84 52
85 if (!outputbuffer.len || socket_ev.poll () & PE_W) 53 // write a nop to the socket at least every IDLE_NOP seconds.
54 if (!outputbuffer.len)
55 {
56 if (last_send + IDLE_PING <= NOW && pl && pl->active)
57 {
58 // this is a bit ugly, but map1/map1a seem to be the only
59 // nop'able commands and they are quite small.
60 packet sl (mapmode == Map1Cmd ? "map1" : "map1a");
61 send_packet (sl);
62 }
63 else
64 return;
65 }
66
67 if (socket_ev.poll () & EV_WRITE)
86 return; 68 return;
87 69
70 last_send = NOW;
88 write_outputbuffer (); 71 write_outputbuffer ();
89} 72}
90 73
91void 74void
92client::write_outputbuffer () 75client::write_outputbuffer ()
102 /* wrap back to start of buffer */ 85 /* wrap back to start of buffer */
103 if (outputbuffer.start == SOCKETBUFSIZE) 86 if (outputbuffer.start == SOCKETBUFSIZE)
104 outputbuffer.start = 0; 87 outputbuffer.start = 0;
105 88
106 outputbuffer.len -= res; 89 outputbuffer.len -= res;
107#ifdef CS_LOGSTATS
108 cst_tot.obytes += res;
109 cst_lst.obytes += res;
110#endif
111 } 90 }
112 else if (res == 0) 91 else if (res == 0)
113 { 92 {
114 LOG (llevError, "socket write failed, connection closed.\n"); 93 LOG (llevError, "socket write failed, connection closed.\n");
115 destroy (); 94 destroy ();
120 // just retry 99 // just retry
121 } 100 }
122 else if (errno == EAGAIN) 101 else if (errno == EAGAIN)
123 { 102 {
124 // delay till ready 103 // delay till ready
125 socket_ev.poll (socket_ev.poll () | PE_W); 104 socket_ev.poll (socket_ev.poll () | EV_WRITE);
126 socket_ev.start (); 105 socket_ev.start ();
127 return; 106 return;
128 } 107 }
129 else 108 else
130 { 109 {
132 destroy (); 111 destroy ();
133 return; 112 return;
134 } 113 }
135 } 114 }
136 115
137 socket_ev.poll (socket_ev.poll () & ~PE_W); 116 socket_ev.poll (socket_ev.poll () & ~EV_WRITE);
138} 117}
139 118
140/****************************************************************************** 119/******************************************************************************
141 * 120 *
142 * Start of read routines. 121 * Start of read routines.
153 if (inbuf_len >= 2 + pkt_len) 132 if (inbuf_len >= 2 + pkt_len)
154 return 2 + pkt_len; 133 return 2 + pkt_len;
155 134
156 if (inbuf_len == sizeof (inbuf)) 135 if (inbuf_len == sizeof (inbuf))
157 { 136 {
158 send_packet_printf ("drawinfo %d input buffer overflow - closing connection.", NDI_RED); 137 send_packet_printf ("drawinfo %d input buffer overflow - closing connection.", NDI_RED | NDI_REPLY);
159 destroy (); 138 destroy ();
160 return -1; 139 return -1;
161 } 140 }
162 } 141 }
163 142
182 161
183/** 162/**
184 * Dispatch table for the server. 163 * Dispatch table for the server.
185 */ 164 */
186static struct packet_type packets[] = { 165static struct packet_type packets[] = {
187 {"ncom", PC(NewPlayerCmd) PF_PLAYING }, 166 {"ncom", PC(NewPlayerCmd) PF_PLAYING | PF_COMMAND6 },
188 {"command", PC(PlayerCmd) PF_PLAYING }, 167 {"command", PC(PlayerCmd) PF_PLAYING | PF_COMMAND0 },
189 168
190 {"examine", PC(ExamineCmd) PF_PLAYING }, 169 {"examine", PC(ExamineCmd) PF_PLAYING },
170 {"ex", PC(ExCmd) PF_PLAYING },
191 {"apply", PC(ApplyCmd) PF_PLAYING }, 171 {"apply", PC(ApplyCmd) PF_PLAYING },
192 {"reply", PC(ReplyCmd) 0 },
193 {"lookat", PC(LookAt) PF_PLAYING }, 172 {"lookat", PC(LookAt) PF_PLAYING },
194 {"lock", PC(LockItem) PF_PLAYING }, 173 {"lock", PC(LockItem) PF_PLAYING },
195 {"mark", PC(MarkItem) PF_PLAYING }, 174 {"mark", PC(MarkItem) PF_PLAYING },
196 {"move", PC(MoveCmd) PF_PLAYING }, 175 {"move", PC(MoveCmd) PF_PLAYING },
197 {"ext", PC(ExtCmd) 0 }, /* CF+ */ 176 {"ext", PC(ExtCmd) 0 }, // CF+
198 {"mapredraw", PC(MapRedrawCmd) 0 }, /* Added: phil */ 177 {"mapredraw", PC(MapRedrawCmd) 0 },
199 {"mapinfo", PC(MapInfoCmd) 0 }, /* CF+ */ 178 {"mapinfo", PC(MapInfoCmd) 0 }, // CF+
200 179
180 {"reply", SC(ReplyCmd) 0 },
201 {"exti", SC(ExtiCmd) 0 }, /* CF+ */ 181 {"exti", SC(ExtiCmd) 0 }, // CF+
202 {"addme", SC(AddMeCmd) 0 }, 182 {"addme", SC(AddMeCmd) 0 },
203 {"askface", SC(SendFaceCmd) 0 }, /* Added: phil */ 183 {"askface", SC(AskFaceCmd) 0 },
204 {"requestinfo", SC(RequestInfo) 0 }, 184 {"requestinfo", SC(RequestInfo) 0 },
205 {"setfacemode", SC(SetFaceMode) 0 }, 185 {"setfacemode", SC(SetFaceMode) 0 },
206 {"setsound", SC(SetSound) 0 }, 186 {"setsound", SC(SetSound) 0 },
207 {"setup", SC(SetUp) 0 }, 187 {"setup", SC(SetUp) 0 },
208 {"version", SC(VersionCmd) 0 }, 188 {"version", SC(VersionCmd) 0 },
213 193
214bool 194bool
215client::may_execute (const packet_type *pkt) const 195client::may_execute (const packet_type *pkt) const
216{ 196{
217 return (!(pkt->flags & PF_PLAYER) || pl) 197 return (!(pkt->flags & PF_PLAYER) || pl)
218 && (!(pkt->flags & PF_PLAYING) || (pl && pl->state == ST_PLAYING)); 198 && (!(pkt->flags & PF_PLAYING) || state == ST_PLAYING);
199}
200
201// HACK: some commands currently should be executed
202// even when the player is frozen. this hack detects
203// those commands. it should be folded into may_execute,
204// but kept seperate to emphasise the hack aspect, i.e.
205// do it better, then remove.
206static bool
207always_immediate (const client *ns, const packet_type *pkt, const char *data, int len)
208{
209 if (!(pkt->flags & (PF_COMMAND0 | PF_COMMAND6)))
210 return false;
211
212 if (!ns->pl || !ns->pl->ob || !ns->pl->ob->map)
213 return false;
214
215 if (pkt->flags & PF_COMMAND6)
216 {
217 data += 6;
218 len -= 6;
219 }
220
221 if (len > 4 && data [3] == ' ' && !strncmp (data, "say " , 4)) return true;
222 if (len > 5 && data [4] == ' ' && !strncmp (data, "chat " , 5)) return true;
223 if (len > 6 && data [5] == ' ' && !strncmp (data, "shout ", 6)) return true;
224
225 if (len == 7 && !strcmp (data, "suicide")) return true;
226
227 return false;
219} 228}
220 229
221void 230void
222client::execute (const packet_type *pkt, char *data, int datalen) 231client::execute (const packet_type *pkt, char *data, int datalen)
223{ 232{
224 if (may_execute (pkt)) 233 if (may_execute (pkt) || always_immediate (this, pkt, data, datalen))
225 { 234 {
226 //TODO: only one format 235 //TODO: only one format
227 if (pkt->flags & PF_PLAYER) 236 if (pkt->flags & PF_PLAYER)
228 ((void (*)(char *, int, player *))pkt->cb)((char *)data, datalen, pl); 237 ((void (*)(char *, int, player *))pkt->cb)((char *)data, datalen, pl);
229 else 238 else
230 ((void (*)(char *, int, client *))pkt->cb)((char *)data, datalen, this); 239 ((void (*)(char *, int, client *))pkt->cb)((char *)data, datalen, this);
231 } 240 }
232 else 241 else
233 send_packet_printf ("drawinfo %d ERROR: you cannot execute '%s' now.", NDI_RED, pkt->name); 242 send_packet_printf ("drawinfo %d ERROR: you cannot execute '%s' now.", NDI_RED | NDI_REPLY, pkt->name);
234} 243}
235 244
236bool 245bool
237client::handle_packet () 246client::handle_packet ()
238{ 247{
270 } 279 }
271 280
272 for (packet_type *pkt = packets; pkt < packets + (sizeof (packets) / sizeof (packets[0])); ++pkt) 281 for (packet_type *pkt = packets; pkt < packets + (sizeof (packets) / sizeof (packets[0])); ++pkt)
273 if (!strcmp ((char *)inbuf + 2, pkt->name)) 282 if (!strcmp ((char *)inbuf + 2, pkt->name))
274 { 283 {
275 if (pkt->flags & PF_PLAYER) 284 if (pkt->flags & PF_PLAYER && !always_immediate (this, pkt, data, datalen))
276 queue_command (pkt, data, datalen); 285 queue_command (pkt, data, datalen);
277 else 286 else
278 execute (pkt, data, datalen); 287 execute (pkt, data, datalen);
279 288
280 goto next_packet; 289 goto next_packet;
281 } 290 }
282 291
283 // If we get here, we didn't find a valid command. 292 // If we get here, we didn't find a valid command.
284 send_packet_printf ("drawinfo %d ERROR: command '%s' not supported.", NDI_RED, (char *)inbuf + 2); 293 send_packet_printf ("drawinfo %d ERROR: command '%s' not supported.", NDI_RED | NDI_REPLY, (char *)inbuf + 2);
285next_packet: 294next_packet:
286 skip_packet (pkt_len); 295 skip_packet (pkt_len);
287 296
288 // input buffer has space again 297 // input buffer has space again
289 socket_ev.poll (socket_ev.poll () | PE_R); 298 socket_ev.poll (socket_ev.poll () | EV_READ);
290 299
291 return true; 300 return true;
292} 301}
293 302
294// callback called when socket is either readable or writable 303// callback called when socket is either readable or writable
295void 304void
296client::socket_cb (iow &w, int got) 305client::socket_cb (iow &w, int revents)
297{ 306{
298 //TODO remove when we have better socket cleanup logic 307 //TODO remove when we have better socket cleanup logic
299 if (status == Ns_Dead) 308 if (destroyed ())
300 { 309 {
301 socket_ev.poll (0); 310 socket_ev.poll (0);
302 return; 311 return;
303 } 312 }
304 313
305 if (got & PE_W) 314 if (revents & EV_WRITE)
306 { 315 {
307 write_outputbuffer (); 316 write_outputbuffer ();
308 317
309 if (!outputbuffer.len) 318 if (!outputbuffer.len)
310 socket_ev.poll (socket_ev.poll () & ~PE_W); 319 socket_ev.poll (socket_ev.poll () & ~EV_WRITE);
311 } 320 }
312 321
313 if (got & PE_R) 322 if (revents & EV_READ)
314 { 323 {
315 //TODO: rate-limit tcp connection in better ways, important 324 //TODO: rate-limit tcp connection in better ways, important
316 325
317 int amount = sizeof (inbuf) - inbuf_len; 326 int amount = sizeof (inbuf) - inbuf_len;
318 327
319 if (!amount) 328 if (!amount)
320 { 329 {
321 // input buffer full 330 // input buffer full
322 socket_ev.poll (socket_ev.poll () & ~PE_R); 331 socket_ev.poll (socket_ev.poll () & ~EV_READ);
323 return; 332 return;
324 } 333 }
325 334
326 amount = read (fd, inbuf + inbuf_len, amount); 335 amount = read (fd, inbuf + inbuf_len, amount);
327 336
343 } 352 }
344 else 353 else
345 { 354 {
346 inbuf_len += amount; 355 inbuf_len += amount;
347 356
348 cst_tot.ibytes += amount;
349 cst_lst.ibytes += amount;
350
351 cmd_ev.start ();
352 }
353 }
354}
355
356// called whenever we have additional commands to process
357void
358client::cmd_cb (iw &w)
359{
360 if (handle_packet ()) 357 if (handle_packet ())
361 w.start (); 358 {
362 else 359 while (handle_packet ())
363 flush (); 360 ;
361
362 flush ();
363 }
364 }
365 }
364} 366}
365 367
366/******************************************************************************* 368/*******************************************************************************
367 * 369 *
368 * Start of write related routines. 370 * Start of write related routines.
377 */ 379 */
378void 380void
379client::send (void *buf_, int len) 381client::send (void *buf_, int len)
380{ 382{
381 char *buf = (char *)buf_; 383 char *buf = (char *)buf_;
382 char *pos = buf;
383 int amt = 0;
384 384
385 if (status == Ns_Dead || !buf) 385 if (destroyed () || !buf)
386 return; 386 return;
387 387
388 if ((len + outputbuffer.len) > SOCKETBUFSIZE) 388 if (len + outputbuffer.len > SOCKETBUFSIZE)
389 { 389 {
390 LOG (llevDebug, "socket on fd %d has overrun internal buffer - marking as dead\n", fd); 390 LOG (llevDebug, "socket on fd %d has overrun internal buffer - marking as dead\n", fd);
391 destroy (); 391 // shutdown the socket, this is safer than destroying it immediately
392 // as lots of code in the callchain might still access the map etc.
393 shutdown (fd, SHUT_RDWR);
392 return; 394 return;
393 } 395 }
394 396
395 int avail, end; 397 int avail, end;
396 398
421 * shortcut function. 423 * shortcut function.
422 */ 424 */
423void 425void
424client::send_packet (packet &sl) 426client::send_packet (packet &sl)
425{ 427{
426 if (status == Ns_Dead) 428 if (destroyed ())
427 return; 429 return;
428 430
429 if (sl.length () >= MAXSOCKBUF) 431 if (sl.length () > MAXSOCKBUF)
430 { 432 {
431 LOG (llevError, "Trying to send a buffer beyond properly size, len =%d\n", sl.length ()); 433 LOG (llevError, "Trying to send a buffer beyond properly size, len =%d\n", sl.length ());
432 /* Almost certainly we've overflowed a buffer, so quit now to make 434 /* Almost certainly we've overflowed a buffer, so quit now to make
433 * it easier to debug. 435 * it easier to debug.
434 */ 436 */
472 va_end (ap); 474 va_end (ap);
473 475
474 send_packet (sl); 476 send_packet (sl);
475} 477}
476 478
479// returns true when the message needs special (read: perl) treatment
480static bool
481msg_is_special (const char *msg)
482{
483 return msg [strcspn (msg, "<[&\n")];
484}
485
486void
487client::send_msg (int color, const char *type, const char *msg)
488{
489 if (!msg || !type) // it can happen (for example, missing attack messages cause this)
490 {
491 LOG (logBacktrace | llevError, "send_msg(%d,%p,%p) called with NULL msg or type.\n", color, type, msg);
492 return;
493 }
494
495 int len = strlen (msg);
496
497 if (msg_is_special (msg) || (type [0] == 'c' && type [1] == '/') || len > (MAXSOCKBUF - 128))
498 cfperl_send_msg (this, color, type, msg);
499 else if (can_msg)
500 send_packet_printf ("msg %d %s %s", color & NDI_CLIENT_MASK, type, msg);
501 else if (color < 0)
502 return; // client cannot handle this
503 else
504 send_packet_printf ("drawinfo %d %s", color & NDI_COLOR_MASK, msg);
505}
506
507void
508client::send_drawinfo (const char *msg, int flags)
509{
510 send_msg (flags, "log", msg);
511}
512
477/*********************************************************************** 513/***********************************************************************
478 * 514 *
479 * packet functions/utilities 515 * packet functions/utilities
480 * 516 *
481 **********************************************************************/ 517 **********************************************************************/
518
519packet::packet (const char *name)
520{
521 reset ();
522
523 int len = strlen (name);
524 memcpy (cur, name, len); cur += len;
525 *cur++ = ' ';
526}
527
528packet &packet::operator <<(const ber32 v)
529{
530 enum { maxlen = 32 / 7 + 1};
531 uint8 buf[maxlen];
532 uint8 *p = buf + maxlen;
533 uint32 val = v.val;
534
535 *--p = val & 0x7F;
536
537 while (val > 0x7F)
538 {
539 val >>= 7;
540 *--p = (val & 0x7F) | 0x80;
541 }
542
543 return *this << data (p, buf + maxlen - p);
544}
482 545
483packet &packet::operator <<(const data &v) 546packet &packet::operator <<(const data &v)
484{ 547{
485 if (room () < v.len) 548 if (room () < v.len)
486 reset (); 549 reset ();
524 return reset (); 587 return reset ();
525 588
526 cur += len; 589 cur += len;
527} 590}
528 591
529/******************************************************************************
530 *
531 * statistics logging functions.
532 *
533 ******************************************************************************/
534
535#ifdef CS_LOGSTATS
536
537/* cst_tot is for the life of the server, cst_last is for the last series of
538 * stats
539 */
540CS_Stats cst_tot, cst_lst;
541
542/**
543 * Writes out the gathered stats. We clear cst_lst.
544 */
545void
546write_cs_stats (void)
547{
548 time_t now = time (NULL);
549
550 /* If no connections recently, don't both to log anything */
551 if (cst_lst.ibytes == 0 && cst_lst.obytes == 0)
552 return;
553
554 /* CSSTAT is put in so scripts can easily find the line */
555 LOG (llevInfo, "CSSTAT: %.16s tot %d %d %d %d inc %d %d %d %d\n",
556 ctime (&now), cst_tot.ibytes, cst_tot.obytes, cst_tot.max_conn,
557 now - cst_tot.time_start, cst_lst.ibytes, cst_lst.obytes, cst_lst.max_conn, now - cst_lst.time_start);
558 cst_lst.ibytes = 0;
559 cst_lst.obytes = 0;
560 cst_lst.time_start = now;
561}
562#endif
563

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines