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 {"fdaddress", store_str, ITEM(res_client.address), 0, 0, 0},
133 {"fdport", store_pint, ITEM(res_client.FDport), 0, ITEM_DEFAULT, 9102},
134 {"password", store_password, ITEM(res_client.password), 0, ITEM_REQUIRED, 0},
135 {"fdpassword", store_password, ITEM(res_client.password), 0, 0, 0},
136 {"catalog", store_res, ITEM(res_client.catalog), R_CATALOG, 0, 0},
137 {"fileretention", store_time, ITEM(res_client.FileRetention), 0, ITEM_DEFAULT, 60*60*24*60},
138 {"jobretention", store_time, ITEM(res_client.JobRetention), 0, ITEM_DEFAULT, 60*60*24*180},
139 {"autoprune", store_yesno, ITEM(res_client.AutoPrune), 1, ITEM_DEFAULT, 1},
140 {"enablessl", store_yesno, ITEM(res_client.enable_ssl), 1, ITEM_DEFAULT, 0},
141 {"maximumconcurrentjobs", store_pint, ITEM(res_client.MaxConcurrentJobs), 0, ITEM_DEFAULT, 1},
142 {NULL, NULL, NULL, 0, 0, 0}
145 /* Storage daemon resource
147 * name handler value code flags default_value
149 static struct res_items store_items[] = {
150 {"name", store_name, ITEM(res_store.hdr.name), 0, ITEM_REQUIRED, 0},
151 {"description", store_str, ITEM(res_store.hdr.desc), 0, 0, 0},
152 {"sdport", store_pint, ITEM(res_store.SDport), 0, ITEM_DEFAULT, 9103},
153 {"address", store_str, ITEM(res_store.address), 0, ITEM_REQUIRED, 0},
154 {"sdaddress", store_str, ITEM(res_store.address), 0, 0, 0},
155 {"password", store_password, ITEM(res_store.password), 0, ITEM_REQUIRED, 0},
156 {"sdpassword", store_password, ITEM(res_store.password), 0, 0, 0},
157 {"device", store_strname, ITEM(res_store.dev_name), 0, ITEM_REQUIRED, 0},
158 {"sddevicename", store_strname, ITEM(res_store.dev_name), 0, 0, 0},
159 {"mediatype", store_strname, ITEM(res_store.media_type), 0, ITEM_REQUIRED, 0},
160 {"autochanger", store_yesno, ITEM(res_store.autochanger), 1, ITEM_DEFAULT, 0},
161 {"enablessl", store_yesno, ITEM(res_store.enable_ssl), 1, ITEM_DEFAULT, 0},
162 {"maximumconcurrentjobs", store_pint, ITEM(res_store.MaxConcurrentJobs), 0, ITEM_DEFAULT, 1},
163 {"sddport", store_pint, ITEM(res_store.SDDport), 0, 0, 0}, /* deprecated */
164 {NULL, NULL, NULL, 0, 0, 0}
168 * Catalog Resource Directives
170 * name handler value code flags default_value
172 static struct res_items cat_items[] = {
173 {"name", store_name, ITEM(res_cat.hdr.name), 0, ITEM_REQUIRED, 0},
174 {"description", store_str, ITEM(res_cat.hdr.desc), 0, 0, 0},
175 {"address", store_str, ITEM(res_cat.db_address), 0, 0, 0},
176 {"dbaddress", store_str, ITEM(res_cat.db_address), 0, 0, 0},
177 {"dbport", store_pint, ITEM(res_cat.db_port), 0, 0, 0},
178 /* keep this password as store_str for the moment */
179 {"password", store_str, ITEM(res_cat.db_password), 0, 0, 0},
180 {"dbpassword", store_str, ITEM(res_cat.db_password), 0, 0, 0},
181 {"user", store_str, ITEM(res_cat.db_user), 0, 0, 0},
182 {"dbname", store_str, ITEM(res_cat.db_name), 0, ITEM_REQUIRED, 0},
183 {"dbsocket", store_str, ITEM(res_cat.db_socket), 0, 0, 0},
184 {NULL, NULL, NULL, 0, 0, 0}
188 * Job Resource Directives
190 * name handler value code flags default_value
192 static struct res_items job_items[] = {
193 {"name", store_name, ITEM(res_job.hdr.name), 0, ITEM_REQUIRED, 0},
194 {"description", store_str, ITEM(res_job.hdr.desc), 0, 0, 0},
195 {"backup", store_backup, ITEM(res_job), JT_BACKUP, 0, 0},
196 {"verify", store_backup, ITEM(res_job), JT_VERIFY, 0, 0},
197 {"restore", store_restore, ITEM(res_job), JT_RESTORE, 0, 0},
198 {"schedule", store_res, ITEM(res_job.schedule), R_SCHEDULE, 0, 0},
199 {"type", store_jobtype, ITEM(res_job), 0, 0, 0},
200 {"level", store_level, ITEM(res_job), 0, 0, 0},
201 {"messages", store_res, ITEM(res_job.messages), R_MSGS, 0, 0},
202 {"storage", store_res, ITEM(res_job.storage), R_STORAGE, 0, 0},
203 {"pool", store_res, ITEM(res_job.pool), R_POOL, 0, 0},
204 {"client", store_res, ITEM(res_job.client), R_CLIENT, 0, 0},
205 {"fileset", store_res, ITEM(res_job.fileset), R_FILESET, 0, 0},
206 {"verifyjob", store_res, ITEM(res_job.verify_job), R_JOB, 0, 0},
207 {"where", store_dir, ITEM(res_job.RestoreWhere), 0, 0, 0},
208 {"replace", store_replace, ITEM(res_job.replace), 0, ITEM_DEFAULT, REPLACE_ALWAYS},
209 {"bootstrap",store_dir, ITEM(res_job.RestoreBootstrap), 0, 0, 0},
210 {"maxruntime", store_time, ITEM(res_job.MaxRunTime), 0, 0, 0},
211 {"maxstartdelay", store_time,ITEM(res_job.MaxStartDelay), 0, 0, 0},
212 {"prefixlinks", store_yesno, ITEM(res_job.PrefixLinks), 1, ITEM_DEFAULT, 0},
213 {"prunejobs", store_yesno, ITEM(res_job.PruneJobs), 1, ITEM_DEFAULT, 0},
214 {"prunefiles", store_yesno, ITEM(res_job.PruneFiles), 1, ITEM_DEFAULT, 0},
215 {"prunevolumes", store_yesno, ITEM(res_job.PruneVolumes), 1, ITEM_DEFAULT, 0},
216 {"runbeforejob", store_str, ITEM(res_job.RunBeforeJob), 0, 0, 0},
217 {"runafterjob", store_str, ITEM(res_job.RunAfterJob), 0, 0, 0},
218 {"runafterfailedjob", store_str, ITEM(res_job.RunAfterFailedJob), 0, 0, 0},
219 {"clientrunbeforejob", store_str, ITEM(res_job.ClientRunBeforeJob), 0, 0, 0},
220 {"clientrunafterjob", store_str, ITEM(res_job.ClientRunAfterJob), 0, 0, 0},
221 {"spoolattributes", store_yesno, ITEM(res_job.SpoolAttributes), 1, ITEM_DEFAULT, 0},
222 {"writebootstrap", store_dir, ITEM(res_job.WriteBootstrap), 0, 0, 0},
223 {"maximumconcurrentjobs", store_pint, ITEM(res_job.MaxConcurrentJobs), 0, ITEM_DEFAULT, 1},
224 {"rescheduleonerror", store_yesno, ITEM(res_job.RescheduleOnError), 1, ITEM_DEFAULT, 0},
225 {"rescheduleinterval", store_time, ITEM(res_job.RescheduleInterval), 0, ITEM_DEFAULT, 60 * 30},
226 {"rescheduletimes", store_pint, ITEM(res_job.RescheduleTimes), 0, 0, 0},
227 {"priority", store_pint, ITEM(res_job.Priority), 0, ITEM_DEFAULT, 10},
228 {"jobretention", store_time, ITEM(res_job.JobRetention), 0, 0, 0},
229 {NULL, NULL, NULL, 0, 0, 0}
234 * name handler value code flags default_value
236 static struct res_items fs_items[] = {
237 {"name", store_name, ITEM(res_fs.hdr.name), 0, ITEM_REQUIRED, 0},
238 {"description", store_str, ITEM(res_fs.hdr.desc), 0, 0, 0},
239 {"include", store_inc, NULL, 0, ITEM_NO_EQUALS, 0},
240 {"exclude", store_inc, NULL, 1, ITEM_NO_EQUALS, 0},
241 {NULL, NULL, NULL, 0, 0, 0}
244 /* Schedule -- see run_conf.c */
247 * name handler value code flags default_value
249 static struct res_items sch_items[] = {
250 {"name", store_name, ITEM(res_sch.hdr.name), 0, ITEM_REQUIRED, 0},
251 {"description", store_str, ITEM(res_sch.hdr.desc), 0, 0, 0},
252 {"run", store_run, ITEM(res_sch.run), 0, 0, 0},
253 {NULL, NULL, NULL, 0, 0, 0}
256 /* Group resource -- not implemented
258 * name handler value code flags default_value
260 static struct res_items group_items[] = {
261 {"name", store_name, ITEM(res_group.hdr.name), 0, ITEM_REQUIRED, 0},
262 {"description", store_str, ITEM(res_group.hdr.desc), 0, 0, 0},
263 {NULL, NULL, NULL, 0, 0, 0}
268 * name handler value code flags default_value
270 static struct res_items pool_items[] = {
271 {"name", store_name, ITEM(res_pool.hdr.name), 0, ITEM_REQUIRED, 0},
272 {"description", store_str, ITEM(res_pool.hdr.desc), 0, 0, 0},
273 {"pooltype", store_strname, ITEM(res_pool.pool_type), 0, ITEM_REQUIRED, 0},
274 {"labelformat", store_strname, ITEM(res_pool.label_format), 0, 0, 0},
275 {"cleaningprefix", store_strname, ITEM(res_pool.cleaning_prefix), 0, 0, 0},
276 {"usecatalog", store_yesno, ITEM(res_pool.use_catalog), 1, ITEM_DEFAULT, 1},
277 {"usevolumeonce", store_yesno, ITEM(res_pool.use_volume_once), 1, 0, 0},
278 {"purgeoldestvolume", store_yesno, ITEM(res_pool.purge_oldest_volume), 1, 0, 0},
279 {"recycleoldestvolume", store_yesno, ITEM(res_pool.recycle_oldest_volume), 1, 0, 0},
280 {"recyclecurrentvolume", store_yesno, ITEM(res_pool.recycle_current_volume), 1, 0, 0},
281 {"maximumvolumes", store_pint, ITEM(res_pool.max_volumes), 0, 0, 0},
282 {"maximumvolumejobs", store_pint, ITEM(res_pool.MaxVolJobs), 0, 0, 0},
283 {"maximumvolumefiles", store_pint, ITEM(res_pool.MaxVolFiles), 0, 0, 0},
284 {"maximumvolumebytes", store_size, ITEM(res_pool.MaxVolBytes), 0, 0, 0},
285 {"acceptanyvolume", store_yesno, ITEM(res_pool.accept_any_volume), 1, ITEM_DEFAULT, 1},
286 {"catalogfiles", store_yesno, ITEM(res_pool.catalog_files), 1, ITEM_DEFAULT, 1},
287 {"volumeretention", store_time, ITEM(res_pool.VolRetention), 0, ITEM_DEFAULT, 60*60*24*365},
288 {"volumeuseduration", store_time, ITEM(res_pool.VolUseDuration),0, 0, 0},
289 {"autoprune", store_yesno, ITEM(res_pool.AutoPrune), 1, ITEM_DEFAULT, 1},
290 {"recycle", store_yesno, ITEM(res_pool.Recycle), 1, ITEM_DEFAULT, 1},
291 {NULL, NULL, NULL, 0, 0, 0}
296 * name handler value code flags default_value
298 static struct res_items counter_items[] = {
299 {"name", store_name, ITEM(res_counter.hdr.name), 0, ITEM_REQUIRED, 0},
300 {"description", store_str, ITEM(res_counter.hdr.desc), 0, 0, 0},
301 {"minimum", store_int, ITEM(res_counter.MinValue), 0, ITEM_DEFAULT, 0},
302 {"maximum", store_pint, ITEM(res_counter.MaxValue), 0, ITEM_DEFAULT, INT32_MAX},
303 {"wrapcounter", store_res, ITEM(res_counter.WrapCounter), R_COUNTER, 0, 0},
304 {"catalog", store_res, ITEM(res_counter.Catalog), R_CATALOG, 0, 0},
305 {NULL, NULL, NULL, 0, 0, 0}
309 /* Message resource */
310 extern struct res_items msgs_items[];
313 * This is the master resource definition.
314 * It must have one item for each of the resources.
316 * NOTE!!! keep it in the same order as the R_codes
317 * or eliminate all resources[rindex].name
319 * name items rcode res_head
321 struct s_res resources[] = {
322 {"director", dir_items, R_DIRECTOR, NULL},
323 {"client", cli_items, R_CLIENT, NULL},
324 {"job", job_items, R_JOB, NULL},
325 {"storage", store_items, R_STORAGE, NULL},
326 {"catalog", cat_items, R_CATALOG, NULL},
327 {"schedule", sch_items, R_SCHEDULE, NULL},
328 {"fileset", fs_items, R_FILESET, NULL},
329 {"group", group_items, R_GROUP, NULL},
330 {"pool", pool_items, R_POOL, NULL},
331 {"messages", msgs_items, R_MSGS, NULL},
332 {"counter", counter_items, R_COUNTER, NULL},
333 {"console", con_items, R_CONSOLE, NULL},
334 {NULL, NULL, 0, NULL}
338 /* Keywords (RHS) permitted in Job Level records
340 * level_name level job_type
342 struct s_jl joblevels[] = {
343 {"Full", L_FULL, JT_BACKUP},
344 {"Base", L_BASE, JT_BACKUP},
345 {"Incremental", L_INCREMENTAL, JT_BACKUP},
346 {"Differential", L_DIFFERENTIAL, JT_BACKUP},
347 {"Since", L_SINCE, JT_BACKUP},
348 {"Catalog", L_VERIFY_CATALOG, JT_VERIFY},
349 {"InitCatalog", L_VERIFY_INIT, JT_VERIFY},
350 {"VolumeToCatalog", L_VERIFY_VOLUME_TO_CATALOG, JT_VERIFY},
351 {"DiskToCatalog", L_VERIFY_DISK_TO_CATALOG, JT_VERIFY},
352 {"Data", L_VERIFY_DATA, JT_VERIFY},
353 {" ", L_NONE, JT_ADMIN},
354 {" ", L_NONE, JT_RESTORE},
358 /* Keywords (RHS) permitted in Job type records
362 struct s_jt jobtypes[] = {
363 {"backup", JT_BACKUP},
365 {"verify", JT_VERIFY},
366 {"restore", JT_RESTORE},
371 /* Keywords (RHS) permitted in Backup and Verify records */
372 static struct s_kw BakVerFields[] = {
379 /* Keywords (RHS) permitted in Restore records */
380 static struct s_kw RestoreFields[] = {
383 {"jobid", 'J'}, /* JobId to restore */
384 {"where", 'W'}, /* root of restore */
385 {"replace", 'R'}, /* replacement options */
386 {"bootstrap", 'B'}, /* bootstrap file */
390 /* Options permitted in Restore replace= */
391 struct s_kw ReplaceOptions[] = {
392 {"always", REPLACE_ALWAYS},
393 {"ifnewer", REPLACE_IFNEWER},
394 {"ifolder", REPLACE_IFOLDER},
395 {"never", REPLACE_NEVER},
399 char *level_to_str(int level)
402 static char level_no[30];
403 char *str = level_no;
405 sprintf(level_no, "%d", level); /* default if not found */
406 for (i=0; joblevels[i].level_name; i++) {
407 if (level == joblevels[i].level) {
408 str = joblevels[i].level_name;
415 /* Dump contents of resource */
416 void dump_resource(int type, RES *reshdr, void sendit(void *sock, char *fmt, ...), void *sock)
418 URES *res = (URES *)reshdr;
420 char ed1[100], ed2[100];
423 sendit(sock, "No %s resource defined\n", res_to_str(type));
426 if (type < 0) { /* no recursion */
432 sendit(sock, "Director: name=%s MaxJobs=%d FDtimeout=%s SDtimeout=%s\n",
433 reshdr->name, res->res_dir.MaxConcurrentJobs,
434 edit_uint64(res->res_dir.FDConnectTimeout, ed1),
435 edit_uint64(res->res_dir.SDConnectTimeout, ed2));
436 if (res->res_dir.query_file) {
437 sendit(sock, " query_file=%s\n", res->res_dir.query_file);
439 if (res->res_dir.messages) {
440 sendit(sock, " --> ");
441 dump_resource(-R_MSGS, (RES *)res->res_dir.messages, sendit, sock);
445 sendit(sock, "Console: name=%s SSL=%d\n",
446 res->res_con.hdr.name, res->res_con.enable_ssl);
449 if (res->res_counter.WrapCounter) {
450 sendit(sock, "Counter: name=%s min=%d max=%d cur=%d wrapcntr=%s\n",
451 res->res_counter.hdr.name, res->res_counter.MinValue,
452 res->res_counter.MaxValue, res->res_counter.CurrentValue,
453 res->res_counter.WrapCounter->hdr.name);
455 sendit(sock, "Counter: name=%s min=%d max=%d\n",
456 res->res_counter.hdr.name, res->res_counter.MinValue,
457 res->res_counter.MaxValue);
459 if (res->res_counter.Catalog) {
460 sendit(sock, " --> ");
461 dump_resource(-R_CATALOG, (RES *)res->res_counter.Catalog, sendit, sock);
466 sendit(sock, "Client: name=%s address=%s FDport=%d MaxJobs=%u\n",
467 res->res_client.hdr.name, res->res_client.address, res->res_client.FDport,
468 res->res_client.MaxConcurrentJobs);
469 sendit(sock, " JobRetention=%s FileRetention=%s AutoPrune=%d\n",
470 edit_utime(res->res_client.JobRetention, ed1),
471 edit_utime(res->res_client.FileRetention, ed2),
472 res->res_client.AutoPrune);
473 if (res->res_client.catalog) {
474 sendit(sock, " --> ");
475 dump_resource(-R_CATALOG, (RES *)res->res_client.catalog, sendit, sock);
479 sendit(sock, "Storage: name=%s address=%s SDport=%d MaxJobs=%u\n\
480 DeviceName=%s MediaType=%s\n",
481 res->res_store.hdr.name, res->res_store.address, res->res_store.SDport,
482 res->res_store.MaxConcurrentJobs,
483 res->res_store.dev_name, res->res_store.media_type);
486 sendit(sock, "Catalog: name=%s address=%s DBport=%d db_name=%s\n\
488 res->res_cat.hdr.name, NPRT(res->res_cat.db_address),
489 res->res_cat.db_port, res->res_cat.db_name, NPRT(res->res_cat.db_user));
492 sendit(sock, "Job: name=%s JobType=%d level=%s Priority=%d MaxJobs=%u\n",
493 res->res_job.hdr.name, res->res_job.JobType,
494 level_to_str(res->res_job.level), res->res_job.Priority,
495 res->res_job.MaxConcurrentJobs);
496 sendit(sock, " Resched=%d Times=%d Interval=%s\n",
497 res->res_job.RescheduleOnError, res->res_job.RescheduleTimes,
498 edit_uint64_with_commas(res->res_job.RescheduleInterval, ed1));
499 if (res->res_job.client) {
500 sendit(sock, " --> ");
501 dump_resource(-R_CLIENT, (RES *)res->res_job.client, sendit, sock);
503 if (res->res_job.fileset) {
504 sendit(sock, " --> ");
505 dump_resource(-R_FILESET, (RES *)res->res_job.fileset, sendit, sock);
507 if (res->res_job.schedule) {
508 sendit(sock, " --> ");
509 dump_resource(-R_SCHEDULE, (RES *)res->res_job.schedule, sendit, sock);
511 if (res->res_job.RestoreWhere) {
512 sendit(sock, " --> Where=%s\n", NPRT(res->res_job.RestoreWhere));
514 if (res->res_job.RestoreBootstrap) {
515 sendit(sock, " --> Bootstrap=%s\n", NPRT(res->res_job.RestoreBootstrap));
517 if (res->res_job.RunBeforeJob) {
518 sendit(sock, " --> RunBefore=%s\n", NPRT(res->res_job.RunBeforeJob));
520 if (res->res_job.RunAfterJob) {
521 sendit(sock, " --> RunAfter=%s\n", NPRT(res->res_job.RunAfterJob));
523 if (res->res_job.RunAfterFailedJob) {
524 sendit(sock, " --> RunAfterFailed=%s\n", NPRT(res->res_job.RunAfterFailedJob));
526 if (res->res_job.WriteBootstrap) {
527 sendit(sock, " --> WriteBootstrap=%s\n", NPRT(res->res_job.WriteBootstrap));
529 if (res->res_job.storage) {
530 sendit(sock, " --> ");
531 dump_resource(-R_STORAGE, (RES *)res->res_job.storage, sendit, sock);
533 if (res->res_job.pool) {
534 sendit(sock, " --> ");
535 dump_resource(-R_POOL, (RES *)res->res_job.pool, sendit, sock);
537 sendit(sock, "!!! No Pool resource\n");
539 if (res->res_job.verify_job) {
540 sendit(sock, " --> ");
541 dump_resource(-R_JOB, (RES *)res->res_job.verify_job, sendit, sock);
544 if (res->res_job.messages) {
545 sendit(sock, " --> ");
546 dump_resource(-R_MSGS, (RES *)res->res_job.messages, sendit, sock);
550 sendit(sock, "FileSet: name=%s\n", res->res_fs.hdr.name);
551 for (int i=0; i<res->res_fs.num_includes; i++) {
552 INCEXE *incexe = res->res_fs.include_items[i];
553 for (int j=0; j<incexe->name_list.size(); j++) {
554 sendit(sock, " Inc: %s\n", incexe->name_list.get(j));
557 for (int i=0; i<res->res_fs.num_excludes; i++) {
558 INCEXE *incexe = res->res_fs.exclude_items[i];
559 for (int j=0; j<incexe->name_list.size(); j++) {
560 sendit(sock, " Exc: %s\n", incexe->name_list.get(j));
565 if (res->res_sch.run) {
567 RUN *run = res->res_sch.run;
568 char buf[1000], num[10];
569 sendit(sock, "Schedule: name=%s\n", res->res_sch.hdr.name);
574 sendit(sock, " --> Run Level=%s\n", level_to_str(run->level));
575 bstrncpy(buf, " hour=", sizeof(buf));
576 for (i=0; i<24; i++) {
577 if (bit_is_set(i, run->hour)) {
578 sprintf(num, "%d ", i);
579 bstrncat(buf, num, sizeof(buf));
584 strcpy(buf, " mday=");
585 for (i=0; i<31; i++) {
586 if (bit_is_set(i, run->mday)) {
587 sprintf(num, "%d ", i+1);
593 strcpy(buf, " month=");
594 for (i=0; i<12; i++) {
595 if (bit_is_set(i, run->month)) {
596 sprintf(num, "%d ", i+1);
602 strcpy(buf, " wday=");
603 for (i=0; i<7; i++) {
604 if (bit_is_set(i, run->wday)) {
605 sprintf(num, "%d ", i+1);
611 strcpy(buf, " wpos=");
612 for (i=0; i<5; i++) {
613 if (bit_is_set(i, run->wpos)) {
614 sprintf(num, "%d ", i+1);
620 sendit(sock, " mins=%d\n", run->minute);
622 sendit(sock, " --> ");
623 dump_resource(-R_POOL, (RES *)run->pool, sendit, sock);
626 sendit(sock, " --> ");
627 dump_resource(-R_STORAGE, (RES *)run->storage, sendit, sock);
630 sendit(sock, " --> ");
631 dump_resource(-R_MSGS, (RES *)run->msgs, sendit, sock);
633 /* If another Run record is chained in, go print it */
639 sendit(sock, "Schedule: name=%s\n", res->res_sch.hdr.name);
643 sendit(sock, "Group: name=%s\n", res->res_group.hdr.name);
646 sendit(sock, "Pool: name=%s PoolType=%s\n", res->res_pool.hdr.name,
647 res->res_pool.pool_type);
648 sendit(sock, " use_cat=%d use_once=%d acpt_any=%d cat_files=%d\n",
649 res->res_pool.use_catalog, res->res_pool.use_volume_once,
650 res->res_pool.accept_any_volume, res->res_pool.catalog_files);
651 sendit(sock, " max_vols=%d auto_prune=%d VolRetention=%s\n",
652 res->res_pool.max_volumes, res->res_pool.AutoPrune,
653 edit_utime(res->res_pool.VolRetention, ed1));
654 sendit(sock, " VolUse=%s recycle=%d LabelFormat=%s\n",
655 edit_utime(res->res_pool.VolUseDuration, ed1),
656 res->res_pool.Recycle,
657 NPRT(res->res_pool.label_format));
658 sendit(sock, " CleaningPrefix=%s\n",
659 NPRT(res->res_pool.cleaning_prefix));
660 sendit(sock, " recyleOldest=%d MaxVolJobs=%d MaxVolFiles=%d\n",
661 res->res_pool.purge_oldest_volume,
662 res->res_pool.MaxVolJobs, res->res_pool.MaxVolFiles);
665 sendit(sock, "Messages: name=%s\n", res->res_msgs.hdr.name);
666 if (res->res_msgs.mail_cmd)
667 sendit(sock, " mailcmd=%s\n", res->res_msgs.mail_cmd);
668 if (res->res_msgs.operator_cmd)
669 sendit(sock, " opcmd=%s\n", res->res_msgs.operator_cmd);
672 sendit(sock, "Unknown resource type %d in dump_resource.\n", type);
675 if (recurse && res->res_dir.hdr.next) {
676 dump_resource(type, res->res_dir.hdr.next, sendit, sock);
681 * Free all the members of an INCEXE structure
683 static void free_incexe(INCEXE *incexe)
685 incexe->name_list.destroy();
686 for (int i=0; i<incexe->num_opts; i++) {
687 FOPTS *fopt = incexe->opts_list[i];
688 fopt->match.destroy();
689 fopt->base_list.destroy();
692 if (incexe->opts_list) {
693 free(incexe->opts_list);
699 * Free memory of resource.
700 * NB, we don't need to worry about freeing any references
701 * to other resources as they will be freed when that
702 * resource chain is traversed. Mainly we worry about freeing
703 * allocated strings (names).
705 void free_resource(int type)
710 int rindex = type - r_first;
712 res = (URES *)resources[rindex].res_head;
717 /* common stuff -- free the resource name and description */
718 nres = (RES *)res->res_dir.hdr.next;
719 if (res->res_dir.hdr.name) {
720 free(res->res_dir.hdr.name);
722 if (res->res_dir.hdr.desc) {
723 free(res->res_dir.hdr.desc);
728 if (res->res_dir.working_directory) {
729 free(res->res_dir.working_directory);
731 if (res->res_dir.pid_directory) {
732 free(res->res_dir.pid_directory);
734 if (res->res_dir.subsys_directory) {
735 free(res->res_dir.subsys_directory);
737 if (res->res_dir.password) {
738 free(res->res_dir.password);
740 if (res->res_dir.query_file) {
741 free(res->res_dir.query_file);
743 if (res->res_dir.DIRaddr) {
744 free(res->res_dir.DIRaddr);
750 if (res->res_con.password) {
751 free(res->res_con.password);
755 if (res->res_client.address) {
756 free(res->res_client.address);
758 if (res->res_client.password) {
759 free(res->res_client.password);
763 if (res->res_store.address) {
764 free(res->res_store.address);
766 if (res->res_store.password) {
767 free(res->res_store.password);
769 if (res->res_store.media_type) {
770 free(res->res_store.media_type);
772 if (res->res_store.dev_name) {
773 free(res->res_store.dev_name);
777 if (res->res_cat.db_address) {
778 free(res->res_cat.db_address);
780 if (res->res_cat.db_socket) {
781 free(res->res_cat.db_socket);
783 if (res->res_cat.db_user) {
784 free(res->res_cat.db_user);
786 if (res->res_cat.db_name) {
787 free(res->res_cat.db_name);
789 if (res->res_cat.db_password) {
790 free(res->res_cat.db_password);
794 if ((num=res->res_fs.num_includes)) {
796 free_incexe(res->res_fs.include_items[num]);
798 free(res->res_fs.include_items);
800 res->res_fs.num_includes = 0;
801 if ((num=res->res_fs.num_excludes)) {
803 free_incexe(res->res_fs.exclude_items[num]);
805 free(res->res_fs.exclude_items);
807 res->res_fs.num_excludes = 0;
810 if (res->res_pool.pool_type) {
811 free(res->res_pool.pool_type);
813 if (res->res_pool.label_format) {
814 free(res->res_pool.label_format);
816 if (res->res_pool.cleaning_prefix) {
817 free(res->res_pool.cleaning_prefix);
821 if (res->res_sch.run) {
823 nrun = res->res_sch.run;
832 if (res->res_job.RestoreWhere) {
833 free(res->res_job.RestoreWhere);
835 if (res->res_job.RestoreBootstrap) {
836 free(res->res_job.RestoreBootstrap);
838 if (res->res_job.WriteBootstrap) {
839 free(res->res_job.WriteBootstrap);
841 if (res->res_job.RunBeforeJob) {
842 free(res->res_job.RunBeforeJob);
844 if (res->res_job.RunAfterJob) {
845 free(res->res_job.RunAfterJob);
847 if (res->res_job.RunAfterFailedJob) {
848 free(res->res_job.RunAfterFailedJob);
850 if (res->res_job.ClientRunBeforeJob) {
851 free(res->res_job.ClientRunBeforeJob);
853 if (res->res_job.ClientRunAfterJob) {
854 free(res->res_job.ClientRunAfterJob);
858 if (res->res_msgs.mail_cmd) {
859 free(res->res_msgs.mail_cmd);
861 if (res->res_msgs.operator_cmd) {
862 free(res->res_msgs.operator_cmd);
864 free_msgs_res((MSGS *)res); /* free message resource */
870 printf("Unknown resource type %d in free_resource.\n", type);
872 /* Common stuff again -- free the resource, recurse to next one */
876 resources[rindex].res_head = nres;
883 * Save the new resource by chaining it into the head list for
884 * the resource. If this is pass 2, we update any resource
885 * pointers because they may not have been defined until
888 void save_resource(int type, struct res_items *items, int pass)
891 int rindex = type - r_first;
896 * Ensure that all required items are present
898 for (i=0; items[i].name; i++) {
899 if (items[i].flags & ITEM_REQUIRED) {
900 if (!bit_is_set(i, res_all.res_dir.hdr.item_present)) {
901 Emsg2(M_ERROR_TERM, 0, "%s item is required in %s resource, but not found.\n",
902 items[i].name, resources[rindex]);
905 /* If this triggers, take a look at lib/parse_conf.h */
906 if (i >= MAX_RES_ITEMS) {
907 Emsg1(M_ERROR_TERM, 0, "Too many items in %s resource\n", resources[rindex]);
911 /* During pass 2 in each "store" routine, we looked up pointers
912 * to all the resources referrenced in the current resource, now we
913 * must copy their addresses from the static record to the allocated
918 /* Resources not containing a resource */
928 /* Resources containing another resource */
930 if ((res = (URES *)GetResWithName(R_DIRECTOR, res_all.res_dir.hdr.name)) == NULL) {
931 Emsg1(M_ERROR_TERM, 0, "Cannot find Director resource %s\n", res_all.res_dir.hdr.name);
933 res->res_dir.messages = res_all.res_dir.messages;
936 if ((res = (URES *)GetResWithName(R_JOB, res_all.res_dir.hdr.name)) == NULL) {
937 Emsg1(M_ERROR_TERM, 0, "Cannot find Job resource %s\n", res_all.res_dir.hdr.name);
939 res->res_job.messages = res_all.res_job.messages;
940 res->res_job.schedule = res_all.res_job.schedule;
941 res->res_job.client = res_all.res_job.client;
942 res->res_job.fileset = res_all.res_job.fileset;
943 res->res_job.storage = res_all.res_job.storage;
944 res->res_job.pool = res_all.res_job.pool;
945 res->res_job.verify_job = res_all.res_job.verify_job;
946 if (res->res_job.JobType == 0) {
947 Emsg1(M_ERROR_TERM, 0, "Job Type not defined for Job resource %s\n", res_all.res_dir.hdr.name);
949 if (res->res_job.level != 0) {
951 for (i=0; joblevels[i].level_name; i++) {
952 if (joblevels[i].level == res->res_job.level &&
953 joblevels[i].job_type == res->res_job.JobType) {
959 Emsg1(M_ERROR_TERM, 0, "Inappropriate level specified in Job resource %s\n",
960 res_all.res_dir.hdr.name);
965 if ((res = (URES *)GetResWithName(R_COUNTER, res_all.res_counter.hdr.name)) == NULL) {
966 Emsg1(M_ERROR_TERM, 0, "Cannot find Counter resource %s\n", res_all.res_counter.hdr.name);
968 res->res_counter.Catalog = res_all.res_counter.Catalog;
969 res->res_counter.WrapCounter = res_all.res_counter.WrapCounter;
973 if ((res = (URES *)GetResWithName(R_CLIENT, res_all.res_client.hdr.name)) == NULL) {
974 Emsg1(M_ERROR_TERM, 0, "Cannot find Client resource %s\n", res_all.res_client.hdr.name);
976 res->res_client.catalog = res_all.res_client.catalog;
979 /* Schedule is a bit different in that it contains a RUN record
980 * chain which isn't a "named" resource. This chain was linked
981 * in by run_conf.c during pass 2, so here we jam the pointer
982 * into the Schedule resource.
984 if ((res = (URES *)GetResWithName(R_SCHEDULE, res_all.res_client.hdr.name)) == NULL) {
985 Emsg1(M_ERROR_TERM, 0, "Cannot find Schedule resource %s\n", res_all.res_client.hdr.name);
987 res->res_sch.run = res_all.res_sch.run;
990 Emsg1(M_ERROR, 0, "Unknown resource type %d in save_resource.\n", type);
994 /* Note, the resource name was already saved during pass 1,
995 * so here, we can just release it.
997 if (res_all.res_dir.hdr.name) {
998 free(res_all.res_dir.hdr.name);
999 res_all.res_dir.hdr.name = NULL;
1001 if (res_all.res_dir.hdr.desc) {
1002 free(res_all.res_dir.hdr.desc);
1003 res_all.res_dir.hdr.desc = NULL;
1009 * The following code is only executed during pass 1
1013 size = sizeof(DIRRES);
1016 size = sizeof(CONRES);
1019 size =sizeof(CLIENT);
1022 size = sizeof(STORE);
1031 size = sizeof(FILESET);
1034 size = sizeof(SCHED);
1037 size = sizeof(GROUP);
1040 size = sizeof(POOL);
1043 size = sizeof(MSGS);
1046 size = sizeof(COUNTER);
1049 printf("Unknown resource type %d in save_resrouce.\n", type);
1056 res = (URES *)malloc(size);
1057 memcpy(res, &res_all, size);
1058 if (!resources[rindex].res_head) {
1059 resources[rindex].res_head = (RES *)res; /* store first entry */
1060 Dmsg3(200, "Inserting first %s res: %s index=%d\n", res_to_str(type),
1061 res->res_dir.hdr.name, rindex);
1064 /* Add new res to end of chain */
1065 for (next=resources[rindex].res_head; next->next; next=next->next) {
1066 if (strcmp(next->name, res->res_dir.hdr.name) == 0) {
1067 Emsg2(M_ERROR_TERM, 0,
1068 _("Attempt to define second %s resource named \"%s\" is not permitted.\n"),
1069 resources[rindex].name, res->res_dir.hdr.name);
1072 next->next = (RES *)res;
1073 Dmsg4(200, "Inserting %s res: %s index=%d pass=%d\n", res_to_str(type),
1074 res->res_dir.hdr.name, rindex, pass);
1080 * Store JobType (backup, verify, restore)
1083 static void store_jobtype(LEX *lc, struct res_items *item, int index, int pass)
1087 token = lex_get_token(lc, T_NAME);
1088 /* Store the type both pass 1 and pass 2 */
1089 for (i=0; jobtypes[i].type_name; i++) {
1090 if (strcasecmp(lc->str, jobtypes[i].type_name) == 0) {
1091 ((JOB *)(item->value))->JobType = jobtypes[i].job_type;
1097 scan_err1(lc, "Expected a Job Type keyword, got: %s", lc->str);
1100 set_bit(index, res_all.hdr.item_present);
1104 * Store Job Level (Full, Incremental, ...)
1107 static void store_level(LEX *lc, struct res_items *item, int index, int pass)
1111 token = lex_get_token(lc, T_NAME);
1112 /* Store the level pass 2 so that type is defined */
1113 for (i=0; joblevels[i].level_name; i++) {
1114 if (strcasecmp(lc->str, joblevels[i].level_name) == 0) {
1115 ((JOB *)(item->value))->level = joblevels[i].level;
1121 scan_err1(lc, "Expected a Job Level keyword, got: %s", lc->str);
1124 set_bit(index, res_all.hdr.item_present);
1127 static void store_replace(LEX *lc, struct res_items *item, int index, int pass)
1130 token = lex_get_token(lc, T_NAME);
1131 /* Scan Replacement options */
1132 for (i=0; ReplaceOptions[i].name; i++) {
1133 if (strcasecmp(lc->str, ReplaceOptions[i].name) == 0) {
1134 *(int *)(item->value) = ReplaceOptions[i].token;
1140 scan_err1(lc, "Expected a Restore replacement option, got: %s", lc->str);
1143 set_bit(index, res_all.hdr.item_present);
1147 * Store backup/verify info for Job record
1149 * Note, this code is used for both BACKUP and VERIFY jobs
1151 * Backup = Client=<client-name> FileSet=<FileSet-name> Level=<level>
1153 static void store_backup(LEX *lc, struct res_items *item, int index, int pass)
1157 int options = lc->options;
1159 lc->options |= LOPT_NO_IDENT; /* make spaces significant */
1162 ((JOB *)(item->value))->JobType = item->code;
1163 while ((token = lex_get_token(lc, T_ALL)) != T_EOL) {
1166 Dmsg1(150, "store_backup got token=%s\n", lex_tok_to_str(token));
1168 if (token != T_IDENTIFIER && token != T_UNQUOTED_STRING && token != T_QUOTED_STRING) {
1169 scan_err1(lc, "Expected a backup/verify keyword, got: %s", lc->str);
1171 Dmsg1(190, "Got keyword: %s\n", lc->str);
1172 for (i=0; BakVerFields[i].name; i++) {
1173 if (strcasecmp(lc->str, BakVerFields[i].name) == 0) {
1175 if (lex_get_token(lc, T_ALL) != T_EQUALS) {
1176 scan_err1(lc, "Expected an equals, got: %s", lc->str);
1178 token = lex_get_token(lc, T_NAME);
1179 Dmsg1(190, "Got value: %s\n", lc->str);
1180 switch (BakVerFields[i].token) {
1182 /* Find Client Resource */
1184 res = GetResWithName(R_CLIENT, lc->str);
1186 scan_err1(lc, "Could not find specified Client Resource: %s",
1189 res_all.res_job.client = (CLIENT *)res;
1193 /* Find FileSet Resource */
1195 res = GetResWithName(R_FILESET, lc->str);
1197 scan_err1(lc, "Could not find specified FileSet Resource: %s\n",
1200 res_all.res_job.fileset = (FILESET *)res;
1205 for (i=0; joblevels[i].level_name; i++) {
1206 if (joblevels[i].job_type == item->code &&
1207 strcasecmp(lc->str, joblevels[i].level_name) == 0) {
1208 ((JOB *)(item->value))->level = joblevels[i].level;
1214 scan_err1(lc, "Expected a Job Level keyword, got: %s", lc->str);
1219 } /* end if strcmp() */
1222 scan_err1(lc, "%s not a valid Backup/verify keyword", lc->str);
1225 lc->options = options; /* reset original options */
1226 set_bit(index, res_all.hdr.item_present);
1230 * Store restore info for Job record
1232 * Restore = JobId=<job-id> Where=<root-directory> Replace=<options> Bootstrap=<file>
1235 static void store_restore(LEX *lc, struct res_items *item, int index, int pass)
1239 int options = lc->options;
1241 lc->options |= LOPT_NO_IDENT; /* make spaces significant */
1243 Dmsg0(190, "Enter store_restore()\n");
1245 ((JOB *)(item->value))->JobType = item->code;
1246 while ((token = lex_get_token(lc, T_ALL)) != T_EOL) {
1249 if (token != T_IDENTIFIER && token != T_UNQUOTED_STRING && token != T_QUOTED_STRING) {
1250 scan_err1(lc, "expected a name, got: %s", lc->str);
1252 for (i=0; RestoreFields[i].name; i++) {
1253 Dmsg1(190, "Restore kw=%s\n", lc->str);
1254 if (strcasecmp(lc->str, RestoreFields[i].name) == 0) {
1256 if (lex_get_token(lc, T_ALL) != T_EQUALS) {
1257 scan_err1(lc, "Expected an equals, got: %s", lc->str);
1259 token = lex_get_token(lc, T_ALL);
1260 Dmsg1(190, "Restore value=%s\n", lc->str);
1261 switch (RestoreFields[i].token) {
1264 if (token != T_IDENTIFIER && token != T_UNQUOTED_STRING && token != T_QUOTED_STRING) {
1265 scan_err1(lc, "Expected a Restore bootstrap file, got: %s", lc->str);
1268 res_all.res_job.RestoreBootstrap = bstrdup(lc->str);
1272 /* Find Client Resource */
1274 res = GetResWithName(R_CLIENT, lc->str);
1276 scan_err1(lc, "Could not find specified Client Resource: %s",
1279 res_all.res_job.client = (CLIENT *)res;
1283 /* Find FileSet Resource */
1285 res = GetResWithName(R_FILESET, lc->str);
1287 scan_err1(lc, "Could not find specified FileSet Resource: %s\n",
1290 res_all.res_job.fileset = (FILESET *)res;
1295 if (token != T_NUMBER) {
1296 scan_err1(lc, "expected an integer number, got: %s", lc->str);
1299 res_all.res_job.RestoreJobId = strtol(lc->str, NULL, 0);
1300 Dmsg1(190, "RestorJobId=%d\n", res_all.res_job.RestoreJobId);
1302 scan_err1(lc, "expected an integer number, got: %s", lc->str);
1307 if (token != T_IDENTIFIER && token != T_UNQUOTED_STRING && token != T_QUOTED_STRING) {
1308 scan_err1(lc, "Expected a Restore root directory, got: %s", lc->str);
1311 res_all.res_job.RestoreWhere = bstrdup(lc->str);
1315 /* Replacement options */
1316 if (token != T_IDENTIFIER && token != T_UNQUOTED_STRING && token != T_QUOTED_STRING) {
1317 scan_err1(lc, "Expected a keyword name, got: %s", lc->str);
1319 /* Fix to scan Replacement options */
1320 for (i=0; ReplaceOptions[i].name; i++) {
1321 if (strcasecmp(lc->str, ReplaceOptions[i].name) == 0) {
1322 ((JOB *)(item->value))->replace = ReplaceOptions[i].token;
1328 scan_err1(lc, "Expected a Restore replacement option, got: %s", lc->str);
1333 } /* end if strcmp() */
1336 scan_err1(lc, "%s not a valid Restore keyword", lc->str);
1339 lc->options = options; /* reset original options */
1340 set_bit(index, res_all.hdr.item_present);