2 * Parse a Bootstrap Records (used for restores)
4 * Kern Sibbald, June MMII
10 Copyright (C) 2002 Kern Sibbald and John Walker
12 This program is free software; you can redistribute it and/or
13 modify it under the terms of the GNU General Public License as
14 published by the Free Software Foundation; either version 2 of
15 the License, or (at your option) any later version.
17 This program is distributed in the hope that it will be useful,
18 but WITHOUT ANY WARRANTY; without even the implied warranty of
19 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
20 General Public License for more details.
22 You should have received a copy of the GNU General Public
23 License along with this program; if not, write to the Free
32 typedef BSR * (ITEM_HANDLER)(LEX *lc, BSR *bsr);
34 static BSR *store_vol(LEX *lc, BSR *bsr);
35 static BSR *store_client(LEX *lc, BSR *bsr);
36 static BSR *store_job(LEX *lc, BSR *bsr);
37 static BSR *store_jobid(LEX *lc, BSR *bsr);
38 static BSR *store_count(LEX *lc, BSR *bsr);
39 static BSR *store_jobtype(LEX *lc, BSR *bsr);
40 static BSR *store_joblevel(LEX *lc, BSR *bsr);
41 static BSR *store_findex(LEX *lc, BSR *bsr);
42 static BSR *store_sessid(LEX *lc, BSR *bsr);
43 static BSR *store_volfile(LEX *lc, BSR *bsr);
44 static BSR *store_volblock(LEX *lc, BSR *bsr);
45 static BSR *store_sesstime(LEX *lc, BSR *bsr);
46 static BSR *store_include(LEX *lc, BSR *bsr);
47 static BSR *store_exclude(LEX *lc, BSR *bsr);
48 static BSR *store_stream(LEX *lc, BSR *bsr);
49 static BSR *store_slot(LEX *lc, BSR *bsr);
53 ITEM_HANDLER *handler;
57 * List of all keywords permitted in bsr files and their handlers
59 struct kw_items items[] = {
60 {"volume", store_vol},
61 {"client", store_client},
63 {"jobid", store_jobid},
64 {"count", store_count},
65 {"fileindex", store_findex},
66 {"jobtype", store_jobtype},
67 {"joblevel", store_joblevel},
68 {"volsessionid", store_sessid},
69 {"volsessiontime", store_sesstime},
70 {"include", store_include},
71 {"exclude", store_exclude},
72 {"volfile", store_volfile},
73 {"volblock", store_volblock},
74 {"stream", store_stream},
85 BSR *bsr = (BSR *)malloc(sizeof(BSR));
86 memset(bsr, 0, sizeof(BSR));
91 * Format a scanner error message
93 static void s_err(char *file, int line, LEX *lc, char *msg, ...)
95 JCR *jcr = (JCR *)(lc->caller_ctx);
99 va_start(arg_ptr, msg);
100 bvsnprintf(buf, sizeof(buf), msg, arg_ptr);
104 Jmsg(jcr, M_FATAL, 0, _("Bootstrap file error: %s\n\
105 : Line %d, col %d of file %s\n%s\n"),
106 buf, lc->line_no, lc->col_no, lc->fname, lc->line);
108 e_msg(file, line, M_FATAL, 0, _("Bootstrap file error: %s\n\
109 : Line %d, col %d of file %s\n%s\n"),
110 buf, lc->line_no, lc->col_no, lc->fname, lc->line);
115 /*********************************************************************
117 * Parse Bootstrap file
120 BSR *parse_bsr(JCR *jcr, char *cf)
124 BSR *root_bsr = new_bsr();
127 Dmsg1(200, "Enter parse_bsf %s\n", cf);
128 lc = lex_open_file(lc, cf, s_err);
129 lc->caller_ctx = (void *)jcr;
130 while ((token=lex_get_token(lc, T_ALL)) != T_EOF) {
131 Dmsg1(200, "parse got token=%s\n", lex_tok_to_str(token));
132 if (token == T_EOL) {
135 for (i=0; items[i].name; i++) {
136 if (strcasecmp(items[i].name, lc->str) == 0) {
137 token = lex_get_token(lc, T_ALL);
138 Dmsg1 (200, "in T_IDENT got token=%s\n", lex_tok_to_str(token));
139 if (token != T_EQUALS) {
140 scan_err1(lc, "expected an equals, got: %s", lc->str);
144 Dmsg1(200, "calling handler for %s\n", items[i].name);
145 /* Call item handler */
146 bsr = items[i].handler(lc, bsr);
152 Dmsg1(200, "Keyword = %s\n", lc->str);
153 scan_err1(lc, "Keyword %s not found", lc->str);
161 lc = lex_close_file(lc);
162 Dmsg0(200, "Leave parse_bsf()\n");
170 static BSR *store_vol(LEX *lc, BSR *bsr)
176 token = lex_get_token(lc, T_STRING);
177 if (token == T_ERROR) {
181 bsr->next = new_bsr();
184 /* This may actually be more than one volume separated by a |
185 * If so, separate them.
187 for (p=lc->str; p && *p; ) {
192 volume = (BSR_VOLUME *)malloc(sizeof(BSR_VOLUME));
193 memset(volume, 0, sizeof(BSR_VOLUME));
194 bstrncpy(volume->VolumeName, p, sizeof(volume->VolumeName));
195 /* Add it to the end of the volume chain */
197 bsr->volume = volume;
199 BSR_VOLUME *bc = bsr->volume;
200 for ( ;bc->next; bc=bc->next)
209 static BSR *store_client(LEX *lc, BSR *bsr)
215 token = lex_get_token(lc, T_NAME);
216 if (token == T_ERROR) {
219 client = (BSR_CLIENT *)malloc(sizeof(BSR_CLIENT));
220 memset(client, 0, sizeof(BSR_CLIENT));
221 bstrncpy(client->ClientName, lc->str, sizeof(client->ClientName));
222 /* Add it to the end of the client chain */
224 bsr->client = client;
226 BSR_CLIENT *bc = bsr->client;
227 for ( ;bc->next; bc=bc->next)
231 token = lex_get_token(lc, T_ALL);
232 if (token != T_COMMA) {
239 static BSR *store_job(LEX *lc, BSR *bsr)
245 token = lex_get_token(lc, T_NAME);
246 if (token == T_ERROR) {
249 job = (BSR_JOB *)malloc(sizeof(BSR_JOB));
250 memset(job, 0, sizeof(BSR_JOB));
251 bstrncpy(job->Job, lc->str, sizeof(job->Job));
252 /* Add it to the end of the client chain */
256 /* Add to end of chain */
257 BSR_JOB *bc = bsr->job;
258 for ( ;bc->next; bc=bc->next)
262 token = lex_get_token(lc, T_ALL);
263 if (token != T_COMMA) {
270 static BSR *store_findex(LEX *lc, BSR *bsr)
276 token = lex_get_token(lc, T_PINT32_RANGE);
277 if (token == T_ERROR) {
280 findex = (BSR_FINDEX *)malloc(sizeof(BSR_FINDEX));
281 memset(findex, 0, sizeof(BSR_FINDEX));
282 findex->findex = lc->pint32_val;
283 findex->findex2 = lc->pint32_val2;
284 /* Add it to the end of the chain */
285 if (!bsr->FileIndex) {
286 bsr->FileIndex = findex;
288 /* Add to end of chain */
289 BSR_FINDEX *bs = bsr->FileIndex;
290 for ( ;bs->next; bs=bs->next)
294 token = lex_get_token(lc, T_ALL);
295 if (token != T_COMMA) {
303 static BSR *store_jobid(LEX *lc, BSR *bsr)
309 token = lex_get_token(lc, T_PINT32_RANGE);
310 if (token == T_ERROR) {
313 jobid = (BSR_JOBID *)malloc(sizeof(BSR_JOBID));
314 memset(jobid, 0, sizeof(BSR_JOBID));
315 jobid->JobId = lc->pint32_val;
316 jobid->JobId2 = lc->pint32_val2;
317 /* Add it to the end of the chain */
321 /* Add to end of chain */
322 BSR_JOBID *bs = bsr->JobId;
323 for ( ;bs->next; bs=bs->next)
327 token = lex_get_token(lc, T_ALL);
328 if (token != T_COMMA) {
336 static BSR *store_count(LEX *lc, BSR *bsr)
340 token = lex_get_token(lc, T_PINT32);
341 if (token == T_ERROR) {
344 bsr->count = lc->pint32_val;
350 static BSR *store_jobtype(LEX *lc, BSR *bsr)
352 /* *****FIXME****** */
353 Dmsg0(-1, "JobType not yet implemented\n");
358 static BSR *store_joblevel(LEX *lc, BSR *bsr)
360 /* *****FIXME****** */
361 Dmsg0(-1, "JobLevel not yet implemented\n");
369 * Routine to handle Volume start/end file
371 static BSR *store_volfile(LEX *lc, BSR *bsr)
374 BSR_VOLFILE *volfile;
377 token = lex_get_token(lc, T_PINT32_RANGE);
378 if (token == T_ERROR) {
381 volfile = (BSR_VOLFILE *)malloc(sizeof(BSR_VOLFILE));
382 memset(volfile, 0, sizeof(BSR_VOLFILE));
383 volfile->sfile = lc->pint32_val;
384 volfile->efile = lc->pint32_val2;
385 /* Add it to the end of the chain */
387 bsr->volfile = volfile;
389 /* Add to end of chain */
390 BSR_VOLFILE *bs = bsr->volfile;
391 for ( ;bs->next; bs=bs->next)
395 token = lex_get_token(lc, T_ALL);
396 if (token != T_COMMA) {
405 * Routine to handle Volume start/end Block
407 static BSR *store_volblock(LEX *lc, BSR *bsr)
410 BSR_VOLBLOCK *volblock;
413 token = lex_get_token(lc, T_PINT32_RANGE);
414 if (token == T_ERROR) {
417 volblock = (BSR_VOLBLOCK *)malloc(sizeof(BSR_VOLBLOCK));
418 memset(volblock, 0, sizeof(BSR_VOLBLOCK));
419 volblock->sblock = lc->pint32_val;
420 volblock->eblock = lc->pint32_val2;
421 /* Add it to the end of the chain */
422 if (!bsr->volblock) {
423 bsr->volblock = volblock;
425 /* Add to end of chain */
426 BSR_VOLBLOCK *bs = bsr->volblock;
427 for ( ;bs->next; bs=bs->next)
431 token = lex_get_token(lc, T_ALL);
432 if (token != T_COMMA) {
440 static BSR *store_sessid(LEX *lc, BSR *bsr)
446 token = lex_get_token(lc, T_PINT32_RANGE);
447 if (token == T_ERROR) {
450 sid = (BSR_SESSID *)malloc(sizeof(BSR_SESSID));
451 memset(sid, 0, sizeof(BSR_SESSID));
452 sid->sessid = lc->pint32_val;
453 sid->sessid2 = lc->pint32_val2;
454 /* Add it to the end of the chain */
458 /* Add to end of chain */
459 BSR_SESSID *bs = bsr->sessid;
460 for ( ;bs->next; bs=bs->next)
464 token = lex_get_token(lc, T_ALL);
465 if (token != T_COMMA) {
472 static BSR *store_sesstime(LEX *lc, BSR *bsr)
478 token = lex_get_token(lc, T_PINT32);
479 if (token == T_ERROR) {
482 stime = (BSR_SESSTIME *)malloc(sizeof(BSR_SESSTIME));
483 memset(stime, 0, sizeof(BSR_SESSTIME));
484 stime->sesstime = lc->pint32_val;
485 /* Add it to the end of the chain */
486 if (!bsr->sesstime) {
487 bsr->sesstime = stime;
489 /* Add to end of chain */
490 BSR_SESSTIME *bs = bsr->sesstime;
491 for ( ;bs->next; bs=bs->next)
495 token = lex_get_token(lc, T_ALL);
496 if (token != T_COMMA) {
504 static BSR *store_stream(LEX *lc, BSR *bsr)
510 token = lex_get_token(lc, T_INT32);
511 if (token == T_ERROR) {
514 stream = (BSR_STREAM *)malloc(sizeof(BSR_STREAM));
515 memset(stream, 0, sizeof(BSR_STREAM));
516 stream->stream = lc->int32_val;
517 /* Add it to the end of the chain */
519 bsr->stream = stream;
521 /* Add to end of chain */
522 BSR_STREAM *bs = bsr->stream;
523 for ( ;bs->next; bs=bs->next)
527 token = lex_get_token(lc, T_ALL);
528 if (token != T_COMMA) {
535 static BSR *store_slot(LEX *lc, BSR *bsr)
539 token = lex_get_token(lc, T_PINT32);
540 if (token == T_ERROR) {
543 bsr->Slot = lc->pint32_val;
548 static BSR *store_include(LEX *lc, BSR *bsr)
554 static BSR *store_exclude(LEX *lc, BSR *bsr)
560 void dump_volfile(BSR_VOLFILE *volfile)
563 Dmsg2(-1, "VolFile : %u-%u\n", volfile->sfile, volfile->efile);
564 dump_volfile(volfile->next);
568 void dump_volblock(BSR_VOLBLOCK *volblock)
571 Dmsg2(-1, "VolBlock : %u-%u\n", volblock->sblock, volblock->eblock);
572 dump_volblock(volblock->next);
577 void dump_findex(BSR_FINDEX *FileIndex)
580 if (FileIndex->findex == FileIndex->findex2) {
581 Dmsg1(-1, "FileIndex : %u\n", FileIndex->findex);
583 Dmsg2(-1, "FileIndex : %u-%u\n", FileIndex->findex, FileIndex->findex2);
585 dump_findex(FileIndex->next);
589 void dump_jobid(BSR_JOBID *jobid)
592 if (jobid->JobId == jobid->JobId2) {
593 Dmsg1(-1, "JobId : %u\n", jobid->JobId);
595 Dmsg2(-1, "JobId : %u-%u\n", jobid->JobId, jobid->JobId2);
597 dump_jobid(jobid->next);
601 void dump_sessid(BSR_SESSID *sessid)
604 if (sessid->sessid == sessid->sessid2) {
605 Dmsg1(-1, "SessId : %u\n", sessid->sessid);
607 Dmsg2(-1, "SessId : %u-%u\n", sessid->sessid, sessid->sessid2);
609 dump_sessid(sessid->next);
613 void dump_volume(BSR_VOLUME *volume)
616 Dmsg1(-1, "VolumeName : %s\n", volume->VolumeName);
617 dump_volume(volume->next);
622 void dump_client(BSR_CLIENT *client)
625 Dmsg1(-1, "Client : %s\n", client->ClientName);
626 dump_client(client->next);
630 void dump_job(BSR_JOB *job)
633 Dmsg1(-1, "Job : %s\n", job->Job);
638 void dump_sesstime(BSR_SESSTIME *sesstime)
641 Dmsg1(-1, "SessTime : %u\n", sesstime->sesstime);
642 dump_sesstime(sesstime->next);
650 void dump_bsr(BSR *bsr)
653 Dmsg0(-1, "BSR is NULL\n");
657 "Next : 0x%x\n", bsr->next);
658 dump_volume(bsr->volume);
659 dump_sessid(bsr->sessid);
660 dump_sesstime(bsr->sesstime);
661 dump_volfile(bsr->volfile);
662 dump_volblock(bsr->volblock);
663 dump_client(bsr->client);
664 dump_jobid(bsr->JobId);
666 dump_findex(bsr->FileIndex);
668 Dmsg1(-1, "Slot : %u\n", bsr->Slot);
671 Dmsg1(-1, "count : %u\n", bsr->count);
681 /*********************************************************************
686 static void free_bsr_item(BSR *bsr)
689 free_bsr_item(bsr->next);
694 void free_bsr(BSR *bsr)
699 free_bsr_item((BSR *)bsr->volume);
700 free_bsr_item((BSR *)bsr->client);
701 free_bsr_item((BSR *)bsr->sessid);
702 free_bsr_item((BSR *)bsr->sesstime);
703 free_bsr_item((BSR *)bsr->volfile);
704 free_bsr_item((BSR *)bsr->volblock);
705 free_bsr_item((BSR *)bsr->JobId);
706 free_bsr_item((BSR *)bsr->job);
707 free_bsr_item((BSR *)bsr->FileIndex);
708 free_bsr_item((BSR *)bsr->JobType);
709 free_bsr_item((BSR *)bsr->JobLevel);
714 /*****************************************************************
715 * Routines for handling volumes
720 vol = (VOL_LIST *)malloc(sizeof(VOL_LIST));
721 memset(vol, 0, sizeof(VOL_LIST));
726 * Add current volume to end of list, only if the Volume
727 * is not already in the list.
729 * returns: 1 if volume added
730 * 0 if volume already in list
732 int add_vol(JCR *jcr, VOL_LIST *vol)
734 VOL_LIST *next = jcr->VolList;
736 if (!next) { /* list empty ? */
737 jcr->VolList = vol; /* yes, add volume */
739 for ( ; next->next; next=next->next) {
740 if (strcmp(vol->VolumeName, next->VolumeName) == 0) {
741 if (vol->start_file < next->start_file) {
742 next->start_file = vol->start_file;
744 return 0; /* already in list */
747 if (strcmp(vol->VolumeName, next->VolumeName) == 0) {
748 if (vol->start_file < next->start_file) {
749 next->start_file = vol->start_file;
751 return 0; /* already in list */
753 next->next = vol; /* add volume */
758 void free_vol_list(JCR *jcr)
760 VOL_LIST *next = jcr->VolList;
772 * Create a list of Volumes (and Slots and Start positions) to be
773 * used in the current restore job.
775 void create_vol_list(JCR *jcr)
781 * Build a list of volumes to be processed
787 if (!bsr->volume || !bsr->volume->VolumeName) {
790 for ( ; bsr; bsr=bsr->next) {
792 BSR_VOLFILE *volfile;
793 uint32_t sfile = UINT32_MAX;
795 /* Find minimum start file so that we can forward space to it */
796 for (volfile = bsr->volfile; volfile; volfile=volfile->next) {
797 if (volfile->sfile < sfile) {
798 sfile = volfile->sfile;
801 /* Now add volumes for this bsr */
802 for (bsrvol = bsr->volume; bsrvol; bsrvol=bsrvol->next) {
804 bstrncpy(vol->VolumeName, bsrvol->VolumeName, sizeof(vol->VolumeName));
805 vol->start_file = sfile;
806 if (add_vol(jcr, vol)) {
808 Dmsg1(400, "Added volume %s\n", vol->VolumeName);
810 Dmsg1(400, "Duplicate volume %s\n", vol->VolumeName);
813 sfile = 0; /* start at beginning of second volume */
817 /* This is the old way -- deprecated */
818 for (p = jcr->VolumeName; p && *p; ) {
819 n = strchr(p, '|'); /* volume name separator */
821 *n++ = 0; /* Terminate name */
824 bstrncpy(vol->VolumeName, p, sizeof(vol->VolumeName));
825 if (add_vol(jcr, vol)) {