2 Bacula® - The Network Backup Solution
4 Copyright (C) 2002-2008 Free Software Foundation Europe e.V.
6 The main author of Bacula is Kern Sibbald, with contributions from
7 many others, a complete list can be found in the file AUTHORS.
8 This program is Free Software; you can redistribute it and/or
9 modify it under the terms of version two of the GNU General Public
10 License as published by the Free Software Foundation and included
13 This program is distributed in the hope that it will be useful, but
14 WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16 General Public License for more details.
18 You should have received a copy of the GNU General Public License
19 along with this program; if not, write to the Free Software
20 Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
23 Bacula® is a registered trademark of Kern Sibbald.
24 The licensor of Bacula is the Free Software Foundation Europe
25 (FSFE), Fiduciary Program, Sumatrastrasse 25, 8006 Zürich,
26 Switzerland, email:ftf@fsfeurope.org.
30 * Bacula Director -- Bootstrap Record routines.
32 * BSR (bootstrap record) handling routines split from
33 * ua_restore.c July MMIII
35 * Kern Sibbald, July MMII
43 /* Forward referenced functions */
44 static uint32_t write_bsr(UAContext *ua, RESTORE_CTX &rx, FILE *fd);
47 * Create new FileIndex entry for BSR
49 RBSR_FINDEX *new_findex()
51 RBSR_FINDEX *fi = (RBSR_FINDEX *)bmalloc(sizeof(RBSR_FINDEX));
52 memset(fi, 0, sizeof(RBSR_FINDEX));
56 /* Free all BSR FileIndex entries */
57 static void free_findex(RBSR_FINDEX *fi)
60 for ( ; fi; fi=next) {
67 * Get storage device name from Storage resource
69 static bool get_storage_device(char *device, char *storage)
72 if (storage[0] == 0) {
75 store = (STORE *)GetResWithName(R_STORAGE, storage);
79 DEVICE *dev = (DEVICE *)(store->device->first());
83 bstrncpy(device, dev->hdr.name, MAX_NAME_LENGTH);
88 * Our data structures were not designed completely
89 * correctly, so the file indexes cover the full
90 * range regardless of volume. The FirstIndex and LastIndex
91 * passed in here are for the current volume, so when
92 * writing out the fi, constrain them to those values.
94 * We are called here once for each JobMedia record
97 static uint32_t write_findex(RBSR_FINDEX *fi,
98 int32_t FirstIndex, int32_t LastIndex, FILE *fd)
101 for ( ; fi; fi=fi->next) {
102 int32_t findex, findex2;
103 if ((fi->findex >= FirstIndex && fi->findex <= LastIndex) ||
104 (fi->findex2 >= FirstIndex && fi->findex2 <= LastIndex) ||
105 (fi->findex < FirstIndex && fi->findex2 > LastIndex)) {
106 findex = fi->findex < FirstIndex ? FirstIndex : fi->findex;
107 findex2 = fi->findex2 > LastIndex ? LastIndex : fi->findex2;
108 if (findex == findex2) {
109 fprintf(fd, "FileIndex=%d\n", findex);
112 fprintf(fd, "FileIndex=%d-%d\n", findex, findex2);
113 count += findex2 - findex + 1;
121 * Find out if Volume defined with FirstIndex and LastIndex
122 * falls within the range of selected files in the bsr.
124 static bool is_volume_selected(RBSR_FINDEX *fi,
125 int32_t FirstIndex, int32_t LastIndex)
127 for ( ; fi; fi=fi->next) {
128 if ((fi->findex >= FirstIndex && fi->findex <= LastIndex) ||
129 (fi->findex2 >= FirstIndex && fi->findex2 <= LastIndex) ||
130 (fi->findex < FirstIndex && fi->findex2 > LastIndex)) {
138 /* Create a new bootstrap record */
141 RBSR *bsr = (RBSR *)bmalloc(sizeof(RBSR));
142 memset(bsr, 0, sizeof(RBSR));
146 /* Free the entire BSR */
147 void free_bsr(RBSR *bsr)
150 for ( ; bsr; bsr=next) {
151 free_findex(bsr->fi);
152 if (bsr->VolParams) {
153 free(bsr->VolParams);
155 if (bsr->fileregex) {
156 free(bsr->fileregex);
164 * Complete the BSR by filling in the VolumeName and
165 * VolSessionId and VolSessionTime using the JobId
167 bool complete_bsr(UAContext *ua, RBSR *bsr)
169 for ( ; bsr; bsr=bsr->next) {
171 memset(&jr, 0, sizeof(jr));
172 jr.JobId = bsr->JobId;
173 if (!db_get_job_record(ua->jcr, ua->db, &jr)) {
174 ua->error_msg(_("Unable to get Job record. ERR=%s\n"), db_strerror(ua->db));
177 bsr->VolSessionId = jr.VolSessionId;
178 bsr->VolSessionTime = jr.VolSessionTime;
179 if ((bsr->VolCount=db_get_job_volume_parameters(ua->jcr, ua->db, bsr->JobId,
180 &(bsr->VolParams))) == 0) {
181 ua->error_msg(_("Unable to get Job Volume Parameters. ERR=%s\n"), db_strerror(ua->db));
182 if (bsr->VolParams) {
183 free(bsr->VolParams);
184 bsr->VolParams = NULL;
192 static pthread_mutex_t mutex = PTHREAD_MUTEX_INITIALIZER;
193 static uint32_t uniq = 0;
195 static void make_unique_restore_filename(UAContext *ua, POOL_MEM &fname)
198 int i = find_arg_with_value(ua, "bootstrap");
200 Mmsg(fname, "%s", ua->argv[i]);
201 jcr->unlink_bsr = false;
206 Mmsg(fname, "%s/%s.restore.%u.bsr", working_directory, my_name, uniq);
207 jcr->unlink_bsr = true;
209 if (jcr->RestoreBootstrap) {
210 free(jcr->RestoreBootstrap);
212 jcr->RestoreBootstrap = bstrdup(fname.c_str());
216 * Write the bootstrap records to file
218 uint32_t write_bsr_file(UAContext *ua, RESTORE_CTX &rx)
221 POOL_MEM fname(PM_MESSAGE);
225 make_unique_restore_filename(ua, fname);
226 fd = fopen(fname.c_str(), "w+b");
229 ua->error_msg(_("Unable to create bootstrap file %s. ERR=%s\n"),
230 fname.c_str(), be.bstrerror());
233 /* Write them to file */
234 count = write_bsr(ua, rx, fd);
238 ua->info_msg(_("No files found to read. No bootstrap file written.\n"));
242 ua->error_msg(_("Error writing bsr file.\n"));
247 ua->send_msg(_("Bootstrap records written to %s\n"), fname.c_str());
249 if (debug_level >= 10) {
257 static void display_vol_info(UAContext *ua, RESTORE_CTX &rx, JobId_t JobId)
259 POOL_MEM volmsg(PM_MESSAGE);
260 char Device[MAX_NAME_LENGTH];
264 for (bsr=rx.bsr; bsr; bsr=bsr->next) {
265 if (JobId && JobId != bsr->JobId) {
269 for (int i=0; i < bsr->VolCount; i++) {
270 if (bsr->VolParams[i].VolumeName[0]) {
271 if (!get_storage_device(Device, bsr->VolParams[i].Storage)) {
274 if (bsr->VolParams[i].InChanger && bsr->VolParams[i].Slot) {
279 Mmsg(volmsg, "%c%-25.25s %-25.25s %-25.25s",
280 online, bsr->VolParams[i].VolumeName,
281 bsr->VolParams[i].Storage,
283 add_prompt(ua, volmsg.c_str());
289 void display_bsr_info(UAContext *ua, RESTORE_CTX &rx)
294 /* Tell the user what he will need to mount */
296 ua->send_msg(_("The job will require the following\n"
297 " Volume(s) Storage(s) SD Device(s)\n"
298 "===========================================================================\n"));
299 /* Create Unique list of Volumes using prompt list */
300 start_prompt(ua, "");
301 if (*rx.JobIds == 0) {
302 /* Print Volumes in any order */
303 display_vol_info(ua, rx, 0);
305 /* Ensure that the volumes are printed in JobId order */
306 for (p=rx.JobIds; get_next_jobid_from_list(&p, &JobId) > 0; ) {
307 display_vol_info(ua, rx, JobId);
310 for (int i=0; i < ua->num_prompts; i++) {
311 ua->send_msg(" %s\n", ua->prompt[i]);
314 if (ua->num_prompts == 0) {
315 ua->send_msg(_("No Volumes found to restore.\n"));
317 ua->send_msg(_("\nVolumes marked with \"*\" are online.\n"));
326 * Here we actually write out the details of the bsr file.
327 * Note, there is one bsr for each JobId, but the bsr may
328 * have multiple volumes, which have been entered in the
329 * order they were written.
330 * The bsrs must be written out in the order the JobIds
331 * are found in the jobid list.
333 static uint32_t write_bsr(UAContext *ua, RESTORE_CTX &rx, FILE *fd)
335 char ed1[50], ed2[50];
337 uint32_t total_count = 0;
338 uint32_t LastIndex = 0;
342 char device[MAX_NAME_LENGTH];
344 if (*rx.JobIds == 0) {
345 for (bsr=rx.bsr; bsr; bsr=bsr->next) {
347 * For a given volume, loop over all the JobMedia records.
348 * VolCount is the number of JobMedia records.
350 for (int i=0; i < bsr->VolCount; i++) {
351 if (!is_volume_selected(bsr->fi, bsr->VolParams[i].FirstIndex,
352 bsr->VolParams[i].LastIndex)) {
353 bsr->VolParams[i].VolumeName[0] = 0; /* zap VolumeName */
357 find_storage_resource(ua, rx, bsr->VolParams[i].Storage,
358 bsr->VolParams[i].MediaType);
360 fprintf(fd, "Volume=\"%s\"\n", bsr->VolParams[i].VolumeName);
361 fprintf(fd, "MediaType=\"%s\"\n", bsr->VolParams[i].MediaType);
362 if (bsr->fileregex) {
363 fprintf(fd, "FileRegex=%s\n", bsr->fileregex);
365 if (get_storage_device(device, bsr->VolParams[i].Storage)) {
366 fprintf(fd, "Device=\"%s\"\n", device);
368 if (bsr->VolParams[i].Slot > 0) {
369 fprintf(fd, "Slot=%d\n", bsr->VolParams[i].Slot);
371 fprintf(fd, "VolSessionId=%u\n", bsr->VolSessionId);
372 fprintf(fd, "VolSessionTime=%u\n", bsr->VolSessionTime);
373 fprintf(fd, "VolAddr=%s-%s\n", edit_uint64(bsr->VolParams[i].StartAddr, ed1),
374 edit_uint64(bsr->VolParams[i].EndAddr, ed2));
375 // Dmsg2(100, "bsr VolParam FI=%u LI=%u\n",
376 // bsr->VolParams[i].FirstIndex, bsr->VolParams[i].LastIndex);
378 count = write_findex(bsr->fi, bsr->VolParams[i].FirstIndex,
379 bsr->VolParams[i].LastIndex, fd);
381 fprintf(fd, "Count=%u\n", count);
383 total_count += count;
384 /* If the same file is present on two tapes or in two files
385 * on a tape, it is a continuation, and should not be treated
386 * twice in the totals.
388 if (!first && LastIndex == bsr->VolParams[i].FirstIndex) {
392 LastIndex = bsr->VolParams[i].LastIndex;
397 for (p=rx.JobIds; get_next_jobid_from_list(&p, &JobId) > 0; ) {
398 for (bsr=rx.bsr; bsr; bsr=bsr->next) {
399 if (JobId != bsr->JobId) {
403 * For a given volume, loop over all the JobMedia records.
404 * VolCount is the number of JobMedia records.
406 for (int i=0; i < bsr->VolCount; i++) {
407 if (!is_volume_selected(bsr->fi, bsr->VolParams[i].FirstIndex,
408 bsr->VolParams[i].LastIndex)) {
409 bsr->VolParams[i].VolumeName[0] = 0; /* zap VolumeName */
413 find_storage_resource(ua, rx, bsr->VolParams[i].Storage,
414 bsr->VolParams[i].MediaType);
416 fprintf(fd, "Volume=\"%s\"\n", bsr->VolParams[i].VolumeName);
417 fprintf(fd, "MediaType=\"%s\"\n", bsr->VolParams[i].MediaType);
418 if (bsr->fileregex) {
419 fprintf(fd, "FileRegex=%s\n", bsr->fileregex);
421 if (get_storage_device(device, bsr->VolParams[i].Storage)) {
422 fprintf(fd, "Device=\"%s\"\n", device);
424 if (bsr->VolParams[i].Slot > 0) {
425 fprintf(fd, "Slot=%d\n", bsr->VolParams[i].Slot);
427 fprintf(fd, "VolSessionId=%u\n", bsr->VolSessionId);
428 fprintf(fd, "VolSessionTime=%u\n", bsr->VolSessionTime);
429 fprintf(fd, "VolAddr=%s-%s\n", edit_uint64(bsr->VolParams[i].StartAddr, ed1),
430 edit_uint64(bsr->VolParams[i].EndAddr, ed2));
431 // Dmsg2(100, "bsr VolParam FI=%u LI=%u\n",
432 // bsr->VolParams[i].FirstIndex, bsr->VolParams[i].LastIndex);
434 count = write_findex(bsr->fi, bsr->VolParams[i].FirstIndex,
435 bsr->VolParams[i].LastIndex, fd);
437 fprintf(fd, "Count=%u\n", count);
439 total_count += count;
440 /* If the same file is present on two tapes or in two files
441 * on a tape, it is a continuation, and should not be treated
442 * twice in the totals.
444 if (!first && LastIndex == bsr->VolParams[i].FirstIndex) {
448 LastIndex = bsr->VolParams[i].LastIndex;
455 void print_bsr(UAContext *ua, RESTORE_CTX &rx)
457 write_bsr(ua, rx, stdout);
464 * Add a FileIndex to the list of BootStrap records.
465 * Here we are only dealing with JobId's and the FileIndexes
466 * associated with those JobIds.
467 * We expect that JobId, FileIndex are sorted ascending.
469 void add_findex(RBSR *bsr, uint32_t JobId, int32_t findex)
472 RBSR_FINDEX *fi, *lfi;
475 return; /* probably a dummy directory */
478 if (bsr->fi == NULL) { /* if no FI add one */
479 /* This is the first FileIndex item in the chain */
480 bsr->fi = new_findex();
482 bsr->fi->findex = findex;
483 bsr->fi->findex2 = findex;
486 /* Walk down list of bsrs until we find the JobId */
487 if (bsr->JobId != JobId) {
488 for (nbsr=bsr->next; nbsr; nbsr=nbsr->next) {
489 if (nbsr->JobId == JobId) {
495 if (!nbsr) { /* Must add new JobId */
496 /* Add new JobId at end of chain */
497 for (nbsr=bsr; nbsr->next; nbsr=nbsr->next)
499 nbsr->next = new_bsr();
500 nbsr->next->JobId = JobId;
501 nbsr->next->fi = new_findex();
502 nbsr->next->fi->findex = findex;
503 nbsr->next->fi->findex2 = findex;
509 * At this point, bsr points to bsr containing this JobId,
510 * and we are sure that there is at least one fi record.
513 /* Check if this findex is smaller than first item */
514 if (findex < fi->findex) {
515 if ((findex+1) == fi->findex) {
516 fi->findex = findex; /* extend down */
519 fi = new_findex(); /* yes, insert before first item */
521 fi->findex2 = findex;
526 /* Walk down fi chain and find where to insert insert new FileIndex */
527 for ( ; fi; fi=fi->next) {
528 if (findex == (fi->findex2 + 1)) { /* extend up */
530 fi->findex2 = findex;
532 * If the following record contains one higher, merge its
533 * file index by extending it up.
535 if (fi->next && ((findex+1) == fi->next->findex)) {
537 fi->findex2 = nfi->findex2;
538 fi->next = nfi->next;
543 if (findex < fi->findex) { /* add before */
544 if ((findex+1) == fi->findex) {
552 /* Add to last place found */
555 fi->findex2 = findex;
556 fi->next = lfi->next;
562 * Add all possible FileIndexes to the list of BootStrap records.
563 * Here we are only dealing with JobId's and the FileIndexes
564 * associated with those JobIds.
566 void add_findex_all(RBSR *bsr, uint32_t JobId)
571 if (bsr->fi == NULL) { /* if no FI add one */
572 /* This is the first FileIndex item in the chain */
573 bsr->fi = new_findex();
576 bsr->fi->findex2 = INT32_MAX;
579 /* Walk down list of bsrs until we find the JobId */
580 if (bsr->JobId != JobId) {
581 for (nbsr=bsr->next; nbsr; nbsr=nbsr->next) {
582 if (nbsr->JobId == JobId) {
588 if (!nbsr) { /* Must add new JobId */
589 /* Add new JobId at end of chain */
590 for (nbsr=bsr; nbsr->next; nbsr=nbsr->next)
592 nbsr->next = new_bsr();
593 nbsr->next->JobId = JobId;
594 nbsr->next->fi = new_findex();
595 nbsr->next->fi->findex = 1;
596 nbsr->next->fi->findex2 = INT32_MAX;
602 * At this point, bsr points to bsr containing this JobId,
603 * and we are sure that there is at least one fi record.
607 fi->findex2 = INT32_MAX;