git.sur5r.net Git - bacula/bacula/blob - bacula/src/dird/job.c

   1 /*
   2    Bacula® - The Network Backup Solution
   3
   4    Copyright (C) 2000-2007 Free Software Foundation Europe e.V.
   5
   6    The main author of Bacula is Kern Sibbald, with contributions from
   7    many others, a complete list can be found in the file AUTHORS.
   8    This program is Free Software; you can redistribute it and/or
   9    modify it under the terms of version two of the GNU General Public
  10    License as published by the Free Software Foundation and included
  11    in the file LICENSE.
  12
  13    This program is distributed in the hope that it will be useful, but
  14    WITHOUT ANY WARRANTY; without even the implied warranty of
  15    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  16    General Public License for more details.
  17
  18    You should have received a copy of the GNU General Public License
  19    along with this program; if not, write to the Free Software
  20    Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  21    02110-1301, USA.
  22
  23    Bacula® is a registered trademark of John Walker.
  24    The licensor of Bacula is the Free Software Foundation Europe
  25    (FSFE), Fiduciary Program, Sumatrastrasse 25, 8006 Zürich,
  26    Switzerland, email:ftf@fsfeurope.org.
  27 */
  28 /*
  29  *
  30  *   Bacula Director Job processing routines
  31  *
  32  *     Kern Sibbald, October MM
  33  *
  34  *    Version $Id$
  35  */
  36
  37 #include "bacula.h"
  38 #include "dird.h"
  39
  40 /* Forward referenced subroutines */
  41 static void *job_thread(void *arg);
  42 static void job_monitor_watchdog(watchdog_t *self);
  43 static void job_monitor_destructor(watchdog_t *self);
  44 static bool job_check_maxwaittime(JCR *control_jcr, JCR *jcr);
  45 static bool job_check_maxruntime(JCR *control_jcr, JCR *jcr);
  46
  47 /* Imported subroutines */
  48 extern void term_scheduler();
  49 extern void term_ua_server();
  50
  51 /* Imported variables */
  52
  53 jobq_t job_queue;
  54
  55 void init_job_server(int max_workers)
  56 {
  57    int stat;
  58    watchdog_t *wd;
  59
  60    if ((stat = jobq_init(&job_queue, max_workers, job_thread)) != 0) {
  61       berrno be;
  62       Emsg1(M_ABORT, 0, _("Could not init job queue: ERR=%s\n"), be.bstrerror(stat));
  63    }
  64    wd = new_watchdog();
  65    wd->callback = job_monitor_watchdog;
  66    wd->destructor = job_monitor_destructor;
  67    wd->one_shot = false;
  68    wd->interval = 60;
  69    wd->data = new_control_jcr("*JobMonitor*", JT_SYSTEM);
  70    register_watchdog(wd);
  71 }
  72
  73 void term_job_server()
  74 {
  75    jobq_destroy(&job_queue);          /* ignore any errors */
  76 }
  77
  78 /*
  79  * Run a job -- typically called by the scheduler, but may also
  80  *              be called by the UA (Console program).
  81  *
  82  *  Returns: 0 on failure
  83  *           JobId on success
  84  *
  85  */
  86 JobId_t run_job(JCR *jcr)
  87 {
  88    int stat;
  89    if (setup_job(jcr)) {
  90       Dmsg0(200, "Add jrc to work queue\n");
  91       /* Queue the job to be run */
  92       if ((stat = jobq_add(&job_queue, jcr)) != 0) {
  93          berrno be;
  94          Jmsg(jcr, M_FATAL, 0, _("Could not add job queue: ERR=%s\n"), be.bstrerror(stat));
  95          return 0;
  96       }
  97       return jcr->JobId;
  98    }
  99    return 0;
 100 }
 101
 102 bool setup_job(JCR *jcr)
 103 {
 104    int errstat;
 105
 106    jcr->lock();
 107    sm_check(__FILE__, __LINE__, true);
 108    init_msg(jcr, jcr->messages);
 109
 110    /* Initialize termination condition variable */
 111    if ((errstat = pthread_cond_init(&jcr->term_wait, NULL)) != 0) {
 112       berrno be;
 113       Jmsg1(jcr, M_FATAL, 0, _("Unable to init job cond variable: ERR=%s\n"), be.bstrerror(errstat));
 114       goto bail_out;
 115    }
 116    jcr->term_wait_inited = true;
 117
 118    create_unique_job_name(jcr, jcr->job->name());
 119    set_jcr_job_status(jcr, JS_Created);
 120    jcr->unlock();
 121
 122    /*
 123     * Open database
 124     */
 125    Dmsg0(100, "Open database\n");
 126    jcr->db=db_init_database(jcr, jcr->catalog->db_name, jcr->catalog->db_user,
 127                             jcr->catalog->db_password, jcr->catalog->db_address,
 128                             jcr->catalog->db_port, jcr->catalog->db_socket,
 129                             jcr->catalog->mult_db_connections);
 130    if (!jcr->db || !db_open_database(jcr, jcr->db)) {
 131       Jmsg(jcr, M_FATAL, 0, _("Could not open database \"%s\".\n"),
 132                  jcr->catalog->db_name);
 133       if (jcr->db) {
 134          Jmsg(jcr, M_FATAL, 0, "%s", db_strerror(jcr->db));
 135          db_close_database(jcr, jcr->db);
 136       }
 137       goto bail_out;
 138    }
 139    Dmsg0(150, "DB opened\n");
 140
 141    if (!jcr->fname) {
 142       jcr->fname = get_pool_memory(PM_FNAME);
 143    }
 144    if (!jcr->pool_source) {
 145       jcr->pool_source = get_pool_memory(PM_MESSAGE);
 146       pm_strcpy(jcr->pool_source, _("unknown source"));
 147    }
 148    Dmsg2(500, "pool=%s (From %s)\n", jcr->pool->name(), jcr->pool_source);
 149    if (jcr->JobType == JT_MIGRATE) {
 150       if (!jcr->rpool_source) {
 151          jcr->rpool_source = get_pool_memory(PM_MESSAGE);
 152          pm_strcpy(jcr->rpool_source, _("unknown source"));
 153       }
 154    }
 155
 156    /*
 157     * Create Job record
 158     */
 159    init_jcr_job_record(jcr);
 160    if (!get_or_create_client_record(jcr)) {
 161       goto bail_out;
 162    }
 163
 164    if (!db_create_job_record(jcr, jcr->db, &jcr->jr)) {
 165       Jmsg(jcr, M_FATAL, 0, "%s", db_strerror(jcr->db));
 166       goto bail_out;
 167    }
 168    jcr->JobId = jcr->jr.JobId;
 169    Dmsg4(100, "Created job record JobId=%d Name=%s Type=%c Level=%c\n",
 170        jcr->JobId, jcr->Job, jcr->jr.JobType, jcr->jr.JobLevel);
 171
 172    generate_daemon_event(jcr, "JobStart");
 173
 174    if (job_canceled(jcr)) {
 175       goto bail_out;
 176    }
 177
 178    /*
 179     * Now, do pre-run stuff, like setting job level (Inc/diff, ...)
 180     *  this allows us to setup a proper job start record for restarting
 181     *  in case of later errors.
 182     */
 183    switch (jcr->JobType) {
 184    case JT_BACKUP:
 185       if (!do_backup_init(jcr)) {
 186          backup_cleanup(jcr, JS_ErrorTerminated);
 187       }
 188       break;
 189    case JT_VERIFY:
 190       if (!do_verify_init(jcr)) {
 191          verify_cleanup(jcr, JS_ErrorTerminated);
 192       }
 193       break;
 194    case JT_RESTORE:
 195       if (!do_restore_init(jcr)) {
 196          restore_cleanup(jcr, JS_ErrorTerminated);
 197       }
 198       break;
 199    case JT_ADMIN:
 200       if (!do_admin_init(jcr)) {
 201          admin_cleanup(jcr, JS_ErrorTerminated);
 202       }
 203       break;
 204    case JT_MIGRATE:
 205       if (!do_migration_init(jcr)) {
 206          migration_cleanup(jcr, JS_ErrorTerminated);
 207       }
 208       break;
 209    default:
 210       Pmsg1(0, _("Unimplemented job type: %d\n"), jcr->JobType);
 211       set_jcr_job_status(jcr, JS_ErrorTerminated);
 212       break;
 213    }
 214
 215    generate_job_event(jcr, "JobInit");
 216    Dsm_check(1);
 217    return true;
 218
 219 bail_out:
 220    return false;
 221 }
 222
 223 void update_job_end(JCR *jcr, int TermCode)
 224 {
 225    dequeue_messages(jcr);             /* display any queued messages */
 226    set_jcr_job_status(jcr, TermCode);
 227    update_job_end_record(jcr);
 228 }
 229
 230 /*
 231  * This is the engine called by jobq.c:jobq_add() when we were pulled
 232  *  from the work queue.
 233  *  At this point, we are running in our own thread and all
 234  *    necessary resources are allocated -- see jobq.c
 235  */
 236 static void *job_thread(void *arg)
 237 {
 238    JCR *jcr = (JCR *)arg;
 239
 240    jcr->my_thread_id = pthread_self();
 241    pthread_detach(jcr->my_thread_id);
 242    Dsm_check(1);
 243
 244    Dmsg0(200, "=====Start Job=========\n");
 245    set_jcr_job_status(jcr, JS_Running);   /* this will be set only if no error */
 246    jcr->start_time = time(NULL);      /* set the real start time */
 247    jcr->jr.StartTime = jcr->start_time;
 248
 249    if (jcr->job->MaxStartDelay != 0 && jcr->job->MaxStartDelay <
 250        (utime_t)(jcr->start_time - jcr->sched_time)) {
 251       set_jcr_job_status(jcr, JS_Canceled);
 252       Jmsg(jcr, M_FATAL, 0, _("Job canceled because max start delay time exceeded.\n"));
 253    }
 254
 255    /* TODO : check if it is used somewhere */
 256    if (jcr->job->RunScripts == NULL) {
 257       Dmsg0(200, "Warning, job->RunScripts is empty\n");
 258       jcr->job->RunScripts = New(alist(10, not_owned_by_alist));
 259    }
 260
 261    if (!db_update_job_start_record(jcr, jcr->db, &jcr->jr)) {
 262       Jmsg(jcr, M_FATAL, 0, "%s", db_strerror(jcr->db));
 263    }
 264
 265    /* Run any script BeforeJob on dird */
 266    run_scripts(jcr, jcr->job->RunScripts, "BeforeJob");
 267
 268    if (job_canceled(jcr)) {
 269       update_job_end(jcr, jcr->JobStatus);
 270
 271    } else {
 272       /*
 273        * We re-update the job start record so that the start
 274        *  time is set after the run before job.  This avoids
 275        *  that any files created by the run before job will
 276        *  be saved twice.  They will be backed up in the current
 277        *  job, but not in the next one unless they are changed.
 278        *  Without this, they will be backed up in this job and
 279        *  in the next job run because in that case, their date
 280        *   is after the start of this run.
 281        */
 282       jcr->start_time = time(NULL);
 283       jcr->jr.StartTime = jcr->start_time;
 284       if (!db_update_job_start_record(jcr, jcr->db, &jcr->jr)) {
 285          Jmsg(jcr, M_FATAL, 0, "%s", db_strerror(jcr->db));
 286       }
 287       generate_job_event(jcr, "JobRun");
 288
 289       switch (jcr->JobType) {
 290       case JT_BACKUP:
 291          if (do_backup(jcr)) {
 292             do_autoprune(jcr);
 293          } else {
 294             backup_cleanup(jcr, JS_ErrorTerminated);
 295          }
 296          break;
 297       case JT_VERIFY:
 298          if (do_verify(jcr)) {
 299             do_autoprune(jcr);
 300          } else {
 301             verify_cleanup(jcr, JS_ErrorTerminated);
 302          }
 303          break;
 304       case JT_RESTORE:
 305          if (do_restore(jcr)) {
 306             do_autoprune(jcr);
 307          } else {
 308             restore_cleanup(jcr, JS_ErrorTerminated);
 309          }
 310          break;
 311       case JT_ADMIN:
 312          if (do_admin(jcr)) {
 313             do_autoprune(jcr);
 314          } else {
 315             admin_cleanup(jcr, JS_ErrorTerminated);
 316          }
 317          break;
 318       case JT_MIGRATE:
 319       case JT_COPY:
 320       case JT_ARCHIVE:
 321          if (do_migration(jcr)) {
 322             do_autoprune(jcr);
 323          } else {
 324             migration_cleanup(jcr, JS_ErrorTerminated);
 325          }
 326          break;
 327       default:
 328          Pmsg1(0, _("Unimplemented job type: %d\n"), jcr->JobType);
 329          break;
 330       }
 331    }
 332
 333    run_scripts(jcr, jcr->job->RunScripts, "AfterJob");
 334
 335    /* Send off any queued messages */
 336    if (jcr->msg_queue && jcr->msg_queue->size() > 0) {
 337       dequeue_messages(jcr);
 338    }
 339
 340    generate_daemon_event(jcr, "JobEnd");
 341    Dmsg1(50, "======== End Job stat=%c ==========\n", jcr->JobStatus);
 342    sm_check(__FILE__, __LINE__, true);
 343    return NULL;
 344 }
 345
 346
 347 /*
 348  * Cancel a job -- typically called by the UA (Console program), but may also
 349  *              be called by the job watchdog.
 350  *
 351  *  Returns: true  if cancel appears to be successful
 352  *           false on failure. Message sent to ua->jcr.
 353  */
 354 bool cancel_job(UAContext *ua, JCR *jcr)
 355 {
 356    BSOCK *sd, *fd;
 357    char ed1[50];
 358
 359    set_jcr_job_status(jcr, JS_Canceled);
 360
 361    switch (jcr->JobStatus) {
 362    case JS_Created:
 363    case JS_WaitJobRes:
 364    case JS_WaitClientRes:
 365    case JS_WaitStoreRes:
 366    case JS_WaitPriority:
 367    case JS_WaitMaxJobs:
 368    case JS_WaitStartTime:
 369       ua->info_msg(_("JobId %s, Job %s marked to be canceled.\n"),
 370               edit_uint64(jcr->JobId, ed1), jcr->Job);
 371       jobq_remove(&job_queue, jcr); /* attempt to remove it from queue */
 372       return true;
 373
 374    default:
 375       /* Cancel File daemon */
 376       if (jcr->file_bsock) {
 377          ua->jcr->client = jcr->client;
 378          if (!connect_to_file_daemon(ua->jcr, 10, FDConnectTimeout, 1)) {
 379             ua->error_msg(_("Failed to connect to File daemon.\n"));
 380             return 0;
 381          }
 382          Dmsg0(200, "Connected to file daemon\n");
 383          fd = ua->jcr->file_bsock;
 384          bnet_fsend(fd, "cancel Job=%s\n", jcr->Job);
 385          while (bnet_recv(fd) >= 0) {
 386             ua->send_msg("%s", fd->msg);
 387          }
 388          bnet_sig(fd, BNET_TERMINATE);
 389          bnet_close(fd);
 390          ua->jcr->file_bsock = NULL;
 391       }
 392
 393       /* Cancel Storage daemon */
 394       if (jcr->store_bsock) {
 395          if (!ua->jcr->wstorage) {
 396             if (jcr->rstorage) {
 397                copy_wstorage(ua->jcr, jcr->rstorage, _("Job resource"));
 398             } else {
 399                copy_wstorage(ua->jcr, jcr->wstorage, _("Job resource"));
 400             }
 401          } else {
 402             USTORE store;
 403             if (jcr->rstorage) {
 404                store.store = jcr->rstore;
 405             } else {
 406                store.store = jcr->wstore;
 407             }
 408             set_wstorage(ua->jcr, &store);
 409          }
 410
 411          if (!connect_to_storage_daemon(ua->jcr, 10, SDConnectTimeout, 1)) {
 412             ua->error_msg(_("Failed to connect to Storage daemon.\n"));
 413             return false;
 414          }
 415          Dmsg0(200, "Connected to storage daemon\n");
 416          sd = ua->jcr->store_bsock;
 417          sd->fsend("cancel Job=%s\n", jcr->Job);
 418          while (sd->recv() >= 0) {
 419             ua->send_msg("%s", sd->msg);
 420          }
 421          sd->signal(BNET_TERMINATE);
 422          sd->close();
 423          ua->jcr->store_bsock = NULL;
 424       }
 425    }
 426
 427    return true;
 428 }
 429
 430 void cancel_storage_daemon_job(JCR *jcr)
 431 {
 432    UAContext *ua = new_ua_context(jcr);
 433    JCR *control_jcr = new_control_jcr("*JobCancel*", JT_SYSTEM);
 434    BSOCK *sd;
 435
 436    ua->jcr = control_jcr;
 437    if (jcr->store_bsock) {
 438       if (!ua->jcr->wstorage) {
 439          if (jcr->rstorage) {
 440             copy_wstorage(ua->jcr, jcr->rstorage, _("Job resource"));
 441          } else {
 442             copy_wstorage(ua->jcr, jcr->wstorage, _("Job resource"));
 443          }
 444       } else {
 445          USTORE store;
 446          if (jcr->rstorage) {
 447             store.store = jcr->rstore;
 448          } else {
 449             store.store = jcr->wstore;
 450          }
 451          set_wstorage(ua->jcr, &store);
 452       }
 453
 454       if (!connect_to_storage_daemon(ua->jcr, 10, SDConnectTimeout, 1)) {
 455          goto bail_out;
 456       }
 457       Dmsg0(200, "Connected to storage daemon\n");
 458       sd = ua->jcr->store_bsock;
 459       sd->fsend("cancel Job=%s\n", jcr->Job);
 460       while (sd->recv() >= 0) {
 461       }
 462       sd->signal(BNET_TERMINATE);
 463       sd->close();
 464       ua->jcr->store_bsock = NULL;
 465    }
 466 bail_out:
 467    free_jcr(control_jcr);
 468    free_ua_context(ua);
 469 }
 470
 471 static void job_monitor_destructor(watchdog_t *self)
 472 {
 473    JCR *control_jcr = (JCR *)self->data;
 474
 475    free_jcr(control_jcr);
 476 }
 477
 478 static void job_monitor_watchdog(watchdog_t *self)
 479 {
 480    JCR *control_jcr, *jcr;
 481
 482    control_jcr = (JCR *)self->data;
 483
 484    Dsm_check(1);
 485    Dmsg1(800, "job_monitor_watchdog %p called\n", self);
 486
 487    foreach_jcr(jcr) {
 488       bool cancel = false;
 489
 490       if (jcr->JobId == 0 || job_canceled(jcr)) {
 491          Dmsg2(800, "Skipping JCR=%p Job=%s\n", jcr, jcr->Job);
 492          continue;
 493       }
 494
 495       /* check MaxWaitTime */
 496       if (job_check_maxwaittime(control_jcr, jcr)) {
 497          set_jcr_job_status(jcr, JS_Canceled);
 498          Jmsg(jcr, M_FATAL, 0, _("Max wait time exceeded. Job canceled.\n"));
 499          cancel = true;
 500       /* check MaxRunTime */
 501       } else if (job_check_maxruntime(control_jcr, jcr)) {
 502          set_jcr_job_status(jcr, JS_Canceled);
 503          Jmsg(jcr, M_FATAL, 0, _("Max run time exceeded. Job canceled.\n"));
 504          cancel = true;
 505       }
 506
 507       if (cancel) {
 508          Dmsg3(800, "Cancelling JCR %p jobid %d (%s)\n", jcr, jcr->JobId, jcr->Job);
 509          UAContext *ua = new_ua_context(jcr);
 510          ua->jcr = control_jcr;
 511          cancel_job(ua, jcr);
 512          free_ua_context(ua);
 513          Dmsg2(800, "Have cancelled JCR %p Job=%d\n", jcr, jcr->JobId);
 514       }
 515
 516    }
 517    /* Keep reference counts correct */
 518    endeach_jcr(jcr);
 519 }
 520
 521 /*
 522  * Check if the maxwaittime has expired and it is possible
 523  *  to cancel the job.
 524  */
 525 static bool job_check_maxwaittime(JCR *control_jcr, JCR *jcr)
 526 {
 527    bool cancel = false;
 528    JOB *job = jcr->job;
 529
 530    if (job_canceled(jcr)) {
 531       return false;                /* already canceled */
 532    }
 533    if (job->MaxWaitTime == 0 && job->FullMaxWaitTime == 0 &&
 534        job->IncMaxWaitTime == 0 && job->DiffMaxWaitTime == 0) {
 535       return false;
 536    }
 537    if (jcr->JobLevel == L_FULL && job->FullMaxWaitTime != 0 &&
 538          (watchdog_time - jcr->start_time) >= job->FullMaxWaitTime) {
 539       cancel = true;
 540    } else if (jcr->JobLevel == L_DIFFERENTIAL && job->DiffMaxWaitTime != 0 &&
 541          (watchdog_time - jcr->start_time) >= job->DiffMaxWaitTime) {
 542       cancel = true;
 543    } else if (jcr->JobLevel == L_INCREMENTAL && job->IncMaxWaitTime != 0 &&
 544          (watchdog_time - jcr->start_time) >= job->IncMaxWaitTime) {
 545       cancel = true;
 546    } else if (job->MaxWaitTime != 0 &&
 547          (watchdog_time - jcr->start_time) >= job->MaxWaitTime) {
 548       cancel = true;
 549    }
 550
 551    return cancel;
 552 }
 553
 554 /*
 555  * Check if maxruntime has expired and if the job can be
 556  *   canceled.
 557  */
 558 static bool job_check_maxruntime(JCR *control_jcr, JCR *jcr)
 559 {
 560    if (jcr->job->MaxRunTime == 0 || job_canceled(jcr)) {
 561       return false;
 562    }
 563    if ((watchdog_time - jcr->start_time) < jcr->job->MaxRunTime) {
 564       Dmsg3(200, "Job %p (%s) with MaxRunTime %d not expired\n",
 565             jcr, jcr->Job, jcr->job->MaxRunTime);
 566       return false;
 567    }
 568
 569    return true;
 570 }
 571
 572 /*
 573  * Get or create a Pool record with the given name.
 574  * Returns: 0 on error
 575  *          poolid if OK
 576  */
 577 DBId_t get_or_create_pool_record(JCR *jcr, char *pool_name)
 578 {
 579    POOL_DBR pr;
 580
 581    memset(&pr, 0, sizeof(pr));
 582    bstrncpy(pr.Name, pool_name, sizeof(pr.Name));
 583    Dmsg1(110, "get_or_create_pool=%s\n", pool_name);
 584
 585    while (!db_get_pool_record(jcr, jcr->db, &pr)) { /* get by Name */
 586       /* Try to create the pool */
 587       if (create_pool(jcr, jcr->db, jcr->pool, POOL_OP_CREATE) < 0) {
 588          Jmsg(jcr, M_FATAL, 0, _("Pool %s not in database. %s"), pr.Name,
 589             db_strerror(jcr->db));
 590          return 0;
 591       } else {
 592          Jmsg(jcr, M_INFO, 0, _("Pool %s created in database.\n"), pr.Name);
 593       }
 594    }
 595    return pr.PoolId;
 596 }
 597
 598 void apply_pool_overrides(JCR *jcr)
 599 {
 600    if (jcr->run_pool_override) {
 601       pm_strcpy(jcr->pool_source, _("Run pool override"));
 602    }
 603    /*
 604     * Apply any level related Pool selections
 605     */
 606    switch (jcr->JobLevel) {
 607    case L_FULL:
 608       if (jcr->full_pool) {
 609          jcr->pool = jcr->full_pool;
 610          if (jcr->run_full_pool_override) {
 611             pm_strcpy(jcr->pool_source, _("Run FullPool override"));
 612          } else {
 613             pm_strcpy(jcr->pool_source, _("Job FullPool override"));
 614          }
 615       }
 616       break;
 617    case L_INCREMENTAL:
 618       if (jcr->inc_pool) {
 619          jcr->pool = jcr->inc_pool;
 620          if (jcr->run_inc_pool_override) {
 621             pm_strcpy(jcr->pool_source, _("Run IncPool override"));
 622          } else {
 623             pm_strcpy(jcr->pool_source, _("Job IncPool override"));
 624          }
 625       }
 626       break;
 627    case L_DIFFERENTIAL:
 628       if (jcr->diff_pool) {
 629          jcr->pool = jcr->diff_pool;
 630          if (jcr->run_diff_pool_override) {
 631             pm_strcpy(jcr->pool_source, _("Run DiffPool override"));
 632          } else {
 633             pm_strcpy(jcr->pool_source, _("Job DiffPool override"));
 634          }
 635       }
 636       break;
 637    }
 638 }
 639
 640
 641 /*
 642  * Get or create a Client record for this Job
 643  */
 644 bool get_or_create_client_record(JCR *jcr)
 645 {
 646    CLIENT_DBR cr;
 647
 648    memset(&cr, 0, sizeof(cr));
 649    bstrncpy(cr.Name, jcr->client->hdr.name, sizeof(cr.Name));
 650    cr.AutoPrune = jcr->client->AutoPrune;
 651    cr.FileRetention = jcr->client->FileRetention;
 652    cr.JobRetention = jcr->client->JobRetention;
 653    if (!jcr->client_name) {
 654       jcr->client_name = get_pool_memory(PM_NAME);
 655    }
 656    pm_strcpy(jcr->client_name, jcr->client->hdr.name);
 657    if (!db_create_client_record(jcr, jcr->db, &cr)) {
 658       Jmsg(jcr, M_FATAL, 0, _("Could not create Client record. ERR=%s\n"),
 659          db_strerror(jcr->db));
 660       return false;
 661    }
 662    jcr->jr.ClientId = cr.ClientId;
 663    if (cr.Uname[0]) {
 664       if (!jcr->client_uname) {
 665          jcr->client_uname = get_pool_memory(PM_NAME);
 666       }
 667       pm_strcpy(jcr->client_uname, cr.Uname);
 668    }
 669    Dmsg2(100, "Created Client %s record %d\n", jcr->client->hdr.name,
 670       jcr->jr.ClientId);
 671    return true;
 672 }
 673
 674 bool get_or_create_fileset_record(JCR *jcr)
 675 {
 676    FILESET_DBR fsr;
 677    /*
 678     * Get or Create FileSet record
 679     */
 680    memset(&fsr, 0, sizeof(FILESET_DBR));
 681    bstrncpy(fsr.FileSet, jcr->fileset->hdr.name, sizeof(fsr.FileSet));
 682    if (jcr->fileset->have_MD5) {
 683       struct MD5Context md5c;
 684       unsigned char digest[MD5HashSize];
 685       memcpy(&md5c, &jcr->fileset->md5c, sizeof(md5c));
 686       MD5Final(digest, &md5c);
 687       /*
 688        * Keep the flag (last arg) set to false otherwise old FileSets will
 689        * get new MD5 sums and the user will get Full backups on everything
 690        */
 691       bin_to_base64(fsr.MD5, sizeof(fsr.MD5), (char *)digest, MD5HashSize, false);
 692       bstrncpy(jcr->fileset->MD5, fsr.MD5, sizeof(jcr->fileset->MD5));
 693    } else {
 694       Jmsg(jcr, M_WARNING, 0, _("FileSet MD5 digest not found.\n"));
 695    }
 696    if (!jcr->fileset->ignore_fs_changes ||
 697        !db_get_fileset_record(jcr, jcr->db, &fsr)) {
 698       if (!db_create_fileset_record(jcr, jcr->db, &fsr)) {
 699          Jmsg(jcr, M_ERROR, 0, _("Could not create FileSet \"%s\" record. ERR=%s\n"),
 700             fsr.FileSet, db_strerror(jcr->db));
 701          return false;
 702       }
 703    }
 704    jcr->jr.FileSetId = fsr.FileSetId;
 705    bstrncpy(jcr->FSCreateTime, fsr.cCreateTime, sizeof(jcr->FSCreateTime));
 706    Dmsg2(119, "Created FileSet %s record %u\n", jcr->fileset->hdr.name,
 707       jcr->jr.FileSetId);
 708    return true;
 709 }
 710
 711 void init_jcr_job_record(JCR *jcr)
 712 {
 713    jcr->jr.SchedTime = jcr->sched_time;
 714    jcr->jr.StartTime = jcr->start_time;
 715    jcr->jr.EndTime = 0;               /* perhaps rescheduled, clear it */
 716    jcr->jr.JobType = jcr->JobType;
 717    jcr->jr.JobLevel = jcr->JobLevel;
 718    jcr->jr.JobStatus = jcr->JobStatus;
 719    jcr->jr.JobId = jcr->JobId;
 720    bstrncpy(jcr->jr.Name, jcr->job->name(), sizeof(jcr->jr.Name));
 721    bstrncpy(jcr->jr.Job, jcr->Job, sizeof(jcr->jr.Job));
 722 }
 723
 724 /*
 725  * Write status and such in DB
 726  */
 727 void update_job_end_record(JCR *jcr)
 728 {
 729    jcr->jr.EndTime = time(NULL);
 730    jcr->end_time = jcr->jr.EndTime;
 731    jcr->jr.JobId = jcr->JobId;
 732    jcr->jr.JobStatus = jcr->JobStatus;
 733    jcr->jr.JobFiles = jcr->JobFiles;
 734    jcr->jr.JobBytes = jcr->JobBytes;
 735    jcr->jr.VolSessionId = jcr->VolSessionId;
 736    jcr->jr.VolSessionTime = jcr->VolSessionTime;
 737    jcr->jr.JobErrors = jcr->Errors;
 738    if (!db_update_job_end_record(jcr, jcr->db, &jcr->jr)) {
 739       Jmsg(jcr, M_WARNING, 0, _("Error updating job record. %s"),
 740          db_strerror(jcr->db));
 741    }
 742 }
 743
 744 /*
 745  * Takes base_name and appends (unique) current
 746  *   date and time to form unique job name.
 747  *
 748  *  Returns: unique job name in jcr->Job
 749  *    date/time in jcr->start_time
 750  */
 751 void create_unique_job_name(JCR *jcr, const char *base_name)
 752 {
 753    /* Job start mutex */
 754    static pthread_mutex_t mutex = PTHREAD_MUTEX_INITIALIZER;
 755    static time_t last_start_time = 0;
 756    time_t now;
 757    struct tm tm;
 758    char dt[MAX_TIME_LENGTH];
 759    char name[MAX_NAME_LENGTH];
 760    char *p;
 761
 762    /* Guarantee unique start time -- maximum one per second, and
 763     * thus unique Job Name
 764     */
 765    P(mutex);                          /* lock creation of jobs */
 766    now = time(NULL);
 767    while (now == last_start_time) {
 768       bmicrosleep(0, 500000);
 769       now = time(NULL);
 770    }
 771    last_start_time = now;
 772    V(mutex);                          /* allow creation of jobs */
 773    jcr->start_time = now;
 774    /* Form Unique JobName */
 775    (void)localtime_r(&now, &tm);
 776    /* Use only characters that are permitted in Windows filenames */
 777    strftime(dt, sizeof(dt), "%Y-%m-%d_%H.%M.%S", &tm);
 778    bstrncpy(name, base_name, sizeof(name));
 779    name[sizeof(name)-22] = 0;          /* truncate if too long */
 780    bsnprintf(jcr->Job, sizeof(jcr->Job), "%s.%s", name, dt); /* add date & time */
 781    /* Convert spaces into underscores */
 782    for (p=jcr->Job; *p; p++) {
 783       if (*p == ' ') {
 784          *p = '_';
 785       }
 786    }
 787 }
 788
 789 /* Called directly from job rescheduling */
 790 void dird_free_jcr_pointers(JCR *jcr)
 791 {
 792    if (jcr->sd_auth_key) {
 793       free(jcr->sd_auth_key);
 794       jcr->sd_auth_key = NULL;
 795    }
 796    if (jcr->where) {
 797       free(jcr->where);
 798       jcr->where = NULL;
 799    }
 800    if (jcr->file_bsock) {
 801       Dmsg0(200, "Close File bsock\n");
 802       bnet_close(jcr->file_bsock);
 803       jcr->file_bsock = NULL;
 804    }
 805    if (jcr->store_bsock) {
 806       Dmsg0(200, "Close Store bsock\n");
 807       bnet_close(jcr->store_bsock);
 808       jcr->store_bsock = NULL;
 809    }
 810    if (jcr->fname) {
 811       Dmsg0(200, "Free JCR fname\n");
 812       free_pool_memory(jcr->fname);
 813       jcr->fname = NULL;
 814    }
 815    if (jcr->RestoreBootstrap) {
 816       free(jcr->RestoreBootstrap);
 817       jcr->RestoreBootstrap = NULL;
 818    }
 819    if (jcr->client_uname) {
 820       free_pool_memory(jcr->client_uname);
 821       jcr->client_uname = NULL;
 822    }
 823    if (jcr->attr) {
 824       free_pool_memory(jcr->attr);
 825       jcr->attr = NULL;
 826    }
 827    if (jcr->ar) {
 828       free(jcr->ar);
 829       jcr->ar = NULL;
 830    }
 831 }
 832
 833 /*
 834  * Free the Job Control Record if no one is still using it.
 835  *  Called from main free_jcr() routine in src/lib/jcr.c so
 836  *  that we can do our Director specific cleanup of the jcr.
 837  */
 838 void dird_free_jcr(JCR *jcr)
 839 {
 840    Dmsg0(200, "Start dird free_jcr\n");
 841
 842    dird_free_jcr_pointers(jcr);
 843    if (jcr->term_wait_inited) {
 844       pthread_cond_destroy(&jcr->term_wait);
 845       jcr->term_wait_inited = false;
 846    }
 847    if (jcr->db_batch && jcr->db_batch != jcr->db) {
 848       db_close_database(jcr, jcr->db_batch);
 849    }
 850    jcr->db_batch = NULL;
 851    if (jcr->db) {
 852       db_close_database(jcr, jcr->db);
 853       jcr->db = NULL;
 854    }
 855    if (jcr->stime) {
 856       Dmsg0(200, "Free JCR stime\n");
 857       free_pool_memory(jcr->stime);
 858       jcr->stime = NULL;
 859    }
 860    if (jcr->fname) {
 861       Dmsg0(200, "Free JCR fname\n");
 862       free_pool_memory(jcr->fname);
 863       jcr->fname = NULL;
 864    }
 865    if (jcr->pool_source) {
 866       free_pool_memory(jcr->pool_source);
 867       jcr->pool_source = NULL;
 868    }
 869    if (jcr->rpool_source) {
 870       free_pool_memory(jcr->rpool_source);
 871       jcr->rpool_source = NULL;
 872    }
 873    if (jcr->wstore_source) {
 874       free_pool_memory(jcr->wstore_source);
 875       jcr->wstore_source = NULL;
 876    }
 877    if (jcr->rstore_source) {
 878       free_pool_memory(jcr->rstore_source);
 879       jcr->rstore_source = NULL;
 880    }
 881
 882    /* Delete lists setup to hold storage pointers */
 883    free_rwstorage(jcr);
 884
 885    jcr->job_end_push.destroy();
 886    Dmsg0(200, "End dird free_jcr\n");
 887 }
 888
 889 /*
 890  * The Job storage definition must be either in the Job record
 891  *  or in the Pool record.  The Pool record overrides the Job
 892  *  record.
 893  */
 894 void get_job_storage(USTORE *store, JOB *job, RUN *run)
 895 {
 896    if (run && run->pool && run->pool->storage) {
 897       store->store = (STORE *)run->pool->storage->first();
 898       pm_strcpy(store->store_source, _("Run pool override"));
 899       return;
 900    }
 901    if (run && run->storage) {
 902       store->store = run->storage;
 903       pm_strcpy(store->store_source, _("Run storage override"));
 904       return;
 905    }
 906    if (job->pool->storage) {
 907       store->store = (STORE *)job->pool->storage->first();
 908       pm_strcpy(store->store_source, _("Pool resource"));
 909    } else {
 910       store->store = (STORE *)job->storage->first();
 911       pm_strcpy(store->store_source, _("Job resource"));
 912    }
 913 }
 914
 915 /*
 916  * Set some defaults in the JCR necessary to
 917  * run. These items are pulled from the job
 918  * definition as defaults, but can be overridden
 919  * later either by the Run record in the Schedule resource,
 920  * or by the Console program.
 921  */
 922 void set_jcr_defaults(JCR *jcr, JOB *job)
 923 {
 924    jcr->job = job;
 925    jcr->JobType = job->JobType;
 926    switch (jcr->JobType) {
 927    case JT_ADMIN:
 928    case JT_RESTORE:
 929       jcr->JobLevel = L_NONE;
 930       break;
 931    case JT_MIGRATE:
 932       if (!jcr->rpool_source) {
 933          jcr->rpool_source = get_pool_memory(PM_MESSAGE);
 934          pm_strcpy(jcr->rpool_source, _("unknown source"));
 935       }
 936       /* Fall-through wanted */
 937    default:
 938       jcr->JobLevel = job->JobLevel;
 939       break;
 940    }
 941    if (!jcr->fname) {
 942       jcr->fname = get_pool_memory(PM_FNAME);
 943    }
 944    if (!jcr->pool_source) {
 945       jcr->pool_source = get_pool_memory(PM_MESSAGE);
 946       pm_strcpy(jcr->pool_source, _("unknown source"));
 947    }
 948
 949    jcr->JobPriority = job->Priority;
 950    /* Copy storage definitions -- deleted in dir_free_jcr above */
 951    if (job->storage) {
 952       copy_rwstorage(jcr, job->storage, _("Job resource"));
 953    } else {
 954       copy_rwstorage(jcr, job->pool->storage, _("Pool resource"));
 955    }
 956    jcr->client = job->client;
 957    if (!jcr->client_name) {
 958       jcr->client_name = get_pool_memory(PM_NAME);
 959    }
 960    pm_strcpy(jcr->client_name, jcr->client->hdr.name);
 961    pm_strcpy(jcr->pool_source, _("Job resource"));
 962    jcr->pool = job->pool;
 963    jcr->full_pool = job->full_pool;
 964    jcr->inc_pool = job->inc_pool;
 965    jcr->diff_pool = job->diff_pool;
 966    jcr->catalog = job->client->catalog;
 967    jcr->fileset = job->fileset;
 968    jcr->messages = job->messages;
 969    jcr->spool_data = job->spool_data;
 970    jcr->write_part_after_job = job->write_part_after_job;
 971    if (jcr->RestoreBootstrap) {
 972       free(jcr->RestoreBootstrap);
 973       jcr->RestoreBootstrap = NULL;
 974    }
 975    /* This can be overridden by Console program */
 976    if (job->RestoreBootstrap) {
 977       jcr->RestoreBootstrap = bstrdup(job->RestoreBootstrap);
 978    }
 979    /* This can be overridden by Console program */
 980    jcr->verify_job = job->verify_job;
 981    /* If no default level given, set one */
 982    if (jcr->JobLevel == 0) {
 983       switch (jcr->JobType) {
 984       case JT_VERIFY:
 985          jcr->JobLevel = L_VERIFY_CATALOG;
 986          break;
 987       case JT_BACKUP:
 988          jcr->JobLevel = L_INCREMENTAL;
 989          break;
 990       case JT_RESTORE:
 991       case JT_ADMIN:
 992          jcr->JobLevel = L_NONE;
 993          break;
 994       default:
 995          jcr->JobLevel = L_FULL;
 996          break;
 997       }
 998    }
 999 }
1000
1001 /*
1002  * Copy the storage definitions from an alist to the JCR
1003  */
1004 void copy_rwstorage(JCR *jcr, alist *storage, const char *where)
1005 {
1006    switch(jcr->JobType) {
1007    case JT_RESTORE:
1008    case JT_VERIFY:
1009    case JT_MIGRATE:
1010       copy_rstorage(jcr, storage, where);
1011       break;
1012    default:
1013       copy_wstorage(jcr, storage, where);
1014       break;
1015    }
1016 }
1017
1018
1019 /* Set storage override.  Releases any previous storage definition */
1020 void set_rwstorage(JCR *jcr, USTORE *store)
1021 {
1022    if (!store) {
1023       Jmsg(jcr, M_FATAL, 0, _("No storage specified.\n"));
1024       return;
1025    }
1026    switch(jcr->JobType) {
1027    case JT_RESTORE:
1028    case JT_VERIFY:
1029    case JT_MIGRATE:
1030       set_rstorage(jcr, store);
1031       break;
1032    default:
1033       set_wstorage(jcr, store);
1034       break;
1035    }
1036 }
1037
1038 void free_rwstorage(JCR *jcr)
1039 {
1040    free_rstorage(jcr);
1041    free_wstorage(jcr);
1042 }
1043
1044 /*
1045  * Copy the storage definitions from an alist to the JCR
1046  */
1047 void copy_rstorage(JCR *jcr, alist *storage, const char *where)
1048 {
1049    if (storage) {
1050       STORE *st;
1051       if (jcr->rstorage) {
1052          delete jcr->rstorage;
1053       }
1054       jcr->rstorage = New(alist(10, not_owned_by_alist));
1055       foreach_alist(st, storage) {
1056          jcr->rstorage->append(st);
1057       }
1058       if (!jcr->rstore_source) {
1059          jcr->rstore_source = get_pool_memory(PM_MESSAGE);
1060       }
1061       pm_strcpy(jcr->rstore_source, where);
1062       if (jcr->rstorage) {
1063          jcr->rstore = (STORE *)jcr->rstorage->first();
1064       }
1065    }
1066 }
1067
1068
1069 /* Set storage override.  Remove all previous storage */
1070 void set_rstorage(JCR *jcr, USTORE *store)
1071 {
1072    STORE *storage;
1073
1074    if (!store->store) {
1075       return;
1076    }
1077    if (jcr->rstorage) {
1078       free_rstorage(jcr);
1079    }
1080    if (!jcr->rstorage) {
1081       jcr->rstorage = New(alist(10, not_owned_by_alist));
1082    }
1083    jcr->rstore = store->store;
1084    if (!jcr->rstore_source) {
1085       jcr->rstore_source = get_pool_memory(PM_MESSAGE);
1086    }
1087    pm_strcpy(jcr->rstore_source, store->store_source);
1088    foreach_alist(storage, jcr->rstorage) {
1089       if (store->store == storage) {
1090          return;
1091       }
1092    }
1093    /* Store not in list, so add it */
1094    jcr->rstorage->prepend(store->store);
1095 }
1096
1097 void free_rstorage(JCR *jcr)
1098 {
1099    if (jcr->rstorage) {
1100       delete jcr->rstorage;
1101       jcr->rstorage = NULL;
1102    }
1103    jcr->rstore = NULL;
1104 }
1105
1106 /*
1107  * Copy the storage definitions from an alist to the JCR
1108  */
1109 void copy_wstorage(JCR *jcr, alist *storage, const char *where)
1110 {
1111    if (storage) {
1112       STORE *st;
1113       if (jcr->wstorage) {
1114          delete jcr->wstorage;
1115       }
1116       jcr->wstorage = New(alist(10, not_owned_by_alist));
1117       foreach_alist(st, storage) {
1118          Dmsg1(100, "wstorage=%s\n", st->name());
1119          jcr->wstorage->append(st);
1120       }
1121       if (!jcr->wstore_source) {
1122          jcr->wstore_source = get_pool_memory(PM_MESSAGE);
1123       }
1124       pm_strcpy(jcr->wstore_source, where);
1125       if (jcr->wstorage) {
1126          jcr->wstore = (STORE *)jcr->wstorage->first();
1127          Dmsg2(100, "wstore=%s where=%s\n", jcr->wstore->name(), jcr->wstore_source);
1128       }
1129    }
1130 }
1131
1132
1133 /* Set storage override. Remove all previous storage */
1134 void set_wstorage(JCR *jcr, USTORE *store)
1135 {
1136    STORE *storage;
1137
1138    if (!store->store) {
1139       return;
1140    }
1141    if (jcr->wstorage) {
1142       free_wstorage(jcr);
1143    }
1144    if (!jcr->wstorage) {
1145       jcr->wstorage = New(alist(10, not_owned_by_alist));
1146    }
1147    jcr->wstore = store->store;
1148    if (!jcr->wstore_source) {
1149       jcr->wstore_source = get_pool_memory(PM_MESSAGE);
1150    }
1151    pm_strcpy(jcr->wstore_source, store->store_source);
1152    Dmsg2(50, "wstore=%s where=%s\n", jcr->wstore->name(), jcr->wstore_source);
1153    foreach_alist(storage, jcr->wstorage) {
1154       if (store->store == storage) {
1155          return;
1156       }
1157    }
1158    /* Store not in list, so add it */
1159    jcr->wstorage->prepend(store->store);
1160 }
1161
1162 void free_wstorage(JCR *jcr)
1163 {
1164    if (jcr->wstorage) {
1165       delete jcr->wstorage;
1166       jcr->wstorage = NULL;
1167    }
1168    jcr->wstore = NULL;
1169 }
1170
1171 void create_clones(JCR *jcr)
1172 {
1173    /*
1174     * Fire off any clone jobs (run directives)
1175     */
1176    Dmsg2(900, "cloned=%d run_cmds=%p\n", jcr->cloned, jcr->job->run_cmds);
1177    if (!jcr->cloned && jcr->job->run_cmds) {
1178       char *runcmd;
1179       JOB *job = jcr->job;
1180       POOLMEM *cmd = get_pool_memory(PM_FNAME);
1181       UAContext *ua = new_ua_context(jcr);
1182       ua->batch = true;
1183       foreach_alist(runcmd, job->run_cmds) {
1184          cmd = edit_job_codes(jcr, cmd, runcmd, "");
1185          Mmsg(ua->cmd, "run %s cloned=yes", cmd);
1186          Dmsg1(900, "=============== Clone cmd=%s\n", ua->cmd);
1187          parse_ua_args(ua);                 /* parse command */
1188          int stat = run_cmd(ua, ua->cmd);
1189          if (stat == 0) {
1190             Jmsg(jcr, M_ERROR, 0, _("Could not start clone job.\n"));
1191          } else {
1192             Jmsg(jcr, M_INFO, 0, _("Clone JobId %d started.\n"), stat);
1193          }
1194       }
1195       free_ua_context(ua);
1196       free_pool_memory(cmd);
1197    }
1198 }
1199
1200 bool create_restore_bootstrap_file(JCR *jcr)
1201 {
1202    RESTORE_CTX rx;
1203    UAContext *ua;
1204    memset(&rx, 0, sizeof(rx));
1205    rx.bsr = new_bsr();
1206    rx.JobIds = "";
1207    rx.bsr->JobId = jcr->previous_jr.JobId;
1208    ua = new_ua_context(jcr);
1209    complete_bsr(ua, rx.bsr);
1210    rx.bsr->fi = new_findex();
1211    rx.bsr->fi->findex = 1;
1212    rx.bsr->fi->findex2 = jcr->previous_jr.JobFiles;
1213    jcr->ExpectedFiles = write_bsr_file(ua, rx);
1214    if (jcr->ExpectedFiles == 0) {
1215       free_ua_context(ua);
1216       free_bsr(rx.bsr);
1217       return false;
1218    }
1219    free_ua_context(ua);
1220    free_bsr(rx.bsr);
1221    jcr->needs_sd = true;
1222    return true;
1223 }