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