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_sesstime(LEX *lc, BSR *bsr);
45 static BSR *store_include(LEX *lc, BSR *bsr);
46 static BSR *store_exclude(LEX *lc, BSR *bsr);
47 static BSR *store_stream(LEX *lc, BSR *bsr);
48 static BSR *store_slot(LEX *lc, BSR *bsr);
52 ITEM_HANDLER *handler;
56 * List of all keywords permitted in bsr files and their handlers
58 struct kw_items items[] = {
59 {"volume", store_vol},
60 {"client", store_client},
62 {"jobid", store_jobid},
63 {"count", store_count},
64 {"fileindex", store_findex},
65 {"jobtype", store_jobtype},
66 {"joblevel", store_joblevel},
67 {"volsessionid", store_sessid},
68 {"volsessiontime", store_sesstime},
69 {"include", store_include},
70 {"exclude", store_exclude},
71 {"volfile", store_volfile},
72 {"stream", store_stream},
83 BSR *bsr = (BSR *)malloc(sizeof(BSR));
84 memset(bsr, 0, sizeof(BSR));
89 * Format a scanner error message
91 static void s_err(char *file, int line, LEX *lc, char *msg, ...)
93 JCR *jcr = (JCR *)(lc->caller_ctx);
97 va_start(arg_ptr, msg);
98 bvsnprintf(buf, sizeof(buf), msg, arg_ptr);
102 Jmsg(jcr, M_FATAL, 0, _("Bootstrap file error: %s\n\
103 : Line %d, col %d of file %s\n%s\n"),
104 buf, lc->line_no, lc->col_no, lc->fname, lc->line);
106 e_msg(file, line, M_FATAL, 0, _("Bootstrap file error: %s\n\
107 : Line %d, col %d of file %s\n%s\n"),
108 buf, lc->line_no, lc->col_no, lc->fname, lc->line);
113 /*********************************************************************
115 * Parse Bootstrap file
118 BSR *parse_bsr(JCR *jcr, char *cf)
122 BSR *root_bsr = new_bsr();
125 Dmsg1(200, "Enter parse_bsf %s\n", cf);
126 lc = lex_open_file(lc, cf, s_err);
127 lc->caller_ctx = (void *)jcr;
128 while ((token=lex_get_token(lc, T_ALL)) != T_EOF) {
129 Dmsg1(200, "parse got token=%s\n", lex_tok_to_str(token));
130 if (token == T_EOL) {
133 for (i=0; items[i].name; i++) {
134 if (strcasecmp(items[i].name, lc->str) == 0) {
135 token = lex_get_token(lc, T_ALL);
136 Dmsg1 (200, "in T_IDENT got token=%s\n", lex_tok_to_str(token));
137 if (token != T_EQUALS) {
138 scan_err1(lc, "expected an equals, got: %s", lc->str);
142 Dmsg1(200, "calling handler for %s\n", items[i].name);
143 /* Call item handler */
144 bsr = items[i].handler(lc, bsr);
150 Dmsg1(200, "Keyword = %s\n", lc->str);
151 scan_err1(lc, "Keyword %s not found", lc->str);
159 lc = lex_close_file(lc);
160 Dmsg0(200, "Leave parse_bsf()\n");
168 static BSR *store_vol(LEX *lc, BSR *bsr)
174 token = lex_get_token(lc, T_STRING);
175 if (token == T_ERROR) {
179 bsr->next = new_bsr();
182 /* This may actually be more than one volume separated by a |
183 * If so, separate them.
185 for (p=lc->str; p && *p; ) {
190 volume = (BSR_VOLUME *)malloc(sizeof(BSR_VOLUME));
191 memset(volume, 0, sizeof(BSR_VOLUME));
192 strcpy(volume->VolumeName, p);
193 /* Add it to the end of the volume chain */
195 bsr->volume = volume;
197 BSR_VOLUME *bc = bsr->volume;
198 for ( ;bc->next; bc=bc->next)
207 static BSR *store_client(LEX *lc, BSR *bsr)
213 token = lex_get_token(lc, T_NAME);
214 if (token == T_ERROR) {
217 client = (BSR_CLIENT *)malloc(sizeof(BSR_CLIENT));
218 memset(client, 0, sizeof(BSR_CLIENT));
219 strcpy(client->ClientName, lc->str);
220 /* Add it to the end of the client chain */
222 bsr->client = client;
224 BSR_CLIENT *bc = bsr->client;
225 for ( ;bc->next; bc=bc->next)
229 token = lex_get_token(lc, T_ALL);
230 if (token != T_COMMA) {
237 static BSR *store_job(LEX *lc, BSR *bsr)
243 token = lex_get_token(lc, T_NAME);
244 if (token == T_ERROR) {
247 job = (BSR_JOB *)malloc(sizeof(BSR_JOB));
248 memset(job, 0, sizeof(BSR_JOB));
249 strcpy(job->Job, lc->str);
250 /* Add it to the end of the client chain */
254 /* Add to end of chain */
255 BSR_JOB *bc = bsr->job;
256 for ( ;bc->next; bc=bc->next)
260 token = lex_get_token(lc, T_ALL);
261 if (token != T_COMMA) {
268 static BSR *store_findex(LEX *lc, BSR *bsr)
274 token = lex_get_token(lc, T_PINT32_RANGE);
275 if (token == T_ERROR) {
278 findex = (BSR_FINDEX *)malloc(sizeof(BSR_FINDEX));
279 memset(findex, 0, sizeof(BSR_FINDEX));
280 findex->findex = lc->pint32_val;
281 findex->findex2 = lc->pint32_val2;
282 /* Add it to the end of the chain */
283 if (!bsr->FileIndex) {
284 bsr->FileIndex = findex;
286 /* Add to end of chain */
287 BSR_FINDEX *bs = bsr->FileIndex;
288 for ( ;bs->next; bs=bs->next)
292 token = lex_get_token(lc, T_ALL);
293 if (token != T_COMMA) {
301 static BSR *store_jobid(LEX *lc, BSR *bsr)
307 token = lex_get_token(lc, T_PINT32_RANGE);
308 if (token == T_ERROR) {
311 jobid = (BSR_JOBID *)malloc(sizeof(BSR_JOBID));
312 memset(jobid, 0, sizeof(BSR_JOBID));
313 jobid->JobId = lc->pint32_val;
314 jobid->JobId2 = lc->pint32_val2;
315 /* Add it to the end of the chain */
319 /* Add to end of chain */
320 BSR_JOBID *bs = bsr->JobId;
321 for ( ;bs->next; bs=bs->next)
325 token = lex_get_token(lc, T_ALL);
326 if (token != T_COMMA) {
334 static BSR *store_count(LEX *lc, BSR *bsr)
338 token = lex_get_token(lc, T_PINT32);
339 if (token == T_ERROR) {
342 bsr->count = lc->pint32_val;
348 static BSR *store_jobtype(LEX *lc, BSR *bsr)
350 /* *****FIXME****** */
351 Dmsg0(-1, "JobType not yet implemented\n");
356 static BSR *store_joblevel(LEX *lc, BSR *bsr)
358 /* *****FIXME****** */
359 Dmsg0(-1, "JobLevel not yet implemented\n");
367 * Routine to handle Volume start/end file
369 static BSR *store_volfile(LEX *lc, BSR *bsr)
372 BSR_VOLFILE *volfile;
375 token = lex_get_token(lc, T_PINT32_RANGE);
376 if (token == T_ERROR) {
379 volfile = (BSR_VOLFILE *)malloc(sizeof(BSR_VOLFILE));
380 memset(volfile, 0, sizeof(BSR_VOLFILE));
381 volfile->sfile = lc->pint32_val;
382 volfile->efile = lc->pint32_val2;
383 /* Add it to the end of the chain */
385 bsr->volfile = volfile;
387 /* Add to end of chain */
388 BSR_VOLFILE *bs = bsr->volfile;
389 for ( ;bs->next; bs=bs->next)
393 token = lex_get_token(lc, T_ALL);
394 if (token != T_COMMA) {
403 static BSR *store_sessid(LEX *lc, BSR *bsr)
409 token = lex_get_token(lc, T_PINT32_RANGE);
410 if (token == T_ERROR) {
413 sid = (BSR_SESSID *)malloc(sizeof(BSR_SESSID));
414 memset(sid, 0, sizeof(BSR_SESSID));
415 sid->sessid = lc->pint32_val;
416 sid->sessid2 = lc->pint32_val2;
417 /* Add it to the end of the chain */
421 /* Add to end of chain */
422 BSR_SESSID *bs = bsr->sessid;
423 for ( ;bs->next; bs=bs->next)
427 token = lex_get_token(lc, T_ALL);
428 if (token != T_COMMA) {
435 static BSR *store_sesstime(LEX *lc, BSR *bsr)
441 token = lex_get_token(lc, T_PINT32);
442 if (token == T_ERROR) {
445 stime = (BSR_SESSTIME *)malloc(sizeof(BSR_SESSTIME));
446 memset(stime, 0, sizeof(BSR_SESSTIME));
447 stime->sesstime = lc->pint32_val;
448 /* Add it to the end of the chain */
449 if (!bsr->sesstime) {
450 bsr->sesstime = stime;
452 /* Add to end of chain */
453 BSR_SESSTIME *bs = bsr->sesstime;
454 for ( ;bs->next; bs=bs->next)
458 token = lex_get_token(lc, T_ALL);
459 if (token != T_COMMA) {
467 static BSR *store_stream(LEX *lc, BSR *bsr)
473 token = lex_get_token(lc, T_INT32);
474 if (token == T_ERROR) {
477 stream = (BSR_STREAM *)malloc(sizeof(BSR_STREAM));
478 memset(stream, 0, sizeof(BSR_STREAM));
479 stream->stream = lc->int32_val;
480 /* Add it to the end of the chain */
482 bsr->stream = stream;
484 /* Add to end of chain */
485 BSR_STREAM *bs = bsr->stream;
486 for ( ;bs->next; bs=bs->next)
490 token = lex_get_token(lc, T_ALL);
491 if (token != T_COMMA) {
498 static BSR *store_slot(LEX *lc, BSR *bsr)
502 token = lex_get_token(lc, T_PINT32);
503 if (token == T_ERROR) {
506 bsr->Slot = lc->pint32_val;
511 static BSR *store_include(LEX *lc, BSR *bsr)
517 static BSR *store_exclude(LEX *lc, BSR *bsr)
523 void dump_volfile(BSR_VOLFILE *volfile)
526 Dmsg2(-1, "VolFile : %u-%u\n", volfile->sfile, volfile->efile);
527 dump_volfile(volfile->next);
531 void dump_findex(BSR_FINDEX *FileIndex)
534 if (FileIndex->findex == FileIndex->findex2) {
535 Dmsg1(-1, "FileIndex : %u\n", FileIndex->findex);
537 Dmsg2(-1, "FileIndex : %u-%u\n", FileIndex->findex, FileIndex->findex2);
539 dump_findex(FileIndex->next);
543 void dump_jobid(BSR_JOBID *jobid)
546 if (jobid->JobId == jobid->JobId2) {
547 Dmsg1(-1, "JobId : %u\n", jobid->JobId);
549 Dmsg2(-1, "JobId : %u-%u\n", jobid->JobId, jobid->JobId2);
551 dump_jobid(jobid->next);
555 void dump_sessid(BSR_SESSID *sessid)
558 if (sessid->sessid == sessid->sessid2) {
559 Dmsg1(-1, "SessId : %u\n", sessid->sessid);
561 Dmsg2(-1, "SessId : %u-%u\n", sessid->sessid, sessid->sessid2);
563 dump_sessid(sessid->next);
567 void dump_volume(BSR_VOLUME *volume)
570 Dmsg1(-1, "VolumeName : %s\n", volume->VolumeName);
571 dump_volume(volume->next);
576 void dump_client(BSR_CLIENT *client)
579 Dmsg1(-1, "Client : %s\n", client->ClientName);
580 dump_client(client->next);
584 void dump_job(BSR_JOB *job)
587 Dmsg1(-1, "Job : %s\n", job->Job);
592 void dump_sesstime(BSR_SESSTIME *sesstime)
595 Dmsg1(-1, "SessTime : %u\n", sesstime->sesstime);
596 dump_sesstime(sesstime->next);
604 void dump_bsr(BSR *bsr)
607 Dmsg0(-1, "BSR is NULL\n");
611 "Next : 0x%x\n", bsr->next);
612 dump_volume(bsr->volume);
613 dump_sessid(bsr->sessid);
614 dump_sesstime(bsr->sesstime);
615 dump_volfile(bsr->volfile);
616 dump_client(bsr->client);
617 dump_jobid(bsr->JobId);
619 dump_findex(bsr->FileIndex);
621 Dmsg1(-1, "Slot : %u\n", bsr->Slot);
624 Dmsg1(-1, "count : %u\n", bsr->count);
634 /*********************************************************************
639 static void free_bsr_item(BSR *bsr)
642 free_bsr_item(bsr->next);
647 void free_bsr(BSR *bsr)
652 free_bsr_item((BSR *)bsr->volume);
653 free_bsr_item((BSR *)bsr->client);
654 free_bsr_item((BSR *)bsr->sessid);
655 free_bsr_item((BSR *)bsr->sesstime);
656 free_bsr_item((BSR *)bsr->volfile);
657 free_bsr_item((BSR *)bsr->JobId);
658 free_bsr_item((BSR *)bsr->job);
659 free_bsr_item((BSR *)bsr->FileIndex);
660 free_bsr_item((BSR *)bsr->JobType);
661 free_bsr_item((BSR *)bsr->JobLevel);
666 /*****************************************************************
667 * Routines for handling volumes
672 vol = (VOL_LIST *)malloc(sizeof(VOL_LIST));
673 memset(vol, 0, sizeof(VOL_LIST));
678 * Add current volume to end of list, only if the Volume
679 * is not already in the list.
681 * returns: 1 if volume added
682 * 0 if volume already in list
684 int add_vol(JCR *jcr, VOL_LIST *vol)
686 VOL_LIST *next = jcr->VolList;
688 if (!next) { /* list empty ? */
689 jcr->VolList = vol; /* yes, add volume */
691 for ( ; next->next; next=next->next) {
692 if (strcmp(vol->VolumeName, next->VolumeName) == 0) {
693 if (vol->start_file < next->start_file) {
694 next->start_file = vol->start_file;
696 return 0; /* already in list */
699 if (strcmp(vol->VolumeName, next->VolumeName) == 0) {
700 if (vol->start_file < next->start_file) {
701 next->start_file = vol->start_file;
703 return 0; /* already in list */
705 next->next = vol; /* add volume */
710 void free_vol_list(JCR *jcr)
712 VOL_LIST *next = jcr->VolList;
723 void create_vol_list(JCR *jcr)
729 * Build a list of volumes to be processed
735 if (!bsr->volume || !bsr->volume->VolumeName) {
738 strcpy(jcr->VolumeName, bsr->volume->VolumeName); /* setup first volume */
739 for ( ; bsr; bsr=bsr->next) {
741 BSR_VOLFILE *volfile;
744 /* Find minimum start file so that we can forward space to it */
745 for (volfile = bsr->volfile; volfile; volfile=volfile->next) {
746 if (volfile->sfile < sfile) {
747 sfile = volfile->sfile;
750 /* Now add volumes for this bsr */
751 for (bsrvol = bsr->volume; bsrvol; bsrvol=bsrvol->next) {
753 strcpy(vol->VolumeName, bsrvol->VolumeName);
754 vol->start_file = sfile;
755 if (add_vol(jcr, vol)) {
757 Dmsg1(400, "Added volume %s\n", vol->VolumeName);
759 Dmsg1(400, "Duplicate volume %s\n", vol->VolumeName);
762 sfile = 0; /* start at beginning of second volume */
766 /* This is the old way -- deprecated */
767 for (p = jcr->VolumeName; p && *p; ) {
768 n = strchr(p, '|'); /* volume name separator */
770 *n++ = 0; /* Terminate name */
773 strcpy(vol->VolumeName, p);
774 if (add_vol(jcr, vol)) {