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