2 Bacula® - The Network Backup Solution
4 Copyright (C) 2000-2008 Free Software Foundation Europe e.V.
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
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.
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
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.
29 * Director specific configuration and defines
31 * Kern Sibbald, Feb MM
36 /* NOTE: #includes at the end of this file */
39 * Resource codes -- they must be sequential for indexing
56 R_LAST = R_DEVICE /* keep this updated */
61 * Some resource attributes
72 /* Used for certain KeyWord tables */
78 /* Job Level keyword structure */
80 const char *level_name; /* level keyword */
81 int level; /* level */
82 int job_type; /* JobType permitting this level */
85 /* Job Type keyword structure */
87 const char *type_name;
91 /* Definition of the contents of each Resource */
92 /* Needed for forward references */
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 utime_t stats_retention; /* Stats retention period in seconds */
138 inline char *DIRRES::name() const { return hdr.name; }
142 * This resource is a bit different from the other resources
143 * because it is not defined in the Director
144 * by DEVICE { ... }, but rather by a "reference" such as
145 * DEVICE = xxx; Then when the Director connects to the
146 * SD, it requests the information about the device.
152 bool found; /* found with SD */
153 int num_writers; /* number of writers */
154 int max_writers; /* = 1 for files */
155 int reserved; /* number of reserves */
156 int num_drives; /* for autochanger */
157 bool autochanger; /* set if device is autochanger */
158 bool open; /* drive open */
159 bool append; /* in append mode */
160 bool read; /* in read mode */
161 bool labeled; /* Volume name valid */
162 bool offline; /* not available */
163 bool autoselect; /* can be selected via autochanger */
165 char ChangerName[MAX_NAME_LENGTH];
166 char VolumeName[MAX_NAME_LENGTH];
167 char MediaType[MAX_NAME_LENGTH];
173 inline char *DEVICE::name() const { return hdr.name; }
176 * Console ACL positions
190 Num_ACL /* keep last */
199 char *password; /* UA server password */
200 alist *ACL_lists[Num_ACL]; /* pointers to ACLs */
201 char *tls_ca_certfile; /* TLS CA Certificate File */
202 char *tls_ca_certdir; /* TLS CA Certificate Directory */
203 char *tls_certfile; /* TLS Server Certificate File */
204 char *tls_keyfile; /* TLS Server Key File */
205 char *tls_dhfile; /* TLS Diffie-Hellman Parameters */
206 alist *tls_allowed_cns; /* TLS Allowed Clients */
207 TLS_CONTEXT *tls_ctx; /* Shared TLS Context */
208 bool tls_authenticate; /* Authenticated with TLS */
209 bool tls_enable; /* Enable TLS */
210 bool tls_require; /* Require TLS */
211 bool tls_verify_peer; /* TLS Verify Client Certificate */
217 inline char *CONRES::name() const { return hdr.name; }
228 int db_port; /* Port */
229 char *db_address; /* host name for remote access */
230 char *db_socket; /* Socket for local access */
234 char *db_driver; /* Select appropriate driver */
235 int mult_db_connections; /* set if multiple connections wanted */
241 inline char *CAT::name() const { return hdr.name; }
252 int FDport; /* Where File daemon listens */
253 utime_t FileRetention; /* file retention period in seconds */
254 utime_t JobRetention; /* job retention period in seconds */
255 utime_t heartbeat_interval; /* Interval to send heartbeats */
258 CAT *catalog; /* Catalog resource */
259 uint32_t MaxConcurrentJobs; /* Maximume concurrent jobs */
260 uint32_t NumConcurrentJobs; /* number of concurrent jobs running */
261 char *tls_ca_certfile; /* TLS CA Certificate File */
262 char *tls_ca_certdir; /* TLS CA Certificate Directory */
263 char *tls_certfile; /* TLS Client Certificate File */
264 char *tls_keyfile; /* TLS Client Key File */
265 alist *tls_allowed_cns; /* TLS Allowed Clients */
266 TLS_CONTEXT *tls_ctx; /* Shared TLS Context */
267 bool tls_authenticate; /* Authenticated with TLS */
268 bool tls_enable; /* Enable TLS */
269 bool tls_require; /* Require TLS */
270 bool AutoPrune; /* Do automatic pruning? */
276 inline char *CLIENT::name() const { return hdr.name; }
287 int SDport; /* port where Directors connect */
288 int SDDport; /* data port for File daemon */
292 alist *device; /* Alternate devices for this Storage */
293 uint32_t MaxConcurrentJobs; /* Maximume concurrent jobs */
294 uint32_t NumConcurrentJobs; /* number of concurrent jobs running */
295 uint32_t NumConcurrentReadJobs; /* number of jobs reading */
296 char *tls_ca_certfile; /* TLS CA Certificate File */
297 char *tls_ca_certdir; /* TLS CA Certificate Directory */
298 char *tls_certfile; /* TLS Client Certificate File */
299 char *tls_keyfile; /* TLS Client Key File */
300 TLS_CONTEXT *tls_ctx; /* Shared TLS Context */
301 bool tls_authenticate; /* Authenticated with TLS */
302 bool tls_enable; /* Enable TLS */
303 bool tls_require; /* Require TLS */
304 bool enabled; /* Set if device is enabled */
305 bool autochanger; /* set if autochanger */
306 int64_t StorageId; /* Set from Storage DB record */
307 utime_t heartbeat_interval; /* Interval to send heartbeats */
308 int drives; /* number of drives in autochanger */
311 char *dev_name() const;
315 inline char *STORE::dev_name() const
317 DEVICE *dev = (DEVICE *)device->first();
318 return dev->hdr.name;
321 inline char *STORE::name() const { return hdr.name; }
324 * This is a sort of "unified" store that has both the
325 * storage pointer and the text of where the pointer was
331 POOLMEM *store_source;
334 USTORE() { store = NULL; store_source = get_pool_memory(PM_MESSAGE);
335 *store_source = 0; };
336 ~USTORE() { destroy(); }
337 void set_source(const char *where);
341 inline void USTORE::destroy()
344 free_pool_memory(store_source);
350 inline void USTORE::set_source(const char *where)
353 store_source = get_pool_memory(PM_MESSAGE);
355 pm_strcpy(store_source, where);
366 int JobType; /* job type (backup, verify, restore */
367 int JobLevel; /* default backup/verify level */
368 int Priority; /* Job priority */
369 int RestoreJobId; /* What -- JobId to restore */
370 int RescheduleTimes; /* Number of times to reschedule job */
371 int replace; /* How (overwrite, ..) */
374 char *RestoreWhere; /* Where on disk to restore -- directory */
375 char *RegexWhere; /* RegexWhere option */
376 char *strip_prefix; /* remove prefix from filename */
377 char *add_prefix; /* add prefix to filename */
378 char *add_suffix; /* add suffix to filename -- .old */
379 char *RestoreBootstrap; /* Bootstrap file */
380 char *PluginOptions; /* Options to pass to plugin */
382 char *WriteBootstrap; /* Where to write bootstrap Job updates */
383 char *WriteVerifyList; /* List of changed files */
385 utime_t MaxRunTime; /* max run time in seconds */
386 utime_t MaxWaitTime; /* max blocking time in seconds */
387 utime_t FullMaxWaitTime; /* Max Full job wait time */
388 utime_t DiffMaxWaitTime; /* Max Differential job wait time */
389 utime_t IncMaxWaitTime; /* Max Incremental job wait time */
390 utime_t MaxStartDelay; /* max start delay in seconds */
391 utime_t RescheduleInterval; /* Reschedule interval */
392 utime_t JobRetention; /* job retention period in seconds */
393 utime_t MaxFullInterval; /* Maximum time interval between Fulls */
394 utime_t MaxDiffInterval; /* Maximum time interval between Diffs */
395 utime_t DuplicateJobProximity; /* Permitted time between duplicicates */
396 int64_t spool_size; /* Size of spool file for this job */
397 uint32_t MaxConcurrentJobs; /* Maximum concurrent jobs */
398 uint32_t NumConcurrentJobs; /* number of concurrent jobs running */
400 MSGS *messages; /* How and where to send messages */
401 SCHED *schedule; /* When -- Automatic schedule */
402 CLIENT *client; /* Who to backup */
403 FILESET *fileset; /* What to backup -- Fileset */
404 alist *storage; /* Where is device -- list of Storage to be used */
405 POOL *pool; /* Where is media -- Media Pool */
406 POOL *full_pool; /* Pool for Full backups */
407 POOL *inc_pool; /* Pool for Incremental backups */
408 POOL *diff_pool; /* Pool for Differental backups */
409 char *selection_pattern;
411 JOB *verify_job; /* Job name to verify */
413 JOB *jobdefs; /* Job defaults */
414 alist *run_cmds; /* Run commands */
415 alist *RunScripts; /* Run {client} program {after|before} Job */
417 bool where_use_regexp; /* true if RestoreWhere is a BREGEXP */
418 bool RescheduleOnError; /* Set to reschedule on error */
419 bool PrefixLinks; /* prefix soft links with Where path */
420 bool PruneJobs; /* Force pruning of Jobs */
421 bool PruneFiles; /* Force pruning of Files */
422 bool PruneVolumes; /* Force pruning of Volumes */
423 bool SpoolAttributes; /* Set to spool attributes in SD */
424 bool spool_data; /* Set to spool data in SD */
425 bool rerun_failed_levels; /* Upgrade to rerun failed levels */
426 bool PreferMountedVolumes; /* Prefer vols mounted rather than new one */
427 bool write_part_after_job; /* Set to write part after job in SD */
428 bool enabled; /* Set if job enabled */
429 bool OptimizeJobScheduling; /* Set if we should optimize Job scheduling */
430 bool stats_enabled; /* Keep job records in a table for long term statistics */
431 bool accurate; /* Set if it is an accurate backup job */
432 bool AllowDuplicateJobs; /* Allow duplicate jobs */
433 bool AllowHigherDuplicates; /* Permit Higher Level */
434 bool CancelQueuedDuplicates; /* Cancel queued jobs */
435 bool CancelRunningDuplicates; /* Cancel Running jobs */
442 inline char *JOB::name() const { return hdr.name; }
447 /* File options structure */
449 char opts[MAX_FOPTS]; /* options string */
450 alist regex; /* regex string(s) */
451 alist regexdir; /* regex string(s) for directories */
452 alist regexfile; /* regex string(s) for files */
453 alist wild; /* wild card strings */
454 alist wilddir; /* wild card strings for directories */
455 alist wildfile; /* wild card strings for files */
456 alist wildbase; /* wild card strings for files without '/' */
457 alist base; /* list of base names */
458 alist fstype; /* file system type limitation */
459 alist drivetype; /* drive type limitation */
460 char *reader; /* reader program */
461 char *writer; /* writer program */
462 char *plugin; /* plugin program */
466 /* This is either an include item or an exclude item */
468 FOPTS *current_opts; /* points to current options structure */
469 FOPTS **opts_list; /* options list */
470 int num_opts; /* number of options items */
471 alist name_list; /* filename list -- holds char * */
472 alist plugin_list; /* filename list for plugins */
483 bool new_include; /* Set if new include used */
484 INCEXE **include_items; /* array of incexe structures */
485 int num_includes; /* number in array */
486 INCEXE **exclude_items;
488 bool have_MD5; /* set if MD5 initialized */
489 struct MD5Context md5c; /* MD5 of include/exclude */
490 char MD5[30]; /* base 64 representation of MD5 */
491 bool ignore_fs_changes; /* Don't force Full if FS changed */
492 bool enable_vss; /* Enable Volume Shadow Copy */
498 inline char *FILESET::name() const { return hdr.name; }
518 int32_t MinValue; /* Minimum value */
519 int32_t MaxValue; /* Maximum value */
520 int32_t CurrentValue; /* Current value */
521 COUNTER *WrapCounter; /* Wrap counter name */
522 CAT *Catalog; /* Where to store */
523 bool created; /* Created in DB */
528 inline char *COUNTER::name() const { return hdr.name; }
538 char *pool_type; /* Pool type */
539 char *label_format; /* Label format string */
540 char *cleaning_prefix; /* Cleaning label prefix */
541 int32_t LabelType; /* Bacula/ANSI/IBM label type */
542 uint32_t max_volumes; /* max number of volumes */
543 utime_t VolRetention; /* volume retention period in seconds */
544 utime_t VolUseDuration; /* duration volume can be used */
545 uint32_t MaxVolJobs; /* Maximum jobs on the Volume */
546 uint32_t MaxVolFiles; /* Maximum files on the Volume */
547 uint64_t MaxVolBytes; /* Maximum bytes on the Volume */
548 utime_t MigrationTime; /* Time to migrate to next pool */
549 uint64_t MigrationHighBytes; /* When migration starts */
550 uint64_t MigrationLowBytes; /* When migration stops */
551 POOL *NextPool; /* Next pool for migration */
552 alist *storage; /* Where is device -- list of Storage to be used */
553 bool use_catalog; /* maintain catalog for media */
554 bool catalog_files; /* maintain file entries in catalog */
555 bool use_volume_once; /* write on volume only once */
556 bool purge_oldest_volume; /* purge oldest volume */
557 bool recycle_oldest_volume; /* attempt to recycle oldest volume */
558 bool recycle_current_volume; /* attempt recycle of current volume */
559 bool AutoPrune; /* default for pool auto prune */
560 bool Recycle; /* default for media recycle yes/no */
561 POOL *RecyclePool; /* RecyclePool destination when media is purged */
562 alist *CopyPool; /* List of copy pools */
563 CAT *catalog; /* Catalog to be used */
568 inline char *POOL::name() const { return hdr.name; }
573 /* Define the Union of all the above
574 * resource structure definitions.
590 RUNSCRIPT res_runscript;
595 /* Run structure contained in Schedule Resource */
598 RUN *next; /* points to next run record */
599 int level; /* level override */
600 int Priority; /* priority override */
602 bool spool_data; /* Data spooling override */
603 bool spool_data_set; /* Data spooling override given */
604 bool write_part_after_job; /* Write part after job override */
605 bool write_part_after_job_set; /* Write part after job override given */
607 POOL *pool; /* Pool override */
608 POOL *full_pool; /* Pool override */
609 POOL *inc_pool; /* Pool override */
610 POOL *diff_pool; /* Pool override */
611 STORE *storage; /* Storage override */
612 MSGS *msgs; /* Messages override */
615 int minute; /* minute to run job */
616 time_t last_run; /* last time run */
617 time_t next_run; /* next time to run */
618 char hour[nbytes_for_bits(24)]; /* bit set for each hour */
619 char mday[nbytes_for_bits(31)]; /* bit set for each day of month */
620 char month[nbytes_for_bits(12)]; /* bit set for each month */
621 char wday[nbytes_for_bits(7)]; /* bit set for each day of the week */
622 char wom[nbytes_for_bits(5)]; /* week of month */
623 char woy[nbytes_for_bits(54)]; /* week of year */
626 #define GetPoolResWithName(x) ((POOL *)GetResWithName(R_POOL, (x)))
627 #define GetStoreResWithName(x) ((STORE *)GetResWithName(R_STORAGE, (x)))
628 #define GetClientResWithName(x) ((CLIENT *)GetResWithName(R_CLIENT, (x)))
629 #define GetJobResWithName(x) ((JOB *)GetResWithName(R_JOB, (x)))
630 #define GetFileSetResWithName(x) ((FILESET *)GetResWithName(R_FILESET, (x)))
631 #define GetCatalogResWithName(x) ((CAT *)GetResWithName(R_CATALOG, (x)))