citadel/sysdep.c

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