]> git.sur5r.net Git - bacula/bacula/blob - bacula/src/stored/device.c
Update doc
[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: 1 on success
77  *           0 on failure
78  */
79 int fixup_device_block_write_error(JCR *jcr, DEVICE *dev, 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
88    wait_time = time(NULL);
89    stat = status_dev(dev);
90    if (!(stat & BMT_EOD)) {
91       return 0;                       /* this really shouldn't happen */
92    }
93
94    Dmsg0(100, "======= Got EOD ========\n");
95
96    block_device(dev, BST_DOING_ACQUIRE);
97    /* Unlock, but leave BLOCKED */
98    unlock_device(dev);
99
100    /* Create a jobmedia record for this job */
101    if (!dir_create_jobmedia_record(jcr)) {
102        Jmsg(jcr, M_ERROR, 0, _("Could not create JobMedia record for Volume=\"%s\" Job=%s\n"),
103             jcr->VolCatInfo.VolCatName, jcr->Job);
104        P(dev->mutex);
105        unblock_device(dev);
106        return 0;
107    }
108
109    bstrncpy(dev->VolCatInfo.VolCatStatus, "Full", sizeof(dev->VolCatInfo.VolCatStatus));
110    Dmsg2(100, "Call update_vol_info Stat=%s Vol=%s\n", 
111       dev->VolCatInfo.VolCatStatus, dev->VolCatInfo.VolCatName);
112    dev->VolCatInfo.VolCatFiles = dev->file;   /* set number of files */
113    dev->VolCatInfo.VolCatJobs++;              /* increment number of jobs */
114    if (!dir_update_volume_info(jcr, dev, 0)) {    /* send Volume info to Director */
115       P(dev->mutex);
116       unblock_device(dev);
117       return 0;                    /* device locked */
118    }
119    Dmsg0(100, "Back from update_vol_info\n");
120
121    bstrncpy(PrevVolName, dev->VolCatInfo.VolCatName, sizeof(PrevVolName));
122    bstrncpy(dev->VolHdr.PrevVolName, PrevVolName, sizeof(dev->VolHdr.PrevVolName));
123
124    label_blk = new_block(dev);
125
126    /* Inform User about end of medium */
127    Jmsg(jcr, M_INFO, 0, _("End of medium on Volume \"%s\" Bytes=%s Blocks=%s at %s.\n"), 
128         PrevVolName, edit_uint64_with_commas(dev->VolCatInfo.VolCatBytes, b1),
129         edit_uint64_with_commas(dev->VolCatInfo.VolCatBlocks, b2),
130         bstrftime(dt, sizeof(dt), time(NULL)));
131
132    if (!mount_next_write_volume(jcr, dev, label_blk, 1)) {
133       free_block(label_blk);
134       P(dev->mutex);
135       unblock_device(dev);
136       return 0;                    /* device locked */
137    }
138    P(dev->mutex);                  /* lock again */
139
140    Jmsg(jcr, M_INFO, 0, _("New volume \"%s\" mounted on device %s at %s.\n"),
141       jcr->VolumeName, dev_name(dev), bstrftime(dt, sizeof(dt), time(NULL)));
142
143    /* 
144     * If this is a new tape, the label_blk will contain the
145     *  label, so write it now. If this is a previously
146     *  used tape, mount_next_write_volume() will return an
147     *  empty label_blk, and nothing will be written.
148     */
149    Dmsg0(190, "write label block to dev\n");
150    if (!write_block_to_dev(jcr->dcr, label_blk)) {
151       Pmsg1(0, "write_block_to_device Volume label failed. ERR=%s",
152         strerror_dev(dev));
153       free_block(label_blk);
154       unblock_device(dev);
155       return 0;                    /* device locked */
156    }
157    free_block(label_blk);
158
159    /* 
160     * Walk through all attached jcrs indicating the volume has changed   
161     */
162    Dmsg1(100, "Walk attached jcrs. Volume=%s\n", dev->VolCatInfo.VolCatName);
163    for (JCR *mjcr=NULL; (mjcr=next_attached_jcr(dev, mjcr)); ) {
164       if (mjcr->JobId == 0) {
165          continue;                 /* ignore console */
166       }
167       mjcr->dcr->NewVol = true;
168       if (jcr != mjcr) {
169          pm_strcpy(&mjcr->VolumeName, jcr->VolumeName);  /* get a copy of the new volume */
170          bstrncpy(mjcr->dcr->VolumeName, jcr->VolumeName, sizeof(mjcr->dcr->VolumeName));
171       }
172    }
173
174    /* Clear NewVol now because dir_get_volume_info() already done */
175    jcr->dcr->NewVol = false;
176    set_new_volume_parameters(jcr, dev);
177
178    jcr->run_time += time(NULL) - wait_time; /* correct run time for mount wait */
179
180    /* Write overflow block to device */
181    Dmsg0(190, "Write overflow block to dev\n");
182    if (!write_block_to_dev(jcr->dcr, block)) {
183       Pmsg1(0, "write_block_to_device overflow block failed. ERR=%s",
184         strerror_dev(dev));
185       unblock_device(dev);
186       return 0;                    /* device locked */
187    }
188
189    unblock_device(dev);
190    return 1;                                /* device locked */
191 }
192
193 /*
194  * We have a new Volume mounted, so reset the Volume parameters
195  *  concerning this job.  The global changes were made earlier
196  *  in the dev structure.
197  */
198 void set_new_volume_parameters(JCR *jcr, DEVICE *dev) 
199 {
200    DCR *dcr = jcr->dcr;
201    if (dcr->NewVol && !dir_get_volume_info(jcr, GET_VOL_INFO_FOR_WRITE)) {
202       Jmsg1(jcr, M_ERROR, 0, "%s", jcr->errmsg);
203    }
204    /* Set new start/end positions */
205    if (dev_state(dev, ST_TAPE)) {
206       dcr->StartBlock = dev->block_num;
207       dcr->StartFile = dev->file;
208    } else {
209       dcr->StartBlock = (uint32_t)dev->file_addr;
210       dcr->StartFile  = (uint32_t)(dev->file_addr >> 32);
211    }
212    /* Reset indicies */
213    dcr->VolFirstIndex = 0;
214    dcr->VolLastIndex = 0;
215    jcr->NumVolumes++;
216    dcr->NewVol = false;
217    dcr->WroteVol = false;
218 }
219
220 /*
221  * We are now in a new Volume file, so reset the Volume parameters
222  *  concerning this job.  The global changes were made earlier
223  *  in the dev structure.
224  */
225 void set_new_file_parameters(JCR *jcr, DEVICE *dev) 
226 {
227    DCR *dcr = jcr->dcr;
228     
229    /* Set new start/end positions */
230    if (dev_state(dev, ST_TAPE)) {
231       dcr->StartBlock = dev->block_num;
232       dcr->StartFile = dev->file;
233    } else {
234       dcr->StartBlock = (uint32_t)dev->file_addr;
235       dcr->StartFile  = (uint32_t)(dev->file_addr >> 32);
236    }
237    /* Reset indicies */
238    dcr->VolFirstIndex = 0;
239    dcr->VolLastIndex = 0;
240    dcr->NewFile = false;
241    dcr->WroteVol = false;
242 }
243
244
245
246 /*
247  *   First Open of the device. Expect dev to already be initialized.  
248  *
249  *   This routine is used only when the Storage daemon starts 
250  *   and always_open is set, and in the stand-alone utility
251  *   routines such as bextract.
252  *
253  *   Note, opening of a normal file is deferred to later so
254  *    that we can get the filename; the device_name for
255  *    a file is the directory only. 
256  *
257  *   Retuns: 0 on failure
258  *           1 on success
259  */
260 int first_open_device(DEVICE *dev)
261 {
262    Dmsg0(120, "start open_output_device()\n");
263    if (!dev) {
264       return 0;
265    }
266
267    lock_device(dev);
268
269    /* Defer opening files */
270    if (!dev_is_tape(dev)) {
271       Dmsg0(129, "Device is file, deferring open.\n");
272       unlock_device(dev);
273       return 1;
274    }
275
276    if (!(dev->state & ST_OPENED)) {
277        int mode;
278        if (dev_cap(dev, CAP_STREAM)) {
279           mode = OPEN_WRITE_ONLY;
280        } else {
281           mode = OPEN_READ_WRITE;
282        }
283       Dmsg0(129, "Opening device.\n");
284       if (open_dev(dev, NULL, mode) < 0) {
285          Emsg1(M_FATAL, 0, _("dev open failed: %s\n"), dev->errmsg);
286          unlock_device(dev);
287          return 0;
288       }
289    }
290    Dmsg1(129, "open_dev %s OK\n", dev_name(dev));
291
292    unlock_device(dev);
293    return 1;
294 }
295
296 /* 
297  * Make sure device is open, if not do so 
298  */
299 int open_device(JCR *jcr, DEVICE *dev)
300 {
301    /* Open device */
302    if  (!(dev_state(dev, ST_OPENED))) {
303        int mode;
304        if (dev_cap(dev, CAP_STREAM)) {
305           mode = OPEN_WRITE_ONLY;
306        } else {
307           mode = OPEN_READ_WRITE;
308        }
309        if (open_dev(dev, jcr->VolCatInfo.VolCatName, mode) < 0) {
310           Jmsg2(jcr, M_FATAL, 0, _("Unable to open device %s. ERR=%s\n"), 
311              dev_name(dev), strerror_dev(dev));
312           return 0;
313        }
314    }
315    return 1;
316 }
317
318 /* 
319  * When dev_blocked is set, all threads EXCEPT thread with id no_wait_id
320  * must wait. The no_wait_id thread is out obtaining a new volume
321  * and preparing the label.
322  */
323 void _lock_device(char *file, int line, DEVICE *dev)
324 {
325    int stat;
326    Dmsg3(500, "lock %d from %s:%d\n", dev->dev_blocked, file, line);
327    P(dev->mutex);
328    if (dev->dev_blocked && !pthread_equal(dev->no_wait_id, pthread_self())) {
329       dev->num_waiting++;             /* indicate that I am waiting */
330       while (dev->dev_blocked) {
331          if ((stat = pthread_cond_wait(&dev->wait, &dev->mutex)) != 0) {
332             V(dev->mutex);
333             Emsg1(M_ABORT, 0, _("pthread_cond_wait failure. ERR=%s\n"),
334                strerror(stat));
335          }
336       }
337       dev->num_waiting--;             /* no longer waiting */
338    }
339 }
340
341 /*
342  * Check if the device is blocked or not
343  */
344 int device_is_unmounted(DEVICE *dev)
345 {
346    int stat;
347    P(dev->mutex);
348    stat = (dev->dev_blocked == BST_UNMOUNTED) ||
349           (dev->dev_blocked == BST_UNMOUNTED_WAITING_FOR_SYSOP);
350    V(dev->mutex);
351    return stat;
352 }
353
354 void _unlock_device(char *file, int line, DEVICE *dev) 
355 {
356    Dmsg2(500, "unlock from %s:%d\n", file, line);
357    V(dev->mutex);
358 }
359
360 /* 
361  * Block all other threads from using the device
362  *  Device must already be locked.  After this call,
363  *  the device is blocked to any thread calling lock_device(),
364  *  but the device is not locked (i.e. no P on device).  Also,
365  *  the current thread can do slip through the lock_device()
366  *  calls without blocking.
367  */
368 void _block_device(char *file, int line, DEVICE *dev, int state)
369 {
370    Dmsg3(500, "block set %d from %s:%d\n", state, file, line);
371    ASSERT(dev->dev_blocked == BST_NOT_BLOCKED);
372    dev->dev_blocked = state;          /* make other threads wait */
373    dev->no_wait_id = pthread_self();  /* allow us to continue */
374 }
375
376
377
378 /*
379  * Unblock the device, and wake up anyone who went to sleep.
380  */
381 void _unblock_device(char *file, int line, DEVICE *dev)
382 {
383    Dmsg3(500, "unblock %d from %s:%d\n", dev->dev_blocked, file, line);
384    ASSERT(dev->dev_blocked);
385    dev->dev_blocked = BST_NOT_BLOCKED;
386    dev->no_wait_id = 0;
387    if (dev->num_waiting > 0) {
388       pthread_cond_broadcast(&dev->wait); /* wake them up */
389    }
390 }
391
392 /*
393  * Enter with device locked and blocked
394  * Exit with device unlocked and blocked by us.
395  */
396 void _steal_device_lock(char *file, int line, DEVICE *dev, bsteal_lock_t *hold, int state)
397 {
398    Dmsg4(500, "steal lock. old=%d new=%d from %s:%d\n", dev->dev_blocked, state,
399       file, line);
400    hold->dev_blocked = dev->dev_blocked;
401    hold->dev_prev_blocked = dev->dev_prev_blocked;
402    hold->no_wait_id = dev->no_wait_id;
403    dev->dev_blocked = state;
404    dev->no_wait_id = pthread_self();
405    V(dev->mutex);
406 }
407
408 /*
409  * Enter with device blocked by us but not locked
410  * Exit with device locked, and blocked by previous owner 
411  */
412 void _give_back_device_lock(char *file, int line, DEVICE *dev, bsteal_lock_t *hold)           
413 {
414    Dmsg4(500, "return lock. old=%d new=%d from %s:%d\n", 
415       dev->dev_blocked, hold->dev_blocked, file, line);
416    P(dev->mutex);
417    dev->dev_blocked = hold->dev_blocked;
418    dev->dev_prev_blocked = hold->dev_prev_blocked;
419    dev->no_wait_id = hold->no_wait_id;
420 }