/*
* This file contains miscellaneous housekeeping tasks.
+ *
+ * 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.
+ *
+ * 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 <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 <limits.h>
-#include <sys/types.h>
-#ifdef HAVE_SYS_SELECT_H
-#include <sys/select.h>
-#endif
#include <libcitadel.h>
-#include "citadel.h"
-#include "server.h"
+
+#include "ctdl_module.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"
-#include "msgbase.h"
+#include "internet_addressing.h"
+#include "config.h"
#include "journaling.h"
-
-#include "ctdl_module.h"
-#include "threads.h"
+#include "citadel_ldap.h"
void check_sched_shutdown(void) {
if ((ScheduledShutdown == 1) && (ContextList == NULL)) {
- CtdlLogPrintf(CTDL_NOTICE, "Scheduled shutdown initiating.\n");
- CtdlThreadStopAll();
+ 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.
++new_refcounts[(int)qrbuf->QRfloor];
}
+
void check_ref_counts(void) {
struct floor flbuf;
int a;
int new_refcounts[MAXFLOORS];
- CtdlLogPrintf(CTDL_DEBUG, "Checking floor reference counts\n");
+ syslog(LOG_DEBUG, "housekeeping: checking floor reference counts");
for (a=0; a<MAXFLOORS; ++a) {
new_refcounts[a] = 0;
}
flbuf.f_flags = flbuf.f_flags & ~QR_INUSE;
}
lputfloor(&flbuf, a);
- CtdlLogPrintf(CTDL_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
* 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 int housekeeping_disabled = 0;
+static time_t last_timer = 0L;
+
void do_housekeeping(void) {
- static int housekeeping_in_progress = 0;
- static time_t last_timer = 0L;
int do_housekeeping_now = 0;
int do_perminute_housekeeping_now = 0;
time_t now;
- const char *old_name;
+
+ if (housekeeping_disabled) {
+ return;
+ }
/*
* We do it this way instead of wrapping the whole loop in an
if (housekeeping_in_progress == 0) {
do_housekeeping_now = 1;
housekeeping_in_progress = 1;
- now = time(NULL);
- if ( (now - last_timer) > (time_t)60 ) {
- do_perminute_housekeeping_now = 1;
- last_timer = time(NULL);
- }
}
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;
}
* loop. Everything below this point is real work.
*/
+ if ( (now - last_timer) > (time_t)60 ) {
+ do_perminute_housekeeping_now = 1;
+ last_timer = time(NULL);
+ }
+
/* First, do the "as often as needed" stuff... */
- old_name = CtdlThreadName("House Keeping - Journal");
JournalRunQueue();
-
- CtdlThreadName("House Keeping - EVT_HOUSE");
- PerformSessionHooks(EVT_HOUSE); /* perform as needed housekeeping */
+ PerformSessionHooks(EVT_HOUSE);
/* Then, do the "once per minute" stuff... */
if (do_perminute_housekeeping_now) {
- cdb_check_handles(); /* suggested by Justin Case */
- CtdlThreadName("House Keeping - EVT_TIMER");
- 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();
}
/*
* All done.
*/
+ begin_critical_section(S_HOUSEKEEPING);
housekeeping_in_progress = 0;
- CtdlThreadName(old_name);
+ end_critical_section(S_HOUSEKEEPING);
+}
+
+
+void CtdlDisableHouseKeeping(void) {
+ syslog(LOG_INFO, "housekeeping: trying to disable");
+ while ( (!housekeeping_disabled) && (!server_shutting_down) && (!housekeeping_in_progress) ) {
+
+ if (housekeeping_in_progress) {
+ sleep(1);
+ }
+ else {
+ begin_critical_section(S_HOUSEKEEPING);
+ if (!housekeeping_in_progress) {
+ housekeeping_disabled = 1;
+ }
+ end_critical_section(S_HOUSEKEEPING);
+ }
+ }
+ syslog(LOG_INFO, "housekeeping: disabled now");
+}
+
+
+void CtdlEnableHouseKeeping(void) {
+ begin_critical_section(S_HOUSEKEEPING);
+ housekeeping_in_progress = 0;
+ end_critical_section(S_HOUSEKEEPING);
}
projects / citadel.git / blobdiff