2 * Configuration file parser for Bacula Storage daemon
4 * Kern Sibbald, March MM
10 Copyright (C) 2000-2005 Kern Sibbald
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;
38 static RES *sres_head[R_LAST - R_FIRST + 1];
39 RES **res_head = sres_head;
42 /* Forward referenced subroutines */
44 /* We build the current resource here statically,
45 * then move it to dynamic memory */
47 int res_all_size = sizeof(res_all);
49 /* Definition of records permitted within each
50 * resource with the routine to process the record
54 /* Globals for the Storage daemon. */
55 static RES_ITEM store_items[] = {
56 {"name", store_name, ITEM(res_store.hdr.name), 0, ITEM_REQUIRED, 0},
57 {"description", store_str, ITEM(res_dir.hdr.desc), 0, 0, 0},
58 {"sdaddress", store_addresses_address, ITEM(res_store.sdaddrs), 0, ITEM_DEFAULT, 9103},
59 {"sdaddresses", store_addresses, ITEM(res_store.sdaddrs), 0, ITEM_DEFAULT, 9103},
60 {"messages", store_res, ITEM(res_store.messages), 0, R_MSGS, 0},
61 {"sdport", store_addresses_port, ITEM(res_store.sdaddrs), 0, ITEM_DEFAULT, 9103},
62 {"workingdirectory", store_dir, ITEM(res_store.working_directory), 0, ITEM_REQUIRED, 0},
63 {"piddirectory", store_dir, ITEM(res_store.pid_directory), 0, ITEM_REQUIRED, 0},
64 {"subsysdirectory", store_dir, ITEM(res_store.subsys_directory), 0, 0, 0},
65 {"scriptsdirectory", store_dir, ITEM(res_store.scripts_directory), 0, 0, 0},
66 {"requiressl", store_yesno,ITEM(res_store.require_ssl), 1, ITEM_DEFAULT, 0},
67 {"maximumconcurrentjobs", store_pint, ITEM(res_store.max_concurrent_jobs), 0, ITEM_DEFAULT, 10},
68 {"heartbeatinterval", store_time, ITEM(res_store.heartbeat_interval), 0, ITEM_DEFAULT, 0},
69 {NULL, NULL, 0, 0, 0, 0}
73 /* Directors that can speak to the Storage daemon */
74 static RES_ITEM dir_items[] = {
75 {"name", store_name, ITEM(res_dir.hdr.name), 0, ITEM_REQUIRED, 0},
76 {"description", store_str, ITEM(res_dir.hdr.desc), 0, 0, 0},
77 {"password", store_password, ITEM(res_dir.password), 0, ITEM_REQUIRED, 0},
78 {"enablessl", store_yesno, ITEM(res_dir.enable_ssl), 1, ITEM_DEFAULT, 0},
79 {"monitor", store_yesno, ITEM(res_dir.monitor), 1, ITEM_DEFAULT, 0},
80 {NULL, NULL, 0, 0, 0, 0}
83 /* Device definition */
84 static RES_ITEM dev_items[] = {
85 {"name", store_name, ITEM(res_dev.hdr.name), 0, ITEM_REQUIRED, 0},
86 {"description", store_str, ITEM(res_dir.hdr.desc), 0, 0, 0},
87 {"mediatype", store_strname,ITEM(res_dev.media_type), 0, ITEM_REQUIRED, 0},
88 {"archivedevice", store_strname,ITEM(res_dev.device_name), 0, ITEM_REQUIRED, 0},
89 {"hardwareendoffile", store_yesno, ITEM(res_dev.cap_bits), CAP_EOF, ITEM_DEFAULT, 1},
90 {"hardwareendofmedium", store_yesno, ITEM(res_dev.cap_bits), CAP_EOM, ITEM_DEFAULT, 1},
91 {"backwardspacerecord", store_yesno, ITEM(res_dev.cap_bits), CAP_BSR, ITEM_DEFAULT, 1},
92 {"backwardspacefile", store_yesno, ITEM(res_dev.cap_bits), CAP_BSF, ITEM_DEFAULT, 1},
93 {"bsfateom", store_yesno, ITEM(res_dev.cap_bits), CAP_BSFATEOM, ITEM_DEFAULT, 0},
94 {"twoeof", store_yesno, ITEM(res_dev.cap_bits), CAP_TWOEOF, ITEM_DEFAULT, 0},
95 {"forwardspacerecord", store_yesno, ITEM(res_dev.cap_bits), CAP_FSR, ITEM_DEFAULT, 1},
96 {"forwardspacefile", store_yesno, ITEM(res_dev.cap_bits), CAP_FSF, ITEM_DEFAULT, 1},
97 {"fastforwardspacefile", store_yesno, ITEM(res_dev.cap_bits), CAP_FASTFSF, ITEM_DEFAULT, 1},
98 {"removablemedia", store_yesno, ITEM(res_dev.cap_bits), CAP_REM, ITEM_DEFAULT, 1},
99 {"randomaccess", store_yesno, ITEM(res_dev.cap_bits), CAP_RACCESS, 0, 0},
100 {"automaticmount", store_yesno, ITEM(res_dev.cap_bits), CAP_AUTOMOUNT, ITEM_DEFAULT, 0},
101 {"labelmedia", store_yesno, ITEM(res_dev.cap_bits), CAP_LABEL, ITEM_DEFAULT, 0},
102 {"alwaysopen", store_yesno, ITEM(res_dev.cap_bits), CAP_ALWAYSOPEN, ITEM_DEFAULT, 1},
103 {"autochanger", store_yesno, ITEM(res_dev.cap_bits), CAP_AUTOCHANGER, ITEM_DEFAULT, 0},
104 {"closeonpoll", store_yesno, ITEM(res_dev.cap_bits), CAP_CLOSEONPOLL, ITEM_DEFAULT, 0},
105 {"blockpositioning", store_yesno, ITEM(res_dev.cap_bits), CAP_POSITIONBLOCKS, ITEM_DEFAULT, 1},
106 {"usemtiocget", store_yesno, ITEM(res_dev.cap_bits), CAP_MTIOCGET, ITEM_DEFAULT, 1},
107 {"checklabels", store_yesno, ITEM(res_dev.cap_bits), CAP_CHECKLABELS, ITEM_DEFAULT, 0},
108 {"autoselect", store_yesno, ITEM(res_dev.autoselect), 1, ITEM_DEFAULT, 1},
109 {"changerdevice", store_strname,ITEM(res_dev.changer_name), 0, 0, 0},
110 {"changercommand", store_strname,ITEM(res_dev.changer_command), 0, 0, 0},
111 {"alertcommand", store_strname,ITEM(res_dev.alert_command), 0, 0, 0},
112 {"maximumchangerwait", store_pint, ITEM(res_dev.max_changer_wait), 0, ITEM_DEFAULT, 5 * 60},
113 {"maximumopenwait", store_pint, ITEM(res_dev.max_open_wait), 0, ITEM_DEFAULT, 5 * 60},
114 {"maximumopenvolumes", store_pint, ITEM(res_dev.max_open_vols), 0, ITEM_DEFAULT, 1},
115 {"maximumnetworkbuffersize", store_pint, ITEM(res_dev.max_network_buffer_size), 0, 0, 0},
116 {"volumepollinterval", store_time, ITEM(res_dev.vol_poll_interval), 0, 0, 0},
117 {"offlineonunmount", store_yesno, ITEM(res_dev.cap_bits), CAP_OFFLINEUNMOUNT, ITEM_DEFAULT, 0},
118 {"maximumrewindwait", store_pint, ITEM(res_dev.max_rewind_wait), 0, ITEM_DEFAULT, 5 * 60},
119 {"minimumblocksize", store_pint, ITEM(res_dev.min_block_size), 0, 0, 0},
120 {"maximumblocksize", store_pint, ITEM(res_dev.max_block_size), 0, 0, 0},
121 {"maximumvolumesize", store_size, ITEM(res_dev.max_volume_size), 0, 0, 0},
122 {"maximumfilesize", store_size, ITEM(res_dev.max_file_size), 0, ITEM_DEFAULT, 1000000000},
123 {"volumecapacity", store_size, ITEM(res_dev.volume_capacity), 0, 0, 0},
124 {"spooldirectory", store_dir, ITEM(res_dev.spool_directory), 0, 0, 0},
125 {"maximumspoolsize", store_size, ITEM(res_dev.max_spool_size), 0, 0, 0},
126 {"maximumjobspoolsize", store_size, ITEM(res_dev.max_job_spool_size), 0, 0, 0},
127 {"driveindex", store_pint, ITEM(res_dev.drive_index), 0, 0, 0},
128 {"maximumpartsize", store_size, ITEM(res_dev.max_part_size), 0, ITEM_DEFAULT, 0},
129 {"requiresmount", store_yesno, ITEM(res_dev.cap_bits), CAP_REQMOUNT, ITEM_DEFAULT, 0},
130 {"mountpoint", store_strname,ITEM(res_dev.mount_point), 0, 0, 0},
131 {"mountcommand", store_strname,ITEM(res_dev.mount_command), 0, 0, 0},
132 {"unmountcommand", store_strname,ITEM(res_dev.unmount_command), 0, 0, 0},
133 {"writepartcommand", store_strname,ITEM(res_dev.write_part_command), 0, 0, 0},
134 {"freespacecommand", store_strname,ITEM(res_dev.free_space_command), 0, 0, 0},
135 {"labeltype", store_label, ITEM(res_dev.label_type), 0, 0, 0},
136 {NULL, NULL, 0, 0, 0, 0}
139 /* Autochanger definition */
140 static RES_ITEM changer_items[] = {
141 {"name", store_name, ITEM(res_changer.hdr.name), 0, ITEM_REQUIRED, 0},
142 {"description", store_str, ITEM(res_changer.hdr.desc), 0, 0, 0},
143 {"device", store_alist_res, ITEM(res_changer.device), R_DEVICE, ITEM_REQUIRED, 0},
144 {"changerdevice", store_strname, ITEM(res_changer.changer_name), 0, ITEM_REQUIRED, 0},
145 {"changercommand", store_strname, ITEM(res_changer.changer_command), 0, ITEM_REQUIRED, 0},
146 {NULL, NULL, 0, 0, 0, 0}
150 // {"mountanonymousvolumes", store_yesno, ITEM(res_dev.cap_bits), CAP_ANONVOLS, ITEM_DEFAULT, 0},
153 /* Message resource */
154 extern RES_ITEM msgs_items[];
157 /* This is the master resource definition */
158 RES_TABLE resources[] = {
159 {"director", dir_items, R_DIRECTOR},
160 {"storage", store_items, R_STORAGE},
161 {"device", dev_items, R_DEVICE},
162 {"messages", msgs_items, R_MSGS},
163 {"autochanger", changer_items, R_AUTOCHANGER},
170 /* Dump contents of resource */
171 void dump_resource(int type, RES *reshdr, void sendit(void *sock, const char *fmt, ...), void *sock)
173 URES *res = (URES *)reshdr;
178 sendit(sock, _("Warning: no \"%s\" resource (%d) defined.\n"), res_to_str(type), type);
181 sendit(sock, "dump_resource type=%d\n", type);
182 if (type < 0) { /* no recursion */
188 sendit(sock, "Director: name=%s\n", res->res_dir.hdr.name);
191 sendit(sock, "Storage: name=%s SDaddr=%s SDport=%d SDDport=%d HB=%s\n",
192 res->res_store.hdr.name,
193 NPRT(get_first_address(res->res_store.sdaddrs, buf, sizeof(buf))),
194 get_first_port_host_order(res->res_store.sdaddrs),
195 get_first_port_host_order(res->res_store.sddaddrs),
196 edit_utime(res->res_store.heartbeat_interval, buf, sizeof(buf)));
197 if (res->res_store.sdaddrs) {
198 foreach_dlist(p, res->res_store.sdaddrs) {
199 sendit(sock, " SDaddr=%s SDport=%d\n",
200 p->get_address(buf, sizeof(buf)), p->get_port_host_order());
203 if (res->res_store.sddaddrs) {
204 foreach_dlist(p, res->res_store.sddaddrs) {
205 sendit(sock, " SDDaddr=%s SDDport=%d\n",
206 p->get_address(buf, sizeof(buf)), p->get_port_host_order());
211 sendit(sock, "Device: name=%s MediaType=%s Device=%s LabelType=%d\n",
212 res->res_dev.hdr.name,
213 res->res_dev.media_type, res->res_dev.device_name,
214 res->res_dev.label_type);
215 sendit(sock, " rew_wait=%d min_bs=%d max_bs=%d\n",
216 res->res_dev.max_rewind_wait, res->res_dev.min_block_size,
217 res->res_dev.max_block_size);
218 sendit(sock, " max_jobs=%d max_files=%" lld " max_size=%" lld "\n",
219 res->res_dev.max_volume_jobs, res->res_dev.max_volume_files,
220 res->res_dev.max_volume_size);
221 sendit(sock, " max_file_size=%" lld " capacity=%" lld "\n",
222 res->res_dev.max_file_size, res->res_dev.volume_capacity);
223 sendit(sock, " spool_directory=%s\n", NPRT(res->res_dev.spool_directory));
224 sendit(sock, " max_spool_size=%" lld " max_job_spool_size=%" lld "\n",
225 res->res_dev.max_spool_size, res->res_dev.max_job_spool_size);
226 if (res->res_dev.changer_res) {
227 sendit(sock, " changer=%p\n", res->res_dev.changer_res);
229 bstrncpy(buf, " ", sizeof(buf));
230 if (res->res_dev.cap_bits & CAP_EOF) {
231 bstrncat(buf, "CAP_EOF ", sizeof(buf));
233 if (res->res_dev.cap_bits & CAP_BSR) {
234 bstrncat(buf, "CAP_BSR ", sizeof(buf));
236 if (res->res_dev.cap_bits & CAP_BSF) {
237 bstrncat(buf, "CAP_BSF ", sizeof(buf));
239 if (res->res_dev.cap_bits & CAP_FSR) {
240 bstrncat(buf, "CAP_FSR ", sizeof(buf));
242 if (res->res_dev.cap_bits & CAP_FSF) {
243 bstrncat(buf, "CAP_FSF ", sizeof(buf));
245 if (res->res_dev.cap_bits & CAP_EOM) {
246 bstrncat(buf, "CAP_EOM ", sizeof(buf));
248 if (res->res_dev.cap_bits & CAP_REM) {
249 bstrncat(buf, "CAP_REM ", sizeof(buf));
251 if (res->res_dev.cap_bits & CAP_RACCESS) {
252 bstrncat(buf, "CAP_RACCESS ", sizeof(buf));
254 if (res->res_dev.cap_bits & CAP_AUTOMOUNT) {
255 bstrncat(buf, "CAP_AUTOMOUNT ", sizeof(buf));
257 if (res->res_dev.cap_bits & CAP_LABEL) {
258 bstrncat(buf, "CAP_LABEL ", sizeof(buf));
260 if (res->res_dev.cap_bits & CAP_ANONVOLS) {
261 bstrncat(buf, "CAP_ANONVOLS ", sizeof(buf));
263 if (res->res_dev.cap_bits & CAP_ALWAYSOPEN) {
264 bstrncat(buf, "CAP_ALWAYSOPEN ", sizeof(buf));
266 if (res->res_dev.cap_bits & CAP_CHECKLABELS) {
267 bstrncat(buf, "CAP_CHECKLABELS ", sizeof(buf));
269 bstrncat(buf, "\n", sizeof(buf));
274 sendit(sock, "Changer: name=%s Changer_devname=%s\n Changer_cmd=%s\n",
275 res->res_changer.hdr.name,
276 res->res_changer.changer_name, res->res_changer.changer_command);
277 foreach_alist(dev, res->res_changer.device) {
278 sendit(sock, " --->Device: name=%s\n", dev->hdr.name);
280 bstrncat(buf, "\n", sizeof(buf));
284 sendit(sock, "Messages: name=%s\n", res->res_msgs.hdr.name);
285 if (res->res_msgs.mail_cmd)
286 sendit(sock, " mailcmd=%s\n", res->res_msgs.mail_cmd);
287 if (res->res_msgs.operator_cmd)
288 sendit(sock, " opcmd=%s\n", res->res_msgs.operator_cmd);
291 sendit(sock, _("Warning: unknown resource type %d\n"), type);
294 if (recurse && res->res_dir.hdr.next)
295 dump_resource(type, (RES *)res->res_dir.hdr.next, sendit, sock);
299 * Free memory of resource.
300 * NB, we don't need to worry about freeing any references
301 * to other resources as they will be freed when that
302 * resource chain is traversed. Mainly we worry about freeing
303 * allocated strings (names).
305 void free_resource(RES *sres, int type)
308 URES *res = (URES *)sres;
313 /* common stuff -- free the resource name */
314 nres = (RES *)res->res_dir.hdr.next;
315 if (res->res_dir.hdr.name) {
316 free(res->res_dir.hdr.name);
318 if (res->res_dir.hdr.desc) {
319 free(res->res_dir.hdr.desc);
325 if (res->res_dir.password) {
326 free(res->res_dir.password);
328 if (res->res_dir.address) {
329 free(res->res_dir.address);
333 if (res->res_changer.changer_name) {
334 free(res->res_changer.changer_name);
336 if (res->res_changer.changer_command) {
337 free(res->res_changer.changer_command);
339 if (res->res_changer.device) {
340 delete res->res_changer.device;
344 if (res->res_store.sdaddrs) {
345 free_addresses(res->res_store.sdaddrs);
347 if (res->res_store.sddaddrs) {
348 free_addresses(res->res_store.sddaddrs);
350 if (res->res_store.working_directory) {
351 free(res->res_store.working_directory);
353 if (res->res_store.pid_directory) {
354 free(res->res_store.pid_directory);
356 if (res->res_store.subsys_directory) {
357 free(res->res_store.subsys_directory);
359 if (res->res_store.scripts_directory) {
360 free(res->res_store.scripts_directory);
364 if (res->res_dev.media_type) {
365 free(res->res_dev.media_type);
367 if (res->res_dev.device_name) {
368 free(res->res_dev.device_name);
370 if (res->res_dev.changer_name) {
371 free(res->res_dev.changer_name);
373 if (res->res_dev.changer_command) {
374 free(res->res_dev.changer_command);
376 if (res->res_dev.alert_command) {
377 free(res->res_dev.alert_command);
379 if (res->res_dev.spool_directory) {
380 free(res->res_dev.spool_directory);
382 if (res->res_dev.mount_point) {
383 free(res->res_dev.mount_point);
385 if (res->res_dev.mount_command) {
386 free(res->res_dev.mount_command);
388 if (res->res_dev.unmount_command) {
389 free(res->res_dev.unmount_command);
391 if (res->res_dev.write_part_command) {
392 free(res->res_dev.write_part_command);
394 if (res->res_dev.free_space_command) {
395 free(res->res_dev.free_space_command);
399 if (res->res_msgs.mail_cmd) {
400 free(res->res_msgs.mail_cmd);
402 if (res->res_msgs.operator_cmd) {
403 free(res->res_msgs.operator_cmd);
405 free_msgs_res((MSGS *)res); /* free message resource */
409 Dmsg1(0, "Unknown resource type %d\n", type);
412 /* Common stuff again -- free the resource, recurse to next one */
417 free_resource(nres, type);
421 /* Save the new resource by chaining it into the head list for
422 * the resource. If this is pass 2, we update any resource
425 void save_resource(int type, RES_ITEM *items, int pass)
428 int rindex = type - r_first;
433 * Ensure that all required items are present
435 for (i=0; items[i].name; i++) {
436 if (items[i].flags & ITEM_REQUIRED) {
437 if (!bit_is_set(i, res_all.res_dir.hdr.item_present)) {
438 Emsg2(M_ERROR_TERM, 0, _("\"%s\" item is required in \"%s\" resource, but not found.\n"),
439 items[i].name, resources[rindex]);
442 /* If this triggers, take a look at lib/parse_conf.h */
443 if (i >= MAX_RES_ITEMS) {
444 Emsg1(M_ERROR_TERM, 0, _("Too many items in \"%s\" resource\n"), resources[rindex]);
448 /* During pass 2, we looked up pointers to all the resources
449 * referrenced in the current resource, , now we
450 * must copy their address from the static record to the allocated
457 /* Resources not containing a resource */
463 /* Resources containing a resource or an alist */
465 if ((res = (URES *)GetResWithName(R_STORAGE, res_all.res_dir.hdr.name)) == NULL) {
466 Emsg1(M_ERROR_TERM, 0, "Cannot find Storage resource \"%s\"\n", res_all.res_dir.hdr.name);
468 res->res_store.messages = res_all.res_store.messages;
471 if ((res = (URES *)GetResWithName(type, res_all.res_changer.hdr.name)) == NULL) {
472 Emsg1(M_ERROR_TERM, 0, "Cannot find AutoChanger resource %s\n",
473 res_all.res_changer.hdr.name);
475 /* we must explicitly copy the device alist pointer */
476 res->res_changer.device = res_all.res_changer.device;
478 * Now update each device in this resource to point back
479 * to the changer resource.
481 foreach_alist(dev, res->res_changer.device) {
482 dev->changer_res = (AUTOCHANGER *)&res->res_changer;
484 if ((errstat = pthread_mutex_init(&res->res_changer.changer_mutex, NULL)) != 0) {
486 Jmsg1(NULL, M_ERROR_TERM, 0, _("Unable to init mutex: ERR=%s\n"),
487 be.strerror(errstat));
491 printf("Unknown resource type %d\n", type);
497 if (res_all.res_dir.hdr.name) {
498 free(res_all.res_dir.hdr.name);
499 res_all.res_dir.hdr.name = NULL;
501 if (res_all.res_dir.hdr.desc) {
502 free(res_all.res_dir.hdr.desc);
503 res_all.res_dir.hdr.desc = NULL;
508 /* The following code is only executed on pass 1 */
511 size = sizeof(DIRRES);
514 size = sizeof(STORES);
517 size = sizeof(DEVRES);
523 size = sizeof(AUTOCHANGER);
526 printf("Unknown resource type %d\n", type);
533 res = (URES *)malloc(size);
534 memcpy(res, &res_all, size);
535 if (!res_head[rindex]) {
536 res_head[rindex] = (RES *)res; /* store first entry */
539 /* Add new res to end of chain */
540 for (next=res_head[rindex]; next->next; next=next->next) {
541 if (strcmp(next->name, res->res_dir.hdr.name) == 0) {
542 Emsg2(M_ERROR_TERM, 0,
543 _("Attempt to define second \"%s\" resource named \"%s\" is not permitted.\n"),
544 resources[rindex].name, res->res_dir.hdr.name);
547 next->next = (RES *)res;
548 Dmsg2(90, "Inserting %s res: %s\n", res_to_str(type),
549 res->res_dir.hdr.name);