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