X-Git-Url: https://code.citadel.org/?a=blobdiff_plain;f=citadel%2Fsysdep.c;h=3caa2dcfc004dfa3573ba19c30f2844ce70dfeb4;hb=6e9fd5f635b9eccd27c91f22b4d8690279e6c20d;hp=31a9c7ba150b732ffd594a8ae037aacd7dde9960;hpb=08694b02c52fb52ad307eea9368b07a88c964114;p=citadel.git diff --git a/citadel/sysdep.c b/citadel/sysdep.c index 31a9c7ba1..3caa2dcfc 100644 --- a/citadel/sysdep.c +++ b/citadel/sysdep.c @@ -1,122 +1,90 @@ -/* - * Citadel "system dependent" stuff. - * - * Here's where we (hopefully) have most parts of the Citadel server that - * would need to be altered to run the server in a non-POSIX environment. - * - * If we ever port to a different platform and either have multiple - * variants of this file or simply load it up with #ifdefs. - * - * Copyright (c) 1987-2011 by the citadel.org team - * - * This program is open source 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, write to the Free Software - * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA - */ +// Citadel "system dependent" stuff. +// +// Here's where we (hopefully) have most parts of the Citadel server that +// might need tweaking when run on different operating system variants. +// +// Copyright (c) 1987-2021 by the citadel.org team +// +// This program is open source software; you can redistribute it and/or modify +// it under the terms of the GNU General Public License, version 3. +// +// 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. #include "sysdep.h" #include #include -#include -#include -#include -#include -#include #include -#include -#include +#include +#include +#include #include #include - -#if TIME_WITH_SYS_TIME -# include -# include -#else -# if HAVE_SYS_TIME_H -# include -# else -# include -# endif -#endif - -#include -#include +#include +#include +#include +#include +#include #include +#include #include #include -#include -#include -#include -#include -#include -#include -#include #define SHOW_ME_VAPPEND_PRINTF #include -#include "citadel.h" -#include "server.h" -#include "sysdep_decls.h" #include "citserver.h" -#include "support.h" #include "config.h" -#include "database.h" +#include "ctdl_module.h" +#include "sysdep_decls.h" +#include "modules/crypto/serv_crypto.h" // Needed for init_ssl, client_write_ssl, client_read_ssl, destruct_ssl #include "housekeeping.h" -#include "modules/crypto/serv_crypto.h" /* Needed for init_ssl, client_write_ssl, client_read_ssl, destruct_ssl */ -#include "ecrash.h" #include "context.h" -#ifdef HAVE_SYS_SELECT_H -#include -#endif - -#ifndef HAVE_SNPRINTF -#include "snprintf.h" -#endif - -#include "ctdl_module.h" -#include "threads.h" -#include "user_ops.h" -#include "control.h" - - -/* - * Signal handler to shut down the server. - */ - +// Signal handler to shut down the server. volatile int exit_signal = 0; volatile int shutdown_and_halt = 0; volatile int restart_server = 0; volatile int running_as_daemon = 0; + static RETSIGTYPE signal_cleanup(int signum) { - syslog(LOG_DEBUG, "Caught signal %d; shutting down.", signum); + syslog(LOG_DEBUG, "sysdep: caught signal %d - backtrace follows:", signum); + + void *bt[1024]; + int bt_size; + char **bt_syms; + int i; + FILE *backtrace_fp = NULL; + + if (backtrace_filename != NULL) { + backtrace_fp = fopen(backtrace_filename, "w"); + } + + bt_size = backtrace(bt, 1024); + bt_syms = backtrace_symbols(bt, bt_size); + for (i = 1; i < bt_size; i++) { + syslog(LOG_DEBUG, "%s", bt_syms[i]); + if (backtrace_fp) { + fprintf(backtrace_fp, "%s\n", bt_syms[i]); + } + } + free(bt_syms); + + if (backtrace_fp) { + fclose(backtrace_fp); + } + exit_signal = signum; server_shutting_down = 1; } -static RETSIGTYPE signal_exit(int signum) { - exit(1); -} - - -/* - * Some initialization stuff... - */ +// Some initialization stuff... void init_sysdep(void) { sigset_t set; - /* Avoid vulnerabilities related to FD_SETSIZE if we can. */ + // Avoid vulnerabilities related to FD_SETSIZE if we can. #ifdef FD_SETSIZE #ifdef RLIMIT_NOFILE struct rlimit rl; @@ -127,55 +95,48 @@ void init_sysdep(void) { #endif #endif - /* If we've got OpenSSL, we're going to use it. */ + // If we've got OpenSSL, we're going to use it. #ifdef HAVE_OPENSSL init_ssl(); #endif - /* - * Set up a place to put thread-specific data. - * We only need a single pointer per thread - it points to the - * CitContext structure (in the ContextList linked list) of the - * session to which the calling thread is currently bound. - */ - if (pthread_key_create(&MyConKey, NULL) != 0) { - syslog(LOG_CRIT, "Can't create TSD key: %s", strerror(errno)); + if (pthread_key_create(&ThreadKey, NULL) != 0) { // TSD for threads + syslog(LOG_ERR, "pthread_key_create() : %m"); + abort(); + } + + if (pthread_key_create(&MyConKey, NULL) != 0) { // TSD for sessions + syslog(LOG_CRIT, "sysdep: can't create TSD key: %m"); + abort(); } - /* - * Interript, hangup, and terminate signals should cause the server - * to gracefully clean up and shut down. - */ + // Interript, hangup, and terminate signals should cause the server to shut down. sigemptyset(&set); sigaddset(&set, SIGINT); sigaddset(&set, SIGHUP); sigaddset(&set, SIGTERM); + sigaddset(&set, SIGSEGV); sigprocmask(SIG_UNBLOCK, &set, NULL); signal(SIGINT, signal_cleanup); signal(SIGHUP, signal_cleanup); signal(SIGTERM, signal_cleanup); - signal(SIGUSR2, signal_exit); + signal(SIGSEGV, signal_cleanup); - /* - * Do not shut down the server on broken pipe signals, otherwise the - * whole Citadel service would come down whenever a single client - * socket breaks. - */ + // Do not shut down the server on broken pipe signals, otherwise the + // whole Citadel service would come down whenever a single client + // socket breaks. signal(SIGPIPE, SIG_IGN); } -/* - * This is a generic function to set up a master socket for listening on - * a TCP port. The server shuts down if the bind fails. (IPv4/IPv6 version) - * - * ip_addr IP address to bind - * port_number port number to bind - * queue_len number of incoming connections to allow in the queue - */ -int ctdl_tcp_server(char *ip_addr, int port_number, int queue_len, char *errormessage) -{ +// This is a generic function to set up a master socket for listening on +// a TCP port. The server shuts down if the bind fails. (IPv4/IPv6 version) +// +// ip_addr IP address to bind +// port_number port number to bind +// queue_len number of incoming connections to allow in the queue +int ctdl_tcp_server(char *ip_addr, int port_number, int queue_len) { struct protoent *p; struct sockaddr_in6 sin6; struct sockaddr_in sin4; @@ -187,60 +148,54 @@ int ctdl_tcp_server(char *ip_addr, int port_number, int queue_len, char *errorme sin6.sin6_family = AF_INET6; sin4.sin_family = AF_INET; - if ( (ip_addr == NULL) /* any IPv6 */ + if ( (ip_addr == NULL) // any IPv6 || (IsEmptyStr(ip_addr)) || (!strcmp(ip_addr, "*")) ) { ip_version = 6; sin6.sin6_addr = in6addr_any; } - else if (!strcmp(ip_addr, "0.0.0.0")) /* any IPv4 */ + else if (!strcmp(ip_addr, "0.0.0.0")) // any IPv4 { ip_version = 4; sin4.sin_addr.s_addr = INADDR_ANY; } - else if ((strchr(ip_addr, '.')) && (!strchr(ip_addr, ':'))) /* specific IPv4 */ + else if ((strchr(ip_addr, '.')) && (!strchr(ip_addr, ':'))) // specific IPv4 { ip_version = 4; if (inet_pton(AF_INET, ip_addr, &sin4.sin_addr) <= 0) { - snprintf(errormessage, SIZ, - "Error binding to [%s] : %s", ip_addr, strerror(errno) - ); - syslog(LOG_ALERT, "%s", errormessage); + syslog(LOG_ALERT, "tcpserver: inet_pton: %m"); return (-1); } } - else /* specific IPv6 */ + else // specific IPv6 { ip_version = 6; if (inet_pton(AF_INET6, ip_addr, &sin6.sin6_addr) <= 0) { - snprintf(errormessage, SIZ, - "Error binding to [%s] : %s", ip_addr, strerror(errno) - ); - syslog(LOG_ALERT, "%s", errormessage); + syslog(LOG_ALERT, "tcpserver: inet_pton: %m"); return (-1); } } if (port_number == 0) { - snprintf(errormessage, SIZ, "Can't start: no port number specified."); - syslog(LOG_ALERT, "%s", errormessage); + syslog(LOG_ALERT, "tcpserver: no port number was specified"); return (-1); } sin6.sin6_port = htons((u_short) port_number); sin4.sin_port = htons((u_short) port_number); p = getprotobyname("tcp"); + if (p == NULL) { + syslog(LOG_ALERT, "tcpserver: getprotobyname: %m"); + return (-1); + } s = socket( ((ip_version == 6) ? PF_INET6 : PF_INET), SOCK_STREAM, (p->p_proto)); if (s < 0) { - snprintf(errormessage, SIZ, - "Can't create a listening socket: %s", strerror(errno) - ); - syslog(LOG_ALERT, "%s", errormessage); + syslog(LOG_ALERT, "tcpserver: socket: %m"); return (-1); } - /* Set some socket options that make sense. */ + // Set some socket options that make sense. i = 1; setsockopt(s, SOL_SOCKET, SO_REUSEADDR, &i, sizeof(i)); @@ -252,34 +207,22 @@ int ctdl_tcp_server(char *ip_addr, int port_number, int queue_len, char *errorme } if (b < 0) { - snprintf(errormessage, SIZ, - "Can't bind: %s", strerror(errno) - ); - syslog(LOG_ALERT, "%s", errormessage); + syslog(LOG_ALERT, "tcpserver: bind: %m"); return (-1); } fcntl(s, F_SETFL, O_NONBLOCK); if (listen(s, ((queue_len >= 5) ? queue_len : 5) ) < 0) { - snprintf(errormessage, SIZ, - "Can't listen: %s", strerror(errno) - ); - syslog(LOG_ALERT, "%s", errormessage); + syslog(LOG_ALERT, "tcpserver: listen: %m"); return (-1); } return (s); } - - - -/* - * Create a Unix domain socket and listen on it - */ -int ctdl_uds_server(char *sockpath, int queue_len, char *errormessage) -{ +// Create a Unix domain socket and listen on it +int ctdl_uds_server(char *sockpath, int queue_len) { struct sockaddr_un addr; int s; int i; @@ -293,10 +236,7 @@ int ctdl_uds_server(char *sockpath, int queue_len, char *errormessage) i = unlink(sockpath); if ((i != 0) && (errno != ENOENT)) { - snprintf(errormessage, SIZ, "citserver: can't unlink %s: %s", - sockpath, strerror(errno) - ); - syslog(LOG_EMERG, "%s", errormessage); + syslog(LOG_ERR, "udsserver: %m"); return(-1); } @@ -306,36 +246,24 @@ int ctdl_uds_server(char *sockpath, int queue_len, char *errormessage) s = socket(AF_UNIX, SOCK_STREAM, 0); if (s < 0) { - snprintf(errormessage, SIZ, - "citserver: Can't create a socket: %s", - strerror(errno)); - syslog(LOG_EMERG, "%s", errormessage); + syslog(LOG_ERR, "udsserver: socket: %m"); return(-1); } if (bind(s, (struct sockaddr *)&addr, sizeof(addr)) < 0) { - snprintf(errormessage, SIZ, - "citserver: Can't bind: %s", - strerror(errno)); - syslog(LOG_EMERG, "%s", errormessage); + syslog(LOG_ERR, "udsserver: bind: %m"); return(-1); } - /* set to nonblock - we need this for some obscure situations */ + // set to nonblock - we need this for some obscure situations if (fcntl(s, F_SETFL, O_NONBLOCK) < 0) { - snprintf(errormessage, SIZ, - "citserver: Can't set socket to non-blocking: %s", - strerror(errno)); - syslog(LOG_EMERG, "%s", errormessage); + syslog(LOG_ERR, "udsserver: fcntl: %m"); close(s); return(-1); } if (listen(s, actual_queue_len) < 0) { - snprintf(errormessage, SIZ, - "citserver: Can't listen: %s", - strerror(errno)); - syslog(LOG_EMERG, "%s", errormessage); + syslog(LOG_ERR, "udsserver: listen: %m"); return(-1); } @@ -348,11 +276,8 @@ int ctdl_uds_server(char *sockpath, int queue_len, char *errormessage) } - -/* - * The following functions implement output buffering on operating systems which - * support it (such as Linux and various BSD flavors). - */ +// The following functions implement output buffering on operating systems which +// support it (such as Linux and various BSD flavors). #ifndef HAVE_DARWIN #ifdef TCP_CORK # define HAVE_TCP_BUFFERING @@ -361,8 +286,8 @@ int ctdl_uds_server(char *sockpath, int queue_len, char *errormessage) # define HAVE_TCP_BUFFERING # define TCP_CORK TCP_NOPUSH # endif -#endif /* TCP_CORK */ -#endif /* HAVE_DARWIN */ +#endif // TCP_CORK +#endif // HAVE_DARWIN static unsigned on = 1, off = 0; @@ -392,38 +317,20 @@ void flush_output(void) { #endif } -/* -static void flush_client_inbuf(void) -{ - CitContext *CCC=CC; - - FlushStrBuf(CCC->ReadBuf); - CCC->RecvBuf->ReadWritePointer = NULL; - -} -*/ - -/* - * client_close() ... close the client socket - */ +// close the client socket void client_close(void) { CitContext *CCC = CC; if (!CCC) return; if (CCC->client_socket <= 0) return; - syslog(LOG_DEBUG, "Closing socket %d", CCC->client_socket); - + syslog(LOG_DEBUG, "sysdep: closing socket %d", CCC->client_socket); close(CCC->client_socket); CCC->client_socket = -1 ; } - - -/* - * client_write() ... Send binary data to the client. - */ +// Send binary data to the client. int client_write(const char *buf, int nbytes) { int bytes_written = 0; @@ -439,26 +346,6 @@ int client_write(const char *buf, int nbytes) Ctx = CC; -#ifdef BIGBAD_IODBG - { - int rv = 0; - char fn [SIZ]; - FILE *fd; - - snprintf(fn, SIZ, "/tmp/foolog_%s.%d", Ctx->ServiceName, Ctx->cs_pid); - - fd = fopen(fn, "a+"); - if (fd) - { - fprintf(fd, "Sending: BufSize: %d BufContent: [", - nbytes); - rv = fwrite(buf, nbytes, 1, fd); - fprintf(fd, "]\n"); - fclose(fd); - } - } -#endif -// flush_client_inbuf(); if (Ctx->redirect_buffer != NULL) { StrBufAppendBufPlain(Ctx->redirect_buffer, buf, nbytes, 0); @@ -482,23 +369,16 @@ int client_write(const char *buf, int nbytes) if (select(1, NULL, &wset, NULL, NULL) == -1) { if (errno == EINTR) { - syslog(LOG_DEBUG, "client_write(%d bytes) select() interrupted.", - nbytes-bytes_written - ); + syslog(LOG_DEBUG, "sysdep: client_write(%d bytes) select() interrupted.", nbytes-bytes_written); if (server_shutting_down) { CC->kill_me = KILLME_SELECT_INTERRUPTED; return (-1); } else { - /* can't trust fd's and stuff so we need to re-create them */ + // can't trust fd's and stuff so we need to re-create them continue; } } else { - syslog(LOG_ERR, - "client_write(%d bytes) select failed: %s (%d)", - nbytes - bytes_written, - strerror(errno), errno - ); - cit_backtrace(); + syslog(LOG_ERR, "sysdep: client_write(%d bytes) select failed: %m", nbytes - bytes_written); client_close(); Ctx->kill_me = KILLME_SELECT_FAILED; return -1; @@ -508,12 +388,7 @@ int client_write(const char *buf, int nbytes) retval = write(Ctx->client_socket, &buf[bytes_written], nbytes - bytes_written); if (retval < 1) { - syslog(LOG_ERR, - "client_write(%d bytes) failed: %s (%d)", - nbytes - bytes_written, - strerror(errno), errno - ); - cit_backtrace(); + syslog(LOG_ERR, "sysdep: client_write(%d bytes) failed: %m", nbytes - bytes_written); client_close(); Ctx->kill_me = KILLME_WRITE_FAILED; return -1; @@ -528,10 +403,8 @@ void cputbuf(const StrBuf *Buf) { } -/* - * cprintf() Send formatted printable data to the client. - * Implemented in terms of client_write() so it's technically not sysdep... - */ +// Send formatted printable data to the client. +// Implemented in terms of client_write() so it's technically not sysdep... void cprintf(const char *format, ...) { va_list arg_ptr; char buf[1024]; @@ -541,82 +414,35 @@ void cprintf(const char *format, ...) { buf[sizeof buf - 2] = '\n'; client_write(buf, strlen(buf)); va_end(arg_ptr); -} +} -/* - * Read data from the client socket. - * - * sock socket fd to read from - * buf buffer to read into - * bytes number of bytes to read - * timeout Number of seconds to wait before timing out - * - * Possible return values: - * 1 Requested number of bytes has been read. - * 0 Request timed out. - * -1 Connection is broken, or other error. - */ -int client_read_blob(StrBuf *Target, int bytes, int timeout) -{ +// Read data from the client socket. +// +// sock socket fd to read from +// buf buffer to read into +// bytes number of bytes to read +// timeout Number of seconds to wait before timing out +// +// Possible return values: +// 1 Requested number of bytes has been read. +// 0 Request timed out. +// -1 Connection is broken, or other error. +int client_read_blob(StrBuf *Target, int bytes, int timeout) { CitContext *CCC=CC; const char *Error; int retval = 0; #ifdef HAVE_OPENSSL if (CCC->redirect_ssl) { -#ifdef BIGBAD_IODBG - int rv = 0; - char fn [SIZ]; - FILE *fd; - - snprintf(fn, SIZ, "/tmp/foolog_%s.%d", CCC->ServiceName, CCC->cs_pid); - - fd = fopen(fn, "a+"); - fprintf(fd, "Reading BLOB: BufSize: %d ", - bytes); - rv = fwrite(ChrPtr(Target), StrLength(Target), 1, fd); - fprintf(fd, "]\n"); - - - fclose(fd); -#endif retval = client_read_sslblob(Target, bytes, timeout); if (retval < 0) { - syslog(LOG_CRIT, "client_read_blob() failed"); + syslog(LOG_ERR, "sysdep: client_read_blob() failed"); } -#ifdef BIGBAD_IODBG - snprintf(fn, SIZ, "/tmp/foolog_%s.%d", CCC->ServiceName, CCC->cs_pid); - - fd = fopen(fn, "a+"); - fprintf(fd, "Read: %d BufContent: [", - StrLength(Target)); - rv = fwrite(ChrPtr(Target), StrLength(Target), 1, fd); - fprintf(fd, "]\n"); - - - fclose(fd); -#endif } else #endif { -#ifdef BIGBAD_IODBG - int rv = 0; - char fn [SIZ]; - FILE *fd; - - snprintf(fn, SIZ, "/tmp/foolog_%s.%d", CCC->ServiceName, CCC->cs_pid); - - fd = fopen(fn, "a+"); - fprintf(fd, "Reading BLOB: BufSize: %d ", - bytes); - rv = fwrite(ChrPtr(Target), StrLength(Target), 1, fd); - fprintf(fd, "]\n"); - - - fclose(fd); -#endif retval = StrBufReadBLOBBuffered(Target, CCC->RecvBuf.Buf, &CCC->RecvBuf.ReadWritePointer, @@ -624,31 +450,20 @@ int client_read_blob(StrBuf *Target, int bytes, int timeout) 1, bytes, O_TERM, - &Error); + &Error + ); if (retval < 0) { - syslog(LOG_CRIT, "client_read_blob() failed: %s", Error); + syslog(LOG_ERR, "sysdep: client_read_blob() failed: %s", Error); client_close(); return retval; } -#ifdef BIGBAD_IODBG - snprintf(fn, SIZ, "/tmp/foolog_%s.%d", CCC->ServiceName, CCC->cs_pid); - - fd = fopen(fn, "a+"); - fprintf(fd, "Read: %d BufContent: [", - StrLength(Target)); - rv = fwrite(ChrPtr(Target), StrLength(Target), 1, fd); - fprintf(fd, "]\n"); - fclose(fd); -#endif } return retval; } -/* - * to make client_read_random_blob() more efficient, increase buffer size. - * just use in greeting function, else your buffer may be flushed - */ +// to make client_read_random_blob() more efficient, increase buffer size. +// just use in greeting function, else your buffer may be flushed void client_set_inbound_buf(long N) { CitContext *CCC=CC; @@ -679,25 +494,6 @@ int client_read_random_blob(StrBuf *Target, int timeout) StrBufAppendBufPlain(Target, pch, len, 0); FlushStrBuf(CCC->RecvBuf.Buf); CCC->RecvBuf.ReadWritePointer = NULL; -#ifdef BIGBAD_IODBG - { - int rv = 0; - char fn [SIZ]; - FILE *fd; - - snprintf(fn, SIZ, "/tmp/foolog_%s.%d", CCC->ServiceName, CCC->cs_pid); - - fd = fopen(fn, "a+"); - fprintf(fd, "Read: BufSize: %d BufContent: [", - StrLength(Target)); - rv = fwrite(ChrPtr(Target), StrLength(Target), 1, fd); - fprintf(fd, "]\n"); - - - fclose(fd); - } -#endif - return StrLength(Target); } return rc; @@ -728,8 +524,7 @@ int client_read_to(char *buf, int bytes, int timeout) } -int HaveMoreLinesWaiting(CitContext *CCC) -{ +int HaveMoreLinesWaiting(CitContext *CCC) { if ((CCC->kill_me != 0) || ( (CCC->RecvBuf.ReadWritePointer == NULL) && (StrLength(CCC->RecvBuf.Buf) == 0) && @@ -740,18 +535,14 @@ int HaveMoreLinesWaiting(CitContext *CCC) } -/* - * Read data from the client socket with default timeout. - * (This is implemented in terms of client_read_to() and could be - * justifiably moved out of sysdep.c) - */ -INLINE int client_read(char *buf, int bytes) -{ - return(client_read_to(buf, bytes, config.c_sleeping)); +// Read data from the client socket with default timeout. +// (This is implemented in terms of client_read_to() and could be +// justifiably moved out of sysdep.c) +INLINE int client_read(char *buf, int bytes) { + return(client_read_to(buf, bytes, CtdlGetConfigInt("c_sleeping"))); } -int CtdlClientGetLine(StrBuf *Target) -{ +int CtdlClientGetLine(StrBuf *Target) { CitContext *CCC=CC; const char *Error; int rc; @@ -759,126 +550,29 @@ int CtdlClientGetLine(StrBuf *Target) FlushStrBuf(Target); #ifdef HAVE_OPENSSL if (CCC->redirect_ssl) { -#ifdef BIGBAD_IODBG - char fn [SIZ]; - FILE *fd; - int len = 0; - int rlen = 0; - int nlen = 0; - int nrlen = 0; - const char *pch; - - snprintf(fn, SIZ, "/tmp/foolog_%s.%d", CCC->ServiceName, CCC->cs_pid); - - fd = fopen(fn, "a+"); - pch = ChrPtr(CCC->RecvBuf.Buf); - len = StrLength(CCC->RecvBuf.Buf); - if (CCC->RecvBuf.ReadWritePointer != NULL) - rlen = CCC->RecvBuf.ReadWritePointer - pch; - else - rlen = 0; - -/* fprintf(fd, "\n\n\nBufSize: %d BufPos: %d \nBufContent: [%s]\n\n_____________________\n", - len, rlen, pch); -*/ - fprintf(fd, "\n\n\nSSL1: BufSize: %d BufPos: %d \n_____________________\n", - len, rlen); -#endif - rc = client_readline_sslbuffer(Target, - CCC->RecvBuf.Buf, - &CCC->RecvBuf.ReadWritePointer, - 1); -#ifdef BIGBAD_IODBG - pch = ChrPtr(CCC->RecvBuf.Buf); - nlen = StrLength(CCC->RecvBuf.Buf); - if (CCC->RecvBuf.ReadWritePointer != NULL) - nrlen = CCC->RecvBuf.ReadWritePointer - pch; - else - nrlen = 0; -/* - fprintf(fd, "\n\n\nBufSize: was: %d is: %d BufPos: was: %d is: %d \nBufContent: [%s]\n\n_____________________\n", - len, nlen, rlen, nrlen, pch); -*/ - fprintf(fd, "\n\n\nSSL2: BufSize: was: %d is: %d BufPos: was: %d is: %d \n", - len, nlen, rlen, nrlen); - - fprintf(fd, "SSL3: Read: BufSize: %d BufContent: [%s]\n\n*************\n", - StrLength(Target), ChrPtr(Target)); - fclose(fd); - - if (rc < 0) { - syslog(LOG_CRIT, "CtdlClientGetLine() failed"); - } -#endif + rc = client_readline_sslbuffer(Target, CCC->RecvBuf.Buf, &CCC->RecvBuf.ReadWritePointer, 1); return rc; } else #endif { -#ifdef BIGBAD_IODBG - char fn [SIZ]; - FILE *fd; - int len, rlen, nlen, nrlen; - const char *pch; - - snprintf(fn, SIZ, "/tmp/foolog_%s.%d", CCC->ServiceName, CCC->cs_pid); - - fd = fopen(fn, "a+"); - pch = ChrPtr(CCC->RecvBuf.Buf); - len = StrLength(CCC->RecvBuf.Buf); - if (CCC->RecvBuf.ReadWritePointer != NULL) - rlen = CCC->RecvBuf.ReadWritePointer - pch; - else - rlen = 0; - -/* fprintf(fd, "\n\n\nBufSize: %d BufPos: %d \nBufContent: [%s]\n\n_____________________\n", - len, rlen, pch); -*/ - fprintf(fd, "\n\n\nBufSize: %d BufPos: %d \n_____________________\n", - len, rlen); -#endif rc = StrBufTCP_read_buffered_line_fast(Target, CCC->RecvBuf.Buf, &CCC->RecvBuf.ReadWritePointer, &CCC->client_socket, 5, 1, - &Error); - -#ifdef BIGBAD_IODBG - pch = ChrPtr(CCC->RecvBuf.Buf); - nlen = StrLength(CCC->RecvBuf.Buf); - if (CCC->RecvBuf.ReadWritePointer != NULL) - nrlen = CCC->RecvBuf.ReadWritePointer - pch; - else - nrlen = 0; -/* - fprintf(fd, "\n\n\nBufSize: was: %d is: %d BufPos: was: %d is: %d \nBufContent: [%s]\n\n_____________________\n", - len, nlen, rlen, nrlen, pch); -*/ - fprintf(fd, "\n\n\nBufSize: was: %d is: %d BufPos: was: %d is: %d \n", - len, nlen, rlen, nrlen); - - fprintf(fd, "Read: BufSize: %d BufContent: [%s]\n\n*************\n", - StrLength(Target), ChrPtr(Target)); - fclose(fd); - - if ((rc < 0) && (Error != NULL)) { - syslog(LOG_CRIT, "CtdlClientGetLine() failed: %s", Error); - } -#endif + &Error + ); return rc; } } -/* - * client_getln() ... Get a LF-terminated line of text from the client. - * (This is implemented in terms of client_read() and could be - * justifiably moved out of sysdep.c) - */ -int client_getln(char *buf, int bufsize) -{ +// Get a LF-terminated line of text from the client. +// (This is implemented in terms of client_read() and could be +// justifiably moved out of sysdep.c) +int client_getln(char *buf, int bufsize) { int i, retval; CitContext *CCC=CC; const char *pCh; @@ -890,8 +584,7 @@ int client_getln(char *buf, int bufsize) i = StrLength(CCC->MigrateBuf); pCh = ChrPtr(CCC->MigrateBuf); - /* Strip the trailing LF, and the trailing CR if present. - */ + // Strip the trailing LF, and the trailing CR if present. if (bufsize <= i) i = bufsize - 1; while ( (i > 0) @@ -910,34 +603,50 @@ int client_getln(char *buf, int bufsize) } -/* - * Cleanup any contexts that are left lying around - */ - - -void close_masters (void) -{ +// Cleanup any contexts that are left lying around +void close_masters(void) { struct ServiceFunctionHook *serviceptr; - - /* - * close all protocol master sockets - */ + const char *Text; + + // close all protocol master sockets for (serviceptr = ServiceHookTable; serviceptr != NULL; serviceptr = serviceptr->next ) { - if (serviceptr->tcp_port > 0) - { - syslog(LOG_INFO, "Closing listener on port %d\n", - serviceptr->tcp_port); + if (serviceptr->tcp_port > 0) { + if (serviceptr->msock == -1) { + Text = "not closing again"; + } + else { + Text = "Closing"; + } + syslog(LOG_INFO, "sysdep: %s %d listener on port %d", + Text, + serviceptr->msock, + serviceptr->tcp_port + ); serviceptr->tcp_port = 0; } - if (serviceptr->sockpath != NULL) - syslog(LOG_INFO, "Closing listener on '%s'\n", - serviceptr->sockpath); + if (serviceptr->sockpath != NULL) { + if (serviceptr->msock == -1) { + Text = "not closing again"; + } + else { + Text = "Closing"; + } + syslog(LOG_INFO, "sysdep: %s %d listener on '%s'", + Text, + serviceptr->msock, + serviceptr->sockpath + ); + } - close(serviceptr->msock); - /* If it's a Unix domain socket, remove the file. */ + if (serviceptr->msock != -1) { + close(serviceptr->msock); + serviceptr->msock = -1; + } + + // If it's a Unix domain socket, remove the file. if (serviceptr->sockpath != NULL) { unlink(serviceptr->sockpath); serviceptr->sockpath = NULL; @@ -946,33 +655,13 @@ void close_masters (void) } -/* - * The system-dependent part of master_cleanup() - close the master socket. - */ +// The system-dependent part of master_cleanup() - close the master socket. void sysdep_master_cleanup(void) { - close_masters(); - context_cleanup(); - #ifdef HAVE_OPENSSL destruct_ssl(); #endif - CtdlDestroyProtoHooks(); - CtdlDestroyDeleteHooks(); - CtdlDestroyXmsgHooks(); - CtdlDestroyNetprocHooks(); - CtdlDestroyUserHooks(); - CtdlDestroyMessageHook(); - CtdlDestroyCleanupHooks(); - CtdlDestroyFixedOutputHooks(); - CtdlDestroySessionHooks(); - CtdlDestroyServiceHook(); - CtdlDestroyRoomHooks(); - CtdlDestroySearchHooks(); - #ifdef HAVE_BACKTRACE -/// eCrash_Uninit(); - #endif } @@ -988,26 +677,17 @@ int nFireUps = 0; int nFireUpsNonRestart = 0; pid_t ForkedPid = 1; -/* - * Start running as a daemon. - */ +// Start running as a daemon. void start_daemon(int unused) { int status = 0; pid_t child = 0; FILE *fp; int do_restart = 0; - current_child = 0; - /* Close stdin/stdout/stderr and replace them with /dev/null. - * We don't just call close() because we don't want these fd's - * to be reused for other files. - */ - if (chdir(ctdl_run_dir) != 0) - syslog(LOG_EMERG, - "unable to change into directory [%s]: %s", - ctdl_run_dir, strerror(errno)); - + // Close stdin/stdout/stderr and replace them with /dev/null. + // We don't just call close() because we don't want these fd's + // to be reused for other files. child = fork(); if (child != 0) { exit(0); @@ -1019,28 +699,23 @@ void start_daemon(int unused) { setsid(); umask(0); - if ((freopen("/dev/null", "r", stdin) != stdin) || - (freopen("/dev/null", "w", stdout) != stdout) || - (freopen("/dev/null", "w", stderr) != stderr)) - syslog(LOG_EMERG, - "unable to reopen stdin/out/err %s", - strerror(errno)); - + if ( (freopen("/dev/null", "r", stdin) != stdin) || + (freopen("/dev/null", "w", stdout) != stdout) || + (freopen("/dev/null", "w", stderr) != stderr) + ) { + syslog(LOG_ERR, "sysdep: unable to reopen stdio: %m"); + } do { current_child = fork(); - signal(SIGTERM, graceful_shutdown); - if (current_child < 0) { perror("fork"); exit(errno); } - else if (current_child == 0) { - return; /* continue starting citadel. */ + return; // continue starting citadel. } - else { fp = fopen(file_pid_file, "w"); if (fp != NULL) { @@ -1049,20 +724,19 @@ void start_daemon(int unused) { } waitpid(current_child, &status, 0); } - do_restart = 0; nFireUpsNonRestart = nFireUps; - /* Exit code 0 means the watcher should exit */ + // Exit code 0 means the watcher should exit if (WIFEXITED(status) && (WEXITSTATUS(status) == CTDLEXIT_SHUTDOWN)) { do_restart = 0; } - /* Exit code 101-109 means the watcher should exit */ + // Exit code 101-109 means the watcher should exit else if (WIFEXITED(status) && (WEXITSTATUS(status) >= 101) && (WEXITSTATUS(status) <= 109)) { do_restart = 0; } - /* Any other exit code, or no exit code, means we should restart. */ + // Any other exit code, or no exit code, means we should restart. else { do_restart = 1; nFireUps++; @@ -1076,15 +750,11 @@ void start_daemon(int unused) { } - -void checkcrash(void) -{ - if (nFireUpsNonRestart != nFireUps) - { +void checkcrash(void) { + if (nFireUpsNonRestart != nFireUps) { StrBuf *CrashMail; - CrashMail = NewStrBuf(); - syslog(LOG_ALERT, "Posting crash message\n"); + syslog(LOG_ALERT, "sysdep: posting crash message"); StrBufPrintf(CrashMail, " \n" " The Citadel server process (citserver) terminated unexpectedly." @@ -1093,7 +763,7 @@ void checkcrash(void) "factor.\n \n" " You can obtain more information about this by enabling core dumps.\n \n" " For more information, please see:\n \n" - " http://citadel.org/doku.php/faq:mastering_your_os:gdb#how.do.i.make.my.system.produce.core-files" + " http://citadel.org/doku.php?id=faq:mastering_your_os:gdb#how.do.i.make.my.system.produce.core-files" "\n \n" " If you have already done this, the core dump is likely to be found at %score.%d\n" @@ -1105,13 +775,11 @@ void checkcrash(void) } -/* - * Generic routine to convert a login name to a full name (gecos) - * Returns nonzero if a conversion took place - */ +// Generic routine to convert a login name to a full name (gecos) +// Returns nonzero if a conversion took place int convert_login(char NameToConvert[]) { struct passwd *pw; - int a; + unsigned int a; pw = getpwnam(NameToConvert); if (pw == NULL) { @@ -1127,10 +795,77 @@ int convert_login(char NameToConvert[]) { } +void HuntBadSession(void) { + int highest; + CitContext *ptr; + fd_set readfds; + struct timeval tv; + struct ServiceFunctionHook *serviceptr; + + // Next, add all of the client sockets + begin_critical_section(S_SESSION_TABLE); + for (ptr = ContextList; ptr != NULL; ptr = ptr->next) { + if ((ptr->state == CON_SYS) && (ptr->client_socket == 0)) + continue; + // Initialize the fdset. + FD_ZERO(&readfds); + highest = 0; + tv.tv_sec = 0; // wake up every second if no input + tv.tv_usec = 0; + + // Don't select on dead sessions, only truly idle ones + if ( (ptr->state == CON_IDLE) + && (ptr->kill_me == 0) + && (ptr->client_socket > 0) + ) { + FD_SET(ptr->client_socket, &readfds); + if (ptr->client_socket > highest) + highest = ptr->client_socket; + + if ((select(highest + 1, &readfds, NULL, NULL, &tv) < 0) && (errno == EBADF)) + { + // Gotcha! + syslog(LOG_ERR, + "sysdep: killing session CC[%d] bad FD: [%d] User[%s] Host[%s:%s]", + ptr->cs_pid, + ptr->client_socket, + ptr->curr_user, + ptr->cs_host, + ptr->cs_addr + ); + ptr->kill_me = 1; + ptr->client_socket = -1; + break; + } + } + } + end_critical_section(S_SESSION_TABLE); + + // First, add the various master sockets to the fdset. + for (serviceptr = ServiceHookTable; serviceptr != NULL; serviceptr = serviceptr->next ) { + + // Initialize the fdset. + highest = 0; + tv.tv_sec = 0; // wake up every second if no input + tv.tv_usec = 0; + + FD_SET(serviceptr->msock, &readfds); + if (serviceptr->msock > highest) { + highest = serviceptr->msock; + } + if ((select(highest + 1, &readfds, NULL, NULL, &tv) < 0) && + (errno == EBADF)) + { + // Gotcha! server socket dead? commit suicide! + syslog(LOG_ERR, "sysdep: found bad FD: %d and its a server socket! Shutting Down!", serviceptr->msock); + server_shutting_down = 1; + break; + } + } +} + -/* - * This loop just keeps going and going and going... - */ +// This loop just keeps going and going and going... void *worker_thread(void *blah) { int highest; CitContext *ptr; @@ -1139,28 +874,41 @@ void *worker_thread(void *blah) { int retval = 0; struct timeval tv; int force_purge = 0; + struct ServiceFunctionHook *serviceptr; + int ssock; // Descriptor for client socket + CitContext *con = NULL; // Temporary context pointer + int i; + pthread_mutex_lock(&ThreadCountMutex); ++num_workers; + pthread_mutex_unlock(&ThreadCountMutex); while (!server_shutting_down) { - /* make doubly sure we're not holding any stale db handles - * which might cause a deadlock. - */ + // make doubly sure we're not holding any stale db handles which might cause a deadlock cdb_check_handles(); do_select: force_purge = 0; - bind_me = NULL; /* Which session shall we handle? */ + bind_me = NULL; // Which session shall we handle? - /* Initialize the fdset. */ + // Initialize the fdset FD_ZERO(&readfds); highest = 0; + // First, add the various master sockets to the fdset. + for (serviceptr = ServiceHookTable; serviceptr != NULL; serviceptr = serviceptr->next ) { + FD_SET(serviceptr->msock, &readfds); + if (serviceptr->msock > highest) { + highest = serviceptr->msock; + } + } + + // Next, add all of the client sockets. begin_critical_section(S_SESSION_TABLE); for (ptr = ContextList; ptr != NULL; ptr = ptr->next) { if ((ptr->state == CON_SYS) && (ptr->client_socket == 0)) continue; - /* Don't select on dead sessions, only truly idle ones */ + // Don't select on dead sessions, only truly idle ones if ( (ptr->state == CON_IDLE) && (ptr->kill_me == 0) && (ptr->client_socket > 0) @@ -1186,13 +934,12 @@ do_select: force_purge = 0; goto SKIP_SELECT; } - /* If we got this far, it means that there are no sessions - * which a previous thread marked for attention, so we go - * ahead and get ready to select(). - */ + // If we got this far, it means that there are no sessions + // which a previous thread marked for attention, so we go + // ahead and get ready to select(). if (!server_shutting_down) { - tv.tv_sec = 1; /* wake up every second if no input */ + tv.tv_sec = 1; // wake up every second if no input tv.tv_usec = 0; retval = select(highest + 1, &readfds, NULL, NULL, &tv); } @@ -1201,22 +948,19 @@ do_select: force_purge = 0; return NULL; } - /* Now figure out who made this select() unblock. - * First, check for an error or exit condition. - */ + // Now figure out who made this select() unblock. + // First, check for an error or exit condition. if (retval < 0) { if (errno == EBADF) { - syslog(LOG_NOTICE, "select() failed: (%s)\n", strerror(errno)); + syslog(LOG_ERR, "sysdep: select() failed: %m"); + HuntBadSession(); goto do_select; } if (errno != EINTR) { - syslog(LOG_EMERG, "Exiting (%s)\n", strerror(errno)); + syslog(LOG_ERR, "sysdep: exiting: %m"); server_shutting_down = 1; continue; } else { -#if 0 - syslog(LOG_DEBUG, "Interrupted select()\n"); -#endif if (server_shutting_down) { --num_workers; return(NULL); @@ -1231,12 +975,55 @@ do_select: force_purge = 0; } } - /* It must be a client socket. Find a context that has data - * waiting on its socket *and* is in the CON_IDLE state. Any - * active sockets other than our chosen one are marked as - * CON_READY so the next thread that comes around can just bind - * to one without having to select() again. - */ + // Next, check to see if it's a new client connecting on a master socket. + + else if ((retval > 0) && (!server_shutting_down)) for (serviceptr = ServiceHookTable; serviceptr != NULL; serviceptr = serviceptr->next) { + + if (FD_ISSET(serviceptr->msock, &readfds)) { + ssock = accept(serviceptr->msock, NULL, 0); + if (ssock >= 0) { + syslog(LOG_DEBUG, "sysdep: new client socket %d", ssock); + + // The master socket is non-blocking but the client + // sockets need to be blocking, otherwise certain + // operations barf on FreeBSD. Not a fatal error. + if (fcntl(ssock, F_SETFL, 0) < 0) { + syslog(LOG_ERR, "sysdep: Can't set socket to blocking: %m"); + } + + // New context will be created already + // set up in the CON_EXECUTING state. + con = CreateNewContext(); + + // Assign our new socket number to it. + con->tcp_port = serviceptr->tcp_port; + con->client_socket = ssock; + con->h_command_function = serviceptr->h_command_function; + con->h_async_function = serviceptr->h_async_function; + con->h_greeting_function = serviceptr->h_greeting_function; + con->ServiceName = serviceptr->ServiceName; + + // Connections on a local client are always from the same host + if (serviceptr->sockpath != NULL) { + con->is_local_client = 1; + } + + // Set the SO_REUSEADDR socket option + i = 1; + setsockopt(ssock, SOL_SOCKET, SO_REUSEADDR, &i, sizeof(i)); + con->state = CON_GREETING; + retval--; + if (retval == 0) + break; + } + } + } + + // It must be a client socket. Find a context that has data + // waiting on its socket *and* is in the CON_IDLE state. Any + // active sockets other than our chosen one are marked as + // CON_READY so the next thread that comes around can just bind + // to one without having to select() again. begin_critical_section(S_SESSION_TABLE); for (ptr = ContextList; ptr != NULL; ptr = ptr->next) { int checkfd = ptr->client_socket; @@ -1244,7 +1031,7 @@ do_select: force_purge = 0; if (FD_ISSET(checkfd, &readfds)) { ptr->input_waiting = 1; if (!bind_me) { - bind_me = ptr; /* I choose you! */ + bind_me = ptr; // I choose you! bind_me->state = CON_EXECUTING; } else { @@ -1252,7 +1039,7 @@ do_select: force_purge = 0; } } else if ((ptr->is_async) && (ptr->async_waiting) && (ptr->h_async_function)) { if (!bind_me) { - bind_me = ptr; /* I choose you! */ + bind_me = ptr; // I choose you! bind_me->state = CON_EXECUTING; } else { @@ -1264,8 +1051,11 @@ do_select: force_purge = 0; end_critical_section(S_SESSION_TABLE); SKIP_SELECT: - /* We're bound to a session */ + // We're bound to a session + pthread_mutex_lock(&ThreadCountMutex); ++active_workers; + pthread_mutex_unlock(&ThreadCountMutex); + if (bind_me != NULL) { become_session(bind_me); @@ -1274,7 +1064,7 @@ SKIP_SELECT: begin_session(bind_me); bind_me->h_greeting_function(); } - /* If the client has sent a command, execute it. */ + // If the client has sent a command, execute it. if (CC->input_waiting) { CC->h_command_function(); @@ -1284,14 +1074,12 @@ SKIP_SELECT: CC->input_waiting = 0; } - /* If there are asynchronous messages waiting and the - * client supports it, do those now */ - if ((CC->is_async) && (CC->async_waiting) - && (CC->h_async_function != NULL)) { + // If there are asynchronous messages waiting and the client supports it, do those now + if ((CC->is_async) && (CC->async_waiting) && (CC->h_async_function != NULL)) { CC->h_async_function(); CC->async_waiting = 0; } - + force_purge = CC->kill_me; become_session(NULL); bind_me->state = CON_IDLE; @@ -1299,136 +1087,29 @@ SKIP_SELECT: dead_session_purge(force_purge); do_housekeeping(); + + pthread_mutex_lock(&ThreadCountMutex); --active_workers; + if ((active_workers + CtdlGetConfigInt("c_min_workers") < num_workers) && + (num_workers > CtdlGetConfigInt("c_min_workers"))) + { + num_workers--; + pthread_mutex_unlock(&ThreadCountMutex); + return (NULL); + } + pthread_mutex_unlock(&ThreadCountMutex); } - /* If control reaches this point, the server is shutting down */ + // If control reaches this point, the server is shutting down + pthread_mutex_lock(&ThreadCountMutex); --num_workers; + pthread_mutex_unlock(&ThreadCountMutex); return(NULL); } - - -/* - * A function to handle selecting on master sockets. - * In other words it handles new connections. - * It is a thread. - */ -void *select_on_master(void *blah) -{ - struct ServiceFunctionHook *serviceptr; - fd_set master_fds; - int highest; - struct timeval tv; - int ssock; /* Descriptor for client socket */ - CitContext *con = NULL; /* Temporary context pointer */ - int m; - int i; - int retval; - - while (!server_shutting_down) { - /* Initialize the fdset. */ - FD_ZERO(&master_fds); - highest = 0; - - /* First, add the various master sockets to the fdset. */ - for (serviceptr = ServiceHookTable; serviceptr != NULL; - serviceptr = serviceptr->next ) { - m = serviceptr->msock; - FD_SET(m, &master_fds); - if (m > highest) { - highest = m; - } - } - - if (!server_shutting_down) { - tv.tv_sec = 60; /* wake up every second if no input */ - tv.tv_usec = 0; - retval = select(highest + 1, &master_fds, NULL, NULL, &tv); - } - else { - retval = -1 ; - } - - /* Now figure out who made this select() unblock. - * First, check for an error or exit condition. - */ - if (retval < 0) { - if (errno == EBADF) { - syslog(LOG_NOTICE, "select() failed: (%s)\n", - strerror(errno)); - continue; - } - if (errno != EINTR) { - syslog(LOG_EMERG, "Exiting (%s)\n", strerror(errno)); - server_shutting_down = 1; - } else { -#if 0 - syslog(LOG_DEBUG, "Interrupted CtdlThreadSelect.\n"); -#endif - if (server_shutting_down) return(NULL); - continue; - } - } - - /* Next, check to see if it's a new client connecting - * on a master socket. - */ - else if ((retval > 0) && (!server_shutting_down)) for (serviceptr = ServiceHookTable; serviceptr != NULL; serviceptr = serviceptr->next) { - - if (FD_ISSET(serviceptr->msock, &master_fds)) { - ssock = accept(serviceptr->msock, NULL, 0); - if (ssock >= 0) { - syslog(LOG_DEBUG, "New client socket %d\n", ssock); - - /* The master socket is non-blocking but the client - * sockets need to be blocking, otherwise certain - * operations barf on FreeBSD. Not a fatal error. - */ - if (fcntl(ssock, F_SETFL, 0) < 0) { - syslog(LOG_EMERG, - "citserver: Can't set socket to blocking: %s\n", - strerror(errno)); - } - - /* New context will be created already - * set up in the CON_EXECUTING state. - */ - con = CreateNewContext(); - - /* Assign our new socket number to it. */ - con->client_socket = ssock; - con->h_command_function = serviceptr->h_command_function; - con->h_async_function = serviceptr->h_async_function; - con->h_greeting_function = serviceptr->h_greeting_function; - con->ServiceName = serviceptr->ServiceName; - - /* Determine whether it's a local socket */ - if (serviceptr->sockpath != NULL) { - con->is_local_socket = 1; - } - - /* Set the SO_REUSEADDR socket option */ - i = 1; - setsockopt(ssock, SOL_SOCKET, SO_REUSEADDR, &i, sizeof(i)); - con->state = CON_GREETING; - retval--; - if (retval == 0) - break; - } - } - } - } - return NULL; -} - - - -/* - * SyslogFacility() - * Translate text facility name to syslog.h defined value. - */ +// SyslogFacility() +// Translate text facility name to syslog.h defined value. int SyslogFacility(char *name) { int i;