]> git.sur5r.net Git - bacula/bacula/blob - bacula/src/stored/acquire.c
kes Make ask_sysop_to_create... to return if waken from wait.
[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 drive only if tape really in drive */
365          if (dev->VolHdr.VolumeName[0]) {
366             release = true;
367          }
368          do_mount = true;
369       } else {
370          /*
371           * At this point, the correct tape is already mounted, so
372           *   we do not need to do mount_next_write_volume(), unless
373           *   we need to recycle the tape.
374           */
375           do_mount = strcmp(dcr->VolCatInfo.VolCatStatus, "Recycle") == 0;
376           Dmsg2(190, "jid=%u Correct tape mounted. recycle=%d\n", 
377                 (uint32_t)jcr->JobId, do_mount);
378           if (dev->num_writers == 0) {
379              memcpy(&dev->VolCatInfo, &dcr->VolCatInfo, sizeof(dev->VolCatInfo));
380           }
381
382           /*
383            *      Insanity check 
384            *
385            * Check to see if the tape position as defined by the OS is
386            *  the same as our concept.  If it is not, we bail out, because
387            *  it means the user has probably manually rewound the tape.
388            * Note, we check only if num_writers == 0, but this code will
389            *  also work fine for any number of writers. If num_writers > 0,
390            *  we probably should cancel all jobs using this device, or 
391            *  perhaps even abort the SD, or at a minimum, mark the tape
392            *  in error.  Another strategy with num_writers == 0, would be
393            *  to rewind the tape and do a new eod() request.
394            */
395           if (dev->is_tape() && dev->num_writers == 0) {
396              int32_t file = dev->get_os_tape_file();
397              if (file >= 0 && file != (int32_t)dev->get_file()) {
398                 Jmsg(jcr, M_FATAL, 0, _("Invalid tape position on volume \"%s\"" 
399                      " on device %s. Expected %d, got %d\n"), 
400                      dev->VolHdr.VolumeName, dev->print_name(), dev->get_file(), file);
401                 goto get_out;
402              }
403           }
404       }
405    } else {
406       /* Not already in append mode, so mount the device */
407       Dmsg2(190, "jid=%u Not in append mode, try mount have_vol=%d\n", 
408             (uint32_t)jcr->JobId, have_vol);
409
410       ASSERT(dev->num_writers == 0);
411       do_mount = true;
412    }
413
414    if (do_mount || !have_vol) {
415       Dmsg1(190, "jid=%u Do mount_next_write_vol\n", (uint32_t)jcr->JobId);
416       bool mounted = mount_next_write_volume(dcr, have_vol, release);
417       if (!mounted) {
418          if (!job_canceled(jcr)) {
419             /* Reduce "noise" -- don't print if job canceled */
420             Jmsg(jcr, M_FATAL, 0, _("Could not ready device %s for append.\n"),
421                dev->print_name());
422             Dmsg2(200, "jid=%u Could not ready device %s for append.\n", 
423                (uint32_t)jcr->JobId, dev->print_name());
424          }
425          goto get_out;
426       }
427       Dmsg2(190, "Output pos=%u:%u\n", dcr->dev->file, dcr->dev->block_num);
428    }
429
430    dev->num_writers++;                /* we are now a writer */
431    if (jcr->NumWriteVolumes == 0) {
432       jcr->NumWriteVolumes = 1;
433    }
434    dev->VolCatInfo.VolCatJobs++;              /* increment number of jobs on vol */
435    dir_update_volume_info(dcr, false, false); /* send Volume info to Director */
436    dev->dlock();
437    if (dcr->reserved_device) {
438       dev->reserved_device--;
439       Dmsg3(100, "jid=%u Dec reserve=%d dev=%s\n", (uint32_t)jcr->JobId,
440             dev->reserved_device, dev->print_name());
441       dcr->reserved_device = false;
442    }
443    dev->dunblock(DEV_LOCKED);
444    return dcr;
445
446 /*
447  * Error return
448  */
449 get_out:
450    dev->dlock();
451    if (dcr->reserved_device) {
452       dev->reserved_device--;
453       Dmsg3(100, "jid=%u Dec reserve=%d dev=%s\n", (uint32_t)jcr->JobId, 
454             dev->reserved_device, dev->print_name());
455       dcr->reserved_device = false;
456    }
457    dev->dunblock(DEV_LOCKED);
458    return NULL;
459 }
460
461
462 static bool is_suitable_volume_mounted(DCR *dcr)
463 {
464    DEVICE *dev = dcr->dev;
465
466    /* Volume mounted? */
467    if (dev->VolHdr.VolumeName[0] == 0) {
468       return false;                      /* no */
469    }
470    bstrncpy(dcr->VolumeName, dev->VolHdr.VolumeName, sizeof(dcr->VolumeName));
471    return dir_get_volume_info(dcr, GET_VOL_INFO_FOR_WRITE);
472 }
473
474 /*
475  * This job is done, so release the device. From a Unix standpoint,
476  *  the device remains open.
477  *
478  * Note, if we are spooling, we may enter with the device locked.
479  * However, in all cases, unlock the device when leaving.
480  *
481  */
482 bool release_device(DCR *dcr)
483 {
484    JCR *jcr = dcr->jcr;
485    DEVICE *dev = dcr->dev;
486    bool ok = true;
487
488    /* lock only if not already locked by this thread */
489    if (!dcr->is_dev_locked()) {
490       dev->r_dlock();
491    }
492    Dmsg2(100, "release_device device %s is %s\n", dev->print_name(), dev->is_tape()?"tape":"disk");
493
494    /* if device is reserved, job never started, so release the reserve here */
495    if (dcr->reserved_device) {
496       dev->reserved_device--;
497       Dmsg2(100, "Dec reserve=%d dev=%s\n", dev->reserved_device, dev->print_name());
498       dcr->reserved_device = false;
499    }
500
501    if (dev->can_read()) {
502       dev->clear_read();              /* clear read bit */
503       Dmsg0(100, "dir_update_vol_info. Release0\n");
504       dir_update_volume_info(dcr, false, false); /* send Volume info to Director */
505       volume_unused(dcr);
506
507    } else if (dev->num_writers > 0) {
508       /* 
509        * Note if WEOT is set, we are at the end of the tape
510        *   and may not be positioned correctly, so the
511        *   job_media_record and update_vol_info have already been
512        *   done, which means we skip them here.
513        */
514       dev->num_writers--;
515       Dmsg1(100, "There are %d writers in release_device\n", dev->num_writers);
516       if (dev->is_labeled()) {
517          Dmsg0(100, "dir_create_jobmedia_record. Release\n");
518          if (!dev->at_weot() && !dir_create_jobmedia_record(dcr)) {
519             Jmsg(jcr, M_FATAL, 0, _("Could not create JobMedia record for Volume=\"%s\" Job=%s\n"),
520                dcr->VolCatInfo.VolCatName, jcr->Job);
521          }
522          /* If no more writers, write an EOF */
523          if (!dev->num_writers && dev->can_write() && dev->block_num > 0) {
524             dev->weof(1);
525             write_ansi_ibm_labels(dcr, ANSI_EOF_LABEL, dev->VolHdr.VolumeName);
526             volume_unused(dcr);
527          }
528          if (!dev->at_weot()) {
529             dev->VolCatInfo.VolCatFiles = dev->file;   /* set number of files */
530             /* Note! do volume update before close, which zaps VolCatInfo */
531             Dmsg0(100, "dir_update_vol_info. Release0\n");
532             dir_update_volume_info(dcr, false, false); /* send Volume info to Director */
533          }
534       }
535
536    } else {
537       /*                
538        * If we reach here, it is most likely because the job
539        *   has failed, since the device is not in read mode and
540        *   there are no writers. It was probably reserved.
541        */
542       volume_unused(dcr);
543    }
544
545    /* If no writers, close if file or !CAP_ALWAYS_OPEN */
546    if (dev->num_writers == 0 && (!dev->is_tape() || !dev->has_cap(CAP_ALWAYSOPEN))) {
547       dvd_remove_empty_part(dcr);        /* get rid of any empty spool part */
548       dev->close();
549    }
550
551    /* Fire off Alert command and include any output */
552    if (!job_canceled(jcr) && dcr->device->alert_command) {
553       POOLMEM *alert;
554       int status = 1;
555       BPIPE *bpipe;
556       char line[MAXSTRING];
557       alert = get_pool_memory(PM_FNAME);
558       alert = edit_device_codes(dcr, alert, dcr->device->alert_command, "");
559       bpipe = open_bpipe(alert, 0, "r");
560       if (bpipe) {
561          while (fgets(line, sizeof(line), bpipe->rfd)) {
562             Jmsg(jcr, M_ALERT, 0, _("Alert: %s"), line);
563          }
564          status = close_bpipe(bpipe);
565       } else {
566          status = errno;
567       }
568       if (status != 0) {
569          berrno be;
570          Jmsg(jcr, M_ALERT, 0, _("3997 Bad alert command: %s: ERR=%s.\n"),
571               alert, be.bstrerror(status));
572       }
573
574       Dmsg1(400, "alert status=%d\n", status);
575       free_pool_memory(alert);
576    }
577    pthread_cond_broadcast(&dev->wait_next_vol);
578    Dmsg1(100, "JobId=%u broadcast wait_device_release\n", (uint32_t)jcr->JobId);
579    pthread_cond_broadcast(&wait_device_release);
580    dev->dunlock();
581    if (dcr->keep_dcr) {
582       detach_dcr_from_dev(dcr);
583    } else {
584       if (jcr->read_dcr == dcr) {
585          jcr->read_dcr = NULL;
586       }
587       if (jcr->dcr == dcr) {
588          jcr->dcr = NULL;
589       }
590       free_dcr(dcr);
591    }
592    Dmsg2(100, "===== Device %s released by JobId=%u\n", dev->print_name(),
593          (uint32_t)jcr->JobId);
594    return ok;
595 }
596
597 /*
598  * Clean up the device for reuse without freeing the memory
599  */
600 bool clean_device(DCR *dcr)
601 {
602    bool ok;
603    dcr->keep_dcr = true;                  /* do not free the dcr */
604    ok = release_device(dcr);
605    dcr->keep_dcr = false;
606    return ok;
607 }
608
609 /*
610  * Create a new Device Control Record and attach
611  *   it to the device (if this is a real job).
612  * Note, this has been updated so that it can be called first 
613  *   without a DEVICE, then a second or third time with a DEVICE,
614  *   and each time, it should cleanup and point to the new device.
615  *   This should facilitate switching devices.
616  * Note, each dcr must point to the controlling job (jcr).  However,
617  *   a job can have multiple dcrs, so we must not store in the jcr's
618  *   structure as previously. The higher level routine must store
619  *   this dcr in the right place
620  *
621  */
622 DCR *new_dcr(JCR *jcr, DCR *dcr, DEVICE *dev)
623 {
624    if (!dcr) {
625       dcr = (DCR *)malloc(sizeof(DCR));
626       memset(dcr, 0, sizeof(DCR));
627       dcr->tid = pthread_self();
628       dcr->spool_fd = -1;
629    }
630    dcr->jcr = jcr;                 /* point back to jcr */
631    /* Set device information, possibly change device */
632    if (dev) {
633       if (dcr->block) {
634          free_block(dcr->block);
635       }
636       dcr->block = new_block(dev);
637       if (dcr->rec) {
638          free_record(dcr->rec);
639       }
640       dcr->rec = new_record();
641       if (dcr->attached_to_dev) {
642          detach_dcr_from_dev(dcr);
643       }
644       /* Use job spoolsize prior to device spoolsize */
645       if (jcr->spool_size) {
646          dcr->max_job_spool_size = jcr->spool_size;
647       } else {
648          dcr->max_job_spool_size = dev->device->max_job_spool_size;
649       }
650       dcr->device = dev->device;
651       dcr->dev = dev;
652       attach_dcr_to_dev(dcr);
653    }
654    return dcr;
655 }
656
657 /*
658  * Search the dcrs list for the given dcr. If it is found,
659  *  as it should be, then remove it. Also zap the jcr pointer
660  *  to the dcr if it is the same one.
661  *
662  * Note, this code will be turned on when we can write to multiple
663  *  dcrs at the same time.
664  */
665 #ifdef needed
666 static void remove_dcr_from_dcrs(DCR *dcr)
667 {
668    JCR *jcr = dcr->jcr;
669    if (jcr->dcrs) {
670       int i = 0;
671       DCR *ldcr;
672       int num = jcr->dcrs->size();
673       for (i=0; i < num; i++) {
674          ldcr = (DCR *)jcr->dcrs->get(i);
675          if (ldcr == dcr) {
676             jcr->dcrs->remove(i);
677             if (jcr->dcr == dcr) {
678                jcr->dcr = NULL;
679             }
680          }
681       }
682    }
683 }
684 #endif
685
686 static void attach_dcr_to_dev(DCR *dcr)
687 {
688    DEVICE *dev = dcr->dev;
689    JCR *jcr = dcr->jcr;
690
691    if (jcr) Dmsg1(500, "JobId=%u enter attach_dcr_to_dev\n", (uint32_t)jcr->JobId);
692    if (!dcr->attached_to_dev && dev->initiated && jcr && jcr->JobType != JT_SYSTEM) {
693       dev->attached_dcrs->append(dcr);  /* attach dcr to device */
694       dcr->attached_to_dev = true;
695       Dmsg1(500, "JobId=%u attach_dcr_to_dev\n", (uint32_t)jcr->JobId);
696    }
697 }
698
699 void detach_dcr_from_dev(DCR *dcr)
700 {
701    DEVICE *dev = dcr->dev;
702    Dmsg1(500, "JobId=%u enter detach_dcr_from_dev\n", (uint32_t)dcr->jcr->JobId);
703
704    /* Detach this dcr only if attached */
705    if (dcr->attached_to_dev && dev) {
706       dev->dlock();
707       unreserve_device(dcr);
708       dcr->dev->attached_dcrs->remove(dcr);  /* detach dcr from device */
709       dcr->attached_to_dev = false;
710 //    remove_dcr_from_dcrs(dcr);      /* remove dcr from jcr list */
711       dev->dunlock();
712    }
713 }
714
715 /*
716  * Free up all aspects of the given dcr -- i.e. dechain it,
717  *  release allocated memory, zap pointers, ...
718  */
719 void free_dcr(DCR *dcr)
720 {
721    JCR *jcr = dcr->jcr;
722
723    detach_dcr_from_dev(dcr);
724
725    if (dcr->block) {
726       free_block(dcr->block);
727    }
728    if (dcr->rec) {
729       free_record(dcr->rec);
730    }
731    if (jcr && jcr->dcr == dcr) {
732       jcr->dcr = NULL;
733    }
734    free(dcr);
735 }