]> git.sur5r.net Git - bacula/bacula/blob - bacula/src/dird/dird_conf.h
Add Job and File Retention to Pool
[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 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    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    uint32_t MaxConcurrentJobs;        /* Maximum concurrent jobs */
401    uint32_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 CancelQueuedDuplicates;       /* Cancel queued jobs */
437    bool CancelRunningDuplicates;      /* Cancel Running jobs */
438    alist *base;                       /* Base jobs */   
439
440    /* Methods */
441    char *name() const;
442 };
443
444 inline char *JOB::name() const { return hdr.name; }
445
446 #undef  MAX_FOPTS
447 #define MAX_FOPTS 40
448
449 /* File options structure */
450 struct FOPTS {
451    char opts[MAX_FOPTS];              /* options string */
452    alist regex;                       /* regex string(s) */
453    alist regexdir;                    /* regex string(s) for directories */
454    alist regexfile;                   /* regex string(s) for files */
455    alist wild;                        /* wild card strings */
456    alist wilddir;                     /* wild card strings for directories */
457    alist wildfile;                    /* wild card strings for files */
458    alist wildbase;                    /* wild card strings for files without '/' */
459    alist base;                        /* list of base names */
460    alist fstype;                      /* file system type limitation */
461    alist drivetype;                   /* drive type limitation */
462    char *reader;                      /* reader program */
463    char *writer;                      /* writer program */
464    char *plugin;                      /* plugin program */
465 };
466
467
468 /* This is either an include item or an exclude item */
469 struct INCEXE {
470    FOPTS *current_opts;               /* points to current options structure */
471    FOPTS **opts_list;                 /* options list */
472    int32_t num_opts;                  /* number of options items */
473    alist name_list;                   /* filename list -- holds char * */
474    alist plugin_list;                 /* filename list for plugins */
475    char *ignoredir;                   /* ignoredir string */
476 };
477
478 /*
479  *   FileSet Resource
480  *
481  */
482 class FILESET {
483 public:
484    RES   hdr;
485
486    bool new_include;                  /* Set if new include used */
487    INCEXE **include_items;            /* array of incexe structures */
488    int32_t num_includes;              /* number in array */
489    INCEXE **exclude_items;
490    int32_t num_excludes;
491    bool have_MD5;                     /* set if MD5 initialized */
492    struct MD5Context md5c;            /* MD5 of include/exclude */
493    char MD5[30];                      /* base 64 representation of MD5 */
494    bool ignore_fs_changes;            /* Don't force Full if FS changed */
495    bool enable_vss;                   /* Enable Volume Shadow Copy */
496
497    /* Methods */
498    char *name() const;
499 };
500
501 inline char *FILESET::name() const { return hdr.name; }
502
503 /*
504  *   Schedule Resource
505  *
506  */
507 class SCHED {
508 public:
509    RES   hdr;
510
511    RUN *run;
512 };
513
514 /*
515  *   Counter Resource
516  */
517 class COUNTER {
518 public:
519    RES   hdr;
520
521    int32_t  MinValue;                 /* Minimum value */
522    int32_t  MaxValue;                 /* Maximum value */
523    int32_t  CurrentValue;             /* Current value */
524    COUNTER *WrapCounter;              /* Wrap counter name */
525    CAT     *Catalog;                  /* Where to store */
526    bool     created;                  /* Created in DB */
527    /* Methods */
528    char *name() const;
529 };
530
531 inline char *COUNTER::name() const { return hdr.name; }
532
533 /*
534  *   Pool Resource
535  *
536  */
537 class POOL {
538 public:
539    RES   hdr;
540
541    char *pool_type;                   /* Pool type */
542    char *label_format;                /* Label format string */
543    char *cleaning_prefix;             /* Cleaning label prefix */
544    int32_t LabelType;                 /* Bacula/ANSI/IBM label type */
545    uint32_t max_volumes;              /* max number of volumes */
546    utime_t VolRetention;              /* volume retention period in seconds */
547    utime_t VolUseDuration;            /* duration volume can be used */
548    uint32_t MaxVolJobs;               /* Maximum jobs on the Volume */
549    uint32_t MaxVolFiles;              /* Maximum files on the Volume */
550    uint64_t MaxVolBytes;              /* Maximum bytes on the Volume */
551    utime_t MigrationTime;             /* Time to migrate to next pool */
552    uint64_t MigrationHighBytes;       /* When migration starts */
553    uint64_t MigrationLowBytes;        /* When migration stops */
554    POOL  *NextPool;                   /* Next pool for migration */
555    alist *storage;                    /* Where is device -- list of Storage to be used */
556    bool  use_catalog;                 /* maintain catalog for media */
557    bool  catalog_files;               /* maintain file entries in catalog */
558    bool  use_volume_once;             /* write on volume only once */
559    bool  purge_oldest_volume;         /* purge oldest volume */
560    bool  recycle_oldest_volume;       /* attempt to recycle oldest volume */
561    bool  recycle_current_volume;      /* attempt recycle of current volume */
562    bool  AutoPrune;                   /* default for pool auto prune */
563    bool  Recycle;                     /* default for media recycle yes/no */
564    uint32_t action_on_purge;          /* action on purge, e.g. truncate the disk volume */
565    POOL  *RecyclePool;                /* RecyclePool destination when media is purged */
566    POOL  *ScratchPool;                /* ScratchPool source when requesting media */
567    alist *CopyPool;                   /* List of copy pools */
568    CAT *catalog;                      /* Catalog to be used */
569    utime_t FileRetention;             /* file retention period in seconds */
570    utime_t JobRetention;              /* job retention period in seconds */
571
572    /* Methods */
573    char *name() const;
574 };
575
576 inline char *POOL::name() const { return hdr.name; }
577
578
579
580
581 /* Define the Union of all the above
582  * resource structure definitions.
583  */
584 union URES {
585    DIRRES     res_dir;
586    CONRES     res_con;
587    CLIENT     res_client;
588    STORE      res_store;
589    CAT        res_cat;
590    JOB        res_job;
591    FILESET    res_fs;
592    SCHED      res_sch;
593    POOL       res_pool;
594    MSGS       res_msgs;
595    COUNTER    res_counter;
596    DEVICE     res_dev;
597    RES        hdr;
598    RUNSCRIPT  res_runscript;
599 };
600
601
602
603 /* Run structure contained in Schedule Resource */
604 class RUN {
605 public:
606    RUN *next;                         /* points to next run record */
607    uint32_t level;                    /* level override */
608    int32_t Priority;                  /* priority override */
609    uint32_t job_type;
610    bool spool_data;                   /* Data spooling override */
611    bool spool_data_set;               /* Data spooling override given */
612    bool write_part_after_job;         /* Write part after job override */
613    bool write_part_after_job_set;     /* Write part after job override given */
614    
615    POOL *pool;                        /* Pool override */
616    POOL *full_pool;                   /* Pool override */
617    POOL *inc_pool;                    /* Pool override */
618    POOL *diff_pool;                   /* Pool override */
619    STORE *storage;                    /* Storage override */
620    MSGS *msgs;                        /* Messages override */
621    char *since;
622    uint32_t level_no;
623    uint32_t minute;                   /* minute to run job */
624    time_t last_run;                   /* last time run */
625    time_t next_run;                   /* next time to run */
626    char hour[nbytes_for_bits(24)];    /* bit set for each hour */
627    char mday[nbytes_for_bits(31)];    /* bit set for each day of month */
628    char month[nbytes_for_bits(12)];   /* bit set for each month */
629    char wday[nbytes_for_bits(7)];     /* bit set for each day of the week */
630    char wom[nbytes_for_bits(5)];      /* week of month */
631    char woy[nbytes_for_bits(54)];     /* week of year */
632 };
633
634 #define GetPoolResWithName(x) ((POOL *)GetResWithName(R_POOL, (x)))
635 #define GetStoreResWithName(x) ((STORE *)GetResWithName(R_STORAGE, (x)))
636 #define GetClientResWithName(x) ((CLIENT *)GetResWithName(R_CLIENT, (x)))
637 #define GetJobResWithName(x) ((JOB *)GetResWithName(R_JOB, (x)))
638 #define GetFileSetResWithName(x) ((FILESET *)GetResWithName(R_FILESET, (x)))
639 #define GetCatalogResWithName(x) ((CAT *)GetResWithName(R_CATALOG, (x)))