]> git.sur5r.net Git - bacula/bacula/blob - bacula/src/stored/mount.c
cf678ae0a61827d74d0e39d9505be7adb26e7c53
[bacula/bacula] / bacula / src / stored / mount.c
1 /*
2  *
3  *  Routines for handling mounting tapes for reading and for
4  *    writing.
5  *
6  *   Kern Sibbald, August MMII
7  *
8  *   Version $Id$
9  */
10 /*
11    Copyright (C) 2000-2005 Kern Sibbald
12
13    This program is free software; you can redistribute it and/or
14    modify it under the terms of the GNU General Public License as
15    published by the Free Software Foundation; either version 2 of
16    the License, or (at your option) any later version.
17
18    This program is distributed in the hope that it will be useful,
19    but WITHOUT ANY WARRANTY; without even the implied warranty of
20    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
21    General Public License for more details.
22
23    You should have received a copy of the GNU General Public
24    License along with this program; if not, write to the Free
25    Software Foundation, Inc., 59 Temple Place - Suite 330, Boston,
26    MA 02111-1307, USA.
27
28  */
29
30 #include "bacula.h"                   /* pull in global headers */
31 #include "stored.h"                   /* pull in Storage Deamon headers */
32
33 static bool rewrite_volume_label(DCR *dcr, bool recycle);
34
35
36 /*
37  * If release is set, we rewind the current volume,
38  * which we no longer want, and ask the user (console)
39  * to mount the next volume.
40  *
41  *  Continue trying until we get it, and then ensure
42  *  that we can write on it.
43  *
44  * This routine returns a 0 only if it is REALLY
45  *  impossible to get the requested Volume.
46  *
47  */
48 bool mount_next_write_volume(DCR *dcr, bool release)
49 {
50    int retry = 0;
51    bool ask = false, recycle, autochanger;
52    int vol_label_status;
53    DEVICE *dev = dcr->dev;
54    JCR *jcr = dcr->jcr;
55    DEV_BLOCK *block = dcr->block;
56
57    Dmsg0(100, "Enter mount_next_volume()\n");
58
59    init_dev_wait_timers(dev);
60
61    /*
62     * Attempt to mount the next volume. If something non-fatal goes
63     *  wrong, we come back here to re-try (new op messages, re-read
64     *  Volume, ...)
65     */
66 mount_next_vol:
67    /* Ignore retry if this is poll request */
68    if (!dev->poll && retry++ > 4) {
69       /* Last ditch effort before giving up, force operator to respond */
70       dcr->VolCatInfo.Slot = 0;
71       if (!dir_ask_sysop_to_mount_volume(dcr)) {
72          Jmsg(jcr, M_FATAL, 0, _("Too many errors trying to mount device %s.\n"),
73               dev_name(dev));
74          return false;
75       }
76    }
77    if (job_canceled(jcr)) {
78       Jmsg(jcr, M_FATAL, 0, _("Job %d canceled.\n"), jcr->JobId);
79       return false;
80    }
81    recycle = false;
82    if (release) {
83       Dmsg0(100, "mount_next_volume release=1\n");
84       release_volume(dcr);
85       ask = true;                     /* ask operator to mount tape */
86    }
87
88    /*
89     * Get Director's idea of what tape we should have mounted.
90     *    in dcr->VolCatInfo
91     */
92    Dmsg0(200, "Before dir_find_next_appendable_volume.\n");
93    while (!dir_find_next_appendable_volume(dcr)) {
94        Dmsg0(200, "not dir_find_next\n");
95        if (!dir_ask_sysop_to_create_appendable_volume(dcr)) {
96          return false;
97        }
98        Dmsg0(200, "Again dir_find_next_append...\n");
99    }
100    if (job_canceled(jcr)) {
101       return false;
102    }
103    Dmsg3(100, "After find_next_append. Vol=%s Slot=%d Parts=%d\n",
104          dcr->VolCatInfo.VolCatName, dcr->VolCatInfo.Slot, dcr->VolCatInfo.VolCatParts);
105    
106    dev->num_parts = dcr->VolCatInfo.VolCatParts;
107
108    /*
109     * Get next volume and ready it for append
110     * This code ensures that the device is ready for
111     * writing. We start from the assumption that there
112     * may not be a tape mounted.
113     *
114     * If the device is a file, we create the output
115     * file. If it is a tape, we check the volume name
116     * and move the tape to the end of data.
117     *
118     * It assumes that the device is not already in use!
119     *
120     */
121    if (autoload_device(dcr, 1, NULL) > 0) {
122       autochanger = true;
123       ask = false;
124    } else {
125       autochanger = false;
126       dcr->VolCatInfo.Slot = 0;
127    }
128    Dmsg1(100, "autoload_dev returns %d\n", autochanger);
129    /*
130     * If we autochanged to correct Volume or (we have not just
131     *   released the Volume AND we can automount) we go ahead
132     *   and read the label. If there is no tape in the drive,
133     *   we will err, recurse and ask the operator the next time.
134     */
135    if (!release && dev_is_tape(dev) && dev_cap(dev, CAP_AUTOMOUNT)) {
136       ask = false;                 /* don't ask SYSOP this time */
137    }
138    /* Don't ask if not removable */
139    if (!dev_cap(dev, CAP_REM)) {
140       ask = false;
141    }
142    Dmsg2(100, "Ask=%d autochanger=%d\n", ask, autochanger);
143    release = true;                /* release next time if we "recurse" */
144
145    if (ask && !dir_ask_sysop_to_mount_volume(dcr)) {
146       Dmsg0(100, "Error return ask_sysop ...\n");
147       return false;          /* error return */
148    }
149    if (job_canceled(jcr)) {
150       return false;
151    }
152    Dmsg1(100, "want vol=%s\n", dcr->VolumeName);
153
154    if (dev->poll && dev_cap(dev, CAP_CLOSEONPOLL)) {
155       force_close_dev(dev);
156    }
157
158    /* Ensure the device is open */
159    /* If we have a dvd that requires mount, we first want to guess
160     * which Volume is loaded, so we continue (if the wrong device is
161     * loaded, open_device would fail). */
162    if (!dev->is_dvd()) {
163       if (!open_device(dcr)) {
164          if (dev->poll) {
165             goto mount_next_vol;
166          } else {
167             return false;
168          }
169       }
170    } else {
171       /*
172        * Just copy the VolCatName in the device resource 
173        *   (usually done by open_dev).
174        * It is necessary so we can open the real files later.   
175        */
176       bstrncpy(dev->VolCatInfo.VolCatName, dcr->VolCatInfo.VolCatName, sizeof(dev->VolCatInfo.VolCatName));
177    }
178
179    /*
180     * Now make sure we have the right tape mounted
181     */
182 read_volume:
183    /*
184     * If we are writing to a stream device, ASSUME the volume label
185     *  is correct.
186     */
187    if (dev_cap(dev, CAP_STREAM)) {
188       vol_label_status = VOL_OK;
189       create_volume_label(dev, dcr->VolumeName, "Default");
190       dev->VolHdr.LabelType = PRE_LABEL;
191    } else if (dev->is_dvd()) {
192       vol_label_status = read_dev_volume_label_guess(dcr, 1);
193    } else {
194       vol_label_status = read_dev_volume_label(dcr);
195    }
196    if (job_canceled(jcr)) {
197       return false;
198    }
199
200    Dmsg2(100, "dirVol=%s dirStat=%s\n", dcr->VolumeName,
201       dcr->VolCatInfo.VolCatStatus);
202    /*
203     * At this point, dev->VolCatInfo has what is in the drive, if anything,
204     *          and   dcr->VolCatInfo has what the Director wants.
205     */
206    switch (vol_label_status) {
207    case VOL_OK:
208       Dmsg1(100, "Vol OK name=%s\n", dcr->VolumeName);
209       memcpy(&dev->VolCatInfo, &dcr->VolCatInfo, sizeof(dev->VolCatInfo));
210       recycle = strcmp(dev->VolCatInfo.VolCatStatus, "Recycle") == 0;
211       break;                    /* got a Volume */
212    case VOL_NAME_ERROR:
213       VOLUME_CAT_INFO VolCatInfo;
214
215       /* If not removable, Volume is broken */
216       if (!dev_cap(dev, CAP_REM)) {
217          Jmsg(jcr, M_WARNING, 0, _("Volume \"%s\" not on device %s.\n"),
218             dcr->VolumeName, dev_name(dev));
219          mark_volume_in_error(dcr);
220          goto mount_next_vol;
221       }
222
223       Dmsg1(100, "Vol NAME Error Name=%s\n", dcr->VolumeName);
224       /* If polling and got a previous bad name, ignore it */
225       if (dev->poll && strcmp(dev->BadVolName, dev->VolHdr.VolName) == 0) {
226          ask = true;
227          Dmsg1(200, "Vol Name error supress due to poll. Name=%s\n",
228             dcr->VolumeName);
229          goto mount_next_vol;
230       }
231       /*
232        * OK, we got a different volume mounted. First save the
233        *  requested Volume info (jcr) structure, then query if
234        *  this volume is really OK. If not, put back the desired
235        *  volume name and continue.
236        */
237       memcpy(&VolCatInfo, &dcr->VolCatInfo, sizeof(VolCatInfo));
238       /* Check if this is a valid Volume in the pool */
239       bstrncpy(dcr->VolumeName, dev->VolHdr.VolName, sizeof(dcr->VolumeName));
240       if (!dir_get_volume_info(dcr, GET_VOL_INFO_FOR_WRITE)) {
241          bstrncpy(dev->BadVolName, dev->VolHdr.VolName, sizeof(dev->BadVolName));
242          Jmsg(jcr, M_WARNING, 0, _("Director wanted Volume \"%s\".\n"
243               "    Current Volume \"%s\" not acceptable because:\n"
244               "    %s"),
245              VolCatInfo.VolCatName, dev->VolHdr.VolName,
246              jcr->dir_bsock->msg);
247          /* Restore desired volume name, note device info out of sync */
248          memcpy(&dcr->VolCatInfo, &VolCatInfo, sizeof(dcr->VolCatInfo));
249          ask = true;
250          goto mount_next_vol;
251       }
252       Dmsg1(100, "want new name=%s\n", dcr->VolumeName);
253       memcpy(&dev->VolCatInfo, &dcr->VolCatInfo, sizeof(dev->VolCatInfo));
254       recycle = strcmp(dev->VolCatInfo.VolCatStatus, "Recycle") == 0;
255       break;                /* got a Volume */
256    /*
257     * At this point, we assume we have a blank tape mounted.
258     */
259    case VOL_NO_LABEL:
260    case VOL_IO_ERROR:
261       /*
262        * If permitted, we label the device, make sure we can do
263        *   it by checking that the VolCatBytes is zero => not labeled,
264        *   once the Volume is labeled we don't want to label another
265        *   blank tape with the same name.  For disk, we go ahead and
266        *   label it anyway, because the OS insures that there is only
267        *   one Volume with that name.
268        * As noted above, at this point dcr->VolCatInfo has what
269        *   the Director wants and dev->VolCatInfo has info on the
270        *   previous tape (or nothing).
271        */
272       if (dev_cap(dev, CAP_LABEL) && (dcr->VolCatInfo.VolCatBytes == 0 ||
273             (!dev->is_tape() && strcmp(dcr->VolCatInfo.VolCatStatus,
274                                    "Recycle") == 0))) {
275          Dmsg0(100, "Create volume label\n");
276          /* Create a new Volume label and write it to the device */
277          if (!write_new_volume_label_to_dev(dcr, dcr->VolumeName,
278                 dcr->pool_name)) {
279             Dmsg0(100, "!write_vol_label\n");
280             goto mount_next_vol;
281          }
282          Dmsg0(100, "dir_update_vol_info. Set Append\n");
283          /* Copy Director's info into the device info */
284          memcpy(&dev->VolCatInfo, &dcr->VolCatInfo, sizeof(dev->VolCatInfo));
285          if (!dir_update_volume_info(dcr, true)) {  /* indicate tape labeled */
286             return false;
287          }
288          Jmsg(jcr, M_INFO, 0, _("Labeled new Volume \"%s\" on device %s.\n"),
289             dcr->VolumeName, dev_name(dev));
290          goto read_volume;      /* read label we just wrote */
291       }
292       /* If not removable, Volume is broken */
293       if (!dev_cap(dev, CAP_REM)) {
294          Jmsg(jcr, M_WARNING, 0, _("Volume \"%s\" not on device %s.\n"),
295             dcr->VolumeName, dev_name(dev));
296          mark_volume_in_error(dcr);
297          goto mount_next_vol;
298       }
299       /* NOTE! Fall-through wanted. */
300    case VOL_NO_MEDIA:
301    default:
302       /* Send error message */
303       if (!dev->poll) {
304          Jmsg(jcr, M_WARNING, 0, "%s", jcr->errmsg);
305       } else {
306          Dmsg1(200, "Msg suppressed by poll: %s\n", jcr->errmsg);
307       }
308       ask = true;
309       /* Needed, so the medium can be changed */
310       if (dev_cap(dev, CAP_REQMOUNT)) {
311          close_dev(dev);  
312       }
313       goto mount_next_vol;
314    }
315
316    /*
317     * See if we have a fresh tape or a tape with data.
318     *
319     * Note, if the LabelType is PRE_LABEL, it was labeled
320     *  but never written. If so, rewrite the label but set as
321     *  VOL_LABEL.  We rewind and return the label (reconstructed)
322     *  in the block so that in the case of a new tape, data can
323     *  be appended just after the block label.  If we are writing
324     *  a second volume, the calling routine will write the label
325     *  before writing the overflow block.
326     *
327     *  If the tape is marked as Recycle, we rewrite the label.
328     */
329    if (dev->VolHdr.LabelType == PRE_LABEL || recycle) {
330       if (!rewrite_volume_label(dcr, recycle)) {
331          goto mount_next_vol;
332       }
333    } else {
334       /*
335        * OK, at this point, we have a valid Bacula label, but
336        * we need to position to the end of the volume, since we are
337        * just now putting it into append mode.
338        */
339       Dmsg0(200, "Device previously written, moving to end of data\n");
340       Jmsg(jcr, M_INFO, 0, _("Volume \"%s\" previously written, moving to end of data.\n"),
341          dcr->VolumeName);
342       if (!eod_dev(dev)) {
343          Jmsg(jcr, M_ERROR, 0, _("Unable to position to end of data on device \"%s\". ERR=%s\n"),
344             dev_name(dev), strerror_dev(dev));
345          mark_volume_in_error(dcr);
346          goto mount_next_vol;
347       }
348       /* *****FIXME**** we should do some checking for files too */
349       if (dev_is_tape(dev)) {
350          /*
351           * Check if we are positioned on the tape at the same place
352           * that the database says we should be.
353           */
354          if (dev->VolCatInfo.VolCatFiles == dev_file(dev)) {
355             Jmsg(jcr, M_INFO, 0, _("Ready to append to end of Volume \"%s\" at file=%d.\n"),
356                  dcr->VolumeName, dev_file(dev));
357          } else {
358             Jmsg(jcr, M_ERROR, 0, _("I canot write on Volume \"%s\" because:\n"
359 "The number of files mismatch! Volume=%u Catalog=%u\n"),
360                  dcr->VolumeName, dev_file(dev), dev->VolCatInfo.VolCatFiles);
361             mark_volume_in_error(dcr);
362             goto mount_next_vol;
363          }
364       }
365       dev->VolCatInfo.VolCatMounts++;      /* Update mounts */
366       Dmsg1(100, "update volinfo mounts=%d\n", dev->VolCatInfo.VolCatMounts);
367       if (!dir_update_volume_info(dcr, false)) {
368          return false;
369       }
370       /* Return an empty block */
371       empty_block(block);             /* we used it for reading so set for write */
372    }
373    dev->state |= ST_APPEND;
374    Dmsg0(100, "set APPEND, normal return from read_dev_for_append\n");
375    return true;
376 }
377
378 /*
379  * Write a volume label.
380  *  Returns: true if OK
381  *           false if unable to write it
382  */
383 static bool rewrite_volume_label(DCR *dcr, bool recycle)
384 {
385    DEVICE *dev = dcr->dev;
386    JCR *jcr = dcr->jcr;
387
388    Dmsg1(190, "set append found freshly labeled volume. dev=%x\n", dev);
389    dev->VolHdr.LabelType = VOL_LABEL; /* set Volume label */
390    dev->state |= ST_APPEND;
391    if (!write_volume_label_to_block(dcr)) {
392       Dmsg0(200, "Error from write volume label.\n");
393       return false;
394    }
395    /*
396     * If we are not dealing with a streaming device,
397     *  write the block now to ensure we have write permission.
398     *  It is better to find out now rather than later.
399     */
400    if (!dev_cap(dev, CAP_STREAM)) {
401       if (!rewind_dev(dev)) {
402          Jmsg2(jcr, M_WARNING, 0, _("Rewind error on device \"%s\". ERR=%s\n"),
403                dev_name(dev), strerror_dev(dev));
404       }
405       if (recycle) {
406          if (!truncate_dev(dev)) {
407             Jmsg2(jcr, M_WARNING, 0, _("Truncate error on device \"%s\". ERR=%s\n"),
408                   dev_name(dev), strerror_dev(dev));
409          }
410       }
411       /* Attempt write to check write permission */
412       Dmsg0(200, "Attempt to write to device.\n");
413       if (!write_ansi_ibm_label(dcr, dev->VolHdr.VolName)) {
414          return false;
415       }
416       if (!write_block_to_dev(dcr)) {
417          Jmsg2(jcr, M_ERROR, 0, _("Unable to write device \"%s\". ERR=%s\n"),
418             dev_name(dev), strerror_dev(dev));
419          Dmsg0(200, "===ERROR write block to dev\n");
420          return false;
421       }
422    }
423    /* Set or reset Volume statistics */
424    dev->VolCatInfo.VolCatJobs = 0;
425    dev->VolCatInfo.VolCatFiles = 0;
426    dev->VolCatInfo.VolCatBytes = 1;
427    dev->VolCatInfo.VolCatErrors = 0;
428    dev->VolCatInfo.VolCatBlocks = 0;
429    dev->VolCatInfo.VolCatRBytes = 0;
430    if (recycle) {
431       dev->VolCatInfo.VolCatMounts++;
432       dev->VolCatInfo.VolCatRecycles++;
433    } else {
434       dev->VolCatInfo.VolCatMounts = 1;
435       dev->VolCatInfo.VolCatRecycles = 0;
436       dev->VolCatInfo.VolCatWrites = 1;
437       dev->VolCatInfo.VolCatReads = 1;
438    }
439    Dmsg0(100, "dir_update_vol_info. Set Append\n");
440    bstrncpy(dev->VolCatInfo.VolCatStatus, "Append", sizeof(dev->VolCatInfo.VolCatStatus));
441    if (!dir_update_volume_info(dcr, true)) {  /* indicate doing relabel */
442       return false;
443    }
444    if (recycle) {
445       Jmsg(jcr, M_INFO, 0, _("Recycled volume \"%s\" on device \"%s\", all previous data lost.\n"),
446          dcr->VolumeName, dev_name(dev));
447    } else {
448       Jmsg(jcr, M_INFO, 0, _("Wrote label to prelabeled Volume \"%s\" on device \"%s\"\n"),
449          dcr->VolumeName, dev_name(dev));
450    }
451    /*
452     * End writing real Volume label (from pre-labeled tape), or recycling
453     *  the volume.
454     */
455    Dmsg0(200, "OK from rewite vol label.\n");
456    return true;
457 }
458
459
460 /*
461  * Mark volume in error in catalog
462  */
463 void mark_volume_in_error(DCR *dcr)
464 {
465    DEVICE *dev = dcr->dev;
466    Jmsg(dcr->jcr, M_INFO, 0, _("Marking Volume \"%s\" in Error in Catalog.\n"),
467         dcr->VolumeName);
468    bstrncpy(dev->VolCatInfo.VolCatStatus, "Error", sizeof(dev->VolCatInfo.VolCatStatus));
469    Dmsg0(100, "dir_update_vol_info. Set Error.\n");
470    dir_update_volume_info(dcr, false);
471 }
472
473 /*
474  * If we are reading, we come here at the end of the tape
475  *  and see if there are more volumes to be mounted.
476  */
477 bool mount_next_read_volume(DCR *dcr)
478 {
479    DEVICE *dev = dcr->dev;
480    JCR *jcr = dcr->jcr;
481    Dmsg2(90, "NumVolumes=%d CurVolume=%d\n", jcr->NumVolumes, jcr->CurVolume);
482    /*
483     * End Of Tape -- mount next Volume (if another specified)
484     */
485    if (jcr->NumVolumes > 1 && jcr->CurVolume < jcr->NumVolumes) {
486       close_dev(dev);
487       dev->state &= ~ST_READ;
488       if (!acquire_device_for_read(jcr, dev)) {
489          Jmsg2(jcr, M_FATAL, 0, "Cannot open Dev=%s, Vol=%s\n", dev_name(dev),
490                dcr->VolumeName);
491          return false;
492       }
493       return true;                    /* next volume mounted */
494    }
495    Dmsg0(90, "End of Device reached.\n");
496    return false;
497 }
498
499 /*
500  * Either because we are going to hang a new volume, or because
501  *  of explicit user request, we release the current volume.
502  */
503 void release_volume(DCR *dcr)
504 {
505    JCR *jcr = dcr->jcr;
506    DEVICE *dev = dcr->dev;
507    if (dcr->WroteVol) {
508       Jmsg0(jcr, M_ERROR, 0, "Hey!!!!! WroteVol non-zero !!!!!\n");
509       Dmsg0(190, "Hey!!!!! WroteVol non-zero !!!!!\n");
510    }
511    /*
512     * First erase all memory of the current volume
513     */
514    dev->block_num = dev->file = 0;
515    dev->EndBlock = dev->EndFile = 0;
516    memset(&dev->VolCatInfo, 0, sizeof(dev->VolCatInfo));
517    memset(&dcr->VolCatInfo, 0, sizeof(dcr->VolCatInfo));
518    memset(&dev->VolHdr, 0, sizeof(dev->VolHdr));
519    /* Force re-read of label */
520    dev->state &= ~(ST_LABEL|ST_READ|ST_APPEND);
521    dcr->VolumeName[0] = 0;
522
523    if (dev->is_open() && (!dev->is_tape() || !dev_cap(dev, CAP_ALWAYSOPEN))) {
524       offline_or_rewind_dev(dev);
525       close_dev(dev);
526    }
527
528    /* If we have not closed the device, then at least rewind the tape */
529    if (dev->is_open()) {
530       offline_or_rewind_dev(dev);
531    }
532    Dmsg0(190, "===== release_volume ---");
533 }