git.sur5r.net Git - bacula/bacula/blob - bacula/src/lib/jcr.c

   1 /*
   2  * Manipulation routines for Job Control Records
   3  *
   4  *  Kern E. Sibbald, December 2000
   5  *
   6  *  Version $Id$
   7  *
   8  *  These routines are thread safe.
   9  *
  10  */
  11 /*
  12    Copyright (C) 2000-2003 Kern Sibbald and John Walker
  13
  14    This program is free software; you can redistribute it and/or
  15    modify it under the terms of the GNU General Public License as
  16    published by the Free Software Foundation; either version 2 of
  17    the License, or (at your option) any later version.
  18
  19    This program is distributed in the hope that it will be useful,
  20    but WITHOUT ANY WARRANTY; without even the implied warranty of
  21    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  22    General Public License for more details.
  23
  24    You should have received a copy of the GNU General Public
  25    License along with this program; if not, write to the Free
  26    Software Foundation, Inc., 59 Temple Place - Suite 330, Boston,
  27    MA 02111-1307, USA.
  28
  29  */
  30
  31 #include "bacula.h"
  32 #include "jcr.h"
  33
  34 struct s_last_job last_job;           /* last job run by this daemon */
  35
  36 static JCR *jobs = NULL;              /* pointer to JCR chain */
  37 static pthread_mutex_t mutex = PTHREAD_MUTEX_INITIALIZER;
  38
  39 /*
  40  * Create a Job Control Record and link it into JCR chain
  41  * Returns newly allocated JCR
  42  * Note, since each daemon has a different JCR, he passes
  43  *  us the size.
  44  */
  45 JCR *new_jcr(int size, JCR_free_HANDLER *daemon_free_jcr)
  46 {
  47    JCR *jcr;
  48
  49    Dmsg0(200, "Enter new_jcr\n");
  50    jcr = (JCR *)malloc(size);
  51    memset(jcr, 0, size);
  52    jcr->my_thread_id = pthread_self();
  53    jcr->sched_time = time(NULL);
  54    jcr->daemon_free_jcr = daemon_free_jcr;    /* plug daemon free routine */
  55    jcr->use_count = 1;
  56    pthread_mutex_init(&(jcr->mutex), NULL);
  57    jcr->JobStatus = JS_Created;       /* ready to run */
  58    jcr->VolumeName = get_pool_memory(PM_FNAME);
  59    jcr->VolumeName[0] = 0;
  60    jcr->errmsg = get_pool_memory(PM_MESSAGE);
  61    jcr->errmsg[0] = 0;
  62
  63    P(mutex);
  64    jcr->prev = NULL;
  65    jcr->next = jobs;
  66    if (jobs) {
  67       jobs->prev = jcr;
  68    }
  69    jobs = jcr;
  70    V(mutex);
  71    return jcr;
  72 }
  73
  74
  75 /*
  76  * Remove a JCR from the chain
  77  * NOTE! The chain must be locked prior to calling
  78  *       this routine.
  79  */
  80 static void remove_jcr(JCR *jcr)
  81 {
  82    Dmsg0(150, "Enter remove_jcr\n");
  83    if (!jcr) {
  84       Emsg0(M_ABORT, 0, "NULL jcr.\n");
  85    }
  86    if (!jcr->prev) {                  /* if no prev */
  87       jobs = jcr->next;               /* set new head */
  88    } else {
  89       jcr->prev->next = jcr->next;    /* update prev */
  90    }
  91    if (jcr->next) {
  92       jcr->next->prev = jcr->prev;
  93    }
  94    Dmsg0(150, "Leave remove_jcr\n");
  95 }
  96
  97 /*
  98  * Free stuff common to all JCRs
  99  */
 100 static void free_common_jcr(JCR *jcr)
 101 {
 102    /* Keep some statistics */
 103    switch (jcr->JobType) {
 104       case JT_BACKUP:
 105       case JT_VERIFY:
 106       case JT_RESTORE:
 107          last_job.NumJobs++;
 108          last_job.JobType = jcr->JobType;
 109          last_job.JobId = jcr->JobId;
 110          last_job.VolSessionId = jcr->VolSessionId;
 111          last_job.VolSessionTime = jcr->VolSessionTime;
 112          strcpy(last_job.Job, jcr->Job);
 113          last_job.JobFiles = jcr->JobFiles;
 114          last_job.JobBytes = jcr->JobBytes;
 115          last_job.JobStatus = jcr->JobStatus;
 116          last_job.start_time = jcr->start_time;
 117          last_job.end_time = time(NULL);
 118          break;
 119       default:
 120          break;
 121    }
 122    pthread_mutex_destroy(&jcr->mutex);
 123
 124    close_msg(jcr);                    /* close messages for this job */
 125
 126    /* do this after closing messages */
 127    if (jcr->client_name) {
 128       free_pool_memory(jcr->client_name);
 129       jcr->client_name = NULL;
 130    }
 131
 132    if (jcr->sd_auth_key) {
 133       Dmsg0(200, "Free JCR sd_auth_key\n");
 134       free(jcr->sd_auth_key);
 135       jcr->sd_auth_key = NULL;
 136    }
 137    if (jcr->VolumeName) {
 138       free_pool_memory(jcr->VolumeName);
 139       jcr->VolumeName = NULL;
 140    }
 141
 142    if (jcr->dir_bsock) {
 143       bnet_close(jcr->dir_bsock);
 144       jcr->dir_bsock = NULL;
 145    }
 146    if (jcr->errmsg) {
 147       free_pool_memory(jcr->errmsg);
 148       jcr->errmsg = NULL;
 149    }
 150    free(jcr);
 151 }
 152
 153 /*
 154  * Global routine to free a jcr
 155  */
 156 #ifdef DEBUG
 157 void b_free_jcr(char *file, int line, JCR *jcr)
 158 {
 159    Dmsg3(200, "Enter free_jcr 0x%x from %s:%d\n", jcr, file, line);
 160
 161 #else
 162
 163 void free_jcr(JCR *jcr)
 164 {
 165    Dmsg1(200, "Enter free_jcr 0x%x\n", jcr);
 166
 167 #endif
 168
 169    P(mutex);
 170    jcr->use_count--;                  /* decrement use count */
 171    Dmsg2(200, "Decrement jcr 0x%x use_count=%d\n", jcr, jcr->use_count);
 172    if (jcr->use_count > 0) {          /* if in use */
 173       V(mutex);
 174       Dmsg2(200, "jcr 0x%x use_count=%d\n", jcr, jcr->use_count);
 175       return;
 176    }
 177    remove_jcr(jcr);
 178    V(mutex);
 179
 180    if (jcr->daemon_free_jcr) {
 181       jcr->daemon_free_jcr(jcr);      /* call daemon free routine */
 182    }
 183    free_common_jcr(jcr);
 184
 185    P(mutex);
 186    close_msg(NULL);                   /* flush any daemon messages */
 187    V(mutex);
 188    Dmsg0(200, "Exit free_jcr\n");
 189 }
 190
 191
 192 /*
 193  * Global routine to free a jcr
 194  *  JCR chain is already locked
 195  */
 196 void free_locked_jcr(JCR *jcr)
 197 {
 198    jcr->use_count--;                  /* decrement use count */
 199    Dmsg2(200, "Decrement jcr 0x%x use_count=%d\n", jcr, jcr->use_count);
 200    if (jcr->use_count > 0) {          /* if in use */
 201       return;
 202    }
 203    remove_jcr(jcr);
 204    jcr->daemon_free_jcr(jcr);         /* call daemon free routine */
 205    free_common_jcr(jcr);
 206 }
 207
 208
 209
 210
 211 /*
 212  * Given a JobId, find the JCR
 213  *   Returns: jcr on success
 214  *            NULL on failure
 215  */
 216 JCR *get_jcr_by_id(uint32_t JobId)
 217 {
 218    JCR *jcr;
 219
 220    P(mutex);
 221    for (jcr = jobs; jcr; jcr=jcr->next) {
 222       if (jcr->JobId == JobId) {
 223          jcr->use_count++;
 224          Dmsg2(200, "Increment jcr 0x%x use_count=%d\n", jcr, jcr->use_count);
 225          break;
 226       }
 227    }
 228    V(mutex);
 229    return jcr;
 230 }
 231
 232 /*
 233  * Given a SessionId and SessionTime, find the JCR
 234  *   Returns: jcr on success
 235  *            NULL on failure
 236  */
 237 JCR *get_jcr_by_session(uint32_t SessionId, uint32_t SessionTime)
 238 {
 239    JCR *jcr;
 240
 241    P(mutex);
 242    for (jcr = jobs; jcr; jcr=jcr->next) {
 243       if (jcr->VolSessionId == SessionId &&
 244           jcr->VolSessionTime == SessionTime) {
 245          jcr->use_count++;
 246          Dmsg2(200, "Increment jcr 0x%x use_count=%d\n", jcr, jcr->use_count);
 247          break;
 248       }
 249    }
 250    V(mutex);
 251    return jcr;
 252 }
 253
 254
 255 /*
 256  * Given a Job, find the JCR
 257  *  compares on the number of characters in Job
 258  *  thus allowing partial matches.
 259  *   Returns: jcr on success
 260  *            NULL on failure
 261  */
 262 JCR *get_jcr_by_partial_name(char *Job)
 263 {
 264    JCR *jcr;
 265    int len;
 266
 267    P(mutex);
 268    len = strlen(Job);
 269    for (jcr = jobs; jcr; jcr=jcr->next) {
 270       if (strncmp(Job, jcr->Job, len) == 0) {
 271          jcr->use_count++;
 272          Dmsg2(200, "Increment jcr 0x%x use_count=%d\n", jcr, jcr->use_count);
 273          break;
 274       }
 275    }
 276    V(mutex);
 277    return jcr;
 278 }
 279
 280
 281 /*
 282  * Given a Job, find the JCR
 283  *  requires an exact match of names.
 284  *   Returns: jcr on success
 285  *            NULL on failure
 286  */
 287 JCR *get_jcr_by_full_name(char *Job)
 288 {
 289    JCR *jcr;
 290
 291    P(mutex);
 292    for (jcr = jobs; jcr; jcr=jcr->next) {
 293       if (strcmp(jcr->Job, Job) == 0) {
 294          jcr->use_count++;
 295          Dmsg2(200, "Increment jcr 0x%x use_count=%d\n", jcr, jcr->use_count);
 296          break;
 297       }
 298    }
 299    V(mutex);
 300    return jcr;
 301 }
 302
 303 void set_jcr_job_status(JCR *jcr, int JobStatus)
 304 {
 305    /*
 306     * For a set of errors, ... keep the current status
 307     *   so it isn't lost. For all others, set it.
 308     */
 309    switch (jcr->JobStatus) {
 310    case JS_ErrorTerminated:
 311    case JS_Error:
 312    case JS_FatalError:
 313    case JS_Differences:
 314    case JS_Canceled:
 315       break;
 316    default:
 317       jcr->JobStatus = JobStatus;
 318    }
 319 }
 320
 321 /*
 322  * Lock the chain
 323  */
 324 void lock_jcr_chain()
 325 {
 326    P(mutex);
 327 }
 328
 329 /*
 330  * Unlock the chain
 331  */
 332 void unlock_jcr_chain()
 333 {
 334    V(mutex);
 335 }
 336
 337
 338 JCR *get_next_jcr(JCR *jcr)
 339 {
 340    JCR *rjcr;
 341
 342    if (jcr == NULL) {
 343       rjcr = jobs;
 344    } else {
 345       rjcr = jcr->next;
 346    }
 347    if (rjcr) {
 348       rjcr->use_count++;
 349       Dmsg1(200, "Increment jcr use_count=%d\n", rjcr->use_count);
 350    }
 351    return rjcr;
 352 }