--- deliantra/server/socket/lowlevel.C 2006/12/17 19:14:00 1.25 +++ deliantra/server/socket/lowlevel.C 2008/09/19 01:39:45 1.66 @@ -1,35 +1,23 @@ /* - CrossFire, A Multiplayer game for X-windows - - Copyright (C) 1992 Frank Tore Johansen - - This program is free software; you can redistribute it and/or modify - it under the terms of the GNU General Public License as published by - the Free Software Foundation; either version 2 of the License, or - (at your option) any later version. - - This program is distributed in the hope that it will be useful, - but WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - GNU General Public License for more details. - - You should have received a copy of the GNU General Public License - along with this program; if not, write to the Free Software - Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. - - The author can be reached via e-mail to mark@pyramid.com -*/ - -/** - * \file - * Low-level socket-related functions. - * - * \date 2003-12-02 - * - * Contains some base functions that both the client and server - * can use. As such, depending what we are being compiled for will - * determine what we can include. the client is designed have - * CFCLIENT defined as part of its compile flags. + * This file is part of Deliantra, the Roguelike Realtime MMORPG. + * + * Copyright (©) 2005,2006,2007,2008 Marc Alexander Lehmann / Robin Redeker / the Deliantra team + * Copyright (©) 1992,2007 Frank Tore Johansen + * + * Deliantra is free software: you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation, either version 3 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program. If not, see . + * + * The authors can be reached via e-mail to */ using namespace std; @@ -38,43 +26,22 @@ #include #include -#ifdef __linux__ +#if HAVE_TCP_INFO # include # include # include -# define TCP_HZ 1000 // sorry... # include #endif -// use a really low timeout, as it doesn't cost any bandwidth, and you can -// easily die in 20 seconds... -#define SOCKET_TIMEOUT1 10 -#define SOCKET_TIMEOUT2 20 +// force a packet when idle for more than this many seconds, +// forcing an ack regularly. +#define IDLE_PING 2. void client::flush () { -#ifdef __linux__ - // check time of last ack, and, if too old, kill connection - struct tcp_info tcpi; - socklen_t len = sizeof (tcpi); - - if (!getsockopt (fd, IPPROTO_TCP, TCP_INFO, &tcpi, &len) && len == sizeof (tcpi)) - { - unsigned int diff = tcpi.tcpi_last_ack_recv - tcpi.tcpi_last_data_sent; - - rtt = tcpi.tcpi_rtt; - rttvar = tcpi.tcpi_rttvar; - - if (tcpi.tcpi_unacked && SOCKET_TIMEOUT1 * TCP_HZ < diff && diff < 0x80000000UL // ack delayed for 20s - && SOCKET_TIMEOUT2 * TCP_HZ < tcpi.tcpi_last_data_sent) // no data sent for 10s - { - LOG (llevDebug, "Connection on fd %d closed due to ack timeout (%u/%u/%u)\n", fd, - (unsigned) tcpi.tcpi_last_ack_recv, (unsigned) tcpi.tcpi_last_data_sent, (unsigned) tcpi.tcpi_unacked); - destroy (); - } - } -#endif + if (destroyed ()) + return; /** * Writes data to socket. @@ -83,9 +50,24 @@ * is called to write it out. */ - if (!outputbuffer.len || socket_ev.poll () & PE_W) + // write a nop to the socket at least every IDLE_NOP seconds. + if (!outputbuffer.len) + { + if (last_send + IDLE_PING <= NOW && pl && pl->active) + { + // this is a bit ugly, but map1/map1a seem to be the only + // nop'able commands and they are quite small. + packet sl (mapmode == Map1Cmd ? "map1" : "map1a"); + send_packet (sl); + } + else + return; + } + + if (socket_ev.poll () & EV_WRITE) return; + last_send = NOW; write_outputbuffer (); } @@ -105,10 +87,6 @@ outputbuffer.start = 0; outputbuffer.len -= res; -#ifdef CS_LOGSTATS - cst_tot.obytes += res; - cst_lst.obytes += res; -#endif } else if (res == 0) { @@ -123,7 +101,7 @@ else if (errno == EAGAIN) { // delay till ready - socket_ev.poll (socket_ev.poll () | PE_W); + socket_ev.poll (socket_ev.poll () | EV_WRITE); socket_ev.start (); return; } @@ -135,7 +113,7 @@ } } - socket_ev.poll (socket_ev.poll () & ~PE_W); + socket_ev.poll (socket_ev.poll () & ~EV_WRITE); } /****************************************************************************** @@ -156,7 +134,7 @@ if (inbuf_len == sizeof (inbuf)) { - send_packet_printf ("drawinfo %d input buffer overflow - closing connection.", NDI_RED); + send_packet_printf ("drawinfo %d input buffer overflow - closing connection.", NDI_RED | NDI_REPLY); destroy (); return -1; } @@ -185,44 +163,74 @@ * Dispatch table for the server. */ static struct packet_type packets[] = { - {"ncom", PC(NewPlayerCmd) PF_PLAYING }, - {"command", PC(PlayerCmd) PF_PLAYING }, + {"ncom", PC(NewPlayerCmd) PF_PLAYING | PF_COMMAND6 }, + {"command", PC(PlayerCmd) PF_PLAYING | PF_COMMAND0 }, {"examine", PC(ExamineCmd) PF_PLAYING }, + {"ex", PC(ExCmd) PF_PLAYING }, {"apply", PC(ApplyCmd) PF_PLAYING }, - {"reply", PC(ReplyCmd) PF_IMMEDIATE }, {"lookat", PC(LookAt) PF_PLAYING }, {"lock", PC(LockItem) PF_PLAYING }, {"mark", PC(MarkItem) PF_PLAYING }, {"move", PC(MoveCmd) PF_PLAYING }, - {"exti", PC(ExtCmd) PF_IMMEDIATE }, /* CF+ */ - {"ext", PC(ExtCmd) 0 }, /* CF+ */ - {"mapredraw", PC(MapRedrawCmd) PF_IMMEDIATE }, /* Added: phil */ - {"mapinfo", PC(MapInfoCmd) 0 }, /* CF+ */ - - {"addme", SC(AddMeCmd) PF_IMMEDIATE }, - {"askface", SC(SendFaceCmd) PF_IMMEDIATE }, /* Added: phil */ - {"requestinfo", SC(RequestInfo) PF_IMMEDIATE }, - {"setfacemode", SC(SetFaceMode) PF_IMMEDIATE }, - {"setsound", SC(SetSound) PF_IMMEDIATE }, - {"setup", SC(SetUp) PF_IMMEDIATE }, - {"version", SC(VersionCmd) PF_IMMEDIATE }, - {"toggleextendedinfos", SC(ToggleExtendedInfos) PF_IMMEDIATE }, /*Added: tchize */ - {"toggleextendedtext", SC(ToggleExtendedText) PF_IMMEDIATE }, /*Added: tchize */ - {"asksmooth", SC(AskSmooth) PF_IMMEDIATE }, /*Added: tchize (smoothing technologies) */ + {"ext", PC(ExtCmd) 0 }, // CF+ + {"mapredraw", PC(MapRedrawCmd) 0 }, + {"mapinfo", PC(MapInfoCmd) 0 }, // CF+ + + {"reply", SC(ReplyCmd) 0 }, + {"exti", SC(ExtiCmd) 0 }, // CF+ + {"addme", SC(AddMeCmd) 0 }, + {"askface", SC(AskFaceCmd) 0 }, + {"requestinfo", SC(RequestInfo) 0 }, + {"setfacemode", SC(SetFaceMode) 0 }, + {"setsound", SC(SetSound) 0 }, + {"setup", SC(SetUp) 0 }, + {"version", SC(VersionCmd) 0 }, + {"toggleextendedinfos", SC(ToggleExtendedInfos) 0 }, /*Added: tchize */ + {"toggleextendedtext", SC(ToggleExtendedText) 0 }, /*Added: tchize */ + {"asksmooth", SC(AskSmooth) 0 }, /*Added: tchize (smoothing technologies) */ }; bool client::may_execute (const packet_type *pkt) const { return (!(pkt->flags & PF_PLAYER) || pl) - && (!(pkt->flags & PF_PLAYING) || (pl && pl->state == ST_PLAYING)); + && (!(pkt->flags & PF_PLAYING) || state == ST_PLAYING); +} + +// HACK: some commands currently should be executed +// even when the player is frozen. this hack detects +// those commands. it should be folded into may_execute, +// but kept seperate to emphasise the hack aspect, i.e. +// do it better, then remove. +static bool +always_immediate (const client *ns, const packet_type *pkt, const char *data, int len) +{ + if (!(pkt->flags & (PF_COMMAND0 | PF_COMMAND6))) + return false; + + if (!ns->pl || !ns->pl->ob || !ns->pl->ob->map) + return false; + + if (pkt->flags & PF_COMMAND6) + { + data += 6; + len -= 6; + } + + if (len > 4 && data [3] == ' ' && !strncmp (data, "say " , 4)) return true; + if (len > 5 && data [4] == ' ' && !strncmp (data, "chat " , 5)) return true; + if (len > 6 && data [5] == ' ' && !strncmp (data, "shout ", 6)) return true; + + if (len == 7 && !strcmp (data, "suicide")) return true; + + return false; } void client::execute (const packet_type *pkt, char *data, int datalen) { - if (may_execute (pkt)) + if (may_execute (pkt) || always_immediate (this, pkt, data, datalen)) { //TODO: only one format if (pkt->flags & PF_PLAYER) @@ -231,7 +239,7 @@ ((void (*)(char *, int, client *))pkt->cb)((char *)data, datalen, this); } else - send_packet_printf ("drawinfo %d ERROR: you cannot execute '%s' now.", NDI_RED, pkt->name); + send_packet_printf ("drawinfo %d ERROR: you cannot execute '%s' now.", NDI_RED | NDI_REPLY, pkt->name); } bool @@ -273,48 +281,45 @@ for (packet_type *pkt = packets; pkt < packets + (sizeof (packets) / sizeof (packets[0])); ++pkt) if (!strcmp ((char *)inbuf + 2, pkt->name)) { - if (pkt->flags & PF_IMMEDIATE) - execute (pkt, data, datalen); - else + if (pkt->flags & PF_PLAYER && !always_immediate (this, pkt, data, datalen)) queue_command (pkt, data, datalen); + else + execute (pkt, data, datalen); goto next_packet; } - /* If we get here, we didn't find a valid command. Logging - * this might be questionable, because a broken client/malicious - * user could certainly send a whole bunch of invalid commands. - */ - send_packet_printf ("drawinfo %d ERROR: command '%s' not supported.", NDI_RED, (char *)inbuf + 2); + // If we get here, we didn't find a valid command. + send_packet_printf ("drawinfo %d ERROR: command '%s' not supported.", NDI_RED | NDI_REPLY, (char *)inbuf + 2); next_packet: skip_packet (pkt_len); // input buffer has space again - socket_ev.poll (socket_ev.poll () | PE_R); + socket_ev.poll (socket_ev.poll () | EV_READ); return true; } // callback called when socket is either readable or writable void -client::socket_cb (iow &w, int got) +client::socket_cb (iow &w, int revents) { //TODO remove when we have better socket cleanup logic - if (status == Ns_Dead) + if (destroyed ()) { socket_ev.poll (0); return; } - if (got & PE_W) + if (revents & EV_WRITE) { write_outputbuffer (); if (!outputbuffer.len) - socket_ev.poll (socket_ev.poll () & ~PE_W); + socket_ev.poll (socket_ev.poll () & ~EV_WRITE); } - if (got & PE_R) + if (revents & EV_READ) { //TODO: rate-limit tcp connection in better ways, important @@ -323,7 +328,7 @@ if (!amount) { // input buffer full - socket_ev.poll (socket_ev.poll () & ~PE_R); + socket_ev.poll (socket_ev.poll () & ~EV_READ); return; } @@ -349,24 +354,17 @@ { inbuf_len += amount; - cst_tot.ibytes += amount; - cst_lst.ibytes += amount; + if (handle_packet ()) + { + while (handle_packet ()) + ; - cmd_ev.start (); + flush (); + } } } } -// called whenever we have additional commands to process -void -client::cmd_cb (iw &w) -{ - if (handle_packet () || handle_command ()) - w.start (); - else - flush (); -} - /******************************************************************************* * * Start of write related routines. @@ -383,16 +381,16 @@ client::send (void *buf_, int len) { char *buf = (char *)buf_; - char *pos = buf; - int amt = 0; - if (status == Ns_Dead || !buf) + if (destroyed () || !buf) return; - if ((len + outputbuffer.len) > SOCKETBUFSIZE) + if (len + outputbuffer.len > SOCKETBUFSIZE) { LOG (llevDebug, "socket on fd %d has overrun internal buffer - marking as dead\n", fd); - destroy (); + // shutdown the socket, this is safer than destroying it immediately + // as lots of code in the callchain might still access the map etc. + shutdown (fd, SHUT_RDWR); return; } @@ -427,10 +425,10 @@ void client::send_packet (packet &sl) { - if (status == Ns_Dead) + if (destroyed ()) return; - if (sl.length () >= MAXSOCKBUF) + if (sl.length () > MAXSOCKBUF) { LOG (llevError, "Trying to send a buffer beyond properly size, len =%d\n", sl.length ()); /* Almost certainly we've overflowed a buffer, so quit now to make @@ -478,12 +476,68 @@ send_packet (sl); } +void +client::send_msg (int color, const char *type, const char *msg) +{ + if (!msg || !type) // it can happen (for example, missing attack messages cause this) + { + LOG (logBacktrace | llevError, "send_msg(%d,%p,%p) called with NULL msg or type.\n", color, type, msg); + return; + } + + int len = strlen (msg); + + if (!(color & NDI_VERBATIM) + && (msg_is_special (msg) + || (type [0] == 'c' && type [1] == '/') || len > (MAXSOCKBUF - 128))) + cfperl_send_msg (this, color, type, msg); + else if (can_msg) + send_packet_printf ("msg %d %s %s", color & NDI_CLIENT_MASK, type, msg); + else if (color < 0) + return; // client cannot handle this + else + send_packet_printf ("drawinfo %d %s", color & NDI_COLOR_MASK, msg); +} + +void +client::send_drawinfo (const char *msg, int flags) +{ + send_msg (flags, "log", msg); +} + /*********************************************************************** * * packet functions/utilities * **********************************************************************/ +packet::packet (const char *name) +{ + reset (); + + int len = strlen (name); + memcpy (cur, name, len); cur += len; + *cur++ = ' '; +} + +packet &packet::operator <<(const ber32 v) +{ + enum { maxlen = 32 / 7 + 1}; + uint8 buf[maxlen]; + uint8 *p = buf + maxlen; + uint32 val = v.val; + + *--p = val & 0x7F; + + while (val > 0x7F) + { + val >>= 7; + *--p = (val & 0x7F) | 0x80; + } + + return *this << data (p, buf + maxlen - p); +} + packet &packet::operator <<(const data &v) { if (room () < v.len) @@ -530,38 +584,3 @@ cur += len; } -/****************************************************************************** - * - * statistics logging functions. - * - ******************************************************************************/ - -#ifdef CS_LOGSTATS - -/* cst_tot is for the life of the server, cst_last is for the last series of - * stats - */ -CS_Stats cst_tot, cst_lst; - -/** - * Writes out the gathered stats. We clear cst_lst. - */ -void -write_cs_stats (void) -{ - time_t now = time (NULL); - - /* If no connections recently, don't both to log anything */ - if (cst_lst.ibytes == 0 && cst_lst.obytes == 0) - return; - - /* CSSTAT is put in so scripts can easily find the line */ - LOG (llevInfo, "CSSTAT: %.16s tot %d %d %d %d inc %d %d %d %d\n", - ctime (&now), cst_tot.ibytes, cst_tot.obytes, cst_tot.max_conn, - now - cst_tot.time_start, cst_lst.ibytes, cst_lst.obytes, cst_lst.max_conn, now - cst_lst.time_start); - cst_lst.ibytes = 0; - cst_lst.obytes = 0; - cst_lst.time_start = now; -} -#endif -