Updated the copyright declaration in several modules, removing any language which...
[citadel.git] / citadel / housekeeping.c
index e1c15e4924106d231ab1813bc6cc49747dc4d81f..108410af29a79a7924526d2f214ba5dea868ffea 100644 (file)
@@ -1,66 +1,65 @@
 /*
- * This file contains housekeeping tasks which periodically
- * need to be executed.
+ * This file contains miscellaneous housekeeping tasks.
  *
+ * Copyright (c) 1987-2011 by the citadel.org team
+ *
+ * This program is open source software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License, version 3.
+ *
+ * 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.
  */
 
+#include "sysdep.h"
 #include <stdlib.h>
 #include <unistd.h>
 #include <stdio.h>
-#include <time.h>
+#include <fcntl.h>
+
+#if TIME_WITH_SYS_TIME
+# include <sys/time.h>
+# include <time.h>
+#else
+# if HAVE_SYS_TIME_H
+#  include <sys/time.h>
+# else
+#  include <time.h>
+# endif
+#endif
+
 #include <ctype.h>
 #include <string.h>
 #include <errno.h>
-#include <pthread.h>
+#include <limits.h>
+#include <sys/types.h>
+#ifdef HAVE_SYS_SELECT_H
+#include <sys/select.h>
+#endif
+#include <syslog.h>
+#include <libcitadel.h>
 #include "citadel.h"
 #include "server.h"
-#include "proto.h"
-
-/*
- * Terminate idle sessions.  This function pounds through the session table
- * comparing the current time to each session's time-of-last-command.  If an
- * idle session is found it is terminated, then the search restarts at the
- * beginning because the pointer to our place in the list becomes invalid.
- */
-void terminate_idle_sessions(void) {
-       struct CitContext *ccptr;
-       time_t now;
-       
-       time(&now);
-       for (ccptr = ContextList; ccptr != NULL; ccptr = ccptr->next) {
-               if (  (ccptr!=CC)
-                  && (config.c_sleeping > 0)
-                  && (now - (ccptr->lastcmd) > config.c_sleeping) ) {
-                       lprintf(3, "Session %d timed out\n", ccptr->cs_pid);
-                       kill_session(ccptr->cs_pid);
-                       ccptr = ContextList;
-                       }
-               }
-       }
+#include "serv_extensions.h"
+#include "citserver.h"
+#include "config.h"
+#include "housekeeping.h"
+#include "sysdep_decls.h"
+#include "room_ops.h"
+#include "database.h"
+#include "msgbase.h"
+#include "journaling.h"
 
+#include "ctdl_module.h"
+#include "threads.h"
 
-/*
- * Main housekeeping function.  This gets run whenever a session terminates.
- */
-void do_housekeeping() {
-
-       begin_critical_section(S_HOUSEKEEPING);
-       /*
-        * Terminate idle sessions.
-        */
-       lprintf(7, "Calling terminate_idle_sessions()\n");
-       terminate_idle_sessions();
-
-       /*
-        * If the server is scheduled to shut down the next time all
-        * users are logged out, now's the time to do it.
-        */
+void check_sched_shutdown(void) {
        if ((ScheduledShutdown == 1) && (ContextList == NULL)) {
-               lprintf(3, "Scheduled shutdown initiating.\n");
-               master_cleanup();
-               }
-       end_critical_section(S_HOUSEKEEPING);
+               syslog(LOG_NOTICE, "Scheduled shutdown initiating.\n");
+               server_shutting_down = 1;
        }
+}
 
 
 
@@ -68,26 +67,98 @@ void do_housekeeping() {
  * Check (and fix) floor reference counts.  This doesn't need to be done
  * very often, since the counts should remain correct during normal operation.
  */
-void check_ref_counts() {
-       int ref[MAXFLOORS];
-       struct quickroom qrbuf;
+void check_ref_counts_backend(struct ctdlroom *qrbuf, void *data) {
+
+       int *new_refcounts;
+
+       new_refcounts = (int *) data;
+
+       ++new_refcounts[(int)qrbuf->QRfloor];
+}
+
+void check_ref_counts(void) {
        struct floor flbuf;
        int a;
 
-       for (a=0; a<MAXFLOORS; ++a) ref[a] = 0;
-               
-       for (a=0; a<MAXROOMS; ++a) {
-               getroom(&qrbuf, a);
-               if (qrbuf.QRflags & QR_INUSE) {
-                       ++ref[(int)qrbuf.QRfloor];
-                       }
-               }
+       int new_refcounts[MAXFLOORS];
+
+       syslog(LOG_DEBUG, "Checking floor reference counts\n");
+       for (a=0; a<MAXFLOORS; ++a) {
+               new_refcounts[a] = 0;
+       }
+
+       cdb_begin_transaction();
+       CtdlForEachRoom(check_ref_counts_backend, (void *)new_refcounts );
+       cdb_end_transaction();
 
        for (a=0; a<MAXFLOORS; ++a) {
                lgetfloor(&flbuf, a);
-               flbuf.f_ref_count = ref[a];
-               if (ref[a] > 0) flbuf.f_flags = flbuf.f_flags | QR_INUSE ;
-               lputfloor(&flbuf, a);
+               flbuf.f_ref_count = new_refcounts[a];
+               if (new_refcounts[a] > 0) {
+                       flbuf.f_flags = flbuf.f_flags | QR_INUSE;
                }
-       }       
+               else {
+                       flbuf.f_flags = flbuf.f_flags & ~QR_INUSE;
+               }
+               lputfloor(&flbuf, a);
+               syslog(LOG_DEBUG, "Floor %d: %d rooms\n", a, new_refcounts[a]);
+       }
+}      
+
+/*
+ * This is the housekeeping loop.  Worker threads come through here after
+ * processing client requests but before jumping back into the pool.  We
+ * only allow housekeeping to execute once per minute, and we only allow one
+ * instance to run at a time.
+ */
+static int housekeeping_in_progress = 0;
+static time_t last_timer = 0L;
+void do_housekeeping(void) {
+       int do_housekeeping_now = 0;
+       int do_perminute_housekeeping_now = 0;
+       time_t now;
+
+       /*
+        * We do it this way instead of wrapping the whole loop in an
+        * S_HOUSEKEEPING critical section because it eliminates the need to
+        * potentially have multiple concurrent mutexes in progress.
+        */
+       begin_critical_section(S_HOUSEKEEPING);
+       if (housekeeping_in_progress == 0) {
+               do_housekeeping_now = 1;
+               housekeeping_in_progress = 1;
+       }
+       end_critical_section(S_HOUSEKEEPING);
 
+       if (do_housekeeping_now == 0) {
+               return;
+       }
+
+       /*
+        * Ok, at this point we've made the decision to run the housekeeping
+        * loop.  Everything below this point is real work.
+        */
+
+       now = time(NULL);
+       if ( (now - last_timer) > (time_t)60 ) {
+               do_perminute_housekeeping_now = 1;
+               last_timer = time(NULL);
+       }
+
+       /* First, do the "as often as needed" stuff... */
+       JournalRunQueue();
+       PerformSessionHooks(EVT_HOUSE);
+
+       /* Then, do the "once per minute" stuff... */
+       if (do_perminute_housekeeping_now) {
+               cdb_check_handles();                    /* suggested by Justin Case */
+               PerformSessionHooks(EVT_TIMER);         /* Run any timer hooks */
+       }
+
+       /*
+        * All done.
+        */
+       begin_critical_section(S_HOUSEKEEPING);
+       housekeeping_in_progress = 0;
+       end_critical_section(S_HOUSEKEEPING);
+}