3 * Bacula Director -- Bootstrap Record routines.
5 * BSR (bootstrap record) handling routines split from
6 * ua_restore.c July MMIII
8 * Kern Sibbald, July MMII
14 Copyright (C) 2002-2003 Kern Sibbald and John Walker
16 This program is free software; you can redistribute it and/or
17 modify it under the terms of the GNU General Public License as
18 published by the Free Software Foundation; either version 2 of
19 the License, or (at your option) any later version.
21 This program is distributed in the hope that it will be useful,
22 but WITHOUT ANY WARRANTY; without even the implied warranty of
23 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
24 General Public License for more details.
26 You should have received a copy of the GNU General Public
27 License along with this program; if not, write to the Free
28 Software Foundation, Inc., 59 Temple Place - Suite 330, Boston,
36 /* Forward referenced functions */
37 static void write_bsr(UAContext *ua, RBSR *bsr, FILE *fd);
41 * Create new FileIndex entry for BSR
43 RBSR_FINDEX *new_findex()
45 RBSR_FINDEX *fi = (RBSR_FINDEX *)bmalloc(sizeof(RBSR_FINDEX));
46 memset(fi, 0, sizeof(RBSR_FINDEX));
50 /* Free all BSR FileIndex entries */
51 static void free_findex(RBSR_FINDEX *fi)
54 free_findex(fi->next);
60 * Our data structures were not designed completely
61 * correctly, so the file indexes cover the full
62 * range regardless of volume. The FirstIndex and LastIndex
63 * passed in here are for the current volume, so when
64 * writing out the fi, constrain them to those values.
66 static void write_findex(UAContext *ua, RBSR_FINDEX *fi,
67 int32_t FirstIndex, int32_t LastIndex, FILE *fd)
70 int32_t findex, findex2;
71 findex = fi->findex < FirstIndex ? FirstIndex : fi->findex;
72 findex2 = fi->findex2 > LastIndex ? LastIndex : fi->findex2;
73 if (findex == findex2) {
74 fprintf(fd, "FileIndex=%d\n", findex);
76 fprintf(fd, "FileIndex=%d-%d\n", findex, findex2);
78 write_findex(ua, fi->next, FirstIndex, LastIndex, fd);
83 * Find out if Volume defined with FirstIndex and LastIndex
84 * falls within the range of selected files in the bsr.
86 static bool is_volume_selected(RBSR_FINDEX *fi,
87 int32_t FirstIndex, int32_t LastIndex)
90 if ((fi->findex >= FirstIndex && fi->findex <= LastIndex) ||
91 (fi->findex2 >= FirstIndex && fi->findex2 <= LastIndex) ||
92 (fi->findex < FirstIndex && fi->findex2 > LastIndex)) {
95 return is_volume_selected(fi->next, FirstIndex, LastIndex);
102 static void print_findex(UAContext *ua, RBSR_FINDEX *fi)
105 if (fi->findex == fi->findex2) {
106 bsendmsg(ua, "FileIndex=%d\n", fi->findex);
108 bsendmsg(ua, "FileIndex=%d-%d\n", fi->findex, fi->findex2);
110 print_findex(ua, fi->next);
114 /* Create a new bootstrap record */
117 RBSR *bsr = (RBSR *)bmalloc(sizeof(RBSR));
118 memset(bsr, 0, sizeof(RBSR));
122 /* Free the entire BSR */
123 void free_bsr(RBSR *bsr)
126 free_findex(bsr->fi);
128 if (bsr->VolParams) {
129 free(bsr->VolParams);
136 * Complete the BSR by filling in the VolumeName and
137 * VolSessionId and VolSessionTime using the JobId
139 int complete_bsr(UAContext *ua, RBSR *bsr)
143 memset(&jr, 0, sizeof(jr));
144 jr.JobId = bsr->JobId;
145 if (!db_get_job_record(ua->jcr, ua->db, &jr)) {
146 bsendmsg(ua, _("Unable to get Job record. ERR=%s\n"), db_strerror(ua->db));
149 bsr->VolSessionId = jr.VolSessionId;
150 bsr->VolSessionTime = jr.VolSessionTime;
151 if ((bsr->VolCount=db_get_job_volume_parameters(ua->jcr, ua->db, bsr->JobId,
152 &(bsr->VolParams))) == 0) {
153 bsendmsg(ua, _("Unable to get Job Volume Parameters. ERR=%s\n"), db_strerror(ua->db));
154 if (bsr->VolParams) {
155 free(bsr->VolParams);
156 bsr->VolParams = NULL;
160 return complete_bsr(ua, bsr->next);
166 * Write the bootstrap record to file
168 int write_bsr_file(UAContext *ua, RBSR *bsr)
171 POOLMEM *fname = get_pool_memory(PM_MESSAGE);
174 Mmsg(&fname, "%s/restore.bsr", working_directory);
175 fd = fopen(fname, "w+");
177 bsendmsg(ua, _("Unable to create bootstrap file %s. ERR=%s\n"),
178 fname, strerror(errno));
179 free_pool_memory(fname);
182 /* Write them to file */
183 write_bsr(ua, bsr, fd);
186 bsendmsg(ua, _("Bootstrap records written to %s\n"), fname);
188 /* Tell the user what he will need to mount */
190 bsendmsg(ua, _("The restore job will require the following Volumes:\n"));
191 /* Create Unique list of Volumes using prompt list */
192 start_prompt(ua, "");
193 for (RBSR *nbsr=bsr; nbsr; nbsr=nbsr->next) {
194 for (int i=0; i < nbsr->VolCount; i++) {
195 if (nbsr->VolParams[i].VolumeName[0]) {
196 add_prompt(ua, nbsr->VolParams[i].VolumeName);
200 for (int i=0; i < ua->num_prompts; i++) {
201 bsendmsg(ua, " %s\n", ua->prompt[i]);
206 free_pool_memory(fname);
210 static void write_bsr(UAContext *ua, RBSR *bsr, FILE *fd)
213 for (int i=0; i < bsr->VolCount; i++) {
214 if (!is_volume_selected(bsr->fi, bsr->VolParams[i].FirstIndex,
215 bsr->VolParams[i].LastIndex)) {
216 bsr->VolParams[i].VolumeName[0] = 0; /* zap VolumeName */
219 fprintf(fd, "Volume=\"%s\"\n", bsr->VolParams[i].VolumeName);
220 fprintf(fd, "VolSessionId=%u\n", bsr->VolSessionId);
221 fprintf(fd, "VolSessionTime=%u\n", bsr->VolSessionTime);
222 fprintf(fd, "VolFile=%u-%u\n", bsr->VolParams[i].StartFile,
223 bsr->VolParams[i].EndFile);
224 fprintf(fd, "VolBlock=%u-%u\n", bsr->VolParams[i].StartBlock,
225 bsr->VolParams[i].EndBlock);
227 // Dmsg2(000, "bsr VolParam FI=%u LI=%u\n",
228 // bsr->VolParams[i].FirstIndex, bsr->VolParams[i].LastIndex);
229 write_findex(ua, bsr->fi, bsr->VolParams[i].FirstIndex,
230 bsr->VolParams[i].LastIndex, fd);
232 write_bsr(ua, bsr->next, fd);
236 static void print_bsr(UAContext *ua, RBSR *bsr)
239 for (int i=0; i < bsr->VolCount; i++) {
240 bsendmsg(ua, "Volume=\"%s\"\n", bsr->VolParams[i].VolumeName);
241 bsendmsg(ua, "VolSessionId=%u\n", bsr->VolSessionId);
242 bsendmsg(ua, "VolSessionTime=%u\n", bsr->VolSessionTime);
243 bsendmsg(ua, "VolFile=%u-%u\n", bsr->VolParams[i].StartFile,
244 bsr->VolParams[i].EndFile);
245 bsendmsg(ua, "VolBlock=%u-%u\n", bsr->VolParams[i].StartBlock,
246 bsr->VolParams[i].EndBlock);
247 print_findex(ua, bsr->fi);
249 print_bsr(ua, bsr->next);
255 * Add a FileIndex to the list of BootStrap records.
256 * Here we are only dealing with JobId's and the FileIndexes
257 * associated with those JobIds.
259 void add_findex(RBSR *bsr, uint32_t JobId, int32_t findex)
262 RBSR_FINDEX *fi, *lfi;
265 return; /* probably a dummy directory */
268 if (!bsr->fi) { /* if no FI add one */
269 /* This is the first FileIndex item in the chain */
270 bsr->fi = new_findex();
272 bsr->fi->findex = findex;
273 bsr->fi->findex2 = findex;
276 /* Walk down list of bsrs until we find the JobId */
277 if (bsr->JobId != JobId) {
278 for (nbsr=bsr->next; nbsr; nbsr=nbsr->next) {
279 if (nbsr->JobId == JobId) {
285 if (!nbsr) { /* Must add new JobId */
286 /* Add new JobId at end of chain */
287 for (nbsr=bsr; nbsr->next; nbsr=nbsr->next)
289 nbsr->next = new_bsr();
290 nbsr->next->JobId = JobId;
291 nbsr->next->fi = new_findex();
292 nbsr->next->fi->findex = findex;
293 nbsr->next->fi->findex2 = findex;
299 * At this point, bsr points to bsr containing JobId,
300 * and we are sure that there is at least one fi record.
303 /* Check if this findex is smaller than first item */
304 if (findex < fi->findex) {
305 if ((findex+1) == fi->findex) {
306 fi->findex = findex; /* extend down */
309 fi = new_findex(); /* yes, insert before first item */
311 fi->findex2 = findex;
316 /* Walk down fi chain and find where to insert insert new FileIndex */
317 for ( ; fi; fi=fi->next) {
318 if (findex == (fi->findex2 + 1)) { /* extend up */
320 fi->findex2 = findex;
321 if (fi->next && ((findex+1) == fi->next->findex)) {
323 fi->findex2 = nfi->findex2;
324 fi->next = nfi->next;
329 if (findex < fi->findex) { /* add before */
330 if ((findex+1) == fi->findex) {
338 /* Add to last place found */
341 fi->findex2 = findex;
342 fi->next = lfi->next;