2 * Main configuration file parser for Bacula Directors,
3 * some parts may be split into separate files such as
4 * the schedule configuration (run_config.c).
6 * Note, the configuration file parser consists of three parts
8 * 1. The generic lexical scanner in lib/lex.c and lib/lex.h
10 * 2. The generic config scanner in lib/parse_config.c and
12 * These files contain the parser code, some utility
13 * routines, and the common store routines (name, int,
16 * 3. The daemon specific file, which contains the Resource
17 * definitions as well as any specific store routines
18 * for the resource records.
20 * Kern Sibbald, January MM
25 Copyright (C) 2000-2003 Kern Sibbald and John Walker
27 This program is free software; you can redistribute it and/or
28 modify it under the terms of the GNU General Public License as
29 published by the Free Software Foundation; either version 2 of
30 the License, or (at your option) any later version.
32 This program is distributed in the hope that it will be useful,
33 but WITHOUT ANY WARRANTY; without even the implied warranty of
34 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
35 General Public License for more details.
37 You should have received a copy of the GNU General Public
38 License along with this program; if not, write to the Free
39 Software Foundation, Inc., 59 Temple Place - Suite 330, Boston,
47 /* Define the first and last resource ID record
48 * types. Note, these should be unique for each
49 * daemon though not a requirement.
51 int r_first = R_FIRST;
54 pthread_mutex_t res_mutex = PTHREAD_MUTEX_INITIALIZER;
56 /* Imported subroutines */
57 extern void store_run(LEX *lc, struct res_items *item, int index, int pass);
58 extern void store_finc(LEX *lc, struct res_items *item, int index, int pass);
59 extern void store_inc(LEX *lc, struct res_items *item, int index, int pass);
62 /* Forward referenced subroutines */
64 static void store_backup(LEX *lc, struct res_items *item, int index, int pass);
65 static void store_restore(LEX *lc, struct res_items *item, int index, int pass);
66 static void store_jobtype(LEX *lc, struct res_items *item, int index, int pass);
67 static void store_level(LEX *lc, struct res_items *item, int index, int pass);
68 static void store_replace(LEX *lc, struct res_items *item, int index, int pass);
71 /* We build the current resource here as we are
72 * scanning the resource configuration definition,
73 * then move it to allocated memory when the resource
77 int res_all_size = sizeof(res_all);
80 /* Definition of records permitted within each
81 * resource with the routine to process the record
82 * information. NOTE! quoted names must be in lower case.
87 * name handler value code flags default_value
89 static struct res_items dir_items[] = {
90 {"name", store_name, ITEM(res_dir.hdr.name), 0, ITEM_REQUIRED, 0},
91 {"description", store_str, ITEM(res_dir.hdr.desc), 0, 0, 0},
92 {"messages", store_res, ITEM(res_dir.messages), R_MSGS, 0, 0},
93 {"dirport", store_pint, ITEM(res_dir.DIRport), 0, ITEM_DEFAULT, 9101},
94 {"diraddress", store_str, ITEM(res_dir.DIRaddr), 0, 0, 0},
95 {"queryfile", store_dir, ITEM(res_dir.query_file), 0, ITEM_REQUIRED, 0},
96 {"workingdirectory", store_dir, ITEM(res_dir.working_directory), 0, ITEM_REQUIRED, 0},
97 {"piddirectory",store_dir, ITEM(res_dir.pid_directory), 0, ITEM_REQUIRED, 0},
98 {"subsysdirectory", store_dir, ITEM(res_dir.subsys_directory), 0, 0, 0},
99 {"requiressl", store_yesno, ITEM(res_dir.require_ssl), 1, ITEM_DEFAULT, 0},
100 {"enablessl", store_yesno, ITEM(res_dir.enable_ssl), 1, ITEM_DEFAULT, 0},
101 {"maximumconcurrentjobs", store_pint, ITEM(res_dir.MaxConcurrentJobs), 0, ITEM_DEFAULT, 1},
102 {"password", store_password, ITEM(res_dir.password), 0, ITEM_REQUIRED, 0},
103 {"fdconnecttimeout", store_time,ITEM(res_dir.FDConnectTimeout), 0, ITEM_DEFAULT, 60 * 30},
104 {"sdconnecttimeout", store_time,ITEM(res_dir.SDConnectTimeout), 0, ITEM_DEFAULT, 60 * 30},
105 {NULL, NULL, NULL, 0, 0, 0}
111 * name handler value code flags default_value
113 static struct res_items con_items[] = {
114 {"name", store_name, ITEM(res_con.hdr.name), 0, ITEM_REQUIRED, 0},
115 {"description", store_str, ITEM(res_con.hdr.desc), 0, 0, 0},
116 {"enablessl", store_yesno, ITEM(res_con.enable_ssl), 1, ITEM_DEFAULT, 0},
117 {"password", store_password, ITEM(res_con.password), 0, ITEM_REQUIRED, 0},
118 {NULL, NULL, NULL, 0, 0, 0}
123 * Client or File daemon resource
125 * name handler value code flags default_value
128 static struct res_items cli_items[] = {
129 {"name", store_name, ITEM(res_client.hdr.name), 0, ITEM_REQUIRED, 0},
130 {"description", store_str, ITEM(res_client.hdr.desc), 0, 0, 0},
131 {"address", store_str, ITEM(res_client.address), 0, ITEM_REQUIRED, 0},
132 {"fdport", store_pint, ITEM(res_client.FDport), 0, ITEM_DEFAULT, 9102},
133 {"password", store_password, ITEM(res_client.password), 0, ITEM_REQUIRED, 0},
134 {"catalog", store_res, ITEM(res_client.catalog), R_CATALOG, 0, 0},
135 {"fileretention", store_time, ITEM(res_client.FileRetention), 0, ITEM_DEFAULT, 60*60*24*60},
136 {"jobretention", store_time, ITEM(res_client.JobRetention), 0, ITEM_DEFAULT, 60*60*24*180},
137 {"autoprune", store_yesno, ITEM(res_client.AutoPrune), 1, ITEM_DEFAULT, 1},
138 {"enablessl", store_yesno, ITEM(res_client.enable_ssl), 1, ITEM_DEFAULT, 0},
139 {"maximumconcurrentjobs", store_pint, ITEM(res_client.MaxConcurrentJobs), 0, ITEM_DEFAULT, 1},
140 {NULL, NULL, NULL, 0, 0, 0}
143 /* Storage daemon resource
145 * name handler value code flags default_value
147 static struct res_items store_items[] = {
148 {"name", store_name, ITEM(res_store.hdr.name), 0, ITEM_REQUIRED, 0},
149 {"description", store_str, ITEM(res_store.hdr.desc), 0, 0, 0},
150 {"sdport", store_pint, ITEM(res_store.SDport), 0, ITEM_DEFAULT, 9103},
151 {"sddport", store_pint, ITEM(res_store.SDDport), 0, 0, 0}, /* deprecated */
152 {"address", store_str, ITEM(res_store.address), 0, ITEM_REQUIRED, 0},
153 {"password", store_password, ITEM(res_store.password), 0, ITEM_REQUIRED, 0},
154 {"device", store_strname, ITEM(res_store.dev_name), 0, ITEM_REQUIRED, 0},
155 {"mediatype", store_strname, ITEM(res_store.media_type), 0, ITEM_REQUIRED, 0},
156 {"autochanger", store_yesno, ITEM(res_store.autochanger), 1, ITEM_DEFAULT, 0},
157 {"enablessl", store_yesno, ITEM(res_store.enable_ssl), 1, ITEM_DEFAULT, 0},
158 {"maximumconcurrentjobs", store_pint, ITEM(res_store.MaxConcurrentJobs), 0, ITEM_DEFAULT, 1},
159 {NULL, NULL, NULL, 0, 0, 0}
163 * Catalog Resource Directives
165 * name handler value code flags default_value
167 static struct res_items cat_items[] = {
168 {"name", store_name, ITEM(res_cat.hdr.name), 0, ITEM_REQUIRED, 0},
169 {"description", store_str, ITEM(res_cat.hdr.desc), 0, 0, 0},
170 {"address", store_str, ITEM(res_cat.db_address), 0, 0, 0},
171 {"dbaddress", store_str, ITEM(res_cat.db_address), 0, 0, 0},
172 {"dbport", store_pint, ITEM(res_cat.db_port), 0, 0, 0},
173 /* keep this password as store_str for the moment */
174 {"password", store_str, ITEM(res_cat.db_password), 0, 0, 0},
175 {"user", store_str, ITEM(res_cat.db_user), 0, 0, 0},
176 {"dbname", store_str, ITEM(res_cat.db_name), 0, ITEM_REQUIRED, 0},
177 {"dbsocket", store_str, ITEM(res_cat.db_socket), 0, 0, 0},
178 {NULL, NULL, NULL, 0, 0, 0}
182 * Job Resource Directives
184 * name handler value code flags default_value
186 static struct res_items job_items[] = {
187 {"name", store_name, ITEM(res_job.hdr.name), 0, ITEM_REQUIRED, 0},
188 {"description", store_str, ITEM(res_job.hdr.desc), 0, 0, 0},
189 {"backup", store_backup, ITEM(res_job), JT_BACKUP, 0, 0},
190 {"verify", store_backup, ITEM(res_job), JT_VERIFY, 0, 0},
191 {"restore", store_restore, ITEM(res_job), JT_RESTORE, 0, 0},
192 {"schedule", store_res, ITEM(res_job.schedule), R_SCHEDULE, 0, 0},
193 {"type", store_jobtype, ITEM(res_job), 0, 0, 0},
194 {"level", store_level, ITEM(res_job), 0, 0, 0},
195 {"messages", store_res, ITEM(res_job.messages), R_MSGS, 0, 0},
196 {"storage", store_res, ITEM(res_job.storage), R_STORAGE, 0, 0},
197 {"pool", store_res, ITEM(res_job.pool), R_POOL, 0, 0},
198 {"client", store_res, ITEM(res_job.client), R_CLIENT, 0, 0},
199 {"fileset", store_res, ITEM(res_job.fileset), R_FILESET, 0, 0},
200 {"where", store_dir, ITEM(res_job.RestoreWhere), 0, 0, 0},
201 {"replace", store_replace, ITEM(res_job.replace), 0, ITEM_DEFAULT, REPLACE_ALWAYS},
202 {"bootstrap",store_dir, ITEM(res_job.RestoreBootstrap), 0, 0, 0},
203 {"maxruntime", store_time, ITEM(res_job.MaxRunTime), 0, 0, 0},
204 {"maxstartdelay", store_time,ITEM(res_job.MaxStartDelay), 0, 0, 0},
205 {"prefixlinks", store_yesno, ITEM(res_job.PrefixLinks), 1, ITEM_DEFAULT, 0},
206 {"prunejobs", store_yesno, ITEM(res_job.PruneJobs), 1, ITEM_DEFAULT, 0},
207 {"prunefiles", store_yesno, ITEM(res_job.PruneFiles), 1, ITEM_DEFAULT, 0},
208 {"prunevolumes", store_yesno, ITEM(res_job.PruneVolumes), 1, ITEM_DEFAULT, 0},
209 {"runbeforejob", store_str, ITEM(res_job.RunBeforeJob), 0, 0, 0},
210 {"runafterjob", store_str, ITEM(res_job.RunAfterJob), 0, 0, 0},
211 {"spoolattributes", store_yesno, ITEM(res_job.SpoolAttributes), 1, ITEM_DEFAULT, 0},
212 {"writebootstrap", store_dir, ITEM(res_job.WriteBootstrap), 0, 0, 0},
213 {"maximumconcurrentjobs", store_pint, ITEM(res_job.MaxConcurrentJobs), 0, ITEM_DEFAULT, 1},
214 {"rescheduleonerror", store_yesno, ITEM(res_job.RescheduleOnError), 1, ITEM_DEFAULT, 0},
215 {"rescheduleinterval", store_time, ITEM(res_job.RescheduleInterval), 0, ITEM_DEFAULT, 60 * 30},
216 {"rescheduletimes", store_pint, ITEM(res_job.RescheduleTimes), 0, 0, 0},
217 {"priority", store_pint, ITEM(res_job.Priority), 0, ITEM_DEFAULT, 10},
218 {NULL, NULL, NULL, 0, 0, 0}
223 * name handler value code flags default_value
225 static struct res_items fs_items[] = {
226 {"name", store_name, ITEM(res_fs.hdr.name), 0, ITEM_REQUIRED, 0},
227 {"description", store_str, ITEM(res_fs.hdr.desc), 0, 0, 0},
228 {"include", store_inc, NULL, 0, 0, 0},
229 {"finclude", store_finc, NULL, 0, ITEM_NO_EQUALS, 0},
230 {"exclude", store_inc, NULL, 1, 0, 0},
231 {"fexclude", store_finc, NULL, 1, ITEM_NO_EQUALS, 0},
232 {NULL, NULL, NULL, 0, 0, 0}
235 /* Schedule -- see run_conf.c */
238 * name handler value code flags default_value
240 static struct res_items sch_items[] = {
241 {"name", store_name, ITEM(res_sch.hdr.name), 0, ITEM_REQUIRED, 0},
242 {"description", store_str, ITEM(res_sch.hdr.desc), 0, 0, 0},
243 {"run", store_run, ITEM(res_sch.run), 0, 0, 0},
244 {NULL, NULL, NULL, 0, 0, 0}
247 /* Group resource -- not implemented
249 * name handler value code flags default_value
251 static struct res_items group_items[] = {
252 {"name", store_name, ITEM(res_group.hdr.name), 0, ITEM_REQUIRED, 0},
253 {"description", store_str, ITEM(res_group.hdr.desc), 0, 0, 0},
254 {NULL, NULL, NULL, 0, 0, 0}
259 * name handler value code flags default_value
261 static struct res_items pool_items[] = {
262 {"name", store_name, ITEM(res_pool.hdr.name), 0, ITEM_REQUIRED, 0},
263 {"description", store_str, ITEM(res_pool.hdr.desc), 0, 0, 0},
264 {"pooltype", store_strname, ITEM(res_pool.pool_type), 0, ITEM_REQUIRED, 0},
265 {"labelformat", store_strname, ITEM(res_pool.label_format), 0, 0, 0},
266 {"cleaningprefix", store_strname, ITEM(res_pool.cleaning_prefix), 0, 0, 0},
267 {"usecatalog", store_yesno, ITEM(res_pool.use_catalog), 1, ITEM_DEFAULT, 1},
268 {"usevolumeonce", store_yesno, ITEM(res_pool.use_volume_once), 1, 0, 0},
269 {"purgeoldestvolume", store_yesno, ITEM(res_pool.purge_oldest_volume), 1, 0, 0},
270 {"recycleoldestvolume", store_yesno, ITEM(res_pool.recycle_oldest_volume), 1, 0, 0},
271 {"recyclecurrentvolume", store_yesno, ITEM(res_pool.recycle_current_volume), 1, 0, 0},
272 {"maximumvolumes", store_pint, ITEM(res_pool.max_volumes), 0, 0, 0},
273 {"maximumvolumejobs", store_pint, ITEM(res_pool.MaxVolJobs), 0, 0, 0},
274 {"maximumvolumefiles", store_pint, ITEM(res_pool.MaxVolFiles), 0, 0, 0},
275 {"maximumvolumebytes", store_size, ITEM(res_pool.MaxVolBytes), 0, 0, 0},
276 {"acceptanyvolume", store_yesno, ITEM(res_pool.accept_any_volume), 1, ITEM_DEFAULT, 1},
277 {"catalogfiles", store_yesno, ITEM(res_pool.catalog_files), 1, ITEM_DEFAULT, 1},
278 {"volumeretention", store_time, ITEM(res_pool.VolRetention), 0, ITEM_DEFAULT, 60*60*24*365},
279 {"volumeuseduration", store_time, ITEM(res_pool.VolUseDuration),0, 0, 0},
280 {"autoprune", store_yesno, ITEM(res_pool.AutoPrune), 1, ITEM_DEFAULT, 1},
281 {"recycle", store_yesno, ITEM(res_pool.Recycle), 1, ITEM_DEFAULT, 1},
282 {NULL, NULL, NULL, 0, 0, 0}
287 * name handler value code flags default_value
289 static struct res_items counter_items[] = {
290 {"name", store_name, ITEM(res_counter.hdr.name), 0, ITEM_REQUIRED, 0},
291 {"description", store_str, ITEM(res_counter.hdr.desc), 0, 0, 0},
292 {"minimum", store_int, ITEM(res_counter.MinValue), 0, ITEM_DEFAULT, 0},
293 {"maximum", store_pint, ITEM(res_counter.MaxValue), 0, ITEM_DEFAULT, INT32_MAX},
294 {"wrapcounter", store_res, ITEM(res_counter.WrapCounter), R_COUNTER, 0, 0},
295 {"catalog", store_res, ITEM(res_counter.Catalog), R_CATALOG, 0, 0},
296 {NULL, NULL, NULL, 0, 0, 0}
300 /* Message resource */
301 extern struct res_items msgs_items[];
304 * This is the master resource definition.
305 * It must have one item for each of the resources.
307 * name items rcode res_head
309 struct s_res resources[] = {
310 {"director", dir_items, R_DIRECTOR, NULL},
311 {"console", con_items, R_CONSOLE, NULL},
312 {"client", cli_items, R_CLIENT, NULL},
313 {"job", job_items, R_JOB, NULL},
314 {"storage", store_items, R_STORAGE, NULL},
315 {"catalog", cat_items, R_CATALOG, NULL},
316 {"schedule", sch_items, R_SCHEDULE, NULL},
317 {"fileset", fs_items, R_FILESET, NULL},
318 {"group", group_items, R_GROUP, NULL},
319 {"pool", pool_items, R_POOL, NULL},
320 {"messages", msgs_items, R_MSGS, NULL},
321 {"counter", counter_items, R_COUNTER, NULL},
322 {NULL, NULL, 0, NULL}
326 /* Keywords (RHS) permitted in Job Level records
328 * level_name level job_type
330 struct s_jl joblevels[] = {
331 {"Full", L_FULL, JT_BACKUP},
332 {"Base", L_BASE, JT_BACKUP},
333 {"Incremental", L_INCREMENTAL, JT_BACKUP},
334 {"Differential", L_DIFFERENTIAL, JT_BACKUP},
335 {"Since", L_SINCE, JT_BACKUP},
336 {"Catalog", L_VERIFY_CATALOG, JT_VERIFY},
337 {"InitCatalog", L_VERIFY_INIT, JT_VERIFY},
338 {"VolumeToCatalog", L_VERIFY_VOLUME_TO_CATALOG, JT_VERIFY},
339 {"Data", L_VERIFY_DATA, JT_VERIFY},
343 /* Keywords (RHS) permitted in Job type records
347 struct s_jt jobtypes[] = {
348 {"backup", JT_BACKUP},
350 {"verify", JT_VERIFY},
351 {"restore", JT_RESTORE},
356 /* Keywords (RHS) permitted in Backup and Verify records */
357 static struct s_kw BakVerFields[] = {
364 /* Keywords (RHS) permitted in Restore records */
365 static struct s_kw RestoreFields[] = {
368 {"jobid", 'J'}, /* JobId to restore */
369 {"where", 'W'}, /* root of restore */
370 {"replace", 'R'}, /* replacement options */
371 {"bootstrap", 'B'}, /* bootstrap file */
375 /* Options permitted in Restore replace= */
376 struct s_kw ReplaceOptions[] = {
377 {"always", REPLACE_ALWAYS},
378 {"ifnewer", REPLACE_IFNEWER},
379 {"ifolder", REPLACE_IFOLDER},
380 {"never", REPLACE_NEVER},
384 char *level_to_str(int level)
387 static char level_no[30];
388 char *str = level_no;
390 sprintf(level_no, "%d", level); /* default if not found */
391 for (i=0; joblevels[i].level_name; i++) {
392 if (level == joblevels[i].level) {
393 str = joblevels[i].level_name;
400 /* Dump contents of resource */
401 void dump_resource(int type, RES *reshdr, void sendit(void *sock, char *fmt, ...), void *sock)
403 URES *res = (URES *)reshdr;
405 char ed1[30], ed2[30];
408 sendit(sock, "No %s resource defined\n", res_to_str(type));
411 if (type < 0) { /* no recursion */
417 sendit(sock, "Director: name=%s MaxJobs=%d FDtimeout=%s SDtimeout=%s\n",
418 reshdr->name, res->res_dir.MaxConcurrentJobs,
419 edit_uint64(res->res_dir.FDConnectTimeout, ed1),
420 edit_uint64(res->res_dir.SDConnectTimeout, ed2));
421 if (res->res_dir.query_file) {
422 sendit(sock, " query_file=%s\n", res->res_dir.query_file);
424 if (res->res_dir.messages) {
425 sendit(sock, " --> ");
426 dump_resource(-R_MSGS, (RES *)res->res_dir.messages, sendit, sock);
430 sendit(sock, "Console: name=%s SSL=%d\n",
431 res->res_con.hdr.name, res->res_con.enable_ssl);
434 sendit(sock, "Counter: name=%s min=%d max=%d\n",
435 res->res_counter.hdr.name, res->res_counter.MinValue,
436 res->res_counter.MaxValue);
437 if (res->res_counter.Catalog) {
438 sendit(sock, " --> ");
439 dump_resource(-R_CATALOG, (RES *)res->res_counter.Catalog, sendit, sock);
441 if (res->res_counter.WrapCounter) {
442 sendit(sock, " --> ");
443 dump_resource(-R_COUNTER, (RES *)res->res_counter.WrapCounter, sendit, sock);
448 sendit(sock, "Client: name=%s address=%s FDport=%d MaxJobs=%u\n",
449 res->res_client.hdr.name, res->res_client.address, res->res_client.FDport,
450 res->res_client.MaxConcurrentJobs);
451 sendit(sock, " JobRetention=%" lld " FileRetention=%" lld " AutoPrune=%d\n",
452 res->res_client.JobRetention, res->res_client.FileRetention,
453 res->res_client.AutoPrune);
454 if (res->res_client.catalog) {
455 sendit(sock, " --> ");
456 dump_resource(-R_CATALOG, (RES *)res->res_client.catalog, sendit, sock);
460 sendit(sock, "Storage: name=%s address=%s SDport=%d MaxJobs=%u\n\
461 DeviceName=%s MediaType=%s\n",
462 res->res_store.hdr.name, res->res_store.address, res->res_store.SDport,
463 res->res_store.MaxConcurrentJobs,
464 res->res_store.dev_name, res->res_store.media_type);
467 sendit(sock, "Catalog: name=%s address=%s DBport=%d db_name=%s\n\
469 res->res_cat.hdr.name, NPRT(res->res_cat.db_address),
470 res->res_cat.db_port, res->res_cat.db_name, NPRT(res->res_cat.db_user));
473 sendit(sock, "Job: name=%s JobType=%d level=%s Priority=%d MaxJobs=%u\n",
474 res->res_job.hdr.name, res->res_job.JobType,
475 level_to_str(res->res_job.level), res->res_job.Priority,
476 res->res_job.MaxConcurrentJobs);
477 sendit(sock, " Resched=%d Times=%d Interval=%s\n",
478 res->res_job.RescheduleOnError, res->res_job.RescheduleTimes,
479 edit_uint64_with_commas(res->res_job.RescheduleInterval, ed1));
480 if (res->res_job.client) {
481 sendit(sock, " --> ");
482 dump_resource(-R_CLIENT, (RES *)res->res_job.client, sendit, sock);
484 if (res->res_job.fileset) {
485 sendit(sock, " --> ");
486 dump_resource(-R_FILESET, (RES *)res->res_job.fileset, sendit, sock);
488 if (res->res_job.schedule) {
489 sendit(sock, " --> ");
490 dump_resource(-R_SCHEDULE, (RES *)res->res_job.schedule, sendit, sock);
492 if (res->res_job.RestoreWhere) {
493 sendit(sock, " --> Where=%s\n", NPRT(res->res_job.RestoreWhere));
495 if (res->res_job.RestoreBootstrap) {
496 sendit(sock, " --> Bootstrap=%s\n", NPRT(res->res_job.RestoreBootstrap));
498 if (res->res_job.RunBeforeJob) {
499 sendit(sock, " --> RunBefore=%s\n", NPRT(res->res_job.RunBeforeJob));
501 if (res->res_job.RunAfterJob) {
502 sendit(sock, " --> RunAfter=%s\n", NPRT(res->res_job.RunAfterJob));
504 if (res->res_job.WriteBootstrap) {
505 sendit(sock, " --> WriteBootstrap=%s\n", NPRT(res->res_job.WriteBootstrap));
507 if (res->res_job.storage) {
508 sendit(sock, " --> ");
509 dump_resource(-R_STORAGE, (RES *)res->res_job.storage, sendit, sock);
511 if (res->res_job.pool) {
512 sendit(sock, " --> ");
513 dump_resource(-R_POOL, (RES *)res->res_job.pool, sendit, sock);
515 sendit(sock, "!!! No Pool resource\n");
517 if (res->res_job.messages) {
518 sendit(sock, " --> ");
519 dump_resource(-R_MSGS, (RES *)res->res_job.messages, sendit, sock);
523 sendit(sock, "FileSet: name=%s\n", res->res_fs.hdr.name);
524 for (int i=0; i<res->res_fs.num_includes; i++) {
525 INCEXE *incexe = res->res_fs.include_items[i];
526 for (int j=0; j<incexe->num_names; j++) {
527 sendit(sock, " Inc: %s\n", incexe->name_list[j]);
530 for (int i=0; i<res->res_fs.num_excludes; i++) {
531 INCEXE *incexe = res->res_fs.exclude_items[i];
532 for (int j=0; j<incexe->num_names; j++) {
533 sendit(sock, " Exc: %s\n", incexe->name_list[j]);
538 if (res->res_sch.run) {
540 RUN *run = res->res_sch.run;
541 char buf[1000], num[10];
542 sendit(sock, "Schedule: name=%s\n", res->res_sch.hdr.name);
547 sendit(sock, " --> Run Level=%s\n", level_to_str(run->level));
548 strcpy(buf, " hour=");
549 for (i=0; i<24; i++) {
550 if (bit_is_set(i, run->hour)) {
551 sprintf(num, "%d ", i);
557 strcpy(buf, " mday=");
558 for (i=0; i<31; i++) {
559 if (bit_is_set(i, run->mday)) {
560 sprintf(num, "%d ", i+1);
566 strcpy(buf, " month=");
567 for (i=0; i<12; i++) {
568 if (bit_is_set(i, run->month)) {
569 sprintf(num, "%d ", i+1);
575 strcpy(buf, " wday=");
576 for (i=0; i<7; i++) {
577 if (bit_is_set(i, run->wday)) {
578 sprintf(num, "%d ", i+1);
584 strcpy(buf, " wpos=");
585 for (i=0; i<5; i++) {
586 if (bit_is_set(i, run->wpos)) {
587 sprintf(num, "%d ", i+1);
593 sendit(sock, " mins=%d\n", run->minute);
595 sendit(sock, " --> ");
596 dump_resource(-R_POOL, (RES *)run->pool, sendit, sock);
599 sendit(sock, " --> ");
600 dump_resource(-R_STORAGE, (RES *)run->storage, sendit, sock);
603 sendit(sock, " --> ");
604 dump_resource(-R_MSGS, (RES *)run->msgs, sendit, sock);
606 /* If another Run record is chained in, go print it */
612 sendit(sock, "Schedule: name=%s\n", res->res_sch.hdr.name);
616 sendit(sock, "Group: name=%s\n", res->res_group.hdr.name);
619 sendit(sock, "Pool: name=%s PoolType=%s\n", res->res_pool.hdr.name,
620 res->res_pool.pool_type);
621 sendit(sock, " use_cat=%d use_once=%d acpt_any=%d cat_files=%d\n",
622 res->res_pool.use_catalog, res->res_pool.use_volume_once,
623 res->res_pool.accept_any_volume, res->res_pool.catalog_files);
624 sendit(sock, " max_vols=%d auto_prune=%d VolRetention=%" lld "\n",
625 res->res_pool.max_volumes, res->res_pool.AutoPrune,
626 res->res_pool.VolRetention);
627 sendit(sock, " recycle=%d LabelFormat=%s\n", res->res_pool.Recycle,
628 NPRT(res->res_pool.label_format));
629 sendit(sock, " CleaningPrefix=%s\n",
630 NPRT(res->res_pool.cleaning_prefix));
631 sendit(sock, " recyleOldest=%d MaxVolJobs=%d MaxVolFiles=%d\n",
632 res->res_pool.purge_oldest_volume,
633 res->res_pool.MaxVolJobs, res->res_pool.MaxVolFiles);
636 sendit(sock, "Messages: name=%s\n", res->res_msgs.hdr.name);
637 if (res->res_msgs.mail_cmd)
638 sendit(sock, " mailcmd=%s\n", res->res_msgs.mail_cmd);
639 if (res->res_msgs.operator_cmd)
640 sendit(sock, " opcmd=%s\n", res->res_msgs.operator_cmd);
643 sendit(sock, "Unknown resource type %d in dump_resource.\n", type);
646 if (recurse && res->res_dir.hdr.next) {
647 dump_resource(type, res->res_dir.hdr.next, sendit, sock);
652 * Free all the members of an INCEXE structure
654 static void free_incexe(INCEXE *incexe)
656 for (int i=0; i<incexe->num_names; i++) {
657 free(incexe->name_list[i]);
659 if (incexe->name_list) {
660 free(incexe->name_list);
662 for (int i=0; i<incexe->num_opts; i++) {
663 FOPTS *fopt = incexe->opts_list[i];
664 fopt->match.destroy();
665 fopt->base_list.destroy();
668 if (incexe->opts_list) {
669 free(incexe->opts_list);
675 * Free memory of resource.
676 * NB, we don't need to worry about freeing any references
677 * to other resources as they will be freed when that
678 * resource chain is traversed. Mainly we worry about freeing
679 * allocated strings (names).
681 void free_resource(int type)
686 int rindex = type - r_first;
688 res = (URES *)resources[rindex].res_head;
693 /* common stuff -- free the resource name and description */
694 nres = (RES *)res->res_dir.hdr.next;
695 if (res->res_dir.hdr.name) {
696 free(res->res_dir.hdr.name);
698 if (res->res_dir.hdr.desc) {
699 free(res->res_dir.hdr.desc);
704 if (res->res_dir.working_directory) {
705 free(res->res_dir.working_directory);
707 if (res->res_dir.pid_directory) {
708 free(res->res_dir.pid_directory);
710 if (res->res_dir.subsys_directory) {
711 free(res->res_dir.subsys_directory);
713 if (res->res_dir.password) {
714 free(res->res_dir.password);
716 if (res->res_dir.query_file) {
717 free(res->res_dir.query_file);
719 if (res->res_dir.DIRaddr) {
720 free(res->res_dir.DIRaddr);
726 if (res->res_con.password) {
727 free(res->res_con.password);
731 if (res->res_client.address) {
732 free(res->res_client.address);
734 if (res->res_client.password) {
735 free(res->res_client.password);
739 if (res->res_store.address) {
740 free(res->res_store.address);
742 if (res->res_store.password) {
743 free(res->res_store.password);
745 if (res->res_store.media_type) {
746 free(res->res_store.media_type);
748 if (res->res_store.dev_name) {
749 free(res->res_store.dev_name);
753 if (res->res_cat.db_address) {
754 free(res->res_cat.db_address);
756 if (res->res_cat.db_socket) {
757 free(res->res_cat.db_socket);
759 if (res->res_cat.db_user) {
760 free(res->res_cat.db_user);
762 if (res->res_cat.db_name) {
763 free(res->res_cat.db_name);
765 if (res->res_cat.db_password) {
766 free(res->res_cat.db_password);
770 if ((num=res->res_fs.num_includes)) {
772 free_incexe(res->res_fs.include_items[num]);
774 free(res->res_fs.include_items);
776 res->res_fs.num_includes = 0;
777 if ((num=res->res_fs.num_excludes)) {
779 free_incexe(res->res_fs.exclude_items[num]);
781 free(res->res_fs.exclude_items);
783 res->res_fs.num_excludes = 0;
786 if (res->res_pool.pool_type) {
787 free(res->res_pool.pool_type);
789 if (res->res_pool.label_format) {
790 free(res->res_pool.label_format);
792 if (res->res_pool.cleaning_prefix) {
793 free(res->res_pool.cleaning_prefix);
797 if (res->res_sch.run) {
799 nrun = res->res_sch.run;
808 if (res->res_job.RestoreWhere) {
809 free(res->res_job.RestoreWhere);
811 if (res->res_job.RestoreBootstrap) {
812 free(res->res_job.RestoreBootstrap);
814 if (res->res_job.WriteBootstrap) {
815 free(res->res_job.WriteBootstrap);
817 if (res->res_job.RunBeforeJob) {
818 free(res->res_job.RunBeforeJob);
820 if (res->res_job.RunAfterJob) {
821 free(res->res_job.RunAfterJob);
825 if (res->res_msgs.mail_cmd)
826 free(res->res_msgs.mail_cmd);
827 if (res->res_msgs.operator_cmd)
828 free(res->res_msgs.operator_cmd);
829 free_msgs_res((MSGS *)res); /* free message resource */
835 printf("Unknown resource type %d in free_resource.\n", type);
837 /* Common stuff again -- free the resource, recurse to next one */
841 resources[rindex].res_head = nres;
848 * Save the new resource by chaining it into the head list for
849 * the resource. If this is pass 2, we update any resource
850 * pointers because they may not have been defined until
853 void save_resource(int type, struct res_items *items, int pass)
856 int rindex = type - r_first;
861 * Ensure that all required items are present
863 for (i=0; items[i].name; i++) {
864 if (items[i].flags & ITEM_REQUIRED) {
865 if (!bit_is_set(i, res_all.res_dir.hdr.item_present)) {
866 Emsg2(M_ERROR_TERM, 0, "%s item is required in %s resource, but not found.\n",
867 items[i].name, resources[rindex]);
870 /* If this triggers, take a look at lib/parse_conf.h */
871 if (i >= MAX_RES_ITEMS) {
872 Emsg1(M_ERROR_TERM, 0, "Too many items in %s resource\n", resources[rindex]);
876 /* During pass 2 in each "store" routine, we looked up pointers
877 * to all the resources referrenced in the current resource, now we
878 * must copy their addresses from the static record to the allocated
883 /* Resources not containing a resource */
893 /* Resources containing another resource */
895 if ((res = (URES *)GetResWithName(R_DIRECTOR, res_all.res_dir.hdr.name)) == NULL) {
896 Emsg1(M_ERROR_TERM, 0, "Cannot find Director resource %s\n", res_all.res_dir.hdr.name);
898 res->res_dir.messages = res_all.res_dir.messages;
901 if ((res = (URES *)GetResWithName(R_JOB, res_all.res_dir.hdr.name)) == NULL) {
902 Emsg1(M_ERROR_TERM, 0, "Cannot find Job resource %s\n", res_all.res_dir.hdr.name);
904 res->res_job.messages = res_all.res_job.messages;
905 res->res_job.schedule = res_all.res_job.schedule;
906 res->res_job.client = res_all.res_job.client;
907 res->res_job.fileset = res_all.res_job.fileset;
908 res->res_job.storage = res_all.res_job.storage;
909 res->res_job.pool = res_all.res_job.pool;
910 if (res->res_job.JobType == 0) {
911 Emsg1(M_ERROR_TERM, 0, "Job Type not defined for Job resource %s\n", res_all.res_dir.hdr.name);
913 if (res->res_job.level != 0) {
915 for (i=0; joblevels[i].level_name; i++) {
916 if (joblevels[i].level == res->res_job.level &&
917 joblevels[i].job_type == res->res_job.JobType) {
923 Emsg1(M_ERROR_TERM, 0, "Inappropriate level specified in Job resource %s\n",
924 res_all.res_dir.hdr.name);
929 if ((res = (URES *)GetResWithName(R_COUNTER, res_all.res_counter.hdr.name)) == NULL) {
930 Emsg1(M_ERROR_TERM, 0, "Cannot find Counter resource %s\n", res_all.res_counter.hdr.name);
932 res->res_counter.Catalog = res_all.res_counter.Catalog;
933 res->res_counter.WrapCounter = res_all.res_counter.WrapCounter;
937 if ((res = (URES *)GetResWithName(R_CLIENT, res_all.res_client.hdr.name)) == NULL) {
938 Emsg1(M_ERROR_TERM, 0, "Cannot find Client resource %s\n", res_all.res_client.hdr.name);
940 res->res_client.catalog = res_all.res_client.catalog;
943 /* Schedule is a bit different in that it contains a RUN record
944 * chain which isn't a "named" resource. This chain was linked
945 * in by run_conf.c during pass 2, so here we jam the pointer
946 * into the Schedule resource.
948 if ((res = (URES *)GetResWithName(R_SCHEDULE, res_all.res_client.hdr.name)) == NULL) {
949 Emsg1(M_ERROR_TERM, 0, "Cannot find Schedule resource %s\n", res_all.res_client.hdr.name);
951 res->res_sch.run = res_all.res_sch.run;
954 Emsg1(M_ERROR, 0, "Unknown resource type %d in save_resource.\n", type);
958 /* Note, the resource name was already saved during pass 1,
959 * so here, we can just release it.
961 if (res_all.res_dir.hdr.name) {
962 free(res_all.res_dir.hdr.name);
963 res_all.res_dir.hdr.name = NULL;
965 if (res_all.res_dir.hdr.desc) {
966 free(res_all.res_dir.hdr.desc);
967 res_all.res_dir.hdr.desc = NULL;
972 /* The following code is only executed for pass 1 */
975 size = sizeof(DIRRES);
978 size = sizeof(CONRES);
981 size =sizeof(CLIENT);
984 size = sizeof(STORE);
993 size = sizeof(FILESET);
996 size = sizeof(SCHED);
999 size = sizeof(GROUP);
1002 size = sizeof(POOL);
1005 size = sizeof(MSGS);
1008 size = sizeof(COUNTER);
1011 printf("Unknown resource type %d in save_resrouce.\n", type);
1018 res = (URES *)malloc(size);
1019 memcpy(res, &res_all, size);
1020 if (!resources[rindex].res_head) {
1021 resources[rindex].res_head = (RES *)res; /* store first entry */
1022 Dmsg3(200, "Inserting first %s res: %s index=%d\n", res_to_str(type),
1023 res->res_dir.hdr.name, rindex);
1026 /* Add new res to end of chain */
1027 for (next=resources[rindex].res_head; next->next; next=next->next)
1029 next->next = (RES *)res;
1030 Dmsg3(200, "Inserting %s res: %s index=%d\n", res_to_str(type),
1031 res->res_dir.hdr.name, rindex);
1037 * Store JobType (backup, verify, restore)
1040 static void store_jobtype(LEX *lc, struct res_items *item, int index, int pass)
1044 token = lex_get_token(lc, T_NAME);
1045 /* Store the type both pass 1 and pass 2 */
1046 for (i=0; jobtypes[i].type_name; i++) {
1047 if (strcasecmp(lc->str, jobtypes[i].type_name) == 0) {
1048 ((JOB *)(item->value))->JobType = jobtypes[i].job_type;
1054 scan_err1(lc, "Expected a Job Type keyword, got: %s", lc->str);
1057 set_bit(index, res_all.hdr.item_present);
1061 * Store Job Level (Full, Incremental, ...)
1064 static void store_level(LEX *lc, struct res_items *item, int index, int pass)
1068 token = lex_get_token(lc, T_NAME);
1069 /* Store the level pass 2 so that type is defined */
1070 for (i=0; joblevels[i].level_name; i++) {
1071 if (strcasecmp(lc->str, joblevels[i].level_name) == 0) {
1072 ((JOB *)(item->value))->level = joblevels[i].level;
1078 scan_err1(lc, "Expected a Job Level keyword, got: %s", lc->str);
1081 set_bit(index, res_all.hdr.item_present);
1084 static void store_replace(LEX *lc, struct res_items *item, int index, int pass)
1087 token = lex_get_token(lc, T_NAME);
1088 /* Scan Replacement options */
1089 for (i=0; ReplaceOptions[i].name; i++) {
1090 if (strcasecmp(lc->str, ReplaceOptions[i].name) == 0) {
1091 *(int *)(item->value) = ReplaceOptions[i].token;
1097 scan_err1(lc, "Expected a Restore replacement option, got: %s", lc->str);
1100 set_bit(index, res_all.hdr.item_present);
1104 * Store backup/verify info for Job record
1106 * Note, this code is used for both BACKUP and VERIFY jobs
1108 * Backup = Client=<client-name> FileSet=<FileSet-name> Level=<level>
1110 static void store_backup(LEX *lc, struct res_items *item, int index, int pass)
1114 int options = lc->options;
1116 lc->options |= LOPT_NO_IDENT; /* make spaces significant */
1119 ((JOB *)(item->value))->JobType = item->code;
1120 while ((token = lex_get_token(lc, T_ALL)) != T_EOL) {
1123 Dmsg1(150, "store_backup got token=%s\n", lex_tok_to_str(token));
1125 if (token != T_IDENTIFIER && token != T_UNQUOTED_STRING && token != T_QUOTED_STRING) {
1126 scan_err1(lc, "Expected a backup/verify keyword, got: %s", lc->str);
1128 Dmsg1(190, "Got keyword: %s\n", lc->str);
1129 for (i=0; BakVerFields[i].name; i++) {
1130 if (strcasecmp(lc->str, BakVerFields[i].name) == 0) {
1132 if (lex_get_token(lc, T_ALL) != T_EQUALS) {
1133 scan_err1(lc, "Expected an equals, got: %s", lc->str);
1135 token = lex_get_token(lc, T_NAME);
1136 Dmsg1(190, "Got value: %s\n", lc->str);
1137 switch (BakVerFields[i].token) {
1139 /* Find Client Resource */
1141 res = GetResWithName(R_CLIENT, lc->str);
1143 scan_err1(lc, "Could not find specified Client Resource: %s",
1146 res_all.res_job.client = (CLIENT *)res;
1150 /* Find FileSet Resource */
1152 res = GetResWithName(R_FILESET, lc->str);
1154 scan_err1(lc, "Could not find specified FileSet Resource: %s\n",
1157 res_all.res_job.fileset = (FILESET *)res;
1162 for (i=0; joblevels[i].level_name; i++) {
1163 if (joblevels[i].job_type == item->code &&
1164 strcasecmp(lc->str, joblevels[i].level_name) == 0) {
1165 ((JOB *)(item->value))->level = joblevels[i].level;
1171 scan_err1(lc, "Expected a Job Level keyword, got: %s", lc->str);
1176 } /* end if strcmp() */
1179 scan_err1(lc, "%s not a valid Backup/verify keyword", lc->str);
1182 lc->options = options; /* reset original options */
1183 set_bit(index, res_all.hdr.item_present);
1187 * Store restore info for Job record
1189 * Restore = JobId=<job-id> Where=<root-directory> Replace=<options> Bootstrap=<file>
1192 static void store_restore(LEX *lc, struct res_items *item, int index, int pass)
1196 int options = lc->options;
1198 lc->options |= LOPT_NO_IDENT; /* make spaces significant */
1200 Dmsg0(190, "Enter store_restore()\n");
1202 ((JOB *)(item->value))->JobType = item->code;
1203 while ((token = lex_get_token(lc, T_ALL)) != T_EOL) {
1206 if (token != T_IDENTIFIER && token != T_UNQUOTED_STRING && token != T_QUOTED_STRING) {
1207 scan_err1(lc, "expected a name, got: %s", lc->str);
1209 for (i=0; RestoreFields[i].name; i++) {
1210 Dmsg1(190, "Restore kw=%s\n", lc->str);
1211 if (strcasecmp(lc->str, RestoreFields[i].name) == 0) {
1213 if (lex_get_token(lc, T_ALL) != T_EQUALS) {
1214 scan_err1(lc, "Expected an equals, got: %s", lc->str);
1216 token = lex_get_token(lc, T_ALL);
1217 Dmsg1(190, "Restore value=%s\n", lc->str);
1218 switch (RestoreFields[i].token) {
1221 if (token != T_IDENTIFIER && token != T_UNQUOTED_STRING && token != T_QUOTED_STRING) {
1222 scan_err1(lc, "Expected a Restore bootstrap file, got: %s", lc->str);
1225 res_all.res_job.RestoreBootstrap = bstrdup(lc->str);
1229 /* Find Client Resource */
1231 res = GetResWithName(R_CLIENT, lc->str);
1233 scan_err1(lc, "Could not find specified Client Resource: %s",
1236 res_all.res_job.client = (CLIENT *)res;
1240 /* Find FileSet Resource */
1242 res = GetResWithName(R_FILESET, lc->str);
1244 scan_err1(lc, "Could not find specified FileSet Resource: %s\n",
1247 res_all.res_job.fileset = (FILESET *)res;
1252 if (token != T_NUMBER) {
1253 scan_err1(lc, "expected an integer number, got: %s", lc->str);
1256 res_all.res_job.RestoreJobId = strtol(lc->str, NULL, 0);
1257 Dmsg1(190, "RestorJobId=%d\n", res_all.res_job.RestoreJobId);
1259 scan_err1(lc, "expected an integer number, got: %s", lc->str);
1264 if (token != T_IDENTIFIER && token != T_UNQUOTED_STRING && token != T_QUOTED_STRING) {
1265 scan_err1(lc, "Expected a Restore root directory, got: %s", lc->str);
1268 res_all.res_job.RestoreWhere = bstrdup(lc->str);
1272 /* Replacement options */
1273 if (token != T_IDENTIFIER && token != T_UNQUOTED_STRING && token != T_QUOTED_STRING) {
1274 scan_err1(lc, "Expected a keyword name, got: %s", lc->str);
1276 /* Fix to scan Replacement options */
1277 for (i=0; ReplaceOptions[i].name; i++) {
1278 if (strcasecmp(lc->str, ReplaceOptions[i].name) == 0) {
1279 ((JOB *)(item->value))->replace = ReplaceOptions[i].token;
1285 scan_err1(lc, "Expected a Restore replacement option, got: %s", lc->str);
1290 } /* end if strcmp() */
1293 scan_err1(lc, "%s not a valid Restore keyword", lc->str);
1296 lc->options = options; /* reset original options */
1297 set_bit(index, res_all.hdr.item_present);