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);
35 static int read_ansi_ibm_label(DCR *dcr);
36 static char *ansi_date(time_t td, char *buf);
38 extern char my_name[];
39 extern int debug_level;
42 * Read the volume label
44 * If dcr->VolumeName == NULL, we accept any Bacula Volume
45 * If dcr->VolumeName[0] == 0, we accept any Bacula Volume
46 * otherwise dcr->VolumeName must match the Volume.
48 * If VolName given, ensure that it matches
50 * Returns VOL_ code as defined in record.h
61 int read_dev_volume_label(DCR *dcr)
64 DEVICE *dev = dcr->dev;
65 char *VolName = dcr->VolumeName;
68 DEV_BLOCK *block = dcr->block;
70 bool want_ansi_ibm_label;
72 Dmsg3(100, "Enter read_volume_label device=%s vol=%s dev_Vol=%s\n",
73 dev_name(dev), VolName, dev->VolHdr.VolName);
75 if (!dev->is_open()) {
76 Emsg0(M_ABORT, 0, _("BAD call to read_dev_volume_label\n"));
78 if (dev->is_labeled()) { /* did we already read label? */
79 /* Compare Volume Names allow special wild card */
80 if (VolName && *VolName && *VolName != '*' && strcmp(dev->VolHdr.VolName, VolName) != 0) {
81 Mmsg(jcr->errmsg, _("Wrong Volume mounted on device %s: Wanted %s have %s\n"),
82 dev_name(dev), VolName, dev->VolHdr.VolName);
84 * Cancel Job if too many label errors
87 if (!dev->poll && jcr->label_errors++ > 100) {
88 Jmsg(jcr, M_FATAL, 0, "Too many tries: %s", jcr->errmsg);
90 return VOL_NAME_ERROR;
92 Dmsg0(30, "Leave read_volume_label() VOL_OK\n");
93 return VOL_OK; /* label already read */
96 dev->state &= ~(ST_LABEL|ST_APPEND|ST_READ); /* set no label, no append */
98 if (!rewind_dev(dev)) {
99 Mmsg(jcr->errmsg, _("Couldn't rewind device %s ERR=%s\n"), dev_name(dev),
101 Dmsg1(30, "%s", jcr->errmsg);
104 bstrncpy(dev->VolHdr.Id, "**error**", sizeof(dev->VolHdr.Id));
106 /* Read ANSI/IBM label if so requested */
108 want_ansi_ibm_label = dcr->VolCatInfo.LabelType != B_BACULA_LABEL ||
109 dcr->device->label_type != B_BACULA_LABEL;
110 if (want_ansi_ibm_label || dev_cap(dev, CAP_CHECKLABELS)) {
111 stat = read_ansi_ibm_label(dcr);
112 /* If we want a label and didn't find it, return error */
113 if (want_ansi_ibm_label && stat != VOL_OK) {
118 if (stat != VOL_OK) { /* Not an ANSI/IBM label, so re-read */
123 /* Read the Bacula Volume label block */
124 record = new_record();
126 Dmsg0(90, "Big if statement in read_volume_label\n");
127 if (!read_block_from_dev(dcr, NO_BLOCK_NUMBER_CHECK)) {
128 Mmsg(jcr->errmsg, _("Requested Volume \"%s\" on %s is not a Bacula "
129 "labeled Volume, because: ERR=%s"), NPRT(VolName), dev_name(dev),
131 Dmsg1(30, "%s", jcr->errmsg);
132 } else if (!read_record_from_block(block, record)) {
133 Mmsg(jcr->errmsg, _("Could not read Volume label from block.\n"));
134 Dmsg1(30, "%s", jcr->errmsg);
135 } else if (!unser_volume_label(dev, record)) {
136 Mmsg(jcr->errmsg, _("Could not unserialize Volume label: ERR=%s\n"),
138 Dmsg1(30, "%s", jcr->errmsg);
139 } else if (strcmp(dev->VolHdr.Id, BaculaId) != 0 &&
140 strcmp(dev->VolHdr.Id, OldBaculaId) != 0) {
141 Mmsg(jcr->errmsg, _("Volume Header Id bad: %s\n"), dev->VolHdr.Id);
142 Dmsg1(30, "%s", jcr->errmsg);
148 if (forge_on || jcr->ignore_label_errors) {
149 dev->state |= ST_LABEL; /* set has Bacula label */
150 Jmsg(jcr, M_ERROR, 0, "%s", jcr->errmsg);
159 /* If we are a streaming device, we only get one chance to read */
160 if (!dev_cap(dev, CAP_STREAM)) {
165 if (dev->VolHdr.VerNum != BaculaTapeVersion &&
166 dev->VolHdr.VerNum != OldCompatibleBaculaTapeVersion1 &&
167 dev->VolHdr.VerNum != OldCompatibleBaculaTapeVersion2) {
168 Mmsg(jcr->errmsg, _("Volume on %s has wrong Bacula version. Wanted %d got %d\n"),
169 dev_name(dev), BaculaTapeVersion, dev->VolHdr.VerNum);
170 Dmsg1(30, "%s", jcr->errmsg);
171 return VOL_VERSION_ERROR;
174 /* We are looking for either an unused Bacula tape (PRE_LABEL) or
175 * a Bacula volume label (VOL_LABEL)
177 if (dev->VolHdr.LabelType != PRE_LABEL && dev->VolHdr.LabelType != VOL_LABEL) {
178 Mmsg(jcr->errmsg, _("Volume on %s has bad Bacula label type: %x\n"),
179 dev_name(dev), dev->VolHdr.LabelType);
180 Dmsg1(30, "%s", jcr->errmsg);
181 return VOL_LABEL_ERROR;
184 dev->state |= ST_LABEL; /* set has Bacula label */
186 /* Compare Volume Names */
187 Dmsg2(30, "Compare Vol names: VolName=%s hdr=%s\n", VolName?VolName:"*", dev->VolHdr.VolName);
188 if (VolName && *VolName && *VolName != '*' && strcmp(dev->VolHdr.VolName, VolName) != 0) {
189 Mmsg(jcr->errmsg, _("Wrong Volume mounted on device %s: Wanted %s have %s\n"),
190 dev_name(dev), VolName, dev->VolHdr.VolName);
191 Dmsg1(30, "%s", jcr->errmsg);
193 * Cancel Job if too many label errors
194 * => we are in a loop
196 if (!dev->poll && jcr->label_errors++ > 100) {
197 Jmsg(jcr, M_FATAL, 0, "Too many tries: %s", jcr->errmsg);
199 return VOL_NAME_ERROR;
201 Dmsg1(30, "Copy vol_name=%s\n", dev->VolHdr.VolName);
203 if (debug_level >= 10) {
204 dump_volume_label(dev);
206 Dmsg0(30, "Leave read_volume_label() VOL_OK\n");
210 /* Read the volume label by guessing the volume name. (only for mounted devices)
211 * write is true if we are reading the label before writing to the device.
213 * If the volume name cannot be guessed :
214 * Writing : returns the label of the current file (on the harddisk).
215 * Reading : returns an error
217 int read_dev_volume_label_guess(DCR *dcr, bool write)
219 int vol_label_status;
220 DEVICE *dev = dcr->dev;
222 Dmsg3(100, "Enter read_dev_volume_label_guess device=%s vol=%s dev_Vol=%s\n",
223 dev_name(dev), dcr->VolumeName, dev->VolHdr.VolName);
225 if (!dev->is_dvd()) {
226 Dmsg0(100, "Leave read_dev_volume_label_guess !CAP_REQMOUNT\n");
227 return read_dev_volume_label(dcr);
230 if (!write && (dcr->VolCatInfo.VolCatParts == 0)) {
231 Dmsg0(100, "Leave read_dev_volume_label_guess !writing, and VolCatParts == 0\n");
232 return read_dev_volume_label(dcr);
235 /* For mounted devices, tries to guess the volume name, and read the label if possible.
237 if (open_guess_name_dev(dev) < 0) {
238 if ((!write) || (dcr->VolCatInfo.VolCatParts > 0)) {
239 Mmsg2(jcr->errmsg, _("Requested Volume \"%s\" on %s is not a Bacula labeled Volume."),
240 dev_name(dev), dcr->VolumeName);
241 Dmsg0(100, "Leave read_dev_volume_label_guess VOL_IO_ERROR (!open_guess_name_dev)\n");
245 if (write && (dev->free_space_errno < 0)) {
246 Dmsg0(100, "Leave read_dev_volume_label_guess !free_space VOL_NO_MEDIA\n");
247 Mmsg2(jcr->errmsg, _("free_space error on %s. The current medium is probably not writable. ERR=%s.\n"),
248 dev->dev_name, dev->errmsg);
252 /* If we can't guess the name, and we are writing, just reopen the right file with open_first_part. */
253 if (open_first_part(dev) < 0) {
255 Mmsg2(jcr->errmsg, _("open_first_part error on %s. ERR=%s.\n"),
256 dev->dev_name, be.strerror());
257 Dmsg0(100, "Leave read_dev_volume_label_guess VOL_IO_ERROR (!open_guess_name_dev && !open_first_part)\n");
261 Dmsg0(100, "Leave read_dev_volume_label_guess !open_guess_name_dev\n");
262 return read_dev_volume_label(dcr);
264 if (write && (dcr->dev->free_space_errno < 0)) {
265 Dmsg0(100, "Leave read_dev_volume_label_guess !free_space VOL_NO_MEDIA\n");
266 Mmsg2(jcr->errmsg, _("free_space error on %s. The current medium is probably not writable. ERR=%s.\n"),
267 dev->dev_name, dev->errmsg);
271 vol_label_status = read_dev_volume_label(dcr);
273 if ((!write) || (dcr->VolCatInfo.VolCatParts > 0)) {
274 Dmsg0(100, "Leave read_dev_volume_label_guess (open_guess_name_dev && (!write || dcr->VolCatInfo.VolCatParts > 0))\n");
275 return vol_label_status;
278 if (open_first_part(dcr->dev) < 0) {
280 Mmsg2(jcr->errmsg, _("open_first_part error on %s. ERR=%s.\n"),
281 dev->dev_name, be.strerror());
282 Dmsg0(100, "Leave read_dev_volume_label_guess VOL_IO_ERROR (open_guess_name_dev && !open_first_part)\n");
286 /* When writing, if the guessed volume name is no the right volume name,
287 * report the error, otherwise, just continue with the right file.
289 if (vol_label_status != VOL_NAME_ERROR) {
290 Dmsg0(100, "Leave read_dev_volume_label_guess (open_guess_name_dev && !VOL_NAME_ERROR)\n");
291 dev->state &= ~ST_LABEL;
292 return read_dev_volume_label(dcr);
295 Dmsg0(100, "Leave read_dev_volume_label_guess (open_guess_name_dev && VOL_NAME_ERROR)\n");
296 return vol_label_status;
301 /* unser_volume_label
303 * Unserialize the Bacula Volume label into the device Volume_Label
306 * Assumes that the record is already read.
308 * Returns: false on error
312 bool unser_volume_label(DEVICE *dev, DEV_RECORD *rec)
316 if (rec->FileIndex != VOL_LABEL && rec->FileIndex != PRE_LABEL) {
317 Mmsg3(dev->errmsg, _("Expecting Volume Label, got FI=%s Stream=%s len=%d\n"),
318 FI_to_ascii(rec->FileIndex),
319 stream_to_ascii(rec->Stream, rec->FileIndex),
326 dev->VolHdr.LabelType = rec->FileIndex;
327 dev->VolHdr.LabelSize = rec->data_len;
330 /* Unserialize the record into the Volume Header */
331 rec->data = check_pool_memory_size(rec->data, SER_LENGTH_Volume_Label);
332 ser_begin(rec->data, SER_LENGTH_Volume_Label);
333 unser_string(dev->VolHdr.Id);
334 unser_uint32(dev->VolHdr.VerNum);
336 if (dev->VolHdr.VerNum >= 11) {
337 unser_btime(dev->VolHdr.label_btime);
338 unser_btime(dev->VolHdr.write_btime);
339 } else { /* old way */
340 unser_float64(dev->VolHdr.label_date);
341 unser_float64(dev->VolHdr.label_time);
343 unser_float64(dev->VolHdr.write_date); /* Unused with VerNum >= 11 */
344 unser_float64(dev->VolHdr.write_time); /* Unused with VerNum >= 11 */
346 unser_string(dev->VolHdr.VolName);
347 unser_string(dev->VolHdr.PrevVolName);
348 unser_string(dev->VolHdr.PoolName);
349 unser_string(dev->VolHdr.PoolType);
350 unser_string(dev->VolHdr.MediaType);
352 unser_string(dev->VolHdr.HostName);
353 unser_string(dev->VolHdr.LabelProg);
354 unser_string(dev->VolHdr.ProgVersion);
355 unser_string(dev->VolHdr.ProgDate);
357 ser_end(rec->data, SER_LENGTH_Volume_Label);
358 Dmsg0(90, "ser_read_vol\n");
359 if (debug_level >= 90) {
360 dump_volume_label(dev);
366 * Put a volume label into the block
368 * Returns: false on failure
371 bool write_volume_label_to_block(DCR *dcr)
374 DEVICE *dev = dcr->dev;
376 DEV_BLOCK *block = dcr->block;
378 Dmsg0(20, "write Label in write_volume_label_to_block()\n");
379 memset(&rec, 0, sizeof(rec));
380 rec.data = get_memory(SER_LENGTH_Volume_Label);
381 empty_block(block); /* Volume label always at beginning */
383 create_volume_label_record(dcr, &rec);
385 block->BlockNumber = 0;
386 if (!write_record_to_block(block, &rec)) {
387 free_pool_memory(rec.data);
388 Jmsg1(jcr, M_FATAL, 0, _("Cannot write Volume label to block for device %s\n"),
392 Dmsg1(90, "Wrote label of %d bytes to block\n", rec.data_len);
394 free_pool_memory(rec.data);
399 * create_volume_label_record
400 * Serialize label (from dev->VolHdr structure) into device record.
401 * Assumes that the dev->VolHdr structure is properly
404 static void create_volume_label_record(DCR *dcr, DEV_RECORD *rec)
408 DEVICE *dev = dcr->dev;
411 /* Serialize the label into the device record. */
413 rec->data = check_pool_memory_size(rec->data, SER_LENGTH_Volume_Label);
414 ser_begin(rec->data, SER_LENGTH_Volume_Label);
415 ser_string(dev->VolHdr.Id);
417 ser_uint32(dev->VolHdr.VerNum);
419 if (dev->VolHdr.VerNum >= 11) {
420 ser_btime(dev->VolHdr.label_btime);
421 dev->VolHdr.write_btime = get_current_btime();
422 ser_btime(dev->VolHdr.write_btime);
423 dev->VolHdr.write_date = 0;
424 dev->VolHdr.write_time = 0;
426 /* OLD WAY DEPRECATED */
427 ser_float64(dev->VolHdr.label_date);
428 ser_float64(dev->VolHdr.label_time);
429 get_current_time(&dt);
430 dev->VolHdr.write_date = dt.julian_day_number;
431 dev->VolHdr.write_time = dt.julian_day_fraction;
433 ser_float64(dev->VolHdr.write_date); /* 0 if VerNum >= 11 */
434 ser_float64(dev->VolHdr.write_time); /* 0 if VerNum >= 11 */
436 ser_string(dev->VolHdr.VolName);
437 ser_string(dev->VolHdr.PrevVolName);
438 ser_string(dev->VolHdr.PoolName);
439 ser_string(dev->VolHdr.PoolType);
440 ser_string(dev->VolHdr.MediaType);
442 ser_string(dev->VolHdr.HostName);
443 ser_string(dev->VolHdr.LabelProg);
444 ser_string(dev->VolHdr.ProgVersion);
445 ser_string(dev->VolHdr.ProgDate);
447 ser_end(rec->data, SER_LENGTH_Volume_Label);
448 rec->data_len = ser_length(rec->data);
449 rec->FileIndex = dev->VolHdr.LabelType;
450 rec->VolSessionId = jcr->VolSessionId;
451 rec->VolSessionTime = jcr->VolSessionTime;
452 rec->Stream = jcr->NumVolumes;
453 Dmsg2(100, "Created Vol label rec: FI=%s len=%d\n", FI_to_ascii(rec->FileIndex),
459 * Create a volume label in memory
461 void create_volume_label(DEVICE *dev, const char *VolName, const char *PoolName)
463 DEVRES *device = (DEVRES *)dev->device;
465 Dmsg0(90, "Start create_volume_label()\n");
469 memset(&dev->VolHdr, 0, sizeof(dev->VolHdr));
471 bstrncpy(dev->VolHdr.Id, BaculaId, sizeof(dev->VolHdr.Id));
472 dev->VolHdr.VerNum = BaculaTapeVersion;
473 dev->VolHdr.LabelType = PRE_LABEL; /* Mark tape as unused */
474 bstrncpy(dev->VolHdr.VolName, VolName, sizeof(dev->VolHdr.VolName));
475 bstrncpy(dev->VolHdr.PoolName, PoolName, sizeof(dev->VolHdr.PoolName));
476 bstrncpy(dev->VolHdr.MediaType, device->media_type, sizeof(dev->VolHdr.MediaType));
478 bstrncpy(dev->VolHdr.PoolType, "Backup", sizeof(dev->VolHdr.PoolType));
480 dev->VolHdr.label_btime = get_current_btime();
481 dev->VolHdr.label_date = 0;
482 dev->VolHdr.label_time = 0;
484 if (gethostname(dev->VolHdr.HostName, sizeof(dev->VolHdr.HostName)) != 0) {
485 dev->VolHdr.HostName[0] = 0;
487 bstrncpy(dev->VolHdr.LabelProg, my_name, sizeof(dev->VolHdr.LabelProg));
488 sprintf(dev->VolHdr.ProgVersion, "Ver. %s %s", VERSION, BDATE);
489 sprintf(dev->VolHdr.ProgDate, "Build %s %s", __DATE__, __TIME__);
490 dev->state |= ST_LABEL; /* set has Bacula label */
491 if (debug_level >= 90) {
492 dump_volume_label(dev);
497 * Write a Volume Label
498 * !!! Note, this is ONLY used for writing
499 * a fresh volume label. Any data
500 * after the label will be destroyed,
501 * in fact, we write the label 5 times !!!!
503 * This routine expects that open_device() was previously called.
505 * This routine should be used only when labeling a blank tape.
507 bool write_new_volume_label_to_dev(DCR *dcr, const char *VolName, const char *PoolName)
510 DEVICE *dev = dcr->dev;
513 Dmsg0(99, "write_volume_label()\n");
514 empty_block(dcr->block);
515 /* Create PRE_LABEL */
516 create_volume_label(dev, VolName, PoolName);
518 if (!rewind_dev(dev)) {
519 memset(&dev->VolHdr, 0, sizeof(dev->VolHdr));
520 Dmsg2(30, "Bad status on %s from rewind. ERR=%s\n", dev_name(dev), strerror_dev(dev));
526 /* Write ANSI/IBM label if so requested */
527 if (!write_ansi_ibm_label(dcr, VolName)) {
528 memset(&dev->VolHdr, 0, sizeof(dev->VolHdr));
532 create_volume_label_record(dcr, dcr->rec);
533 dcr->rec->Stream = 0;
535 /* Temporarily mark in append state to enable writing */
536 dev->state |= ST_APPEND;
537 if (!write_record_to_block(dcr->block, dcr->rec)) {
538 Dmsg2(30, "Bad Label write on %s. ERR=%s\n", dev_name(dev), strerror_dev(dev));
539 memset(&dev->VolHdr, 0, sizeof(dev->VolHdr));
542 Dmsg2(30, "Wrote label of %d bytes to %s\n", dcr->rec->data_len, dev_name(dev));
545 Dmsg0(99, "Call write_block_to_dev()\n");
546 if (!write_block_to_dev(dcr)) {
547 memset(&dev->VolHdr, 0, sizeof(dev->VolHdr));
548 Dmsg2(30, "Bad Label write on %s. ERR=%s\n", dev_name(dev), strerror_dev(dev));
551 Dmsg0(99, " Wrote block to device\n");
553 if (weof_dev(dev, 1) == 0) {
554 dev->state |= ST_LABEL;
558 if (debug_level >= 20) {
559 dump_volume_label(dev);
563 dev->state &= ~ST_APPEND; /* remove append since this is PRE_LABEL */
569 * Create session label
570 * The pool memory must be released by the calling program
572 void create_session_label(DCR *dcr, DEV_RECORD *rec, int label)
577 rec->VolSessionId = jcr->VolSessionId;
578 rec->VolSessionTime = jcr->VolSessionTime;
579 rec->Stream = jcr->JobId;
581 rec->data = check_pool_memory_size(rec->data, SER_LENGTH_Session_Label);
582 ser_begin(rec->data, SER_LENGTH_Session_Label);
583 ser_string(BaculaId);
584 ser_uint32(BaculaTapeVersion);
586 ser_uint32(jcr->JobId);
588 /* Changed in VerNum 11 */
589 ser_btime(get_current_btime());
592 ser_string(dcr->pool_name);
593 ser_string(dcr->pool_type);
594 ser_string(jcr->job_name); /* base Job name */
595 ser_string(jcr->client_name);
597 /* Added in VerNum 10 */
598 ser_string(jcr->Job); /* Unique name of this Job */
599 ser_string(jcr->fileset_name);
600 ser_uint32(jcr->JobType);
601 ser_uint32(jcr->JobLevel);
602 /* Added in VerNum 11 */
603 ser_string(jcr->fileset_md5);
605 if (label == EOS_LABEL) {
606 ser_uint32(jcr->JobFiles);
607 ser_uint64(jcr->JobBytes);
608 ser_uint32(dcr->StartBlock);
609 ser_uint32(dcr->EndBlock);
610 ser_uint32(dcr->StartFile);
611 ser_uint32(dcr->EndFile);
612 ser_uint32(jcr->JobErrors);
614 /* Added in VerNum 11 */
615 ser_uint32(jcr->JobStatus);
617 ser_end(rec->data, SER_LENGTH_Session_Label);
618 rec->data_len = ser_length(rec->data);
621 /* Write session label
622 * Returns: false on failure
625 bool write_session_label(DCR *dcr, int label)
628 DEVICE *dev = dcr->dev;
630 DEV_BLOCK *block = dcr->block;
633 Dmsg1(90, "session_label record=%x\n", rec);
636 if (dev->is_tape()) {
637 dcr->StartBlock = dev->block_num;
638 dcr->StartFile = dev->file;
640 dcr->StartBlock = (uint32_t)dev->file_addr;
641 dcr->StartFile = (uint32_t)(dev->file_addr >> 32);
645 if (dev->is_tape()) {
646 dcr->EndBlock = dev->EndBlock;
647 dcr->EndFile = dev->EndFile;
649 dcr->EndBlock = (uint32_t)dev->file_addr;
650 dcr->EndFile = (uint32_t)(dev->file_addr >> 32);
654 Jmsg1(jcr, M_ABORT, 0, _("Bad session label = %d\n"), label);
657 create_session_label(dcr, rec, label);
658 rec->FileIndex = label;
661 * We guarantee that the session record can totally fit
662 * into a block. If not, write the block, and put it in
663 * the next block. Having the sesssion record totally in
664 * one block makes reading them much easier (no need to
665 * read the next block).
667 if (!can_write_record_to_block(block, rec)) {
668 Dmsg0(100, "Cannot write session label to block.\n");
669 if (!write_block_to_device(dcr)) {
670 Dmsg0(90, "Got session label write_block_to_dev error.\n");
671 /* ****FIXME***** errno is not set here */
672 Jmsg(jcr, M_FATAL, 0, _("Error writing Session label to %s: %s\n"),
673 dev_vol_name(dev), strerror(errno));
678 if (!write_record_to_block(block, rec)) {
679 Jmsg(jcr, M_FATAL, 0, _("Error writing Session label to %s: %s\n"),
680 dev_vol_name(dev), strerror(errno));
685 Dmsg6(20, "Write sesson_label record JobId=%d FI=%s SessId=%d Strm=%s len=%d "
686 "remainder=%d\n", jcr->JobId,
687 FI_to_ascii(rec->FileIndex), rec->VolSessionId,
688 stream_to_ascii(rec->Stream, rec->FileIndex), rec->data_len,
692 Dmsg2(20, "Leave write_session_label Block=%d File=%d\n",
693 dev->block_num, dev->file);
697 void dump_volume_label(DEVICE *dev)
699 int dbl = debug_level;
701 const char *LabelType;
708 switch (dev->VolHdr.LabelType) {
710 LabelType = "PRE_LABEL";
713 LabelType = "VOL_LABEL";
716 LabelType = "EOM_LABEL";
719 LabelType = "SOS_LABEL";
722 LabelType = "EOS_LABEL";
728 sprintf(buf, "Unknown %d", dev->VolHdr.LabelType);
732 Pmsg11(-1, "\nVolume Label:\n"
745 dev->VolHdr.Id, dev->VolHdr.VerNum,
746 dev->VolHdr.VolName, dev->VolHdr.PrevVolName,
747 File, LabelType, dev->VolHdr.LabelSize,
748 dev->VolHdr.PoolName, dev->VolHdr.MediaType,
749 dev->VolHdr.PoolType, dev->VolHdr.HostName);
751 if (dev->VolHdr.VerNum >= 11) {
753 bstrftime(dt, sizeof(dt), btime_to_unix(dev->VolHdr.label_btime));
754 Pmsg1(-1, "Date label written: %s\n", dt);
756 dt.julian_day_number = dev->VolHdr.label_date;
757 dt.julian_day_fraction = dev->VolHdr.label_time;
760 "Date label written: %04d-%02d-%02d at %02d:%02d\n",
761 tm.tm_year+1900, tm.tm_mon+1, tm.tm_mday, tm.tm_hour, tm.tm_min);
768 bool unser_session_label(SESSION_LABEL *label, DEV_RECORD *rec)
772 rec->data = check_pool_memory_size(rec->data, SER_LENGTH_Session_Label);
773 unser_begin(rec->data, SER_LENGTH_Session_Label);
774 unser_string(label->Id);
775 unser_uint32(label->VerNum);
776 unser_uint32(label->JobId);
777 if (label->VerNum >= 11) {
778 unser_btime(label->write_btime);
780 unser_float64(label->write_date);
782 unser_float64(label->write_time);
783 unser_string(label->PoolName);
784 unser_string(label->PoolType);
785 unser_string(label->JobName);
786 unser_string(label->ClientName);
787 if (label->VerNum >= 10) {
788 unser_string(label->Job); /* Unique name of this Job */
789 unser_string(label->FileSetName);
790 unser_uint32(label->JobType);
791 unser_uint32(label->JobLevel);
793 if (label->VerNum >= 11) {
794 unser_string(label->FileSetMD5);
796 label->FileSetMD5[0] = 0;
798 if (rec->FileIndex == EOS_LABEL) {
799 unser_uint32(label->JobFiles);
800 unser_uint64(label->JobBytes);
801 unser_uint32(label->StartBlock);
802 unser_uint32(label->EndBlock);
803 unser_uint32(label->StartFile);
804 unser_uint32(label->EndFile);
805 unser_uint32(label->JobErrors);
806 if (label->VerNum >= 11) {
807 unser_uint32(label->JobStatus);
809 label->JobStatus = JS_Terminated; /* kludge */
816 static void dump_session_label(DEV_RECORD *rec, const char *type)
822 char ec1[30], ec2[30], ec3[30], ec4[30], ec5[30], ec6[30], ec7[30];
824 unser_session_label(&label, rec);
827 Pmsg7(-1, "\n%s Record:\n"
834 "", type, label.JobId, label.VerNum,
835 label.PoolName, label.PoolType,
836 label.JobName, label.ClientName);
838 if (label.VerNum >= 10) {
840 "Job (unique name) : %s\n"
844 "", label.Job, label.FileSetName, label.JobType, label.JobLevel);
847 if (rec->FileIndex == EOS_LABEL) {
858 edit_uint64_with_commas(label.JobFiles, ec1),
859 edit_uint64_with_commas(label.JobBytes, ec2),
860 edit_uint64_with_commas(label.StartBlock, ec3),
861 edit_uint64_with_commas(label.EndBlock, ec4),
862 edit_uint64_with_commas(label.StartFile, ec5),
863 edit_uint64_with_commas(label.EndFile, ec6),
864 edit_uint64_with_commas(label.JobErrors, ec7),
867 if (label.VerNum >= 11) {
869 bstrftime(dt, sizeof(dt), btime_to_unix(label.write_btime));
870 Pmsg1(-1, _("Date written : %s\n"), dt);
872 dt.julian_day_number = label.write_date;
873 dt.julian_day_fraction = label.write_time;
876 "Date written : %04d-%02d-%02d at %02d:%02d\n"),
877 tm.tm_year+1900, tm.tm_mon+1, tm.tm_mday, tm.tm_hour, tm.tm_min);
883 void dump_label_record(DEVICE *dev, DEV_RECORD *rec, int verbose)
890 switch (rec->FileIndex) {
892 type = _("Fresh Volume");
898 type = _("Begin Job Session");
901 type = _("End Job Session");
904 type = _("End of Media");
907 type = ("End of Tape");
914 switch (rec->FileIndex) {
917 unser_volume_label(dev, rec);
918 dump_volume_label(dev);
921 dump_session_label(rec, type);
924 dump_session_label(rec, type);
927 Pmsg5(-1, "%s Record: SessId=%d SessTime=%d JobId=%d DataLen=%d\n",
928 type, rec->VolSessionId, rec->VolSessionTime, rec->Stream, rec->data_len);
931 Pmsg0(-1, _("End of physical tape.\n"));
934 Pmsg5(-1, "%s Record: SessId=%d SessTime=%d JobId=%d DataLen=%d\n",
935 type, rec->VolSessionId, rec->VolSessionTime, rec->Stream, rec->data_len);
940 switch (rec->FileIndex) {
942 unser_session_label(&label, rec);
943 Pmsg6(-1, "%s Record: SessId=%d SessTime=%d JobId=%d Level=%c Type=%c\n",
944 type, rec->VolSessionId, rec->VolSessionTime, rec->Stream,
945 label.JobLevel, label.JobType);
948 char ed1[30], ed2[30];
949 unser_session_label(&label, rec);
950 Pmsg6(-1, "%s Record: SessId=%d SessTime=%d JobId=%d Level=%c Type=%c\n",
951 type, rec->VolSessionId, rec->VolSessionTime, rec->Stream,
952 label.JobLevel, label.JobType);
953 Pmsg4(-1, " Files=%s Bytes=%s Errors=%d Status=%c\n",
954 edit_uint64_with_commas(label.JobFiles, ed1),
955 edit_uint64_with_commas(label.JobBytes, ed2),
956 label.JobErrors, (char)label.JobStatus);
962 Pmsg5(-1, "%s Record: SessId=%d SessTime=%d JobId=%d DataLen=%d\n",
963 type, rec->VolSessionId, rec->VolSessionTime, rec->Stream, rec->data_len);
973 * Write an ANSI or IBM 80 character tape label
974 * Assume we are positioned at the beginning of the tape.
975 * Returns: true of OK
978 bool write_ansi_ibm_label(DCR *dcr, const char *VolName)
980 DEVICE *dev = dcr->dev;
982 char label[80]; /* tape label */
983 char date[20]; /* ansi date buffer */
985 int len, stat, label_type;
988 * If the Device requires a specific label type use it,
989 * otherwise, use the type requested by the Director
991 if (dcr->device->label_type != B_BACULA_LABEL) {
992 label_type = dcr->device->label_type; /* force label type */
994 label_type = dcr->VolCatInfo.LabelType; /* accept Dir type */
997 switch (label_type) {
1003 Dmsg1(000, "Write ANSI label type=%d\n", label_type);
1004 len = strlen(VolName);
1006 len = 6; /* max len ANSI label */
1008 memset(label, ' ', sizeof(label));
1009 ser_begin(label, sizeof(label));
1010 ser_bytes("VOL1", 4);
1011 ser_bytes(VolName, len);
1012 label[79] = '3'; /* ANSI label flag */
1013 /* Write VOL1 label */
1014 stat = write(dev->fd, label, sizeof(label));
1015 if (stat != sizeof(label)) {
1017 Jmsg1(jcr, M_FATAL, 0, _("Could not write ANSI VOL1 label. ERR=%s\n"),
1021 /* Now construct HDR1 label */
1022 ser_begin(label, sizeof(label));
1023 ser_bytes("HDR1", 4);
1024 len = strlen(VolName);
1026 len = 17; /* Max filename len */
1028 ser_bytes(VolName, len); /* stick Volume name in Filename field */
1032 ser_begin(&label[21], sizeof(label)-21);
1033 ser_bytes(VolName, len); /* write Vol Ser No. */
1034 ser_begin(&label[27], sizeof(label)-27);
1035 ser_bytes("00010001000100", 14); /* File section, File seq no, Generation no */
1037 ser_bytes(ansi_date(now, date), 6); /* current date */
1038 ser_bytes(ansi_date(now - 24 * 3600, date), 6); /* created yesterday */
1039 ser_bytes(" 000000Bacula ", 27);
1040 /* Write HDR1 label */
1041 stat = write(dev->fd, label, sizeof(label));
1042 if (stat != sizeof(label)) {
1044 Jmsg1(jcr, M_FATAL, 0, _("Could not write ANSI HDR1 label. ERR=%s\n"),
1048 /* Now construct HDR2 label */
1049 memset(label, ' ', sizeof(label));
1050 ser_begin(label, sizeof(label));
1051 ser_bytes("HDR2F3200032000", 15);
1052 /* Write HDR1 label */
1053 stat = write(dev->fd, label, sizeof(label));
1054 if (stat != sizeof(label)) {
1056 Jmsg1(jcr, M_FATAL, 0, _("Could not write ANSI HDR1 label. ERR=%s\n"),
1060 if (weof_dev(dev, 1) < 0) {
1061 Jmsg(jcr, M_FATAL, 0, _("Error writing EOF to tape. ERR=%s"), dev->errmsg);
1066 Jmsg0(jcr, M_ABORT, 0, _("write_ansi_ibm_label called for non-ANSI/IBM type\n"));
1067 return false; /* should not get here */
1071 static int read_ansi_ibm_label(DCR *dcr)
1073 DEVICE *dev = dcr->dev;
1074 JCR *jcr = dcr->jcr;
1075 char label[80]; /* tape label */
1076 int stat, i, num_rec;
1079 * Read VOL1, HDR1, HDR2 labels, but ignore the data
1080 * If tape read the following EOF mark, on disk do
1083 Dmsg0(000, "Read ansi label.\n");
1084 if (dev->is_tape()) {
1089 for (i=0; i < num_rec; i++) {
1091 stat = read(dev->fd, label, sizeof(label));
1092 } while (stat == -1 && errno == EINTR);
1095 clrerror_dev(dev, -1);
1096 Dmsg1(000, "Read device got: ERR=%s\n", be.strerror());
1097 Mmsg2(dev->errmsg, _("Read error on device %s in ANSI/IBM label. ERR=%s\n"),
1098 dev->dev_name, be.strerror());
1099 Jmsg(jcr, M_ERROR, 0, "%s", dev->errmsg);
1100 dev->VolCatInfo.VolCatErrors++;
1101 return VOL_IO_ERROR;
1104 if (dev->at_eof()) {
1105 dev->state |= ST_EOT;
1106 return VOL_NO_LABEL;
1108 dev->state |= ST_EOF;
1112 case 0: /* Want VOL1 label */
1113 if (stat != 80 || strncmp("VOL1", label, 4) != 0) {
1114 Dmsg0(000, "No VOL1 label\n");
1115 return VOL_NO_LABEL;
1119 if (stat != 80 || strncmp("HDR1", label, 4) != 0) {
1120 Dmsg0(000, "No HDR1 label\n");
1121 return VOL_NO_LABEL;
1125 if (stat != 80 || strncmp("HDR2", label, 4) != 0) {
1126 Dmsg0(000, "No HDR2 label\n");
1127 return VOL_NO_LABEL;
1130 case 3: /* Should get EOF here */
1132 Dmsg0(000, "No EOF\n");
1133 return VOL_IO_ERROR;
1138 /* ***FIXME*** add detection of IBM labels */
1139 dev->label_type = B_ANSI_LABEL;
1140 Dmsg0(000, "ANSI label OK\n");
1145 static char *ansi_date(time_t td, char *buf)
1153 bsnprintf(buf, 10, " %05d ", 1000 * (tm->tm_year + 1900 - 2000) + tm->tm_yday);