*
* 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
- * abstractions that are platform-independent from the calling side.
*
* Eventually we'll try porting to a different platform and either have
* multiple variants of this file or simply load it up with #ifdefs.
pthread_mutex_t Critters[MAX_SEMAPHORES]; /* Things needing locking */
pthread_key_t MyConKey; /* TSD key for MyContext() */
-int msock; /* master listening socket */
int verbosity = DEFAULT_VERBOSITY; /* Logging level */
struct CitContext masterCC;
int rescan[2]; /* The Rescan Pipe */
+time_t last_purge = 0; /* Last dead session purge */
+int num_threads = 0; /* Current number of threads */
+int num_sessions = 0; /* Current number of sessions */
+
+fd_set masterfds; /* Master sockets etc. */
+int masterhighest;
+
/*
* lprintf() ... Write logging information
static RETSIGTYPE signal_cleanup(int signum) {
time_to_die = 1;
- }
+}
/*
/* Set up a bunch of semaphores to be used for critical sections */
for (a=0; a<MAX_SEMAPHORES; ++a) {
pthread_mutex_init(&Critters[a], NULL);
- }
+ }
/*
* Set up a place to put thread-specific data.
*/
if (pthread_key_create(&MyConKey, NULL) != 0) {
lprintf(1, "Can't create TSD key!! %s\n", strerror(errno));
- }
+ }
/*
* The action for unexpected signals and exceptions should be to
* socket breaks.
*/
signal(SIGPIPE, SIG_IGN);
- }
+}
/*
sin.sin_addr.s_addr = INADDR_ANY;
if (port_number == 0) {
- lprintf(1,
- "citserver: No port number specified. Run setup.\n");
- exit(1);
- }
+ lprintf(1, "citserver: illegal port number specified\n");
+ return(-1);
+ }
sin.sin_port = htons((u_short)port_number);
if (s < 0) {
lprintf(1, "citserver: Can't create a socket: %s\n",
strerror(errno));
- exit(errno);
- }
+ return(-1);
+ }
/* Set the SO_REUSEADDR socket option, because it makes sense. */
i = 1;
if (bind(s, (struct sockaddr *)&sin, sizeof(sin)) < 0) {
lprintf(1, "citserver: Can't bind: %s\n", strerror(errno));
- exit(errno);
+ sin.sin_port = 0;
+ if (bind(s, (struct sockaddr *)&sin, sizeof(sin)) < 0) {
+ lprintf(1, "citserver: Can't bind: %s\n",
+ strerror(errno));
+ return(-1);
+ }
+ else {
+ lprintf(1, "bind to alternate port %d ok\n",
+ htons(sin.sin_port) );
}
+ }
if (listen(s, queue_len) < 0) {
lprintf(1, "citserver: Can't listen: %s\n", strerror(errno));
- exit(errno);
- }
+ return(-1);
+ }
return(s);
- }
+}
retCC = (struct CitContext *) pthread_getspecific(MyConKey);
if (retCC == NULL) retCC = &masterCC;
return(retCC);
- }
+}
/*
struct CitContext *CreateNewContext(void) {
struct CitContext *me, *ptr;
int num = 1;
+ int startover = 0;
me = (struct CitContext *) mallok(sizeof(struct CitContext));
if (me == NULL) {
lprintf(1, "citserver: can't allocate memory!!\n");
return NULL;
- }
+ }
memset(me, 0, sizeof(struct CitContext));
/* The new context will be created already in the CON_EXECUTING state
begin_critical_section(S_SESSION_TABLE);
/* obtain a unique session number */
- for (ptr = ContextList; ptr != NULL; ptr = ptr->next) {
- if (ptr->cs_pid == num) {
- ++num;
- ptr = ContextList;
+ do {
+ startover = 0;
+ for (ptr = ContextList; ptr != NULL; ptr = ptr->next) {
+ if (ptr->cs_pid == num) {
+ ++num;
+ startover = 1;
+ }
}
- }
+ } while (startover == 1);
me->cs_pid = num;
me->next = ContextList;
ContextList = me;
+ ++num_sessions;
end_critical_section(S_SESSION_TABLE);
return(me);
- }
-
-
-
-/*
- * Return the number of sessions currently running.
- * (This should probably be moved out of sysdep.c)
- */
-int session_count(void) {
- struct CitContext *ptr;
- int TheCount = 0;
-
- begin_critical_section(S_SESSION_TABLE);
- for (ptr = ContextList; ptr != NULL; ptr = ptr->next) {
- ++TheCount;
- }
- end_critical_section(S_SESSION_TABLE);
+}
- return(TheCount);
- }
/*
strerror(errno));
CC->kill_me = 1;
return;
- }
- bytes_written = bytes_written + retval;
}
+ bytes_written = bytes_written + retval;
}
+}
/*
buf[sizeof buf - 2] = '\n';
client_write(buf, strlen(buf));
va_end(arg_ptr);
- }
+}
/*
* Return values are:
* 1 Requested number of bytes has been read.
* 0 Request timed out.
- * If the socket breaks, the session is immediately terminated.
+ * -1 The socket is broken.
+ * If the socket breaks, the session will be terminated.
*/
int client_read_to(char *buf, int bytes, int timeout)
{
while(len<bytes) {
FD_ZERO(&rfds);
FD_SET(CC->client_socket, &rfds);
- tv.tv_sec = 1;
+ tv.tv_sec = timeout;
tv.tv_usec = 0;
retval = select( (CC->client_socket)+1,
if (FD_ISSET(CC->client_socket, &rfds) == 0) {
return(0);
- }
+ }
rlen = read(CC->client_socket, &buf[len], bytes-len);
if (rlen<1) {
strerror(errno));
CC->kill_me = 1;
return(-1);
- }
- len = len + rlen;
}
- return(1);
+ len = len + rlen;
}
+ return(1);
+}
/*
* Read data from the client socket with default timeout.
int client_read(char *buf, int bytes)
{
return(client_read_to(buf, bytes, config.c_sleeping));
- }
+}
/*
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.
*/
while ((strlen(buf)>0)&&(!isprint(buf[strlen(buf)-1])))
buf[strlen(buf)-1] = 0;
return(retval);
- }
+}
* The system-dependent part of master_cleanup() - close the master socket.
*/
void sysdep_master_cleanup(void) {
- lprintf(7, "Closing master socket %d\n", msock);
- close(msock);
- }
+ /* FIX close all protocol master sockets here */
+}
/*
/* close(0); */
close(1);
close(2);
- }
+ }
signal(SIGHUP,SIG_IGN);
signal(SIGINT,SIG_IGN);
signal(SIGQUIT,SIG_IGN);
if (fork()!=0) exit(0);
- }
+}
cprintf("%d Higher access required.\n",
ERROR + HIGHER_ACCESS_REQUIRED);
return;
- }
+ }
for (a=1; a<=3; ++a) {
if (num_parms(cmdbuf) >= a) {
for (b=0; b<strlen(netsetup_args[a-1]); ++b) {
if (netsetup_args[a-1][b] == 34) {
netsetup_args[a-1][b] = '_';
- }
}
}
+ }
else {
netsetup_args[a-1][0] = 0;
- }
}
+ }
sprintf(fbuf, "./netsetup \"%s\" \"%s\" \"%s\" </dev/null 2>&1",
netsetup_args[0], netsetup_args[1], netsetup_args[2]);
if (netsetup == NULL) {
cprintf("%d %s\n", ERROR, strerror(errno));
return;
- }
+ }
fbuf[0] = 0;
while (ch = getc(netsetup), (ch > 0)) {
fbuf[strlen(fbuf)+1] = 0;
fbuf[strlen(fbuf)] = ch;
- }
+ }
retcode = pclose(netsetup);
if (retcode != 0) {
for (a=0; a<strlen(fbuf); ++a) {
if (fbuf[a] < 32) fbuf[a] = 32;
- }
+ }
fbuf[245] = 0;
cprintf("%d %s\n", ERROR, fbuf);
return;
- }
+ }
cprintf("%d Command succeeded. Output follows:\n", LISTING_FOLLOWS);
cprintf("%s", fbuf);
if (fbuf[strlen(fbuf)-1] != 10) cprintf("\n");
cprintf("000\n");
- }
+}
pw = getpwnam(NameToConvert);
if (pw == NULL) {
return(0);
- }
+ }
else {
strcpy(NameToConvert, pw->pw_gecos);
for (a=0; a<strlen(NameToConvert); ++a) {
if (NameToConvert[a] == ',') NameToConvert[a] = 0;
- }
- return(1);
}
+ return(1);
}
+}
* This function has code to prevent it from running more than once every
* few seconds, because running it after every single unbind would waste a lot
* of CPU time and keep the context list locked too much.
+ *
+ * After that's done, we raise or lower the size of the worker thread pool
+ * if such an action is appropriate.
*/
void dead_session_purge(void) {
- static time_t last_purge = 0;
struct CitContext *ptr, *rem;
-
+ pthread_attr_t attr;
+ pthread_t newthread;
+
if ( (time(NULL) - last_purge) < 5 ) return; /* Too soon, go away */
+ time(&last_purge);
do {
rem = NULL;
begin_critical_section(S_SESSION_TABLE);
for (ptr = ContextList; ptr != NULL; ptr = ptr->next) {
if ( (ptr->state == CON_IDLE) && (ptr->kill_me) ) {
- rem = ptr;
+ rem = ptr;
}
}
end_critical_section(S_SESSION_TABLE);
/* RemoveContext() enters its own S_SESSION_TABLE critical
* section, so we have to do it like this.
*/
- if (rem != NULL) RemoveContext(rem);
+ if (rem != NULL) {
+ lprintf(9, "Purging session %d\n", rem->cs_pid);
+ RemoveContext(rem);
+ }
} while (rem != NULL);
+
+
+ /* Raise or lower the size of the worker thread pool if such
+ * an action is appropriate.
+ */
+
+ if ( (num_sessions > num_threads)
+ && (num_threads < config.c_max_workers) ) {
+
+ pthread_attr_init(&attr);
+ pthread_attr_setdetachstate(&attr, PTHREAD_CREATE_DETACHED);
+ if (pthread_create(&newthread, &attr,
+ (void* (*)(void*)) worker_thread, NULL) != 0) {
+ lprintf(1, "Can't create worker thead: %s\n",
+ strerror(errno));
+ }
+
+ }
+
+ else if ( (num_sessions < num_threads)
+ && (num_threads > config.c_min_workers) ) {
+ --num_threads;
+ pthread_exit(NULL);
+ }
+
}
struct passwd *pw;
int drop_root_perms = 1;
char *moddir;
+ struct ServiceFunctionHook *serviceptr;
/* specify default port name and trace file */
strcpy(tracefile, "");
freopen(tracefile, "r", stdin);
freopen(tracefile, "w", stdout);
freopen(tracefile, "w", stderr);
- }
+ }
/* run in the background if -d was specified */
else if (!strcmp(argv[a], "-d")) {
start_daemon( (strlen(tracefile) > 0) ? 0 : 1 ) ;
- }
+ }
/* -x specifies the desired logging level */
else if (!strncmp(argv[a], "-x", 2)) {
verbosity = atoi(&argv[a][2]);
- }
+ }
else if (!strncmp(argv[a], "-h", 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
"citserver [-tTraceFile] [-d] [-f]"
" [-xLogLevel] [-hHomeDir]\n");
exit(1);
- }
-
}
+ }
+
/* Tell 'em who's in da house */
lprintf(1,
"\nMultithreaded message server for Citadel/UX\n"
get_config();
/*
- * Bind the server to our favourite port.
- * There is no need to check for errors, because ig_tcp_server()
- * exits if it doesn't succeed.
+ * Do non system dependent startup functions.
+ */
+ master_startup();
+
+ /*
+ * Bind the server to our favorite ports.
+ */
+ CtdlRegisterServiceHook(config.c_port_number,
+ citproto_begin_session,
+ do_command_loop);
+
+ /*
+ * 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);
+ }
+
+ /*
+ * The rescan pipe exists so that worker threads can be woken up and
+ * told to re-scan the context list for fd's to listen on. This is
+ * necessary, for example, when a context is about to go idle and needs
+ * to get back on that list.
+ */
+ if (pipe(rescan)) {
+ lprintf(1, "Can't create rescan pipe!\n");
+ exit(errno);
+ }
+
+ /*
+ * Set up a fd_set containing all the master sockets to which we
+ * always listen. It's computationally less expensive to just copy
+ * this to a local fd_set when starting a new select() and then add
+ * the client sockets than it is to initialize a new one and then
+ * figure out what to put there.
*/
- lprintf(7, "Attempting to bind to port %d...\n", config.c_port_number);
- msock = ig_tcp_server(config.c_port_number, 5);
- lprintf(7, "Listening on socket %d\n", msock);
+ FD_ZERO(&masterfds);
+ masterhighest = 0;
+ FD_SET(rescan[0], &masterfds);
+ if (rescan[0] > masterhighest) masterhighest = rescan[0];
+
+ for (serviceptr = ServiceHookTable; serviceptr != NULL;
+ serviceptr = serviceptr->next ) {
+ serviceptr->msock = ig_tcp_server(
+ serviceptr->tcp_port, config.c_maxsessions);
+ if (serviceptr->msock >= 0) {
+ FD_SET(serviceptr->msock, &masterfds);
+ if (serviceptr->msock > masterhighest)
+ masterhighest = serviceptr->msock;
+ lprintf(7, "Bound to port %-5d (socket %d)\n",
+ serviceptr->tcp_port,
+ serviceptr->msock);
+ }
+ else {
+ lprintf(1, "Unable to bind to port %d\n",
+ serviceptr->tcp_port);
+ }
+ }
+
/*
- * Now that we've bound the socket, change to the BBS user id and its
+ * Now that we've bound the sockets, change to the BBS user id and its
* corresponding group ids
*/
if (drop_root_perms) {
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.
+ * Create the housekeeper thread
*/
- 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);
}
- /*
- * The rescan pipe exists so that worker threads can be woken up and
- * told to re-scan the context list for fd's to listen on. This is
- * necessary, for example, when a context is about to go idle and needs
- * to get back on that list.
- */
- if (pipe(rescan)) {
- lprintf(1, "Can't create rescan pipe!\n");
- exit(errno);
- }
-
/*
* Now create a bunch of worker threads.
*/
- for (i=0; i<(NUM_WORKER_THREADS-1); ++i) {
+ for (i=0; i<(config.c_min_workers-1); ++i) {
pthread_attr_init(&attr);
pthread_attr_setdetachstate(&attr, PTHREAD_CREATE_DETACHED);
if (pthread_create(&HousekeepingThread, &attr,
}
-
-
+/*
+ * Bind a thread to a context.
+ */
+inline void become_session(struct CitContext *which_con) {
+ pthread_setspecific(MyConKey, (void *)which_con );
+}
void worker_thread(void) {
int i;
char junk;
- int numselect = 0;
int highest;
struct CitContext *ptr;
struct CitContext *bind_me = NULL;
fd_set readfds;
int retval;
struct CitContext *con= NULL; /* Temporary context pointer */
+ struct ServiceFunctionHook *serviceptr;
struct sockaddr_in fsin; /* Data for master socket */
int alen; /* Data for master socket */
int ssock; /* Descriptor for client socket */
+ ++num_threads;
while (!time_to_die) {
/*
- * In a stupid environment, we would have all idle threads
+ * A naive implementation would have all idle threads
* calling select() and then they'd all wake up at once. We
* solve this problem by putting the select() in a critical
* section, so only one thread has the opportunity to wake
*/
begin_critical_section(S_I_WANNA_SELECT);
-SETUP_FD: FD_ZERO(&readfds);
- FD_SET(msock, &readfds);
- highest = msock;
- FD_SET(rescan[0], &readfds);
- if (rescan[0] > highest) highest = rescan[0];
- numselect = 2;
-
+SETUP_FD: memcpy(&readfds, &masterfds, sizeof(fd_set) );
+ highest = masterhighest;
begin_critical_section(S_SESSION_TABLE);
for (ptr = ContextList; ptr != NULL; ptr = ptr->next) {
if (ptr->state == CON_IDLE) {
FD_SET(ptr->client_socket, &readfds);
if (ptr->client_socket > highest)
highest = ptr->client_socket;
- ++numselect;
}
}
end_critical_section(S_SESSION_TABLE);
*/
if (retval < 0) {
end_critical_section(S_I_WANNA_SELECT);
- lprintf(9, "Exiting (%s)\n", errno);
+ lprintf(9, "Exiting (%s)\n", strerror(errno));
time_to_die = 1;
}
/* Next, check to see if it's a new client connecting
* on the master socket.
*/
- else if (FD_ISSET(msock, &readfds)) {
- alen = sizeof fsin;
- ssock = accept(msock, (struct sockaddr *)&fsin, &alen);
- if (ssock < 0) {
- lprintf(2, "citserver: accept() failed: %s\n",
- strerror(errno));
- }
- else {
- lprintf(7, "citserver: New client socket %d\n",
- ssock);
-
- /* New context will be created already set up
- * in the CON_EXECUTING state.
- */
- con = CreateNewContext();
-
- /* Assign our new socket number to it. */
- con->client_socket = ssock;
+ else for (serviceptr = ServiceHookTable; serviceptr != NULL;
+ serviceptr = serviceptr->next ) {
+
+ if (FD_ISSET(serviceptr->msock, &readfds)) {
+ alen = sizeof fsin;
+ ssock = accept(serviceptr->msock,
+ (struct sockaddr *)&fsin, &alen);
+ if (ssock < 0) {
+ lprintf(2, "citserver: accept(): %s\n",
+ strerror(errno));
+ }
+ else {
+ lprintf(7, "citserver: "
+ "New client socket %d\n",
+ ssock);
+
+ /* New context will be created already
+ * set up in the CON_EXECUTING state.
+ */
+ con = CreateNewContext();
+
+ /* Assign new socket number to it. */
+ con->client_socket = ssock;
+ con->h_command_function =
+ serviceptr->h_command_function;
- /* Set the SO_REUSEADDR socket option */
- i = 1;
- setsockopt(ssock, SOL_SOCKET, SO_REUSEADDR,
- &i, sizeof(i));
-
- pthread_setspecific(MyConKey, (void *)con);
- begin_session(con);
- /* do_command_loop(); */
- pthread_setspecific(MyConKey, (void *)NULL);
- con->state = CON_IDLE;
- goto SETUP_FD;
+ /* Set the SO_REUSEADDR socket option */
+ i = 1;
+ setsockopt(ssock, SOL_SOCKET,
+ SO_REUSEADDR,
+ &i, sizeof(i));
+
+ become_session(con);
+ begin_session(con);
+ serviceptr->h_greeting_function();
+ become_session(NULL);
+ con->state = CON_IDLE;
+ goto SETUP_FD;
+ }
}
}
* thread that the &readfds needs to be refreshed with more
* current data.
*/
- else if (FD_ISSET(rescan[0], &readfds)) {
+ if (!time_to_die) if (FD_ISSET(rescan[0], &readfds)) {
read(rescan[0], &junk, 1);
goto SETUP_FD;
}
/* We're bound to a session, now do *one* command */
if (bind_me != NULL) {
- pthread_setspecific(MyConKey, (void *)bind_me);
- do_command_loop();
- pthread_setspecific(MyConKey, (void *)NULL);
+ become_session(bind_me);
+ CC->h_command_function();
+ become_session(NULL);
bind_me->state = CON_IDLE;
if (bind_me->kill_me == 1) {
RemoveContext(bind_me);
write(rescan[1], &junk, 1);
}
else {
- lprintf(9, "Thread %02d found nothing to do!\n",
- getpid());
+ lprintf(9, "Thread found nothing to do!\n");
}
}
dead_session_purge();
}
+ /* If control reaches this point, the server is shutting down */
+ master_cleanup();
+ --num_threads;
pthread_exit(NULL);
}