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.22 by root, Fri Dec 15 19:59:20 2006 UTC vs.
Revision 1.57 by root, Sat Sep 1 08:03:46 2007 UTC

1/* 1/*
2 CrossFire, A Multiplayer game for X-windows 2 * This file is part of Crossfire TRT, the Roguelike Realtime MORPG.
3 3 *
4 * Copyright (©) 2005,2006,2007 Marc Alexander Lehmann / Robin Redeker / the Crossfire TRT 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 * Crossfire TRT 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 <crossfire@schmorp.de>
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# define TCP_HZ 1000 // sorry...
46# include <netinet/tcp.h> 33# include <netinet/tcp.h>
47#endif 34#endif
48 35
49// 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,
50// easily die in 20 seconds... 37// forcing an ack regularly.
51#define SOCKET_TIMEOUT1 10 38#define IDLE_PING 2.
52#define SOCKET_TIMEOUT2 20
53 39
54void 40void
55client::flush () 41client::flush ()
56{ 42{
57#ifdef __linux__ 43 if (destroyed ())
58 // check time of last ack, and, if too old, kill connection 44 return;
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 status = Ns_Dead;
75 }
76 }
77#endif
78 45
79 /** 46 /**
80 * Writes data to socket. 47 * Writes data to socket.
81 * 48 *
82 * 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
83 * is called to write it out. 50 * is called to write it out.
84 */ 51 */
85 52
86 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 () & PE_W)
87 return; 68 return;
88 69
70 last_send = NOW;
89 write_outputbuffer (); 71 write_outputbuffer ();
90} 72}
91 73
92void 74void
93client::write_outputbuffer () 75client::write_outputbuffer ()
103 /* wrap back to start of buffer */ 85 /* wrap back to start of buffer */
104 if (outputbuffer.start == SOCKETBUFSIZE) 86 if (outputbuffer.start == SOCKETBUFSIZE)
105 outputbuffer.start = 0; 87 outputbuffer.start = 0;
106 88
107 outputbuffer.len -= res; 89 outputbuffer.len -= res;
108#ifdef CS_LOGSTATS
109 cst_tot.obytes += res;
110 cst_lst.obytes += res;
111#endif
112 } 90 }
113 else if (res == 0) 91 else if (res == 0)
114 { 92 {
115 LOG (llevError, "socket write failed, connection closed.\n"); 93 LOG (llevError, "socket write failed, connection closed.\n");
116 status = Ns_Dead; 94 destroy ();
117 return; 95 return;
118 } 96 }
119 else if (errno == EINTR) 97 else if (errno == EINTR)
120 { 98 {
121 // just retry 99 // just retry
128 return; 106 return;
129 } 107 }
130 else 108 else
131 { 109 {
132 LOG (llevError, "socket write failed: %s\n", strerror (errno)); 110 LOG (llevError, "socket write failed: %s\n", strerror (errno));
133 status = Ns_Dead; 111 destroy ();
134 return; 112 return;
135 } 113 }
136 } 114 }
137 115
138 socket_ev.poll (socket_ev.poll () & ~PE_W); 116 socket_ev.poll (socket_ev.poll () & ~PE_W);
139} 117}
140 118
119/******************************************************************************
120 *
121 * Start of read routines.
122 *
123 ******************************************************************************/
124
125int
126client::next_packet ()
127{
128 if (inbuf_len >= 2)
129 {
130 int pkt_len = (inbuf [0] << 8) | inbuf [1];
131
132 if (inbuf_len >= 2 + pkt_len)
133 return 2 + pkt_len;
134
135 if (inbuf_len == sizeof (inbuf))
136 {
137 send_packet_printf ("drawinfo %d input buffer overflow - closing connection.", NDI_RED | NDI_REPLY);
138 destroy ();
139 return -1;
140 }
141 }
142
143 return 0;
144}
145
146void
147client::skip_packet (int len)
148{
149 inbuf_len -= len;
150 memmove (inbuf, inbuf + len, inbuf_len);
151}
152
141/*********************************************************************** 153/*****************************************************************************
142 * 154 * Start of command dispatch area.
143 * packet functions/utilities 155 * The commands here are protocol commands.
144 *
145 **********************************************************************/ 156 ****************************************************************************/
146 157
147packet &packet::operator <<(const data &v) 158// SocketCommand, PlayingCommand, should not exist with those ugly casts
159#define SC(cb) (void *)static_cast<void (*)(char *, int, client *)>(cb),
160#define PC(cb) (void *)static_cast<void (*)(char *, int, player *)>(cb), PF_PLAYER |
161
162/**
163 * Dispatch table for the server.
164 */
165static struct packet_type packets[] = {
166 {"ncom", PC(NewPlayerCmd) PF_PLAYING | PF_COMMAND6 },
167 {"command", PC(PlayerCmd) PF_PLAYING | PF_COMMAND0 },
168
169 {"examine", PC(ExamineCmd) PF_PLAYING },
170 {"ex", PC(ExCmd) PF_PLAYING },
171 {"apply", PC(ApplyCmd) PF_PLAYING },
172 {"lookat", PC(LookAt) PF_PLAYING },
173 {"lock", PC(LockItem) PF_PLAYING },
174 {"mark", PC(MarkItem) PF_PLAYING },
175 {"move", PC(MoveCmd) PF_PLAYING },
176 {"ext", PC(ExtCmd) 0 }, // CF+
177 {"mapredraw", PC(MapRedrawCmd) 0 },
178 {"mapinfo", PC(MapInfoCmd) 0 }, // CF+
179
180 {"reply", SC(ReplyCmd) 0 },
181 {"exti", SC(ExtiCmd) 0 }, // CF+
182 {"addme", SC(AddMeCmd) 0 },
183 {"askface", SC(AskFaceCmd) 0 },
184 {"requestinfo", SC(RequestInfo) 0 },
185 {"setfacemode", SC(SetFaceMode) 0 },
186 {"setsound", SC(SetSound) 0 },
187 {"setup", SC(SetUp) 0 },
188 {"version", SC(VersionCmd) 0 },
189 {"toggleextendedinfos", SC(ToggleExtendedInfos) 0 }, /*Added: tchize */
190 {"toggleextendedtext", SC(ToggleExtendedText) 0 }, /*Added: tchize */
191 {"asksmooth", SC(AskSmooth) 0 }, /*Added: tchize (smoothing technologies) */
192};
193
194bool
195client::may_execute (const packet_type *pkt) const
148{ 196{
149 if (room () < v.len) 197 return (!(pkt->flags & PF_PLAYER) || pl)
150 reset (); 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 && !strncmp (data, "say " , 4))
222 return true;
223 if (len > 5 && !strncmp (data, "chat ", 5))
224 return true;
225
226 return false;
227}
228
229void
230client::execute (const packet_type *pkt, char *data, int datalen)
231{
232 if (may_execute (pkt) || always_immediate (this, pkt, data, datalen))
233 {
234 //TODO: only one format
235 if (pkt->flags & PF_PLAYER)
236 ((void (*)(char *, int, player *))pkt->cb)((char *)data, datalen, pl);
237 else
238 ((void (*)(char *, int, client *))pkt->cb)((char *)data, datalen, this);
239 }
151 else 240 else
241 send_packet_printf ("drawinfo %d ERROR: you cannot execute '%s' now.", NDI_RED | NDI_REPLY, pkt->name);
242}
243
244bool
245client::handle_packet ()
246{
247 int pkt_len = next_packet ();
248
249 if (!pkt_len)
250 return false;
251 else if (pkt_len < 0)
252 {
253 LOG (llevError, "read error on player %s\n",
254 pl && pl->ob ? &pl->ob->name : "[anonymous]");
255 destroy ();
256 return false;
152 { 257 }
153 if (v.len) 258
259 inbuf [pkt_len] = 0; /* Terminate buffer - useful for string data */
260
261 /* First, break out beginning word. There are at least
262 * a few commands that do not have any paremeters. If
263 * we get such a command, don't worry about trying
264 * to break it up.
265 */
266 int datalen;
267 char *data = strchr ((char *)inbuf + 2, ' ');
268
269 if (data)
270 {
271 *data++ = 0;
272 datalen = pkt_len - (data - (char *)inbuf);
273 }
274 else
275 {
276 data = (char *)inbuf + 2; // better read garbage than segfault
277 datalen = 0;
278 }
279
280 for (packet_type *pkt = packets; pkt < packets + (sizeof (packets) / sizeof (packets[0])); ++pkt)
281 if (!strcmp ((char *)inbuf + 2, pkt->name))
154 { 282 {
155 memcpy (cur, v.ptr, v.len); 283 if (pkt->flags & PF_PLAYER && !always_immediate (this, pkt, data, datalen))
156 cur += v.len; 284 queue_command (pkt, data, datalen);
285 else
286 execute (pkt, data, datalen);
287
288 goto next_packet;
157 } 289 }
290
291 // If we get here, we didn't find a valid command.
292 send_packet_printf ("drawinfo %d ERROR: command '%s' not supported.", NDI_RED | NDI_REPLY, (char *)inbuf + 2);
293next_packet:
294 skip_packet (pkt_len);
295
296 // input buffer has space again
297 socket_ev.poll (socket_ev.poll () | PE_R);
298
299 return true;
300}
301
302// callback called when socket is either readable or writable
303void
304client::socket_cb (iow &w, int got)
305{
306 //TODO remove when we have better socket cleanup logic
307 if (destroyed ())
158 } 308 {
159 309 socket_ev.poll (0);
160 return *this; 310 return;
161}
162
163packet &packet::operator <<(const data8 &v)
164{
165 unsigned int len = min (v.len, 0x00FF);
166 return *this << uint8 (len) << data (v.ptr, len);
167}
168
169packet &packet::operator <<(const data16 &v)
170{
171 unsigned int len = min (v.len, 0xFFFF);
172 return *this << uint16 (len) << data (v.ptr, len);
173}
174
175packet &packet::operator <<(const char *v)
176{
177 return *this << data (v, strlen (v ? v : 0));
178}
179
180void
181packet::printf (const char *format, ...)
182{
183 int size = room ();
184
185 va_list ap;
186 va_start (ap, format);
187 int len = vsnprintf ((char *)cur, size, format, ap);
188 va_end (ap);
189
190 if (len >= size)
191 return reset ();
192
193 cur += len;
194}
195
196/******************************************************************************
197 *
198 * Start of read routines.
199 *
200 ******************************************************************************/
201
202int
203client::read_packet ()
204{
205 for (;;)
206 { 311 }
207 if (inbuf_len >= 2)
208 {
209 unsigned int pkt_len = (inbuf [0] << 8) | inbuf [1];
210 312
211 if (inbuf_len >= 2 + pkt_len) 313 if (got & PE_W)
212 return pkt_len + 2; 314 {
213 } 315 write_outputbuffer ();
316
317 if (!outputbuffer.len)
318 socket_ev.poll (socket_ev.poll () & ~PE_W);
319 }
320
321 if (got & PE_R)
322 {
323 //TODO: rate-limit tcp connection in better ways, important
214 324
215 int amount = sizeof (inbuf) - inbuf_len; 325 int amount = sizeof (inbuf) - inbuf_len;
216 326
217 if (amount <= 0) 327 if (!amount)
218 { 328 {
219 LOG (llevError, "packet too large");//TODO 329 // input buffer full
330 socket_ev.poll (socket_ev.poll () & ~PE_R);
220 return -1; 331 return;
221 } 332 }
222 333
223 amount = read (fd, inbuf + inbuf_len, amount); 334 amount = read (fd, inbuf + inbuf_len, amount);
224 335
225 if (!amount) 336 if (!amount)
226 { 337 {
227 status = Ns_Dead; 338 destroy ();
228 return -1; 339 return;
229 } 340 }
230 else if (amount < 0) 341 else if (amount < 0)
231 { 342 {
232 if (errno != EAGAIN && errno != EINTR) 343 if (errno != EAGAIN && errno != EINTR)
233 { 344 {
234 LOG (llevError, "read error: %s\n", strerror (errno)); 345 LOG (llevError, "read error: %s\n", strerror (errno));
346 destroy ();
235 return -1; 347 return;
236 } 348 }
237 349
238 return 0; 350 // should not be here, normally
351 }
352 else
239 } 353 {
240
241 inbuf_len += amount; 354 inbuf_len += amount;
242 355
243 cst_tot.ibytes += amount; 356 cmd_ev.start ();
244 cst_lst.ibytes += amount; 357 }
245 } 358 }
246} 359}
247 360
361// called whenever we have additional commands to process
248void 362void
249client::skip_packet (int len) 363client::cmd_cb (iw &w)
250{ 364{
251 inbuf_len -= len; 365 if (handle_packet ())
252 memmove (inbuf, inbuf + len, inbuf_len); 366 w.start ();
367 else
368 flush ();
253} 369}
254 370
255/******************************************************************************* 371/*******************************************************************************
256 * 372 *
257 * Start of write related routines. 373 * Start of write related routines.
266 */ 382 */
267void 383void
268client::send (void *buf_, int len) 384client::send (void *buf_, int len)
269{ 385{
270 char *buf = (char *)buf_; 386 char *buf = (char *)buf_;
271 char *pos = buf;
272 int amt = 0;
273 387
274 if (status == Ns_Dead || !buf) 388 if (destroyed () || !buf)
275 {
276 LOG (llevDebug, "Write_To_Socket called with dead socket\n");
277 return; 389 return;
278 }
279 390
280 if ((len + outputbuffer.len) > SOCKETBUFSIZE) 391 if (len + outputbuffer.len > SOCKETBUFSIZE)
281 { 392 {
282 LOG (llevDebug, "Socket on fd %d has overrun internal buffer - marking as dead\n", fd); 393 LOG (llevDebug, "socket on fd %d has overrun internal buffer - marking as dead\n", fd);
283 status = Ns_Dead; 394 // shutdown the socket, this is safer than destroying it immediately
395 // as lots of code in the callchain might still access the map etc.
396 shutdown (fd, SHUT_RDWR);
284 return; 397 return;
285 } 398 }
286 399
287 int avail, end; 400 int avail, end;
288 401
306 } 419 }
307 420
308 outputbuffer.len += len; 421 outputbuffer.len += len;
309} 422}
310 423
311void
312client::socket_cb (iow &w, int got)
313{
314 write_outputbuffer ();
315
316 if (!outputbuffer.len)
317 socket_ev.poll (socket_ev.poll () & ~PE_W);
318}
319
320/** 424/**
321 * Takes a string of data, and writes it out to the socket. A very handy 425 * Takes a string of data, and writes it out to the socket. A very handy
322 * shortcut function. 426 * shortcut function.
323 */ 427 */
324void 428void
325client::send_packet (packet &sl) 429client::send_packet (packet &sl)
326{ 430{
327 if (status == Ns_Dead) 431 if (destroyed ())
328 return; 432 return;
329 433
330 if (sl.length () >= MAXSOCKBUF) 434 if (sl.length () > MAXSOCKBUF)
331 { 435 {
332 LOG (llevError, "Trying to send a buffer beyond properly size, len =%d\n", sl.length ()); 436 LOG (llevError, "Trying to send a buffer beyond properly size, len =%d\n", sl.length ());
333 /* Almost certainly we've overflowed a buffer, so quit now to make 437 /* Almost certainly we've overflowed a buffer, so quit now to make
334 * it easier to debug. 438 * it easier to debug.
335 */ 439 */
360client::send_packet (const char *buf) 464client::send_packet (const char *buf)
361{ 465{
362 send_packet (buf, strlen (buf)); 466 send_packet (buf, strlen (buf));
363} 467}
364 468
469void
470client::send_packet_printf (const char *format, ...)
471{
472 packet sl;
473
474 va_list ap;
475 va_start (ap, format);
476 sl.vprintf (format, ap);
477 va_end (ap);
478
479 send_packet (sl);
480}
481
482// returns true when the message needs special (read: perl) treatment
483static bool
484msg_is_special (const char *msg)
485{
486 return msg [strcspn (msg, "<[&\n")];
487}
488
489void
490client::send_msg (int color, const char *type, const char *msg)
491{
492 if (msg_is_special (msg) || (type [0] == 'c' && type [1] == '/'))
493 cfperl_send_msg (this, color, type, msg);
494 else if (can_msg)
495 send_packet_printf ("msg %d %s %s", color & NDI_CLIENT_MASK, type, msg);
496 else if (color < 0)
497 return; // client cannot handle this
498 else
499 send_packet_printf ("drawinfo %d %s", color & NDI_COLOR_MASK, msg);
500}
501
502void
503client::send_drawinfo (const char *msg, int flags)
504{
505 send_msg (flags, "log", msg);
506}
507
365/****************************************************************************** 508/***********************************************************************
366 * 509 *
367 * statistics logging functions. 510 * packet functions/utilities
368 * 511 *
369 ******************************************************************************/ 512 **********************************************************************/
370 513
371#ifdef CS_LOGSTATS 514packet::packet (const char *name)
372
373/* cst_tot is for the life of the server, cst_last is for the last series of
374 * stats
375 */
376CS_Stats cst_tot, cst_lst;
377
378/**
379 * Writes out the gathered stats. We clear cst_lst.
380 */
381void
382write_cs_stats (void)
383{ 515{
384 time_t now = time (NULL); 516 reset ();
385 517
386 /* If no connections recently, don't both to log anything */ 518 int len = strlen (name);
387 if (cst_lst.ibytes == 0 && cst_lst.obytes == 0) 519 memcpy (cur, name, len); cur += len;
388 return; 520 *cur++ = ' ';
389
390 /* CSSTAT is put in so scripts can easily find the line */
391 LOG (llevInfo, "CSSTAT: %.16s tot %d %d %d %d inc %d %d %d %d\n",
392 ctime (&now), cst_tot.ibytes, cst_tot.obytes, cst_tot.max_conn,
393 now - cst_tot.time_start, cst_lst.ibytes, cst_lst.obytes, cst_lst.max_conn, now - cst_lst.time_start);
394 cst_lst.ibytes = 0;
395 cst_lst.obytes = 0;
396 cst_lst.time_start = now;
397} 521}
398#endif
399 522
523packet &packet::operator <<(const ber32 v)
524{
525 enum { maxlen = 32 / 7 + 1};
526 uint8 buf[maxlen];
527 uint8 *p = buf + maxlen;
528 uint32 val = v.val;
529
530 *--p = val & 0x7F;
531
532 while (val > 0x7F)
533 {
534 val >>= 7;
535 *--p = (val & 0x7F) | 0x80;
536 }
537
538 return *this << data (p, buf + maxlen - p);
539}
540
541packet &packet::operator <<(const data &v)
542{
543 if (room () < v.len)
544 reset ();
545 else
546 {
547 if (v.len)
548 {
549 memcpy (cur, v.ptr, v.len);
550 cur += v.len;
551 }
552 }
553
554 return *this;
555}
556
557packet &packet::operator <<(const data8 &v)
558{
559 unsigned int len = min (v.len, 0x00FF);
560 return *this << uint8 (len) << data (v.ptr, len);
561}
562
563packet &packet::operator <<(const data16 &v)
564{
565 unsigned int len = min (v.len, 0xFFFF);
566 return *this << uint16 (len) << data (v.ptr, len);
567}
568
569packet &packet::operator <<(const char *v)
570{
571 return *this << data (v, strlen (v ? v : 0));
572}
573
574void
575packet::vprintf (const char *format, va_list ap)
576{
577 int size = room ();
578
579 int len = vsnprintf ((char *)cur, size, format, ap);
580
581 if (len >= size)
582 return reset ();
583
584 cur += len;
585}
586

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines