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-2008 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 and included
  11    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    const char *plugin_directory;      /* Plugin Directory */
 114    char *pid_directory;               /* PidDirectory */
 115    char *subsys_directory;            /* SubsysDirectory */
 116    MSGS *messages;                    /* Daemon message handler */
 117    uint32_t MaxConcurrentJobs;        /* Max concurrent jobs for whole director */
 118    utime_t FDConnectTimeout;          /* timeout for connect in seconds */
 119    utime_t SDConnectTimeout;          /* timeout in seconds */
 120    utime_t heartbeat_interval;        /* Interval to send heartbeats */
 121    char *tls_ca_certfile;             /* TLS CA Certificate File */
 122    char *tls_ca_certdir;              /* TLS CA Certificate Directory */
 123    char *tls_certfile;                /* TLS Server Certificate File */
 124    char *tls_keyfile;                 /* TLS Server Key File */
 125    char *tls_dhfile;                  /* TLS Diffie-Hellman Parameters */
 126    alist *tls_allowed_cns;            /* TLS Allowed Clients */
 127    TLS_CONTEXT *tls_ctx;              /* Shared TLS Context */
 128    bool tls_authenticate;             /* Authenticated with TLS */
 129    bool tls_enable;                   /* Enable TLS */
 130    bool tls_require;                  /* Require TLS */
 131    bool tls_verify_peer;              /* TLS Verify Client Certificate */
 132
 133    /* Methods */
 134    char *name() const;
 135 };
 136
 137 inline char *DIRRES::name() const { return hdr.name; }
 138
 139 /*
 140  * Device Resource
 141  *  This resource is a bit different from the other resources
 142  *  because it is not defined in the Director
 143  *  by DEVICE { ... }, but rather by a "reference" such as
 144  *  DEVICE = xxx; Then when the Director connects to the
 145  *  SD, it requests the information about the device.
 146  */
 147 class DEVICE {
 148 public:
 149    RES hdr;
 150
 151    bool found;                        /* found with SD */
 152    int num_writers;                   /* number of writers */
 153    int max_writers;                   /* = 1 for files */
 154    int reserved;                      /* number of reserves */
 155    int num_drives;                    /* for autochanger */
 156    bool autochanger;                  /* set if device is autochanger */
 157    bool open;                         /* drive open */
 158    bool append;                       /* in append mode */
 159    bool read;                         /* in read mode */
 160    bool labeled;                      /* Volume name valid */
 161    bool offline;                      /* not available */
 162    bool autoselect;                   /* can be selected via autochanger */
 163    uint32_t PoolId;
 164    char ChangerName[MAX_NAME_LENGTH];
 165    char VolumeName[MAX_NAME_LENGTH];
 166    char MediaType[MAX_NAME_LENGTH];
 167
 168    /* Methods */
 169    char *name() const;
 170 };
 171
 172 inline char *DEVICE::name() const { return hdr.name; }
 173
 174 /*
 175  * Console ACL positions
 176  */
 177 enum {
 178    Job_ACL = 0,
 179    Client_ACL,
 180    Storage_ACL,
 181    Schedule_ACL,
 182    Run_ACL,
 183    Pool_ACL,
 184    Command_ACL,
 185    FileSet_ACL,
 186    Catalog_ACL,
 187    Where_ACL,
 188    Num_ACL                            /* keep last */
 189 };
 190
 191 /*
 192  *    Console Resource
 193  */
 194 class CONRES {
 195 public:
 196    RES   hdr;
 197    char *password;                    /* UA server password */
 198    alist *ACL_lists[Num_ACL];         /* pointers to ACLs */
 199    char *tls_ca_certfile;             /* TLS CA Certificate File */
 200    char *tls_ca_certdir;              /* TLS CA Certificate Directory */
 201    char *tls_certfile;                /* TLS Server Certificate File */
 202    char *tls_keyfile;                 /* TLS Server Key File */
 203    char *tls_dhfile;                  /* TLS Diffie-Hellman Parameters */
 204    alist *tls_allowed_cns;            /* TLS Allowed Clients */
 205    TLS_CONTEXT *tls_ctx;              /* Shared TLS Context */
 206    bool tls_authenticate;             /* Authenticated with TLS */
 207    bool tls_enable;                   /* Enable TLS */
 208    bool tls_require;                  /* Require TLS */
 209    bool tls_verify_peer;              /* TLS Verify Client Certificate */
 210
 211    /* Methods */
 212    char *name() const;
 213 };
 214
 215 inline char *CONRES::name() const { return hdr.name; }
 216
 217
 218 /*
 219  *   Catalog Resource
 220  *
 221  */
 222 class CAT {
 223 public:
 224    RES   hdr;
 225
 226    int   db_port;                     /* Port */
 227    char *db_address;                  /* host name for remote access */
 228    char *db_socket;                   /* Socket for local access */
 229    char *db_password;
 230    char *db_user;
 231    char *db_name;
 232    char *db_driver;                   /* Select appropriate driver */
 233    int   mult_db_connections;         /* set if multiple connections wanted */
 234
 235    /* Methods */
 236    char *name() const;
 237 };
 238
 239 inline char *CAT::name() const { return hdr.name; }
 240
 241
 242 /*
 243  *   Client Resource
 244  *
 245  */
 246 class CLIENT {
 247 public:
 248    RES   hdr;
 249
 250    int   FDport;                      /* Where File daemon listens */
 251    utime_t FileRetention;             /* file retention period in seconds */
 252    utime_t JobRetention;              /* job retention period in seconds */
 253    utime_t heartbeat_interval;        /* Interval to send heartbeats */
 254    char *address;
 255    char *password;
 256    CAT *catalog;                      /* Catalog resource */
 257    uint32_t MaxConcurrentJobs;        /* Maximume concurrent jobs */
 258    uint32_t NumConcurrentJobs;        /* number of concurrent jobs running */
 259    char *tls_ca_certfile;             /* TLS CA Certificate File */
 260    char *tls_ca_certdir;              /* TLS CA Certificate Directory */
 261    char *tls_certfile;                /* TLS Client Certificate File */
 262    char *tls_keyfile;                 /* TLS Client Key File */
 263    alist *tls_allowed_cns;            /* TLS Allowed Clients */
 264    TLS_CONTEXT *tls_ctx;              /* Shared TLS Context */
 265    bool tls_authenticate;             /* Authenticated with TLS */
 266    bool tls_enable;                   /* Enable TLS */
 267    bool tls_require;                  /* Require TLS */
 268    bool AutoPrune;                    /* Do automatic pruning? */
 269
 270    /* Methods */
 271    char *name() const;
 272 };
 273
 274 inline char *CLIENT::name() const { return hdr.name; }
 275
 276
 277 /*
 278  *   Store Resource
 279  *
 280  */
 281 class STORE {
 282 public:
 283    RES   hdr;
 284
 285    int   SDport;                      /* port where Directors connect */
 286    int   SDDport;                     /* data port for File daemon */
 287    char *address;
 288    char *password;
 289    char *media_type;
 290    alist *device;                     /* Alternate devices for this Storage */
 291    uint32_t MaxConcurrentJobs;        /* Maximume concurrent jobs */
 292    uint32_t NumConcurrentJobs;        /* number of concurrent jobs running */
 293    char *tls_ca_certfile;             /* TLS CA Certificate File */
 294    char *tls_ca_certdir;              /* TLS CA Certificate Directory */
 295    char *tls_certfile;                /* TLS Client Certificate File */
 296    char *tls_keyfile;                 /* TLS Client Key File */
 297    TLS_CONTEXT *tls_ctx;              /* Shared TLS Context */
 298    bool tls_authenticate;             /* Authenticated with TLS */
 299    bool tls_enable;                   /* Enable TLS */
 300    bool tls_require;                  /* Require TLS */
 301    bool enabled;                      /* Set if device is enabled */
 302    bool  autochanger;                 /* set if autochanger */
 303    int64_t StorageId;                 /* Set from Storage DB record */
 304    utime_t heartbeat_interval;        /* Interval to send heartbeats */
 305    int  drives;                       /* number of drives in autochanger */
 306
 307    /* Methods */
 308    char *dev_name() const;
 309    char *name() const;
 310 };
 311
 312 inline char *STORE::dev_name() const
 313 {
 314    DEVICE *dev = (DEVICE *)device->first();
 315    return dev->hdr.name;
 316 }
 317
 318 inline char *STORE::name() const { return hdr.name; }
 319
 320 /*
 321  * This is a sort of "unified" store that has both the
 322  *  storage pointer and the text of where the pointer was
 323  *  found.
 324  */
 325 class USTORE {
 326 public:
 327    STORE *store;
 328    POOLMEM *store_source;
 329
 330    /* Methods */
 331    USTORE() { store = NULL; store_source = get_pool_memory(PM_MESSAGE);
 332               *store_source = 0; };
 333    ~USTORE() { destroy(); }
 334    void set_source(const char *where);
 335    void destroy();
 336 };
 337
 338 inline void USTORE::destroy()
 339 {
 340    if (store_source) {
 341       free_pool_memory(store_source);
 342       store_source = NULL;
 343    }
 344 }
 345
 346
 347 inline void USTORE::set_source(const char *where)
 348 {
 349    if (!store_source) {
 350       store_source = get_pool_memory(PM_MESSAGE);
 351    }
 352    pm_strcpy(store_source, where);
 353 }
 354
 355
 356 /*
 357  *   Job Resource
 358  */
 359 class JOB {
 360 public:
 361    RES   hdr;
 362
 363    int   JobType;                     /* job type (backup, verify, restore */
 364    int   JobLevel;                    /* default backup/verify level */
 365    int   Priority;                    /* Job priority */
 366    int   RestoreJobId;                /* What -- JobId to restore */
 367    char *RestoreWhere;                /* Where on disk to restore -- directory */
 368    char *RegexWhere;                  /* RegexWhere option */
 369    char *strip_prefix;                /* remove prefix from filename  */
 370    char *add_prefix;                  /* add prefix to filename  */
 371    char *add_suffix;                  /* add suffix to filename -- .old */
 372    bool  where_use_regexp;            /* true if RestoreWhere is a BREGEXP */
 373    char *RestoreBootstrap;            /* Bootstrap file */
 374    alist *RunScripts;                 /* Run {client} program {after|before} Job */
 375    union {
 376       char *WriteBootstrap;           /* Where to write bootstrap Job updates */
 377       char *WriteVerifyList;          /* List of changed files */
 378    };
 379    int   replace;                     /* How (overwrite, ..) */
 380    utime_t MaxRunTime;                /* max run time in seconds */
 381    utime_t MaxWaitTime;               /* max blocking time in seconds */
 382    utime_t FullMaxWaitTime;           /* Max Full job wait time */
 383    utime_t DiffMaxWaitTime;           /* Max Differential job wait time */
 384    utime_t IncMaxWaitTime;            /* Max Incremental job wait time */
 385    utime_t MaxStartDelay;             /* max start delay in seconds */
 386    utime_t RescheduleInterval;        /* Reschedule interval */
 387    utime_t JobRetention;              /* job retention period in seconds */
 388    uint32_t MaxConcurrentJobs;        /* Maximum concurrent jobs */
 389    int64_t spool_size;                /* Size of spool file for this job */
 390    int RescheduleTimes;               /* Number of times to reschedule job */
 391    bool RescheduleOnError;            /* Set to reschedule on error */
 392    bool PrefixLinks;                  /* prefix soft links with Where path */
 393    bool PruneJobs;                    /* Force pruning of Jobs */
 394    bool PruneFiles;                   /* Force pruning of Files */
 395    bool PruneVolumes;                 /* Force pruning of Volumes */
 396    bool SpoolAttributes;              /* Set to spool attributes in SD */
 397    bool spool_data;                   /* Set to spool data in SD */
 398    bool rerun_failed_levels;          /* Upgrade to rerun failed levels */
 399    bool PreferMountedVolumes;         /* Prefer vols mounted rather than new one */
 400    bool write_part_after_job;         /* Set to write part after job in SD */
 401    bool enabled;                      /* Set if job enabled */
 402    bool OptimizeJobScheduling;        /* Set if we should optimize Job scheduling */
 403    bool accurate;                     /* Set if it is an accurate backup job */
 404
 405    MSGS      *messages;               /* How and where to send messages */
 406    SCHED     *schedule;               /* When -- Automatic schedule */
 407    CLIENT    *client;                 /* Who to backup */
 408    FILESET   *fileset;                /* What to backup -- Fileset */
 409    alist     *storage;                /* Where is device -- list of Storage to be used */
 410    POOL      *pool;                   /* Where is media -- Media Pool */
 411    POOL      *full_pool;              /* Pool for Full backups */
 412    POOL      *inc_pool;               /* Pool for Incremental backups */
 413    POOL      *diff_pool;              /* Pool for Differental backups */
 414    char      *selection_pattern;
 415    int        selection_type;
 416    union {
 417       JOB       *verify_job;          /* Job name to verify */
 418    };
 419    JOB       *jobdefs;                /* Job defaults */
 420    alist     *run_cmds;               /* Run commands */
 421    uint32_t NumConcurrentJobs;        /* number of concurrent jobs running */
 422
 423    /* Methods */
 424    char *name() const;
 425 };
 426
 427 inline char *JOB::name() const { return hdr.name; }
 428
 429 #undef  MAX_FOPTS
 430 #define MAX_FOPTS 34
 431
 432 /* File options structure */
 433 struct FOPTS {
 434    char opts[MAX_FOPTS];              /* options string */
 435    alist regex;                       /* regex string(s) */
 436    alist regexdir;                    /* regex string(s) for directories */
 437    alist regexfile;                   /* regex string(s) for files */
 438    alist wild;                        /* wild card strings */
 439    alist wilddir;                     /* wild card strings for directories */
 440    alist wildfile;                    /* wild card strings for files */
 441    alist wildbase;                    /* wild card strings for files without '/' */
 442    alist base;                        /* list of base names */
 443    alist fstype;                      /* file system type limitation */
 444    alist drivetype;                   /* drive type limitation */
 445    char *reader;                      /* reader program */
 446    char *writer;                      /* writer program */
 447    char *plugin;                      /* plugin program */
 448 };
 449
 450
 451 /* This is either an include item or an exclude item */
 452 struct INCEXE {
 453    FOPTS *current_opts;               /* points to current options structure */
 454    FOPTS **opts_list;                 /* options list */
 455    int num_opts;                      /* number of options items */
 456    alist name_list;                   /* filename list -- holds char * */
 457    alist plugin_list;                 /* filename list for plugins */
 458 };
 459
 460 /*
 461  *   FileSet Resource
 462  *
 463  */
 464 class FILESET {
 465 public:
 466    RES   hdr;
 467
 468    bool new_include;                  /* Set if new include used */
 469    INCEXE **include_items;            /* array of incexe structures */
 470    int num_includes;                  /* number in array */
 471    INCEXE **exclude_items;
 472    int num_excludes;
 473    bool have_MD5;                     /* set if MD5 initialized */
 474    struct MD5Context md5c;            /* MD5 of include/exclude */
 475    char MD5[30];                      /* base 64 representation of MD5 */
 476    bool ignore_fs_changes;            /* Don't force Full if FS changed */
 477    bool enable_vss;                   /* Enable Volume Shadow Copy */
 478
 479    /* Methods */
 480    char *name() const;
 481 };
 482
 483 inline char *FILESET::name() const { return hdr.name; }
 484
 485 /*
 486  *   Schedule Resource
 487  *
 488  */
 489 class SCHED {
 490 public:
 491    RES   hdr;
 492
 493    RUN *run;
 494 };
 495
 496 /*
 497  *   Counter Resource
 498  */
 499 class COUNTER {
 500 public:
 501    RES   hdr;
 502
 503    int32_t  MinValue;                 /* Minimum value */
 504    int32_t  MaxValue;                 /* Maximum value */
 505    int32_t  CurrentValue;             /* Current value */
 506    COUNTER *WrapCounter;              /* Wrap counter name */
 507    CAT     *Catalog;                  /* Where to store */
 508    bool     created;                  /* Created in DB */
 509    /* Methods */
 510    char *name() const;
 511 };
 512
 513 inline char *COUNTER::name() const { return hdr.name; }
 514
 515 /*
 516  *   Pool Resource
 517  *
 518  */
 519 class POOL {
 520 public:
 521    RES   hdr;
 522
 523    char *pool_type;                   /* Pool type */
 524    char *label_format;                /* Label format string */
 525    char *cleaning_prefix;             /* Cleaning label prefix */
 526    int32_t LabelType;                 /* Bacula/ANSI/IBM label type */
 527    uint32_t max_volumes;              /* max number of volumes */
 528    utime_t VolRetention;              /* volume retention period in seconds */
 529    utime_t VolUseDuration;            /* duration volume can be used */
 530    uint32_t MaxVolJobs;               /* Maximum jobs on the Volume */
 531    uint32_t MaxVolFiles;              /* Maximum files on the Volume */
 532    uint64_t MaxVolBytes;              /* Maximum bytes on the Volume */
 533    utime_t MigrationTime;             /* Time to migrate to next pool */
 534    uint64_t MigrationHighBytes;       /* When migration starts */
 535    uint64_t MigrationLowBytes;        /* When migration stops */
 536    POOL  *NextPool;                   /* Next pool for migration */
 537    alist *storage;                    /* Where is device -- list of Storage to be used */
 538    bool  use_catalog;                 /* maintain catalog for media */
 539    bool  catalog_files;               /* maintain file entries in catalog */
 540    bool  use_volume_once;             /* write on volume only once */
 541    bool  purge_oldest_volume;         /* purge oldest volume */
 542    bool  recycle_oldest_volume;       /* attempt to recycle oldest volume */
 543    bool  recycle_current_volume;      /* attempt recycle of current volume */
 544    bool  AutoPrune;                   /* default for pool auto prune */
 545    bool  Recycle;                     /* default for media recycle yes/no */
 546    POOL  *RecyclePool;                /* RecyclePool destination when media is purged */
 547    alist *CopyPool;                   /* List of copy pools */
 548    CAT *Catalog;                      /* Catalog to be used */
 549    /* Methods */
 550    char *name() const;
 551 };
 552
 553 inline char *POOL::name() const { return hdr.name; }
 554
 555
 556
 557
 558 /* Define the Union of all the above
 559  * resource structure definitions.
 560  */
 561 union URES {
 562    DIRRES     res_dir;
 563    CONRES     res_con;
 564    CLIENT     res_client;
 565    STORE      res_store;
 566    CAT        res_cat;
 567    JOB        res_job;
 568    FILESET    res_fs;
 569    SCHED      res_sch;
 570    POOL       res_pool;
 571    MSGS       res_msgs;
 572    COUNTER    res_counter;
 573    DEVICE     res_dev;
 574    RES        hdr;
 575    RUNSCRIPT  res_runscript;
 576 };
 577
 578
 579
 580 /* Run structure contained in Schedule Resource */
 581 class RUN {
 582 public:
 583    RUN *next;                         /* points to next run record */
 584    int level;                         /* level override */
 585    int Priority;                      /* priority override */
 586    int job_type;
 587    bool spool_data;                   /* Data spooling override */
 588    bool spool_data_set;               /* Data spooling override given */
 589    bool write_part_after_job;         /* Write part after job override */
 590    bool write_part_after_job_set;     /* Write part after job override given */
 591
 592    POOL *pool;                        /* Pool override */
 593    POOL *full_pool;                   /* Pool override */
 594    POOL *inc_pool;                    /* Pool override */
 595    POOL *diff_pool;                   /* Pool override */
 596    STORE *storage;                    /* Storage override */
 597    MSGS *msgs;                        /* Messages override */
 598    char *since;
 599    int level_no;
 600    int minute;                        /* minute to run job */
 601    time_t last_run;                   /* last time run */
 602    time_t next_run;                   /* next time to run */
 603    char hour[nbytes_for_bits(24)];    /* bit set for each hour */
 604    char mday[nbytes_for_bits(31)];    /* bit set for each day of month */
 605    char month[nbytes_for_bits(12)];   /* bit set for each month */
 606    char wday[nbytes_for_bits(7)];     /* bit set for each day of the week */
 607    char wom[nbytes_for_bits(5)];      /* week of month */
 608    char woy[nbytes_for_bits(54)];     /* week of year */
 609 };
 610
 611 #define GetPoolResWithName(x) ((POOL *)GetResWithName(R_POOL, (x)))
 612 #define GetStoreResWithName(x) ((STORE *)GetResWithName(R_STORAGE, (x)))
 613 #define GetClientResWithName(x) ((CLIENT *)GetResWithName(R_CLIENT, (x)))
 614 #define GetJobResWithName(x) ((JOB *)GetResWithName(R_JOB, (x)))
 615 #define GetFileSetResWithName(x) ((FILESET *)GetResWithName(R_FILESET, (x)))
 616 #define GetCatalogResWithName(x) ((CAT *)GetResWithName(R_CATALOG, (x)))