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