git.sur5r.net Git - bacula/bacula/blob - bacula/src/dird/dird_conf.h

   1 /*
   2    Bacula® - The Network Backup Solution
   3
   4    Copyright (C) 2000-2007 Free Software Foundation Europe e.V.
   5
   6    The main author of Bacula is Kern Sibbald, with contributions from
   7    many others, a complete list can be found in the file AUTHORS.
   8    This program is Free Software; you can redistribute it and/or
   9    modify it under the terms of version two of the GNU General Public
  10    License as published by the Free Software Foundation plus additions
  11    that are listed in the file LICENSE.
  12
  13    This program is distributed in the hope that it will be useful, but
  14    WITHOUT ANY WARRANTY; without even the implied warranty of
  15    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  16    General Public License for more details.
  17
  18    You should have received a copy of the GNU General Public License
  19    along with this program; if not, write to the Free Software
  20    Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  21    02110-1301, USA.
  22
  23    Bacula® is a registered trademark of John Walker.
  24    The licensor of Bacula is the Free Software Foundation Europe
  25    (FSFE), Fiduciary Program, Sumatrastrasse 25, 8006 Zürich,
  26    Switzerland, email:ftf@fsfeurope.org.
  27 */
  28 /*
  29  * Director specific configuration and defines
  30  *
  31  *     Kern Sibbald, Feb MM
  32  *
  33  *    Version $Id$
  34  */
  35
  36 /* NOTE:  #includes at the end of this file */
  37
  38 /*
  39  * Resource codes -- they must be sequential for indexing
  40  */
  41 enum {
  42    R_DIRECTOR = 1001,
  43    R_CLIENT,
  44    R_JOB,
  45    R_STORAGE,
  46    R_CATALOG,
  47    R_SCHEDULE,
  48    R_FILESET,
  49    R_POOL,
  50    R_MSGS,
  51    R_COUNTER,
  52    R_CONSOLE,
  53    R_JOBDEFS,
  54    R_DEVICE,
  55    R_FIRST = R_DIRECTOR,
  56    R_LAST  = R_DEVICE                 /* keep this updated */
  57 };
  58
  59
  60 /*
  61  * Some resource attributes
  62  */
  63 enum {
  64    R_NAME = 1020,
  65    R_ADDRESS,
  66    R_PASSWORD,
  67    R_TYPE,
  68    R_BACKUP
  69 };
  70
  71
  72 /* Used for certain KeyWord tables */
  73 struct s_kw {
  74    const char *name;
  75    int token;
  76 };
  77
  78 /* Job Level keyword structure */
  79 struct s_jl {
  80    const char *level_name;                  /* level keyword */
  81    int  level;                        /* level */
  82    int  job_type;                     /* JobType permitting this level */
  83 };
  84
  85 /* Job Type keyword structure */
  86 struct s_jt {
  87    const char *type_name;
  88    int job_type;
  89 };
  90
  91 /* Definition of the contents of each Resource */
  92 /* Needed for forward references */
  93 class SCHED;
  94 class CLIENT;
  95 class FILESET;
  96 class POOL;
  97 class RUN;
  98 class DEVICE;
  99 class RUNSCRIPT;
 100
 101 /*
 102  *   Director Resource
 103  *
 104  */
 105 class DIRRES {
 106 public:
 107    RES   hdr;
 108    dlist *DIRaddrs;
 109    char *password;                    /* Password for UA access */
 110    char *query_file;                  /* SQL query file */
 111    char *working_directory;           /* WorkingDirectory */
 112    const char *scripts_directory;     /* ScriptsDirectory */
 113    char *pid_directory;               /* PidDirectory */
 114    char *subsys_directory;            /* SubsysDirectory */
 115    MSGS *messages;                    /* Daemon message handler */
 116    uint32_t MaxConcurrentJobs;        /* Max concurrent jobs for whole director */
 117    utime_t FDConnectTimeout;          /* timeout for connect in seconds */
 118    utime_t SDConnectTimeout;          /* timeout in seconds */
 119    char *tls_ca_certfile;             /* TLS CA Certificate File */
 120    char *tls_ca_certdir;              /* TLS CA Certificate Directory */
 121    char *tls_certfile;                /* TLS Server Certificate File */
 122    char *tls_keyfile;                 /* TLS Server Key File */
 123    char *tls_dhfile;                  /* TLS Diffie-Hellman Parameters */
 124    alist *tls_allowed_cns;            /* TLS Allowed Clients */
 125    TLS_CONTEXT *tls_ctx;              /* Shared TLS Context */
 126    bool tls_enable;                   /* Enable TLS */
 127    bool tls_require;                  /* Require TLS */
 128    bool tls_verify_peer;              /* TLS Verify Client Certificate */
 129
 130    /* Methods */
 131    char *name() const;
 132 };
 133
 134 inline char *DIRRES::name() const { return hdr.name; }
 135
 136 /*
 137  * Device Resource
 138  *  This resource is a bit different from the other resources
 139  *  because it is not defined in the Director
 140  *  by DEVICE { ... }, but rather by a "reference" such as
 141  *  DEVICE = xxx; Then when the Director connects to the
 142  *  SD, it requests the information about the device.
 143  */
 144 class DEVICE {
 145 public:
 146    RES hdr;
 147
 148    bool found;                        /* found with SD */
 149    int num_writers;                   /* number of writers */
 150    int max_writers;                   /* = 1 for files */
 151    int reserved;                      /* number of reserves */
 152    int num_drives;                    /* for autochanger */
 153    bool autochanger;                  /* set if device is autochanger */
 154    bool open;                         /* drive open */
 155    bool append;                       /* in append mode */
 156    bool read;                         /* in read mode */
 157    bool labeled;                      /* Volume name valid */
 158    bool offline;                      /* not available */
 159    bool autoselect;                   /* can be selected via autochanger */
 160    uint32_t PoolId;
 161    char ChangerName[MAX_NAME_LENGTH];
 162    char VolumeName[MAX_NAME_LENGTH];
 163    char MediaType[MAX_NAME_LENGTH];
 164
 165    /* Methods */
 166    char *name() const;
 167 };
 168
 169 inline char *DEVICE::name() const { return hdr.name; }
 170
 171 /*
 172  * Console ACL positions
 173  */
 174 enum {
 175    Job_ACL = 0,
 176    Client_ACL,
 177    Storage_ACL,
 178    Schedule_ACL,
 179    Run_ACL,
 180    Pool_ACL,
 181    Command_ACL,
 182    FileSet_ACL,
 183    Catalog_ACL,
 184    Where_ACL,
 185    Num_ACL                            /* keep last */
 186 };
 187
 188 /*
 189  *    Console Resource
 190  */
 191 class CONRES {
 192 public:
 193    RES   hdr;
 194    char *password;                    /* UA server password */
 195    alist *ACL_lists[Num_ACL];         /* pointers to ACLs */
 196    char *tls_ca_certfile;             /* TLS CA Certificate File */
 197    char *tls_ca_certdir;              /* TLS CA Certificate Directory */
 198    char *tls_certfile;                /* TLS Server Certificate File */
 199    char *tls_keyfile;                 /* TLS Server Key File */
 200    char *tls_dhfile;                  /* TLS Diffie-Hellman Parameters */
 201    alist *tls_allowed_cns;            /* TLS Allowed Clients */
 202    TLS_CONTEXT *tls_ctx;              /* Shared TLS Context */
 203    bool tls_enable;                   /* Enable TLS */
 204    bool tls_require;                  /* Require TLS */
 205    bool tls_verify_peer;              /* TLS Verify Client Certificate */
 206
 207    /* Methods */
 208    char *name() const;
 209 };
 210
 211 inline char *CONRES::name() const { return hdr.name; }
 212
 213
 214 /*
 215  *   Catalog Resource
 216  *
 217  */
 218 class CAT {
 219 public:
 220    RES   hdr;
 221
 222    int   db_port;                     /* Port */
 223    char *db_address;                  /* host name for remote access */
 224    char *db_socket;                   /* Socket for local access */
 225    char *db_password;
 226    char *db_user;
 227    char *db_name;
 228    int   mult_db_connections;         /* set if multiple connections wanted */
 229
 230    /* Methods */
 231    char *name() const;
 232 };
 233
 234 inline char *CAT::name() const { return hdr.name; }
 235
 236
 237 /*
 238  *   Client Resource
 239  *
 240  */
 241 class CLIENT {
 242 public:
 243    RES   hdr;
 244
 245    int   FDport;                      /* Where File daemon listens */
 246    utime_t FileRetention;             /* file retention period in seconds */
 247    utime_t JobRetention;              /* job retention period in seconds */
 248    char *address;
 249    char *password;
 250    CAT *catalog;                      /* Catalog resource */
 251    uint32_t MaxConcurrentJobs;        /* Maximume concurrent jobs */
 252    uint32_t NumConcurrentJobs;        /* number of concurrent jobs running */
 253    char *tls_ca_certfile;             /* TLS CA Certificate File */
 254    char *tls_ca_certdir;              /* TLS CA Certificate Directory */
 255    char *tls_certfile;                /* TLS Client Certificate File */
 256    char *tls_keyfile;                 /* TLS Client Key File */
 257    TLS_CONTEXT *tls_ctx;              /* Shared TLS Context */
 258    bool tls_enable;                   /* Enable TLS */
 259    bool tls_require;                  /* Require TLS */
 260    bool AutoPrune;                    /* Do automatic pruning? */
 261
 262    /* Methods */
 263    char *name() const;
 264 };
 265
 266 inline char *CLIENT::name() const { return hdr.name; }
 267
 268
 269 /*
 270  *   Store Resource
 271  *
 272  */
 273 class STORE {
 274 public:
 275    RES   hdr;
 276
 277    int   SDport;                      /* port where Directors connect */
 278    int   SDDport;                     /* data port for File daemon */
 279    char *address;
 280    char *password;
 281    char *media_type;
 282    alist *device;                     /* Alternate devices for this Storage */
 283    uint32_t MaxConcurrentJobs;        /* Maximume concurrent jobs */
 284    uint32_t NumConcurrentJobs;        /* number of concurrent jobs running */
 285    char *tls_ca_certfile;             /* TLS CA Certificate File */
 286    char *tls_ca_certdir;              /* TLS CA Certificate Directory */
 287    char *tls_certfile;                /* TLS Client Certificate File */
 288    char *tls_keyfile;                 /* TLS Client Key File */
 289    TLS_CONTEXT *tls_ctx;              /* Shared TLS Context */
 290    bool tls_enable;                   /* Enable TLS */
 291    bool tls_require;                  /* Require TLS */
 292    bool enabled;                      /* Set if device is enabled */
 293    bool  autochanger;                 /* set if autochanger */
 294    int64_t StorageId;                 /* Set from Storage DB record */
 295    int  drives;                       /* number of drives in autochanger */
 296
 297    /* Methods */
 298    char *dev_name() const;
 299    char *name() const;
 300 };
 301
 302 inline char *STORE::dev_name() const
 303 {
 304    DEVICE *dev = (DEVICE *)device->first();
 305    return dev->hdr.name;
 306 }
 307
 308 inline char *STORE::name() const { return hdr.name; }
 309
 310 /*
 311  * This is a sort of "unified" store that has both the
 312  *  storage pointer and the text of where the pointer was
 313  *  found.
 314  */
 315 class USTORE {
 316 public:
 317    STORE *store;
 318    POOLMEM *store_source;
 319
 320    /* Methods */
 321    USTORE() { store = NULL; store_source = get_pool_memory(PM_MESSAGE);
 322               *store_source = 0; };
 323    ~USTORE() { destroy(); }
 324    void set_source(const char *where);
 325    void destroy();
 326 };
 327
 328 inline void USTORE::destroy()
 329 {
 330    if (store_source) {
 331       free_pool_memory(store_source);
 332       store_source = NULL;
 333    }
 334 }
 335
 336
 337 inline void USTORE::set_source(const char *where)
 338 {
 339    if (!store_source) {
 340       store_source = get_pool_memory(PM_MESSAGE);
 341    }
 342    pm_strcpy(store_source, where);
 343 }
 344
 345
 346 /*
 347  *   Job Resource
 348  */
 349 class JOB {
 350 public:
 351    RES   hdr;
 352
 353    int   JobType;                     /* job type (backup, verify, restore */
 354    int   JobLevel;                    /* default backup/verify level */
 355    int   Priority;                    /* Job priority */
 356    int   RestoreJobId;                /* What -- JobId to restore */
 357    char *RestoreWhere;                /* Where on disk to restore -- directory */
 358    char *RestoreBootstrap;            /* Bootstrap file */
 359    alist *RunScripts;                 /* Run {client} program {after|before} Job */
 360    union {
 361       char *WriteBootstrap;           /* Where to write bootstrap Job updates */
 362       char *WriteVerifyList;          /* List of changed files */
 363    };
 364    int   replace;                     /* How (overwrite, ..) */
 365    utime_t MaxRunTime;                /* max run time in seconds */
 366    utime_t MaxWaitTime;               /* max blocking time in seconds */
 367    utime_t FullMaxWaitTime;           /* Max Full job wait time */
 368    utime_t DiffMaxWaitTime;           /* Max Differential job wait time */
 369    utime_t IncMaxWaitTime;            /* Max Incremental job wait time */
 370    utime_t MaxStartDelay;             /* max start delay in seconds */
 371    utime_t RescheduleInterval;        /* Reschedule interval */
 372    utime_t JobRetention;              /* job retention period in seconds */
 373    uint32_t MaxConcurrentJobs;        /* Maximum concurrent jobs */
 374    int RescheduleTimes;               /* Number of times to reschedule job */
 375    bool RescheduleOnError;            /* Set to reschedule on error */
 376    bool PrefixLinks;                  /* prefix soft links with Where path */
 377    bool PruneJobs;                    /* Force pruning of Jobs */
 378    bool PruneFiles;                   /* Force pruning of Files */
 379    bool PruneVolumes;                 /* Force pruning of Volumes */
 380    bool SpoolAttributes;              /* Set to spool attributes in SD */
 381    bool spool_data;                   /* Set to spool data in SD */
 382    bool rerun_failed_levels;          /* Upgrade to rerun failed levels */
 383    bool PreferMountedVolumes;         /* Prefer vols mounted rather than new one */
 384    bool write_part_after_job;         /* Set to write part after job in SD */
 385    bool enabled;                      /* Set if job enabled */
 386
 387    MSGS      *messages;               /* How and where to send messages */
 388    SCHED     *schedule;               /* When -- Automatic schedule */
 389    CLIENT    *client;                 /* Who to backup */
 390    FILESET   *fileset;                /* What to backup -- Fileset */
 391    alist     *storage;                /* Where is device -- list of Storage to be used */
 392    POOL      *pool;                   /* Where is media -- Media Pool */
 393    POOL      *full_pool;              /* Pool for Full backups */
 394    POOL      *inc_pool;               /* Pool for Incremental backups */
 395    POOL      *diff_pool;              /* Pool for Differental backups */
 396    char      *selection_pattern;
 397    int        selection_type;
 398    union {
 399       JOB       *verify_job;          /* Job name to verify */
 400    };
 401    JOB       *jobdefs;                /* Job defaults */
 402    alist     *run_cmds;               /* Run commands */
 403    uint32_t NumConcurrentJobs;        /* number of concurrent jobs running */
 404
 405    /* Methods */
 406    char *name() const;
 407 };
 408
 409 inline char *JOB::name() const { return hdr.name; }
 410
 411 #undef  MAX_FOPTS
 412 #define MAX_FOPTS 34
 413
 414 /* File options structure */
 415 struct FOPTS {
 416    char opts[MAX_FOPTS];              /* options string */
 417    alist regex;                       /* regex string(s) */
 418    alist regexdir;                    /* regex string(s) for directories */
 419    alist regexfile;                   /* regex string(s) for files */
 420    alist wild;                        /* wild card strings */
 421    alist wilddir;                     /* wild card strings for directories */
 422    alist wildfile;                    /* wild card strings for files */
 423    alist wildbase;                    /* wild card strings for files without '/' */
 424    alist base;                        /* list of base names */
 425    alist fstype;                      /* file system type limitation */
 426    alist drivetype;                   /* drive type limitation */
 427    char *reader;                      /* reader program */
 428    char *writer;                      /* writer program */
 429 };
 430
 431
 432 /* This is either an include item or an exclude item */
 433 struct INCEXE {
 434    FOPTS *current_opts;               /* points to current options structure */
 435    FOPTS **opts_list;                 /* options list */
 436    int num_opts;                      /* number of options items */
 437    alist name_list;                   /* filename list -- holds char * */
 438 };
 439
 440 /*
 441  *   FileSet Resource
 442  *
 443  */
 444 class FILESET {
 445 public:
 446    RES   hdr;
 447
 448    bool new_include;                  /* Set if new include used */
 449    INCEXE **include_items;            /* array of incexe structures */
 450    int num_includes;                  /* number in array */
 451    INCEXE **exclude_items;
 452    int num_excludes;
 453    bool have_MD5;                     /* set if MD5 initialized */
 454    struct MD5Context md5c;            /* MD5 of include/exclude */
 455    char MD5[30];                      /* base 64 representation of MD5 */
 456    bool ignore_fs_changes;            /* Don't force Full if FS changed */
 457    bool enable_vss;                   /* Enable Volume Shadow Copy */
 458
 459    /* Methods */
 460    char *name() const;
 461 };
 462
 463 inline char *FILESET::name() const { return hdr.name; }
 464
 465 /*
 466  *   Schedule Resource
 467  *
 468  */
 469 class SCHED {
 470 public:
 471    RES   hdr;
 472
 473    RUN *run;
 474 };
 475
 476 /*
 477  *   Counter Resource
 478  */
 479 class COUNTER {
 480 public:
 481    RES   hdr;
 482
 483    int32_t  MinValue;                 /* Minimum value */
 484    int32_t  MaxValue;                 /* Maximum value */
 485    int32_t  CurrentValue;             /* Current value */
 486    COUNTER *WrapCounter;              /* Wrap counter name */
 487    CAT     *Catalog;                  /* Where to store */
 488    bool     created;                  /* Created in DB */
 489    /* Methods */
 490    char *name() const;
 491 };
 492
 493 inline char *COUNTER::name() const { return hdr.name; }
 494
 495 /*
 496  *   Pool Resource
 497  *
 498  */
 499 class POOL {
 500 public:
 501    RES   hdr;
 502
 503    char *pool_type;                   /* Pool type */
 504    char *label_format;                /* Label format string */
 505    char *cleaning_prefix;             /* Cleaning label prefix */
 506    int32_t LabelType;                 /* Bacula/ANSI/IBM label type */
 507    uint32_t max_volumes;              /* max number of volumes */
 508    utime_t VolRetention;              /* volume retention period in seconds */
 509    utime_t VolUseDuration;            /* duration volume can be used */
 510    uint32_t MaxVolJobs;               /* Maximum jobs on the Volume */
 511    uint32_t MaxVolFiles;              /* Maximum files on the Volume */
 512    uint64_t MaxVolBytes;              /* Maximum bytes on the Volume */
 513    utime_t MigrationTime;             /* Time to migrate to next pool */
 514    uint64_t MigrationHighBytes;       /* When migration starts */
 515    uint64_t MigrationLowBytes;        /* When migration stops */
 516    POOL  *NextPool;                   /* Next pool for migration */
 517    alist *storage;                    /* Where is device -- list of Storage to be used */
 518    bool  use_catalog;                 /* maintain catalog for media */
 519    bool  catalog_files;               /* maintain file entries in catalog */
 520    bool  use_volume_once;             /* write on volume only once */
 521    bool  purge_oldest_volume;         /* purge oldest volume */
 522    bool  recycle_oldest_volume;       /* attempt to recycle oldest volume */
 523    bool  recycle_current_volume;      /* attempt recycle of current volume */
 524    bool  AutoPrune;                   /* default for pool auto prune */
 525    bool  Recycle;                     /* default for media recycle yes/no */
 526    POOL  *RecyclePool;                /* RecyclePool destination when media is purged */
 527    /* Methods */
 528    char *name() const;
 529 };
 530
 531 inline char *POOL::name() const { return hdr.name; }
 532
 533
 534
 535
 536 /* Define the Union of all the above
 537  * resource structure definitions.
 538  */
 539 union URES {
 540    DIRRES     res_dir;
 541    CONRES     res_con;
 542    CLIENT     res_client;
 543    STORE      res_store;
 544    CAT        res_cat;
 545    JOB        res_job;
 546    FILESET    res_fs;
 547    SCHED      res_sch;
 548    POOL       res_pool;
 549    MSGS       res_msgs;
 550    COUNTER    res_counter;
 551    DEVICE     res_dev;
 552    RES        hdr;
 553    RUNSCRIPT  res_runscript;
 554 };
 555
 556
 557
 558 /* Run structure contained in Schedule Resource */
 559 class RUN {
 560 public:
 561    RUN *next;                         /* points to next run record */
 562    int level;                         /* level override */
 563    int Priority;                      /* priority override */
 564    int job_type;
 565    bool spool_data;                   /* Data spooling override */
 566    bool spool_data_set;               /* Data spooling override given */
 567    bool write_part_after_job;         /* Write part after job override */
 568    bool write_part_after_job_set;     /* Write part after job override given */
 569
 570    POOL *pool;                        /* Pool override */
 571    POOL *full_pool;                   /* Pool override */
 572    POOL *inc_pool;                    /* Pool override */
 573    POOL *diff_pool;                   /* Pool override */
 574    STORE *storage;                    /* Storage override */
 575    MSGS *msgs;                        /* Messages override */
 576    char *since;
 577    int level_no;
 578    int minute;                        /* minute to run job */
 579    time_t last_run;                   /* last time run */
 580    time_t next_run;                   /* next time to run */
 581    char hour[nbytes_for_bits(24)];    /* bit set for each hour */
 582    char mday[nbytes_for_bits(31)];    /* bit set for each day of month */
 583    char month[nbytes_for_bits(12)];   /* bit set for each month */
 584    char wday[nbytes_for_bits(7)];     /* bit set for each day of the week */
 585    char wom[nbytes_for_bits(5)];      /* week of month */
 586    char woy[nbytes_for_bits(54)];     /* week of year */
 587 };