citadel/housekeeping.c

   1 /*
   2  * This file contains miscellaneous housekeeping tasks.
   3  *
   4  * Copyright (c) 1987-2018 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 {
  83         static void *original_brk = NULL;
  84         if (!original_brk) original_brk = sbrk(0);      // Remember the original program break so we can test for leaks
  85         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
  86 }
  87
  88
  89 /*
  90  * This is the housekeeping loop.  Worker threads come through here after
  91  * processing client requests but before jumping back into the pool.  We
  92  * only allow housekeeping to execute once per minute, and we only allow one
  93  * instance to run at a time.
  94  */
  95 static int housekeeping_in_progress = 0;
  96 static time_t last_timer = 0L;
  97 void do_housekeeping(void) {
  98         int do_housekeeping_now = 0;
  99         int do_perminute_housekeeping_now = 0;
 100         time_t now;
 101
 102         /*
 103          * We do it this way instead of wrapping the whole loop in an
 104          * S_HOUSEKEEPING critical section because it eliminates the need to
 105          * potentially have multiple concurrent mutexes in progress.
 106          */
 107         begin_critical_section(S_HOUSEKEEPING);
 108         if (housekeeping_in_progress == 0) {
 109                 do_housekeeping_now = 1;
 110                 housekeeping_in_progress = 1;
 111         }
 112         end_critical_section(S_HOUSEKEEPING);
 113
 114         now = time(NULL);
 115         if (do_housekeeping_now == 0) {
 116                 if ( (now - last_timer) > (time_t)300 ) {
 117                         syslog(LOG_WARNING,
 118                                 "housekeeping: WARNING: housekeeping loop has not run for %ld minutes.  Is something stuck?",
 119                                 ((now - last_timer) / 60)
 120                         );
 121                 }
 122                 return;
 123         }
 124
 125         /*
 126          * Ok, at this point we've made the decision to run the housekeeping
 127          * loop.  Everything below this point is real work.
 128          */
 129
 130         if ( (now - last_timer) > (time_t)60 ) {
 131                 do_perminute_housekeeping_now = 1;
 132                 last_timer = time(NULL);
 133         }
 134
 135         /* First, do the "as often as needed" stuff... */
 136         JournalRunQueue();
 137         PerformSessionHooks(EVT_HOUSE);
 138
 139         /* Then, do the "once per minute" stuff... */
 140         if (do_perminute_housekeeping_now) {
 141                 cdb_check_handles();
 142                 PerformSessionHooks(EVT_TIMER);         // Run all registered TIMER hooks
 143
 144 #ifdef HAVE_LDAP                                        // LDAP sync isn't in a module so we can put it here
 145                 static time_t last_ldap_sync = 0L;
 146                 if ( (now - last_ldap_sync) > (time_t)CtdlGetConfigLong("c_ldap_sync_freq") ) {
 147                         CtdlSynchronizeUsersFromLDAP();
 148                         last_ldap_sync = time(NULL);
 149                 }
 150 #endif
 151
 152         keep_an_eye_on_memory_usage();
 153         }
 154
 155         /*
 156          * All done.
 157          */
 158         begin_critical_section(S_HOUSEKEEPING);
 159         housekeeping_in_progress = 0;
 160         end_critical_section(S_HOUSEKEEPING);
 161 }
 162
 163
 164 void CtdlDisableHouseKeeping(void)
 165 {
 166         int ActiveBackgroundJobs;
 167         int do_housekeeping_now = 0;
 168         struct CitContext *nptr;
 169         int nContexts, i;
 170
 171 retry_block_housekeeping:
 172         syslog(LOG_INFO, "housekeeping: trying to disable services");
 173         begin_critical_section(S_HOUSEKEEPING);
 174         if (housekeeping_in_progress == 0) {
 175                 do_housekeeping_now = 1;
 176                 housekeeping_in_progress = 1;
 177         }
 178         end_critical_section(S_HOUSEKEEPING);
 179         if (do_housekeeping_now == 0) {
 180                 usleep(1000000);
 181                 goto retry_block_housekeeping;
 182         }
 183
 184         syslog(LOG_INFO, "housekeeping: checking for running server jobs");
 185
 186 retry_wait_for_contexts:
 187         /* So that we don't keep the context list locked for a long time
 188          * we create a copy of it first
 189          */
 190         ActiveBackgroundJobs = 0;
 191         nptr = CtdlGetContextArray(&nContexts) ;
 192         if (nptr)
 193         {
 194                 for (i=0; i<nContexts; i++)
 195                 {
 196                         if ((nptr[i].state != CON_SYS) || (nptr[i].lastcmd == 0))
 197                                 continue;
 198                         ActiveBackgroundJobs ++;
 199                         syslog(LOG_INFO, "jousekeeping: job CC[%d] active; use TERM if you don't want to wait for it", nptr[i].cs_pid);
 200
 201                 }
 202
 203                 free(nptr);
 204
 205         }
 206         if (ActiveBackgroundJobs != 0) {
 207                 syslog(LOG_INFO, "housekeeping: found %d running jobs, need to wait", ActiveBackgroundJobs);
 208                 usleep(5000000);
 209                 goto retry_wait_for_contexts;
 210         }
 211         syslog(LOG_INFO, "housekeeping: disabled now.");
 212 }
 213
 214
 215 void CtdlEnableHouseKeeping(void)
 216 {
 217         begin_critical_section(S_HOUSEKEEPING);
 218         housekeeping_in_progress = 0;
 219         end_critical_section(S_HOUSEKEEPING);
 220 }