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 <newclient.h> |
39 |
#include <sproto.h> |
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 |
Socket_Flush (NewSocket * ns) |
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 (ns->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 |
if (tcpi.tcpi_unacked && SOCKET_TIMEOUT1 * TCP_HZ < diff && diff < 0x80000000UL // ack delayed for 20s |
67 |
&& SOCKET_TIMEOUT2 * TCP_HZ < tcpi.tcpi_last_data_sent) // no data sent for 10s |
68 |
{ |
69 |
LOG (llevDebug, "Connection on fd %d closed due to ack timeout (%u/%u/%u)\n", ns->fd, |
70 |
(unsigned) tcpi.tcpi_last_ack_recv, (unsigned) tcpi.tcpi_last_data_sent, (unsigned) tcpi.tcpi_unacked); |
71 |
ns->status = Ns_Dead; |
72 |
} |
73 |
} |
74 |
|
75 |
int val; |
76 |
|
77 |
val = 0; |
78 |
setsockopt (ns->fd, IPPROTO_TCP, TCP_CORK, &val, sizeof (val)); |
79 |
val = 1; |
80 |
setsockopt (ns->fd, IPPROTO_TCP, TCP_CORK, &val, sizeof (val)); |
81 |
#endif |
82 |
} |
83 |
|
84 |
/*********************************************************************** |
85 |
* |
86 |
* SockList functions/utilities |
87 |
* |
88 |
**********************************************************************/ |
89 |
|
90 |
void |
91 |
SockList_Init (SockList * sl) |
92 |
{ |
93 |
sl->len = 0; |
94 |
sl->buf = NULL; |
95 |
} |
96 |
|
97 |
void |
98 |
SockList_AddInt (SockList * sl, uint32 data) |
99 |
{ |
100 |
sl->buf[sl->len++] = (data >> 24) & 0xff; |
101 |
sl->buf[sl->len++] = (data >> 16) & 0xff; |
102 |
sl->buf[sl->len++] = (data >> 8) & 0xff; |
103 |
sl->buf[sl->len++] = data & 0xff; |
104 |
} |
105 |
|
106 |
void |
107 |
SockList_AddInt64 (SockList * sl, uint64 data) |
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 |
*/ |
123 |
int |
124 |
GetInt_String (unsigned char *data) |
125 |
{ |
126 |
return ((data[0] << 24) + (data[1] << 16) + (data[2] << 8) + data[3]); |
127 |
} |
128 |
|
129 |
short |
130 |
GetShort_String (unsigned char *data) |
131 |
{ |
132 |
return ((data[0] << 8) + data[1]); |
133 |
} |
134 |
|
135 |
/****************************************************************************** |
136 |
* |
137 |
* Start of read routines. |
138 |
* |
139 |
******************************************************************************/ |
140 |
|
141 |
/** |
142 |
* This reads from fd and puts the data in sl. We return true if we think |
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 |
|
149 |
int |
150 |
SockList_ReadPacket (int fd, SockList * sl, int len) |
151 |
{ |
152 |
int stat, toread; |
153 |
|
154 |
/* Sanity check - shouldn't happen */ |
155 |
if (sl->len < 0) |
156 |
{ |
157 |
abort (); |
158 |
} |
159 |
/* We already have a partial packet */ |
160 |
if (sl->len < 2) |
161 |
{ |
162 |
do |
163 |
{ |
164 |
stat = read (fd, sl->buf + sl->len, 2 - sl->len); |
165 |
} |
166 |
while ((stat == -1) && (errno == EINTR)); |
167 |
|
168 |
if (stat < 0) |
169 |
{ |
170 |
/* In non blocking mode, EAGAIN is set when there is no |
171 |
* data available. |
172 |
*/ |
173 |
if (errno != EAGAIN && errno != EWOULDBLOCK) |
174 |
{ |
175 |
LOG (llevDebug, "ReadPacket got error %s, returning 0\n", strerror (errno)); |
176 |
} |
177 |
return 0; /*Error */ |
178 |
} |
179 |
if (stat == 0) |
180 |
return -1; |
181 |
sl->len += stat; |
182 |
#ifdef CS_LOGSTATS |
183 |
cst_tot.ibytes += stat; |
184 |
cst_lst.ibytes += stat; |
185 |
#endif |
186 |
if (stat < 2) |
187 |
return 0; /* Still don't have a full packet */ |
188 |
} |
189 |
/* Figure out how much more data we need to read. Add 2 from the |
190 |
* end of this - size header information is not included. |
191 |
*/ |
192 |
toread = 2 + (sl->buf[0] << 8) + sl->buf[1] - sl->len; |
193 |
if ((toread + sl->len) >= len) |
194 |
{ |
195 |
LOG (llevError, "SockList_ReadPacket: Want to read more bytes than will fit in buffer (%d>=%d).\n", toread + sl->len, len); |
196 |
/* Quick hack in case for 'oldsocketmode' input. If we are |
197 |
* closing the socket anyways, then reading this extra 100 bytes |
198 |
* shouldn't hurt. |
199 |
*/ |
200 |
read (fd, sl->buf + 2, 100); |
201 |
|
202 |
/* return error so the socket is closed */ |
203 |
return -1; |
204 |
} |
205 |
do |
206 |
{ |
207 |
do |
208 |
{ |
209 |
stat = read (fd, sl->buf + sl->len, toread); |
210 |
} |
211 |
while ((stat < 0) && (errno == EINTR)); |
212 |
if (stat < 0) |
213 |
{ |
214 |
|
215 |
if (errno != EAGAIN && errno != EWOULDBLOCK) |
216 |
{ |
217 |
LOG (llevDebug, "ReadPacket got error %s, returning 0\n", strerror (errno)); |
218 |
} |
219 |
return 0; /*Error */ |
220 |
} |
221 |
if (stat == 0) |
222 |
return -1; |
223 |
sl->len += stat; |
224 |
#ifdef CS_LOGSTATS |
225 |
cst_tot.ibytes += stat; |
226 |
cst_lst.ibytes += stat; |
227 |
#endif |
228 |
toread -= stat; |
229 |
if (toread == 0) |
230 |
return 1; |
231 |
if (toread < 0) |
232 |
{ |
233 |
LOG (llevError, "SockList_ReadPacket: Read more bytes than desired.\n"); |
234 |
return 1; |
235 |
} |
236 |
} |
237 |
while (toread > 0); |
238 |
return 0; |
239 |
} |
240 |
|
241 |
/******************************************************************************* |
242 |
* |
243 |
* Start of write related routines. |
244 |
* |
245 |
******************************************************************************/ |
246 |
|
247 |
/** |
248 |
* Adds data to a socket buffer for whatever reason. |
249 |
* |
250 |
* ns is the socket we are adding the data to, buf is the start of the |
251 |
* data, and len is the number of bytes to add. |
252 |
*/ |
253 |
|
254 |
static void |
255 |
add_to_buffer (NewSocket * ns, char *buf, int len) |
256 |
{ |
257 |
int avail, end; |
258 |
|
259 |
if ((len + ns->outputbuffer.len) > SOCKETBUFSIZE) |
260 |
{ |
261 |
LOG (llevDebug, "Socket on fd %d has overrun internal buffer - marking as dead\n", ns->fd); |
262 |
ns->status = Ns_Dead; |
263 |
return; |
264 |
} |
265 |
|
266 |
/* data + end is where we start putting the new data. The last byte |
267 |
* currently in use is actually data + end -1 |
268 |
*/ |
269 |
|
270 |
end = ns->outputbuffer.start + ns->outputbuffer.len; |
271 |
/* The buffer is already in a wrapped state, so adjust end */ |
272 |
if (end >= SOCKETBUFSIZE) |
273 |
end -= SOCKETBUFSIZE; |
274 |
|
275 |
avail = SOCKETBUFSIZE - end; |
276 |
|
277 |
/* We can all fit it behind the current data without wrapping */ |
278 |
if (avail >= len) |
279 |
memcpy (ns->outputbuffer.data + end, buf, len); |
280 |
else |
281 |
{ |
282 |
memcpy (ns->outputbuffer.data + end, buf, avail); |
283 |
memcpy (ns->outputbuffer.data, buf + avail, len - avail); |
284 |
} |
285 |
|
286 |
ns->outputbuffer.len += len; |
287 |
#if 0 |
288 |
LOG (llevDebug, "Added %d to output buffer, total length now %d, start=%d\n", len, ns->outputbuffer.len, ns->outputbuffer.start); |
289 |
#endif |
290 |
} |
291 |
|
292 |
/** |
293 |
* Writes data to socket. |
294 |
* |
295 |
* When the socket is clear to write, and we have backlogged data, this |
296 |
* is called to write it out. |
297 |
*/ |
298 |
void |
299 |
write_socket_buffer (NewSocket * ns) |
300 |
{ |
301 |
int amt, max; |
302 |
|
303 |
if (ns->outputbuffer.len == 0) |
304 |
{ |
305 |
LOG (llevDebug, "write_socket_buffer called when there is no data, fd=%d\n", ns->fd); |
306 |
return; |
307 |
} |
308 |
|
309 |
do |
310 |
{ |
311 |
max = SOCKETBUFSIZE - ns->outputbuffer.start; |
312 |
if (ns->outputbuffer.len < max) |
313 |
max = ns->outputbuffer.len; |
314 |
|
315 |
do |
316 |
{ |
317 |
amt = write (ns->fd, ns->outputbuffer.data + ns->outputbuffer.start, max); |
318 |
} |
319 |
while ((amt < 0) && (errno == EINTR)); |
320 |
|
321 |
if (amt < 0) |
322 |
{ /* We got an error */ |
323 |
|
324 |
if (errno != EWOULDBLOCK) |
325 |
{ |
326 |
LOG (llevError, "New socket write failed (wsb) (%d: %s).\n", errno, strerror (errno)); |
327 |
ns->status = Ns_Dead; |
328 |
return; |
329 |
} |
330 |
else |
331 |
{ /* EWOULDBLOCK */ |
332 |
/* can't write it, so store it away. */ |
333 |
ns->can_write = 0; |
334 |
return; |
335 |
} |
336 |
} |
337 |
ns->outputbuffer.start += amt; |
338 |
/* wrap back to start of buffer */ |
339 |
if (ns->outputbuffer.start == SOCKETBUFSIZE) |
340 |
ns->outputbuffer.start = 0; |
341 |
ns->outputbuffer.len -= amt; |
342 |
#ifdef CS_LOGSTATS |
343 |
cst_tot.obytes += amt; |
344 |
cst_lst.obytes += amt; |
345 |
#endif |
346 |
} |
347 |
while (ns->outputbuffer.len > 0); |
348 |
} |
349 |
|
350 |
/** |
351 |
* This writes data to the socket. - It is very low level - |
352 |
* all we try and do is write out the data to the socket |
353 |
* provided (ns). buf is the data to write, len is the number |
354 |
* of bytes to write. IT doesn't return anything - rather, it |
355 |
* updates the ns structure if we get an error. |
356 |
*/ |
357 |
void |
358 |
Write_To_Socket (NewSocket * ns, char *buf, int len) |
359 |
{ |
360 |
int amt = 0; |
361 |
char *pos = buf; |
362 |
|
363 |
if (ns->status == Ns_Dead || !buf) |
364 |
{ |
365 |
LOG (llevDebug, "Write_To_Socket called with dead socket\n"); |
366 |
return; |
367 |
} |
368 |
|
369 |
#ifndef __GNU__ /* This caused problems on Hurd */ |
370 |
if (!ns->can_write) |
371 |
{ |
372 |
add_to_buffer (ns, buf, len); |
373 |
return; |
374 |
} |
375 |
#endif |
376 |
/* If we manage to write more than we wanted, take it as a bonus */ |
377 |
while (len > 0) |
378 |
{ |
379 |
|
380 |
do |
381 |
{ |
382 |
amt = write (ns->fd, pos, len); |
383 |
} |
384 |
while ((amt < 0) && (errno == EINTR)); |
385 |
|
386 |
if (amt < 0) |
387 |
{ /* We got an error */ |
388 |
if (errno != EWOULDBLOCK) |
389 |
{ |
390 |
LOG (llevError, "New socket write failed WTS (%d: %s).\n", /* ---WIN32 */ |
391 |
errno, strerror (errno)); |
392 |
ns->status = Ns_Dead; |
393 |
return; |
394 |
} |
395 |
else |
396 |
{ /* EWOULDBLOCK */ |
397 |
/* can't write it, so store it away. */ |
398 |
add_to_buffer (ns, pos, len); |
399 |
ns->can_write = 0; |
400 |
return; |
401 |
} |
402 |
} |
403 |
/* amt gets set to 0 above in blocking code, so we do this as |
404 |
* an else if to make sure we don't reprocess it. |
405 |
*/ |
406 |
else if (amt == 0) |
407 |
{ |
408 |
LOG (llevError, "Write_To_Socket: No data written out.\n"); |
409 |
} |
410 |
len -= amt; |
411 |
pos += amt; |
412 |
#ifdef CS_LOGSTATS |
413 |
cst_tot.obytes += amt; |
414 |
cst_lst.obytes += amt; |
415 |
#endif |
416 |
} |
417 |
} |
418 |
|
419 |
|
420 |
/** |
421 |
* Takes a string of data, and writes it out to the socket. A very handy |
422 |
* shortcut function. |
423 |
*/ |
424 |
void |
425 |
cs_write_string (NewSocket * ns, const char *buf, int len) |
426 |
{ |
427 |
SockList sl; |
428 |
|
429 |
sl.len = len; |
430 |
sl.buf = (unsigned char *) buf; |
431 |
Send_With_Handling (ns, &sl); |
432 |
} |
433 |
|
434 |
|
435 |
/** |
436 |
* Calls Write_To_Socket to send data to the client. |
437 |
* |
438 |
* The only difference in this function is that we take a SockList |
439 |
*, and we prepend the length information. |
440 |
*/ |
441 |
void |
442 |
Send_With_Handling (NewSocket * ns, SockList * msg) |
443 |
{ |
444 |
unsigned char sbuf[4]; |
445 |
|
446 |
if (ns->status == Ns_Dead || !msg) |
447 |
return; |
448 |
|
449 |
if (msg->len >= MAXSOCKBUF) |
450 |
{ |
451 |
LOG (llevError, "Trying to send a buffer beyond properly size, len =%d\n", msg->len); |
452 |
/* Almost certainly we've overflowed a buffer, so quite now to make |
453 |
* it easier to debug. |
454 |
*/ |
455 |
abort (); |
456 |
} |
457 |
sbuf[0] = ((uint32) (msg->len) >> 8) & 0xFF; |
458 |
sbuf[1] = ((uint32) (msg->len)) & 0xFF; |
459 |
if (ns->status != Ns_Old) |
460 |
Write_To_Socket (ns, (char *) sbuf, 2); |
461 |
Write_To_Socket (ns, (char *) msg->buf, msg->len); |
462 |
} |
463 |
|
464 |
/** |
465 |
* Takes a string of data, and writes it out to the socket. A very handy |
466 |
* shortcut function. |
467 |
*/ |
468 |
void |
469 |
Write_String_To_Socket (NewSocket * ns, char *buf, int len) |
470 |
{ |
471 |
SockList sl; |
472 |
|
473 |
sl.len = len; |
474 |
sl.buf = (unsigned char *) buf; |
475 |
Send_With_Handling (ns, &sl); |
476 |
} |
477 |
|
478 |
|
479 |
/****************************************************************************** |
480 |
* |
481 |
* statistics logging functions. |
482 |
* |
483 |
******************************************************************************/ |
484 |
|
485 |
#ifdef CS_LOGSTATS |
486 |
|
487 |
/* cst_tot is for the life of the server, cst_last is for the last series of |
488 |
* stats |
489 |
*/ |
490 |
CS_Stats cst_tot, cst_lst; |
491 |
|
492 |
/** |
493 |
* Writes out the gathered stats. We clear cst_lst. |
494 |
*/ |
495 |
void |
496 |
write_cs_stats (void) |
497 |
{ |
498 |
time_t now = time (NULL); |
499 |
|
500 |
/* If no connections recently, don't both to log anything */ |
501 |
if (cst_lst.ibytes == 0 && cst_lst.obytes == 0) |
502 |
return; |
503 |
|
504 |
/* CSSTAT is put in so scripts can easily find the line */ |
505 |
LOG (llevInfo, "CSSTAT: %.16s tot %d %d %d %d inc %d %d %d %d\n", |
506 |
ctime (&now), cst_tot.ibytes, cst_tot.obytes, cst_tot.max_conn, |
507 |
now - cst_tot.time_start, cst_lst.ibytes, cst_lst.obytes, cst_lst.max_conn, now - cst_lst.time_start); |
508 |
cst_lst.ibytes = 0; |
509 |
cst_lst.obytes = 0; |
510 |
cst_lst.max_conn = socket_info.nconns; |
511 |
cst_lst.time_start = now; |
512 |
} |
513 |
#endif |