2 * Configuration file parser for Bacula Storage daemon
4 * Kern Sibbald, March MM
10 Copyright (C) 2000-2004 Kern Sibbald and John Walker
12 This program is free software; you can redistribute it and/or
13 modify it under the terms of the GNU General Public License as
14 published by the Free Software Foundation; either version 2 of
15 the License, or (at your option) any later version.
17 This program is distributed in the hope that it will be useful,
18 but WITHOUT ANY WARRANTY; without even the implied warranty of
19 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
20 General Public License for more details.
22 You should have received a copy of the GNU General Public
23 License along with this program; if not, write to the Free
24 Software Foundation, Inc., 59 Temple Place - Suite 330, Boston,
32 extern int debug_level;
35 /* First and last resource ids */
36 int r_first = R_FIRST;
40 /* Forward referenced subroutines */
42 /* We build the current resource here statically,
43 * then move it to dynamic memory */
45 int res_all_size = sizeof(res_all);
47 /* Definition of records permitted within each
48 * resource with the routine to process the record
52 /* Globals for the Storage daemon. */
53 static RES_ITEM store_items[] = {
54 {"name", store_name, ITEM(res_store.hdr.name), 0, ITEM_REQUIRED, 0},
55 {"description", store_str, ITEM(res_dir.hdr.desc), 0, 0, 0},
56 {"address", store_str, ITEM(res_store.address), 0, 0, 0}, /* deprecated */
57 {"sdaddress", store_str, ITEM(res_store.SDaddr), 0, 0, 0},
58 {"messages", store_res, ITEM(res_store.messages), 0, R_MSGS, 0},
59 {"sdport", store_int, ITEM(res_store.SDport), 0, ITEM_DEFAULT, 9103},
60 {"sddport", store_int, ITEM(res_store.SDDport), 0, 0, 0}, /* deprecated */
61 {"workingdirectory", store_dir, ITEM(res_store.working_directory), 0, ITEM_REQUIRED, 0},
62 {"piddirectory", store_dir, ITEM(res_store.pid_directory), 0, ITEM_REQUIRED, 0},
63 {"subsysdirectory", store_dir, ITEM(res_store.subsys_directory), 0, 0, 0},
64 {"requiressl", store_yesno,ITEM(res_store.require_ssl), 1, ITEM_DEFAULT, 0},
65 {"maximumconcurrentjobs", store_pint, ITEM(res_store.max_concurrent_jobs), 0, ITEM_DEFAULT, 10},
66 {"heartbeatinterval", store_time, ITEM(res_store.heartbeat_interval), 0, ITEM_DEFAULT, 0},
67 {NULL, NULL, 0, 0, 0, 0}
71 /* Directors that can speak to the Storage daemon */
72 static RES_ITEM dir_items[] = {
73 {"name", store_name, ITEM(res_dir.hdr.name), 0, ITEM_REQUIRED, 0},
74 {"description", store_str, ITEM(res_dir.hdr.desc), 0, 0, 0},
75 {"password", store_password, ITEM(res_dir.password), 0, ITEM_REQUIRED, 0},
76 {"address", store_str, ITEM(res_dir.address), 0, 0, 0},
77 {"enablessl", store_yesno, ITEM(res_dir.enable_ssl), 1, ITEM_DEFAULT, 0},
78 {NULL, NULL, 0, 0, 0, 0}
81 /* Device definition */
82 static RES_ITEM dev_items[] = {
83 {"name", store_name, ITEM(res_dev.hdr.name), 0, ITEM_REQUIRED, 0},
84 {"description", store_str, ITEM(res_dir.hdr.desc), 0, 0, 0},
85 {"mediatype", store_strname,ITEM(res_dev.media_type), 0, ITEM_REQUIRED, 0},
86 {"archivedevice", store_strname,ITEM(res_dev.device_name), 0, ITEM_REQUIRED, 0},
87 {"hardwareendoffile", store_yesno, ITEM(res_dev.cap_bits), CAP_EOF, ITEM_DEFAULT, 1},
88 {"hardwareendofmedium", store_yesno, ITEM(res_dev.cap_bits), CAP_EOM, ITEM_DEFAULT, 1},
89 {"backwardspacerecord", store_yesno, ITEM(res_dev.cap_bits), CAP_BSR, ITEM_DEFAULT, 1},
90 {"backwardspacefile", store_yesno, ITEM(res_dev.cap_bits), CAP_BSF, ITEM_DEFAULT, 1},
91 {"bsfateom", store_yesno, ITEM(res_dev.cap_bits), CAP_BSFATEOM, ITEM_DEFAULT, 0},
92 {"twoeof", store_yesno, ITEM(res_dev.cap_bits), CAP_TWOEOF, ITEM_DEFAULT, 0},
93 {"forwardspacerecord", store_yesno, ITEM(res_dev.cap_bits), CAP_FSR, ITEM_DEFAULT, 1},
94 {"forwardspacefile", store_yesno, ITEM(res_dev.cap_bits), CAP_FSF, ITEM_DEFAULT, 1},
95 {"fastforwardspacefile", store_yesno, ITEM(res_dev.cap_bits), CAP_FASTFSF, ITEM_DEFAULT, 1},
96 {"removablemedia", store_yesno, ITEM(res_dev.cap_bits), CAP_REM, ITEM_DEFAULT, 1},
97 {"randomaccess", store_yesno, ITEM(res_dev.cap_bits), CAP_RACCESS, 0, 0},
98 {"automaticmount", store_yesno, ITEM(res_dev.cap_bits), CAP_AUTOMOUNT, ITEM_DEFAULT, 0},
99 {"labelmedia", store_yesno, ITEM(res_dev.cap_bits), CAP_LABEL, ITEM_DEFAULT, 0},
100 {"alwaysopen", store_yesno, ITEM(res_dev.cap_bits), CAP_ALWAYSOPEN, ITEM_DEFAULT, 1},
101 {"autochanger", store_yesno, ITEM(res_dev.cap_bits), CAP_AUTOCHANGER, ITEM_DEFAULT, 0},
102 {"closeonpoll", store_yesno, ITEM(res_dev.cap_bits), CAP_CLOSEONPOLL, ITEM_DEFAULT, 0},
103 {"changerdevice", store_strname,ITEM(res_dev.changer_name), 0, 0, 0},
104 {"changercommand", store_strname,ITEM(res_dev.changer_command), 0, 0, 0},
105 {"maximumchangerwait", store_pint, ITEM(res_dev.max_changer_wait), 0, ITEM_DEFAULT, 5 * 60},
106 {"maximumopenwait", store_pint, ITEM(res_dev.max_open_wait), 0, ITEM_DEFAULT, 5 * 60},
107 {"maximumopenvolumes", store_pint, ITEM(res_dev.max_open_vols), 0, ITEM_DEFAULT, 1},
108 {"maximumnetworkbuffersize", store_pint, ITEM(res_dev.max_network_buffer_size), 0, 0, 0},
109 {"volumepollinterval", store_time, ITEM(res_dev.vol_poll_interval), 0, 0, 0},
110 {"offlineonunmount", store_yesno, ITEM(res_dev.cap_bits), CAP_OFFLINEUNMOUNT, ITEM_DEFAULT, 0},
111 {"maximumrewindwait", store_pint, ITEM(res_dev.max_rewind_wait), 0, ITEM_DEFAULT, 5 * 60},
112 {"minimumblocksize", store_pint, ITEM(res_dev.min_block_size), 0, 0, 0},
113 {"maximumblocksize", store_pint, ITEM(res_dev.max_block_size), 0, 0, 0},
114 {"maximumvolumesize", store_size, ITEM(res_dev.max_volume_size), 0, 0, 0},
115 {"maximumfilesize", store_size, ITEM(res_dev.max_file_size), 0, ITEM_DEFAULT, 1000000000},
116 {"volumecapacity", store_size, ITEM(res_dev.volume_capacity), 0, 0, 0},
117 {"spooldirectory", store_dir, ITEM(res_dev.spool_directory), 0, 0, 0},
118 {"maximumspoolsize", store_size, ITEM(res_dev.max_spool_size), 0, 0, 0},
119 {"maximumjobspoolsize", store_size, ITEM(res_dev.max_job_spool_size), 0, 0, 0},
120 {NULL, NULL, 0, 0, 0, 0}
123 // {"mountanonymousvolumes", store_yesno, ITEM(res_dev.cap_bits), CAP_ANONVOLS, ITEM_DEFAULT, 0},
126 /* Message resource */
127 extern RES_ITEM msgs_items[];
130 /* This is the master resource definition */
131 RES_TABLE resources[] = {
132 {"director", dir_items, R_DIRECTOR, NULL},
133 {"storage", store_items, R_STORAGE, NULL},
134 {"device", dev_items, R_DEVICE, NULL},
135 {"messages", msgs_items, R_MSGS, NULL},
136 {NULL, NULL, 0, NULL}
141 /* Dump contents of resource */
142 void dump_resource(int type, RES *reshdr, void sendit(void *sock, char *fmt, ...), void *sock)
144 URES *res = (URES *)reshdr;
148 sendit(sock, _("Warning: no %s resource (%d) defined.\n"), res_to_str(type), type);
151 sendit(sock, "dump_resource type=%d\n", type);
152 if (type < 0) { /* no recursion */
158 sendit(sock, "Director: name=%s\n", res->res_dir.hdr.name);
161 sendit(sock, "Storage: name=%s SDaddr=%s SDport=%d SDDport=%d HB=%s\n",
162 res->res_store.hdr.name, NPRT(res->res_store.SDaddr),
163 res->res_store.SDport, res->res_store.SDDport,
164 edit_utime(res->res_store.heartbeat_interval, buf));
167 sendit(sock, "Device: name=%s MediaType=%s Device=%s\n",
168 res->res_dev.hdr.name,
169 res->res_dev.media_type, res->res_dev.device_name);
170 sendit(sock, " rew_wait=%d min_bs=%d max_bs=%d\n",
171 res->res_dev.max_rewind_wait, res->res_dev.min_block_size,
172 res->res_dev.max_block_size);
173 sendit(sock, " max_jobs=%d max_files=%" lld " max_size=%" lld "\n",
174 res->res_dev.max_volume_jobs, res->res_dev.max_volume_files,
175 res->res_dev.max_volume_size);
176 sendit(sock, " max_file_size=%" lld " capacity=%" lld "\n",
177 res->res_dev.max_file_size, res->res_dev.volume_capacity);
178 sendit(sock, " spool_directory=%s\n", res->res_dev.spool_directory);
179 sendit(sock, " max_spool_size=%" lld " max_job_spool_size=%" lld "\n",
180 res->res_dev.max_spool_size, res->res_dev.max_job_spool_size);
182 if (res->res_dev.cap_bits & CAP_EOF) {
183 bstrncat(buf, "CAP_EOF ", sizeof(buf));
185 if (res->res_dev.cap_bits & CAP_BSR) {
186 bstrncat(buf, "CAP_BSR ", sizeof(buf));
188 if (res->res_dev.cap_bits & CAP_BSF) {
189 bstrncat(buf, "CAP_BSF ", sizeof(buf));
191 if (res->res_dev.cap_bits & CAP_FSR) {
192 bstrncat(buf, "CAP_FSR ", sizeof(buf));
194 if (res->res_dev.cap_bits & CAP_FSF) {
195 bstrncat(buf, "CAP_FSF ", sizeof(buf));
197 if (res->res_dev.cap_bits & CAP_EOM) {
198 bstrncat(buf, "CAP_EOM ", sizeof(buf));
200 if (res->res_dev.cap_bits & CAP_REM) {
201 bstrncat(buf, "CAP_REM ", sizeof(buf));
203 if (res->res_dev.cap_bits & CAP_RACCESS) {
204 bstrncat(buf, "CAP_RACCESS ", sizeof(buf));
206 if (res->res_dev.cap_bits & CAP_AUTOMOUNT) {
207 bstrncat(buf, "CAP_AUTOMOUNT ", sizeof(buf));
209 if (res->res_dev.cap_bits & CAP_LABEL) {
210 bstrncat(buf, "CAP_LABEL ", sizeof(buf));
212 if (res->res_dev.cap_bits & CAP_ANONVOLS) {
213 bstrncat(buf, "CAP_ANONVOLS ", sizeof(buf));
215 if (res->res_dev.cap_bits & CAP_ALWAYSOPEN) {
216 bstrncat(buf, "CAP_ALWAYSOPEN ", sizeof(buf));
218 bstrncat(buf, "\n", sizeof(buf));
222 sendit(sock, "Messages: name=%s\n", res->res_msgs.hdr.name);
223 if (res->res_msgs.mail_cmd)
224 sendit(sock, " mailcmd=%s\n", res->res_msgs.mail_cmd);
225 if (res->res_msgs.operator_cmd)
226 sendit(sock, " opcmd=%s\n", res->res_msgs.operator_cmd);
229 sendit(sock, _("Warning: unknown resource type %d\n"), type);
232 if (recurse && res->res_dir.hdr.next)
233 dump_resource(type, (RES *)res->res_dir.hdr.next, sendit, sock);
237 * Free memory of resource.
238 * NB, we don't need to worry about freeing any references
239 * to other resources as they will be freed when that
240 * resource chain is traversed. Mainly we worry about freeing
241 * allocated strings (names).
243 void free_resource(RES *sres, int type)
246 URES *res = (URES *)sres;
251 /* common stuff -- free the resource name */
252 nres = (RES *)res->res_dir.hdr.next;
253 if (res->res_dir.hdr.name) {
254 free(res->res_dir.hdr.name);
256 if (res->res_dir.hdr.desc) {
257 free(res->res_dir.hdr.desc);
263 if (res->res_dir.password) {
264 free(res->res_dir.password);
266 if (res->res_dir.address) {
267 free(res->res_dir.address);
271 if (res->res_store.address) { /* ***FIXME*** deprecated */
272 free(res->res_store.address);
274 if (res->res_store.SDaddr) {
275 free(res->res_store.SDaddr);
277 if (res->res_store.working_directory) {
278 free(res->res_store.working_directory);
280 if (res->res_store.pid_directory) {
281 free(res->res_store.pid_directory);
283 if (res->res_store.subsys_directory) {
284 free(res->res_store.subsys_directory);
288 if (res->res_dev.media_type) {
289 free(res->res_dev.media_type);
291 if (res->res_dev.device_name) {
292 free(res->res_dev.device_name);
294 if (res->res_dev.changer_name) {
295 free(res->res_dev.changer_name);
297 if (res->res_dev.changer_command) {
298 free(res->res_dev.changer_command);
300 if (res->res_dev.spool_directory) {
301 free(res->res_dev.spool_directory);
305 if (res->res_msgs.mail_cmd) {
306 free(res->res_msgs.mail_cmd);
308 if (res->res_msgs.operator_cmd) {
309 free(res->res_msgs.operator_cmd);
311 free_msgs_res((MSGS *)res); /* free message resource */
315 Dmsg1(0, "Unknown resource type %d\n", type);
318 /* Common stuff again -- free the resource, recurse to next one */
323 free_resource(nres, type);
327 /* Save the new resource by chaining it into the head list for
328 * the resource. If this is pass 2, we update any resource
329 * pointers (currently only in the Job resource).
331 void save_resource(int type, RES_ITEM *items, int pass)
334 int rindex = type - r_first;
339 * Ensure that all required items are present
341 for (i=0; items[i].name; i++) {
342 if (items[i].flags & ITEM_REQUIRED) {
343 if (!bit_is_set(i, res_all.res_dir.hdr.item_present)) {
344 Emsg2(M_ABORT, 0, _("%s item is required in %s resource, but not found.\n"),
345 items[i].name, resources[rindex]);
348 /* If this triggers, take a look at lib/parse_conf.h */
349 if (i >= MAX_RES_ITEMS) {
350 Emsg1(M_ABORT, 0, _("Too many items in %s resource\n"), resources[rindex]);
354 /* During pass 2, we looked up pointers to all the resources
355 * referrenced in the current resource, , now we
356 * must copy their address from the static record to the allocated
361 /* Resources not containing a resource */
367 /* Resources containing a resource */
369 if ((res = (URES *)GetResWithName(R_STORAGE, res_all.res_dir.hdr.name)) == NULL) {
370 Emsg1(M_ABORT, 0, "Cannot find Storage resource %s\n", res_all.res_dir.hdr.name);
372 res->res_store.messages = res_all.res_store.messages;
375 printf("Unknown resource type %d\n", type);
381 if (res_all.res_dir.hdr.name) {
382 free(res_all.res_dir.hdr.name);
383 res_all.res_dir.hdr.name = NULL;
385 if (res_all.res_dir.hdr.desc) {
386 free(res_all.res_dir.hdr.desc);
387 res_all.res_dir.hdr.desc = NULL;
392 /* The following code is only executed on pass 1 */
395 size = sizeof(DIRRES);
398 size = sizeof(STORES);
401 size = sizeof(DEVRES);
407 printf("Unknown resource type %d\n", type);
414 res = (URES *)malloc(size);
415 memcpy(res, &res_all, size);
416 if (!resources[rindex].res_head) {
417 resources[rindex].res_head = (RES *)res; /* store first entry */
420 /* Add new res to end of chain */
421 for (next=resources[rindex].res_head; next->next; next=next->next) {
422 if (strcmp(next->name, res->res_dir.hdr.name) == 0) {
423 Emsg2(M_ERROR_TERM, 0,
424 _("Attempt to define second %s resource named \"%s\" is not permitted.\n"),
425 resources[rindex].name, res->res_dir.hdr.name);
428 next->next = (RES *)res;
429 Dmsg2(90, "Inserting %s res: %s\n", res_to_str(type),
430 res->res_dir.hdr.name);