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

   1 /*
   2  * Bacula job queue routines.
   3  *
   4  *  This code consists of three queues, the waiting_jobs
   5  *  queue, where jobs are initially queued, the ready_jobs
   6  *  queue, where jobs are placed when all the resources are
   7  *  allocated and they can immediately be run, and the
   8  *  running queue where jobs are placed when they are
   9  *  running.
  10  *
  11  *  Kern Sibbald, July MMIII
  12  *
  13  *   Version $Id$
  14  *
  15  *  This code was adapted from the Bacula workq, which was
  16  *    adapted from "Programming with POSIX Threads", by
  17  *    David R. Butenhof
  18  *
  19  */
  20 /*
  21    Copyright (C) 2000-2003 Kern Sibbald and John Walker
  22
  23    This program is free software; you can redistribute it and/or
  24    modify it under the terms of the GNU General Public License as
  25    published by the Free Software Foundation; either version 2 of
  26    the License, or (at your option) any later version.
  27
  28    This program is distributed in the hope that it will be useful,
  29    but WITHOUT ANY WARRANTY; without even the implied warranty of
  30    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  31    General Public License for more details.
  32
  33    You should have received a copy of the GNU General Public
  34    License along with this program; if not, write to the Free
  35    Software Foundation, Inc., 59 Temple Place - Suite 330, Boston,
  36    MA 02111-1307, USA.
  37
  38  */
  39
  40 #include "bacula.h"
  41 #include "dird.h"
  42
  43
  44 /* Forward referenced functions */
  45 static void *jobq_server(void *arg);
  46 static int   start_server(jobq_t *jq);
  47
  48 /*
  49  * Initialize a job queue
  50  *
  51  *  Returns: 0 on success
  52  *           errno on failure
  53  */
  54 int jobq_init(jobq_t *jq, int threads, void *(*engine)(void *arg))
  55 {
  56    int stat;
  57    jobq_item_t *item = NULL;
  58
  59    if ((stat = pthread_attr_init(&jq->attr)) != 0) {
  60       return stat;
  61    }
  62    if ((stat = pthread_attr_setdetachstate(&jq->attr, PTHREAD_CREATE_DETACHED)) != 0) {
  63       pthread_attr_destroy(&jq->attr);
  64       return stat;
  65    }
  66    if ((stat = pthread_mutex_init(&jq->mutex, NULL)) != 0) {
  67       pthread_attr_destroy(&jq->attr);
  68       return stat;
  69    }
  70    if ((stat = pthread_cond_init(&jq->work, NULL)) != 0) {
  71       pthread_mutex_destroy(&jq->mutex);
  72       pthread_attr_destroy(&jq->attr);
  73       return stat;
  74    }
  75    jq->quit = false;
  76    jq->max_workers = threads;         /* max threads to create */
  77    jq->num_workers = 0;               /* no threads yet */
  78    jq->idle_workers = 0;              /* no idle threads */
  79    jq->engine = engine;               /* routine to run */
  80    jq->valid = JOBQ_VALID;
  81    /* Initialize the job queues */
  82    jq->waiting_jobs = new dlist(item, &item->link);
  83    jq->running_jobs = new dlist(item, &item->link);
  84    jq->ready_jobs = new dlist(item, &item->link);
  85    return 0;
  86 }
  87
  88 /*
  89  * Destroy the job queue
  90  *
  91  * Returns: 0 on success
  92  *          errno on failure
  93  */
  94 int jobq_destroy(jobq_t *jq)
  95 {
  96    int stat, stat1, stat2;
  97
  98   if (jq->valid != JOBQ_VALID) {
  99      return EINVAL;
 100   }
 101   if ((stat = pthread_mutex_lock(&jq->mutex)) != 0) {
 102      return stat;
 103   }
 104   jq->valid = 0;                      /* prevent any more operations */
 105
 106   /*
 107    * If any threads are active, wake them
 108    */
 109   if (jq->num_workers > 0) {
 110      jq->quit = true;
 111      if (jq->idle_workers) {
 112         if ((stat = pthread_cond_broadcast(&jq->work)) != 0) {
 113            pthread_mutex_unlock(&jq->mutex);
 114            return stat;
 115         }
 116      }
 117      while (jq->num_workers > 0) {
 118         if ((stat = pthread_cond_wait(&jq->work, &jq->mutex)) != 0) {
 119            pthread_mutex_unlock(&jq->mutex);
 120            return stat;
 121         }
 122      }
 123   }
 124   if ((stat = pthread_mutex_unlock(&jq->mutex)) != 0) {
 125      return stat;
 126   }
 127   stat  = pthread_mutex_destroy(&jq->mutex);
 128   stat1 = pthread_cond_destroy(&jq->work);
 129   stat2 = pthread_attr_destroy(&jq->attr);
 130   delete jq->waiting_jobs;
 131   delete jq->running_jobs;
 132   delete jq->ready_jobs;
 133   return (stat != 0 ? stat : (stat1 != 0 ? stat1 : stat2));
 134 }
 135
 136 struct wait_pkt {
 137    JCR *jcr;
 138    jobq_t *jq;
 139 };
 140
 141 /*
 142  * Wait until schedule time arrives before starting. Normally
 143  *  this routine is only used for jobs started from the console
 144  *  for which the user explicitly specified a start time. Otherwise
 145  *  most jobs are put into the job queue only when their
 146  *  scheduled time arives.
 147  */
 148 static void *sched_wait(void *arg)
 149 {
 150    JCR *jcr = ((wait_pkt *)arg)->jcr;
 151    jobq_t *jq = ((wait_pkt *)arg)->jq;
 152
 153    Dmsg0(100, "Enter sched_wait.\n");
 154    free(arg);
 155    time_t wtime = jcr->sched_time - time(NULL);
 156    /* Wait until scheduled time arrives */
 157    if (wtime > 0 && verbose) {
 158       Jmsg(jcr, M_INFO, 0, _("Job %s waiting %d seconds for scheduled start time.\n"),
 159          jcr->Job, wtime);
 160       set_jcr_job_status(jcr, JS_WaitStartTime);
 161    }
 162    /* Check every 30 seconds if canceled */
 163    while (wtime > 0) {
 164       Dmsg2(100, "Waiting on sched time, jobid=%d secs=%d\n", jcr->JobId, wtime);
 165       if (wtime > 30) {
 166          wtime = 30;
 167       }
 168       bmicrosleep(wtime, 0);
 169       if (job_canceled(jcr)) {
 170          break;
 171       }
 172       wtime = jcr->sched_time - time(NULL);
 173    }
 174    jobq_add(jq, jcr);
 175    Dmsg0(100, "Exit sched_wait\n");
 176    return NULL;
 177 }
 178
 179
 180 /*
 181  *  Add a job to the queue
 182  *    jq is a queue that was created with jobq_init
 183  *
 184  */
 185 int jobq_add(jobq_t *jq, JCR *jcr)
 186 {
 187    int stat;
 188    jobq_item_t *item, *li;
 189    bool inserted = false;
 190    time_t wtime = jcr->sched_time - time(NULL);
 191    pthread_t id;
 192    wait_pkt *sched_pkt;
 193
 194
 195    Dmsg1(100, "jobq_add jobid=%d\n", jcr->JobId);
 196    if (jq->valid != JOBQ_VALID) {
 197       return EINVAL;
 198    }
 199
 200    if (!job_canceled(jcr) && wtime > 0) {
 201       set_thread_concurrency(jq->max_workers + 2);
 202       sched_pkt = (wait_pkt *)malloc(sizeof(wait_pkt));
 203       sched_pkt->jcr = jcr;
 204       sched_pkt->jq = jq;
 205       stat = pthread_create(&id, &jq->attr, sched_wait, (void *)sched_pkt);
 206       return stat;
 207    }
 208
 209    if ((stat = pthread_mutex_lock(&jq->mutex)) != 0) {
 210       return stat;
 211    }
 212
 213    if ((item = (jobq_item_t *)malloc(sizeof(jobq_item_t))) == NULL) {
 214       return ENOMEM;
 215    }
 216    item->jcr = jcr;
 217
 218    if (job_canceled(jcr)) {
 219       /* Add job to ready queue so that it is canceled quickly */
 220       jq->ready_jobs->prepend(item);
 221       Dmsg1(100, "Prepended job=%d to ready queue\n", jcr->JobId);
 222    } else {
 223       /* Add this job to the wait queue in priority sorted order */
 224       for (li=NULL; (li=(jobq_item_t *)jq->waiting_jobs->next(li)); ) {
 225          Dmsg2(100, "waiting item jobid=%d priority=%d\n",
 226             li->jcr->JobId, li->jcr->JobPriority);
 227          if (li->jcr->JobPriority > jcr->JobPriority) {
 228             jq->waiting_jobs->insert_before(item, li);
 229             Dmsg2(100, "insert_before jobid=%d before %d\n",
 230                li->jcr->JobId, jcr->JobId);
 231             inserted = true;
 232             break;
 233          }
 234       }
 235       /* If not jobs in wait queue, append it */
 236       if (!inserted) {
 237          jq->waiting_jobs->append(item);
 238          Dmsg1(100, "Appended item jobid=%d\n", jcr->JobId);
 239       }
 240    }
 241
 242    /* Ensure that at least one server looks at the queue. */
 243    stat = start_server(jq);
 244
 245    pthread_mutex_unlock(&jq->mutex);
 246    Dmsg0(100, "Return jobq_add\n");
 247    return stat;
 248 }
 249
 250 /*
 251  *  Remove a job from the job queue. Used only by cancel Console command.
 252  *    jq is a queue that was created with jobq_init
 253  *    work_item is an element of work
 254  *
 255  *   Note, it is "removed" by immediately calling a processing routine.
 256  *    if you want to cancel it, you need to provide some external means
 257  *    of doing so.
 258  */
 259 int jobq_remove(jobq_t *jq, JCR *jcr)
 260 {
 261    int stat;
 262    bool found = false;
 263    jobq_item_t *item;
 264
 265    Dmsg1(100, "jobq_remove jobid=%d\n", jcr->JobId);
 266    if (jq->valid != JOBQ_VALID) {
 267       return EINVAL;
 268    }
 269
 270    if ((stat = pthread_mutex_lock(&jq->mutex)) != 0) {
 271       return stat;
 272    }
 273
 274    for (item=NULL; (item=(jobq_item_t *)jq->waiting_jobs->next(item)); ) {
 275       if (jcr == item->jcr) {
 276          found = true;
 277          break;
 278       }
 279    }
 280    if (!found) {
 281       return EINVAL;
 282    }
 283
 284    /* Move item to be the first on the list */
 285    jq->waiting_jobs->remove(item);
 286    jq->ready_jobs->prepend(item);
 287
 288    stat = start_server(jq);
 289
 290    pthread_mutex_unlock(&jq->mutex);
 291    Dmsg0(100, "Return jobq_remove\n");
 292    return stat;
 293 }
 294
 295
 296 /*
 297  * Start the server thread if it isn't already running
 298  */
 299 static int start_server(jobq_t *jq)
 300 {
 301    int stat = 0;
 302    pthread_t id;
 303
 304    /* if any threads are idle, wake one */
 305    if (jq->idle_workers > 0) {
 306       Dmsg0(100, "Signal worker to wake up\n");
 307       if ((stat = pthread_cond_signal(&jq->work)) != 0) {
 308          return stat;
 309       }
 310    } else if (jq->num_workers < jq->max_workers) {
 311       Dmsg0(100, "Create worker thread\n");
 312       /* No idle threads so create a new one */
 313       set_thread_concurrency(jq->max_workers + 1);
 314       if ((stat = pthread_create(&id, &jq->attr, jobq_server, (void *)jq)) != 0) {
 315          return stat;
 316       }
 317    }
 318    return stat;
 319 }
 320
 321
 322 /*
 323  * This is the worker thread that serves the job queue.
 324  * When all the resources are acquired for the job,
 325  *  it will call the user's engine.
 326  */
 327 static void *jobq_server(void *arg)
 328 {
 329    struct timespec timeout;
 330    jobq_t *jq = (jobq_t *)arg;
 331    jobq_item_t *je;                   /* job entry in queue */
 332    int stat;
 333    bool timedout;
 334    bool work = true;
 335
 336    Dmsg0(100, "Start jobq_server\n");
 337    if ((stat = pthread_mutex_lock(&jq->mutex)) != 0) {
 338       return NULL;
 339    }
 340    jq->num_workers++;
 341
 342    for (;;) {
 343       struct timeval tv;
 344       struct timezone tz;
 345
 346       Dmsg0(100, "Top of for loop\n");
 347       timedout = false;
 348       Dmsg0(100, "gettimeofday()\n");
 349       gettimeofday(&tv, &tz);
 350       timeout.tv_nsec = 0;
 351       timeout.tv_sec = tv.tv_sec + 4;
 352
 353       while (!work && !jq->quit) {
 354          /*
 355           * Wait 4 seconds, then if no more work, exit
 356           */
 357          Dmsg0(200, "pthread_cond_timedwait()\n");
 358          stat = pthread_cond_timedwait(&jq->work, &jq->mutex, &timeout);
 359          Dmsg1(100, "timedwait=%d\n", stat);
 360          if (stat == ETIMEDOUT) {
 361             timedout = true;
 362             break;
 363          } else if (stat != 0) {
 364             /* This shouldn't happen */
 365             Dmsg0(100, "This shouldn't happen\n");
 366             jq->num_workers--;
 367             pthread_mutex_unlock(&jq->mutex);
 368             return NULL;
 369          }
 370       }
 371       /*
 372        * If anything is in the ready queue, run it
 373        */
 374       Dmsg0(100, "Checking ready queue.\n");
 375       while (!jq->ready_jobs->empty() && !jq->quit) {
 376          JCR *jcr;
 377          je = (jobq_item_t *)jq->ready_jobs->first();
 378          jcr = je->jcr;
 379          jq->ready_jobs->remove(je);
 380          if (!jq->ready_jobs->empty()) {
 381             Dmsg0(100, "ready queue not empty start server\n");
 382             if (start_server(jq) != 0) {
 383                jq->num_workers--;
 384                pthread_mutex_unlock(&jq->mutex);
 385                return NULL;
 386             }
 387          }
 388          jq->running_jobs->append(je);
 389          Dmsg1(100, "Took jobid=%d from ready and appended to run\n", jcr->JobId);
 390          if ((stat = pthread_mutex_unlock(&jq->mutex)) != 0) {
 391             jq->num_workers--;
 392             return NULL;
 393          }
 394          /* Call user's routine here */
 395          Dmsg1(100, "Calling user engine for jobid=%d\n", jcr->JobId);
 396          jq->engine(je->jcr);
 397          Dmsg1(100, "Back from user engine jobid=%d.\n", jcr->JobId);
 398          if ((stat = pthread_mutex_lock(&jq->mutex)) != 0) {
 399             jq->num_workers--;
 400             free(je);                 /* release job entry */
 401             return NULL;
 402          }
 403          Dmsg0(200, "Done lock mutex\n");
 404          jq->running_jobs->remove(je);
 405          /*
 406           * Release locks if acquired. Note, they will not have
 407           *  been acquired for jobs canceled before they were
 408           *  put into the ready queue.
 409           */
 410          if (jcr->acquired_resource_locks) {
 411             jcr->store->NumConcurrentJobs--;
 412             jcr->client->NumConcurrentJobs--;
 413             jcr->job->NumConcurrentJobs--;
 414          }
 415
 416          if (jcr->job->RescheduleOnError &&
 417              jcr->JobStatus != JS_Terminated &&
 418              jcr->JobStatus != JS_Canceled &&
 419              jcr->job->RescheduleTimes > 0 &&
 420              jcr->reschedule_count < jcr->job->RescheduleTimes) {
 421
 422              /*
 423               * Reschedule this job by cleaning it up, but
 424               *  reuse the same JobId if possible.
 425               */
 426             jcr->reschedule_count++;
 427             jcr->sched_time = time(NULL) + jcr->job->RescheduleInterval;
 428             Dmsg2(100, "Rescheduled Job %s to re-run in %d seconds.\n", jcr->Job,
 429                (int)jcr->job->RescheduleInterval);
 430             jcr->JobStatus = JS_Created; /* force new status */
 431             dird_free_jcr(jcr);          /* partial cleanup old stuff */
 432             if (jcr->JobBytes == 0) {
 433                Dmsg1(100, "Requeue job=%d\n", jcr->JobId);
 434                V(jq->mutex);
 435                jobq_add(jq, jcr);     /* queue the job to run again */
 436                P(jq->mutex);
 437                free(je);              /* free the job entry */
 438                continue;              /* look for another job to run */
 439             }
 440             /*
 441              * Something was actually backed up, so we cannot reuse
 442              *   the old JobId or there will be database record
 443              *   conflicts.  We now create a new job, copying the
 444              *   appropriate fields.
 445              */
 446             JCR *njcr = new_jcr(sizeof(JCR), dird_free_jcr);
 447             set_jcr_defaults(njcr, jcr->job);
 448             njcr->reschedule_count = jcr->reschedule_count;
 449             njcr->JobLevel = jcr->JobLevel;
 450             njcr->JobStatus = jcr->JobStatus;
 451             njcr->pool = jcr->pool;
 452             njcr->store = jcr->store;
 453             njcr->messages = jcr->messages;
 454             Dmsg0(100, "Call to run new job\n");
 455             V(jq->mutex);
 456             run_job(njcr);            /* This creates a "new" job */
 457             P(jq->mutex);
 458             Dmsg0(100, "Back from running new job.\n");
 459          }
 460          /* Clean up and release old jcr */
 461          if (jcr->db) {
 462             Dmsg0(100, "Close DB\n");
 463             db_close_database(jcr, jcr->db);
 464             jcr->db = NULL;
 465          }
 466          Dmsg1(100, "====== Termination job=%d\n", jcr->JobId);
 467          free_jcr(jcr);
 468          free(je);                    /* release job entry */
 469       }
 470       /*
 471        * If any job in the wait queue can be run,
 472        *  move it to the ready queue
 473        */
 474       Dmsg0(100, "Done check ready, now check wait queue.\n");
 475       while (!jq->waiting_jobs->empty() && !jq->quit) {
 476          int Priority;
 477          je = (jobq_item_t *)jq->waiting_jobs->first();
 478          jobq_item_t *re = (jobq_item_t *)jq->running_jobs->first();
 479          if (re) {
 480             Priority = re->jcr->JobPriority;
 481             Dmsg1(100, "Set Run pri=%d\n", Priority);
 482          } else {
 483             Priority = je->jcr->JobPriority;
 484             Dmsg1(100, "Set Job pri=%d\n", Priority);
 485          }
 486          /*
 487           * Walk down the list of waiting jobs and attempt
 488           *   to acquire the resources it needs.
 489           */
 490          for ( ; je;  ) {
 491             /* je is current job item on the queue, jn is the next one */
 492             JCR *jcr = je->jcr;
 493             jobq_item_t *jn = (jobq_item_t *)jq->waiting_jobs->next(je);
 494             Dmsg3(100, "Examining Job=%d JobPri=%d want Pri=%d\n",
 495                jcr->JobId, jcr->JobPriority, Priority);
 496             /* Take only jobs of correct Priority */
 497             if (jcr->JobPriority != Priority) {
 498                set_jcr_job_status(jcr, JS_WaitPriority);
 499                break;
 500             }
 501             if (jcr->store->NumConcurrentJobs < jcr->store->MaxConcurrentJobs) {
 502                jcr->store->NumConcurrentJobs++;
 503             } else {
 504                set_jcr_job_status(jcr, JS_WaitStoreRes);
 505                je = jn;
 506                continue;
 507             }
 508             if (jcr->client->NumConcurrentJobs < jcr->client->MaxConcurrentJobs) {
 509                jcr->client->NumConcurrentJobs++;
 510             } else {
 511                jcr->store->NumConcurrentJobs--;
 512                set_jcr_job_status(jcr, JS_WaitClientRes);
 513                je = jn;
 514                continue;
 515             }
 516             if (jcr->job->NumConcurrentJobs < jcr->job->MaxConcurrentJobs) {
 517                jcr->job->NumConcurrentJobs++;
 518             } else {
 519                jcr->store->NumConcurrentJobs--;
 520                jcr->client->NumConcurrentJobs--;
 521                set_jcr_job_status(jcr, JS_WaitJobRes);
 522                je = jn;
 523                continue;
 524             }
 525             /* Got all locks, now remove it from wait queue and append it
 526              *   to the ready queue
 527              */
 528             jcr->acquired_resource_locks = true;
 529             jq->waiting_jobs->remove(je);
 530             jq->ready_jobs->append(je);
 531             Dmsg1(100, "moved JobId=%d from wait to ready queue\n", je->jcr->JobId);
 532             je = jn;
 533          } /* end for loop */
 534          break;
 535       } /* end while loop */
 536       Dmsg0(100, "Done checking wait queue.\n");
 537       /*
 538        * If no more ready work and we are asked to quit, then do it
 539        */
 540       if (jq->ready_jobs->empty() && jq->quit) {
 541          jq->num_workers--;
 542          if (jq->num_workers == 0) {
 543             Dmsg0(100, "Wake up destroy routine\n");
 544             /* Wake up destroy routine if he is waiting */
 545             pthread_cond_broadcast(&jq->work);
 546          }
 547          break;
 548       }
 549       Dmsg0(100, "Check for work request\n");
 550       /*
 551        * If no more work requests, and we waited long enough, quit
 552        */
 553       Dmsg2(100, "timedout=%d read empty=%d\n", timedout,
 554          jq->ready_jobs->empty());
 555       if (jq->ready_jobs->empty() && timedout) {
 556          Dmsg0(100, "break big loop\n");
 557          jq->num_workers--;
 558          break;
 559       }
 560       Dmsg0(100, "Loop again\n");
 561       work = false;
 562    } /* end of big for loop */
 563
 564    Dmsg0(200, "unlock mutex\n");
 565    pthread_mutex_unlock(&jq->mutex);
 566    Dmsg0(100, "End jobq_server\n");
 567    return NULL;
 568 }