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-2004 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 static RES *sres_head[R_LAST - R_FIRST + 1];
  39 RES **res_head = sres_head;
  40
  41
  42 /* Forward referenced subroutines */
  43
  44 /* We build the current resource here statically,
  45  * then move it to dynamic memory */
  46 URES res_all;
  47 int res_all_size = sizeof(res_all);
  48
  49 /* Definition of records permitted within each
  50  * resource with the routine to process the record
  51  * information.
  52  */
  53
  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    {"sddport",               store_addresses_port,  ITEM(res_store.sddaddrs),    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}
  70 };
  71
  72
  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    {NULL, NULL, 0, 0, 0, 0}
  80 };
  81
  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    {"changerdevice",         store_strname,ITEM(res_dev.changer_name), 0, 0, 0},
 105    {"changercommand",        store_strname,ITEM(res_dev.changer_command), 0, 0, 0},
 106    {"alertcommand",          store_strname,ITEM(res_dev.alert_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}
 124 };
 125
 126 // {"mountanonymousvolumes", store_yesno,  ITEM(res_dev.cap_bits), CAP_ANONVOLS,   ITEM_DEFAULT, 0},
 127
 128
 129 /* Message resource */
 130 extern RES_ITEM msgs_items[];
 131
 132
 133 /* This is the master resource definition */
 134 RES_TABLE resources[] = {
 135    {"director",      dir_items,   R_DIRECTOR},
 136    {"storage",       store_items, R_STORAGE},
 137    {"device",        dev_items,   R_DEVICE},
 138    {"messages",      msgs_items,  R_MSGS},
 139    {NULL,            NULL,        0}
 140 };
 141
 142
 143
 144
 145 /* Dump contents of resource */
 146 void dump_resource(int type, RES *reshdr, void sendit(void *sock, const char *fmt, ...), void *sock)
 147 {
 148    URES *res = (URES *)reshdr;
 149    char buf[MAXSTRING];
 150    int recurse = 1;
 151    IPADDR *p;
 152    if (res == NULL) {
 153       sendit(sock, _("Warning: no \"%s\" resource (%d) defined.\n"), res_to_str(type), type);
 154       return;
 155    }
 156    sendit(sock, "dump_resource type=%d\n", type);
 157    if (type < 0) {                    /* no recursion */
 158       type = - type;
 159       recurse = 0;
 160    }
 161    switch (type) {
 162    case R_DIRECTOR:
 163       sendit(sock, "Director: name=%s\n", res->res_dir.hdr.name);
 164       break;
 165    case R_STORAGE:
 166       sendit(sock, "Storage: name=%s SDaddr=%s SDport=%d SDDport=%d HB=%s\n",
 167            res->res_store.hdr.name,
 168            NPRT(get_first_address(res->res_store.sdaddrs, buf, sizeof(buf))),
 169            get_first_port_host_order(res->res_store.sdaddrs),
 170            get_first_port_host_order(res->res_store.sddaddrs),
 171            edit_utime(res->res_store.heartbeat_interval, buf, sizeof(buf)));
 172           foreach_dlist(p, res->res_store.sdaddrs) {
 173                 sendit(sock, "        SDaddr=%s SDport=%d\n",
 174                              p->get_address(buf, sizeof(buf)), p->get_port_host_order());
 175           }
 176           foreach_dlist(p, res->res_store.sddaddrs) {
 177                 sendit(sock, "        SDDaddr=%s SDDport=%d\n",
 178                              p->get_address(buf, sizeof(buf)), p->get_port_host_order());
 179           }
 180       break;
 181    case R_DEVICE:
 182       sendit(sock, "Device: name=%s MediaType=%s Device=%s\n",
 183          res->res_dev.hdr.name,
 184          res->res_dev.media_type, res->res_dev.device_name);
 185       sendit(sock, "        rew_wait=%d min_bs=%d max_bs=%d\n",
 186          res->res_dev.max_rewind_wait, res->res_dev.min_block_size,
 187          res->res_dev.max_block_size);
 188       sendit(sock, "        max_jobs=%d max_files=%" lld " max_size=%" lld "\n",
 189          res->res_dev.max_volume_jobs, res->res_dev.max_volume_files,
 190          res->res_dev.max_volume_size);
 191       sendit(sock, "        max_file_size=%" lld " capacity=%" lld "\n",
 192          res->res_dev.max_file_size, res->res_dev.volume_capacity);
 193       sendit(sock, "         spool_directory=%s\n", NPRT(res->res_dev.spool_directory));
 194       sendit(sock, "         max_spool_size=%" lld " max_job_spool_size=%" lld "\n",
 195          res->res_dev.max_spool_size, res->res_dev.max_job_spool_size);
 196       strcpy(buf, "        ");
 197       if (res->res_dev.cap_bits & CAP_EOF) {
 198          bstrncat(buf, "CAP_EOF ", sizeof(buf));
 199       }
 200       if (res->res_dev.cap_bits & CAP_BSR) {
 201          bstrncat(buf, "CAP_BSR ", sizeof(buf));
 202       }
 203       if (res->res_dev.cap_bits & CAP_BSF) {
 204          bstrncat(buf, "CAP_BSF ", sizeof(buf));
 205       }
 206       if (res->res_dev.cap_bits & CAP_FSR) {
 207          bstrncat(buf, "CAP_FSR ", sizeof(buf));
 208       }
 209       if (res->res_dev.cap_bits & CAP_FSF) {
 210          bstrncat(buf, "CAP_FSF ", sizeof(buf));
 211       }
 212       if (res->res_dev.cap_bits & CAP_EOM) {
 213          bstrncat(buf, "CAP_EOM ", sizeof(buf));
 214       }
 215       if (res->res_dev.cap_bits & CAP_REM) {
 216          bstrncat(buf, "CAP_REM ", sizeof(buf));
 217       }
 218       if (res->res_dev.cap_bits & CAP_RACCESS) {
 219          bstrncat(buf, "CAP_RACCESS ", sizeof(buf));
 220       }
 221       if (res->res_dev.cap_bits & CAP_AUTOMOUNT) {
 222          bstrncat(buf, "CAP_AUTOMOUNT ", sizeof(buf));
 223       }
 224       if (res->res_dev.cap_bits & CAP_LABEL) {
 225          bstrncat(buf, "CAP_LABEL ", sizeof(buf));
 226       }
 227       if (res->res_dev.cap_bits & CAP_ANONVOLS) {
 228          bstrncat(buf, "CAP_ANONVOLS ", sizeof(buf));
 229       }
 230       if (res->res_dev.cap_bits & CAP_ALWAYSOPEN) {
 231          bstrncat(buf, "CAP_ALWAYSOPEN ", sizeof(buf));
 232       }
 233       bstrncat(buf, "\n", sizeof(buf));
 234       sendit(sock, buf);
 235       break;
 236    case R_MSGS:
 237       sendit(sock, "Messages: name=%s\n", res->res_msgs.hdr.name);
 238       if (res->res_msgs.mail_cmd)
 239          sendit(sock, "      mailcmd=%s\n", res->res_msgs.mail_cmd);
 240       if (res->res_msgs.operator_cmd)
 241          sendit(sock, "      opcmd=%s\n", res->res_msgs.operator_cmd);
 242       break;
 243    default:
 244       sendit(sock, _("Warning: unknown resource type %d\n"), type);
 245       break;
 246    }
 247    if (recurse && res->res_dir.hdr.next)
 248       dump_resource(type, (RES *)res->res_dir.hdr.next, sendit, sock);
 249 }
 250
 251 /*
 252  * Free memory of resource.
 253  * NB, we don't need to worry about freeing any references
 254  * to other resources as they will be freed when that
 255  * resource chain is traversed.  Mainly we worry about freeing
 256  * allocated strings (names).
 257  */
 258 void free_resource(RES *sres, int type)
 259 {
 260    RES *nres;
 261    URES *res = (URES *)sres;
 262
 263    if (res == NULL)
 264       return;
 265
 266    /* common stuff -- free the resource name */
 267    nres = (RES *)res->res_dir.hdr.next;
 268    if (res->res_dir.hdr.name) {
 269       free(res->res_dir.hdr.name);
 270    }
 271    if (res->res_dir.hdr.desc) {
 272       free(res->res_dir.hdr.desc);
 273    }
 274
 275
 276    switch (type) {
 277       case R_DIRECTOR:
 278          if (res->res_dir.password) {
 279             free(res->res_dir.password);
 280          }
 281          if (res->res_dir.address) {
 282             free(res->res_dir.address);
 283          }
 284          break;
 285       case R_STORAGE:
 286          if (res->res_store.sdaddrs) {
 287             free_addresses(res->res_store.sdaddrs);
 288          }
 289          if (res->res_store.sddaddrs) {
 290             free_addresses(res->res_store.sddaddrs);
 291          }
 292          if (res->res_store.working_directory) {
 293             free(res->res_store.working_directory);
 294          }
 295          if (res->res_store.pid_directory) {
 296             free(res->res_store.pid_directory);
 297          }
 298          if (res->res_store.subsys_directory) {
 299             free(res->res_store.subsys_directory);
 300          }
 301          break;
 302       case R_DEVICE:
 303          if (res->res_dev.media_type) {
 304             free(res->res_dev.media_type);
 305          }
 306          if (res->res_dev.device_name) {
 307             free(res->res_dev.device_name);
 308          }
 309          if (res->res_dev.changer_name) {
 310             free(res->res_dev.changer_name);
 311          }
 312          if (res->res_dev.changer_command) {
 313             free(res->res_dev.changer_command);
 314          }
 315          if (res->res_dev.alert_command) {
 316             free(res->res_dev.alert_command);
 317          }
 318          if (res->res_dev.spool_directory) {
 319             free(res->res_dev.spool_directory);
 320          }
 321          break;
 322       case R_MSGS:
 323          if (res->res_msgs.mail_cmd) {
 324             free(res->res_msgs.mail_cmd);
 325          }
 326          if (res->res_msgs.operator_cmd) {
 327             free(res->res_msgs.operator_cmd);
 328          }
 329          free_msgs_res((MSGS *)res);  /* free message resource */
 330          res = NULL;
 331          break;
 332       default:
 333          Dmsg1(0, "Unknown resource type %d\n", type);
 334          break;
 335    }
 336    /* Common stuff again -- free the resource, recurse to next one */
 337    if (res) {
 338       free(res);
 339    }
 340    if (nres) {
 341       free_resource(nres, type);
 342    }
 343 }
 344
 345 /* Save the new resource by chaining it into the head list for
 346  * the resource. If this is pass 2, we update any resource
 347  * pointers (currently only in the Job resource).
 348  */
 349 void save_resource(int type, RES_ITEM *items, int pass)
 350 {
 351    URES *res;
 352    int rindex = type - r_first;
 353    int i, size;
 354    int error = 0;
 355
 356    /*
 357     * Ensure that all required items are present
 358     */
 359    for (i=0; items[i].name; i++) {
 360       if (items[i].flags & ITEM_REQUIRED) {
 361          if (!bit_is_set(i, res_all.res_dir.hdr.item_present)) {
 362             Emsg2(M_ERROR_TERM, 0, _("\"%s\" item is required in \"%s\" resource, but not found.\n"),
 363               items[i].name, resources[rindex]);
 364           }
 365       }
 366       /* If this triggers, take a look at lib/parse_conf.h */
 367       if (i >= MAX_RES_ITEMS) {
 368          Emsg1(M_ERROR_TERM, 0, _("Too many items in \"%s\" resource\n"), resources[rindex]);
 369       }
 370    }
 371
 372    /* During pass 2, we looked up pointers to all the resources
 373     * referrenced in the current resource, , now we
 374     * must copy their address from the static record to the allocated
 375     * record.
 376     */
 377    if (pass == 2) {
 378       switch (type) {
 379          /* Resources not containing a resource */
 380          case R_DIRECTOR:
 381          case R_DEVICE:
 382          case R_MSGS:
 383             break;
 384
 385          /* Resources containing a resource */
 386          case R_STORAGE:
 387             if ((res = (URES *)GetResWithName(R_STORAGE, res_all.res_dir.hdr.name)) == NULL) {
 388                Emsg1(M_ERROR_TERM, 0, "Cannot find Storage resource \"%s\"\n", res_all.res_dir.hdr.name);
 389             }
 390             res->res_store.messages = res_all.res_store.messages;
 391             break;
 392          default:
 393             printf("Unknown resource type %d\n", type);
 394             error = 1;
 395             break;
 396       }
 397
 398
 399       if (res_all.res_dir.hdr.name) {
 400          free(res_all.res_dir.hdr.name);
 401          res_all.res_dir.hdr.name = NULL;
 402       }
 403       if (res_all.res_dir.hdr.desc) {
 404          free(res_all.res_dir.hdr.desc);
 405          res_all.res_dir.hdr.desc = NULL;
 406       }
 407       return;
 408    }
 409
 410    /* The following code is only executed on pass 1 */
 411    switch (type) {
 412       case R_DIRECTOR:
 413          size = sizeof(DIRRES);
 414          break;
 415       case R_STORAGE:
 416          size = sizeof(STORES);
 417          break;
 418       case R_DEVICE:
 419          size = sizeof(DEVRES);
 420          break;
 421       case R_MSGS:
 422          size = sizeof(MSGS);
 423          break;
 424       default:
 425          printf("Unknown resource type %d\n", type);
 426          error = 1;
 427          size = 1;
 428          break;
 429    }
 430    /* Common */
 431    if (!error) {
 432       res = (URES *)malloc(size);
 433       memcpy(res, &res_all, size);
 434       if (!res_head[rindex]) {
 435          res_head[rindex] = (RES *)res; /* store first entry */
 436       } else {
 437          RES *next;
 438          /* Add new res to end of chain */
 439          for (next=res_head[rindex]; next->next; next=next->next) {
 440             if (strcmp(next->name, res->res_dir.hdr.name) == 0) {
 441                Emsg2(M_ERROR_TERM, 0,
 442                   _("Attempt to define second \"%s\" resource named \"%s\" is not permitted.\n"),
 443                   resources[rindex].name, res->res_dir.hdr.name);
 444             }
 445          }
 446          next->next = (RES *)res;
 447          Dmsg2(90, "Inserting %s res: %s\n", res_to_str(type),
 448                res->res_dir.hdr.name);
 449       }
 450    }
 451 }