* Renamed "struct user" to "struct ctdluser"
[citadel.git] / citadel / housekeeping.c
index 50deb5f9cdb815fd76730fe3d10331aa976cf22a..55d40e3d1ce5bae468b9346d7749d990405b6547 100644 (file)
@@ -1,36 +1,51 @@
 /*
- * This file contains housekeeping tasks which periodically
- * need to be executed.  It keeps a nice little queue...
- *
  * $Id$
+ *
+ * This file contains miscellaneous housekeeping tasks.
+ *
  */
 
+#ifdef DLL_EXPORT
+#define IN_LIBCIT
+#endif
+
 #include "sysdep.h"
 #include <stdlib.h>
 #include <unistd.h>
 #include <stdio.h>
 #include <fcntl.h>
-#include <time.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 <limits.h>
 #include <sys/types.h>
-#include <sys/time.h>
 #ifdef HAVE_SYS_SELECT_H
 #include <sys/select.h>
 #endif
 #include "tools.h"
 #include "citadel.h"
 #include "server.h"
+#include "serv_extensions.h"
 #include "citserver.h"
 #include "config.h"
 #include "housekeeping.h"
 #include "sysdep_decls.h"
 #include "room_ops.h"
+#include "database.h"
 
 
-int housepipe[2];      /* This is the queue for housekeeping tasks */
 
 
 /*
@@ -43,6 +58,7 @@ void terminate_idle_sessions(void) {
        struct CitContext *ccptr;
        time_t now;
        int session_to_kill;
+       int killed = 0;
 
        now = time(NULL);
        session_to_kill = 0;
@@ -52,9 +68,11 @@ void terminate_idle_sessions(void) {
                && (config.c_sleeping > 0)
                && (now - (ccptr->lastcmd) > config.c_sleeping) ) {
                        ccptr->kill_me = 1;
+                       ++killed;
                }
        }
        end_critical_section(S_SESSION_TABLE);
+       lprintf(9, "Terminated %d idle sessions\n", killed);
 }
 
 
@@ -62,121 +80,86 @@ void terminate_idle_sessions(void) {
 void check_sched_shutdown(void) {
        if ((ScheduledShutdown == 1) && (ContextList == NULL)) {
                lprintf(3, "Scheduled shutdown initiating.\n");
-               master_cleanup();
+               time_to_die = 1;
        }
 }
 
 
 
-/*
- * This is the main loop for the housekeeping thread.  It remains active
- * during the entire run of the server.
- */
-void housekeeping_loop(void) {
-       long flags;
-        struct timeval tv;
-        fd_set readfds;
-        int did_something;
-       char house_cmd[256];    /* Housekeep cmds are always 256 bytes long */
-       char cmd[256];
-
-       if (pipe(housepipe) != 0) {
-               lprintf(1, "FATAL ERROR: can't create housekeeping pipe: %s\n",
-                       strerror(errno));
-               exit(0);
-       }
-
-       flags = (long) fcntl(housepipe[1], F_GETFL);
-       flags |= O_NONBLOCK;
-       fcntl(housepipe[1], F_SETFL, flags);
-
-       while(1) {
-               do {
-                       did_something = 0;
-                       tv.tv_sec = HOUSEKEEPING_WAKEUP;
-                       tv.tv_usec = 0;
-                       FD_ZERO(&readfds);
-                       FD_SET(housepipe[0], &readfds);
-                       select(housepipe[0] + 1, &readfds, 0L, 0L, &tv);
-                       if (FD_ISSET(housepipe[0], &readfds)) {
-                               did_something = 1;
-                       }
-
-                       if (did_something) {
-                               read(housepipe[0], house_cmd, 256);
-                       }
-                       else {
-                               memset(house_cmd, 0, 256);
-                               strcpy(house_cmd, "MINUTE");
-                       }
-
-                       extract(cmd, house_cmd, 0);
-
-                       /* Do whatever this cmd requires */
-
-                       /* Once-every-minute housekeeper */
-                       if (!strcmp(cmd, "MINUTE")) {
-                               terminate_idle_sessions();
-                       }
-
-                       /* Scheduled shutdown housekeeper */
-                       else if (!strcmp(cmd, "SCHED_SHUTDOWN")) {
-                               check_sched_shutdown();
-                       }
-
-                       /* Unknown */
-                       else {
-                               lprintf(7, "Unknown housekeeping command\n");
-                       }
-
-               } while (did_something);
-       }
-}
-
-
-
-
-
-
-void enter_housekeeping_cmd(char *cmd) {
-       char cmdbuf[256];
-
-       lprintf(9, "enter_housekeeping_cmd(%s)\n", cmd);
-       safestrncpy(cmdbuf, cmd, 256);
-       begin_critical_section(S_HOUSEKEEPING);
-       write(housepipe[1], cmdbuf, 256);
-       end_critical_section(S_HOUSEKEEPING);
-       lprintf(9, "leaving enter_housekeeping_cmd()\n");
-}
-       
-
-
 /*
  * Check (and fix) floor reference counts.  This doesn't need to be done
  * very often, since the counts should remain correct during normal operation.
  * NOTE: this function pair should ONLY be called during startup.  It is NOT
  * thread safe.
  */
-void check_ref_counts_backend(struct quickroom *qrbuf, void *data) {
+void check_ref_counts_backend(struct ctdlroom *qrbuf, void *data) {
        struct floor flbuf;
 
        getfloor(&flbuf, qrbuf->QRfloor);
        ++flbuf.f_ref_count;
        flbuf.f_flags = flbuf.f_flags | QR_INUSE;
        putfloor(&flbuf, qrbuf->QRfloor);
-       }
+}
 
 void check_ref_counts(void) {
        struct floor flbuf;
        int a;
 
+       lprintf(7, "Checking floor reference counts\n");
        for (a=0; a<MAXFLOORS; ++a) {
                getfloor(&flbuf, a);
                flbuf.f_ref_count = 0;
                flbuf.f_flags = flbuf.f_flags & ~QR_INUSE;
                putfloor(&flbuf, a);
-               }
+       }
 
+       cdb_begin_transaction();
        ForEachRoom(check_ref_counts_backend, NULL);
-       }       
+       cdb_end_transaction();
+}      
+
+/*
+ * 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.
+ */
+void do_housekeeping(void) {
+       static int housekeeping_in_progress = 0;
+       static time_t last_timer = 0L;
+       int do_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);
+       now = time(NULL);
+       if ( (now - last_timer) > (time_t)60 ) {
+               if (housekeeping_in_progress == 0) {
+                       do_housekeeping_now = 1;
+                       housekeeping_in_progress = 1;
+                       last_timer = time(NULL);
+               }
+       }
+       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.
+        */
+
+       cdb_check_handles();                    /* suggested by Justin Case */
+       PerformSessionHooks(EVT_TIMER);         /* Run any timer hooks */
+
+       /*
+        * All done.
+        */
+       housekeeping_in_progress = 0;
+}