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