3 * label.c Bacula routines to handle labels
11 Copyright (C) 2000-2005 Kern Sibbald
13 This program is free software; you can redistribute it and/or
14 modify it under the terms of the GNU General Public License as
15 published by the Free Software Foundation; either version 2 of
16 the License, or (at your option) any later version.
18 This program is distributed in the hope that it will be useful,
19 but WITHOUT ANY WARRANTY; without even the implied warranty of
20 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
21 General Public License for more details.
23 You should have received a copy of the GNU General Public
24 License along with this program; if not, write to the Free
25 Software Foundation, Inc., 59 Temple Place - Suite 330, Boston,
30 #include "bacula.h" /* pull in global headers */
31 #include "stored.h" /* pull in Storage Deamon headers */
33 /* Forward referenced functions */
34 static void create_volume_label_record(DCR *dcr, DEV_RECORD *rec);
36 extern char my_name[];
37 extern int debug_level;
40 * Read the volume label
42 * If dcr->VolumeName == NULL, we accept any Bacula Volume
43 * If dcr->VolumeName[0] == 0, we accept any Bacula Volume
44 * otherwise dcr->VolumeName must match the Volume.
46 * If VolName given, ensure that it matches
48 * Returns VOL_ code as defined in record.h
50 * VOL_OK good label found
51 * VOL_NO_LABEL volume not labeled
52 * VOL_IO_ERROR I/O error reading tape
53 * VOL_NAME_ERROR label has wrong name
54 * VOL_CREATE_ERROR Error creating label
55 * VOL_VERSION_ERROR label has wrong version
56 * VOL_LABEL_ERROR bad label type
57 * VOL_NO_MEDIA no media in drive
59 * The dcr block is emptied on return, and the Volume is
62 int read_dev_volume_label(DCR *dcr)
65 DEVICE *dev = dcr->dev;
66 char *VolName = dcr->VolumeName;
69 DEV_BLOCK *block = dcr->block;
73 Dmsg3(100, "Enter read_volume_label device=%s vol=%s dev_Vol=%s\n",
74 dev_name(dev), VolName, dev->VolHdr.VolName);
76 if (!dev->is_open()) {
77 Emsg0(M_ABORT, 0, _("BAD call to read_dev_volume_label\n"));
79 if (dev->is_labeled()) { /* did we already read label? */
80 /* Compare Volume Names allow special wild card */
81 if (VolName && *VolName && *VolName != '*' && strcmp(dev->VolHdr.VolName, VolName) != 0) {
82 Mmsg(jcr->errmsg, _("Wrong Volume mounted on device %s: Wanted %s have %s\n"),
83 dev_name(dev), VolName, dev->VolHdr.VolName);
85 * Cancel Job if too many label errors
88 if (!dev->poll && jcr->label_errors++ > 100) {
89 Jmsg(jcr, M_FATAL, 0, "Too many tries: %s", jcr->errmsg);
91 return VOL_NAME_ERROR;
93 Dmsg0(30, "Leave read_volume_label() VOL_OK\n");
94 return VOL_OK; /* label already read */
97 dev->state &= ~(ST_LABEL|ST_APPEND|ST_READ); /* set no label, no append */
98 dev->label_type = B_BACULA_LABEL;
100 if (!rewind_dev(dev)) {
101 Mmsg(jcr->errmsg, _("Couldn't rewind device %s ERR=%s\n"), dev_name(dev),
103 Dmsg1(30, "%s", jcr->errmsg);
106 bstrncpy(dev->VolHdr.Id, "**error**", sizeof(dev->VolHdr.Id));
108 /* Read ANSI/IBM label if so requested */
110 want_ansi_label = dcr->VolCatInfo.LabelType != B_BACULA_LABEL ||
111 dcr->device->label_type != B_BACULA_LABEL;
112 if (want_ansi_label || dev_cap(dev, CAP_CHECKLABELS)) {
113 stat = read_ansi_ibm_label(dcr);
114 /* If we want a label and didn't find it, return error */
115 if (want_ansi_label && stat != VOL_OK) {
120 if (stat == VOL_NAME_ERROR || stat == VOL_LABEL_ERROR) {
121 Mmsg(jcr->errmsg, _("Wrong Volume mounted on device %s: Wanted %s have %s\n"),
122 dev_name(dev), VolName, dev->VolHdr.VolName);
123 if (!dev->poll && jcr->label_errors++ > 100) {
124 Jmsg(jcr, M_FATAL, 0, "Too many tries: %s", jcr->errmsg);
130 if (stat != VOL_OK) { /* Not an ANSI/IBM label, so re-read */
135 /* Read the Bacula Volume label block */
136 record = new_record();
139 Dmsg0(90, "Big if statement in read_volume_label\n");
140 if (!read_block_from_dev(dcr, NO_BLOCK_NUMBER_CHECK)) {
141 Mmsg(jcr->errmsg, _("Requested Volume \"%s\" on %s is not a Bacula "
142 "labeled Volume, because: ERR=%s"), NPRT(VolName), dev_name(dev),
144 Dmsg1(30, "%s", jcr->errmsg);
145 } else if (!read_record_from_block(block, record)) {
146 Mmsg(jcr->errmsg, _("Could not read Volume label from block.\n"));
147 Dmsg1(30, "%s", jcr->errmsg);
148 } else if (!unser_volume_label(dev, record)) {
149 Mmsg(jcr->errmsg, _("Could not unserialize Volume label: ERR=%s\n"),
151 Dmsg1(30, "%s", jcr->errmsg);
152 } else if (strcmp(dev->VolHdr.Id, BaculaId) != 0 &&
153 strcmp(dev->VolHdr.Id, OldBaculaId) != 0) {
154 Mmsg(jcr->errmsg, _("Volume Header Id bad: %s\n"), dev->VolHdr.Id);
155 Dmsg1(30, "%s", jcr->errmsg);
159 free_record(record); /* finished reading Volume record */
160 empty_block(block); /* done with block */
163 if (forge_on || jcr->ignore_label_errors) {
164 dev->state |= ST_LABEL; /* set has Bacula label */
165 Jmsg(jcr, M_ERROR, 0, "%s", jcr->errmsg);
172 /* At this point, we have read the first Bacula block, and
173 * then read the Bacula Volume label. Now we need to
174 * make sure we have the right Volume.
177 /* If we are a streaming device, we only get one chance to read */
178 if (!dev_cap(dev, CAP_STREAM)) {
182 if (dev->VolHdr.VerNum != BaculaTapeVersion &&
183 dev->VolHdr.VerNum != OldCompatibleBaculaTapeVersion1 &&
184 dev->VolHdr.VerNum != OldCompatibleBaculaTapeVersion2) {
185 Mmsg(jcr->errmsg, _("Volume on %s has wrong Bacula version. Wanted %d got %d\n"),
186 dev_name(dev), BaculaTapeVersion, dev->VolHdr.VerNum);
187 Dmsg1(30, "%s", jcr->errmsg);
188 return VOL_VERSION_ERROR;
191 /* We are looking for either an unused Bacula tape (PRE_LABEL) or
192 * a Bacula volume label (VOL_LABEL)
194 if (dev->VolHdr.LabelType != PRE_LABEL && dev->VolHdr.LabelType != VOL_LABEL) {
195 Mmsg(jcr->errmsg, _("Volume on %s has bad Bacula label type: %x\n"),
196 dev_name(dev), dev->VolHdr.LabelType);
197 Dmsg1(30, "%s", jcr->errmsg);
198 if (!dev->poll && jcr->label_errors++ > 100) {
199 Jmsg(jcr, M_FATAL, 0, "Too many tries: %s", jcr->errmsg);
201 return VOL_LABEL_ERROR;
204 dev->state |= ST_LABEL; /* set has Bacula label */
206 /* Compare Volume Names */
207 Dmsg2(30, "Compare Vol names: VolName=%s hdr=%s\n", VolName?VolName:"*", dev->VolHdr.VolName);
208 if (VolName && *VolName && *VolName != '*' && strcmp(dev->VolHdr.VolName, VolName) != 0) {
209 Mmsg(jcr->errmsg, _("Wrong Volume mounted on device %s: Wanted %s have %s\n"),
210 dev_name(dev), VolName, dev->VolHdr.VolName);
211 Dmsg1(30, "%s", jcr->errmsg);
213 * Cancel Job if too many label errors
214 * => we are in a loop
216 if (!dev->poll && jcr->label_errors++ > 100) {
217 Jmsg(jcr, M_FATAL, 0, "Too many tries: %s", jcr->errmsg);
219 return VOL_NAME_ERROR;
221 Dmsg1(30, "Copy vol_name=%s\n", dev->VolHdr.VolName);
223 if (debug_level >= 10) {
224 dump_volume_label(dev);
226 Dmsg0(30, "Leave read_volume_label() VOL_OK\n");
230 /* Read the volume label by guessing the volume name. (only for DVD devices)
231 * write is true if we are reading the label before writing to the device.
233 * If the volume name cannot be guessed :
234 * Writing : returns the label of the current file (on the harddisk).
235 * Reading : returns an error
237 int read_dev_volume_label_guess(DCR *dcr, bool write)
239 int vol_label_status;
240 DEVICE *dev = dcr->dev;
242 Dmsg3(100, "Enter read_dev_volume_label_guess device=%s vol=%s dev_Vol=%s\n",
243 dev_name(dev), dcr->VolumeName, dev->VolHdr.VolName);
245 if (!dev->is_dvd()) {
246 Dmsg0(100, "Leave read_dev_volume_label_guess !CAP_REQMOUNT\n");
247 return read_dev_volume_label(dcr);
250 if (!write && (dcr->VolCatInfo.VolCatParts == 0)) {
251 Dmsg0(100, "Leave read_dev_volume_label_guess !writing, and VolCatParts == 0\n");
252 return read_dev_volume_label(dcr);
255 /* For mounted devices, tries to guess the volume name, and read the label if possible.
257 if (open_guess_name_dev(dev) < 0) {
258 if (!write || dcr->VolCatInfo.VolCatParts > 0) {
259 Mmsg2(jcr->errmsg, _("Requested Volume \"%s\" on %s is not a Bacula labeled Volume."),
260 dev_name(dev), dcr->VolumeName);
261 Dmsg0(100, "Leave read_dev_volume_label_guess VOL_IO_ERROR (!open_guess_name_dev)\n");
265 if (write && dev->free_space_errno < 0) {
266 Dmsg0(100, "Leave read_dev_volume_label_guess !free_space VOL_NO_MEDIA\n");
267 Mmsg2(jcr->errmsg, _("free_space error on %s. The current medium is probably not writable. ERR=%s.\n"),
268 dev->dev_name, dev->errmsg);
272 /* If we can't guess the name, and we are writing, just reopen the right file with open_first_part. */
273 if (open_first_part(dev) < 0) {
275 Mmsg2(jcr->errmsg, _("open_first_part error on %s. ERR=%s.\n"),
276 dev->dev_name, be.strerror());
277 Dmsg0(100, "Leave read_dev_volume_label_guess VOL_IO_ERROR (!open_guess_name_dev && !open_first_part)\n");
281 Dmsg0(100, "Leave read_dev_volume_label_guess !open_guess_name_dev\n");
282 return read_dev_volume_label(dcr);
284 if (write && dcr->dev->free_space_errno < 0) {
285 Dmsg0(100, "Leave read_dev_volume_label_guess !free_space VOL_NO_MEDIA\n");
286 Mmsg2(jcr->errmsg, _("free_space error on %s. The current medium is probably not writable. ERR=%s.\n"),
287 dev->dev_name, dev->errmsg);
291 vol_label_status = read_dev_volume_label(dcr);
293 if (!write || dcr->VolCatInfo.VolCatParts > 0) {
294 Dmsg0(100, "Leave read_dev_volume_label_guess (open_guess_name_dev && (!write || dcr->VolCatInfo.VolCatParts > 0))\n");
295 return vol_label_status;
298 if (open_first_part(dcr->dev) < 0) {
300 Mmsg2(jcr->errmsg, _("open_first_part error on %s. ERR=%s.\n"),
301 dev->dev_name, be.strerror());
302 Dmsg0(100, "Leave read_dev_volume_label_guess VOL_IO_ERROR (open_guess_name_dev && !open_first_part)\n");
306 /* When writing, if the guessed volume name is no the right volume name,
307 * report the error, otherwise, just continue with the right file.
309 if (vol_label_status != VOL_NAME_ERROR) {
310 Dmsg0(100, "Leave read_dev_volume_label_guess (open_guess_name_dev && !VOL_NAME_ERROR)\n");
311 dev->state &= ~ST_LABEL;
312 return read_dev_volume_label(dcr);
314 Dmsg0(100, "Leave read_dev_volume_label_guess (open_guess_name_dev && VOL_NAME_ERROR)\n");
315 return vol_label_status;
321 * Put a volume label into the block
323 * Returns: false on failure
326 bool write_volume_label_to_block(DCR *dcr)
329 DEVICE *dev = dcr->dev;
331 DEV_BLOCK *block = dcr->block;
333 Dmsg0(20, "write Label in write_volume_label_to_block()\n");
334 memset(&rec, 0, sizeof(rec));
335 rec.data = get_memory(SER_LENGTH_Volume_Label);
336 empty_block(block); /* Volume label always at beginning */
338 create_volume_label_record(dcr, &rec);
340 block->BlockNumber = 0;
341 if (!write_record_to_block(block, &rec)) {
342 free_pool_memory(rec.data);
343 Jmsg1(jcr, M_FATAL, 0, _("Cannot write Volume label to block for device %s\n"),
347 Dmsg1(90, "Wrote label of %d bytes to block\n", rec.data_len);
349 free_pool_memory(rec.data);
355 * Write a Volume Label
356 * !!! Note, this is ONLY used for writing
357 * a fresh volume label. Any data
358 * after the label will be destroyed,
359 * in fact, we write the label 5 times !!!!
361 * This routine expects that open_device() was previously called.
363 * This routine should be used only when labeling a blank tape.
365 bool write_new_volume_label_to_dev(DCR *dcr, const char *VolName, const char *PoolName)
367 DEVICE *dev = dcr->dev;
370 Dmsg0(99, "write_volume_label()\n");
371 empty_block(dcr->block);
373 Dmsg1(000, "Label type=%d\n", dev->label_type);
374 if (!rewind_dev(dev)) {
375 memset(&dev->VolHdr, 0, sizeof(dev->VolHdr));
376 Dmsg2(30, "Bad status on %s from rewind. ERR=%s\n", dev_name(dev), strerror_dev(dev));
382 /* Create PRE_LABEL */
383 create_volume_label(dev, VolName, PoolName);
386 * If we have already detected an ANSI label, re-read it
387 * to skip past it. Otherwise, we write a new one if
390 if (dev->label_type != B_BACULA_LABEL) {
391 if (read_ansi_ibm_label(dcr) != VOL_OK) {
395 } else if (!write_ansi_ibm_label(dcr, VolName)) {
399 create_volume_label_record(dcr, dcr->rec);
400 dcr->rec->Stream = 0;
402 /* Temporarily mark in append state to enable writing */
403 dev->state |= ST_APPEND;
404 if (!write_record_to_block(dcr->block, dcr->rec)) {
405 Dmsg2(30, "Bad Label write on %s. ERR=%s\n", dev_name(dev), strerror_dev(dev));
408 Dmsg2(30, "Wrote label of %d bytes to %s\n", dcr->rec->data_len, dev_name(dev));
411 Dmsg0(99, "Call write_block_to_dev()\n");
412 if (!write_block_to_dev(dcr)) {
413 Dmsg2(30, "Bad Label write on %s. ERR=%s\n", dev_name(dev), strerror_dev(dev));
416 Dmsg0(99, " Wrote block to device\n");
418 if (weof_dev(dev, 1) == 0) {
419 dev->state |= ST_LABEL;
422 if (debug_level >= 20) {
423 dump_volume_label(dev);
425 dev->state &= ~ST_APPEND; /* remove append since this is PRE_LABEL */
429 memset(&dev->VolHdr, 0, sizeof(dev->VolHdr));
430 dev->state &= ~ST_APPEND; /* remove append since this is PRE_LABEL */
435 * Write a volume label. This is ONLY called if we have a valid Bacula
436 * label of type PRE_LABEL;
437 * Returns: true if OK
438 * false if unable to write it
440 bool rewrite_volume_label(DCR *dcr, bool recycle)
442 DEVICE *dev = dcr->dev;
445 Dmsg1(190, "set append found freshly labeled volume. dev=%x\n", dev);
446 dev->VolHdr.LabelType = VOL_LABEL; /* set Volume label */
447 dev->state |= ST_APPEND;
448 if (!write_volume_label_to_block(dcr)) {
449 Dmsg0(200, "Error from write volume label.\n");
453 * If we are not dealing with a streaming device,
454 * write the block now to ensure we have write permission.
455 * It is better to find out now rather than later.
456 * We do not write the block now if this is an ANSI label. This
457 * avoids re-writing the ANSI label, which we do not want to do.
459 if (!dev_cap(dev, CAP_STREAM)) {
460 if (!rewind_dev(dev)) {
461 Jmsg2(jcr, M_WARNING, 0, _("Rewind error on device \"%s\". ERR=%s\n"),
462 dev_name(dev), strerror_dev(dev));
465 if (!truncate_dev(dev)) {
466 Jmsg2(jcr, M_WARNING, 0, _("Truncate error on device \"%s\". ERR=%s\n"),
467 dev_name(dev), strerror_dev(dev));
472 * If we have already detected an ANSI label, re-read it
473 * to skip past it. Otherwise, we write a new one if
476 if (dev->label_type != B_BACULA_LABEL) {
477 if (read_ansi_ibm_label(dcr) != VOL_OK) {
481 } else if (!write_ansi_ibm_label(dcr, dev->VolHdr.VolName)) {
485 /* Attempt write to check write permission */
486 Dmsg0(200, "Attempt to write to device.\n");
487 if (!write_block_to_dev(dcr)) {
488 Jmsg2(jcr, M_ERROR, 0, _("Unable to write device \"%s\". ERR=%s\n"),
489 dev_name(dev), strerror_dev(dev));
490 Dmsg0(200, "===ERROR write block to dev\n");
494 /* Set or reset Volume statistics */
495 dev->VolCatInfo.VolCatJobs = 0;
496 dev->VolCatInfo.VolCatFiles = 0;
497 dev->VolCatInfo.VolCatBytes = 1;
498 dev->VolCatInfo.VolCatErrors = 0;
499 dev->VolCatInfo.VolCatBlocks = 0;
500 dev->VolCatInfo.VolCatRBytes = 0;
502 dev->VolCatInfo.VolCatMounts++;
503 dev->VolCatInfo.VolCatRecycles++;
505 dev->VolCatInfo.VolCatMounts = 1;
506 dev->VolCatInfo.VolCatRecycles = 0;
507 dev->VolCatInfo.VolCatWrites = 1;
508 dev->VolCatInfo.VolCatReads = 1;
510 Dmsg0(100, "dir_update_vol_info. Set Append\n");
511 bstrncpy(dev->VolCatInfo.VolCatStatus, "Append", sizeof(dev->VolCatInfo.VolCatStatus));
512 if (!dir_update_volume_info(dcr, true)) { /* indicate doing relabel */
516 Jmsg(jcr, M_INFO, 0, _("Recycled volume \"%s\" on device \"%s\", all previous data lost.\n"),
517 dcr->VolumeName, dev_name(dev));
519 Jmsg(jcr, M_INFO, 0, _("Wrote label to prelabeled Volume \"%s\" on device \"%s\"\n"),
520 dcr->VolumeName, dev_name(dev));
523 * End writing real Volume label (from pre-labeled tape), or recycling
526 Dmsg0(200, "OK from rewite vol label.\n");
532 * create_volume_label_record
533 * Serialize label (from dev->VolHdr structure) into device record.
534 * Assumes that the dev->VolHdr structure is properly
537 static void create_volume_label_record(DCR *dcr, DEV_RECORD *rec)
541 DEVICE *dev = dcr->dev;
544 /* Serialize the label into the device record. */
546 rec->data = check_pool_memory_size(rec->data, SER_LENGTH_Volume_Label);
547 ser_begin(rec->data, SER_LENGTH_Volume_Label);
548 ser_string(dev->VolHdr.Id);
550 ser_uint32(dev->VolHdr.VerNum);
552 if (dev->VolHdr.VerNum >= 11) {
553 ser_btime(dev->VolHdr.label_btime);
554 dev->VolHdr.write_btime = get_current_btime();
555 ser_btime(dev->VolHdr.write_btime);
556 dev->VolHdr.write_date = 0;
557 dev->VolHdr.write_time = 0;
559 /* OLD WAY DEPRECATED */
560 ser_float64(dev->VolHdr.label_date);
561 ser_float64(dev->VolHdr.label_time);
562 get_current_time(&dt);
563 dev->VolHdr.write_date = dt.julian_day_number;
564 dev->VolHdr.write_time = dt.julian_day_fraction;
566 ser_float64(dev->VolHdr.write_date); /* 0 if VerNum >= 11 */
567 ser_float64(dev->VolHdr.write_time); /* 0 if VerNum >= 11 */
569 ser_string(dev->VolHdr.VolName);
570 ser_string(dev->VolHdr.PrevVolName);
571 ser_string(dev->VolHdr.PoolName);
572 ser_string(dev->VolHdr.PoolType);
573 ser_string(dev->VolHdr.MediaType);
575 ser_string(dev->VolHdr.HostName);
576 ser_string(dev->VolHdr.LabelProg);
577 ser_string(dev->VolHdr.ProgVersion);
578 ser_string(dev->VolHdr.ProgDate);
580 ser_end(rec->data, SER_LENGTH_Volume_Label);
581 rec->data_len = ser_length(rec->data);
582 rec->FileIndex = dev->VolHdr.LabelType;
583 rec->VolSessionId = jcr->VolSessionId;
584 rec->VolSessionTime = jcr->VolSessionTime;
585 rec->Stream = jcr->NumVolumes;
586 Dmsg2(100, "Created Vol label rec: FI=%s len=%d\n", FI_to_ascii(rec->FileIndex),
592 * Create a volume label in memory
594 void create_volume_label(DEVICE *dev, const char *VolName, const char *PoolName)
596 DEVRES *device = (DEVRES *)dev->device;
598 Dmsg0(90, "Start create_volume_label()\n");
602 memset(&dev->VolHdr, 0, sizeof(dev->VolHdr));
604 bstrncpy(dev->VolHdr.Id, BaculaId, sizeof(dev->VolHdr.Id));
605 dev->VolHdr.VerNum = BaculaTapeVersion;
606 dev->VolHdr.LabelType = PRE_LABEL; /* Mark tape as unused */
607 bstrncpy(dev->VolHdr.VolName, VolName, sizeof(dev->VolHdr.VolName));
608 bstrncpy(dev->VolHdr.PoolName, PoolName, sizeof(dev->VolHdr.PoolName));
609 bstrncpy(dev->VolHdr.MediaType, device->media_type, sizeof(dev->VolHdr.MediaType));
611 bstrncpy(dev->VolHdr.PoolType, "Backup", sizeof(dev->VolHdr.PoolType));
613 dev->VolHdr.label_btime = get_current_btime();
614 dev->VolHdr.label_date = 0;
615 dev->VolHdr.label_time = 0;
617 if (gethostname(dev->VolHdr.HostName, sizeof(dev->VolHdr.HostName)) != 0) {
618 dev->VolHdr.HostName[0] = 0;
620 bstrncpy(dev->VolHdr.LabelProg, my_name, sizeof(dev->VolHdr.LabelProg));
621 sprintf(dev->VolHdr.ProgVersion, "Ver. %s %s", VERSION, BDATE);
622 sprintf(dev->VolHdr.ProgDate, "Build %s %s", __DATE__, __TIME__);
623 dev->state |= ST_LABEL; /* set has Bacula label */
624 if (debug_level >= 90) {
625 dump_volume_label(dev);
630 * Create session label
631 * The pool memory must be released by the calling program
633 void create_session_label(DCR *dcr, DEV_RECORD *rec, int label)
638 rec->VolSessionId = jcr->VolSessionId;
639 rec->VolSessionTime = jcr->VolSessionTime;
640 rec->Stream = jcr->JobId;
642 rec->data = check_pool_memory_size(rec->data, SER_LENGTH_Session_Label);
643 ser_begin(rec->data, SER_LENGTH_Session_Label);
644 ser_string(BaculaId);
645 ser_uint32(BaculaTapeVersion);
647 ser_uint32(jcr->JobId);
649 /* Changed in VerNum 11 */
650 ser_btime(get_current_btime());
653 ser_string(dcr->pool_name);
654 ser_string(dcr->pool_type);
655 ser_string(jcr->job_name); /* base Job name */
656 ser_string(jcr->client_name);
658 /* Added in VerNum 10 */
659 ser_string(jcr->Job); /* Unique name of this Job */
660 ser_string(jcr->fileset_name);
661 ser_uint32(jcr->JobType);
662 ser_uint32(jcr->JobLevel);
663 /* Added in VerNum 11 */
664 ser_string(jcr->fileset_md5);
666 if (label == EOS_LABEL) {
667 ser_uint32(jcr->JobFiles);
668 ser_uint64(jcr->JobBytes);
669 ser_uint32(dcr->StartBlock);
670 ser_uint32(dcr->EndBlock);
671 ser_uint32(dcr->StartFile);
672 ser_uint32(dcr->EndFile);
673 ser_uint32(jcr->JobErrors);
675 /* Added in VerNum 11 */
676 ser_uint32(jcr->JobStatus);
678 ser_end(rec->data, SER_LENGTH_Session_Label);
679 rec->data_len = ser_length(rec->data);
682 /* Write session label
683 * Returns: false on failure
686 bool write_session_label(DCR *dcr, int label)
689 DEVICE *dev = dcr->dev;
691 DEV_BLOCK *block = dcr->block;
694 Dmsg1(90, "session_label record=%x\n", rec);
697 if (dev->is_tape()) {
698 dcr->StartBlock = dev->block_num;
699 dcr->StartFile = dev->file;
701 dcr->StartBlock = (uint32_t)dev->file_addr;
702 dcr->StartFile = (uint32_t)(dev->file_addr >> 32);
706 if (dev->is_tape()) {
707 dcr->EndBlock = dev->EndBlock;
708 dcr->EndFile = dev->EndFile;
710 dcr->EndBlock = (uint32_t)dev->file_addr;
711 dcr->EndFile = (uint32_t)(dev->file_addr >> 32);
715 Jmsg1(jcr, M_ABORT, 0, _("Bad session label = %d\n"), label);
718 create_session_label(dcr, rec, label);
719 rec->FileIndex = label;
722 * We guarantee that the session record can totally fit
723 * into a block. If not, write the block, and put it in
724 * the next block. Having the sesssion record totally in
725 * one block makes reading them much easier (no need to
726 * read the next block).
728 if (!can_write_record_to_block(block, rec)) {
729 Dmsg0(100, "Cannot write session label to block.\n");
730 if (!write_block_to_device(dcr)) {
731 Dmsg0(90, "Got session label write_block_to_dev error.\n");
732 /* ****FIXME***** errno is not set here */
733 Jmsg(jcr, M_FATAL, 0, _("Error writing Session label to %s: %s\n"),
734 dev_vol_name(dev), strerror(errno));
739 if (!write_record_to_block(block, rec)) {
740 Jmsg(jcr, M_FATAL, 0, _("Error writing Session label to %s: %s\n"),
741 dev_vol_name(dev), strerror(errno));
746 Dmsg6(20, "Write sesson_label record JobId=%d FI=%s SessId=%d Strm=%s len=%d "
747 "remainder=%d\n", jcr->JobId,
748 FI_to_ascii(rec->FileIndex), rec->VolSessionId,
749 stream_to_ascii(rec->Stream, rec->FileIndex), rec->data_len,
753 Dmsg2(20, "Leave write_session_label Block=%d File=%d\n",
754 dev->block_num, dev->file);
758 /* unser_volume_label
760 * Unserialize the Bacula Volume label into the device Volume_Label
763 * Assumes that the record is already read.
765 * Returns: false on error
769 bool unser_volume_label(DEVICE *dev, DEV_RECORD *rec)
773 if (rec->FileIndex != VOL_LABEL && rec->FileIndex != PRE_LABEL) {
774 Mmsg3(dev->errmsg, _("Expecting Volume Label, got FI=%s Stream=%s len=%d\n"),
775 FI_to_ascii(rec->FileIndex),
776 stream_to_ascii(rec->Stream, rec->FileIndex),
783 dev->VolHdr.LabelType = rec->FileIndex;
784 dev->VolHdr.LabelSize = rec->data_len;
787 /* Unserialize the record into the Volume Header */
788 rec->data = check_pool_memory_size(rec->data, SER_LENGTH_Volume_Label);
789 ser_begin(rec->data, SER_LENGTH_Volume_Label);
790 unser_string(dev->VolHdr.Id);
791 unser_uint32(dev->VolHdr.VerNum);
793 if (dev->VolHdr.VerNum >= 11) {
794 unser_btime(dev->VolHdr.label_btime);
795 unser_btime(dev->VolHdr.write_btime);
796 } else { /* old way */
797 unser_float64(dev->VolHdr.label_date);
798 unser_float64(dev->VolHdr.label_time);
800 unser_float64(dev->VolHdr.write_date); /* Unused with VerNum >= 11 */
801 unser_float64(dev->VolHdr.write_time); /* Unused with VerNum >= 11 */
803 unser_string(dev->VolHdr.VolName);
804 unser_string(dev->VolHdr.PrevVolName);
805 unser_string(dev->VolHdr.PoolName);
806 unser_string(dev->VolHdr.PoolType);
807 unser_string(dev->VolHdr.MediaType);
809 unser_string(dev->VolHdr.HostName);
810 unser_string(dev->VolHdr.LabelProg);
811 unser_string(dev->VolHdr.ProgVersion);
812 unser_string(dev->VolHdr.ProgDate);
814 ser_end(rec->data, SER_LENGTH_Volume_Label);
815 Dmsg0(90, "ser_read_vol\n");
816 if (debug_level >= 90) {
817 dump_volume_label(dev);
823 bool unser_session_label(SESSION_LABEL *label, DEV_RECORD *rec)
827 rec->data = check_pool_memory_size(rec->data, SER_LENGTH_Session_Label);
828 unser_begin(rec->data, SER_LENGTH_Session_Label);
829 unser_string(label->Id);
830 unser_uint32(label->VerNum);
831 unser_uint32(label->JobId);
832 if (label->VerNum >= 11) {
833 unser_btime(label->write_btime);
835 unser_float64(label->write_date);
837 unser_float64(label->write_time);
838 unser_string(label->PoolName);
839 unser_string(label->PoolType);
840 unser_string(label->JobName);
841 unser_string(label->ClientName);
842 if (label->VerNum >= 10) {
843 unser_string(label->Job); /* Unique name of this Job */
844 unser_string(label->FileSetName);
845 unser_uint32(label->JobType);
846 unser_uint32(label->JobLevel);
848 if (label->VerNum >= 11) {
849 unser_string(label->FileSetMD5);
851 label->FileSetMD5[0] = 0;
853 if (rec->FileIndex == EOS_LABEL) {
854 unser_uint32(label->JobFiles);
855 unser_uint64(label->JobBytes);
856 unser_uint32(label->StartBlock);
857 unser_uint32(label->EndBlock);
858 unser_uint32(label->StartFile);
859 unser_uint32(label->EndFile);
860 unser_uint32(label->JobErrors);
861 if (label->VerNum >= 11) {
862 unser_uint32(label->JobStatus);
864 label->JobStatus = JS_Terminated; /* kludge */
870 void dump_volume_label(DEVICE *dev)
872 int dbl = debug_level;
874 const char *LabelType;
881 switch (dev->VolHdr.LabelType) {
883 LabelType = "PRE_LABEL";
886 LabelType = "VOL_LABEL";
889 LabelType = "EOM_LABEL";
892 LabelType = "SOS_LABEL";
895 LabelType = "EOS_LABEL";
901 sprintf(buf, "Unknown %d", dev->VolHdr.LabelType);
905 Pmsg11(-1, "\nVolume Label:\n"
918 dev->VolHdr.Id, dev->VolHdr.VerNum,
919 dev->VolHdr.VolName, dev->VolHdr.PrevVolName,
920 File, LabelType, dev->VolHdr.LabelSize,
921 dev->VolHdr.PoolName, dev->VolHdr.MediaType,
922 dev->VolHdr.PoolType, dev->VolHdr.HostName);
924 if (dev->VolHdr.VerNum >= 11) {
926 bstrftime(dt, sizeof(dt), btime_to_unix(dev->VolHdr.label_btime));
927 Pmsg1(-1, "Date label written: %s\n", dt);
929 dt.julian_day_number = dev->VolHdr.label_date;
930 dt.julian_day_fraction = dev->VolHdr.label_time;
933 "Date label written: %04d-%02d-%02d at %02d:%02d\n",
934 tm.tm_year+1900, tm.tm_mon+1, tm.tm_mday, tm.tm_hour, tm.tm_min);
942 static void dump_session_label(DEV_RECORD *rec, const char *type)
948 char ec1[30], ec2[30], ec3[30], ec4[30], ec5[30], ec6[30], ec7[30];
950 unser_session_label(&label, rec);
953 Pmsg7(-1, "\n%s Record:\n"
960 "", type, label.JobId, label.VerNum,
961 label.PoolName, label.PoolType,
962 label.JobName, label.ClientName);
964 if (label.VerNum >= 10) {
966 "Job (unique name) : %s\n"
970 "", label.Job, label.FileSetName, label.JobType, label.JobLevel);
973 if (rec->FileIndex == EOS_LABEL) {
984 edit_uint64_with_commas(label.JobFiles, ec1),
985 edit_uint64_with_commas(label.JobBytes, ec2),
986 edit_uint64_with_commas(label.StartBlock, ec3),
987 edit_uint64_with_commas(label.EndBlock, ec4),
988 edit_uint64_with_commas(label.StartFile, ec5),
989 edit_uint64_with_commas(label.EndFile, ec6),
990 edit_uint64_with_commas(label.JobErrors, ec7),
993 if (label.VerNum >= 11) {
995 bstrftime(dt, sizeof(dt), btime_to_unix(label.write_btime));
996 Pmsg1(-1, _("Date written : %s\n"), dt);
998 dt.julian_day_number = label.write_date;
999 dt.julian_day_fraction = label.write_time;
1000 tm_decode(&dt, &tm);
1002 "Date written : %04d-%02d-%02d at %02d:%02d\n"),
1003 tm.tm_year+1900, tm.tm_mon+1, tm.tm_mday, tm.tm_hour, tm.tm_min);
1009 void dump_label_record(DEVICE *dev, DEV_RECORD *rec, int verbose)
1016 switch (rec->FileIndex) {
1018 type = _("Fresh Volume");
1024 type = _("Begin Job Session");
1027 type = _("End Job Session");
1030 type = _("End of Media");
1033 type = ("End of Tape");
1036 type = _("Unknown");
1040 switch (rec->FileIndex) {
1043 unser_volume_label(dev, rec);
1044 dump_volume_label(dev);
1047 dump_session_label(rec, type);
1050 dump_session_label(rec, type);
1053 Pmsg5(-1, "%s Record: SessId=%d SessTime=%d JobId=%d DataLen=%d\n",
1054 type, rec->VolSessionId, rec->VolSessionTime, rec->Stream, rec->data_len);
1057 Pmsg0(-1, _("End of physical tape.\n"));
1060 Pmsg5(-1, "%s Record: SessId=%d SessTime=%d JobId=%d DataLen=%d\n",
1061 type, rec->VolSessionId, rec->VolSessionTime, rec->Stream, rec->data_len);
1065 SESSION_LABEL label;
1066 switch (rec->FileIndex) {
1068 unser_session_label(&label, rec);
1069 Pmsg6(-1, "%s Record: SessId=%d SessTime=%d JobId=%d Level=%c Type=%c\n",
1070 type, rec->VolSessionId, rec->VolSessionTime, rec->Stream,
1071 label.JobLevel, label.JobType);
1074 char ed1[30], ed2[30];
1075 unser_session_label(&label, rec);
1076 Pmsg6(-1, "%s Record: SessId=%d SessTime=%d JobId=%d Level=%c Type=%c\n",
1077 type, rec->VolSessionId, rec->VolSessionTime, rec->Stream,
1078 label.JobLevel, label.JobType);
1079 Pmsg4(-1, " Files=%s Bytes=%s Errors=%d Status=%c\n",
1080 edit_uint64_with_commas(label.JobFiles, ed1),
1081 edit_uint64_with_commas(label.JobBytes, ed2),
1082 label.JobErrors, (char)label.JobStatus);
1088 Pmsg5(-1, "%s Record: SessId=%d SessTime=%d JobId=%d DataLen=%d\n",
1089 type, rec->VolSessionId, rec->VolSessionTime, rec->Stream, rec->data_len);