* more merges
[citadel.git] / citadel / sysdep.c
1 /*
2  * $Id$
3  *
4  * Citadel/UX "system dependent" stuff.
5  * See copyright.txt for copyright information.
6  *
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.
9  * 
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.
12  *
13  */
14
15
16 #include "sysdep.h"
17 #include <stdlib.h>
18 #include <unistd.h>
19 #include <stdio.h>
20 #include <fcntl.h>
21 #include <ctype.h>
22 #include <signal.h>
23 #include <sys/types.h>
24 #include <sys/stat.h>
25 #include <sys/wait.h>
26 #include <sys/socket.h>
27 #include <sys/time.h>
28 #include <limits.h>
29 #include <netinet/in.h>
30 #include <netdb.h>
31 #include <sys/un.h>
32 #include <string.h>
33 #include <pwd.h>
34 #include <errno.h>
35 #include <stdarg.h>
36 #include <syslog.h>
37 #include <grp.h>
38 #ifdef __GNUC__
39 #include <malloc.h>
40 #endif
41 #ifdef HAVE_PTHREAD_H
42 #include <pthread.h>
43 #endif
44 #include "citadel.h"
45 #include "server.h"
46 #include "sysdep_decls.h"
47 #include "citserver.h"
48 #include "support.h"
49 #include "config.h"
50 #include "database.h"
51 #include "housekeeping.h"
52 #include "dynloader.h"
53 #include "tools.h"
54
55 #ifdef HAVE_SYS_SELECT_H
56 #include <sys/select.h>
57 #endif
58
59 #ifndef HAVE_SNPRINTF
60 #include "snprintf.h"
61 #endif
62
63 #ifdef DEBUG_MEMORY_LEAKS
64 struct TheHeap *heap = NULL;
65 #endif
66
67 pthread_mutex_t Critters[MAX_SEMAPHORES];       /* Things needing locking */
68 pthread_key_t MyConKey;                         /* TSD key for MyContext() */
69
70 int verbosity = DEFAULT_VERBOSITY;              /* Logging level */
71
72 struct CitContext masterCC;
73 int rescan[2];                                  /* The Rescan Pipe */
74 time_t last_purge = 0;                          /* Last dead session purge */
75 static int num_threads = 0;                     /* Current number of threads */
76 int num_sessions = 0;                           /* Current number of sessions */
77
78 fd_set masterfds;                               /* Master sockets etc. */
79 int masterhighest;
80
81 time_t last_timer = 0L;                         /* Last timer hook processing */
82
83 static pthread_t initial_thread;                /* tid for main() thread */
84
85
86 /*
87  * lprintf()  ...   Write logging information
88  */
89 void lprintf(int loglevel, const char *format, ...) {   
90         va_list arg_ptr;
91         char buf[512];
92   
93         va_start(arg_ptr, format);   
94         vsprintf(buf, format, arg_ptr);   
95         va_end(arg_ptr);   
96
97         if (loglevel <= verbosity) { 
98                 fprintf(stderr, "%s", buf);
99                 fflush(stderr);
100         }
101
102         PerformLogHooks(loglevel, buf);
103 }   
104
105
106
107 #ifdef DEBUG_MEMORY_LEAKS
108 void *tracked_malloc(size_t tsize, char *tfile, int tline) {
109         void *ptr;
110         struct TheHeap *hptr;
111
112         ptr = malloc(tsize);
113         if (ptr == NULL) {
114                 lprintf(3, "DANGER!  mallok(%d) at %s:%d failed!\n",
115                         tsize, tfile, tline);
116                 return(NULL);
117         }
118
119         hptr = (struct TheHeap *) malloc(sizeof(struct TheHeap));
120         strcpy(hptr->h_file, tfile);
121         hptr->h_line = tline;
122         hptr->next = heap;
123         hptr->h_ptr = ptr;
124         heap = hptr;
125         return ptr;
126 }
127
128 char *tracked_strdup(const char *orig, char *tfile, int tline) {
129         char *s;
130
131         s = tracked_malloc( (strlen(orig)+1), tfile, tline);
132         if (s == NULL) return NULL;
133
134         strcpy(s, orig);
135         return s;
136 }
137
138 void tracked_free(void *ptr) {
139         struct TheHeap *hptr, *freeme;
140
141         if (heap->h_ptr == ptr) {
142                 hptr = heap->next;
143                 free(heap);
144                 heap = hptr;
145         }
146         else {
147                 for (hptr=heap; hptr->next!=NULL; hptr=hptr->next) {
148                         if (hptr->next->h_ptr == ptr) {
149                                 freeme = hptr->next;
150                                 hptr->next = hptr->next->next;
151                                 free(freeme);
152                         }
153                 }
154         }
155
156         free(ptr);
157 }
158
159 void *tracked_realloc(void *ptr, size_t size) {
160         void *newptr;
161         struct TheHeap *hptr;
162         
163         newptr = realloc(ptr, size);
164
165         for (hptr=heap; hptr!=NULL; hptr=hptr->next) {
166                 if (hptr->h_ptr == ptr) hptr->h_ptr = newptr;
167         }
168
169         return newptr;
170 }
171
172
173 void dump_tracked() {
174         struct TheHeap *hptr;
175
176         cprintf("%d Here's what's allocated...\n", LISTING_FOLLOWS);    
177         for (hptr=heap; hptr!=NULL; hptr=hptr->next) {
178                 cprintf("%20s %5d\n",
179                         hptr->h_file, hptr->h_line);
180         }
181 #ifdef __GNUC__
182         malloc_stats();
183 #endif
184
185         cprintf("000\n");
186 }
187 #endif
188
189
190 /*
191  * We used to use master_cleanup() as a signal handler to shut down the server.
192  * however, master_cleanup() and the functions it calls do some things that
193  * aren't such a good idea to do from a signal handler: acquiring mutexes,
194  * playing with signal masks on BSDI systems, etc. so instead we install the
195  * following signal handler to set a global variable to inform the main loop
196  * that it's time to call master_cleanup() and exit.
197  */
198
199 volatile int time_to_die = 0;
200
201 static RETSIGTYPE signal_cleanup(int signum) {
202         time_to_die = 1;
203 }
204
205
206 /*
207  * Some initialization stuff...
208  */
209 void init_sysdep(void) {
210         int a;
211
212         /* Set up a bunch of semaphores to be used for critical sections */
213         for (a=0; a<MAX_SEMAPHORES; ++a) {
214                 pthread_mutex_init(&Critters[a], NULL);
215         }
216
217         /*
218          * Set up a place to put thread-specific data.
219          * We only need a single pointer per thread - it points to the
220          * CitContext structure (in the ContextList linked list) of the
221          * session to which the calling thread is currently bound.
222          */
223         if (pthread_key_create(&MyConKey, NULL) != 0) {
224                 lprintf(1, "Can't create TSD key!!  %s\n", strerror(errno));
225         }
226
227         /*
228          * The action for unexpected signals and exceptions should be to
229          * call signal_cleanup() to gracefully shut down the server.
230          */
231         signal(SIGINT, signal_cleanup);
232         signal(SIGQUIT, signal_cleanup);
233         signal(SIGHUP, signal_cleanup);
234         signal(SIGTERM, signal_cleanup);
235
236         /*
237          * Do not shut down the server on broken pipe signals, otherwise the
238          * whole Citadel service would come down whenever a single client
239          * socket breaks.
240          */
241         signal(SIGPIPE, SIG_IGN);
242 }
243
244
245 /*
246  * Obtain a semaphore lock to begin a critical section.
247  */
248 void begin_critical_section(int which_one)
249 {
250         /* lprintf(9, "begin_critical_section(%d)\n", which_one); */
251         pthread_mutex_lock(&Critters[which_one]);
252 }
253
254 /*
255  * Release a semaphore lock to end a critical section.
256  */
257 void end_critical_section(int which_one)
258 {
259         /* lprintf(9, "end_critical_section(%d)\n", which_one); */
260         pthread_mutex_unlock(&Critters[which_one]);
261 }
262
263
264
265 /*
266  * This is a generic function to set up a master socket for listening on
267  * a TCP port.  The server shuts down if the bind fails.
268  *
269  */
270 int ig_tcp_server(int port_number, int queue_len)
271 {
272         struct sockaddr_in sin;
273         int s, i;
274         int actual_queue_len;
275
276         actual_queue_len = queue_len;
277         if (actual_queue_len < 5) actual_queue_len = 5;
278
279         memset(&sin, 0, sizeof(sin));
280         sin.sin_family = AF_INET;
281         sin.sin_addr.s_addr = INADDR_ANY;
282         sin.sin_port = htons((u_short)port_number);
283
284         s = socket(PF_INET, SOCK_STREAM,
285                 (getprotobyname("tcp")->p_proto));
286
287         if (s < 0) {
288                 lprintf(1, "citserver: Can't create a socket: %s\n",
289                         strerror(errno));
290                 return(-1);
291         }
292
293         i = 1;
294         setsockopt(s, SOL_SOCKET, SO_REUSEADDR, &i, sizeof(i));
295
296         if (bind(s, (struct sockaddr *)&sin, sizeof(sin)) < 0) {
297                 lprintf(1, "citserver: Can't bind: %s\n",
298                         strerror(errno));
299                 close(s);
300                 return(-1);
301         }
302
303         if (listen(s, actual_queue_len) < 0) {
304                 lprintf(1, "citserver: Can't listen: %s\n", strerror(errno));
305                 close(s);
306                 return(-1);
307         }
308
309         return(s);
310 }
311
312
313
314 /*
315  * Create a Unix domain socket and listen on it
316  */
317 int ig_uds_server(char *sockpath, int queue_len)
318 {
319         struct sockaddr_un addr;
320         int s;
321         int i;
322         int actual_queue_len;
323
324         actual_queue_len = queue_len;
325         if (actual_queue_len < 5) actual_queue_len = 5;
326
327         i = unlink(sockpath);
328         if (i != 0) if (errno != ENOENT) {
329                 lprintf(1, "citserver: can't unlink %s: %s\n",
330                         sockpath, strerror(errno));
331                 return(-1);
332         }
333
334         memset(&addr, 0, sizeof(addr));
335         addr.sun_family = AF_UNIX;
336         safestrncpy(addr.sun_path, sockpath, sizeof addr.sun_path);
337
338         s = socket(AF_UNIX, SOCK_STREAM, 0);
339         if (s < 0) {
340                 lprintf(1, "citserver: Can't create a socket: %s\n",
341                         strerror(errno));
342                 return(-1);
343         }
344
345         if (bind(s, (struct sockaddr *)&addr, sizeof(addr)) < 0) {
346                 lprintf(1, "citserver: Can't bind: %s\n",
347                         strerror(errno));
348                 return(-1);
349         }
350
351         if (listen(s, actual_queue_len) < 0) {
352                 lprintf(1, "citserver: Can't listen: %s\n", strerror(errno));
353                 return(-1);
354         }
355
356         chmod(sockpath, 0777);
357         return(s);
358 }
359
360
361
362 /*
363  * Return a pointer to the CitContext structure bound to the thread which
364  * called this function.  If there's no such binding (for example, if it's
365  * called by the housekeeper thread) then a generic 'master' CC is returned.
366  */
367 struct CitContext *MyContext(void) {
368         struct CitContext *retCC;
369         retCC = (struct CitContext *) pthread_getspecific(MyConKey);
370         if (retCC == NULL) retCC = &masterCC;
371         return(retCC);
372 }
373
374
375 /*
376  * Initialize a new context and place it in the list.  The session number
377  * used to be the PID (which is why it's called cs_pid), but that was when we
378  * had one process per session.  Now we just assign them sequentially, starting
379  * at 1 (don't change it to 0 because masterCC uses 0) and re-using them when
380  * sessions terminate.
381  */
382 struct CitContext *CreateNewContext(void) {
383         struct CitContext *me, *ptr;
384         int num = 1;
385         int startover = 0;
386
387         me = (struct CitContext *) mallok(sizeof(struct CitContext));
388         if (me == NULL) {
389                 lprintf(1, "citserver: can't allocate memory!!\n");
390                 return NULL;
391         }
392         memset(me, 0, sizeof(struct CitContext));
393
394         /* The new context will be created already in the CON_EXECUTING state
395          * in order to prevent another thread from grabbing it while it's
396          * being set up.
397          */
398         me->state = CON_EXECUTING;
399
400         begin_critical_section(S_SESSION_TABLE);
401
402         /* obtain a unique session number */
403         do {
404                 startover = 0;
405                 for (ptr = ContextList; ptr != NULL; ptr = ptr->next) {
406                         if (ptr->cs_pid == num) {
407                                 ++num;
408                                 startover = 1;
409                         }
410                 }
411         } while (startover == 1);
412
413         me->cs_pid = num;
414         me->next = ContextList;
415         ContextList = me;
416         ++num_sessions;
417
418         end_critical_section(S_SESSION_TABLE);
419         return(me);
420 }
421
422
423
424 /*
425  * client_write()   ...    Send binary data to the client.
426  */
427 void client_write(char *buf, int nbytes)
428 {
429         int bytes_written = 0;
430         int retval;
431         int sock;
432
433         if (CC->redirect_fp != NULL) {
434                 fwrite(buf, nbytes, 1, CC->redirect_fp);
435                 return;
436         }
437
438         if (CC->redirect_sock > 0) {
439                 sock = CC->redirect_sock;       /* and continue below... */
440         }
441         else {
442                 sock = CC->client_socket;
443         }
444
445         while (bytes_written < nbytes) {
446                 retval = write(sock, &buf[bytes_written],
447                         nbytes - bytes_written);
448                 if (retval < 1) {
449                         lprintf(2, "client_write() failed: %s\n",
450                                 strerror(errno));
451                         if (sock == CC->client_socket) CC->kill_me = 1;
452                         return;
453                 }
454                 bytes_written = bytes_written + retval;
455         }
456 }
457
458
459 /*
460  * cprintf()  ...   Send formatted printable data to the client.   It is
461  *                  implemented in terms of client_write() but remains in
462  *                  sysdep.c in case we port to somewhere without va_args...
463  */
464 void cprintf(const char *format, ...) {   
465         va_list arg_ptr;   
466         char buf[SIZ];   
467    
468         va_start(arg_ptr, format);   
469         if (vsnprintf(buf, sizeof buf, format, arg_ptr) == -1)
470                 buf[sizeof buf - 2] = '\n';
471         client_write(buf, strlen(buf)); 
472         va_end(arg_ptr);
473 }   
474
475
476 /*
477  * Read data from the client socket.
478  * Return values are:
479  *      1       Requested number of bytes has been read.
480  *      0       Request timed out.
481  *      -1      The socket is broken.
482  * If the socket breaks, the session will be terminated.
483  */
484 int client_read_to(char *buf, int bytes, int timeout)
485 {
486         int len,rlen;
487         fd_set rfds;
488         struct timeval tv;
489         int retval;
490
491         len = 0;
492         while(len<bytes) {
493                 FD_ZERO(&rfds);
494                 FD_SET(CC->client_socket, &rfds);
495                 tv.tv_sec = timeout;
496                 tv.tv_usec = 0;
497
498                 retval = select( (CC->client_socket)+1, 
499                                         &rfds, NULL, NULL, &tv);
500
501                 if (FD_ISSET(CC->client_socket, &rfds) == 0) {
502                         return(0);
503                 }
504
505                 rlen = read(CC->client_socket, &buf[len], bytes-len);
506                 if (rlen<1) {
507                         lprintf(2, "client_read() failed: %s\n",
508                                 strerror(errno));
509                         CC->kill_me = 1;
510                         return(-1);
511                 }
512                 len = len + rlen;
513         }
514         return(1);
515 }
516
517 /*
518  * Read data from the client socket with default timeout.
519  * (This is implemented in terms of client_read_to() and could be
520  * justifiably moved out of sysdep.c)
521  */
522 int client_read(char *buf, int bytes)
523 {
524         return(client_read_to(buf, bytes, config.c_sleeping));
525 }
526
527
528 /*
529  * client_gets()   ...   Get a LF-terminated line of text from the client.
530  * (This is implemented in terms of client_read() and could be
531  * justifiably moved out of sysdep.c)
532  */
533 int client_gets(char *buf)
534 {
535         int i, retval;
536
537         /* Read one character at a time.
538          */
539         for (i = 0;;i++) {
540                 retval = client_read(&buf[i], 1);
541                 if (retval != 1 || buf[i] == '\n' || i == (SIZ-1))
542                         break;
543         }
544
545         /* If we got a long line, discard characters until the newline.
546          */
547         if (i == (SIZ-1))
548                 while (buf[i] != '\n' && retval == 1)
549                         retval = client_read(&buf[i], 1);
550
551         /* Strip the trailing newline and any trailing nonprintables (cr's)
552          */
553         buf[i] = 0;
554         while ((strlen(buf)>0)&&(!isprint(buf[strlen(buf)-1])))
555                 buf[strlen(buf)-1] = 0;
556         if (retval < 0) strcpy(buf, "000");
557         return(retval);
558 }
559
560
561
562 /*
563  * The system-dependent part of master_cleanup() - close the master socket.
564  */
565 void sysdep_master_cleanup(void) {
566         struct ServiceFunctionHook *serviceptr;
567
568         /*
569          * close all protocol master sockets
570          */
571         for (serviceptr = ServiceHookTable; serviceptr != NULL;
572             serviceptr = serviceptr->next ) {
573
574                 if (serviceptr->tcp_port > 0)
575                         lprintf(3, "Closing listener on port %d\n",
576                                 serviceptr->tcp_port);
577
578                 if (serviceptr->sockpath != NULL)
579                         lprintf(3, "Closing listener on '%s'\n",
580                                 serviceptr->sockpath);
581
582                 close(serviceptr->msock);
583
584                 /* If it's a Unix domain socket, remove the file. */
585                 if (serviceptr->sockpath != NULL) {
586                         unlink(serviceptr->sockpath);
587                 }
588         }
589 }
590
591
592 /*
593  * Terminate another session.
594  * (This could justifiably be moved out of sysdep.c because it
595  * no longer does anything that is system-dependent.)
596  */
597 void kill_session(int session_to_kill) {
598         struct CitContext *ptr;
599
600         begin_critical_section(S_SESSION_TABLE);
601         for (ptr = ContextList; ptr != NULL; ptr = ptr->next) {
602                 if (ptr->cs_pid == session_to_kill) {
603                         ptr->kill_me = 1;
604                 }
605         }
606         end_critical_section(S_SESSION_TABLE);
607 }
608
609
610
611
612 /*
613  * Start running as a daemon.  Only close stdio if do_close_stdio is set.
614  */
615 void start_daemon(int do_close_stdio) {
616         if (do_close_stdio) {
617                 /* close(0); */
618                 close(1);
619                 close(2);
620         }
621         signal(SIGHUP,SIG_IGN);
622         signal(SIGINT,SIG_IGN);
623         signal(SIGQUIT,SIG_IGN);
624         if (fork()!=0) exit(0);
625 }
626
627
628
629 /*
630  * Tie in to the 'netsetup' program.
631  *
632  * (We're going to hope that netsetup never feeds more than 4096 bytes back.)
633  */
634 void cmd_nset(char *cmdbuf)
635 {
636         int retcode;
637         char fbuf[4096];
638         FILE *netsetup;
639         int ch;
640         int a, b;
641         char netsetup_args[3][SIZ];
642
643         if (CC->usersupp.axlevel < 6) {
644                 cprintf("%d Higher access required.\n", 
645                         ERROR + HIGHER_ACCESS_REQUIRED);
646                 return;
647         }
648
649         for (a=1; a<=3; ++a) {
650                 if (num_parms(cmdbuf) >= a) {
651                         extract(netsetup_args[a-1], cmdbuf, a-1);
652                         for (b=0; b<strlen(netsetup_args[a-1]); ++b) {
653                                 if (netsetup_args[a-1][b] == 34) {
654                                         netsetup_args[a-1][b] = '_';
655                                 }
656                         }
657                 }
658                 else {
659                         netsetup_args[a-1][0] = 0;
660                 }
661         }
662
663         sprintf(fbuf, "./netsetup \"%s\" \"%s\" \"%s\" </dev/null 2>&1",
664                 netsetup_args[0], netsetup_args[1], netsetup_args[2]);
665         netsetup = popen(fbuf, "r");
666         if (netsetup == NULL) {
667                 cprintf("%d %s\n", ERROR, strerror(errno));
668                 return;
669         }
670
671         fbuf[0] = 0;
672         while (ch = getc(netsetup), (ch > 0)) {
673                 fbuf[strlen(fbuf)+1] = 0;
674                 fbuf[strlen(fbuf)] = ch;
675         }
676
677         retcode = pclose(netsetup);
678
679         if (retcode != 0) {
680                 for (a=0; a<strlen(fbuf); ++a) {
681                         if (fbuf[a] < 32) fbuf[a] = 32;
682                 }
683                 fbuf[245] = 0;
684                 cprintf("%d %s\n", ERROR, fbuf);
685                 return;
686         }
687
688         cprintf("%d Command succeeded.  Output follows:\n", LISTING_FOLLOWS);
689         cprintf("%s", fbuf);
690         if (fbuf[strlen(fbuf)-1] != 10) cprintf("\n");
691         cprintf("000\n");
692 }
693
694
695
696 /*
697  * Generic routine to convert a login name to a full name (gecos)
698  * Returns nonzero if a conversion took place
699  */
700 int convert_login(char NameToConvert[]) {
701         struct passwd *pw;
702         int a;
703
704         pw = getpwnam(NameToConvert);
705         if (pw == NULL) {
706                 return(0);
707         }
708         else {
709                 strcpy(NameToConvert, pw->pw_gecos);
710                 for (a=0; a<strlen(NameToConvert); ++a) {
711                         if (NameToConvert[a] == ',') NameToConvert[a] = 0;
712                 }
713                 return(1);
714         }
715 }
716
717 static struct worker_node {
718         pthread_t tid;
719         struct worker_node *next;
720 } *worker_list = NULL;
721
722
723 /*
724  * create a worker thread. this function must always be called from within
725  * an S_WORKER_LIST critical section!
726  */
727 static void create_worker(void) {
728         int ret;
729         struct worker_node *n = mallok(sizeof *n);
730
731         if (n == NULL) {
732                 lprintf(1, "can't allocate worker_node, exiting\n");
733                 time_to_die = -1;
734                 return;
735         }
736
737         if ((ret = pthread_create(&n->tid, NULL, worker_thread, NULL) != 0))
738         {
739
740                 lprintf(1, "Can't create worker thread: %s\n",
741                         strerror(ret));
742         }
743
744         n->next = worker_list;
745         worker_list = n;
746 }
747
748
749
750 /*
751  * Purge all sessions which have the 'kill_me' flag set.
752  * This function has code to prevent it from running more than once every
753  * few seconds, because running it after every single unbind would waste a lot
754  * of CPU time and keep the context list locked too much.
755  *
756  * After that's done, we raise or lower the size of the worker thread pool
757  * if such an action is appropriate.
758  */
759 void dead_session_purge(void) {
760         struct CitContext *ptr, *rem;
761         struct worker_node **node, *tmp;
762         pthread_t self;
763
764         if ( (time(NULL) - last_purge) < 5 ) return;    /* Too soon, go away */
765         time(&last_purge);
766
767         do {
768                 rem = NULL;
769                 begin_critical_section(S_SESSION_TABLE);
770                 for (ptr = ContextList; ptr != NULL; ptr = ptr->next) {
771                         if ( (ptr->state == CON_IDLE) && (ptr->kill_me) ) {
772                                 rem = ptr;
773                         }
774                 }
775                 end_critical_section(S_SESSION_TABLE);
776
777                 /* RemoveContext() enters its own S_SESSION_TABLE critical
778                  * section, so we have to do it like this.
779                  */     
780                 if (rem != NULL) {
781                         lprintf(9, "Purging session %d\n", rem->cs_pid);
782                         RemoveContext(rem);
783                 }
784
785         } while (rem != NULL);
786
787
788         /* Raise or lower the size of the worker thread pool if such
789          * an action is appropriate.
790          */
791
792         self = pthread_self();
793
794         if ( (num_sessions > num_threads)
795            && (num_threads < config.c_max_workers) ) {
796                 begin_critical_section(S_WORKER_LIST);
797                 create_worker();
798                 end_critical_section(S_WORKER_LIST);
799         }
800         
801         /* don't let the initial thread die since it's responsible for
802            waiting for all the other threads to terminate. */
803         else if ( (num_sessions < num_threads)
804            && (num_threads > config.c_min_workers)
805            && (self != initial_thread) ) {
806                 cdb_free_tsd();
807                 begin_critical_section(S_WORKER_LIST);
808                 --num_threads;
809
810                 /* we're exiting before server shutdown... unlink ourself from
811                    the worker list and detach our thread to avoid memory leaks
812                  */
813
814                 for (node = &worker_list; *node != NULL; node = &(*node)->next)
815                         if ((*node)->tid == self) {
816                                 tmp = *node;
817                                 *node = (*node)->next;
818                                 phree(tmp);
819                                 break;
820                         }
821
822                 pthread_detach(self);
823                 end_critical_section(S_WORKER_LIST);
824                 pthread_exit(NULL);
825         }
826
827 }
828
829
830
831
832
833 /*
834  * Redirect a session's output to a file or socket.
835  * This function may be called with a file handle *or* a socket (but not
836  * both).  Call with neither to return output to its normal client socket.
837  */
838 void CtdlRedirectOutput(FILE *fp, int sock) {
839
840         if (fp != NULL) CC->redirect_fp = fp;
841         else CC->redirect_fp = NULL;
842
843         if (sock > 0) CC->redirect_sock = sock;
844         else CC->redirect_sock = (-1);
845
846 }
847
848
849 /*
850  * masterCC is the context we use when not attached to a session.  This
851  * function initializes it.
852  */
853 void InitializeMasterCC(void) {
854         memset(&masterCC, 0, sizeof(struct CitContext));
855         masterCC.internal_pgm = 1;
856         masterCC.cs_pid = 0;
857 }
858
859
860
861 /*
862  * Set up a fd_set containing all the master sockets to which we
863  * always listen.  It's computationally less expensive to just copy
864  * this to a local fd_set when starting a new select() and then add
865  * the client sockets than it is to initialize a new one and then
866  * figure out what to put there.
867  */
868 void init_master_fdset(void) {
869         struct ServiceFunctionHook *serviceptr;
870         int m;
871
872         lprintf(9, "Initializing master fdset\n");
873
874         FD_ZERO(&masterfds);
875         masterhighest = 0;
876
877         lprintf(9, "Will listen on rescan pipe %d\n", rescan[0]);
878         FD_SET(rescan[0], &masterfds);
879         if (rescan[0] > masterhighest) masterhighest = rescan[0];
880
881         for (serviceptr = ServiceHookTable; serviceptr != NULL;
882             serviceptr = serviceptr->next ) {
883                 m = serviceptr->msock;
884                 lprintf(9, "Will listen on master socket %d\n", m);
885                 FD_SET(m, &masterfds);
886                 if (m > masterhighest) {
887                         masterhighest = m;
888                 }
889         }
890         lprintf(9, "masterhighest = %d\n", masterhighest);
891 }
892
893
894
895 /*
896  * Here's where it all begins.
897  */
898 int main(int argc, char **argv)
899 {
900         char tracefile[128];            /* Name of file to log traces to */
901         int a, i;                       /* General-purpose variables */
902         struct passwd *pw;
903         int drop_root_perms = 1;
904         char *moddir;
905         struct worker_node *wnp;
906         
907         /* specify default port name and trace file */
908         strcpy(tracefile, "");
909
910         /* initialize the master context */
911         InitializeMasterCC();
912
913         /* parse command-line arguments */
914         for (a=1; a<argc; ++a) {
915
916                 /* -t specifies where to log trace messages to */
917                 if (!strncmp(argv[a], "-t", 2)) {
918                         strcpy(tracefile, argv[a]);
919                         strcpy(tracefile, &tracefile[2]);
920                         freopen(tracefile, "r", stdin);
921                         freopen(tracefile, "w", stdout);
922                         freopen(tracefile, "w", stderr);
923                 }
924
925                 /* run in the background if -d was specified */
926                 else if (!strcmp(argv[a], "-d")) {
927                         start_daemon( (strlen(tracefile) > 0) ? 0 : 1 ) ;
928                 }
929
930                 /* -x specifies the desired logging level */
931                 else if (!strncmp(argv[a], "-x", 2)) {
932                         verbosity = atoi(&argv[a][2]);
933                 }
934
935                 else if (!strncmp(argv[a], "-h", 2)) {
936                         safestrncpy(bbs_home_directory, &argv[a][2],
937                                     sizeof bbs_home_directory);
938                         home_specified = 1;
939                 }
940
941                 else if (!strncmp(argv[a], "-f", 2)) {
942                         do_defrag = 1;
943                 }
944
945                 /* -r tells the server not to drop root permissions. don't use
946                  * this unless you know what you're doing. this should be
947                  * removed in the next release if it proves unnecessary. */
948                 else if (!strcmp(argv[a], "-r"))
949                         drop_root_perms = 0;
950
951                 /* any other parameter makes it crash and burn */
952                 else {
953                         lprintf(1,      "citserver: usage: "
954                                         "citserver [-tTraceFile] [-d] [-f]"
955                                         " [-xLogLevel] [-hHomeDir]\n");
956                         exit(1);
957                 }
958
959         }
960
961         /* Tell 'em who's in da house */
962         lprintf(1,
963 "\nMultithreaded message server for Citadel/UX\n"
964 "Copyright (C) 1987-2000 by the Citadel/UX development team.\n"
965 "Citadel/UX is free software, covered by the GNU General Public License, and\n"
966 "you are welcome to change it and/or distribute copies of it under certain\n"
967 "conditions.  There is absolutely no warranty for this software.  Please\n"
968 "read the 'COPYING.txt' file for details.\n\n");
969
970         /* Initialize... */
971         init_sysdep();
972         openlog("citserver", LOG_PID, LOG_USER);
973
974         /* Load site-specific parameters */
975         lprintf(7, "Loading citadel.config\n");
976         get_config();
977
978
979         /*
980          * Do non system dependent startup functions.
981          */
982         master_startup();
983
984         /*
985          * Bind the server to a Unix-domain socket.
986          */
987         CtdlRegisterServiceHook(0,
988                                 "citadel.socket",
989                                 citproto_begin_session,
990                                 do_command_loop);
991
992         /*
993          * Bind the server to our favorite TCP port (usually 504).
994          */
995         CtdlRegisterServiceHook(config.c_port_number,
996                                 NULL,
997                                 citproto_begin_session,
998                                 do_command_loop);
999
1000         /*
1001          * Load any server-side modules (plugins) available here.
1002          */
1003         lprintf(7, "Initializing loadable modules\n");
1004         if ((moddir = malloc(strlen(bbs_home_directory) + 9)) != NULL) {
1005                 sprintf(moddir, "%s/modules", bbs_home_directory);
1006                 DLoader_Init(moddir);
1007                 free(moddir);
1008         }
1009
1010         /*
1011          * The rescan pipe exists so that worker threads can be woken up and
1012          * told to re-scan the context list for fd's to listen on.  This is
1013          * necessary, for example, when a context is about to go idle and needs
1014          * to get back on that list.
1015          */
1016         if (pipe(rescan)) {
1017                 lprintf(1, "Can't create rescan pipe!\n");
1018                 exit(errno);
1019         }
1020
1021         init_master_fdset();
1022
1023         /*
1024          * Now that we've bound the sockets, change to the BBS user id and its
1025          * corresponding group ids
1026          */
1027         if (drop_root_perms) {
1028                 if ((pw = getpwuid(BBSUID)) == NULL)
1029                         lprintf(1, "WARNING: getpwuid(%d): %s\n"
1030                                    "Group IDs will be incorrect.\n", BBSUID,
1031                                 strerror(errno));
1032                 else {
1033                         initgroups(pw->pw_name, pw->pw_gid);
1034                         if (setgid(pw->pw_gid))
1035                                 lprintf(3, "setgid(%d): %s\n", pw->pw_gid,
1036                                         strerror(errno));
1037                 }
1038                 lprintf(7, "Changing uid to %d\n", BBSUID);
1039                 if (setuid(BBSUID) != 0) {
1040                         lprintf(3, "setuid() failed: %s\n", strerror(errno));
1041                 }
1042         }
1043
1044         /* We want to check for idle sessions once per minute */
1045         CtdlRegisterSessionHook(terminate_idle_sessions, EVT_TIMER);
1046
1047         /*
1048          * Now create a bunch of worker threads.
1049          */
1050         lprintf(9, "Starting %d worker threads\n", config.c_min_workers-1);
1051         begin_critical_section(S_WORKER_LIST);
1052         for (i=0; i<(config.c_min_workers-1); ++i) {
1053                 create_worker();
1054         }
1055         end_critical_section(S_WORKER_LIST);
1056
1057         /* Now this thread can become a worker as well. */
1058         initial_thread = pthread_self();
1059         worker_thread(NULL);
1060
1061         /* Server is exiting. Wait for workers to shutdown. */
1062         lprintf(7, "Waiting for worker threads to shut down\n");
1063
1064         begin_critical_section(S_WORKER_LIST);
1065         while (worker_list != NULL) {
1066                 wnp = worker_list;
1067                 worker_list = wnp->next;
1068
1069                 /* avoid deadlock with an exiting thread */
1070                 end_critical_section(S_WORKER_LIST);
1071                 if ((i = pthread_join(wnp->tid, NULL)))
1072                         lprintf(1, "pthread_join: %s\n", strerror(i));
1073                 phree(wnp);
1074                 begin_critical_section(S_WORKER_LIST);
1075         }
1076         end_critical_section(S_WORKER_LIST);
1077
1078         master_cleanup();
1079
1080         return(0);
1081 }
1082
1083
1084 /*
1085  * Bind a thread to a context.  (It's inline merely to speed things up.)
1086  */
1087 inline void become_session(struct CitContext *which_con) {
1088         pthread_setspecific(MyConKey, (void *)which_con );
1089 }
1090
1091
1092
1093 /* 
1094  * This loop just keeps going and going and going...
1095  */     
1096 void *worker_thread(void *arg) {
1097         int i;
1098         char junk;
1099         int highest;
1100         struct CitContext *ptr;
1101         struct CitContext *bind_me = NULL;
1102         fd_set readfds;
1103         int retval;
1104         struct CitContext *con= NULL;   /* Temporary context pointer */
1105         struct ServiceFunctionHook *serviceptr;
1106         struct sockaddr_in fsin;        /* Data for master socket */
1107         int alen;                       /* Data for master socket */
1108         int ssock;                      /* Descriptor for client socket */
1109         struct timeval tv;
1110
1111         num_threads++;
1112
1113         cdb_allocate_tsd();
1114
1115         while (!time_to_die) {
1116
1117                 /* 
1118                  * A naive implementation would have all idle threads
1119                  * calling select() and then they'd all wake up at once.  We
1120                  * solve this problem by putting the select() in a critical
1121                  * section, so only one thread has the opportunity to wake
1122                  * up.  If we wake up on a master socket, create a new
1123                  * session context; otherwise, just bind the thread to the
1124                  * context we want and go on our merry way.
1125                  */
1126
1127                 /* make doubly sure we're not holding any stale db handles
1128                  * which might cause a deadlock.
1129                  */
1130                 cdb_release_handles();
1131
1132                 begin_critical_section(S_I_WANNA_SELECT);
1133 SETUP_FD:       memcpy(&readfds, &masterfds, sizeof masterfds);
1134                 highest = masterhighest;
1135                 begin_critical_section(S_SESSION_TABLE);
1136                 for (ptr = ContextList; ptr != NULL; ptr = ptr->next) {
1137                         if (ptr->state == CON_IDLE) {
1138                                 FD_SET(ptr->client_socket, &readfds);
1139                                 if (ptr->client_socket > highest)
1140                                         highest = ptr->client_socket;
1141                         }
1142                 }
1143                 end_critical_section(S_SESSION_TABLE);
1144
1145                 tv.tv_sec = 1;          /* wake up every second if no input */
1146                 tv.tv_usec = 0;
1147
1148                 do_select:
1149                 if (!time_to_die)
1150                         retval = select(highest + 1, &readfds, NULL, NULL, &tv);
1151                 else {
1152                         end_critical_section(S_I_WANNA_SELECT);
1153                         break;
1154                 }
1155
1156                 /* Now figure out who made this select() unblock.
1157                  * First, check for an error or exit condition.
1158                  */
1159                 if (retval < 0) {
1160                         if (errno != EINTR) {
1161                                 lprintf(9, "Exiting (%s)\n", strerror(errno));
1162                                 time_to_die = 1;
1163                         } else if (!time_to_die)
1164                                 goto do_select;
1165                 }
1166
1167                 /* Next, check to see if it's a new client connecting
1168                  * on a master socket.
1169                  */
1170                 else for (serviceptr = ServiceHookTable; serviceptr != NULL;
1171                      serviceptr = serviceptr->next ) {
1172
1173                         if (FD_ISSET(serviceptr->msock, &readfds)) {
1174                                 alen = sizeof fsin;
1175                                 ssock = accept(serviceptr->msock,
1176                                         (struct sockaddr *)&fsin, &alen);
1177                                 if (ssock < 0) {
1178                                         lprintf(2, "citserver: accept(): %s\n",
1179                                                 strerror(errno));
1180                                 }
1181                                 else {
1182                                         lprintf(7, "citserver: "
1183                                                 "New client socket %d\n",
1184                                                 ssock);
1185
1186                                         /* New context will be created already
1187                                         * set up in the CON_EXECUTING state.
1188                                         */
1189                                         con = CreateNewContext();
1190
1191                                         /* Assign new socket number to it. */
1192                                         con->client_socket = ssock;
1193                                         con->h_command_function =
1194                                                 serviceptr->h_command_function;
1195
1196                                         /* Determine whether local socket */
1197                                         if (serviceptr->sockpath != NULL)
1198                                                 con->is_local_socket = 1;
1199         
1200                                         /* Set the SO_REUSEADDR socket option */
1201                                         i = 1;
1202                                         setsockopt(ssock, SOL_SOCKET,
1203                                                 SO_REUSEADDR,
1204                                                 &i, sizeof(i));
1205
1206                                         become_session(con);
1207                                         begin_session(con);
1208                                         serviceptr->h_greeting_function();
1209                                         become_session(NULL);
1210                                         con->state = CON_IDLE;
1211                                         goto SETUP_FD;
1212                                 }
1213                         }
1214                 }
1215
1216                 /* If the rescan pipe went active, someone is telling this
1217                  * thread that the &readfds needs to be refreshed with more
1218                  * current data.
1219                  */
1220                 if (time_to_die) {
1221                         end_critical_section(S_I_WANNA_SELECT);
1222                         break;
1223                 }
1224
1225                 if (FD_ISSET(rescan[0], &readfds)) {
1226                         read(rescan[0], &junk, 1);
1227                         goto SETUP_FD;
1228                 }
1229
1230                 /* It must be a client socket.  Find a context that has data
1231                  * waiting on its socket *and* is in the CON_IDLE state.
1232                  */
1233                 else {
1234                         bind_me = NULL;
1235                         begin_critical_section(S_SESSION_TABLE);
1236                         for (ptr = ContextList;
1237                             ( (ptr != NULL) && (bind_me == NULL) );
1238                             ptr = ptr->next) {
1239                                 if ( (FD_ISSET(ptr->client_socket, &readfds))
1240                                    && (ptr->state == CON_IDLE) ) {
1241                                         bind_me = ptr;
1242                                 }
1243                         }
1244                         if (bind_me != NULL) {
1245                                 /* Found one.  Stake a claim to it before
1246                                  * letting anyone else touch the context list.
1247                                  */
1248                                 bind_me->state = CON_EXECUTING;
1249                         }
1250
1251                         end_critical_section(S_SESSION_TABLE);
1252                         end_critical_section(S_I_WANNA_SELECT);
1253
1254                         /* We're bound to a session, now do *one* command */
1255                         if (bind_me != NULL) {
1256                                 become_session(bind_me);
1257                                 CC->h_command_function();
1258                                 become_session(NULL);
1259                                 bind_me->state = CON_IDLE;
1260                                 if (bind_me->kill_me == 1) {
1261                                         RemoveContext(bind_me);
1262                                 } 
1263                                 write(rescan[1], &junk, 1);
1264                         }
1265
1266                 }
1267                 dead_session_purge();
1268                 if ((time(NULL) - last_timer) > 60L) {
1269                         last_timer = time(NULL);
1270                         cdb_release_handles(); /* suggested by Justin Case */
1271                         PerformSessionHooks(EVT_TIMER);
1272                 }
1273
1274                 check_sched_shutdown();
1275         }
1276
1277         /* If control reaches this point, the server is shutting down */        
1278         --num_threads;
1279         return NULL;
1280 }
1281
1282
1283