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 #ifdef JOB_QUEUE
  44
  45 /* Forward referenced functions */
  46 static void *jobq_server(void *arg);
  47 static int   start_server(jobq_t *jq);
  48
  49 /*
  50  * Initialize a job queue
  51  *
  52  *  Returns: 0 on success
  53  *           errno on failure
  54  */
  55 int jobq_init(jobq_t *jq, int threads, void *(*engine)(void *arg))
  56 {
  57    int stat;
  58    jobq_item_t *item = NULL;
  59
  60    if ((stat = pthread_attr_init(&jq->attr)) != 0) {
  61       return stat;
  62    }
  63    if ((stat = pthread_attr_setdetachstate(&jq->attr, PTHREAD_CREATE_DETACHED)) != 0) {
  64       pthread_attr_destroy(&jq->attr);
  65       return stat;
  66    }
  67    if ((stat = pthread_mutex_init(&jq->mutex, NULL)) != 0) {
  68       pthread_attr_destroy(&jq->attr);
  69       return stat;
  70    }
  71    if ((stat = pthread_cond_init(&jq->work, NULL)) != 0) {
  72       pthread_mutex_destroy(&jq->mutex);
  73       pthread_attr_destroy(&jq->attr);
  74       return stat;
  75    }
  76    jq->quit = false;
  77    jq->max_workers = threads;         /* max threads to create */
  78    jq->num_workers = 0;               /* no threads yet */
  79    jq->idle_workers = 0;              /* no idle threads */
  80    jq->engine = engine;               /* routine to run */
  81    jq->valid = JOBQ_VALID;
  82    /* Initialize the job queues */
  83    jq->waiting_jobs = new dlist(item, &item->link);
  84    jq->running_jobs = new dlist(item, &item->link);
  85    jq->ready_jobs = new dlist(item, &item->link);
  86    return 0;
  87 }
  88
  89 /*
  90  * Destroy the job queue
  91  *
  92  * Returns: 0 on success
  93  *          errno on failure
  94  */
  95 int jobq_destroy(jobq_t *jq)
  96 {
  97    int stat, stat1, stat2;
  98
  99   if (jq->valid != JOBQ_VALID) {
 100      return EINVAL;
 101   }
 102   if ((stat = pthread_mutex_lock(&jq->mutex)) != 0) {
 103      return stat;
 104   }
 105   jq->valid = 0;                      /* prevent any more operations */
 106
 107   /*
 108    * If any threads are active, wake them
 109    */
 110   if (jq->num_workers > 0) {
 111      jq->quit = true;
 112      if (jq->idle_workers) {
 113         if ((stat = pthread_cond_broadcast(&jq->work)) != 0) {
 114            pthread_mutex_unlock(&jq->mutex);
 115            return stat;
 116         }
 117      }
 118      while (jq->num_workers > 0) {
 119         if ((stat = pthread_cond_wait(&jq->work, &jq->mutex)) != 0) {
 120            pthread_mutex_unlock(&jq->mutex);
 121            return stat;
 122         }
 123      }
 124   }
 125   if ((stat = pthread_mutex_unlock(&jq->mutex)) != 0) {
 126      return stat;
 127   }
 128   stat  = pthread_mutex_destroy(&jq->mutex);
 129   stat1 = pthread_cond_destroy(&jq->work);
 130   stat2 = pthread_attr_destroy(&jq->attr);
 131   delete jq->waiting_jobs;
 132   delete jq->running_jobs;
 133   delete jq->ready_jobs;
 134   return (stat != 0 ? stat : (stat1 != 0 ? stat1 : stat2));
 135 }
 136
 137 struct wait_pkt {
 138    JCR *jcr;
 139    jobq_t *jq;
 140 };
 141
 142 /*
 143  * Wait until schedule time arrives before starting
 144  */
 145 static void *sched_wait(void *arg)
 146 {
 147    JCR *jcr = ((wait_pkt *)arg)->jcr;
 148    jobq_t *jq = ((wait_pkt *)arg)->jq;
 149
 150    Dmsg0(100, "Enter sched_wait.\n");
 151    free(arg);
 152    time_t wtime = jcr->sched_time - time(NULL);
 153    /* Wait until scheduled time arrives */
 154    if (wtime > 0 && verbose) {
 155       Jmsg(jcr, M_INFO, 0, _("Job %s waiting %d seconds for scheduled start time.\n"),
 156          jcr->Job, wtime);
 157       set_jcr_job_status(jcr, JS_WaitStartTime);
 158    }
 159    /* Check every 30 seconds if canceled */
 160    while (wtime > 0) {
 161       Dmsg2(100, "Waiting on sched time, jobid=%d secs=%d\n", jcr->JobId, wtime);
 162       if (wtime > 30) {
 163          wtime = 30;
 164       }
 165       bmicrosleep(wtime, 0);
 166       if (job_canceled(jcr)) {
 167          break;
 168       }
 169       wtime = jcr->sched_time - time(NULL);
 170    }
 171    jobq_add(jq, jcr);
 172    Dmsg0(100, "Exit sched_wait\n");
 173    return NULL;
 174 }
 175
 176
 177 /*
 178  *  Add a job to the queue
 179  *    jq is a queue that was created with jobq_init
 180  *
 181  */
 182 int jobq_add(jobq_t *jq, JCR *jcr)
 183 {
 184    int stat;
 185    jobq_item_t *item, *li;
 186    bool inserted = false;
 187    time_t wtime = jcr->sched_time - time(NULL);
 188    pthread_t id;
 189    wait_pkt *sched_pkt;
 190
 191
 192    Dmsg1(100, "jobq_add jobid=%d\n", jcr->JobId);
 193    if (jq->valid != JOBQ_VALID) {
 194       return EINVAL;
 195    }
 196
 197    if (!job_canceled(jcr) && wtime > 0) {
 198       set_thread_concurrency(jq->max_workers + 2);
 199       sched_pkt = (wait_pkt *)malloc(sizeof(wait_pkt));
 200       sched_pkt->jcr = jcr;
 201       sched_pkt->jq = jq;
 202       stat = pthread_create(&id, &jq->attr, sched_wait, (void *)sched_pkt);
 203       return stat;
 204    }
 205
 206    if ((stat = pthread_mutex_lock(&jq->mutex)) != 0) {
 207       return stat;
 208    }
 209
 210    if ((item = (jobq_item_t *)malloc(sizeof(jobq_item_t))) == NULL) {
 211       return ENOMEM;
 212    }
 213    item->jcr = jcr;
 214
 215    if (job_canceled(jcr)) {
 216       /* Add job to ready queue so that it is canceled quickly */
 217       jq->ready_jobs->prepend(item);
 218       Dmsg1(100, "Prepended job=%d to ready queue\n", jcr->JobId);
 219    } else {
 220       /* Add this job to the wait queue in priority sorted order */
 221       for (li=NULL; (li=(jobq_item_t *)jq->waiting_jobs->next(li)); ) {
 222          Dmsg2(100, "waiting item jobid=%d priority=%d\n",
 223             li->jcr->JobId, li->jcr->JobPriority);
 224          if (li->jcr->JobPriority > jcr->JobPriority) {
 225             jq->waiting_jobs->insert_before(item, li);
 226             Dmsg2(100, "insert_before jobid=%d before %d\n",
 227                li->jcr->JobId, jcr->JobId);
 228             inserted = true;
 229             break;
 230          }
 231       }
 232       /* If not jobs in wait queue, append it */
 233       if (!inserted) {
 234          jq->waiting_jobs->append(item);
 235          Dmsg1(100, "Appended item jobid=%d\n", jcr->JobId);
 236       }
 237    }
 238
 239    stat = start_server(jq);
 240
 241    if (stat == 0) {
 242       pthread_mutex_unlock(&jq->mutex);
 243    }
 244    Dmsg0(100, "Return jobq_add\n");
 245    return stat;
 246 }
 247
 248 /*
 249  *  Remove a job from the job queue
 250  *    jq is a queue that was created with jobq_init
 251  *    work_item is an element of work
 252  *
 253  *   Note, it is "removed" by immediately calling a processing routine.
 254  *    if you want to cancel it, you need to provide some external means
 255  *    of doing so.
 256  */
 257 int jobq_remove(jobq_t *jq, JCR *jcr)
 258 {
 259    int stat;
 260    bool found = false;
 261    jobq_item_t *item;
 262
 263    Dmsg1(100, "jobq_remove jobid=%d\n", jcr->JobId);
 264    if (jq->valid != JOBQ_VALID) {
 265       return EINVAL;
 266    }
 267
 268    if ((stat = pthread_mutex_lock(&jq->mutex)) != 0) {
 269       return stat;
 270    }
 271
 272    for (item=NULL; (item=(jobq_item_t *)jq->waiting_jobs->next(item)); ) {
 273       if (jcr == item->jcr) {
 274          found = true;
 275          break;
 276       }
 277    }
 278    if (!found) {
 279       return EINVAL;
 280    }
 281
 282    /* Move item to be the first on the list */
 283    jq->waiting_jobs->remove(item);
 284    jq->ready_jobs->prepend(item);
 285
 286    stat = start_server(jq);
 287    if (stat != 0) {
 288       return stat;
 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
 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          pthread_mutex_unlock(&jq->mutex);
 309          return stat;
 310       }
 311    } else if (jq->num_workers < jq->max_workers) {
 312       Dmsg0(100, "Create worker thread\n");
 313       /* No idle threads so create a new one */
 314       set_thread_concurrency(jq->max_workers + 1);
 315       if ((stat = pthread_create(&id, &jq->attr, jobq_server, (void *)jq)) != 0) {
 316          pthread_mutex_unlock(&jq->mutex);
 317          return stat;
 318       }
 319       jq->num_workers++;
 320    }
 321    return stat;
 322 }
 323
 324
 325 /*
 326  * This is the worker thread that serves the job queue.
 327  * When all the resources are acquired for the job,
 328  *  it will call the user's engine.
 329  */
 330 static void *jobq_server(void *arg)
 331 {
 332    struct timespec timeout;
 333    jobq_t *jq = (jobq_t *)arg;
 334    jobq_item_t *je;                   /* job entry in queue */
 335    int stat;
 336    bool timedout;
 337    bool work = true;
 338
 339    Dmsg0(100, "Start jobq_server\n");
 340    if ((stat = pthread_mutex_lock(&jq->mutex)) != 0) {
 341       return NULL;
 342    }
 343
 344    for (;;) {
 345       struct timeval tv;
 346       struct timezone tz;
 347
 348       Dmsg0(100, "Top of for loop\n");
 349       timedout = false;
 350       Dmsg0(100, "gettimeofday()\n");
 351       gettimeofday(&tv, &tz);
 352       timeout.tv_nsec = 0;
 353       timeout.tv_sec = tv.tv_sec + 4;
 354
 355       while (!work && !jq->quit) {
 356          /*
 357           * Wait 4 seconds, then if no more work, exit
 358           */
 359          Dmsg0(200, "pthread_cond_timedwait()\n");
 360          stat = pthread_cond_timedwait(&jq->work, &jq->mutex, &timeout);
 361          Dmsg1(100, "timedwait=%d\n", stat);
 362          if (stat == ETIMEDOUT) {
 363             timedout = true;
 364             break;
 365          } else if (stat != 0) {
 366             /* This shouldn't happen */
 367             Dmsg0(100, "This shouldn't happen\n");
 368             jq->num_workers--;
 369             pthread_mutex_unlock(&jq->mutex);
 370             return NULL;
 371          }
 372       }
 373       /*
 374        * If anything is in the ready queue, run it
 375        */
 376       Dmsg0(100, "Checking ready queue.\n");
 377       while (!jq->ready_jobs->empty() && !jq->quit) {
 378          je = (jobq_item_t *)jq->ready_jobs->first();
 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                return NULL;
 384             }
 385          }
 386          jq->running_jobs->append(je);
 387          Dmsg1(100, "Took jobid=%d from ready and appended to run\n", je->jcr->JobId);
 388          if ((stat = pthread_mutex_unlock(&jq->mutex)) != 0) {
 389             return NULL;
 390          }
 391          /* Call user's routine here */
 392          Dmsg1(100, "Calling user engine for jobid=%d\n", je->jcr->JobId);
 393          jq->engine(je->jcr);
 394          Dmsg1(100, "Back from user engine jobid=%d.\n", je->jcr->JobId);
 395          if ((stat = pthread_mutex_lock(&jq->mutex)) != 0) {
 396             free(je);                 /* release job entry */
 397             return NULL;
 398          }
 399          Dmsg0(200, "Done lock mutex\n");
 400          jq->running_jobs->remove(je);
 401          /*
 402           * Release locks if acquired. Note, they will not have
 403           *  been acquired for jobs canceled before they were
 404           *  put into the ready queue.
 405           */
 406          if (je->jcr->acquired_resource_locks) {
 407             je->jcr->store->NumConcurrentJobs--;
 408             je->jcr->client->NumConcurrentJobs--;
 409             je->jcr->job->NumConcurrentJobs--;
 410          }
 411          free_jcr(je->jcr);
 412          free(je);                    /* release job entry */
 413       }
 414       /*
 415        * If any job in the wait queue can be run,
 416        *  move it to the ready queue
 417        */
 418       Dmsg0(100, "Done check ready, now check wait queue.\n");
 419       while (!jq->waiting_jobs->empty() && !jq->quit) {
 420          int Priority;
 421          je = (jobq_item_t *)jq->waiting_jobs->first();
 422          jobq_item_t *re = (jobq_item_t *)jq->running_jobs->first();
 423          if (re) {
 424             Priority = re->jcr->JobPriority;
 425             Dmsg1(100, "Set Run pri=%d\n", Priority);
 426          } else {
 427             Priority = je->jcr->JobPriority;
 428             Dmsg1(100, "Set Job pri=%d\n", Priority);
 429          }
 430          /*
 431           * Acquire locks
 432           */
 433          for ( ; je;  ) {
 434             JCR *jcr = je->jcr;
 435             jobq_item_t *jn = (jobq_item_t *)jq->waiting_jobs->next(je);
 436             Dmsg3(100, "Examining Job=%d JobPri=%d want Pri=%d\n",
 437                jcr->JobId, jcr->JobPriority, Priority);
 438             /* Take only jobs of correct Priority */
 439             if (jcr->JobPriority != Priority) {
 440                set_jcr_job_status(jcr, JS_WaitPriority);
 441                break;
 442             }
 443             if (jcr->store->NumConcurrentJobs < jcr->store->MaxConcurrentJobs) {
 444                jcr->store->NumConcurrentJobs++;
 445             } else {
 446                set_jcr_job_status(jcr, JS_WaitStoreRes);
 447                je = jn;
 448                continue;
 449             }
 450             if (jcr->client->NumConcurrentJobs < jcr->client->MaxConcurrentJobs) {
 451                jcr->client->NumConcurrentJobs++;
 452             } else {
 453                jcr->store->NumConcurrentJobs--;
 454                set_jcr_job_status(jcr, JS_WaitClientRes);
 455                je = jn;
 456                continue;
 457             }
 458             if (jcr->job->NumConcurrentJobs < jcr->job->MaxConcurrentJobs) {
 459                jcr->job->NumConcurrentJobs++;
 460             } else {
 461                jcr->store->NumConcurrentJobs--;
 462                jcr->client->NumConcurrentJobs--;
 463                set_jcr_job_status(jcr, JS_WaitJobRes);
 464                je = jn;
 465                continue;
 466             }
 467             jcr->acquired_resource_locks = true;
 468             jq->waiting_jobs->remove(je);
 469             jq->ready_jobs->append(je);
 470             Dmsg1(100, "moved JobId=%d from wait to ready queue\n", je->jcr->JobId);
 471             je = jn;
 472          } /* end for loop */
 473          break;
 474       } /* end while loop */
 475       Dmsg0(100, "Done checking wait queue.\n");
 476       /*
 477        * If no more ready work and we are asked to quit, then do it
 478        */
 479       if (jq->ready_jobs->empty() && jq->quit) {
 480          jq->num_workers--;
 481          if (jq->num_workers == 0) {
 482             Dmsg0(100, "Wake up destroy routine\n");
 483             /* Wake up destroy routine if he is waiting */
 484             pthread_cond_broadcast(&jq->work);
 485          }
 486          break;
 487       }
 488       Dmsg0(100, "Check for work request\n");
 489       /*
 490        * If no more work requests, and we waited long enough, quit
 491        */
 492       Dmsg2(100, "timedout=%d read empty=%d\n", timedout,
 493          jq->ready_jobs->empty());
 494       if (jq->ready_jobs->empty() && timedout) {
 495          Dmsg0(100, "break big loop\n");
 496          jq->num_workers--;
 497          break;
 498       }
 499       Dmsg0(100, "Loop again\n");
 500       work = false;
 501    } /* end of big for loop */
 502
 503    Dmsg0(200, "unlock mutex\n");
 504    pthread_mutex_unlock(&jq->mutex);
 505    Dmsg0(100, "End jobq_server\n");
 506    return NULL;
 507 }
 508
 509 #endif /* JOB_QUEUE */