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

   1 /*
   2  * Director specific configuration and defines
   3  *
   4  *     Kern Sibbald, Feb MM
   5  *
   6  *    Version $Id$
   7  */
   8 /*
   9    Copyright (C) 2000-2004 Kern Sibbald and John Walker
  10
  11    This program is free software; you can redistribute it and/or
  12    modify it under the terms of the GNU General Public License as
  13    published by the Free Software Foundation; either version 2 of
  14    the License, or (at your option) any later version.
  15
  16    This program is distributed in the hope that it will be useful,
  17    but WITHOUT ANY WARRANTY; without even the implied warranty of
  18    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  19    General Public License for more details.
  20
  21    You should have received a copy of the GNU General Public
  22    License along with this program; if not, write to the Free
  23    Software Foundation, Inc., 59 Temple Place - Suite 330, Boston,
  24    MA 02111-1307, USA.
  25
  26  */
  27
  28 /* NOTE:  #includes at the end of this file */
  29
  30 /*
  31  * Resource codes -- they must be sequential for indexing
  32  */
  33 enum {
  34    R_DIRECTOR = 1001,
  35    R_CLIENT,
  36    R_JOB,
  37    R_STORAGE,
  38    R_CATALOG,
  39    R_SCHEDULE,
  40    R_FILESET,
  41    R_POOL,
  42    R_MSGS,
  43    R_COUNTER,
  44    R_CONSOLE,
  45    R_JOBDEFS,
  46    R_FIRST = R_DIRECTOR,
  47    R_LAST  = R_JOBDEFS                /* keep this updated */
  48 };
  49
  50
  51 /*
  52  * Some resource attributes
  53  */
  54 enum {
  55    R_NAME = 1020,
  56    R_ADDRESS,
  57    R_PASSWORD,
  58    R_TYPE,
  59    R_BACKUP
  60 };
  61
  62
  63 /* Used for certain KeyWord tables */
  64 struct s_kw {
  65    const char *name;
  66    int token;
  67 };
  68
  69 /* Job Level keyword structure */
  70 struct s_jl {
  71    const char *level_name;                  /* level keyword */
  72    int  level;                        /* level */
  73    int  job_type;                     /* JobType permitting this level */
  74 };
  75
  76 /* Job Type keyword structure */
  77 struct s_jt {
  78    const char *type_name;
  79    int job_type;
  80 };
  81
  82 /* Definition of the contents of each Resource */
  83 /* Needed for forward references */
  84 struct SCHED;
  85 struct CLIENT;
  86 struct FILESET;
  87 struct POOL;
  88 struct RUN;
  89
  90 /*
  91  *   Director Resource
  92  *
  93  */
  94 struct DIRRES {
  95    RES   hdr;
  96    dlist *DIRaddrs;
  97    char *password;                    /* Password for UA access */
  98    int enable_ssl;                    /* Use SSL for UA */
  99    char *query_file;                  /* SQL query file */
 100    char *working_directory;           /* WorkingDirectory */
 101    char *pid_directory;               /* PidDirectory */
 102    char *subsys_directory;            /* SubsysDirectory */
 103    int require_ssl;                   /* Require SSL for all connections */
 104    MSGS *messages;                    /* Daemon message handler */
 105    uint32_t MaxConcurrentJobs;        /* Max concurrent jobs for whole director */
 106    utime_t FDConnectTimeout;          /* timeout for connect in seconds */
 107    utime_t SDConnectTimeout;          /* timeout in seconds */
 108 };
 109
 110
 111 /*
 112  * Console ACL positions
 113  */
 114 enum {
 115    Job_ACL = 0,
 116    Client_ACL,
 117    Storage_ACL,
 118    Schedule_ACL,
 119    Run_ACL,
 120    Pool_ACL,
 121    Command_ACL,
 122    FileSet_ACL,
 123    Catalog_ACL,
 124    Num_ACL                            /* keep last */
 125 };
 126
 127 /*
 128  *    Console Resource
 129  */
 130 struct CONRES {
 131    RES   hdr;
 132    char *password;                    /* UA server password */
 133    int enable_ssl;                    /* Use SSL */
 134    alist *ACL_lists[Num_ACL];         /* pointers to ACLs */
 135 };
 136
 137
 138 /*
 139  *   Catalog Resource
 140  *
 141  */
 142 struct CAT {
 143    RES   hdr;
 144
 145    int   db_port;                     /* Port -- not yet implemented */
 146    char *db_address;                  /* host name for remote access */
 147    char *db_socket;                   /* Socket for local access */
 148    char *db_password;
 149    char *db_user;
 150    char *db_name;
 151 };
 152
 153
 154 /*
 155  *   Client Resource
 156  *
 157  */
 158 struct CLIENT {
 159    RES   hdr;
 160
 161    int   FDport;                      /* Where File daemon listens */
 162    int   AutoPrune;                   /* Do automatic pruning? */
 163    utime_t FileRetention;             /* file retention period in seconds */
 164    utime_t JobRetention;              /* job retention period in seconds */
 165    char *address;
 166    char *password;
 167    CAT *catalog;                      /* Catalog resource */
 168    uint32_t MaxConcurrentJobs;        /* Maximume concurrent jobs */
 169    uint32_t NumConcurrentJobs;        /* number of concurrent jobs running */
 170    int enable_ssl;                    /* Use SSL */
 171 };
 172
 173 /*
 174  *   Store Resource
 175  *
 176  */
 177 struct STORE {
 178    RES   hdr;
 179
 180    int   SDport;                      /* port where Directors connect */
 181    int   SDDport;                     /* data port for File daemon */
 182    char *address;
 183    char *password;
 184    char *media_type;
 185    char *dev_name;
 186    int  autochanger;                  /* set if autochanger */
 187    uint32_t MaxConcurrentJobs;        /* Maximume concurrent jobs */
 188    uint32_t NumConcurrentJobs;        /* number of concurrent jobs running */
 189    int enable_ssl;                    /* Use SSL */
 190 };
 191
 192
 193 /*
 194  *   Job Resource
 195  */
 196 struct JOB {
 197    RES   hdr;
 198
 199    int   JobType;                     /* job type (backup, verify, restore */
 200    int   level;                       /* default backup/verify level */
 201    int   Priority;                    /* Job priority */
 202    int   RestoreJobId;                /* What -- JobId to restore */
 203    char *RestoreWhere;                /* Where on disk to restore -- directory */
 204    char *RestoreBootstrap;            /* Bootstrap file */
 205    char *RunBeforeJob;                /* Run program before Job */
 206    char *RunAfterJob;                 /* Run program after Job */
 207    char *RunAfterFailedJob;           /* Run program after Job that errs */
 208    char *ClientRunBeforeJob;          /* Run client program before Job */
 209    char *ClientRunAfterJob;           /* Run client program after Job */
 210    char *WriteBootstrap;              /* Where to write bootstrap Job updates */
 211    int   replace;                     /* How (overwrite, ..) */
 212    utime_t MaxRunTime;                /* max run time in seconds */
 213    utime_t MaxWaitTime;               /* max blocking time in seconds */
 214    utime_t MaxStartDelay;             /* max start delay in seconds */
 215    int PrefixLinks;                   /* prefix soft links with Where path */
 216    int PruneJobs;                     /* Force pruning of Jobs */
 217    int PruneFiles;                    /* Force pruning of Files */
 218    int PruneVolumes;                  /* Force pruning of Volumes */
 219    int SpoolAttributes;               /* Set to spool attributes in SD */
 220    int spool_data;                    /* Set to spool data in SD */
 221    uint32_t MaxConcurrentJobs;        /* Maximume concurrent jobs */
 222    int RescheduleOnError;             /* Set to reschedule on error */
 223    int RescheduleTimes;               /* Number of times to reschedule job */
 224    utime_t RescheduleInterval;        /* Reschedule interval */
 225    utime_t JobRetention;              /* job retention period in seconds */
 226
 227    MSGS      *messages;               /* How and where to send messages */
 228    SCHED     *schedule;               /* When -- Automatic schedule */
 229    CLIENT    *client;                 /* Who to backup */
 230    FILESET   *fileset;                /* What to backup -- Fileset */
 231    STORE     *storage;                /* Where is device -- Storage daemon */
 232    POOL      *pool;                   /* Where is media -- Media Pool */
 233    POOL      *full_pool;              /* Pool for Full backups */
 234    POOL      *inc_pool;               /* Pool for Incremental backups */
 235    POOL      *dif_pool;               /* Pool for Differental backups */
 236    JOB       *verify_job;             /* Job name to verify */
 237    JOB       *jobdefs;                /* Job defaults */
 238    uint32_t NumConcurrentJobs;        /* number of concurrent jobs running */
 239 };
 240
 241 #undef  MAX_FOPTS
 242 #define MAX_FOPTS 30
 243
 244 /* File options structure */
 245 struct FOPTS {
 246    char opts[MAX_FOPTS];              /* options string */
 247    alist regex;                       /* regex string(s) */
 248    alist wild;                        /* wild card strings */
 249    alist base;                        /* list of base names */
 250    char *reader;                      /* reader program */
 251    char *writer;                      /* writer program */
 252 };
 253
 254
 255 /* This is either an include item or an exclude item */
 256 struct INCEXE {
 257    FOPTS *current_opts;               /* points to current options structure */
 258    FOPTS **opts_list;                 /* options list */
 259    int num_opts;                      /* number of options items */
 260    alist name_list;                   /* filename list -- holds char * */
 261 };
 262
 263 /*
 264  *   FileSet Resource
 265  *
 266  */
 267 struct FILESET {
 268    RES   hdr;
 269
 270    bool new_include;                  /* Set if new include used */
 271    INCEXE **include_items;            /* array of incexe structures */
 272    int num_includes;                  /* number in array */
 273    INCEXE **exclude_items;
 274    int num_excludes;
 275    bool have_MD5;                     /* set if MD5 initialized */
 276    struct MD5Context md5c;            /* MD5 of include/exclude */
 277    char MD5[30];                      /* base 64 representation of MD5 */
 278    int ignore_fs_changes;             /* Don't force Full if FS changed */
 279 };
 280
 281
 282 /*
 283  *   Schedule Resource
 284  *
 285  */
 286 struct SCHED {
 287    RES   hdr;
 288
 289    RUN *run;
 290 };
 291
 292 /*
 293  *   Counter Resource
 294  */
 295 struct COUNTER {
 296    RES   hdr;
 297
 298    int32_t  MinValue;                 /* Minimum value */
 299    int32_t  MaxValue;                 /* Maximum value */
 300    int32_t  CurrentValue;             /* Current value */
 301    COUNTER *WrapCounter;              /* Wrap counter name */
 302    CAT     *Catalog;                  /* Where to store */
 303    bool     created;                  /* Created in DB */
 304 };
 305
 306 /*
 307  *   Pool Resource
 308  *
 309  */
 310 struct POOL {
 311    RES   hdr;
 312
 313    char *pool_type;                   /* Pool type */
 314    char *label_format;                /* Label format string */
 315    char *cleaning_prefix;             /* Cleaning label prefix */
 316    int   use_catalog;                 /* maintain catalog for media */
 317    int   catalog_files;               /* maintain file entries in catalog */
 318    int   use_volume_once;             /* write on volume only once */
 319    int   accept_any_volume;           /* accept any volume */
 320    int   purge_oldest_volume;         /* purge oldest volume */
 321    int   recycle_oldest_volume;       /* attempt to recycle oldest volume */
 322    int   recycle_current_volume;      /* attempt recycle of current volume */
 323    uint32_t max_volumes;              /* max number of volumes */
 324    utime_t VolRetention;              /* volume retention period in seconds */
 325    utime_t VolUseDuration;            /* duration volume can be used */
 326    uint32_t MaxVolJobs;               /* Maximum jobs on the Volume */
 327    uint32_t MaxVolFiles;              /* Maximum files on the Volume */
 328    uint64_t MaxVolBytes;              /* Maximum bytes on the Volume */
 329    int   AutoPrune;                   /* default for pool auto prune */
 330    int   Recycle;                     /* default for media recycle yes/no */
 331 };
 332
 333
 334 /* Define the Union of all the above
 335  * resource structure definitions.
 336  */
 337 union URES {
 338    DIRRES     res_dir;
 339    CONRES     res_con;
 340    CLIENT     res_client;
 341    STORE      res_store;
 342    CAT        res_cat;
 343    JOB        res_job;
 344    FILESET    res_fs;
 345    SCHED      res_sch;
 346    POOL       res_pool;
 347    MSGS       res_msgs;
 348    COUNTER    res_counter;
 349    RES        hdr;
 350 };
 351
 352
 353
 354 /* Run structure contained in Schedule Resource */
 355 struct RUN {
 356    RUN *next;                         /* points to next run record */
 357    int level;                         /* level override */
 358    int Priority;                      /* priority override */
 359    int job_type;
 360    bool spool_data;                   /* Data spooling override */
 361    bool spool_data_set;               /* Data spooling override given */
 362    POOL *pool;                        /* Pool override */
 363    POOL *full_pool;                   /* Pool override */
 364    POOL *inc_pool;                    /* Pool override */
 365    POOL *dif_pool;                    /* Pool override */
 366    STORE *storage;                    /* Storage override */
 367    MSGS *msgs;                        /* Messages override */
 368    char *since;
 369    int level_no;
 370    int minute;                        /* minute to run job */
 371    time_t last_run;                   /* last time run */
 372    time_t next_run;                   /* next time to run */
 373    char hour[nbytes_for_bits(24)];    /* bit set for each hour */
 374    char mday[nbytes_for_bits(31)];    /* bit set for each day of month */
 375    char month[nbytes_for_bits(12)];   /* bit set for each month */
 376    char wday[nbytes_for_bits(7)];     /* bit set for each day of the week */
 377    char wom[nbytes_for_bits(5)];      /* week of month */
 378    char woy[nbytes_for_bits(54)];     /* week of year */
 379 };