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