2 * Configuration file parser for Bacula Storage daemon
4 * Kern Sibbald, March MM
10 Copyright (C) 2000, 2001, 2002 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 pthread_mutex_t res_mutex = PTHREAD_MUTEX_INITIALIZER;
41 /* Forward referenced subroutines */
43 /* We build the current resource here statically,
44 * then move it to dynamic memory */
46 int res_all_size = sizeof(res_all);
48 /* Definition of records permitted within each
49 * resource with the routine to process the record
53 /* Globals for the Storage daemon. */
54 static struct res_items store_items[] = {
55 {"name", store_name, ITEM(res_store.hdr.name), 0, ITEM_REQUIRED, 0},
56 {"description", store_str, ITEM(res_dir.hdr.desc), 0, 0, 0},
57 {"address", store_str, ITEM(res_store.address), 0, 0, 0}, /* deprecated */
58 {"sdaddress", store_str, ITEM(res_store.SDaddr), 0, 0, 0},
59 {"messages", store_res, ITEM(res_store.messages), 0, R_MSGS, 0},
60 {"sdport", store_int, ITEM(res_store.SDport), 0, ITEM_DEFAULT, 9103},
61 {"sddport", store_int, ITEM(res_store.SDDport), 0, 0, 0}, /* deprecated */
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 struct res_items 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 {"address", store_str, ITEM(res_dir.address), 0, 0, 0},
78 {"enablessl", store_yesno, ITEM(res_dir.enable_ssl), 1, ITEM_DEFAULT, 0},
79 {NULL, NULL, 0, 0, 0, 0}
82 /* Device definition */
83 static struct res_items 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 {"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 {"removablemedia", store_yesno, ITEM(res_dev.cap_bits), CAP_REM, ITEM_DEFAULT, 1},
96 {"randomaccess", store_yesno, ITEM(res_dev.cap_bits), CAP_RACCESS, 0, 0},
97 {"automaticmount", store_yesno, ITEM(res_dev.cap_bits), CAP_AUTOMOUNT, ITEM_DEFAULT, 0},
98 {"labelmedia", store_yesno, ITEM(res_dev.cap_bits), CAP_LABEL, ITEM_DEFAULT, 0},
99 {"alwaysopen", store_yesno, ITEM(res_dev.cap_bits), CAP_ALWAYSOPEN, ITEM_DEFAULT, 1},
100 {"autochanger", store_yesno, ITEM(res_dev.cap_bits), CAP_AUTOCHANGER, ITEM_DEFAULT, 0},
101 {"changerdevice", store_strname,ITEM(res_dev.changer_name), 0, 0, 0},
102 {"changercommand", store_strname,ITEM(res_dev.changer_command), 0, 0, 0},
103 {"maximumchangerwait", store_pint, ITEM(res_dev.max_changer_wait), 0, ITEM_DEFAULT, 2 * 60},
104 {"maximumopenwait", store_pint, ITEM(res_dev.max_open_wait), 0, ITEM_DEFAULT, 5 * 60},
105 {"maximumopenvolumes", store_pint, ITEM(res_dev.max_open_vols), 0, ITEM_DEFAULT, 1},
106 {"offlineonunmount", store_yesno, ITEM(res_dev.cap_bits), CAP_OFFLINEUNMOUNT, ITEM_DEFAULT, 0},
107 {"maximumrewindwait", store_pint, ITEM(res_dev.max_rewind_wait), 0, ITEM_DEFAULT, 5 * 60},
108 {"minimumblocksize", store_pint, ITEM(res_dev.min_block_size), 0, 0, 0},
109 {"maximumblocksize", store_pint, ITEM(res_dev.max_block_size), 0, 0, 0},
110 {"maximumvolumesize", store_size, ITEM(res_dev.max_volume_size), 0, 0, 0},
111 {"maximumfilesize", store_size, ITEM(res_dev.max_file_size), 0, ITEM_DEFAULT, 1000000000},
112 {"volumecapacity", store_size, ITEM(res_dev.volume_capacity), 0, 0, 0},
113 {NULL, NULL, 0, 0, 0, 0}
116 // {"mountanonymousvolumes", store_yesno, ITEM(res_dev.cap_bits), CAP_ANONVOLS, ITEM_DEFAULT, 0},
119 /* Message resource */
120 extern struct res_items msgs_items[];
123 /* This is the master resource definition */
124 struct s_res resources[] = {
125 {"director", dir_items, R_DIRECTOR, NULL},
126 {"storage", store_items, R_STORAGE, NULL},
127 {"device", dev_items, R_DEVICE, NULL},
128 {"messages", msgs_items, R_MSGS, NULL},
129 {NULL, NULL, 0, NULL}
134 /* Dump contents of resource */
135 void dump_resource(int type, RES *reshdr, void sendit(void *sock, char *fmt, ...), void *sock)
137 URES *res = (URES *)reshdr;
141 sendit(sock, _("Warning: no %s resource (%d) defined.\n"), res_to_str(type), type);
144 sendit(sock, "dump_resource type=%d\n", type);
145 if (type < 0) { /* no recursion */
151 sendit(sock, "Director: name=%s\n", res->res_dir.hdr.name);
154 sendit(sock, "Storage: name=%s SDaddr=%s SDport=%d SDDport=%d HB=%s\n",
155 res->res_store.hdr.name, NPRT(res->res_store.SDaddr),
156 res->res_store.SDport, res->res_store.SDDport,
157 edit_utime(res->res_store.heartbeat_interval, buf));
160 sendit(sock, "Device: name=%s MediaType=%s Device=%s\n",
161 res->res_dev.hdr.name,
162 res->res_dev.media_type, res->res_dev.device_name);
163 sendit(sock, " rew_wait=%d min_bs=%d max_bs=%d\n",
164 res->res_dev.max_rewind_wait, res->res_dev.min_block_size,
165 res->res_dev.max_block_size);
166 sendit(sock, " max_jobs=%d max_files=%" lld " max_size=%" lld "\n",
167 res->res_dev.max_volume_jobs, res->res_dev.max_volume_files,
168 res->res_dev.max_volume_size);
169 sendit(sock, " max_file_size=%" lld " capacity=%" lld "\n",
170 res->res_dev.max_file_size, res->res_dev.volume_capacity);
172 if (res->res_dev.cap_bits & CAP_EOF) {
173 strcat(buf, "CAP_EOF ");
175 if (res->res_dev.cap_bits & CAP_BSR) {
176 strcat(buf, "CAP_BSR ");
178 if (res->res_dev.cap_bits & CAP_BSF) {
179 strcat(buf, "CAP_BSF ");
181 if (res->res_dev.cap_bits & CAP_FSR) {
182 strcat(buf, "CAP_FSR ");
184 if (res->res_dev.cap_bits & CAP_FSF) {
185 strcat(buf, "CAP_FSF ");
187 if (res->res_dev.cap_bits & CAP_EOM) {
188 strcat(buf, "CAP_EOM ");
190 if (res->res_dev.cap_bits & CAP_REM) {
191 strcat(buf, "CAP_REM ");
193 if (res->res_dev.cap_bits & CAP_RACCESS) {
194 strcat(buf, "CAP_RACCESS ");
196 if (res->res_dev.cap_bits & CAP_AUTOMOUNT) {
197 strcat(buf, "CAP_AUTOMOUNT ");
199 if (res->res_dev.cap_bits & CAP_LABEL) {
200 strcat(buf, "CAP_LABEL ");
202 if (res->res_dev.cap_bits & CAP_ANONVOLS) {
203 strcat(buf, "CAP_ANONVOLS ");
205 if (res->res_dev.cap_bits & CAP_ALWAYSOPEN) {
206 strcat(buf, "CAP_ALWAYSOPEN ");
212 sendit(sock, "Messages: name=%s\n", res->res_msgs.hdr.name);
213 if (res->res_msgs.mail_cmd)
214 sendit(sock, " mailcmd=%s\n", res->res_msgs.mail_cmd);
215 if (res->res_msgs.operator_cmd)
216 sendit(sock, " opcmd=%s\n", res->res_msgs.operator_cmd);
219 sendit(sock, _("Warning: unknown resource type %d\n"), type);
222 if (recurse && res->res_dir.hdr.next)
223 dump_resource(type, (RES *)res->res_dir.hdr.next, sendit, sock);
227 * Free memory of resource.
228 * NB, we don't need to worry about freeing any references
229 * to other resources as they will be freed when that
230 * resource chain is traversed. Mainly we worry about freeing
231 * allocated strings (names).
233 void free_resource(int type)
237 int rindex = type - r_first;
238 res = (URES *)resources[rindex].res_head;
243 /* common stuff -- free the resource name */
244 nres = (URES *)res->res_dir.hdr.next;
245 if (res->res_dir.hdr.name) {
246 free(res->res_dir.hdr.name);
248 if (res->res_dir.hdr.desc) {
249 free(res->res_dir.hdr.desc);
255 if (res->res_dir.password) {
256 free(res->res_dir.password);
258 if (res->res_dir.address) {
259 free(res->res_dir.address);
263 if (res->res_store.address) { /* ***FIXME*** deprecated */
264 free(res->res_store.address);
266 if (res->res_store.SDaddr) {
267 free(res->res_store.SDaddr);
269 if (res->res_store.working_directory) {
270 free(res->res_store.working_directory);
272 if (res->res_store.pid_directory) {
273 free(res->res_store.pid_directory);
275 if (res->res_store.subsys_directory) {
276 free(res->res_store.subsys_directory);
280 if (res->res_dev.media_type) {
281 free(res->res_dev.media_type);
283 if (res->res_dev.device_name) {
284 free(res->res_dev.device_name);
286 if (res->res_dev.changer_name) {
287 free(res->res_dev.changer_name);
289 if (res->res_dev.changer_command) {
290 free(res->res_dev.changer_command);
294 if (res->res_msgs.mail_cmd) {
295 free(res->res_msgs.mail_cmd);
297 if (res->res_msgs.operator_cmd) {
298 free(res->res_msgs.operator_cmd);
300 free_msgs_res((MSGS *)res); /* free message resource */
304 Dmsg1(0, "Unknown resource type %d\n", type);
307 /* Common stuff again -- free the resource, recurse to next one */
311 resources[rindex].res_head = (RES *)nres;
317 /* Save the new resource by chaining it into the head list for
318 * the resource. If this is pass 2, we update any resource
319 * pointers (currently only in the Job resource).
321 void save_resource(int type, struct res_items *items, int pass)
324 int rindex = type - r_first;
329 * Ensure that all required items are present
331 for (i=0; items[i].name; i++) {
332 if (items[i].flags & ITEM_REQUIRED) {
333 if (!bit_is_set(i, res_all.res_dir.hdr.item_present)) {
334 Emsg2(M_ABORT, 0, _("%s item is required in %s resource, but not found.\n"),
335 items[i].name, resources[rindex]);
338 /* If this triggers, take a look at lib/parse_conf.h */
339 if (i >= MAX_RES_ITEMS) {
340 Emsg1(M_ABORT, 0, _("Too many items in %s resource\n"), resources[rindex]);
344 /* During pass 2, we looked up pointers to all the resources
345 * referrenced in the current resource, , now we
346 * must copy their address from the static record to the allocated
351 /* Resources not containing a resource */
357 /* Resources containing a resource */
359 if ((res = (URES *)GetResWithName(R_STORAGE, res_all.res_dir.hdr.name)) == NULL) {
360 Emsg1(M_ABORT, 0, "Cannot find Storage resource %s\n", res_all.res_dir.hdr.name);
362 res->res_store.messages = res_all.res_store.messages;
365 printf("Unknown resource type %d\n", type);
371 if (res_all.res_dir.hdr.name) {
372 free(res_all.res_dir.hdr.name);
373 res_all.res_dir.hdr.name = NULL;
375 if (res_all.res_dir.hdr.desc) {
376 free(res_all.res_dir.hdr.desc);
377 res_all.res_dir.hdr.desc = NULL;
382 /* The following code is only executed on pass 1 */
385 size = sizeof(DIRRES);
388 size = sizeof(STORES);
391 size = sizeof(DEVRES);
397 printf("Unknown resource type %d\n", type);
404 res = (URES *)malloc(size);
405 memcpy(res, &res_all, size);
406 if (!resources[rindex].res_head) {
407 resources[rindex].res_head = (RES *)res; /* store first entry */
410 /* Add new res to end of chain */
411 for (next=resources[rindex].res_head; next->next; next=next->next) {
412 if (strcmp(next->name, res->res_dir.hdr.name) == 0) {
413 Emsg2(M_ERROR_TERM, 0,
414 _("Attempt to define second %s resource named \"%s\" is not permitted.\n"),
415 resources[rindex].name, res->res_dir.hdr.name);
418 next->next = (RES *)res;
419 Dmsg2(90, "Inserting %s res: %s\n", res_to_str(type),
420 res->res_dir.hdr.name);