Simplified disable_housekeeping
[citadel.git] / citadel / housekeeping.c
index 92336277733acaaeaab8a0bd9145dfeea0cf7ee6..4de8e4baf497317e3ab23578755a7ab6474c4d05 100644 (file)
@@ -1,7 +1,7 @@
 /*
  * This file contains miscellaneous housekeeping tasks.
  *
- * Copyright (c) 1987-2011 by the citadel.org team
+ * Copyright (c) 1987-2021 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.
 #include "serv_extensions.h"
 #include "room_ops.h"
 #include "internet_addressing.h"
+#include "config.h"
 #include "journaling.h"
+#include "citadel_ldap.h"
 
 void check_sched_shutdown(void) {
        if ((ScheduledShutdown == 1) && (ContextList == NULL)) {
-               syslog(LOG_NOTICE, "Scheduled shutdown initiating.\n");
+               syslog(LOG_NOTICE, "housekeeping: scheduled shutdown initiating");
                server_shutting_down = 1;
        }
 }
 
 
-
 /*
  * Check (and fix) floor reference counts.  This doesn't need to be done
  * very often, since the counts should remain correct during normal operation.
@@ -43,13 +44,14 @@ void check_ref_counts_backend(struct ctdlroom *qrbuf, void *data) {
        ++new_refcounts[(int)qrbuf->QRfloor];
 }
 
+
 void check_ref_counts(void) {
        struct floor flbuf;
        int a;
 
        int new_refcounts[MAXFLOORS];
 
-       syslog(LOG_DEBUG, "Checking floor reference counts\n");
+       syslog(LOG_DEBUG, "housekeeping: checking floor reference counts");
        for (a=0; a<MAXFLOORS; ++a) {
                new_refcounts[a] = 0;
        }
@@ -68,9 +70,20 @@ void check_ref_counts(void) {
                        flbuf.f_flags = flbuf.f_flags & ~QR_INUSE;
                }
                lputfloor(&flbuf, a);
-               syslog(LOG_DEBUG, "Floor %d: %d rooms\n", a, new_refcounts[a]);
+               syslog(LOG_DEBUG, "housekeeping: floor %d has %d rooms", a, new_refcounts[a]);
        }
-}      
+}
+
+
+/*
+ * Provide hints as to whether we have any memory leaks
+ */
+void keep_an_eye_on_memory_usage(void) {
+       static void *original_brk = NULL;
+       if (!original_brk) original_brk = sbrk(0);      // Remember the original program break so we can test for leaks
+       syslog(LOG_DEBUG, "original_brk=%lx, current_brk=%lx, addl=%ld", (long)original_brk, (long)sbrk(0), (long)(sbrk(0)-original_brk));      // FIXME not so noisy please
+}
+
 
 /*
  * This is the housekeeping loop.  Worker threads come through here after
@@ -79,12 +92,18 @@ void check_ref_counts(void) {
  * instance to run at a time.
  */
 static int housekeeping_in_progress = 0;
+static int housekeeping_disabled = 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;
 
+       if (housekeeping_disabled) {
+               return;
+       }
+
        /*
         * We do it this way instead of wrapping the whole loop in an
         * S_HOUSEKEEPING critical section because it eliminates the need to
@@ -97,7 +116,14 @@ void do_housekeeping(void) {
        }
        end_critical_section(S_HOUSEKEEPING);
 
-       if (do_housekeeping_now == 0) {
+       now = time(NULL);
+       if ( (do_housekeeping_now == 0) && (!CtdlIsSingleUser()) ) {
+               if ( (now - last_timer) > (time_t)300 ) {
+                       syslog(LOG_WARNING,
+                               "housekeeping: WARNING: housekeeping loop has not run for %ld minutes.  Is something stuck?",
+                               ((now - last_timer) / 60)
+                       );
+               }
                return;
        }
 
@@ -106,7 +132,6 @@ void do_housekeeping(void) {
         * 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);
@@ -118,8 +143,18 @@ void do_housekeeping(void) {
 
        /* 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 */
+               cdb_check_handles();
+               PerformSessionHooks(EVT_TIMER);         // Run all registered TIMER hooks
+
+#ifdef HAVE_LDAP                                       // LDAP sync isn't in a module so we can put it here
+               static time_t last_ldap_sync = 0L;
+               if ( (now - last_ldap_sync) > (time_t)CtdlGetConfigLong("c_ldap_sync_freq") ) {
+                       CtdlSynchronizeUsersFromLDAP();
+                       last_ldap_sync = time(NULL);
+               }
+#endif
+
+       keep_an_eye_on_memory_usage();
        }
 
        /*
@@ -130,58 +165,27 @@ void do_housekeeping(void) {
        end_critical_section(S_HOUSEKEEPING);
 }
 
-void CtdlDisableHouseKeeping(void)
-{
-       int ActiveBackgroundJobs;
-       int do_housekeeping_now = 0;
-       struct CitContext *nptr;
-       int nContexts, i;
 
-retry_block_housekeeping:
-       syslog(LOG_INFO, "trying to disable housekeeping services");
-       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) {
-               usleep(1000000);
-               goto retry_block_housekeeping;
-       }
-       
-       syslog(LOG_INFO, "checking for running server Jobs");
+void CtdlDisableHouseKeeping(void) {
+       syslog(LOG_INFO, "housekeeping: trying to disable");
+       while ( (!housekeeping_disabled) && (!server_shutting_down) && (!housekeeping_in_progress) ) {
 
-retry_wait_for_contexts:
-       /* So that we don't keep the context list locked for a long time
-        * we create a copy of it first
-        */
-       ActiveBackgroundJobs = 0;
-       nptr = CtdlGetContextArray(&nContexts) ;
-       if (nptr)
-       {
-               for (i=0; i<nContexts; i++) 
-               {
-                       if ((nptr[i].state != CON_SYS) || (nptr[i].IO == NULL) || (nptr[i].lastcmd == 0))
-                               continue;
-                       ActiveBackgroundJobs ++;
-                       syslog(LOG_INFO, "Job CC[%d] active; use TERM if you don't want to wait for it",nptr[i].cs_pid);
-               
+               if (housekeeping_in_progress) {
+                       sleep(1);
+               }
+               else {
+                       begin_critical_section(S_HOUSEKEEPING);
+                       if (!housekeeping_in_progress) {
+                               housekeeping_disabled = 1;
+                       }
+                       end_critical_section(S_HOUSEKEEPING);
                }
-       
-               free(nptr);
-
-       }
-       if (ActiveBackgroundJobs != 0) {
-               syslog(LOG_INFO, "found %d running jobs, need to wait", ActiveBackgroundJobs);
-               usleep(5000000);
-               goto retry_wait_for_contexts;
        }
-       syslog(LOG_INFO, "Housekeeping disabled now.");
+       syslog(LOG_INFO, "housekeeping: disabled now");
 }
 
-void CtdlEnableHouseKeeping(void)
-{
+
+void CtdlEnableHouseKeeping(void) {
        begin_critical_section(S_HOUSEKEEPING);
        housekeeping_in_progress = 0;
        end_critical_section(S_HOUSEKEEPING);