2 Bacula® - The Network Backup Solution
4 Copyright (C) 2000-2007 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 char *pid_directory; /* PidDirectory */
114 char *subsys_directory; /* SubsysDirectory */
115 MSGS *messages; /* Daemon message handler */
116 uint32_t MaxConcurrentJobs; /* Max concurrent jobs for whole director */
117 utime_t FDConnectTimeout; /* timeout for connect in seconds */
118 utime_t SDConnectTimeout; /* timeout in seconds */
119 utime_t heartbeat_interval; /* Interval to send heartbeats */
120 char *tls_ca_certfile; /* TLS CA Certificate File */
121 char *tls_ca_certdir; /* TLS CA Certificate Directory */
122 char *tls_certfile; /* TLS Server Certificate File */
123 char *tls_keyfile; /* TLS Server Key File */
124 char *tls_dhfile; /* TLS Diffie-Hellman Parameters */
125 alist *tls_allowed_cns; /* TLS Allowed Clients */
126 TLS_CONTEXT *tls_ctx; /* Shared TLS Context */
127 bool tls_enable; /* Enable TLS */
128 bool tls_require; /* Require TLS */
129 bool tls_verify_peer; /* TLS Verify Client Certificate */
135 inline char *DIRRES::name() const { return hdr.name; }
139 * This resource is a bit different from the other resources
140 * because it is not defined in the Director
141 * by DEVICE { ... }, but rather by a "reference" such as
142 * DEVICE = xxx; Then when the Director connects to the
143 * SD, it requests the information about the device.
149 bool found; /* found with SD */
150 int num_writers; /* number of writers */
151 int max_writers; /* = 1 for files */
152 int reserved; /* number of reserves */
153 int num_drives; /* for autochanger */
154 bool autochanger; /* set if device is autochanger */
155 bool open; /* drive open */
156 bool append; /* in append mode */
157 bool read; /* in read mode */
158 bool labeled; /* Volume name valid */
159 bool offline; /* not available */
160 bool autoselect; /* can be selected via autochanger */
162 char ChangerName[MAX_NAME_LENGTH];
163 char VolumeName[MAX_NAME_LENGTH];
164 char MediaType[MAX_NAME_LENGTH];
170 inline char *DEVICE::name() const { return hdr.name; }
173 * Console ACL positions
186 Num_ACL /* keep last */
195 char *password; /* UA server password */
196 alist *ACL_lists[Num_ACL]; /* pointers to ACLs */
197 char *tls_ca_certfile; /* TLS CA Certificate File */
198 char *tls_ca_certdir; /* TLS CA Certificate Directory */
199 char *tls_certfile; /* TLS Server Certificate File */
200 char *tls_keyfile; /* TLS Server Key File */
201 char *tls_dhfile; /* TLS Diffie-Hellman Parameters */
202 alist *tls_allowed_cns; /* TLS Allowed Clients */
203 TLS_CONTEXT *tls_ctx; /* Shared TLS Context */
204 bool tls_enable; /* Enable TLS */
205 bool tls_require; /* Require TLS */
206 bool tls_verify_peer; /* TLS Verify Client Certificate */
212 inline char *CONRES::name() const { return hdr.name; }
223 int db_port; /* Port */
224 char *db_address; /* host name for remote access */
225 char *db_socket; /* Socket for local access */
229 int mult_db_connections; /* set if multiple connections wanted */
235 inline char *CAT::name() const { return hdr.name; }
246 int FDport; /* Where File daemon listens */
247 utime_t FileRetention; /* file retention period in seconds */
248 utime_t JobRetention; /* job retention period in seconds */
249 utime_t heartbeat_interval; /* Interval to send heartbeats */
252 CAT *catalog; /* Catalog resource */
253 uint32_t MaxConcurrentJobs; /* Maximume concurrent jobs */
254 uint32_t NumConcurrentJobs; /* number of concurrent jobs running */
255 char *tls_ca_certfile; /* TLS CA Certificate File */
256 char *tls_ca_certdir; /* TLS CA Certificate Directory */
257 char *tls_certfile; /* TLS Client Certificate File */
258 char *tls_keyfile; /* TLS Client Key File */
259 alist *tls_allowed_cns; /* TLS Allowed Clients */
260 TLS_CONTEXT *tls_ctx; /* Shared TLS Context */
261 bool tls_enable; /* Enable TLS */
262 bool tls_require; /* Require TLS */
263 bool AutoPrune; /* Do automatic pruning? */
269 inline char *CLIENT::name() const { return hdr.name; }
280 int SDport; /* port where Directors connect */
281 int SDDport; /* data port for File daemon */
285 alist *device; /* Alternate devices for this Storage */
286 uint32_t MaxConcurrentJobs; /* Maximume concurrent jobs */
287 uint32_t NumConcurrentJobs; /* number of concurrent jobs running */
288 char *tls_ca_certfile; /* TLS CA Certificate File */
289 char *tls_ca_certdir; /* TLS CA Certificate Directory */
290 char *tls_certfile; /* TLS Client Certificate File */
291 char *tls_keyfile; /* TLS Client Key File */
292 TLS_CONTEXT *tls_ctx; /* Shared TLS Context */
293 bool tls_enable; /* Enable TLS */
294 bool tls_require; /* Require TLS */
295 bool enabled; /* Set if device is enabled */
296 bool autochanger; /* set if autochanger */
297 int64_t StorageId; /* Set from Storage DB record */
298 utime_t heartbeat_interval; /* Interval to send heartbeats */
299 int drives; /* number of drives in autochanger */
302 char *dev_name() const;
306 inline char *STORE::dev_name() const
308 DEVICE *dev = (DEVICE *)device->first();
309 return dev->hdr.name;
312 inline char *STORE::name() const { return hdr.name; }
315 * This is a sort of "unified" store that has both the
316 * storage pointer and the text of where the pointer was
322 POOLMEM *store_source;
325 USTORE() { store = NULL; store_source = get_pool_memory(PM_MESSAGE);
326 *store_source = 0; };
327 ~USTORE() { destroy(); }
328 void set_source(const char *where);
332 inline void USTORE::destroy()
335 free_pool_memory(store_source);
341 inline void USTORE::set_source(const char *where)
344 store_source = get_pool_memory(PM_MESSAGE);
346 pm_strcpy(store_source, where);
357 int JobType; /* job type (backup, verify, restore */
358 int JobLevel; /* default backup/verify level */
359 int Priority; /* Job priority */
360 int RestoreJobId; /* What -- JobId to restore */
361 char *RestoreWhere; /* Where on disk to restore -- directory */
362 char *RegexWhere; /* RegexWhere option */
363 char *strip_prefix; /* remove prefix from filename */
364 char *add_prefix; /* add prefix to filename */
365 char *add_suffix; /* add suffix to filename -- .old */
366 bool where_use_regexp; /* true if RestoreWhere is a BREGEXP */
367 char *RestoreBootstrap; /* Bootstrap file */
368 alist *RunScripts; /* Run {client} program {after|before} Job */
370 char *WriteBootstrap; /* Where to write bootstrap Job updates */
371 char *WriteVerifyList; /* List of changed files */
373 int replace; /* How (overwrite, ..) */
374 utime_t MaxRunTime; /* max run time in seconds */
375 utime_t MaxWaitTime; /* max blocking time in seconds */
376 utime_t FullMaxWaitTime; /* Max Full job wait time */
377 utime_t DiffMaxWaitTime; /* Max Differential job wait time */
378 utime_t IncMaxWaitTime; /* Max Incremental job wait time */
379 utime_t MaxStartDelay; /* max start delay in seconds */
380 utime_t RescheduleInterval; /* Reschedule interval */
381 utime_t JobRetention; /* job retention period in seconds */
382 uint32_t MaxConcurrentJobs; /* Maximum concurrent jobs */
383 int64_t spool_size; /* Size of spool file for this job */
384 int RescheduleTimes; /* Number of times to reschedule job */
385 bool RescheduleOnError; /* Set to reschedule on error */
386 bool PrefixLinks; /* prefix soft links with Where path */
387 bool PruneJobs; /* Force pruning of Jobs */
388 bool PruneFiles; /* Force pruning of Files */
389 bool PruneVolumes; /* Force pruning of Volumes */
390 bool SpoolAttributes; /* Set to spool attributes in SD */
391 bool spool_data; /* Set to spool data in SD */
392 bool rerun_failed_levels; /* Upgrade to rerun failed levels */
393 bool PreferMountedVolumes; /* Prefer vols mounted rather than new one */
394 bool write_part_after_job; /* Set to write part after job in SD */
395 bool enabled; /* Set if job enabled */
396 bool OptimizeJobScheduling; /* Set if we should optimize Job scheduling */
398 MSGS *messages; /* How and where to send messages */
399 SCHED *schedule; /* When -- Automatic schedule */
400 CLIENT *client; /* Who to backup */
401 FILESET *fileset; /* What to backup -- Fileset */
402 alist *storage; /* Where is device -- list of Storage to be used */
403 POOL *pool; /* Where is media -- Media Pool */
404 POOL *full_pool; /* Pool for Full backups */
405 POOL *inc_pool; /* Pool for Incremental backups */
406 POOL *diff_pool; /* Pool for Differental backups */
407 char *selection_pattern;
410 JOB *verify_job; /* Job name to verify */
412 JOB *jobdefs; /* Job defaults */
413 alist *run_cmds; /* Run commands */
414 uint32_t NumConcurrentJobs; /* number of concurrent jobs running */
420 inline char *JOB::name() const { return hdr.name; }
425 /* File options structure */
427 char opts[MAX_FOPTS]; /* options string */
428 alist regex; /* regex string(s) */
429 alist regexdir; /* regex string(s) for directories */
430 alist regexfile; /* regex string(s) for files */
431 alist wild; /* wild card strings */
432 alist wilddir; /* wild card strings for directories */
433 alist wildfile; /* wild card strings for files */
434 alist wildbase; /* wild card strings for files without '/' */
435 alist base; /* list of base names */
436 alist fstype; /* file system type limitation */
437 alist drivetype; /* drive type limitation */
438 char *reader; /* reader program */
439 char *writer; /* writer program */
443 /* This is either an include item or an exclude item */
445 FOPTS *current_opts; /* points to current options structure */
446 FOPTS **opts_list; /* options list */
447 int num_opts; /* number of options items */
448 alist name_list; /* filename list -- holds char * */
459 bool new_include; /* Set if new include used */
460 INCEXE **include_items; /* array of incexe structures */
461 int num_includes; /* number in array */
462 INCEXE **exclude_items;
464 bool have_MD5; /* set if MD5 initialized */
465 struct MD5Context md5c; /* MD5 of include/exclude */
466 char MD5[30]; /* base 64 representation of MD5 */
467 bool ignore_fs_changes; /* Don't force Full if FS changed */
468 bool enable_vss; /* Enable Volume Shadow Copy */
474 inline char *FILESET::name() const { return hdr.name; }
494 int32_t MinValue; /* Minimum value */
495 int32_t MaxValue; /* Maximum value */
496 int32_t CurrentValue; /* Current value */
497 COUNTER *WrapCounter; /* Wrap counter name */
498 CAT *Catalog; /* Where to store */
499 bool created; /* Created in DB */
504 inline char *COUNTER::name() const { return hdr.name; }
514 char *pool_type; /* Pool type */
515 char *label_format; /* Label format string */
516 char *cleaning_prefix; /* Cleaning label prefix */
517 int32_t LabelType; /* Bacula/ANSI/IBM label type */
518 uint32_t max_volumes; /* max number of volumes */
519 utime_t VolRetention; /* volume retention period in seconds */
520 utime_t VolUseDuration; /* duration volume can be used */
521 uint32_t MaxVolJobs; /* Maximum jobs on the Volume */
522 uint32_t MaxVolFiles; /* Maximum files on the Volume */
523 uint64_t MaxVolBytes; /* Maximum bytes on the Volume */
524 utime_t MigrationTime; /* Time to migrate to next pool */
525 uint64_t MigrationHighBytes; /* When migration starts */
526 uint64_t MigrationLowBytes; /* When migration stops */
527 POOL *NextPool; /* Next pool for migration */
528 alist *storage; /* Where is device -- list of Storage to be used */
529 bool use_catalog; /* maintain catalog for media */
530 bool catalog_files; /* maintain file entries in catalog */
531 bool use_volume_once; /* write on volume only once */
532 bool purge_oldest_volume; /* purge oldest volume */
533 bool recycle_oldest_volume; /* attempt to recycle oldest volume */
534 bool recycle_current_volume; /* attempt recycle of current volume */
535 bool AutoPrune; /* default for pool auto prune */
536 bool Recycle; /* default for media recycle yes/no */
537 POOL *RecyclePool; /* RecyclePool destination when media is purged */
538 alist *CopyPool; /* List of copy pools */
539 CAT *Catalog; /* Catalog to be used */
544 inline char *POOL::name() const { return hdr.name; }
549 /* Define the Union of all the above
550 * resource structure definitions.
566 RUNSCRIPT res_runscript;
571 /* Run structure contained in Schedule Resource */
574 RUN *next; /* points to next run record */
575 int level; /* level override */
576 int Priority; /* priority override */
578 bool spool_data; /* Data spooling override */
579 bool spool_data_set; /* Data spooling override given */
580 bool write_part_after_job; /* Write part after job override */
581 bool write_part_after_job_set; /* Write part after job override given */
583 POOL *pool; /* Pool override */
584 POOL *full_pool; /* Pool override */
585 POOL *inc_pool; /* Pool override */
586 POOL *diff_pool; /* Pool override */
587 STORE *storage; /* Storage override */
588 MSGS *msgs; /* Messages override */
591 int minute; /* minute to run job */
592 time_t last_run; /* last time run */
593 time_t next_run; /* next time to run */
594 char hour[nbytes_for_bits(24)]; /* bit set for each hour */
595 char mday[nbytes_for_bits(31)]; /* bit set for each day of month */
596 char month[nbytes_for_bits(12)]; /* bit set for each month */
597 char wday[nbytes_for_bits(7)]; /* bit set for each day of the week */
598 char wom[nbytes_for_bits(5)]; /* week of month */
599 char woy[nbytes_for_bits(54)]; /* week of year */
602 #define GetPoolResWithName(x) ((POOL *)GetResWithName(R_POOL, (x)))
603 #define GetStoreResWithName(x) ((STORE *)GetResWithName(R_STORAGE, (x)))
604 #define GetClientResWithName(x) ((CLIENT *)GetResWithName(R_CLIENT, (x)))
605 #define GetJobResWithName(x) ((JOB *)GetResWithName(R_JOB, (x)))
606 #define GetFileSetResWithName(x) ((FILESET *)GetResWithName(R_FILESET, (x)))
607 #define GetCatalogResWithName(x) ((CAT *)GetResWithName(R_CATALOG, (x)))