]> git.sur5r.net Git - bacula/bacula/blob - bacula/src/stored/device.c
More dcr updates
[bacula/bacula] / bacula / src / stored / device.c
1 /*
2  *
3  *  Higher Level Device routines. 
4  *  Knows about Bacula tape labels and such  
5  *
6  *  NOTE! In general, subroutines that have the word
7  *        "device" in the name do locking.  Subroutines
8  *        that have the word "dev" in the name do not
9  *        do locking.  Thus if xxx_device() calls
10  *        yyy_dev(), all is OK, but if xxx_device()
11  *        calls yyy_device(), everything will hang.
12  *        Obviously, no zzz_dev() is allowed to call
13  *        a www_device() or everything falls apart. 
14  *
15  * Concerning the routines lock_device() and block_device()
16  *  see the end of this module for details.  In general,
17  *  blocking a device leaves it in a state where all threads
18  *  other than the current thread block when they attempt to 
19  *  lock the device. They remain suspended (blocked) until the device
20  *  is unblocked. So, a device is blocked during an operation
21  *  that takes a long time (initialization, mounting a new
22  *  volume, ...) locking a device is done for an operation
23  *  that takes a short time such as writing data to the   
24  *  device.
25  *
26  *
27  *   Kern Sibbald, MM, MMI
28  *                            
29  *   Version $Id$
30  */
31 /*
32    Copyright (C) 2000-2004 Kern Sibbald and John Walker
33
34    This program is free software; you can redistribute it and/or
35    modify it under the terms of the GNU General Public License as
36    published by the Free Software Foundation; either version 2 of
37    the License, or (at your option) any later version.
38
39    This program is distributed in the hope that it will be useful,
40    but WITHOUT ANY WARRANTY; without even the implied warranty of
41    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
42    General Public License for more details.
43
44    You should have received a copy of the GNU General Public
45    License along with this program; if not, write to the Free
46    Software Foundation, Inc., 59 Temple Place - Suite 330, Boston,
47    MA 02111-1307, USA.
48
49  */
50
51 #include "bacula.h"                   /* pull in global headers */
52 #include "stored.h"                   /* pull in Storage Deamon headers */
53
54 /* Forward referenced functions */
55
56 extern char my_name[];
57 extern int debug_level;
58
59 /*
60  * This is the dreaded moment. We either have an end of
61  * medium condition or worse, and error condition.
62  * Attempt to "recover" by obtaining a new Volume.
63  *
64  * Here are a few things to know:
65  *  jcr->VolCatInfo contains the info on the "current" tape for this job.
66  *  dev->VolCatInfo contains the info on the tape in the drive.
67  *    The tape in the drive could have changed several times since 
68  *    the last time the job used it (jcr->VolCatInfo).
69  *  jcr->VolumeName is the name of the current/desired tape in the drive.
70  *
71  * We enter with device locked, and 
72  *     exit with device locked.
73  *
74  * Note, we are called only from one place in block.c
75  *
76  *  Returns: true  on success
77  *           false on failure
78  */
79 bool fixup_device_block_write_error(DCR *dcr, DEV_BLOCK *block)
80 {
81    uint32_t stat;
82    char PrevVolName[MAX_NAME_LENGTH];
83    DEV_BLOCK *label_blk;
84    char b1[30], b2[30];
85    time_t wait_time;
86    char dt[MAX_TIME_LENGTH];
87    JCR *jcr = dcr->jcr;
88    DEVICE *dev = dcr->dev;
89
90    wait_time = time(NULL);
91    stat = status_dev(dev);
92    if (!(stat & BMT_EOD)) {
93       return false;                    /* this really shouldn't happen */
94    }
95
96    Dmsg0(100, "======= Got EOD ========\n");
97
98    block_device(dev, BST_DOING_ACQUIRE);
99    /* Unlock, but leave BLOCKED */
100    unlock_device(dev);
101
102    /* Create a jobmedia record for this job */
103    if (!dir_create_jobmedia_record(jcr)) {
104        Jmsg(jcr, M_ERROR, 0, _("Could not create JobMedia record for Volume=\"%s\" Job=%s\n"),
105             jcr->VolCatInfo.VolCatName, jcr->Job);
106        P(dev->mutex);
107        unblock_device(dev);
108        return false;
109    }
110
111    bstrncpy(dev->VolCatInfo.VolCatStatus, "Full", sizeof(dev->VolCatInfo.VolCatStatus));
112    Dmsg2(100, "Call update_vol_info Stat=%s Vol=%s\n", 
113       dev->VolCatInfo.VolCatStatus, dev->VolCatInfo.VolCatName);
114    dev->VolCatInfo.VolCatFiles = dev->file;   /* set number of files */
115    dev->VolCatInfo.VolCatJobs++;              /* increment number of jobs */
116    if (!dir_update_volume_info(jcr, false)) {    /* send Volume info to Director */
117       P(dev->mutex);
118       unblock_device(dev);
119       return false;                /* device locked */
120    }
121    Dmsg0(100, "Back from update_vol_info\n");
122
123    bstrncpy(PrevVolName, dev->VolCatInfo.VolCatName, sizeof(PrevVolName));
124    bstrncpy(dev->VolHdr.PrevVolName, PrevVolName, sizeof(dev->VolHdr.PrevVolName));
125
126    label_blk = new_block(dev);
127
128    /* Inform User about end of medium */
129    Jmsg(jcr, M_INFO, 0, _("End of medium on Volume \"%s\" Bytes=%s Blocks=%s at %s.\n"), 
130         PrevVolName, edit_uint64_with_commas(dev->VolCatInfo.VolCatBytes, b1),
131         edit_uint64_with_commas(dev->VolCatInfo.VolCatBlocks, b2),
132         bstrftime(dt, sizeof(dt), time(NULL)));
133
134    if (!mount_next_write_volume(dcr, label_blk, 1)) {
135       free_block(label_blk);
136       P(dev->mutex);
137       unblock_device(dev);
138       return false;                /* device locked */
139    }
140    P(dev->mutex);                  /* lock again */
141
142    Jmsg(jcr, M_INFO, 0, _("New volume \"%s\" mounted on device %s at %s.\n"),
143       jcr->VolumeName, dev_name(dev), bstrftime(dt, sizeof(dt), time(NULL)));
144
145    /* 
146     * If this is a new tape, the label_blk will contain the
147     *  label, so write it now. If this is a previously
148     *  used tape, mount_next_write_volume() will return an
149     *  empty label_blk, and nothing will be written.
150     */
151    Dmsg0(190, "write label block to dev\n");
152    if (!write_block_to_dev(dcr, label_blk)) {
153       Pmsg1(0, "write_block_to_device Volume label failed. ERR=%s",
154         strerror_dev(dev));
155       free_block(label_blk);
156       unblock_device(dev);
157       return false;                /* device locked */
158    }
159    free_block(label_blk);
160
161    /* 
162     * Walk through all attached jcrs indicating the volume has changed   
163     */
164    Dmsg1(100, "Walk attached jcrs. Volume=%s\n", dev->VolCatInfo.VolCatName);
165    for (JCR *mjcr=NULL; (mjcr=next_attached_jcr(dev, mjcr)); ) {
166       if (mjcr->JobId == 0) {
167          continue;                 /* ignore console */
168       }
169       mjcr->dcr->NewVol = true;
170       if (jcr != mjcr) {
171          pm_strcpy(&mjcr->VolumeName, jcr->VolumeName);  /* get a copy of the new volume */
172          bstrncpy(mjcr->dcr->VolumeName, jcr->VolumeName, sizeof(mjcr->dcr->VolumeName));
173       }
174    }
175
176    /* Clear NewVol now because dir_get_volume_info() already done */
177    jcr->dcr->NewVol = false;
178    set_new_volume_parameters(jcr, dev);
179
180    jcr->run_time += time(NULL) - wait_time; /* correct run time for mount wait */
181
182    /* Write overflow block to device */
183    Dmsg0(190, "Write overflow block to dev\n");
184    if (!write_block_to_dev(dcr, block)) {
185       Pmsg1(0, "write_block_to_device overflow block failed. ERR=%s",
186         strerror_dev(dev));
187       unblock_device(dev);
188       return false;                /* device locked */
189    }
190
191    unblock_device(dev);
192    return true;                             /* device locked */
193 }
194
195 /*
196  * We have a new Volume mounted, so reset the Volume parameters
197  *  concerning this job.  The global changes were made earlier
198  *  in the dev structure.
199  */
200 void set_new_volume_parameters(JCR *jcr, DEVICE *dev) 
201 {
202    DCR *dcr = jcr->dcr;
203    if (dcr->NewVol && !dir_get_volume_info(jcr, GET_VOL_INFO_FOR_WRITE)) {
204       Jmsg1(jcr, M_ERROR, 0, "%s", jcr->errmsg);
205    }
206    /* Set new start/end positions */
207    if (dev_state(dev, ST_TAPE)) {
208       dcr->StartBlock = dev->block_num;
209       dcr->StartFile = dev->file;
210    } else {
211       dcr->StartBlock = (uint32_t)dev->file_addr;
212       dcr->StartFile  = (uint32_t)(dev->file_addr >> 32);
213    }
214    /* Reset indicies */
215    dcr->VolFirstIndex = 0;
216    dcr->VolLastIndex = 0;
217    jcr->NumVolumes++;
218    dcr->NewVol = false;
219    dcr->WroteVol = false;
220 }
221
222 /*
223  * We are now in a new Volume file, so reset the Volume parameters
224  *  concerning this job.  The global changes were made earlier
225  *  in the dev structure.
226  */
227 void set_new_file_parameters(JCR *jcr, DEVICE *dev) 
228 {
229    DCR *dcr = jcr->dcr;
230     
231    /* Set new start/end positions */
232    if (dev_state(dev, ST_TAPE)) {
233       dcr->StartBlock = dev->block_num;
234       dcr->StartFile = dev->file;
235    } else {
236       dcr->StartBlock = (uint32_t)dev->file_addr;
237       dcr->StartFile  = (uint32_t)(dev->file_addr >> 32);
238    }
239    /* Reset indicies */
240    dcr->VolFirstIndex = 0;
241    dcr->VolLastIndex = 0;
242    dcr->NewFile = false;
243    dcr->WroteVol = false;
244 }
245
246
247
248 /*
249  *   First Open of the device. Expect dev to already be initialized.  
250  *
251  *   This routine is used only when the Storage daemon starts 
252  *   and always_open is set, and in the stand-alone utility
253  *   routines such as bextract.
254  *
255  *   Note, opening of a normal file is deferred to later so
256  *    that we can get the filename; the device_name for
257  *    a file is the directory only. 
258  *
259  *   Retuns: 0 on failure
260  *           1 on success
261  */
262 int first_open_device(DEVICE *dev)
263 {
264    Dmsg0(120, "start open_output_device()\n");
265    if (!dev) {
266       return 0;
267    }
268
269    lock_device(dev);
270
271    /* Defer opening files */
272    if (!dev_is_tape(dev)) {
273       Dmsg0(129, "Device is file, deferring open.\n");
274       unlock_device(dev);
275       return 1;
276    }
277
278    if (!(dev->state & ST_OPENED)) {
279        int mode;
280        if (dev_cap(dev, CAP_STREAM)) {
281           mode = OPEN_WRITE_ONLY;
282        } else {
283           mode = OPEN_READ_WRITE;
284        }
285       Dmsg0(129, "Opening device.\n");
286       if (open_dev(dev, NULL, mode) < 0) {
287          Emsg1(M_FATAL, 0, _("dev open failed: %s\n"), dev->errmsg);
288          unlock_device(dev);
289          return 0;
290       }
291    }
292    Dmsg1(129, "open_dev %s OK\n", dev_name(dev));
293
294    unlock_device(dev);
295    return 1;
296 }
297
298 /* 
299  * Make sure device is open, if not do so 
300  */
301 int open_device(JCR *jcr, DEVICE *dev)
302 {
303    /* Open device */
304    if  (!(dev_state(dev, ST_OPENED))) {
305        int mode;
306        if (dev_cap(dev, CAP_STREAM)) {
307           mode = OPEN_WRITE_ONLY;
308        } else {
309           mode = OPEN_READ_WRITE;
310        }
311        if (open_dev(dev, jcr->VolCatInfo.VolCatName, mode) < 0) {
312           Jmsg2(jcr, M_FATAL, 0, _("Unable to open device %s. ERR=%s\n"), 
313              dev_name(dev), strerror_dev(dev));
314           return 0;
315        }
316    }
317    return 1;
318 }
319
320 /* 
321  * When dev_blocked is set, all threads EXCEPT thread with id no_wait_id
322  * must wait. The no_wait_id thread is out obtaining a new volume
323  * and preparing the label.
324  */
325 void _lock_device(const char *file, int line, DEVICE *dev)
326 {
327    int stat;
328    Dmsg3(500, "lock %d from %s:%d\n", dev->dev_blocked, file, line);
329    P(dev->mutex);
330    if (dev->dev_blocked && !pthread_equal(dev->no_wait_id, pthread_self())) {
331       dev->num_waiting++;             /* indicate that I am waiting */
332       while (dev->dev_blocked) {
333          if ((stat = pthread_cond_wait(&dev->wait, &dev->mutex)) != 0) {
334             V(dev->mutex);
335             Emsg1(M_ABORT, 0, _("pthread_cond_wait failure. ERR=%s\n"),
336                strerror(stat));
337          }
338       }
339       dev->num_waiting--;             /* no longer waiting */
340    }
341 }
342
343 /*
344  * Check if the device is blocked or not
345  */
346 int device_is_unmounted(DEVICE *dev)
347 {
348    int stat;
349    P(dev->mutex);
350    stat = (dev->dev_blocked == BST_UNMOUNTED) ||
351           (dev->dev_blocked == BST_UNMOUNTED_WAITING_FOR_SYSOP);
352    V(dev->mutex);
353    return stat;
354 }
355
356 void _unlock_device(const char *file, int line, DEVICE *dev) 
357 {
358    Dmsg2(500, "unlock from %s:%d\n", file, line);
359    V(dev->mutex);
360 }
361
362 /* 
363  * Block all other threads from using the device
364  *  Device must already be locked.  After this call,
365  *  the device is blocked to any thread calling lock_device(),
366  *  but the device is not locked (i.e. no P on device).  Also,
367  *  the current thread can do slip through the lock_device()
368  *  calls without blocking.
369  */
370 void _block_device(const char *file, int line, DEVICE *dev, int state)
371 {
372    Dmsg3(500, "block set %d from %s:%d\n", state, file, line);
373    ASSERT(dev->dev_blocked == BST_NOT_BLOCKED);
374    dev->dev_blocked = state;          /* make other threads wait */
375    dev->no_wait_id = pthread_self();  /* allow us to continue */
376 }
377
378
379
380 /*
381  * Unblock the device, and wake up anyone who went to sleep.
382  */
383 void _unblock_device(const char *file, int line, DEVICE *dev)
384 {
385    Dmsg3(500, "unblock %d from %s:%d\n", dev->dev_blocked, file, line);
386    ASSERT(dev->dev_blocked);
387    dev->dev_blocked = BST_NOT_BLOCKED;
388    dev->no_wait_id = 0;
389    if (dev->num_waiting > 0) {
390       pthread_cond_broadcast(&dev->wait); /* wake them up */
391    }
392 }
393
394 /*
395  * Enter with device locked and blocked
396  * Exit with device unlocked and blocked by us.
397  */
398 void _steal_device_lock(const char *file, int line, DEVICE *dev, bsteal_lock_t *hold, int state)
399 {
400    Dmsg4(500, "steal lock. old=%d new=%d from %s:%d\n", dev->dev_blocked, state,
401       file, line);
402    hold->dev_blocked = dev->dev_blocked;
403    hold->dev_prev_blocked = dev->dev_prev_blocked;
404    hold->no_wait_id = dev->no_wait_id;
405    dev->dev_blocked = state;
406    dev->no_wait_id = pthread_self();
407    V(dev->mutex);
408 }
409
410 /*
411  * Enter with device blocked by us but not locked
412  * Exit with device locked, and blocked by previous owner 
413  */
414 void _give_back_device_lock(const char *file, int line, DEVICE *dev, bsteal_lock_t *hold)             
415 {
416    Dmsg4(500, "return lock. old=%d new=%d from %s:%d\n", 
417       dev->dev_blocked, hold->dev_blocked, file, line);
418    P(dev->mutex);
419    dev->dev_blocked = hold->dev_blocked;
420    dev->dev_prev_blocked = hold->dev_prev_blocked;
421    dev->no_wait_id = hold->no_wait_id;
422    if (dev->dev_blocked == BST_NOT_BLOCKED && dev->num_waiting > 0) {
423       pthread_cond_broadcast(&dev->wait); /* wake them up */
424    }
425 }