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