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.7 by root, Sun Nov 26 19:48:50 2006 UTC vs.
Revision 1.88 by root, Tue Nov 6 15:11:16 2012 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 (C) 1992 Frank Tore Johansen 4 * Copyright (©) 2005,2006,2007,2008,2009,2010,2011,2012 Marc Alexander Lehmann / Robin Redeker / the Deliantra team
5 5 *
6 This program is free software; you can redistribute it and/or modify 6 * Deliantra is free software: you can redistribute it and/or modify it under
7 it under the terms of the GNU General Public License as published by 7 * the terms of the Affero GNU General Public License as published by the
8 the Free Software Foundation; either version 2 of the License, or 8 * Free Software Foundation, either version 3 of the License, or (at your
9 (at your option) any later version. 9 * option) any later version.
10 10 *
11 This program is distributed in the hope that it will be useful, 11 * This program is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of 12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU General Public License for more details. 14 * GNU General Public License for more details.
15 15 *
16 You should have received a copy of the GNU General Public License 16 * You should have received a copy of the Affero GNU General Public License
17 along with this program; if not, write to the Free Software 17 * and the GNU General Public License along with this program. If not, see
18 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. 18 * <http://www.gnu.org/licenses/>.
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 <newclient.h>
39#include <sproto.h> 26#include <sproto.h>
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
55Socket_Flush (NewSocket * ns) 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 45
62 if (!getsockopt (ns->fd, IPPROTO_TCP, TCP_INFO, &tcpi, &len) && len == sizeof (tcpi)) 46 /**
63 { 47 * Writes data to socket.
64 unsigned int diff = tcpi.tcpi_last_ack_recv - tcpi.tcpi_last_data_sent; 48 *
49 * When the socket is clear to write, and we have backlogged data, this
50 * is called to write it out.
51 */
65 52
66 if (tcpi.tcpi_unacked && SOCKET_TIMEOUT1 * TCP_HZ < diff && diff < 0x80000000UL // ack delayed for 20s 53 // write a nop to the socket at least every IDLE_NOP seconds.
67 && SOCKET_TIMEOUT2 * TCP_HZ < tcpi.tcpi_last_data_sent) // no data sent for 10s 54 if (!outputbuffer.len)
68 { 55 {
69 LOG (llevDebug, "Connection on fd %d closed due to ack timeout (%u/%u/%u)\n", ns->fd, 56 if (last_send + IDLE_PING <= NOW && pl && pl->active)
70 (unsigned) tcpi.tcpi_last_ack_recv, (unsigned) tcpi.tcpi_last_data_sent, (unsigned) tcpi.tcpi_unacked);
71 ns->status = Ns_Dead;
72 } 57 {
58 // this is a bit ugly, but map1a seems to be the only
59 // nop'able command and it is quite small.
60 packet sl ("map1a");
61 send_packet (sl);
62 }
63 else
64 return;
65 }
66
67 if (socket_ev.poll () & EV_WRITE)
68 return;
69
70 last_send = NOW;
71 write_outputbuffer ();
72}
73
74void
75client::write_outputbuffer ()
76{
77 while (outputbuffer.len)
73 } 78 {
79 int res = write (fd, outputbuffer.data + outputbuffer.start,
80 min (outputbuffer.len, SOCKETBUFSIZE - outputbuffer.start));
74 81
75 int val; 82 if (res > 0)
83 {
84 outputbuffer.start += res;
85 /* wrap back to start of buffer */
86 if (outputbuffer.start == SOCKETBUFSIZE)
87 outputbuffer.start = 0;
76 88
77 val = 0; 89 outputbuffer.len -= res;
78 setsockopt (ns->fd, IPPROTO_TCP, TCP_CORK, &val, sizeof (val)); 90 }
79 val = 1; 91 else if (res == 0)
80 setsockopt (ns->fd, IPPROTO_TCP, TCP_CORK, &val, sizeof (val)); 92 {
81#endif 93 LOG (llevError, "socket write failed, connection closed.\n");
82} 94 destroy ();
95 return;
96 }
97 else if (errno == EINTR)
98 {
99 // just retry
100 }
101 else if (errno == EAGAIN)
102 {
103 // delay till ready
104 socket_ev.poll (socket_ev.poll () | EV_WRITE);
105 socket_ev.start ();
106 return;
107 }
108 else
109 {
110 LOG (llevError, "socket write failed: %s\n", strerror (errno));
111 destroy ();
112 return;
113 }
114 }
83 115
116 socket_ev.poll (socket_ev.poll () & ~EV_WRITE);
117}
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
84/*********************************************************************** 153/*****************************************************************************
85 * 154 * Start of command dispatch area.
86 * SockList functions/utilities 155 * The commands here are protocol commands.
87 *
88 **********************************************************************/ 156 ****************************************************************************/
89 157
90void 158// SocketCommand, PlayingCommand, should not exist with those ugly casts
91SockList_Init (SockList * sl) 159#define SC(cb) (void *)static_cast<void (*)(char *, int, client *)>(cb),
92{ 160#define PC(cb) (void *)static_cast<void (*)(char *, int, player *)>(cb), PF_PLAYER |
93 sl->len = 0;
94 sl->buf = NULL;
95}
96 161
97void 162static void
98SockList_AddInt (SockList * sl, uint32 data) 163NopCmd (char *, int, client *)
99{ 164{
100 sl->buf[sl->len++] = (data >> 24) & 0xff; 165 // do nothing
101 sl->buf[sl->len++] = (data >> 16) & 0xff;
102 sl->buf[sl->len++] = (data >> 8) & 0xff;
103 sl->buf[sl->len++] = data & 0xff;
104} 166}
105 167
106void 168/**
107SockList_AddInt64 (SockList * sl, uint64 data) 169 * Dispatch table for the server.
108{
109 sl->buf[sl->len++] = (char) ((data >> 56) & 0xff);
110 sl->buf[sl->len++] = (char) ((data >> 48) & 0xff);
111 sl->buf[sl->len++] = (char) ((data >> 40) & 0xff);
112 sl->buf[sl->len++] = (char) ((data >> 32) & 0xff);
113
114 sl->buf[sl->len++] = (char) ((data >> 24) & 0xff);
115 sl->buf[sl->len++] = (char) ((data >> 16) & 0xff);
116 sl->buf[sl->len++] = (char) ((data >> 8) & 0xff);
117 sl->buf[sl->len++] = (char) (data & 0xff);
118}
119
120/* Basically does the reverse of SockList_AddInt, but on
121 * strings instead. Same for the GetShort, but for 16 bits.
122 */ 170 */
123int 171static struct packet_type packets[] = {
124GetInt_String (unsigned char *data) 172 {"ncom", PC(NewPlayerCmd) PF_PLAYING | PF_COMMAND6 },
125{ 173 {"command", PC(PlayerCmd) PF_PLAYING | PF_COMMAND0 },
126 return ((data[0] << 24) + (data[1] << 16) + (data[2] << 8) + data[3]);
127}
128 174
129short 175 {"examine", PC(ExamineCmd) PF_PLAYING },
130GetShort_String (unsigned char *data) 176 {"ex", PC(ExCmd) PF_PLAYING },
131{ 177 {"apply", PC(ApplyCmd) PF_PLAYING },
132 return ((data[0] << 8) + data[1]); 178 {"lookat", PC(LookAt) PF_PLAYING },
133} 179 {"lock", PC(LockItem) PF_PLAYING },
180 {"mark", PC(MarkItem) PF_PLAYING },
181 {"move", PC(MoveCmd) PF_PLAYING },
182 {"ext", PC(ExtCmd) 0 }, // CF+/Deliantra
183 {"mapredraw", PC(MapRedrawCmd) 0 },
184 {"mapinfo", PC(MapInfoCmd) 0 }, // CF+/Deliantra
134 185
135/****************************************************************************** 186 {"reply", SC(ReplyCmd) 0 },
136 * 187 {"exti", SC(ExtiCmd) 0 }, // CF+/Deliantra
137 * Start of read routines. 188 {"addme", SC(AddMeCmd) 0 },
138 * 189 {"askface", SC(AskFaceCmd) 0 },
139 ******************************************************************************/ 190 {"requestinfo", SC(RequestInfo) 0 },
191 {"setsound", SC(SetSound) 0 },
192 {"setup", SC(SetUp) 0 },
193 {"version", SC(VersionCmd) 0 },
140 194
141/** 195 {"toggleextendedtext", SC(NopCmd) 0 }, // deliantra: disabled
142 * This reads from fd and puts the data in sl. We return true if we think 196};
143 * we have a full packet, 0 if we have a partial packet. The only processing
144 * we do is remove the intial size value. len (As passed) is the size of the
145 * buffer allocated in the socklist. We make the assumption the buffer is
146 * at least 2 bytes long.
147 */
148 197
149int 198bool
150SockList_ReadPacket (int fd, SockList * sl, int len) 199client::may_execute (const packet_type *pkt) const
151{ 200{
152 int stat, toread; 201 return (!(pkt->flags & PF_PLAYER) || pl)
202 && (!(pkt->flags & PF_PLAYING) || state == ST_PLAYING);
203}
153 204
154 /* Sanity check - shouldn't happen */ 205// HACK: some commands currently should be executed
155 if (sl->len < 0) 206// even when the player is frozen. this hack detects
156 { 207// those commands. it should be folded into may_execute,
157 abort (); 208// but kept seperate to emphasise the hack aspect, i.e.
209// do it better, then remove.
210static bool
211always_immediate (const client *ns, const packet_type *pkt, const char *data, int len)
212{
213 if (!(pkt->flags & (PF_COMMAND0 | PF_COMMAND6)))
214 return false;
215
216 if (!ns->pl || !ns->pl->ob || !ns->pl->ob->map)
217 return false;
218
219 if (pkt->flags & PF_COMMAND6)
158 } 220 {
159 /* We already have a partial packet */ 221 data += 6;
160 if (sl->len < 2) 222 len -= 6;
161 { 223 }
162#ifdef WIN32 /* ***WIN32 SockList_ReadPacket: change read() to recv() */
163 224
164 stat = recv (fd, sl->buf + sl->len, 2 - sl->len, 0); 225 if (len > 4 && data [ 3] == ' ' && !strncmp (data, "say " , 4)) return true;
226 if (len > 5 && data [ 4] == ' ' && !strncmp (data, "chat " , 5)) return true;
227 if (len > 6 && data [ 5] == ' ' && !strncmp (data, "shout " , 6)) return true;
228 if (len > 8 && data [ 7] == ' ' && !strncmp (data, "suicide " , 8)) return true;
229 if (len > 18 && data [17] == ' ' && !strncmp (data, "accept-invitation ", 18)) return true;
165 230
166#else 231 if (len == 7 && !strcmp (data, "suicide")) return true;
167 do 232
168 { 233 return false;
169 stat = read (fd, sl->buf + sl->len, 2 - sl->len); 234}
235
236void
237client::execute (const packet_type *pkt, char *data, int datalen)
238{
239 if (may_execute (pkt) || always_immediate (this, pkt, data, datalen))
240 {
241 //TODO: only one format
242 if (pkt->flags & PF_PLAYER)
170 } 243 {
171 while ((stat == -1) && (errno == EINTR)); 244 ((void (*)(char *, int, player *))pkt->cb)((char *)data, datalen, pl);
172#endif 245 pl->need_updated_stats ();
173 if (stat < 0)
174 { 246 }
175 /* In non blocking mode, EAGAIN is set when there is no 247 else
176 * data available. 248 ((void (*)(char *, int, client *))pkt->cb)((char *)data, datalen, this);
177 */ 249 }
178#ifdef WIN32 /* ***WIN32 SockList_ReadPacket: error handling for win32 */ 250 else
179 if ((stat == -1) && WSAGetLastError () != WSAEWOULDBLOCK) 251 send_packet_printf ("drawinfo %d ERROR: you cannot execute '%s' now.", NDI_RED | NDI_REPLY, pkt->name);
252}
253
254bool
255client::handle_packet ()
256{
257 int pkt_len = next_packet ();
258
259 if (!pkt_len)
260 return false;
261 else if (pkt_len < 0)
262 {
263 LOG (llevError, "read error on player %s\n",
264 pl && pl->ob ? &pl->ob->name : "[anonymous]");
265 destroy ();
266 return false;
267 }
268
269 uint8_t save_byte = inbuf [pkt_len]; // rather ugly
270 inbuf [pkt_len] = 0; /* temporarily terminate buffer - useful for string data */
271
272 /* First, break out beginning word. There are at least
273 * a few commands that do not have any paremeters. If
274 * we get such a command, don't worry about trying
275 * to break it up.
276 */
277 int datalen;
278 char *data = strchr ((char *)inbuf + 2, ' ');
279
280 if (data)
281 {
282 *data++ = 0;
283 datalen = pkt_len - (data - (char *)inbuf);
284 }
285 else
286 {
287 data = (char *)inbuf + 2; // better read garbage than segfault
288 datalen = 0;
289 }
290
291 for (packet_type *pkt = packets; pkt < packets + array_length (packets); ++pkt)
292 if (!strcmp ((char *)inbuf + 2, pkt->name))
293 {
294 if (pkt->flags & PF_PLAYER && !always_immediate (this, pkt, data, datalen))
295 queue_command (pkt, data, datalen);
296 else
297 execute (pkt, data, datalen);
298
299 goto next_packet;
300 }
301
302 // If we get here, we didn't find a valid command.
303 send_packet_printf ("drawinfo %d ERROR: command '%s' not supported.", NDI_RED | NDI_REPLY, (char *)inbuf + 2);
304
305next_packet:
306 inbuf [pkt_len] = save_byte; // rather ugly
307 skip_packet (pkt_len);
308
309 // input buffer has space again
310 socket_ev.poll (socket_ev.poll () | EV_READ);
311
312 return true;
313}
314
315void
316client::inbuf_handle ()
317{
318 if (!handle_packet ())
319 return;
320
321 while (handle_packet ())
322 ;
323
324 flush ();
325}
326
327// callback called when socket is either readable or writable
328void
329client::socket_cb (iow &w, int revents)
330{
331 //TODO remove when we have better socket cleanup logic
332 if (destroyed ())
333 {
334 socket_ev.poll (0);
335 return;
336 }
337
338 if (revents & EV_WRITE)
339 {
340 write_outputbuffer ();
341
342 if (!outputbuffer.len)
343 socket_ev.poll (socket_ev.poll () & ~EV_WRITE);
344 }
345
346 if (revents & EV_READ)
347 {
348 //TODO: rate-limit tcp connection in better ways, important
349
350 int amount = sizeof (inbuf) - inbuf_len;
351
352 if (!amount)
353 {
354 // input buffer full
355 LOG (llevError, "input buffer overflow.");
356 destroy ();
357 return;
358 }
359
360 if (ws_version)
361 {
362 if (ws_inbuf_len + 2048 > ws_inbuf_alloc)
363 ws_inbuf = (uint8 *)realloc (ws_inbuf, ws_inbuf_alloc += 4096);
364
365 int len = read (fd, ws_inbuf + ws_inbuf_len, ws_inbuf_alloc - ws_inbuf_len);
366
367 if (len > 0)
180 { 368 {
181 if (WSAGetLastError () == WSAECONNRESET) 369 ws_inbuf_len += len;
182 LOG (llevDebug, "Connection closed by client\n"); 370
183 else 371 if (ws_inbuf_len < 2 + 4) // 6 is minimum length: op, len, mask
372 return;
373
374 int d = 2;
375 int o = ws_inbuf [0] & 15;
376 int l = ws_inbuf [1] & 127;
377
378 if (l == 126)
184 { 379 {
185 LOG (llevDebug, "ReadPacket got error %d, returning 0\n", WSAGetLastError ()); 380 l = (ws_inbuf [2] << 8) | ws_inbuf [3];
381 d += 2;
186 } 382 }
187 return -1; /* kick this user! */ 383 else if (l == 127)
384 {
385 if (ws_inbuf_len < 2 + 8)
386 return;
387
388 // we don't do extra long frames, if a browser wants to send >2**32 bytes,
389 // there are bigger issues to fix.
390 l = (ws_inbuf [6] << 24)
391 | (ws_inbuf [7] << 16)
392 | (ws_inbuf [8] << 8)
393 | ws_inbuf [9];
394 d += 8;
395 }
396
397 // we only continue if we have a complete frame
398 if (ws_inbuf_len < d + 4 + l)
399 return;
400
401 switch (o)
402 {
403 case 0: o = ws_inbuf_type; break; // continuation
404 case 1: ws_inbuf_type = 1; break; // utf-8
405 case 2: ws_inbuf_type = 2; break; // binary
406 }
407
408 if (l > amount)
409 {
410 // input buffer full
411 LOG (llevError, "input buffer overflow (ws).");
412 destroy ();
413 return;
414 }
415
416 for (int i = 0; i < l; ++i)
417 inbuf [inbuf_len + i] = ws_inbuf [d + 4 + i] ^ ws_inbuf [d + (i & 3)];
418
419 // remove frame
420 ws_inbuf_len -= d + 4 + l;
421 memmove (ws_inbuf, ws_inbuf + d + 4 + l, ws_inbuf_len);
422
423 switch (o)
424 {
425 case 1: // utf-8
426 {
427 uint8 *a = inbuf + inbuf_len;
428 uint8 *b = a;
429 uint8 *c = a + l;
430
431 for (; a < c; ++a, ++b)
432 {
433 *b = *a;
434
435 if (*a >= 0x80)
436 *b = (a [0] & 0x1f) << 6 | (a [1] & 0x3f), ++a;
437 }
438
439 l -= a - b;
440 }
441 break;
442 case 2: // binary
443 break;
444
445 case 9: // ping
446 {
447 // send pong - we assume ping messages are <64k
448 // as we can't handle >10k at the moment anyway.
449 uint8 hdr [] = { 0x8a, 126, l >> 8, l };
450 send (hdr, sizeof (hdr));
451 send (inbuf + inbuf_len, l);
452 }
453 return;
454
455 case 10: // pong
456 return;
457
458 case 8: // close
459 default:
460 destroy ();
461 return;
462 }
463
464 amount = l;
188 } 465 }
189#else 466 else
467 amount = -1;
468 }
469 else
470 amount = read (fd, inbuf + inbuf_len, amount);
471
472 if (!amount)
473 {
474 destroy ();
475 return;
476 }
477 else if (amount < 0)
478 {
190 if (errno != EAGAIN && errno != EWOULDBLOCK) 479 if (errno != EAGAIN && errno != EINTR)
191 { 480 {
192 LOG (llevDebug, "ReadPacket got error %s, returning 0\n", strerror (errno)); 481 LOG (llevError, "read error: %s\n", strerror (errno));
482 destroy ();
483 return;
193 } 484 }
194#endif
195 return 0; /*Error */
196 }
197 if (stat == 0)
198 return -1;
199 sl->len += stat;
200#ifdef CS_LOGSTATS
201 cst_tot.ibytes += stat;
202 cst_lst.ibytes += stat;
203#endif
204 if (stat < 2)
205 return 0; /* Still don't have a full packet */
206 }
207 /* Figure out how much more data we need to read. Add 2 from the
208 * end of this - size header information is not included.
209 */
210 toread = 2 + (sl->buf[0] << 8) + sl->buf[1] - sl->len;
211 if ((toread + sl->len) >= len)
212 {
213 LOG (llevError, "SockList_ReadPacket: Want to read more bytes than will fit in buffer (%d>=%d).\n", toread + sl->len, len);
214 /* Quick hack in case for 'oldsocketmode' input. If we are
215 * closing the socket anyways, then reading this extra 100 bytes
216 * shouldn't hurt.
217 */
218#ifdef WIN32 /* ***win32 SockList_ReadPacket: change read() to recv() */
219 recv (fd, sl->buf + 2, 100, 0);
220#else
221 read (fd, sl->buf + 2, 100);
222#endif /* end win32 */
223 485
224 /* return error so the socket is closed */ 486 // should not be here, normally
225 return -1;
226 }
227 do
228 {
229#ifdef WIN32 /* ***win32 SockList_ReadPacket: change read() to recv() */
230 stat = recv (fd, sl->buf + sl->len, toread, 0);
231#else
232 do
233 { 487 }
234 stat = read (fd, sl->buf + sl->len, toread); 488 else
235 } 489 {
236 while ((stat < 0) && (errno == EINTR)); 490 inbuf_len += amount;
237#endif 491 inbuf_handle ();
238 if (stat < 0)
239 { 492 }
240
241#ifdef WIN32 /* ***win32 SockList_ReadPacket: change error handling for win32 */
242 if ((stat == -1) && WSAGetLastError () != WSAEWOULDBLOCK)
243 {
244 if (WSAGetLastError () == WSAECONNRESET)
245 LOG (llevDebug, "Connection closed by client\n");
246 else
247 {
248 LOG (llevDebug, "ReadPacket got error %d, returning 0\n", WSAGetLastError ());
249 }
250 return -1; /* kick this user! */
251 }
252#else
253 if (errno != EAGAIN && errno != EWOULDBLOCK)
254 {
255 LOG (llevDebug, "ReadPacket got error %s, returning 0\n", strerror (errno));
256 }
257#endif
258 return 0; /*Error */
259 }
260 if (stat == 0)
261 return -1;
262 sl->len += stat;
263#ifdef CS_LOGSTATS
264 cst_tot.ibytes += stat;
265 cst_lst.ibytes += stat;
266#endif
267 toread -= stat;
268 if (toread == 0)
269 return 1;
270 if (toread < 0)
271 {
272 LOG (llevError, "SockList_ReadPacket: Read more bytes than desired.\n");
273 return 1;
274 }
275 } 493 }
276 while (toread > 0);
277 return 0;
278} 494}
279 495
280/******************************************************************************* 496/*******************************************************************************
281 * 497 *
282 * Start of write related routines. 498 * Start of write related routines.
287 * Adds data to a socket buffer for whatever reason. 503 * Adds data to a socket buffer for whatever reason.
288 * 504 *
289 * ns is the socket we are adding the data to, buf is the start of the 505 * ns is the socket we are adding the data to, buf is the start of the
290 * data, and len is the number of bytes to add. 506 * data, and len is the number of bytes to add.
291 */ 507 */
292 508void
293static void 509client::send (void *buf_, int len)
294add_to_buffer (NewSocket * ns, char *buf, int len)
295{ 510{
511 char *buf = (char *)buf_;
512
513 if (destroyed () || !buf)
514 return;
515
516 if (len + outputbuffer.len > SOCKETBUFSIZE)
517 {
518 LOG (llevDebug, "socket on fd %d has overrun internal buffer - marking as dead\n", fd);
519 // shutdown the socket, this is safer than destroying it immediately
520 // as lots of code in the callchain might still access the map etc.
521 shutdown (fd, SHUT_RDWR);
522 return;
523 }
524
296 int avail, end; 525 int avail, end;
297
298 if ((len + ns->outputbuffer.len) > SOCKETBUFSIZE)
299 {
300 LOG (llevDebug, "Socket on fd %d has overrun internal buffer - marking as dead\n", ns->fd);
301 ns->status = Ns_Dead;
302 return;
303 }
304 526
305 /* data + end is where we start putting the new data. The last byte 527 /* data + end is where we start putting the new data. The last byte
306 * currently in use is actually data + end -1 528 * currently in use is actually data + end -1
307 */ 529 */
308
309 end = ns->outputbuffer.start + ns->outputbuffer.len; 530 end = outputbuffer.start + outputbuffer.len;
310 /* The buffer is already in a wrapped state, so adjust end */ 531 /* The buffer is already in a wrapped state, so adjust end */
311 if (end >= SOCKETBUFSIZE) 532 if (end >= SOCKETBUFSIZE)
312 end -= SOCKETBUFSIZE; 533 end -= SOCKETBUFSIZE;
313 534
314 avail = SOCKETBUFSIZE - end; 535 avail = SOCKETBUFSIZE - end;
315 536
316 /* We can all fit it behind the current data without wrapping */ 537 /* We can all fit it behind the current data without wrapping */
317 if (avail >= len) 538 if (avail >= len)
318 memcpy (ns->outputbuffer.data + end, buf, len); 539 memcpy (outputbuffer.data + end, buf, len);
319 else 540 else
320 { 541 {
321 memcpy (ns->outputbuffer.data + end, buf, avail); 542 memcpy (outputbuffer.data + end, buf, avail);
322 memcpy (ns->outputbuffer.data, buf + avail, len - avail); 543 memcpy (outputbuffer.data, buf + avail, len - avail);
323 } 544 }
324 545
325 ns->outputbuffer.len += len; 546 outputbuffer.len += len;
326#if 0
327 LOG (llevDebug, "Added %d to output buffer, total length now %d, start=%d\n", len, ns->outputbuffer.len, ns->outputbuffer.start);
328#endif
329} 547}
330
331/**
332 * Writes data to socket.
333 *
334 * When the socket is clear to write, and we have backlogged data, this
335 * is called to write it out.
336 */
337void
338write_socket_buffer (NewSocket * ns)
339{
340 int amt, max;
341
342 if (ns->outputbuffer.len == 0)
343 {
344 LOG (llevDebug, "write_socket_buffer called when there is no data, fd=%d\n", ns->fd);
345 return;
346 }
347
348 do
349 {
350 max = SOCKETBUFSIZE - ns->outputbuffer.start;
351 if (ns->outputbuffer.len < max)
352 max = ns->outputbuffer.len;
353
354#ifdef WIN32 /* ***win32 write_socket_buffer: change write() to send() */
355 amt = send (ns->fd, ns->outputbuffer.data + ns->outputbuffer.start, max, 0);
356#else
357 do
358 {
359 amt = write (ns->fd, ns->outputbuffer.data + ns->outputbuffer.start, max);
360 }
361 while ((amt < 0) && (errno == EINTR));
362#endif
363
364 if (amt < 0)
365 { /* We got an error */
366
367#ifdef WIN32 /* ***win32 write_socket_buffer: change error handling */
368 if (amt == -1 && WSAGetLastError () != WSAEWOULDBLOCK)
369 {
370 LOG (llevError, "New socket write failed (wsb) (%d).\n", WSAGetLastError ());
371#else
372 if (errno != EWOULDBLOCK)
373 {
374 LOG (llevError, "New socket write failed (wsb) (%d: %s).\n", errno, strerror (errno));
375#endif
376 ns->status = Ns_Dead;
377 return;
378 }
379 else
380 { /* EWOULDBLOCK */
381 /* can't write it, so store it away. */
382 ns->can_write = 0;
383 return;
384 }
385 }
386 ns->outputbuffer.start += amt;
387 /* wrap back to start of buffer */
388 if (ns->outputbuffer.start == SOCKETBUFSIZE)
389 ns->outputbuffer.start = 0;
390 ns->outputbuffer.len -= amt;
391#ifdef CS_LOGSTATS
392 cst_tot.obytes += amt;
393 cst_lst.obytes += amt;
394#endif
395 }
396 while (ns->outputbuffer.len > 0);
397}
398
399/**
400 * This writes data to the socket. - It is very low level -
401 * all we try and do is write out the data to the socket
402 * provided (ns). buf is the data to write, len is the number
403 * of bytes to write. IT doesn't return anything - rather, it
404 * updates the ns structure if we get an error.
405 */
406void
407Write_To_Socket (NewSocket * ns, char *buf, int len)
408{
409 int amt = 0;
410 char *pos = buf;
411
412 if (ns->status == Ns_Dead || !buf)
413 {
414 LOG (llevDebug, "Write_To_Socket called with dead socket\n");
415 return;
416 }
417
418#ifndef __GNU__ /* This caused problems on Hurd */
419 if (!ns->can_write)
420 {
421 add_to_buffer (ns, buf, len);
422 return;
423 }
424#endif
425 /* If we manage to write more than we wanted, take it as a bonus */
426 while (len > 0)
427 {
428
429#ifdef WIN32 /* ***win32 Write_To_Socket: change write() to send() */
430 amt = send (ns->fd, pos, len, 0);
431#else
432 do
433 {
434 amt = write (ns->fd, pos, len);
435 }
436 while ((amt < 0) && (errno == EINTR));
437#endif
438
439 if (amt < 0)
440 { /* We got an error */
441#ifdef WIN32 /* ***win32 Write_To_Socket: change error handling */
442 if (amt == -1 && WSAGetLastError () != WSAEWOULDBLOCK)
443 {
444 LOG (llevError, "New socket write failed WTS (%d).\n", WSAGetLastError ());
445#else
446 if (errno != EWOULDBLOCK)
447 {
448 LOG (llevError, "New socket write failed WTS (%d: %s).\n", /* ---WIN32 */
449 errno, strerror (errno));
450#endif
451 ns->status = Ns_Dead;
452 return;
453 }
454 else
455 { /* EWOULDBLOCK */
456 /* can't write it, so store it away. */
457 add_to_buffer (ns, pos, len);
458 ns->can_write = 0;
459 return;
460 }
461 }
462 /* amt gets set to 0 above in blocking code, so we do this as
463 * an else if to make sure we don't reprocess it.
464 */
465 else if (amt == 0)
466 {
467 LOG (llevError, "Write_To_Socket: No data written out.\n");
468 }
469 len -= amt;
470 pos += amt;
471#ifdef CS_LOGSTATS
472 cst_tot.obytes += amt;
473 cst_lst.obytes += amt;
474#endif
475 }
476}
477
478 548
479/** 549/**
480 * Takes a string of data, and writes it out to the socket. A very handy 550 * Takes a string of data, and writes it out to the socket. A very handy
481 * shortcut function. 551 * shortcut function.
482 */ 552 */
483void 553void
484cs_write_string (NewSocket * ns, const char *buf, int len) 554client::send_packet (packet &sl)
485{ 555{
486 SockList sl; 556 if (destroyed ())
487
488 sl.len = len;
489 sl.buf = (unsigned char *) buf;
490 Send_With_Handling (ns, &sl);
491}
492
493
494/**
495 * Calls Write_To_Socket to send data to the client.
496 *
497 * The only difference in this function is that we take a SockList
498 *, and we prepend the length information.
499 */
500void
501Send_With_Handling (NewSocket * ns, SockList * msg)
502{
503 unsigned char sbuf[4];
504
505 if (ns->status == Ns_Dead || !msg)
506 return; 557 return;
507 558
508 if (msg->len >= MAXSOCKBUF) 559 if (sl.length () > MAXSOCKBUF)
509 { 560 {
510 LOG (llevError, "Trying to send a buffer beyond properly size, len =%d\n", msg->len); 561 LOG (llevError, "Trying to send a buffer beyond properly size, len =%d\n", sl.length ());
511 /* Almost certainly we've overflowed a buffer, so quite now to make 562 /* Almost certainly we've overflowed a buffer, so quit now to make
512 * it easier to debug. 563 * it easier to debug.
513 */ 564 */
514 abort (); 565 abort ();
515 } 566 }
516 sbuf[0] = ((uint32) (msg->len) >> 8) & 0xFF;
517 sbuf[1] = ((uint32) (msg->len)) & 0xFF;
518 if (ns->status != Ns_Old)
519 Write_To_Socket (ns, (char *) sbuf, 2);
520 Write_To_Socket (ns, (char *) msg->buf, msg->len);
521}
522 567
523/** 568 if (!sl.length ())
524 * Takes a string of data, and writes it out to the socket. A very handy
525 * shortcut function.
526 */
527void
528Write_String_To_Socket (NewSocket * ns, char *buf, int len)
529{
530 SockList sl;
531
532 sl.len = len;
533 sl.buf = (unsigned char *) buf;
534 Send_With_Handling (ns, &sl);
535}
536
537
538/******************************************************************************
539 *
540 * statistics logging functions.
541 *
542 ******************************************************************************/
543
544#ifdef CS_LOGSTATS
545
546/* cst_tot is for the life of the server, cst_last is for the last series of
547 * stats
548 */
549CS_Stats cst_tot, cst_lst;
550
551/**
552 * Writes out the gathered stats. We clear cst_lst.
553 */
554void
555write_cs_stats (void)
556{
557 time_t now = time (NULL);
558
559 /* If no connections recently, don't both to log anything */
560 if (cst_lst.ibytes == 0 && cst_lst.obytes == 0)
561 return; 569 return;
562 570
563 /* CSSTAT is put in so scripts can easily find the line */ 571 if (ws_version == 8)
564 LOG (llevInfo, "CSSTAT: %.16s tot %d %d %d %d inc %d %d %d %d\n", 572 {
565 ctime (&now), cst_tot.ibytes, cst_tot.obytes, cst_tot.max_conn, 573 static uint8 buf [MAXSOCKBUF * 2 + 4];
566 now - cst_tot.time_start, cst_lst.ibytes, cst_lst.obytes, cst_lst.max_conn, now - cst_lst.time_start); 574
567 cst_lst.ibytes = 0; 575 uint8 *b = buf + 4;
568 cst_lst.obytes = 0; 576 for (uint8 *a = sl.buf_ + sl.hdrlen; a < sl.cur; ++a)
569 cst_lst.max_conn = socket_info.nconns; 577 {
570 cst_lst.time_start = now; 578 if (*a < 0x80)
579 *b++ = *a;
580 else
581 {
582 *b++ = 0xc0 | ((*a >> 6) & 0x1f);
583 *b++ = 0x80 | ( *a & 0x3f);
584 }
585 }
586
587 assert (b - buf < sizeof (buf));
588
589 int l = b - (buf + 4);
590
591 if (l < 126)
592 {
593 buf [2] = 0x81;
594 buf [3] = l;
595
596 send (buf + 2, l + 2);
597 }
598 else
599 {
600 buf [0] = 0x81;
601 buf [1] = 126;
602 buf [2] = l >> 8;
603 buf [3] = l;
604
605 send (buf, l + 4);
606 }
607 }
608 else if (ws_version == 13)
609 {
610 int l = sl.length ();
611
612 if (l < 126)
613 {
614 uint8 hdr [] = { 0x82, 126, l >> 8, l };
615 send (hdr, sizeof (hdr));
616 }
617 else
618 {
619 uint8 hdr [] = { 0x82, l };
620 send (hdr, sizeof (hdr));
621 }
622
623 send (sl.buf_ + sl.hdrlen, l);
624 }
625 else
626 {
627 assert (sl.hdrlen == 2);
628
629 sl.buf_ [0] = sl.length () >> 8;
630 sl.buf_ [1] = sl.length () ;
631
632 send (sl.buf_, sl.length () + sl.hdrlen);
633 }
571} 634}
572#endif 635
636void
637client::send_packet (const char *buf, int len)
638{
639 packet sl;
640
641 sl << data (buf, len);
642 send_packet (sl);
643}
644
645void
646client::send_packet (const char *buf)
647{
648 send_packet (buf, strlen (buf));
649}
650
651void
652client::send_packet_printf (const char *format, ...)
653{
654 packet sl;
655
656 va_list ap;
657 va_start (ap, format);
658 sl.vprintf (format, ap);
659 va_end (ap);
660
661 send_packet (sl);
662}
663
664void
665client::send_msg (int color, const char *type, const char *msg)
666{
667 if (!msg || !type) // it can happen (for example, missing attack messages cause this)
668 {
669 LOG (logBacktrace | llevError, "send_msg(%d,%p,%p) called with NULL msg or type.\n", color, type, msg);
670 return;
671 }
672
673 int len = strlen (msg);
674
675 if (!(color & NDI_VERBATIM)
676 && (msg_is_special (msg)
677 || (type [0] == 'c' && type [1] == '/') || len > (MAXSOCKBUF - 128)))
678 cfperl_send_msg (this, color, type, msg);
679 else
680 send_packet_printf ("msg %d %s %s", color & NDI_CLIENT_MASK, type, msg);
681}
682
683void
684client::send_drawinfo (const char *msg, int flags)
685{
686 send_msg (flags, "log", msg);
687}
688
689/***********************************************************************
690 *
691 * packet functions/utilities
692 *
693 **********************************************************************/
694
695packet::packet (const char *name)
696{
697 reset ();
698
699 int len = strlen (name);
700 memcpy (cur, name, len); cur += len;
701 *cur++ = ' ';
702}
703
704packet &packet::operator <<(const ber32 v)
705{
706 enum { maxlen = 32 / 7 + 1 };
707 uint8 buf[maxlen];
708 uint8 *p = buf + maxlen;
709 uint32 val = v.val;
710
711 *--p = val & 0x7F;
712
713 while (val > 0x7F)
714 {
715 val >>= 7;
716 *--p = (val & 0x7F) | 0x80;
717 }
718
719 return *this << data (p, buf + maxlen - p);
720}
721
722packet &packet::operator <<(const data &v)
723{
724 if (room () < v.len)
725 reset ();
726 else
727 {
728 if (v.len)
729 {
730 memcpy (cur, v.ptr, v.len);
731 cur += v.len;
732 }
733 }
734
735 return *this;
736}
737
738packet &packet::operator <<(const data8 &v)
739{
740 unsigned int len = min (v.len, 0x00FF);
741 return *this << uint8 (len) << data (v.ptr, len);
742}
743
744packet &packet::operator <<(const data16 &v)
745{
746 unsigned int len = min (v.len, 0xFFFF);
747 return *this << uint16 (len) << data (v.ptr, len);
748}
749
750packet &packet::operator <<(const char *v)
751{
752 return *this << data (v, strlen (v ? v : 0));
753}
754
755void
756packet::vprintf (const char *format, va_list ap)
757{
758 int size = room ();
759
760 int len = vsnprintf ((char *)cur, size, format, ap);
761
762 if (len >= size)
763 return reset ();
764
765 cur += len;
766}
767

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines