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, 2001, 2002 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 void free_jcr(JCR *jcr)
 157 {
 158    Dmsg0(200, "Enter free_jcr\n");
 159    P(mutex);
 160    jcr->use_count--;                  /* decrement use count */
 161    Dmsg1(200, "Decrement jcr use_count=%d\n", jcr->use_count);
 162    if (jcr->use_count > 0) {          /* if in use */
 163       V(mutex);
 164       Dmsg1(200, "jcr use_count=%d\n", jcr->use_count);
 165       return;
 166    }
 167    remove_jcr(jcr);
 168    V(mutex);
 169
 170    jcr->daemon_free_jcr(jcr);         /* call daemon free routine */
 171    free_common_jcr(jcr);
 172    Dmsg0(200, "Exit free_jcr\n");
 173 }
 174
 175
 176 /*
 177  * Global routine to free a jcr
 178  *  JCR chain is already locked
 179  */
 180 void free_locked_jcr(JCR *jcr)
 181 {
 182    jcr->use_count--;                  /* decrement use count */
 183    Dmsg1(200, "Decrement jcr use_count=%d\n", jcr->use_count);
 184    if (jcr->use_count > 0) {          /* if in use */
 185       return;
 186    }
 187    remove_jcr(jcr);
 188    jcr->daemon_free_jcr(jcr);         /* call daemon free routine */
 189    free_common_jcr(jcr);
 190 }
 191
 192
 193
 194
 195 /*
 196  * Given a JobId, find the JCR
 197  *   Returns: jcr on success
 198  *            NULL on failure
 199  */
 200 JCR *get_jcr_by_id(uint32_t JobId)
 201 {
 202    JCR *jcr;
 203
 204    P(mutex);
 205    for (jcr = jobs; jcr; jcr=jcr->next) {
 206       if (jcr->JobId == JobId) {
 207          jcr->use_count++;
 208          Dmsg1(200, "Increment jcr use_count=%d\n", jcr->use_count);
 209          break;
 210       }
 211    }
 212    V(mutex);
 213    return jcr;
 214 }
 215
 216 /*
 217  * Given a SessionId and SessionTime, find the JCR
 218  *   Returns: jcr on success
 219  *            NULL on failure
 220  */
 221 JCR *get_jcr_by_session(uint32_t SessionId, uint32_t SessionTime)
 222 {
 223    JCR *jcr;
 224
 225    P(mutex);
 226    for (jcr = jobs; jcr; jcr=jcr->next) {
 227       if (jcr->VolSessionId == SessionId &&
 228           jcr->VolSessionTime == SessionTime) {
 229          jcr->use_count++;
 230          Dmsg1(200, "Increment jcr use_count=%d\n", jcr->use_count);
 231          break;
 232       }
 233    }
 234    V(mutex);
 235    return jcr;
 236 }
 237
 238
 239 /*
 240  * Given a Job, find the JCR
 241  *  compares on the number of characters in Job
 242  *  thus allowing partial matches.
 243  *   Returns: jcr on success
 244  *            NULL on failure
 245  */
 246 JCR *get_jcr_by_partial_name(char *Job)
 247 {
 248    JCR *jcr;
 249    int len;
 250
 251    P(mutex);
 252    len = strlen(Job);
 253    for (jcr = jobs; jcr; jcr=jcr->next) {
 254       if (strncmp(Job, jcr->Job, len) == 0) {
 255          jcr->use_count++;
 256          Dmsg1(200, "Increment jcr use_count=%d\n", jcr->use_count);
 257          break;
 258       }
 259    }
 260    V(mutex);
 261    return jcr;
 262 }
 263
 264
 265 /*
 266  * Given a Job, find the JCR
 267  *  requires an exact match of names.
 268  *   Returns: jcr on success
 269  *            NULL on failure
 270  */
 271 JCR *get_jcr_by_full_name(char *Job)
 272 {
 273    JCR *jcr;
 274
 275    P(mutex);
 276    for (jcr = jobs; jcr; jcr=jcr->next) {
 277       if (strcmp(jcr->Job, Job) == 0) {
 278          jcr->use_count++;
 279          Dmsg1(200, "Increment jcr use_count=%d\n", jcr->use_count);
 280          break;
 281       }
 282    }
 283    V(mutex);
 284    return jcr;
 285 }
 286
 287 /*
 288  * Lock the chain
 289  */
 290 void lock_jcr_chain()
 291 {
 292    P(mutex);
 293 }
 294
 295 /*
 296  * Unlock the chain
 297  */
 298 void unlock_jcr_chain()
 299 {
 300    V(mutex);
 301 }
 302
 303
 304 JCR *get_next_jcr(JCR *jcr)
 305 {
 306    JCR *rjcr;
 307
 308    if (jcr == NULL) {
 309       rjcr = jobs;
 310    } else {
 311       rjcr = jcr->next;
 312    }
 313    if (rjcr) {
 314       rjcr->use_count++;
 315       Dmsg1(200, "Increment jcr use_count=%d\n", rjcr->use_count);
 316    }
 317    return rjcr;
 318 }