citadel/housekeeping.c

   1 /*
   2  * This file contains miscellaneous housekeeping tasks.
   3  *
   4  * Copyright (c) 1987-2021 by the citadel.org team
   5  *
   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.
   8  *
   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.
  13  */
  14
  15 #include <stdio.h>
  16 #include <libcitadel.h>
  17
  18 #include "ctdl_module.h"
  19 #include "serv_extensions.h"
  20 #include "room_ops.h"
  21 #include "internet_addressing.h"
  22 #include "config.h"
  23 #include "journaling.h"
  24 #include "citadel_ldap.h"
  25
  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;
  30         }
  31 }
  32
  33
  34 /*
  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.
  37  */
  38 void check_ref_counts_backend(struct ctdlroom *qrbuf, void *data) {
  39
  40         int *new_refcounts;
  41
  42         new_refcounts = (int *) data;
  43
  44         ++new_refcounts[(int)qrbuf->QRfloor];
  45 }
  46
  47
  48 void check_ref_counts(void) {
  49         struct floor flbuf;
  50         int a;
  51
  52         int new_refcounts[MAXFLOORS];
  53
  54         syslog(LOG_DEBUG, "housekeeping: checking floor reference counts");
  55         for (a=0; a<MAXFLOORS; ++a) {
  56                 new_refcounts[a] = 0;
  57         }
  58
  59         cdb_begin_transaction();
  60         CtdlForEachRoom(check_ref_counts_backend, (void *)new_refcounts );
  61         cdb_end_transaction();
  62
  63         for (a=0; a<MAXFLOORS; ++a) {
  64                 lgetfloor(&flbuf, a);
  65                 flbuf.f_ref_count = new_refcounts[a];
  66                 if (new_refcounts[a] > 0) {
  67                         flbuf.f_flags = flbuf.f_flags | QR_INUSE;
  68                 }
  69                 else {
  70                         flbuf.f_flags = flbuf.f_flags & ~QR_INUSE;
  71                 }
  72                 lputfloor(&flbuf, a);
  73                 syslog(LOG_DEBUG, "housekeeping: floor %d has %d rooms", a, new_refcounts[a]);
  74         }
  75 }
  76
  77
  78 /*
  79  * Provide hints as to whether we have any memory leaks
  80  */
  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
  85 }
  86
  87
  88 /*
  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.
  93  */
  94 static int housekeeping_in_progress = 0;
  95 static time_t last_timer = 0L;
  96 void do_housekeeping(void) {
  97         int do_housekeeping_now = 0;
  98         int do_perminute_housekeeping_now = 0;
  99         time_t now;
 100
 101         /*
 102          * We do it this way instead of wrapping the whole loop in an
 103          * S_HOUSEKEEPING critical section because it eliminates the need to
 104          * potentially have multiple concurrent mutexes in progress.
 105          */
 106         begin_critical_section(S_HOUSEKEEPING);
 107         if (housekeeping_in_progress == 0) {
 108                 do_housekeeping_now = 1;
 109                 housekeeping_in_progress = 1;
 110         }
 111         end_critical_section(S_HOUSEKEEPING);
 112
 113         now = time(NULL);
 114         if ( (do_housekeeping_now == 0) && (!CtdlIsSingleUser()) ) {
 115                 if ( (now - last_timer) > (time_t)300 ) {
 116                         syslog(LOG_WARNING,
 117                                 "housekeeping: WARNING: housekeeping loop has not run for %ld minutes.  Is something stuck?",
 118                                 ((now - last_timer) / 60)
 119                         );
 120                 }
 121                 return;
 122         }
 123
 124         /*
 125          * Ok, at this point we've made the decision to run the housekeeping
 126          * loop.  Everything below this point is real work.
 127          */
 128
 129         if ( (now - last_timer) > (time_t)60 ) {
 130                 do_perminute_housekeeping_now = 1;
 131                 last_timer = time(NULL);
 132         }
 133
 134         /* First, do the "as often as needed" stuff... */
 135         JournalRunQueue();
 136         PerformSessionHooks(EVT_HOUSE);
 137
 138         /* Then, do the "once per minute" stuff... */
 139         if (do_perminute_housekeeping_now) {
 140                 cdb_check_handles();
 141                 PerformSessionHooks(EVT_TIMER);         // Run all registered TIMER hooks
 142
 143 #ifdef HAVE_LDAP                                        // LDAP sync isn't in a module so we can put it here
 144                 static time_t last_ldap_sync = 0L;
 145                 if ( (now - last_ldap_sync) > (time_t)CtdlGetConfigLong("c_ldap_sync_freq") ) {
 146                         CtdlSynchronizeUsersFromLDAP();
 147                         last_ldap_sync = time(NULL);
 148                 }
 149 #endif
 150
 151         keep_an_eye_on_memory_usage();
 152         }
 153
 154         /*
 155          * All done.
 156          */
 157         begin_critical_section(S_HOUSEKEEPING);
 158         housekeeping_in_progress = 0;
 159         end_critical_section(S_HOUSEKEEPING);
 160 }
 161
 162
 163 void CtdlDisableHouseKeeping(void) {
 164         int ActiveBackgroundJobs;
 165         int do_housekeeping_now = 0;
 166         struct CitContext *nptr;
 167         int nContexts, i;
 168
 169 retry_block_housekeeping:
 170         syslog(LOG_INFO, "housekeeping: trying to disable services");
 171         begin_critical_section(S_HOUSEKEEPING);
 172         if (housekeeping_in_progress == 0) {
 173                 do_housekeeping_now = 1;
 174                 housekeeping_in_progress = 1;
 175         }
 176         end_critical_section(S_HOUSEKEEPING);
 177         if (do_housekeeping_now == 0) {
 178                 usleep(1000000);
 179                 goto retry_block_housekeeping;
 180         }
 181
 182         syslog(LOG_INFO, "housekeeping: checking for running server jobs");
 183
 184 retry_wait_for_contexts:
 185         /* So that we don't keep the context list locked for a long time
 186          * we create a copy of it first
 187          */
 188         ActiveBackgroundJobs = 0;
 189         nptr = CtdlGetContextArray(&nContexts) ;
 190         if (nptr)
 191         {
 192                 for (i=0; i<nContexts; i++)
 193                 {
 194                         if ((nptr[i].state != CON_SYS) || (nptr[i].lastcmd == 0))
 195                                 continue;
 196                         ActiveBackgroundJobs ++;
 197                         syslog(LOG_INFO, "jousekeeping: job CC[%d] active; use TERM if you don't want to wait for it", nptr[i].cs_pid);
 198
 199                 }
 200
 201                 free(nptr);
 202
 203         }
 204         if (ActiveBackgroundJobs != 0) {
 205                 syslog(LOG_INFO, "housekeeping: found %d running jobs, need to wait", ActiveBackgroundJobs);
 206                 usleep(5000000);
 207                 goto retry_wait_for_contexts;
 208         }
 209         syslog(LOG_INFO, "housekeeping: disabled now.");
 210 }
 211
 212
 213 void CtdlEnableHouseKeeping(void) {
 214         begin_critical_section(S_HOUSEKEEPING);
 215         housekeeping_in_progress = 0;
 216         end_critical_section(S_HOUSEKEEPING);
 217 }