2 * This file contains miscellaneous housekeeping tasks.
4 * Copyright (c) 1987-2021 by the citadel.org team
6 * This program is open source software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License, version 3.
9 * This program is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 * GNU General Public License for more details.
16 #include <libcitadel.h>
18 #include "ctdl_module.h"
19 #include "serv_extensions.h"
21 #include "internet_addressing.h"
23 #include "journaling.h"
24 #include "citadel_ldap.h"
26 void check_sched_shutdown(void) {
27 if ((ScheduledShutdown == 1) && (ContextList == NULL)) {
28 syslog(LOG_NOTICE, "housekeeping: scheduled shutdown initiating");
29 server_shutting_down = 1;
35 * Check (and fix) floor reference counts. This doesn't need to be done
36 * very often, since the counts should remain correct during normal operation.
38 void check_ref_counts_backend(struct ctdlroom *qrbuf, void *data) {
42 new_refcounts = (int *) data;
44 ++new_refcounts[(int)qrbuf->QRfloor];
48 void check_ref_counts(void) {
52 int new_refcounts[MAXFLOORS];
54 syslog(LOG_DEBUG, "housekeeping: checking floor reference counts");
55 for (a=0; a<MAXFLOORS; ++a) {
59 cdb_begin_transaction();
60 CtdlForEachRoom(check_ref_counts_backend, (void *)new_refcounts );
61 cdb_end_transaction();
63 for (a=0; a<MAXFLOORS; ++a) {
65 flbuf.f_ref_count = new_refcounts[a];
66 if (new_refcounts[a] > 0) {
67 flbuf.f_flags = flbuf.f_flags | QR_INUSE;
70 flbuf.f_flags = flbuf.f_flags & ~QR_INUSE;
73 syslog(LOG_DEBUG, "housekeeping: floor %d has %d rooms", a, new_refcounts[a]);
79 * Provide hints as to whether we have any memory leaks
81 void keep_an_eye_on_memory_usage(void) {
82 static void *original_brk = NULL;
83 if (!original_brk) original_brk = sbrk(0); // Remember the original program break so we can test for leaks
84 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
89 * This is the housekeeping loop. Worker threads come through here after
90 * processing client requests but before jumping back into the pool. We
91 * only allow housekeeping to execute once per minute, and we only allow one
92 * instance to run at a time.
94 static int housekeeping_in_progress = 0;
95 static int housekeeping_disabled = 0;
96 static time_t last_timer = 0L;
98 void do_housekeeping(void) {
99 int do_housekeeping_now = 0;
100 int do_perminute_housekeeping_now = 0;
103 if (housekeeping_disabled) {
108 * We do it this way instead of wrapping the whole loop in an
109 * S_HOUSEKEEPING critical section because it eliminates the need to
110 * potentially have multiple concurrent mutexes in progress.
112 begin_critical_section(S_HOUSEKEEPING);
113 if (housekeeping_in_progress == 0) {
114 do_housekeeping_now = 1;
115 housekeeping_in_progress = 1;
117 end_critical_section(S_HOUSEKEEPING);
120 if ( (do_housekeeping_now == 0) && (!CtdlIsSingleUser()) ) {
121 if ( (now - last_timer) > (time_t)300 ) {
123 "housekeeping: WARNING: housekeeping loop has not run for %ld minutes. Is something stuck?",
124 ((now - last_timer) / 60)
131 * Ok, at this point we've made the decision to run the housekeeping
132 * loop. Everything below this point is real work.
135 if ( (now - last_timer) > (time_t)60 ) {
136 do_perminute_housekeeping_now = 1;
137 last_timer = time(NULL);
140 /* First, do the "as often as needed" stuff... */
142 PerformSessionHooks(EVT_HOUSE);
144 /* Then, do the "once per minute" stuff... */
145 if (do_perminute_housekeeping_now) {
147 PerformSessionHooks(EVT_TIMER); // Run all registered TIMER hooks
149 #ifdef HAVE_LDAP // LDAP sync isn't in a module so we can put it here
150 static time_t last_ldap_sync = 0L;
151 if ( (now - last_ldap_sync) > (time_t)CtdlGetConfigLong("c_ldap_sync_freq") ) {
152 CtdlSynchronizeUsersFromLDAP();
153 last_ldap_sync = time(NULL);
157 keep_an_eye_on_memory_usage();
163 begin_critical_section(S_HOUSEKEEPING);
164 housekeeping_in_progress = 0;
165 end_critical_section(S_HOUSEKEEPING);
169 void CtdlDisableHouseKeeping(void) {
170 syslog(LOG_INFO, "housekeeping: trying to disable");
171 while ( (!housekeeping_disabled) && (!server_shutting_down) && (!housekeeping_in_progress) ) {
173 if (housekeeping_in_progress) {
177 begin_critical_section(S_HOUSEKEEPING);
178 if (!housekeeping_in_progress) {
179 housekeeping_disabled = 1;
181 end_critical_section(S_HOUSEKEEPING);
184 syslog(LOG_INFO, "housekeeping: disabled now");
188 void CtdlEnableHouseKeeping(void) {
189 begin_critical_section(S_HOUSEKEEPING);
190 housekeeping_in_progress = 0;
191 end_critical_section(S_HOUSEKEEPING);