git.sur5r.net Git - bacula/bacula/blob - bacula/src/stored/stored_conf.c

   1 /*
   2  * Configuration file parser for Bacula Storage daemon
   3  *
   4  *     Kern Sibbald, March MM
   5  *
   6  *   Version $Id$
   7  */
   8
   9 /*
  10    Copyright (C) 2000, 2001, 2002 Kern Sibbald and John Walker
  11
  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.
  16
  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.
  21
  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,
  25    MA 02111-1307, USA.
  26
  27  */
  28
  29 #include "bacula.h"
  30 #include "stored.h"
  31
  32 extern int debug_level;
  33
  34
  35 /* First and last resource ids */
  36 int r_first = R_FIRST;
  37 int r_last  = R_LAST;
  38 pthread_mutex_t res_mutex =  PTHREAD_MUTEX_INITIALIZER;
  39
  40
  41 /* Forward referenced subroutines */
  42
  43 /* We build the current resource here statically,
  44  * then move it to dynamic memory */
  45 URES res_all;
  46 int res_all_size = sizeof(res_all);
  47
  48 /* Definition of records permitted within each
  49  * resource with the routine to process the record
  50  * information.
  51  */
  52
  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, ITEM_REQUIRED, 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, 5},
  67    {"heartbeatinterval",     store_time, ITEM(res_store.heartbeat_interval), 0, ITEM_DEFAULT, 20*60},
  68    {NULL, NULL, 0, 0, 0, 0}
  69 };
  70
  71
  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}
  80 };
  81
  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    {"mountanonymousvolumes", store_yesno,  ITEM(res_dev.cap_bits), CAP_ANONVOLS,   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    {"changerdevice",         store_strname,ITEM(res_dev.changer_name), 0, 0, 0},
 103    {"changercommand",        store_strname,ITEM(res_dev.changer_command), 0, 0, 0},
 104    {"maximumchangerwait",    store_pint,   ITEM(res_dev.max_changer_wait), 0, ITEM_DEFAULT, 2 * 60},
 105    {"maximumopenwait",       store_pint,   ITEM(res_dev.max_open_wait), 0, ITEM_DEFAULT, 5 * 60},
 106    {"maximumopenvolumes",    store_pint,   ITEM(res_dev.max_open_vols), 0, ITEM_DEFAULT, 1},
 107    {"offlineonunmount",      store_yesno,  ITEM(res_dev.cap_bits), CAP_OFFLINEUNMOUNT, ITEM_DEFAULT, 0},
 108    {"maximumrewindwait",     store_pint,   ITEM(res_dev.max_rewind_wait), 0, ITEM_DEFAULT, 5 * 60},
 109    {"minimumblocksize",      store_pint,   ITEM(res_dev.min_block_size), 0, 0, 0},
 110    {"maximumblocksize",      store_pint,   ITEM(res_dev.max_block_size), 0, 0, 0},
 111    {"maximumvolumesize",     store_size,   ITEM(res_dev.max_volume_size), 0, 0, 0},
 112    {"maximumfilesize",       store_size,   ITEM(res_dev.max_file_size), 0, 0, 0},
 113    {"volumecapacity",        store_size,   ITEM(res_dev.volume_capacity), 0, 0, 0},
 114    {NULL, NULL, 0, 0, 0, 0}
 115 };
 116
 117 /* Message resource */
 118 extern struct res_items msgs_items[];
 119
 120
 121 /* This is the master resource definition */
 122 struct s_res resources[] = {
 123    {"director",      dir_items,   R_DIRECTOR,  NULL},
 124    {"storage",       store_items, R_STORAGE,   NULL},
 125    {"device",        dev_items,   R_DEVICE,    NULL},
 126    {"messages",      msgs_items,  R_MSGS,      NULL},
 127    {NULL,            NULL,        0,           NULL}
 128 };
 129
 130
 131
 132 /* Dump contents of resource */
 133 void dump_resource(int type, RES *reshdr, void sendit(void *sock, char *fmt, ...), void *sock)
 134 {
 135    URES *res = (URES *)reshdr;
 136    char buf[MAXSTRING];
 137    int recurse = 1;
 138    if (res == NULL) {
 139       sendit(sock, _("Warning: no %s resource (%d) defined.\n"), res_to_str(type), type);
 140       return;
 141    }
 142    sendit(sock, "dump_resource type=%d\n", type);
 143    if (type < 0) {                    /* no recursion */
 144       type = - type;
 145       recurse = 0;
 146    }
 147    switch (type) {
 148       case R_DIRECTOR:
 149          sendit(sock, "Director: name=%s\n", res->res_dir.hdr.name);
 150          break;
 151       case R_STORAGE:
 152          sendit(sock, "Storage: name=%s SDaddr=%s SDport=%d SDDport=%d\n",
 153             res->res_store.hdr.name, res->res_store.SDaddr,
 154             res->res_store.SDport, res->res_store.SDDport);
 155          break;
 156       case R_DEVICE:
 157          sendit(sock, "Device: name=%s MediaType=%s Device=%s\n",
 158             res->res_dev.hdr.name,
 159             res->res_dev.media_type, res->res_dev.device_name);
 160          sendit(sock, "        rew_wait=%d min_bs=%d max_bs=%d\n",
 161             res->res_dev.max_rewind_wait, res->res_dev.min_block_size,
 162             res->res_dev.max_block_size);
 163          sendit(sock, "        max_jobs=%d max_files=%" lld " max_size=%" lld "\n",
 164             res->res_dev.max_volume_jobs, res->res_dev.max_volume_files,
 165             res->res_dev.max_volume_size);
 166          sendit(sock, "        max_file_size=%" lld " capacity=%" lld "\n",
 167             res->res_dev.max_file_size, res->res_dev.volume_capacity);
 168          strcpy(buf, "        ");
 169          if (res->res_dev.cap_bits & CAP_EOF) {
 170             strcat(buf, "CAP_EOF ");
 171          }
 172          if (res->res_dev.cap_bits & CAP_BSR) {
 173             strcat(buf, "CAP_BSR ");
 174          }
 175          if (res->res_dev.cap_bits & CAP_BSF) {
 176             strcat(buf, "CAP_BSF ");
 177          }
 178          if (res->res_dev.cap_bits & CAP_FSR) {
 179             strcat(buf, "CAP_FSR ");
 180          }
 181          if (res->res_dev.cap_bits & CAP_FSF) {
 182             strcat(buf, "CAP_FSF ");
 183          }
 184          if (res->res_dev.cap_bits & CAP_EOM) {
 185             strcat(buf, "CAP_EOM ");
 186          }
 187          if (res->res_dev.cap_bits & CAP_REM) {
 188             strcat(buf, "CAP_REM ");
 189          }
 190          if (res->res_dev.cap_bits & CAP_RACCESS) {
 191             strcat(buf, "CAP_RACCESS ");
 192          }
 193          if (res->res_dev.cap_bits & CAP_AUTOMOUNT) {
 194             strcat(buf, "CAP_AUTOMOUNT ");
 195          }
 196          if (res->res_dev.cap_bits & CAP_LABEL) {
 197             strcat(buf, "CAP_LABEL ");
 198          }
 199          if (res->res_dev.cap_bits & CAP_ANONVOLS) {
 200             strcat(buf, "CAP_ANONVOLS ");
 201          }
 202          if (res->res_dev.cap_bits & CAP_ALWAYSOPEN) {
 203             strcat(buf, "CAP_ALWAYSOPEN ");
 204          }
 205          strcat(buf, "\n");
 206          sendit(sock, buf);
 207          break;
 208       case R_MSGS:
 209          sendit(sock, "Messages: name=%s\n", res->res_msgs.hdr.name);
 210          if (res->res_msgs.mail_cmd)
 211             sendit(sock, "      mailcmd=%s\n", res->res_msgs.mail_cmd);
 212          if (res->res_msgs.operator_cmd)
 213             sendit(sock, "      opcmd=%s\n", res->res_msgs.operator_cmd);
 214          break;
 215       default:
 216          sendit(sock, _("Warning: unknown resource type %d\n"), type);
 217          break;
 218    }
 219    if (recurse && res->res_dir.hdr.next)
 220       dump_resource(type, (RES *)res->res_dir.hdr.next, sendit, sock);
 221 }
 222
 223 /*
 224  * Free memory of resource.
 225  * NB, we don't need to worry about freeing any references
 226  * to other resources as they will be freed when that
 227  * resource chain is traversed.  Mainly we worry about freeing
 228  * allocated strings (names).
 229  */
 230 void free_resource(int type)
 231 {
 232    URES *nres;
 233    URES *res;
 234    int rindex = type - r_first;
 235    res = (URES *)resources[rindex].res_head;
 236
 237    if (res == NULL)
 238       return;
 239
 240    /* common stuff -- free the resource name */
 241    nres = (URES *)res->res_dir.hdr.next;
 242    if (res->res_dir.hdr.name) {
 243       free(res->res_dir.hdr.name);
 244    }
 245    if (res->res_dir.hdr.desc) {
 246       free(res->res_dir.hdr.desc);
 247    }
 248
 249
 250    switch (type) {
 251       case R_DIRECTOR:
 252          if (res->res_dir.password) {
 253             free(res->res_dir.password);
 254          }
 255          if (res->res_dir.address) {
 256             free(res->res_dir.address);
 257          }
 258          break;
 259       case R_STORAGE:
 260          if (res->res_store.address) {  /* ***FIXME*** deprecated */
 261             free(res->res_store.address);
 262          }
 263          if (res->res_store.SDaddr) {
 264             free(res->res_store.SDaddr);
 265          }
 266          if (res->res_store.working_directory) {
 267             free(res->res_store.working_directory);
 268          }
 269          if (res->res_store.pid_directory) {
 270             free(res->res_store.pid_directory);
 271          }
 272          if (res->res_store.subsys_directory) {
 273             free(res->res_store.subsys_directory);
 274          }
 275          break;
 276       case R_DEVICE:
 277          if (res->res_dev.media_type) {
 278             free(res->res_dev.media_type);
 279          }
 280          if (res->res_dev.device_name) {
 281             free(res->res_dev.device_name);
 282          }
 283          if (res->res_dev.changer_name) {
 284             free(res->res_dev.changer_name);
 285          }
 286          if (res->res_dev.changer_command) {
 287             free(res->res_dev.changer_command);
 288          }
 289          break;
 290       case R_MSGS:
 291          if (res->res_msgs.mail_cmd) {
 292             free(res->res_msgs.mail_cmd);
 293          }
 294          if (res->res_msgs.operator_cmd) {
 295             free(res->res_msgs.operator_cmd);
 296          }
 297          free_msgs_res((MSGS *)res);  /* free message resource */
 298          res = NULL;
 299          break;
 300       default:
 301          Dmsg1(0, "Unknown resource type %d\n", type);
 302          break;
 303    }
 304    /* Common stuff again -- free the resource, recurse to next one */
 305    if (res) {
 306       free(res);
 307    }
 308    resources[rindex].res_head = (RES *)nres;
 309    if (nres) {
 310       free_resource(type);
 311    }
 312 }
 313
 314 /* Save the new resource by chaining it into the head list for
 315  * the resource. If this is pass 2, we update any resource
 316  * pointers (currently only in the Job resource).
 317  */
 318 void save_resource(int type, struct res_items *items, int pass)
 319 {
 320    URES *res;
 321    int rindex = type - r_first;
 322    int i, size;
 323    int error = 0;
 324
 325    /*
 326     * Ensure that all required items are present
 327     */
 328    for (i=0; items[i].name; i++) {
 329       if (items[i].flags & ITEM_REQUIRED) {
 330          if (!bit_is_set(i, res_all.res_dir.hdr.item_present)) {
 331             Emsg2(M_ABORT, 0, _("%s item is required in %s resource, but not found.\n"),
 332               items[i].name, resources[rindex]);
 333           }
 334       }
 335       /* If this triggers, take a look at lib/parse_conf.h */
 336       if (i >= MAX_RES_ITEMS) {
 337          Emsg1(M_ABORT, 0, _("Too many items in %s resource\n"), resources[rindex]);
 338       }
 339    }
 340
 341    /* During pass 2, we looked up pointers to all the resources
 342     * referrenced in the current resource, , now we
 343     * must copy their address from the static record to the allocated
 344     * record.
 345     */
 346    if (pass == 2) {
 347       switch (type) {
 348          /* Resources not containing a resource */
 349          case R_DIRECTOR:
 350          case R_DEVICE:
 351          case R_MSGS:
 352             break;
 353
 354          /* Resources containing a resource */
 355          case R_STORAGE:
 356             if ((res = (URES *)GetResWithName(R_STORAGE, res_all.res_dir.hdr.name)) == NULL) {
 357                Emsg1(M_ABORT, 0, "Cannot find Storage resource %s\n", res_all.res_dir.hdr.name);
 358             }
 359             res->res_store.messages = res_all.res_store.messages;
 360             break;
 361          default:
 362             printf("Unknown resource type %d\n", type);
 363             error = 1;
 364             break;
 365       }
 366
 367
 368       if (res_all.res_dir.hdr.name) {
 369          free(res_all.res_dir.hdr.name);
 370          res_all.res_dir.hdr.name = NULL;
 371       }
 372       if (res_all.res_dir.hdr.desc) {
 373          free(res_all.res_dir.hdr.desc);
 374          res_all.res_dir.hdr.desc = NULL;
 375       }
 376       return;
 377    }
 378
 379    /* The following code is only executed on pass 1 */
 380    switch (type) {
 381       case R_DIRECTOR:
 382          size = sizeof(DIRRES);
 383          break;
 384       case R_STORAGE:
 385          size = sizeof(STORES);
 386          break;
 387       case R_DEVICE:
 388          size = sizeof(DEVRES);
 389          break;
 390       case R_MSGS:
 391          size = sizeof(MSGS);
 392          break;
 393       default:
 394          printf("Unknown resource type %d\n", type);
 395          error = 1;
 396          size = 1;
 397          break;
 398    }
 399    /* Common */
 400    if (!error) {
 401       res = (URES *)malloc(size);
 402       memcpy(res, &res_all, size);
 403       if (!resources[rindex].res_head) {
 404          resources[rindex].res_head = (RES *)res; /* store first entry */
 405       } else {
 406          RES *next;
 407          /* Add new res to end of chain */
 408          for (next=resources[rindex].res_head; next->next; next=next->next)
 409             { }
 410          next->next = (RES *)res;
 411          Dmsg2(90, "Inserting %s res: %s\n", res_to_str(type),
 412                res->res_dir.hdr.name);
 413       }
 414    }
 415 }