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