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-2003 2002 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 };
  47
  48 #define R_FIRST  R_DIRECTOR
  49 #define R_LAST   R_JOBDEFS
  50
  51 /*
  52  * Some resource attributes
  53  */
  54 #define R_NAME                1020
  55 #define R_ADDRESS             1021
  56 #define R_PASSWORD            1022
  57 #define R_TYPE                1023
  58 #define R_BACKUP              1024
  59
  60
  61 /* Used for certain KeyWord tables */
  62 struct s_kw {
  63    char *name;
  64    int token;
  65 };
  66
  67 /* Job Level keyword structure */
  68 struct s_jl {
  69    char *level_name;                  /* level keyword */
  70    int  level;                        /* level */
  71    int  job_type;                     /* JobType permitting this level */
  72 };
  73
  74 /* Job Type keyword structure */
  75 struct s_jt {
  76    char *type_name;
  77    int job_type;
  78 };
  79
  80 /* Definition of the contents of each Resource */
  81 /* Needed for forward references */
  82 struct SCHED;
  83 struct CLIENT;
  84 struct FILESET;
  85 struct POOL;
  86 struct RUN;
  87
  88 /*
  89  *   Director Resource
  90  *
  91  */
  92 struct DIRRES {
  93    RES   hdr;
  94    int   DIRport;                     /* where we listen -- UA port server port */
  95    char *DIRaddr;                     /* bind address */
  96    char *password;                    /* Password for UA access */
  97    int enable_ssl;                    /* Use SSL for UA */
  98    char *query_file;                  /* SQL query file */
  99    char *working_directory;           /* WorkingDirectory */
 100    char *pid_directory;               /* PidDirectory */
 101    char *subsys_directory;            /* SubsysDirectory */
 102    int require_ssl;                   /* Require SSL for all connections */
 103    MSGS *messages;                    /* Daemon message handler */
 104    uint32_t MaxConcurrentJobs;        /* Max concurrent jobs for whole director */
 105    utime_t FDConnectTimeout;          /* timeout for connect in seconds */
 106    utime_t SDConnectTimeout;          /* timeout in seconds */
 107 };
 108
 109
 110 /*
 111  * Console ACL positions
 112  */
 113 enum {
 114    Job_ACL = 0,
 115    Client_ACL,
 116    Storage_ACL,
 117    Schedule_ACL,
 118    Run_ACL,
 119    Pool_ACL,
 120    Command_ACL,
 121    FileSet_ACL,
 122    Catalog_ACL,
 123    Num_ACL                            /* keep last */
 124 };
 125
 126 /*
 127  *    Console Resource
 128  */
 129 struct CONRES {
 130    RES   hdr;
 131    char *password;                    /* UA server password */
 132    int enable_ssl;                    /* Use SSL */
 133    alist *ACL_lists[Num_ACL];         /* pointers to ACLs */
 134 };
 135
 136
 137 /*
 138  *   Catalog Resource
 139  *
 140  */
 141 struct CAT {
 142    RES   hdr;
 143
 144    int   db_port;                     /* Port -- not yet implemented */
 145    char *db_address;                  /* host name for remote access */
 146    char *db_socket;                   /* Socket for local access */
 147    char *db_password;
 148    char *db_user;
 149    char *db_name;
 150 };
 151
 152
 153 /*
 154  *   Client Resource
 155  *
 156  */
 157 struct CLIENT {
 158    RES   hdr;
 159
 160    int   FDport;                      /* Where File daemon listens */
 161    int   AutoPrune;                   /* Do automatic pruning? */
 162    utime_t FileRetention;             /* file retention period in seconds */
 163    utime_t JobRetention;              /* job retention period in seconds */
 164    char *address;
 165    char *password;
 166    CAT *catalog;                      /* Catalog resource */
 167    uint32_t MaxConcurrentJobs;        /* Maximume concurrent jobs */
 168    uint32_t NumConcurrentJobs;        /* number of concurrent jobs running */
 169    int enable_ssl;                    /* Use SSL */
 170 };
 171
 172 /*
 173  *   Store Resource
 174  *
 175  */
 176 struct STORE {
 177    RES   hdr;
 178
 179    int   SDport;                      /* port where Directors connect */
 180    int   SDDport;                     /* data port for File daemon */
 181    char *address;
 182    char *password;
 183    char *media_type;
 184    char *dev_name;
 185    int  autochanger;                  /* set if autochanger */
 186    uint32_t MaxConcurrentJobs;        /* Maximume concurrent jobs */
 187    uint32_t NumConcurrentJobs;        /* number of concurrent jobs running */
 188    int enable_ssl;                    /* Use SSL */
 189 };
 190
 191
 192 /*
 193  *   Job Resource
 194  */
 195 struct JOB {
 196    RES   hdr;
 197
 198    int   JobType;                     /* job type (backup, verify, restore */
 199    int   level;                       /* default backup/verify level */
 200    int   Priority;                    /* Job priority */
 201    int   RestoreJobId;                /* What -- JobId to restore */
 202    char *RestoreWhere;                /* Where on disk to restore -- directory */
 203    char *RestoreBootstrap;            /* Bootstrap file */
 204    char *RunBeforeJob;                /* Run program before Job */
 205    char *RunAfterJob;                 /* Run program after Job */
 206    char *RunAfterFailedJob;           /* Run program after Job that errs */
 207    char *ClientRunBeforeJob;          /* Run client program before Job */
 208    char *ClientRunAfterJob;           /* Run client program after Job */
 209    char *WriteBootstrap;              /* Where to write bootstrap Job updates */
 210    int   replace;                     /* How (overwrite, ..) */
 211    utime_t MaxRunTime;                /* max run time in seconds */
 212    utime_t MaxWaitTime;               /* max blocking time in seconds */
 213    utime_t MaxStartDelay;             /* max start delay in seconds */
 214    int PrefixLinks;                   /* prefix soft links with Where path */
 215    int PruneJobs;                     /* Force pruning of Jobs */
 216    int PruneFiles;                    /* Force pruning of Files */
 217    int PruneVolumes;                  /* Force pruning of Volumes */
 218    int SpoolAttributes;               /* Set to spool attributes in SD */
 219    uint32_t MaxConcurrentJobs;        /* Maximume concurrent jobs */
 220    int RescheduleOnError;             /* Set to reschedule on error */
 221    int RescheduleTimes;               /* Number of times to reschedule job */
 222    utime_t RescheduleInterval;        /* Reschedule interval */
 223    utime_t JobRetention;              /* job retention period in seconds */
 224
 225    MSGS      *messages;               /* How and where to send messages */
 226    SCHED     *schedule;               /* When -- Automatic schedule */
 227    CLIENT    *client;                 /* Who to backup */
 228    FILESET   *fileset;                /* What to backup -- Fileset */
 229    STORE     *storage;                /* Where is device -- Storage daemon */
 230    POOL      *pool;                   /* Where is media -- Media Pool */
 231    JOB       *verify_job;             /* Job name to verify */
 232    JOB       *jobdefs;                /* Job defaults */
 233    uint32_t NumConcurrentJobs;        /* number of concurrent jobs running */
 234 };
 235
 236 #define MAX_FOPTS 30
 237
 238 /* File options structure */
 239 struct FOPTS {
 240    char opts[MAX_FOPTS];              /* options string */
 241    alist match;                       /* match string(s) */
 242    alist base_list;                   /* list of base names */
 243 };
 244
 245
 246 /* This is either an include item or an exclude item */
 247 struct INCEXE {
 248    FOPTS *current_opts;               /* points to current options structure */
 249    FOPTS **opts_list;                 /* options list */
 250    int num_opts;                      /* number of options items */
 251    alist name_list;                   /* filename list -- holds char * */
 252 };
 253
 254 /*
 255  *   FileSet Resource
 256  *
 257  */
 258 struct FILESET {
 259    RES   hdr;
 260
 261    int new_include;                   /* Set if new include used */
 262    INCEXE **include_items;            /* array of incexe structures */
 263    int num_includes;                  /* number in array */
 264    INCEXE **exclude_items;
 265    int num_excludes;
 266    int have_MD5;                      /* set if MD5 initialized */
 267    struct MD5Context md5c;            /* MD5 of include/exclude */
 268    char MD5[30];                      /* base 64 representation of MD5 */
 269 };
 270
 271
 272 /*
 273  *   Schedule Resource
 274  *
 275  */
 276 struct SCHED {
 277    RES   hdr;
 278
 279    RUN *run;
 280 };
 281
 282 /*
 283  *   Counter Resource
 284  */
 285 struct COUNTER {
 286    RES   hdr;
 287
 288    int32_t  MinValue;                 /* Minimum value */
 289    int32_t  MaxValue;                 /* Maximum value */
 290    int32_t  CurrentValue;             /* Current value */
 291    COUNTER *WrapCounter;              /* Wrap counter name */
 292    CAT     *Catalog;                  /* Where to store */
 293    bool     created;                  /* Created in DB */
 294 };
 295
 296 /*
 297  *   Pool Resource
 298  *
 299  */
 300 struct POOL {
 301    RES   hdr;
 302
 303    char *pool_type;                   /* Pool type */
 304    char *label_format;                /* Label format string */
 305    char *cleaning_prefix;             /* Cleaning label prefix */
 306    int   use_catalog;                 /* maintain catalog for media */
 307    int   catalog_files;               /* maintain file entries in catalog */
 308    int   use_volume_once;             /* write on volume only once */
 309    int   accept_any_volume;           /* accept any volume */
 310    int   purge_oldest_volume;         /* purge oldest volume */
 311    int   recycle_oldest_volume;       /* attempt to recycle oldest volume */
 312    int   recycle_current_volume;      /* attempt recycle of current volume */
 313    uint32_t max_volumes;              /* max number of volumes */
 314    utime_t VolRetention;              /* volume retention period in seconds */
 315    utime_t VolUseDuration;            /* duration volume can be used */
 316    uint32_t MaxVolJobs;               /* Maximum jobs on the Volume */
 317    uint32_t MaxVolFiles;              /* Maximum files on the Volume */
 318    uint64_t MaxVolBytes;              /* Maximum bytes on the Volume */
 319    int   AutoPrune;                   /* default for pool auto prune */
 320    int   Recycle;                     /* default for media recycle yes/no */
 321 };
 322
 323
 324 /* Define the Union of all the above
 325  * resource structure definitions.
 326  */
 327 union URES {
 328    DIRRES     res_dir;
 329    CONRES     res_con;
 330    CLIENT     res_client;
 331    STORE      res_store;
 332    CAT        res_cat;
 333    JOB        res_job;
 334    FILESET    res_fs;
 335    SCHED      res_sch;
 336    POOL       res_pool;
 337    MSGS       res_msgs;
 338    COUNTER    res_counter;
 339    RES        hdr;
 340 };
 341
 342
 343
 344 /* Run structure contained in Schedule Resource */
 345 struct RUN {
 346    RUN *next;                         /* points to next run record */
 347    int level;                         /* level override */
 348    int Priority;                      /* priority override */
 349    int job_type;
 350    POOL *pool;                        /* Pool override */
 351    STORE *storage;                    /* Storage override */
 352    MSGS *msgs;                        /* Messages override */
 353    char *since;
 354    int level_no;
 355    int minute;                        /* minute to run job */
 356    time_t last_run;                   /* last time run */
 357    time_t next_run;                   /* next time to run */
 358    char hour[nbytes_for_bits(24)];    /* bit set for each hour */
 359    char mday[nbytes_for_bits(31)];    /* bit set for each day of month */
 360    char month[nbytes_for_bits(12)];   /* bit set for each month */
 361    char wday[nbytes_for_bits(7)];     /* bit set for each day of the week */
 362    char wom[nbytes_for_bits(5)];      /* week of month */
 363    char woy[nbytes_for_bits(54)];     /* week of year */
 364 };