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