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-2004 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;
53 static RES *sres_head[R_LAST - R_FIRST + 1];
54 RES **res_head = sres_head;
56 /* Imported subroutines */
57 extern void store_run(LEX *lc, RES_ITEM *item, int index, int pass);
58 extern void store_finc(LEX *lc, RES_ITEM *item, int index, int pass);
59 extern void store_inc(LEX *lc, RES_ITEM *item, int index, int pass);
62 /* Forward referenced subroutines */
64 void store_jobtype(LEX *lc, RES_ITEM *item, int index, int pass);
65 void store_level(LEX *lc, RES_ITEM *item, int index, int pass);
66 void store_replace(LEX *lc, RES_ITEM *item, int index, int pass);
67 void store_acl(LEX *lc, RES_ITEM *item, int index, int pass);
70 /* We build the current resource here as we are
71 * scanning the resource configuration definition,
72 * then move it to allocated memory when the resource
76 int res_all_size = sizeof(res_all);
79 /* Definition of records permitted within each
80 * resource with the routine to process the record
81 * information. NOTE! quoted names must be in lower case.
86 * name handler value code flags default_value
88 static RES_ITEM dir_items[] = {
89 {"name", store_name, ITEM(res_dir.hdr.name), 0, ITEM_REQUIRED, 0},
90 {"description", store_str, ITEM(res_dir.hdr.desc), 0, 0, 0},
91 {"messages", store_res, ITEM(res_dir.messages), R_MSGS, 0, 0},
92 {"dirport", store_addresses_port, ITEM(res_dir.DIRaddrs), 0, ITEM_DEFAULT, 9101},
93 {"diraddress", store_addresses_address, ITEM(res_dir.DIRaddrs), 0, ITEM_DEFAULT, 9101},
94 {"diraddresses",store_addresses, ITEM(res_dir.DIRaddrs), 0, ITEM_DEFAULT, 9101},
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 RES_ITEM 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 {"jobacl", store_acl, ITEM(res_con.ACL_lists), Job_ACL, 0, 0},
119 {"clientacl", store_acl, ITEM(res_con.ACL_lists), Client_ACL, 0, 0},
120 {"storageacl", store_acl, ITEM(res_con.ACL_lists), Storage_ACL, 0, 0},
121 {"scheduleacl", store_acl, ITEM(res_con.ACL_lists), Schedule_ACL, 0, 0},
122 {"runacl", store_acl, ITEM(res_con.ACL_lists), Run_ACL, 0, 0},
123 {"poolacl", store_acl, ITEM(res_con.ACL_lists), Pool_ACL, 0, 0},
124 {"commandacl", store_acl, ITEM(res_con.ACL_lists), Command_ACL, 0, 0},
125 {"filesetacl", store_acl, ITEM(res_con.ACL_lists), FileSet_ACL, 0, 0},
126 {"catalogacl", store_acl, ITEM(res_con.ACL_lists), Catalog_ACL, 0, 0},
127 {NULL, NULL, NULL, 0, 0, 0}
132 * Client or File daemon resource
134 * name handler value code flags default_value
137 static RES_ITEM cli_items[] = {
138 {"name", store_name, ITEM(res_client.hdr.name), 0, ITEM_REQUIRED, 0},
139 {"description", store_str, ITEM(res_client.hdr.desc), 0, 0, 0},
140 {"address", store_str, ITEM(res_client.address), 0, ITEM_REQUIRED, 0},
141 {"fdaddress", store_str, ITEM(res_client.address), 0, 0, 0},
142 {"fdport", store_pint, ITEM(res_client.FDport), 0, ITEM_DEFAULT, 9102},
143 {"password", store_password, ITEM(res_client.password), 0, ITEM_REQUIRED, 0},
144 {"fdpassword", store_password, ITEM(res_client.password), 0, 0, 0},
145 {"catalog", store_res, ITEM(res_client.catalog), R_CATALOG, ITEM_REQUIRED, 0},
146 {"fileretention", store_time, ITEM(res_client.FileRetention), 0, ITEM_DEFAULT, 60*60*24*60},
147 {"jobretention", store_time, ITEM(res_client.JobRetention), 0, ITEM_DEFAULT, 60*60*24*180},
148 {"autoprune", store_yesno, ITEM(res_client.AutoPrune), 1, ITEM_DEFAULT, 1},
149 {"enablessl", store_yesno, ITEM(res_client.enable_ssl), 1, ITEM_DEFAULT, 0},
150 {"maximumconcurrentjobs", store_pint, ITEM(res_client.MaxConcurrentJobs), 0, ITEM_DEFAULT, 1},
151 {NULL, NULL, NULL, 0, 0, 0}
154 /* Storage daemon resource
156 * name handler value code flags default_value
158 static RES_ITEM store_items[] = {
159 {"name", store_name, ITEM(res_store.hdr.name), 0, ITEM_REQUIRED, 0},
160 {"description", store_str, ITEM(res_store.hdr.desc), 0, 0, 0},
161 {"sdport", store_pint, ITEM(res_store.SDport), 0, ITEM_DEFAULT, 9103},
162 {"address", store_str, ITEM(res_store.address), 0, ITEM_REQUIRED, 0},
163 {"sdaddress", store_str, ITEM(res_store.address), 0, 0, 0},
164 {"password", store_password, ITEM(res_store.password), 0, ITEM_REQUIRED, 0},
165 {"sdpassword", store_password, ITEM(res_store.password), 0, 0, 0},
166 {"device", store_strname, ITEM(res_store.dev_name), 0, ITEM_REQUIRED, 0},
167 {"sddevicename", store_strname, ITEM(res_store.dev_name), 0, 0, 0},
168 {"mediatype", store_strname, ITEM(res_store.media_type), 0, ITEM_REQUIRED, 0},
169 {"autochanger", store_yesno, ITEM(res_store.autochanger), 1, ITEM_DEFAULT, 0},
170 {"enablessl", store_yesno, ITEM(res_store.enable_ssl), 1, ITEM_DEFAULT, 0},
171 {"maximumconcurrentjobs", store_pint, ITEM(res_store.MaxConcurrentJobs), 0, ITEM_DEFAULT, 1},
172 {"sddport", store_pint, ITEM(res_store.SDDport), 0, 0, 0}, /* deprecated */
173 {NULL, NULL, NULL, 0, 0, 0}
177 * Catalog Resource Directives
179 * name handler value code flags default_value
181 static RES_ITEM cat_items[] = {
182 {"name", store_name, ITEM(res_cat.hdr.name), 0, ITEM_REQUIRED, 0},
183 {"description", store_str, ITEM(res_cat.hdr.desc), 0, 0, 0},
184 {"address", store_str, ITEM(res_cat.db_address), 0, 0, 0},
185 {"dbaddress", store_str, ITEM(res_cat.db_address), 0, 0, 0},
186 {"dbport", store_pint, ITEM(res_cat.db_port), 0, 0, 0},
187 /* keep this password as store_str for the moment */
188 {"password", store_str, ITEM(res_cat.db_password), 0, 0, 0},
189 {"dbpassword", store_str, ITEM(res_cat.db_password), 0, 0, 0},
190 {"user", store_str, ITEM(res_cat.db_user), 0, 0, 0},
191 {"dbname", store_str, ITEM(res_cat.db_name), 0, ITEM_REQUIRED, 0},
192 {"dbsocket", store_str, ITEM(res_cat.db_socket), 0, 0, 0},
193 {"multipleconnections", store_yesno, ITEM(res_cat.mult_db_connections), 0, 0, 0},
194 {NULL, NULL, NULL, 0, 0, 0}
198 * Job Resource Directives
200 * name handler value code flags default_value
202 RES_ITEM job_items[] = {
203 {"name", store_name, ITEM(res_job.hdr.name), 0, ITEM_REQUIRED, 0},
204 {"description", store_str, ITEM(res_job.hdr.desc), 0, 0, 0},
205 {"type", store_jobtype, ITEM(res_job.JobType), 0, ITEM_REQUIRED, 0},
206 {"level", store_level, ITEM(res_job.JobLevel), 0, 0, 0},
207 {"messages", store_res, ITEM(res_job.messages), R_MSGS, ITEM_REQUIRED, 0},
208 {"storage", store_alist_res, ITEM(res_job.storage), R_STORAGE, ITEM_REQUIRED, MAX_STORE},
209 {"pool", store_res, ITEM(res_job.pool), R_POOL, ITEM_REQUIRED, 0},
210 {"fullbackuppool", store_res, ITEM(res_job.full_pool), R_POOL, 0, 0},
211 {"incrementalbackuppool", store_res, ITEM(res_job.inc_pool), R_POOL, 0, 0},
212 {"differentialbackuppool", store_res, ITEM(res_job.dif_pool), R_POOL, 0, 0},
213 {"client", store_res, ITEM(res_job.client), R_CLIENT, ITEM_REQUIRED, 0},
214 {"fileset", store_res, ITEM(res_job.fileset), R_FILESET, ITEM_REQUIRED, 0},
215 {"schedule", store_res, ITEM(res_job.schedule), R_SCHEDULE, 0, 0},
216 {"verifyjob", store_res, ITEM(res_job.verify_job), R_JOB, 0, 0},
217 {"jobdefs", store_res, ITEM(res_job.jobdefs), R_JOBDEFS, 0, 0},
218 {"where", store_dir, ITEM(res_job.RestoreWhere), 0, 0, 0},
219 {"bootstrap",store_dir, ITEM(res_job.RestoreBootstrap), 0, 0, 0},
220 {"writebootstrap",store_dir, ITEM(res_job.WriteBootstrap), 0, 0, 0},
221 {"replace", store_replace, ITEM(res_job.replace), 0, ITEM_DEFAULT, REPLACE_ALWAYS},
222 {"maxruntime", store_time, ITEM(res_job.MaxRunTime), 0, 0, 0},
223 {"maxwaittime", store_time, ITEM(res_job.MaxWaitTime), 0, 0, 0},
224 {"maxstartdelay",store_time, ITEM(res_job.MaxStartDelay), 0, 0, 0},
225 {"jobretention", store_time, ITEM(res_job.JobRetention), 0, 0, 0},
226 {"prefixlinks", store_yesno, ITEM(res_job.PrefixLinks), 1, ITEM_DEFAULT, 0},
227 {"prunejobs", store_yesno, ITEM(res_job.PruneJobs), 1, ITEM_DEFAULT, 0},
228 {"prunefiles", store_yesno, ITEM(res_job.PruneFiles), 1, ITEM_DEFAULT, 0},
229 {"prunevolumes",store_yesno, ITEM(res_job.PruneVolumes), 1, ITEM_DEFAULT, 0},
230 {"spoolattributes",store_yesno, ITEM(res_job.SpoolAttributes), 1, ITEM_DEFAULT, 0},
231 {"spooldata", store_yesno, ITEM(res_job.spool_data), 1, ITEM_DEFAULT, 0},
232 {"rerunfailedlevels", store_yesno, ITEM(res_job.rerun_failed_levels), 1, ITEM_DEFAULT, 0},
233 {"runbeforejob", store_str, ITEM(res_job.RunBeforeJob), 0, 0, 0},
234 {"runafterjob", store_str, ITEM(res_job.RunAfterJob), 0, 0, 0},
235 {"runafterfailedjob", store_str, ITEM(res_job.RunAfterFailedJob), 0, 0, 0},
236 {"clientrunbeforejob", store_str, ITEM(res_job.ClientRunBeforeJob), 0, 0, 0},
237 {"clientrunafterjob", store_str, ITEM(res_job.ClientRunAfterJob), 0, 0, 0},
238 {"maximumconcurrentjobs", store_pint, ITEM(res_job.MaxConcurrentJobs), 0, ITEM_DEFAULT, 1},
239 {"rescheduleonerror", store_yesno, ITEM(res_job.RescheduleOnError), 1, ITEM_DEFAULT, 0},
240 {"rescheduleinterval", store_time, ITEM(res_job.RescheduleInterval), 0, ITEM_DEFAULT, 60 * 30},
241 {"rescheduletimes", store_pint, ITEM(res_job.RescheduleTimes), 0, 0, 0},
242 {"priority", store_pint, ITEM(res_job.Priority), 0, ITEM_DEFAULT, 10},
243 {NULL, NULL, NULL, 0, 0, 0}
248 * name handler value code flags default_value
250 static RES_ITEM fs_items[] = {
251 {"name", store_name, ITEM(res_fs.hdr.name), 0, ITEM_REQUIRED, 0},
252 {"description", store_str, ITEM(res_fs.hdr.desc), 0, 0, 0},
253 {"include", store_inc, NULL, 0, ITEM_NO_EQUALS, 0},
254 {"exclude", store_inc, NULL, 1, ITEM_NO_EQUALS, 0},
255 {"ignorefilesetchanges", store_yesno, ITEM(res_fs.ignore_fs_changes), 1, ITEM_DEFAULT, 0},
256 {NULL, NULL, NULL, 0, 0, 0}
259 /* Schedule -- see run_conf.c */
262 * name handler value code flags default_value
264 static RES_ITEM sch_items[] = {
265 {"name", store_name, ITEM(res_sch.hdr.name), 0, ITEM_REQUIRED, 0},
266 {"description", store_str, ITEM(res_sch.hdr.desc), 0, 0, 0},
267 {"run", store_run, ITEM(res_sch.run), 0, 0, 0},
268 {NULL, NULL, NULL, 0, 0, 0}
273 * name handler value code flags default_value
275 static RES_ITEM pool_items[] = {
276 {"name", store_name, ITEM(res_pool.hdr.name), 0, ITEM_REQUIRED, 0},
277 {"description", store_str, ITEM(res_pool.hdr.desc), 0, 0, 0},
278 {"pooltype", store_strname, ITEM(res_pool.pool_type), 0, ITEM_REQUIRED, 0},
279 {"labelformat", store_strname, ITEM(res_pool.label_format), 0, 0, 0},
280 {"cleaningprefix", store_strname, ITEM(res_pool.cleaning_prefix), 0, 0, 0},
281 {"usecatalog", store_yesno, ITEM(res_pool.use_catalog), 1, ITEM_DEFAULT, 1},
282 {"usevolumeonce", store_yesno, ITEM(res_pool.use_volume_once), 1, 0, 0},
283 {"purgeoldestvolume", store_yesno, ITEM(res_pool.purge_oldest_volume), 1, 0, 0},
284 {"recycleoldestvolume", store_yesno, ITEM(res_pool.recycle_oldest_volume), 1, 0, 0},
285 {"recyclecurrentvolume", store_yesno, ITEM(res_pool.recycle_current_volume), 1, 0, 0},
286 {"maximumvolumes", store_pint, ITEM(res_pool.max_volumes), 0, 0, 0},
287 {"maximumvolumejobs", store_pint, ITEM(res_pool.MaxVolJobs), 0, 0, 0},
288 {"maximumvolumefiles", store_pint, ITEM(res_pool.MaxVolFiles), 0, 0, 0},
289 {"maximumvolumebytes", store_size, ITEM(res_pool.MaxVolBytes), 0, 0, 0},
290 {"acceptanyvolume", store_yesno, ITEM(res_pool.accept_any_volume), 1, ITEM_DEFAULT, 1},
291 {"catalogfiles", store_yesno, ITEM(res_pool.catalog_files), 1, ITEM_DEFAULT, 1},
292 {"volumeretention", store_time, ITEM(res_pool.VolRetention), 0, ITEM_DEFAULT, 60*60*24*365},
293 {"volumeuseduration", store_time, ITEM(res_pool.VolUseDuration),0, 0, 0},
294 {"autoprune", store_yesno, ITEM(res_pool.AutoPrune), 1, ITEM_DEFAULT, 1},
295 {"recycle", store_yesno, ITEM(res_pool.Recycle), 1, ITEM_DEFAULT, 1},
296 {NULL, NULL, NULL, 0, 0, 0}
301 * name handler value code flags default_value
303 static RES_ITEM counter_items[] = {
304 {"name", store_name, ITEM(res_counter.hdr.name), 0, ITEM_REQUIRED, 0},
305 {"description", store_str, ITEM(res_counter.hdr.desc), 0, 0, 0},
306 {"minimum", store_int, ITEM(res_counter.MinValue), 0, ITEM_DEFAULT, 0},
307 {"maximum", store_pint, ITEM(res_counter.MaxValue), 0, ITEM_DEFAULT, INT32_MAX},
308 {"wrapcounter", store_res, ITEM(res_counter.WrapCounter), R_COUNTER, 0, 0},
309 {"catalog", store_res, ITEM(res_counter.Catalog), R_CATALOG, 0, 0},
310 {NULL, NULL, NULL, 0, 0, 0}
314 /* Message resource */
315 extern RES_ITEM msgs_items[];
318 * This is the master resource definition.
319 * It must have one item for each of the resources.
321 * NOTE!!! keep it in the same order as the R_codes
322 * or eliminate all resources[rindex].name
324 * name items rcode res_head
326 RES_TABLE resources[] = {
327 {"director", dir_items, R_DIRECTOR},
328 {"client", cli_items, R_CLIENT},
329 {"job", job_items, R_JOB},
330 {"storage", store_items, R_STORAGE},
331 {"catalog", cat_items, R_CATALOG},
332 {"schedule", sch_items, R_SCHEDULE},
333 {"fileset", fs_items, R_FILESET},
334 {"pool", pool_items, R_POOL},
335 {"messages", msgs_items, R_MSGS},
336 {"counter", counter_items, R_COUNTER},
337 {"console", con_items, R_CONSOLE},
338 {"jobdefs", job_items, R_JOBDEFS},
343 /* Keywords (RHS) permitted in Job Level records
345 * level_name level job_type
347 struct s_jl joblevels[] = {
348 {"Full", L_FULL, JT_BACKUP},
349 {"Base", L_BASE, JT_BACKUP},
350 {"Incremental", L_INCREMENTAL, JT_BACKUP},
351 {"Differential", L_DIFFERENTIAL, JT_BACKUP},
352 {"Since", L_SINCE, JT_BACKUP},
353 {"Catalog", L_VERIFY_CATALOG, JT_VERIFY},
354 {"InitCatalog", L_VERIFY_INIT, JT_VERIFY},
355 {"VolumeToCatalog", L_VERIFY_VOLUME_TO_CATALOG, JT_VERIFY},
356 {"DiskToCatalog", L_VERIFY_DISK_TO_CATALOG, JT_VERIFY},
357 {"Data", L_VERIFY_DATA, JT_VERIFY},
358 {" ", L_NONE, JT_ADMIN},
359 {" ", L_NONE, JT_RESTORE},
363 /* Keywords (RHS) permitted in Job type records
367 struct s_jt jobtypes[] = {
368 {"backup", JT_BACKUP},
370 {"verify", JT_VERIFY},
371 {"restore", JT_RESTORE},
375 #ifdef old_deprecated_code
377 /* Keywords (RHS) permitted in Backup and Verify records */
378 static struct s_kw BakVerFields[] = {
385 /* Keywords (RHS) permitted in Restore records */
386 static struct s_kw RestoreFields[] = {
389 {"jobid", 'J'}, /* JobId to restore */
390 {"where", 'W'}, /* root of restore */
391 {"replace", 'R'}, /* replacement options */
392 {"bootstrap", 'B'}, /* bootstrap file */
397 /* Options permitted in Restore replace= */
398 struct s_kw ReplaceOptions[] = {
399 {"always", REPLACE_ALWAYS},
400 {"ifnewer", REPLACE_IFNEWER},
401 {"ifolder", REPLACE_IFOLDER},
402 {"never", REPLACE_NEVER},
406 const char *level_to_str(int level)
409 static char level_no[30];
410 const char *str = level_no;
412 bsnprintf(level_no, sizeof(level_no), "%d", level); /* default if not found */
413 for (i=0; joblevels[i].level_name; i++) {
414 if (level == joblevels[i].level) {
415 str = joblevels[i].level_name;
422 /* Dump contents of resource */
423 void dump_resource(int type, RES *reshdr, void sendit(void *sock, const char *fmt, ...), void *sock)
425 URES *res = (URES *)reshdr;
427 char ed1[100], ed2[100];
430 sendit(sock, "No %s resource defined\n", res_to_str(type));
433 if (type < 0) { /* no recursion */
439 sendit(sock, "Director: name=%s MaxJobs=%d FDtimeout=%s SDtimeout=%s\n",
440 reshdr->name, res->res_dir.MaxConcurrentJobs,
441 edit_uint64(res->res_dir.FDConnectTimeout, ed1),
442 edit_uint64(res->res_dir.SDConnectTimeout, ed2));
443 if (res->res_dir.query_file) {
444 sendit(sock, " query_file=%s\n", res->res_dir.query_file);
446 if (res->res_dir.messages) {
447 sendit(sock, " --> ");
448 dump_resource(-R_MSGS, (RES *)res->res_dir.messages, sendit, sock);
452 sendit(sock, "Console: name=%s SSL=%d\n",
453 res->res_con.hdr.name, res->res_con.enable_ssl);
456 if (res->res_counter.WrapCounter) {
457 sendit(sock, "Counter: name=%s min=%d max=%d cur=%d wrapcntr=%s\n",
458 res->res_counter.hdr.name, res->res_counter.MinValue,
459 res->res_counter.MaxValue, res->res_counter.CurrentValue,
460 res->res_counter.WrapCounter->hdr.name);
462 sendit(sock, "Counter: name=%s min=%d max=%d\n",
463 res->res_counter.hdr.name, res->res_counter.MinValue,
464 res->res_counter.MaxValue);
466 if (res->res_counter.Catalog) {
467 sendit(sock, " --> ");
468 dump_resource(-R_CATALOG, (RES *)res->res_counter.Catalog, sendit, sock);
473 sendit(sock, "Client: name=%s address=%s FDport=%d MaxJobs=%u\n",
474 res->res_client.hdr.name, res->res_client.address, res->res_client.FDport,
475 res->res_client.MaxConcurrentJobs);
476 sendit(sock, " JobRetention=%s FileRetention=%s AutoPrune=%d\n",
477 edit_utime(res->res_client.JobRetention, ed1, sizeof(ed1)),
478 edit_utime(res->res_client.FileRetention, ed2, sizeof(ed2)),
479 res->res_client.AutoPrune);
480 if (res->res_client.catalog) {
481 sendit(sock, " --> ");
482 dump_resource(-R_CATALOG, (RES *)res->res_client.catalog, sendit, sock);
486 sendit(sock, "Storage: name=%s address=%s SDport=%d MaxJobs=%u\n\
487 DeviceName=%s MediaType=%s\n",
488 res->res_store.hdr.name, res->res_store.address, res->res_store.SDport,
489 res->res_store.MaxConcurrentJobs,
490 res->res_store.dev_name, res->res_store.media_type);
493 sendit(sock, "Catalog: name=%s address=%s DBport=%d db_name=%s\n\
495 res->res_cat.hdr.name, NPRT(res->res_cat.db_address),
496 res->res_cat.db_port, res->res_cat.db_name, NPRT(res->res_cat.db_user));
500 sendit(sock, "%s: name=%s JobType=%d level=%s Priority=%d MaxJobs=%u\n",
501 type == R_JOB ? "Job" : "JobDefs",
502 res->res_job.hdr.name, res->res_job.JobType,
503 level_to_str(res->res_job.JobLevel), res->res_job.Priority,
504 res->res_job.MaxConcurrentJobs);
505 sendit(sock, " Resched=%d Times=%d Interval=%s Spool=%d\n",
506 res->res_job.RescheduleOnError, res->res_job.RescheduleTimes,
507 edit_uint64_with_commas(res->res_job.RescheduleInterval, ed1),
508 res->res_job.spool_data);
509 if (res->res_job.client) {
510 sendit(sock, " --> ");
511 dump_resource(-R_CLIENT, (RES *)res->res_job.client, sendit, sock);
513 if (res->res_job.fileset) {
514 sendit(sock, " --> ");
515 dump_resource(-R_FILESET, (RES *)res->res_job.fileset, sendit, sock);
517 if (res->res_job.schedule) {
518 sendit(sock, " --> ");
519 dump_resource(-R_SCHEDULE, (RES *)res->res_job.schedule, sendit, sock);
521 if (res->res_job.RestoreWhere) {
522 sendit(sock, " --> Where=%s\n", NPRT(res->res_job.RestoreWhere));
524 if (res->res_job.RestoreBootstrap) {
525 sendit(sock, " --> Bootstrap=%s\n", NPRT(res->res_job.RestoreBootstrap));
527 if (res->res_job.RunBeforeJob) {
528 sendit(sock, " --> RunBefore=%s\n", NPRT(res->res_job.RunBeforeJob));
530 if (res->res_job.RunAfterJob) {
531 sendit(sock, " --> RunAfter=%s\n", NPRT(res->res_job.RunAfterJob));
533 if (res->res_job.RunAfterFailedJob) {
534 sendit(sock, " --> RunAfterFailed=%s\n", NPRT(res->res_job.RunAfterFailedJob));
536 if (res->res_job.WriteBootstrap) {
537 sendit(sock, " --> WriteBootstrap=%s\n", NPRT(res->res_job.WriteBootstrap));
539 if (res->res_job.storage[0]) {
540 sendit(sock, " --> ");
542 // dump_resource(-R_STORAGE, (RES *)res->res_job.storage, sendit, sock);
544 if (res->res_job.pool) {
545 sendit(sock, " --> ");
546 dump_resource(-R_POOL, (RES *)res->res_job.pool, sendit, sock);
548 if (res->res_job.full_pool) {
549 sendit(sock, " --> ");
550 dump_resource(-R_POOL, (RES *)res->res_job.full_pool, sendit, sock);
552 if (res->res_job.inc_pool) {
553 sendit(sock, " --> ");
554 dump_resource(-R_POOL, (RES *)res->res_job.inc_pool, sendit, sock);
556 if (res->res_job.dif_pool) {
557 sendit(sock, " --> ");
558 dump_resource(-R_POOL, (RES *)res->res_job.dif_pool, sendit, sock);
560 if (res->res_job.verify_job) {
561 sendit(sock, " --> ");
562 dump_resource(-type, (RES *)res->res_job.verify_job, sendit, sock);
565 if (res->res_job.messages) {
566 sendit(sock, " --> ");
567 dump_resource(-R_MSGS, (RES *)res->res_job.messages, sendit, sock);
573 sendit(sock, "FileSet: name=%s\n", res->res_fs.hdr.name);
574 for (i=0; i<res->res_fs.num_includes; i++) {
575 INCEXE *incexe = res->res_fs.include_items[i];
576 for (j=0; j<incexe->num_opts; j++) {
577 FOPTS *fo = incexe->opts_list[j];
578 sendit(sock, " O %s\n", fo->opts);
579 for (k=0; k<fo->regex.size(); k++) {
580 sendit(sock, " R %s\n", fo->regex.get(k));
582 for (k=0; k<fo->wild.size(); k++) {
583 sendit(sock, " W %s\n", fo->wild.get(k));
585 for (k=0; k<fo->base.size(); k++) {
586 sendit(sock, " B %s\n", fo->base.get(k));
589 sendit(sock, " D %s\n", fo->reader);
592 sendit(sock, " T %s\n", fo->writer);
594 sendit(sock, " N\n");
596 for (j=0; j<incexe->name_list.size(); j++) {
597 sendit(sock, " I %s\n", incexe->name_list.get(j));
599 if (incexe->name_list.size()) {
600 sendit(sock, " N\n");
604 for (i=0; i<res->res_fs.num_excludes; i++) {
605 INCEXE *incexe = res->res_fs.exclude_items[i];
606 for (j=0; j<incexe->name_list.size(); j++) {
607 sendit(sock, " E %s\n", incexe->name_list.get(j));
609 if (incexe->name_list.size()) {
610 sendit(sock, " N\n");
616 if (res->res_sch.run) {
618 RUN *run = res->res_sch.run;
619 char buf[1000], num[30];
620 sendit(sock, "Schedule: name=%s\n", res->res_sch.hdr.name);
625 sendit(sock, " --> Run Level=%s\n", level_to_str(run->level));
626 bstrncpy(buf, " hour=", sizeof(buf));
627 for (i=0; i<24; i++) {
628 if (bit_is_set(i, run->hour)) {
629 bsnprintf(num, sizeof(num), "%d ", i);
630 bstrncat(buf, num, sizeof(buf));
633 bstrncat(buf, "\n", sizeof(buf));
635 bstrncpy(buf, " mday=", sizeof(buf));
636 for (i=0; i<31; i++) {
637 if (bit_is_set(i, run->mday)) {
638 bsnprintf(num, sizeof(num), "%d ", i);
639 bstrncat(buf, num, sizeof(buf));
642 bstrncat(buf, "\n", sizeof(buf));
644 bstrncpy(buf, " month=", sizeof(buf));
645 for (i=0; i<12; i++) {
646 if (bit_is_set(i, run->month)) {
647 bsnprintf(num, sizeof(num), "%d ", i);
648 bstrncat(buf, num, sizeof(buf));
651 bstrncat(buf, "\n", sizeof(buf));
653 bstrncpy(buf, " wday=", sizeof(buf));
654 for (i=0; i<7; i++) {
655 if (bit_is_set(i, run->wday)) {
656 bsnprintf(num, sizeof(num), "%d ", i);
657 bstrncat(buf, num, sizeof(buf));
660 bstrncat(buf, "\n", sizeof(buf));
662 bstrncpy(buf, " wom=", sizeof(buf));
663 for (i=0; i<5; i++) {
664 if (bit_is_set(i, run->wom)) {
665 bsnprintf(num, sizeof(num), "%d ", i);
666 bstrncat(buf, num, sizeof(buf));
669 bstrncat(buf, "\n", sizeof(buf));
671 bstrncpy(buf, " woy=", sizeof(buf));
672 for (i=0; i<54; i++) {
673 if (bit_is_set(i, run->woy)) {
674 bsnprintf(num, sizeof(num), "%d ", i);
675 bstrncat(buf, num, sizeof(buf));
678 bstrncat(buf, "\n", sizeof(buf));
680 sendit(sock, " mins=%d\n", run->minute);
682 sendit(sock, " --> ");
683 dump_resource(-R_POOL, (RES *)run->pool, sendit, sock);
686 sendit(sock, " --> ");
687 dump_resource(-R_STORAGE, (RES *)run->storage, sendit, sock);
690 sendit(sock, " --> ");
691 dump_resource(-R_MSGS, (RES *)run->msgs, sendit, sock);
693 /* If another Run record is chained in, go print it */
699 sendit(sock, "Schedule: name=%s\n", res->res_sch.hdr.name);
703 sendit(sock, "Pool: name=%s PoolType=%s\n", res->res_pool.hdr.name,
704 res->res_pool.pool_type);
705 sendit(sock, " use_cat=%d use_once=%d acpt_any=%d cat_files=%d\n",
706 res->res_pool.use_catalog, res->res_pool.use_volume_once,
707 res->res_pool.accept_any_volume, res->res_pool.catalog_files);
708 sendit(sock, " max_vols=%d auto_prune=%d VolRetention=%s\n",
709 res->res_pool.max_volumes, res->res_pool.AutoPrune,
710 edit_utime(res->res_pool.VolRetention, ed1, sizeof(ed1)));
711 sendit(sock, " VolUse=%s recycle=%d LabelFormat=%s\n",
712 edit_utime(res->res_pool.VolUseDuration, ed1, sizeof(ed1)),
713 res->res_pool.Recycle,
714 NPRT(res->res_pool.label_format));
715 sendit(sock, " CleaningPrefix=%s\n",
716 NPRT(res->res_pool.cleaning_prefix));
717 sendit(sock, " recyleOldest=%d MaxVolJobs=%d MaxVolFiles=%d\n",
718 res->res_pool.purge_oldest_volume,
719 res->res_pool.MaxVolJobs, res->res_pool.MaxVolFiles);
722 sendit(sock, "Messages: name=%s\n", res->res_msgs.hdr.name);
723 if (res->res_msgs.mail_cmd)
724 sendit(sock, " mailcmd=%s\n", res->res_msgs.mail_cmd);
725 if (res->res_msgs.operator_cmd)
726 sendit(sock, " opcmd=%s\n", res->res_msgs.operator_cmd);
729 sendit(sock, "Unknown resource type %d in dump_resource.\n", type);
732 if (recurse && res->res_dir.hdr.next) {
733 dump_resource(type, res->res_dir.hdr.next, sendit, sock);
738 * Free all the members of an INCEXE structure
740 static void free_incexe(INCEXE *incexe)
742 incexe->name_list.destroy();
743 for (int i=0; i<incexe->num_opts; i++) {
744 FOPTS *fopt = incexe->opts_list[i];
745 fopt->regex.destroy();
746 fopt->wild.destroy();
747 fopt->base.destroy();
756 if (incexe->opts_list) {
757 free(incexe->opts_list);
763 * Free memory of resource -- called when daemon terminates.
764 * NB, we don't need to worry about freeing any references
765 * to other resources as they will be freed when that
766 * resource chain is traversed. Mainly we worry about freeing
767 * allocated strings (names).
769 void free_resource(RES *sres, int type)
772 RES *nres; /* next resource if linked */
773 URES *res = (URES *)sres;
778 /* common stuff -- free the resource name and description */
779 nres = (RES *)res->res_dir.hdr.next;
780 if (res->res_dir.hdr.name) {
781 free(res->res_dir.hdr.name);
783 if (res->res_dir.hdr.desc) {
784 free(res->res_dir.hdr.desc);
789 if (res->res_dir.working_directory) {
790 free(res->res_dir.working_directory);
792 if (res->res_dir.pid_directory) {
793 free(res->res_dir.pid_directory);
795 if (res->res_dir.subsys_directory) {
796 free(res->res_dir.subsys_directory);
798 if (res->res_dir.password) {
799 free(res->res_dir.password);
801 if (res->res_dir.query_file) {
802 free(res->res_dir.query_file);
804 if (res->res_dir.DIRaddrs) {
805 free_addresses(res->res_dir.DIRaddrs);
811 if (res->res_con.password) {
812 free(res->res_con.password);
814 for (int i=0; i<Num_ACL; i++) {
815 if (res->res_con.ACL_lists[i]) {
816 delete res->res_con.ACL_lists[i];
817 res->res_con.ACL_lists[i] = NULL;
822 if (res->res_client.address) {
823 free(res->res_client.address);
825 if (res->res_client.password) {
826 free(res->res_client.password);
830 if (res->res_store.address) {
831 free(res->res_store.address);
833 if (res->res_store.password) {
834 free(res->res_store.password);
836 if (res->res_store.media_type) {
837 free(res->res_store.media_type);
839 if (res->res_store.dev_name) {
840 free(res->res_store.dev_name);
844 if (res->res_cat.db_address) {
845 free(res->res_cat.db_address);
847 if (res->res_cat.db_socket) {
848 free(res->res_cat.db_socket);
850 if (res->res_cat.db_user) {
851 free(res->res_cat.db_user);
853 if (res->res_cat.db_name) {
854 free(res->res_cat.db_name);
856 if (res->res_cat.db_password) {
857 free(res->res_cat.db_password);
861 if ((num=res->res_fs.num_includes)) {
863 free_incexe(res->res_fs.include_items[num]);
865 free(res->res_fs.include_items);
867 res->res_fs.num_includes = 0;
868 if ((num=res->res_fs.num_excludes)) {
870 free_incexe(res->res_fs.exclude_items[num]);
872 free(res->res_fs.exclude_items);
874 res->res_fs.num_excludes = 0;
877 if (res->res_pool.pool_type) {
878 free(res->res_pool.pool_type);
880 if (res->res_pool.label_format) {
881 free(res->res_pool.label_format);
883 if (res->res_pool.cleaning_prefix) {
884 free(res->res_pool.cleaning_prefix);
888 if (res->res_sch.run) {
890 nrun = res->res_sch.run;
900 if (res->res_job.RestoreWhere) {
901 free(res->res_job.RestoreWhere);
903 if (res->res_job.RestoreBootstrap) {
904 free(res->res_job.RestoreBootstrap);
906 if (res->res_job.WriteBootstrap) {
907 free(res->res_job.WriteBootstrap);
909 if (res->res_job.RunBeforeJob) {
910 free(res->res_job.RunBeforeJob);
912 if (res->res_job.RunAfterJob) {
913 free(res->res_job.RunAfterJob);
915 if (res->res_job.RunAfterFailedJob) {
916 free(res->res_job.RunAfterFailedJob);
918 if (res->res_job.ClientRunBeforeJob) {
919 free(res->res_job.ClientRunBeforeJob);
921 if (res->res_job.ClientRunAfterJob) {
922 free(res->res_job.ClientRunAfterJob);
924 for (int i=0; i < MAX_STORE; i++) {
925 if (res->res_job.storage[i]) {
926 delete (alist *)res->res_job.storage[i];
931 if (res->res_msgs.mail_cmd) {
932 free(res->res_msgs.mail_cmd);
934 if (res->res_msgs.operator_cmd) {
935 free(res->res_msgs.operator_cmd);
937 free_msgs_res((MSGS *)res); /* free message resource */
941 printf("Unknown resource type %d in free_resource.\n", type);
943 /* Common stuff again -- free the resource, recurse to next one */
948 free_resource(nres, type);
953 * Save the new resource by chaining it into the head list for
954 * the resource. If this is pass 2, we update any resource
955 * pointers because they may not have been defined until
958 void save_resource(int type, RES_ITEM *items, int pass)
961 int rindex = type - r_first;
965 /* Check Job requirements after applying JobDefs */
966 if (type != R_JOB && type != R_JOBDEFS) {
968 * Ensure that all required items are present
970 for (i=0; items[i].name; i++) {
971 if (items[i].flags & ITEM_REQUIRED) {
972 if (!bit_is_set(i, res_all.res_dir.hdr.item_present)) {
973 Emsg2(M_ERROR_TERM, 0, "%s item is required in %s resource, but not found.\n",
974 items[i].name, resources[rindex]);
977 /* If this triggers, take a look at lib/parse_conf.h */
978 if (i >= MAX_RES_ITEMS) {
979 Emsg1(M_ERROR_TERM, 0, "Too many items in %s resource\n", resources[rindex]);
985 * During pass 2 in each "store" routine, we looked up pointers
986 * to all the resources referrenced in the current resource, now we
987 * must copy their addresses from the static record to the allocated
992 /* Resources not containing a resource */
1001 /* Resources containing another resource */
1003 if ((res = (URES *)GetResWithName(R_DIRECTOR, res_all.res_dir.hdr.name)) == NULL) {
1004 Emsg1(M_ERROR_TERM, 0, "Cannot find Director resource %s\n", res_all.res_dir.hdr.name);
1006 res->res_dir.messages = res_all.res_dir.messages;
1010 if ((res = (URES *)GetResWithName(type, res_all.res_dir.hdr.name)) == NULL) {
1011 Emsg1(M_ERROR_TERM, 0, "Cannot find Job resource %s\n",
1012 res_all.res_dir.hdr.name);
1014 res->res_job.messages = res_all.res_job.messages;
1015 res->res_job.schedule = res_all.res_job.schedule;
1016 res->res_job.client = res_all.res_job.client;
1017 res->res_job.fileset = res_all.res_job.fileset;
1018 for (int i=0; i < MAX_STORE; i++) {
1019 res->res_job.storage[i] = res_all.res_job.storage[i];
1021 res->res_job.pool = res_all.res_job.pool;
1022 res->res_job.full_pool = res_all.res_job.full_pool;
1023 res->res_job.inc_pool = res_all.res_job.inc_pool;
1024 res->res_job.dif_pool = res_all.res_job.dif_pool;
1025 res->res_job.verify_job = res_all.res_job.verify_job;
1026 res->res_job.jobdefs = res_all.res_job.jobdefs;
1029 if ((res = (URES *)GetResWithName(R_COUNTER, res_all.res_counter.hdr.name)) == NULL) {
1030 Emsg1(M_ERROR_TERM, 0, "Cannot find Counter resource %s\n", res_all.res_counter.hdr.name);
1032 res->res_counter.Catalog = res_all.res_counter.Catalog;
1033 res->res_counter.WrapCounter = res_all.res_counter.WrapCounter;
1037 if ((res = (URES *)GetResWithName(R_CLIENT, res_all.res_client.hdr.name)) == NULL) {
1038 Emsg1(M_ERROR_TERM, 0, "Cannot find Client resource %s\n", res_all.res_client.hdr.name);
1040 res->res_client.catalog = res_all.res_client.catalog;
1044 * Schedule is a bit different in that it contains a RUN record
1045 * chain which isn't a "named" resource. This chain was linked
1046 * in by run_conf.c during pass 2, so here we jam the pointer
1047 * into the Schedule resource.
1049 if ((res = (URES *)GetResWithName(R_SCHEDULE, res_all.res_client.hdr.name)) == NULL) {
1050 Emsg1(M_ERROR_TERM, 0, "Cannot find Schedule resource %s\n", res_all.res_client.hdr.name);
1052 res->res_sch.run = res_all.res_sch.run;
1055 Emsg1(M_ERROR, 0, "Unknown resource type %d in save_resource.\n", type);
1059 /* Note, the resource name was already saved during pass 1,
1060 * so here, we can just release it.
1062 if (res_all.res_dir.hdr.name) {
1063 free(res_all.res_dir.hdr.name);
1064 res_all.res_dir.hdr.name = NULL;
1066 if (res_all.res_dir.hdr.desc) {
1067 free(res_all.res_dir.hdr.desc);
1068 res_all.res_dir.hdr.desc = NULL;
1074 * The following code is only executed during pass 1
1078 size = sizeof(DIRRES);
1081 size = sizeof(CONRES);
1084 size =sizeof(CLIENT);
1087 size = sizeof(STORE);
1097 size = sizeof(FILESET);
1100 size = sizeof(SCHED);
1103 size = sizeof(POOL);
1106 size = sizeof(MSGS);
1109 size = sizeof(COUNTER);
1112 printf("Unknown resource type %d in save_resrouce.\n", type);
1119 res = (URES *)malloc(size);
1120 memcpy(res, &res_all, size);
1121 if (!res_head[rindex]) {
1122 res_head[rindex] = (RES *)res; /* store first entry */
1123 Dmsg3(900, "Inserting first %s res: %s index=%d\n", res_to_str(type),
1124 res->res_dir.hdr.name, rindex);
1127 /* Add new res to end of chain */
1128 for (next=res_head[rindex]; next->next; next=next->next) {
1129 if (strcmp(next->name, res->res_dir.hdr.name) == 0) {
1130 Emsg2(M_ERROR_TERM, 0,
1131 _("Attempt to define second %s resource named \"%s\" is not permitted.\n"),
1132 resources[rindex].name, res->res_dir.hdr.name);
1135 next->next = (RES *)res;
1136 Dmsg4(900, "Inserting %s res: %s index=%d pass=%d\n", res_to_str(type),
1137 res->res_dir.hdr.name, rindex, pass);
1143 * Store JobType (backup, verify, restore)
1146 void store_jobtype(LEX *lc, RES_ITEM *item, int index, int pass)
1150 token = lex_get_token(lc, T_NAME);
1151 /* Store the type both pass 1 and pass 2 */
1152 for (i=0; jobtypes[i].type_name; i++) {
1153 if (strcasecmp(lc->str, jobtypes[i].type_name) == 0) {
1154 *(int *)(item->value) = jobtypes[i].job_type;
1160 scan_err1(lc, "Expected a Job Type keyword, got: %s", lc->str);
1163 set_bit(index, res_all.hdr.item_present);
1167 * Store Job Level (Full, Incremental, ...)
1170 void store_level(LEX *lc, RES_ITEM *item, int index, int pass)
1174 token = lex_get_token(lc, T_NAME);
1175 /* Store the level pass 2 so that type is defined */
1176 for (i=0; joblevels[i].level_name; i++) {
1177 if (strcasecmp(lc->str, joblevels[i].level_name) == 0) {
1178 *(int *)(item->value) = joblevels[i].level;
1184 scan_err1(lc, "Expected a Job Level keyword, got: %s", lc->str);
1187 set_bit(index, res_all.hdr.item_present);
1190 void store_replace(LEX *lc, RES_ITEM *item, int index, int pass)
1193 token = lex_get_token(lc, T_NAME);
1194 /* Scan Replacement options */
1195 for (i=0; ReplaceOptions[i].name; i++) {
1196 if (strcasecmp(lc->str, ReplaceOptions[i].name) == 0) {
1197 *(int *)(item->value) = ReplaceOptions[i].token;
1203 scan_err1(lc, "Expected a Restore replacement option, got: %s", lc->str);
1206 set_bit(index, res_all.hdr.item_present);
1210 * Store ACL (access control list)
1213 void store_acl(LEX *lc, RES_ITEM *item, int index, int pass)
1218 token = lex_get_token(lc, T_NAME);
1220 if (((alist **)item->value)[item->code] == NULL) {
1221 ((alist **)item->value)[item->code] = New(alist(10, owned_by_alist));
1222 Dmsg1(900, "Defined new ACL alist at %d\n", item->code);
1224 ((alist **)item->value)[item->code]->append(bstrdup(lc->str));
1225 Dmsg2(900, "Appended to %d %s\n", item->code, lc->str);
1227 token = lex_get_token(lc, T_ALL);
1228 if (token == T_COMMA) {
1229 continue; /* get another ACL */
1233 set_bit(index, res_all.hdr.item_present);