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