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