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