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