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