]> git.sur5r.net Git - bacula/bacula/blob - bacula/src/stored/reserve.c
Reservation tweaks + more debug output
[bacula/bacula] / bacula / src / stored / reserve.c
1 /*
2    Bacula® - The Network Backup Solution
3
4    Copyright (C) 2000-2008 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  *   Drive reservation functions for Storage Daemon
30  *
31  *   Kern Sibbald, MM
32  *
33  *   Split from job.c and acquire.c June 2005
34  *
35  *   Version $Id$
36  *
37  */
38
39 #include "bacula.h"
40 #include "stored.h"
41
42 const int dbglvl =  50;
43
44 static dlist *vol_list = NULL;
45 static brwlock_t reservation_lock;
46 static brwlock_t vol_list_lock;
47
48 /* Forward referenced functions */
49 static int can_reserve_drive(DCR *dcr, RCTX &rctx);
50 static int reserve_device(RCTX &rctx);
51 static bool reserve_device_for_read(DCR *dcr);
52 static bool reserve_device_for_append(DCR *dcr, RCTX &rctx);
53 static bool use_storage_cmd(JCR *jcr);
54 static void queue_reserve_message(JCR *jcr);
55 static void pop_reserve_messages(JCR *jcr);
56 void switch_device(DCR *dcr, DEVICE *dev);
57
58 /* Requests from the Director daemon */
59 static char use_storage[]  = "use storage=%127s media_type=%127s "
60    "pool_name=%127s pool_type=%127s append=%d copy=%d stripe=%d\n";
61 static char use_device[]  = "use device=%127s\n";
62
63 /* Responses sent to Director daemon */
64 static char OK_device[] = "3000 OK use device device=%s\n";
65 static char NO_device[] = "3924 Device \"%s\" not in SD Device resources.\n";
66 static char BAD_use[]   = "3913 Bad use command: %s\n";
67
68 bool use_cmd(JCR *jcr) 
69 {
70    /*
71     * Get the device, media, and pool information
72     */
73    if (!use_storage_cmd(jcr)) {
74       set_jcr_job_status(jcr, JS_ErrorTerminated);
75       memset(jcr->sd_auth_key, 0, strlen(jcr->sd_auth_key));
76       return false;
77    }
78    return true;
79 }
80
81 static int my_compare(void *item1, void *item2)
82 {
83    return strcmp(((VOLRES *)item1)->vol_name, ((VOLRES *)item2)->vol_name);
84 }
85
86 /*
87  * This allows a given thread to recursively call lock_reservations.
88  *   It must, of course, call unlock_... the same number of times.
89  */
90 void init_reservations_lock()
91 {
92    int errstat;
93    if ((errstat=rwl_init(&reservation_lock)) != 0) {
94       berrno be;
95       Emsg1(M_ABORT, 0, _("Unable to initialize reservation lock. ERR=%s\n"),
96             be.bstrerror(errstat));
97    }
98
99    if ((errstat=rwl_init(&vol_list_lock)) != 0) {
100       berrno be;
101       Emsg1(M_ABORT, 0, _("Unable to initialize volume list lock. ERR=%s\n"),
102             be.bstrerror(errstat));
103    }
104 }
105
106 void term_reservations_lock()
107 {
108    rwl_destroy(&reservation_lock);
109    rwl_destroy(&vol_list_lock);
110 }
111
112 int reservations_lock_count = 0;
113
114 /* This applies to a drive and to Volumes */
115 void _lock_reservations()
116 {
117    int errstat;
118    reservations_lock_count++;
119    if ((errstat=rwl_writelock(&reservation_lock)) != 0) {
120       berrno be;
121       Emsg2(M_ABORT, 0, "rwl_writelock failure. stat=%d: ERR=%s\n",
122            errstat, be.bstrerror(errstat));
123    }
124 }
125
126 void _unlock_reservations()
127 {
128    int errstat;
129    reservations_lock_count--;
130    if ((errstat=rwl_writeunlock(&reservation_lock)) != 0) {
131       berrno be;
132       Emsg2(M_ABORT, 0, "rwl_writeunlock failure. stat=%d: ERR=%s\n",
133            errstat, be.bstrerror(errstat));
134    }
135 }
136
137 int vol_list_lock_count = 0;
138
139 /* 
140  * This allows a given thread to recursively call to lock_volumes()
141  */
142 void _lock_volumes()
143 {
144    int errstat;
145    vol_list_lock_count++;
146    if ((errstat=rwl_writelock(&vol_list_lock)) != 0) {
147       berrno be;
148       Emsg2(M_ABORT, 0, "rwl_writelock failure. stat=%d: ERR=%s\n",
149            errstat, be.bstrerror(errstat));
150    }
151 }
152
153 void _unlock_volumes()
154 {
155    int errstat;
156    vol_list_lock_count--;
157    if ((errstat=rwl_writeunlock(&vol_list_lock)) != 0) {
158       berrno be;
159       Emsg2(M_ABORT, 0, "rwl_writeunlock failure. stat=%d: ERR=%s\n",
160            errstat, be.bstrerror(errstat));
161    }
162 }
163
164
165 /*
166  * List Volumes -- this should be moved to status.c
167  */
168 enum {
169    debug_lock = true,
170    debug_nolock = false
171 };
172
173 static void debug_list_volumes(const char *imsg)
174 {
175    VOLRES *vol;
176    POOL_MEM msg(PM_MESSAGE);
177
178    lock_volumes();
179    foreach_dlist(vol, vol_list) {
180       if (vol->dev) {
181          Mmsg(msg, "List %s: %s rel=%d on device %s\n", imsg, 
182               vol->vol_name, vol->released, vol->dev->print_name());
183       } else {
184          Mmsg(msg, "List %s: %s rel=%d no dev\n", imsg, vol->vol_name, vol->released);
185       }
186       Dmsg1(dbglvl, "%s", msg.c_str());
187    }
188
189 #ifdef xxx
190    DEVICE *dev = NULL;
191    foreach_dlist(vol, vol_list) {
192       if (vol->dev == dev) {
193          Dmsg0(dbglvl, "Two Volumes on same device.\n");
194          ASSERT(0);
195          dev = vol->dev;
196       }
197    }
198 #endif
199
200 // Dmsg2(dbglvl, "List from %s: %d volumes\n", imsg, count);
201    unlock_volumes();
202 }
203
204
205 /*
206  * List Volumes -- this should be moved to status.c
207  */
208 void list_volumes(void sendit(const char *msg, int len, void *sarg), void *arg)
209 {
210    VOLRES *vol;
211    POOL_MEM msg(PM_MESSAGE);
212    int len;
213
214    lock_volumes();
215    foreach_dlist(vol, vol_list) {
216       DEVICE *dev = vol->dev;
217       if (dev) {
218          len = Mmsg(msg, "%s on device %s\n", vol->vol_name, dev->print_name());
219          sendit(msg.c_str(), len, arg);
220          len = Mmsg(msg, "    Reader=%d writers=%d reserved=%d released=%d\n", 
221             dev->can_read()?1:0, dev->num_writers, dev->reserved_device, vol->released);
222          sendit(msg.c_str(), len, arg);
223       } else {
224          len = Mmsg(msg, "%s no device. released=%d\n", vol->vol_name, vol->released);
225          sendit(msg.c_str(), len, arg);
226       }
227    }
228    unlock_volumes();
229 }
230
231 /*
232  * Create a Volume item to put in the Volume list
233  *   Ensure that the device points to it.
234  */
235 static VOLRES *new_vol_item(DCR *dcr, const char *VolumeName)
236 {
237    VOLRES *vol;
238    vol = (VOLRES *)malloc(sizeof(VOLRES));
239    memset(vol, 0, sizeof(VOLRES));
240    vol->vol_name = bstrdup(VolumeName);
241    vol->dev = dcr->dev;
242    Dmsg3(dbglvl, "new Vol=%s at %p dev=%s\n",
243          VolumeName, vol->vol_name, vol->dev->print_name());
244    return vol;
245 }
246
247 static void free_vol_item(VOLRES *vol)
248 {
249    free(vol->vol_name);
250    if (vol->dev) {
251       vol->dev->vol = NULL;
252    }
253    free(vol);
254 }
255
256
257 /*
258  * Put a new Volume entry in the Volume list. This
259  *  effectively reserves the volume so that it will
260  *  not be mounted again.
261  *
262  * If the device has any current volume associated with it,
263  *  and it is a different Volume, and the device is not busy,
264  *  we release the old Volume item and insert the new one.
265  * 
266  * It is assumed that the device is free and locked so that
267  *  we can change the device structure.
268  *
269  * Some details of the Volume list handling:
270  *
271  *  1. The Volume list entry must be attached to the drive (rather than 
272  *       attached to a job as it currently is. I.e. the drive that "owns" 
273  *       the volume (reserved, in use, mounted)
274  *       must point to the volume (still to be maintained in a list).
275  *
276  *  2. The Volume is entered in the list when a drive is reserved.  
277  *
278  *  3. When a drive is in use, the device code must appropriately update the
279  *      volume name as it changes (currently the list is static -- an entry is
280  *      removed when the Volume is no longer reserved, in use or mounted).  
281  *      The new code must keep the same list entry as long as the drive
282  *       has any volume associated with it but the volume name in the list
283  *       must be updated when the drive has a different volume mounted.
284  *
285  *  4. A job that has reserved a volume, can un-reserve the volume, and if the 
286  *      volume is not mounted, and not reserved, and not in use, it will be
287  *      removed from the list.
288  *
289  *  5. If a job wants to reserve a drive with a different Volume from the one on
290  *      the drive, it can re-use the drive for the new Volume.
291  *
292  *  6. If a job wants a Volume that is in a different drive, it can either use the
293  *      other drive or take the volume, only if the other drive is not in use or
294  *      not reserved.
295  *
296  *  One nice aspect of this is that the reserve use count and the writer use count 
297  *  already exist and are correctly programmed and will need no changes -- use 
298  *  counts are always very tricky.
299  *
300  *  The old code had a concept of "reserving" a Volume, but was changed 
301  *  to reserving and using a drive.  A volume is must be attached to (owned by) a 
302  *  drive and can move from drive to drive or be unused given certain specific 
303  *  conditions of the drive.  The key is that the drive must "own" the Volume.  
304  *  The old code had the job (dcr) owning the volume (more or less).  The job was
305  *  to change the insertion and removal of the volumes from the list to be based 
306  *  on the drive rather than the job.  
307  *
308  *  Return: VOLRES entry on success
309  *          NULL volume busy on another drive
310  */
311 VOLRES *reserve_volume(DCR *dcr, const char *VolumeName)
312 {
313    VOLRES *vol, *nvol;
314    DEVICE * volatile dev = dcr->dev;
315
316    ASSERT(dev != NULL);
317
318    Dmsg1(dbglvl, "enter reserve_volume %s\n", VolumeName);
319    /* 
320     * We lock the reservations system here to ensure
321     *  when adding a new volume that no newly scheduled
322     *  job can reserve it.
323     */
324    lock_volumes();
325    debug_list_volumes("begin reserve_volume");
326    /* 
327     * First, remove any old volume attached to this device as it
328     *  is no longer used.
329     */
330    if (dev->vol) {
331       vol = dev->vol;
332       Dmsg4(dbglvl, "Vol attached=%s, newvol=%s release=%d on %s\n",
333          vol->vol_name, VolumeName, vol->released, dev->print_name());
334       /*
335        * Make sure we don't remove the current volume we are inserting
336        *  because it was probably inserted by another job, or it
337        *  is not being used and is marked as released.
338        */
339       if (strcmp(vol->vol_name, VolumeName) == 0) {
340          Dmsg1(dbglvl, "=== OK, vol=%s on device. set not released.\n", VolumeName);
341          vol->released = false;         /* retake vol if released previously */
342          goto get_out;                  /* Volume already on this device */
343       } else {
344          /* Don't release a volume if it is in use */
345          if (!vol->released) {
346             Dmsg1(dbglvl, "Cannot free vol=%s. It is not released.\n", vol->vol_name);
347             vol = NULL;                  /* vol in use */
348             goto get_out;
349          }
350          Dmsg2(dbglvl, "reserve_vol free vol=%s at %p\n", vol->vol_name, vol->vol_name);
351          unload_autochanger(dcr, -1);   /* unload the volume */
352          free_volume(dev);
353          debug_list_volumes("reserve_vol free");
354       }
355    }
356
357    /* Create a new Volume entry */
358    nvol = new_vol_item(dcr, VolumeName);
359
360    /*
361     * Now try to insert the new Volume
362     */
363    vol = (VOLRES *)vol_list->binary_insert(nvol, my_compare);
364    if (vol != nvol) {
365       Dmsg2(dbglvl, "Found vol=%s dev-same=%d\n", vol->vol_name, dev==vol->dev);
366       /*
367        * At this point, a Volume with this name already is in the list,
368        *   so we simply release our new Volume entry. Note, this should
369        *   only happen if we are moving the volume from one drive to another.
370        */
371       Dmsg2(dbglvl, "reserve_vol free-tmp vol=%s at %p\n", 
372             vol->vol_name, vol->vol_name);
373       /*
374        * Clear dev pointer so that free_vol_item() doesn't 
375        *  take away our volume. 
376        */
377       nvol->dev = NULL;                   /* don't zap dev entry */
378       free_vol_item(nvol);
379
380       /* Check if we are trying to use the Volume on a different drive */
381       if (dev != vol->dev) {
382          /* Caller wants to switch Volume to another device */
383          Dmsg2(dbglvl, "==== Swap from dev=%s to %s\n",
384                dev->print_name(), vol->dev->print_name());
385          switch_device(dcr, vol->dev);
386          dev = vol->dev;
387          bstrncpy(dcr->VolumeName, VolumeName, sizeof(dcr->VolumeName));
388 #ifdef xxx
389          if (!vol->dev->is_busy()) {
390             /* OK to move it -- I'm not sure this will work */
391             Dmsg3(dbglvl, "==== Swap vol=%s from dev=%s to %s\n", VolumeName,
392                vol->dev->print_name(), dev->print_name());
393             vol->dev->vol = NULL;         /* take vol from old drive */
394             vol->dev->VolHdr.VolumeName[0] = 0;
395             vol->dev = dev;               /* point vol at new drive */
396             dev->vol = vol;               /* point dev at vol */
397             dev->VolHdr.VolumeName[0] = 0;
398          } else {
399             Dmsg3(dbglvl, "==== Swap not possible Vol busy vol=%s from dev=%s to %s\n", 
400                VolumeName, vol->dev->print_name(), dev->print_name());
401             vol = NULL;                /* device busy */
402             goto get_out;
403          }
404 #endif
405       }
406    }
407    dev->vol = vol;
408
409 get_out:
410    if (vol) {
411       Dmsg1(dbglvl, "=== set not released. vol=%s\n", vol->vol_name);
412       vol->released = false;
413    }
414    debug_list_volumes("end new volume");
415    unlock_volumes();
416    return vol;
417 }
418
419 /* 
420  * Switch from current device to given device  
421  *   (not yet used) 
422  */
423 void switch_device(DCR *dcr, DEVICE *dev)
424 {
425    // lock_reservations();
426    DCR save_dcr;
427
428    dev->dlock();
429    memcpy(&save_dcr, dcr, sizeof(save_dcr));
430    clean_device(dcr);                  /* clean up the dcr */
431
432    dcr->dev = dev;                     /* get new device pointer */
433    Jmsg(dcr->jcr, M_INFO, 0, _("Device switch. New device %s chosen.\n"),
434       dcr->dev->print_name());
435
436    bstrncpy(dcr->VolumeName, save_dcr.VolumeName, sizeof(dcr->VolumeName));
437    bstrncpy(dcr->media_type, save_dcr.media_type, sizeof(dcr->media_type));
438    dcr->VolCatInfo.Slot = save_dcr.VolCatInfo.Slot;
439    bstrncpy(dcr->pool_name, save_dcr.pool_name, sizeof(dcr->pool_name));
440    bstrncpy(dcr->pool_type, save_dcr.pool_type, sizeof(dcr->pool_type));
441    bstrncpy(dcr->dev_name, dev->dev_name, sizeof(dcr->dev_name));
442
443    dev->reserved_device++;
444    dcr->reserved_device = true;
445
446    dev->dunlock();
447 }
448
449 /*
450  * Search for a Volume name in the Volume list.
451  *
452  *  Returns: VOLRES entry on success
453  *           NULL if the Volume is not in the list
454  */
455 VOLRES *find_volume(DCR *dcr)
456 {
457    VOLRES vol, *fvol;
458    /* Do not lock reservations here */
459    lock_volumes();
460    vol.vol_name = bstrdup(dcr->VolumeName);
461    fvol = (VOLRES *)vol_list->binary_search(&vol, my_compare);
462    free(vol.vol_name);
463    Dmsg2(dbglvl, "find_vol=%s found=%d\n", dcr->VolumeName, fvol!=NULL);
464    debug_list_volumes("find_volume");
465    unlock_volumes();
466    return fvol;
467 }
468
469 /* 
470  * Remove any reservation from a drive and tell the system
471  *  that the volume is unused at least by us.
472  */
473 void unreserve_device(DCR *dcr)
474 {
475    DEVICE *dev = dcr->dev;
476    if (dcr->reserved_device) {
477       dcr->reserved_device = false;
478       dev->reserved_device--;
479       Dmsg2(dbglvl, "Dec reserve=%d dev=%s\n", dev->reserved_device, dev->print_name());
480       dcr->reserved_device = false;
481       /* If we set read mode in reserving, remove it */
482       if (dev->can_read()) {
483          dev->clear_read();
484       }
485       if (dev->num_writers < 0) {
486          Jmsg1(dcr->jcr, M_ERROR, 0, _("Hey! num_writers=%d!!!!\n"), dev->num_writers);
487          dev->num_writers = 0;
488       }
489       if (dev->reserved_device == 0 && dev->num_writers == 0) {
490          volume_unused(dcr);
491       }
492    }
493 }
494
495 /*  
496  * Free a Volume from the Volume list if it is no longer used
497  *   Note, for tape drives we want to remember where the Volume
498  *   was when last used, so rather than free the volume entry,
499  *   we simply mark it "released" so when the drive is really
500  *   needed for another volume, we can reuse it.
501  *
502  *  Returns: true if the Volume found and "removed" from the list
503  *           false if the Volume is not in the list or is in use
504  */
505 bool volume_unused(DCR *dcr)
506 {
507    DEVICE *dev = dcr->dev;
508
509    if (dev->vol == NULL) {
510       Dmsg1(dbglvl, "vol_unused: no vol on %s\n", dev->print_name());
511       debug_list_volumes("null vol cannot unreserve_volume");
512       return false;
513    }
514
515 #ifdef xxx
516    if (dev->is_busy()) {
517       Dmsg1(dbglvl, "vol_unused: busy on %s\n", dev->print_name());
518       debug_list_volumes("dev busy cannot unreserve_volume");
519       return false;
520    }
521 #endif
522 #ifdef xxx
523    if (dev->num_writers > 0 || dev->reserved_device > 0) {
524       ASSERT(0);
525    }
526 #endif
527
528    /*  
529     * If this is a tape, we do not free the volume, rather we wait
530     *  until the autoloader unloads it, or until another tape is
531     *  explicitly read in this drive. This allows the SD to remember
532     *  where the tapes are or last were.
533     */
534    Dmsg3(dbglvl, "=== mark released vol=%s num_writers=%d dev_reserved=%d\n",
535       dev->vol->vol_name, dev->num_writers, dev->reserved_device);
536    dev->vol->released = true;
537    if (dev->is_tape()) { // || dev->is_autochanger()) {
538       return true;
539    } else {
540       /*
541        * Note, this frees the volume reservation entry, but the 
542        *   file descriptor remains open with the OS.
543        */
544       return free_volume(dev);
545    }
546 }
547
548 /*
549  * Unconditionally release the volume entry
550  */
551 bool free_volume(DEVICE *dev)
552 {
553    VOLRES *vol;
554
555    if (dev->vol == NULL) {
556       Dmsg1(dbglvl, "No vol on dev %s\n", dev->print_name());
557       return false;
558    }
559    lock_volumes();
560    vol = dev->vol;
561    dev->vol = NULL;
562    vol_list->remove(vol);
563    Dmsg2(dbglvl, "=== free_volume %s dev=%s\n", vol->vol_name, dev->print_name());
564    free_vol_item(vol);
565    debug_list_volumes("free_volume");
566    unlock_volumes();
567 // return vol != NULL;
568    return true;
569 }
570
571       
572 /* Create the Volume list */
573 void create_volume_list()
574 {
575    VOLRES *vol = NULL;
576    if (vol_list == NULL) {
577       vol_list = New(dlist(vol, &vol->link));
578    }
579 }
580
581 /* Release all Volumes from the list */
582 void free_volume_list()
583 {
584    VOLRES *vol;
585    if (!vol_list) {
586       return;
587    }
588    lock_volumes();
589    foreach_dlist(vol, vol_list) {
590       if (vol->dev) {
591          Dmsg2(dbglvl, "free vol_list Volume=%s dev=%s\n", vol->vol_name, vol->dev->print_name());
592       } else {
593          Dmsg1(dbglvl, "free vol_list Volume=%s No dev\n", vol->vol_name);
594       }
595       free(vol->vol_name);
596       vol->vol_name = NULL;
597    }
598    delete vol_list;
599    vol_list = NULL;
600    unlock_volumes();
601 }
602
603 bool is_volume_in_use(DCR *dcr)
604 {
605    VOLRES *vol = find_volume(dcr);
606    if (!vol) {
607       Dmsg1(dbglvl, "Vol=%s not in use.\n", dcr->VolumeName);
608       return false;                   /* vol not in list */
609    }
610    ASSERT(vol->dev != NULL);
611
612    if (dcr->dev == vol->dev) {        /* same device OK */
613       Dmsg1(dbglvl, "Vol=%s on same dev.\n", dcr->VolumeName);
614       return false;
615    } else {
616       Dmsg3(dbglvl, "Vol=%s on %s we have %s\n", dcr->VolumeName,
617             vol->dev->print_name(), dcr->dev->print_name());
618    }
619    if (!vol->dev->is_busy()) {
620       Dmsg2(dbglvl, "Vol=%s dev=%s not busy.\n", dcr->VolumeName, vol->dev->print_name());
621       return false;
622    } else {
623       Dmsg2(dbglvl, "Vol=%s dev=%s busy.\n", dcr->VolumeName, vol->dev->print_name());
624    }
625    Dmsg2(dbglvl, "Vol=%s in use by %s.\n", dcr->VolumeName, vol->dev->print_name());
626    return true;
627 }
628
629
630 /*
631  * We get the following type of information:
632  *
633  * use storage=xxx media_type=yyy pool_name=xxx pool_type=yyy append=1 copy=0 strip=0
634  *  use device=zzz
635  *  use device=aaa
636  *  use device=bbb
637  * use storage=xxx media_type=yyy pool_name=xxx pool_type=yyy append=0 copy=0 strip=0
638  *  use device=bbb
639  *
640  */
641 static bool use_storage_cmd(JCR *jcr)
642 {
643    POOL_MEM store_name, dev_name, media_type, pool_name, pool_type;
644    BSOCK *dir = jcr->dir_bsock;
645    int append;
646    bool ok;       
647    int Copy, Stripe;
648    DIRSTORE *store;
649    RCTX rctx;
650    alist *dirstore;
651
652    memset(&rctx, 0, sizeof(RCTX));
653    rctx.jcr = jcr;
654    /*
655     * If there are multiple devices, the director sends us
656     *   use_device for each device that it wants to use.
657     */
658    dirstore = New(alist(10, not_owned_by_alist));
659    jcr->reserve_msgs = New(alist(10, not_owned_by_alist));  
660    do {
661       Dmsg1(dbglvl, "<dird: %s", dir->msg);
662       ok = sscanf(dir->msg, use_storage, store_name.c_str(), 
663                   media_type.c_str(), pool_name.c_str(), 
664                   pool_type.c_str(), &append, &Copy, &Stripe) == 7;
665       if (!ok) {
666          break;
667       }
668       if (append) {
669          jcr->write_store = dirstore;
670       } else {
671          jcr->read_store = dirstore;
672       }
673       rctx.append = append;
674       unbash_spaces(store_name);
675       unbash_spaces(media_type);
676       unbash_spaces(pool_name);
677       unbash_spaces(pool_type);
678       store = new DIRSTORE;
679       dirstore->append(store);
680       memset(store, 0, sizeof(DIRSTORE));
681       store->device = New(alist(10));
682       bstrncpy(store->name, store_name, sizeof(store->name));
683       bstrncpy(store->media_type, media_type, sizeof(store->media_type));
684       bstrncpy(store->pool_name, pool_name, sizeof(store->pool_name));
685       bstrncpy(store->pool_type, pool_type, sizeof(store->pool_type));
686       store->append = append;
687
688       /* Now get all devices */
689       while (dir->recv() >= 0) {
690          Dmsg1(dbglvl, "<dird device: %s", dir->msg);
691          ok = sscanf(dir->msg, use_device, dev_name.c_str()) == 1;
692          if (!ok) {
693             break;
694          }
695          unbash_spaces(dev_name);
696          store->device->append(bstrdup(dev_name.c_str()));
697       }
698    }  while (ok && dir->recv() >= 0);
699
700    /* Developer debug code */
701    char *device_name;
702    if (debug_level >= dbglvl) {
703       foreach_alist(store, dirstore) {
704          Dmsg5(dbglvl, "Storage=%s media_type=%s pool=%s pool_type=%s append=%d\n", 
705             store->name, store->media_type, store->pool_name, 
706             store->pool_type, store->append);
707          foreach_alist(device_name, store->device) {
708             Dmsg1(dbglvl, "     Device=%s\n", device_name);
709          }
710       }
711    }
712
713    init_jcr_device_wait_timers(jcr);
714    jcr->dcr = new_dcr(jcr, NULL, NULL);         /* get a dcr */
715    if (!jcr->dcr) {
716       BSOCK *dir = jcr->dir_bsock;
717       dir->fsend(_("3939 Could not get dcr\n"));
718       Dmsg1(dbglvl, ">dird: %s", dir->msg);
719       ok = false;
720    }
721    /*                    
722     * At this point, we have a list of all the Director's Storage
723     *  resources indicated for this Job, which include Pool, PoolType,
724     *  storage name, and Media type.     
725     * Then for each of the Storage resources, we have a list of
726     *  device names that were given.
727     *
728     * Wiffle through them and find one that can do the backup.
729     */
730    if (ok) {
731       int wait_for_device_retries = 0;  
732       int repeat = 0;
733       bool fail = false;
734       rctx.notify_dir = true;
735
736       lock_reservations();
737       for ( ; !fail && !job_canceled(jcr); ) {
738          pop_reserve_messages(jcr);
739          rctx.suitable_device = false;
740          rctx.have_volume = false;
741          rctx.VolumeName[0] = 0;
742          rctx.any_drive = false;
743          if (!jcr->PreferMountedVols) {
744             /*
745              * Here we try to find a drive that is not used.
746              * This will maximize the use of available drives.
747              *
748              */
749             rctx.num_writers = 20000000;   /* start with impossible number */
750             rctx.low_use_drive = NULL;
751             rctx.PreferMountedVols = false;                
752             rctx.exact_match = false;
753             rctx.autochanger_only = true;
754             Dmsg5(dbglvl, "PrefMnt=%d exact=%d suitable=%d chgronly=%d any=%d\n",
755                rctx.PreferMountedVols, rctx.exact_match, rctx.suitable_device,
756                rctx.autochanger_only, rctx.any_drive);
757             if ((ok = find_suitable_device_for_job(jcr, rctx))) {
758                break;
759             }
760             /* Look through all drives possibly for low_use drive */
761             if (rctx.low_use_drive) {
762                rctx.try_low_use_drive = true;
763                if ((ok = find_suitable_device_for_job(jcr, rctx))) {
764                   break;
765                }
766                rctx.try_low_use_drive = false;
767             }
768             rctx.autochanger_only = false;
769             Dmsg5(dbglvl, "PrefMnt=%d exact=%d suitable=%d chgronly=%d any=%d\n",
770                rctx.PreferMountedVols, rctx.exact_match, rctx.suitable_device,
771                rctx.autochanger_only, rctx.any_drive);
772             if ((ok = find_suitable_device_for_job(jcr, rctx))) {
773                break;
774             }
775          }
776          /*
777           * Now we look for a drive that may or may not be in
778           *  use.
779           */
780          /* Look for an exact Volume match all drives */
781          rctx.PreferMountedVols = true;
782          rctx.exact_match = true;
783          rctx.autochanger_only = false;
784          Dmsg5(dbglvl, "PrefMnt=%d exact=%d suitable=%d chgronly=%d any=%d\n",
785             rctx.PreferMountedVols, rctx.exact_match, rctx.suitable_device,
786             rctx.autochanger_only, rctx.any_drive);
787          if ((ok = find_suitable_device_for_job(jcr, rctx))) {
788             break;
789          }
790          /* Look for any mounted drive */
791          rctx.exact_match = false;
792          Dmsg5(dbglvl, "PrefMnt=%d exact=%d suitable=%d chgronly=%d any=%d\n",
793             rctx.PreferMountedVols, rctx.exact_match, rctx.suitable_device,
794             rctx.autochanger_only, rctx.any_drive);
795          if ((ok = find_suitable_device_for_job(jcr, rctx))) {
796             break;
797          }
798          /* Try any drive */
799          rctx.any_drive = true;
800          Dmsg5(dbglvl, "PrefMnt=%d exact=%d suitable=%d chgronly=%d any=%d\n",
801             rctx.PreferMountedVols, rctx.exact_match, rctx.suitable_device,
802             rctx.autochanger_only, rctx.any_drive);
803          if ((ok = find_suitable_device_for_job(jcr, rctx))) {
804             break;
805          }
806          /* Keep reservations locked *except* during wait_for_device() */
807          unlock_reservations();
808          /*     
809           * The idea of looping on repeat a few times it to ensure
810           * that if there is some subtle timing problem between two
811           * jobs, we will simply try again, and most likely succeed.
812           * This can happen if one job reserves a drive or finishes using
813           * a drive at the same time a second job wants it.
814           */
815          if (repeat++ > 1) {              /* try algorithm 3 times */
816             bmicrosleep(30, 0);           /* wait a bit */
817             Dmsg0(dbglvl, "repeat reserve algorithm\n");
818          } else if (!rctx.suitable_device || !wait_for_device(jcr, wait_for_device_retries)) {
819             Dmsg0(dbglvl, "Fail. !suitable_device || !wait_for_device\n");
820             fail = true;
821          }   
822          lock_reservations();
823          dir->signal(BNET_HEARTBEAT);  /* Inform Dir that we are alive */
824       }
825       unlock_reservations();
826       if (!ok) {
827          /*
828           * If we get here, there are no suitable devices available, which
829           *  means nothing configured.  If a device is suitable but busy
830           *  with another Volume, we will not come here.
831           */
832          unbash_spaces(dir->msg);
833          pm_strcpy(jcr->errmsg, dir->msg);
834          Jmsg(jcr, M_INFO, 0, _("Failed command: %s\n"), jcr->errmsg);
835          Jmsg(jcr, M_FATAL, 0, _("\n"
836             "     Device \"%s\" with MediaType \"%s\" requested by DIR not found in SD Device resources.\n"),
837               dev_name.c_str(), media_type.c_str());
838          dir->fsend(NO_device, dev_name.c_str());
839
840          Dmsg1(dbglvl, ">dird: %s", dir->msg);
841       }
842    } else {
843       unbash_spaces(dir->msg);
844       pm_strcpy(jcr->errmsg, dir->msg);
845       Jmsg(jcr, M_FATAL, 0, _("Failed command: %s\n"), jcr->errmsg);
846       dir->fsend(BAD_use, jcr->errmsg);
847       Dmsg1(dbglvl, ">dird: %s", dir->msg);
848    }
849
850    release_reserve_messages(jcr);
851    return ok;
852 }
853
854
855 /*
856  * Walk through the autochanger resources and check if
857  *  the volume is in one of them.
858  * 
859  * Returns:  true  if volume is in device
860  *           false otherwise
861  */
862 static bool is_vol_in_autochanger(RCTX &rctx, VOLRES *vol)
863 {
864    AUTOCHANGER *changer = vol->dev->device->changer_res;
865
866    /* Find resource, and make sure we were able to open it */
867    if (strcmp(rctx.device_name, changer->hdr.name) == 0) {
868       Dmsg1(dbglvl, "Found changer device %s\n", vol->dev->device->hdr.name);
869       return true;
870    }  
871    Dmsg1(dbglvl, "Incorrect changer device %s\n", changer->hdr.name);
872    return false;
873 }
874
875 /*
876  * Search for a device suitable for this job.
877  * Note, this routine sets sets rctx.suitable_device if any 
878  *   device exists within the SD.  The device may not be actually
879  *   useable.
880  * It also returns if it finds a useable device.  
881  */
882 bool find_suitable_device_for_job(JCR *jcr, RCTX &rctx)
883 {
884    bool ok = false;
885    DIRSTORE *store;
886    char *device_name;
887    alist *dirstore;
888    DCR *dcr = jcr->dcr;
889
890    if (rctx.append) {
891       dirstore = jcr->write_store;
892    } else {
893       dirstore = jcr->read_store;
894    }
895    Dmsg4(dbglvl, "PrefMnt=%d exact=%d suitable=%d chgronly=%d\n",
896       rctx.PreferMountedVols, rctx.exact_match, rctx.suitable_device,
897       rctx.autochanger_only);
898
899    /* 
900     * If the appropriate conditions of this if are met, namely that
901     *  we are appending and the user wants mounted drive (or we
902     *  force try a mounted drive because they are all busy), we
903     *  start by looking at all the Volumes in the volume list.
904     */
905    if (!vol_list->empty() && rctx.append && rctx.PreferMountedVols) {
906       dlist *temp_vol_list, *save_vol_list;
907       VOLRES *vol = NULL;
908       lock_volumes();
909       Dmsg0(dbglvl, "lock volumes\n");                           
910
911       /*  
912        * Create a temporary copy of the volume list.  We do this,
913        *   to avoid having the volume list locked during the
914        *   call to reserve_device(), which would cause a deadlock.
915        * Note, we may want to add an update counter on the vol_list
916        *   so that if it is modified while we are traversing the copy
917        *   we can take note and act accordingly (probably redo the 
918        *   search at least a few times).
919        */
920       Dmsg0(dbglvl, "duplicate vol list\n");
921       temp_vol_list = New(dlist(vol, &vol->link));
922       foreach_dlist(vol, vol_list) {
923          VOLRES *nvol;
924          VOLRES *tvol = (VOLRES *)malloc(sizeof(VOLRES));
925          memset(tvol, 0, sizeof(VOLRES));
926          tvol->vol_name = bstrdup(vol->vol_name);
927          tvol->dev = vol->dev;
928          nvol = (VOLRES *)temp_vol_list->binary_insert(tvol, my_compare);
929          if (tvol != nvol) {
930             tvol->dev = NULL;                   /* don't zap dev entry */
931             free_vol_item(tvol);
932             Pmsg0(000, "Logic error. Duplicating vol list hit duplicate.\n");
933             Jmsg(jcr, M_WARNING, 0, "Logic error. Duplicating vol list hit duplicate.\n");
934          }
935       }
936       Dmsg0(dbglvl, "unlock volumes\n");
937       unlock_volumes();
938
939       /* Look through reserved volumes for one we can use */
940       Dmsg0(dbglvl, "look for vol in vol list\n");
941       foreach_dlist(vol, temp_vol_list) {
942          if (!vol->dev) {
943             Dmsg1(dbglvl, "vol=%s no dev\n", vol->vol_name);
944             continue;
945          }
946          /* Check with Director if this Volume is OK */
947          bstrncpy(dcr->VolumeName, vol->vol_name, sizeof(dcr->VolumeName));
948          if (!dir_get_volume_info(dcr, GET_VOL_INFO_FOR_WRITE)) {
949             continue;
950          }
951
952          Dmsg1(dbglvl, "vol=%s OK for this job\n", vol->vol_name);
953          foreach_alist(store, dirstore) {
954             int stat;
955             rctx.store = store;
956             foreach_alist(device_name, store->device) {
957                /* Found a device, try to use it */
958                rctx.device_name = device_name;
959                rctx.device = vol->dev->device;
960
961                if (vol->dev->is_autochanger()) {
962                   Dmsg1(dbglvl, "vol=%s is in changer\n", vol->vol_name);
963                   if (!is_vol_in_autochanger(rctx, vol)) {
964                      continue;
965                   }
966                } else if (strcmp(device_name, vol->dev->device->hdr.name) != 0) {
967                   Dmsg2(dbglvl, "device=%s not suitable want %s\n",
968                         vol->dev->device->hdr.name, device_name);
969                   continue;
970                }
971
972                bstrncpy(rctx.VolumeName, vol->vol_name, sizeof(rctx.VolumeName));
973                rctx.have_volume = true;
974                /* Try reserving this device and volume */
975                Dmsg2(dbglvl, "try vol=%s on device=%s\n", rctx.VolumeName, device_name);
976                stat = reserve_device(rctx);
977                if (stat == 1) {             /* found available device */
978                   Dmsg1(dbglvl, "Suitable device found=%s\n", device_name);
979                   ok = true;
980                   break;
981                } else if (stat == 0) {      /* device busy */
982                   Dmsg1(dbglvl, "Suitable device=%s, busy: not use\n", device_name);
983                } else {
984                   /* otherwise error */
985                   Dmsg0(dbglvl, "No suitable device found.\n");
986                }
987                rctx.have_volume = false;
988                rctx.VolumeName[0] = 0;
989             }
990             if (ok) {
991                break;
992             }
993          }
994          if (ok) {
995             break;
996          }
997       } /* end for loop over reserved volumes */
998
999       Dmsg0(dbglvl, "lock volumes\n");
1000       lock_volumes();
1001       save_vol_list = vol_list;
1002       vol_list = temp_vol_list;
1003       free_volume_list();                  /* release temp_vol_list */
1004       vol_list = save_vol_list;
1005       Dmsg0(dbglvl, "deleted temp vol list\n");
1006       Dmsg0(dbglvl, "unlock volumes\n");
1007       unlock_volumes();
1008       debug_list_volumes("=== After free temp table\n");
1009    }
1010    if (ok) {
1011       Dmsg1(dbglvl, "Usable dev found. Vol=%s from in-use vols list\n", rctx.VolumeName);
1012       return true;
1013    }
1014
1015    /* 
1016     * No reserved volume we can use, so now search for an available device.  
1017     *
1018     * For each storage device that the user specified, we
1019     *  search and see if there is a resource for that device.
1020     */
1021    foreach_alist(store, dirstore) {
1022       rctx.store = store;
1023       foreach_alist(device_name, store->device) {
1024          int stat;
1025          rctx.device_name = device_name;
1026          stat = search_res_for_device(rctx); 
1027          if (stat == 1) {             /* found available device */
1028             Dmsg1(dbglvl, "available device found=%s\n", device_name);
1029             ok = true;
1030             break;
1031          } else if (stat == 0) {      /* device busy */
1032             Dmsg1(dbglvl, "No usable device=%s, busy: not use\n", device_name);
1033          } else {
1034             /* otherwise error */
1035             Dmsg0(dbglvl, "No usable device found.\n");
1036          }
1037       }
1038       if (ok) {
1039          break;
1040       }
1041    }
1042    if (ok) {
1043       Dmsg1(dbglvl, "Usable dev found. Vol=%s\n", rctx.VolumeName);
1044    }
1045    return ok;
1046 }
1047
1048 /*
1049  * Search for a particular storage device with particular storage
1050  *  characteristics (MediaType).
1051  */
1052 int search_res_for_device(RCTX &rctx) 
1053 {
1054    AUTOCHANGER *changer;
1055    int stat;
1056
1057    Dmsg1(dbglvl, "search res for %s\n", rctx.device_name);
1058    /* Look through Autochangers first */
1059    foreach_res(changer, R_AUTOCHANGER) {
1060       Dmsg1(dbglvl, "Try match changer res=%s\n", changer->hdr.name);
1061       /* Find resource, and make sure we were able to open it */
1062       if (strcmp(rctx.device_name, changer->hdr.name) == 0) {
1063          /* Try each device in this AutoChanger */
1064          foreach_alist(rctx.device, changer->device) {
1065             Dmsg1(dbglvl, "Try changer device %s\n", rctx.device->hdr.name);
1066             stat = reserve_device(rctx);
1067             if (stat != 1) {             /* try another device */
1068                continue;
1069             }
1070             /* Debug code */
1071             if (rctx.store->append == SD_APPEND) {
1072                Dmsg2(dbglvl, "Device %s reserved=%d for append.\n", 
1073                   rctx.device->hdr.name, rctx.jcr->dcr->dev->reserved_device);
1074             } else {
1075                Dmsg2(dbglvl, "Device %s reserved=%d for read.\n", 
1076                   rctx.device->hdr.name, rctx.jcr->read_dcr->dev->reserved_device);
1077             }
1078             return stat;
1079          }
1080       }
1081    }
1082
1083    /* Now if requested look through regular devices */
1084    if (!rctx.autochanger_only) {
1085       foreach_res(rctx.device, R_DEVICE) {
1086          Dmsg1(dbglvl, "Try match res=%s\n", rctx.device->hdr.name);
1087          /* Find resource, and make sure we were able to open it */
1088          if (strcmp(rctx.device_name, rctx.device->hdr.name) == 0) {
1089             stat = reserve_device(rctx);
1090             if (stat != 1) {             /* try another device */
1091                continue;
1092             }
1093             /* Debug code */
1094             if (rctx.store->append == SD_APPEND) {
1095                Dmsg2(dbglvl, "Device %s reserved=%d for append.\n", 
1096                   rctx.device->hdr.name, rctx.jcr->dcr->dev->reserved_device);
1097             } else {
1098                Dmsg2(dbglvl, "Device %s reserved=%d for read.\n", 
1099                   rctx.device->hdr.name, rctx.jcr->read_dcr->dev->reserved_device);
1100             }
1101             return stat;
1102          }
1103       }
1104    }
1105    return -1;                    /* nothing found */
1106 }
1107
1108 /*
1109  *  Try to reserve a specific device.
1110  *
1111  *  Returns: 1 -- OK, have DCR
1112  *           0 -- must wait
1113  *          -1 -- fatal error
1114  */
1115 static int reserve_device(RCTX &rctx)
1116 {
1117    bool ok;
1118    DCR *dcr;
1119    const int name_len = MAX_NAME_LENGTH;
1120
1121    /* Make sure MediaType is OK */
1122    Dmsg2(dbglvl, "chk MediaType device=%s request=%s\n",
1123          rctx.device->media_type, rctx.store->media_type);
1124    if (strcmp(rctx.device->media_type, rctx.store->media_type) != 0) {
1125       return -1;
1126    }
1127
1128    /* Make sure device exists -- i.e. we can stat() it */
1129    if (!rctx.device->dev) {
1130       rctx.device->dev = init_dev(rctx.jcr, rctx.device);
1131    }
1132    if (!rctx.device->dev) {
1133       if (rctx.device->changer_res) {
1134         Jmsg(rctx.jcr, M_WARNING, 0, _("\n"
1135            "     Device \"%s\" in changer \"%s\" requested by DIR could not be opened or does not exist.\n"),
1136              rctx.device->hdr.name, rctx.device_name);
1137       } else {
1138          Jmsg(rctx.jcr, M_WARNING, 0, _("\n"
1139             "     Device \"%s\" requested by DIR could not be opened or does not exist.\n"),
1140               rctx.device_name);
1141       }
1142       return -1;  /* no use waiting */
1143    }  
1144
1145    rctx.suitable_device = true;
1146    Dmsg1(dbglvl, "try reserve %s\n", rctx.device->hdr.name);
1147    rctx.jcr->dcr = dcr = new_dcr(rctx.jcr, rctx.jcr->dcr, rctx.device->dev);
1148    if (!dcr) {
1149       BSOCK *dir = rctx.jcr->dir_bsock;
1150       dir->fsend(_("3926 Could not get dcr for device: %s\n"), rctx.device_name);
1151       Dmsg1(dbglvl, ">dird: %s", dir->msg);
1152       return -1;
1153    }
1154    bstrncpy(dcr->pool_name, rctx.store->pool_name, name_len);
1155    bstrncpy(dcr->pool_type, rctx.store->pool_type, name_len);
1156    bstrncpy(dcr->media_type, rctx.store->media_type, name_len);
1157    bstrncpy(dcr->dev_name, rctx.device_name, name_len);
1158    if (rctx.store->append == SD_APPEND) {
1159       Dmsg2(dbglvl, "call reserve for append: have_vol=%d vol=%s\n", rctx.have_volume, rctx.VolumeName);                                   
1160       ok = reserve_device_for_append(dcr, rctx);
1161       if (!ok) {
1162          goto bail_out;
1163       }
1164
1165       rctx.jcr->dcr = dcr;
1166       Dmsg5(dbglvl, "Reserved=%d dev_name=%s mediatype=%s pool=%s ok=%d\n",
1167                dcr->dev->reserved_device,
1168                dcr->dev_name, dcr->media_type, dcr->pool_name, ok);
1169       Dmsg3(dbglvl, "Vol=%s num_writers=%d, have_vol=%d\n", 
1170          rctx.VolumeName, dcr->dev->num_writers, rctx.have_volume);
1171       if (rctx.have_volume) {
1172          Dmsg0(dbglvl, "Call reserve_volume\n");
1173          if (reserve_volume(dcr, rctx.VolumeName)) {
1174             Dmsg1(dbglvl, "Reserved vol=%s\n", rctx.VolumeName);
1175          } else {
1176             Dmsg1(dbglvl, "Could not reserve vol=%s\n", rctx.VolumeName);
1177             goto bail_out;
1178          }
1179       } else {
1180          dcr->any_volume = true;
1181          Dmsg0(dbglvl, "no vol, call find_next_appendable_vol.\n");
1182          if (dir_find_next_appendable_volume(dcr)) {
1183             bstrncpy(rctx.VolumeName, dcr->VolumeName, sizeof(rctx.VolumeName));
1184             rctx.have_volume = true;
1185             Dmsg1(dbglvl, "looking for Volume=%s\n", rctx.VolumeName);
1186          } else {
1187             Dmsg0(dbglvl, "No next volume found\n");
1188             rctx.have_volume = false;
1189             rctx.VolumeName[0] = 0;
1190             /*
1191              * If there is at least one volume that is valid and in use,
1192              *   but we get here, check if we are running with prefers
1193              *   non-mounted drives.  In that case, we have selected a
1194              *   non-used drive and our one and only volume is mounted
1195              *   elsewhere, so we bail out and retry using that drive.
1196              */
1197             if (dcr->volume_in_use && !rctx.PreferMountedVols) {
1198                rctx.PreferMountedVols = true;
1199                if (dcr->VolumeName[0]) {
1200                   unreserve_device(dcr);
1201                }
1202                goto bail_out;
1203             }
1204             /*
1205              * Note. Under some circumstances, the Director can hand us
1206              *  a Volume name that is not the same as the one on the current
1207              *  drive, and in that case, the call above to find the next
1208              *  volume will fail because in attempting to reserve the Volume
1209              *  the code will realize that we already have a tape mounted,
1210              *  and it will fail.  This *should* only happen if there are 
1211              *  writers, thus the following test.  In that case, we simply
1212              *  bail out, and continue waiting, rather than plunging on
1213              *  and hoping that the operator can resolve the problem. 
1214              */
1215             if (dcr->dev->num_writers != 0) {
1216                if (dcr->VolumeName[0]) {
1217                   unreserve_device(dcr);
1218                }
1219                goto bail_out;
1220             }
1221          }
1222       }
1223    } else {
1224       ok = reserve_device_for_read(dcr);
1225       if (ok) {
1226          rctx.jcr->read_dcr = dcr;
1227          Dmsg5(dbglvl, "Read reserved=%d dev_name=%s mediatype=%s pool=%s ok=%d\n",
1228                dcr->dev->reserved_device,
1229                dcr->dev_name, dcr->media_type, dcr->pool_name, ok);
1230       }
1231    }
1232    if (!ok) {
1233       goto bail_out;
1234    }
1235
1236    if (rctx.notify_dir) {
1237       POOL_MEM dev_name;
1238       BSOCK *dir = rctx.jcr->dir_bsock;
1239       pm_strcpy(dev_name, rctx.device->hdr.name);
1240       bash_spaces(dev_name);
1241       ok = dir->fsend(OK_device, dev_name.c_str());  /* Return real device name */
1242       Dmsg1(dbglvl, ">dird: %s", dir->msg);
1243    } else {
1244       ok = true;
1245    }
1246    return ok ? 1 : -1;
1247
1248 bail_out:
1249    rctx.have_volume = false;
1250    rctx.VolumeName[0] = 0;
1251    Dmsg0(dbglvl, "Not OK.\n");
1252    return 0;
1253 }
1254
1255 /*
1256  * We "reserve" the drive by setting the ST_READ bit. No one else
1257  *  should touch the drive until that is cleared.
1258  *  This allows the DIR to "reserve" the device before actually
1259  *  starting the job. 
1260  */
1261 static bool reserve_device_for_read(DCR *dcr)
1262 {
1263    DEVICE *dev = dcr->dev;
1264    JCR *jcr = dcr->jcr;
1265    bool ok = false;
1266
1267    ASSERT(dcr);
1268
1269    dev->dlock();  
1270
1271    if (is_device_unmounted(dev)) {             
1272       Dmsg1(dbglvl, "Device %s is BLOCKED due to user unmount.\n", dev->print_name());
1273       Mmsg(jcr->errmsg, _("3601 JobId=%u device %s is BLOCKED due to user unmount.\n"),
1274            jcr->JobId, dev->print_name());
1275       queue_reserve_message(jcr);
1276       goto bail_out;
1277    }
1278
1279    if (dev->is_busy()) {
1280       Dmsg4(dbglvl, "Device %s is busy ST_READ=%d num_writers=%d reserved=%d.\n", 
1281          dev->print_name(),
1282          dev->state & ST_READ?1:0, dev->num_writers, dev->reserved_device);
1283       Mmsg(jcr->errmsg, _("3602 JobId=%u device %s is busy (already reading/writing).\n"),
1284             jcr->JobId, dev->print_name());
1285       queue_reserve_message(jcr);
1286       goto bail_out;
1287    }
1288
1289    dev->clear_append();
1290    dev->set_read();
1291    ok = true;
1292    dev->reserved_device++;
1293    Dmsg3(dbglvl, "Inc reserve=%d dev=%s %p\n", dev->reserved_device, dev->print_name(), dev);
1294    dcr->reserved_device = true;
1295
1296 bail_out:
1297    dev->dunlock();
1298    return ok;
1299 }
1300
1301
1302 /*
1303  * We reserve the device for appending by incrementing the 
1304  *  reserved_device. We do virtually all the same work that
1305  *  is done in acquire_device_for_append(), but we do
1306  *  not attempt to mount the device. This routine allows
1307  *  the DIR to reserve multiple devices before *really* 
1308  *  starting the job. It also permits the SD to refuse 
1309  *  certain devices (not up, ...).
1310  *
1311  * Note, in reserving a device, if the device is for the
1312  *  same pool and the same pool type, then it is acceptable.
1313  *  The Media Type has already been checked. If we are
1314  *  the first tor reserve the device, we put the pool
1315  *  name and pool type in the device record.
1316  */
1317 static bool reserve_device_for_append(DCR *dcr, RCTX &rctx)
1318 {
1319    JCR *jcr = dcr->jcr;
1320    DEVICE *dev = dcr->dev;
1321    bool ok = false;
1322
1323    ASSERT(dcr);
1324
1325    dev->dlock();
1326
1327    /* If device is being read, we cannot write it */
1328    if (dev->can_read()) {
1329       Mmsg(jcr->errmsg, _("3603 JobId=%u device %s is busy reading.\n"), 
1330          jcr->JobId, dev->print_name());
1331       Dmsg1(dbglvl, "%s", jcr->errmsg);
1332       queue_reserve_message(jcr);
1333       goto bail_out;
1334    }
1335
1336    /* If device is unmounted, we are out of luck */
1337    if (is_device_unmounted(dev)) {
1338       Mmsg(jcr->errmsg, _("3604 JobId=%u device %s is BLOCKED due to user unmount.\n"), 
1339          jcr->JobId, dev->print_name());
1340       Dmsg1(dbglvl, "%s", jcr->errmsg);
1341       queue_reserve_message(jcr);
1342       goto bail_out;
1343    }
1344
1345    Dmsg1(dbglvl, "reserve_append device is %s\n", dev->print_name());
1346
1347    /* Now do detailed tests ... */
1348    if (can_reserve_drive(dcr, rctx) != 1) {
1349       Dmsg0(dbglvl, "can_reserve_drive!=1\n");
1350       goto bail_out;
1351    }
1352
1353    dev->reserved_device++;
1354    Dmsg3(dbglvl, "Inc reserve=%d dev=%s %p\n", dev->reserved_device, 
1355       dev->print_name(), dev);
1356    dcr->reserved_device = true;
1357    ok = true;
1358
1359 bail_out:
1360    dev->dunlock();
1361    return ok;
1362 }
1363
1364 static int is_pool_ok(DCR *dcr)
1365 {
1366    DEVICE *dev = dcr->dev;
1367    JCR *jcr = dcr->jcr;
1368
1369    /* Now check if we want the same Pool and pool type */
1370    if (strcmp(dev->pool_name, dcr->pool_name) == 0 &&
1371        strcmp(dev->pool_type, dcr->pool_type) == 0) {
1372       /* OK, compatible device */
1373       Dmsg1(dbglvl, "OK dev: %s num_writers=0, reserved, pool matches\n", dev->print_name());
1374       return 1;
1375    } else {
1376       /* Drive Pool not suitable for us */
1377       Mmsg(jcr->errmsg, _(
1378 "3608 JobId=%u wants Pool=\"%s\" but have Pool=\"%s\" nreserve=%d on drive %s.\n"), 
1379             (uint32_t)jcr->JobId, dcr->pool_name, dev->pool_name,
1380             dev->reserved_device, dev->print_name());
1381       queue_reserve_message(jcr);
1382       Dmsg2(dbglvl, "failed: busy num_writers=0, reserved, pool=%s wanted=%s\n",
1383          dev->pool_name, dcr->pool_name);
1384    }
1385    return 0;
1386 }
1387
1388 static bool is_max_jobs_ok(DCR *dcr) 
1389 {
1390    DEVICE *dev = dcr->dev;
1391    JCR *jcr = dcr->jcr;
1392
1393    Dmsg4(dbglvl, "MaxJobs=%d Jobs=%d reserves=%d Vol=%s\n",
1394          dcr->VolCatInfo.VolCatMaxJobs,
1395          dcr->VolCatInfo.VolCatJobs, dev->reserved_device,
1396          dcr->VolumeName);
1397    if (dcr->VolCatInfo.VolCatMaxJobs > 0 && dcr->VolCatInfo.VolCatMaxJobs <=
1398         (dcr->VolCatInfo.VolCatJobs + dev->reserved_device)) {
1399       /* Max Job Vols depassed or already reserved */
1400       Mmsg(jcr->errmsg, _("3610 JobId=%u Volume max jobs exceeded on drive %s.\n"), 
1401             (uint32_t)jcr->JobId, dev->print_name());
1402       queue_reserve_message(jcr);
1403       Dmsg1(dbglvl, "reserve dev failed: %s", jcr->errmsg);
1404       return false;                /* wait */
1405    }
1406    return true;
1407 }
1408
1409 /*
1410  * Returns: 1 if drive can be reserved
1411  *          0 if we should wait
1412  *         -1 on error or impossibility
1413  */
1414 static int can_reserve_drive(DCR *dcr, RCTX &rctx) 
1415 {
1416    DEVICE *dev = dcr->dev;
1417    JCR *jcr = dcr->jcr;
1418
1419    Dmsg5(dbglvl, "PrefMnt=%d exact=%d suitable=%d chgronly=%d any=%d\n",
1420          rctx.PreferMountedVols, rctx.exact_match, rctx.suitable_device,
1421          rctx.autochanger_only, rctx.any_drive);
1422
1423    /* Check for max jobs on this Volume */
1424    if (!is_max_jobs_ok(dcr)) {
1425       return 0;
1426    }
1427
1428    /* setting any_drive overrides PreferMountedVols flag */
1429    if (!rctx.any_drive) {
1430       /*
1431        * When PreferMountedVols is set, we keep track of the 
1432        *  drive in use that has the least number of writers, then if
1433        *  no unmounted drive is found, we try that drive. This   
1434        *  helps spread the load to the least used drives.  
1435        */
1436       if (rctx.try_low_use_drive && dev == rctx.low_use_drive) {
1437          Dmsg2(dbglvl, "OK dev=%s == low_drive=%s.\n",
1438             dev->print_name(), rctx.low_use_drive->print_name());
1439          return 1;
1440       }
1441       /* If he wants a free drive, but this one is busy, no go */
1442       if (!rctx.PreferMountedVols && dev->is_busy()) {
1443          /* Save least used drive */
1444          if ((dev->num_writers + dev->reserved_device) < rctx.num_writers) {
1445             rctx.num_writers = dev->num_writers + dev->reserved_device;
1446             rctx.low_use_drive = dev;
1447             Dmsg2(dbglvl, "set low use drive=%s num_writers=%d\n", 
1448                dev->print_name(), rctx.num_writers);
1449          } else {
1450             Dmsg1(dbglvl, "not low use num_writers=%d\n", dev->num_writers+dev->reserved_device);
1451          }
1452          Dmsg0(dbglvl, "failed: !prefMnt && busy.\n");
1453          Mmsg(jcr->errmsg, _("3605 JobId=%u wants free drive but device %s is busy.\n"), 
1454             jcr->JobId, dev->print_name());
1455          queue_reserve_message(jcr);
1456          return 0;
1457       }
1458
1459       /* Check for prefer mounted volumes */
1460       if (rctx.PreferMountedVols && !dev->vol && dev->is_tape()) {
1461          Mmsg(jcr->errmsg, _("3606 JobId=%u prefers mounted drives, but drive %s has no Volume.\n"), 
1462             jcr->JobId, dev->print_name());
1463          queue_reserve_message(jcr);
1464          Dmsg0(dbglvl, "failed: want mounted -- no vol\n");
1465          return 0;                 /* No volume mounted */
1466       }
1467
1468       /* Check for exact Volume name match */
1469       /* ***FIXME*** for Disk, we can accept any volume that goes with this
1470        *    drive.
1471        */
1472       if (rctx.exact_match && rctx.have_volume) {
1473          bool ok;
1474          Dmsg5(dbglvl, "PrefMnt=%d exact=%d suitable=%d chgronly=%d any=%d\n",
1475                rctx.PreferMountedVols, rctx.exact_match, rctx.suitable_device,
1476                rctx.autochanger_only, rctx.any_drive);
1477          Dmsg4(dbglvl, "have_vol=%d have=%s resvol=%s want=%s\n",
1478                   rctx.have_volume, dev->VolHdr.VolumeName, 
1479                   dev->vol?dev->vol->vol_name:"*none*", rctx.VolumeName);
1480          ok = strcmp(dev->VolHdr.VolumeName, rctx.VolumeName) == 0 ||
1481                  (dev->vol && strcmp(dev->vol->vol_name, rctx.VolumeName) == 0);
1482          if (!ok) {
1483             Mmsg(jcr->errmsg, _("3607 JobId=%u wants Vol=\"%s\" drive has Vol=\"%s\" on drive %s.\n"), 
1484                jcr->JobId, rctx.VolumeName, dev->VolHdr.VolumeName, 
1485                dev->print_name());
1486             queue_reserve_message(jcr);
1487             Dmsg3(dbglvl, "not OK: dev have=%s resvol=%s want=%s\n",
1488                   dev->VolHdr.VolumeName, dev->vol?dev->vol->vol_name:"*none*", rctx.VolumeName);
1489             return 0;
1490          }
1491          if (is_volume_in_use(dcr)) {
1492             return 0;              /* fail if volume on another drive */
1493          }
1494       }
1495    }
1496
1497    /* Check for unused autochanger drive */
1498    if (rctx.autochanger_only && !dev->is_busy() &&
1499        dev->VolHdr.VolumeName[0] == 0) {
1500       /* Device is available but not yet reserved, reserve it for us */
1501       Dmsg1(dbglvl, "OK Res Unused autochanger %s.\n", dev->print_name());
1502       bstrncpy(dev->pool_name, dcr->pool_name, sizeof(dev->pool_name));
1503       bstrncpy(dev->pool_type, dcr->pool_type, sizeof(dev->pool_type));
1504       return 1;                       /* reserve drive */
1505    }
1506
1507    /*
1508     * Handle the case that there are no writers
1509     */
1510    if (dev->num_writers == 0) {
1511       /* Now check if there are any reservations on the drive */
1512       if (dev->reserved_device) {           
1513          return is_pool_ok(dcr);
1514       } else if (dev->can_append()) {
1515          if (is_pool_ok(dcr)) {
1516             return 1; 
1517          } else {
1518             /* Changing pool, unload old tape if any in drive */
1519             Dmsg0(dbglvl, "OK dev: num_writers=0, not reserved, pool change, unload changer\n");
1520             unload_autochanger(dcr, 0);
1521          }
1522       }
1523       /* Device is available but not yet reserved, reserve it for us */
1524       Dmsg1(dbglvl, "OK Dev avail reserved %s\n", dev->print_name());
1525       bstrncpy(dev->pool_name, dcr->pool_name, sizeof(dev->pool_name));
1526       bstrncpy(dev->pool_type, dcr->pool_type, sizeof(dev->pool_type));
1527       return 1;                       /* reserve drive */
1528    }
1529
1530    /*
1531     * Check if the device is in append mode with writers (i.e.
1532     *  available if pool is the same).
1533     */
1534    if (dev->can_append() || dev->num_writers > 0) {
1535       return is_pool_ok(dcr);
1536    } else {
1537       Pmsg1(000, _("Logic error!!!! JobId=%u Should not get here.\n"), (int)jcr->JobId);
1538       Mmsg(jcr->errmsg, _("3910 JobId=%u Logic error!!!! drive %s Should not get here.\n"),
1539             jcr->JobId, dev->print_name());
1540       queue_reserve_message(jcr);
1541       Jmsg0(jcr, M_FATAL, 0, _("Logic error!!!! Should not get here.\n"));
1542       return -1;                      /* error, should not get here */
1543    }
1544    Mmsg(jcr->errmsg, _("3911 JobId=%u failed reserve drive %s.\n"), 
1545          jcr->JobId, dev->print_name());
1546    queue_reserve_message(jcr);
1547    Dmsg1(dbglvl, "failed: No reserve %s\n", dev->print_name());
1548    return 0;
1549 }
1550
1551
1552
1553
1554 /*
1555  * Queue a reservation error or failure message for this jcr
1556  */
1557 static void queue_reserve_message(JCR *jcr)
1558 {
1559    int i;   
1560    alist *msgs;
1561    char *msg;
1562
1563    jcr->lock();
1564
1565    msgs = jcr->reserve_msgs;
1566    if (!msgs) {
1567       goto bail_out;
1568    }
1569    /*
1570     * Look for duplicate message.  If found, do
1571     * not insert
1572     */
1573    for (i=msgs->size()-1; i >= 0; i--) {
1574       msg = (char *)msgs->get(i);
1575       if (!msg) {
1576          goto bail_out;
1577       }
1578       /* Comparison based on 4 digit message number */
1579       if (strncmp(msg, jcr->errmsg, 4) == 0) {
1580          goto bail_out;
1581       }
1582    }      
1583    /* Message unique, so insert it */
1584    jcr->reserve_msgs->push(bstrdup(jcr->errmsg));
1585
1586 bail_out:
1587    jcr->unlock();
1588 }
1589
1590 /*
1591  * Send any reservation messages queued for this jcr
1592  */
1593 void send_drive_reserve_messages(JCR *jcr, void sendit(const char *msg, int len, void *sarg), void *arg)
1594 {
1595    int i;
1596    alist *msgs;
1597    char *msg;
1598
1599    jcr->lock();
1600    msgs = jcr->reserve_msgs;
1601    if (!msgs || msgs->size() == 0) {
1602       goto bail_out;
1603    }
1604    for (i=msgs->size()-1; i >= 0; i--) {
1605       msg = (char *)msgs->get(i);
1606       if (msg) {
1607          sendit("   ", 3, arg);
1608          sendit(msg, strlen(msg), arg);
1609       } else {
1610          break;
1611       }
1612    }
1613
1614 bail_out:
1615    jcr->unlock();
1616 }
1617
1618 /*
1619  * Pop and release any reservations messages
1620  */
1621 static void pop_reserve_messages(JCR *jcr)
1622 {
1623    alist *msgs;
1624    char *msg;
1625
1626    jcr->lock();
1627    msgs = jcr->reserve_msgs;
1628    if (!msgs) {
1629       goto bail_out;
1630    }
1631    while ((msg = (char *)msgs->pop())) {
1632       free(msg);
1633    }
1634 bail_out:
1635    jcr->unlock();
1636 }
1637
1638 /*
1639  * Also called from acquire.c 
1640  */
1641 void release_reserve_messages(JCR *jcr)
1642 {
1643    pop_reserve_messages(jcr);
1644    jcr->lock();
1645    if (!jcr->reserve_msgs) {
1646       goto bail_out;
1647    }
1648    delete jcr->reserve_msgs;
1649    jcr->reserve_msgs = NULL;
1650
1651 bail_out:
1652    jcr->unlock();
1653 }