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