]> git.sur5r.net Git - bacula/bacula/blob - bacula/src/stored/mount.c
- Modified ANSI label code to preserve any ANSI label
[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
34 /*
35  * If release is set, we rewind the current volume,
36  * which we no longer want, and ask the user (console)
37  * to mount the next volume.
38  *
39  *  Continue trying until we get it, and then ensure
40  *  that we can write on it.
41  *
42  * This routine returns a 0 only if it is REALLY
43  *  impossible to get the requested Volume.
44  *
45  */
46 bool mount_next_write_volume(DCR *dcr, bool release)
47 {
48    int retry = 0;
49    bool ask = false, recycle, autochanger;
50    int vol_label_status;
51    DEVICE *dev = dcr->dev;
52    JCR *jcr = dcr->jcr;
53    DEV_BLOCK *block = dcr->block;
54
55    Dmsg0(100, "Enter mount_next_volume()\n");
56
57    init_dev_wait_timers(dev);
58
59    /*
60     * Attempt to mount the next volume. If something non-fatal goes
61     *  wrong, we come back here to re-try (new op messages, re-read
62     *  Volume, ...)
63     */
64 mount_next_vol:
65    /* Ignore retry if this is poll request */
66    if (!dev->poll && retry++ > 4) {
67       /* Last ditch effort before giving up, force operator to respond */
68       dcr->VolCatInfo.Slot = 0;
69       if (!dir_ask_sysop_to_mount_volume(dcr)) {
70          Jmsg(jcr, M_FATAL, 0, _("Too many errors trying to mount device %s.\n"),
71               dev_name(dev));
72          return false;
73       }
74    }
75    if (job_canceled(jcr)) {
76       Jmsg(jcr, M_FATAL, 0, _("Job %d canceled.\n"), jcr->JobId);
77       return false;
78    }
79    recycle = false;
80    if (release) {
81       Dmsg0(100, "mount_next_volume release=1\n");
82       release_volume(dcr);
83       ask = true;                     /* ask operator to mount tape */
84    }
85
86    /*
87     * Get Director's idea of what tape we should have mounted.
88     *    in dcr->VolCatInfo
89     */
90    Dmsg0(200, "Before dir_find_next_appendable_volume.\n");
91    while (!dir_find_next_appendable_volume(dcr)) {
92        Dmsg0(200, "not dir_find_next\n");
93        if (!dir_ask_sysop_to_create_appendable_volume(dcr)) {
94          return false;
95        }
96        Dmsg0(200, "Again dir_find_next_append...\n");
97    }
98    if (job_canceled(jcr)) {
99       return false;
100    }
101    Dmsg3(100, "After find_next_append. Vol=%s Slot=%d Parts=%d\n",
102          dcr->VolCatInfo.VolCatName, dcr->VolCatInfo.Slot, dcr->VolCatInfo.VolCatParts);
103    
104    dev->num_parts = dcr->VolCatInfo.VolCatParts;
105
106    /*
107     * Get next volume and ready it for append
108     * This code ensures that the device is ready for
109     * writing. We start from the assumption that there
110     * may not be a tape mounted.
111     *
112     * If the device is a file, we create the output
113     * file. If it is a tape, we check the volume name
114     * and move the tape to the end of data.
115     *
116     * It assumes that the device is not already in use!
117     *
118     */
119    if (autoload_device(dcr, 1, NULL) > 0) {
120       autochanger = true;
121       ask = false;
122    } else {
123       autochanger = false;
124       dcr->VolCatInfo.Slot = 0;
125    }
126    Dmsg1(100, "autoload_dev returns %d\n", autochanger);
127    /*
128     * If we autochanged to correct Volume or (we have not just
129     *   released the Volume AND we can automount) we go ahead
130     *   and read the label. If there is no tape in the drive,
131     *   we will err, recurse and ask the operator the next time.
132     */
133    if (!release && dev_is_tape(dev) && dev_cap(dev, CAP_AUTOMOUNT)) {
134       ask = false;                 /* don't ask SYSOP this time */
135    }
136    /* Don't ask if not removable */
137    if (!dev_cap(dev, CAP_REM)) {
138       ask = false;
139    }
140    Dmsg2(100, "Ask=%d autochanger=%d\n", ask, autochanger);
141    release = true;                /* release next time if we "recurse" */
142
143    if (ask && !dir_ask_sysop_to_mount_volume(dcr)) {
144       Dmsg0(100, "Error return ask_sysop ...\n");
145       return false;          /* error return */
146    }
147    if (job_canceled(jcr)) {
148       return false;
149    }
150    Dmsg1(100, "want vol=%s\n", dcr->VolumeName);
151
152    if (dev->poll && dev_cap(dev, CAP_CLOSEONPOLL)) {
153       force_close_dev(dev);
154    }
155
156    /* Ensure the device is open */
157    /* If we have a dvd that requires mount, we first want to guess
158     * which Volume is loaded, so we continue (if the wrong device is
159     * loaded, open_device would fail). */
160    if (!dev->is_dvd()) {
161       if (!open_device(dcr)) {
162          if (dev->poll) {
163             goto mount_next_vol;
164          } else {
165             return false;
166          }
167       }
168    } else {
169       /*
170        * Just copy the VolCatName in the device resource 
171        *   (usually done by open_dev).
172        * It is necessary so we can open the real files later.   
173        */
174       bstrncpy(dev->VolCatInfo.VolCatName, dcr->VolCatInfo.VolCatName, sizeof(dev->VolCatInfo.VolCatName));
175    }
176
177    /*
178     * Now make sure we have the right tape mounted
179     */
180 read_volume:
181    /*
182     * If we are writing to a stream device, ASSUME the volume label
183     *  is correct.
184     */
185    if (dev_cap(dev, CAP_STREAM)) {
186       vol_label_status = VOL_OK;
187       create_volume_label(dev, dcr->VolumeName, "Default");
188       dev->VolHdr.LabelType = PRE_LABEL;
189    } else if (dev->is_dvd()) {
190       vol_label_status = read_dev_volume_label_guess(dcr, 1);
191    } else {
192       vol_label_status = read_dev_volume_label(dcr);
193    }
194    if (job_canceled(jcr)) {
195       return false;
196    }
197
198    Dmsg2(100, "dirVol=%s dirStat=%s\n", dcr->VolumeName,
199       dcr->VolCatInfo.VolCatStatus);
200    /*
201     * At this point, dev->VolCatInfo has what is in the drive, if anything,
202     *          and   dcr->VolCatInfo has what the Director wants.
203     */
204    switch (vol_label_status) {
205    case VOL_OK:
206       Dmsg1(100, "Vol OK name=%s\n", dcr->VolumeName);
207       memcpy(&dev->VolCatInfo, &dcr->VolCatInfo, sizeof(dev->VolCatInfo));
208       recycle = strcmp(dev->VolCatInfo.VolCatStatus, "Recycle") == 0;
209       break;                    /* got a Volume */
210    case VOL_NAME_ERROR:
211       VOLUME_CAT_INFO VolCatInfo;
212
213       /* If not removable, Volume is broken */
214       if (!dev_cap(dev, CAP_REM)) {
215          Jmsg(jcr, M_WARNING, 0, _("Volume \"%s\" not on device %s.\n"),
216             dcr->VolumeName, dev_name(dev));
217          mark_volume_in_error(dcr);
218          goto mount_next_vol;
219       }
220
221       Dmsg1(100, "Vol NAME Error Name=%s\n", dcr->VolumeName);
222       /* If polling and got a previous bad name, ignore it */
223       if (dev->poll && strcmp(dev->BadVolName, dev->VolHdr.VolName) == 0) {
224          ask = true;
225          Dmsg1(200, "Vol Name error supress due to poll. Name=%s\n",
226             dcr->VolumeName);
227          goto mount_next_vol;
228       }
229       /*
230        * OK, we got a different volume mounted. First save the
231        *  requested Volume info (jcr) structure, then query if
232        *  this volume is really OK. If not, put back the desired
233        *  volume name and continue.
234        */
235       memcpy(&VolCatInfo, &dcr->VolCatInfo, sizeof(VolCatInfo));
236       /* Check if this is a valid Volume in the pool */
237       bstrncpy(dcr->VolumeName, dev->VolHdr.VolName, sizeof(dcr->VolumeName));
238       if (!dir_get_volume_info(dcr, GET_VOL_INFO_FOR_WRITE)) {
239          bstrncpy(dev->BadVolName, dev->VolHdr.VolName, sizeof(dev->BadVolName));
240          Jmsg(jcr, M_WARNING, 0, _("Director wanted Volume \"%s\".\n"
241               "    Current Volume \"%s\" not acceptable because:\n"
242               "    %s"),
243              VolCatInfo.VolCatName, dev->VolHdr.VolName,
244              jcr->dir_bsock->msg);
245          /* Restore desired volume name, note device info out of sync */
246          memcpy(&dcr->VolCatInfo, &VolCatInfo, sizeof(dcr->VolCatInfo));
247          ask = true;
248          goto mount_next_vol;
249       }
250       Dmsg1(100, "want new name=%s\n", dcr->VolumeName);
251       memcpy(&dev->VolCatInfo, &dcr->VolCatInfo, sizeof(dev->VolCatInfo));
252       recycle = strcmp(dev->VolCatInfo.VolCatStatus, "Recycle") == 0;
253       break;                /* got a Volume */
254    /*
255     * At this point, we assume we have a blank tape mounted.
256     */
257    case VOL_NO_LABEL:
258    case VOL_IO_ERROR:
259       /*
260        * If permitted, we label the device, make sure we can do
261        *   it by checking that the VolCatBytes is zero => not labeled,
262        *   once the Volume is labeled we don't want to label another
263        *   blank tape with the same name.  For disk, we go ahead and
264        *   label it anyway, because the OS insures that there is only
265        *   one Volume with that name.
266        * As noted above, at this point dcr->VolCatInfo has what
267        *   the Director wants and dev->VolCatInfo has info on the
268        *   previous tape (or nothing).
269        */
270       if (dev_cap(dev, CAP_LABEL) && (dcr->VolCatInfo.VolCatBytes == 0 ||
271             (!dev->is_tape() && strcmp(dcr->VolCatInfo.VolCatStatus,
272                                    "Recycle") == 0))) {
273          Dmsg0(100, "Create volume label\n");
274          /* Create a new Volume label and write it to the device */
275          if (!write_new_volume_label_to_dev(dcr, dcr->VolumeName,
276                 dcr->pool_name)) {
277             Dmsg0(100, "!write_vol_label\n");
278             goto mount_next_vol;
279          }
280          Dmsg0(100, "dir_update_vol_info. Set Append\n");
281          /* Copy Director's info into the device info */
282          memcpy(&dev->VolCatInfo, &dcr->VolCatInfo, sizeof(dev->VolCatInfo));
283          if (!dir_update_volume_info(dcr, true)) {  /* indicate tape labeled */
284             return false;
285          }
286          Jmsg(jcr, M_INFO, 0, _("Labeled new Volume \"%s\" on device %s.\n"),
287             dcr->VolumeName, dev_name(dev));
288          goto read_volume;      /* read label we just wrote */
289       }
290       /* If not removable, Volume is broken */
291       if (!dev_cap(dev, CAP_REM)) {
292          Jmsg(jcr, M_WARNING, 0, _("Volume \"%s\" not on device %s.\n"),
293             dcr->VolumeName, dev_name(dev));
294          mark_volume_in_error(dcr);
295          goto mount_next_vol;
296       }
297       /* NOTE! Fall-through wanted. */
298    case VOL_NO_MEDIA:
299    default:
300       /* Send error message */
301       if (!dev->poll) {
302          Jmsg(jcr, M_WARNING, 0, "%s", jcr->errmsg);
303       } else {
304          Dmsg1(200, "Msg suppressed by poll: %s\n", jcr->errmsg);
305       }
306       ask = true;
307       /* Needed, so the medium can be changed */
308       if (dev_cap(dev, CAP_REQMOUNT)) {
309          close_dev(dev);  
310       }
311       goto mount_next_vol;
312    }
313
314    /*
315     * See if we have a fresh tape or a tape with data.
316     *
317     * Note, if the LabelType is PRE_LABEL, it was labeled
318     *  but never written. If so, rewrite the label but set as
319     *  VOL_LABEL.  We rewind and return the label (reconstructed)
320     *  in the block so that in the case of a new tape, data can
321     *  be appended just after the block label.  If we are writing
322     *  a second volume, the calling routine will write the label
323     *  before writing the overflow block.
324     *
325     *  If the tape is marked as Recycle, we rewrite the label.
326     */
327    if (dev->VolHdr.LabelType == PRE_LABEL || recycle) {
328       if (!rewrite_volume_label(dcr, recycle)) {
329          goto mount_next_vol;
330       }
331    } else {
332       /*
333        * OK, at this point, we have a valid Bacula label, but
334        * we need to position to the end of the volume, since we are
335        * just now putting it into append mode.
336        */
337       Dmsg0(200, "Device previously written, moving to end of data\n");
338       Jmsg(jcr, M_INFO, 0, _("Volume \"%s\" previously written, moving to end of data.\n"),
339          dcr->VolumeName);
340       if (!eod_dev(dev)) {
341          Jmsg(jcr, M_ERROR, 0, _("Unable to position to end of data on device \"%s\". ERR=%s\n"),
342             dev_name(dev), strerror_dev(dev));
343          mark_volume_in_error(dcr);
344          goto mount_next_vol;
345       }
346       /* *****FIXME**** we should do some checking for files too */
347       if (dev_is_tape(dev)) {
348          /*
349           * Check if we are positioned on the tape at the same place
350           * that the database says we should be.
351           */
352          if (dev->VolCatInfo.VolCatFiles == dev_file(dev)) {
353             Jmsg(jcr, M_INFO, 0, _("Ready to append to end of Volume \"%s\" at file=%d.\n"),
354                  dcr->VolumeName, dev_file(dev));
355          } else {
356             Jmsg(jcr, M_ERROR, 0, _("I canot write on Volume \"%s\" because:\n"
357 "The number of files mismatch! Volume=%u Catalog=%u\n"),
358                  dcr->VolumeName, dev_file(dev), dev->VolCatInfo.VolCatFiles);
359             mark_volume_in_error(dcr);
360             goto mount_next_vol;
361          }
362       }
363       dev->VolCatInfo.VolCatMounts++;      /* Update mounts */
364       Dmsg1(100, "update volinfo mounts=%d\n", dev->VolCatInfo.VolCatMounts);
365       if (!dir_update_volume_info(dcr, false)) {
366          return false;
367       }
368       /* Return an empty block */
369       empty_block(block);             /* we used it for reading so set for write */
370    }
371    dev->state |= ST_APPEND;
372    Dmsg0(100, "set APPEND, normal return from read_dev_for_append\n");
373    return true;
374 }
375
376
377
378 /*
379  * Mark volume in error in catalog
380  */
381 void mark_volume_in_error(DCR *dcr)
382 {
383    DEVICE *dev = dcr->dev;
384    Jmsg(dcr->jcr, M_INFO, 0, _("Marking Volume \"%s\" in Error in Catalog.\n"),
385         dcr->VolumeName);
386    bstrncpy(dev->VolCatInfo.VolCatStatus, "Error", sizeof(dev->VolCatInfo.VolCatStatus));
387    Dmsg0(100, "dir_update_vol_info. Set Error.\n");
388    dir_update_volume_info(dcr, false);
389 }
390
391 /*
392  * If we are reading, we come here at the end of the tape
393  *  and see if there are more volumes to be mounted.
394  */
395 bool mount_next_read_volume(DCR *dcr)
396 {
397    DEVICE *dev = dcr->dev;
398    JCR *jcr = dcr->jcr;
399    Dmsg2(90, "NumVolumes=%d CurVolume=%d\n", jcr->NumVolumes, jcr->CurVolume);
400    /*
401     * End Of Tape -- mount next Volume (if another specified)
402     */
403    if (jcr->NumVolumes > 1 && jcr->CurVolume < jcr->NumVolumes) {
404       close_dev(dev);
405       dev->state &= ~ST_READ;
406       if (!acquire_device_for_read(jcr, dev)) {
407          Jmsg2(jcr, M_FATAL, 0, "Cannot open Dev=%s, Vol=%s\n", dev_name(dev),
408                dcr->VolumeName);
409          return false;
410       }
411       return true;                    /* next volume mounted */
412    }
413    Dmsg0(90, "End of Device reached.\n");
414    return false;
415 }
416
417 /*
418  * Either because we are going to hang a new volume, or because
419  *  of explicit user request, we release the current volume.
420  */
421 void release_volume(DCR *dcr)
422 {
423    JCR *jcr = dcr->jcr;
424    DEVICE *dev = dcr->dev;
425    if (dcr->WroteVol) {
426       Jmsg0(jcr, M_ERROR, 0, "Hey!!!!! WroteVol non-zero !!!!!\n");
427       Dmsg0(190, "Hey!!!!! WroteVol non-zero !!!!!\n");
428    }
429    /*
430     * First erase all memory of the current volume
431     */
432    dev->block_num = dev->file = 0;
433    dev->EndBlock = dev->EndFile = 0;
434    memset(&dev->VolCatInfo, 0, sizeof(dev->VolCatInfo));
435    memset(&dcr->VolCatInfo, 0, sizeof(dcr->VolCatInfo));
436    memset(&dev->VolHdr, 0, sizeof(dev->VolHdr));
437    /* Force re-read of label */
438    dev->state &= ~(ST_LABEL|ST_READ|ST_APPEND);
439    dev->label_type = B_BACULA_LABEL;
440    dcr->VolumeName[0] = 0;
441
442    if (dev->is_open() && (!dev->is_tape() || !dev_cap(dev, CAP_ALWAYSOPEN))) {
443       offline_or_rewind_dev(dev);
444       close_dev(dev);
445    }
446
447    /* If we have not closed the device, then at least rewind the tape */
448    if (dev->is_open()) {
449       offline_or_rewind_dev(dev);
450    }
451    Dmsg0(190, "===== release_volume ---");
452 }