]> git.sur5r.net Git - bacula/bacula/blob - bacula/src/dird/dird_conf.h
Switch from GPLv2 to AGPLv3
[bacula/bacula] / bacula / src / dird / dird_conf.h
1 /*
2    Bacula® - The Network Backup Solution
3
4    Copyright (C) 2000-2010 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 three of the GNU Affero 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 Affero 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 Kern Sibbald.
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  */
34
35 /* NOTE:  #includes at the end of this file */
36
37 /*
38  * Resource codes -- they must be sequential for indexing
39  */
40 enum {
41    R_DIRECTOR = 1001,
42    R_CLIENT,
43    R_JOB,
44    R_STORAGE,
45    R_CATALOG,
46    R_SCHEDULE,
47    R_FILESET,
48    R_POOL,
49    R_MSGS,
50    R_COUNTER,
51    R_CONSOLE,
52    R_JOBDEFS,
53    R_DEVICE,
54    R_FIRST = R_DIRECTOR,
55    R_LAST  = R_DEVICE                 /* keep this updated */
56 };
57
58
59 /*
60  * Some resource attributes
61  */
62 enum {
63    R_NAME = 1020,
64    R_ADDRESS,
65    R_PASSWORD,
66    R_TYPE,
67    R_BACKUP
68 };
69
70
71 /* Used for certain KeyWord tables */
72 struct s_kw {
73    const char *name;
74    uint32_t token;
75 };
76
77 /* Job Level keyword structure */
78 struct s_jl {
79    const char *level_name;                 /* level keyword */
80    int32_t  level;                         /* level */
81    int32_t  job_type;                      /* JobType permitting this level */
82 };
83
84 /* Job Type keyword structure */
85 struct s_jt {
86    const char *type_name;
87    int32_t job_type;
88 };
89
90 /* Definition of the contents of each Resource */
91 /* Needed for forward references */
92 class SCHED;
93 class CLIENT;
94 class FILESET;
95 class POOL;
96 class RUN;
97 class DEVICE;
98 class RUNSCRIPT;
99
100 /*
101  *   Director Resource
102  *
103  */
104 class DIRRES {
105 public:
106    RES   hdr;
107    dlist *DIRaddrs;
108    dlist *DIRsrc_addr;                /* address to source connections from */
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    const char *plugin_directory;      /* Plugin Directory */
114    char *pid_directory;               /* PidDirectory */
115    char *subsys_directory;            /* SubsysDirectory */
116    MSGS *messages;                    /* Daemon message handler */
117    uint32_t MaxConcurrentJobs;        /* Max concurrent jobs for whole director */
118    uint32_t MaxConsoleConnect;        /* Max concurrent console session */
119    utime_t FDConnectTimeout;          /* timeout for connect in seconds */
120    utime_t SDConnectTimeout;          /* timeout in seconds */
121    utime_t heartbeat_interval;        /* Interval to send heartbeats */
122    char *tls_ca_certfile;             /* TLS CA Certificate File */
123    char *tls_ca_certdir;              /* TLS CA Certificate Directory */
124    char *tls_certfile;                /* TLS Server Certificate File */
125    char *tls_keyfile;                 /* TLS Server Key File */
126    char *tls_dhfile;                  /* TLS Diffie-Hellman Parameters */
127    alist *tls_allowed_cns;            /* TLS Allowed Clients */
128    TLS_CONTEXT *tls_ctx;              /* Shared TLS Context */
129    utime_t stats_retention;           /* Stats retention period in seconds */
130    bool tls_authenticate;             /* Authenticated with TLS */
131    bool tls_enable;                   /* Enable TLS */
132    bool tls_require;                  /* Require TLS */
133    bool tls_verify_peer;              /* TLS Verify Client Certificate */
134    char *verid;                       /* Custom Id to print in version command */
135    /* Methods */
136    char *name() const;
137 };
138
139 inline char *DIRRES::name() const { return hdr.name; }
140
141 /*
142  * Device Resource
143  *  This resource is a bit different from the other resources
144  *  because it is not defined in the Director 
145  *  by DEVICE { ... }, but rather by a "reference" such as
146  *  DEVICE = xxx; Then when the Director connects to the
147  *  SD, it requests the information about the device.
148  */
149 class DEVICE {
150 public:
151    RES hdr;
152
153    bool found;                        /* found with SD */
154    int32_t num_writers;               /* number of writers */
155    int32_t max_writers;               /* = 1 for files */
156    int32_t reserved;                  /* number of reserves */
157    int32_t num_drives;                /* for autochanger */
158    bool autochanger;                  /* set if device is autochanger */
159    bool open;                         /* drive open */
160    bool append;                       /* in append mode */
161    bool read;                         /* in read mode */
162    bool labeled;                      /* Volume name valid */
163    bool offline;                      /* not available */
164    bool autoselect;                   /* can be selected via autochanger */
165    uint32_t PoolId;
166    char ChangerName[MAX_NAME_LENGTH];
167    char VolumeName[MAX_NAME_LENGTH];
168    char MediaType[MAX_NAME_LENGTH];
169
170    /* Methods */
171    char *name() const;
172 };
173
174 inline char *DEVICE::name() const { return hdr.name; }
175
176 /*
177  * Console ACL positions
178  */
179 enum {
180    Job_ACL = 0,
181    Client_ACL,
182    Storage_ACL,
183    Schedule_ACL,
184    Run_ACL,
185    Pool_ACL,
186    Command_ACL,
187    FileSet_ACL,
188    Catalog_ACL,
189    Where_ACL,
190    PluginOptions_ACL,
191    Num_ACL                            /* keep last */
192 };
193
194 /*
195  *    Console Resource
196  */
197 class CONRES {
198 public:
199    RES   hdr;
200    char *password;                    /* UA server password */
201    alist *ACL_lists[Num_ACL];         /* pointers to ACLs */
202    char *tls_ca_certfile;             /* TLS CA Certificate File */
203    char *tls_ca_certdir;              /* TLS CA Certificate Directory */
204    char *tls_certfile;                /* TLS Server Certificate File */
205    char *tls_keyfile;                 /* TLS Server Key File */
206    char *tls_dhfile;                  /* TLS Diffie-Hellman Parameters */
207    alist *tls_allowed_cns;            /* TLS Allowed Clients */
208    TLS_CONTEXT *tls_ctx;              /* Shared TLS Context */
209    bool tls_authenticate;             /* Authenticated with TLS */
210    bool tls_enable;                   /* Enable TLS */
211    bool tls_require;                  /* Require TLS */
212    bool tls_verify_peer;              /* TLS Verify Client Certificate */
213
214    /* Methods */
215    char *name() const;
216 };
217
218 inline char *CONRES::name() const { return hdr.name; }
219
220
221 /*
222  *   Catalog Resource
223  *
224  */
225 class CAT {
226 public:
227    RES   hdr;
228
229    uint32_t db_port;                  /* Port */
230    char *db_address;                  /* host name for remote access */
231    char *db_socket;                   /* Socket for local access */
232    char *db_password;
233    char *db_user;
234    char *db_name;
235    char *db_driver;                   /* Select appropriate driver */
236    uint32_t mult_db_connections;      /* set if multiple connections wanted */
237
238    /* Methods */
239    char *name() const;
240    char *display(POOLMEM *dst);       /* Get catalog information */
241 };
242
243 inline char *CAT::name() const { return hdr.name; }
244
245
246 /*
247  *   Client Resource
248  *
249  */
250 class CLIENT {
251 public:
252    RES   hdr;
253
254    uint32_t FDport;                   /* Where File daemon listens */
255    utime_t FileRetention;             /* file retention period in seconds */
256    utime_t JobRetention;              /* job retention period in seconds */
257    utime_t heartbeat_interval;        /* Interval to send heartbeats */
258    char *address;
259    char *password;
260    CAT *catalog;                      /* Catalog resource */
261    int32_t MaxConcurrentJobs;         /* Maximum concurrent jobs */
262    int32_t NumConcurrentJobs;         /* number of concurrent jobs running */
263    char *tls_ca_certfile;             /* TLS CA Certificate File */
264    char *tls_ca_certdir;              /* TLS CA Certificate Directory */
265    char *tls_certfile;                /* TLS Client Certificate File */
266    char *tls_keyfile;                 /* TLS Client Key File */
267    alist *tls_allowed_cns;            /* TLS Allowed Clients */
268    TLS_CONTEXT *tls_ctx;              /* Shared TLS Context */
269    bool tls_authenticate;             /* Authenticated with TLS */
270    bool tls_enable;                   /* Enable TLS */
271    bool tls_require;                  /* Require TLS */
272    bool AutoPrune;                    /* Do automatic pruning? */
273
274    /* Methods */
275    char *name() const;
276 };
277
278 inline char *CLIENT::name() const { return hdr.name; }
279
280
281 /*
282  *   Store Resource
283  *
284  */
285 class STORE {
286 public:
287    RES   hdr;
288
289    uint32_t SDport;                   /* port where Directors connect */
290    uint32_t SDDport;                  /* data port for File daemon */
291    char *address;
292    char *password;
293    char *media_type;
294    alist *device;                     /* Alternate devices for this Storage */
295    int32_t MaxConcurrentJobs;         /* Maximum concurrent jobs */
296    int32_t NumConcurrentJobs;         /* number of concurrent jobs running */
297    int32_t NumConcurrentReadJobs;     /* number of jobs reading */
298    char *tls_ca_certfile;             /* TLS CA Certificate File */
299    char *tls_ca_certdir;              /* TLS CA Certificate Directory */
300    char *tls_certfile;                /* TLS Client Certificate File */
301    char *tls_keyfile;                 /* TLS Client Key File */
302    TLS_CONTEXT *tls_ctx;              /* Shared TLS Context */
303    bool tls_authenticate;             /* Authenticated with TLS */
304    bool tls_enable;                   /* Enable TLS */
305    bool tls_require;                  /* Require TLS */
306    bool enabled;                      /* Set if device is enabled */
307    bool  autochanger;                 /* set if autochanger */
308    bool AllowCompress;                /* set if this Storage should allow jobs to enable compression */
309    int64_t StorageId;                 /* Set from Storage DB record */
310    utime_t heartbeat_interval;        /* Interval to send heartbeats */
311    uint32_t drives;                   /* number of drives in autochanger */
312
313    /* Methods */
314    char *dev_name() const;
315    char *name() const;
316 };
317
318 inline char *STORE::dev_name() const
319
320    DEVICE *dev = (DEVICE *)device->first();
321    return dev->hdr.name;
322 }
323
324 inline char *STORE::name() const { return hdr.name; }
325
326 /*
327  * This is a sort of "unified" store that has both the
328  *  storage pointer and the text of where the pointer was
329  *  found.
330  */
331 class USTORE {
332 public:
333    STORE *store;
334    POOLMEM *store_source;
335
336    /* Methods */
337    USTORE() { store = NULL; store_source = get_pool_memory(PM_MESSAGE); 
338               *store_source = 0; };
339    ~USTORE() { destroy(); }   
340    void set_source(const char *where);
341    void destroy();
342 };
343
344 inline void USTORE::destroy()
345 {
346    if (store_source) {
347       free_pool_memory(store_source);
348       store_source = NULL;
349    }
350 }
351
352
353 inline void USTORE::set_source(const char *where)
354 {
355    if (!store_source) {
356       store_source = get_pool_memory(PM_MESSAGE);
357    }
358    pm_strcpy(store_source, where);
359 }
360
361
362 /*
363  *   Job Resource
364  */
365 class JOB {
366 public:
367    RES   hdr;
368
369    uint32_t   JobType;                /* job type (backup, verify, restore */
370    uint32_t   JobLevel;               /* default backup/verify level */
371    int32_t   Priority;                /* Job priority */
372    uint32_t   RestoreJobId;           /* What -- JobId to restore */
373    int32_t   RescheduleTimes;         /* Number of times to reschedule job */
374    uint32_t   replace;                /* How (overwrite, ..) */
375    uint32_t   selection_type;
376
377    char *RestoreWhere;                /* Where on disk to restore -- directory */
378    char *RegexWhere;                  /* RegexWhere option */
379    char *strip_prefix;                /* remove prefix from filename  */
380    char *add_prefix;                  /* add prefix to filename  */
381    char *add_suffix;                  /* add suffix to filename -- .old */
382    char *RestoreBootstrap;            /* Bootstrap file */
383    char *PluginOptions;               /* Options to pass to plugin */
384    union {
385       char *WriteBootstrap;           /* Where to write bootstrap Job updates */
386       char *WriteVerifyList;          /* List of changed files */
387    };
388    utime_t MaxRunTime;                /* max run time in seconds */
389    utime_t MaxWaitTime;               /* max blocking time in seconds */
390    utime_t FullMaxRunTime;            /* Max Full job run time */
391    utime_t DiffMaxRunTime;            /* Max Differential job run time */
392    utime_t IncMaxRunTime;             /* Max Incremental job run time */
393    utime_t MaxStartDelay;             /* max start delay in seconds */
394    utime_t MaxRunSchedTime;           /* max run time in seconds from Scheduled time*/
395    utime_t RescheduleInterval;        /* Reschedule interval */
396    utime_t MaxFullInterval;           /* Maximum time interval between Fulls */
397    utime_t MaxDiffInterval;           /* Maximum time interval between Diffs */
398    utime_t DuplicateJobProximity;     /* Permitted time between duplicicates */
399    int64_t spool_size;                /* Size of spool file for this job */
400    int32_t MaxConcurrentJobs;         /* Maximum concurrent jobs */
401    int32_t NumConcurrentJobs;         /* number of concurrent jobs running */
402    bool allow_mixed_priority;         /* Allow jobs with higher priority concurrently with this */
403
404    MSGS      *messages;               /* How and where to send messages */
405    SCHED     *schedule;               /* When -- Automatic schedule */
406    CLIENT    *client;                 /* Who to backup */
407    FILESET   *fileset;                /* What to backup -- Fileset */
408    alist     *storage;                /* Where is device -- list of Storage to be used */
409    POOL      *pool;                   /* Where is media -- Media Pool */
410    POOL      *full_pool;              /* Pool for Full backups */
411    POOL      *inc_pool;               /* Pool for Incremental backups */
412    POOL      *diff_pool;              /* Pool for Differental backups */
413    char      *selection_pattern;
414    union {
415       JOB    *verify_job;             /* Job name to verify */
416    };
417    JOB       *jobdefs;                /* Job defaults */
418    alist     *run_cmds;               /* Run commands */
419    alist *RunScripts;                 /* Run {client} program {after|before} Job */
420
421    bool where_use_regexp;             /* true if RestoreWhere is a BREGEXP */
422    bool RescheduleOnError;            /* Set to reschedule on error */
423    bool PrefixLinks;                  /* prefix soft links with Where path */
424    bool PruneJobs;                    /* Force pruning of Jobs */
425    bool PruneFiles;                   /* Force pruning of Files */
426    bool PruneVolumes;                 /* Force pruning of Volumes */
427    bool SpoolAttributes;              /* Set to spool attributes in SD */
428    bool spool_data;                   /* Set to spool data in SD */
429    bool rerun_failed_levels;          /* Upgrade to rerun failed levels */
430    bool PreferMountedVolumes;         /* Prefer vols mounted rather than new one */
431    bool write_part_after_job;         /* Set to write part after job in SD */
432    bool enabled;                      /* Set if job enabled */
433    bool accurate;                     /* Set if it is an accurate backup job */
434    bool AllowDuplicateJobs;           /* Allow duplicate jobs */
435    bool AllowHigherDuplicates;        /* Permit Higher Level */
436    bool CancelLowerLevelDuplicates;   /* Cancel lower level backup jobs */
437    bool CancelQueuedDuplicates;       /* Cancel queued jobs */
438    bool CancelRunningDuplicates;      /* Cancel Running jobs */
439    alist *base;                       /* Base jobs */   
440
441    /* Methods */
442    char *name() const;
443 };
444
445 inline char *JOB::name() const { return hdr.name; }
446
447 #undef  MAX_FOPTS
448 #define MAX_FOPTS 40
449
450 /* File options structure */
451 struct FOPTS {
452    char opts[MAX_FOPTS];              /* options string */
453    alist regex;                       /* regex string(s) */
454    alist regexdir;                    /* regex string(s) for directories */
455    alist regexfile;                   /* regex string(s) for files */
456    alist wild;                        /* wild card strings */
457    alist wilddir;                     /* wild card strings for directories */
458    alist wildfile;                    /* wild card strings for files */
459    alist wildbase;                    /* wild card strings for files without '/' */
460    alist base;                        /* list of base names */
461    alist fstype;                      /* file system type limitation */
462    alist drivetype;                   /* drive type limitation */
463    char *reader;                      /* reader program */
464    char *writer;                      /* writer program */
465    char *plugin;                      /* plugin program */
466 };
467
468
469 /* This is either an include item or an exclude item */
470 struct INCEXE {
471    FOPTS *current_opts;               /* points to current options structure */
472    FOPTS **opts_list;                 /* options list */
473    int32_t num_opts;                  /* number of options items */
474    alist name_list;                   /* filename list -- holds char * */
475    alist plugin_list;                 /* filename list for plugins */
476    char *ignoredir;                   /* ignoredir string */
477 };
478
479 /*
480  *   FileSet Resource
481  *
482  */
483 class FILESET {
484 public:
485    RES   hdr;
486
487    bool new_include;                  /* Set if new include used */
488    INCEXE **include_items;            /* array of incexe structures */
489    int32_t num_includes;              /* number in array */
490    INCEXE **exclude_items;
491    int32_t num_excludes;
492    bool have_MD5;                     /* set if MD5 initialized */
493    struct MD5Context md5c;            /* MD5 of include/exclude */
494    char MD5[30];                      /* base 64 representation of MD5 */
495    bool ignore_fs_changes;            /* Don't force Full if FS changed */
496    bool enable_vss;                   /* Enable Volume Shadow Copy */
497
498    /* Methods */
499    char *name() const;
500 };
501
502 inline char *FILESET::name() const { return hdr.name; }
503
504 /*
505  *   Schedule Resource
506  *
507  */
508 class SCHED {
509 public:
510    RES   hdr;
511
512    RUN *run;
513 };
514
515 /*
516  *   Counter Resource
517  */
518 class COUNTER {
519 public:
520    RES   hdr;
521
522    int32_t  MinValue;                 /* Minimum value */
523    int32_t  MaxValue;                 /* Maximum value */
524    int32_t  CurrentValue;             /* Current value */
525    COUNTER *WrapCounter;              /* Wrap counter name */
526    CAT     *Catalog;                  /* Where to store */
527    bool     created;                  /* Created in DB */
528    /* Methods */
529    char *name() const;
530 };
531
532 inline char *COUNTER::name() const { return hdr.name; }
533
534 /*
535  *   Pool Resource
536  *
537  */
538 class POOL {
539 public:
540    RES   hdr;
541
542    char *pool_type;                   /* Pool type */
543    char *label_format;                /* Label format string */
544    char *cleaning_prefix;             /* Cleaning label prefix */
545    int32_t LabelType;                 /* Bacula/ANSI/IBM label type */
546    uint32_t max_volumes;              /* max number of volumes */
547    utime_t VolRetention;              /* volume retention period in seconds */
548    utime_t VolUseDuration;            /* duration volume can be used */
549    uint32_t MaxVolJobs;               /* Maximum jobs on the Volume */
550    uint32_t MaxVolFiles;              /* Maximum files on the Volume */
551    uint64_t MaxVolBytes;              /* Maximum bytes on the Volume */
552    utime_t MigrationTime;             /* Time to migrate to next pool */
553    uint64_t MigrationHighBytes;       /* When migration starts */
554    uint64_t MigrationLowBytes;        /* When migration stops */
555    POOL  *NextPool;                   /* Next pool for migration */
556    alist *storage;                    /* Where is device -- list of Storage to be used */
557    bool  use_catalog;                 /* maintain catalog for media */
558    bool  catalog_files;               /* maintain file entries in catalog */
559    bool  use_volume_once;             /* write on volume only once */
560    bool  purge_oldest_volume;         /* purge oldest volume */
561    bool  recycle_oldest_volume;       /* attempt to recycle oldest volume */
562    bool  recycle_current_volume;      /* attempt recycle of current volume */
563    bool  AutoPrune;                   /* default for pool auto prune */
564    bool  Recycle;                     /* default for media recycle yes/no */
565    uint32_t action_on_purge;          /* action on purge, e.g. truncate the disk volume */
566    POOL  *RecyclePool;                /* RecyclePool destination when media is purged */
567    POOL  *ScratchPool;                /* ScratchPool source when requesting media */
568    alist *CopyPool;                   /* List of copy pools */
569    CAT *catalog;                      /* Catalog to be used */
570    utime_t FileRetention;             /* file retention period in seconds */
571    utime_t JobRetention;              /* job retention period in seconds */
572
573    /* Methods */
574    char *name() const;
575 };
576
577 inline char *POOL::name() const { return hdr.name; }
578
579
580
581
582 /* Define the Union of all the above
583  * resource structure definitions.
584  */
585 union URES {
586    DIRRES     res_dir;
587    CONRES     res_con;
588    CLIENT     res_client;
589    STORE      res_store;
590    CAT        res_cat;
591    JOB        res_job;
592    FILESET    res_fs;
593    SCHED      res_sch;
594    POOL       res_pool;
595    MSGS       res_msgs;
596    COUNTER    res_counter;
597    DEVICE     res_dev;
598    RES        hdr;
599    RUNSCRIPT  res_runscript;
600 };
601
602
603
604 /* Run structure contained in Schedule Resource */
605 class RUN {
606 public:
607    RUN *next;                         /* points to next run record */
608    uint32_t level;                    /* level override */
609    int32_t Priority;                  /* priority override */
610    uint32_t job_type;
611    bool spool_data;                   /* Data spooling override */
612    bool spool_data_set;               /* Data spooling override given */
613    bool write_part_after_job;         /* Write part after job override */
614    bool write_part_after_job_set;     /* Write part after job override given */
615    
616    POOL *pool;                        /* Pool override */
617    POOL *full_pool;                   /* Pool override */
618    POOL *inc_pool;                    /* Pool override */
619    POOL *diff_pool;                   /* Pool override */
620    STORE *storage;                    /* Storage override */
621    MSGS *msgs;                        /* Messages override */
622    char *since;
623    uint32_t level_no;
624    uint32_t minute;                   /* minute to run job */
625    time_t last_run;                   /* last time run */
626    time_t next_run;                   /* next time to run */
627    char hour[nbytes_for_bits(24)];    /* bit set for each hour */
628    char mday[nbytes_for_bits(31)];    /* bit set for each day of month */
629    char month[nbytes_for_bits(12)];   /* bit set for each month */
630    char wday[nbytes_for_bits(7)];     /* bit set for each day of the week */
631    char wom[nbytes_for_bits(5)];      /* week of month */
632    char woy[nbytes_for_bits(54)];     /* week of year */
633 };
634
635 #define GetPoolResWithName(x) ((POOL *)GetResWithName(R_POOL, (x)))
636 #define GetStoreResWithName(x) ((STORE *)GetResWithName(R_STORAGE, (x)))
637 #define GetClientResWithName(x) ((CLIENT *)GetResWithName(R_CLIENT, (x)))
638 #define GetJobResWithName(x) ((JOB *)GetResWithName(R_JOB, (x)))
639 #define GetFileSetResWithName(x) ((FILESET *)GetResWithName(R_FILESET, (x)))
640 #define GetCatalogResWithName(x) ((CAT *)GetResWithName(R_CATALOG, (x)))