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