]> git.sur5r.net Git - bacula/bacula/blob - bacula/src/stored/acquire.c
d670beba2c07d8bb9198f10d492fec97af7337c3
[bacula/bacula] / bacula / src / stored / acquire.c
1 /*
2    Bacula® - The Network Backup Solution
3
4    Copyright (C) 2002-2008 Free Software Foundation Europe e.V.
5
6    The main author of Bacula is Kern Sibbald, with contributions from
7    many others, a complete list can be found in the file AUTHORS.
8    This program is Free Software; you can redistribute it and/or
9    modify it under the terms of version two of the GNU General Public
10    License as published by the Free Software Foundation and included
11    in the file LICENSE.
12
13    This program is distributed in the hope that it will be useful, but
14    WITHOUT ANY WARRANTY; without even the implied warranty of
15    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16    General Public License for more details.
17
18    You should have received a copy of the GNU General Public License
19    along with this program; if not, write to the Free Software
20    Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
21    02110-1301, USA.
22
23    Bacula® is a registered trademark of John Walker.
24    The licensor of Bacula is the Free Software Foundation Europe
25    (FSFE), Fiduciary Program, Sumatrastrasse 25, 8006 Zürich,
26    Switzerland, email:ftf@fsfeurope.org.
27 */
28 /*
29  *  Routines to acquire and release a device for read/write
30  *
31  *   Kern Sibbald, August MMII
32  *
33  *   Version $Id$
34  */
35
36 #include "bacula.h"                   /* pull in global headers */
37 #include "stored.h"                   /* pull in Storage Deamon headers */
38
39 /* Forward referenced functions */
40 static void attach_dcr_to_dev(DCR *dcr);
41 static bool is_tape_position_ok(JCR *jcr, DEVICE *dev);
42
43
44 /*********************************************************************
45  * Acquire device for reading. 
46  *  The drive should have previously been reserved by calling 
47  *  reserve_device_for_read(). We read the Volume label from the block and
48  *  leave the block pointers just after the label.
49  *
50  *  Returns: NULL if failed for any reason
51  *           dcr  if successful
52  */
53 bool acquire_device_for_read(DCR *dcr)
54 {
55    DEVICE *dev = dcr->dev;
56    JCR *jcr = dcr->jcr;
57    bool ok = false;
58    bool tape_previously_mounted;
59    bool tape_initially_mounted;
60    VOL_LIST *vol;
61    bool try_autochanger = true;
62    int i;
63    int vol_label_status;
64    int retry = 0;
65    
66    Dmsg1(950, "jcr->dcr=%p\n", jcr->dcr);
67    dev->dblock(BST_DOING_ACQUIRE);
68
69    if (dev->num_writers > 0) {
70       Jmsg2(jcr, M_FATAL, 0, _("Acquire read: num_writers=%d not zero. Job %d canceled.\n"), 
71          dev->num_writers, jcr->JobId);
72       goto get_out;
73    }
74
75    /* Find next Volume, if any */
76    vol = jcr->VolList;
77    if (!vol) {
78       char ed1[50];
79       Jmsg(jcr, M_FATAL, 0, _("No volumes specified for reading. Job %s canceled.\n"), 
80          edit_int64(jcr->JobId, ed1));
81       goto get_out;
82    }
83    jcr->CurReadVolume++;
84    for (i=1; i<jcr->CurReadVolume; i++) {
85       vol = vol->next;
86    }
87    if (!vol) {
88       Jmsg(jcr, M_FATAL, 0, _("Logic error: no next volume to read. Numvol=%d Curvol=%d\n"),
89          jcr->NumReadVolumes, jcr->CurReadVolume);
90       goto get_out;                   /* should not happen */   
91    }
92    /*    
93     * Note, if we want to be able to work from a .bsr file only          
94     *  for disaster recovery, we must "simulate" reading the catalog
95     */
96    bstrncpy(dcr->VolumeName, vol->VolumeName, sizeof(dcr->VolumeName));
97    bstrncpy(dcr->VolCatInfo.VolCatName, vol->VolumeName, sizeof(dcr->VolCatInfo.VolCatName));
98    bstrncpy(dcr->media_type, vol->MediaType, sizeof(dcr->media_type));
99    dcr->VolCatInfo.Slot = vol->Slot;
100    dcr->VolCatInfo.InChanger = vol->Slot > 0; 
101    if (reserve_volume(dcr, dcr->VolumeName) == NULL) {
102       Dmsg2(100, "Could not reserve volume %s on %s\n", dcr->VolumeName,
103             dcr->dev->print_name());
104       Jmsg2(jcr, M_FATAL, 0, _("Could not reserve volume %s on %s\n"), dcr->VolumeName,
105             dcr->dev->print_name());
106       goto get_out;
107    }
108    if (dev->vol && dev->vol->is_swapping()) {
109       dev->vol->set_slot(vol->Slot);
110       Dmsg3(100, "swapping: slot=%d Vol=%s dev=%s\n", dev->vol->get_slot(),
111          dev->vol->vol_name, dev->print_name());
112    }
113     
114    /*
115     * If the MediaType requested for this volume is not the
116     *  same as the current drive, we attempt to find the same
117     *  device that was used to write the orginal volume.  If
118     *  found, we switch to using that device.
119     *
120     *  N.B. A lot of routines rely on the dcr pointer not changing
121     *    read_records.c even has multiple dcrs cached, so we take care
122     *    here to release all important parts of the dcr and re-acquire
123     *    them such as the block pointer (size may change), but we do
124     *    not release the dcr.
125     */
126    Dmsg2(50, "MediaType dcr=%s dev=%s\n", dcr->media_type, dev->device->media_type);
127    if (dcr->media_type[0] && strcmp(dcr->media_type, dev->device->media_type) != 0) {
128       RCTX rctx;
129       DIRSTORE *store;
130       int stat;
131
132       Jmsg3(jcr, M_INFO, 0, _("Changing device. Want Media Type=\"%s\" have=\"%s\"\n"
133                               "  device=%s\n"), 
134             dcr->media_type, dev->device->media_type, dev->print_name());
135       Dmsg3(50, "Changing device. Want Media Type=\"%s\" have=\"%s\"\n"
136                               "  device=%s\n", 
137             dcr->media_type, dev->device->media_type, dev->print_name());
138
139       dev->dunblock(DEV_UNLOCKED);
140
141       lock_reservations();
142       memset(&rctx, 0, sizeof(RCTX));
143       rctx.jcr = jcr;
144       jcr->reserve_msgs = New(alist(10, not_owned_by_alist));
145       rctx.any_drive = true;
146       rctx.device_name = vol->device;
147       store = new DIRSTORE;
148       memset(store, 0, sizeof(DIRSTORE));
149       store->name[0] = 0; /* No dir name */
150       bstrncpy(store->media_type, vol->MediaType, sizeof(store->media_type));
151       bstrncpy(store->pool_name, dcr->pool_name, sizeof(store->pool_name));
152       bstrncpy(store->pool_type, dcr->pool_type, sizeof(store->pool_type));
153       store->append = false;
154       rctx.store = store;
155       clean_device(dcr);                     /* clean up the dcr */
156       
157       /*
158        * Search for a new device
159        */
160       stat = search_res_for_device(rctx);
161       release_reserve_messages(jcr);         /* release queued messages */
162       unlock_reservations();
163
164       if (stat == 1) {
165          dev = dcr->dev;                     /* get new device pointer */
166          dev->dblock(BST_DOING_ACQUIRE); 
167          dcr->VolumeName[0] = 0;
168          Jmsg(jcr, M_INFO, 0, _("Media Type change.  New device %s chosen.\n"),
169             dev->print_name());
170          Dmsg1(50, "Media Type change.  New device %s chosen.\n", dev->print_name());
171
172          bstrncpy(dcr->VolumeName, vol->VolumeName, sizeof(dcr->VolumeName));
173          bstrncpy(dcr->media_type, vol->MediaType, sizeof(dcr->media_type));
174          dcr->VolCatInfo.Slot = vol->Slot;
175          bstrncpy(dcr->pool_name, store->pool_name, sizeof(dcr->pool_name));
176          bstrncpy(dcr->pool_type, store->pool_type, sizeof(dcr->pool_type));
177       } else {
178          /* error */
179          Jmsg1(jcr, M_FATAL, 0, _("No suitable device found to read Volume \"%s\"\n"),
180             vol->VolumeName);
181          Dmsg1(50, "No suitable device found to read Volume \"%s\"\n", vol->VolumeName);
182          goto get_out;
183       }
184    }
185
186
187    init_device_wait_timers(dcr);
188
189    tape_previously_mounted = dev->can_read() || dev->can_append() ||
190                              dev->is_labeled();
191    tape_initially_mounted = tape_previously_mounted;
192
193
194    /* Volume info is always needed because of VolParts */
195    Dmsg0(200, "dir_get_volume_info\n");
196    if (!dir_get_volume_info(dcr, GET_VOL_INFO_FOR_READ)) {
197       Jmsg1(jcr, M_WARNING, 0, "%s", jcr->errmsg);
198    }
199    
200    for ( ;; ) {
201       /* If not polling limit retries */
202       if (!dev->poll && retry++ > 10) {
203          break;
204       }
205       dev->clear_labeled();              /* force reread of label */
206       if (job_canceled(jcr)) {
207          char ed1[50];
208          Mmsg1(dev->errmsg, _("Job %s canceled.\n"), edit_int64(jcr->JobId, ed1));
209          Jmsg(jcr, M_INFO, 0, dev->errmsg);
210          goto get_out;                /* error return */
211       }
212
213       dcr->do_swapping(false/*is_writing*/);
214
215       /*
216        * This code ensures that the device is ready for
217        * reading. If it is a file, it opens it.
218        * If it is a tape, it checks the volume name
219        */
220       Dmsg1(100, "bstored: open vol=%s\n", dcr->VolumeName);
221       if (dev->open(dcr, OPEN_READ_ONLY) < 0) {
222          if (!dev->poll) {
223             Jmsg3(jcr, M_WARNING, 0, _("Read open device %s Volume \"%s\" failed: ERR=%s\n"),
224                   dev->print_name(), dcr->VolumeName, dev->bstrerror());
225          }
226          goto default_path;
227       }
228       Dmsg1(50, "opened dev %s OK\n", dev->print_name());
229       
230       /* Read Volume Label */
231       Dmsg0(50, "calling read-vol-label\n");
232       vol_label_status = read_dev_volume_label(dcr);
233       switch (vol_label_status) {
234       case VOL_OK:
235          ok = true;
236          memcpy(&dev->VolCatInfo, &dcr->VolCatInfo, sizeof(dev->VolCatInfo));
237          break;                    /* got it */
238       case VOL_IO_ERROR:
239          /*
240           * Send error message generated by read_dev_volume_label()
241           *  only we really had a tape mounted. This supresses superfluous
242           *  error messages when nothing is mounted.
243           */
244          if (tape_previously_mounted) {
245             Jmsg(jcr, M_WARNING, 0, "%s", jcr->errmsg);
246          }
247          goto default_path;
248       case VOL_NAME_ERROR:
249          if (tape_initially_mounted) {
250             tape_initially_mounted = false;
251             goto default_path;
252          }
253          /* If polling and got a previous bad name, ignore it */
254          if (dev->poll && strcmp(dev->BadVolName, dev->VolHdr.VolumeName) == 0) {
255             goto default_path;
256          } else {
257              bstrncpy(dev->BadVolName, dev->VolHdr.VolumeName, sizeof(dev->BadVolName));
258          }
259          if (!unload_autochanger(dcr, -1)) {
260             /* at least free the device so we can re-open with correct volume */
261             dev->close();                                                          
262          }
263          /* Fall through */
264       default:
265          Jmsg1(jcr, M_WARNING, 0, "%s", jcr->errmsg);
266 default_path:
267          tape_previously_mounted = true;
268          
269          /*
270           * If the device requires mount, close it, so the device can be ejected.
271           */
272          if (dev->requires_mount()) {
273             dev->close();
274          }
275          
276          /* Call autochanger only once unless ask_sysop called */
277          if (try_autochanger) {
278             int stat;
279             Dmsg2(200, "calling autoload Vol=%s Slot=%d\n",
280                dcr->VolumeName, dcr->VolCatInfo.Slot);
281             stat = autoload_device(dcr, 0, NULL);
282             if (stat > 0) {
283                try_autochanger = false;
284                continue;              /* try reading volume mounted */
285             }
286             /* Try closing and re-opening */
287             dev->close();
288             dev->clear_unload();
289             if (dev->open(dcr, OPEN_READ_ONLY) >= 0) {
290                continue;
291             }
292             if (!dev->poll) {
293                Jmsg3(jcr, M_WARNING, 0, _("Read open device %s Volume \"%s\" failed: ERR=%s\n"),
294                      dev->print_name(), dcr->VolumeName, dev->bstrerror());
295             }
296          }
297          
298          /* Mount a specific volume and no other */
299          Dmsg0(200, "calling dir_ask_sysop\n");
300          if (!dir_ask_sysop_to_mount_volume(dcr, ST_READ)) {
301             goto get_out;             /* error return */
302          }
303          try_autochanger = true;      /* permit using autochanger again */
304          continue;                    /* try reading again */
305       } /* end switch */
306       break;
307    } /* end for loop */
308    if (!ok) {
309       Jmsg1(jcr, M_FATAL, 0, _("Too many errors trying to mount device %s for reading.\n"),
310             dev->print_name());
311       goto get_out;
312    }
313
314    dev->clear_append();
315    dev->set_read();
316    set_jcr_job_status(jcr, JS_Running);
317    dir_send_job_status(jcr);
318    Jmsg(jcr, M_INFO, 0, _("Ready to read from volume \"%s\" on device %s.\n"),
319       dcr->VolumeName, dev->print_name());
320
321 get_out:
322    dev->dlock();
323    dcr->clear_reserved();
324    /* 
325     * Normally we are blocked, but in at least one error case above 
326     *   we are not blocked because we unsuccessfully tried changing
327     *   devices.  
328     */
329    if (dev->is_blocked()) {
330       dev->dunblock(DEV_LOCKED);
331    }
332    Dmsg1(950, "jcr->dcr=%p\n", jcr->dcr);
333    return ok;
334 }
335
336
337 /*
338  * Acquire device for writing. We permit multiple writers.
339  *  If this is the first one, we read the label.
340  *
341  *  Returns: NULL if failed for any reason
342  *           dcr if successful.
343  *   Note, normally reserve_device_for_append() is called
344  *   before this routine.
345  */
346 DCR *acquire_device_for_append(DCR *dcr)
347 {
348    DEVICE *dev = dcr->dev;
349    JCR *jcr = dcr->jcr;
350    bool ok = false;
351
352    init_device_wait_timers(dcr);
353
354    dev->dblock(BST_DOING_ACQUIRE);
355    Dmsg1(100, "acquire_append device is %s\n", dev->is_tape()?"tape":
356         (dev->is_dvd()?"DVD":"disk"));
357
358    /*
359     * With the reservation system, this should not happen
360     */
361    if (dev->can_read()) {
362       Jmsg1(jcr, M_FATAL, 0, _("Want to append, but device %s is busy reading.\n"), dev->print_name());
363       Dmsg1(200, "Want to append but device %s is busy reading.\n", dev->print_name());
364       goto get_out;
365    }
366
367    /*
368     * have_vol defines whether or not mount_next_write_volume should
369     *   ask the Director again about what Volume to use.
370     */
371    if (dev->can_append() && dcr->is_suitable_volume_mounted() &&
372        strcmp(dcr->VolCatInfo.VolCatStatus, "Recycle") != 0) {
373       Dmsg0(190, "device already in append.\n");
374       /*
375        * At this point, the correct tape is already mounted, so
376        *   we do not need to do mount_next_write_volume(), unless
377        *   we need to recycle the tape.
378        */
379        if (dev->num_writers == 0) {
380           memcpy(&dev->VolCatInfo, &dcr->VolCatInfo, sizeof(dev->VolCatInfo));
381        }
382        if (!is_tape_position_ok(jcr, dev)) {
383           goto get_out;
384        }
385    } else {
386       Dmsg1(190, "jid=%u Do mount_next_write_vol\n", (uint32_t)jcr->JobId);
387       if (!dcr->mount_next_write_volume()) {
388          if (!job_canceled(jcr)) {
389             /* Reduce "noise" -- don't print if job canceled */
390             Jmsg(jcr, M_FATAL, 0, _("Could not ready device %s for append.\n"),
391                dev->print_name());
392             Dmsg1(200, "Could not ready device %s for append.\n", 
393                dev->print_name());
394          }
395          goto get_out;
396       }
397       Dmsg2(190, "Output pos=%u:%u\n", dcr->dev->file, dcr->dev->block_num);
398    }
399
400    dev->num_writers++;                /* we are now a writer */
401    if (jcr->NumWriteVolumes == 0) {
402       jcr->NumWriteVolumes = 1;
403    }
404    dev->VolCatInfo.VolCatJobs++;              /* increment number of jobs on vol */
405    dir_update_volume_info(dcr, false, false); /* send Volume info to Director */
406    ok = true;
407
408 get_out:
409    dev->dlock();
410    dcr->clear_reserved();
411    dev->dunblock(DEV_LOCKED);
412    return ok ? dcr : NULL;
413 }
414
415 /*
416  *      Insanity check 
417  *
418  * Check to see if the tape position as defined by the OS is
419  *  the same as our concept.  If it is not, we bail out, because
420  *  it means the user has probably manually rewound the tape.
421  * Note, we check only if num_writers == 0, but this code will
422  *  also work fine for any number of writers. If num_writers > 0,
423  *  we probably should cancel all jobs using this device, or 
424  *  perhaps even abort the SD, or at a minimum, mark the tape
425  *  in error.  Another strategy with num_writers == 0, would be
426  *  to rewind the tape and do a new eod() request.
427  */
428 static bool is_tape_position_ok(JCR *jcr, DEVICE *dev)
429 {
430    if (dev->is_tape() && dev->num_writers == 0) {
431       int32_t file = dev->get_os_tape_file();
432       if (file >= 0 && file != (int32_t)dev->get_file()) {
433          Jmsg(jcr, M_FATAL, 0, _("Invalid tape position on volume \"%s\"" 
434               " on device %s. Expected %d, got %d\n"), 
435               dev->VolHdr.VolumeName, dev->print_name(), dev->get_file(), file);
436          return false;
437       }
438    }
439    return true;
440 }
441
442
443 /*
444  * This job is done, so release the device. From a Unix standpoint,
445  *  the device remains open.
446  *
447  * Note, if we are spooling, we may enter with the device locked.
448  * However, in all cases, unlock the device when leaving.
449  *
450  */
451 bool release_device(DCR *dcr)
452 {
453    JCR *jcr = dcr->jcr;
454    DEVICE *dev = dcr->dev;
455    bool ok = true;
456    char tbuf[100];
457
458    /* lock only if not already locked by this thread */
459    if (!dcr->is_dev_locked()) {
460       dev->r_dlock();
461    }
462    lock_volumes();
463    Dmsg2(100, "release_device device %s is %s\n", dev->print_name(), dev->is_tape()?"tape":"disk");
464
465    /* if device is reserved, job never started, so release the reserve here */
466    dcr->clear_reserved();
467
468    if (dev->can_read()) {
469       dev->clear_read();              /* clear read bit */
470       Dmsg0(100, "dir_update_vol_info. Release0\n");
471       dir_update_volume_info(dcr, false, false); /* send Volume info to Director */
472       volume_unused(dcr);
473
474    } else if (dev->num_writers > 0) {
475       /* 
476        * Note if WEOT is set, we are at the end of the tape
477        *   and may not be positioned correctly, so the
478        *   job_media_record and update_vol_info have already been
479        *   done, which means we skip them here.
480        */
481       dev->num_writers--;
482       Dmsg1(100, "There are %d writers in release_device\n", dev->num_writers);
483       if (dev->is_labeled()) {
484          Dmsg2(200, "dir_create_jobmedia. Release vol=%s dev=%s\n", 
485                dev->VolCatInfo.VolCatName, dev->print_name());
486          if (!dev->at_weot() && !dir_create_jobmedia_record(dcr)) {
487             Jmsg(jcr, M_FATAL, 0, _("Could not create JobMedia record for Volume=\"%s\" Job=%s\n"),
488                dcr->VolCatInfo.VolCatName, jcr->Job);
489          }
490          /* If no more writers, and no errors, and wrote something, write an EOF */
491          if (!dev->num_writers && dev->can_write() && dev->block_num > 0) {
492             dev->weof(1);
493             write_ansi_ibm_labels(dcr, ANSI_EOF_LABEL, dev->VolHdr.VolumeName);
494          }
495          if (!dev->at_weot()) {
496             dev->VolCatInfo.VolCatFiles = dev->file;   /* set number of files */
497             /* Note! do volume update before close, which zaps VolCatInfo */
498             dir_update_volume_info(dcr, false, false); /* send Volume info to Director */
499             Dmsg2(200, "dir_update_vol_info. Release vol=%s dev=%s\n", 
500                   dev->VolCatInfo.VolCatName, dev->print_name());
501          }
502          if (dev->num_writers == 0) {         /* if not being used */
503 //       if (!dev->is_busy()) {               /* if not being used */
504             volume_unused(dcr);               /*  we obviously are not using the volume */
505          }
506       }
507
508    } else {
509       /*                
510        * If we reach here, it is most likely because the job
511        *   has failed, since the device is not in read mode and
512        *   there are no writers. It was probably reserved.
513        */
514       volume_unused(dcr);
515    }
516    unlock_volumes();
517    Dmsg3(100, "%d writers, %d reserve, dev=%s\n", dev->num_writers, dev->num_reserved(),
518          dev->print_name());
519    debug_list_volumes("acquire:release_device()");
520
521
522    /* If no writers, close if file or !CAP_ALWAYS_OPEN */
523    if (dev->num_writers == 0 && (!dev->is_tape() || !dev->has_cap(CAP_ALWAYSOPEN))) {
524       dvd_remove_empty_part(dcr);        /* get rid of any empty spool part */
525       dev->close();
526    }
527
528    /* Fire off Alert command and include any output */
529    if (!job_canceled(jcr) && dcr->device->alert_command) {
530       POOLMEM *alert;
531       int status = 1;
532       BPIPE *bpipe;
533       char line[MAXSTRING];
534       alert = get_pool_memory(PM_FNAME);
535       alert = edit_device_codes(dcr, alert, dcr->device->alert_command, "");
536       bpipe = open_bpipe(alert, 0, "r");
537       if (bpipe) {
538          while (fgets(line, sizeof(line), bpipe->rfd)) {
539             Jmsg(jcr, M_ALERT, 0, _("Alert: %s"), line);
540          }
541          status = close_bpipe(bpipe);
542       } else {
543          status = errno;
544       }
545       if (status != 0) {
546          berrno be;
547          Jmsg(jcr, M_ALERT, 0, _("3997 Bad alert command: %s: ERR=%s.\n"),
548               alert, be.bstrerror(status));
549       }
550
551       Dmsg1(400, "alert status=%d\n", status);
552       free_pool_memory(alert);
553    }
554    pthread_cond_broadcast(&dev->wait_next_vol);
555    Dmsg2(100, "JobId=%u broadcast wait_device_release at %s\n", 
556          (uint32_t)jcr->JobId, bstrftimes(tbuf, sizeof(tbuf), (utime_t)time(NULL)));
557    pthread_cond_broadcast(&wait_device_release);
558    dev->dunlock();
559    if (dcr->keep_dcr) {
560       detach_dcr_from_dev(dcr);
561    } else {
562       if (jcr->read_dcr == dcr) {
563          jcr->read_dcr = NULL;
564       }
565       if (jcr->dcr == dcr) {
566          jcr->dcr = NULL;
567       }
568       free_dcr(dcr);
569    }
570    Dmsg2(100, "===== Device %s released by JobId=%u\n", dev->print_name(),
571          (uint32_t)jcr->JobId);
572    return ok;
573 }
574
575 /*
576  * Clean up the device for reuse without freeing the memory
577  */
578 bool clean_device(DCR *dcr)
579 {
580    bool ok;
581    dcr->keep_dcr = true;                  /* do not free the dcr */
582    ok = release_device(dcr);
583    dcr->keep_dcr = false;
584    return ok;
585 }
586
587 /*
588  * Create a new Device Control Record and attach
589  *   it to the device (if this is a real job).
590  * Note, this has been updated so that it can be called first 
591  *   without a DEVICE, then a second or third time with a DEVICE,
592  *   and each time, it should cleanup and point to the new device.
593  *   This should facilitate switching devices.
594  * Note, each dcr must point to the controlling job (jcr).  However,
595  *   a job can have multiple dcrs, so we must not store in the jcr's
596  *   structure as previously. The higher level routine must store
597  *   this dcr in the right place
598  *
599  */
600 DCR *new_dcr(JCR *jcr, DCR *dcr, DEVICE *dev)
601 {
602    if (!dcr) {
603       dcr = (DCR *)malloc(sizeof(DCR));
604       memset(dcr, 0, sizeof(DCR));
605       dcr->tid = pthread_self();
606       dcr->spool_fd = -1;
607    }
608    dcr->jcr = jcr;                 /* point back to jcr */
609    /* Set device information, possibly change device */
610    if (dev) {
611       if (dcr->block) {
612          free_block(dcr->block);
613       }
614       dcr->block = new_block(dev);
615       if (dcr->rec) {
616          free_record(dcr->rec);
617       }
618       dcr->rec = new_record();
619       if (dcr->attached_to_dev) {
620          detach_dcr_from_dev(dcr);
621       }
622       /* Use job spoolsize prior to device spoolsize */
623       if (jcr->spool_size) {
624          dcr->max_job_spool_size = jcr->spool_size;
625       } else {
626          dcr->max_job_spool_size = dev->device->max_job_spool_size;
627       }
628       dcr->device = dev->device;
629       dcr->dev = dev;
630       attach_dcr_to_dev(dcr);
631    }
632    return dcr;
633 }
634
635 /*
636  * Search the dcrs list for the given dcr. If it is found,
637  *  as it should be, then remove it. Also zap the jcr pointer
638  *  to the dcr if it is the same one.
639  *
640  * Note, this code will be turned on when we can write to multiple
641  *  dcrs at the same time.
642  */
643 #ifdef needed
644 static void remove_dcr_from_dcrs(DCR *dcr)
645 {
646    JCR *jcr = dcr->jcr;
647    if (jcr->dcrs) {
648       int i = 0;
649       DCR *ldcr;
650       int num = jcr->dcrs->size();
651       for (i=0; i < num; i++) {
652          ldcr = (DCR *)jcr->dcrs->get(i);
653          if (ldcr == dcr) {
654             jcr->dcrs->remove(i);
655             if (jcr->dcr == dcr) {
656                jcr->dcr = NULL;
657             }
658          }
659       }
660    }
661 }
662 #endif
663
664 static void attach_dcr_to_dev(DCR *dcr)
665 {
666    DEVICE *dev = dcr->dev;
667    JCR *jcr = dcr->jcr;
668
669    if (jcr) Dmsg1(500, "JobId=%u enter attach_dcr_to_dev\n", (uint32_t)jcr->JobId);
670    if (!dcr->attached_to_dev && dev->initiated && jcr && jcr->JobType != JT_SYSTEM) {
671       dev->attached_dcrs->append(dcr);  /* attach dcr to device */
672       dcr->attached_to_dev = true;
673       Dmsg1(500, "JobId=%u attach_dcr_to_dev\n", (uint32_t)jcr->JobId);
674    }
675 }
676
677 void detach_dcr_from_dev(DCR *dcr)
678 {
679    DEVICE *dev = dcr->dev;
680    Dmsg0(500, "Enter detach_dcr_from_dev\n"); /* jcr is NULL in some cases */
681
682    /* Detach this dcr only if attached */
683    if (dcr->attached_to_dev && dev) {
684       dev->dlock();
685       dcr->unreserve_device();
686       dcr->dev->attached_dcrs->remove(dcr);  /* detach dcr from device */
687       dcr->attached_to_dev = false;
688 //    remove_dcr_from_dcrs(dcr);      /* remove dcr from jcr list */
689       dev->dunlock();
690    }
691 }
692
693 /*
694  * Free up all aspects of the given dcr -- i.e. dechain it,
695  *  release allocated memory, zap pointers, ...
696  */
697 void free_dcr(DCR *dcr)
698 {
699    JCR *jcr = dcr->jcr;
700
701    detach_dcr_from_dev(dcr);
702
703    if (dcr->block) {
704       free_block(dcr->block);
705    }
706    if (dcr->rec) {
707       free_record(dcr->rec);
708    }
709    if (jcr && jcr->dcr == dcr) {
710       jcr->dcr = NULL;
711    }
712    free(dcr);
713 }