2 * Thread handling stuff for Citadel server
4 * Copyright (c) 1987-2011 by the citadel.org team
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.
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.
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
24 #include <sys/types.h>
26 #include <sys/socket.h>
33 #if TIME_WITH_SYS_TIME
34 # include <sys/time.h>
38 # include <sys/time.h>
47 # if HAVE_SYS_SYSCALL_H
48 # include <sys/syscall.h>
52 #include <libcitadel.h>
55 #include "ctdl_module.h"
56 #include "modules_init.h"
57 #include "housekeeping.h"
59 #include "citserver.h"
60 #include "sysdep_decls.h"
62 #include "event_client.h"
65 int num_workers = 0; /* Current number of worker threads */
66 int active_workers = 0; /* Number of ACTIVE worker threads */
67 pthread_key_t ThreadKey;
68 pthread_mutex_t Critters[MAX_SEMAPHORES]; /* Things needing locking */
69 struct thread_tsd masterTSD;
70 int server_shutting_down = 0; /* set to nonzero during shutdown */
74 void InitializeSemaphores(void)
78 /* Set up a bunch of semaphores to be used for critical sections */
79 for (i=0; i<MAX_SEMAPHORES; ++i) {
80 pthread_mutex_init(&Critters[i], NULL);
88 * Obtain a semaphore lock to begin a critical section.
89 * but only if no one else has one
91 int try_critical_section(int which_one)
93 /* For all types of critical sections except those listed here,
94 * ensure nobody ever tries to do a critical section within a
95 * transaction; this could lead to deadlock.
97 if ( (which_one != S_FLOORCACHE)
98 && (which_one != S_RPLIST)
102 return (pthread_mutex_trylock(&Critters[which_one]));
107 * Obtain a semaphore lock to begin a critical section.
109 void begin_critical_section(int which_one)
111 /* For all types of critical sections except those listed here,
112 * ensure nobody ever tries to do a critical section within a
113 * transaction; this could lead to deadlock.
115 if ( (which_one != S_FLOORCACHE)
116 && (which_one != S_RPLIST)
120 pthread_mutex_lock(&Critters[which_one]);
124 * Release a semaphore lock to end a critical section.
126 void end_critical_section(int which_one)
128 pthread_mutex_unlock(&Critters[which_one]);
135 * Return a pointer to our thread-specific (not session-specific) data.
137 struct thread_tsd *MyThread(void) {
138 register struct thread_tsd *c;
139 return ((c = (struct thread_tsd *) pthread_getspecific(ThreadKey), c == NULL) ? &masterTSD : c);
145 * Called by CtdlThreadCreate()
146 * We have to pass through here before starting our thread in order to create a set of data
147 * that is thread-specific rather than session-specific.
149 void *CTC_backend(void *supplied_start_routine)
151 struct thread_tsd *mytsd;
152 void *(*start_routine)(void*) = supplied_start_routine;
154 mytsd = (struct thread_tsd *) malloc(sizeof(struct thread_tsd));
155 memset(mytsd, 0, sizeof(struct thread_tsd));
156 pthread_setspecific(ThreadKey, (const void *) mytsd);
166 * Function to create a thread.
168 void CtdlThreadCreate(void *(*start_routine)(void*))
175 ret = pthread_attr_init(&attr);
176 ret = pthread_attr_setstacksize(&attr, THREADSTACKSIZE);
177 ret = pthread_create(&thread, &attr, CTC_backend, (void *)start_routine);
178 if (ret != 0) syslog(LOG_EMERG, "pthread_create() : %s", strerror(errno));
182 void InitializeMasterTSD(void) {
183 memset(&masterTSD, 0, sizeof(struct thread_tsd));
186 extern void ShutDownEventQueues(void);
188 int EventQShuttingDown = 0;
191 * Initialize the thread system
193 void go_threading(void)
195 if (pthread_key_create(&ThreadKey, NULL) != 0) {
196 syslog(LOG_EMERG, "pthread_key_create() : %s", strerror(errno));
200 /* Second call to module init functions now that threading is up */
201 initialise_modules(1);
203 /* Begin with one worker thread. We will expand the pool if necessary */
204 CtdlThreadCreate(worker_thread);
206 /* The supervisor thread monitors worker threads and spawns more of them if it finds that
207 * they are all in use. FIXME make the 256 max threads a configurable value.
209 while (!server_shutting_down) {
210 if ((active_workers == num_workers) && (num_workers < 256)) {
211 CtdlThreadCreate(worker_thread);
216 /* When we get to this point we are getting ready to shut down our Citadel server */
217 if (!EventQShuttingDown)
219 EventQShuttingDown = 1;
220 ShutDownEventQueues();
226 terminate_all_sessions(); /* close all client sockets */
227 CtdlShutdownServiceHooks(); /* close all listener sockets to prevent new connections */
228 PerformSessionHooks(EVT_SHUTDOWN); /* run any registered shutdown hooks */
231 while ( (num_workers > 0) && (countdown-- > 0)) {
232 syslog(LOG_DEBUG, "Waiting %d seconds for %d worker threads to exit",
233 countdown, num_workers