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 |
#include <cstdarg> |
41 |
|
42 |
#ifdef __linux__ |
43 |
# include <sys/types.h> |
44 |
# include <sys/socket.h> |
45 |
# include <netinet/in.h> |
46 |
# define TCP_HZ 1000 // sorry... |
47 |
# include <netinet/tcp.h> |
48 |
#endif |
49 |
|
50 |
// use a really low timeout, as it doesn't cost any bandwidth, and you can |
51 |
// easily die in 20 seconds... |
52 |
#define SOCKET_TIMEOUT1 10 |
53 |
#define SOCKET_TIMEOUT2 20 |
54 |
|
55 |
void |
56 |
Socket_Flush (NewSocket * ns) |
57 |
{ |
58 |
#ifdef __linux__ |
59 |
// check time of last ack, and, if too old, kill connection |
60 |
struct tcp_info tcpi; |
61 |
socklen_t len = sizeof (tcpi); |
62 |
|
63 |
if (!getsockopt (ns->fd, IPPROTO_TCP, TCP_INFO, &tcpi, &len) && len == sizeof (tcpi)) |
64 |
{ |
65 |
unsigned int diff = tcpi.tcpi_last_ack_recv - tcpi.tcpi_last_data_sent; |
66 |
|
67 |
if (tcpi.tcpi_unacked && SOCKET_TIMEOUT1 * TCP_HZ < diff && diff < 0x80000000UL // ack delayed for 20s |
68 |
&& SOCKET_TIMEOUT2 * TCP_HZ < tcpi.tcpi_last_data_sent) // no data sent for 10s |
69 |
{ |
70 |
LOG (llevDebug, "Connection on fd %d closed due to ack timeout (%u/%u/%u)\n", ns->fd, |
71 |
(unsigned) tcpi.tcpi_last_ack_recv, (unsigned) tcpi.tcpi_last_data_sent, (unsigned) tcpi.tcpi_unacked); |
72 |
ns->status = Ns_Dead; |
73 |
} |
74 |
} |
75 |
|
76 |
int val; |
77 |
|
78 |
val = 0; setsockopt (ns->fd, IPPROTO_TCP, TCP_CORK, &val, sizeof (val)); |
79 |
val = 1; setsockopt (ns->fd, IPPROTO_TCP, TCP_CORK, &val, sizeof (val)); |
80 |
#endif |
81 |
} |
82 |
|
83 |
/*********************************************************************** |
84 |
* |
85 |
* packet functions/utilities |
86 |
* |
87 |
**********************************************************************/ |
88 |
|
89 |
packet &packet::operator <<(const data &v) |
90 |
{ |
91 |
if (room () < v.len) |
92 |
reset (); |
93 |
else |
94 |
{ |
95 |
if (v.len) |
96 |
{ |
97 |
memcpy (cur, v.ptr, v.len); |
98 |
cur += v.len; |
99 |
} |
100 |
} |
101 |
|
102 |
return *this; |
103 |
} |
104 |
|
105 |
packet &packet::operator <<(const data8 &v) |
106 |
{ |
107 |
unsigned int len = min (v.len, 0x00FF); |
108 |
return *this << uint8 (len) << data (v.ptr, len); |
109 |
} |
110 |
|
111 |
packet &packet::operator <<(const data16 &v) |
112 |
{ |
113 |
unsigned int len = min (v.len, 0xFFFF); |
114 |
return *this << uint16 (len) << data (v.ptr, len); |
115 |
} |
116 |
|
117 |
packet &packet::operator <<(const char *v) |
118 |
{ |
119 |
return *this << data (v, strlen (v ? v : 0)); |
120 |
} |
121 |
|
122 |
void |
123 |
packet::printf (const char *format, ...) |
124 |
{ |
125 |
int size = room (); |
126 |
|
127 |
va_list ap; |
128 |
va_start (ap, format); |
129 |
int len = vsnprintf ((char *)cur, size, format, ap); |
130 |
va_end (ap); |
131 |
|
132 |
if (len >= size) |
133 |
return reset (); |
134 |
|
135 |
cur += len; |
136 |
} |
137 |
|
138 |
/****************************************************************************** |
139 |
* |
140 |
* Start of read routines. |
141 |
* |
142 |
******************************************************************************/ |
143 |
|
144 |
int |
145 |
NewSocket::read_packet () |
146 |
{ |
147 |
for (;;) |
148 |
{ |
149 |
if (inbuf_len >= 2) |
150 |
{ |
151 |
unsigned int pkt_len = (inbuf [0] << 8) | inbuf [1]; |
152 |
|
153 |
if (inbuf_len >= 2 + pkt_len) |
154 |
return pkt_len + 2; |
155 |
} |
156 |
|
157 |
int amount = sizeof (inbuf) - inbuf_len; |
158 |
|
159 |
if (amount <= 0) |
160 |
{ |
161 |
LOG (llevError, "packet too large");//TODO |
162 |
return -1; |
163 |
} |
164 |
|
165 |
amount = read (fd, inbuf + inbuf_len, amount); |
166 |
|
167 |
if (!amount) |
168 |
{ |
169 |
status = Ns_Dead; |
170 |
return -1; |
171 |
} |
172 |
else if (amount < 0) |
173 |
{ |
174 |
if (errno != EAGAIN && errno != EINTR) |
175 |
{ |
176 |
LOG (llevError, "read error: %s", strerror (errno)); |
177 |
return -1; |
178 |
} |
179 |
|
180 |
return 0; |
181 |
} |
182 |
|
183 |
inbuf_len += amount; |
184 |
|
185 |
cst_tot.ibytes += amount; |
186 |
cst_lst.ibytes += amount; |
187 |
} |
188 |
} |
189 |
|
190 |
void |
191 |
NewSocket::skip_packet (int len) |
192 |
{ |
193 |
inbuf_len -= len; |
194 |
memmove (inbuf, inbuf + len, inbuf_len); |
195 |
} |
196 |
|
197 |
/******************************************************************************* |
198 |
* |
199 |
* Start of write related routines. |
200 |
* |
201 |
******************************************************************************/ |
202 |
|
203 |
/** |
204 |
* Adds data to a socket buffer for whatever reason. |
205 |
* |
206 |
* ns is the socket we are adding the data to, buf is the start of the |
207 |
* data, and len is the number of bytes to add. |
208 |
*/ |
209 |
|
210 |
static void |
211 |
add_to_buffer (NewSocket *ns, char *buf, int len) |
212 |
{ |
213 |
int avail, end; |
214 |
|
215 |
if ((len + ns->outputbuffer.len) > SOCKETBUFSIZE) |
216 |
{ |
217 |
LOG (llevDebug, "Socket on fd %d has overrun internal buffer - marking as dead\n", ns->fd); |
218 |
ns->status = Ns_Dead; |
219 |
return; |
220 |
} |
221 |
|
222 |
/* data + end is where we start putting the new data. The last byte |
223 |
* currently in use is actually data + end -1 |
224 |
*/ |
225 |
|
226 |
end = ns->outputbuffer.start + ns->outputbuffer.len; |
227 |
/* The buffer is already in a wrapped state, so adjust end */ |
228 |
if (end >= SOCKETBUFSIZE) |
229 |
end -= SOCKETBUFSIZE; |
230 |
|
231 |
avail = SOCKETBUFSIZE - end; |
232 |
|
233 |
/* We can all fit it behind the current data without wrapping */ |
234 |
if (avail >= len) |
235 |
memcpy (ns->outputbuffer.data + end, buf, len); |
236 |
else |
237 |
{ |
238 |
memcpy (ns->outputbuffer.data + end, buf, avail); |
239 |
memcpy (ns->outputbuffer.data, buf + avail, len - avail); |
240 |
} |
241 |
|
242 |
ns->outputbuffer.len += len; |
243 |
#if 0 |
244 |
LOG (llevDebug, "Added %d to output buffer, total length now %d, start=%d\n", len, ns->outputbuffer.len, ns->outputbuffer.start); |
245 |
#endif |
246 |
} |
247 |
|
248 |
/** |
249 |
* Writes data to socket. |
250 |
* |
251 |
* When the socket is clear to write, and we have backlogged data, this |
252 |
* is called to write it out. |
253 |
*/ |
254 |
void |
255 |
write_socket_buffer (NewSocket * ns) |
256 |
{ |
257 |
int amt, max; |
258 |
|
259 |
if (ns->outputbuffer.len == 0) |
260 |
{ |
261 |
LOG (llevDebug, "write_socket_buffer called when there is no data, fd=%d\n", ns->fd); |
262 |
return; |
263 |
} |
264 |
|
265 |
do |
266 |
{ |
267 |
max = SOCKETBUFSIZE - ns->outputbuffer.start; |
268 |
if (ns->outputbuffer.len < max) |
269 |
max = ns->outputbuffer.len; |
270 |
|
271 |
do |
272 |
{ |
273 |
amt = write (ns->fd, ns->outputbuffer.data + ns->outputbuffer.start, max); |
274 |
} |
275 |
while ((amt < 0) && (errno == EINTR)); |
276 |
|
277 |
if (amt < 0) |
278 |
{ /* We got an error */ |
279 |
|
280 |
if (errno != EWOULDBLOCK) |
281 |
{ |
282 |
LOG (llevError, "New socket write failed (wsb) (%d: %s).\n", errno, strerror (errno)); |
283 |
ns->status = Ns_Dead; |
284 |
return; |
285 |
} |
286 |
else |
287 |
{ /* EWOULDBLOCK */ |
288 |
/* can't write it, so store it away. */ |
289 |
ns->can_write = 0; |
290 |
return; |
291 |
} |
292 |
} |
293 |
ns->outputbuffer.start += amt; |
294 |
/* wrap back to start of buffer */ |
295 |
if (ns->outputbuffer.start == SOCKETBUFSIZE) |
296 |
ns->outputbuffer.start = 0; |
297 |
ns->outputbuffer.len -= amt; |
298 |
#ifdef CS_LOGSTATS |
299 |
cst_tot.obytes += amt; |
300 |
cst_lst.obytes += amt; |
301 |
#endif |
302 |
} |
303 |
while (ns->outputbuffer.len > 0); |
304 |
} |
305 |
|
306 |
/** |
307 |
* This writes data to the socket. - It is very low level - |
308 |
* all we try and do is write out the data to the socket |
309 |
* provided (ns). buf is the data to write, len is the number |
310 |
* of bytes to write. IT doesn't return anything - rather, it |
311 |
* updates the ns structure if we get an error. |
312 |
*/ |
313 |
void |
314 |
NewSocket::send (void *buf_, int len) |
315 |
{ |
316 |
char *buf = (char *)buf_; |
317 |
char *pos = buf; |
318 |
int amt = 0; |
319 |
|
320 |
if (status == Ns_Dead || !buf) |
321 |
{ |
322 |
LOG (llevDebug, "Write_To_Socket called with dead socket\n"); |
323 |
return; |
324 |
} |
325 |
|
326 |
#ifndef __GNU__ /* This caused problems on Hurd */ |
327 |
if (!can_write) |
328 |
{ |
329 |
add_to_buffer (this, buf, len); |
330 |
return; |
331 |
} |
332 |
#endif |
333 |
|
334 |
/* If we manage to write more than we wanted, take it as a bonus */ |
335 |
while (len > 0) |
336 |
{ |
337 |
do |
338 |
{ |
339 |
amt = write (fd, pos, len); |
340 |
} |
341 |
while ((amt < 0) && (errno == EINTR)); |
342 |
|
343 |
if (amt < 0) |
344 |
{ /* We got an error */ |
345 |
if (errno != EWOULDBLOCK) |
346 |
{ |
347 |
LOG (llevError, "New socket write failed WTS (%d: %s).\n", /* ---WIN32 */ |
348 |
errno, strerror (errno)); |
349 |
status = Ns_Dead; |
350 |
return; |
351 |
} |
352 |
else |
353 |
{ /* EWOULDBLOCK */ |
354 |
/* can't write it, so store it away. */ |
355 |
add_to_buffer (this, pos, len); |
356 |
can_write = 0; |
357 |
return; |
358 |
} |
359 |
} |
360 |
/* amt gets set to 0 above in blocking code, so we do this as |
361 |
* an else if to make sure we don't reprocess it. |
362 |
*/ |
363 |
else if (amt == 0) |
364 |
LOG (llevError, "Write_To_Socket: No data written out.\n"); |
365 |
|
366 |
len -= amt; |
367 |
pos += amt; |
368 |
#ifdef CS_LOGSTATS |
369 |
cst_tot.obytes += amt; |
370 |
cst_lst.obytes += amt; |
371 |
#endif |
372 |
} |
373 |
} |
374 |
|
375 |
/** |
376 |
* Takes a string of data, and writes it out to the socket. A very handy |
377 |
* shortcut function. |
378 |
*/ |
379 |
|
380 |
void |
381 |
NewSocket::send_packet (packet &sl) |
382 |
{ |
383 |
Send_With_Handling (this, &sl); |
384 |
} |
385 |
|
386 |
void |
387 |
NewSocket::send_packet (const char *buf, int len) |
388 |
{ |
389 |
packet sl; |
390 |
|
391 |
sl << data (buf, len); |
392 |
send_packet (sl); |
393 |
} |
394 |
|
395 |
void |
396 |
NewSocket::send_packet (const char *buf) |
397 |
{ |
398 |
send_packet (buf, strlen (buf)); |
399 |
} |
400 |
|
401 |
/** |
402 |
* Calls Write_To_Socket to send data to the client. |
403 |
* |
404 |
* The only difference in this function is that we take a packet |
405 |
*, and we prepend the length information. |
406 |
*/ |
407 |
void |
408 |
Send_With_Handling (NewSocket *ns, packet *msg) |
409 |
{ |
410 |
unsigned char sbuf[4]; |
411 |
|
412 |
if (ns->status == Ns_Dead || !msg) |
413 |
return; |
414 |
|
415 |
if (msg->length () >= MAXSOCKBUF) |
416 |
{ |
417 |
LOG (llevError, "Trying to send a buffer beyond properly size, len =%d\n", msg->length ()); |
418 |
/* Almost certainly we've overflowed a buffer, so quite now to make |
419 |
* it easier to debug. |
420 |
*/ |
421 |
abort (); |
422 |
} |
423 |
|
424 |
sbuf[0] = ((uint32) (msg->length ()) >> 8); |
425 |
sbuf[1] = ((uint32) (msg->length ()) ); |
426 |
|
427 |
if (ns->status != Ns_Old) |
428 |
ns->send (sbuf, 2); |
429 |
|
430 |
ns->send (msg->buf, msg->length ()); |
431 |
} |
432 |
|
433 |
/****************************************************************************** |
434 |
* |
435 |
* statistics logging functions. |
436 |
* |
437 |
******************************************************************************/ |
438 |
|
439 |
#ifdef CS_LOGSTATS |
440 |
|
441 |
/* cst_tot is for the life of the server, cst_last is for the last series of |
442 |
* stats |
443 |
*/ |
444 |
CS_Stats cst_tot, cst_lst; |
445 |
|
446 |
/** |
447 |
* Writes out the gathered stats. We clear cst_lst. |
448 |
*/ |
449 |
void |
450 |
write_cs_stats (void) |
451 |
{ |
452 |
time_t now = time (NULL); |
453 |
|
454 |
/* If no connections recently, don't both to log anything */ |
455 |
if (cst_lst.ibytes == 0 && cst_lst.obytes == 0) |
456 |
return; |
457 |
|
458 |
/* CSSTAT is put in so scripts can easily find the line */ |
459 |
LOG (llevInfo, "CSSTAT: %.16s tot %d %d %d %d inc %d %d %d %d\n", |
460 |
ctime (&now), cst_tot.ibytes, cst_tot.obytes, cst_tot.max_conn, |
461 |
now - cst_tot.time_start, cst_lst.ibytes, cst_lst.obytes, cst_lst.max_conn, now - cst_lst.time_start); |
462 |
cst_lst.ibytes = 0; |
463 |
cst_lst.obytes = 0; |
464 |
cst_lst.max_conn = socket_info.nconns; |
465 |
cst_lst.time_start = now; |
466 |
} |
467 |
#endif |
468 |
|