citadel/sysdep.c

   1 /*
   2  * $Id$
   3  *
   4  * Citadel "system dependent" stuff.
   5  * See COPYING 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 #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/stat.h>
  24 #include <sys/wait.h>
  25 #include <sys/socket.h>
  26 #include <syslog.h>
  27 #include <sys/syslog.h>
  28
  29 #if TIME_WITH_SYS_TIME
  30 # include <sys/time.h>
  31 # include <time.h>
  32 #else
  33 # if HAVE_SYS_TIME_H
  34 #  include <sys/time.h>
  35 # else
  36 #  include <time.h>
  37 # endif
  38 #endif
  39
  40 #include <limits.h>
  41 #include <sys/resource.h>
  42 #include <netinet/in.h>
  43 #include <netinet/tcp.h>
  44 #include <arpa/inet.h>
  45 #include <netdb.h>
  46 #include <sys/un.h>
  47 #include <string.h>
  48 #include <pwd.h>
  49 #include <errno.h>
  50 #include <stdarg.h>
  51 #include <grp.h>
  52 #include <libcitadel.h>
  53 #include "citadel.h"
  54 #include "server.h"
  55 #include "sysdep_decls.h"
  56 #include "citserver.h"
  57 #include "support.h"
  58 #include "config.h"
  59 #include "database.h"
  60 #include "housekeeping.h"
  61 #include "modules/crypto/serv_crypto.h" /* Needed for init_ssl, client_write_ssl, client_read_ssl, destruct_ssl */
  62 #include "ecrash.h"
  63
  64 #ifdef HAVE_SYS_SELECT_H
  65 #include <sys/select.h>
  66 #endif
  67
  68 #ifndef HAVE_SNPRINTF
  69 #include "snprintf.h"
  70 #endif
  71
  72 #include "ctdl_module.h"
  73 #include "threads.h"
  74 #include "user_ops.h"
  75 #include "control.h"
  76
  77
  78 #ifdef DEBUG_MEMORY_LEAKS
  79 struct igheap {
  80         struct igheap *next;
  81         char file[32];
  82         int line;
  83         void *block;
  84 };
  85
  86 struct igheap *igheap = NULL;
  87 #endif
  88
  89
  90 citthread_key_t MyConKey;                               /* TSD key for MyContext() */
  91
  92 int verbosity = DEFAULT_VERBOSITY;              /* Logging level */
  93
  94 struct CitContext masterCC;
  95 time_t last_purge = 0;                          /* Last dead session purge */
  96 int num_sessions = 0;                           /* Current number of sessions */
  97
  98 int syslog_facility = LOG_DAEMON;
  99 int enable_syslog = 0;
 100
 101
 102 /* Flag for single user mode */
 103 static int want_single_user = 0;
 104
 105 /* Try to go single user */
 106
 107 int CtdlTrySingleUser(void)
 108 {
 109         int can_do = 0;
 110
 111         begin_critical_section(S_SINGLE_USER);
 112         if (want_single_user)
 113                 can_do = 0;
 114         else
 115         {
 116                 can_do = 1;
 117                 want_single_user = 1;
 118         }
 119         end_critical_section(S_SINGLE_USER);
 120         return can_do;
 121 }
 122
 123 void CtdlEndSingleUser(void)
 124 {
 125         begin_critical_section(S_SINGLE_USER);
 126         want_single_user = 0;
 127         end_critical_section(S_SINGLE_USER);
 128 }
 129
 130
 131 int CtdlWantSingleUser(void)
 132 {
 133         return want_single_user;
 134 }
 135
 136 int CtdlIsSingleUser(void)
 137 {
 138         if (want_single_user)
 139         {
 140                 /* check for only one context here */
 141                 if (num_sessions == 1)
 142                         return TRUE;
 143         }
 144         return FALSE;
 145 }
 146
 147
 148 /*
 149  * CtdlLogPrintf()  ...   Write logging information
 150  */
 151 void CtdlLogPrintf(enum LogLevel loglevel, const char *format, ...) {
 152         va_list arg_ptr;
 153         va_start(arg_ptr, format);
 154         vCtdlLogPrintf(loglevel, format, arg_ptr);
 155         va_end(arg_ptr);
 156 }
 157
 158 void vCtdlLogPrintf(enum LogLevel loglevel, const char *format, va_list arg_ptr)
 159 {
 160         char buf[SIZ], buf2[SIZ];
 161
 162         if (enable_syslog) {
 163                 vsyslog((syslog_facility | loglevel), format, arg_ptr);
 164         }
 165
 166         /* stderr output code */
 167         if (enable_syslog || running_as_daemon) return;
 168
 169         /* if we run in forground and syslog is disabled, log to terminal */
 170         if (loglevel <= verbosity) {
 171                 struct timeval tv;
 172                 struct tm tim;
 173                 time_t unixtime;
 174
 175                 gettimeofday(&tv, NULL);
 176                 /* Promote to time_t; types differ on some OSes (like darwin) */
 177                 unixtime = tv.tv_sec;
 178                 localtime_r(&unixtime, &tim);
 179                 if (CC->cs_pid != 0) {
 180                         sprintf(buf,
 181                                 "%04d/%02d/%02d %2d:%02d:%02d.%06ld [%3d] ",
 182                                 tim.tm_year + 1900, tim.tm_mon + 1,
 183                                 tim.tm_mday, tim.tm_hour, tim.tm_min,
 184                                 tim.tm_sec, (long)tv.tv_usec,
 185                                 CC->cs_pid);
 186                 } else {
 187                         sprintf(buf,
 188                                 "%04d/%02d/%02d %2d:%02d:%02d.%06ld ",
 189                                 tim.tm_year + 1900, tim.tm_mon + 1,
 190                                 tim.tm_mday, tim.tm_hour, tim.tm_min,
 191                                 tim.tm_sec, (long)tv.tv_usec);
 192                 }
 193                 vsnprintf(buf2, SIZ, format, arg_ptr);
 194
 195                 fprintf(stderr, "%s%s", buf, buf2);
 196                 fflush(stderr);
 197         }
 198 }
 199
 200
 201
 202 /*
 203  * Signal handler to shut down the server.
 204  */
 205
 206 volatile int exit_signal = 0;
 207 volatile int shutdown_and_halt = 0;
 208 volatile int restart_server = 0;
 209 volatile int running_as_daemon = 0;
 210
 211 static RETSIGTYPE signal_cleanup(int signum) {
 212 #ifdef THREADS_USESIGNALS
 213         if (CT)
 214                 CT->signal = signum;
 215         else
 216 #endif
 217         {
 218                 CtdlLogPrintf(CTDL_DEBUG, "Caught signal %d; shutting down.\n", signum);
 219                 exit_signal = signum;
 220         }
 221 }
 222
 223
 224
 225 /*
 226  * Some initialization stuff...
 227  */
 228 void init_sysdep(void) {
 229         sigset_t set;
 230
 231         /* Avoid vulnerabilities related to FD_SETSIZE if we can. */
 232 #ifdef FD_SETSIZE
 233 #ifdef RLIMIT_NOFILE
 234         struct rlimit rl;
 235         getrlimit(RLIMIT_NOFILE, &rl);
 236         rl.rlim_cur = FD_SETSIZE;
 237         rl.rlim_max = FD_SETSIZE;
 238         setrlimit(RLIMIT_NOFILE, &rl);
 239 #endif
 240 #endif
 241
 242         /* If we've got OpenSSL, we're going to use it. */
 243 #ifdef HAVE_OPENSSL
 244         init_ssl();
 245 #endif
 246
 247         /*
 248          * Set up a place to put thread-specific data.
 249          * We only need a single pointer per thread - it points to the
 250          * CitContext structure (in the ContextList linked list) of the
 251          * session to which the calling thread is currently bound.
 252          */
 253         if (citthread_key_create(&MyConKey, NULL) != 0) {
 254                 CtdlLogPrintf(CTDL_CRIT, "Can't create TSD key: %s\n",
 255                         strerror(errno));
 256         }
 257
 258         /*
 259          * The action for unexpected signals and exceptions should be to
 260          * call signal_cleanup() to gracefully shut down the server.
 261          */
 262         sigemptyset(&set);
 263         sigaddset(&set, SIGINT);
 264         sigaddset(&set, SIGQUIT);
 265         sigaddset(&set, SIGHUP);
 266         sigaddset(&set, SIGTERM);
 267         // sigaddset(&set, SIGSEGV);    commented out because
 268         // sigaddset(&set, SIGILL);     we want core dumps
 269         // sigaddset(&set, SIGBUS);
 270         sigprocmask(SIG_UNBLOCK, &set, NULL);
 271
 272         signal(SIGINT, signal_cleanup);
 273         signal(SIGQUIT, signal_cleanup);
 274         signal(SIGHUP, signal_cleanup);
 275         signal(SIGTERM, signal_cleanup);
 276         // signal(SIGSEGV, signal_cleanup);     commented out because
 277         // signal(SIGILL, signal_cleanup);      we want core dumps
 278         // signal(SIGBUS, signal_cleanup);
 279
 280         /*
 281          * Do not shut down the server on broken pipe signals, otherwise the
 282          * whole Citadel service would come down whenever a single client
 283          * socket breaks.
 284          */
 285         signal(SIGPIPE, SIG_IGN);
 286 }
 287
 288
 289
 290
 291 /*
 292  * This is a generic function to set up a master socket for listening on
 293  * a TCP port.  The server shuts down if the bind fails.
 294  *
 295  */
 296 int ig_tcp_server(char *ip_addr, int port_number, int queue_len, char **errormessage)
 297 {
 298         struct sockaddr_in sin;
 299         int s, i;
 300         int actual_queue_len;
 301
 302         actual_queue_len = queue_len;
 303         if (actual_queue_len < 5) actual_queue_len = 5;
 304
 305         memset(&sin, 0, sizeof(sin));
 306         sin.sin_family = AF_INET;
 307         sin.sin_port = htons((u_short)port_number);
 308         if (ip_addr == NULL) {
 309                 sin.sin_addr.s_addr = INADDR_ANY;
 310         }
 311         else {
 312                 sin.sin_addr.s_addr = inet_addr(ip_addr);
 313         }
 314
 315         if (sin.sin_addr.s_addr == !INADDR_ANY) {
 316                 sin.sin_addr.s_addr = INADDR_ANY;
 317         }
 318
 319         s = socket(PF_INET, SOCK_STREAM, IPPROTO_TCP);
 320
 321         if (s < 0) {
 322                 *errormessage = (char*) malloc(SIZ + 1);
 323                 snprintf(*errormessage, SIZ,
 324                                  "citserver: Can't create a socket: %s",
 325                                  strerror(errno));
 326                 CtdlLogPrintf(CTDL_EMERG, "%s\n", *errormessage);
 327                 return(-1);
 328         }
 329
 330         i = 1;
 331         setsockopt(s, SOL_SOCKET, SO_REUSEADDR, &i, sizeof(i));
 332
 333         if (bind(s, (struct sockaddr *)&sin, sizeof(sin)) < 0) {
 334                 *errormessage = (char*) malloc(SIZ + 1);
 335                 snprintf(*errormessage, SIZ,
 336                                  "citserver: Can't bind: %s",
 337                                  strerror(errno));
 338                 CtdlLogPrintf(CTDL_EMERG, "%s\n", *errormessage);
 339                 close(s);
 340                 return(-1);
 341         }
 342
 343         /* set to nonblock - we need this for some obscure situations */
 344         if (fcntl(s, F_SETFL, O_NONBLOCK) < 0) {
 345                 *errormessage = (char*) malloc(SIZ + 1);
 346                 snprintf(*errormessage, SIZ,
 347                                  "citserver: Can't set socket to non-blocking: %s",
 348                                  strerror(errno));
 349                 CtdlLogPrintf(CTDL_EMERG, "%s\n", *errormessage);
 350                 close(s);
 351                 return(-1);
 352         }
 353
 354         if (listen(s, actual_queue_len) < 0) {
 355                 *errormessage = (char*) malloc(SIZ + 1);
 356                 snprintf(*errormessage, SIZ,
 357                                  "citserver: Can't listen: %s",
 358                                  strerror(errno));
 359                 CtdlLogPrintf(CTDL_EMERG, "%s\n", *errormessage);
 360                 close(s);
 361                 return(-1);
 362         }
 363
 364         return(s);
 365 }
 366
 367
 368
 369 /*
 370  * Create a Unix domain socket and listen on it
 371  */
 372 int ig_uds_server(char *sockpath, int queue_len, char **errormessage)
 373 {
 374         struct sockaddr_un addr;
 375         int s;
 376         int i;
 377         int actual_queue_len;
 378
 379         actual_queue_len = queue_len;
 380         if (actual_queue_len < 5) actual_queue_len = 5;
 381
 382         i = unlink(sockpath);
 383         if ((i != 0) && (errno != ENOENT)) {
 384                 *errormessage = (char*) malloc(SIZ + 1);
 385                 snprintf(*errormessage, SIZ, "citserver: can't unlink %s: %s",
 386                         sockpath, strerror(errno));
 387                 CtdlLogPrintf(CTDL_EMERG, "%s\n", *errormessage);
 388                 return(-1);
 389         }
 390
 391         memset(&addr, 0, sizeof(addr));
 392         addr.sun_family = AF_UNIX;
 393         safestrncpy(addr.sun_path, sockpath, sizeof addr.sun_path);
 394
 395         s = socket(AF_UNIX, SOCK_STREAM, 0);
 396         if (s < 0) {
 397                 *errormessage = (char*) malloc(SIZ + 1);
 398                 snprintf(*errormessage, SIZ,
 399                          "citserver: Can't create a socket: %s",
 400                          strerror(errno));
 401                 CtdlLogPrintf(CTDL_EMERG, "%s\n", *errormessage);
 402                 return(-1);
 403         }
 404
 405         if (bind(s, (struct sockaddr *)&addr, sizeof(addr)) < 0) {
 406                 *errormessage = (char*) malloc(SIZ + 1);
 407                 snprintf(*errormessage, SIZ,
 408                          "citserver: Can't bind: %s",
 409                          strerror(errno));
 410                 CtdlLogPrintf(CTDL_EMERG, "%s\n", *errormessage);
 411                 return(-1);
 412         }
 413
 414         /* set to nonblock - we need this for some obscure situations */
 415         if (fcntl(s, F_SETFL, O_NONBLOCK) < 0) {
 416                 *errormessage = (char*) malloc(SIZ + 1);
 417                 snprintf(*errormessage, SIZ,
 418                          "citserver: Can't set socket to non-blocking: %s",
 419                          strerror(errno));
 420                 CtdlLogPrintf(CTDL_EMERG, "%s\n", *errormessage);
 421                 close(s);
 422                 return(-1);
 423         }
 424
 425         if (listen(s, actual_queue_len) < 0) {
 426                 *errormessage = (char*) malloc(SIZ + 1);
 427                 snprintf(*errormessage, SIZ,
 428                          "citserver: Can't listen: %s",
 429                          strerror(errno));
 430                 CtdlLogPrintf(CTDL_EMERG, "%s\n", *errormessage);
 431                 return(-1);
 432         }
 433
 434         chmod(sockpath, S_ISGID|S_IRUSR|S_IWUSR|S_IXUSR|S_IRGRP|S_IWGRP|S_IXGRP|S_IROTH|S_IWOTH|S_IXOTH);
 435         return(s);
 436 }
 437
 438
 439
 440 /*
 441  * Return a pointer to the CitContext structure bound to the thread which
 442  * called this function.  If there's no such binding (for example, if it's
 443  * called by the housekeeper thread) then a generic 'master' CC is returned.
 444  *
 445  * This function is used *VERY* frequently and must be kept small.
 446  */
 447 struct CitContext *MyContext(void) {
 448
 449         register struct CitContext *c;
 450
 451         return ((c = (struct CitContext *) citthread_getspecific(MyConKey),
 452                 c == NULL) ? &masterCC : c
 453         );
 454 }
 455
 456
 457 /*
 458  * Initialize a new context and place it in the list.  The session number
 459  * used to be the PID (which is why it's called cs_pid), but that was when we
 460  * had one process per session.  Now we just assign them sequentially, starting
 461  * at 1 (don't change it to 0 because masterCC uses 0).
 462  */
 463 struct CitContext *CreateNewContext(void) {
 464         struct CitContext *me;
 465         static int next_pid = 0;
 466
 467         me = (struct CitContext *) malloc(sizeof(struct CitContext));
 468         if (me == NULL) {
 469                 CtdlLogPrintf(CTDL_ALERT, "citserver: can't allocate memory!!\n");
 470                 return NULL;
 471         }
 472
 473         memset(me, 0, sizeof(struct CitContext));
 474
 475         /* Give the contaxt a name. Hopefully makes it easier to track */
 476         strcpy (me->user.fullname, "SYS_notauth");
 477
 478         /* The new context will be created already in the CON_EXECUTING state
 479          * in order to prevent another thread from grabbing it while it's
 480          * being set up.
 481          */
 482         me->state = CON_EXECUTING;
 483         /*
 484          * Generate a unique session number and insert this context into
 485          * the list.
 486          */
 487         begin_critical_section(S_SESSION_TABLE);
 488         me->cs_pid = ++next_pid;
 489         me->prev = NULL;
 490         me->next = ContextList;
 491         ContextList = me;
 492         if (me->next != NULL) {
 493                 me->next->prev = me;
 494         }
 495         ++num_sessions;
 496         end_critical_section(S_SESSION_TABLE);
 497         return (me);
 498 }
 499
 500
 501 struct CitContext *CtdlGetContextArray(int *count)
 502 {
 503         int nContexts, i;
 504         struct CitContext *nptr, *cptr;
 505
 506         nContexts = num_sessions;
 507         nptr = malloc(sizeof(struct CitContext) * nContexts);
 508         if (!nptr)
 509                 return NULL;
 510         begin_critical_section(S_SESSION_TABLE);
 511         for (cptr = ContextList, i=0; cptr != NULL && i < nContexts; cptr = cptr->next, i++)
 512                 memcpy(&nptr[i], cptr, sizeof (struct CitContext));
 513         end_critical_section (S_SESSION_TABLE);
 514
 515         *count = i;
 516         return nptr;
 517 }
 518
 519
 520
 521 /**
 522  * This function fills in a context and its user field correctly
 523  * Then creates/loads that user
 524  */
 525 void CtdlFillSystemContext(struct CitContext *context, char *name)
 526 {
 527         char sysname[USERNAME_SIZE];
 528
 529         memset(context, 0, sizeof(struct CitContext));
 530         context->internal_pgm = 1;
 531         context->cs_pid = 0;
 532         strcpy (sysname, "SYS_");
 533         strcat (sysname, name);
 534         /* internal_create_user has the side effect of loading the user regardless of wether they
 535          * already existed or needed to be created
 536          */
 537         internal_create_user (sysname, &(context->user), -1) ;
 538
 539         /* Check to see if the system user needs upgrading */
 540         if (context->user.usernum == 0)
 541         {       /* old system user with number 0, upgrade it */
 542                 context->user.usernum = get_new_user_number();
 543                 CtdlLogPrintf(CTDL_DEBUG, "Upgrading system user \"%s\" from user number 0 to user number %d\n", context->user.fullname, context->user.usernum);
 544                 /* add user to the database */
 545                 putuser(&(context->user));
 546                 cdb_store(CDB_USERSBYNUMBER, &(context->user.usernum), sizeof(long), context->user.fullname, strlen(context->user.fullname)+1);
 547         }
 548 }
 549
 550 /*
 551  * The following functions implement output buffering on operating systems which
 552  * support it (such as Linux and various BSD flavors).
 553  */
 554 #ifndef HAVE_DARWIN
 555 #ifdef TCP_CORK
 556 #       define HAVE_TCP_BUFFERING
 557 #else
 558 #       ifdef TCP_NOPUSH
 559 #               define HAVE_TCP_BUFFERING
 560 #               define TCP_CORK TCP_NOPUSH
 561 #       endif
 562 #endif /* TCP_CORK */
 563 #endif /* HAVE_DARWIN */
 564
 565 static unsigned on = 1, off = 0;
 566
 567 void buffer_output(void) {
 568 #ifdef HAVE_TCP_BUFFERING
 569         if (!CC->redirect_ssl) {
 570                 setsockopt(CC->client_socket, IPPROTO_TCP, TCP_CORK, &on, 4);
 571         }
 572 #endif
 573 }
 574
 575 void unbuffer_output(void) {
 576 #ifdef HAVE_TCP_BUFFERING
 577         if (!CC->redirect_ssl) {
 578                 setsockopt(CC->client_socket, IPPROTO_TCP, TCP_CORK, &off, 4);
 579         }
 580 #endif
 581 }
 582
 583 void flush_output(void) {
 584 #ifdef HAVE_TCP_BUFFERING
 585         struct CitContext *CCC = CC;
 586         setsockopt(CCC->client_socket, IPPROTO_TCP, TCP_CORK, &off, 4);
 587         setsockopt(CCC->client_socket, IPPROTO_TCP, TCP_CORK, &on, 4);
 588 #endif
 589 }
 590
 591
 592
 593 /*
 594  * client_write()   ...    Send binary data to the client.
 595  */
 596 int client_write(char *buf, int nbytes)
 597 {
 598         int bytes_written = 0;
 599         int retval;
 600 #ifndef HAVE_TCP_BUFFERING
 601         int old_buffer_len = 0;
 602 #endif
 603         fd_set wset;
 604         t_context *Ctx;
 605         int fdflags;
 606
 607         Ctx = CC;
 608         if (Ctx->redirect_buffer != NULL) {
 609                 if ((Ctx->redirect_len + nbytes + 2) >= Ctx->redirect_alloc) {
 610                         Ctx->redirect_alloc = (Ctx->redirect_alloc * 2) + nbytes;
 611                         Ctx->redirect_buffer = realloc(Ctx->redirect_buffer,
 612                                                 Ctx->redirect_alloc);
 613                 }
 614                 memcpy(&Ctx->redirect_buffer[Ctx->redirect_len], buf, nbytes);
 615                 Ctx->redirect_len += nbytes;
 616                 Ctx->redirect_buffer[Ctx->redirect_len] = 0;
 617                 return 0;
 618         }
 619
 620 #ifdef HAVE_OPENSSL
 621         if (Ctx->redirect_ssl) {
 622                 client_write_ssl(buf, nbytes);
 623                 return 0;
 624         }
 625 #endif
 626
 627         fdflags = fcntl(Ctx->client_socket, F_GETFL);
 628
 629         while (bytes_written < nbytes) {
 630                 if ((fdflags & O_NONBLOCK) == O_NONBLOCK) {
 631                         FD_ZERO(&wset);
 632                         FD_SET(Ctx->client_socket, &wset);
 633                         if (select(1, NULL, &wset, NULL, NULL) == -1) {
 634                                 CtdlLogPrintf(CTDL_ERR,
 635                                         "client_write(%d bytes) select failed: %s (%d)\n",
 636                                         nbytes - bytes_written,
 637                                         strerror(errno), errno);
 638                                 cit_backtrace();
 639                                 Ctx->kill_me = 1;
 640                                 return -1;
 641                         }
 642                 }
 643
 644                 retval = write(Ctx->client_socket, &buf[bytes_written],
 645                         nbytes - bytes_written);
 646                 if (retval < 1) {
 647                         CtdlLogPrintf(CTDL_ERR,
 648                                 "client_write(%d bytes) failed: %s (%d)\n",
 649                                 nbytes - bytes_written,
 650                                 strerror(errno), errno);
 651                         cit_backtrace();
 652                         // CtdlLogPrintf(CTDL_DEBUG, "Tried to send: %s",  &buf[bytes_written]);
 653                         Ctx->kill_me = 1;
 654                         return -1;
 655                 }
 656                 bytes_written = bytes_written + retval;
 657         }
 658         return 0;
 659 }
 660
 661
 662 /*
 663  * cprintf()    Send formatted printable data to the client.
 664  *              Implemented in terms of client_write() so it's technically not sysdep...
 665  */
 666 void cprintf(const char *format, ...) {
 667         va_list arg_ptr;
 668         char buf[1024];
 669
 670         va_start(arg_ptr, format);
 671         if (vsnprintf(buf, sizeof buf, format, arg_ptr) == -1)
 672                 buf[sizeof buf - 2] = '\n';
 673         client_write(buf, strlen(buf));
 674         va_end(arg_ptr);
 675 }
 676
 677
 678 /*
 679  * Read data from the client socket.
 680  * Return values are:
 681  *      1       Requested number of bytes has been read.
 682  *      0       Request timed out.
 683  *      -1      The socket is broken.
 684  * If the socket breaks, the session will be terminated.
 685  */
 686 int client_read_to(char *buf, int bytes, int timeout)
 687 {
 688         int len,rlen;
 689         fd_set rfds;
 690         int fd;
 691         struct timeval tv;
 692         int retval;
 693
 694 #ifdef HAVE_OPENSSL
 695         if (CC->redirect_ssl) {
 696                 return (client_read_ssl(buf, bytes, timeout));
 697         }
 698 #endif
 699         len = 0;
 700         fd = CC->client_socket;
 701         while(len<bytes) {
 702                 FD_ZERO(&rfds);
 703                 FD_SET(fd, &rfds);
 704                 tv.tv_sec = timeout;
 705                 tv.tv_usec = 0;
 706
 707                 retval = select( (fd)+1,
 708                                  &rfds, NULL, NULL, &tv);
 709                 if (retval < 0)
 710                 {
 711                         if (errno == EINTR)
 712                         {
 713                                 CtdlLogPrintf(CTDL_DEBUG, "Interrupted select().\n");
 714                                 CC->kill_me = 1;
 715                                 return (-1);
 716                         }
 717                 }
 718
 719                 if (FD_ISSET(fd, &rfds) == 0) {
 720                         return(0);
 721                 }
 722
 723                 rlen = read(fd, &buf[len], bytes-len);
 724                 if (rlen<1) {
 725                         /* The socket has been disconnected! */
 726                         CC->kill_me = 1;
 727                         return(-1);
 728                 }
 729                 len = len + rlen;
 730         }
 731         return(1);
 732 }
 733
 734 /*
 735  * Read data from the client socket with default timeout.
 736  * (This is implemented in terms of client_read_to() and could be
 737  * justifiably moved out of sysdep.c)
 738  */
 739 INLINE int client_read(char *buf, int bytes)
 740 {
 741         return(client_read_to(buf, bytes, config.c_sleeping));
 742 }
 743
 744
 745 /*
 746  * client_getln()   ...   Get a LF-terminated line of text from the client.
 747  * (This is implemented in terms of client_read() and could be
 748  * justifiably moved out of sysdep.c)
 749  */
 750 int client_getln(char *buf, int bufsize)
 751 {
 752         int i, retval;
 753
 754         /* Read one character at a time.
 755          */
 756         for (i = 0;;i++) {
 757                 retval = client_read(&buf[i], 1);
 758                 if (retval != 1 || buf[i] == '\n' || i == (bufsize-1))
 759                         break;
 760         }
 761
 762         /* If we got a long line, discard characters until the newline.
 763          */
 764         if (i == (bufsize-1))
 765                 while (buf[i] != '\n' && retval == 1)
 766                         retval = client_read(&buf[i], 1);
 767
 768         /* Strip the trailing LF, and the trailing CR if present.
 769          */
 770         buf[i] = 0;
 771         while ( (i > 0)
 772                 && ( (buf[i - 1]==13)
 773                      || ( buf[i - 1]==10)) ) {
 774                 i--;
 775                 buf[i] = 0;
 776         }
 777         if (retval < 0) safestrncpy(&buf[i], "000", bufsize - i);
 778         return(retval);
 779 }
 780
 781
 782 /*
 783  * Cleanup any contexts that are left lying around
 784  */
 785 void context_cleanup(void)
 786 {
 787         struct CitContext *ptr = NULL;
 788         struct CitContext *rem = NULL;
 789
 790         /*
 791          * Clean up the contexts.
 792          * There are no threads so no critical_section stuff is needed.
 793          */
 794         ptr = ContextList;
 795
 796         /* We need to update the ContextList because some modules may want to itterate it
 797          * Question is should we NULL it before iterating here or should we just keep updating it
 798          * as we remove items?
 799          *
 800          * Answer is to NULL it first to prevent modules from doing any actions on the list at all
 801          */
 802         ContextList=NULL;
 803         while (ptr != NULL){
 804                 /* Remove the session from the active list */
 805                 rem = ptr->next;
 806                 --num_sessions;
 807
 808                 CtdlLogPrintf(CTDL_DEBUG, "Purging session %d\n", ptr->cs_pid);
 809                 RemoveContext(ptr);
 810                 free (ptr);
 811                 ptr = rem;
 812         }
 813 }
 814
 815
 816
 817 void close_masters (void)
 818 {
 819         struct ServiceFunctionHook *serviceptr;
 820
 821         /*
 822          * close all protocol master sockets
 823          */
 824         for (serviceptr = ServiceHookTable; serviceptr != NULL;
 825             serviceptr = serviceptr->next ) {
 826
 827                 if (serviceptr->tcp_port > 0)
 828                 {
 829                         CtdlLogPrintf(CTDL_INFO, "Closing listener on port %d\n",
 830                                 serviceptr->tcp_port);
 831                         serviceptr->tcp_port = 0;
 832                 }
 833
 834                 if (serviceptr->sockpath != NULL)
 835                         CtdlLogPrintf(CTDL_INFO, "Closing listener on '%s'\n",
 836                                 serviceptr->sockpath);
 837
 838                 close(serviceptr->msock);
 839                 /* If it's a Unix domain socket, remove the file. */
 840                 if (serviceptr->sockpath != NULL) {
 841                         unlink(serviceptr->sockpath);
 842                         serviceptr->sockpath = NULL;
 843                 }
 844         }
 845 }
 846
 847
 848 /*
 849  * The system-dependent part of master_cleanup() - close the master socket.
 850  */
 851 void sysdep_master_cleanup(void) {
 852
 853         close_masters();
 854
 855         context_cleanup();
 856
 857 #ifdef HAVE_OPENSSL
 858         destruct_ssl();
 859 #endif
 860         CtdlDestroyProtoHooks();
 861         CtdlDestroyDeleteHooks();
 862         CtdlDestroyXmsgHooks();
 863         CtdlDestroyNetprocHooks();
 864         CtdlDestroyUserHooks();
 865         CtdlDestroyMessageHook();
 866         CtdlDestroyCleanupHooks();
 867         CtdlDestroyFixedOutputHooks();
 868         CtdlDestroySessionHooks();
 869         CtdlDestroyServiceHook();
 870         CtdlDestroyRoomHooks();
 871         CtdlDestroyDirectoryServiceFuncs();
 872         #ifdef HAVE_BACKTRACE
 873         eCrash_Uninit();
 874         #endif
 875 }
 876
 877
 878
 879 /*
 880  * Terminate another session.
 881  * (This could justifiably be moved out of sysdep.c because it
 882  * no longer does anything that is system-dependent.)
 883  */
 884 void kill_session(int session_to_kill) {
 885         struct CitContext *ptr;
 886
 887         begin_critical_section(S_SESSION_TABLE);
 888         for (ptr = ContextList; ptr != NULL; ptr = ptr->next) {
 889                 if (ptr->cs_pid == session_to_kill) {
 890                         ptr->kill_me = 1;
 891                 }
 892         }
 893         end_critical_section(S_SESSION_TABLE);
 894 }
 895
 896 pid_t current_child;
 897 void graceful_shutdown(int signum) {
 898         kill(current_child, signum);
 899         unlink(file_pid_file);
 900         exit(0);
 901 }
 902
 903 int nFireUps = 0;
 904 int nFireUpsNonRestart = 0;
 905 pid_t ForkedPid = 1;
 906
 907 /*
 908  * Start running as a daemon.
 909  */
 910 void start_daemon(int unused) {
 911         int status = 0;
 912         pid_t child = 0;
 913         FILE *fp;
 914         int do_restart = 0;
 915
 916         current_child = 0;
 917
 918         /* Close stdin/stdout/stderr and replace them with /dev/null.
 919          * We don't just call close() because we don't want these fd's
 920          * to be reused for other files.
 921          */
 922         chdir(ctdl_run_dir);
 923
 924         child = fork();
 925         if (child != 0) {
 926                 exit(0);
 927         }
 928
 929         signal(SIGHUP, SIG_IGN);
 930         signal(SIGINT, SIG_IGN);
 931         signal(SIGQUIT, SIG_IGN);
 932
 933         setsid();
 934         umask(0);
 935         freopen("/dev/null", "r", stdin);
 936         freopen("/dev/null", "w", stdout);
 937         freopen("/dev/null", "w", stderr);
 938
 939         do {
 940                 current_child = fork();
 941
 942                 signal(SIGTERM, graceful_shutdown);
 943
 944                 if (current_child < 0) {
 945                         perror("fork");
 946                         exit(errno);
 947                 }
 948
 949                 else if (current_child == 0) {
 950                         return; /* continue starting citadel. */
 951                 }
 952
 953                 else {
 954                         fp = fopen(file_pid_file, "w");
 955                         if (fp != NULL) {
 956                                 fprintf(fp, ""F_PID_T"\n", getpid());
 957                                 fclose(fp);
 958                         }
 959                         waitpid(current_child, &status, 0);
 960                 }
 961                 do_restart = 0;
 962                 nFireUpsNonRestart = nFireUps;
 963
 964                 /* Exit code 0 means the watcher should exit */
 965                 if (WIFEXITED(status) && (WEXITSTATUS(status) == CTDLEXIT_SHUTDOWN)) {
 966                         do_restart = 0;
 967                 }
 968
 969                 /* Exit code 101-109 means the watcher should exit */
 970                 else if (WIFEXITED(status) && (WEXITSTATUS(status) >= 101) && (WEXITSTATUS(status) <= 109)) {
 971                         do_restart = 0;
 972                 }
 973
 974                 /* Any other exit code, or no exit code, means we should restart. */
 975                 else {
 976                         do_restart = 1;
 977                         nFireUps++;
 978                         ForkedPid = current_child;
 979                 }
 980
 981         } while (do_restart);
 982
 983         unlink(file_pid_file);
 984         exit(WEXITSTATUS(status));
 985 }
 986
 987
 988
 989 void checkcrash(void)
 990 {
 991         if (nFireUpsNonRestart != nFireUps)
 992         {
 993                 StrBuf *CrashMail;
 994
 995                 CrashMail = NewStrBuf();
 996                 CtdlLogPrintf (CTDL_ALERT, "----------------sending crash mail\n");
 997                 StrBufPrintf(CrashMail,
 998                              "Your CitServer is just recovering from an unexpected termination.\n"
 999                              " this maybe the result of an error in citserver or an external influence.\n"
1000                              " You can get more information on this by enabling coredumping; for more information see\n"
1001                              " http://citadel.org/doku.php/faq:mastering_your_os:gdb#how.do.i.make.my.system.produce.core-files\n"
1002                              " If you already did, the file you're looking for most probably is %score.%d\n"
1003                              " Yours faithfully...",
1004                              ctdl_run_dir, ForkedPid);
1005                 aide_message(ChrPtr(CrashMail), "Citadel server crashed.");
1006                 FreeStrBuf(&CrashMail);
1007         }
1008 }
1009
1010
1011 /*
1012  * Generic routine to convert a login name to a full name (gecos)
1013  * Returns nonzero if a conversion took place
1014  */
1015 int convert_login(char NameToConvert[]) {
1016         struct passwd *pw;
1017         int a;
1018
1019         pw = getpwnam(NameToConvert);
1020         if (pw == NULL) {
1021                 return(0);
1022         }
1023         else {
1024                 strcpy(NameToConvert, pw->pw_gecos);
1025                 for (a=0; a<strlen(NameToConvert); ++a) {
1026                         if (NameToConvert[a] == ',') NameToConvert[a] = 0;
1027                 }
1028                 return(1);
1029         }
1030 }
1031
1032 /*
1033  * Purge all sessions which have the 'kill_me' flag set.
1034  * This function has code to prevent it from running more than once every
1035  * few seconds, because running it after every single unbind would waste a lot
1036  * of CPU time and keep the context list locked too much.  To force it to run
1037  * anyway, set "force" to nonzero.
1038  */
1039 void dead_session_purge(int force) {
1040         struct CitContext *ptr, *ptr2;          /* general-purpose utility pointer */
1041         struct CitContext *rem = NULL;  /* list of sessions to be destroyed */
1042
1043         if (force == 0) {
1044                 if ( (time(NULL) - last_purge) < 5 ) {
1045                         return; /* Too soon, go away */
1046                 }
1047         }
1048         time(&last_purge);
1049
1050         if (try_critical_section(S_SESSION_TABLE))
1051                 return;
1052
1053         ptr = ContextList;
1054         while (ptr) {
1055                 ptr2 = ptr;
1056                 ptr = ptr->next;
1057
1058                 if ( (ptr2->state == CON_IDLE) && (ptr2->kill_me) ) {
1059                         /* Remove the session from the active list */
1060                         if (ptr2->prev) {
1061                                 ptr2->prev->next = ptr2->next;
1062                         }
1063                         else {
1064                                 ContextList = ptr2->next;
1065                         }
1066                         if (ptr2->next) {
1067                                 ptr2->next->prev = ptr2->prev;
1068                         }
1069
1070                         --num_sessions;
1071                         /* And put it on our to-be-destroyed list */
1072                         ptr2->next = rem;
1073                         rem = ptr2;
1074                 }
1075         }
1076         end_critical_section(S_SESSION_TABLE);
1077
1078         /* Now that we no longer have the session list locked, we can take
1079          * our time and destroy any sessions on the to-be-killed list, which
1080          * is allocated privately on this thread's stack.
1081          */
1082         while (rem != NULL) {
1083                 CtdlLogPrintf(CTDL_DEBUG, "Purging session %d\n", rem->cs_pid);
1084                 RemoveContext(rem);
1085                 ptr = rem;
1086                 rem = rem->next;
1087                 free(ptr);
1088         }
1089 }
1090
1091
1092
1093
1094
1095 /*
1096  * masterCC is the context we use when not attached to a session.  This
1097  * function initializes it.
1098  */
1099 void InitializeMasterCC(void) {
1100         memset(&masterCC, 0, sizeof(struct CitContext));
1101         masterCC.internal_pgm = 1;
1102         masterCC.cs_pid = 0;
1103 }
1104
1105
1106
1107
1108 /*
1109  * Bind a thread to a context.  (It's inline merely to speed things up.)
1110  */
1111 INLINE void become_session(struct CitContext *which_con) {
1112         citthread_setspecific(MyConKey, (void *)which_con );
1113 }
1114
1115
1116
1117 /*
1118  * This loop just keeps going and going and going...
1119  */
1120 /*
1121  * FIXME:
1122  * This current implimentation of worker_thread creates a bottle neck in several situations
1123  * The first thing to remember is that a single thread can handle more than one connection at a time.
1124  * More threads mean less memory for the system to run in.
1125  * So for efficiency we want every thread to be doing something useful or waiting in the main loop for
1126  * something to happen anywhere.
1127  * This current implimentation requires worker threads to wait in other locations, after it has
1128  * been committed to a single connection which is very wasteful.
1129  * As an extreme case consider this:
1130  * A slow client connects and this slow client sends only one character each second.
1131  * With this current implimentation a single worker thread is dispatched to handle that connection
1132  * until such times as the client timeout expires, an error occurs on the socket or the client
1133  * completes its transmission.
1134  * THIS IS VERY BAD since that thread could have handled a read from many more clients in each one
1135  * second interval between chars.
1136  *
1137  * It is my intention to re-write this code and the associated client_getln, client_read functions
1138  * to allow any thread to read data on behalf of any connection (context).
1139  * To do this I intend to have this main loop read chars into a buffer stored in the context.
1140  * Once the correct criteria for a full buffer is met then we will dispatch a thread to
1141  * process it.
1142  * This worker thread loop also needs to be able to handle binary data.
1143  */
1144
1145 void *worker_thread(void *arg) {
1146         int i;
1147         int highest;
1148         struct CitContext *ptr;
1149         struct CitContext *bind_me = NULL;
1150         fd_set readfds;
1151         int retval = 0;
1152         struct CitContext *con= NULL;   /* Temporary context pointer */
1153         struct ServiceFunctionHook *serviceptr;
1154         int ssock;                      /* Descriptor for client socket */
1155         struct timeval tv;
1156         int force_purge = 0;
1157         int m;
1158
1159
1160         while (!CtdlThreadCheckStop()) {
1161
1162                 /* make doubly sure we're not holding any stale db handles
1163                  * which might cause a deadlock.
1164                  */
1165                 cdb_check_handles();
1166 do_select:      force_purge = 0;
1167                 bind_me = NULL;         /* Which session shall we handle? */
1168
1169                 /* Initialize the fdset. */
1170                 FD_ZERO(&readfds);
1171                 highest = 0;
1172
1173                 begin_critical_section(S_SESSION_TABLE);
1174                 for (ptr = ContextList; ptr != NULL; ptr = ptr->next) {
1175                         if (ptr->state == CON_IDLE) {
1176                                 FD_SET(ptr->client_socket, &readfds);
1177                                 if (ptr->client_socket > highest)
1178                                         highest = ptr->client_socket;
1179                         }
1180                         if ((bind_me == NULL) && (ptr->state == CON_READY)) {
1181                                 bind_me = ptr;
1182                                 ptr->state = CON_EXECUTING;
1183                         }
1184                 }
1185                 end_critical_section(S_SESSION_TABLE);
1186
1187                 if (bind_me) {
1188                         goto SKIP_SELECT;
1189                 }
1190
1191                 /* If we got this far, it means that there are no sessions
1192                  * which a previous thread marked for attention, so we go
1193                  * ahead and get ready to select().
1194                  */
1195
1196                 /* First, add the various master sockets to the fdset. */
1197                 for (serviceptr = ServiceHookTable; serviceptr != NULL;
1198                 serviceptr = serviceptr->next ) {
1199                         m = serviceptr->msock;
1200                         FD_SET(m, &readfds);
1201                         if (m > highest) {
1202                                 highest = m;
1203                         }
1204                 }
1205
1206                 if (!CtdlThreadCheckStop()) {
1207                         tv.tv_sec = 1;          /* wake up every second if no input */
1208                         tv.tv_usec = 0;
1209                         retval = CtdlThreadSelect(highest + 1, &readfds, NULL, NULL, &tv);
1210                 }
1211                 else
1212                         return NULL;
1213
1214                 /* Now figure out who made this select() unblock.
1215                  * First, check for an error or exit condition.
1216                  */
1217                 if (retval < 0) {
1218                         if (errno == EBADF) {
1219                                 CtdlLogPrintf(CTDL_NOTICE, "select() failed: (%s)\n",
1220                                         strerror(errno));
1221                                 goto do_select;
1222                         }
1223                         if (errno != EINTR) {
1224                                 CtdlLogPrintf(CTDL_EMERG, "Exiting (%s)\n", strerror(errno));
1225                                 CtdlThreadStopAll();
1226                         } else {
1227                                 CtdlLogPrintf(CTDL_DEBUG, "Interrupted CtdlThreadSelect.\n");
1228                                 if (CtdlThreadCheckStop()) return(NULL);
1229                                 goto do_select;
1230                         }
1231                 }
1232                 else if(retval == 0) {
1233                         if (CtdlThreadCheckStop()) return(NULL);
1234                         goto SKIP_SELECT;
1235                 }
1236                 /* Next, check to see if it's a new client connecting
1237                  * on a master socket.
1238                  */
1239                 else for (serviceptr = ServiceHookTable; serviceptr != NULL;
1240                      serviceptr = serviceptr->next ) {
1241
1242                         if (FD_ISSET(serviceptr->msock, &readfds)) {
1243                                 ssock = accept(serviceptr->msock, NULL, 0);
1244                                 if (ssock >= 0) {
1245                                         CtdlLogPrintf(CTDL_DEBUG,
1246                                                 "New client socket %d\n",
1247                                                 ssock);
1248
1249                                         /* The master socket is non-blocking but the client
1250                                          * sockets need to be blocking, otherwise certain
1251                                          * operations barf on FreeBSD.  Not a fatal error.
1252                                          */
1253                                         if (fcntl(ssock, F_SETFL, 0) < 0) {
1254                                                 CtdlLogPrintf(CTDL_EMERG,
1255                                                         "citserver: Can't set socket to blocking: %s\n",
1256                                                         strerror(errno));
1257                                         }
1258
1259                                         /* New context will be created already
1260                                          * set up in the CON_EXECUTING state.
1261                                          */
1262                                         con = CreateNewContext();
1263
1264                                         /* Assign our new socket number to it. */
1265                                         con->client_socket = ssock;
1266                                         con->h_command_function =
1267                                                 serviceptr->h_command_function;
1268                                         con->h_async_function =
1269                                                 serviceptr->h_async_function;
1270                                         con->ServiceName =
1271                                                 serviceptr->ServiceName;
1272
1273                                         /* Determine whether it's a local socket */
1274                                         if (serviceptr->sockpath != NULL)
1275                                                 con->is_local_socket = 1;
1276
1277                                         /* Set the SO_REUSEADDR socket option */
1278                                         i = 1;
1279                                         setsockopt(ssock, SOL_SOCKET,
1280                                                 SO_REUSEADDR,
1281                                                 &i, sizeof(i));
1282
1283                                         become_session(con);
1284                                         begin_session(con);
1285                                         serviceptr->h_greeting_function();
1286                                         become_session(NULL);
1287                                         con->state = CON_IDLE;
1288                                         goto do_select;
1289                                 }
1290                         }
1291                 }
1292
1293                 /* It must be a client socket.  Find a context that has data
1294                  * waiting on its socket *and* is in the CON_IDLE state.  Any
1295                  * active sockets other than our chosen one are marked as
1296                  * CON_READY so the next thread that comes around can just bind
1297                  * to one without having to select() again.
1298                  */
1299                 begin_critical_section(S_SESSION_TABLE);
1300                 for (ptr = ContextList; ptr != NULL; ptr = ptr->next) {
1301                         if ( (FD_ISSET(ptr->client_socket, &readfds))
1302                            && (ptr->state != CON_EXECUTING) ) {
1303                                 ptr->input_waiting = 1;
1304                                 if (!bind_me) {
1305                                         bind_me = ptr;  /* I choose you! */
1306                                         bind_me->state = CON_EXECUTING;
1307                                 }
1308                                 else {
1309                                         ptr->state = CON_READY;
1310                                 }
1311                         }
1312                 }
1313                 end_critical_section(S_SESSION_TABLE);
1314
1315 SKIP_SELECT:
1316                 /* We're bound to a session */
1317                 if (bind_me != NULL) {
1318                         become_session(bind_me);
1319
1320                         /* If the client has sent a command, execute it. */
1321                         if (CC->input_waiting) {
1322                                 CC->h_command_function();
1323                                 CC->input_waiting = 0;
1324                         }
1325
1326                         /* If there are asynchronous messages waiting and the
1327                          * client supports it, do those now */
1328                         if ((CC->is_async) && (CC->async_waiting)
1329                            && (CC->h_async_function != NULL)) {
1330                                 CC->h_async_function();
1331                                 CC->async_waiting = 0;
1332                         }
1333
1334                         force_purge = CC->kill_me;
1335                         become_session(NULL);
1336                         bind_me->state = CON_IDLE;
1337                 }
1338
1339                 dead_session_purge(force_purge);
1340                 do_housekeeping();
1341         }
1342         /* If control reaches this point, the server is shutting down */
1343         return(NULL);
1344 }
1345
1346
1347
1348
1349 /*
1350  * SyslogFacility()
1351  * Translate text facility name to syslog.h defined value.
1352  */
1353 int SyslogFacility(char *name)
1354 {
1355         int i;
1356         struct
1357         {
1358                 int facility;
1359                 char *name;
1360         }   facTbl[] =
1361         {
1362                 {   LOG_KERN,   "kern"          },
1363                 {   LOG_USER,   "user"          },
1364                 {   LOG_MAIL,   "mail"          },
1365                 {   LOG_DAEMON, "daemon"        },
1366                 {   LOG_AUTH,   "auth"          },
1367                 {   LOG_SYSLOG, "syslog"        },
1368                 {   LOG_LPR,    "lpr"           },
1369                 {   LOG_NEWS,   "news"          },
1370                 {   LOG_UUCP,   "uucp"          },
1371                 {   LOG_LOCAL0, "local0"        },
1372                 {   LOG_LOCAL1, "local1"        },
1373                 {   LOG_LOCAL2, "local2"        },
1374                 {   LOG_LOCAL3, "local3"        },
1375                 {   LOG_LOCAL4, "local4"        },
1376                 {   LOG_LOCAL5, "local5"        },
1377                 {   LOG_LOCAL6, "local6"        },
1378                 {   LOG_LOCAL7, "local7"        },
1379                 {   0,            NULL          }
1380         };
1381         for(i = 0; facTbl[i].name != NULL; i++) {
1382                 if(!strcasecmp(name, facTbl[i].name))
1383                         return facTbl[i].facility;
1384         }
1385         enable_syslog = 0;
1386         return LOG_DAEMON;
1387 }
1388
1389
1390 /********** MEM CHEQQER ***********/
1391
1392 #ifdef DEBUG_MEMORY_LEAKS
1393
1394 #undef malloc
1395 #undef realloc
1396 #undef strdup
1397 #undef free
1398
1399 void *tracked_malloc(size_t size, char *file, int line) {
1400         struct igheap *thisheap;
1401         void *block;
1402
1403         block = malloc(size);
1404         if (block == NULL) return(block);
1405
1406         thisheap = malloc(sizeof(struct igheap));
1407         if (thisheap == NULL) {
1408                 free(block);
1409                 return(NULL);
1410         }
1411
1412         thisheap->block = block;
1413         strcpy(thisheap->file, file);
1414         thisheap->line = line;
1415
1416         begin_critical_section(S_DEBUGMEMLEAKS);
1417         thisheap->next = igheap;
1418         igheap = thisheap;
1419         end_critical_section(S_DEBUGMEMLEAKS);
1420
1421         return(block);
1422 }
1423
1424
1425 void *tracked_realloc(void *ptr, size_t size, char *file, int line) {
1426         struct igheap *thisheap;
1427         void *block;
1428
1429         block = realloc(ptr, size);
1430         if (block == NULL) return(block);
1431
1432         thisheap = malloc(sizeof(struct igheap));
1433         if (thisheap == NULL) {
1434                 free(block);
1435                 return(NULL);
1436         }
1437
1438         thisheap->block = block;
1439         strcpy(thisheap->file, file);
1440         thisheap->line = line;
1441
1442         begin_critical_section(S_DEBUGMEMLEAKS);
1443         thisheap->next = igheap;
1444         igheap = thisheap;
1445         end_critical_section(S_DEBUGMEMLEAKS);
1446
1447         return(block);
1448 }
1449
1450
1451
1452 void tracked_free(void *ptr) {
1453         struct igheap *thisheap;
1454         struct igheap *trash;
1455
1456         free(ptr);
1457
1458         if (igheap == NULL) return;
1459         begin_critical_section(S_DEBUGMEMLEAKS);
1460         for (thisheap = igheap; thisheap != NULL; thisheap = thisheap->next) {
1461                 if (thisheap->next != NULL) {
1462                         if (thisheap->next->block == ptr) {
1463                                 trash = thisheap->next;
1464                                 thisheap->next = thisheap->next->next;
1465                                 free(trash);
1466                         }
1467                 }
1468         }
1469         if (igheap->block == ptr) {
1470                 trash = igheap;
1471                 igheap = igheap->next;
1472                 free(trash);
1473         }
1474         end_critical_section(S_DEBUGMEMLEAKS);
1475 }
1476
1477 char *tracked_strdup(const char *s, char *file, int line) {
1478         char *ptr;
1479
1480         if (s == NULL) return(NULL);
1481         ptr = tracked_malloc(strlen(s) + 1, file, line);
1482         if (ptr == NULL) return(NULL);
1483         strncpy(ptr, s, strlen(s));
1484         return(ptr);
1485 }
1486
1487 void dump_heap(void) {
1488         struct igheap *thisheap;
1489
1490         for (thisheap = igheap; thisheap != NULL; thisheap = thisheap->next) {
1491                 CtdlLogPrintf(CTDL_CRIT, "UNFREED: %30s : %d\n",
1492                         thisheap->file, thisheap->line);
1493         }
1494 }
1495
1496 #endif /*  DEBUG_MEMORY_LEAKS */