citadel/housekeeping.c

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