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;
38 static RES *sres_head[R_LAST - R_FIRST];
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 {"address", store_str, ITEM(res_store.address), 0, 0, 0}, /* deprecated */
59 {"sdaddress", store_str, ITEM(res_store.SDaddr), 0, 0, 0},
60 {"messages", store_res, ITEM(res_store.messages), 0, R_MSGS, 0},
61 {"sdport", store_int, ITEM(res_store.SDport), 0, ITEM_DEFAULT, 9103},
62 {"sddport", store_int, ITEM(res_store.SDDport), 0, 0, 0}, /* deprecated */
63 {"workingdirectory", store_dir, ITEM(res_store.working_directory), 0, ITEM_REQUIRED, 0},
64 {"piddirectory", store_dir, ITEM(res_store.pid_directory), 0, ITEM_REQUIRED, 0},
65 {"subsysdirectory", store_dir, ITEM(res_store.subsys_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 {"address", store_str, ITEM(res_dir.address), 0, 0, 0},
79 {"enablessl", store_yesno, ITEM(res_dir.enable_ssl), 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 {"changerdevice", store_strname,ITEM(res_dev.changer_name), 0, 0, 0},
106 {"changercommand", store_strname,ITEM(res_dev.changer_command), 0, 0, 0},
107 {"maximumchangerwait", store_pint, ITEM(res_dev.max_changer_wait), 0, ITEM_DEFAULT, 5 * 60},
108 {"maximumopenwait", store_pint, ITEM(res_dev.max_open_wait), 0, ITEM_DEFAULT, 5 * 60},
109 {"maximumopenvolumes", store_pint, ITEM(res_dev.max_open_vols), 0, ITEM_DEFAULT, 1},
110 {"maximumnetworkbuffersize", store_pint, ITEM(res_dev.max_network_buffer_size), 0, 0, 0},
111 {"volumepollinterval", store_time, ITEM(res_dev.vol_poll_interval), 0, 0, 0},
112 {"offlineonunmount", store_yesno, ITEM(res_dev.cap_bits), CAP_OFFLINEUNMOUNT, ITEM_DEFAULT, 0},
113 {"maximumrewindwait", store_pint, ITEM(res_dev.max_rewind_wait), 0, ITEM_DEFAULT, 5 * 60},
114 {"minimumblocksize", store_pint, ITEM(res_dev.min_block_size), 0, 0, 0},
115 {"maximumblocksize", store_pint, ITEM(res_dev.max_block_size), 0, 0, 0},
116 {"maximumvolumesize", store_size, ITEM(res_dev.max_volume_size), 0, 0, 0},
117 {"maximumfilesize", store_size, ITEM(res_dev.max_file_size), 0, ITEM_DEFAULT, 1000000000},
118 {"volumecapacity", store_size, ITEM(res_dev.volume_capacity), 0, 0, 0},
119 {"spooldirectory", store_dir, ITEM(res_dev.spool_directory), 0, 0, 0},
120 {"maximumspoolsize", store_size, ITEM(res_dev.max_spool_size), 0, 0, 0},
121 {"maximumjobspoolsize", store_size, ITEM(res_dev.max_job_spool_size), 0, 0, 0},
122 {"driveindex", store_pint, ITEM(res_dev.drive_index), 0, 0, 0},
123 {NULL, NULL, 0, 0, 0, 0}
126 // {"mountanonymousvolumes", store_yesno, ITEM(res_dev.cap_bits), CAP_ANONVOLS, ITEM_DEFAULT, 0},
129 /* Message resource */
130 extern RES_ITEM msgs_items[];
133 /* This is the master resource definition */
134 RES_TABLE resources[] = {
135 {"director", dir_items, R_DIRECTOR, NULL},
136 {"storage", store_items, R_STORAGE, NULL},
137 {"device", dev_items, R_DEVICE, NULL},
138 {"messages", msgs_items, R_MSGS, NULL},
139 {NULL, NULL, 0, NULL}
144 /* Dump contents of resource */
145 void dump_resource(int type, RES *reshdr, void sendit(void *sock, const char *fmt, ...), void *sock)
147 URES *res = (URES *)reshdr;
151 sendit(sock, _("Warning: no \"%s\" resource (%d) defined.\n"), res_to_str(type), type);
154 sendit(sock, "dump_resource type=%d\n", type);
155 if (type < 0) { /* no recursion */
161 sendit(sock, "Director: name=%s\n", res->res_dir.hdr.name);
164 sendit(sock, "Storage: name=%s SDaddr=%s SDport=%d SDDport=%d HB=%s\n",
165 res->res_store.hdr.name, NPRT(res->res_store.SDaddr),
166 res->res_store.SDport, res->res_store.SDDport,
167 edit_utime(res->res_store.heartbeat_interval, buf));
170 sendit(sock, "Device: name=%s MediaType=%s Device=%s\n",
171 res->res_dev.hdr.name,
172 res->res_dev.media_type, res->res_dev.device_name);
173 sendit(sock, " rew_wait=%d min_bs=%d max_bs=%d\n",
174 res->res_dev.max_rewind_wait, res->res_dev.min_block_size,
175 res->res_dev.max_block_size);
176 sendit(sock, " max_jobs=%d max_files=%" lld " max_size=%" lld "\n",
177 res->res_dev.max_volume_jobs, res->res_dev.max_volume_files,
178 res->res_dev.max_volume_size);
179 sendit(sock, " max_file_size=%" lld " capacity=%" lld "\n",
180 res->res_dev.max_file_size, res->res_dev.volume_capacity);
181 sendit(sock, " spool_directory=%s\n", NPRT(res->res_dev.spool_directory));
182 sendit(sock, " max_spool_size=%" lld " max_job_spool_size=%" lld "\n",
183 res->res_dev.max_spool_size, res->res_dev.max_job_spool_size);
185 if (res->res_dev.cap_bits & CAP_EOF) {
186 bstrncat(buf, "CAP_EOF ", sizeof(buf));
188 if (res->res_dev.cap_bits & CAP_BSR) {
189 bstrncat(buf, "CAP_BSR ", sizeof(buf));
191 if (res->res_dev.cap_bits & CAP_BSF) {
192 bstrncat(buf, "CAP_BSF ", sizeof(buf));
194 if (res->res_dev.cap_bits & CAP_FSR) {
195 bstrncat(buf, "CAP_FSR ", sizeof(buf));
197 if (res->res_dev.cap_bits & CAP_FSF) {
198 bstrncat(buf, "CAP_FSF ", sizeof(buf));
200 if (res->res_dev.cap_bits & CAP_EOM) {
201 bstrncat(buf, "CAP_EOM ", sizeof(buf));
203 if (res->res_dev.cap_bits & CAP_REM) {
204 bstrncat(buf, "CAP_REM ", sizeof(buf));
206 if (res->res_dev.cap_bits & CAP_RACCESS) {
207 bstrncat(buf, "CAP_RACCESS ", sizeof(buf));
209 if (res->res_dev.cap_bits & CAP_AUTOMOUNT) {
210 bstrncat(buf, "CAP_AUTOMOUNT ", sizeof(buf));
212 if (res->res_dev.cap_bits & CAP_LABEL) {
213 bstrncat(buf, "CAP_LABEL ", sizeof(buf));
215 if (res->res_dev.cap_bits & CAP_ANONVOLS) {
216 bstrncat(buf, "CAP_ANONVOLS ", sizeof(buf));
218 if (res->res_dev.cap_bits & CAP_ALWAYSOPEN) {
219 bstrncat(buf, "CAP_ALWAYSOPEN ", sizeof(buf));
221 bstrncat(buf, "\n", sizeof(buf));
225 sendit(sock, "Messages: name=%s\n", res->res_msgs.hdr.name);
226 if (res->res_msgs.mail_cmd)
227 sendit(sock, " mailcmd=%s\n", res->res_msgs.mail_cmd);
228 if (res->res_msgs.operator_cmd)
229 sendit(sock, " opcmd=%s\n", res->res_msgs.operator_cmd);
232 sendit(sock, _("Warning: unknown resource type %d\n"), type);
235 if (recurse && res->res_dir.hdr.next)
236 dump_resource(type, (RES *)res->res_dir.hdr.next, sendit, sock);
240 * Free memory of resource.
241 * NB, we don't need to worry about freeing any references
242 * to other resources as they will be freed when that
243 * resource chain is traversed. Mainly we worry about freeing
244 * allocated strings (names).
246 void free_resource(RES *sres, int type)
249 URES *res = (URES *)sres;
254 /* common stuff -- free the resource name */
255 nres = (RES *)res->res_dir.hdr.next;
256 if (res->res_dir.hdr.name) {
257 free(res->res_dir.hdr.name);
259 if (res->res_dir.hdr.desc) {
260 free(res->res_dir.hdr.desc);
266 if (res->res_dir.password) {
267 free(res->res_dir.password);
269 if (res->res_dir.address) {
270 free(res->res_dir.address);
274 if (res->res_store.address) { /* ***FIXME*** deprecated */
275 free(res->res_store.address);
277 if (res->res_store.SDaddr) {
278 free(res->res_store.SDaddr);
280 if (res->res_store.working_directory) {
281 free(res->res_store.working_directory);
283 if (res->res_store.pid_directory) {
284 free(res->res_store.pid_directory);
286 if (res->res_store.subsys_directory) {
287 free(res->res_store.subsys_directory);
291 if (res->res_dev.media_type) {
292 free(res->res_dev.media_type);
294 if (res->res_dev.device_name) {
295 free(res->res_dev.device_name);
297 if (res->res_dev.changer_name) {
298 free(res->res_dev.changer_name);
300 if (res->res_dev.changer_command) {
301 free(res->res_dev.changer_command);
303 if (res->res_dev.spool_directory) {
304 free(res->res_dev.spool_directory);
308 if (res->res_msgs.mail_cmd) {
309 free(res->res_msgs.mail_cmd);
311 if (res->res_msgs.operator_cmd) {
312 free(res->res_msgs.operator_cmd);
314 free_msgs_res((MSGS *)res); /* free message resource */
318 Dmsg1(0, "Unknown resource type %d\n", type);
321 /* Common stuff again -- free the resource, recurse to next one */
326 free_resource(nres, type);
330 /* Save the new resource by chaining it into the head list for
331 * the resource. If this is pass 2, we update any resource
332 * pointers (currently only in the Job resource).
334 void save_resource(int type, RES_ITEM *items, int pass)
337 int rindex = type - r_first;
342 * Ensure that all required items are present
344 for (i=0; items[i].name; i++) {
345 if (items[i].flags & ITEM_REQUIRED) {
346 if (!bit_is_set(i, res_all.res_dir.hdr.item_present)) {
347 Emsg2(M_ERROR_TERM, 0, _("\"%s\" item is required in \"%s\" resource, but not found.\n"),
348 items[i].name, resources[rindex]);
351 /* If this triggers, take a look at lib/parse_conf.h */
352 if (i >= MAX_RES_ITEMS) {
353 Emsg1(M_ERROR_TERM, 0, _("Too many items in \"%s\" resource\n"), resources[rindex]);
357 /* During pass 2, we looked up pointers to all the resources
358 * referrenced in the current resource, , now we
359 * must copy their address from the static record to the allocated
364 /* Resources not containing a resource */
370 /* Resources containing a resource */
372 if ((res = (URES *)GetResWithName(R_STORAGE, res_all.res_dir.hdr.name)) == NULL) {
373 Emsg1(M_ERROR_TERM, 0, "Cannot find Storage resource \"%s\"\n", res_all.res_dir.hdr.name);
375 res->res_store.messages = res_all.res_store.messages;
378 printf("Unknown resource type %d\n", type);
384 if (res_all.res_dir.hdr.name) {
385 free(res_all.res_dir.hdr.name);
386 res_all.res_dir.hdr.name = NULL;
388 if (res_all.res_dir.hdr.desc) {
389 free(res_all.res_dir.hdr.desc);
390 res_all.res_dir.hdr.desc = NULL;
395 /* The following code is only executed on pass 1 */
398 size = sizeof(DIRRES);
401 size = sizeof(STORES);
404 size = sizeof(DEVRES);
410 printf("Unknown resource type %d\n", type);
417 res = (URES *)malloc(size);
418 memcpy(res, &res_all, size);
419 if (!resources[rindex].res_head) {
420 resources[rindex].res_head = (RES *)res; /* store first entry */
423 /* Add new res to end of chain */
424 for (next=resources[rindex].res_head; next->next; next=next->next) {
425 if (strcmp(next->name, res->res_dir.hdr.name) == 0) {
426 Emsg2(M_ERROR_TERM, 0,
427 _("Attempt to define second \"%s\" resource named \"%s\" is not permitted.\n"),
428 resources[rindex].name, res->res_dir.hdr.name);
431 next->next = (RES *)res;
432 Dmsg2(90, "Inserting %s res: %s\n", res_to_str(type),
433 res->res_dir.hdr.name);