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 #include <libcitadel.h>
55 #include "sysdep_decls.h"
56 #include "citserver.h"
60 #include "housekeeping.h"
61 #include "modules/crypto/serv_crypto.h" /* Needed for init_ssl, client_write_ssl, client_read_ssl, destruct_ssl */
65 #ifdef HAVE_SYS_SELECT_H
66 #include <sys/select.h>
73 #include "ctdl_module.h"
79 #ifdef DEBUG_MEMORY_LEAKS
87 struct igheap *igheap = NULL;
91 int verbosity = DEFAULT_VERBOSITY; /* Logging level */
93 int syslog_facility = LOG_DAEMON;
94 int enable_syslog = 0;
98 * CtdlLogPrintf() ... Write logging information
100 void CtdlLogPrintf(enum LogLevel loglevel, const char *format, ...) {
102 va_start(arg_ptr, format);
103 vCtdlLogPrintf(loglevel, format, arg_ptr);
107 void vCtdlLogPrintf(enum LogLevel loglevel, const char *format, va_list arg_ptr)
109 char buf[SIZ], buf2[SIZ];
112 vsyslog((syslog_facility | loglevel), format, arg_ptr);
115 /* stderr output code */
116 if (enable_syslog || running_as_daemon) return;
118 /* if we run in forground and syslog is disabled, log to terminal */
119 if (loglevel <= verbosity) {
123 CitContext *CCC = CC;
125 gettimeofday(&tv, NULL);
126 /* Promote to time_t; types differ on some OSes (like darwin) */
127 unixtime = tv.tv_sec;
128 localtime_r(&unixtime, &tim);
129 if ((CCC != NULL) && (CCC->cs_pid != 0)) {
131 "%04d/%02d/%02d %2d:%02d:%02d.%06ld [%3d] ",
132 tim.tm_year + 1900, tim.tm_mon + 1,
133 tim.tm_mday, tim.tm_hour, tim.tm_min,
134 tim.tm_sec, (long)tv.tv_usec,
138 "%04d/%02d/%02d %2d:%02d:%02d.%06ld ",
139 tim.tm_year + 1900, tim.tm_mon + 1,
140 tim.tm_mday, tim.tm_hour, tim.tm_min,
141 tim.tm_sec, (long)tv.tv_usec);
143 vsnprintf(buf2, SIZ, format, arg_ptr);
145 fprintf(stderr, "%s%s", buf, buf2);
153 * Signal handler to shut down the server.
156 volatile int exit_signal = 0;
157 volatile int shutdown_and_halt = 0;
158 volatile int restart_server = 0;
159 volatile int running_as_daemon = 0;
161 static RETSIGTYPE signal_cleanup(int signum) {
167 CtdlLogPrintf(CTDL_DEBUG, "Caught signal %d; shutting down.\n", signum);
168 exit_signal = signum;
172 static RETSIGTYPE signal_exit(int signum) {
179 * Some initialization stuff...
181 void init_sysdep(void) {
184 /* Avoid vulnerabilities related to FD_SETSIZE if we can. */
188 getrlimit(RLIMIT_NOFILE, &rl);
189 rl.rlim_cur = FD_SETSIZE;
190 rl.rlim_max = FD_SETSIZE;
191 setrlimit(RLIMIT_NOFILE, &rl);
195 /* If we've got OpenSSL, we're going to use it. */
201 * Set up a place to put thread-specific data.
202 * We only need a single pointer per thread - it points to the
203 * CitContext structure (in the ContextList linked list) of the
204 * session to which the calling thread is currently bound.
206 if (citthread_key_create(&MyConKey, NULL) != 0) {
207 CtdlLogPrintf(CTDL_CRIT, "Can't create TSD key: %s\n",
212 * The action for unexpected signals and exceptions should be to
213 * call signal_cleanup() to gracefully shut down the server.
216 sigaddset(&set, SIGINT);
217 sigaddset(&set, SIGQUIT);
218 sigaddset(&set, SIGHUP);
219 sigaddset(&set, SIGTERM);
220 // sigaddset(&set, SIGSEGV); commented out because
221 // sigaddset(&set, SIGILL); we want core dumps
222 // sigaddset(&set, SIGBUS);
223 sigprocmask(SIG_UNBLOCK, &set, NULL);
225 signal(SIGINT, signal_cleanup);
226 signal(SIGQUIT, signal_cleanup);
227 signal(SIGHUP, signal_cleanup);
228 signal(SIGTERM, signal_cleanup);
229 signal(SIGUSR2, signal_exit);
230 // signal(SIGSEGV, signal_cleanup); commented out because
231 // signal(SIGILL, signal_cleanup); we want core dumps
232 // signal(SIGBUS, signal_cleanup);
235 * Do not shut down the server on broken pipe signals, otherwise the
236 * whole Citadel service would come down whenever a single client
239 signal(SIGPIPE, SIG_IGN);
246 * This is a generic function to set up a master socket for listening on
247 * a TCP port. The server shuts down if the bind fails.
250 int ig_tcp_server(char *ip_addr, int port_number, int queue_len, char **errormessage)
252 struct sockaddr_in sin;
254 int actual_queue_len;
256 actual_queue_len = queue_len;
257 if (actual_queue_len < 5) actual_queue_len = 5;
259 memset(&sin, 0, sizeof(sin));
260 sin.sin_family = AF_INET;
261 sin.sin_port = htons((u_short)port_number);
262 if (ip_addr == NULL) {
263 sin.sin_addr.s_addr = INADDR_ANY;
266 sin.sin_addr.s_addr = inet_addr(ip_addr);
269 if (sin.sin_addr.s_addr == !INADDR_ANY) {
270 sin.sin_addr.s_addr = INADDR_ANY;
273 s = socket(PF_INET, SOCK_STREAM, IPPROTO_TCP);
276 *errormessage = (char*) malloc(SIZ + 1);
277 snprintf(*errormessage, SIZ,
278 "citserver: Can't create a socket: %s",
280 CtdlLogPrintf(CTDL_EMERG, "%s\n", *errormessage);
285 setsockopt(s, SOL_SOCKET, SO_REUSEADDR, &i, sizeof(i));
287 if (bind(s, (struct sockaddr *)&sin, sizeof(sin)) < 0) {
288 *errormessage = (char*) malloc(SIZ + 1);
289 snprintf(*errormessage, SIZ,
290 "citserver: Can't bind: %s",
292 CtdlLogPrintf(CTDL_EMERG, "%s\n", *errormessage);
297 /* set to nonblock - we need this for some obscure situations */
298 if (fcntl(s, F_SETFL, O_NONBLOCK) < 0) {
299 *errormessage = (char*) malloc(SIZ + 1);
300 snprintf(*errormessage, SIZ,
301 "citserver: Can't set socket to non-blocking: %s",
303 CtdlLogPrintf(CTDL_EMERG, "%s\n", *errormessage);
308 if (listen(s, actual_queue_len) < 0) {
309 *errormessage = (char*) malloc(SIZ + 1);
310 snprintf(*errormessage, SIZ,
311 "citserver: Can't listen: %s",
313 CtdlLogPrintf(CTDL_EMERG, "%s\n", *errormessage);
324 * Create a Unix domain socket and listen on it
326 int ig_uds_server(char *sockpath, int queue_len, char **errormessage)
328 struct sockaddr_un addr;
331 int actual_queue_len;
332 #ifdef HAVE_STRUCT_UCRED
336 actual_queue_len = queue_len;
337 if (actual_queue_len < 5) actual_queue_len = 5;
339 i = unlink(sockpath);
340 if ((i != 0) && (errno != ENOENT)) {
341 *errormessage = (char*) malloc(SIZ + 1);
342 snprintf(*errormessage, SIZ, "citserver: can't unlink %s: %s",
343 sockpath, strerror(errno));
344 CtdlLogPrintf(CTDL_EMERG, "%s\n", *errormessage);
348 memset(&addr, 0, sizeof(addr));
349 addr.sun_family = AF_UNIX;
350 safestrncpy(addr.sun_path, sockpath, sizeof addr.sun_path);
352 s = socket(AF_UNIX, SOCK_STREAM, 0);
354 *errormessage = (char*) malloc(SIZ + 1);
355 snprintf(*errormessage, SIZ,
356 "citserver: Can't create a socket: %s",
358 CtdlLogPrintf(CTDL_EMERG, "%s\n", *errormessage);
362 if (bind(s, (struct sockaddr *)&addr, sizeof(addr)) < 0) {
363 *errormessage = (char*) malloc(SIZ + 1);
364 snprintf(*errormessage, SIZ,
365 "citserver: Can't bind: %s",
367 CtdlLogPrintf(CTDL_EMERG, "%s\n", *errormessage);
371 /* set to nonblock - we need this for some obscure situations */
372 if (fcntl(s, F_SETFL, O_NONBLOCK) < 0) {
373 *errormessage = (char*) malloc(SIZ + 1);
374 snprintf(*errormessage, SIZ,
375 "citserver: Can't set socket to non-blocking: %s",
377 CtdlLogPrintf(CTDL_EMERG, "%s\n", *errormessage);
382 if (listen(s, actual_queue_len) < 0) {
383 *errormessage = (char*) malloc(SIZ + 1);
384 snprintf(*errormessage, SIZ,
385 "citserver: Can't listen: %s",
387 CtdlLogPrintf(CTDL_EMERG, "%s\n", *errormessage);
391 #ifdef HAVE_STRUCT_UCRED
392 setsockopt(s, SOL_SOCKET, SO_PASSCRED, &passcred, sizeof(passcred));
395 chmod(sockpath, S_ISGID|S_IRUSR|S_IWUSR|S_IXUSR|S_IRGRP|S_IWGRP|S_IXGRP|S_IROTH|S_IWOTH|S_IXOTH);
402 * The following functions implement output buffering on operating systems which
403 * support it (such as Linux and various BSD flavors).
407 # define HAVE_TCP_BUFFERING
410 # define HAVE_TCP_BUFFERING
411 # define TCP_CORK TCP_NOPUSH
413 #endif /* TCP_CORK */
414 #endif /* HAVE_DARWIN */
416 static unsigned on = 1, off = 0;
418 void buffer_output(void) {
419 #ifdef HAVE_TCP_BUFFERING
421 if (!CC->redirect_ssl)
423 setsockopt(CC->client_socket, IPPROTO_TCP, TCP_CORK, &on, 4);
427 void unbuffer_output(void) {
428 #ifdef HAVE_TCP_BUFFERING
430 if (!CC->redirect_ssl)
432 setsockopt(CC->client_socket, IPPROTO_TCP, TCP_CORK, &off, 4);
436 void flush_output(void) {
437 #ifdef HAVE_TCP_BUFFERING
438 struct CitContext *CCC = CC;
439 setsockopt(CCC->client_socket, IPPROTO_TCP, TCP_CORK, &off, 4);
440 setsockopt(CCC->client_socket, IPPROTO_TCP, TCP_CORK, &on, 4);
445 static void flush_client_inbuf(void)
449 FlushStrBuf(CCC->ReadBuf);
456 * client_write() ... Send binary data to the client.
458 int client_write(const char *buf, int nbytes)
460 int bytes_written = 0;
462 #ifndef HAVE_TCP_BUFFERING
463 int old_buffer_len = 0;
469 if (nbytes < 1) return(0);
471 // flush_client_inbuf();
473 if (Ctx->redirect_buffer != NULL) {
474 StrBufAppendBufPlain(Ctx->redirect_buffer,
480 if (Ctx->redirect_ssl) {
481 client_write_ssl(buf, nbytes);
485 if (Ctx->client_socket == -1) return -1;
487 fdflags = fcntl(Ctx->client_socket, F_GETFL);
489 while ((bytes_written < nbytes) && (Ctx->client_socket != -1)){
490 if ((fdflags & O_NONBLOCK) == O_NONBLOCK) {
492 FD_SET(Ctx->client_socket, &wset);
493 if (select(1, NULL, &wset, NULL, NULL) == -1) {
496 CtdlLogPrintf(CTDL_DEBUG, "client_write(%d bytes) select() interrupted.\n", nbytes-bytes_written);
497 if (CtdlThreadCheckStop()) {
501 /* can't trust fd's and stuff so we need to re-create them */
505 CtdlLogPrintf(CTDL_ERR,
506 "client_write(%d bytes) select failed: %s (%d)\n",
507 nbytes - bytes_written,
508 strerror(errno), errno);
516 retval = write(Ctx->client_socket, &buf[bytes_written],
517 nbytes - bytes_written);
519 CtdlLogPrintf(CTDL_ERR,
520 "client_write(%d bytes) failed: %s (%d)\n",
521 nbytes - bytes_written,
522 strerror(errno), errno);
524 // CtdlLogPrintf(CTDL_DEBUG, "Tried to send: %s", &buf[bytes_written]);
528 bytes_written = bytes_written + retval;
533 void cputbuf(const StrBuf *Buf) {
534 client_write(ChrPtr(Buf), StrLength(Buf));
539 * cprintf() Send formatted printable data to the client.
540 * Implemented in terms of client_write() so it's technically not sysdep...
542 void cprintf(const char *format, ...) {
546 va_start(arg_ptr, format);
547 if (vsnprintf(buf, sizeof buf, format, arg_ptr) == -1)
548 buf[sizeof buf - 2] = '\n';
549 client_write(buf, strlen(buf));
555 * Read data from the client socket.
557 * sock socket fd to read from
558 * buf buffer to read into
559 * bytes number of bytes to read
560 * timeout Number of seconds to wait before timing out
562 * Possible return values:
563 * 1 Requested number of bytes has been read.
564 * 0 Request timed out.
565 * -1 Connection is broken, or other error.
567 int client_read_blob(StrBuf *Target, int bytes, int timeout)
574 if (CCC->redirect_ssl) {
575 retval = client_read_sslblob(Target, bytes, timeout);
580 retval = StrBufReadBLOBBuffered(Target,
589 CtdlLogPrintf(CTDL_CRIT,
601 snprintf(fn, SIZ, "/tmp/foolog_%s.%d", CCC->ServiceName, CCC->cs_pid);
603 fd = fopen(fn, "a+");
604 fprintf(fd, "Read: BufSize: %d BufContent: [",
606 rv = fwrite(ChrPtr(Target), StrLength(Target), 1, fd);
614 return retval == bytes;
617 int client_read_to(char *buf, int bytes, int timeout)
622 rc = client_read_blob(CCC->MigrateBuf, bytes, timeout);
631 ChrPtr(CCC->MigrateBuf),
632 StrLength(CCC->MigrateBuf) + 1);
633 FlushStrBuf(CCC->MigrateBuf);
639 int HaveMoreLinesWaiting(CitContext *CCC)
641 if ((CCC->kill_me == 1) || (
642 (CCC->Pos == NULL) &&
643 (StrLength(CCC->ReadBuf) == 0) &&
644 (CCC->client_socket != -1)) )
652 * Read data from the client socket with default timeout.
653 * (This is implemented in terms of client_read_to() and could be
654 * justifiably moved out of sysdep.c)
656 INLINE int client_read(char *buf, int bytes)
658 return(client_read_to(buf, bytes, config.c_sleeping));
661 int CtdlClientGetLine(StrBuf *Target)
669 if (CCC->redirect_ssl) {
673 int len, rlen, nlen, nrlen;
676 snprintf(fn, SIZ, "/tmp/foolog_%s.%d", CCC->ServiceName, CCC->cs_pid);
678 fd = fopen(fn, "a+");
679 pch = ChrPtr(CCC->ReadBuf);
680 len = StrLength(CCC->ReadBuf);
681 if (CCC->Pos != NULL)
682 rlen = CC->Pos - pch;
686 /* fprintf(fd, "\n\n\nBufSize: %d BufPos: %d \nBufContent: [%s]\n\n_____________________\n",
689 fprintf(fd, "\n\n\nBufSize: %d BufPos: %d \n_____________________\n",
692 rc = client_readline_sslbuffer(Target,
696 pch = ChrPtr(CCC->ReadBuf);
697 nlen = StrLength(CCC->ReadBuf);
698 if (CCC->Pos != NULL)
699 nrlen = CC->Pos - pch;
703 fprintf(fd, "\n\n\nBufSize: was: %d is: %d BufPos: was: %d is: %d \nBufContent: [%s]\n\n_____________________\n",
704 len, nlen, rlen, nrlen, pch);
706 fprintf(fd, "\n\n\nBufSize: was: %d is: %d BufPos: was: %d is: %d \n",
707 len, nlen, rlen, nrlen);
709 fprintf(fd, "Read: BufSize: %d BufContent: [%s]\n\n*************\n",
710 StrLength(Target), ChrPtr(Target));
713 if ((rc < 0) && (Error != NULL))
714 CtdlLogPrintf(CTDL_CRIT,
727 int len, rlen, nlen, nrlen;
730 snprintf(fn, SIZ, "/tmp/foolog_%s.%d", CCC->ServiceName, CCC->cs_pid);
732 fd = fopen(fn, "a+");
733 pch = ChrPtr(CCC->ReadBuf);
734 len = StrLength(CCC->ReadBuf);
735 if (CCC->Pos != NULL)
736 rlen = CC->Pos - pch;
740 /* fprintf(fd, "\n\n\nBufSize: %d BufPos: %d \nBufContent: [%s]\n\n_____________________\n",
743 fprintf(fd, "\n\n\nBufSize: %d BufPos: %d \n_____________________\n",
746 rc = StrBufTCP_read_buffered_line_fast(Target,
755 pch = ChrPtr(CCC->ReadBuf);
756 nlen = StrLength(CCC->ReadBuf);
757 if (CCC->Pos != NULL)
758 nrlen = CC->Pos - pch;
762 fprintf(fd, "\n\n\nBufSize: was: %d is: %d BufPos: was: %d is: %d \nBufContent: [%s]\n\n_____________________\n",
763 len, nlen, rlen, nrlen, pch);
765 fprintf(fd, "\n\n\nBufSize: was: %d is: %d BufPos: was: %d is: %d \n",
766 len, nlen, rlen, nrlen);
768 fprintf(fd, "Read: BufSize: %d BufContent: [%s]\n\n*************\n",
769 StrLength(Target), ChrPtr(Target));
772 if ((rc < 0) && (Error != NULL))
773 CtdlLogPrintf(CTDL_CRIT,
784 * client_getln() ... Get a LF-terminated line of text from the client.
785 * (This is implemented in terms of client_read() and could be
786 * justifiably moved out of sysdep.c)
788 int client_getln(char *buf, int bufsize)
794 retval = CtdlClientGetLine(CCC->MigrateBuf);
799 i = StrLength(CCC->MigrateBuf);
800 pCh = ChrPtr(CCC->MigrateBuf);
801 /* Strip the trailing LF, and the trailing CR if present.
806 && ( (pCh[i - 1]==13)
807 || ( pCh[i - 1]==10)) ) {
813 FlushStrBuf(CCC->MigrateBuf);
815 safestrncpy(&buf[i], "000", bufsize - i);
822 * Cleanup any contexts that are left lying around
826 void close_masters (void)
828 struct ServiceFunctionHook *serviceptr;
831 * close all protocol master sockets
833 for (serviceptr = ServiceHookTable; serviceptr != NULL;
834 serviceptr = serviceptr->next ) {
836 if (serviceptr->tcp_port > 0)
838 CtdlLogPrintf(CTDL_INFO, "Closing listener on port %d\n",
839 serviceptr->tcp_port);
840 serviceptr->tcp_port = 0;
843 if (serviceptr->sockpath != NULL)
844 CtdlLogPrintf(CTDL_INFO, "Closing listener on '%s'\n",
845 serviceptr->sockpath);
847 close(serviceptr->msock);
848 /* If it's a Unix domain socket, remove the file. */
849 if (serviceptr->sockpath != NULL) {
850 unlink(serviceptr->sockpath);
851 serviceptr->sockpath = NULL;
858 * The system-dependent part of master_cleanup() - close the master socket.
860 void sysdep_master_cleanup(void) {
869 CtdlDestroyProtoHooks();
870 CtdlDestroyDeleteHooks();
871 CtdlDestroyXmsgHooks();
872 CtdlDestroyNetprocHooks();
873 CtdlDestroyUserHooks();
874 CtdlDestroyMessageHook();
875 CtdlDestroyCleanupHooks();
876 CtdlDestroyFixedOutputHooks();
877 CtdlDestroySessionHooks();
878 CtdlDestroyServiceHook();
879 CtdlDestroyRoomHooks();
880 #ifdef HAVE_BACKTRACE
888 void graceful_shutdown(int signum) {
889 kill(current_child, signum);
890 unlink(file_pid_file);
895 int nFireUpsNonRestart = 0;
899 * Start running as a daemon.
901 void start_daemon(int unused) {
909 /* Close stdin/stdout/stderr and replace them with /dev/null.
910 * We don't just call close() because we don't want these fd's
911 * to be reused for other files.
913 if (chdir(ctdl_run_dir) != 0)
914 CtdlLogPrintf(CTDL_EMERG,
915 "unable to change into directory [%s]: %s",
916 ctdl_run_dir, strerror(errno));
923 signal(SIGHUP, SIG_IGN);
924 signal(SIGINT, SIG_IGN);
925 signal(SIGQUIT, SIG_IGN);
929 if ((freopen("/dev/null", "r", stdin) != stdin) ||
930 (freopen("/dev/null", "w", stdout) != stdout) ||
931 (freopen("/dev/null", "w", stderr) != stderr))
932 CtdlLogPrintf(CTDL_EMERG,
933 "unable to reopen stdin/out/err %s",
938 current_child = fork();
940 signal(SIGTERM, graceful_shutdown);
942 if (current_child < 0) {
947 else if (current_child == 0) {
948 return; /* continue starting citadel. */
952 fp = fopen(file_pid_file, "w");
954 fprintf(fp, ""F_PID_T"\n", getpid());
957 waitpid(current_child, &status, 0);
960 nFireUpsNonRestart = nFireUps;
962 /* Exit code 0 means the watcher should exit */
963 if (WIFEXITED(status) && (WEXITSTATUS(status) == CTDLEXIT_SHUTDOWN)) {
967 /* Exit code 101-109 means the watcher should exit */
968 else if (WIFEXITED(status) && (WEXITSTATUS(status) >= 101) && (WEXITSTATUS(status) <= 109)) {
972 /* Any other exit code, or no exit code, means we should restart. */
976 ForkedPid = current_child;
979 } while (do_restart);
981 unlink(file_pid_file);
982 exit(WEXITSTATUS(status));
987 void checkcrash(void)
989 if (nFireUpsNonRestart != nFireUps)
993 CrashMail = NewStrBuf();
994 CtdlLogPrintf(CTDL_ALERT, "Posting crash message\n");
995 StrBufPrintf(CrashMail,
997 " The Citadel server process (citserver) terminated unexpectedly."
999 " This could be the result of a bug in the server program, or some external "
1001 " You can obtain more information about this by enabling core dumps.\n \n"
1002 " For more information, please see:\n \n"
1003 " http://citadel.org/doku.php/faq:mastering_your_os:gdb#how.do.i.make.my.system.produce.core-files"
1006 " If you have already done this, the core dump is likely to be found at %score.%d\n"
1008 ctdl_run_dir, ForkedPid);
1009 CtdlAideMessage(ChrPtr(CrashMail), "Citadel server process terminated unexpectedly");
1010 FreeStrBuf(&CrashMail);
1016 * Generic routine to convert a login name to a full name (gecos)
1017 * Returns nonzero if a conversion took place
1019 int convert_login(char NameToConvert[]) {
1023 pw = getpwnam(NameToConvert);
1028 strcpy(NameToConvert, pw->pw_gecos);
1029 for (a=0; a<strlen(NameToConvert); ++a) {
1030 if (NameToConvert[a] == ',') NameToConvert[a] = 0;
1039 * This loop just keeps going and going and going...
1043 * This current implimentation of worker_thread creates a bottle neck in several situations
1044 * The first thing to remember is that a single thread can handle more than one connection at a time.
1045 * More threads mean less memory for the system to run in.
1046 * So for efficiency we want every thread to be doing something useful or waiting in the main loop for
1047 * something to happen anywhere.
1048 * This current implimentation requires worker threads to wait in other locations, after it has
1049 * been committed to a single connection which is very wasteful.
1050 * As an extreme case consider this:
1051 * A slow client connects and this slow client sends only one character each second.
1052 * With this current implimentation a single worker thread is dispatched to handle that connection
1053 * until such times as the client timeout expires, an error occurs on the socket or the client
1054 * completes its transmission.
1055 * THIS IS VERY BAD since that thread could have handled a read from many more clients in each one
1056 * second interval between chars.
1058 * It is my intention to re-write this code and the associated client_getln, client_read functions
1059 * to allow any thread to read data on behalf of any connection (context).
1060 * To do this I intend to have this main loop read chars into a buffer stored in the context.
1061 * Once the correct criteria for a full buffer is met then we will dispatch a thread to
1063 * This worker thread loop also needs to be able to handle binary data.
1066 void *worker_thread(void *arg) {
1069 CitContext *bind_me = NULL;
1073 int force_purge = 0;
1076 while (!CtdlThreadCheckStop()) {
1078 /* make doubly sure we're not holding any stale db handles
1079 * which might cause a deadlock.
1081 cdb_check_handles();
1082 do_select: force_purge = 0;
1083 bind_me = NULL; /* Which session shall we handle? */
1085 /* Initialize the fdset. */
1089 begin_critical_section(S_SESSION_TABLE);
1090 for (ptr = ContextList; ptr != NULL; ptr = ptr->next) {
1092 client_socket = ptr->client_socket;
1093 /* Dont select on dead sessions only truly idle ones */
1094 if ((ptr->state == CON_IDLE) &&
1095 (CC->kill_me == 0) &&
1096 (client_socket != -1))
1098 FD_SET(client_socket, &readfds);
1099 if (client_socket > highest)
1100 highest = client_socket;
1102 if ((bind_me == NULL) && (ptr->state == CON_READY)) {
1104 ptr->state = CON_EXECUTING;
1107 if ((bind_me == NULL) && (ptr->state == CON_GREETING)) {
1109 ptr->state = CON_STARTING;
1113 end_critical_section(S_SESSION_TABLE);
1119 /* If we got this far, it means that there are no sessions
1120 * which a previous thread marked for attention, so we go
1121 * ahead and get ready to select().
1124 if (!CtdlThreadCheckStop()) {
1125 tv.tv_sec = 1; /* wake up every second if no input */
1127 retval = CtdlThreadSelect(highest + 1, &readfds, NULL, NULL, &tv);
1132 /* Now figure out who made this select() unblock.
1133 * First, check for an error or exit condition.
1136 if (errno == EBADF) {
1137 CtdlLogPrintf(CTDL_NOTICE, "select() failed: (%s)\n",
1141 if (errno != EINTR) {
1142 CtdlLogPrintf(CTDL_EMERG, "Exiting (%s)\n", strerror(errno));
1143 CtdlThreadStopAll();
1146 CtdlLogPrintf(CTDL_DEBUG, "Interrupted CtdlThreadSelect.\n");
1147 if (CtdlThreadCheckStop()) return(NULL);
1151 else if(retval == 0) {
1152 if (CtdlThreadCheckStop()) return(NULL);
1155 /* It must be a client socket. Find a context that has data
1156 * waiting on its socket *and* is in the CON_IDLE state. Any
1157 * active sockets other than our chosen one are marked as
1158 * CON_READY so the next thread that comes around can just bind
1159 * to one without having to select() again.
1161 begin_critical_section(S_SESSION_TABLE);
1162 for (ptr = ContextList; ptr != NULL; ptr = ptr->next) {
1163 int checkfd = ptr->client_socket;
1164 if ((checkfd != -1) && (ptr->state == CON_IDLE) ){
1165 if (FD_ISSET(checkfd, &readfds)) {
1166 ptr->input_waiting = 1;
1168 bind_me = ptr; /* I choose you! */
1169 bind_me->state = CON_EXECUTING;
1172 ptr->state = CON_READY;
1174 } else if ((ptr->is_async) && (ptr->async_waiting) && (ptr->h_async_function)) {
1176 bind_me = ptr; /* I choose you! */
1177 bind_me->state = CON_EXECUTING;
1180 ptr->state = CON_READY;
1185 end_critical_section(S_SESSION_TABLE);
1188 /* We're bound to a session */
1189 if (bind_me != NULL) {
1190 become_session(bind_me);
1192 if (bind_me->state == CON_STARTING) {
1193 bind_me->state = CON_EXECUTING;
1194 begin_session(bind_me);
1195 bind_me->h_greeting_function();
1197 /* If the client has sent a command, execute it. */
1198 if (CC->input_waiting) {
1199 CC->h_command_function();
1201 while (HaveMoreLinesWaiting(CC))
1202 CC->h_command_function();
1204 CC->input_waiting = 0;
1207 /* If there are asynchronous messages waiting and the
1208 * client supports it, do those now */
1209 if ((CC->is_async) && (CC->async_waiting)
1210 && (CC->h_async_function != NULL)) {
1211 CC->h_async_function();
1212 CC->async_waiting = 0;
1215 force_purge = CC->kill_me;
1216 become_session(NULL);
1217 bind_me->state = CON_IDLE;
1220 dead_session_purge(force_purge);
1223 /* If control reaches this point, the server is shutting down */
1231 * A function to handle selecting on master sockets.
1232 * In other words it handles new connections.
1235 void *select_on_master (void *arg)
1237 struct ServiceFunctionHook *serviceptr;
1241 int ssock; /* Descriptor for client socket */
1242 CitContext *con= NULL; /* Temporary context pointer */
1247 while (!CtdlThreadCheckStop()) {
1248 /* Initialize the fdset. */
1249 FD_ZERO(&master_fds);
1252 /* First, add the various master sockets to the fdset. */
1253 for (serviceptr = ServiceHookTable; serviceptr != NULL;
1254 serviceptr = serviceptr->next ) {
1255 m = serviceptr->msock;
1256 FD_SET(m, &master_fds);
1262 if (!CtdlThreadCheckStop()) {
1263 tv.tv_sec = 60; /* wake up every second if no input */
1265 retval = CtdlThreadSelect(highest + 1, &master_fds, NULL, NULL, &tv);
1270 /* Now figure out who made this select() unblock.
1271 * First, check for an error or exit condition.
1274 if (errno == EBADF) {
1275 CtdlLogPrintf(CTDL_NOTICE, "select() failed: (%s)\n",
1279 if (errno != EINTR) {
1280 CtdlLogPrintf(CTDL_EMERG, "Exiting (%s)\n", strerror(errno));
1281 CtdlThreadStopAll();
1283 CtdlLogPrintf(CTDL_DEBUG, "Interrupted CtdlThreadSelect.\n");
1284 if (CtdlThreadCheckStop()) return(NULL);
1288 else if(retval == 0) {
1289 if (CtdlThreadCheckStop()) return(NULL);
1292 /* Next, check to see if it's a new client connecting
1293 * on a master socket.
1295 else for (serviceptr = ServiceHookTable; serviceptr != NULL;
1296 serviceptr = serviceptr->next ) {
1298 if (FD_ISSET(serviceptr->msock, &master_fds)) {
1299 ssock = accept(serviceptr->msock, NULL, 0);
1301 CtdlLogPrintf(CTDL_DEBUG,
1302 "New client socket %d\n",
1305 /* The master socket is non-blocking but the client
1306 * sockets need to be blocking, otherwise certain
1307 * operations barf on FreeBSD. Not a fatal error.
1309 if (fcntl(ssock, F_SETFL, 0) < 0) {
1310 CtdlLogPrintf(CTDL_EMERG,
1311 "citserver: Can't set socket to blocking: %s\n",
1315 /* New context will be created already
1316 * set up in the CON_EXECUTING state.
1318 con = CreateNewContext();
1320 /* Assign our new socket number to it. */
1321 con->client_socket = ssock;
1322 con->h_command_function =
1323 serviceptr->h_command_function;
1324 con->h_async_function =
1325 serviceptr->h_async_function;
1326 con->h_greeting_function = serviceptr->h_greeting_function;
1328 serviceptr->ServiceName;
1330 /* Determine whether it's a local socket */
1331 if (serviceptr->sockpath != NULL)
1332 con->is_local_socket = 1;
1334 /* Set the SO_REUSEADDR socket option */
1336 setsockopt(ssock, SOL_SOCKET,
1340 con->state = CON_GREETING;
1356 * Translate text facility name to syslog.h defined value.
1358 int SyslogFacility(char *name)
1367 { LOG_KERN, "kern" },
1368 { LOG_USER, "user" },
1369 { LOG_MAIL, "mail" },
1370 { LOG_DAEMON, "daemon" },
1371 { LOG_AUTH, "auth" },
1372 { LOG_SYSLOG, "syslog" },
1374 { LOG_NEWS, "news" },
1375 { LOG_UUCP, "uucp" },
1376 { LOG_LOCAL0, "local0" },
1377 { LOG_LOCAL1, "local1" },
1378 { LOG_LOCAL2, "local2" },
1379 { LOG_LOCAL3, "local3" },
1380 { LOG_LOCAL4, "local4" },
1381 { LOG_LOCAL5, "local5" },
1382 { LOG_LOCAL6, "local6" },
1383 { LOG_LOCAL7, "local7" },
1386 for(i = 0; facTbl[i].name != NULL; i++) {
1387 if(!strcasecmp(name, facTbl[i].name))
1388 return facTbl[i].facility;
1395 /********** MEM CHEQQER ***********/
1397 #ifdef DEBUG_MEMORY_LEAKS
1404 void *tracked_malloc(size_t size, char *file, int line) {
1405 struct igheap *thisheap;
1408 block = malloc(size);
1409 if (block == NULL) return(block);
1411 thisheap = malloc(sizeof(struct igheap));
1412 if (thisheap == NULL) {
1417 thisheap->block = block;
1418 strcpy(thisheap->file, file);
1419 thisheap->line = line;
1421 begin_critical_section(S_DEBUGMEMLEAKS);
1422 thisheap->next = igheap;
1424 end_critical_section(S_DEBUGMEMLEAKS);
1430 void *tracked_realloc(void *ptr, size_t size, char *file, int line) {
1431 struct igheap *thisheap;
1434 block = realloc(ptr, size);
1435 if (block == NULL) return(block);
1437 thisheap = malloc(sizeof(struct igheap));
1438 if (thisheap == NULL) {
1443 thisheap->block = block;
1444 strcpy(thisheap->file, file);
1445 thisheap->line = line;
1447 begin_critical_section(S_DEBUGMEMLEAKS);
1448 thisheap->next = igheap;
1450 end_critical_section(S_DEBUGMEMLEAKS);
1457 void tracked_free(void *ptr) {
1458 struct igheap *thisheap;
1459 struct igheap *trash;
1463 if (igheap == NULL) return;
1464 begin_critical_section(S_DEBUGMEMLEAKS);
1465 for (thisheap = igheap; thisheap != NULL; thisheap = thisheap->next) {
1466 if (thisheap->next != NULL) {
1467 if (thisheap->next->block == ptr) {
1468 trash = thisheap->next;
1469 thisheap->next = thisheap->next->next;
1474 if (igheap->block == ptr) {
1476 igheap = igheap->next;
1479 end_critical_section(S_DEBUGMEMLEAKS);
1482 char *tracked_strdup(const char *s, char *file, int line) {
1485 if (s == NULL) return(NULL);
1486 ptr = tracked_malloc(strlen(s) + 1, file, line);
1487 if (ptr == NULL) return(NULL);
1488 strncpy(ptr, s, strlen(s));
1492 void dump_heap(void) {
1493 struct igheap *thisheap;
1495 for (thisheap = igheap; thisheap != NULL; thisheap = thisheap->next) {
1496 CtdlLogPrintf(CTDL_CRIT, "UNFREED: %30s : %d\n",
1497 thisheap->file, thisheap->line);
1501 #endif /* DEBUG_MEMORY_LEAKS */