ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/deliantra/server/socket/lowlevel.C
Revision: 1.28
Committed: Thu Dec 21 06:12:37 2006 UTC (17 years, 5 months ago) by root
Content type: text/plain
Branch: MAIN
Changes since 1.27: +4 -4 lines
Log Message:
- made client a first-class crossfire-perl object
  (its attachable), but perl support is missing.
- added some client events
- fixed reply not working after logout

File Contents

# User Rev Content
1 elmex 1.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 <sproto.h>
39 root 1.11 #include <cstdarg>
40 elmex 1.1
41     #ifdef __linux__
42     # include <sys/types.h>
43     # include <sys/socket.h>
44     # include <netinet/in.h>
45     # include <netinet/tcp.h>
46     #endif
47    
48     // use a really low timeout, as it doesn't cost any bandwidth, and you can
49     // easily die in 20 seconds...
50 root 1.26 #define SOCKET_TIMEOUT1 10 * 1000
51     #define SOCKET_TIMEOUT2 20 * 1000
52 elmex 1.1
53 root 1.5 void
54 root 1.22 client::flush ()
55 elmex 1.1 {
56     #ifdef __linux__
57     // check time of last ack, and, if too old, kill connection
58     struct tcp_info tcpi;
59     socklen_t len = sizeof (tcpi);
60    
61 root 1.20 if (!getsockopt (fd, IPPROTO_TCP, TCP_INFO, &tcpi, &len) && len == sizeof (tcpi))
62 elmex 1.1 {
63     unsigned int diff = tcpi.tcpi_last_ack_recv - tcpi.tcpi_last_data_sent;
64    
65 root 1.21 rtt = tcpi.tcpi_rtt;
66     rttvar = tcpi.tcpi_rttvar;
67    
68 root 1.26 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 elmex 1.1 {
71 root 1.20 LOG (llevDebug, "Connection on fd %d closed due to ack timeout (%u/%u/%u)\n", fd,
72 root 1.5 (unsigned) tcpi.tcpi_last_ack_recv, (unsigned) tcpi.tcpi_last_data_sent, (unsigned) tcpi.tcpi_unacked);
73 root 1.23 destroy ();
74 elmex 1.1 }
75     }
76 root 1.20 #endif
77    
78     /**
79     * Writes data to socket.
80     *
81     * When the socket is clear to write, and we have backlogged data, this
82     * is called to write it out.
83     */
84    
85     if (!outputbuffer.len || socket_ev.poll () & PE_W)
86     return;
87    
88     write_outputbuffer ();
89     }
90 elmex 1.1
91 root 1.20 void
92 root 1.22 client::write_outputbuffer ()
93 root 1.20 {
94     while (outputbuffer.len)
95     {
96     int res = write (fd, outputbuffer.data + outputbuffer.start,
97     min (outputbuffer.len, SOCKETBUFSIZE - outputbuffer.start));
98 root 1.5
99 root 1.20 if (res > 0)
100     {
101     outputbuffer.start += res;
102     /* wrap back to start of buffer */
103     if (outputbuffer.start == SOCKETBUFSIZE)
104     outputbuffer.start = 0;
105    
106     outputbuffer.len -= res;
107     #ifdef CS_LOGSTATS
108     cst_tot.obytes += res;
109     cst_lst.obytes += res;
110 elmex 1.1 #endif
111 root 1.20 }
112     else if (res == 0)
113     {
114     LOG (llevError, "socket write failed, connection closed.\n");
115 root 1.23 destroy ();
116 root 1.20 return;
117     }
118     else if (errno == EINTR)
119     {
120     // just retry
121     }
122     else if (errno == EAGAIN)
123     {
124     // delay till ready
125     socket_ev.poll (socket_ev.poll () | PE_W);
126     socket_ev.start ();
127     return;
128     }
129     else
130     {
131     LOG (llevError, "socket write failed: %s\n", strerror (errno));
132 root 1.23 destroy ();
133 root 1.20 return;
134     }
135     }
136    
137     socket_ev.poll (socket_ev.poll () & ~PE_W);
138 elmex 1.1 }
139    
140 root 1.23 /******************************************************************************
141 elmex 1.1 *
142 root 1.23 * Start of read routines.
143 elmex 1.1 *
144 root 1.23 ******************************************************************************/
145 elmex 1.1
146 root 1.23 int
147     client::next_packet ()
148 elmex 1.1 {
149 root 1.23 if (inbuf_len >= 2)
150 root 1.11 {
151 root 1.23 int pkt_len = (inbuf [0] << 8) | inbuf [1];
152    
153     if (inbuf_len >= 2 + pkt_len)
154     return 2 + pkt_len;
155    
156     if (inbuf_len == sizeof (inbuf))
157 root 1.15 {
158 root 1.23 send_packet_printf ("drawinfo %d input buffer overflow - closing connection.", NDI_RED);
159     destroy ();
160     return -1;
161 root 1.15 }
162 root 1.11 }
163 root 1.9
164 root 1.23 return 0;
165 root 1.11 }
166 root 1.9
167 root 1.23 void
168     client::skip_packet (int len)
169 root 1.11 {
170 root 1.23 inbuf_len -= len;
171     memmove (inbuf, inbuf + len, inbuf_len);
172 elmex 1.1 }
173    
174 root 1.23 /*****************************************************************************
175     * Start of command dispatch area.
176     * The commands here are protocol commands.
177     ****************************************************************************/
178    
179     // SocketCommand, PlayingCommand, should not exist with those ugly casts
180     #define SC(cb) (void *)static_cast<void (*)(char *, int, client *)>(cb),
181     #define PC(cb) (void *)static_cast<void (*)(char *, int, player *)>(cb), PF_PLAYER |
182    
183     /**
184     * Dispatch table for the server.
185     */
186     static struct packet_type packets[] = {
187     {"ncom", PC(NewPlayerCmd) PF_PLAYING },
188     {"command", PC(PlayerCmd) PF_PLAYING },
189    
190     {"examine", PC(ExamineCmd) PF_PLAYING },
191     {"apply", PC(ApplyCmd) PF_PLAYING },
192     {"lookat", PC(LookAt) PF_PLAYING },
193     {"lock", PC(LockItem) PF_PLAYING },
194     {"mark", PC(MarkItem) PF_PLAYING },
195     {"move", PC(MoveCmd) PF_PLAYING },
196     {"ext", PC(ExtCmd) 0 }, /* CF+ */
197 root 1.26 {"mapredraw", PC(MapRedrawCmd) 0 }, /* Added: phil */
198 root 1.23 {"mapinfo", PC(MapInfoCmd) 0 }, /* CF+ */
199    
200 root 1.28 {"reply", SC(ReplyCmd) 0 },
201 root 1.26 {"exti", SC(ExtiCmd) 0 }, /* CF+ */
202     {"addme", SC(AddMeCmd) 0 },
203     {"askface", SC(SendFaceCmd) 0 }, /* Added: phil */
204     {"requestinfo", SC(RequestInfo) 0 },
205     {"setfacemode", SC(SetFaceMode) 0 },
206     {"setsound", SC(SetSound) 0 },
207     {"setup", SC(SetUp) 0 },
208     {"version", SC(VersionCmd) 0 },
209     {"toggleextendedinfos", SC(ToggleExtendedInfos) 0 }, /*Added: tchize */
210     {"toggleextendedtext", SC(ToggleExtendedText) 0 }, /*Added: tchize */
211     {"asksmooth", SC(AskSmooth) 0 }, /*Added: tchize (smoothing technologies) */
212 root 1.23 };
213    
214     bool
215     client::may_execute (const packet_type *pkt) const
216 elmex 1.1 {
217 root 1.23 return (!(pkt->flags & PF_PLAYER) || pl)
218     && (!(pkt->flags & PF_PLAYING) || (pl && pl->state == ST_PLAYING));
219 root 1.11 }
220 root 1.9
221 root 1.23 void
222     client::execute (const packet_type *pkt, char *data, int datalen)
223 root 1.11 {
224 root 1.23 if (may_execute (pkt))
225     {
226     //TODO: only one format
227     if (pkt->flags & PF_PLAYER)
228     ((void (*)(char *, int, player *))pkt->cb)((char *)data, datalen, pl);
229     else
230     ((void (*)(char *, int, client *))pkt->cb)((char *)data, datalen, this);
231     }
232     else
233     send_packet_printf ("drawinfo %d ERROR: you cannot execute '%s' now.", NDI_RED, pkt->name);
234 elmex 1.1 }
235    
236 root 1.23 bool
237     client::handle_packet ()
238 root 1.10 {
239 root 1.23 int pkt_len = next_packet ();
240    
241     if (!pkt_len)
242     return false;
243     else if (pkt_len < 0)
244     {
245     LOG (llevError, "read error on player %s\n",
246     pl && pl->ob ? &pl->ob->name : "[anonymous]");
247     destroy ();
248     return false;
249     }
250    
251     inbuf [pkt_len] = 0; /* Terminate buffer - useful for string data */
252    
253     /* First, break out beginning word. There are at least
254     * a few commands that do not have any paremeters. If
255     * we get such a command, don't worry about trying
256     * to break it up.
257     */
258     int datalen;
259     char *data = strchr ((char *)inbuf + 2, ' ');
260    
261     if (data)
262     {
263     *data++ = 0;
264     datalen = pkt_len - (data - (char *)inbuf);
265     }
266     else
267     {
268     data = (char *)inbuf + 2; // better read garbage than segfault
269     datalen = 0;
270     }
271 root 1.15
272 root 1.23 for (packet_type *pkt = packets; pkt < packets + (sizeof (packets) / sizeof (packets[0])); ++pkt)
273     if (!strcmp ((char *)inbuf + 2, pkt->name))
274     {
275 root 1.26 if (pkt->flags & PF_PLAYER)
276     queue_command (pkt, data, datalen);
277     else
278 root 1.23 execute (pkt, data, datalen);
279    
280     goto next_packet;
281     }
282    
283 root 1.26 // If we get here, we didn't find a valid command.
284 root 1.23 send_packet_printf ("drawinfo %d ERROR: command '%s' not supported.", NDI_RED, (char *)inbuf + 2);
285     next_packet:
286     skip_packet (pkt_len);
287 root 1.11
288 root 1.23 // input buffer has space again
289     socket_ev.poll (socket_ev.poll () | PE_R);
290 root 1.10
291 root 1.23 return true;
292 root 1.10 }
293    
294 root 1.23 // callback called when socket is either readable or writable
295     void
296     client::socket_cb (iow &w, int got)
297     {
298     //TODO remove when we have better socket cleanup logic
299 root 1.28 if (destroyed)
300 root 1.23 {
301     socket_ev.poll (0);
302     return;
303     }
304 elmex 1.1
305 root 1.23 if (got & PE_W)
306 root 1.5 {
307 root 1.23 write_outputbuffer ();
308    
309     if (!outputbuffer.len)
310     socket_ev.poll (socket_ev.poll () & ~PE_W);
311     }
312 root 1.12
313 root 1.23 if (got & PE_R)
314     {
315     //TODO: rate-limit tcp connection in better ways, important
316 pippijn 1.8
317 root 1.12 int amount = sizeof (inbuf) - inbuf_len;
318    
319 root 1.23 if (!amount)
320 root 1.5 {
321 root 1.23 // input buffer full
322     socket_ev.poll (socket_ev.poll () & ~PE_R);
323     return;
324 root 1.3 }
325 elmex 1.1
326 root 1.12 amount = read (fd, inbuf + inbuf_len, amount);
327    
328     if (!amount)
329 root 1.5 {
330 root 1.23 destroy ();
331     return;
332 root 1.5 }
333 root 1.12 else if (amount < 0)
334 root 1.5 {
335 root 1.12 if (errno != EAGAIN && errno != EINTR)
336 root 1.5 {
337 root 1.20 LOG (llevError, "read error: %s\n", strerror (errno));
338 root 1.23 destroy ();
339     return;
340 root 1.3 }
341 root 1.12
342 root 1.23 // should not be here, normally
343 root 1.3 }
344 root 1.23 else
345     {
346     inbuf_len += amount;
347 root 1.12
348 root 1.23 cst_tot.ibytes += amount;
349     cst_lst.ibytes += amount;
350 root 1.12
351 root 1.23 cmd_ev.start ();
352     }
353 root 1.5 }
354 root 1.12 }
355    
356 root 1.23 // called whenever we have additional commands to process
357 root 1.12 void
358 root 1.23 client::cmd_cb (iw &w)
359 root 1.12 {
360 root 1.26 if (handle_packet ())
361 root 1.23 w.start ();
362     else
363     flush ();
364 elmex 1.1 }
365    
366     /*******************************************************************************
367     *
368     * Start of write related routines.
369     *
370     ******************************************************************************/
371    
372     /**
373     * Adds data to a socket buffer for whatever reason.
374     *
375     * ns is the socket we are adding the data to, buf is the start of the
376     * data, and len is the number of bytes to add.
377     */
378 root 1.20 void
379 root 1.22 client::send (void *buf_, int len)
380 root 1.20 {
381     char *buf = (char *)buf_;
382     char *pos = buf;
383     int amt = 0;
384 elmex 1.1
385 root 1.28 if (destroyed || !buf)
386 root 1.23 return;
387 elmex 1.1
388 root 1.20 if ((len + outputbuffer.len) > SOCKETBUFSIZE)
389 root 1.5 {
390 root 1.23 LOG (llevDebug, "socket on fd %d has overrun internal buffer - marking as dead\n", fd);
391     destroy ();
392 root 1.5 return;
393     }
394    
395 root 1.20 int avail, end;
396    
397 root 1.5 /* data + end is where we start putting the new data. The last byte
398     * currently in use is actually data + end -1
399     */
400 root 1.20 end = outputbuffer.start + outputbuffer.len;
401 root 1.5 /* The buffer is already in a wrapped state, so adjust end */
402     if (end >= SOCKETBUFSIZE)
403     end -= SOCKETBUFSIZE;
404 root 1.7
405 root 1.5 avail = SOCKETBUFSIZE - end;
406 elmex 1.1
407 root 1.5 /* We can all fit it behind the current data without wrapping */
408     if (avail >= len)
409 root 1.20 memcpy (outputbuffer.data + end, buf, len);
410 root 1.5 else
411     {
412 root 1.20 memcpy (outputbuffer.data + end, buf, avail);
413     memcpy (outputbuffer.data, buf + avail, len - avail);
414 elmex 1.1 }
415 root 1.7
416 root 1.20 outputbuffer.len += len;
417 elmex 1.1 }
418    
419     /**
420     * Takes a string of data, and writes it out to the socket. A very handy
421     * shortcut function.
422     */
423 root 1.13 void
424 root 1.22 client::send_packet (packet &sl)
425 root 1.13 {
426 root 1.28 if (destroyed)
427 root 1.19 return;
428    
429     if (sl.length () >= MAXSOCKBUF)
430     {
431     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
433     * it easier to debug.
434     */
435     abort ();
436     }
437    
438     if (!sl.length ())
439     return;
440    
441     assert (sl.hdrlen == 2);
442    
443     sl.buf_ [0] = sl.length () >> 8;
444     sl.buf_ [1] = sl.length () ;
445    
446     send (sl.buf_, sl.length () + sl.hdrlen);
447 root 1.13 }
448    
449 root 1.5 void
450 root 1.22 client::send_packet (const char *buf, int len)
451 elmex 1.1 {
452 root 1.14 packet sl;
453 elmex 1.1
454 root 1.13 sl << data (buf, len);
455     send_packet (sl);
456 elmex 1.1 }
457    
458 root 1.13 void
459 root 1.22 client::send_packet (const char *buf)
460 root 1.13 {
461     send_packet (buf, strlen (buf));
462     }
463 elmex 1.1
464 root 1.23 void
465     client::send_packet_printf (const char *format, ...)
466     {
467     packet sl;
468    
469     va_list ap;
470     va_start (ap, format);
471     sl.vprintf (format, ap);
472     va_end (ap);
473    
474     send_packet (sl);
475     }
476    
477     /***********************************************************************
478     *
479     * packet functions/utilities
480     *
481     **********************************************************************/
482    
483 root 1.27 packet::packet (const char *name)
484     {
485     reset ();
486    
487     int len = strlen (name);
488     memcpy (cur, name, len); cur += len;
489     *cur++ = ' ';
490     }
491    
492 root 1.23 packet &packet::operator <<(const data &v)
493     {
494     if (room () < v.len)
495     reset ();
496     else
497     {
498     if (v.len)
499     {
500     memcpy (cur, v.ptr, v.len);
501     cur += v.len;
502     }
503     }
504    
505     return *this;
506     }
507    
508     packet &packet::operator <<(const data8 &v)
509     {
510     unsigned int len = min (v.len, 0x00FF);
511     return *this << uint8 (len) << data (v.ptr, len);
512     }
513    
514     packet &packet::operator <<(const data16 &v)
515     {
516     unsigned int len = min (v.len, 0xFFFF);
517     return *this << uint16 (len) << data (v.ptr, len);
518     }
519    
520     packet &packet::operator <<(const char *v)
521     {
522     return *this << data (v, strlen (v ? v : 0));
523     }
524    
525     void
526     packet::vprintf (const char *format, va_list ap)
527     {
528     int size = room ();
529    
530     int len = vsnprintf ((char *)cur, size, format, ap);
531    
532     if (len >= size)
533     return reset ();
534    
535     cur += len;
536     }
537    
538 elmex 1.1 /******************************************************************************
539     *
540     * statistics logging functions.
541     *
542     ******************************************************************************/
543    
544     #ifdef CS_LOGSTATS
545 root 1.5
546 elmex 1.1 /* cst_tot is for the life of the server, cst_last is for the last series of
547     * stats
548     */
549     CS_Stats cst_tot, cst_lst;
550    
551     /**
552     * Writes out the gathered stats. We clear cst_lst.
553     */
554 root 1.5 void
555     write_cs_stats (void)
556 elmex 1.1 {
557 root 1.5 time_t now = time (NULL);
558 elmex 1.1
559 root 1.5 /* If no connections recently, don't both to log anything */
560     if (cst_lst.ibytes == 0 && cst_lst.obytes == 0)
561     return;
562    
563     /* CSSTAT is put in so scripts can easily find the line */
564     LOG (llevInfo, "CSSTAT: %.16s tot %d %d %d %d inc %d %d %d %d\n",
565     ctime (&now), cst_tot.ibytes, cst_tot.obytes, cst_tot.max_conn,
566     now - cst_tot.time_start, cst_lst.ibytes, cst_lst.obytes, cst_lst.max_conn, now - cst_lst.time_start);
567     cst_lst.ibytes = 0;
568     cst_lst.obytes = 0;
569     cst_lst.time_start = now;
570 elmex 1.1 }
571     #endif
572 root 1.9