ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/deliantra/server/socket/lowlevel.C
Revision: 1.60
Committed: Mon Oct 1 01:09:10 2007 UTC (16 years, 7 months ago) by root
Content type: text/plain
Branch: MAIN
Changes since 1.59: +7 -11 lines
Log Message:
do away with silly command process idle watcher, we process most commands in the mainloop anyways, so its only overhead

File Contents

# Content
1 /*
2 * This file is part of Crossfire TRT, the Roguelike Realtime MORPG.
3 *
4 * Copyright (©) 2005,2006,2007 Marc Alexander Lehmann / Robin Redeker / the Crossfire TRT team
5 * Copyright (©) 1992,2007 Frank Tore Johansen
6 *
7 * Crossfire TRT is free software: you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License as published by
9 * the Free Software Foundation, either version 3 of the License, or
10 * (at your option) any later version.
11 *
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
16 *
17 * You should have received a copy of the GNU General Public License
18 * along with this program. If not, see <http://www.gnu.org/licenses/>.
19 *
20 * The authors can be reached via e-mail to <crossfire@schmorp.de>
21 */
22
23 using namespace std;
24
25 #include <global.h>
26 #include <sproto.h>
27 #include <cstdarg>
28
29 #if HAVE_TCP_INFO
30 # include <sys/types.h>
31 # include <sys/socket.h>
32 # include <netinet/in.h>
33 # include <netinet/tcp.h>
34 #endif
35
36 // force a packet when idle for more than this many seconds,
37 // forcing an ack regularly.
38 #define IDLE_PING 2.
39
40 void
41 client::flush ()
42 {
43 if (destroyed ())
44 return;
45
46 /**
47 * Writes data to socket.
48 *
49 * When the socket is clear to write, and we have backlogged data, this
50 * is called to write it out.
51 */
52
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)
68 return;
69
70 last_send = NOW;
71 write_outputbuffer ();
72 }
73
74 void
75 client::write_outputbuffer ()
76 {
77 while (outputbuffer.len)
78 {
79 int res = write (fd, outputbuffer.data + outputbuffer.start,
80 min (outputbuffer.len, SOCKETBUFSIZE - outputbuffer.start));
81
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;
88
89 outputbuffer.len -= res;
90 }
91 else if (res == 0)
92 {
93 LOG (llevError, "socket write failed, connection closed.\n");
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 () | PE_W);
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 }
115
116 socket_ev.poll (socket_ev.poll () & ~PE_W);
117 }
118
119 /******************************************************************************
120 *
121 * Start of read routines.
122 *
123 ******************************************************************************/
124
125 int
126 client::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
146 void
147 client::skip_packet (int len)
148 {
149 inbuf_len -= len;
150 memmove (inbuf, inbuf + len, inbuf_len);
151 }
152
153 /*****************************************************************************
154 * Start of command dispatch area.
155 * The commands here are protocol commands.
156 ****************************************************************************/
157
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 */
165 static 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
194 bool
195 client::may_execute (const packet_type *pkt) const
196 {
197 return (!(pkt->flags & PF_PLAYER) || pl)
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.
206 static bool
207 always_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
229 void
230 client::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 }
240 else
241 send_packet_printf ("drawinfo %d ERROR: you cannot execute '%s' now.", NDI_RED | NDI_REPLY, pkt->name);
242 }
243
244 bool
245 client::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;
257 }
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))
282 {
283 if (pkt->flags & PF_PLAYER && !always_immediate (this, pkt, data, datalen))
284 queue_command (pkt, data, datalen);
285 else
286 execute (pkt, data, datalen);
287
288 goto next_packet;
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);
293 next_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
303 void
304 client::socket_cb (iow &w, int got)
305 {
306 //TODO remove when we have better socket cleanup logic
307 if (destroyed ())
308 {
309 socket_ev.poll (0);
310 return;
311 }
312
313 if (got & PE_W)
314 {
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
324
325 int amount = sizeof (inbuf) - inbuf_len;
326
327 if (!amount)
328 {
329 // input buffer full
330 socket_ev.poll (socket_ev.poll () & ~PE_R);
331 return;
332 }
333
334 amount = read (fd, inbuf + inbuf_len, amount);
335
336 if (!amount)
337 {
338 destroy ();
339 return;
340 }
341 else if (amount < 0)
342 {
343 if (errno != EAGAIN && errno != EINTR)
344 {
345 LOG (llevError, "read error: %s\n", strerror (errno));
346 destroy ();
347 return;
348 }
349
350 // should not be here, normally
351 }
352 else
353 {
354 inbuf_len += amount;
355
356 if (handle_packet ())
357 {
358 while (handle_packet ())
359 ;
360
361 flush ();
362 }
363 }
364 }
365 }
366
367 /*******************************************************************************
368 *
369 * Start of write related routines.
370 *
371 ******************************************************************************/
372
373 /**
374 * Adds data to a socket buffer for whatever reason.
375 *
376 * ns is the socket we are adding the data to, buf is the start of the
377 * data, and len is the number of bytes to add.
378 */
379 void
380 client::send (void *buf_, int len)
381 {
382 char *buf = (char *)buf_;
383
384 if (destroyed () || !buf)
385 return;
386
387 if (len + outputbuffer.len > SOCKETBUFSIZE)
388 {
389 LOG (llevDebug, "socket on fd %d has overrun internal buffer - marking as dead\n", fd);
390 // shutdown the socket, this is safer than destroying it immediately
391 // as lots of code in the callchain might still access the map etc.
392 shutdown (fd, SHUT_RDWR);
393 return;
394 }
395
396 int avail, end;
397
398 /* data + end is where we start putting the new data. The last byte
399 * currently in use is actually data + end -1
400 */
401 end = outputbuffer.start + outputbuffer.len;
402 /* The buffer is already in a wrapped state, so adjust end */
403 if (end >= SOCKETBUFSIZE)
404 end -= SOCKETBUFSIZE;
405
406 avail = SOCKETBUFSIZE - end;
407
408 /* We can all fit it behind the current data without wrapping */
409 if (avail >= len)
410 memcpy (outputbuffer.data + end, buf, len);
411 else
412 {
413 memcpy (outputbuffer.data + end, buf, avail);
414 memcpy (outputbuffer.data, buf + avail, len - avail);
415 }
416
417 outputbuffer.len += len;
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 client::send_packet (packet &sl)
426 {
427 if (destroyed ())
428 return;
429
430 if (sl.length () > MAXSOCKBUF)
431 {
432 LOG (llevError, "Trying to send a buffer beyond properly size, len =%d\n", sl.length ());
433 /* Almost certainly we've overflowed a buffer, so quit now to make
434 * it easier to debug.
435 */
436 abort ();
437 }
438
439 if (!sl.length ())
440 return;
441
442 assert (sl.hdrlen == 2);
443
444 sl.buf_ [0] = sl.length () >> 8;
445 sl.buf_ [1] = sl.length () ;
446
447 send (sl.buf_, sl.length () + sl.hdrlen);
448 }
449
450 void
451 client::send_packet (const char *buf, int len)
452 {
453 packet sl;
454
455 sl << data (buf, len);
456 send_packet (sl);
457 }
458
459 void
460 client::send_packet (const char *buf)
461 {
462 send_packet (buf, strlen (buf));
463 }
464
465 void
466 client::send_packet_printf (const char *format, ...)
467 {
468 packet sl;
469
470 va_list ap;
471 va_start (ap, format);
472 sl.vprintf (format, ap);
473 va_end (ap);
474
475 send_packet (sl);
476 }
477
478 // returns true when the message needs special (read: perl) treatment
479 static bool
480 msg_is_special (const char *msg)
481 {
482 return msg [strcspn (msg, "<[&\n")];
483 }
484
485 void
486 client::send_msg (int color, const char *type, const char *msg)
487 {
488 if (!msg || !type) // it can happen (for example, missing attack messages cause this)
489 {
490 LOG (logBacktrace | llevError, "send_msg(%d,%p,%p) called with NULL msg or type.\n", color, type, msg);
491 return;
492 }
493
494 int len = strlen (msg);
495
496 if (msg_is_special (msg) || (type [0] == 'c' && type [1] == '/') || len > (MAXSOCKBUF - 128))
497 cfperl_send_msg (this, color, type, msg);
498 else if (can_msg)
499 send_packet_printf ("msg %d %s %s", color & NDI_CLIENT_MASK, type, msg);
500 else if (color < 0)
501 return; // client cannot handle this
502 else
503 send_packet_printf ("drawinfo %d %s", color & NDI_COLOR_MASK, msg);
504 }
505
506 void
507 client::send_drawinfo (const char *msg, int flags)
508 {
509 send_msg (flags, "log", msg);
510 }
511
512 /***********************************************************************
513 *
514 * packet functions/utilities
515 *
516 **********************************************************************/
517
518 packet::packet (const char *name)
519 {
520 reset ();
521
522 int len = strlen (name);
523 memcpy (cur, name, len); cur += len;
524 *cur++ = ' ';
525 }
526
527 packet &packet::operator <<(const ber32 v)
528 {
529 enum { maxlen = 32 / 7 + 1};
530 uint8 buf[maxlen];
531 uint8 *p = buf + maxlen;
532 uint32 val = v.val;
533
534 *--p = val & 0x7F;
535
536 while (val > 0x7F)
537 {
538 val >>= 7;
539 *--p = (val & 0x7F) | 0x80;
540 }
541
542 return *this << data (p, buf + maxlen - p);
543 }
544
545 packet &packet::operator <<(const data &v)
546 {
547 if (room () < v.len)
548 reset ();
549 else
550 {
551 if (v.len)
552 {
553 memcpy (cur, v.ptr, v.len);
554 cur += v.len;
555 }
556 }
557
558 return *this;
559 }
560
561 packet &packet::operator <<(const data8 &v)
562 {
563 unsigned int len = min (v.len, 0x00FF);
564 return *this << uint8 (len) << data (v.ptr, len);
565 }
566
567 packet &packet::operator <<(const data16 &v)
568 {
569 unsigned int len = min (v.len, 0xFFFF);
570 return *this << uint16 (len) << data (v.ptr, len);
571 }
572
573 packet &packet::operator <<(const char *v)
574 {
575 return *this << data (v, strlen (v ? v : 0));
576 }
577
578 void
579 packet::vprintf (const char *format, va_list ap)
580 {
581 int size = room ();
582
583 int len = vsnprintf ((char *)cur, size, format, ap);
584
585 if (len >= size)
586 return reset ();
587
588 cur += len;
589 }
590