2 Bacula® - The Network Backup Solution
4 Copyright (C) 2000-2011 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 three of the GNU Affero 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 Affero 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 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.
29 * Bacula JCR Structure definition for Daemons and the Library
30 * This definition consists of a "Global" definition common
31 * to all daemons and used by the library routines, and a
32 * daemon specific part that is enabled with #defines.
34 * Kern Sibbald, Nov MM
42 /* Backup/Verify level code. These are stored in the DB */
43 #define L_FULL 'F' /* Full backup */
44 #define L_INCREMENTAL 'I' /* since last backup */
45 #define L_DIFFERENTIAL 'D' /* since last full backup */
47 #define L_VERIFY_CATALOG 'C' /* verify from catalog */
48 #define L_VERIFY_INIT 'V' /* verify save (init DB) */
49 #define L_VERIFY_VOLUME_TO_CATALOG 'O' /* verify Volume to catalog entries */
50 #define L_VERIFY_DISK_TO_CATALOG 'd' /* verify Disk attributes to catalog */
51 #define L_VERIFY_DATA 'A' /* verify data on volume */
52 #define L_BASE 'B' /* Base level job */
53 #define L_NONE ' ' /* None, for Restore and Admin */
54 #define L_VIRTUAL_FULL 'f' /* Virtual full backup */
57 /* Job Types. These are stored in the DB */
58 #define JT_BACKUP 'B' /* Backup Job */
59 #define JT_MIGRATED_JOB 'M' /* A previous backup job that was migrated */
60 #define JT_VERIFY 'V' /* Verify Job */
61 #define JT_RESTORE 'R' /* Restore Job */
62 #define JT_CONSOLE 'U' /* console program */
63 #define JT_SYSTEM 'I' /* internal system "job" */
64 #define JT_ADMIN 'D' /* admin job */
65 #define JT_ARCHIVE 'A' /* Archive Job */
66 #define JT_JOB_COPY 'C' /* Copy of a Job */
67 #define JT_COPY 'c' /* Copy Job */
68 #define JT_MIGRATE 'g' /* Migration Job */
69 #define JT_SCAN 'S' /* Scan Job */
71 /* Job Status. Some of these are stored in the DB */
72 #define JS_Canceled 'A' /* canceled by user */
73 #define JS_Blocked 'B' /* blocked */
74 #define JS_Created 'C' /* created but not yet running */
75 #define JS_Differences 'D' /* Verify differences */
76 #define JS_ErrorTerminated 'E' /* Job terminated in error */
77 #define JS_WaitFD 'F' /* waiting on File daemon */
78 #define JS_Incomplete 'I' /* Incomplete Job */
79 #define JS_DataCommitting 'L' /* Committing data (last despool) */
80 #define JS_WaitMount 'M' /* waiting for Mount */
81 #define JS_Running 'R' /* running */
82 #define JS_WaitSD 'S' /* waiting on the Storage daemon */
83 #define JS_Terminated 'T' /* terminated normally */
84 #define JS_Warnings 'W' /* Terminated normally with warnings */
86 #define JS_AttrDespooling 'a' /* SD despooling attributes */
87 #define JS_WaitClientRes 'c' /* Waiting for Client resource */
88 #define JS_WaitMaxJobs 'd' /* Waiting for maximum jobs */
89 #define JS_Error 'e' /* Non-fatal error */
90 #define JS_FatalError 'f' /* Fatal error */
91 #define JS_AttrInserting 'i' /* Doing batch insert file records */
92 #define JS_WaitJobRes 'j' /* Waiting for job resource */
93 #define JS_DataDespooling 'l' /* Doing data despooling */
94 #define JS_WaitMedia 'm' /* waiting for new media */
95 #define JS_WaitPriority 'p' /* Waiting for higher priority jobs to finish */
96 #define JS_WaitStoreRes 's' /* Waiting for storage resource */
97 #define JS_WaitStartTime 't' /* Waiting for start time */
99 /* Migration selection types */
105 MT_POOL_UNCOPIED_JOBS,
112 #define job_canceled(jcr) \
113 (jcr->JobStatus == JS_Canceled || \
114 jcr->JobStatus == JS_ErrorTerminated || \
115 jcr->JobStatus == JS_FatalError \
118 #define job_waiting(jcr) \
119 (jcr->JobStatus == JS_WaitFD || \
120 jcr->JobStatus == JS_WaitSD || \
121 jcr->JobStatus == JS_WaitMedia || \
122 jcr->JobStatus == JS_WaitMount || \
123 jcr->JobStatus == JS_WaitStoreRes || \
124 jcr->JobStatus == JS_WaitJobRes || \
125 jcr->JobStatus == JS_WaitClientRes|| \
126 jcr->JobStatus == JS_WaitMaxJobs || \
127 jcr->JobStatus == JS_WaitPriority || \
128 jcr->SDJobStatus == JS_WaitMedia || \
129 jcr->SDJobStatus == JS_WaitMount || \
130 jcr->SDJobStatus == JS_WaitMaxJobs)
134 #define foreach_jcr(jcr) \
135 for (jcr=jcr_walk_start(); jcr; (jcr=jcr_walk_next(jcr)) )
137 #define endeach_jcr(jcr) jcr_walk_end(jcr)
142 /* Forward referenced structures */
150 struct xattr_private_data_t;
158 bool pki_sign; /* Enable PKI Signatures? */
159 bool pki_encrypt; /* Enable PKI Encryption? */
160 DIGEST *digest; /* Last file's digest context */
161 X509_KEYPAIR *pki_keypair; /* Encryption key pair */
162 alist *pki_signers; /* Trusted Signers */
163 alist *pki_recipients; /* Trusted Recipients */
164 CRYPTO_SESSION *pki_session; /* PKE Public Keys + Symmetric Session Keys */
165 POOLMEM *pki_session_encoded; /* Cached DER-encoded copy of pki_session */
166 int32_t pki_session_encoded_size; /* Size of DER-encoded pki_session */
167 POOLMEM *crypto_buf; /* Encryption/Decryption buffer */
171 typedef void (JCR_free_HANDLER)(JCR *jcr);
173 /* Job Control Record (JCR) */
176 pthread_mutex_t mutex; /* jcr mutex */
177 volatile int32_t _use_count; /* use count */
178 int32_t m_JobType; /* backup, restore, verify ... */
179 int32_t m_JobLevel; /* Job level */
180 bool my_thread_killable; /* can we kill the thread? */
182 void lock() {P(mutex); };
183 void unlock() {V(mutex); };
184 void inc_use_count(void) {lock(); _use_count++; unlock(); };
185 void dec_use_count(void) {lock(); _use_count--; unlock(); };
186 int32_t use_count() const { return _use_count; };
187 void init_mutex(void) {pthread_mutex_init(&mutex, NULL); };
188 void destroy_mutex(void) {pthread_mutex_destroy(&mutex); };
189 bool is_job_canceled() {return job_canceled(this); };
190 bool is_canceled() {return job_canceled(this); };
191 bool is_incomplete() { return JobStatus == JS_Incomplete; };
192 bool is_JobLevel(int32_t JobLevel) { return JobLevel == m_JobLevel; };
193 bool is_JobType(int32_t JobType) { return JobType == m_JobType; };
194 bool is_JobStatus(int32_t aJobStatus) { return aJobStatus == JobStatus; };
195 void setJobLevel(int32_t JobLevel) { m_JobLevel = JobLevel; };
196 void setJobType(int32_t JobType) { m_JobType = JobType; };
197 int32_t getJobType() const { return m_JobType; };
198 int32_t getJobLevel() const { return m_JobLevel; };
199 int32_t getJobStatus() const { return JobStatus; };
200 bool no_client_used() const {
201 return (m_JobType == JT_MIGRATE || m_JobType == JT_COPY ||
202 m_JobLevel == L_VIRTUAL_FULL);
204 const char *get_OperationName(); /* in lib/jcr.c */
205 const char *get_ActionName(bool past); /* in lib/jcr.c */
206 void setJobStatus(int JobStatus); /* in lib/jcr.c */
207 bool JobReads(); /* in lib/jcr.c */
208 void my_thread_send_signal(int sig); /* in lib/jcr.c */
209 void set_killable(bool killable); /* in lib/jcr.c */
210 bool is_killable() const { return my_thread_killable; };
212 /* Global part of JCR common to all daemons */
213 dlink link; /* JCR chain link */
214 pthread_t my_thread_id; /* id of thread controlling jcr */
215 BSOCK *dir_bsock; /* Director bsock or NULL if we are him */
216 BSOCK *store_bsock; /* Storage connection socket */
217 BSOCK *file_bsock; /* File daemon connection socket */
218 JCR_free_HANDLER *daemon_free_jcr; /* Local free routine */
219 dlist *msg_queue; /* Queued messages */
220 pthread_mutex_t msg_queue_mutex; /* message queue mutex */
221 bool dequeuing_msgs; /* Set when dequeuing messages */
222 alist job_end_push; /* Job end pushed calls */
223 POOLMEM *VolumeName; /* Volume name desired -- pool_memory */
224 POOLMEM *errmsg; /* edited error message */
225 char Job[MAX_NAME_LENGTH]; /* Unique name of this Job */
226 char event[MAX_NAME_LENGTH]; /* Current event (python) */
227 uint32_t eventType; /* Current event type (plugin) */
229 uint32_t JobId; /* Director's JobId */
230 uint32_t VolSessionId;
231 uint32_t VolSessionTime;
232 uint32_t JobFiles; /* Number of files written, this job */
233 uint32_t JobErrors; /* Number of non-fatal errors this job */
234 uint32_t JobWarnings; /* Number of warning messages */
235 uint64_t JobBytes; /* Number of bytes processed this job */
236 uint64_t ReadBytes; /* Bytes read -- before compression */
237 FileId_t FileId; /* Last FileId used */
238 volatile int32_t JobStatus; /* ready, running, blocked, terminated */
239 int32_t JobPriority; /* Job priority */
240 time_t sched_time; /* job schedule time, i.e. when it should start */
241 time_t start_time; /* when job actually started */
242 time_t run_time; /* used for computing speed */
243 time_t end_time; /* job end time */
244 time_t wait_time_sum; /* cumulative wait time since job start */
245 time_t wait_time; /* timestamp when job have started to wait */
246 POOLMEM *client_name; /* client name */
247 POOLMEM *JobIds; /* User entered string of JobIds */
248 POOLMEM *RestoreBootstrap; /* Bootstrap file to restore */
249 POOLMEM *stime; /* start time for incremental/differential */
250 char *sd_auth_key; /* SD auth key */
251 MSGS *jcr_msgs; /* Copy of message resource -- actually used */
252 uint32_t ClientId; /* Client associated with Job */
253 char *where; /* prefix to restore files to */
254 char *RegexWhere; /* file relocation in restore */
255 alist *where_bregexp; /* BREGEXP alist for path manipulation */
256 int32_t cached_pnl; /* cached path length */
257 POOLMEM *cached_path; /* cached path */
258 bool prefix_links; /* Prefix links with Where path */
259 bool gui; /* set if gui using console */
260 bool authenticated; /* set when client authenticated */
261 bool cached_attribute; /* set if attribute is cached */
262 bool batch_started; /* is batch mode already started ? */
263 bool cmd_plugin; /* Set when processing a command Plugin = */
264 bool keep_path_list; /* Keep newly created path in a hash */
265 bool accurate; /* true if job is accurate */
266 bool HasBase; /* True if job use base jobs */
267 bool incomplete; /* finishing an incomplete job */
269 void *Python_job; /* Python Job Object */
270 void *Python_events; /* Python Events Object */
271 POOLMEM *attr; /* Attribute string from SD */
272 B_DB *db; /* database pointer */
273 B_DB *db_batch; /* database pointer for batch and accurate */
274 uint64_t nb_base_files; /* Number of base files */
275 uint64_t nb_base_files_used; /* Number of useful files in base */
277 ATTR_DBR *ar; /* DB attribute record */
278 guid_list *id_list; /* User/group id to name list */
280 bpContext *plugin_ctx_list; /* list of contexts for plugins */
281 bpContext *plugin_ctx; /* current plugin context */
282 Plugin *plugin; /* plugin instance */
283 save_pkt *plugin_sp; /* plugin save packet */
284 char *plugin_options; /* user set options for plugin */
285 POOLMEM *comment; /* Comment for this Job */
286 int64_t max_bandwidth; /* Bandwidth limit for this Job */
287 htable *path_list; /* Directory list (used by findlib) */
289 /* Daemon specific part of JCR */
290 /* This should be empty in the library */
292 #ifdef DIRECTOR_DAEMON
293 /* Director Daemon specific data part of JCR */
294 pthread_t SD_msg_chan; /* Message channel thread id */
295 pthread_cond_t term_wait; /* Wait for job termination */
296 workq_ele_t *work_item; /* Work queue item if scheduled */
297 volatile bool sd_msg_thread_done; /* Set when Storage message thread done */
298 BSOCK *ua; /* User agent */
299 JOB *job; /* Job resource */
300 JOB *verify_job; /* Job resource of verify previous job */
301 alist *rstorage; /* Read storage possibilities */
302 STORE *rstore; /* Selected read storage */
303 alist *wstorage; /* Write storage possibilities */
304 STORE *wstore; /* Selected write storage */
305 CLIENT *client; /* Client resource */
306 POOL *pool; /* Pool resource = write for migration */
307 POOL *rpool; /* Read pool. Used only in migration */
308 POOL *full_pool; /* Full backup pool resource */
309 POOL *inc_pool; /* Incremental backup pool resource */
310 POOL *diff_pool; /* Differential backup pool resource */
311 FILESET *fileset; /* FileSet resource */
312 CAT *catalog; /* Catalog resource */
313 MSGS *messages; /* Default message handler */
314 uint32_t SDJobFiles; /* Number of files written, this job */
315 uint64_t SDJobBytes; /* Number of bytes processed this job */
316 uint32_t SDErrors; /* Number of non-fatal errors */
317 volatile int32_t SDJobStatus; /* Storage Job Status */
318 volatile int32_t FDJobStatus; /* File daemon Job Status */
319 uint32_t ExpectedFiles; /* Expected restore files */
320 uint32_t MediaId; /* DB record IDs associated with this job */
321 uint32_t FileIndex; /* Last FileIndex processed */
322 POOLMEM *fname; /* name to put into catalog */
323 JOB_DBR jr; /* Job DB record for current job */
324 JOB_DBR previous_jr; /* previous job database record */
325 JOB *previous_job; /* Job resource of migration previous job */
326 JCR *mig_jcr; /* JCR for migration/copy job */
327 char FSCreateTime[MAX_TIME_LENGTH]; /* FileSet CreateTime as returned from DB */
328 char since[MAX_TIME_LENGTH]; /* since time */
330 JobId_t RestoreJobId; /* Id specified by UA */
331 JobId_t MigrateJobId;
333 POOLMEM *client_uname; /* client uname */
334 POOLMEM *pool_source; /* Where pool came from */
335 POOLMEM *rpool_source; /* Where migrate read pool came from */
336 POOLMEM *rstore_source; /* Where read storage came from */
337 POOLMEM *wstore_source; /* Where write storage came from */
338 POOLMEM *catalog_source; /* Where catalog came from */
339 uint32_t replace; /* Replace option */
340 int32_t NumVols; /* Number of Volume used in pool */
341 int32_t reschedule_count; /* Number of times rescheduled */
342 int32_t FDVersion; /* File daemon version number */
343 int64_t spool_size; /* Spool size for this job */
344 bool spool_data; /* Spool data in SD */
345 bool acquired_resource_locks; /* set if resource locks acquired */
346 bool term_wait_inited; /* Set when cond var inited */
347 bool fn_printed; /* printed filename */
348 bool write_part_after_job; /* Write part after job in SD */
349 bool needs_sd; /* set if SD needed by Job */
350 bool cloned; /* set if cloned */
351 bool unlink_bsr; /* Unlink bsr file created */
352 bool VSS; /* VSS used by FD */
353 bool Encrypt; /* Encryption used by FD */
354 bool stats_enabled; /* Keep all job records in a table for long term statistics */
355 bool no_maxtime; /* Don't check Max*Time for this JCR */
356 bool keep_sd_auth_key; /* Clear or not the SD auth key after connection*/
357 bool use_accurate_chksum; /* Use or not checksum option in accurate code */
358 bool run_pool_override;
359 bool run_full_pool_override;
360 bool run_inc_pool_override;
361 bool run_diff_pool_override;
362 bool sd_canceled; /* set if SD canceled */
363 #endif /* DIRECTOR_DAEMON */
367 /* File Daemon specific part of JCR */
368 uint32_t num_files_examined; /* files examined this job */
369 POOLMEM *last_fname; /* last file saved/verified */
370 POOLMEM *job_metadata; /* VSS job metadata */
371 acl_data_t *acl_data; /* ACLs for backup/restore */
372 xattr_data_t *xattr_data; /* Extended Attributes for backup/restore */
373 int32_t last_type; /* type of last file saved/verified */
374 int incremental; /* set if incremental for SINCE */
375 utime_t mtime; /* begin time for SINCE */
376 int listing; /* job listing in estimate */
377 long Ticket; /* Ticket */
378 char *big_buf; /* I/O buffer */
379 POOLMEM *compress_buf; /* Compression buffer */
380 int32_t compress_buf_size; /* Length of compression buffer */
381 void *pZLIB_compress_workset; /* zlib compression session data */
382 int32_t replace; /* Replace options */
383 int32_t buf_size; /* length of buffer */
384 FF_PKT *ff; /* Find Files packet */
385 char stored_addr[MAX_NAME_LENGTH]; /* storage daemon address */
390 pthread_t heartbeat_id; /* id of heartbeat thread */
391 volatile bool hb_started; /* heartbeat running */
392 BSOCK *hb_bsock; /* duped SD socket */
393 BSOCK *hb_dir_bsock; /* duped DIR socket */
394 alist *RunScripts; /* Commands to run before and after job */
395 CRYPTO_CTX crypto; /* Crypto ctx */
396 DIRRES* director; /* Director resource */
397 bool VSS; /* VSS used by FD */
398 bool multi_restore; /* Dir can do multiple storage restore */
399 htable *file_list; /* Previous file list (accurate mode) */
400 uint64_t base_size; /* compute space saved with base job */
401 #endif /* FILE_DAEMON */
404 #ifdef STORAGE_DAEMON
405 /* Storage Daemon specific part of JCR */
406 JCR *next_dev; /* next JCR attached to device */
407 JCR *prev_dev; /* previous JCR attached to device */
408 char *dir_auth_key; /* Dir auth key */
409 pthread_cond_t job_start_wait; /* Wait for FD to start Job */
411 DCR *read_dcr; /* device context for reading */
412 DCR *dcr; /* device context record */
413 alist *dcrs; /* list of dcrs open */
414 POOLMEM *job_name; /* base Job name (not unique) */
415 POOLMEM *fileset_name; /* FileSet */
416 POOLMEM *fileset_md5; /* MD5 for FileSet */
417 VOL_LIST *VolList; /* list to read */
418 int32_t NumWriteVolumes; /* number of volumes written */
419 int32_t NumReadVolumes; /* total number of volumes to read */
420 int32_t CurReadVolume; /* current read volume number */
421 int32_t label_errors; /* count of label errors */
423 long Ticket; /* ticket for this job */
424 bool ignore_label_errors; /* ignore Volume label errors */
425 bool spool_attributes; /* set if spooling attributes */
426 bool no_attributes; /* set if no attributes wanted */
427 int64_t spool_size; /* Spool size for this job */
428 bool spool_data; /* set to spool data */
429 int32_t CurVol; /* Current Volume count */
430 DIRRES* director; /* Director resource */
431 alist *write_store; /* list of write storage devices sent by DIR */
432 alist *read_store; /* list of read devices sent by DIR */
433 alist *reserve_msgs; /* reserve fail messages */
434 bool write_part_after_job; /* Set to write part after job */
435 bool PreferMountedVols; /* Prefer mounted vols rather than new */
436 bool Resched; /* Job may be rescheduled */
438 /* Parmaters for Open Read Session */
439 BSR *bsr; /* Bootstrap record -- has everything */
440 bool mount_next_volume; /* set to cause next volume mount */
441 uint32_t read_VolSessionId;
442 uint32_t read_VolSessionTime;
443 uint32_t read_StartFile;
444 uint32_t read_EndFile;
445 uint32_t read_StartBlock;
446 uint32_t read_EndBlock;
447 /* Device wait times */
450 int32_t max_num_wait;
452 int32_t rem_wait_sec;
454 #endif /* STORAGE_DAEMON */
459 * Setting a NULL in tsd doesn't clear the tsd but instead tells
460 * pthreads not to call the tsd destructor. Consequently, we
461 * define this *invalid* jcr address and stuff it in the tsd
462 * when the jcr is not valid.
464 #define INVALID_JCR ((JCR *)(-1))
468 * Structure for all daemons that keeps some summary
469 * info on the last job run.
473 int32_t Errors; /* FD/SD errors */
478 uint32_t VolSessionId;
479 uint32_t VolSessionTime;
484 char Job[MAX_NAME_LENGTH];
487 extern struct s_last_job last_job;
488 extern DLL_IMP_EXP dlist *last_jobs;
491 /* The following routines are found in lib/jcr.c */
492 extern int get_next_jobid_from_list(char **p, uint32_t *JobId);
493 extern bool init_jcr_subsystem(void);
494 extern JCR *new_jcr(int size, JCR_free_HANDLER *daemon_free_jcr);
495 extern JCR *get_jcr_by_id(uint32_t JobId);
496 extern JCR *get_jcr_by_session(uint32_t SessionId, uint32_t SessionTime);
497 extern JCR *get_jcr_by_partial_name(char *Job);
498 extern JCR *get_jcr_by_full_name(char *Job);
499 extern JCR *get_next_jcr(JCR *jcr);
500 extern void set_jcr_job_status(JCR *jcr, int JobStatus);
501 extern int DLL_IMP_EXP num_jobs_run;
504 extern void b_free_jcr(const char *file, int line, JCR *jcr);
505 #define free_jcr(jcr) b_free_jcr(__FILE__, __LINE__, (jcr))
507 extern void free_jcr(JCR *jcr);
510 /* Used to display specific job information after a fatal signal */
511 typedef void (dbg_jcr_hook_t)(JCR *jcr, FILE *fp);
512 extern void dbg_jcr_add_hook(dbg_jcr_hook_t *fct);
514 #endif /* __JCR_H_ */