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 */
64 #ifdef HAVE_SYS_SELECT_H
65 #include <sys/select.h>
72 #include "ctdl_module.h"
78 #ifdef DEBUG_MEMORY_LEAKS
86 struct igheap *igheap = NULL;
90 citthread_key_t MyConKey; /* TSD key for MyContext() */
92 int verbosity = DEFAULT_VERBOSITY; /* Logging level */
94 struct CitContext masterCC;
95 time_t last_purge = 0; /* Last dead session purge */
96 int num_sessions = 0; /* Current number of sessions */
98 int syslog_facility = LOG_DAEMON;
99 int enable_syslog = 0;
102 /* Flag for single user mode */
103 static int want_single_user = 0;
105 /* Try to go single user */
107 int CtdlTrySingleUser(void)
111 begin_critical_section(S_SINGLE_USER);
112 if (want_single_user)
117 want_single_user = 1;
119 end_critical_section(S_SINGLE_USER);
123 void CtdlEndSingleUser(void)
125 begin_critical_section(S_SINGLE_USER);
126 want_single_user = 0;
127 end_critical_section(S_SINGLE_USER);
131 int CtdlWantSingleUser(void)
133 return want_single_user;
136 int CtdlIsSingleUser(void)
138 if (want_single_user)
140 /* check for only one context here */
141 if (num_sessions == 1)
149 * CtdlLogPrintf() ... Write logging information
151 void CtdlLogPrintf(enum LogLevel loglevel, const char *format, ...) {
153 va_start(arg_ptr, format);
154 vCtdlLogPrintf(loglevel, format, arg_ptr);
158 void vCtdlLogPrintf(enum LogLevel loglevel, const char *format, va_list arg_ptr)
160 char buf[SIZ], buf2[SIZ];
163 vsyslog((syslog_facility | loglevel), format, arg_ptr);
166 /* stderr output code */
167 if (enable_syslog || running_as_daemon) return;
169 /* if we run in forground and syslog is disabled, log to terminal */
170 if (loglevel <= verbosity) {
175 gettimeofday(&tv, NULL);
176 /* Promote to time_t; types differ on some OSes (like darwin) */
177 unixtime = tv.tv_sec;
178 localtime_r(&unixtime, &tim);
179 if (CC->cs_pid != 0) {
181 "%04d/%02d/%02d %2d:%02d:%02d.%06ld [%3d] ",
182 tim.tm_year + 1900, tim.tm_mon + 1,
183 tim.tm_mday, tim.tm_hour, tim.tm_min,
184 tim.tm_sec, (long)tv.tv_usec,
188 "%04d/%02d/%02d %2d:%02d:%02d.%06ld ",
189 tim.tm_year + 1900, tim.tm_mon + 1,
190 tim.tm_mday, tim.tm_hour, tim.tm_min,
191 tim.tm_sec, (long)tv.tv_usec);
193 vsnprintf(buf2, SIZ, format, arg_ptr);
195 fprintf(stderr, "%s%s", buf, buf2);
203 * Signal handler to shut down the server.
206 volatile int exit_signal = 0;
207 volatile int shutdown_and_halt = 0;
208 volatile int restart_server = 0;
209 volatile int running_as_daemon = 0;
211 static RETSIGTYPE signal_cleanup(int signum) {
212 #ifdef THREADS_USESIGNALS
218 CtdlLogPrintf(CTDL_DEBUG, "Caught signal %d; shutting down.\n", signum);
219 exit_signal = signum;
226 * Some initialization stuff...
228 void init_sysdep(void) {
231 /* Avoid vulnerabilities related to FD_SETSIZE if we can. */
235 getrlimit(RLIMIT_NOFILE, &rl);
236 rl.rlim_cur = FD_SETSIZE;
237 rl.rlim_max = FD_SETSIZE;
238 setrlimit(RLIMIT_NOFILE, &rl);
242 /* If we've got OpenSSL, we're going to use it. */
248 * Set up a place to put thread-specific data.
249 * We only need a single pointer per thread - it points to the
250 * CitContext structure (in the ContextList linked list) of the
251 * session to which the calling thread is currently bound.
253 if (citthread_key_create(&MyConKey, NULL) != 0) {
254 CtdlLogPrintf(CTDL_CRIT, "Can't create TSD key: %s\n",
259 * The action for unexpected signals and exceptions should be to
260 * call signal_cleanup() to gracefully shut down the server.
263 sigaddset(&set, SIGINT);
264 sigaddset(&set, SIGQUIT);
265 sigaddset(&set, SIGHUP);
266 sigaddset(&set, SIGTERM);
267 // sigaddset(&set, SIGSEGV); commented out because
268 // sigaddset(&set, SIGILL); we want core dumps
269 // sigaddset(&set, SIGBUS);
270 sigprocmask(SIG_UNBLOCK, &set, NULL);
272 signal(SIGINT, signal_cleanup);
273 signal(SIGQUIT, signal_cleanup);
274 signal(SIGHUP, signal_cleanup);
275 signal(SIGTERM, signal_cleanup);
276 // signal(SIGSEGV, signal_cleanup); commented out because
277 // signal(SIGILL, signal_cleanup); we want core dumps
278 // signal(SIGBUS, signal_cleanup);
281 * Do not shut down the server on broken pipe signals, otherwise the
282 * whole Citadel service would come down whenever a single client
285 signal(SIGPIPE, SIG_IGN);
292 * This is a generic function to set up a master socket for listening on
293 * a TCP port. The server shuts down if the bind fails.
296 int ig_tcp_server(char *ip_addr, int port_number, int queue_len, char **errormessage)
298 struct sockaddr_in sin;
300 int actual_queue_len;
302 actual_queue_len = queue_len;
303 if (actual_queue_len < 5) actual_queue_len = 5;
305 memset(&sin, 0, sizeof(sin));
306 sin.sin_family = AF_INET;
307 sin.sin_port = htons((u_short)port_number);
308 if (ip_addr == NULL) {
309 sin.sin_addr.s_addr = INADDR_ANY;
312 sin.sin_addr.s_addr = inet_addr(ip_addr);
315 if (sin.sin_addr.s_addr == !INADDR_ANY) {
316 sin.sin_addr.s_addr = INADDR_ANY;
319 s = socket(PF_INET, SOCK_STREAM, IPPROTO_TCP);
322 *errormessage = (char*) malloc(SIZ + 1);
323 snprintf(*errormessage, SIZ,
324 "citserver: Can't create a socket: %s",
326 CtdlLogPrintf(CTDL_EMERG, "%s\n", *errormessage);
331 setsockopt(s, SOL_SOCKET, SO_REUSEADDR, &i, sizeof(i));
333 if (bind(s, (struct sockaddr *)&sin, sizeof(sin)) < 0) {
334 *errormessage = (char*) malloc(SIZ + 1);
335 snprintf(*errormessage, SIZ,
336 "citserver: Can't bind: %s",
338 CtdlLogPrintf(CTDL_EMERG, "%s\n", *errormessage);
343 /* set to nonblock - we need this for some obscure situations */
344 if (fcntl(s, F_SETFL, O_NONBLOCK) < 0) {
345 *errormessage = (char*) malloc(SIZ + 1);
346 snprintf(*errormessage, SIZ,
347 "citserver: Can't set socket to non-blocking: %s",
349 CtdlLogPrintf(CTDL_EMERG, "%s\n", *errormessage);
354 if (listen(s, actual_queue_len) < 0) {
355 *errormessage = (char*) malloc(SIZ + 1);
356 snprintf(*errormessage, SIZ,
357 "citserver: Can't listen: %s",
359 CtdlLogPrintf(CTDL_EMERG, "%s\n", *errormessage);
370 * Create a Unix domain socket and listen on it
372 int ig_uds_server(char *sockpath, int queue_len, char **errormessage)
374 struct sockaddr_un addr;
377 int actual_queue_len;
379 actual_queue_len = queue_len;
380 if (actual_queue_len < 5) actual_queue_len = 5;
382 i = unlink(sockpath);
383 if ((i != 0) && (errno != ENOENT)) {
384 *errormessage = (char*) malloc(SIZ + 1);
385 snprintf(*errormessage, SIZ, "citserver: can't unlink %s: %s",
386 sockpath, strerror(errno));
387 CtdlLogPrintf(CTDL_EMERG, "%s\n", *errormessage);
391 memset(&addr, 0, sizeof(addr));
392 addr.sun_family = AF_UNIX;
393 safestrncpy(addr.sun_path, sockpath, sizeof addr.sun_path);
395 s = socket(AF_UNIX, SOCK_STREAM, 0);
397 *errormessage = (char*) malloc(SIZ + 1);
398 snprintf(*errormessage, SIZ,
399 "citserver: Can't create a socket: %s",
401 CtdlLogPrintf(CTDL_EMERG, "%s\n", *errormessage);
405 if (bind(s, (struct sockaddr *)&addr, sizeof(addr)) < 0) {
406 *errormessage = (char*) malloc(SIZ + 1);
407 snprintf(*errormessage, SIZ,
408 "citserver: Can't bind: %s",
410 CtdlLogPrintf(CTDL_EMERG, "%s\n", *errormessage);
414 /* set to nonblock - we need this for some obscure situations */
415 if (fcntl(s, F_SETFL, O_NONBLOCK) < 0) {
416 *errormessage = (char*) malloc(SIZ + 1);
417 snprintf(*errormessage, SIZ,
418 "citserver: Can't set socket to non-blocking: %s",
420 CtdlLogPrintf(CTDL_EMERG, "%s\n", *errormessage);
425 if (listen(s, actual_queue_len) < 0) {
426 *errormessage = (char*) malloc(SIZ + 1);
427 snprintf(*errormessage, SIZ,
428 "citserver: Can't listen: %s",
430 CtdlLogPrintf(CTDL_EMERG, "%s\n", *errormessage);
434 chmod(sockpath, S_ISGID|S_IRUSR|S_IWUSR|S_IXUSR|S_IRGRP|S_IWGRP|S_IXGRP|S_IROTH|S_IWOTH|S_IXOTH);
441 * Return a pointer to the CitContext structure bound to the thread which
442 * called this function. If there's no such binding (for example, if it's
443 * called by the housekeeper thread) then a generic 'master' CC is returned.
445 * This function is used *VERY* frequently and must be kept small.
447 struct CitContext *MyContext(void) {
449 register struct CitContext *c;
451 return ((c = (struct CitContext *) citthread_getspecific(MyConKey),
452 c == NULL) ? &masterCC : c
458 * Initialize a new context and place it in the list. The session number
459 * used to be the PID (which is why it's called cs_pid), but that was when we
460 * had one process per session. Now we just assign them sequentially, starting
461 * at 1 (don't change it to 0 because masterCC uses 0).
463 struct CitContext *CreateNewContext(void) {
464 struct CitContext *me;
465 static int next_pid = 0;
467 me = (struct CitContext *) malloc(sizeof(struct CitContext));
469 CtdlLogPrintf(CTDL_ALERT, "citserver: can't allocate memory!!\n");
473 memset(me, 0, sizeof(struct CitContext));
475 /* Give the contaxt a name. Hopefully makes it easier to track */
476 strcpy (me->user.fullname, "SYS_notauth");
478 /* The new context will be created already in the CON_EXECUTING state
479 * in order to prevent another thread from grabbing it while it's
482 me->state = CON_EXECUTING;
484 * Generate a unique session number and insert this context into
487 begin_critical_section(S_SESSION_TABLE);
488 me->cs_pid = ++next_pid;
490 me->next = ContextList;
492 if (me->next != NULL) {
496 end_critical_section(S_SESSION_TABLE);
501 struct CitContext *CtdlGetContextArray(int *count)
504 struct CitContext *nptr, *cptr;
506 nContexts = num_sessions;
507 nptr = malloc(sizeof(struct CitContext) * nContexts);
510 begin_critical_section(S_SESSION_TABLE);
511 for (cptr = ContextList, i=0; cptr != NULL && i < nContexts; cptr = cptr->next, i++)
512 memcpy(&nptr[i], cptr, sizeof (struct CitContext));
513 end_critical_section (S_SESSION_TABLE);
522 * This function fills in a context and its user field correctly
523 * Then creates/loads that user
525 void CtdlFillSystemContext(struct CitContext *context, char *name)
527 char sysname[USERNAME_SIZE];
529 memset(context, 0, sizeof(struct CitContext));
530 context->internal_pgm = 1;
532 strcpy (sysname, "SYS_");
533 strcat (sysname, name);
534 /* internal_create_user has the side effect of loading the user regardless of wether they
535 * already existed or needed to be created
537 internal_create_user (sysname, &(context->user), -1) ;
539 /* Check to see if the system user needs upgrading */
540 if (context->user.usernum == 0)
541 { /* old system user with number 0, upgrade it */
542 context->user.usernum = get_new_user_number();
543 CtdlLogPrintf(CTDL_DEBUG, "Upgrading system user \"%s\" from user number 0 to user number %d\n", context->user.fullname, context->user.usernum);
544 /* add user to the database */
545 putuser(&(context->user));
546 cdb_store(CDB_USERSBYNUMBER, &(context->user.usernum), sizeof(long), context->user.fullname, strlen(context->user.fullname)+1);
551 * The following functions implement output buffering on operating systems which
552 * support it (such as Linux and various BSD flavors).
556 # define HAVE_TCP_BUFFERING
559 # define HAVE_TCP_BUFFERING
560 # define TCP_CORK TCP_NOPUSH
562 #endif /* TCP_CORK */
563 #endif /* HAVE_DARWIN */
565 static unsigned on = 1, off = 0;
567 void buffer_output(void) {
568 #ifdef HAVE_TCP_BUFFERING
570 if (!CC->redirect_ssl)
572 setsockopt(CC->client_socket, IPPROTO_TCP, TCP_CORK, &on, 4);
576 void unbuffer_output(void) {
577 #ifdef HAVE_TCP_BUFFERING
579 if (!CC->redirect_ssl)
581 setsockopt(CC->client_socket, IPPROTO_TCP, TCP_CORK, &off, 4);
585 void flush_output(void) {
586 #ifdef HAVE_TCP_BUFFERING
587 struct CitContext *CCC = CC;
588 setsockopt(CCC->client_socket, IPPROTO_TCP, TCP_CORK, &off, 4);
589 setsockopt(CCC->client_socket, IPPROTO_TCP, TCP_CORK, &on, 4);
596 * client_write() ... Send binary data to the client.
598 int client_write(char *buf, int nbytes)
600 int bytes_written = 0;
602 #ifndef HAVE_TCP_BUFFERING
603 int old_buffer_len = 0;
610 if (Ctx->redirect_buffer != NULL) {
611 if ((Ctx->redirect_len + nbytes + 2) >= Ctx->redirect_alloc) {
612 Ctx->redirect_alloc = (Ctx->redirect_alloc * 2) + nbytes;
613 Ctx->redirect_buffer = realloc(Ctx->redirect_buffer,
614 Ctx->redirect_alloc);
616 memcpy(&Ctx->redirect_buffer[Ctx->redirect_len], buf, nbytes);
617 Ctx->redirect_len += nbytes;
618 Ctx->redirect_buffer[Ctx->redirect_len] = 0;
623 if (Ctx->redirect_ssl) {
624 client_write_ssl(buf, nbytes);
629 fdflags = fcntl(Ctx->client_socket, F_GETFL);
631 while (bytes_written < nbytes) {
632 if ((fdflags & O_NONBLOCK) == O_NONBLOCK) {
634 FD_SET(Ctx->client_socket, &wset);
635 if (select(1, NULL, &wset, NULL, NULL) == -1) {
636 CtdlLogPrintf(CTDL_ERR,
637 "client_write(%d bytes) select failed: %s (%d)\n",
638 nbytes - bytes_written,
639 strerror(errno), errno);
646 retval = write(Ctx->client_socket, &buf[bytes_written],
647 nbytes - bytes_written);
649 CtdlLogPrintf(CTDL_ERR,
650 "client_write(%d bytes) failed: %s (%d)\n",
651 nbytes - bytes_written,
652 strerror(errno), errno);
654 // CtdlLogPrintf(CTDL_DEBUG, "Tried to send: %s", &buf[bytes_written]);
658 bytes_written = bytes_written + retval;
665 * cprintf() Send formatted printable data to the client.
666 * Implemented in terms of client_write() so it's technically not sysdep...
668 void cprintf(const char *format, ...) {
672 va_start(arg_ptr, format);
673 if (vsnprintf(buf, sizeof buf, format, arg_ptr) == -1)
674 buf[sizeof buf - 2] = '\n';
675 client_write(buf, strlen(buf));
681 * Read data from the client socket.
683 * 1 Requested number of bytes has been read.
684 * 0 Request timed out.
685 * -1 The socket is broken.
686 * If the socket breaks, the session will be terminated.
688 int client_read_to(char *buf, int bytes, int timeout)
697 if (CC->redirect_ssl) {
698 return (client_read_ssl(buf, bytes, timeout));
702 fd = CC->client_socket;
709 retval = select( (fd)+1,
710 &rfds, NULL, NULL, &tv);
715 CtdlLogPrintf(CTDL_DEBUG, "Interrupted select().\n");
721 if (FD_ISSET(fd, &rfds) == 0) {
725 rlen = read(fd, &buf[len], bytes-len);
727 /* The socket has been disconnected! */
737 * Read data from the client socket with default timeout.
738 * (This is implemented in terms of client_read_to() and could be
739 * justifiably moved out of sysdep.c)
741 INLINE int client_read(char *buf, int bytes)
743 return(client_read_to(buf, bytes, config.c_sleeping));
748 * client_getln() ... Get a LF-terminated line of text from the client.
749 * (This is implemented in terms of client_read() and could be
750 * justifiably moved out of sysdep.c)
752 int client_getln(char *buf, int bufsize)
756 /* Read one character at a time.
759 retval = client_read(&buf[i], 1);
760 if (retval != 1 || buf[i] == '\n' || i == (bufsize-1))
764 /* If we got a long line, discard characters until the newline.
766 if (i == (bufsize-1))
767 while (buf[i] != '\n' && retval == 1)
768 retval = client_read(&buf[i], 1);
770 /* Strip the trailing LF, and the trailing CR if present.
774 && ( (buf[i - 1]==13)
775 || ( buf[i - 1]==10)) ) {
779 if (retval < 0) safestrncpy(&buf[i], "000", bufsize - i);
785 * Cleanup any contexts that are left lying around
787 void context_cleanup(void)
789 struct CitContext *ptr = NULL;
790 struct CitContext *rem = NULL;
793 * Clean up the contexts.
794 * There are no threads so no critical_section stuff is needed.
798 /* We need to update the ContextList because some modules may want to itterate it
799 * Question is should we NULL it before iterating here or should we just keep updating it
800 * as we remove items?
802 * Answer is to NULL it first to prevent modules from doing any actions on the list at all
806 /* Remove the session from the active list */
810 CtdlLogPrintf(CTDL_DEBUG, "Purging session %d\n", ptr->cs_pid);
819 void close_masters (void)
821 struct ServiceFunctionHook *serviceptr;
824 * close all protocol master sockets
826 for (serviceptr = ServiceHookTable; serviceptr != NULL;
827 serviceptr = serviceptr->next ) {
829 if (serviceptr->tcp_port > 0)
831 CtdlLogPrintf(CTDL_INFO, "Closing listener on port %d\n",
832 serviceptr->tcp_port);
833 serviceptr->tcp_port = 0;
836 if (serviceptr->sockpath != NULL)
837 CtdlLogPrintf(CTDL_INFO, "Closing listener on '%s'\n",
838 serviceptr->sockpath);
840 close(serviceptr->msock);
841 /* If it's a Unix domain socket, remove the file. */
842 if (serviceptr->sockpath != NULL) {
843 unlink(serviceptr->sockpath);
844 serviceptr->sockpath = NULL;
851 * The system-dependent part of master_cleanup() - close the master socket.
853 void sysdep_master_cleanup(void) {
862 CtdlDestroyProtoHooks();
863 CtdlDestroyDeleteHooks();
864 CtdlDestroyXmsgHooks();
865 CtdlDestroyNetprocHooks();
866 CtdlDestroyUserHooks();
867 CtdlDestroyMessageHook();
868 CtdlDestroyCleanupHooks();
869 CtdlDestroyFixedOutputHooks();
870 CtdlDestroySessionHooks();
871 CtdlDestroyServiceHook();
872 CtdlDestroyRoomHooks();
873 CtdlDestroyDirectoryServiceFuncs();
874 #ifdef HAVE_BACKTRACE
882 * Terminate another session.
883 * (This could justifiably be moved out of sysdep.c because it
884 * no longer does anything that is system-dependent.)
886 void kill_session(int session_to_kill) {
887 struct CitContext *ptr;
889 begin_critical_section(S_SESSION_TABLE);
890 for (ptr = ContextList; ptr != NULL; ptr = ptr->next) {
891 if (ptr->cs_pid == session_to_kill) {
895 end_critical_section(S_SESSION_TABLE);
899 void graceful_shutdown(int signum) {
900 kill(current_child, signum);
901 unlink(file_pid_file);
906 int nFireUpsNonRestart = 0;
910 * Start running as a daemon.
912 void start_daemon(int unused) {
920 /* Close stdin/stdout/stderr and replace them with /dev/null.
921 * We don't just call close() because we don't want these fd's
922 * to be reused for other files.
931 signal(SIGHUP, SIG_IGN);
932 signal(SIGINT, SIG_IGN);
933 signal(SIGQUIT, SIG_IGN);
937 freopen("/dev/null", "r", stdin);
938 freopen("/dev/null", "w", stdout);
939 freopen("/dev/null", "w", stderr);
942 current_child = fork();
944 signal(SIGTERM, graceful_shutdown);
946 if (current_child < 0) {
951 else if (current_child == 0) {
952 return; /* continue starting citadel. */
956 fp = fopen(file_pid_file, "w");
958 fprintf(fp, ""F_PID_T"\n", getpid());
961 waitpid(current_child, &status, 0);
964 nFireUpsNonRestart = nFireUps;
966 /* Exit code 0 means the watcher should exit */
967 if (WIFEXITED(status) && (WEXITSTATUS(status) == CTDLEXIT_SHUTDOWN)) {
971 /* Exit code 101-109 means the watcher should exit */
972 else if (WIFEXITED(status) && (WEXITSTATUS(status) >= 101) && (WEXITSTATUS(status) <= 109)) {
976 /* Any other exit code, or no exit code, means we should restart. */
980 ForkedPid = current_child;
983 } while (do_restart);
985 unlink(file_pid_file);
986 exit(WEXITSTATUS(status));
991 void checkcrash(void)
993 if (nFireUpsNonRestart != nFireUps)
997 CrashMail = NewStrBuf();
998 CtdlLogPrintf(CTDL_ALERT, "Posting crash message\n");
999 StrBufPrintf(CrashMail,
1001 " The Citadel server process (citserver) terminated unexpectedly."
1003 " This could be the result of a bug in the server program, or some external "
1004 "factor. You can obtain more information about this by enabling core dumps. "
1005 "For more information, please see: "
1006 "http://citadel.org/doku.php/faq:mastering_your_os:gdb#how.do.i.make.my.system.produce.core-files"
1008 " If you have already done this, the core dump is likely to be found at %score.%d\n"
1010 ctdl_run_dir, ForkedPid);
1011 aide_message(ChrPtr(CrashMail), "Citadel server process terminated unexpectedly");
1012 FreeStrBuf(&CrashMail);
1018 * Generic routine to convert a login name to a full name (gecos)
1019 * Returns nonzero if a conversion took place
1021 int convert_login(char NameToConvert[]) {
1025 pw = getpwnam(NameToConvert);
1030 strcpy(NameToConvert, pw->pw_gecos);
1031 for (a=0; a<strlen(NameToConvert); ++a) {
1032 if (NameToConvert[a] == ',') NameToConvert[a] = 0;
1039 * Purge all sessions which have the 'kill_me' flag set.
1040 * This function has code to prevent it from running more than once every
1041 * few seconds, because running it after every single unbind would waste a lot
1042 * of CPU time and keep the context list locked too much. To force it to run
1043 * anyway, set "force" to nonzero.
1045 void dead_session_purge(int force) {
1046 struct CitContext *ptr, *ptr2; /* general-purpose utility pointer */
1047 struct CitContext *rem = NULL; /* list of sessions to be destroyed */
1050 if ( (time(NULL) - last_purge) < 5 ) {
1051 return; /* Too soon, go away */
1056 if (try_critical_section(S_SESSION_TABLE))
1064 if ( (ptr2->state == CON_IDLE) && (ptr2->kill_me) ) {
1065 /* Remove the session from the active list */
1067 ptr2->prev->next = ptr2->next;
1070 ContextList = ptr2->next;
1073 ptr2->next->prev = ptr2->prev;
1077 /* And put it on our to-be-destroyed list */
1082 end_critical_section(S_SESSION_TABLE);
1084 /* Now that we no longer have the session list locked, we can take
1085 * our time and destroy any sessions on the to-be-killed list, which
1086 * is allocated privately on this thread's stack.
1088 while (rem != NULL) {
1089 CtdlLogPrintf(CTDL_DEBUG, "Purging session %d\n", rem->cs_pid);
1102 * masterCC is the context we use when not attached to a session. This
1103 * function initializes it.
1105 void InitializeMasterCC(void) {
1106 memset(&masterCC, 0, sizeof(struct CitContext));
1107 masterCC.internal_pgm = 1;
1108 masterCC.cs_pid = 0;
1115 * Bind a thread to a context. (It's inline merely to speed things up.)
1117 INLINE void become_session(struct CitContext *which_con) {
1118 citthread_setspecific(MyConKey, (void *)which_con );
1124 * This loop just keeps going and going and going...
1128 * This current implimentation of worker_thread creates a bottle neck in several situations
1129 * The first thing to remember is that a single thread can handle more than one connection at a time.
1130 * More threads mean less memory for the system to run in.
1131 * So for efficiency we want every thread to be doing something useful or waiting in the main loop for
1132 * something to happen anywhere.
1133 * This current implimentation requires worker threads to wait in other locations, after it has
1134 * been committed to a single connection which is very wasteful.
1135 * As an extreme case consider this:
1136 * A slow client connects and this slow client sends only one character each second.
1137 * With this current implimentation a single worker thread is dispatched to handle that connection
1138 * until such times as the client timeout expires, an error occurs on the socket or the client
1139 * completes its transmission.
1140 * THIS IS VERY BAD since that thread could have handled a read from many more clients in each one
1141 * second interval between chars.
1143 * It is my intention to re-write this code and the associated client_getln, client_read functions
1144 * to allow any thread to read data on behalf of any connection (context).
1145 * To do this I intend to have this main loop read chars into a buffer stored in the context.
1146 * Once the correct criteria for a full buffer is met then we will dispatch a thread to
1148 * This worker thread loop also needs to be able to handle binary data.
1151 void *worker_thread(void *arg) {
1154 struct CitContext *ptr;
1155 struct CitContext *bind_me = NULL;
1158 struct CitContext *con= NULL; /* Temporary context pointer */
1159 struct ServiceFunctionHook *serviceptr;
1160 int ssock; /* Descriptor for client socket */
1162 int force_purge = 0;
1166 while (!CtdlThreadCheckStop()) {
1168 /* make doubly sure we're not holding any stale db handles
1169 * which might cause a deadlock.
1171 cdb_check_handles();
1172 do_select: force_purge = 0;
1173 bind_me = NULL; /* Which session shall we handle? */
1175 /* Initialize the fdset. */
1179 begin_critical_section(S_SESSION_TABLE);
1180 for (ptr = ContextList; ptr != NULL; ptr = ptr->next) {
1181 if (ptr->state == CON_IDLE) {
1182 FD_SET(ptr->client_socket, &readfds);
1183 if (ptr->client_socket > highest)
1184 highest = ptr->client_socket;
1186 if ((bind_me == NULL) && (ptr->state == CON_READY)) {
1188 ptr->state = CON_EXECUTING;
1191 end_critical_section(S_SESSION_TABLE);
1197 /* If we got this far, it means that there are no sessions
1198 * which a previous thread marked for attention, so we go
1199 * ahead and get ready to select().
1202 /* First, add the various master sockets to the fdset. */
1203 for (serviceptr = ServiceHookTable; serviceptr != NULL;
1204 serviceptr = serviceptr->next ) {
1205 m = serviceptr->msock;
1206 FD_SET(m, &readfds);
1212 if (!CtdlThreadCheckStop()) {
1213 tv.tv_sec = 1; /* wake up every second if no input */
1215 retval = CtdlThreadSelect(highest + 1, &readfds, NULL, NULL, &tv);
1220 /* Now figure out who made this select() unblock.
1221 * First, check for an error or exit condition.
1224 if (errno == EBADF) {
1225 CtdlLogPrintf(CTDL_NOTICE, "select() failed: (%s)\n",
1229 if (errno != EINTR) {
1230 CtdlLogPrintf(CTDL_EMERG, "Exiting (%s)\n", strerror(errno));
1231 CtdlThreadStopAll();
1233 CtdlLogPrintf(CTDL_DEBUG, "Interrupted CtdlThreadSelect.\n");
1234 if (CtdlThreadCheckStop()) return(NULL);
1238 else if(retval == 0) {
1239 if (CtdlThreadCheckStop()) return(NULL);
1242 /* Next, check to see if it's a new client connecting
1243 * on a master socket.
1245 else for (serviceptr = ServiceHookTable; serviceptr != NULL;
1246 serviceptr = serviceptr->next ) {
1248 if (FD_ISSET(serviceptr->msock, &readfds)) {
1249 ssock = accept(serviceptr->msock, NULL, 0);
1251 CtdlLogPrintf(CTDL_DEBUG,
1252 "New client socket %d\n",
1255 /* The master socket is non-blocking but the client
1256 * sockets need to be blocking, otherwise certain
1257 * operations barf on FreeBSD. Not a fatal error.
1259 if (fcntl(ssock, F_SETFL, 0) < 0) {
1260 CtdlLogPrintf(CTDL_EMERG,
1261 "citserver: Can't set socket to blocking: %s\n",
1265 /* New context will be created already
1266 * set up in the CON_EXECUTING state.
1268 con = CreateNewContext();
1270 /* Assign our new socket number to it. */
1271 con->client_socket = ssock;
1272 con->h_command_function =
1273 serviceptr->h_command_function;
1274 con->h_async_function =
1275 serviceptr->h_async_function;
1277 serviceptr->ServiceName;
1279 /* Determine whether it's a local socket */
1280 if (serviceptr->sockpath != NULL)
1281 con->is_local_socket = 1;
1283 /* Set the SO_REUSEADDR socket option */
1285 setsockopt(ssock, SOL_SOCKET,
1289 become_session(con);
1291 serviceptr->h_greeting_function();
1292 become_session(NULL);
1293 con->state = CON_IDLE;
1299 /* It must be a client socket. Find a context that has data
1300 * waiting on its socket *and* is in the CON_IDLE state. Any
1301 * active sockets other than our chosen one are marked as
1302 * CON_READY so the next thread that comes around can just bind
1303 * to one without having to select() again.
1305 begin_critical_section(S_SESSION_TABLE);
1306 for (ptr = ContextList; ptr != NULL; ptr = ptr->next) {
1307 if ( (FD_ISSET(ptr->client_socket, &readfds))
1308 && (ptr->state != CON_EXECUTING) ) {
1309 ptr->input_waiting = 1;
1311 bind_me = ptr; /* I choose you! */
1312 bind_me->state = CON_EXECUTING;
1315 ptr->state = CON_READY;
1319 end_critical_section(S_SESSION_TABLE);
1322 /* We're bound to a session */
1323 if (bind_me != NULL) {
1324 become_session(bind_me);
1326 /* If the client has sent a command, execute it. */
1327 if (CC->input_waiting) {
1328 CC->h_command_function();
1329 CC->input_waiting = 0;
1332 /* If there are asynchronous messages waiting and the
1333 * client supports it, do those now */
1334 if ((CC->is_async) && (CC->async_waiting)
1335 && (CC->h_async_function != NULL)) {
1336 CC->h_async_function();
1337 CC->async_waiting = 0;
1340 force_purge = CC->kill_me;
1341 become_session(NULL);
1342 bind_me->state = CON_IDLE;
1345 dead_session_purge(force_purge);
1348 /* If control reaches this point, the server is shutting down */
1357 * Translate text facility name to syslog.h defined value.
1359 int SyslogFacility(char *name)
1368 { LOG_KERN, "kern" },
1369 { LOG_USER, "user" },
1370 { LOG_MAIL, "mail" },
1371 { LOG_DAEMON, "daemon" },
1372 { LOG_AUTH, "auth" },
1373 { LOG_SYSLOG, "syslog" },
1375 { LOG_NEWS, "news" },
1376 { LOG_UUCP, "uucp" },
1377 { LOG_LOCAL0, "local0" },
1378 { LOG_LOCAL1, "local1" },
1379 { LOG_LOCAL2, "local2" },
1380 { LOG_LOCAL3, "local3" },
1381 { LOG_LOCAL4, "local4" },
1382 { LOG_LOCAL5, "local5" },
1383 { LOG_LOCAL6, "local6" },
1384 { LOG_LOCAL7, "local7" },
1387 for(i = 0; facTbl[i].name != NULL; i++) {
1388 if(!strcasecmp(name, facTbl[i].name))
1389 return facTbl[i].facility;
1396 /********** MEM CHEQQER ***********/
1398 #ifdef DEBUG_MEMORY_LEAKS
1405 void *tracked_malloc(size_t size, char *file, int line) {
1406 struct igheap *thisheap;
1409 block = malloc(size);
1410 if (block == NULL) return(block);
1412 thisheap = malloc(sizeof(struct igheap));
1413 if (thisheap == NULL) {
1418 thisheap->block = block;
1419 strcpy(thisheap->file, file);
1420 thisheap->line = line;
1422 begin_critical_section(S_DEBUGMEMLEAKS);
1423 thisheap->next = igheap;
1425 end_critical_section(S_DEBUGMEMLEAKS);
1431 void *tracked_realloc(void *ptr, size_t size, char *file, int line) {
1432 struct igheap *thisheap;
1435 block = realloc(ptr, size);
1436 if (block == NULL) return(block);
1438 thisheap = malloc(sizeof(struct igheap));
1439 if (thisheap == NULL) {
1444 thisheap->block = block;
1445 strcpy(thisheap->file, file);
1446 thisheap->line = line;
1448 begin_critical_section(S_DEBUGMEMLEAKS);
1449 thisheap->next = igheap;
1451 end_critical_section(S_DEBUGMEMLEAKS);
1458 void tracked_free(void *ptr) {
1459 struct igheap *thisheap;
1460 struct igheap *trash;
1464 if (igheap == NULL) return;
1465 begin_critical_section(S_DEBUGMEMLEAKS);
1466 for (thisheap = igheap; thisheap != NULL; thisheap = thisheap->next) {
1467 if (thisheap->next != NULL) {
1468 if (thisheap->next->block == ptr) {
1469 trash = thisheap->next;
1470 thisheap->next = thisheap->next->next;
1475 if (igheap->block == ptr) {
1477 igheap = igheap->next;
1480 end_critical_section(S_DEBUGMEMLEAKS);
1483 char *tracked_strdup(const char *s, char *file, int line) {
1486 if (s == NULL) return(NULL);
1487 ptr = tracked_malloc(strlen(s) + 1, file, line);
1488 if (ptr == NULL) return(NULL);
1489 strncpy(ptr, s, strlen(s));
1493 void dump_heap(void) {
1494 struct igheap *thisheap;
1496 for (thisheap = igheap; thisheap != NULL; thisheap = thisheap->next) {
1497 CtdlLogPrintf(CTDL_CRIT, "UNFREED: %30s : %d\n",
1498 thisheap->file, thisheap->line);
1502 #endif /* DEBUG_MEMORY_LEAKS */