citadel/housekeeping.c

   1 /*
   2  * $Id$
   3  *
   4  * This file contains miscellaneous housekeeping tasks.
   5  *
   6  */
   7
   8 #include "sysdep.h"
   9 #include <stdlib.h>
  10 #include <unistd.h>
  11 #include <stdio.h>
  12 #include <fcntl.h>
  13
  14 #if TIME_WITH_SYS_TIME
  15 # include <sys/time.h>
  16 # include <time.h>
  17 #else
  18 # if HAVE_SYS_TIME_H
  19 #  include <sys/time.h>
  20 # else
  21 #  include <time.h>
  22 # endif
  23 #endif
  24
  25 #include <ctype.h>
  26 #include <string.h>
  27 #include <errno.h>
  28 #include <limits.h>
  29 #include <sys/types.h>
  30 #ifdef HAVE_SYS_SELECT_H
  31 #include <sys/select.h>
  32 #endif
  33 #include <libcitadel.h>
  34 #include "citadel.h"
  35 #include "server.h"
  36 #include "serv_extensions.h"
  37 #include "citserver.h"
  38 #include "config.h"
  39 #include "housekeeping.h"
  40 #include "sysdep_decls.h"
  41 #include "room_ops.h"
  42 #include "database.h"
  43 #include "msgbase.h"
  44 #include "journaling.h"
  45
  46 #include "ctdl_module.h"
  47 #include "threads.h"
  48
  49 /*
  50  * Terminate idle sessions.  This function pounds through the session table
  51  * comparing the current time to each session's time-of-last-command.  If an
  52  * idle session is found it is terminated, then the search restarts at the
  53  * beginning because the pointer to our place in the list becomes invalid.
  54  */
  55 void terminate_idle_sessions(void) {
  56         struct CitContext *ccptr;
  57         time_t now;
  58         int session_to_kill;
  59         int killed = 0;
  60
  61         now = time(NULL);
  62         session_to_kill = 0;
  63         begin_critical_section(S_SESSION_TABLE);
  64         for (ccptr = ContextList; ccptr != NULL; ccptr = ccptr->next) {
  65                 if (  (ccptr!=CC)
  66                 && (config.c_sleeping > 0)
  67                 && (now - (ccptr->lastcmd) > config.c_sleeping) ) {
  68                         ccptr->kill_me = 1;
  69                         ++killed;
  70                 }
  71         }
  72         end_critical_section(S_SESSION_TABLE);
  73         if (killed > 0)
  74                 CtdlLogPrintf(CTDL_INFO, "Terminated %d idle sessions\n", killed);
  75 }
  76
  77
  78
  79 void check_sched_shutdown(void) {
  80         if ((ScheduledShutdown == 1) && (ContextList == NULL)) {
  81                 CtdlLogPrintf(CTDL_NOTICE, "Scheduled shutdown initiating.\n");
  82                 CtdlThreadStopAll();
  83         }
  84 }
  85
  86
  87
  88 /*
  89  * Check (and fix) floor reference counts.  This doesn't need to be done
  90  * very often, since the counts should remain correct during normal operation.
  91  */
  92 void check_ref_counts_backend(struct ctdlroom *qrbuf, void *data) {
  93
  94         int *new_refcounts;
  95
  96         new_refcounts = (int *) data;
  97
  98         ++new_refcounts[(int)qrbuf->QRfloor];
  99 }
 100
 101 void check_ref_counts(void) {
 102         struct floor flbuf;
 103         int a;
 104
 105         int new_refcounts[MAXFLOORS];
 106
 107         CtdlLogPrintf(CTDL_DEBUG, "Checking floor reference counts\n");
 108         for (a=0; a<MAXFLOORS; ++a) {
 109                 new_refcounts[a] = 0;
 110         }
 111
 112         cdb_begin_transaction();
 113         ForEachRoom(check_ref_counts_backend, (void *)new_refcounts );
 114         cdb_end_transaction();
 115
 116         for (a=0; a<MAXFLOORS; ++a) {
 117                 lgetfloor(&flbuf, a);
 118                 flbuf.f_ref_count = new_refcounts[a];
 119                 if (new_refcounts[a] > 0) {
 120                         flbuf.f_flags = flbuf.f_flags | QR_INUSE;
 121                 }
 122                 else {
 123                         flbuf.f_flags = flbuf.f_flags & ~QR_INUSE;
 124                 }
 125                 lputfloor(&flbuf, a);
 126                 CtdlLogPrintf(CTDL_DEBUG, "Floor %d: %d rooms\n", a, new_refcounts[a]);
 127         }
 128 }
 129
 130 /*
 131  * This is the housekeeping loop.  Worker threads come through here after
 132  * processing client requests but before jumping back into the pool.  We
 133  * only allow housekeeping to execute once per minute, and we only allow one
 134  * instance to run at a time.
 135  */
 136 void do_housekeeping(void) {
 137         static int housekeeping_in_progress = 0;
 138         static time_t last_timer = 0L;
 139         int do_housekeeping_now = 0;
 140         int do_perminute_housekeeping_now = 0;
 141         time_t now;
 142         const char *old_name;
 143
 144         /*
 145          * We do it this way instead of wrapping the whole loop in an
 146          * S_HOUSEKEEPING critical section because it eliminates the need to
 147          * potentially have multiple concurrent mutexes in progress.
 148          */
 149         begin_critical_section(S_HOUSEKEEPING);
 150         if (housekeeping_in_progress == 0) {
 151                 do_housekeeping_now = 1;
 152                 housekeeping_in_progress = 1;
 153                 now = time(NULL);
 154                 if ( (now - last_timer) > (time_t)60 ) {
 155                         do_perminute_housekeeping_now = 1;
 156                         last_timer = time(NULL);
 157                 }
 158         }
 159         end_critical_section(S_HOUSEKEEPING);
 160
 161         if (do_housekeeping_now == 0) {
 162                 return;
 163         }
 164
 165         /*
 166          * Ok, at this point we've made the decision to run the housekeeping
 167          * loop.  Everything below this point is real work.
 168          */
 169
 170         /* First, do the "as often as needed" stuff... */
 171         old_name = CtdlThreadName("House Keeping - Journal");
 172         JournalRunQueue();
 173
 174         CtdlThreadName("House Keeping - EVT_HOUSE");
 175         PerformSessionHooks(EVT_HOUSE); /* perform as needed housekeeping */
 176
 177         /* Then, do the "once per minute" stuff... */
 178         if (do_perminute_housekeeping_now) {
 179                 cdb_check_handles();                    /* suggested by Justin Case */
 180                 CtdlThreadName("House Keeping - EVT_TIMER");
 181                 PerformSessionHooks(EVT_TIMER);         /* Run any timer hooks */
 182         }
 183
 184         /*
 185          * All done.
 186          */
 187         housekeeping_in_progress = 0;
 188         CtdlThreadName(old_name);
 189 }