]> code.citadel.org Git - citadel.git/blob - citadel/sysdep.c
remove duplicated declarations
[citadel.git] / citadel / sysdep.c
1 /*
2  * Citadel/UX "system dependent" stuff.
3  * See copyright.txt for copyright information.
4  *
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.
9  * 
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.
12  */
13
14
15 #include <stdlib.h>
16 #include <unistd.h>
17 #include <stdio.h>
18 #include <fcntl.h>
19 #include <signal.h>
20 #include <sys/types.h>
21 #include <sys/wait.h>
22 #include <sys/socket.h>
23 #include <sys/time.h>
24 #include <netinet/in.h>
25 #include <netdb.h>
26 #include <string.h>
27 #include <pwd.h>
28 #include <errno.h>
29 #include <stdarg.h>
30 #include <syslog.h>
31 #include <pthread.h>
32 #include "citadel.h"
33 #include "server.h"
34 #include "sysdep_decls.h"
35 #include "citserver.h"
36 #include "hooks.h"
37 #include "support.h"
38 #include "config.h"
39 #include "database.h"
40 #include "housekeeping.h"
41
42 #ifdef NEED_SELECT_H
43 #include <sys/select.h>
44 #endif
45
46 pthread_mutex_t Critters[MAX_SEMAPHORES];       /* Things needing locking */
47 pthread_key_t MyConKey;                         /* TSD key for MyContext() */
48
49 int msock;                                      /* master listening socket */
50 int verbosity = 3;                              /* Logging level */
51
52
53 /*
54  * lprintf()  ...   Write logging information
55  */
56 void lprintf(int loglevel, const char *format, ...) {   
57         va_list arg_ptr;   
58         char buf[256];   
59         int rc;   
60   
61         if (loglevel <= verbosity) { 
62                 va_start(arg_ptr, format);   
63                 rc = vsprintf(buf, format, arg_ptr);   
64                 va_end(arg_ptr);   
65                 
66                 fprintf(stderr, "%s", buf);
67                 fflush(stderr);
68                 }
69   
70         }   
71
72
73 /*
74  * Some initialization stuff...
75  */
76 void init_sysdep(void) {
77         int a;
78
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);
82                 }
83
84         /*
85          * Set up a place to put thread-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.
88          */
89         if (pthread_key_create(&MyConKey, NULL) != 0) {
90                 lprintf(1, "Can't create TSD key!!  %s\n", strerror(errno));
91                 }
92
93         /*
94          * The action for unexpected signals and exceptions should be to
95          * call master_cleanup() to gracefully shut down the server.
96          */
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);
101         }
102
103
104 /*
105  * Obtain a semaphore lock to begin a critical section.
106  */
107 void begin_critical_section(int which_one)
108 {
109         int oldval;
110
111         lprintf(8, "begin_critical_section(%d)\n", which_one);
112         if (CC != NULL) hook_crit_get(CC->cs_pid, which_one);
113
114         /* Don't get interrupted during the critical section */
115         pthread_setcanceltype(PTHREAD_CANCEL_DEFERRED, &oldval);
116
117         /* Obtain a semaphore */
118         pthread_mutex_lock(&Critters[which_one]);
119
120         if (CC != NULL) hook_crit_got(CC->cs_pid, which_one);
121         }
122
123 /*
124  * Release a semaphore lock to end a critical section.
125  */
126 void end_critical_section(int which_one)
127 {
128         int oldval;
129
130         lprintf(8, "  end_critical_section(%d)\n", which_one);
131         if (CC != NULL) hook_crit_end(CC->cs_pid, which_one);
132
133         /* Let go of the semaphore */
134         pthread_mutex_unlock(&Critters[which_one]);
135
136         /* If a cancel was sent during the critical section, do it now.
137          * Then re-enable thread cancellation.
138          */
139         pthread_testcancel();
140         pthread_setcanceltype(PTHREAD_CANCEL_ASYNCHRONOUS, &oldval);
141         pthread_testcancel();
142
143         }
144
145
146
147 /*
148  * This is a generic function to set up a master socket for listening on
149  * a TCP port.  The server shuts down if the bind fails.
150  */
151 int ig_tcp_server(int port_number, int queue_len)
152 {
153         struct sockaddr_in sin;
154         int s, i;
155
156         bzero((char *)&sin, sizeof(sin));
157         sin.sin_family = AF_INET;
158         sin.sin_addr.s_addr = INADDR_ANY;
159
160         if (port_number == 0) {
161                 lprintf(1, "citserver: No port number specified.  Run setup again.\n");
162                 exit(1);
163                 }
164         
165         sin.sin_port = htons((u_short)port_number);
166
167         s = socket(PF_INET, SOCK_STREAM, (getprotobyname("tcp")->p_proto));
168         if (s < 0) {
169                 lprintf(1, "citserver: Can't create a socket: %s\n",
170                         strerror(errno));
171                 exit(errno);
172                 }
173
174         /* Set the SO_REUSEADDR socket option, because it makes sense. */
175         i = 1;
176         setsockopt(s, SOL_SOCKET, SO_REUSEADDR, &i, sizeof(i));
177
178         if (bind(s, (struct sockaddr *)&sin, sizeof(sin)) < 0) {
179                 lprintf(1, "citserver: Can't bind: %s\n", strerror(errno));
180                 exit(errno);
181                 }
182
183         if (listen(s, queue_len) < 0) {
184                 lprintf(1, "citserver: Can't listen: %s\n", strerror(errno));
185                 exit(errno);
186                 }
187
188         return(s);
189         }
190
191
192 /*
193  * Return a pointer to a thread's own CitContext structure (old)
194  * NOTE: this version of MyContext() is commented out because it is no longer
195  * in use.  It was written before I discovered TSD keys.  This
196  * version pounds through the context list until it finds the one matching
197  * the currently running thread.  It remains here, commented out, in case it
198  * is needed for future ports to threading libraries which have the equivalent
199  * of pthread_self() but not pthread_key_create() and its ilk.
200  *
201  * struct CitContext *MyContext() {
202  *      struct CitContext *ptr;
203  *      THREAD me;
204  *
205  *      me = pthread_self();
206  *      for (ptr=ContextList; ptr!=NULL; ptr=ptr->next) {
207  *              if (ptr->mythread == me) return(ptr);
208  *              }
209  *      return(NULL);
210  *      }
211  */
212
213 /*
214  * Return a pointer to a thread's own CitContext structure (new)
215  */
216 struct CitContext *MyContext(void) {
217         return (struct CitContext *) pthread_getspecific(MyConKey);
218         }
219
220
221 /*
222  * Wedge our way into the context list.
223  */
224 struct CitContext *CreateNewContext(void) {
225         struct CitContext *me;
226
227         lprintf(9, "CreateNewContext: calling malloc()\n");
228         me = (struct CitContext *) malloc(sizeof(struct CitContext));
229         if (me == NULL) {
230                 lprintf(1, "citserver: can't allocate memory!!\n");
231                 pthread_exit(NULL);
232                 }
233         bzero(me, sizeof(struct CitContext));
234
235         begin_critical_section(S_SESSION_TABLE);
236         me->next = ContextList;
237         ContextList = me;
238         end_critical_section(S_SESSION_TABLE);
239         return(me);
240         }
241
242 /*
243  * Add a thread's thread ID to the context
244  */
245 void InitMyContext(struct CitContext *con)
246 {
247         int oldval;
248
249         con->mythread = pthread_self();
250         pthread_setcancelstate(PTHREAD_CANCEL_ENABLE, &oldval);
251         pthread_setcanceltype(PTHREAD_CANCEL_ASYNCHRONOUS, &oldval);
252         if (pthread_setspecific(MyConKey, (void *)con) != 0) {
253                 lprintf(1, "ERROR!  pthread_setspecific() failed: %s\n",
254                         strerror(errno));
255                 }
256         }
257
258 /*
259  * Remove a context from the context list.
260  */
261 void RemoveContext(struct CitContext *con)
262 {
263         struct CitContext *ptr;
264
265         lprintf(7, "Starting RemoveContext()\n");
266         lprintf(9, "session count before RemoveContext is %d\n", session_count());
267         if (con==NULL) {
268                 lprintf(7, "WARNING: RemoveContext() called with null!\n");
269                 return;
270                 }
271
272         begin_critical_section(S_SESSION_TABLE);
273         lprintf(7, "Closing socket %d\n", con->client_socket);
274         close(con->client_socket);
275
276         if (ContextList==con) {
277                 ContextList = ContextList->next;
278                 }
279         else {
280                 for (ptr = ContextList; ptr != NULL; ptr = ptr->next) {
281                         if (ptr->next == con) {
282                                 ptr->next = ptr->next->next;
283                                 }
284                         }
285                 }
286         
287         free(con);
288
289         lprintf(9, "session count after RemoveContext is %d\n", session_count());
290
291         lprintf(7, "Done with RemoveContext\n");
292         end_critical_section(S_SESSION_TABLE);
293         }
294
295
296 /*
297  * Return the number of sessions currently running.
298  * (This should probably be moved out of sysdep.c)
299  */
300 int session_count(void) {
301         struct CitContext *ptr;
302         int TheCount = 0;
303
304         lprintf(9, "session_count() starting\n");
305         for (ptr = ContextList; ptr != NULL; ptr = ptr->next) {
306                 ++TheCount;
307                 lprintf(9, "Counted session %3d (%d)\n", ptr->cs_pid, TheCount);
308                 }
309
310         lprintf(9, "session_count() finishing\n");
311         return(TheCount);
312         }
313
314
315 /*
316  * client_write()   ...    Send binary data to the client.
317  */
318 void client_write(char *buf, int nbytes)
319 {
320         int bytes_written = 0;
321         int retval;
322         while (bytes_written < nbytes) {
323                 retval = write(CC->client_socket, &buf[bytes_written],
324                         nbytes - bytes_written);
325                 if (retval < 1) {
326                         lprintf(2, "client_write() failed: %s\n",
327                                 strerror(errno));
328                         cleanup(errno);
329                         }
330                 bytes_written = bytes_written + retval;
331                 }
332         }
333
334
335 /*
336  * cprintf()  ...   Send formatted printable data to the client.   It is
337  *                  implemented in terms of client_write() but remains in
338  *                  sysdep.c in case we port to somewhere without va_args...
339  */
340 void cprintf(const char *format, ...) {   
341         va_list arg_ptr;   
342         char buf[256];   
343         int rc;   
344    
345         va_start(arg_ptr, format);   
346         rc = vsprintf(buf, format, arg_ptr);   
347         va_end(arg_ptr);   
348   
349         client_write(buf, strlen(buf)); 
350         }   
351
352
353 /*
354  * Read data from the client socket.
355  * Return values are:
356  *      1       Requested number of bytes has been read.
357  *      0       Request timed out.
358  * If the socket breaks, the session is immediately terminated.
359  */
360 int client_read_to(char *buf, int bytes, int timeout)
361 {
362         int len,rlen;
363         fd_set rfds;
364         struct timeval tv;
365         int retval;
366
367         len = 0;
368         while(len<bytes) {
369                 FD_ZERO(&rfds);
370                 FD_SET(CC->client_socket, &rfds);
371                 tv.tv_sec = timeout;
372                 tv.tv_usec = 0;
373
374                 retval = select( (CC->client_socket)+1, 
375                                         &rfds, NULL, NULL, &tv);
376                 if (FD_ISSET(CC->client_socket, &rfds) == 0) {
377                         return(0);
378                         }
379
380                 rlen = read(CC->client_socket, &buf[len], bytes-len);
381                 if (rlen<1) {
382                         lprintf(2, "client_read() failed: %s\n",
383                                 strerror(errno));
384                         cleanup(errno);
385                         }
386                 len = len + rlen;
387                 }
388         return(1);
389         }
390
391 /*
392  * Read data from the client socket with default timeout.
393  * (This is implemented in terms of client_read_to() and could be
394  * justifiably moved out of sysdep.c)
395  */
396 int client_read(char *buf, int bytes)
397 {
398         return(client_read_to(buf, bytes, config.c_sleeping));
399         }
400
401
402 /*
403  * client_gets()   ...   Get a LF-terminated line of text from the client.
404  * (This is implemented in terms of client_read() and could be
405  * justifiably moved out of sysdep.c)
406  */
407 int client_gets(char *buf)
408 {
409         int retval = 0;
410
411         /* Clear the buffer, and read one character at a time.
412          */
413         buf[0] = 0;
414         do {
415                 if (strlen(buf)<255) {
416                         buf[strlen(buf) + 1] = 0;
417                         retval = client_read(&buf[strlen(buf)], 1);
418                         }
419                 } while ( (buf[strlen(buf)-1] != 10) && (retval==1) );
420
421         /* Strip the trailing newline.
422          */
423         if (strlen(buf) > 0) buf[strlen(buf)-1] = 0;
424         return(retval);
425         }
426
427
428
429 /*
430  * The system-dependent part of master_cleanup() - close the master socket.
431  */
432 void sysdep_master_cleanup(void) {
433         lprintf(7, "Closing master socket %d\n", msock);
434         close(msock);
435         }
436
437 /*
438  * Cleanup routine to be called when one thread is shutting down.
439  */
440 void cleanup(int exit_code)
441 {
442         /* Terminate the thread.
443          * Its cleanup handler will call cleanup_stuff()
444          */
445         lprintf(7, "Calling pthread_exit()\n");
446         pthread_exit(NULL);
447         }
448
449 /*
450  * Terminate another session.
451  */
452 void kill_session(int session_to_kill) {
453         struct CitContext *ptr;
454
455         for (ptr = ContextList; ptr != NULL; ptr = ptr->next) {
456                 if (ptr->cs_pid == session_to_kill) {
457                         pthread_cancel(ptr->mythread);
458                         }
459                 }
460         }
461
462
463 /*
464  * The system-dependent wrapper around the main context loop.
465  */
466 void sd_context_loop(struct CitContext *con) {
467         pthread_cleanup_push(*cleanup_stuff, NULL);
468         context_loop(con);
469         pthread_cleanup_pop(0);
470         }
471
472
473 /*
474  * Start running as a daemon.  Only close stdio if do_close_stdio is set.
475  */
476 void start_daemon(int do_close_stdio) {
477         if (do_close_stdio) {
478                 /* close(0); */
479                 close(1);
480                 close(2);
481                 }
482         signal(SIGHUP,SIG_IGN);
483         signal(SIGINT,SIG_IGN);
484         signal(SIGQUIT,SIG_IGN);
485         if (fork()!=0) exit(0);
486         }
487
488
489
490 /*
491  * Tie in to the 'netsetup' program.
492  *
493  * (We're going to hope that netsetup never feeds more than 4096 bytes back.)
494  */
495 void cmd_nset(char *cmdbuf)
496 {
497         int retcode;
498         char fbuf[4096];
499         FILE *netsetup;
500         int ch;
501         int a, b;
502         char netsetup_args[3][256];
503
504         if (CC->usersupp.axlevel < 6) {
505                 cprintf("%d Higher access required.\n", 
506                         ERROR + HIGHER_ACCESS_REQUIRED);
507                 return;
508                 }
509
510         for (a=1; a<=3; ++a) {
511                 if (num_parms(cmdbuf) >= a) {
512                         extract(netsetup_args[a-1], cmdbuf, a-1);
513                         for (b=0; b<strlen(netsetup_args[a-1]); ++b) {
514                                 if (netsetup_args[a-1][b] == 34) {
515                                         netsetup_args[a-1][b] = '_';
516                                         }
517                                 }
518                         }
519                 else {
520                         netsetup_args[a-1][0] = 0;
521                         }
522                 }
523
524         sprintf(fbuf, "./netsetup \"%s\" \"%s\" \"%s\" </dev/null 2>&1",
525                 netsetup_args[0], netsetup_args[1], netsetup_args[2]);
526         netsetup = popen(fbuf, "r");
527         if (netsetup == NULL) {
528                 cprintf("%d %s\n", ERROR, strerror(errno));
529                 return;
530                 }
531
532         fbuf[0] = 0;
533         while (ch = getc(netsetup), (ch > 0)) {
534                 fbuf[strlen(fbuf)+1] = 0;
535                 fbuf[strlen(fbuf)] = ch;
536                 }
537
538         retcode = pclose(netsetup);
539
540         if (retcode != 0) {
541                 for (a=0; a<strlen(fbuf); ++a) {
542                         if (fbuf[a] < 32) fbuf[a] = 32;
543                         }
544                 fbuf[245] = 0;
545                 cprintf("%d %s\n", ERROR, fbuf);
546                 return;
547                 }
548
549         cprintf("%d Command succeeded.  Output follows:\n", LISTING_FOLLOWS);
550         cprintf("%s", fbuf);
551         if (fbuf[strlen(fbuf)-1] != 10) cprintf("\n");
552         cprintf("000\n");
553         }
554
555
556
557 /*
558  * Generic routine to convert a login name to a full name (gecos)
559  * Returns nonzero if a conversion took place
560  */
561 int convert_login(char NameToConvert[]) {
562         struct passwd *pw;
563         int a;
564
565         pw = getpwnam(NameToConvert);
566         if (pw == NULL) {
567                 return(0);
568                 }
569         else {
570                 strcpy(NameToConvert, pw->pw_gecos);
571                 for (a=0; a<strlen(NameToConvert); ++a) {
572                         if (NameToConvert[a] == ',') NameToConvert[a] = 0;
573                         }
574                 return(1);
575                 }
576         }
577
578
579
580
581         
582
583 /*
584  * Here's where it all begins.
585  */
586 int main(int argc, char **argv)
587 {
588         struct sockaddr_in fsin;        /* Data for master socket */
589         int alen;                       /* Data for master socket */
590         int ssock;                      /* Descriptor for master socket */
591         THREAD SessThread;              /* Thread descriptor */
592         pthread_attr_t attr;            /* Thread attributes */
593         struct CitContext *con;         /* Temporary context pointer */
594         char tracefile[128];            /* Name of file to log traces to */
595         int a, i;                       /* General-purpose variables */
596         char convbuf[128];
597
598         /* specify default port name and trace file */
599         strcpy(tracefile, "");
600
601         /* parse command-line arguments */
602         for (a=1; a<argc; ++a) {
603
604                 /* -t specifies where to log trace messages to */
605                 if (!strncmp(argv[a], "-t", 2)) {
606                         strcpy(tracefile, argv[a]);
607                         strcpy(tracefile, &tracefile[2]);
608                         freopen(tracefile, "r", stdin);
609                         freopen(tracefile, "w", stdout);
610                         freopen(tracefile, "w", stderr);
611                         }
612
613                 /* run in the background if -d was specified */
614                 else if (!strcmp(argv[a], "-d")) {
615                         start_daemon( (strlen(tracefile) > 0) ? 0 : 1 ) ;
616                         }
617
618                 /* -x specifies the desired logging level */
619                 else if (!strncmp(argv[a], "-x", 2)) {
620                         strcpy(convbuf, argv[a]);
621                         verbosity = atoi(&convbuf[2]);
622                         }
623
624                 else if (!strncmp(argv[a], "-h", 2)) {
625                         strcpy(convbuf, argv[a]);
626                         strcpy(bbs_home_directory, &convbuf[2]);
627                         home_specified = 1;
628                         }
629
630                 /* any other parameter makes it crash and burn */
631                 else {
632                         lprintf(1, "citserver: usage: ");
633                         lprintf(1, "citserver [-tTraceFile]");
634                         lprintf(1, " [-d] [-xLogLevel] [-hHomeDir]\n");
635                         exit(1);
636                         }
637
638                 }
639
640         /* Tell 'em who's in da house */
641         lprintf(1, "Multithreaded message server for %s\n", CITADEL);
642         lprintf(1, "Copyright (C) 1987-1998 by Art Cancro.  ");
643         lprintf(1, "All rights reserved.\n\n");
644
645         /* Initialize... */
646         init_sysdep();
647         openlog("citserver",LOG_PID,LOG_USER);
648
649         /* Load site-specific parameters */
650         lprintf(7, "Loading citadel.config\n");
651         get_config();
652         hook_init();
653
654         /* Databases must be opened *after* config is loaded, otherwise we might
655          * end up working in the wrong directory.
656          */
657         lprintf(7, "Opening databases\n");
658         open_databases();
659
660         lprintf(7, "Checking floor reference counts\n");
661         check_ref_counts();
662
663         /*
664          * Bind the server to our favourite port.
665          * There is no need to check for errors, because ig_tcp_server()
666          * exits if it doesn't succeed.
667          */
668         lprintf(7, "Attempting to bind to port %d...\n", config.c_port_number);
669         msock = ig_tcp_server(config.c_port_number, 5);
670         lprintf(7, "Listening on socket %d\n", msock);
671
672         /*
673          * Now that we've bound the socket, change to the BBS user id
674         lprintf(7, "Changing uid to %d\n", BBSUID);
675         if (setuid(BBSUID) != 0) {
676                 lprintf(3, "setuid() failed: %s", strerror(errno));
677                 }
678          */
679
680         /* 
681          * Endless loop.  Listen on the master socket.  When a connection
682          * comes in, create a socket, a context, and a thread.
683          */     
684         while (1) {
685                 ssock = accept(msock, (struct sockaddr *)&fsin, &alen);
686                 if (ssock < 0) {
687                         lprintf(2, "citserver: accept() failed: %s\n",
688                                 strerror(errno));
689                         }
690                 else {
691                         lprintf(7, "citserver: Client socket %d\n", ssock);
692                         lprintf(9, "creating context\n");
693                         con = CreateNewContext();
694                         con->client_socket = ssock;
695
696                         /* Set the SO_REUSEADDR socket option */
697                         lprintf(9, "setting socket options\n");
698                         i = 1;
699                         setsockopt(ssock, SOL_SOCKET, SO_REUSEADDR,
700                                 &i, sizeof(i));
701
702                         /* set attributes for the new thread */
703                         lprintf(9, "setting thread attributes\n");
704                         pthread_attr_init(&attr);
705                         pthread_attr_setdetachstate(&attr,
706                                 PTHREAD_CREATE_DETACHED);
707
708                         /* now create the thread */
709                         lprintf(9, "creating thread\n");
710                         if (pthread_create(&SessThread, &attr, (void *)sd_context_loop,
711                            con) != 0) {
712                                 lprintf(1,
713                                         "citserver: can't create thread: %s\n",
714                                         strerror(errno));
715                                 }
716
717                         /* detach the thread 
718                          * (defunct -- now done at thread creation time)
719                          * if (pthread_detach(&SessThread) != 0) {
720                          *      lprintf(1,
721                          *              "citserver: can't detach thread: %s\n",
722                          *              strerror(errno));
723                          *      }
724                          */
725                         lprintf(9, "done!\n");
726                         }
727                 }
728         }
729