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;
40 char BaculaId[] = "Bacula 0.9 mortal\n";
41 unsigned int BaculaTapeVersion = 10;
42 unsigned int OldCompatableBaculaTapeVersion = 9;
46 * Read the volume label
48 * If jcr->VolumeName == NULL, we accept any Bacula Volume
49 * If jcr->VolumeName[0] == 0, we accept any Bacula Volume
50 * otherwise jcr->VolumeName must match the Volume.
52 * If VolName given, ensure that it matches
54 * Returns VOL_ code as defined in record.h
64 int read_dev_volume_label(JCR *jcr, DEVICE *dev, DEV_BLOCK *block)
66 char *VolName = jcr->VolumeName;
69 Dmsg2(30, "Enter read_volume_label device=%s vol=%s\n",
70 dev_name(dev), VolName);
72 if (dev->state & ST_LABEL) { /* did we already read label? */
73 /* Compare Volume Names */
74 if (VolName && *VolName && strcmp(dev->VolHdr.VolName, VolName) != 0) {
75 Mmsg(&jcr->errmsg, _("Volume name mismatch on device %s: Wanted %s got %s\n"),
76 dev_name(dev), VolName, dev->VolHdr.VolName);
78 * Cancel Job if too many label errors
81 if (jcr->label_errors > 100) {
82 jcr->JobStatus = JS_Cancelled;
83 Jmsg(jcr, M_FATAL, 0, "%s", jcr->errmsg);
85 return jcr->label_status = VOL_NAME_ERROR;
87 Dmsg0(30, "Leave read_volume_label() VOL_OK\n");
88 return jcr->label_status = VOL_OK; /* label already read */
91 dev->state &= ~(ST_LABEL|ST_APPEND|ST_READ); /* set no label, no append */
93 if (!rewind_dev(dev)) {
94 Mmsg(&jcr->errmsg, _("Couldn't rewind device %s ERR=%s\n"), dev_name(dev),
96 return jcr->label_status = VOL_IO_ERROR;
98 strcpy(dev->VolHdr.Id, "**error**");
100 /* Read the device label block */
101 record = new_record();
102 Dmsg0(90, "Big if statement in read_volume_label\n");
103 if (!read_block_from_dev(dev, block) ||
104 !read_record_from_block(block, record) ||
105 !unser_volume_label(dev, record) ||
106 strcmp(dev->VolHdr.Id, BaculaId) != 0) {
108 Mmsg(&jcr->errmsg, _("Volume on %s is not a Bacula labeled Volume, \
109 because:\n %s"), dev_name(dev), strerror_dev(dev));
113 return jcr->label_status = VOL_NO_LABEL;
120 if (dev->VolHdr.VerNum != BaculaTapeVersion &&
121 dev->VolHdr.VerNum != OldCompatableBaculaTapeVersion) {
122 Mmsg(&jcr->errmsg, _("Volume on %s has wrong Bacula version. Wanted %d got %d\n"),
123 dev_name(dev), BaculaTapeVersion, dev->VolHdr.VerNum);
124 return jcr->label_status = VOL_VERSION_ERROR;
127 /* Compare Volume Names */
128 Dmsg2(30, "Compare Vol names: VolName=%s hdr=%s\n", VolName?VolName:"*", dev->VolHdr.VolName);
129 if (VolName && *VolName && strcmp(dev->VolHdr.VolName, VolName) != 0) {
130 Mmsg(&jcr->errmsg, _("Volume name mismatch. Wanted %s got %s\n"),
131 VolName, dev->VolHdr.VolName);
133 * Cancel Job if too many label errors
134 * => we are in a loop
136 if (jcr->label_errors > 100) {
137 jcr->JobStatus = JS_Cancelled;
138 Jmsg(jcr, M_FATAL, 0, "%s", jcr->errmsg);
140 return jcr->label_status = VOL_NAME_ERROR;
142 Dmsg1(30, "Copy vol_name=%s\n", dev->VolHdr.VolName);
144 /* We are looking for either an unused Bacula tape (PRE_LABEL) or
145 * a Bacula volume label (VOL_LABEL)
147 if (dev->VolHdr.LabelType != PRE_LABEL && dev->VolHdr.LabelType != VOL_LABEL) {
148 Mmsg(&jcr->errmsg, _("Volume on %s has bad Bacula label type: %x\n"),
149 dev_name(dev), dev->VolHdr.LabelType);
150 return jcr->label_status = VOL_LABEL_ERROR;
153 dev->state |= ST_LABEL; /* set has Bacula label */
154 if (debug_level >= 10) {
155 dump_volume_label(dev);
157 Dmsg0(30, "Leave read_volume_label() VOL_OK\n");
158 return jcr->label_status = VOL_OK;
161 /* unser_volume_label
163 * Unserialize the Volume label into the device Volume_Label
166 * Assumes that the record is already read.
168 * Returns: 0 on error
172 int unser_volume_label(DEVICE *dev, DEV_RECORD *rec)
176 if (rec->FileIndex != VOL_LABEL && rec->FileIndex != PRE_LABEL) {
177 Mmsg3(&dev->errmsg, _("Expecting Volume Label, got FI=%s Stream=%s len=%d\n"),
178 FI_to_ascii(rec->FileIndex), stream_to_ascii(rec->Stream),
183 dev->VolHdr.LabelType = rec->FileIndex;
184 dev->VolHdr.LabelSize = rec->data_len;
187 /* Unserialize the record into the Volume Header */
188 ser_begin(rec->data, SER_LENGTH_Volume_Label);
189 #define Fld(x) (dev->VolHdr.x)
190 unser_string(Fld(Id));
192 unser_uint32(Fld(VerNum));
194 unser_float64(Fld(label_date));
195 unser_float64(Fld(label_time));
196 unser_float64(Fld(write_date));
197 unser_float64(Fld(write_time));
199 unser_string(Fld(VolName));
200 unser_string(Fld(PrevVolName));
201 unser_string(Fld(PoolName));
202 unser_string(Fld(PoolType));
203 unser_string(Fld(MediaType));
205 unser_string(Fld(HostName));
206 unser_string(Fld(LabelProg));
207 unser_string(Fld(ProgVersion));
208 unser_string(Fld(ProgDate));
210 ser_end(rec->data, SER_LENGTH_Volume_Label);
212 Dmsg0(90, "ser_read_vol\n");
213 if (debug_level >= 90) {
214 dump_volume_label(dev);
220 * Put a volume label into the block
222 * Returns: 0 on failure
225 int write_volume_label_to_block(JCR *jcr, DEVICE *dev, DEV_BLOCK *block)
229 Dmsg0(20, "write Label in write_volume_label_to_block()\n");
230 memset(&rec, 0, sizeof(rec));
231 rec.data = get_memory(SER_LENGTH_Volume_Label);
233 create_volume_label_record(jcr, dev, &rec);
235 empty_block(block); /* Volume label always at beginning */
236 if (!write_record_to_block(block, &rec)) {
237 free_pool_memory(rec.data);
238 Jmsg1(jcr, M_FATAL, 0, _("Cannot write Volume label to block for device %s\n"),
242 Dmsg1(90, "Wrote label of %d bytes to block\n", rec.data_len);
244 free_pool_memory(rec.data);
249 * create_volume_label_record
250 * Serialize label (from dev->VolHdr structure) into device record.
251 * Assumes that the dev->VolHdr structure is properly
254 static void create_volume_label_record(JCR *jcr, DEVICE *dev, DEV_RECORD *rec)
259 /* Serialize the label into the device record. */
261 ser_begin(rec->data, SER_LENGTH_Volume_Label);
262 #define Fld(x) (dev->VolHdr.x)
265 ser_uint32(Fld(VerNum));
267 ser_float64(Fld(label_date));
268 ser_float64(Fld(label_time));
270 get_current_time(&dt);
271 Fld(write_date) = dt.julian_day_number;
272 Fld(write_time) = dt.julian_day_fraction;
274 ser_float64(Fld(write_date));
275 ser_float64(Fld(write_time));
277 ser_string(Fld(VolName));
278 ser_string(Fld(PrevVolName));
279 ser_string(Fld(PoolName));
280 ser_string(Fld(PoolType));
281 ser_string(Fld(MediaType));
283 ser_string(Fld(HostName));
284 ser_string(Fld(LabelProg));
285 ser_string(Fld(ProgVersion));
286 ser_string(Fld(ProgDate));
288 ser_end(rec->data, SER_LENGTH_Volume_Label);
289 rec->data_len = ser_length(rec->data);
290 rec->FileIndex = Fld(LabelType);
291 rec->VolSessionId = jcr->VolSessionId;
292 rec->VolSessionTime = jcr->VolSessionTime;
293 rec->Stream = jcr->NumVolumes;
294 Dmsg2(100, "Created Vol label rec: FI=%s len=%d\n", FI_to_ascii(rec->FileIndex),
301 * Create a volume label in memory
302 * Returns: 0 on error
305 static int create_volume_label(DEVICE *dev, char *VolName)
308 DEVRES *device = (DEVRES *)dev->device;
310 Dmsg0(90, "Start create_volume_label()\n");
314 memset(&dev->VolHdr, 0, sizeof(dev->VolHdr));
316 /* ***FIXME*** we really need to get the volume name,
317 * pool name, and pool type from the database.
318 * We also need to pickup the MediaType.
320 strcpy(dev->VolHdr.Id, BaculaId);
321 dev->VolHdr.VerNum = BaculaTapeVersion;
322 dev->VolHdr.LabelType = PRE_LABEL; /* Mark tape as unused */
323 strcpy(dev->VolHdr.VolName, VolName);
324 strcpy(dev->VolHdr.PoolName, "Default");
325 strcpy(dev->VolHdr.MediaType, device->media_type);
326 strcpy(dev->VolHdr.PoolType, "Backup");
328 /* Put label time/date in header */
329 get_current_time(&dt);
330 dev->VolHdr.label_date = dt.julian_day_number;
331 dev->VolHdr.label_time = dt.julian_day_fraction;
333 strcpy(dev->VolHdr.LabelProg, my_name);
334 sprintf(dev->VolHdr.ProgVersion, "Ver. %s %s", VERSION, DATE);
335 sprintf(dev->VolHdr.ProgDate, "Build %s %s", __DATE__, __TIME__);
336 dev->state |= ST_LABEL; /* set has Bacula label */
337 if (debug_level >= 90) {
338 dump_volume_label(dev);
344 * Write a Volume Label
345 * !!! Note, this is ONLY used for writing
346 * a fresh volume label. Any data
347 * after the label will be destroyed,
348 * in fact, we write the label 5 times !!!!
350 * This routine expects that open_device() was previously called.
352 * This routine should be used only when labeling a blank tape.
354 int write_volume_label_to_dev(JCR *jcr, DEVRES *device, char *VolName, char *PoolName)
356 DEVICE *dev = device->dev;
362 Dmsg0(99, "write_volume_label()\n");
363 if (!create_volume_label(dev, VolName)) {
366 strcpy(dev->VolHdr.MediaType, device->media_type);
367 strcpy(dev->VolHdr.VolName, VolName);
368 strcpy(dev->VolHdr.PoolName, PoolName);
370 if (!rewind_dev(dev)) {
371 Dmsg2(30, "Bad status on %s from rewind. ERR=%s\n", dev_name(dev), strerror_dev(dev));
375 block = new_block(dev);
376 memset(&rec, 0, sizeof(rec));
377 rec.data = (char *) get_memory(SER_LENGTH_Volume_Label);
378 create_volume_label_record(jcr, dev, &rec);
381 if (!write_record_to_block(block, &rec)) {
382 Dmsg2(30, "Bad Label write on %s. ERR=%s\n", dev_name(dev), strerror_dev(dev));
384 free_pool_memory(rec.data);
387 Dmsg2(30, "Wrote label of %d bytes to %s\n", rec.data_len, dev_name(dev));
389 free_pool_memory(rec.data);
391 Dmsg0(99, "Call write_block_to_device()\n");
392 if (!write_block_to_dev(dev, block)) {
393 Dmsg2(30, "Bad Label write on %s. ERR=%s\n", dev_name(dev), strerror_dev(dev));
396 Dmsg0(99, " Wrote block to device\n");
400 dev->state |= ST_LABEL;
402 if (debug_level >= 20) {
403 dump_volume_label(dev);
411 * Create session label
412 * The pool memory must be released by the calling program
414 void create_session_label(JCR *jcr, DEV_RECORD *rec, int label)
419 rec->sync = 1; /* wait for completion */
420 rec->VolSessionId = jcr->VolSessionId;
421 rec->VolSessionTime = jcr->VolSessionTime;
422 rec->Stream = jcr->JobId;
424 ser_begin(rec->data, SER_LENGTH_Session_Label);
425 ser_string(BaculaId);
426 ser_uint32(BaculaTapeVersion);
428 ser_uint32(jcr->JobId);
430 get_current_time(&dt);
431 ser_float64(dt.julian_day_number);
432 ser_float64(dt.julian_day_fraction);
434 ser_string(jcr->pool_name);
435 ser_string(jcr->pool_type);
436 ser_string(jcr->job_name); /* base Job name */
437 ser_string(jcr->client_name);
438 /* Added in VerNum 10 */
439 ser_string(jcr->Job); /* Unique name of this Job */
440 ser_string(jcr->fileset_name);
441 ser_uint32(jcr->JobType);
442 ser_uint32(jcr->JobLevel);
444 if (label == EOS_LABEL) {
445 ser_uint32(jcr->JobFiles);
446 ser_uint64(jcr->JobBytes);
447 ser_uint32(jcr->start_block);
448 ser_uint32(jcr->end_block);
449 ser_uint32(jcr->start_file);
450 ser_uint32(jcr->end_file);
451 ser_uint32(jcr->JobErrors);
453 ser_end(rec->data, SER_LENGTH_Session_Label);
454 rec->data_len = ser_length(rec->data);
457 /* Write session label
458 * Returns: 0 on failure
461 int write_session_label(JCR *jcr, DEV_BLOCK *block, int label)
463 DEVICE *dev = jcr->device->dev;
467 Dmsg1(90, "session_label record=%x\n", rec);
470 jcr->start_block = dev->block_num;
471 jcr->start_file = dev->file;
474 jcr->end_block = dev->block_num;
475 jcr->end_file = dev->file;
478 Jmsg1(jcr, M_ABORT, 0, _("Bad session label = %d\n"), label);
481 create_session_label(jcr, rec, label);
482 rec->FileIndex = label;
485 * We guarantee that the session record can totally fit
486 * into a block. If not, write the block, and put it in
487 * the next block. Having the sesssion record totally in
488 * one block makes reading them much easier (no need to
489 * read the next block).
491 if (!can_write_record_to_block(block, rec)) {
492 Dmsg0(100, "Cannot write session label to block.\n");
493 if (!write_block_to_device(jcr, dev, block)) {
494 Dmsg0(90, "Got session label write_block_to_dev error.\n");
495 Jmsg(jcr, M_FATAL, 0, _("Error writing Session label to %s: %s\n"),
496 dev_vol_name(dev), strerror(errno));
501 if (!write_record_to_block(block, rec)) {
502 Jmsg(jcr, M_FATAL, 0, _("Error writing Session label to %s: %s\n"),
503 dev_vol_name(dev), strerror(errno));
508 Dmsg6(20, "Write sesson_label record JobId=%d FI=%s SessId=%d Strm=%s len=%d\n\
509 remainder=%d\n", jcr->JobId,
510 FI_to_ascii(rec->FileIndex), rec->VolSessionId,
511 stream_to_ascii(rec->Stream), rec->data_len,
515 Dmsg2(20, "Leave write_session_label Block=%d File=%d\n",
516 dev->block_num, dev->file);
520 void dump_volume_label(DEVICE *dev)
524 char *LabelType, buf[30];
529 switch (dev->VolHdr.LabelType) {
531 LabelType = "PRE_LABEL";
534 LabelType = "VOL_LABEL";
537 LabelType = "EOM_LABEL";
540 LabelType = "SOS_LABEL";
543 LabelType = "EOS_LABEL";
547 sprintf(buf, "Unknown %d", dev->VolHdr.LabelType);
554 Pmsg11(-1, "\nVolume Label:\n\
567 dev->VolHdr.Id, dev->VolHdr.VerNum,
568 dev->VolHdr.VolName, dev->VolHdr.PrevVolName,
569 File, LabelType, dev->VolHdr.LabelSize,
570 dev->VolHdr.PoolName, dev->VolHdr.MediaType,
571 dev->VolHdr.PoolType, dev->VolHdr.HostName);
573 dt.julian_day_number = dev->VolHdr.label_date;
574 dt.julian_day_fraction = dev->VolHdr.label_time;
577 Date label written: %04d-%02d-%02d at %02d:%02d\n",
578 tm.tm_year+1900, tm.tm_mon+1, tm.tm_mday, tm.tm_hour, tm.tm_min);
582 int unser_session_label(SESSION_LABEL *label, DEV_RECORD *rec)
586 unser_begin(rec->data, SER_LENGTH_Session_Label);
587 unser_string(label->Id);
588 unser_uint32(label->VerNum);
589 unser_uint32(label->JobId);
590 unser_float64(label->write_date);
591 unser_float64(label->write_time);
592 unser_string(label->PoolName);
593 unser_string(label->PoolType);
594 unser_string(label->JobName);
595 unser_string(label->ClientName);
596 if (label->VerNum > 9) {
597 unser_string(label->Job); /* Unique name of this Job */
598 unser_string(label->FileSetName);
599 unser_uint32(label->JobType);
600 unser_uint32(label->JobLevel);
602 if (rec->FileIndex == EOS_LABEL) {
603 unser_uint32(label->JobFiles);
604 unser_uint64(label->JobBytes);
605 unser_uint32(label->start_block);
606 unser_uint32(label->end_block);
607 unser_uint32(label->start_file);
608 unser_uint32(label->end_file);
609 unser_uint32(label->JobErrors);
615 static void dump_session_label(DEV_RECORD *rec, char *type)
621 char ec1[30], ec2[30], ec3[30], ec4[30], ec5[30], ec6[30], ec7[30];
624 unser_session_label(&label, rec);
627 Pmsg6(-1, "\n%s Record:\n\
634 label.JobId, label.PoolName, label.PoolType,
635 label.JobName, label.ClientName);
637 if (label.VerNum >= 10) {
639 Job (unique name) : %s\n\
643 ", label.Job, label.FileSetName, label.JobType, label.JobLevel);
646 if (rec->FileIndex == EOS_LABEL) {
656 edit_uint64_with_commas(label.JobFiles, ec1),
657 edit_uint64_with_commas(label.JobBytes, ec2),
658 edit_uint64_with_commas(label.start_block, ec3),
659 edit_uint64_with_commas(label.end_block, ec4),
660 edit_uint64_with_commas(label.start_file, ec5),
661 edit_uint64_with_commas(label.end_file, ec6),
662 edit_uint64_with_commas(label.JobErrors, ec7));
664 dt.julian_day_number = label.write_date;
665 dt.julian_day_fraction = label.write_time;
668 Date written : %04d-%02d-%02d at %02d:%02d\n",
669 tm.tm_year+1900, tm.tm_mon+1, tm.tm_mday, tm.tm_hour, tm.tm_min);
674 void dump_label_record(DEVICE *dev, DEV_RECORD *rec, int verbose)
681 switch (rec->FileIndex) {
683 type = "Fresh Volume";
689 type = "Begin Session";
692 type = "End Session";
695 type = "End of Media";
702 switch (rec->FileIndex) {
705 unser_volume_label(dev, rec);
706 dump_volume_label(dev);
709 dump_session_label(rec, type);
712 dump_session_label(rec, type);
715 Pmsg5(-1, "%s Record: VSessId=%d VSessTime=%d JobId=%d DataLen=%d\n",
716 type, rec->VolSessionId, rec->VolSessionTime, rec->Stream, rec->data_len);
719 Pmsg5(-1, "%s Record: VSessId=%d VSessTime=%d JobId=%d DataLen=%d\n",
720 type, rec->VolSessionId, rec->VolSessionTime, rec->Stream, rec->data_len);
724 Pmsg5(-1, "%s Record: VSessId=%d VSessTime=%d JobId=%d DataLen=%d\n",
725 type, rec->VolSessionId, rec->VolSessionTime, rec->Stream, rec->data_len);