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    pthread_detach(pthread_self());
 241    Dsm_check(1);
 242
 243    Dmsg0(200, "=====Start Job=========\n");
 244    set_jcr_job_status(jcr, JS_Running);   /* this will be set only if no error */
 245    jcr->start_time = time(NULL);      /* set the real start time */
 246    jcr->jr.StartTime = jcr->start_time;
 247
 248    if (jcr->job->MaxStartDelay != 0 && jcr->job->MaxStartDelay <
 249        (utime_t)(jcr->start_time - jcr->sched_time)) {
 250       set_jcr_job_status(jcr, JS_Canceled);
 251       Jmsg(jcr, M_FATAL, 0, _("Job canceled because max start delay time exceeded.\n"));
 252    }
 253
 254    /* TODO : check if it is used somewhere */
 255    if (jcr->job->RunScripts == NULL) {
 256       Dmsg0(200, "Warning, job->RunScripts is empty\n");
 257       jcr->job->RunScripts = New(alist(10, not_owned_by_alist));
 258    }
 259
 260    if (!db_update_job_start_record(jcr, jcr->db, &jcr->jr)) {
 261       Jmsg(jcr, M_FATAL, 0, "%s", db_strerror(jcr->db));
 262    }
 263
 264    /* Run any script BeforeJob on dird */
 265    run_scripts(jcr, jcr->job->RunScripts, "BeforeJob");
 266
 267    if (job_canceled(jcr)) {
 268       update_job_end(jcr, jcr->JobStatus);
 269
 270    } else {
 271       /*
 272        * We re-update the job start record so that the start
 273        *  time is set after the run before job.  This avoids
 274        *  that any files created by the run before job will
 275        *  be saved twice.  They will be backed up in the current
 276        *  job, but not in the next one unless they are changed.
 277        *  Without this, they will be backed up in this job and
 278        *  in the next job run because in that case, their date
 279        *   is after the start of this run.
 280        */
 281       jcr->start_time = time(NULL);
 282       jcr->jr.StartTime = jcr->start_time;
 283       if (!db_update_job_start_record(jcr, jcr->db, &jcr->jr)) {
 284          Jmsg(jcr, M_FATAL, 0, "%s", db_strerror(jcr->db));
 285       }
 286       generate_job_event(jcr, "JobRun");
 287
 288       switch (jcr->JobType) {
 289       case JT_BACKUP:
 290          if (do_backup(jcr)) {
 291             do_autoprune(jcr);
 292          } else {
 293             backup_cleanup(jcr, JS_ErrorTerminated);
 294          }
 295          break;
 296       case JT_VERIFY:
 297          if (do_verify(jcr)) {
 298             do_autoprune(jcr);
 299          } else {
 300             verify_cleanup(jcr, JS_ErrorTerminated);
 301          }
 302          break;
 303       case JT_RESTORE:
 304          if (do_restore(jcr)) {
 305             do_autoprune(jcr);
 306          } else {
 307             restore_cleanup(jcr, JS_ErrorTerminated);
 308          }
 309          break;
 310       case JT_ADMIN:
 311          if (do_admin(jcr)) {
 312             do_autoprune(jcr);
 313          } else {
 314             admin_cleanup(jcr, JS_ErrorTerminated);
 315          }
 316          break;
 317       case JT_MIGRATE:
 318       case JT_COPY:
 319       case JT_ARCHIVE:
 320          if (do_migration(jcr)) {
 321             do_autoprune(jcr);
 322          } else {
 323             migration_cleanup(jcr, JS_ErrorTerminated);
 324          }
 325          break;
 326       default:
 327          Pmsg1(0, _("Unimplemented job type: %d\n"), jcr->JobType);
 328          break;
 329       }
 330    }
 331
 332    run_scripts(jcr, jcr->job->RunScripts, "AfterJob");
 333
 334    /* Send off any queued messages */
 335    if (jcr->msg_queue && jcr->msg_queue->size() > 0) {
 336       dequeue_messages(jcr);
 337    }
 338
 339    generate_daemon_event(jcr, "JobEnd");
 340    Dmsg1(50, "======== End Job stat=%c ==========\n", jcr->JobStatus);
 341    sm_check(__FILE__, __LINE__, true);
 342    return NULL;
 343 }
 344
 345
 346 /*
 347  * Cancel a job -- typically called by the UA (Console program), but may also
 348  *              be called by the job watchdog.
 349  *
 350  *  Returns: true  if cancel appears to be successful
 351  *           false on failure. Message sent to ua->jcr.
 352  */
 353 bool cancel_job(UAContext *ua, JCR *jcr)
 354 {
 355    BSOCK *sd, *fd;
 356    char ed1[50];
 357
 358    set_jcr_job_status(jcr, JS_Canceled);
 359
 360    switch (jcr->JobStatus) {
 361    case JS_Created:
 362    case JS_WaitJobRes:
 363    case JS_WaitClientRes:
 364    case JS_WaitStoreRes:
 365    case JS_WaitPriority:
 366    case JS_WaitMaxJobs:
 367    case JS_WaitStartTime:
 368       ua->info_msg(_("JobId %s, Job %s marked to be canceled.\n"),
 369               edit_uint64(jcr->JobId, ed1), jcr->Job);
 370       jobq_remove(&job_queue, jcr); /* attempt to remove it from queue */
 371       return true;
 372
 373    default:
 374       /* Cancel File daemon */
 375       if (jcr->file_bsock) {
 376          ua->jcr->client = jcr->client;
 377          if (!connect_to_file_daemon(ua->jcr, 10, FDConnectTimeout, 1)) {
 378             ua->error_msg(_("Failed to connect to File daemon.\n"));
 379             return 0;
 380          }
 381          Dmsg0(200, "Connected to file daemon\n");
 382          fd = ua->jcr->file_bsock;
 383          bnet_fsend(fd, "cancel Job=%s\n", jcr->Job);
 384          while (bnet_recv(fd) >= 0) {
 385             ua->send_msg("%s", fd->msg);
 386          }
 387          bnet_sig(fd, BNET_TERMINATE);
 388          bnet_close(fd);
 389          ua->jcr->file_bsock = NULL;
 390       }
 391
 392       /* Cancel Storage daemon */
 393       if (jcr->store_bsock) {
 394          if (!ua->jcr->wstorage) {
 395             if (jcr->rstorage) {
 396                copy_wstorage(ua->jcr, jcr->rstorage, _("Job resource"));
 397             } else {
 398                copy_wstorage(ua->jcr, jcr->wstorage, _("Job resource"));
 399             }
 400          } else {
 401             USTORE store;
 402             if (jcr->rstorage) {
 403                store.store = jcr->rstore;
 404             } else {
 405                store.store = jcr->wstore;
 406             }
 407             set_wstorage(ua->jcr, &store);
 408          }
 409
 410          if (!connect_to_storage_daemon(ua->jcr, 10, SDConnectTimeout, 1)) {
 411             ua->error_msg(_("Failed to connect to Storage daemon.\n"));
 412             return false;
 413          }
 414          Dmsg0(200, "Connected to storage daemon\n");
 415          sd = ua->jcr->store_bsock;
 416          sd->fsend("cancel Job=%s\n", jcr->Job);
 417          while (sd->recv() >= 0) {
 418             ua->send_msg("%s", sd->msg);
 419          }
 420          sd->signal(BNET_TERMINATE);
 421          sd->close();
 422          ua->jcr->store_bsock = NULL;
 423       }
 424    }
 425
 426    return true;
 427 }
 428
 429 void cancel_storage_daemon_job(JCR *jcr)
 430 {
 431    UAContext *ua = new_ua_context(jcr);
 432    JCR *control_jcr = new_control_jcr("*JobCancel*", JT_SYSTEM);
 433    BSOCK *sd;
 434
 435    ua->jcr = control_jcr;
 436    if (jcr->store_bsock) {
 437       if (!ua->jcr->wstorage) {
 438          if (jcr->rstorage) {
 439             copy_wstorage(ua->jcr, jcr->rstorage, _("Job resource"));
 440          } else {
 441             copy_wstorage(ua->jcr, jcr->wstorage, _("Job resource"));
 442          }
 443       } else {
 444          USTORE store;
 445          if (jcr->rstorage) {
 446             store.store = jcr->rstore;
 447          } else {
 448             store.store = jcr->wstore;
 449          }
 450          set_wstorage(ua->jcr, &store);
 451       }
 452
 453       if (!connect_to_storage_daemon(ua->jcr, 10, SDConnectTimeout, 1)) {
 454          goto bail_out;
 455       }
 456       Dmsg0(200, "Connected to storage daemon\n");
 457       sd = ua->jcr->store_bsock;
 458       sd->fsend("cancel Job=%s\n", jcr->Job);
 459       while (sd->recv() >= 0) {
 460       }
 461       sd->signal(BNET_TERMINATE);
 462       sd->close();
 463       ua->jcr->store_bsock = NULL;
 464    }
 465 bail_out:
 466    free_jcr(control_jcr);
 467    free_ua_context(ua);
 468 }
 469
 470 static void job_monitor_destructor(watchdog_t *self)
 471 {
 472    JCR *control_jcr = (JCR *)self->data;
 473
 474    free_jcr(control_jcr);
 475 }
 476
 477 static void job_monitor_watchdog(watchdog_t *self)
 478 {
 479    JCR *control_jcr, *jcr;
 480
 481    control_jcr = (JCR *)self->data;
 482
 483    Dsm_check(1);
 484    Dmsg1(800, "job_monitor_watchdog %p called\n", self);
 485
 486    foreach_jcr(jcr) {
 487       bool cancel = false;
 488
 489       if (jcr->JobId == 0 || job_canceled(jcr)) {
 490          Dmsg2(800, "Skipping JCR=%p Job=%s\n", jcr, jcr->Job);
 491          continue;
 492       }
 493
 494       /* check MaxWaitTime */
 495       if (job_check_maxwaittime(control_jcr, jcr)) {
 496          set_jcr_job_status(jcr, JS_Canceled);
 497          Jmsg(jcr, M_FATAL, 0, _("Max wait time exceeded. Job canceled.\n"));
 498          cancel = true;
 499       /* check MaxRunTime */
 500       } else if (job_check_maxruntime(control_jcr, jcr)) {
 501          set_jcr_job_status(jcr, JS_Canceled);
 502          Jmsg(jcr, M_FATAL, 0, _("Max run time exceeded. Job canceled.\n"));
 503          cancel = true;
 504       }
 505
 506       if (cancel) {
 507          Dmsg3(800, "Cancelling JCR %p jobid %d (%s)\n", jcr, jcr->JobId, jcr->Job);
 508          UAContext *ua = new_ua_context(jcr);
 509          ua->jcr = control_jcr;
 510          cancel_job(ua, jcr);
 511          free_ua_context(ua);
 512          Dmsg2(800, "Have cancelled JCR %p Job=%d\n", jcr, jcr->JobId);
 513       }
 514
 515    }
 516    /* Keep reference counts correct */
 517    endeach_jcr(jcr);
 518 }
 519
 520 /*
 521  * Check if the maxwaittime has expired and it is possible
 522  *  to cancel the job.
 523  */
 524 static bool job_check_maxwaittime(JCR *control_jcr, JCR *jcr)
 525 {
 526    bool cancel = false;
 527    JOB *job = jcr->job;
 528
 529    if (job_canceled(jcr)) {
 530       return false;                /* already canceled */
 531    }
 532    if (job->MaxWaitTime == 0 && job->FullMaxWaitTime == 0 &&
 533        job->IncMaxWaitTime == 0 && job->DiffMaxWaitTime == 0) {
 534       return false;
 535    }
 536    if (jcr->JobLevel == L_FULL && job->FullMaxWaitTime != 0 &&
 537          (watchdog_time - jcr->start_time) >= job->FullMaxWaitTime) {
 538       cancel = true;
 539    } else if (jcr->JobLevel == L_DIFFERENTIAL && job->DiffMaxWaitTime != 0 &&
 540          (watchdog_time - jcr->start_time) >= job->DiffMaxWaitTime) {
 541       cancel = true;
 542    } else if (jcr->JobLevel == L_INCREMENTAL && job->IncMaxWaitTime != 0 &&
 543          (watchdog_time - jcr->start_time) >= job->IncMaxWaitTime) {
 544       cancel = true;
 545    } else if (job->MaxWaitTime != 0 &&
 546          (watchdog_time - jcr->start_time) >= job->MaxWaitTime) {
 547       cancel = true;
 548    }
 549
 550    return cancel;
 551 }
 552
 553 /*
 554  * Check if maxruntime has expired and if the job can be
 555  *   canceled.
 556  */
 557 static bool job_check_maxruntime(JCR *control_jcr, JCR *jcr)
 558 {
 559    if (jcr->job->MaxRunTime == 0 || job_canceled(jcr) || jcr->JobStatus == JS_Created) {
 560       return false;
 561    }
 562    if ((watchdog_time - jcr->start_time) < jcr->job->MaxRunTime) {
 563       Dmsg3(200, "Job %p (%s) with MaxRunTime %d not expired\n",
 564             jcr, jcr->Job, jcr->job->MaxRunTime);
 565       return false;
 566    }
 567
 568    return true;
 569 }
 570
 571 /*
 572  * Get or create a Pool record with the given name.
 573  * Returns: 0 on error
 574  *          poolid if OK
 575  */
 576 DBId_t get_or_create_pool_record(JCR *jcr, char *pool_name)
 577 {
 578    POOL_DBR pr;
 579
 580    memset(&pr, 0, sizeof(pr));
 581    bstrncpy(pr.Name, pool_name, sizeof(pr.Name));
 582    Dmsg1(110, "get_or_create_pool=%s\n", pool_name);
 583
 584    while (!db_get_pool_record(jcr, jcr->db, &pr)) { /* get by Name */
 585       /* Try to create the pool */
 586       if (create_pool(jcr, jcr->db, jcr->pool, POOL_OP_CREATE) < 0) {
 587          Jmsg(jcr, M_FATAL, 0, _("Pool %s not in database. %s"), pr.Name,
 588             db_strerror(jcr->db));
 589          return 0;
 590       } else {
 591          Jmsg(jcr, M_INFO, 0, _("Pool %s created in database.\n"), pr.Name);
 592       }
 593    }
 594    return pr.PoolId;
 595 }
 596
 597 void apply_pool_overrides(JCR *jcr)
 598 {
 599    if (jcr->run_pool_override) {
 600       pm_strcpy(jcr->pool_source, _("Run pool override"));
 601    }
 602    /*
 603     * Apply any level related Pool selections
 604     */
 605    switch (jcr->JobLevel) {
 606    case L_FULL:
 607       if (jcr->full_pool) {
 608          jcr->pool = jcr->full_pool;
 609          if (jcr->run_full_pool_override) {
 610             pm_strcpy(jcr->pool_source, _("Run FullPool override"));
 611          } else {
 612             pm_strcpy(jcr->pool_source, _("Job FullPool override"));
 613          }
 614       }
 615       break;
 616    case L_INCREMENTAL:
 617       if (jcr->inc_pool) {
 618          jcr->pool = jcr->inc_pool;
 619          if (jcr->run_inc_pool_override) {
 620             pm_strcpy(jcr->pool_source, _("Run IncPool override"));
 621          } else {
 622             pm_strcpy(jcr->pool_source, _("Job IncPool override"));
 623          }
 624       }
 625       break;
 626    case L_DIFFERENTIAL:
 627       if (jcr->diff_pool) {
 628          jcr->pool = jcr->diff_pool;
 629          if (jcr->run_diff_pool_override) {
 630             pm_strcpy(jcr->pool_source, _("Run DiffPool override"));
 631          } else {
 632             pm_strcpy(jcr->pool_source, _("Job DiffPool override"));
 633          }
 634       }
 635       break;
 636    }
 637 }
 638
 639
 640 /*
 641  * Get or create a Client record for this Job
 642  */
 643 bool get_or_create_client_record(JCR *jcr)
 644 {
 645    CLIENT_DBR cr;
 646
 647    memset(&cr, 0, sizeof(cr));
 648    bstrncpy(cr.Name, jcr->client->hdr.name, sizeof(cr.Name));
 649    cr.AutoPrune = jcr->client->AutoPrune;
 650    cr.FileRetention = jcr->client->FileRetention;
 651    cr.JobRetention = jcr->client->JobRetention;
 652    if (!jcr->client_name) {
 653       jcr->client_name = get_pool_memory(PM_NAME);
 654    }
 655    pm_strcpy(jcr->client_name, jcr->client->hdr.name);
 656    if (!db_create_client_record(jcr, jcr->db, &cr)) {
 657       Jmsg(jcr, M_FATAL, 0, _("Could not create Client record. ERR=%s\n"),
 658          db_strerror(jcr->db));
 659       return false;
 660    }
 661    jcr->jr.ClientId = cr.ClientId;
 662    if (cr.Uname[0]) {
 663       if (!jcr->client_uname) {
 664          jcr->client_uname = get_pool_memory(PM_NAME);
 665       }
 666       pm_strcpy(jcr->client_uname, cr.Uname);
 667    }
 668    Dmsg2(100, "Created Client %s record %d\n", jcr->client->hdr.name,
 669       jcr->jr.ClientId);
 670    return true;
 671 }
 672
 673 bool get_or_create_fileset_record(JCR *jcr)
 674 {
 675    FILESET_DBR fsr;
 676    /*
 677     * Get or Create FileSet record
 678     */
 679    memset(&fsr, 0, sizeof(FILESET_DBR));
 680    bstrncpy(fsr.FileSet, jcr->fileset->hdr.name, sizeof(fsr.FileSet));
 681    if (jcr->fileset->have_MD5) {
 682       struct MD5Context md5c;
 683       unsigned char digest[MD5HashSize];
 684       memcpy(&md5c, &jcr->fileset->md5c, sizeof(md5c));
 685       MD5Final(digest, &md5c);
 686       /*
 687        * Keep the flag (last arg) set to false otherwise old FileSets will
 688        * get new MD5 sums and the user will get Full backups on everything
 689        */
 690       bin_to_base64(fsr.MD5, sizeof(fsr.MD5), (char *)digest, MD5HashSize, false);
 691       bstrncpy(jcr->fileset->MD5, fsr.MD5, sizeof(jcr->fileset->MD5));
 692    } else {
 693       Jmsg(jcr, M_WARNING, 0, _("FileSet MD5 digest not found.\n"));
 694    }
 695    if (!jcr->fileset->ignore_fs_changes ||
 696        !db_get_fileset_record(jcr, jcr->db, &fsr)) {
 697       if (!db_create_fileset_record(jcr, jcr->db, &fsr)) {
 698          Jmsg(jcr, M_ERROR, 0, _("Could not create FileSet \"%s\" record. ERR=%s\n"),
 699             fsr.FileSet, db_strerror(jcr->db));
 700          return false;
 701       }
 702    }
 703    jcr->jr.FileSetId = fsr.FileSetId;
 704    bstrncpy(jcr->FSCreateTime, fsr.cCreateTime, sizeof(jcr->FSCreateTime));
 705    Dmsg2(119, "Created FileSet %s record %u\n", jcr->fileset->hdr.name,
 706       jcr->jr.FileSetId);
 707    return true;
 708 }
 709
 710 void init_jcr_job_record(JCR *jcr)
 711 {
 712    jcr->jr.SchedTime = jcr->sched_time;
 713    jcr->jr.StartTime = jcr->start_time;
 714    jcr->jr.EndTime = 0;               /* perhaps rescheduled, clear it */
 715    jcr->jr.JobType = jcr->JobType;
 716    jcr->jr.JobLevel = jcr->JobLevel;
 717    jcr->jr.JobStatus = jcr->JobStatus;
 718    jcr->jr.JobId = jcr->JobId;
 719    bstrncpy(jcr->jr.Name, jcr->job->name(), sizeof(jcr->jr.Name));
 720    bstrncpy(jcr->jr.Job, jcr->Job, sizeof(jcr->jr.Job));
 721 }
 722
 723 /*
 724  * Write status and such in DB
 725  */
 726 void update_job_end_record(JCR *jcr)
 727 {
 728    jcr->jr.EndTime = time(NULL);
 729    jcr->end_time = jcr->jr.EndTime;
 730    jcr->jr.JobId = jcr->JobId;
 731    jcr->jr.JobStatus = jcr->JobStatus;
 732    jcr->jr.JobFiles = jcr->JobFiles;
 733    jcr->jr.JobBytes = jcr->JobBytes;
 734    jcr->jr.VolSessionId = jcr->VolSessionId;
 735    jcr->jr.VolSessionTime = jcr->VolSessionTime;
 736    jcr->jr.JobErrors = jcr->Errors;
 737    if (!db_update_job_end_record(jcr, jcr->db, &jcr->jr)) {
 738       Jmsg(jcr, M_WARNING, 0, _("Error updating job record. %s"),
 739          db_strerror(jcr->db));
 740    }
 741 }
 742
 743 /*
 744  * Takes base_name and appends (unique) current
 745  *   date and time to form unique job name.
 746  *
 747  *  Note, the seconds are actually a sequence number. This
 748  *   permits us to start a maximum fo 59 unique jobs a second, which
 749  *   should be sufficient.
 750  *
 751  *  Returns: unique job name in jcr->Job
 752  *    date/time in jcr->start_time
 753  */
 754 void create_unique_job_name(JCR *jcr, const char *base_name)
 755 {
 756    /* Job start mutex */
 757    static pthread_mutex_t mutex = PTHREAD_MUTEX_INITIALIZER;
 758    static time_t last_start_time = 0;
 759    static int seq = 0;
 760    time_t now;
 761    struct tm tm;
 762    char dt[MAX_TIME_LENGTH];
 763    char name[MAX_NAME_LENGTH];
 764    char *p;
 765
 766    /* Guarantee unique start time -- maximum one per second, and
 767     * thus unique Job Name
 768     */
 769    P(mutex);                          /* lock creation of jobs */
 770    now = time(NULL);
 771    seq++;
 772    if (seq > 59) {                    /* wrap as if it is seconds */
 773       seq = 0;
 774       while (now == last_start_time) {
 775          bmicrosleep(0, 500000);
 776          now = time(NULL);
 777       }
 778    }
 779    last_start_time = now;
 780    V(mutex);                          /* allow creation of jobs */
 781    jcr->start_time = now;
 782    /* Form Unique JobName */
 783    (void)localtime_r(&now, &tm);
 784    /* Use only characters that are permitted in Windows filenames */
 785    strftime(dt, sizeof(dt), "%Y-%m-%d_%H.%M", &tm);
 786    bstrncpy(name, base_name, sizeof(name));
 787    name[sizeof(name)-22] = 0;          /* truncate if too long */
 788    bsnprintf(jcr->Job, sizeof(jcr->Job), "%s.%s.%02d", name, dt, seq); /* add date & time */
 789    /* Convert spaces into underscores */
 790    for (p=jcr->Job; *p; p++) {
 791       if (*p == ' ') {
 792          *p = '_';
 793       }
 794    }
 795 }
 796
 797 /* Called directly from job rescheduling */
 798 void dird_free_jcr_pointers(JCR *jcr)
 799 {
 800    if (jcr->sd_auth_key) {
 801       free(jcr->sd_auth_key);
 802       jcr->sd_auth_key = NULL;
 803    }
 804    if (jcr->where) {
 805       free(jcr->where);
 806       jcr->where = NULL;
 807    }
 808    if (jcr->file_bsock) {
 809       Dmsg0(200, "Close File bsock\n");
 810       bnet_close(jcr->file_bsock);
 811       jcr->file_bsock = NULL;
 812    }
 813    if (jcr->store_bsock) {
 814       Dmsg0(200, "Close Store bsock\n");
 815       bnet_close(jcr->store_bsock);
 816       jcr->store_bsock = NULL;
 817    }
 818    if (jcr->fname) {
 819       Dmsg0(200, "Free JCR fname\n");
 820       free_pool_memory(jcr->fname);
 821       jcr->fname = NULL;
 822    }
 823    if (jcr->RestoreBootstrap) {
 824       free(jcr->RestoreBootstrap);
 825       jcr->RestoreBootstrap = NULL;
 826    }
 827    if (jcr->client_uname) {
 828       free_pool_memory(jcr->client_uname);
 829       jcr->client_uname = NULL;
 830    }
 831    if (jcr->attr) {
 832       free_pool_memory(jcr->attr);
 833       jcr->attr = NULL;
 834    }
 835    if (jcr->ar) {
 836       free(jcr->ar);
 837       jcr->ar = NULL;
 838    }
 839 }
 840
 841 /*
 842  * Free the Job Control Record if no one is still using it.
 843  *  Called from main free_jcr() routine in src/lib/jcr.c so
 844  *  that we can do our Director specific cleanup of the jcr.
 845  */
 846 void dird_free_jcr(JCR *jcr)
 847 {
 848    Dmsg0(200, "Start dird free_jcr\n");
 849
 850    dird_free_jcr_pointers(jcr);
 851    if (jcr->term_wait_inited) {
 852       pthread_cond_destroy(&jcr->term_wait);
 853       jcr->term_wait_inited = false;
 854    }
 855    if (jcr->db_batch && jcr->db_batch != jcr->db) {
 856       db_close_database(jcr, jcr->db_batch);
 857    }
 858    jcr->db_batch = NULL;
 859    if (jcr->db) {
 860       db_close_database(jcr, jcr->db);
 861       jcr->db = NULL;
 862    }
 863    if (jcr->stime) {
 864       Dmsg0(200, "Free JCR stime\n");
 865       free_pool_memory(jcr->stime);
 866       jcr->stime = NULL;
 867    }
 868    if (jcr->fname) {
 869       Dmsg0(200, "Free JCR fname\n");
 870       free_pool_memory(jcr->fname);
 871       jcr->fname = NULL;
 872    }
 873    if (jcr->pool_source) {
 874       free_pool_memory(jcr->pool_source);
 875       jcr->pool_source = NULL;
 876    }
 877    if (jcr->rpool_source) {
 878       free_pool_memory(jcr->rpool_source);
 879       jcr->rpool_source = NULL;
 880    }
 881    if (jcr->wstore_source) {
 882       free_pool_memory(jcr->wstore_source);
 883       jcr->wstore_source = NULL;
 884    }
 885    if (jcr->rstore_source) {
 886       free_pool_memory(jcr->rstore_source);
 887       jcr->rstore_source = NULL;
 888    }
 889
 890    /* Delete lists setup to hold storage pointers */
 891    free_rwstorage(jcr);
 892
 893    jcr->job_end_push.destroy();
 894    Dmsg0(200, "End dird free_jcr\n");
 895 }
 896
 897 /*
 898  * The Job storage definition must be either in the Job record
 899  *  or in the Pool record.  The Pool record overrides the Job
 900  *  record.
 901  */
 902 void get_job_storage(USTORE *store, JOB *job, RUN *run)
 903 {
 904    if (run && run->pool && run->pool->storage) {
 905       store->store = (STORE *)run->pool->storage->first();
 906       pm_strcpy(store->store_source, _("Run pool override"));
 907       return;
 908    }
 909    if (run && run->storage) {
 910       store->store = run->storage;
 911       pm_strcpy(store->store_source, _("Run storage override"));
 912       return;
 913    }
 914    if (job->pool->storage) {
 915       store->store = (STORE *)job->pool->storage->first();
 916       pm_strcpy(store->store_source, _("Pool resource"));
 917    } else {
 918       store->store = (STORE *)job->storage->first();
 919       pm_strcpy(store->store_source, _("Job resource"));
 920    }
 921 }
 922
 923 /*
 924  * Set some defaults in the JCR necessary to
 925  * run. These items are pulled from the job
 926  * definition as defaults, but can be overridden
 927  * later either by the Run record in the Schedule resource,
 928  * or by the Console program.
 929  */
 930 void set_jcr_defaults(JCR *jcr, JOB *job)
 931 {
 932    jcr->job = job;
 933    jcr->JobType = job->JobType;
 934    jcr->JobStatus = JS_Created;
 935    switch (jcr->JobType) {
 936    case JT_ADMIN:
 937    case JT_RESTORE:
 938       jcr->JobLevel = L_NONE;
 939       break;
 940    case JT_MIGRATE:
 941       if (!jcr->rpool_source) {
 942          jcr->rpool_source = get_pool_memory(PM_MESSAGE);
 943          pm_strcpy(jcr->rpool_source, _("unknown source"));
 944       }
 945       /* Fall-through wanted */
 946    default:
 947       jcr->JobLevel = job->JobLevel;
 948       break;
 949    }
 950    if (!jcr->fname) {
 951       jcr->fname = get_pool_memory(PM_FNAME);
 952    }
 953    if (!jcr->pool_source) {
 954       jcr->pool_source = get_pool_memory(PM_MESSAGE);
 955       pm_strcpy(jcr->pool_source, _("unknown source"));
 956    }
 957
 958    jcr->JobPriority = job->Priority;
 959    /* Copy storage definitions -- deleted in dir_free_jcr above */
 960    if (job->storage) {
 961       copy_rwstorage(jcr, job->storage, _("Job resource"));
 962    } else {
 963       copy_rwstorage(jcr, job->pool->storage, _("Pool resource"));
 964    }
 965    jcr->client = job->client;
 966    if (!jcr->client_name) {
 967       jcr->client_name = get_pool_memory(PM_NAME);
 968    }
 969    pm_strcpy(jcr->client_name, jcr->client->hdr.name);
 970    pm_strcpy(jcr->pool_source, _("Job resource"));
 971    jcr->pool = job->pool;
 972    jcr->full_pool = job->full_pool;
 973    jcr->inc_pool = job->inc_pool;
 974    jcr->diff_pool = job->diff_pool;
 975    jcr->catalog = job->client->catalog;
 976    jcr->fileset = job->fileset;
 977    jcr->messages = job->messages;
 978    jcr->spool_data = job->spool_data;
 979    jcr->spool_size = job->spool_size;
 980    jcr->write_part_after_job = job->write_part_after_job;
 981    if (jcr->RestoreBootstrap) {
 982       free(jcr->RestoreBootstrap);
 983       jcr->RestoreBootstrap = NULL;
 984    }
 985    /* This can be overridden by Console program */
 986    if (job->RestoreBootstrap) {
 987       jcr->RestoreBootstrap = bstrdup(job->RestoreBootstrap);
 988    }
 989    /* This can be overridden by Console program */
 990    jcr->verify_job = job->verify_job;
 991    /* If no default level given, set one */
 992    if (jcr->JobLevel == 0) {
 993       switch (jcr->JobType) {
 994       case JT_VERIFY:
 995          jcr->JobLevel = L_VERIFY_CATALOG;
 996          break;
 997       case JT_BACKUP:
 998          jcr->JobLevel = L_INCREMENTAL;
 999          break;
1000       case JT_RESTORE:
1001       case JT_ADMIN:
1002          jcr->JobLevel = L_NONE;
1003          break;
1004       default:
1005          jcr->JobLevel = L_FULL;
1006          break;
1007       }
1008    }
1009 }
1010
1011 /*
1012  * Copy the storage definitions from an alist to the JCR
1013  */
1014 void copy_rwstorage(JCR *jcr, alist *storage, const char *where)
1015 {
1016    switch(jcr->JobType) {
1017    case JT_RESTORE:
1018    case JT_VERIFY:
1019    case JT_MIGRATE:
1020       copy_rstorage(jcr, storage, where);
1021       break;
1022    default:
1023       copy_wstorage(jcr, storage, where);
1024       break;
1025    }
1026 }
1027
1028
1029 /* Set storage override.  Releases any previous storage definition */
1030 void set_rwstorage(JCR *jcr, USTORE *store)
1031 {
1032    if (!store) {
1033       Jmsg(jcr, M_FATAL, 0, _("No storage specified.\n"));
1034       return;
1035    }
1036    switch(jcr->JobType) {
1037    case JT_RESTORE:
1038    case JT_VERIFY:
1039    case JT_MIGRATE:
1040       set_rstorage(jcr, store);
1041       break;
1042    default:
1043       set_wstorage(jcr, store);
1044       break;
1045    }
1046 }
1047
1048 void free_rwstorage(JCR *jcr)
1049 {
1050    free_rstorage(jcr);
1051    free_wstorage(jcr);
1052 }
1053
1054 /*
1055  * Copy the storage definitions from an alist to the JCR
1056  */
1057 void copy_rstorage(JCR *jcr, alist *storage, const char *where)
1058 {
1059    if (storage) {
1060       STORE *st;
1061       if (jcr->rstorage) {
1062          delete jcr->rstorage;
1063       }
1064       jcr->rstorage = New(alist(10, not_owned_by_alist));
1065       foreach_alist(st, storage) {
1066          jcr->rstorage->append(st);
1067       }
1068       if (!jcr->rstore_source) {
1069          jcr->rstore_source = get_pool_memory(PM_MESSAGE);
1070       }
1071       pm_strcpy(jcr->rstore_source, where);
1072       if (jcr->rstorage) {
1073          jcr->rstore = (STORE *)jcr->rstorage->first();
1074       }
1075    }
1076 }
1077
1078
1079 /* Set storage override.  Remove all previous storage */
1080 void set_rstorage(JCR *jcr, USTORE *store)
1081 {
1082    STORE *storage;
1083
1084    if (!store->store) {
1085       return;
1086    }
1087    if (jcr->rstorage) {
1088       free_rstorage(jcr);
1089    }
1090    if (!jcr->rstorage) {
1091       jcr->rstorage = New(alist(10, not_owned_by_alist));
1092    }
1093    jcr->rstore = store->store;
1094    if (!jcr->rstore_source) {
1095       jcr->rstore_source = get_pool_memory(PM_MESSAGE);
1096    }
1097    pm_strcpy(jcr->rstore_source, store->store_source);
1098    foreach_alist(storage, jcr->rstorage) {
1099       if (store->store == storage) {
1100          return;
1101       }
1102    }
1103    /* Store not in list, so add it */
1104    jcr->rstorage->prepend(store->store);
1105 }
1106
1107 void free_rstorage(JCR *jcr)
1108 {
1109    if (jcr->rstorage) {
1110       delete jcr->rstorage;
1111       jcr->rstorage = NULL;
1112    }
1113    jcr->rstore = NULL;
1114 }
1115
1116 /*
1117  * Copy the storage definitions from an alist to the JCR
1118  */
1119 void copy_wstorage(JCR *jcr, alist *storage, const char *where)
1120 {
1121    if (storage) {
1122       STORE *st;
1123       if (jcr->wstorage) {
1124          delete jcr->wstorage;
1125       }
1126       jcr->wstorage = New(alist(10, not_owned_by_alist));
1127       foreach_alist(st, storage) {
1128          Dmsg1(100, "wstorage=%s\n", st->name());
1129          jcr->wstorage->append(st);
1130       }
1131       if (!jcr->wstore_source) {
1132          jcr->wstore_source = get_pool_memory(PM_MESSAGE);
1133       }
1134       pm_strcpy(jcr->wstore_source, where);
1135       if (jcr->wstorage) {
1136          jcr->wstore = (STORE *)jcr->wstorage->first();
1137          Dmsg2(100, "wstore=%s where=%s\n", jcr->wstore->name(), jcr->wstore_source);
1138       }
1139    }
1140 }
1141
1142
1143 /* Set storage override. Remove all previous storage */
1144 void set_wstorage(JCR *jcr, USTORE *store)
1145 {
1146    STORE *storage;
1147
1148    if (!store->store) {
1149       return;
1150    }
1151    if (jcr->wstorage) {
1152       free_wstorage(jcr);
1153    }
1154    if (!jcr->wstorage) {
1155       jcr->wstorage = New(alist(10, not_owned_by_alist));
1156    }
1157    jcr->wstore = store->store;
1158    if (!jcr->wstore_source) {
1159       jcr->wstore_source = get_pool_memory(PM_MESSAGE);
1160    }
1161    pm_strcpy(jcr->wstore_source, store->store_source);
1162    Dmsg2(50, "wstore=%s where=%s\n", jcr->wstore->name(), jcr->wstore_source);
1163    foreach_alist(storage, jcr->wstorage) {
1164       if (store->store == storage) {
1165          return;
1166       }
1167    }
1168    /* Store not in list, so add it */
1169    jcr->wstorage->prepend(store->store);
1170 }
1171
1172 void free_wstorage(JCR *jcr)
1173 {
1174    if (jcr->wstorage) {
1175       delete jcr->wstorage;
1176       jcr->wstorage = NULL;
1177    }
1178    jcr->wstore = NULL;
1179 }
1180
1181 void create_clones(JCR *jcr)
1182 {
1183    /*
1184     * Fire off any clone jobs (run directives)
1185     */
1186    Dmsg2(900, "cloned=%d run_cmds=%p\n", jcr->cloned, jcr->job->run_cmds);
1187    if (!jcr->cloned && jcr->job->run_cmds) {
1188       char *runcmd;
1189       JOB *job = jcr->job;
1190       POOLMEM *cmd = get_pool_memory(PM_FNAME);
1191       UAContext *ua = new_ua_context(jcr);
1192       ua->batch = true;
1193       foreach_alist(runcmd, job->run_cmds) {
1194          cmd = edit_job_codes(jcr, cmd, runcmd, "");
1195          Mmsg(ua->cmd, "run %s cloned=yes", cmd);
1196          Dmsg1(900, "=============== Clone cmd=%s\n", ua->cmd);
1197          parse_ua_args(ua);                 /* parse command */
1198          int stat = run_cmd(ua, ua->cmd);
1199          if (stat == 0) {
1200             Jmsg(jcr, M_ERROR, 0, _("Could not start clone job.\n"));
1201          } else {
1202             Jmsg(jcr, M_INFO, 0, _("Clone JobId %d started.\n"), stat);
1203          }
1204       }
1205       free_ua_context(ua);
1206       free_pool_memory(cmd);
1207    }
1208 }
1209
1210 bool create_restore_bootstrap_file(JCR *jcr)
1211 {
1212    RESTORE_CTX rx;
1213    UAContext *ua;
1214    memset(&rx, 0, sizeof(rx));
1215    rx.bsr = new_bsr();
1216    rx.JobIds = (char *)"";
1217    rx.bsr->JobId = jcr->previous_jr.JobId;
1218    ua = new_ua_context(jcr);
1219    complete_bsr(ua, rx.bsr);
1220    rx.bsr->fi = new_findex();
1221    rx.bsr->fi->findex = 1;
1222    rx.bsr->fi->findex2 = jcr->previous_jr.JobFiles;
1223    jcr->ExpectedFiles = write_bsr_file(ua, rx);
1224    if (jcr->ExpectedFiles == 0) {
1225       free_ua_context(ua);
1226       free_bsr(rx.bsr);
1227       return false;
1228    }
1229    free_ua_context(ua);
1230    free_bsr(rx.bsr);
1231    jcr->needs_sd = true;
1232    return true;
1233 }