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, 2001, 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
  47 #define R_LAST                        R_COUNTER
  48
  49 /*
  50  * Some resource attributes
  51  */
  52 #define R_NAME                        1020
  53 #define R_ADDRESS                     1021
  54 #define R_PASSWORD                    1022
  55 #define R_TYPE                        1023
  56 #define R_BACKUP                      1024
  57
  58
  59 /* Used for certain KeyWord tables */
  60 struct s_kw {
  61    char *name;
  62    int token;
  63 };
  64
  65 /* Job Level keyword structure */
  66 struct s_jl {
  67    char *level_name;                  /* level keyword */
  68    int  level;                        /* level */
  69    int  job_type;                     /* JobType permitting this level */
  70 };
  71
  72 /* Job Type keyword structure */
  73 struct s_jt {
  74    char *type_name;
  75    int job_type;
  76 };
  77
  78 /* Definition of the contents of each Resource */
  79
  80 /*
  81  *   Director Resource
  82  *
  83  */
  84 struct s_res_dir {
  85    RES   hdr;
  86    int   DIRport;                     /* where we listen -- UA port server port */
  87    char *password;                    /* Password for UA access */
  88    char *query_file;                  /* SQL query file */
  89    char *working_directory;           /* WorkingDirectory */
  90    char *pid_directory;               /* PidDirectory */
  91    char *subsys_directory;            /* SubsysDirectory */
  92    struct s_res_msgs *messages;       /* Daemon message handler */
  93    int   MaxConcurrentJobs;
  94    btime_t FDConnectTimeout;          /* timeout for connect in seconds */
  95    btime_t SDConnectTimeout;          /* timeout in seconds */
  96 };
  97 typedef struct s_res_dir DIRRES;
  98
  99 /*
 100  *   Client Resource
 101  *
 102  */
 103 struct s_res_client {
 104    RES   hdr;
 105
 106    int   FDport;                      /* Where File daemon listens */
 107    int   AutoPrune;                   /* Do automatic pruning? */
 108    btime_t FileRetention;             /* file retention period in seconds */
 109    btime_t JobRetention;              /* job retention period in seconds */
 110    char *address;
 111    char *password;
 112    struct s_res_cat    *catalog;       /* Catalog resource */
 113 };
 114 typedef struct s_res_client CLIENT;
 115
 116 /*
 117  *   Store Resource
 118  *
 119  */
 120 struct s_res_store {
 121    RES   hdr;
 122
 123    int   SDport;                      /* port where Directors connect */
 124    int   SDDport;                     /* data port for File daemon */
 125    char *address;
 126    char *password;
 127    char *media_type;
 128    char *dev_name;
 129 };
 130 typedef struct s_res_store STORE;
 131
 132 /*
 133  *   Catalog Resource
 134  *
 135  */
 136 struct s_res_cat {
 137    RES   hdr;
 138
 139    int   DBport;                      /* Port -- not yet implemented */
 140    char *address;
 141    char *db_password;
 142    char *db_user;
 143    char *db_name;
 144 };
 145 typedef struct s_res_cat CAT;
 146
 147 /*
 148  *   Job Resource
 149  *
 150  */
 151 struct s_res_job {
 152    RES   hdr;
 153
 154    int   JobType;                     /* job type (backup, verify, restore */
 155    int   level;                       /* default backup/verify level */
 156    int   RestoreJobId;                /* What -- JobId to restore */
 157    char *RestoreWhere;                /* Where on disk to restore -- directory */
 158    char *RestoreBootstrap;            /* Bootstrap file */
 159    int   RestoreOptions;              /* How (overwrite, ..) */
 160    btime_t MaxRunTime;                /* max run time in seconds */
 161    btime_t MaxStartDelay;             /* max start delay in seconds */
 162    int PruneJobs;                     /* Force pruning of Jobs */
 163    int PruneFiles;                    /* Force pruning of Files */
 164    int PruneVolumes;                  /* Force pruning of Volumes */
 165
 166    struct s_res_msgs   *messages;     /* How and where to send messages */
 167    struct s_res_sch    *schedule;     /* When -- Automatic schedule */
 168    struct s_res_client *client;       /* Who to backup */
 169    struct s_res_fs     *fs;           /* What to backup -- Fileset */
 170    struct s_res_store  *storage;      /* Where is device -- Storage daemon */
 171    struct s_res_pool   *pool;         /* Where is media -- Media Pool */
 172 };
 173 typedef struct s_res_job JOB;
 174
 175 /*
 176  *   FileSet Resource
 177  *
 178  */
 179 struct s_res_fs {
 180    RES   hdr;
 181
 182    char **include_array;
 183    int num_includes;
 184    int include_size;
 185    char **exclude_array;
 186    int num_excludes;
 187    int exclude_size;
 188    int have_MD5;                      /* set if MD5 initialized */
 189    struct MD5Context md5c;            /* MD5 of include/exclude */
 190 };
 191 typedef struct s_res_fs FILESET;
 192
 193
 194 /*
 195  *   Schedule Resource
 196  *
 197  */
 198 struct s_res_sch {
 199    RES   hdr;
 200
 201    struct s_run *run;
 202 };
 203 typedef struct s_res_sch SCHED;
 204
 205 /*
 206  *   Group Resource (not used)
 207  *
 208  */
 209 struct s_res_group {
 210    RES   hdr;
 211 };
 212 typedef struct s_res_group GROUP;
 213
 214 /*
 215  *   Counter Resource
 216  */
 217 struct s_res_counter {
 218    RES   hdr;
 219
 220    int32_t MinValue;                  /* Minimum value */
 221    int32_t MaxValue;                  /* Maximum value */
 222    int     Global;                    /* global/local */
 223    char  *WrapCounter;                /* Wrap counter name */
 224 };
 225 typedef struct s_res_counter COUNTER;
 226
 227 /*
 228  *   Pool Resource
 229  *
 230  */
 231 struct s_res_pool {
 232    RES   hdr;
 233
 234    struct s_res_counter counter;      /* Counter resources */
 235    char *pool_type;                   /* Pool type */
 236    char *label_format;                /* Label format string */
 237    int   use_catalog;                 /* maintain catalog for media */
 238    int   catalog_files;               /* maintain file entries in catalog */
 239    int   use_volume_once;             /* write on volume only once */
 240    int   accept_any_volume;           /* accept any volume */
 241    int   max_volumes;                 /* max number of volumes */
 242    btime_t VolRetention;              /* volume retention period in seconds */
 243    int   AutoPrune;                   /* default for pool auto prune */
 244    int   Recycle;                     /* default for media recycle yes/no */
 245 };
 246 typedef struct s_res_pool POOL;
 247
 248
 249 /* Define the Union of all the above
 250  * resource structure definitions.
 251  */
 252 union u_res {
 253    struct s_res_dir     res_dir;
 254    struct s_res_client  res_client;
 255    struct s_res_store   res_store;
 256    struct s_res_cat     res_cat;
 257    struct s_res_job     res_job;
 258    struct s_res_fs      res_fs;
 259    struct s_res_sch     res_sch;
 260    struct s_res_group   res_group;
 261    struct s_res_pool    res_pool;
 262    struct s_res_msgs    res_msgs;
 263    struct s_res_counter res_counter;
 264    RES hdr;
 265 };
 266
 267 typedef union u_res URES;
 268
 269
 270 /* Run structure contained in Schedule Resource */
 271 struct s_run {
 272    struct s_run *next;                /* points to next run record */
 273    int level;                         /* level override */
 274    int job_type;
 275    POOL *pool;                        /* Pool override */
 276    STORE *storage;                    /* Storage override */
 277    MSGS *msgs;                        /* Messages override */
 278    char *since;
 279    int level_no;
 280    int minute;                        /* minute to run job */
 281    time_t last_run;                   /* last time run */
 282    time_t next_run;                   /* next time to run */
 283    char hour[nbytes_for_bits(24)];    /* bit set for each hour */
 284    char mday[nbytes_for_bits(31)];    /* bit set for each day of month */
 285    char month[nbytes_for_bits(12)];   /* bit set for each month */
 286    char wday[nbytes_for_bits(7)];     /* bit set for each day of the week */
 287 };
 288 typedef struct s_run RUN;