2 * Citadel/UX "system dependent" stuff.
3 * See copyright.txt for copyright information.
5 * Here's where we (hopefully) have all the parts of the Citadel server that
6 * would need to be altered to run the server in a non-POSIX environment.
7 * Wherever possible, we use function wrappers and type definitions to create
8 * abstractions that are platform-independent from the calling side.
10 * Eventually we'll try porting to a different platform and either have
11 * multiple variants of this file or simply load it up with #ifdefs.
20 #include <sys/types.h>
22 #include <sys/socket.h>
24 #include <netinet/in.h>
34 #include "sysdep_decls.h"
35 #include "citserver.h"
39 #include "housekeeping.h"
40 #include "dynloader.h"
43 #include <sys/select.h>
46 pthread_mutex_t Critters[MAX_SEMAPHORES]; /* Things needing locking */
47 pthread_key_t MyConKey; /* TSD key for MyContext() */
49 int msock; /* master listening socket */
50 int verbosity = 3; /* Logging level */
54 * lprintf() ... Write logging information
56 void lprintf(int loglevel, const char *format, ...) {
61 if (loglevel <= verbosity) {
62 va_start(arg_ptr, format);
63 rc = vsprintf(buf, format, arg_ptr);
66 fprintf(stderr, "%s", buf);
74 * Some initialization stuff...
76 void init_sysdep(void) {
79 /* Set up a bunch of semaphores to be used for critical sections */
80 for (a=0; a<MAX_SEMAPHORES; ++a) {
81 pthread_mutex_init(&Critters[a], NULL);
85 * Set up a place to put thred-specific data.
86 * We only need a single pointer per thread - it points to the
87 * thread's CitContext structure in the ContextList linked list.
89 if (pthread_key_create(&MyConKey, NULL) != 0) {
90 lprintf(1, "Can't create TSD key!! %s\n", strerror(errno));
94 * The action for unexpected signals and exceptions should be to
95 * call master_cleanup() to gracefully shut down the server.
97 signal(SIGINT, (void(*)(int))master_cleanup);
98 signal(SIGQUIT, (void(*)(int))master_cleanup);
99 signal(SIGHUP, (void(*)(int))master_cleanup);
100 signal(SIGTERM, (void(*)(int))master_cleanup);
105 * Obtain a semaphore lock to begin a critical section.
107 void begin_critical_section(int which_one)
111 lprintf(8, "begin_critical_section(%d)\n", which_one);
113 /* Don't get interrupted during the critical section */
114 pthread_setcanceltype(PTHREAD_CANCEL_DEFERRED, &oldval);
116 /* Obtain a semaphore */
117 pthread_mutex_lock(&Critters[which_one]);
122 * Release a semaphore lock to end a critical section.
124 void end_critical_section(int which_one)
128 lprintf(8, " end_critical_section(%d)\n", which_one);
130 /* Let go of the semaphore */
131 pthread_mutex_unlock(&Critters[which_one]);
133 /* If a cancel was sent during the critical section, do it now.
134 * Then re-enable thread cancellation.
136 pthread_testcancel();
137 pthread_setcanceltype(PTHREAD_CANCEL_ASYNCHRONOUS, &oldval);
138 pthread_testcancel();
145 * This is a generic function to set up a master socket for listening on
146 * a TCP port. The server shuts down if the bind fails.
148 int ig_tcp_server(int port_number, int queue_len)
150 struct sockaddr_in sin;
153 bzero((char *)&sin, sizeof(sin));
154 sin.sin_family = AF_INET;
155 sin.sin_addr.s_addr = INADDR_ANY;
157 if (port_number == 0) {
158 lprintf(1, "citserver: No port number specified. Run setup again.\n");
162 sin.sin_port = htons((u_short)port_number);
164 s = socket(PF_INET, SOCK_STREAM, (getprotobyname("tcp")->p_proto));
166 lprintf(1, "citserver: Can't create a socket: %s\n",
171 /* Set the SO_REUSEADDR socket option, because it makes sense. */
173 setsockopt(s, SOL_SOCKET, SO_REUSEADDR, &i, sizeof(i));
175 if (bind(s, (struct sockaddr *)&sin, sizeof(sin)) < 0) {
176 lprintf(1, "citserver: Can't bind: %s\n", strerror(errno));
180 if (listen(s, queue_len) < 0) {
181 lprintf(1, "citserver: Can't listen: %s\n", strerror(errno));
190 * Return a pointer to a thread's own CitContext structure (old)
191 * NOTE: this version of MyContext() is commented out because it is no longer
192 * in use. It was written before I discovered TSD keys. This
193 * version pounds through the context list until it finds the one matching
194 * the currently running thread. It remains here, commented out, in case it
195 * is needed for future ports to threading libraries which have the equivalent
196 * of pthread_self() but not pthread_key_create() and its ilk.
198 * struct CitContext *MyContext() {
199 * struct CitContext *ptr;
202 * me = pthread_self();
203 * for (ptr=ContextList; ptr!=NULL; ptr=ptr->next) {
204 * if (ptr->mythread == me) return(ptr);
211 * Return a pointer to a thread's own CitContext structure (new)
213 struct CitContext *MyContext(void) {
214 return (struct CitContext *) pthread_getspecific(MyConKey);
219 * Wedge our way into the context list.
221 struct CitContext *CreateNewContext(void) {
222 struct CitContext *me;
224 lprintf(9, "CreateNewContext: calling malloc()\n");
225 me = (struct CitContext *) malloc(sizeof(struct CitContext));
227 lprintf(1, "citserver: can't allocate memory!!\n");
230 bzero(me, sizeof(struct CitContext));
232 begin_critical_section(S_SESSION_TABLE);
233 me->next = ContextList;
235 end_critical_section(S_SESSION_TABLE);
240 * Add a thread's thread ID to the context
242 void InitMyContext(struct CitContext *con)
246 con->mythread = pthread_self();
247 pthread_setcancelstate(PTHREAD_CANCEL_ENABLE, &oldval);
248 pthread_setcanceltype(PTHREAD_CANCEL_ASYNCHRONOUS, &oldval);
249 if (pthread_setspecific(MyConKey, (void *)con) != 0) {
250 lprintf(1, "ERROR! pthread_setspecific() failed: %s\n",
256 * Remove a context from the context list.
258 void RemoveContext(struct CitContext *con)
260 struct CitContext *ptr;
262 lprintf(7, "Starting RemoveContext()\n");
263 lprintf(9, "session count before RemoveContext is %d\n", session_count());
265 lprintf(7, "WARNING: RemoveContext() called with null!\n");
269 begin_critical_section(S_SESSION_TABLE);
270 lprintf(7, "Closing socket %d\n", con->client_socket);
271 close(con->client_socket);
273 if (ContextList==con) {
274 ContextList = ContextList->next;
277 for (ptr = ContextList; ptr != NULL; ptr = ptr->next) {
278 if (ptr->next == con) {
279 ptr->next = ptr->next->next;
286 lprintf(9, "session count after RemoveContext is %d\n", session_count());
288 lprintf(7, "Done with RemoveContext\n");
289 end_critical_section(S_SESSION_TABLE);
294 * Return the number of sessions currently running.
295 * (This should probably be moved out of sysdep.c)
297 int session_count(void) {
298 struct CitContext *ptr;
301 lprintf(9, "session_count() starting\n");
302 for (ptr = ContextList; ptr != NULL; ptr = ptr->next) {
304 lprintf(9, "Counted session %3d (%d)\n", ptr->cs_pid, TheCount);
307 lprintf(9, "session_count() finishing\n");
313 * client_write() ... Send binary data to the client.
315 void client_write(char *buf, int nbytes)
317 int bytes_written = 0;
319 while (bytes_written < nbytes) {
320 retval = write(CC->client_socket, &buf[bytes_written],
321 nbytes - bytes_written);
323 lprintf(2, "client_write() failed: %s\n",
327 bytes_written = bytes_written + retval;
333 * cprintf() ... Send formatted printable data to the client. It is
334 * implemented in terms of client_write() but remains in
335 * sysdep.c in case we port to somewhere without va_args...
337 void cprintf(const char *format, ...) {
342 va_start(arg_ptr, format);
343 rc = vsprintf(buf, format, arg_ptr);
346 client_write(buf, strlen(buf));
351 * Read data from the client socket.
353 * 1 Requested number of bytes has been read.
354 * 0 Request timed out.
355 * If the socket breaks, the session is immediately terminated.
357 int client_read_to(char *buf, int bytes, int timeout)
367 FD_SET(CC->client_socket, &rfds);
371 retval = select( (CC->client_socket)+1,
372 &rfds, NULL, NULL, &tv);
373 if (FD_ISSET(CC->client_socket, &rfds) == 0) {
377 rlen = read(CC->client_socket, &buf[len], bytes-len);
379 lprintf(2, "client_read() failed: %s\n",
389 * Read data from the client socket with default timeout.
390 * (This is implemented in terms of client_read_to() and could be
391 * justifiably moved out of sysdep.c)
393 int client_read(char *buf, int bytes)
395 return(client_read_to(buf, bytes, config.c_sleeping));
400 * client_gets() ... Get a LF-terminated line of text from the client.
401 * (This is implemented in terms of client_read() and could be
402 * justifiably moved out of sysdep.c)
404 int client_gets(char *buf)
408 /* Clear the buffer, and read one character at a time.
412 if (strlen(buf)<255) {
413 buf[strlen(buf) + 1] = 0;
414 retval = client_read(&buf[strlen(buf)], 1);
416 } while ( (buf[strlen(buf)-1] != 10) && (retval==1) );
418 /* Strip the trailing newline.
420 if (strlen(buf) > 0) buf[strlen(buf)-1] = 0;
427 * The system-dependent part of master_cleanup() - close the master socket.
429 void sysdep_master_cleanup(void) {
430 lprintf(7, "Closing master socket %d\n", msock);
435 * Cleanup routine to be called when one thread is shutting down.
437 void cleanup(int exit_code)
439 /* Terminate the thread.
440 * Its cleanup handler will call cleanup_stuff()
442 lprintf(7, "Calling pthread_exit()\n");
447 * Terminate another session.
449 void kill_session(int session_to_kill) {
450 struct CitContext *ptr;
452 for (ptr = ContextList; ptr != NULL; ptr = ptr->next) {
453 if (ptr->cs_pid == session_to_kill) {
454 pthread_cancel(ptr->mythread);
461 * The system-dependent wrapper around the main context loop.
463 void sd_context_loop(struct CitContext *con) {
464 pthread_cleanup_push(*cleanup_stuff, NULL);
466 pthread_cleanup_pop(0);
471 * Start running as a daemon. Only close stdio if do_close_stdio is set.
473 void start_daemon(int do_close_stdio) {
474 if (do_close_stdio) {
479 signal(SIGHUP,SIG_IGN);
480 signal(SIGINT,SIG_IGN);
481 signal(SIGQUIT,SIG_IGN);
482 if (fork()!=0) exit(0);
488 * Tie in to the 'netsetup' program.
490 * (We're going to hope that netsetup never feeds more than 4096 bytes back.)
492 void cmd_nset(char *cmdbuf)
499 char netsetup_args[3][256];
501 if (CC->usersupp.axlevel < 6) {
502 cprintf("%d Higher access required.\n",
503 ERROR + HIGHER_ACCESS_REQUIRED);
507 for (a=1; a<=3; ++a) {
508 if (num_parms(cmdbuf) >= a) {
509 extract(netsetup_args[a-1], cmdbuf, a-1);
510 for (b=0; b<strlen(netsetup_args[a-1]); ++b) {
511 if (netsetup_args[a-1][b] == 34) {
512 netsetup_args[a-1][b] = '_';
517 netsetup_args[a-1][0] = 0;
521 sprintf(fbuf, "./netsetup \"%s\" \"%s\" \"%s\" </dev/null 2>&1",
522 netsetup_args[0], netsetup_args[1], netsetup_args[2]);
523 netsetup = popen(fbuf, "r");
524 if (netsetup == NULL) {
525 cprintf("%d %s\n", ERROR, strerror(errno));
530 while (ch = getc(netsetup), (ch > 0)) {
531 fbuf[strlen(fbuf)+1] = 0;
532 fbuf[strlen(fbuf)] = ch;
535 retcode = pclose(netsetup);
538 for (a=0; a<strlen(fbuf); ++a) {
539 if (fbuf[a] < 32) fbuf[a] = 32;
542 cprintf("%d %s\n", ERROR, fbuf);
546 cprintf("%d Command succeeded. Output follows:\n", LISTING_FOLLOWS);
548 if (fbuf[strlen(fbuf)-1] != 10) cprintf("\n");
555 * Generic routine to convert a login name to a full name (gecos)
556 * Returns nonzero if a conversion took place
558 int convert_login(char NameToConvert[]) {
562 pw = getpwnam(NameToConvert);
567 strcpy(NameToConvert, pw->pw_gecos);
568 for (a=0; a<strlen(NameToConvert); ++a) {
569 if (NameToConvert[a] == ',') NameToConvert[a] = 0;
581 * Here's where it all begins.
583 int main(int argc, char **argv)
585 struct sockaddr_in fsin; /* Data for master socket */
586 int alen; /* Data for master socket */
587 int ssock; /* Descriptor for master socket */
588 THREAD SessThread; /* Thread descriptor */
589 pthread_attr_t attr; /* Thread attributes */
590 struct CitContext *con; /* Temporary context pointer */
591 char tracefile[128]; /* Name of file to log traces to */
592 int a, i; /* General-purpose variables */
596 /* specify default port name and trace file */
597 strcpy(tracefile, "");
599 /* parse command-line arguments */
600 for (a=1; a<argc; ++a) {
602 /* -t specifies where to log trace messages to */
603 if (!strncmp(argv[a], "-t", 2)) {
604 strcpy(tracefile, argv[a]);
605 strcpy(tracefile, &tracefile[2]);
606 freopen(tracefile, "r", stdin);
607 freopen(tracefile, "w", stdout);
608 freopen(tracefile, "w", stderr);
611 /* run in the background if -d was specified */
612 else if (!strcmp(argv[a], "-d")) {
613 start_daemon( (strlen(tracefile) > 0) ? 0 : 1 ) ;
616 /* -x specifies the desired logging level */
617 else if (!strncmp(argv[a], "-x", 2)) {
618 strcpy(convbuf, argv[a]);
619 verbosity = atoi(&convbuf[2]);
622 else if (!strncmp(argv[a], "-h", 2)) {
623 strcpy(convbuf, argv[a]);
624 strcpy(bbs_home_directory, &convbuf[2]);
628 /* any other parameter makes it crash and burn */
630 lprintf(1, "citserver: usage: ");
631 lprintf(1, "citserver [-tTraceFile]");
632 lprintf(1, " [-d] [-xLogLevel] [-hHomeDir]\n");
638 /* Tell 'em who's in da house */
639 lprintf(1, "Multithreaded message server for %s\n", CITADEL);
640 lprintf(1, "Copyright (C) 1987-1998 by Art Cancro. ");
641 lprintf(1, "All rights reserved.\n\n");
645 openlog("citserver",LOG_PID,LOG_USER);
646 lprintf(1, "Initting modules...\n");
647 snprintf(modpath, 128, "%s/modules", BBSDIR);
648 DLoader_Init(modpath);
649 lprintf(1, "Modules done initializing...\n");
651 lprintf(1, "First symtab item:");
652 lprintf(1, my_symtab->fcn_name);
655 /* Load site-specific parameters */
656 lprintf(7, "Loading citadel.config\n");
659 /* Databases must be opened *after* config is loaded, otherwise we might
660 * end up working in the wrong directory.
662 lprintf(7, "Opening databases\n");
665 lprintf(7, "Checking floor reference counts\n");
669 * Bind the server to our favourite port.
670 * There is no need to check for errors, because ig_tcp_server()
671 * exits if it doesn't succeed.
673 lprintf(7, "Attempting to bind to port %d...\n", config.c_port_number);
674 msock = ig_tcp_server(config.c_port_number, 5);
675 lprintf(7, "Listening on socket %d\n", msock);
678 * Now that we've bound the socket, change to the BBS user id
679 lprintf(7, "Changing uid to %d\n", BBSUID);
680 if (setuid(BBSUID) != 0) {
681 lprintf(3, "setuid() failed: %s", strerror(errno));
686 * Endless loop. Listen on the master socket. When a connection
687 * comes in, create a socket, a context, and a thread.
690 ssock = accept(msock, (struct sockaddr *)&fsin, &alen);
692 lprintf(2, "citserver: accept() failed: %s\n",
696 lprintf(7, "citserver: Client socket %d\n", ssock);
697 lprintf(9, "creating context\n");
698 con = CreateNewContext();
699 con->client_socket = ssock;
701 /* Set the SO_REUSEADDR socket option */
702 lprintf(9, "setting socket options\n");
704 setsockopt(ssock, SOL_SOCKET, SO_REUSEADDR,
707 /* set attributes for the new thread */
708 lprintf(9, "setting thread attributes\n");
709 pthread_attr_init(&attr);
710 pthread_attr_setdetachstate(&attr,
711 PTHREAD_CREATE_DETACHED);
713 /* now create the thread */
714 lprintf(9, "creating thread\n");
715 if (pthread_create(&SessThread, &attr, (void *)sd_context_loop,
718 "citserver: can't create thread: %s\n",
723 * (defunct -- now done at thread creation time)
724 * if (pthread_detach(&SessThread) != 0) {
726 * "citserver: can't detach thread: %s\n",
730 lprintf(9, "done!\n");