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;
175 * Some initialization stuff...
177 void init_sysdep(void) {
180 /* Avoid vulnerabilities related to FD_SETSIZE if we can. */
184 getrlimit(RLIMIT_NOFILE, &rl);
185 rl.rlim_cur = FD_SETSIZE;
186 rl.rlim_max = FD_SETSIZE;
187 setrlimit(RLIMIT_NOFILE, &rl);
191 /* If we've got OpenSSL, we're going to use it. */
197 * Set up a place to put thread-specific data.
198 * We only need a single pointer per thread - it points to the
199 * CitContext structure (in the ContextList linked list) of the
200 * session to which the calling thread is currently bound.
202 if (citthread_key_create(&MyConKey, NULL) != 0) {
203 CtdlLogPrintf(CTDL_CRIT, "Can't create TSD key: %s\n",
208 * The action for unexpected signals and exceptions should be to
209 * call signal_cleanup() to gracefully shut down the server.
212 sigaddset(&set, SIGINT);
213 sigaddset(&set, SIGQUIT);
214 sigaddset(&set, SIGHUP);
215 sigaddset(&set, SIGTERM);
216 // sigaddset(&set, SIGSEGV); commented out because
217 // sigaddset(&set, SIGILL); we want core dumps
218 // sigaddset(&set, SIGBUS);
219 sigprocmask(SIG_UNBLOCK, &set, NULL);
221 signal(SIGINT, signal_cleanup);
222 signal(SIGQUIT, signal_cleanup);
223 signal(SIGHUP, signal_cleanup);
224 signal(SIGTERM, signal_cleanup);
225 // signal(SIGSEGV, signal_cleanup); commented out because
226 // signal(SIGILL, signal_cleanup); we want core dumps
227 // signal(SIGBUS, signal_cleanup);
230 * Do not shut down the server on broken pipe signals, otherwise the
231 * whole Citadel service would come down whenever a single client
234 signal(SIGPIPE, SIG_IGN);
241 * This is a generic function to set up a master socket for listening on
242 * a TCP port. The server shuts down if the bind fails.
245 int ig_tcp_server(char *ip_addr, int port_number, int queue_len, char **errormessage)
247 struct sockaddr_in sin;
249 int actual_queue_len;
251 actual_queue_len = queue_len;
252 if (actual_queue_len < 5) actual_queue_len = 5;
254 memset(&sin, 0, sizeof(sin));
255 sin.sin_family = AF_INET;
256 sin.sin_port = htons((u_short)port_number);
257 if (ip_addr == NULL) {
258 sin.sin_addr.s_addr = INADDR_ANY;
261 sin.sin_addr.s_addr = inet_addr(ip_addr);
264 if (sin.sin_addr.s_addr == !INADDR_ANY) {
265 sin.sin_addr.s_addr = INADDR_ANY;
268 s = socket(PF_INET, SOCK_STREAM, IPPROTO_TCP);
271 *errormessage = (char*) malloc(SIZ + 1);
272 snprintf(*errormessage, SIZ,
273 "citserver: Can't create a socket: %s",
275 CtdlLogPrintf(CTDL_EMERG, "%s\n", *errormessage);
280 setsockopt(s, SOL_SOCKET, SO_REUSEADDR, &i, sizeof(i));
282 if (bind(s, (struct sockaddr *)&sin, sizeof(sin)) < 0) {
283 *errormessage = (char*) malloc(SIZ + 1);
284 snprintf(*errormessage, SIZ,
285 "citserver: Can't bind: %s",
287 CtdlLogPrintf(CTDL_EMERG, "%s\n", *errormessage);
292 /* set to nonblock - we need this for some obscure situations */
293 if (fcntl(s, F_SETFL, O_NONBLOCK) < 0) {
294 *errormessage = (char*) malloc(SIZ + 1);
295 snprintf(*errormessage, SIZ,
296 "citserver: Can't set socket to non-blocking: %s",
298 CtdlLogPrintf(CTDL_EMERG, "%s\n", *errormessage);
303 if (listen(s, actual_queue_len) < 0) {
304 *errormessage = (char*) malloc(SIZ + 1);
305 snprintf(*errormessage, SIZ,
306 "citserver: Can't listen: %s",
308 CtdlLogPrintf(CTDL_EMERG, "%s\n", *errormessage);
319 * Create a Unix domain socket and listen on it
321 int ig_uds_server(char *sockpath, int queue_len, char **errormessage)
323 struct sockaddr_un addr;
326 int actual_queue_len;
327 #ifdef HAVE_STRUCT_UCRED
331 actual_queue_len = queue_len;
332 if (actual_queue_len < 5) actual_queue_len = 5;
334 i = unlink(sockpath);
335 if ((i != 0) && (errno != ENOENT)) {
336 *errormessage = (char*) malloc(SIZ + 1);
337 snprintf(*errormessage, SIZ, "citserver: can't unlink %s: %s",
338 sockpath, strerror(errno));
339 CtdlLogPrintf(CTDL_EMERG, "%s\n", *errormessage);
343 memset(&addr, 0, sizeof(addr));
344 addr.sun_family = AF_UNIX;
345 safestrncpy(addr.sun_path, sockpath, sizeof addr.sun_path);
347 s = socket(AF_UNIX, SOCK_STREAM, 0);
349 *errormessage = (char*) malloc(SIZ + 1);
350 snprintf(*errormessage, SIZ,
351 "citserver: Can't create a socket: %s",
353 CtdlLogPrintf(CTDL_EMERG, "%s\n", *errormessage);
357 if (bind(s, (struct sockaddr *)&addr, sizeof(addr)) < 0) {
358 *errormessage = (char*) malloc(SIZ + 1);
359 snprintf(*errormessage, SIZ,
360 "citserver: Can't bind: %s",
362 CtdlLogPrintf(CTDL_EMERG, "%s\n", *errormessage);
366 /* set to nonblock - we need this for some obscure situations */
367 if (fcntl(s, F_SETFL, O_NONBLOCK) < 0) {
368 *errormessage = (char*) malloc(SIZ + 1);
369 snprintf(*errormessage, SIZ,
370 "citserver: Can't set socket to non-blocking: %s",
372 CtdlLogPrintf(CTDL_EMERG, "%s\n", *errormessage);
377 if (listen(s, actual_queue_len) < 0) {
378 *errormessage = (char*) malloc(SIZ + 1);
379 snprintf(*errormessage, SIZ,
380 "citserver: Can't listen: %s",
382 CtdlLogPrintf(CTDL_EMERG, "%s\n", *errormessage);
386 #ifdef HAVE_STRUCT_UCRED
387 setsockopt(s, SOL_SOCKET, SO_PASSCRED, &passcred, sizeof(passcred));
390 chmod(sockpath, S_ISGID|S_IRUSR|S_IWUSR|S_IXUSR|S_IRGRP|S_IWGRP|S_IXGRP|S_IROTH|S_IWOTH|S_IXOTH);
397 * The following functions implement output buffering on operating systems which
398 * support it (such as Linux and various BSD flavors).
402 # define HAVE_TCP_BUFFERING
405 # define HAVE_TCP_BUFFERING
406 # define TCP_CORK TCP_NOPUSH
408 #endif /* TCP_CORK */
409 #endif /* HAVE_DARWIN */
411 static unsigned on = 1, off = 0;
413 void buffer_output(void) {
414 #ifdef HAVE_TCP_BUFFERING
416 if (!CC->redirect_ssl)
418 setsockopt(CC->client_socket, IPPROTO_TCP, TCP_CORK, &on, 4);
422 void unbuffer_output(void) {
423 #ifdef HAVE_TCP_BUFFERING
425 if (!CC->redirect_ssl)
427 setsockopt(CC->client_socket, IPPROTO_TCP, TCP_CORK, &off, 4);
431 void flush_output(void) {
432 #ifdef HAVE_TCP_BUFFERING
433 struct CitContext *CCC = CC;
434 setsockopt(CCC->client_socket, IPPROTO_TCP, TCP_CORK, &off, 4);
435 setsockopt(CCC->client_socket, IPPROTO_TCP, TCP_CORK, &on, 4);
439 static void flush_client_inbuf(void)
443 FlushStrBuf(CCC->ReadBuf);
449 * client_write() ... Send binary data to the client.
451 int client_write(const char *buf, int nbytes)
453 int bytes_written = 0;
455 #ifndef HAVE_TCP_BUFFERING
456 int old_buffer_len = 0;
462 // flush_client_inbuf();
464 if (Ctx->redirect_buffer != NULL) {
465 if ((Ctx->redirect_len + nbytes + 2) >= Ctx->redirect_alloc) {
466 Ctx->redirect_alloc = (Ctx->redirect_alloc * 2) + nbytes;
467 Ctx->redirect_buffer = realloc(Ctx->redirect_buffer,
468 Ctx->redirect_alloc);
470 memcpy(&Ctx->redirect_buffer[Ctx->redirect_len], buf, nbytes);
471 Ctx->redirect_len += nbytes;
472 Ctx->redirect_buffer[Ctx->redirect_len] = 0;
477 if (Ctx->redirect_ssl) {
478 client_write_ssl(buf, nbytes);
482 if (Ctx->client_socket == -1) return -1;
484 fdflags = fcntl(Ctx->client_socket, F_GETFL);
486 while ((bytes_written < nbytes) && (Ctx->client_socket != -1)){
487 if ((fdflags & O_NONBLOCK) == O_NONBLOCK) {
489 FD_SET(Ctx->client_socket, &wset);
490 if (select(1, NULL, &wset, NULL, NULL) == -1) {
493 CtdlLogPrintf(CTDL_DEBUG, "client_write(%d bytes) select() interrupted.\n", nbytes-bytes_written);
494 if (CtdlThreadCheckStop()) {
498 /* can't trust fd's and stuff so we need to re-create them */
502 CtdlLogPrintf(CTDL_ERR,
503 "client_write(%d bytes) select failed: %s (%d)\n",
504 nbytes - bytes_written,
505 strerror(errno), errno);
513 retval = write(Ctx->client_socket, &buf[bytes_written],
514 nbytes - bytes_written);
516 CtdlLogPrintf(CTDL_ERR,
517 "client_write(%d bytes) failed: %s (%d)\n",
518 nbytes - bytes_written,
519 strerror(errno), errno);
521 // CtdlLogPrintf(CTDL_DEBUG, "Tried to send: %s", &buf[bytes_written]);
525 bytes_written = bytes_written + retval;
530 void cputbuf(const StrBuf *Buf) {
531 client_write(ChrPtr(Buf), StrLength(Buf));
536 * cprintf() Send formatted printable data to the client.
537 * Implemented in terms of client_write() so it's technically not sysdep...
539 void cprintf(const char *format, ...) {
543 va_start(arg_ptr, format);
544 if (vsnprintf(buf, sizeof buf, format, arg_ptr) == -1)
545 buf[sizeof buf - 2] = '\n';
546 client_write(buf, strlen(buf));
552 * Read data from the client socket.
554 * sock socket fd to read from
555 * buf buffer to read into
556 * bytes number of bytes to read
557 * timeout Number of seconds to wait before timing out
559 * Possible return values:
560 * 1 Requested number of bytes has been read.
561 * 0 Request timed out.
562 * -1 Connection is broken, or other error.
564 int client_read_blob(StrBuf *Target, int bytes, int timeout)
571 if (CCC->redirect_ssl) {
572 retval = client_read_sslblob(Target, bytes, timeout);
577 retval = StrBufReadBLOBBuffered(Target,
586 CtdlLogPrintf(CTDL_CRIT,
596 snprintf(fn, SIZ, "/tmp/foolog_%s.%d", CCC->ServiceName, CCC->cs_pid);
598 fd = fopen(fn, "a+");
599 fprintf(fd, "Read: BufSize: %d BufContent: [",
601 fwrite(ChrPtr(Target), StrLength(Target), 1, fd);
608 return retval == bytes;
611 int client_read_to(char *buf, int bytes, int timeout)
616 rc = client_read_blob(CCC->MigrateBuf, bytes, timeout);
625 ChrPtr(CCC->MigrateBuf),
626 StrLength(CCC->MigrateBuf) + 1);
627 FlushStrBuf(CCC->MigrateBuf);
633 int HaveMoreLinesWaiting(CitContext *CCC)
635 if ((CCC->Pos == NULL) && (StrLength(CCC->ReadBuf) == 0))
643 * Read data from the client socket with default timeout.
644 * (This is implemented in terms of client_read_to() and could be
645 * justifiably moved out of sysdep.c)
647 INLINE int client_read(char *buf, int bytes)
649 return(client_read_to(buf, bytes, config.c_sleeping));
652 int CtdlClientGetLine(StrBuf *Target)
660 if (CCC->redirect_ssl) {
661 return client_readline_sslbuffer(Target,
670 int len, rlen, nlen, nrlen;
673 snprintf(fn, SIZ, "/tmp/foolog_%s.%d", CCC->ServiceName, CCC->cs_pid);
675 fd = fopen(fn, "a+");
676 pch = ChrPtr(CCC->ReadBuf);
677 len = StrLength(CCC->ReadBuf);
678 if (CCC->Pos != NULL)
679 rlen = CC->Pos - pch;
683 /* fprintf(fd, "\n\n\nBufSize: %d BufPos: %d \nBufContent: [%s]\n\n_____________________\n",
686 fprintf(fd, "\n\n\nBufSize: %d BufPos: %d \n_____________________\n",
688 rc = StrBufTCP_read_buffered_line_fast(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,
724 * client_getln() ... Get a LF-terminated line of text from the client.
725 * (This is implemented in terms of client_read() and could be
726 * justifiably moved out of sysdep.c)
728 int client_getln(char *buf, int bufsize)
734 retval = CtdlClientGetLine(CCC->MigrateBuf);
736 i = StrLength(CCC->MigrateBuf);
737 pCh = ChrPtr(CCC->MigrateBuf);
738 /* Strip the trailing LF, and the trailing CR if present.
743 && ( (pCh[i - 1]==13)
744 || ( pCh[i - 1]==10)) ) {
750 FlushStrBuf(CCC->MigrateBuf);
752 safestrncpy(&buf[i], "000", bufsize - i);
759 * Cleanup any contexts that are left lying around
763 void close_masters (void)
765 struct ServiceFunctionHook *serviceptr;
768 * close all protocol master sockets
770 for (serviceptr = ServiceHookTable; serviceptr != NULL;
771 serviceptr = serviceptr->next ) {
773 if (serviceptr->tcp_port > 0)
775 CtdlLogPrintf(CTDL_INFO, "Closing listener on port %d\n",
776 serviceptr->tcp_port);
777 serviceptr->tcp_port = 0;
780 if (serviceptr->sockpath != NULL)
781 CtdlLogPrintf(CTDL_INFO, "Closing listener on '%s'\n",
782 serviceptr->sockpath);
784 close(serviceptr->msock);
785 /* If it's a Unix domain socket, remove the file. */
786 if (serviceptr->sockpath != NULL) {
787 unlink(serviceptr->sockpath);
788 serviceptr->sockpath = NULL;
795 * The system-dependent part of master_cleanup() - close the master socket.
797 void sysdep_master_cleanup(void) {
806 CtdlDestroyProtoHooks();
807 CtdlDestroyDeleteHooks();
808 CtdlDestroyXmsgHooks();
809 CtdlDestroyNetprocHooks();
810 CtdlDestroyUserHooks();
811 CtdlDestroyMessageHook();
812 CtdlDestroyCleanupHooks();
813 CtdlDestroyFixedOutputHooks();
814 CtdlDestroySessionHooks();
815 CtdlDestroyServiceHook();
816 CtdlDestroyRoomHooks();
817 #ifdef HAVE_BACKTRACE
825 void graceful_shutdown(int signum) {
826 kill(current_child, signum);
827 unlink(file_pid_file);
832 int nFireUpsNonRestart = 0;
836 * Start running as a daemon.
838 void start_daemon(int unused) {
846 /* Close stdin/stdout/stderr and replace them with /dev/null.
847 * We don't just call close() because we don't want these fd's
848 * to be reused for other files.
850 if (chdir(ctdl_run_dir) != 0)
851 CtdlLogPrintf(CTDL_EMERG,
852 "unable to change into directory [%s]: %s",
853 ctdl_run_dir, strerror(errno));
860 signal(SIGHUP, SIG_IGN);
861 signal(SIGINT, SIG_IGN);
862 signal(SIGQUIT, SIG_IGN);
866 if ((freopen("/dev/null", "r", stdin) != stdin) ||
867 (freopen("/dev/null", "w", stdout) != stdout) ||
868 (freopen("/dev/null", "w", stderr) != stderr))
869 CtdlLogPrintf(CTDL_EMERG,
870 "unable to reopen stdin/out/err %s",
875 current_child = fork();
877 signal(SIGTERM, graceful_shutdown);
879 if (current_child < 0) {
884 else if (current_child == 0) {
885 return; /* continue starting citadel. */
889 fp = fopen(file_pid_file, "w");
891 fprintf(fp, ""F_PID_T"\n", getpid());
894 waitpid(current_child, &status, 0);
897 nFireUpsNonRestart = nFireUps;
899 /* Exit code 0 means the watcher should exit */
900 if (WIFEXITED(status) && (WEXITSTATUS(status) == CTDLEXIT_SHUTDOWN)) {
904 /* Exit code 101-109 means the watcher should exit */
905 else if (WIFEXITED(status) && (WEXITSTATUS(status) >= 101) && (WEXITSTATUS(status) <= 109)) {
909 /* Any other exit code, or no exit code, means we should restart. */
913 ForkedPid = current_child;
916 } while (do_restart);
918 unlink(file_pid_file);
919 exit(WEXITSTATUS(status));
924 void checkcrash(void)
926 if (nFireUpsNonRestart != nFireUps)
930 CrashMail = NewStrBuf();
931 CtdlLogPrintf(CTDL_ALERT, "Posting crash message\n");
932 StrBufPrintf(CrashMail,
934 " The Citadel server process (citserver) terminated unexpectedly."
936 " This could be the result of a bug in the server program, or some external "
938 " You can obtain more information about this by enabling core dumps.\n \n"
939 " For more information, please see:\n \n"
940 " http://citadel.org/doku.php/faq:mastering_your_os:gdb#how.do.i.make.my.system.produce.core-files"
943 " If you have already done this, the core dump is likely to be found at %score.%d\n"
945 ctdl_run_dir, ForkedPid);
946 CtdlAideMessage(ChrPtr(CrashMail), "Citadel server process terminated unexpectedly");
947 FreeStrBuf(&CrashMail);
953 * Generic routine to convert a login name to a full name (gecos)
954 * Returns nonzero if a conversion took place
956 int convert_login(char NameToConvert[]) {
960 pw = getpwnam(NameToConvert);
965 strcpy(NameToConvert, pw->pw_gecos);
966 for (a=0; a<strlen(NameToConvert); ++a) {
967 if (NameToConvert[a] == ',') NameToConvert[a] = 0;
976 * This loop just keeps going and going and going...
980 * This current implimentation of worker_thread creates a bottle neck in several situations
981 * The first thing to remember is that a single thread can handle more than one connection at a time.
982 * More threads mean less memory for the system to run in.
983 * So for efficiency we want every thread to be doing something useful or waiting in the main loop for
984 * something to happen anywhere.
985 * This current implimentation requires worker threads to wait in other locations, after it has
986 * been committed to a single connection which is very wasteful.
987 * As an extreme case consider this:
988 * A slow client connects and this slow client sends only one character each second.
989 * With this current implimentation a single worker thread is dispatched to handle that connection
990 * until such times as the client timeout expires, an error occurs on the socket or the client
991 * completes its transmission.
992 * THIS IS VERY BAD since that thread could have handled a read from many more clients in each one
993 * second interval between chars.
995 * It is my intention to re-write this code and the associated client_getln, client_read functions
996 * to allow any thread to read data on behalf of any connection (context).
997 * To do this I intend to have this main loop read chars into a buffer stored in the context.
998 * Once the correct criteria for a full buffer is met then we will dispatch a thread to
1000 * This worker thread loop also needs to be able to handle binary data.
1003 void *worker_thread(void *arg) {
1006 CitContext *bind_me = NULL;
1010 int force_purge = 0;
1013 while (!CtdlThreadCheckStop()) {
1015 /* make doubly sure we're not holding any stale db handles
1016 * which might cause a deadlock.
1018 cdb_check_handles();
1019 do_select: force_purge = 0;
1020 bind_me = NULL; /* Which session shall we handle? */
1022 /* Initialize the fdset. */
1026 begin_critical_section(S_SESSION_TABLE);
1027 for (ptr = ContextList; ptr != NULL; ptr = ptr->next) {
1029 client_socket = ptr->client_socket;
1030 /* Dont select on dead sessions only truly idle ones */
1031 if ((ptr->state == CON_IDLE) &&
1032 (CC->kill_me == 0) &&
1033 (client_socket != -1))
1035 FD_SET(client_socket, &readfds);
1036 if (client_socket > highest)
1037 highest = client_socket;
1039 if ((bind_me == NULL) && (ptr->state == CON_READY)) {
1041 ptr->state = CON_EXECUTING;
1044 if ((bind_me == NULL) && (ptr->state == CON_GREETING)) {
1046 ptr->state = CON_STARTING;
1050 end_critical_section(S_SESSION_TABLE);
1056 /* If we got this far, it means that there are no sessions
1057 * which a previous thread marked for attention, so we go
1058 * ahead and get ready to select().
1061 if (!CtdlThreadCheckStop()) {
1062 tv.tv_sec = 1; /* wake up every second if no input */
1064 retval = CtdlThreadSelect(highest + 1, &readfds, NULL, NULL, &tv);
1069 /* Now figure out who made this select() unblock.
1070 * First, check for an error or exit condition.
1073 if (errno == EBADF) {
1074 CtdlLogPrintf(CTDL_NOTICE, "select() failed: (%s)\n",
1078 if (errno != EINTR) {
1079 CtdlLogPrintf(CTDL_EMERG, "Exiting (%s)\n", strerror(errno));
1080 CtdlThreadStopAll();
1083 CtdlLogPrintf(CTDL_DEBUG, "Interrupted CtdlThreadSelect.\n");
1084 if (CtdlThreadCheckStop()) return(NULL);
1088 else if(retval == 0) {
1089 if (CtdlThreadCheckStop()) return(NULL);
1092 /* It must be a client socket. Find a context that has data
1093 * waiting on its socket *and* is in the CON_IDLE state. Any
1094 * active sockets other than our chosen one are marked as
1095 * CON_READY so the next thread that comes around can just bind
1096 * to one without having to select() again.
1098 begin_critical_section(S_SESSION_TABLE);
1099 for (ptr = ContextList; ptr != NULL; ptr = ptr->next) {
1100 int checkfd = ptr->client_socket;
1101 if ((checkfd != -1) &&
1102 (FD_ISSET(checkfd, &readfds)) &&
1103 (ptr->state == CON_IDLE) )
1105 ptr->input_waiting = 1;
1107 bind_me = ptr; /* I choose you! */
1108 bind_me->state = CON_EXECUTING;
1111 ptr->state = CON_READY;
1115 end_critical_section(S_SESSION_TABLE);
1118 /* We're bound to a session */
1119 if (bind_me != NULL) {
1120 become_session(bind_me);
1122 if (bind_me->state == CON_STARTING) {
1123 bind_me->state = CON_EXECUTING;
1124 begin_session(bind_me);
1125 bind_me->h_greeting_function();
1127 /* If the client has sent a command, execute it. */
1128 if (CC->input_waiting) {
1129 CC->h_command_function();
1131 while (HaveMoreLinesWaiting(CC))
1132 CC->h_command_function();
1134 CC->input_waiting = 0;
1137 /* If there are asynchronous messages waiting and the
1138 * client supports it, do those now */
1139 if ((CC->is_async) && (CC->async_waiting)
1140 && (CC->h_async_function != NULL)) {
1141 CC->h_async_function();
1142 CC->async_waiting = 0;
1145 force_purge = CC->kill_me;
1146 become_session(NULL);
1147 bind_me->state = CON_IDLE;
1150 dead_session_purge(force_purge);
1153 /* If control reaches this point, the server is shutting down */
1161 * A function to handle selecting on master sockets.
1162 * In other words it handles new connections.
1165 void *select_on_master (void *arg)
1167 struct ServiceFunctionHook *serviceptr;
1171 int ssock; /* Descriptor for client socket */
1172 CitContext *con= NULL; /* Temporary context pointer */
1177 while (!CtdlThreadCheckStop()) {
1178 /* Initialize the fdset. */
1179 FD_ZERO(&master_fds);
1182 /* First, add the various master sockets to the fdset. */
1183 for (serviceptr = ServiceHookTable; serviceptr != NULL;
1184 serviceptr = serviceptr->next ) {
1185 m = serviceptr->msock;
1186 FD_SET(m, &master_fds);
1192 if (!CtdlThreadCheckStop()) {
1193 tv.tv_sec = 60; /* wake up every second if no input */
1195 retval = CtdlThreadSelect(highest + 1, &master_fds, NULL, NULL, &tv);
1200 /* Now figure out who made this select() unblock.
1201 * First, check for an error or exit condition.
1204 if (errno == EBADF) {
1205 CtdlLogPrintf(CTDL_NOTICE, "select() failed: (%s)\n",
1209 if (errno != EINTR) {
1210 CtdlLogPrintf(CTDL_EMERG, "Exiting (%s)\n", strerror(errno));
1211 CtdlThreadStopAll();
1213 CtdlLogPrintf(CTDL_DEBUG, "Interrupted CtdlThreadSelect.\n");
1214 if (CtdlThreadCheckStop()) return(NULL);
1218 else if(retval == 0) {
1219 if (CtdlThreadCheckStop()) return(NULL);
1222 /* Next, check to see if it's a new client connecting
1223 * on a master socket.
1225 else for (serviceptr = ServiceHookTable; serviceptr != NULL;
1226 serviceptr = serviceptr->next ) {
1228 if (FD_ISSET(serviceptr->msock, &master_fds)) {
1229 ssock = accept(serviceptr->msock, NULL, 0);
1231 CtdlLogPrintf(CTDL_DEBUG,
1232 "New client socket %d\n",
1235 /* The master socket is non-blocking but the client
1236 * sockets need to be blocking, otherwise certain
1237 * operations barf on FreeBSD. Not a fatal error.
1239 if (fcntl(ssock, F_SETFL, 0) < 0) {
1240 CtdlLogPrintf(CTDL_EMERG,
1241 "citserver: Can't set socket to blocking: %s\n",
1245 /* New context will be created already
1246 * set up in the CON_EXECUTING state.
1248 con = CreateNewContext();
1250 /* Assign our new socket number to it. */
1251 con->client_socket = ssock;
1252 con->h_command_function =
1253 serviceptr->h_command_function;
1254 con->h_async_function =
1255 serviceptr->h_async_function;
1256 con->h_greeting_function = serviceptr->h_greeting_function;
1258 serviceptr->ServiceName;
1260 /* Determine whether it's a local socket */
1261 if (serviceptr->sockpath != NULL)
1262 con->is_local_socket = 1;
1264 /* Set the SO_REUSEADDR socket option */
1266 setsockopt(ssock, SOL_SOCKET,
1270 con->state = CON_GREETING;
1286 * Translate text facility name to syslog.h defined value.
1288 int SyslogFacility(char *name)
1297 { LOG_KERN, "kern" },
1298 { LOG_USER, "user" },
1299 { LOG_MAIL, "mail" },
1300 { LOG_DAEMON, "daemon" },
1301 { LOG_AUTH, "auth" },
1302 { LOG_SYSLOG, "syslog" },
1304 { LOG_NEWS, "news" },
1305 { LOG_UUCP, "uucp" },
1306 { LOG_LOCAL0, "local0" },
1307 { LOG_LOCAL1, "local1" },
1308 { LOG_LOCAL2, "local2" },
1309 { LOG_LOCAL3, "local3" },
1310 { LOG_LOCAL4, "local4" },
1311 { LOG_LOCAL5, "local5" },
1312 { LOG_LOCAL6, "local6" },
1313 { LOG_LOCAL7, "local7" },
1316 for(i = 0; facTbl[i].name != NULL; i++) {
1317 if(!strcasecmp(name, facTbl[i].name))
1318 return facTbl[i].facility;
1325 /********** MEM CHEQQER ***********/
1327 #ifdef DEBUG_MEMORY_LEAKS
1334 void *tracked_malloc(size_t size, char *file, int line) {
1335 struct igheap *thisheap;
1338 block = malloc(size);
1339 if (block == NULL) return(block);
1341 thisheap = malloc(sizeof(struct igheap));
1342 if (thisheap == NULL) {
1347 thisheap->block = block;
1348 strcpy(thisheap->file, file);
1349 thisheap->line = line;
1351 begin_critical_section(S_DEBUGMEMLEAKS);
1352 thisheap->next = igheap;
1354 end_critical_section(S_DEBUGMEMLEAKS);
1360 void *tracked_realloc(void *ptr, size_t size, char *file, int line) {
1361 struct igheap *thisheap;
1364 block = realloc(ptr, size);
1365 if (block == NULL) return(block);
1367 thisheap = malloc(sizeof(struct igheap));
1368 if (thisheap == NULL) {
1373 thisheap->block = block;
1374 strcpy(thisheap->file, file);
1375 thisheap->line = line;
1377 begin_critical_section(S_DEBUGMEMLEAKS);
1378 thisheap->next = igheap;
1380 end_critical_section(S_DEBUGMEMLEAKS);
1387 void tracked_free(void *ptr) {
1388 struct igheap *thisheap;
1389 struct igheap *trash;
1393 if (igheap == NULL) return;
1394 begin_critical_section(S_DEBUGMEMLEAKS);
1395 for (thisheap = igheap; thisheap != NULL; thisheap = thisheap->next) {
1396 if (thisheap->next != NULL) {
1397 if (thisheap->next->block == ptr) {
1398 trash = thisheap->next;
1399 thisheap->next = thisheap->next->next;
1404 if (igheap->block == ptr) {
1406 igheap = igheap->next;
1409 end_critical_section(S_DEBUGMEMLEAKS);
1412 char *tracked_strdup(const char *s, char *file, int line) {
1415 if (s == NULL) return(NULL);
1416 ptr = tracked_malloc(strlen(s) + 1, file, line);
1417 if (ptr == NULL) return(NULL);
1418 strncpy(ptr, s, strlen(s));
1422 void dump_heap(void) {
1423 struct igheap *thisheap;
1425 for (thisheap = igheap; thisheap != NULL; thisheap = thisheap->next) {
1426 CtdlLogPrintf(CTDL_CRIT, "UNFREED: %30s : %d\n",
1427 thisheap->file, thisheap->line);
1431 #endif /* DEBUG_MEMORY_LEAKS */