* Citadel/UX "system dependent" stuff.
* See copyright.txt for copyright information.
*
+ * $Id$
+ *
* Here's where we (hopefully) have all the parts of the Citadel server that
* would need to be altered to run the server in a non-POSIX environment.
* Wherever possible, we use function wrappers and type definitions to create
*/
+#include "sysdep.h"
#include <stdlib.h>
#include <unistd.h>
#include <stdio.h>
#include <fcntl.h>
+#include <ctype.h>
#include <signal.h>
#include <sys/types.h>
#include <sys/wait.h>
#include <errno.h>
#include <stdarg.h>
#include <syslog.h>
+#include <grp.h>
+#ifdef __GNUC__
+#include <malloc.h>
+#endif
+#ifdef HAVE_PTHREAD_H
#include <pthread.h>
+#endif
#include "citadel.h"
#include "server.h"
#include "sysdep_decls.h"
#include "database.h"
#include "housekeeping.h"
#include "dynloader.h"
+#include "tools.h"
#ifdef HAVE_SYS_SELECT_H
#include <sys/select.h>
#include "snprintf.h"
#endif
+#ifdef DEBUG_MEMORY_LEAKS
+struct TheHeap *heap = NULL;
+#endif
+
pthread_mutex_t Critters[MAX_SEMAPHORES]; /* Things needing locking */
pthread_key_t MyConKey; /* TSD key for MyContext() */
* lprintf() ... Write logging information
*/
void lprintf(int loglevel, const char *format, ...) {
- va_list arg_ptr;
- char buf[256];
- int rc;
+ va_list arg_ptr;
+ char buf[512];
+ va_start(arg_ptr, format);
+ vsprintf(buf, format, arg_ptr);
+ va_end(arg_ptr);
+
if (loglevel <= verbosity) {
- va_start(arg_ptr, format);
- rc = vsprintf(buf, format, arg_ptr);
- va_end(arg_ptr);
-
fprintf(stderr, "%s", buf);
fflush(stderr);
}
-
+
+ PerformLogHooks(loglevel, buf);
}
+
+#ifdef DEBUG_MEMORY_LEAKS
+void *tracked_malloc(size_t tsize, char *tfile, int tline) {
+ void *ptr;
+ struct TheHeap *hptr;
+
+ ptr = malloc(tsize);
+ if (ptr == NULL) return(NULL);
+
+ hptr = (struct TheHeap *) malloc(sizeof(struct TheHeap));
+ strcpy(hptr->h_file, tfile);
+ hptr->h_line = tline;
+ hptr->next = heap;
+ hptr->h_ptr = ptr;
+ heap = hptr;
+ return ptr;
+ }
+
+char *tracked_strdup(const char *orig, char *tfile, int tline) {
+ char *s;
+
+ s = tracked_malloc( (strlen(orig)+1), tfile, tline);
+ if (s == NULL) return NULL;
+
+ strcpy(s, orig);
+ return s;
+}
+
+void tracked_free(void *ptr) {
+ struct TheHeap *hptr, *freeme;
+
+ if (heap->h_ptr == ptr) {
+ hptr = heap->next;
+ free(heap);
+ heap = hptr;
+ }
+ else {
+ for (hptr=heap; hptr->next!=NULL; hptr=hptr->next) {
+ if (hptr->next->h_ptr == ptr) {
+ freeme = hptr->next;
+ hptr->next = hptr->next->next;
+ free(freeme);
+ }
+ }
+ }
+
+ free(ptr);
+ }
+
+void *tracked_realloc(void *ptr, size_t size) {
+ void *newptr;
+ struct TheHeap *hptr;
+
+ newptr = realloc(ptr, size);
+
+ for (hptr=heap; hptr!=NULL; hptr=hptr->next) {
+ if (hptr->h_ptr == ptr) hptr->h_ptr = newptr;
+ }
+
+ return newptr;
+ }
+
+
+void dump_tracked() {
+ struct TheHeap *hptr;
+
+ cprintf("%d Here's what's allocated...\n", LISTING_FOLLOWS);
+ for (hptr=heap; hptr!=NULL; hptr=hptr->next) {
+ cprintf("%20s %5d\n",
+ hptr->h_file, hptr->h_line);
+ }
+#ifdef __GNUC__
+ malloc_stats();
+#endif
+
+ cprintf("000\n");
+ }
+#endif
+
+static pthread_t main_thread_id;
+
+#ifndef HAVE_PTHREAD_CANCEL
+/*
+ * signal handler to fake thread cancellation; only required on BSDI as far
+ * as I know.
+ */
+static RETSIGTYPE cancel_thread(int signum) {
+ pthread_exit(NULL);
+ }
+#endif
+
+/*
+ * we used to use master_cleanup() as a signal handler to shut down the server.
+ * however, master_cleanup() and the functions it calls do some things that
+ * aren't such a good idea to do from a signal handler: acquiring mutexes,
+ * playing with signal masks on BSDI systems, etc. so instead we install the
+ * following signal handler to set a global variable to inform the main loop
+ * that it's time to call master_cleanup() and exit.
+ */
+
+static volatile int time_to_die = 0;
+
+static RETSIGTYPE signal_cleanup(int signum) {
+ time_to_die = 1;
+ }
+
+
/*
* Some initialization stuff...
*/
}
/*
- * Set up a place to put thred-specific data.
+ * Set up a place to put thread-specific data.
* We only need a single pointer per thread - it points to the
* thread's CitContext structure in the ContextList linked list.
*/
/*
* The action for unexpected signals and exceptions should be to
- * call master_cleanup() to gracefully shut down the server.
+ * call signal_cleanup() to gracefully shut down the server.
*/
- signal(SIGINT, (void(*)(int))master_cleanup);
- signal(SIGQUIT, (void(*)(int))master_cleanup);
- signal(SIGHUP, (void(*)(int))master_cleanup);
- signal(SIGTERM, (void(*)(int))master_cleanup);
+ signal(SIGINT, signal_cleanup);
+ signal(SIGQUIT, signal_cleanup);
+ signal(SIGHUP, signal_cleanup);
+ signal(SIGTERM, signal_cleanup);
+ signal(SIGPIPE, SIG_IGN);
+ main_thread_id = pthread_self();
+#ifndef HAVE_PTHREAD_CANCEL /* fake it - only BSDI afaik */
+ signal(SIGUSR1, cancel_thread);
+#endif
}
*/
void begin_critical_section(int which_one)
{
+#ifdef HAVE_PTHREAD_CANCEL
int oldval;
+#else
+ sigset_t set;
+#endif
- lprintf(8, "begin_critical_section(%d)\n", which_one);
-
- /* Don't get interrupted during the critical section */
- pthread_setcanceltype(PTHREAD_CANCEL_DEFERRED, &oldval);
+ /* lprintf(8, "begin_critical_section(%d)\n", which_one); */
+
+ if (!pthread_equal(pthread_self(), main_thread_id)) {
+ /* Keep a count of how many critical sections this thread has
+ * open, so that end_critical_section() doesn't enable
+ * cancellation prematurely. */
+ CC->n_crit++;
+#ifdef HAVE_PTHREAD_CANCEL
+ /* Don't get interrupted during the critical section */
+ pthread_setcanceltype(PTHREAD_CANCEL_DEFERRED, &oldval);
+#else
+ /* We're faking cancellation with signals. Block SIGUSR1 while
+ * we're in the critical section. */
+ sigemptyset(&set);
+ sigaddset(&set, SIGUSR1);
+ pthread_sigmask(SIG_BLOCK, &set, NULL);
+#endif
+ }
/* Obtain a semaphore */
pthread_mutex_lock(&Critters[which_one]);
*/
void end_critical_section(int which_one)
{
+#ifdef HAVE_PTHREAD_CANCEL
int oldval;
+#else
+ sigset_t set;
+#endif
- lprintf(8, " end_critical_section(%d)\n", which_one);
+ /* lprintf(8, " end_critical_section(%d)\n", which_one); */
/* Let go of the semaphore */
pthread_mutex_unlock(&Critters[which_one]);
- /* If a cancel was sent during the critical section, do it now.
- * Then re-enable thread cancellation.
- */
- pthread_testcancel();
- pthread_setcanceltype(PTHREAD_CANCEL_ASYNCHRONOUS, &oldval);
- pthread_testcancel();
+ if (!pthread_equal(pthread_self(), main_thread_id))
+ if (!--CC->n_crit) {
+#ifdef HAVE_PTHREAD_CANCEL
+ /* If a cancel was sent during the critical section, do it now.
+ * Then re-enable thread cancellation.
+ */
+ pthread_testcancel();
+ pthread_setcanceltype(PTHREAD_CANCEL_ASYNCHRONOUS, &oldval);
+ pthread_testcancel();
+#else
+ /* We're faking it. Unblock SIGUSR1; signals sent during the
+ * critical section should now be able to kill us. */
+ sigemptyset(&set);
+ sigaddset(&set, SIGUSR1);
+ pthread_sigmask(SIG_UNBLOCK, &set, NULL);
+#endif
+ }
}
struct sockaddr_in sin;
int s, i;
- bzero((char *)&sin, sizeof(sin));
+ memset(&sin, 0, sizeof(sin));
sin.sin_family = AF_INET;
sin.sin_addr.s_addr = INADDR_ANY;
if (port_number == 0) {
- lprintf(1, "citserver: No port number specified. Run setup again.\n");
+ lprintf(1,
+ "citserver: No port number specified. Run setup.\n");
exit(1);
}
struct CitContext *CreateNewContext(void) {
struct CitContext *me;
- lprintf(9, "CreateNewContext: calling malloc()\n");
- me = (struct CitContext *) malloc(sizeof(struct CitContext));
+ me = (struct CitContext *) mallok(sizeof(struct CitContext));
if (me == NULL) {
lprintf(1, "citserver: can't allocate memory!!\n");
pthread_exit(NULL);
}
- bzero(me, sizeof(struct CitContext));
+ memset(me, 0, sizeof(struct CitContext));
begin_critical_section(S_SESSION_TABLE);
me->next = ContextList;
*/
void InitMyContext(struct CitContext *con)
{
+#ifdef HAVE_PTHREAD_CANCEL
int oldval;
+#endif
con->mythread = pthread_self();
+#ifdef HAVE_PTHREAD_CANCEL
pthread_setcancelstate(PTHREAD_CANCEL_ENABLE, &oldval);
pthread_setcanceltype(PTHREAD_CANCEL_ASYNCHRONOUS, &oldval);
+#endif
if (pthread_setspecific(MyConKey, (void *)con) != 0) {
lprintf(1, "ERROR! pthread_setspecific() failed: %s\n",
strerror(errno));
struct CitContext *ptr;
lprintf(7, "Starting RemoveContext()\n");
- lprintf(9, "session count before RemoveContext is %d\n", session_count());
if (con==NULL) {
lprintf(7, "WARNING: RemoveContext() called with null!\n");
return;
}
+ /*
+ * session_count() starts its own S_SESSION_TABLE critical section;
+ * so do not call it from within this loop.
+ */
begin_critical_section(S_SESSION_TABLE);
lprintf(7, "Closing socket %d\n", con->client_socket);
close(con->client_socket);
else {
for (ptr = ContextList; ptr != NULL; ptr = ptr->next) {
if (ptr->next == con) {
- ptr->next = ptr->next->next;
+ ptr->next = con->next;
}
}
}
-
- free(con);
- lprintf(9, "session count after RemoveContext is %d\n", session_count());
-
- lprintf(7, "Done with RemoveContext\n");
+ phree(con);
end_critical_section(S_SESSION_TABLE);
+ lprintf(7, "Done with RemoveContext\n");
}
struct CitContext *ptr;
int TheCount = 0;
- lprintf(9, "session_count() starting\n");
+ begin_critical_section(S_SESSION_TABLE);
for (ptr = ContextList; ptr != NULL; ptr = ptr->next) {
++TheCount;
- lprintf(9, "Counted session %3d (%d)\n", ptr->cs_pid, TheCount);
}
+ end_critical_section(S_SESSION_TABLE);
- lprintf(9, "session_count() finishing\n");
return(TheCount);
}
void cprintf(const char *format, ...) {
va_list arg_ptr;
char buf[256];
- int rc;
va_start(arg_ptr, format);
- rc = vsprintf(buf, format, arg_ptr);
- va_end(arg_ptr);
-
+ if (vsnprintf(buf, sizeof buf, format, arg_ptr) == -1)
+ buf[sizeof buf - 2] = '\n';
client_write(buf, strlen(buf));
+ va_end(arg_ptr);
}
*/
int client_gets(char *buf)
{
- int retval = 0;
+ int i, retval;
- /* Clear the buffer, and read one character at a time.
+ /* Read one character at a time.
*/
- buf[0] = 0;
- do {
- if (strlen(buf)<255) {
- buf[strlen(buf) + 1] = 0;
- retval = client_read(&buf[strlen(buf)], 1);
- }
- } while ( (buf[strlen(buf)-1] != 10) && (retval==1) );
+ for (i = 0;;i++) {
+ retval = client_read(&buf[i], 1);
+ if (retval != 1 || buf[i] == '\n' || i == 255)
+ break;
+ }
+
+ /* If we got a long line, discard characters until the newline.
+ */
+ if (i == 255)
+ while (buf[i] != '\n' && retval == 1)
+ retval = client_read(&buf[i], 1);
- /* Strip the trailing newline.
+ /* Strip the trailing newline and any trailing nonprintables (cr's)
*/
- if (strlen(buf) > 0) buf[strlen(buf)-1] = 0;
+ buf[i] = 0;
+ while ((strlen(buf)>0)&&(!isprint(buf[strlen(buf)-1])))
+ buf[strlen(buf)-1] = 0;
return(retval);
}
*/
void kill_session(int session_to_kill) {
struct CitContext *ptr;
+ THREAD killme = 0;
+ begin_critical_section(S_SESSION_TABLE);
for (ptr = ContextList; ptr != NULL; ptr = ptr->next) {
if (ptr->cs_pid == session_to_kill) {
- pthread_cancel(ptr->mythread);
+ killme = ptr->mythread;
}
}
+ end_critical_section(S_SESSION_TABLE);
+
+ if (killme != 0) {
+#ifdef HAVE_PTHREAD_CANCEL
+ pthread_cancel(killme);
+#else
+ pthread_kill(killme, SIGUSR1);
+#ifdef __FreeBSD__
+ /* there's a very stupid bug in the user threads package on
+ FreeBSD 3.1 which prevents a signal from being properly
+ dispatched to a thread that's in a blocking syscall. the
+ first signal interrupts the syscall, the second one actually
+ gets delivered. */
+ pthread_kill(killme, SIGUSR1);
+#endif
+#endif
+ }
}
/*
* The system-dependent wrapper around the main context loop.
*/
-void sd_context_loop(struct CitContext *con) {
+void *sd_context_loop(struct CitContext *con) {
pthread_cleanup_push(*cleanup_stuff, NULL);
context_loop(con);
pthread_cleanup_pop(0);
+ return NULL;
}
int alen; /* Data for master socket */
int ssock; /* Descriptor for master socket */
THREAD SessThread; /* Thread descriptor */
+ THREAD HousekeepingThread; /* Thread descriptor */
pthread_attr_t attr; /* Thread attributes */
struct CitContext *con; /* Temporary context pointer */
char tracefile[128]; /* Name of file to log traces to */
int a, i; /* General-purpose variables */
- char convbuf[128];
- char modpath[128];
+ fd_set readfds;
+ struct timeval tv;
+ struct passwd *pw;
+ int drop_root_perms = 1;
+ char *moddir;
/* specify default port name and trace file */
strcpy(tracefile, "");
/* -x specifies the desired logging level */
else if (!strncmp(argv[a], "-x", 2)) {
- strcpy(convbuf, argv[a]);
- verbosity = atoi(&convbuf[2]);
+ verbosity = atoi(&argv[a][2]);
}
else if (!strncmp(argv[a], "-h", 2)) {
- strcpy(convbuf, argv[a]);
- strcpy(bbs_home_directory, &convbuf[2]);
+ safestrncpy(bbs_home_directory, &argv[a][2],
+ sizeof bbs_home_directory);
home_specified = 1;
}
+ else if (!strncmp(argv[a], "-f", 2)) {
+ do_defrag = 1;
+ }
+
+ /* -r tells the server not to drop root permissions. don't use
+ * this unless you know what you're doing. this should be
+ * removed in the next release if it proves unnecessary. */
+ else if (!strcmp(argv[a], "-r"))
+ drop_root_perms = 0;
+
/* any other parameter makes it crash and burn */
else {
- lprintf(1, "citserver: usage: ");
- lprintf(1, "citserver [-tTraceFile]");
- lprintf(1, " [-d] [-xLogLevel] [-hHomeDir]\n");
+ lprintf(1, "citserver: usage: "
+ "citserver [-tTraceFile] [-d] [-f]"
+ " [-xLogLevel] [-hHomeDir]\n");
exit(1);
}
}
/* Tell 'em who's in da house */
- lprintf(1, "Multithreaded message server for %s\n", CITADEL);
- lprintf(1, "Copyright (C) 1987-1998 by Art Cancro. ");
- lprintf(1, "All rights reserved.\n\n");
+ lprintf(1,
+"\nMultithreaded message server for Citadel/UX\n"
+"Copyright (C) 1987-1999 by the Citadel/UX development team.\n"
+"Citadel/UX is free software, covered by the GNU General Public License, and\n"
+"you are welcome to change it and/or distribute copies of it under certain\n"
+"conditions. There is absolutely no warranty for this software. Please\n"
+"read the 'COPYING.txt' file for details.\n\n");
/* Initialize... */
init_sysdep();
openlog("citserver",LOG_PID,LOG_USER);
- lprintf(1, "Initting modules...\n");
- snprintf(modpath, 128, "%s/modules", BBSDIR);
- DLoader_Init(modpath);
- lprintf(1, "Modules done initializing...\n");
-/*
- lprintf(1, "First symtab item:");
- lprintf(1, my_symtab->fcn_name);
- lprintf(1, "\n");
-*/
/* Load site-specific parameters */
lprintf(7, "Loading citadel.config\n");
get_config();
- /* Do non system dependent startup functions */
- master_startup();
-
/*
* Bind the server to our favourite port.
* There is no need to check for errors, because ig_tcp_server()
lprintf(7, "Listening on socket %d\n", msock);
/*
- * Now that we've bound the socket, change to the BBS user id
- lprintf(7, "Changing uid to %d\n", BBSUID);
- if (setuid(BBSUID) != 0) {
- lprintf(3, "setuid() failed: %s", strerror(errno));
+ * Now that we've bound the socket, change to the BBS user id and its
+ * corresponding group ids
+ */
+ if (drop_root_perms) {
+ if ((pw = getpwuid(BBSUID)) == NULL)
+ lprintf(1, "WARNING: getpwuid(%d): %s\n"
+ "Group IDs will be incorrect.\n", BBSUID,
+ strerror(errno));
+ else {
+ initgroups(pw->pw_name, pw->pw_gid);
+ if (setgid(pw->pw_gid))
+ lprintf(3, "setgid(%d): %s\n", pw->pw_gid,
+ strerror(errno));
+ }
+ lprintf(7, "Changing uid to %d\n", BBSUID);
+ if (setuid(BBSUID) != 0) {
+ lprintf(3, "setuid() failed: %s\n", strerror(errno));
+ }
}
+
+ /*
+ * Do non system dependent startup functions.
+ */
+ master_startup();
+
+ /*
+ * Load any server-side modules (plugins) available here.
*/
+ lprintf(7, "Initializing loadable modules\n");
+ if ((moddir = malloc(strlen(bbs_home_directory) + 9)) != NULL) {
+ sprintf(moddir, "%s/modules", bbs_home_directory);
+ DLoader_Init(moddir);
+ free(moddir);
+ }
+
+ lprintf(7, "Starting housekeeper thread\n");
+ pthread_attr_init(&attr);
+ pthread_attr_setdetachstate(&attr, PTHREAD_CREATE_DETACHED);
+ if (pthread_create(&HousekeepingThread, &attr,
+ (void* (*)(void*)) housekeeping_loop, NULL) != 0) {
+ lprintf(1, "Can't create housekeeping thead: %s\n",
+ strerror(errno));
+ }
/*
* Endless loop. Listen on the master socket. When a connection
* comes in, create a socket, a context, and a thread.
*/
- while (1) {
+ while (!time_to_die) {
+ /* we need to check if a signal has been delivered. because
+ * syscalls may be restartable across signals, we call
+ * select with a timeout of 1 second and repeatedly check for
+ * time_to_die... */
+ FD_ZERO(&readfds);
+ FD_SET(msock, &readfds);
+ tv.tv_sec = 1;
+ tv.tv_usec = 0;
+ if (select(msock + 1, &readfds, NULL, NULL, &tv) <= 0)
+ continue;
+ alen = sizeof fsin;
ssock = accept(msock, (struct sockaddr *)&fsin, &alen);
if (ssock < 0) {
lprintf(2, "citserver: accept() failed: %s\n",
}
else {
lprintf(7, "citserver: Client socket %d\n", ssock);
- lprintf(9, "creating context\n");
con = CreateNewContext();
con->client_socket = ssock;
/* Set the SO_REUSEADDR socket option */
- lprintf(9, "setting socket options\n");
i = 1;
setsockopt(ssock, SOL_SOCKET, SO_REUSEADDR,
&i, sizeof(i));
/* set attributes for the new thread */
- lprintf(9, "setting thread attributes\n");
pthread_attr_init(&attr);
pthread_attr_setdetachstate(&attr,
PTHREAD_CREATE_DETACHED);
/* now create the thread */
- lprintf(9, "creating thread\n");
- if (pthread_create(&SessThread, &attr, (void *)sd_context_loop,
- con) != 0) {
+ if (pthread_create(&SessThread, &attr,
+ (void* (*)(void*)) sd_context_loop,
+ con)
+ != 0) {
lprintf(1,
"citserver: can't create thread: %s\n",
strerror(errno));
}
- /* detach the thread
- * (defunct -- now done at thread creation time)
- * if (pthread_detach(&SessThread) != 0) {
- * lprintf(1,
- * "citserver: can't detach thread: %s\n",
- * strerror(errno));
- * }
- */
- lprintf(9, "done!\n");
}
}
+ master_cleanup();
+ return 0;
}