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         setsockopt(CC->client_socket, IPPROTO_TCP, TCP_CORK, &on, 4);
 570 #endif
 571 }
 572
 573 void unbuffer_output(void) {
 574 #ifdef HAVE_TCP_BUFFERING
 575         setsockopt(CC->client_socket, IPPROTO_TCP, TCP_CORK, &off, 4);
 576 #endif
 577 }
 578
 579 void flush_output(void) {
 580 #ifdef HAVE_TCP_BUFFERING
 581         struct CitContext *CCC = CC;
 582         setsockopt(CCC->client_socket, IPPROTO_TCP, TCP_CORK, &off, 4);
 583         setsockopt(CCC->client_socket, IPPROTO_TCP, TCP_CORK, &on, 4);
 584 #endif
 585 }
 586
 587
 588
 589 /*
 590  * client_write()   ...    Send binary data to the client.
 591  */
 592 int client_write(char *buf, int nbytes)
 593 {
 594         int bytes_written = 0;
 595         int retval;
 596 #ifndef HAVE_TCP_BUFFERING
 597         int old_buffer_len = 0;
 598 #endif
 599         fd_set wset;
 600         t_context *Ctx;
 601         int fdflags;
 602
 603         Ctx = CC;
 604         if (Ctx->redirect_buffer != NULL) {
 605                 if ((Ctx->redirect_len + nbytes + 2) >= Ctx->redirect_alloc) {
 606                         Ctx->redirect_alloc = (Ctx->redirect_alloc * 2) + nbytes;
 607                         Ctx->redirect_buffer = realloc(Ctx->redirect_buffer,
 608                                                 Ctx->redirect_alloc);
 609                 }
 610                 memcpy(&Ctx->redirect_buffer[Ctx->redirect_len], buf, nbytes);
 611                 Ctx->redirect_len += nbytes;
 612                 Ctx->redirect_buffer[Ctx->redirect_len] = 0;
 613                 return 0;
 614         }
 615
 616 #ifdef HAVE_OPENSSL
 617         if (Ctx->redirect_ssl) {
 618                 client_write_ssl(buf, nbytes);
 619                 return 0;
 620         }
 621 #endif
 622
 623         fdflags = fcntl(Ctx->client_socket, F_GETFL);
 624
 625         while (bytes_written < nbytes) {
 626                 if ((fdflags & O_NONBLOCK) == O_NONBLOCK) {
 627                         FD_ZERO(&wset);
 628                         FD_SET(Ctx->client_socket, &wset);
 629                         if (select(1, NULL, &wset, NULL, NULL) == -1) {
 630                                 CtdlLogPrintf(CTDL_ERR,
 631                                         "client_write(%d bytes) select failed: %s (%d)\n",
 632                                         nbytes - bytes_written,
 633                                         strerror(errno), errno);
 634                                 cit_backtrace();
 635                                 Ctx->kill_me = 1;
 636                                 return -1;
 637                         }
 638                 }
 639
 640                 retval = write(Ctx->client_socket, &buf[bytes_written],
 641                         nbytes - bytes_written);
 642                 if (retval < 1) {
 643                         CtdlLogPrintf(CTDL_ERR,
 644                                 "client_write(%d bytes) failed: %s (%d)\n",
 645                                 nbytes - bytes_written,
 646                                 strerror(errno), errno);
 647                         cit_backtrace();
 648                         // CtdlLogPrintf(CTDL_DEBUG, "Tried to send: %s",  &buf[bytes_written]);
 649                         Ctx->kill_me = 1;
 650                         return -1;
 651                 }
 652                 bytes_written = bytes_written + retval;
 653         }
 654         return 0;
 655 }
 656
 657
 658 /*
 659  * cprintf()    Send formatted printable data to the client.
 660  *              Implemented in terms of client_write() so it's technically not sysdep...
 661  */
 662 void cprintf(const char *format, ...) {
 663         va_list arg_ptr;
 664         char buf[1024];
 665
 666         va_start(arg_ptr, format);
 667         if (vsnprintf(buf, sizeof buf, format, arg_ptr) == -1)
 668                 buf[sizeof buf - 2] = '\n';
 669         client_write(buf, strlen(buf));
 670         va_end(arg_ptr);
 671 }
 672
 673
 674 /*
 675  * Read data from the client socket.
 676  * Return values are:
 677  *      1       Requested number of bytes has been read.
 678  *      0       Request timed out.
 679  *      -1      The socket is broken.
 680  * If the socket breaks, the session will be terminated.
 681  */
 682 int client_read_to(char *buf, int bytes, int timeout)
 683 {
 684         int len,rlen;
 685         fd_set rfds;
 686         int fd;
 687         struct timeval tv;
 688         int retval;
 689
 690 #ifdef HAVE_OPENSSL
 691         if (CC->redirect_ssl) {
 692                 return (client_read_ssl(buf, bytes, timeout));
 693         }
 694 #endif
 695         len = 0;
 696         fd = CC->client_socket;
 697         while(len<bytes) {
 698                 FD_ZERO(&rfds);
 699                 FD_SET(fd, &rfds);
 700                 tv.tv_sec = timeout;
 701                 tv.tv_usec = 0;
 702
 703                 retval = select( (fd)+1,
 704                                  &rfds, NULL, NULL, &tv);
 705                 if (retval < 0)
 706                 {
 707                         if (errno == EINTR)
 708                         {
 709                                 CtdlLogPrintf(CTDL_DEBUG, "Interrupted select().\n");
 710                                 CC->kill_me = 1;
 711                                 return (-1);
 712                         }
 713                 }
 714
 715                 if (FD_ISSET(fd, &rfds) == 0) {
 716                         return(0);
 717                 }
 718
 719                 rlen = read(fd, &buf[len], bytes-len);
 720                 if (rlen<1) {
 721                         /* The socket has been disconnected! */
 722                         CC->kill_me = 1;
 723                         return(-1);
 724                 }
 725                 len = len + rlen;
 726         }
 727         return(1);
 728 }
 729
 730 /*
 731  * Read data from the client socket with default timeout.
 732  * (This is implemented in terms of client_read_to() and could be
 733  * justifiably moved out of sysdep.c)
 734  */
 735 INLINE int client_read(char *buf, int bytes)
 736 {
 737         return(client_read_to(buf, bytes, config.c_sleeping));
 738 }
 739
 740
 741 /*
 742  * client_getln()   ...   Get a LF-terminated line of text from the client.
 743  * (This is implemented in terms of client_read() and could be
 744  * justifiably moved out of sysdep.c)
 745  */
 746 int client_getln(char *buf, int bufsize)
 747 {
 748         int i, retval;
 749
 750         /* Read one character at a time.
 751          */
 752         for (i = 0;;i++) {
 753                 retval = client_read(&buf[i], 1);
 754                 if (retval != 1 || buf[i] == '\n' || i == (bufsize-1))
 755                         break;
 756         }
 757
 758         /* If we got a long line, discard characters until the newline.
 759          */
 760         if (i == (bufsize-1))
 761                 while (buf[i] != '\n' && retval == 1)
 762                         retval = client_read(&buf[i], 1);
 763
 764         /* Strip the trailing LF, and the trailing CR if present.
 765          */
 766         buf[i] = 0;
 767         while ( (i > 0)
 768                 && ( (buf[i - 1]==13)
 769                      || ( buf[i - 1]==10)) ) {
 770                 i--;
 771                 buf[i] = 0;
 772         }
 773         if (retval < 0) safestrncpy(&buf[i], "000", bufsize - i);
 774         return(retval);
 775 }
 776
 777
 778 /*
 779  * Cleanup any contexts that are left lying around
 780  */
 781 void context_cleanup(void)
 782 {
 783         struct CitContext *ptr = NULL;
 784         struct CitContext *rem = NULL;
 785
 786         /*
 787          * Clean up the contexts.
 788          * There are no threads so no critical_section stuff is needed.
 789          */
 790         ptr = ContextList;
 791
 792         /* We need to update the ContextList because some modules may want to itterate it
 793          * Question is should we NULL it before iterating here or should we just keep updating it
 794          * as we remove items?
 795          *
 796          * Answer is to NULL it first to prevent modules from doing any actions on the list at all
 797          */
 798         ContextList=NULL;
 799         while (ptr != NULL){
 800                 /* Remove the session from the active list */
 801                 rem = ptr->next;
 802                 --num_sessions;
 803
 804                 CtdlLogPrintf(CTDL_DEBUG, "Purging session %d\n", ptr->cs_pid);
 805                 RemoveContext(ptr);
 806                 free (ptr);
 807                 ptr = rem;
 808         }
 809 }
 810
 811
 812
 813 void close_masters (void)
 814 {
 815         struct ServiceFunctionHook *serviceptr;
 816
 817         /*
 818          * close all protocol master sockets
 819          */
 820         for (serviceptr = ServiceHookTable; serviceptr != NULL;
 821             serviceptr = serviceptr->next ) {
 822
 823                 if (serviceptr->tcp_port > 0)
 824                 {
 825                         CtdlLogPrintf(CTDL_INFO, "Closing listener on port %d\n",
 826                                 serviceptr->tcp_port);
 827                         serviceptr->tcp_port = 0;
 828                 }
 829
 830                 if (serviceptr->sockpath != NULL)
 831                         CtdlLogPrintf(CTDL_INFO, "Closing listener on '%s'\n",
 832                                 serviceptr->sockpath);
 833
 834                 close(serviceptr->msock);
 835                 /* If it's a Unix domain socket, remove the file. */
 836                 if (serviceptr->sockpath != NULL) {
 837                         unlink(serviceptr->sockpath);
 838                         serviceptr->sockpath = NULL;
 839                 }
 840         }
 841 }
 842
 843
 844 /*
 845  * The system-dependent part of master_cleanup() - close the master socket.
 846  */
 847 void sysdep_master_cleanup(void) {
 848
 849         close_masters();
 850
 851         context_cleanup();
 852
 853 #ifdef HAVE_OPENSSL
 854         destruct_ssl();
 855 #endif
 856         CtdlDestroyProtoHooks();
 857         CtdlDestroyDeleteHooks();
 858         CtdlDestroyXmsgHooks();
 859         CtdlDestroyNetprocHooks();
 860         CtdlDestroyUserHooks();
 861         CtdlDestroyMessageHook();
 862         CtdlDestroyCleanupHooks();
 863         CtdlDestroyFixedOutputHooks();
 864         CtdlDestroySessionHooks();
 865         CtdlDestroyServiceHook();
 866         CtdlDestroyRoomHooks();
 867         CtdlDestroyDirectoryServiceFuncs();
 868         #ifdef HAVE_BACKTRACE
 869         eCrash_Uninit();
 870         #endif
 871 }
 872
 873
 874
 875 /*
 876  * Terminate another session.
 877  * (This could justifiably be moved out of sysdep.c because it
 878  * no longer does anything that is system-dependent.)
 879  */
 880 void kill_session(int session_to_kill) {
 881         struct CitContext *ptr;
 882
 883         begin_critical_section(S_SESSION_TABLE);
 884         for (ptr = ContextList; ptr != NULL; ptr = ptr->next) {
 885                 if (ptr->cs_pid == session_to_kill) {
 886                         ptr->kill_me = 1;
 887                 }
 888         }
 889         end_critical_section(S_SESSION_TABLE);
 890 }
 891
 892 pid_t current_child;
 893 void graceful_shutdown(int signum) {
 894         kill(current_child, signum);
 895         unlink(file_pid_file);
 896         exit(0);
 897 }
 898
 899
 900 /*
 901  * Start running as a daemon.
 902  */
 903 void start_daemon(int unused) {
 904         int status = 0;
 905         pid_t child = 0;
 906         FILE *fp;
 907         int do_restart = 0;
 908
 909         current_child = 0;
 910
 911         /* Close stdin/stdout/stderr and replace them with /dev/null.
 912          * We don't just call close() because we don't want these fd's
 913          * to be reused for other files.
 914          */
 915         chdir(ctdl_run_dir);
 916
 917         child = fork();
 918         if (child != 0) {
 919                 exit(0);
 920         }
 921
 922         signal(SIGHUP, SIG_IGN);
 923         signal(SIGINT, SIG_IGN);
 924         signal(SIGQUIT, SIG_IGN);
 925
 926         setsid();
 927         umask(0);
 928         freopen("/dev/null", "r", stdin);
 929         freopen("/dev/null", "w", stdout);
 930         freopen("/dev/null", "w", stderr);
 931
 932         do {
 933                 current_child = fork();
 934
 935                 signal(SIGTERM, graceful_shutdown);
 936
 937                 if (current_child < 0) {
 938                         perror("fork");
 939                         exit(errno);
 940                 }
 941
 942                 else if (current_child == 0) {
 943                         return; /* continue starting citadel. */
 944                 }
 945
 946                 else {
 947                         fp = fopen(file_pid_file, "w");
 948                         if (fp != NULL) {
 949                                 fprintf(fp, ""F_PID_T"\n", getpid());
 950                                 fclose(fp);
 951                         }
 952                         waitpid(current_child, &status, 0);
 953                 }
 954
 955                 do_restart = 0;
 956
 957                 /* Did the main process exit with an actual exit code? */
 958                 if (WIFEXITED(status)) {
 959
 960                         /* Exit code 0 means the watcher should exit */
 961                         if (WEXITSTATUS(status) == 0) {
 962                                 do_restart = 0;
 963                         }
 964
 965                         /* Exit code 101-109 means the watcher should exit */
 966                         else if ( (WEXITSTATUS(status) >= 101) && (WEXITSTATUS(status) <= 109) ) {
 967                                 do_restart = 0;
 968                         }
 969
 970                         /* Any other exit code means we should restart. */
 971                         else {
 972                                 do_restart = 1;
 973                         }
 974                 }
 975
 976                 /* Any other type of termination (signals, etc.) should also restart. */
 977                 else {
 978                         do_restart = 1;
 979                 }
 980
 981         } while (do_restart);
 982
 983         unlink(file_pid_file);
 984         exit(WEXITSTATUS(status));
 985 }
 986
 987
 988
 989 /*
 990  * Generic routine to convert a login name to a full name (gecos)
 991  * Returns nonzero if a conversion took place
 992  */
 993 int convert_login(char NameToConvert[]) {
 994         struct passwd *pw;
 995         int a;
 996
 997         pw = getpwnam(NameToConvert);
 998         if (pw == NULL) {
 999                 return(0);
1000         }
1001         else {
1002                 strcpy(NameToConvert, pw->pw_gecos);
1003                 for (a=0; a<strlen(NameToConvert); ++a) {
1004                         if (NameToConvert[a] == ',') NameToConvert[a] = 0;
1005                 }
1006                 return(1);
1007         }
1008 }
1009
1010 /*
1011  * Purge all sessions which have the 'kill_me' flag set.
1012  * This function has code to prevent it from running more than once every
1013  * few seconds, because running it after every single unbind would waste a lot
1014  * of CPU time and keep the context list locked too much.  To force it to run
1015  * anyway, set "force" to nonzero.
1016  */
1017 void dead_session_purge(int force) {
1018         struct CitContext *ptr, *ptr2;          /* general-purpose utility pointer */
1019         struct CitContext *rem = NULL;  /* list of sessions to be destroyed */
1020
1021         if (force == 0) {
1022                 if ( (time(NULL) - last_purge) < 5 ) {
1023                         return; /* Too soon, go away */
1024                 }
1025         }
1026         time(&last_purge);
1027
1028         if (try_critical_section(S_SESSION_TABLE))
1029                 return;
1030
1031         ptr = ContextList;
1032         while (ptr) {
1033                 ptr2 = ptr;
1034                 ptr = ptr->next;
1035
1036                 if ( (ptr2->state == CON_IDLE) && (ptr2->kill_me) ) {
1037                         /* Remove the session from the active list */
1038                         if (ptr2->prev) {
1039                                 ptr2->prev->next = ptr2->next;
1040                         }
1041                         else {
1042                                 ContextList = ptr2->next;
1043                         }
1044                         if (ptr2->next) {
1045                                 ptr2->next->prev = ptr2->prev;
1046                         }
1047
1048                         --num_sessions;
1049                         /* And put it on our to-be-destroyed list */
1050                         ptr2->next = rem;
1051                         rem = ptr2;
1052                 }
1053         }
1054         end_critical_section(S_SESSION_TABLE);
1055
1056         /* Now that we no longer have the session list locked, we can take
1057          * our time and destroy any sessions on the to-be-killed list, which
1058          * is allocated privately on this thread's stack.
1059          */
1060         while (rem != NULL) {
1061                 CtdlLogPrintf(CTDL_DEBUG, "Purging session %d\n", rem->cs_pid);
1062                 RemoveContext(rem);
1063                 ptr = rem;
1064                 rem = rem->next;
1065                 free(ptr);
1066         }
1067 }
1068
1069
1070
1071
1072
1073 /*
1074  * masterCC is the context we use when not attached to a session.  This
1075  * function initializes it.
1076  */
1077 void InitializeMasterCC(void) {
1078         memset(&masterCC, 0, sizeof(struct CitContext));
1079         masterCC.internal_pgm = 1;
1080         masterCC.cs_pid = 0;
1081 }
1082
1083
1084
1085
1086 /*
1087  * Bind a thread to a context.  (It's inline merely to speed things up.)
1088  */
1089 INLINE void become_session(struct CitContext *which_con) {
1090         citthread_setspecific(MyConKey, (void *)which_con );
1091 }
1092
1093
1094
1095 /*
1096  * This loop just keeps going and going and going...
1097  */
1098 /*
1099  * FIXME:
1100  * This current implimentation of worker_thread creates a bottle neck in several situations
1101  * The first thing to remember is that a single thread can handle more than one connection at a time.
1102  * More threads mean less memory for the system to run in.
1103  * So for efficiency we want every thread to be doing something useful or waiting in the main loop for
1104  * something to happen anywhere.
1105  * This current implimentation requires worker threads to wait in other locations, after it has
1106  * been committed to a single connection which is very wasteful.
1107  * As an extreme case consider this:
1108  * A slow client connects and this slow client sends only one character each second.
1109  * With this current implimentation a single worker thread is dispatched to handle that connection
1110  * until such times as the client timeout expires, an error occurs on the socket or the client
1111  * completes its transmission.
1112  * THIS IS VERY BAD since that thread could have handled a read from many more clients in each one
1113  * second interval between chars.
1114  *
1115  * It is my intention to re-write this code and the associated client_getln, client_read functions
1116  * to allow any thread to read data on behalf of any connection (context).
1117  * To do this I intend to have this main loop read chars into a buffer stored in the context.
1118  * Once the correct criteria for a full buffer is met then we will dispatch a thread to
1119  * process it.
1120  * This worker thread loop also needs to be able to handle binary data.
1121  */
1122
1123 void *worker_thread(void *arg) {
1124         int i;
1125         int highest;
1126         struct CitContext *ptr;
1127         struct CitContext *bind_me = NULL;
1128         fd_set readfds;
1129         int retval = 0;
1130         struct CitContext *con= NULL;   /* Temporary context pointer */
1131         struct ServiceFunctionHook *serviceptr;
1132         int ssock;                      /* Descriptor for client socket */
1133         struct timeval tv;
1134         int force_purge = 0;
1135         int m;
1136
1137
1138         while (!CtdlThreadCheckStop()) {
1139
1140                 /* make doubly sure we're not holding any stale db handles
1141                  * which might cause a deadlock.
1142                  */
1143                 cdb_check_handles();
1144 do_select:      force_purge = 0;
1145                 bind_me = NULL;         /* Which session shall we handle? */
1146
1147                 /* Initialize the fdset. */
1148                 FD_ZERO(&readfds);
1149                 highest = 0;
1150
1151                 begin_critical_section(S_SESSION_TABLE);
1152                 for (ptr = ContextList; ptr != NULL; ptr = ptr->next) {
1153                         if (ptr->state == CON_IDLE) {
1154                                 FD_SET(ptr->client_socket, &readfds);
1155                                 if (ptr->client_socket > highest)
1156                                         highest = ptr->client_socket;
1157                         }
1158                         if ((bind_me == NULL) && (ptr->state == CON_READY)) {
1159                                 bind_me = ptr;
1160                                 ptr->state = CON_EXECUTING;
1161                         }
1162                 }
1163                 end_critical_section(S_SESSION_TABLE);
1164
1165                 if (bind_me) {
1166                         goto SKIP_SELECT;
1167                 }
1168
1169                 /* If we got this far, it means that there are no sessions
1170                  * which a previous thread marked for attention, so we go
1171                  * ahead and get ready to select().
1172                  */
1173
1174                 /* First, add the various master sockets to the fdset. */
1175                 for (serviceptr = ServiceHookTable; serviceptr != NULL;
1176                 serviceptr = serviceptr->next ) {
1177                         m = serviceptr->msock;
1178                         FD_SET(m, &readfds);
1179                         if (m > highest) {
1180                                 highest = m;
1181                         }
1182                 }
1183
1184                 if (!CtdlThreadCheckStop()) {
1185                         tv.tv_sec = 1;          /* wake up every second if no input */
1186                         tv.tv_usec = 0;
1187                         retval = CtdlThreadSelect(highest + 1, &readfds, NULL, NULL, &tv);
1188                 }
1189                 else
1190                         return NULL;
1191
1192                 /* Now figure out who made this select() unblock.
1193                  * First, check for an error or exit condition.
1194                  */
1195                 if (retval < 0) {
1196                         if (errno == EBADF) {
1197                                 CtdlLogPrintf(CTDL_NOTICE, "select() failed: (%s)\n",
1198                                         strerror(errno));
1199                                 goto do_select;
1200                         }
1201                         if (errno != EINTR) {
1202                                 CtdlLogPrintf(CTDL_EMERG, "Exiting (%s)\n", strerror(errno));
1203                                 CtdlThreadStopAll();
1204                         } else {
1205                                 CtdlLogPrintf(CTDL_DEBUG, "Interrupted CtdlThreadSelect.\n");
1206                                 if (CtdlThreadCheckStop()) return(NULL);
1207                                 goto do_select;
1208                         }
1209                 }
1210                 else if(retval == 0) {
1211                         if (CtdlThreadCheckStop()) return(NULL);
1212                         goto SKIP_SELECT;
1213                 }
1214                 /* Next, check to see if it's a new client connecting
1215                  * on a master socket.
1216                  */
1217                 else for (serviceptr = ServiceHookTable; serviceptr != NULL;
1218                      serviceptr = serviceptr->next ) {
1219
1220                         if (FD_ISSET(serviceptr->msock, &readfds)) {
1221                                 ssock = accept(serviceptr->msock, NULL, 0);
1222                                 if (ssock >= 0) {
1223                                         CtdlLogPrintf(CTDL_DEBUG,
1224                                                 "New client socket %d\n",
1225                                                 ssock);
1226
1227                                         /* The master socket is non-blocking but the client
1228                                          * sockets need to be blocking, otherwise certain
1229                                          * operations barf on FreeBSD.  Not a fatal error.
1230                                          */
1231                                         if (fcntl(ssock, F_SETFL, 0) < 0) {
1232                                                 CtdlLogPrintf(CTDL_EMERG,
1233                                                         "citserver: Can't set socket to blocking: %s\n",
1234                                                         strerror(errno));
1235                                         }
1236
1237                                         /* New context will be created already
1238                                          * set up in the CON_EXECUTING state.
1239                                          */
1240                                         con = CreateNewContext();
1241
1242                                         /* Assign our new socket number to it. */
1243                                         con->client_socket = ssock;
1244                                         con->h_command_function =
1245                                                 serviceptr->h_command_function;
1246                                         con->h_async_function =
1247                                                 serviceptr->h_async_function;
1248                                         con->ServiceName =
1249                                                 serviceptr->ServiceName;
1250
1251                                         /* Determine whether it's a local socket */
1252                                         if (serviceptr->sockpath != NULL)
1253                                                 con->is_local_socket = 1;
1254
1255                                         /* Set the SO_REUSEADDR socket option */
1256                                         i = 1;
1257                                         setsockopt(ssock, SOL_SOCKET,
1258                                                 SO_REUSEADDR,
1259                                                 &i, sizeof(i));
1260
1261                                         become_session(con);
1262                                         begin_session(con);
1263                                         serviceptr->h_greeting_function();
1264                                         become_session(NULL);
1265                                         con->state = CON_IDLE;
1266                                         goto do_select;
1267                                 }
1268                         }
1269                 }
1270
1271                 /* It must be a client socket.  Find a context that has data
1272                  * waiting on its socket *and* is in the CON_IDLE state.  Any
1273                  * active sockets other than our chosen one are marked as
1274                  * CON_READY so the next thread that comes around can just bind
1275                  * to one without having to select() again.
1276                  */
1277                 begin_critical_section(S_SESSION_TABLE);
1278                 for (ptr = ContextList; ptr != NULL; ptr = ptr->next) {
1279                         if ( (FD_ISSET(ptr->client_socket, &readfds))
1280                            && (ptr->state != CON_EXECUTING) ) {
1281                                 ptr->input_waiting = 1;
1282                                 if (!bind_me) {
1283                                         bind_me = ptr;  /* I choose you! */
1284                                         bind_me->state = CON_EXECUTING;
1285                                 }
1286                                 else {
1287                                         ptr->state = CON_READY;
1288                                 }
1289                         }
1290                 }
1291                 end_critical_section(S_SESSION_TABLE);
1292
1293 SKIP_SELECT:
1294                 /* We're bound to a session */
1295                 if (bind_me != NULL) {
1296                         become_session(bind_me);
1297
1298                         /* If the client has sent a command, execute it. */
1299                         if (CC->input_waiting) {
1300                                 CC->h_command_function();
1301                                 CC->input_waiting = 0;
1302                         }
1303
1304                         /* If there are asynchronous messages waiting and the
1305                          * client supports it, do those now */
1306                         if ((CC->is_async) && (CC->async_waiting)
1307                            && (CC->h_async_function != NULL)) {
1308                                 CC->h_async_function();
1309                                 CC->async_waiting = 0;
1310                         }
1311
1312                         force_purge = CC->kill_me;
1313                         become_session(NULL);
1314                         bind_me->state = CON_IDLE;
1315                 }
1316
1317                 dead_session_purge(force_purge);
1318                 do_housekeeping();
1319         }
1320         /* If control reaches this point, the server is shutting down */
1321         return(NULL);
1322 }
1323
1324
1325
1326
1327 /*
1328  * SyslogFacility()
1329  * Translate text facility name to syslog.h defined value.
1330  */
1331 int SyslogFacility(char *name)
1332 {
1333         int i;
1334         struct
1335         {
1336                 int facility;
1337                 char *name;
1338         }   facTbl[] =
1339         {
1340                 {   LOG_KERN,   "kern"          },
1341                 {   LOG_USER,   "user"          },
1342                 {   LOG_MAIL,   "mail"          },
1343                 {   LOG_DAEMON, "daemon"        },
1344                 {   LOG_AUTH,   "auth"          },
1345                 {   LOG_SYSLOG, "syslog"        },
1346                 {   LOG_LPR,    "lpr"           },
1347                 {   LOG_NEWS,   "news"          },
1348                 {   LOG_UUCP,   "uucp"          },
1349                 {   LOG_LOCAL0, "local0"        },
1350                 {   LOG_LOCAL1, "local1"        },
1351                 {   LOG_LOCAL2, "local2"        },
1352                 {   LOG_LOCAL3, "local3"        },
1353                 {   LOG_LOCAL4, "local4"        },
1354                 {   LOG_LOCAL5, "local5"        },
1355                 {   LOG_LOCAL6, "local6"        },
1356                 {   LOG_LOCAL7, "local7"        },
1357                 {   0,            NULL          }
1358         };
1359         for(i = 0; facTbl[i].name != NULL; i++) {
1360                 if(!strcasecmp(name, facTbl[i].name))
1361                         return facTbl[i].facility;
1362         }
1363         enable_syslog = 0;
1364         return LOG_DAEMON;
1365 }
1366
1367
1368 /********** MEM CHEQQER ***********/
1369
1370 #ifdef DEBUG_MEMORY_LEAKS
1371
1372 #undef malloc
1373 #undef realloc
1374 #undef strdup
1375 #undef free
1376
1377 void *tracked_malloc(size_t size, char *file, int line) {
1378         struct igheap *thisheap;
1379         void *block;
1380
1381         block = malloc(size);
1382         if (block == NULL) return(block);
1383
1384         thisheap = malloc(sizeof(struct igheap));
1385         if (thisheap == NULL) {
1386                 free(block);
1387                 return(NULL);
1388         }
1389
1390         thisheap->block = block;
1391         strcpy(thisheap->file, file);
1392         thisheap->line = line;
1393
1394         begin_critical_section(S_DEBUGMEMLEAKS);
1395         thisheap->next = igheap;
1396         igheap = thisheap;
1397         end_critical_section(S_DEBUGMEMLEAKS);
1398
1399         return(block);
1400 }
1401
1402
1403 void *tracked_realloc(void *ptr, size_t size, char *file, int line) {
1404         struct igheap *thisheap;
1405         void *block;
1406
1407         block = realloc(ptr, size);
1408         if (block == NULL) return(block);
1409
1410         thisheap = malloc(sizeof(struct igheap));
1411         if (thisheap == NULL) {
1412                 free(block);
1413                 return(NULL);
1414         }
1415
1416         thisheap->block = block;
1417         strcpy(thisheap->file, file);
1418         thisheap->line = line;
1419
1420         begin_critical_section(S_DEBUGMEMLEAKS);
1421         thisheap->next = igheap;
1422         igheap = thisheap;
1423         end_critical_section(S_DEBUGMEMLEAKS);
1424
1425         return(block);
1426 }
1427
1428
1429
1430 void tracked_free(void *ptr) {
1431         struct igheap *thisheap;
1432         struct igheap *trash;
1433
1434         free(ptr);
1435
1436         if (igheap == NULL) return;
1437         begin_critical_section(S_DEBUGMEMLEAKS);
1438         for (thisheap = igheap; thisheap != NULL; thisheap = thisheap->next) {
1439                 if (thisheap->next != NULL) {
1440                         if (thisheap->next->block == ptr) {
1441                                 trash = thisheap->next;
1442                                 thisheap->next = thisheap->next->next;
1443                                 free(trash);
1444                         }
1445                 }
1446         }
1447         if (igheap->block == ptr) {
1448                 trash = igheap;
1449                 igheap = igheap->next;
1450                 free(trash);
1451         }
1452         end_critical_section(S_DEBUGMEMLEAKS);
1453 }
1454
1455 char *tracked_strdup(const char *s, char *file, int line) {
1456         char *ptr;
1457
1458         if (s == NULL) return(NULL);
1459         ptr = tracked_malloc(strlen(s) + 1, file, line);
1460         if (ptr == NULL) return(NULL);
1461         strncpy(ptr, s, strlen(s));
1462         return(ptr);
1463 }
1464
1465 void dump_heap(void) {
1466         struct igheap *thisheap;
1467
1468         for (thisheap = igheap; thisheap != NULL; thisheap = thisheap->next) {
1469                 CtdlLogPrintf(CTDL_CRIT, "UNFREED: %30s : %d\n",
1470                         thisheap->file, thisheap->line);
1471         }
1472 }
1473
1474 #endif /*  DEBUG_MEMORY_LEAKS */