4 * Citadel "system dependent" stuff.
5 * See COPYING for copyright information.
7 * Here's where we (hopefully) have most parts of the Citadel server that
8 * would need to be altered to run the server in a non-POSIX environment.
10 * If we ever port to a different platform and either have multiple
11 * variants of this file or simply load it up with #ifdefs.
22 #include <sys/types.h>
25 #include <sys/socket.h>
27 #include <sys/syslog.h>
29 #if TIME_WITH_SYS_TIME
30 # include <sys/time.h>
34 # include <sys/time.h>
41 #include <sys/resource.h>
42 #include <netinet/in.h>
43 #include <netinet/tcp.h>
44 #include <arpa/inet.h>
52 #define SHOW_ME_VAPPEND_PRINTF
53 #include <libcitadel.h>
56 #include "sysdep_decls.h"
57 #include "citserver.h"
61 #include "housekeeping.h"
62 #include "modules/crypto/serv_crypto.h" /* Needed for init_ssl, client_write_ssl, client_read_ssl, destruct_ssl */
66 #ifdef HAVE_SYS_SELECT_H
67 #include <sys/select.h>
74 #include "ctdl_module.h"
80 #ifdef DEBUG_MEMORY_LEAKS
88 struct igheap *igheap = NULL;
92 int verbosity = DEFAULT_VERBOSITY; /* Logging level */
94 int syslog_facility = LOG_DAEMON;
95 int enable_syslog = 0;
96 int print_to_logfile = 1;
99 * CtdlLogPrintf() ... Write logging information
101 void CtdlLogPrintf(enum LogLevel loglevel, const char *format, ...) {
103 va_start(arg_ptr, format);
104 vCtdlLogPrintf(loglevel, format, arg_ptr);
108 void vCtdlLogPrintf(enum LogLevel loglevel, const char *format, va_list arg_ptr)
112 vsyslog((syslog_facility | loglevel), format, arg_ptr);
115 /* stderr output code */
116 if (enable_syslog || !print_to_logfile) return;
118 /* if we run in forground and syslog is disabled, log to terminal */
119 if (loglevel <= verbosity) {
123 CitContext *CCC = MyContext();
124 ThreadTSD *cTSD = CTP;
125 CtdlThreadNode *node = NULL;
132 if ((node != NULL) && (node->reltid != 0)) {
133 lwpid = node->reltid;
136 gettimeofday(&tv, NULL);
138 /* Promote to time_t; types differ on some OSes (like darwin) */
139 unixtime = tv.tv_sec;
140 localtime_r(&unixtime, &tim);
143 "%04d/%02d/%02d %2d:%02d:%02d.%06ld ",
144 tim.tm_year + 1900, tim.tm_mon + 1,
145 tim.tm_mday, tim.tm_hour, tim.tm_min,
146 tim.tm_sec, (long)tv.tv_usec
150 fprintf(stderr, "[LWP:%ld] ", lwpid);
154 if (CCC->cs_pid != 0) {
155 fprintf(stderr, "[%3d] ", CCC->cs_pid);
157 else if (CCC->user.usernum != 0) {
158 fprintf(stderr, "[:%ld] ", CCC->user.usernum);
162 vfprintf(stderr, format, arg_ptr);
170 * Signal handler to shut down the server.
173 volatile int exit_signal = 0;
174 volatile int shutdown_and_halt = 0;
175 volatile int restart_server = 0;
176 volatile int running_as_daemon = 0;
178 static RETSIGTYPE signal_cleanup(int signum) {
184 CtdlLogPrintf(CTDL_DEBUG, "Caught signal %d; shutting down.\n", signum);
185 exit_signal = signum;
189 static RETSIGTYPE signal_exit(int signum) {
196 * Some initialization stuff...
198 void init_sysdep(void) {
201 /* Avoid vulnerabilities related to FD_SETSIZE if we can. */
205 getrlimit(RLIMIT_NOFILE, &rl);
206 rl.rlim_cur = FD_SETSIZE;
207 rl.rlim_max = FD_SETSIZE;
208 setrlimit(RLIMIT_NOFILE, &rl);
212 /* If we've got OpenSSL, we're going to use it. */
218 * Set up a place to put thread-specific data.
219 * We only need a single pointer per thread - it points to the
220 * CitContext structure (in the ContextList linked list) of the
221 * session to which the calling thread is currently bound.
223 if (citthread_key_create(&MyConKey, NULL) != 0) {
224 CtdlLogPrintf(CTDL_CRIT, "Can't create TSD key: %s\n",
229 * The action for unexpected signals and exceptions should be to
230 * call signal_cleanup() to gracefully shut down the server.
233 sigaddset(&set, SIGINT); // intr = shutdown
234 // sigaddset(&set, SIGQUIT); // quit = force quit
235 sigaddset(&set, SIGHUP);
236 sigaddset(&set, SIGTERM);
237 // sigaddset(&set, SIGSEGV); // we want core dumps
238 // sigaddset(&set, SIGILL); // we want core dumps
239 // sigaddset(&set, SIGBUS);
240 sigprocmask(SIG_UNBLOCK, &set, NULL);
242 signal(SIGINT, signal_cleanup); // intr = shutdown
243 // signal(SIGQUIT, signal_cleanup); // quit = force quit
244 signal(SIGHUP, signal_cleanup);
245 signal(SIGTERM, signal_cleanup);
246 signal(SIGUSR2, signal_exit);
247 // signal(SIGSEGV, signal_cleanup); // we want coredumps
248 // signal(SIGILL, signal_cleanup); // we want core dumps
249 // signal(SIGBUS, signal_cleanup);
252 * Do not shut down the server on broken pipe signals, otherwise the
253 * whole Citadel service would come down whenever a single client
256 signal(SIGPIPE, SIG_IGN);
261 * This is a generic function to set up a master socket for listening on
262 * a TCP port. The server shuts down if the bind fails. (IPv4/IPv6 version)
264 * ip_addr IP address to bind
265 * port_number port number to bind
266 * queue_len number of incoming connections to allow in the queue
268 int ctdl_tcp_server(char *ip_addr, int port_number, int queue_len, char *errormessage)
271 struct sockaddr_in6 sin6;
272 struct sockaddr_in sin4;
276 memset(&sin6, 0, sizeof(sin6));
277 memset(&sin4, 0, sizeof(sin4));
278 sin6.sin6_family = AF_INET6;
279 sin4.sin_family = AF_INET;
281 if ( (ip_addr == NULL) /* any IPv6 */
282 || (IsEmptyStr(ip_addr))
283 || (!strcmp(ip_addr, "*"))
286 sin6.sin6_addr = in6addr_any;
288 else if (!strcmp(ip_addr, "0.0.0.0")) /* any IPv4 */
291 sin4.sin_addr.s_addr = INADDR_ANY;
293 else if ((strchr(ip_addr, '.')) && (!strchr(ip_addr, ':'))) /* specific IPv4 */
296 if (inet_pton(AF_INET, ip_addr, &sin4.sin_addr) <= 0) {
297 snprintf(errormessage, SIZ,
298 "Error binding to [%s] : %s", ip_addr, strerror(errno)
300 CtdlLogPrintf(CTDL_ALERT, "%s\n", errormessage);
304 else /* specific IPv6 */
307 if (inet_pton(AF_INET6, ip_addr, &sin6.sin6_addr) <= 0) {
308 snprintf(errormessage, SIZ,
309 "Error binding to [%s] : %s", ip_addr, strerror(errno)
311 CtdlLogPrintf(CTDL_ALERT, "%s\n", errormessage);
316 if (port_number == 0) {
317 snprintf(errormessage, SIZ,
318 "Can't start: no port number specified."
320 CtdlLogPrintf(CTDL_ALERT, "%s\n", errormessage);
323 sin6.sin6_port = htons((u_short) port_number);
324 sin4.sin_port = htons((u_short) port_number);
326 p = getprotobyname("tcp");
328 s = socket( ((ip_version == 6) ? PF_INET6 : PF_INET), SOCK_STREAM, (p->p_proto));
330 snprintf(errormessage, SIZ,
331 "Can't create a listening socket: %s", strerror(errno)
333 CtdlLogPrintf(CTDL_ALERT, "%s\n", errormessage);
336 /* Set some socket options that make sense. */
338 setsockopt(s, SOL_SOCKET, SO_REUSEADDR, &i, sizeof(i));
340 if (ip_version == 6) {
341 b = bind(s, (struct sockaddr *) &sin6, sizeof(sin6));
344 b = bind(s, (struct sockaddr *) &sin4, sizeof(sin4));
348 snprintf(errormessage, SIZ,
349 "Can't bind: %s", strerror(errno)
351 CtdlLogPrintf(CTDL_ALERT, "%s\n", errormessage);
355 fcntl(s, F_SETFL, O_NONBLOCK);
357 if (listen(s, ((queue_len >= 5) ? queue_len : 5) ) < 0) {
358 snprintf(errormessage, SIZ,
359 "Can't listen: %s", strerror(errno)
361 CtdlLogPrintf(CTDL_ALERT, "%s\n", errormessage);
372 * Create a Unix domain socket and listen on it
374 int ctdl_uds_server(char *sockpath, int queue_len, char *errormessage)
376 struct sockaddr_un addr;
379 int actual_queue_len;
380 #ifdef HAVE_STRUCT_UCRED
384 actual_queue_len = queue_len;
385 if (actual_queue_len < 5) actual_queue_len = 5;
387 i = unlink(sockpath);
388 if ((i != 0) && (errno != ENOENT)) {
389 snprintf(errormessage, SIZ, "citserver: can't unlink %s: %s",
390 sockpath, strerror(errno)
392 CtdlLogPrintf(CTDL_EMERG, "%s\n", errormessage);
396 memset(&addr, 0, sizeof(addr));
397 addr.sun_family = AF_UNIX;
398 safestrncpy(addr.sun_path, sockpath, sizeof addr.sun_path);
400 s = socket(AF_UNIX, SOCK_STREAM, 0);
402 snprintf(errormessage, SIZ,
403 "citserver: Can't create a socket: %s",
405 CtdlLogPrintf(CTDL_EMERG, "%s\n", errormessage);
409 if (bind(s, (struct sockaddr *)&addr, sizeof(addr)) < 0) {
410 snprintf(errormessage, SIZ,
411 "citserver: Can't bind: %s",
413 CtdlLogPrintf(CTDL_EMERG, "%s\n", errormessage);
417 /* set to nonblock - we need this for some obscure situations */
418 if (fcntl(s, F_SETFL, O_NONBLOCK) < 0) {
419 snprintf(errormessage, SIZ,
420 "citserver: Can't set socket to non-blocking: %s",
422 CtdlLogPrintf(CTDL_EMERG, "%s\n", errormessage);
427 if (listen(s, actual_queue_len) < 0) {
428 snprintf(errormessage, SIZ,
429 "citserver: Can't listen: %s",
431 CtdlLogPrintf(CTDL_EMERG, "%s\n", errormessage);
435 #ifdef HAVE_STRUCT_UCRED
436 setsockopt(s, SOL_SOCKET, SO_PASSCRED, &passcred, sizeof(passcred));
439 chmod(sockpath, S_ISGID|S_IRUSR|S_IWUSR|S_IXUSR|S_IRGRP|S_IWGRP|S_IXGRP|S_IROTH|S_IWOTH|S_IXOTH);
446 * The following functions implement output buffering on operating systems which
447 * support it (such as Linux and various BSD flavors).
451 # define HAVE_TCP_BUFFERING
454 # define HAVE_TCP_BUFFERING
455 # define TCP_CORK TCP_NOPUSH
457 #endif /* TCP_CORK */
458 #endif /* HAVE_DARWIN */
460 static unsigned on = 1, off = 0;
462 void buffer_output(void) {
463 #ifdef HAVE_TCP_BUFFERING
465 if (!CC->redirect_ssl)
467 setsockopt(CC->client_socket, IPPROTO_TCP, TCP_CORK, &on, 4);
471 void unbuffer_output(void) {
472 #ifdef HAVE_TCP_BUFFERING
474 if (!CC->redirect_ssl)
476 setsockopt(CC->client_socket, IPPROTO_TCP, TCP_CORK, &off, 4);
480 void flush_output(void) {
481 #ifdef HAVE_TCP_BUFFERING
482 struct CitContext *CCC = CC;
483 setsockopt(CCC->client_socket, IPPROTO_TCP, TCP_CORK, &off, 4);
484 setsockopt(CCC->client_socket, IPPROTO_TCP, TCP_CORK, &on, 4);
489 static void flush_client_inbuf(void)
493 FlushStrBuf(CCC->ReadBuf);
500 * client_write() ... Send binary data to the client.
502 int client_write(const char *buf, int nbytes)
504 int bytes_written = 0;
506 #ifndef HAVE_TCP_BUFFERING
507 int old_buffer_len = 0;
513 if (nbytes < 1) return(0);
523 snprintf(fn, SIZ, "/tmp/foolog_%s.%d", Ctx->ServiceName, Ctx->cs_pid);
525 fd = fopen(fn, "a+");
526 fprintf(fd, "Sending: BufSize: %d BufContent: [",
528 rv = fwrite(buf, nbytes, 1, fd);
535 // flush_client_inbuf();
536 if (Ctx->redirect_buffer != NULL) {
537 StrBufAppendBufPlain(Ctx->redirect_buffer,
543 if (Ctx->redirect_ssl) {
544 client_write_ssl(buf, nbytes);
548 if (Ctx->client_socket == -1) return -1;
550 fdflags = fcntl(Ctx->client_socket, F_GETFL);
552 while ((bytes_written < nbytes) && (Ctx->client_socket != -1)){
553 if ((fdflags & O_NONBLOCK) == O_NONBLOCK) {
555 FD_SET(Ctx->client_socket, &wset);
556 if (select(1, NULL, &wset, NULL, NULL) == -1) {
559 CtdlLogPrintf(CTDL_DEBUG, "client_write(%d bytes) select() interrupted.\n", nbytes-bytes_written);
560 if (CtdlThreadCheckStop()) {
564 /* can't trust fd's and stuff so we need to re-create them */
568 CtdlLogPrintf(CTDL_ERR,
569 "client_write(%d bytes) select failed: %s (%d)\n",
570 nbytes - bytes_written,
571 strerror(errno), errno);
579 retval = write(Ctx->client_socket, &buf[bytes_written],
580 nbytes - bytes_written);
582 CtdlLogPrintf(CTDL_ERR,
583 "client_write(%d bytes) failed: %s (%d)\n",
584 nbytes - bytes_written,
585 strerror(errno), errno);
587 // CtdlLogPrintf(CTDL_DEBUG, "Tried to send: %s", &buf[bytes_written]);
591 bytes_written = bytes_written + retval;
596 void cputbuf(const StrBuf *Buf) {
597 client_write(ChrPtr(Buf), StrLength(Buf));
602 * cprintf() Send formatted printable data to the client.
603 * Implemented in terms of client_write() so it's technically not sysdep...
605 void cprintf(const char *format, ...) {
609 va_start(arg_ptr, format);
610 if (vsnprintf(buf, sizeof buf, format, arg_ptr) == -1)
611 buf[sizeof buf - 2] = '\n';
612 client_write(buf, strlen(buf));
618 * Read data from the client socket.
620 * sock socket fd to read from
621 * buf buffer to read into
622 * bytes number of bytes to read
623 * timeout Number of seconds to wait before timing out
625 * Possible return values:
626 * 1 Requested number of bytes has been read.
627 * 0 Request timed out.
628 * -1 Connection is broken, or other error.
630 int client_read_blob(StrBuf *Target, int bytes, int timeout)
637 if (CCC->redirect_ssl) {
643 snprintf(fn, SIZ, "/tmp/foolog_%s.%d", CCC->ServiceName, CCC->cs_pid);
645 fd = fopen(fn, "a+");
646 fprintf(fd, "Reading BLOB: BufSize: %d ",
648 rv = fwrite(ChrPtr(Target), StrLength(Target), 1, fd);
654 retval = client_read_sslblob(Target, bytes, timeout);
656 CtdlLogPrintf(CTDL_CRIT,
661 snprintf(fn, SIZ, "/tmp/foolog_%s.%d", CCC->ServiceName, CCC->cs_pid);
663 fd = fopen(fn, "a+");
664 fprintf(fd, "Read: %d BufContent: [",
666 rv = fwrite(ChrPtr(Target), StrLength(Target), 1, fd);
681 snprintf(fn, SIZ, "/tmp/foolog_%s.%d", CCC->ServiceName, CCC->cs_pid);
683 fd = fopen(fn, "a+");
684 fprintf(fd, "Reading BLOB: BufSize: %d ",
686 rv = fwrite(ChrPtr(Target), StrLength(Target), 1, fd);
692 retval = StrBufReadBLOBBuffered(Target,
701 CtdlLogPrintf(CTDL_CRIT,
708 snprintf(fn, SIZ, "/tmp/foolog_%s.%d", CCC->ServiceName, CCC->cs_pid);
710 fd = fopen(fn, "a+");
711 fprintf(fd, "Read: %d BufContent: [",
713 rv = fwrite(ChrPtr(Target), StrLength(Target), 1, fd);
725 * to make client_read_random_blob() more efficient, increase buffer size.
726 * just use in greeting function, else your buffer may be flushed
728 void client_set_inbound_buf(long N)
730 FlushStrBuf(CC->ReadBuf);
731 ReAdjustEmptyBuf(CC->ReadBuf, N * SIZ, N * SIZ);
734 int client_read_random_blob(StrBuf *Target, int timeout)
739 rc = client_read_blob(Target, 1, timeout);
745 len = StrLength(CCC->ReadBuf);
746 pch = ChrPtr(CCC->ReadBuf);
750 if (CCC->Pos != NULL) {
751 len -= CCC->Pos - pch;
754 StrBufAppendBufPlain(Target, pch, len, 0);
755 FlushStrBuf(CCC->ReadBuf);
763 snprintf(fn, SIZ, "/tmp/foolog_%s.%d", CCC->ServiceName, CCC->cs_pid);
765 fd = fopen(fn, "a+");
766 fprintf(fd, "Read: BufSize: %d BufContent: [",
768 rv = fwrite(ChrPtr(Target), StrLength(Target), 1, fd);
776 return StrLength(Target);
784 int client_read_to(char *buf, int bytes, int timeout)
789 rc = client_read_blob(CCC->MigrateBuf, bytes, timeout);
798 ChrPtr(CCC->MigrateBuf),
799 StrLength(CCC->MigrateBuf) + 1);
800 FlushStrBuf(CCC->MigrateBuf);
806 int HaveMoreLinesWaiting(CitContext *CCC)
808 if ((CCC->kill_me == 1) || (
809 (CCC->Pos == NULL) &&
810 (StrLength(CCC->ReadBuf) == 0) &&
811 (CCC->client_socket != -1)) )
819 * Read data from the client socket with default timeout.
820 * (This is implemented in terms of client_read_to() and could be
821 * justifiably moved out of sysdep.c)
823 INLINE int client_read(char *buf, int bytes)
825 return(client_read_to(buf, bytes, config.c_sleeping));
828 int CtdlClientGetLine(StrBuf *Target)
836 if (CCC->redirect_ssl) {
846 snprintf(fn, SIZ, "/tmp/foolog_%s.%d", CCC->ServiceName, CCC->cs_pid);
848 fd = fopen(fn, "a+");
849 pch = ChrPtr(CCC->ReadBuf);
850 len = StrLength(CCC->ReadBuf);
851 if (CCC->Pos != NULL)
852 rlen = CC->Pos - pch;
856 /* fprintf(fd, "\n\n\nBufSize: %d BufPos: %d \nBufContent: [%s]\n\n_____________________\n",
859 fprintf(fd, "\n\n\nSSL1: BufSize: %d BufPos: %d \n_____________________\n",
862 rc = client_readline_sslbuffer(Target,
867 pch = ChrPtr(CCC->ReadBuf);
868 nlen = StrLength(CCC->ReadBuf);
869 if (CCC->Pos != NULL)
870 nrlen = CC->Pos - pch;
874 fprintf(fd, "\n\n\nBufSize: was: %d is: %d BufPos: was: %d is: %d \nBufContent: [%s]\n\n_____________________\n",
875 len, nlen, rlen, nrlen, pch);
877 fprintf(fd, "\n\n\nSSL2: BufSize: was: %d is: %d BufPos: was: %d is: %d \n",
878 len, nlen, rlen, nrlen);
880 fprintf(fd, "SSL3: Read: BufSize: %d BufContent: [%s]\n\n*************\n",
881 StrLength(Target), ChrPtr(Target));
885 CtdlLogPrintf(CTDL_CRIT,
897 int len, rlen, nlen, nrlen;
900 snprintf(fn, SIZ, "/tmp/foolog_%s.%d", CCC->ServiceName, CCC->cs_pid);
902 fd = fopen(fn, "a+");
903 pch = ChrPtr(CCC->ReadBuf);
904 len = StrLength(CCC->ReadBuf);
905 if (CCC->Pos != NULL)
906 rlen = CC->Pos - pch;
910 /* fprintf(fd, "\n\n\nBufSize: %d BufPos: %d \nBufContent: [%s]\n\n_____________________\n",
913 fprintf(fd, "\n\n\nBufSize: %d BufPos: %d \n_____________________\n",
916 rc = StrBufTCP_read_buffered_line_fast(Target,
925 pch = ChrPtr(CCC->ReadBuf);
926 nlen = StrLength(CCC->ReadBuf);
927 if (CCC->Pos != NULL)
928 nrlen = CC->Pos - pch;
932 fprintf(fd, "\n\n\nBufSize: was: %d is: %d BufPos: was: %d is: %d \nBufContent: [%s]\n\n_____________________\n",
933 len, nlen, rlen, nrlen, pch);
935 fprintf(fd, "\n\n\nBufSize: was: %d is: %d BufPos: was: %d is: %d \n",
936 len, nlen, rlen, nrlen);
938 fprintf(fd, "Read: BufSize: %d BufContent: [%s]\n\n*************\n",
939 StrLength(Target), ChrPtr(Target));
942 if ((rc < 0) && (Error != NULL))
943 CtdlLogPrintf(CTDL_CRIT,
954 * client_getln() ... Get a LF-terminated line of text from the client.
955 * (This is implemented in terms of client_read() and could be
956 * justifiably moved out of sysdep.c)
958 int client_getln(char *buf, int bufsize)
964 retval = CtdlClientGetLine(CCC->MigrateBuf);
969 i = StrLength(CCC->MigrateBuf);
970 pCh = ChrPtr(CCC->MigrateBuf);
971 /* Strip the trailing LF, and the trailing CR if present.
976 && ( (pCh[i - 1]==13)
977 || ( pCh[i - 1]==10)) ) {
983 FlushStrBuf(CCC->MigrateBuf);
985 safestrncpy(&buf[i], "000", bufsize - i);
992 * Cleanup any contexts that are left lying around
996 void close_masters (void)
998 struct ServiceFunctionHook *serviceptr;
1001 * close all protocol master sockets
1003 for (serviceptr = ServiceHookTable; serviceptr != NULL;
1004 serviceptr = serviceptr->next ) {
1006 if (serviceptr->tcp_port > 0)
1008 CtdlLogPrintf(CTDL_INFO, "Closing listener on port %d\n",
1009 serviceptr->tcp_port);
1010 serviceptr->tcp_port = 0;
1013 if (serviceptr->sockpath != NULL)
1014 CtdlLogPrintf(CTDL_INFO, "Closing listener on '%s'\n",
1015 serviceptr->sockpath);
1017 close(serviceptr->msock);
1018 /* If it's a Unix domain socket, remove the file. */
1019 if (serviceptr->sockpath != NULL) {
1020 unlink(serviceptr->sockpath);
1021 serviceptr->sockpath = NULL;
1028 * The system-dependent part of master_cleanup() - close the master socket.
1030 void sysdep_master_cleanup(void) {
1039 CtdlDestroyProtoHooks();
1040 CtdlDestroyDeleteHooks();
1041 CtdlDestroyXmsgHooks();
1042 CtdlDestroyNetprocHooks();
1043 CtdlDestroyUserHooks();
1044 CtdlDestroyMessageHook();
1045 CtdlDestroyCleanupHooks();
1046 CtdlDestroyFixedOutputHooks();
1047 CtdlDestroySessionHooks();
1048 CtdlDestroyServiceHook();
1049 CtdlDestroyRoomHooks();
1050 #ifdef HAVE_BACKTRACE
1051 /// eCrash_Uninit();
1057 pid_t current_child;
1058 void graceful_shutdown(int signum) {
1059 kill(current_child, signum);
1060 unlink(file_pid_file);
1065 int nFireUpsNonRestart = 0;
1066 pid_t ForkedPid = 1;
1069 * Start running as a daemon.
1071 void start_daemon(int unused) {
1079 /* Close stdin/stdout/stderr and replace them with /dev/null.
1080 * We don't just call close() because we don't want these fd's
1081 * to be reused for other files.
1083 if (chdir(ctdl_run_dir) != 0)
1084 CtdlLogPrintf(CTDL_EMERG,
1085 "unable to change into directory [%s]: %s",
1086 ctdl_run_dir, strerror(errno));
1093 signal(SIGHUP, SIG_IGN);
1094 signal(SIGINT, SIG_IGN);
1095 signal(SIGQUIT, SIG_IGN);
1099 if ((freopen("/dev/null", "r", stdin) != stdin) ||
1100 (freopen("/dev/null", "w", stdout) != stdout) ||
1101 (freopen("/dev/null", "w", stderr) != stderr))
1102 CtdlLogPrintf(CTDL_EMERG,
1103 "unable to reopen stdin/out/err %s",
1108 current_child = fork();
1110 signal(SIGTERM, graceful_shutdown);
1112 if (current_child < 0) {
1117 else if (current_child == 0) {
1118 return; /* continue starting citadel. */
1122 fp = fopen(file_pid_file, "w");
1124 fprintf(fp, ""F_PID_T"\n", getpid());
1127 waitpid(current_child, &status, 0);
1130 nFireUpsNonRestart = nFireUps;
1132 /* Exit code 0 means the watcher should exit */
1133 if (WIFEXITED(status) && (WEXITSTATUS(status) == CTDLEXIT_SHUTDOWN)) {
1137 /* Exit code 101-109 means the watcher should exit */
1138 else if (WIFEXITED(status) && (WEXITSTATUS(status) >= 101) && (WEXITSTATUS(status) <= 109)) {
1142 /* Any other exit code, or no exit code, means we should restart. */
1146 ForkedPid = current_child;
1149 } while (do_restart);
1151 unlink(file_pid_file);
1152 exit(WEXITSTATUS(status));
1157 void checkcrash(void)
1159 if (nFireUpsNonRestart != nFireUps)
1163 CrashMail = NewStrBuf();
1164 CtdlLogPrintf(CTDL_ALERT, "Posting crash message\n");
1165 StrBufPrintf(CrashMail,
1167 " The Citadel server process (citserver) terminated unexpectedly."
1169 " This could be the result of a bug in the server program, or some external "
1171 " You can obtain more information about this by enabling core dumps.\n \n"
1172 " For more information, please see:\n \n"
1173 " http://citadel.org/doku.php/faq:mastering_your_os:gdb#how.do.i.make.my.system.produce.core-files"
1176 " If you have already done this, the core dump is likely to be found at %score.%d\n"
1178 ctdl_run_dir, ForkedPid);
1179 CtdlAideMessage(ChrPtr(CrashMail), "Citadel server process terminated unexpectedly");
1180 FreeStrBuf(&CrashMail);
1186 * Generic routine to convert a login name to a full name (gecos)
1187 * Returns nonzero if a conversion took place
1189 int convert_login(char NameToConvert[]) {
1193 pw = getpwnam(NameToConvert);
1198 strcpy(NameToConvert, pw->pw_gecos);
1199 for (a=0; a<strlen(NameToConvert); ++a) {
1200 if (NameToConvert[a] == ',') NameToConvert[a] = 0;
1209 * This loop just keeps going and going and going...
1213 * This current implimentation of worker_thread creates a bottle neck in several situations
1214 * The first thing to remember is that a single thread can handle more than one connection at a time.
1215 * More threads mean less memory for the system to run in.
1216 * So for efficiency we want every thread to be doing something useful or waiting in the main loop for
1217 * something to happen anywhere.
1218 * This current implimentation requires worker threads to wait in other locations, after it has
1219 * been committed to a single connection which is very wasteful.
1220 * As an extreme case consider this:
1221 * A slow client connects and this slow client sends only one character each second.
1222 * With this current implimentation a single worker thread is dispatched to handle that connection
1223 * until such times as the client timeout expires, an error occurs on the socket or the client
1224 * completes its transmission.
1225 * THIS IS VERY BAD since that thread could have handled a read from many more clients in each one
1226 * second interval between chars.
1228 * It is my intention to re-write this code and the associated client_getln, client_read functions
1229 * to allow any thread to read data on behalf of any connection (context).
1230 * To do this I intend to have this main loop read chars into a buffer stored in the context.
1231 * Once the correct criteria for a full buffer is met then we will dispatch a thread to
1233 * This worker thread loop also needs to be able to handle binary data.
1236 void *worker_thread(void *arg) {
1239 CitContext *bind_me = NULL;
1243 int force_purge = 0;
1246 while (!CtdlThreadCheckStop()) {
1248 /* make doubly sure we're not holding any stale db handles
1249 * which might cause a deadlock.
1251 cdb_check_handles();
1252 do_select: force_purge = 0;
1253 bind_me = NULL; /* Which session shall we handle? */
1255 /* Initialize the fdset. */
1259 begin_critical_section(S_SESSION_TABLE);
1260 for (ptr = ContextList; ptr != NULL; ptr = ptr->next) {
1262 client_socket = ptr->client_socket;
1263 /* Dont select on dead sessions only truly idle ones */
1264 if ((ptr->state == CON_IDLE) &&
1265 (CC->kill_me == 0) &&
1266 (client_socket != -1))
1268 FD_SET(client_socket, &readfds);
1269 if (client_socket > highest)
1270 highest = client_socket;
1272 if ((bind_me == NULL) && (ptr->state == CON_READY)) {
1274 ptr->state = CON_EXECUTING;
1277 if ((bind_me == NULL) && (ptr->state == CON_GREETING)) {
1279 ptr->state = CON_STARTING;
1283 end_critical_section(S_SESSION_TABLE);
1289 /* If we got this far, it means that there are no sessions
1290 * which a previous thread marked for attention, so we go
1291 * ahead and get ready to select().
1294 if (!CtdlThreadCheckStop()) {
1295 tv.tv_sec = 1; /* wake up every second if no input */
1297 retval = CtdlThreadSelect(highest + 1, &readfds, NULL, NULL, &tv);
1302 /* Now figure out who made this select() unblock.
1303 * First, check for an error or exit condition.
1306 if (errno == EBADF) {
1307 CtdlLogPrintf(CTDL_NOTICE, "select() failed: (%s)\n",
1311 if (errno != EINTR) {
1312 CtdlLogPrintf(CTDL_EMERG, "Exiting (%s)\n", strerror(errno));
1313 CtdlThreadStopAll();
1316 CtdlLogPrintf(CTDL_DEBUG, "Interrupted CtdlThreadSelect.\n");
1317 if (CtdlThreadCheckStop()) return(NULL);
1321 else if(retval == 0) {
1322 if (CtdlThreadCheckStop()) return(NULL);
1325 /* It must be a client socket. Find a context that has data
1326 * waiting on its socket *and* is in the CON_IDLE state. Any
1327 * active sockets other than our chosen one are marked as
1328 * CON_READY so the next thread that comes around can just bind
1329 * to one without having to select() again.
1331 begin_critical_section(S_SESSION_TABLE);
1332 for (ptr = ContextList; ptr != NULL; ptr = ptr->next) {
1333 int checkfd = ptr->client_socket;
1334 if ((checkfd != -1) && (ptr->state == CON_IDLE) ){
1335 if (FD_ISSET(checkfd, &readfds)) {
1336 ptr->input_waiting = 1;
1338 bind_me = ptr; /* I choose you! */
1339 bind_me->state = CON_EXECUTING;
1342 ptr->state = CON_READY;
1344 } else if ((ptr->is_async) && (ptr->async_waiting) && (ptr->h_async_function)) {
1346 bind_me = ptr; /* I choose you! */
1347 bind_me->state = CON_EXECUTING;
1350 ptr->state = CON_READY;
1355 end_critical_section(S_SESSION_TABLE);
1358 /* We're bound to a session */
1359 if (bind_me != NULL) {
1360 become_session(bind_me);
1362 if (bind_me->state == CON_STARTING) {
1363 bind_me->state = CON_EXECUTING;
1364 begin_session(bind_me);
1365 bind_me->h_greeting_function();
1367 /* If the client has sent a command, execute it. */
1368 if (CC->input_waiting) {
1369 CC->h_command_function();
1371 while (HaveMoreLinesWaiting(CC))
1372 CC->h_command_function();
1374 CC->input_waiting = 0;
1377 /* If there are asynchronous messages waiting and the
1378 * client supports it, do those now */
1379 if ((CC->is_async) && (CC->async_waiting)
1380 && (CC->h_async_function != NULL)) {
1381 CC->h_async_function();
1382 CC->async_waiting = 0;
1385 force_purge = CC->kill_me;
1386 become_session(NULL);
1387 bind_me->state = CON_IDLE;
1390 dead_session_purge(force_purge);
1393 /* If control reaches this point, the server is shutting down */
1401 * A function to handle selecting on master sockets.
1402 * In other words it handles new connections.
1405 void *select_on_master (void *arg)
1407 struct ServiceFunctionHook *serviceptr;
1411 int ssock; /* Descriptor for client socket */
1412 CitContext *con= NULL; /* Temporary context pointer */
1416 struct CitContext select_on_master_CC;
1418 CtdlFillSystemContext(&select_on_master_CC, "select_on_master");
1419 citthread_setspecific(MyConKey, (void *)&select_on_master_CC);
1421 while (!CtdlThreadCheckStop()) {
1422 /* Initialize the fdset. */
1423 FD_ZERO(&master_fds);
1426 /* First, add the various master sockets to the fdset. */
1427 for (serviceptr = ServiceHookTable; serviceptr != NULL;
1428 serviceptr = serviceptr->next ) {
1429 m = serviceptr->msock;
1430 FD_SET(m, &master_fds);
1436 if (!CtdlThreadCheckStop()) {
1437 tv.tv_sec = 60; /* wake up every second if no input */
1439 retval = CtdlThreadSelect(highest + 1, &master_fds, NULL, NULL, &tv);
1444 /* Now figure out who made this select() unblock.
1445 * First, check for an error or exit condition.
1448 if (errno == EBADF) {
1449 CtdlLogPrintf(CTDL_NOTICE, "select() failed: (%s)\n",
1453 if (errno != EINTR) {
1454 CtdlLogPrintf(CTDL_EMERG, "Exiting (%s)\n", strerror(errno));
1455 CtdlThreadStopAll();
1457 CtdlLogPrintf(CTDL_DEBUG, "Interrupted CtdlThreadSelect.\n");
1458 if (CtdlThreadCheckStop()) return(NULL);
1462 else if(retval == 0) {
1463 if (CtdlThreadCheckStop()) return(NULL);
1466 /* Next, check to see if it's a new client connecting
1467 * on a master socket.
1469 else for (serviceptr = ServiceHookTable; serviceptr != NULL;
1470 serviceptr = serviceptr->next ) {
1472 if (FD_ISSET(serviceptr->msock, &master_fds)) {
1473 ssock = accept(serviceptr->msock, NULL, 0);
1475 CtdlLogPrintf(CTDL_DEBUG,
1476 "New client socket %d\n",
1479 /* The master socket is non-blocking but the client
1480 * sockets need to be blocking, otherwise certain
1481 * operations barf on FreeBSD. Not a fatal error.
1483 if (fcntl(ssock, F_SETFL, 0) < 0) {
1484 CtdlLogPrintf(CTDL_EMERG,
1485 "citserver: Can't set socket to blocking: %s\n",
1489 /* New context will be created already
1490 * set up in the CON_EXECUTING state.
1492 con = CreateNewContext();
1494 /* Assign our new socket number to it. */
1495 con->client_socket = ssock;
1496 con->h_command_function =
1497 serviceptr->h_command_function;
1498 con->h_async_function =
1499 serviceptr->h_async_function;
1500 con->h_greeting_function = serviceptr->h_greeting_function;
1502 serviceptr->ServiceName;
1504 /* Determine whether it's a local socket */
1505 if (serviceptr->sockpath != NULL)
1506 con->is_local_socket = 1;
1508 /* Set the SO_REUSEADDR socket option */
1510 setsockopt(ssock, SOL_SOCKET,
1514 con->state = CON_GREETING;
1523 CtdlClearSystemContext();
1532 * Translate text facility name to syslog.h defined value.
1534 int SyslogFacility(char *name)
1543 { LOG_KERN, "kern" },
1544 { LOG_USER, "user" },
1545 { LOG_MAIL, "mail" },
1546 { LOG_DAEMON, "daemon" },
1547 { LOG_AUTH, "auth" },
1548 { LOG_SYSLOG, "syslog" },
1550 { LOG_NEWS, "news" },
1551 { LOG_UUCP, "uucp" },
1552 { LOG_LOCAL0, "local0" },
1553 { LOG_LOCAL1, "local1" },
1554 { LOG_LOCAL2, "local2" },
1555 { LOG_LOCAL3, "local3" },
1556 { LOG_LOCAL4, "local4" },
1557 { LOG_LOCAL5, "local5" },
1558 { LOG_LOCAL6, "local6" },
1559 { LOG_LOCAL7, "local7" },
1562 for(i = 0; facTbl[i].name != NULL; i++) {
1563 if(!strcasecmp(name, facTbl[i].name))
1564 return facTbl[i].facility;
1571 /********** MEM CHEQQER ***********/
1573 #ifdef DEBUG_MEMORY_LEAKS
1580 void *tracked_malloc(size_t size, char *file, int line) {
1581 struct igheap *thisheap;
1584 block = malloc(size);
1585 if (block == NULL) return(block);
1587 thisheap = malloc(sizeof(struct igheap));
1588 if (thisheap == NULL) {
1593 thisheap->block = block;
1594 strcpy(thisheap->file, file);
1595 thisheap->line = line;
1597 begin_critical_section(S_DEBUGMEMLEAKS);
1598 thisheap->next = igheap;
1600 end_critical_section(S_DEBUGMEMLEAKS);
1606 void *tracked_realloc(void *ptr, size_t size, char *file, int line) {
1607 struct igheap *thisheap;
1610 block = realloc(ptr, size);
1611 if (block == NULL) return(block);
1613 thisheap = malloc(sizeof(struct igheap));
1614 if (thisheap == NULL) {
1619 thisheap->block = block;
1620 strcpy(thisheap->file, file);
1621 thisheap->line = line;
1623 begin_critical_section(S_DEBUGMEMLEAKS);
1624 thisheap->next = igheap;
1626 end_critical_section(S_DEBUGMEMLEAKS);
1633 void tracked_free(void *ptr) {
1634 struct igheap *thisheap;
1635 struct igheap *trash;
1639 if (igheap == NULL) return;
1640 begin_critical_section(S_DEBUGMEMLEAKS);
1641 for (thisheap = igheap; thisheap != NULL; thisheap = thisheap->next) {
1642 if (thisheap->next != NULL) {
1643 if (thisheap->next->block == ptr) {
1644 trash = thisheap->next;
1645 thisheap->next = thisheap->next->next;
1650 if (igheap->block == ptr) {
1652 igheap = igheap->next;
1655 end_critical_section(S_DEBUGMEMLEAKS);
1658 char *tracked_strdup(const char *s, char *file, int line) {
1661 if (s == NULL) return(NULL);
1662 ptr = tracked_malloc(strlen(s) + 1, file, line);
1663 if (ptr == NULL) return(NULL);
1664 strncpy(ptr, s, strlen(s));
1668 void dump_heap(void) {
1669 struct igheap *thisheap;
1671 for (thisheap = igheap; thisheap != NULL; thisheap = thisheap->next) {
1672 CtdlLogPrintf(CTDL_CRIT, "UNFREED: %30s : %d\n",
1673 thisheap->file, thisheap->line);
1677 #endif /* DEBUG_MEMORY_LEAKS */