3 * label.c Bacula routines to handle labels
11 Copyright (C) 2000, 2001, 2002 Kern Sibbald and John Walker
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 int create_volume_label(DEVICE *dev, char *VolName);
35 static void create_volume_label_record(JCR *jcr, DEVICE *dev, DEV_RECORD *rec);
37 extern char my_name[];
38 extern int debug_level;
41 * Read the volume label
43 * If jcr->VolumeName == NULL, we accept any Bacula Volume
44 * If jcr->VolumeName[0] == 0, we accept any Bacula Volume
45 * otherwise jcr->VolumeName must match the Volume.
47 * If VolName given, ensure that it matches
49 * Returns VOL_ code as defined in record.h
59 int read_dev_volume_label(JCR *jcr, DEVICE *dev, DEV_BLOCK *block)
61 char *VolName = jcr->VolumeName;
65 Dmsg2(30, "Enter read_volume_label device=%s vol=%s\n",
66 dev_name(dev), VolName);
68 if (dev->state & ST_LABEL) { /* did we already read label? */
69 /* Compare Volume Names */
70 if (VolName && *VolName && strcmp(dev->VolHdr.VolName, VolName) != 0) {
71 Mmsg(&jcr->errmsg, _("Volume name mismatch on device %s: Wanted %s got %s\n"),
72 dev_name(dev), VolName, dev->VolHdr.VolName);
74 * Cancel Job if too many label errors
77 if (jcr->label_errors > 100) {
78 jcr->JobStatus = JS_Cancelled;
79 Jmsg(jcr, M_FATAL, 0, "%s", jcr->errmsg);
81 return jcr->label_status = VOL_NAME_ERROR;
83 Dmsg0(30, "Leave read_volume_label() VOL_OK\n");
84 return jcr->label_status = VOL_OK; /* label already read */
87 dev->state &= ~(ST_LABEL|ST_APPEND|ST_READ); /* set no label, no append */
89 if (!rewind_dev(dev)) {
90 Mmsg(&jcr->errmsg, _("Couldn't rewind device %s ERR=%s\n"), dev_name(dev),
92 return jcr->label_status = VOL_IO_ERROR;
94 strcpy(dev->VolHdr.Id, "**error**");
96 /* Read the device label block */
97 record = new_record();
98 Dmsg0(90, "Big if statement in read_volume_label\n");
99 if (!read_block_from_dev(dev, block)) {
100 Mmsg(&jcr->errmsg, _("Volume on %s is not a Bacula labeled Volume, \
101 because:\n %s"), dev_name(dev), strerror_dev(dev));
102 } else if (!read_record_from_block(block, record)) {
103 Mmsg(&jcr->errmsg, _("Could not read Volume label from block.\n"));
104 } else if (!unser_volume_label(dev, record)) {
105 Mmsg(&jcr->errmsg, _("Could not unserialize Volume label: %s\n"),
107 } else if (strcmp(dev->VolHdr.Id, BaculaId) != 0) {
108 Mmsg(&jcr->errmsg, _("Volume Header Id bad: %s\n"), dev->VolHdr.Id);
116 return jcr->label_status = VOL_NO_LABEL;
123 if (dev->VolHdr.VerNum != BaculaTapeVersion &&
124 dev->VolHdr.VerNum != OldCompatibleBaculaTapeVersion1 &&
125 dev->VolHdr.VerNum != OldCompatibleBaculaTapeVersion2) {
126 Mmsg(&jcr->errmsg, _("Volume on %s has wrong Bacula version. Wanted %d got %d\n"),
127 dev_name(dev), BaculaTapeVersion, dev->VolHdr.VerNum);
128 return jcr->label_status = VOL_VERSION_ERROR;
131 /* Compare Volume Names */
132 Dmsg2(30, "Compare Vol names: VolName=%s hdr=%s\n", VolName?VolName:"*", dev->VolHdr.VolName);
133 if (VolName && *VolName && strcmp(dev->VolHdr.VolName, VolName) != 0) {
134 Mmsg(&jcr->errmsg, _("Volume name mismatch. Wanted %s got %s\n"),
135 VolName, dev->VolHdr.VolName);
137 * Cancel Job if too many label errors
138 * => we are in a loop
140 if (jcr->label_errors > 100) {
141 jcr->JobStatus = JS_Cancelled;
142 Jmsg(jcr, M_FATAL, 0, "%s", jcr->errmsg);
144 return jcr->label_status = VOL_NAME_ERROR;
146 Dmsg1(30, "Copy vol_name=%s\n", dev->VolHdr.VolName);
148 /* We are looking for either an unused Bacula tape (PRE_LABEL) or
149 * a Bacula volume label (VOL_LABEL)
151 if (dev->VolHdr.LabelType != PRE_LABEL && dev->VolHdr.LabelType != VOL_LABEL) {
152 Mmsg(&jcr->errmsg, _("Volume on %s has bad Bacula label type: %x\n"),
153 dev_name(dev), dev->VolHdr.LabelType);
154 return jcr->label_status = VOL_LABEL_ERROR;
157 dev->state |= ST_LABEL; /* set has Bacula label */
158 if (debug_level >= 10) {
159 dump_volume_label(dev);
161 Dmsg0(30, "Leave read_volume_label() VOL_OK\n");
162 return jcr->label_status = VOL_OK;
165 /* unser_volume_label
167 * Unserialize the Volume label into the device Volume_Label
170 * Assumes that the record is already read.
172 * Returns: 0 on error
176 int unser_volume_label(DEVICE *dev, DEV_RECORD *rec)
180 if (rec->FileIndex != VOL_LABEL && rec->FileIndex != PRE_LABEL) {
181 Mmsg3(&dev->errmsg, _("Expecting Volume Label, got FI=%s Stream=%s len=%d\n"),
182 FI_to_ascii(rec->FileIndex), stream_to_ascii(rec->Stream),
187 dev->VolHdr.LabelType = rec->FileIndex;
188 dev->VolHdr.LabelSize = rec->data_len;
191 /* Unserialize the record into the Volume Header */
192 ser_begin(rec->data, SER_LENGTH_Volume_Label);
193 #define Fld(x) (dev->VolHdr.x)
194 unser_string(Fld(Id));
196 unser_uint32(Fld(VerNum));
198 if (Fld(VerNum) >= 11) {
199 unser_btime(Fld(label_btime));
200 unser_btime(Fld(write_btime));
201 } else { /* old way */
202 unser_float64(Fld(label_date));
203 unser_float64(Fld(label_time));
205 unser_float64(Fld(write_date)); /* Unused with VerNum >= 11 */
206 unser_float64(Fld(write_time)); /* Unused with VerNum >= 11 */
208 unser_string(Fld(VolName));
209 unser_string(Fld(PrevVolName));
210 unser_string(Fld(PoolName));
211 unser_string(Fld(PoolType));
212 unser_string(Fld(MediaType));
214 unser_string(Fld(HostName));
215 unser_string(Fld(LabelProg));
216 unser_string(Fld(ProgVersion));
217 unser_string(Fld(ProgDate));
219 ser_end(rec->data, SER_LENGTH_Volume_Label);
221 Dmsg0(90, "ser_read_vol\n");
222 if (debug_level >= 90) {
223 dump_volume_label(dev);
229 * Put a volume label into the block
231 * Returns: 0 on failure
234 int write_volume_label_to_block(JCR *jcr, DEVICE *dev, DEV_BLOCK *block)
238 Dmsg0(20, "write Label in write_volume_label_to_block()\n");
239 memset(&rec, 0, sizeof(rec));
240 rec.data = get_memory(SER_LENGTH_Volume_Label);
242 create_volume_label_record(jcr, dev, &rec);
244 empty_block(block); /* Volume label always at beginning */
245 if (!write_record_to_block(block, &rec)) {
246 free_pool_memory(rec.data);
247 Jmsg1(jcr, M_FATAL, 0, _("Cannot write Volume label to block for device %s\n"),
251 Dmsg1(90, "Wrote label of %d bytes to block\n", rec.data_len);
253 free_pool_memory(rec.data);
258 * create_volume_label_record
259 * Serialize label (from dev->VolHdr structure) into device record.
260 * Assumes that the dev->VolHdr structure is properly
263 static void create_volume_label_record(JCR *jcr, DEVICE *dev, DEV_RECORD *rec)
268 /* Serialize the label into the device record. */
270 ser_begin(rec->data, SER_LENGTH_Volume_Label);
271 #define Fld(x) (dev->VolHdr.x)
274 ser_uint32(Fld(VerNum));
276 if (Fld(VerNum >= 11)) {
277 ser_btime(Fld(label_btime));
278 Fld(write_btime) = get_current_btime();
279 ser_btime(Fld(write_btime));
283 ser_float64(Fld(label_date));
284 ser_float64(Fld(label_time));
285 get_current_time(&dt);
286 Fld(write_date) = dt.julian_day_number;
287 Fld(write_time) = dt.julian_day_fraction;
290 ser_float64(Fld(write_date)); /* unused if VerNum >= 11 */
291 ser_float64(Fld(write_time)); /* unused if VerNum >= 11 */
293 ser_string(Fld(VolName));
294 ser_string(Fld(PrevVolName));
295 ser_string(Fld(PoolName));
296 ser_string(Fld(PoolType));
297 ser_string(Fld(MediaType));
299 ser_string(Fld(HostName));
300 ser_string(Fld(LabelProg));
301 ser_string(Fld(ProgVersion));
302 ser_string(Fld(ProgDate));
304 ser_end(rec->data, SER_LENGTH_Volume_Label);
305 rec->data_len = ser_length(rec->data);
306 rec->FileIndex = Fld(LabelType);
307 rec->VolSessionId = jcr->VolSessionId;
308 rec->VolSessionTime = jcr->VolSessionTime;
309 rec->Stream = jcr->NumVolumes;
310 Dmsg2(100, "Created Vol label rec: FI=%s len=%d\n", FI_to_ascii(rec->FileIndex),
317 * Create a volume label in memory
318 * Returns: 0 on error
321 static int create_volume_label(DEVICE *dev, char *VolName)
324 DEVRES *device = (DEVRES *)dev->device;
326 Dmsg0(90, "Start create_volume_label()\n");
330 memset(&dev->VolHdr, 0, sizeof(dev->VolHdr));
332 /* ***FIXME*** we really need to get the volume name,
333 * pool name, and pool type from the database.
334 * We also need to pickup the MediaType.
336 strcpy(dev->VolHdr.Id, BaculaId);
337 dev->VolHdr.VerNum = BaculaTapeVersion;
338 dev->VolHdr.LabelType = PRE_LABEL; /* Mark tape as unused */
339 strcpy(dev->VolHdr.VolName, VolName);
340 strcpy(dev->VolHdr.PoolName, "Default");
341 strcpy(dev->VolHdr.MediaType, device->media_type);
342 strcpy(dev->VolHdr.PoolType, "Backup");
344 /* Put label time/date in header */
345 if (BaculaTapeVersion >= 11) {
346 dev->VolHdr.label_btime = get_current_btime();
347 dev->VolHdr.label_date = 0;
348 dev->VolHdr.label_time = 0;
350 get_current_time(&dt);
351 dev->VolHdr.label_date = dt.julian_day_number;
352 dev->VolHdr.label_time = dt.julian_day_fraction;
355 strcpy(dev->VolHdr.LabelProg, my_name);
356 sprintf(dev->VolHdr.ProgVersion, "Ver. %s %s", VERSION, DATE);
357 sprintf(dev->VolHdr.ProgDate, "Build %s %s", __DATE__, __TIME__);
358 dev->state |= ST_LABEL; /* set has Bacula label */
359 if (debug_level >= 90) {
360 dump_volume_label(dev);
366 * Write a Volume Label
367 * !!! Note, this is ONLY used for writing
368 * a fresh volume label. Any data
369 * after the label will be destroyed,
370 * in fact, we write the label 5 times !!!!
372 * This routine expects that open_device() was previously called.
374 * This routine should be used only when labeling a blank tape.
376 int write_volume_label_to_dev(JCR *jcr, DEVRES *device, char *VolName, char *PoolName)
378 DEVICE *dev = device->dev;
384 Dmsg0(99, "write_volume_label()\n");
385 if (!create_volume_label(dev, VolName)) {
388 strcpy(dev->VolHdr.MediaType, device->media_type);
389 strcpy(dev->VolHdr.VolName, VolName);
390 strcpy(dev->VolHdr.PoolName, PoolName);
392 if (!rewind_dev(dev)) {
393 Dmsg2(30, "Bad status on %s from rewind. ERR=%s\n", dev_name(dev), strerror_dev(dev));
397 block = new_block(dev);
398 memset(&rec, 0, sizeof(rec));
399 rec.data = get_memory(SER_LENGTH_Volume_Label);
400 create_volume_label_record(jcr, dev, &rec);
403 if (!write_record_to_block(block, &rec)) {
404 Dmsg2(30, "Bad Label write on %s. ERR=%s\n", dev_name(dev), strerror_dev(dev));
406 free_pool_memory(rec.data);
409 Dmsg2(30, "Wrote label of %d bytes to %s\n", rec.data_len, dev_name(dev));
411 free_pool_memory(rec.data);
413 Dmsg0(99, "Call write_block_to_device()\n");
414 if (!write_block_to_dev(dev, block)) {
415 Dmsg2(30, "Bad Label write on %s. ERR=%s\n", dev_name(dev), strerror_dev(dev));
418 Dmsg0(99, " Wrote block to device\n");
422 dev->state |= ST_LABEL;
424 if (debug_level >= 20) {
425 dump_volume_label(dev);
433 * Create session label
434 * The pool memory must be released by the calling program
436 void create_session_label(JCR *jcr, DEV_RECORD *rec, int label)
441 rec->sync = 1; /* wait for completion */
442 rec->VolSessionId = jcr->VolSessionId;
443 rec->VolSessionTime = jcr->VolSessionTime;
444 rec->Stream = jcr->JobId;
446 ser_begin(rec->data, SER_LENGTH_Session_Label);
447 ser_string(BaculaId);
448 ser_uint32(BaculaTapeVersion);
450 ser_uint32(jcr->JobId);
452 if (BaculaTapeVersion >= 11) {
453 ser_btime(get_current_btime());
456 get_current_time(&dt);
457 ser_float64(dt.julian_day_number);
458 ser_float64(dt.julian_day_fraction);
461 ser_string(jcr->pool_name);
462 ser_string(jcr->pool_type);
463 ser_string(jcr->job_name); /* base Job name */
464 ser_string(jcr->client_name);
465 /* Added in VerNum 10 */
466 ser_string(jcr->Job); /* Unique name of this Job */
467 ser_string(jcr->fileset_name);
468 ser_uint32(jcr->JobType);
469 ser_uint32(jcr->JobLevel);
471 if (label == EOS_LABEL) {
472 ser_uint32(jcr->JobFiles);
473 ser_uint64(jcr->JobBytes);
474 ser_uint32(jcr->StartBlock);
475 ser_uint32(jcr->EndBlock);
476 ser_uint32(jcr->StartFile);
477 ser_uint32(jcr->EndFile);
478 ser_uint32(jcr->JobErrors);
479 /* Added in VerNum 11 */
480 ser_uint32(jcr->JobStatus);
482 ser_end(rec->data, SER_LENGTH_Session_Label);
483 rec->data_len = ser_length(rec->data);
486 /* Write session label
487 * Returns: 0 on failure
490 int write_session_label(JCR *jcr, DEV_BLOCK *block, int label)
492 DEVICE *dev = jcr->device->dev;
496 Dmsg1(90, "session_label record=%x\n", rec);
499 jcr->StartBlock = dev->block_num;
500 jcr->StartFile = dev->file;
503 jcr->EndBlock = dev->block_num;
504 jcr->EndFile = dev->file;
507 Jmsg1(jcr, M_ABORT, 0, _("Bad session label = %d\n"), label);
510 create_session_label(jcr, rec, label);
511 rec->FileIndex = label;
514 * We guarantee that the session record can totally fit
515 * into a block. If not, write the block, and put it in
516 * the next block. Having the sesssion record totally in
517 * one block makes reading them much easier (no need to
518 * read the next block).
520 if (!can_write_record_to_block(block, rec)) {
521 Dmsg0(100, "Cannot write session label to block.\n");
522 if (!write_block_to_device(jcr, dev, block)) {
523 Dmsg0(90, "Got session label write_block_to_dev error.\n");
524 Jmsg(jcr, M_FATAL, 0, _("Error writing Session label to %s: %s\n"),
525 dev_vol_name(dev), strerror(errno));
530 if (!write_record_to_block(block, rec)) {
531 Jmsg(jcr, M_FATAL, 0, _("Error writing Session label to %s: %s\n"),
532 dev_vol_name(dev), strerror(errno));
537 Dmsg6(20, "Write sesson_label record JobId=%d FI=%s SessId=%d Strm=%s len=%d\n\
538 remainder=%d\n", jcr->JobId,
539 FI_to_ascii(rec->FileIndex), rec->VolSessionId,
540 stream_to_ascii(rec->Stream), rec->data_len,
544 Dmsg2(20, "Leave write_session_label Block=%d File=%d\n",
545 dev->block_num, dev->file);
549 void dump_volume_label(DEVICE *dev)
551 int dbl = debug_level;
553 char *LabelType, buf[30];
559 switch (dev->VolHdr.LabelType) {
561 LabelType = "PRE_LABEL";
564 LabelType = "VOL_LABEL";
567 LabelType = "EOM_LABEL";
570 LabelType = "SOS_LABEL";
573 LabelType = "EOS_LABEL";
579 sprintf(buf, "Unknown %d", dev->VolHdr.LabelType);
584 Pmsg11(-1, "\nVolume Label:\n\
597 dev->VolHdr.Id, dev->VolHdr.VerNum,
598 dev->VolHdr.VolName, dev->VolHdr.PrevVolName,
599 File, LabelType, dev->VolHdr.LabelSize,
600 dev->VolHdr.PoolName, dev->VolHdr.MediaType,
601 dev->VolHdr.PoolType, dev->VolHdr.HostName);
603 if (dev->VolHdr.VerNum >= 11) {
605 bstrftime(dt, sizeof(dt), (time_t)dev->VolHdr.label_btime);
606 Pmsg1(-1, "Date label written: %s\n", dt);
608 dt.julian_day_number = dev->VolHdr.label_date;
609 dt.julian_day_fraction = dev->VolHdr.label_time;
612 Date label written: %04d-%02d-%02d at %02d:%02d\n",
613 tm.tm_year+1900, tm.tm_mon+1, tm.tm_mday, tm.tm_hour, tm.tm_min);
620 int unser_session_label(SESSION_LABEL *label, DEV_RECORD *rec)
624 unser_begin(rec->data, SER_LENGTH_Session_Label);
625 unser_string(label->Id);
626 unser_uint32(label->VerNum);
627 unser_uint32(label->JobId);
628 if (label->VerNum >= 11) {
629 unser_btime(label->write_btime);
631 unser_float64(label->write_date);
633 unser_float64(label->write_time);
634 unser_string(label->PoolName);
635 unser_string(label->PoolType);
636 unser_string(label->JobName);
637 unser_string(label->ClientName);
638 if (label->VerNum >= 10) {
639 unser_string(label->Job); /* Unique name of this Job */
640 unser_string(label->FileSetName);
641 unser_uint32(label->JobType);
642 unser_uint32(label->JobLevel);
644 if (rec->FileIndex == EOS_LABEL) {
645 unser_uint32(label->JobFiles);
646 unser_uint64(label->JobBytes);
647 unser_uint32(label->StartBlock);
648 unser_uint32(label->EndBlock);
649 unser_uint32(label->StartFile);
650 unser_uint32(label->EndFile);
651 unser_uint32(label->JobErrors);
652 if (label->VerNum >= 11) {
653 unser_uint32(label->JobStatus);
655 label->JobStatus = JS_Terminated; /* kludge */
662 static void dump_session_label(DEV_RECORD *rec, char *type)
668 char ec1[30], ec2[30], ec3[30], ec4[30], ec5[30], ec6[30], ec7[30];
670 unser_session_label(&label, rec);
673 Pmsg7(-1, "\n%s Record:\n\
680 ", type, label.JobId, label.VerNum,
681 label.PoolName, label.PoolType,
682 label.JobName, label.ClientName);
684 if (label.VerNum >= 10) {
686 Job (unique name) : %s\n\
690 ", label.Job, label.FileSetName, label.JobType, label.JobLevel);
693 if (rec->FileIndex == EOS_LABEL) {
704 edit_uint64_with_commas(label.JobFiles, ec1),
705 edit_uint64_with_commas(label.JobBytes, ec2),
706 edit_uint64_with_commas(label.StartBlock, ec3),
707 edit_uint64_with_commas(label.EndBlock, ec4),
708 edit_uint64_with_commas(label.StartFile, ec5),
709 edit_uint64_with_commas(label.EndFile, ec6),
710 edit_uint64_with_commas(label.JobErrors, ec7),
713 if (label.VerNum >= 11) {
715 bstrftime(dt, sizeof(dt), (time_t)label.write_btime);
716 Pmsg1(-1, _("Date written : %s\n"), dt);
718 dt.julian_day_number = label.write_date;
719 dt.julian_day_fraction = label.write_time;
722 Date written : %04d-%02d-%02d at %02d:%02d\n"),
723 tm.tm_year+1900, tm.tm_mon+1, tm.tm_mday, tm.tm_hour, tm.tm_min);
729 void dump_label_record(DEVICE *dev, DEV_RECORD *rec, int verbose)
736 switch (rec->FileIndex) {
738 type = _("Fresh Volume");
744 type = _("Begin Session");
747 type = _("End Session");
750 type = _("End of Media");
753 type = ("End of Tape");
760 switch (rec->FileIndex) {
763 unser_volume_label(dev, rec);
764 dump_volume_label(dev);
767 dump_session_label(rec, type);
770 dump_session_label(rec, type);
773 Pmsg5(-1, "%s Record: SessId=%d SessTime=%d JobId=%d DataLen=%d\n",
774 type, rec->VolSessionId, rec->VolSessionTime, rec->Stream, rec->data_len);
777 Pmsg0(-1, _("End of physical tape.\n"));
780 Pmsg5(-1, "%s Record: SessId=%d SessTime=%d JobId=%d DataLen=%d\n",
781 type, rec->VolSessionId, rec->VolSessionTime, rec->Stream, rec->data_len);
785 switch (rec->FileIndex) {
789 unser_session_label(&label, rec);
790 Pmsg6(-1, "%s Record: SessId=%d SessTime=%d JobId=%d Level=%c \
792 type, rec->VolSessionId, rec->VolSessionTime, rec->Stream,
793 label.JobLevel, label.JobType);
799 Pmsg5(-1, "%s Record: SessId=%d SessTime=%d JobId=%d DataLen=%d\n",
800 type, rec->VolSessionId, rec->VolSessionTime, rec->Stream, rec->data_len);