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 {"requiressl", store_yesno,ITEM(res_store.require_ssl), 1, ITEM_DEFAULT, 0},
66 {"maximumconcurrentjobs", store_pint, ITEM(res_store.max_concurrent_jobs), 0, ITEM_DEFAULT, 10},
67 {"heartbeatinterval", store_time, ITEM(res_store.heartbeat_interval), 0, ITEM_DEFAULT, 0},
68 {NULL, NULL, 0, 0, 0, 0}
72 /* Directors that can speak to the Storage daemon */
73 static RES_ITEM dir_items[] = {
74 {"name", store_name, ITEM(res_dir.hdr.name), 0, ITEM_REQUIRED, 0},
75 {"description", store_str, ITEM(res_dir.hdr.desc), 0, 0, 0},
76 {"password", store_password, ITEM(res_dir.password), 0, ITEM_REQUIRED, 0},
77 {"enablessl", store_yesno, ITEM(res_dir.enable_ssl), 1, ITEM_DEFAULT, 0},
78 {"monitor", store_yesno, ITEM(res_dir.monitor), 1, ITEM_DEFAULT, 0},
79 {NULL, NULL, 0, 0, 0, 0}
82 /* Device definition */
83 static RES_ITEM dev_items[] = {
84 {"name", store_name, ITEM(res_dev.hdr.name), 0, ITEM_REQUIRED, 0},
85 {"description", store_str, ITEM(res_dir.hdr.desc), 0, 0, 0},
86 {"mediatype", store_strname,ITEM(res_dev.media_type), 0, ITEM_REQUIRED, 0},
87 {"archivedevice", store_strname,ITEM(res_dev.device_name), 0, ITEM_REQUIRED, 0},
88 {"hardwareendoffile", store_yesno, ITEM(res_dev.cap_bits), CAP_EOF, ITEM_DEFAULT, 1},
89 {"hardwareendofmedium", store_yesno, ITEM(res_dev.cap_bits), CAP_EOM, ITEM_DEFAULT, 1},
90 {"backwardspacerecord", store_yesno, ITEM(res_dev.cap_bits), CAP_BSR, ITEM_DEFAULT, 1},
91 {"backwardspacefile", store_yesno, ITEM(res_dev.cap_bits), CAP_BSF, ITEM_DEFAULT, 1},
92 {"bsfateom", store_yesno, ITEM(res_dev.cap_bits), CAP_BSFATEOM, ITEM_DEFAULT, 0},
93 {"twoeof", store_yesno, ITEM(res_dev.cap_bits), CAP_TWOEOF, ITEM_DEFAULT, 0},
94 {"forwardspacerecord", store_yesno, ITEM(res_dev.cap_bits), CAP_FSR, ITEM_DEFAULT, 1},
95 {"forwardspacefile", store_yesno, ITEM(res_dev.cap_bits), CAP_FSF, ITEM_DEFAULT, 1},
96 {"fastforwardspacefile", store_yesno, ITEM(res_dev.cap_bits), CAP_FASTFSF, ITEM_DEFAULT, 1},
97 {"removablemedia", store_yesno, ITEM(res_dev.cap_bits), CAP_REM, ITEM_DEFAULT, 1},
98 {"randomaccess", store_yesno, ITEM(res_dev.cap_bits), CAP_RACCESS, 0, 0},
99 {"automaticmount", store_yesno, ITEM(res_dev.cap_bits), CAP_AUTOMOUNT, ITEM_DEFAULT, 0},
100 {"labelmedia", store_yesno, ITEM(res_dev.cap_bits), CAP_LABEL, ITEM_DEFAULT, 0},
101 {"alwaysopen", store_yesno, ITEM(res_dev.cap_bits), CAP_ALWAYSOPEN, ITEM_DEFAULT, 1},
102 {"autochanger", store_yesno, ITEM(res_dev.cap_bits), CAP_AUTOCHANGER, ITEM_DEFAULT, 0},
103 {"closeonpoll", store_yesno, ITEM(res_dev.cap_bits), CAP_CLOSEONPOLL, ITEM_DEFAULT, 0},
104 {"blockpositioning", store_yesno, ITEM(res_dev.cap_bits), CAP_POSITIONBLOCKS, ITEM_DEFAULT, 1},
105 {"usemtiocget", store_yesno, ITEM(res_dev.cap_bits), CAP_MTIOCGET, ITEM_DEFAULT, 1},
106 {"checklabels", store_yesno, ITEM(res_dev.cap_bits), CAP_CHECKLABELS, ITEM_DEFAULT, 0},
107 {"autoselect", store_yesno, ITEM(res_dev.autoselect), 1, ITEM_DEFAULT, 1},
108 {"changerdevice", store_strname,ITEM(res_dev.changer_name), 0, 0, 0},
109 {"changercommand", store_strname,ITEM(res_dev.changer_command), 0, 0, 0},
110 {"alertcommand", store_strname,ITEM(res_dev.alert_command), 0, 0, 0},
111 {"maximumchangerwait", store_pint, ITEM(res_dev.max_changer_wait), 0, ITEM_DEFAULT, 5 * 60},
112 {"maximumopenwait", store_pint, ITEM(res_dev.max_open_wait), 0, ITEM_DEFAULT, 5 * 60},
113 {"maximumopenvolumes", store_pint, ITEM(res_dev.max_open_vols), 0, ITEM_DEFAULT, 1},
114 {"maximumnetworkbuffersize", store_pint, ITEM(res_dev.max_network_buffer_size), 0, 0, 0},
115 {"volumepollinterval", store_time, ITEM(res_dev.vol_poll_interval), 0, 0, 0},
116 {"offlineonunmount", store_yesno, ITEM(res_dev.cap_bits), CAP_OFFLINEUNMOUNT, ITEM_DEFAULT, 0},
117 {"maximumrewindwait", store_pint, ITEM(res_dev.max_rewind_wait), 0, ITEM_DEFAULT, 5 * 60},
118 {"minimumblocksize", store_pint, ITEM(res_dev.min_block_size), 0, 0, 0},
119 {"maximumblocksize", store_pint, ITEM(res_dev.max_block_size), 0, 0, 0},
120 {"maximumvolumesize", store_size, ITEM(res_dev.max_volume_size), 0, 0, 0},
121 {"maximumfilesize", store_size, ITEM(res_dev.max_file_size), 0, ITEM_DEFAULT, 1000000000},
122 {"volumecapacity", store_size, ITEM(res_dev.volume_capacity), 0, 0, 0},
123 {"spooldirectory", store_dir, ITEM(res_dev.spool_directory), 0, 0, 0},
124 {"maximumspoolsize", store_size, ITEM(res_dev.max_spool_size), 0, 0, 0},
125 {"maximumjobspoolsize", store_size, ITEM(res_dev.max_job_spool_size), 0, 0, 0},
126 {"driveindex", store_pint, ITEM(res_dev.drive_index), 0, 0, 0},
127 {"maximumpartsize", store_size, ITEM(res_dev.max_part_size), 0, ITEM_DEFAULT, 0},
128 {"requiresmount", store_yesno, ITEM(res_dev.cap_bits), CAP_REQMOUNT, ITEM_DEFAULT, 0},
129 {"mountpoint", store_strname,ITEM(res_dev.mount_point), 0, 0, 0},
130 {"mountcommand", store_strname,ITEM(res_dev.mount_command), 0, 0, 0},
131 {"unmountcommand", store_strname,ITEM(res_dev.unmount_command), 0, 0, 0},
132 {"writepartcommand", store_strname,ITEM(res_dev.write_part_command), 0, 0, 0},
133 {"freespacecommand", store_strname,ITEM(res_dev.free_space_command), 0, 0, 0},
134 {"labeltype", store_label, ITEM(res_dev.label_type), 0, 0, 0},
135 {NULL, NULL, 0, 0, 0, 0}
138 /* Autochanger definition */
139 static RES_ITEM changer_items[] = {
140 {"name", store_name, ITEM(res_changer.hdr.name), 0, ITEM_REQUIRED, 0},
141 {"description", store_str, ITEM(res_changer.hdr.desc), 0, 0, 0},
142 {"device", store_alist_res, ITEM(res_changer.device), R_DEVICE, ITEM_REQUIRED, 0},
143 {"changerdevice", store_strname, ITEM(res_changer.changer_name), 0, ITEM_REQUIRED, 0},
144 {"changercommand", store_strname, ITEM(res_changer.changer_command), 0, ITEM_REQUIRED, 0},
145 {NULL, NULL, 0, 0, 0, 0}
149 // {"mountanonymousvolumes", store_yesno, ITEM(res_dev.cap_bits), CAP_ANONVOLS, ITEM_DEFAULT, 0},
152 /* Message resource */
153 extern RES_ITEM msgs_items[];
156 /* This is the master resource definition */
157 RES_TABLE resources[] = {
158 {"director", dir_items, R_DIRECTOR},
159 {"storage", store_items, R_STORAGE},
160 {"device", dev_items, R_DEVICE},
161 {"messages", msgs_items, R_MSGS},
162 {"autochanger", changer_items, R_AUTOCHANGER},
169 /* Dump contents of resource */
170 void dump_resource(int type, RES *reshdr, void sendit(void *sock, const char *fmt, ...), void *sock)
172 URES *res = (URES *)reshdr;
177 sendit(sock, _("Warning: no \"%s\" resource (%d) defined.\n"), res_to_str(type), type);
180 sendit(sock, "dump_resource type=%d\n", type);
181 if (type < 0) { /* no recursion */
187 sendit(sock, "Director: name=%s\n", res->res_dir.hdr.name);
190 sendit(sock, "Storage: name=%s SDaddr=%s SDport=%d SDDport=%d HB=%s\n",
191 res->res_store.hdr.name,
192 NPRT(get_first_address(res->res_store.sdaddrs, buf, sizeof(buf))),
193 get_first_port_host_order(res->res_store.sdaddrs),
194 get_first_port_host_order(res->res_store.sddaddrs),
195 edit_utime(res->res_store.heartbeat_interval, buf, sizeof(buf)));
196 if (res->res_store.sdaddrs) {
197 foreach_dlist(p, res->res_store.sdaddrs) {
198 sendit(sock, " SDaddr=%s SDport=%d\n",
199 p->get_address(buf, sizeof(buf)), p->get_port_host_order());
202 if (res->res_store.sddaddrs) {
203 foreach_dlist(p, res->res_store.sddaddrs) {
204 sendit(sock, " SDDaddr=%s SDDport=%d\n",
205 p->get_address(buf, sizeof(buf)), p->get_port_host_order());
210 sendit(sock, "Device: name=%s MediaType=%s Device=%s LabelType=%d\n",
211 res->res_dev.hdr.name,
212 res->res_dev.media_type, res->res_dev.device_name,
213 res->res_dev.label_type);
214 sendit(sock, " rew_wait=%d min_bs=%d max_bs=%d\n",
215 res->res_dev.max_rewind_wait, res->res_dev.min_block_size,
216 res->res_dev.max_block_size);
217 sendit(sock, " max_jobs=%d max_files=%" lld " max_size=%" lld "\n",
218 res->res_dev.max_volume_jobs, res->res_dev.max_volume_files,
219 res->res_dev.max_volume_size);
220 sendit(sock, " max_file_size=%" lld " capacity=%" lld "\n",
221 res->res_dev.max_file_size, res->res_dev.volume_capacity);
222 sendit(sock, " spool_directory=%s\n", NPRT(res->res_dev.spool_directory));
223 sendit(sock, " max_spool_size=%" lld " max_job_spool_size=%" lld "\n",
224 res->res_dev.max_spool_size, res->res_dev.max_job_spool_size);
225 if (res->res_dev.changer_res) {
226 sendit(sock, " changer=%p\n", res->res_dev.changer_res);
228 bstrncpy(buf, " ", sizeof(buf));
229 if (res->res_dev.cap_bits & CAP_EOF) {
230 bstrncat(buf, "CAP_EOF ", sizeof(buf));
232 if (res->res_dev.cap_bits & CAP_BSR) {
233 bstrncat(buf, "CAP_BSR ", sizeof(buf));
235 if (res->res_dev.cap_bits & CAP_BSF) {
236 bstrncat(buf, "CAP_BSF ", sizeof(buf));
238 if (res->res_dev.cap_bits & CAP_FSR) {
239 bstrncat(buf, "CAP_FSR ", sizeof(buf));
241 if (res->res_dev.cap_bits & CAP_FSF) {
242 bstrncat(buf, "CAP_FSF ", sizeof(buf));
244 if (res->res_dev.cap_bits & CAP_EOM) {
245 bstrncat(buf, "CAP_EOM ", sizeof(buf));
247 if (res->res_dev.cap_bits & CAP_REM) {
248 bstrncat(buf, "CAP_REM ", sizeof(buf));
250 if (res->res_dev.cap_bits & CAP_RACCESS) {
251 bstrncat(buf, "CAP_RACCESS ", sizeof(buf));
253 if (res->res_dev.cap_bits & CAP_AUTOMOUNT) {
254 bstrncat(buf, "CAP_AUTOMOUNT ", sizeof(buf));
256 if (res->res_dev.cap_bits & CAP_LABEL) {
257 bstrncat(buf, "CAP_LABEL ", sizeof(buf));
259 if (res->res_dev.cap_bits & CAP_ANONVOLS) {
260 bstrncat(buf, "CAP_ANONVOLS ", sizeof(buf));
262 if (res->res_dev.cap_bits & CAP_ALWAYSOPEN) {
263 bstrncat(buf, "CAP_ALWAYSOPEN ", sizeof(buf));
265 if (res->res_dev.cap_bits & CAP_CHECKLABELS) {
266 bstrncat(buf, "CAP_CHECKLABELS ", sizeof(buf));
268 bstrncat(buf, "\n", sizeof(buf));
273 sendit(sock, "Changer: name=%s Changer_devname=%s\n Changer_cmd=%s\n",
274 res->res_changer.hdr.name,
275 res->res_changer.changer_name, res->res_changer.changer_command);
276 foreach_alist(dev, res->res_changer.device) {
277 sendit(sock, " --->Device: name=%s\n", dev->hdr.name);
279 bstrncat(buf, "\n", sizeof(buf));
283 sendit(sock, "Messages: name=%s\n", res->res_msgs.hdr.name);
284 if (res->res_msgs.mail_cmd)
285 sendit(sock, " mailcmd=%s\n", res->res_msgs.mail_cmd);
286 if (res->res_msgs.operator_cmd)
287 sendit(sock, " opcmd=%s\n", res->res_msgs.operator_cmd);
290 sendit(sock, _("Warning: unknown resource type %d\n"), type);
293 if (recurse && res->res_dir.hdr.next)
294 dump_resource(type, (RES *)res->res_dir.hdr.next, sendit, sock);
298 * Free memory of resource.
299 * NB, we don't need to worry about freeing any references
300 * to other resources as they will be freed when that
301 * resource chain is traversed. Mainly we worry about freeing
302 * allocated strings (names).
304 void free_resource(RES *sres, int type)
307 URES *res = (URES *)sres;
312 /* common stuff -- free the resource name */
313 nres = (RES *)res->res_dir.hdr.next;
314 if (res->res_dir.hdr.name) {
315 free(res->res_dir.hdr.name);
317 if (res->res_dir.hdr.desc) {
318 free(res->res_dir.hdr.desc);
324 if (res->res_dir.password) {
325 free(res->res_dir.password);
327 if (res->res_dir.address) {
328 free(res->res_dir.address);
332 if (res->res_changer.changer_name) {
333 free(res->res_changer.changer_name);
335 if (res->res_changer.changer_command) {
336 free(res->res_changer.changer_command);
338 if (res->res_changer.device) {
339 delete res->res_changer.device;
343 if (res->res_store.sdaddrs) {
344 free_addresses(res->res_store.sdaddrs);
346 if (res->res_store.sddaddrs) {
347 free_addresses(res->res_store.sddaddrs);
349 if (res->res_store.working_directory) {
350 free(res->res_store.working_directory);
352 if (res->res_store.pid_directory) {
353 free(res->res_store.pid_directory);
355 if (res->res_store.subsys_directory) {
356 free(res->res_store.subsys_directory);
360 if (res->res_dev.media_type) {
361 free(res->res_dev.media_type);
363 if (res->res_dev.device_name) {
364 free(res->res_dev.device_name);
366 if (res->res_dev.changer_name) {
367 free(res->res_dev.changer_name);
369 if (res->res_dev.changer_command) {
370 free(res->res_dev.changer_command);
372 if (res->res_dev.alert_command) {
373 free(res->res_dev.alert_command);
375 if (res->res_dev.spool_directory) {
376 free(res->res_dev.spool_directory);
378 if (res->res_dev.mount_point) {
379 free(res->res_dev.mount_point);
381 if (res->res_dev.mount_command) {
382 free(res->res_dev.mount_command);
384 if (res->res_dev.unmount_command) {
385 free(res->res_dev.unmount_command);
387 if (res->res_dev.write_part_command) {
388 free(res->res_dev.write_part_command);
390 if (res->res_dev.free_space_command) {
391 free(res->res_dev.free_space_command);
395 if (res->res_msgs.mail_cmd) {
396 free(res->res_msgs.mail_cmd);
398 if (res->res_msgs.operator_cmd) {
399 free(res->res_msgs.operator_cmd);
401 free_msgs_res((MSGS *)res); /* free message resource */
405 Dmsg1(0, "Unknown resource type %d\n", type);
408 /* Common stuff again -- free the resource, recurse to next one */
413 free_resource(nres, type);
417 /* Save the new resource by chaining it into the head list for
418 * the resource. If this is pass 2, we update any resource
421 void save_resource(int type, RES_ITEM *items, int pass)
424 int rindex = type - r_first;
429 * Ensure that all required items are present
431 for (i=0; items[i].name; i++) {
432 if (items[i].flags & ITEM_REQUIRED) {
433 if (!bit_is_set(i, res_all.res_dir.hdr.item_present)) {
434 Emsg2(M_ERROR_TERM, 0, _("\"%s\" item is required in \"%s\" resource, but not found.\n"),
435 items[i].name, resources[rindex]);
438 /* If this triggers, take a look at lib/parse_conf.h */
439 if (i >= MAX_RES_ITEMS) {
440 Emsg1(M_ERROR_TERM, 0, _("Too many items in \"%s\" resource\n"), resources[rindex]);
444 /* During pass 2, we looked up pointers to all the resources
445 * referrenced in the current resource, , now we
446 * must copy their address from the static record to the allocated
453 /* Resources not containing a resource */
459 /* Resources containing a resource or an alist */
461 if ((res = (URES *)GetResWithName(R_STORAGE, res_all.res_dir.hdr.name)) == NULL) {
462 Emsg1(M_ERROR_TERM, 0, "Cannot find Storage resource \"%s\"\n", res_all.res_dir.hdr.name);
464 res->res_store.messages = res_all.res_store.messages;
467 if ((res = (URES *)GetResWithName(type, res_all.res_changer.hdr.name)) == NULL) {
468 Emsg1(M_ERROR_TERM, 0, "Cannot find AutoChanger resource %s\n",
469 res_all.res_changer.hdr.name);
471 /* we must explicitly copy the device alist pointer */
472 res->res_changer.device = res_all.res_changer.device;
474 * Now update each device in this resource to point back
475 * to the changer resource.
477 foreach_alist(dev, res->res_changer.device) {
478 dev->changer_res = (AUTOCHANGER *)&res->res_changer;
480 if ((errstat = pthread_mutex_init(&res->res_changer.changer_mutex, NULL)) != 0) {
482 Jmsg1(NULL, M_ERROR_TERM, 0, _("Unable to init mutex: ERR=%s\n"),
483 be.strerror(errstat));
487 printf("Unknown resource type %d\n", type);
493 if (res_all.res_dir.hdr.name) {
494 free(res_all.res_dir.hdr.name);
495 res_all.res_dir.hdr.name = NULL;
497 if (res_all.res_dir.hdr.desc) {
498 free(res_all.res_dir.hdr.desc);
499 res_all.res_dir.hdr.desc = NULL;
504 /* The following code is only executed on pass 1 */
507 size = sizeof(DIRRES);
510 size = sizeof(STORES);
513 size = sizeof(DEVRES);
519 size = sizeof(AUTOCHANGER);
522 printf("Unknown resource type %d\n", type);
529 res = (URES *)malloc(size);
530 memcpy(res, &res_all, size);
531 if (!res_head[rindex]) {
532 res_head[rindex] = (RES *)res; /* store first entry */
535 /* Add new res to end of chain */
536 for (next=res_head[rindex]; next->next; next=next->next) {
537 if (strcmp(next->name, res->res_dir.hdr.name) == 0) {
538 Emsg2(M_ERROR_TERM, 0,
539 _("Attempt to define second \"%s\" resource named \"%s\" is not permitted.\n"),
540 resources[rindex].name, res->res_dir.hdr.name);
543 next->next = (RES *)res;
544 Dmsg2(90, "Inserting %s res: %s\n", res_to_str(type),
545 res->res_dir.hdr.name);