citadel/threads.c

   1 /*
   2  * Thread handling stuff for Citadel server
   3  *
   4  * Copyright (c) 1987-2011 by the citadel.org team
   5  *
   6  * This program is open source software; you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License as published by
   8  * the Free Software Foundation; either version 3 of the License, or
   9  * (at your option) any later version.
  10  *
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  * GNU General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License
  17  * along with this program; if not, write to the Free Software
  18  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
  19  */
  20
  21 #include <stdlib.h>
  22 #include <unistd.h>
  23 #include <stdio.h>
  24 #include <sys/types.h>
  25 #include <errno.h>
  26 #include <sys/socket.h>
  27 #include <unistd.h>
  28 #include <fcntl.h>
  29 #include <signal.h>
  30 #include <syslog.h>
  31
  32 #include "sysdep.h"
  33 #if TIME_WITH_SYS_TIME
  34 # include <sys/time.h>
  35 # include <time.h>
  36 #else
  37 # if HAVE_SYS_TIME_H
  38 #  include <sys/time.h>
  39 # else
  40 #  include <time.h>
  41 # endif
  42 #endif
  43
  44 #ifdef HAVE_SYSCALL_H
  45 # include <syscall.h>
  46 #else
  47 # if HAVE_SYS_SYSCALL_H
  48 #  include <sys/syscall.h>
  49 # endif
  50 #endif
  51
  52 #include <libcitadel.h>
  53
  54 #include "threads.h"
  55 #include "ctdl_module.h"
  56 #include "modules_init.h"
  57 #include "housekeeping.h"
  58 #include "config.h"
  59 #include "citserver.h"
  60 #include "sysdep_decls.h"
  61 #include "context.h"
  62 #include "event_client.h"
  63
  64
  65 /*
  66  * To create a thread you must call one of the create thread functions.
  67  * You must pass it the address of (a pointer to a CtdlThreadNode initialised to NULL) like this
  68  * struct CtdlThreadNode *node = NULL;
  69  * pass in &node
  70  * If the thread is created *node will point to the thread control structure for the created thread.
  71  * If the thread creation fails *node remains NULL
  72  * Do not free the memory pointed to by *node, it doesn't belong to you.
  73  * This new interface duplicates much of the eCrash stuff. We should go for closer integration since that would
  74  * remove the need for the calls to eCrashRegisterThread and friends
  75  */
  76
  77 static int num_threads = 0;                     /* Current number of threads */
  78 pthread_key_t ThreadKey;
  79 pthread_mutex_t Critters[MAX_SEMAPHORES];       /* Things needing locking */
  80 struct thread_tsd masterTSD;
  81
  82
  83
  84 void InitializeSemaphores(void)
  85 {
  86         int i;
  87
  88         /* Set up a bunch of semaphores to be used for critical sections */
  89         for (i=0; i<MAX_SEMAPHORES; ++i) {
  90                 pthread_mutex_init(&Critters[i], NULL);
  91         }
  92 }
  93
  94
  95
  96
  97 /*
  98  * Obtain a semaphore lock to begin a critical section.
  99  * but only if no one else has one
 100  */
 101 int try_critical_section(int which_one)
 102 {
 103         /* For all types of critical sections except those listed here,
 104          * ensure nobody ever tries to do a critical section within a
 105          * transaction; this could lead to deadlock.
 106          */
 107         if (    (which_one != S_FLOORCACHE)
 108                 && (which_one != S_RPLIST)
 109         ) {
 110                 cdb_check_handles();
 111         }
 112         return (pthread_mutex_trylock(&Critters[which_one]));
 113 }
 114
 115
 116 /*
 117  * Obtain a semaphore lock to begin a critical section.
 118  */
 119 void begin_critical_section(int which_one)
 120 {
 121         /* For all types of critical sections except those listed here,
 122          * ensure nobody ever tries to do a critical section within a
 123          * transaction; this could lead to deadlock.
 124          */
 125         if (    (which_one != S_FLOORCACHE)
 126                 && (which_one != S_RPLIST)
 127         ) {
 128                 cdb_check_handles();
 129         }
 130         pthread_mutex_lock(&Critters[which_one]);
 131 }
 132
 133 /*
 134  * Release a semaphore lock to end a critical section.
 135  */
 136 void end_critical_section(int which_one)
 137 {
 138         pthread_mutex_unlock(&Critters[which_one]);
 139 }
 140
 141
 142 /*
 143  * A function to tell all threads to exit
 144  */
 145 void CtdlThreadStopAll(void)
 146 {
 147         terminate_all_sessions();               /* close all client sockets */
 148         CtdlShutdownServiceHooks();             /* close all listener sockets to prevent new connections */
 149         PerformSessionHooks(EVT_SHUTDOWN);      /* run any registered shutdown hooks */
 150 }
 151
 152
 153 /*
 154  * A function for a thread to check if it has been asked to stop
 155  */
 156 int CtdlThreadCheckStop(void)
 157 {
 158
 159         /* FIXME this needs to do something useful.  moar code pls ! */
 160
 161         return 0;
 162 }
 163
 164
 165 /*
 166  * Return a pointer to our thread-specific (not session-specific) data.
 167  */
 168 struct thread_tsd *MyThread(void) {
 169         register struct thread_tsd *c;
 170         return ((c = (struct thread_tsd *) pthread_getspecific(ThreadKey), c == NULL) ? &masterTSD : c);
 171 }
 172
 173
 174
 175 /*
 176  * Called by CtdlThreadCreate()
 177  * We have to pass through here before starting our thread in order to create a set of data
 178  * that is thread-specific rather than session-specific.
 179  */
 180 void *CTC_backend(void *supplied_start_routine)
 181 {
 182         struct thread_tsd *mytsd;
 183         void *(*start_routine)(void*) = supplied_start_routine;
 184
 185         mytsd = (struct thread_tsd *) malloc(sizeof(struct thread_tsd));
 186         memset(mytsd, 0, sizeof(struct thread_tsd));
 187         pthread_setspecific(ThreadKey, (const void *) mytsd);
 188
 189         start_routine(NULL);
 190
 191         return(NULL);
 192 }
 193
 194
 195 /*
 196  * Function to create a thread.
 197  */
 198 void CtdlThreadCreate(void *(*start_routine)(void*))
 199 {
 200         pthread_t thread;
 201         pthread_attr_t attr;
 202         int ret = 0;
 203
 204
 205         ret = pthread_attr_init(&attr);
 206         ret = pthread_attr_setstacksize(&attr, THREADSTACKSIZE);
 207         ret = pthread_create(&thread, &attr, CTC_backend, (void *)start_routine);
 208         if (ret != 0) syslog(LOG_EMERG, "pthread_create() : %s", strerror(errno));
 209
 210         ++num_threads;
 211 }
 212
 213
 214 void InitializeMasterTSD(void) {
 215         memset(&masterTSD, 0, sizeof(struct thread_tsd));
 216 }
 217
 218
 219 /*
 220  * Initialize the thread system
 221  */
 222 void go_threading(void)
 223 {
 224         if (pthread_key_create(&ThreadKey, NULL) != 0) {
 225                 syslog(LOG_EMERG, "pthread_key_create() : %s", strerror(errno));
 226                 abort();
 227         }
 228
 229         /* Second call to module init functions now that threading is up */
 230         initialise_modules(1);
 231
 232         CtdlThreadCreate(select_on_master);
 233
 234         /* FIXME temporary fixed size pool of worker threads */
 235         CtdlThreadCreate(worker_thread);
 236         CtdlThreadCreate(worker_thread);
 237         CtdlThreadCreate(worker_thread);
 238         CtdlThreadCreate(worker_thread);
 239         CtdlThreadCreate(worker_thread);
 240         CtdlThreadCreate(worker_thread);
 241         CtdlThreadCreate(worker_thread);
 242         CtdlThreadCreate(worker_thread);
 243
 244         /* At this point I am a union worker and therefore serve no useful purpose. */
 245
 246         while(!CtdlThreadCheckStop()) {
 247                 sleep(3);
 248         }
 249
 250         /* Shut down */
 251         CtdlThreadStopAll();
 252         exit(0);
 253 }