use the gnu format string checker for CtdlLogPrintf; fix associated new warnings...
[citadel.git] / citadel / threads.c
index c13a2aed52c700e216e70b1d3095e8efe2879772..0dcf4c38e8e4c255a98bc23e3cde03cf14a988f7 100644 (file)
@@ -1,11 +1,21 @@
 /*
- * $Id$
+ * Thread handling stuff for Citadel server
  *
- * Citadel "system dependent" stuff.
- * See COPYING for copyright information.
+ * Copyright (c) 1987-2010 by the citadel.org team
  *
- * Here's where we have the Citadel thread implimentation
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 3 of the License, or
+ * (at your option) any later version.
  *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  */
 
 #include <stdlib.h>
@@ -18,6 +28,7 @@
 #include <fcntl.h>
 #include <signal.h>
 
+#include "sysdep.h"
 #if TIME_WITH_SYS_TIME
 # include <sys/time.h>
 # include <time.h>
 # endif
 #endif
 
+#ifdef HAVE_SYSCALL_H
+# include <syscall.h>
+#else 
+# if HAVE_SYS_SYSCALL_H
+#  include <sys/syscall.h>
+# endif
+#endif
+
 #include <libcitadel.h>
 
 #include "threads.h"
@@ -39,6 +58,7 @@
 #include "citserver.h"
 #include "sysdep_decls.h"
 #include "context.h"
+#include "event_client.h"
 
 /*
  * define this to use the new worker_thread method of handling connections
@@ -333,10 +353,14 @@ void CtdlThreadStopAll(void)
 {
        /* First run any registered shutdown hooks.  This probably doesn't belong here. */
        PerformSessionHooks(EVT_SHUTDOWN);
-
+       
+       /* then close all tcp ports so nobody else can talk to us anymore. */
+       CtdlShutdownServiceHooks();
        //FIXME: The signalling of the condition should not be in the critical_section
        // We need to build a list of threads we are going to signal and then signal them afterwards
        
+       ShutDownEventQueue();
+
        CtdlThreadNode *this_thread;
        
        begin_critical_section(S_THREAD_LIST);
@@ -345,10 +369,9 @@ void CtdlThreadStopAll(void)
        GC_thread->state = CTDL_THREAD_STOP_REQ;
        while(this_thread)
        {
-#ifdef THREADS_USESIGNALS
                if (!citthread_equal(this_thread->tid, GC_thread->tid))
                        citthread_kill(this_thread->tid, SIGHUP);
-#endif
+
                ctdl_thread_internal_change_state (this_thread, CTDL_THREAD_STOP_REQ);
                citthread_cond_signal(&this_thread->ThreadCond);
                citthread_cond_signal(&this_thread->SleepCond);
@@ -410,16 +433,18 @@ double CtdlThreadGetWorkerAvg(void)
 
 double CtdlThreadGetLoadAvg(void)
 {
-       double load_avg[3] ;
+       double load_avg[3] = {0.0, 0.0, 0.0};
 
-       int ret;
+       int ret = 0;
        int smp_num_cpus;
 
        /* Borrowed this straight from procps */
        smp_num_cpus = sysconf(_SC_NPROCESSORS_ONLN);
        if(smp_num_cpus<1) smp_num_cpus=1; /* SPARC glibc is buggy */
 
+#ifdef HAVE_GETLOADAVG
        ret = getloadavg(load_avg, 3);
+#endif
        if (ret < 0)
                return 0;
        return load_avg[0] / smp_num_cpus;
@@ -508,13 +533,13 @@ int CtdlThreadCheckStop(void)
        
        state = CT->state;
 
-#ifdef THREADS_USESIGNALS
        if (CT->signal)
        {
                CtdlLogPrintf(CTDL_DEBUG, "Thread \"%s\" caught signal %d.\n", CT->name, CT->signal);
+               if (CT->signal == SIGHUP)
+                       CT->state = CTDL_THREAD_STOP_REQ;
                CT->signal = 0;
        }
-#endif
        if(state == CTDL_THREAD_STOP_REQ)
        {
                CT->state = CTDL_THREAD_STOPPING;
@@ -544,10 +569,10 @@ void CtdlThreadStop(CtdlThreadNode *thread)
                return;
        if (!(this_thread->thread_func))
                return;         // Don't stop garbage collector
-#ifdef THREADS_USESIGNALS
+
        if (!citthread_equal(this_thread->tid, GC_thread->tid))
                citthread_kill(this_thread->tid, SIGHUP);
-#endif
+
        ctdl_thread_internal_change_state (this_thread, CTDL_THREAD_STOP_REQ);
        citthread_cond_signal(&this_thread->ThreadCond);
        citthread_cond_signal(&this_thread->SleepCond);
@@ -593,10 +618,20 @@ static void ctdl_internal_thread_cleanup(void *arg)
         * In here we were called by the current thread because it is exiting
         * NB. WE ARE THE CURRENT THREAD
         */
-       CtdlLogPrintf(CTDL_NOTICE, "Thread \"%s\" (0x%08lx) exited.\n", CT->name, CT->tid);
+       if (CT)
+       {
+               const char *name = CT->name;
+               const pid_t tid = CT->tid;
+
+               CtdlLogPrintf(CTDL_NOTICE, "Thread \"%s\" (0x%08lx) exited.\n", name, (unsigned long) tid);
+       }
+       else 
+       {
+               CtdlLogPrintf(CTDL_NOTICE, "some ((unknown ? ? ?) Thread exited.\n");
+       }
        
        #ifdef HAVE_BACKTRACE
-       eCrash_UnregisterThread();
+///    eCrash_UnregisterThread();
        #endif
        
        citthread_mutex_lock(&CT->ThreadMutex);
@@ -661,7 +696,7 @@ void CtdlThreadGC (void)
        CtdlThreadNode *this_thread, *that_thread;
        int workers = 0, sys_workers;
        int ret=0;
-       
+
        begin_critical_section(S_THREAD_LIST);
        
        /* Handle exiting of garbage collector thread */
@@ -682,7 +717,10 @@ void CtdlThreadGC (void)
                
                if ((that_thread->state == CTDL_THREAD_STOP_REQ || that_thread->state == CTDL_THREAD_STOPPING)
                        && (!citthread_equal(that_thread->tid, citthread_self())))
-                               CtdlLogPrintf(CTDL_DEBUG, "Waiting for thread %s (0x%08lx) to exit.\n", that_thread->name, that_thread->tid);
+               {
+                       CtdlLogPrintf(CTDL_DEBUG, "Waiting for thread %s (0x%08lx) to exit.\n", that_thread->name, that_thread->tid);
+                       terminate_stuck_sessions();
+               }
                else
                {
                        /**
@@ -802,7 +840,6 @@ static void *ctdl_internal_thread_func (void *arg)
        begin_critical_section(S_THREAD_LIST);
        this_thread = (CtdlThreadNode *) arg;
        gettimeofday(&this_thread->start_time, NULL);           /* Time this thread started */
-//     citthread_mutex_lock(&this_thread->ThreadMutex);
        
        // Register the cleanup function to take care of when we exit.
        citthread_cleanup_push(ctdl_internal_thread_cleanup, NULL);
@@ -815,8 +852,6 @@ static void *ctdl_internal_thread_func (void *arg)
         * Other wise there is a window to allow this threads creation to continue to full grown and
         * therby prevent a shutdown of the server.
         */
-//     citthread_mutex_unlock(&this_thread->ThreadMutex);
-               
        if (!CtdlThreadCheckStop())
        {
                citthread_mutex_lock(&this_thread->ThreadMutex);
@@ -827,10 +862,13 @@ static void *ctdl_internal_thread_func (void *arg)
        
        // Register for tracing
        #ifdef HAVE_BACKTRACE
-       eCrash_RegisterThread(this_thread->name, 0);
+///    eCrash_RegisterThread(this_thread->name, 0);
        #endif
        
        // Tell the world we are here
+#if defined(HAVE_SYSCALL_H) && defined (SYS_gettid)
+       this_thread->reltid = syscall(SYS_gettid);
+#endif
        CtdlLogPrintf(CTDL_NOTICE, "Created a new thread \"%s\" (0x%08lx).\n",
                this_thread->name, this_thread->tid);
        
@@ -961,8 +999,6 @@ CtdlThreadNode *ctdl_internal_create_thread(char *name, long flags, void *(*thre
        this_thread->thread_func = thread_func;
        this_thread->user_args = args;
        
-//     citthread_mutex_lock(&this_thread->ThreadMutex);
-       
        begin_critical_section(S_THREAD_LIST);
        /*
         * We pass this_thread into the thread as its args so that it can find out information
@@ -983,7 +1019,6 @@ CtdlThreadNode *ctdl_internal_create_thread(char *name, long flags, void *(*thre
                free(this_thread);
                return NULL;
        }
-       
        num_threads++;  // Increase the count of threads in the system.
        if(this_thread->flags & CTDLTHREAD_WORKER)
                num_workers++;
@@ -994,7 +1029,6 @@ CtdlThreadNode *ctdl_internal_create_thread(char *name, long flags, void *(*thre
                this_thread->next->prev = this_thread;
        ctdl_thread_internal_calc_loadavg();
        
-//     citthread_mutex_unlock(&this_thread->ThreadMutex);
        end_critical_section(S_THREAD_LIST);
        
        return this_thread;
@@ -1016,73 +1050,10 @@ CtdlThreadNode *CtdlThreadCreate(char *name, long flags, void *(*thread_func) (v
 
 
 
-/*
- * Internal function to schedule a thread.
- * Must be called from within a S_THREAD_LIST critical section
- */ 
-CtdlThreadNode *CtdlThreadSchedule(char *name, long flags, void *(*thread_func) (void *arg), void *args, time_t when)
-{
-       CtdlThreadNode *this_thread;
-
-       if (num_threads >= 32767)
-       {
-               CtdlLogPrintf(CTDL_EMERG, "Thread system. Thread list full.\n");
-               return NULL;
-       }
-               
-       this_thread = malloc(sizeof(CtdlThreadNode));
-       if (this_thread == NULL) {
-               CtdlLogPrintf(CTDL_EMERG, "Thread system, can't allocate CtdlThreadNode, exiting\n");
-               return NULL;
-       }
-       /* Initialise the thread structure */
-       if (ctdl_internal_init_thread_struct(this_thread, flags) == NULL)
-       {
-               free(this_thread);
-               CtdlLogPrintf(CTDL_EMERG, "Thread system, can't initialise CtdlThreadNode, exiting\n");
-               return NULL;
-       }
-
-       /*
-        * If we got here we are going to create the thread so we must initilise the structure
-        * first because most implimentations of threading can't create it in a stopped state
-        * and it might want to do things with its structure that aren't initialised otherwise.
-        */
-       if(name)
-       {
-               this_thread->name = name;
-       }
-       else
-       {
-               this_thread->name = "Un-named Thread";
-       }
-       
-       this_thread->flags = flags;
-       this_thread->thread_func = thread_func;
-       this_thread->user_args = args;
-       
-       /*
-        * When to start this thread
-        */
-       this_thread->when = when;
-
-       begin_critical_section(S_SCHEDULE_LIST);
-       this_thread->next = CtdlThreadSchedList;
-       CtdlThreadSchedList = this_thread;
-       if (this_thread->next)
-               this_thread->next->prev = this_thread;
-       end_critical_section(S_SCHEDULE_LIST);
-       
-       return this_thread;
-}
-
-
-
 CtdlThreadNode *ctdl_thread_internal_start_scheduled (CtdlThreadNode *this_thread)
 {
        int ret = 0;
        
-//     citthread_mutex_lock(&that_thread->ThreadMutex);
        begin_critical_section(S_THREAD_LIST);
        /*
         * We pass this_thread into the thread as its args so that it can find out information
@@ -1093,7 +1064,6 @@ CtdlThreadNode *ctdl_thread_internal_start_scheduled (CtdlThreadNode *this_threa
        {
                end_critical_section(S_THREAD_LIST);
                CtdlLogPrintf(CTDL_DEBUG, "Failed to start scheduled thread \"%s\": %s\n", this_thread->name, strerror(ret));
-//             citthread_mutex_unlock(&this_thread->ThreadMutex);
                citthread_mutex_destroy(&(this_thread->ThreadMutex));
                citthread_cond_destroy(&(this_thread->ThreadCond));
                citthread_mutex_destroy(&(this_thread->SleepMutex));
@@ -1112,7 +1082,6 @@ CtdlThreadNode *ctdl_thread_internal_start_scheduled (CtdlThreadNode *this_threa
        CtdlThreadList = this_thread;
        if (this_thread->next)
                this_thread->next->prev = this_thread;
-//     citthread_mutex_unlock(&that_thread->ThreadMutex);
        
        ctdl_thread_internal_calc_loadavg();
        end_critical_section(S_THREAD_LIST);
@@ -1274,8 +1243,10 @@ void go_threading(void)
        ctdl_thread_internal_init();
 
        /* Second call to module init functions now that threading is up */
-       if (!statcount)
+       if (!statcount) {
                initialise_modules(1);
+               CtdlThreadCreate("select_on_master", CTDLTHREAD_BIGSTACK, select_on_master, NULL);
+       }
        else {
                CtdlLogPrintf(CTDL_EMERG, "Running connection simulation stats\n");
                gettimeofday(&start, NULL);
@@ -1286,7 +1257,7 @@ void go_threading(void)
        /*
         * This thread is now used for garbage collection of other threads in the thread list
         */
-       CtdlLogPrintf(CTDL_INFO, "Startup thread %d becoming garbage collector,\n", citthread_self());
+       CtdlLogPrintf(CTDL_INFO, "Startup thread %ld becoming garbage collector,\n", (long) citthread_self());
 
        /*
         * We do a lot of locking and unlocking of the thread list in here.
@@ -1302,7 +1273,6 @@ void go_threading(void)
                if (exit_signal)
                {
                        CtdlThreadStopAll();
-//                     close_masters();
                }
                check_sched_shutdown();
                if (CT->state > CTDL_THREAD_STOP_REQ)
@@ -1352,30 +1322,18 @@ void go_threading(void)
                 * based on the system load
                 */
                if (!statcount) {
-#ifdef NEW_WORKER
-               if ((((CtdlThreadGetWorkers() < config.c_max_workers) && (CtdlThreadGetWorkers() <= num_sessions) ) || CtdlThreadGetWorkers() < config.c_min_workers) && (CT->state > CTDL_THREAD_STOP_REQ))
-#else
                if ((((CtdlThreadGetWorkers() < config.c_max_workers) && (CtdlThreadGetWorkerAvg() > 60)) || CtdlThreadGetWorkers() < config.c_min_workers) && (CT->state > CTDL_THREAD_STOP_REQ))
-#endif /* NEW_WORKER */
                {
                        /* Only start new threads if we are not going to overload the machine */
                        /* Temporarily set to 10 should be enough to make sure we don't stranglew the server
                         * at least until we make this a config option */
                        if (CtdlThreadGetLoadAvg() < ((double)10.00)) {
                                for (i=0; i<5 ; i++) {
-#ifdef NEW_WORKER
-                                       CtdlThreadCreate("Worker Thread (new)",
-                                               CTDLTHREAD_BIGSTACK + CTDLTHREAD_WORKER,
-                                               new_worker_thread,
-                                               NULL
-                                               );
-#else
                                        CtdlThreadCreate("Worker Thread",
                                                CTDLTHREAD_BIGSTACK + CTDLTHREAD_WORKER,
                                                worker_thread,
                                                NULL
                                                );
-#endif /* NEW_WORKER */
                                }
                        }
                        else
@@ -1413,248 +1371,3 @@ void go_threading(void)
 
 
 
-/*
- * Starting a new implimentation of a worker thread.
- * This new implimentation will be faster and do more work per thread.
- */
-/*
- * Select on master socket.
- * First worker thread in here acquires the lock and builds an FDSET of master sockets.
- * then it goes into a loop selecting on the master sockets timing out every few milliseconds.
- * If it times out it rebiulds its list and loops.
- * If the select succeeds it creates a new context and returns.
- * During this time the other workers are selecting on existing contexts or sleeping.
- */
-void select_on_master(void)
-{
-        fd_set readfds;
-        struct ServiceFunctionHook *serviceptr;
-        int ssock;                     /* Descriptor for client socket */
-        int highest;
-        int m, i;
-        int retval = 0;
-        struct timeval tv;
-        CitContext *con;
-        const char *old_name;
-
-
-
-        old_name = CtdlThreadName("select_on_master");
-
-        /* Initialize the fdset. */
-        FD_ZERO(&readfds);
-        highest = 0;
-
-        /* First, add the various master sockets to the fdset. */
-        for (serviceptr = ServiceHookTable; serviceptr != NULL; serviceptr = serviceptr->next ) {
-                m = serviceptr->msock;
-                FD_SET(m, &readfds);
-                if (m > highest) {
-                        highest = m;
-                }
-        }
-
-        tv.tv_sec = 1;         /* wake up every 1 sec if no input */
-        tv.tv_usec = 0;
-        retval = CtdlThreadSelect(highest + 1, &readfds, NULL, NULL, &tv);
-
-        /* Select got an error or we are shutting down so get out */
-        if (retval == 0 || CtdlThreadCheckStop()) {
-                CtdlThreadName(old_name);
-                return;
-        }
-
-        /* Select says something happened on one of our master sockets so now we handle it */
-        for (serviceptr = ServiceHookTable; serviceptr != NULL; serviceptr = serviceptr->next ) {
-                if (FD_ISSET(serviceptr->msock, &readfds)) {
-                        ssock = accept(serviceptr->msock, NULL, 0);
-                        if (ssock >= 0) {
-                                CtdlLogPrintf(CTDL_DEBUG, "New client socket %d\n", ssock);
-                                /* The master socket is non-blocking but the client
-                                 * sockets need to be blocking, otherwise certain
-                                 * operations barf on FreeBSD.  Not a fatal error.
-                                 */
-                                if (fcntl(ssock, F_SETFL, 0) < 0) {
-                                        CtdlLogPrintf(CTDL_EMERG,
-                                                      "citserver: Can't set socket to blocking: %s\n",
-                                                      strerror(errno));
-                                }
-
-                                /* New context will be created already
-                                 * set up in the CON_EXECUTING state.
-                                 */
-                                con = CreateNewContext();
-                                CT->Context = con;
-
-                                /* Assign our new socket number to it. */
-                                con->client_socket = ssock;
-                                con->h_command_function = serviceptr->h_command_function;
-                                con->h_async_function = serviceptr->h_async_function;
-                                con->ServiceName = serviceptr->ServiceName;
-                                /* Determine whether it's a local socket */
-                                if (serviceptr->sockpath != NULL)
-                                        con->is_local_socket = 1;
-
-                                /* Set the SO_REUSEADDR socket option */
-                                i = 1;
-                                setsockopt(ssock, SOL_SOCKET, SO_REUSEADDR, &i, sizeof(i));
-
-                                become_session(con);
-                                begin_session(con);
-                                serviceptr->h_greeting_function();
-                                become_session(NULL);
-                                con->state = CON_IDLE;
-                                break;
-                        }
-                }
-        }
-
-        CtdlThreadName(old_name);
-}
-
-/*
- * Select on client socket.
- * First worker thread in here acquires the lock and builds an FDSET of client sockets.
- * then it selects on the client sockets timing out after 1 second.
- * If it times out the thread goes off to check on housekeeping etc.
- * If the select succeeds the thread goes off to handle the client request.
- * If the list of client connections is empty the threads all sleep for one second
- */
-CitContext *select_on_client(void)
-{
-       fd_set readfds;
-       struct timeval tv;
-       int retval = 0;
-       int highest=0;
-       const char *old_name;
-       
-       
-       old_name = CtdlThreadName("select_on_client");
-       
-       /* Initialise the fdset */
-       FD_ZERO(&readfds);
-       FD_SET(CT->Context->client_socket, &readfds);
-       highest = CT->Context->client_socket;   
-       /* Now we can select on any connections that are waiting */
-       
-       if (!CtdlThreadCheckStop())
-       {
-               tv.tv_sec = config.c_sleeping;          /* wake up every second if no input */
-               tv.tv_usec = 0;
-               retval = select(highest + 1, &readfds, NULL, NULL, &tv);
-       }
-       else    /* Shutting down? */
-       {
-               CtdlThreadName(old_name);
-               return(NULL);
-       }
-               
-
-       /* Now figure out who made this select() unblock.
-        * First, check for an error or exit condition.
-        */
-       if (retval < 0) {
-               if (errno == EBADF) {
-                       CtdlLogPrintf(CTDL_NOTICE, "select() failed: (%s)\n",
-                               strerror(errno));
-               }
-               if (errno != EINTR) {
-                       CtdlLogPrintf(CTDL_EMERG, "Exiting (%s)\n", strerror(errno));
-                       CtdlThreadStopAll();
-               } else if (!CtdlThreadCheckStop()) {
-                       CtdlLogPrintf(CTDL_DEBUG, "Un handled select failure.\n");
-               }
-               CtdlThreadName(old_name);
-               return NULL;
-       }
-       else if(retval == 0)
-       {
-               CtdlThreadName(old_name);
-               CT->Context->kill_me = 1;
-               CT->Context = NULL;
-               return CT->Context;
-       }
-       
-       CT->Context->state = CON_EXECUTING;
-       CT->Context->input_waiting = 1;
-       
-       CtdlThreadName(old_name);
-       return (CT->Context);
-}
-
-
-
-/*
- * Do the worker threads work when needed
- */
-int execute_session(CitContext *bind_me)
-{
-       int force_purge;
-       
-       become_session(bind_me);
-
-       /* If the client has sent a command, execute it. */
-       if (CC->input_waiting) {
-               CC->h_command_function();
-               CC->input_waiting = 0;
-       }
-
-       /* If there are asynchronous messages waiting and the
-        * client supports it, do those now */
-       if ((CC->is_async) && (CC->async_waiting)
-          && (CC->h_async_function != NULL)) {
-               CC->h_async_function();
-               CC->async_waiting = 0;
-       }
-               
-       force_purge = CC->kill_me;
-       if (force_purge)
-               CT->Context = NULL;
-       become_session(NULL);
-       bind_me->state = CON_IDLE;
-       return force_purge;
-}
-
-
-
-
-/*
- * A new worker_thread loop.
- */
-void *new_worker_thread(void *arg)
-{
-       CitContext *bind_me;
-       int force_purge;
-       
-       while (!CtdlThreadCheckStop()) {
-
-               /* make doubly sure we're not holding any stale db handles
-                * which might cause a deadlock.
-                */
-               cdb_check_handles();
-               force_purge = 0;
-               bind_me = NULL;         /* Which session shall we handle? */
-                       
-               if (CT->Context == NULL)
-                       select_on_master();
-               if (CtdlThreadCheckStop())
-                       break;
-                       
-               if (CT->Context)
-                       bind_me = select_on_client();
-               if (CtdlThreadCheckStop())
-                       break;
-                       
-               if (bind_me)
-                       force_purge = execute_session(bind_me);
-                       
-               dead_session_purge(force_purge);
-               if (CtdlThreadCheckStop())
-                       break;
-                       
-               do_housekeeping();
-       }
-       return NULL;
-}