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_WaitDevice 'q' /* Queued waiting for device */
97 #define JS_WaitStoreRes 's' /* Waiting for storage resource */
98 #define JS_WaitStartTime 't' /* Waiting for start time */
101 /* Migration selection types */
107 MT_POOL_UNCOPIED_JOBS,
114 #define job_canceled(jcr) \
115 (jcr->JobStatus == JS_Canceled || \
116 jcr->JobStatus == JS_ErrorTerminated || \
117 jcr->JobStatus == JS_FatalError \
120 #define job_waiting(jcr) \
121 (jcr->JobStatus == JS_WaitFD || \
122 jcr->JobStatus == JS_WaitSD || \
123 jcr->JobStatus == JS_WaitMedia || \
124 jcr->JobStatus == JS_WaitMount || \
125 jcr->JobStatus == JS_WaitStoreRes || \
126 jcr->JobStatus == JS_WaitJobRes || \
127 jcr->JobStatus == JS_WaitClientRes|| \
128 jcr->JobStatus == JS_WaitMaxJobs || \
129 jcr->JobStatus == JS_WaitPriority || \
130 jcr->SDJobStatus == JS_WaitMedia || \
131 jcr->SDJobStatus == JS_WaitMount || \
132 jcr->SDJobStatus == JS_WaitDevice || \
133 jcr->SDJobStatus == JS_WaitMaxJobs)
137 #define foreach_jcr(jcr) \
138 for (jcr=jcr_walk_start(); jcr; (jcr=jcr_walk_next(jcr)) )
140 #define endeach_jcr(jcr) jcr_walk_end(jcr)
145 /* Forward referenced structures */
154 struct xattr_private_data_t;
162 bool pki_sign; /* Enable PKI Signatures? */
163 bool pki_encrypt; /* Enable PKI Encryption? */
164 DIGEST *digest; /* Last file's digest context */
165 X509_KEYPAIR *pki_keypair; /* Encryption key pair */
166 alist *pki_signers; /* Trusted Signers */
167 alist *pki_recipients; /* Trusted Recipients */
168 CRYPTO_SESSION *pki_session; /* PKE Public Keys + Symmetric Session Keys */
169 POOLMEM *pki_session_encoded; /* Cached DER-encoded copy of pki_session */
170 int32_t pki_session_encoded_size; /* Size of DER-encoded pki_session */
171 POOLMEM *crypto_buf; /* Encryption/Decryption buffer */
175 typedef void (JCR_free_HANDLER)(JCR *jcr);
177 /* Job Control Record (JCR) */
180 pthread_mutex_t mutex; /* jcr mutex */
181 volatile int32_t _use_count; /* use count */
182 int32_t m_JobType; /* backup, restore, verify ... */
183 int32_t m_JobLevel; /* Job level */
184 bool my_thread_killable; /* can we kill the thread? */
186 void lock() {P(mutex); };
187 void unlock() {V(mutex); };
188 void inc_use_count(void) {lock(); _use_count++; unlock(); };
189 void dec_use_count(void) {lock(); _use_count--; unlock(); };
190 int32_t use_count() const { return _use_count; };
191 void init_mutex(void) {pthread_mutex_init(&mutex, NULL); };
192 void destroy_mutex(void) {pthread_mutex_destroy(&mutex); };
193 bool is_job_canceled() {return job_canceled(this); };
194 bool is_canceled() {return job_canceled(this); };
195 bool is_incomplete() { return JobStatus == JS_Incomplete; };
196 bool is_JobLevel(int32_t JobLevel) { return JobLevel == m_JobLevel; };
197 bool is_JobType(int32_t JobType) { return JobType == m_JobType; };
198 bool is_JobStatus(int32_t aJobStatus) { return aJobStatus == JobStatus; };
199 void setJobLevel(int32_t JobLevel) { m_JobLevel = JobLevel; };
200 void setJobType(int32_t JobType) { m_JobType = JobType; };
201 void forceJobStatus(int32_t aJobStatus) { JobStatus = aJobStatus; };
202 int32_t getJobType() const { return m_JobType; };
203 int32_t getJobLevel() const { return m_JobLevel; };
204 int32_t getJobStatus() const { return JobStatus; };
205 bool no_client_used() const {
206 return (m_JobType == JT_MIGRATE || m_JobType == JT_COPY ||
207 m_JobLevel == L_VIRTUAL_FULL);
209 const char *get_OperationName(); /* in lib/jcr.c */
210 const char *get_ActionName(bool past); /* in lib/jcr.c */
211 void setJobStatus(int newJobStatus); /* in lib/jcr.c */
212 bool sendJobStatus(); /* in lib/jcr.c */
213 bool sendJobStatus(int newJobStatus); /* in lib/jcr.c */
214 bool JobReads(); /* in lib/jcr.c */
215 void my_thread_send_signal(int sig); /* in lib/jcr.c */
216 void set_killable(bool killable); /* in lib/jcr.c */
217 bool is_killable() const { return my_thread_killable; };
219 /* Global part of JCR common to all daemons */
220 dlink link; /* JCR chain link */
221 pthread_t my_thread_id; /* id of thread controlling jcr */
222 BSOCK *dir_bsock; /* Director bsock or NULL if we are him */
223 BSOCK *store_bsock; /* Storage connection socket */
224 BSOCK *file_bsock; /* File daemon connection socket */
225 JCR_free_HANDLER *daemon_free_jcr; /* Local free routine */
226 dlist *msg_queue; /* Queued messages */
227 pthread_mutex_t msg_queue_mutex; /* message queue mutex */
228 bool dequeuing_msgs; /* Set when dequeuing messages */
229 alist job_end_push; /* Job end pushed calls */
230 POOLMEM *VolumeName; /* Volume name desired -- pool_memory */
231 POOLMEM *errmsg; /* edited error message */
232 char Job[MAX_NAME_LENGTH]; /* Unique name of this Job */
233 char event[MAX_NAME_LENGTH]; /* Current event (python) */
234 uint32_t eventType; /* Current event type (plugin) */
236 uint32_t JobId; /* Director's JobId */
237 uint32_t VolSessionId;
238 uint32_t VolSessionTime;
239 uint32_t JobFiles; /* Number of files written, this job */
240 uint32_t JobErrors; /* Number of non-fatal errors this job */
241 uint32_t JobWarnings; /* Number of warning messages */
242 uint64_t JobBytes; /* Number of bytes processed this job */
243 uint64_t ReadBytes; /* Bytes read -- before compression */
244 FileId_t FileId; /* Last FileId used */
245 volatile int32_t JobStatus; /* ready, running, blocked, terminated */
246 int32_t JobPriority; /* Job priority */
247 time_t sched_time; /* job schedule time, i.e. when it should start */
248 time_t start_time; /* when job actually started */
249 time_t run_time; /* used for computing speed */
250 time_t end_time; /* job end time */
251 time_t wait_time_sum; /* cumulative wait time since job start */
252 time_t wait_time; /* timestamp when job have started to wait */
253 POOLMEM *client_name; /* client name */
254 POOLMEM *JobIds; /* User entered string of JobIds */
255 POOLMEM *RestoreBootstrap; /* Bootstrap file to restore */
256 POOLMEM *stime; /* start time for incremental/differential */
257 char *sd_auth_key; /* SD auth key */
258 MSGS *jcr_msgs; /* Copy of message resource -- actually used */
259 uint32_t ClientId; /* Client associated with Job */
260 char *where; /* prefix to restore files to */
261 char *RegexWhere; /* file relocation in restore */
262 alist *where_bregexp; /* BREGEXP alist for path manipulation */
263 int32_t cached_pnl; /* cached path length */
264 POOLMEM *cached_path; /* cached path */
265 bool prefix_links; /* Prefix links with Where path */
266 bool gui; /* set if gui using console */
267 bool authenticated; /* set when client authenticated */
268 bool cached_attribute; /* set if attribute is cached */
269 bool batch_started; /* is batch mode already started ? */
270 bool cmd_plugin; /* Set when processing a command Plugin = */
271 bool opt_plugin; /* Set when processing an option Plugin = */
272 bool keep_path_list; /* Keep newly created path in a hash */
273 bool accurate; /* true if job is accurate */
274 bool HasBase; /* True if job use base jobs */
275 bool rerunning; /* rerunning an incomplete job */
277 void *Python_job; /* Python Job Object */
278 void *Python_events; /* Python Events Object */
279 POOLMEM *attr; /* Attribute string from SD */
280 B_DB *db; /* database pointer */
281 B_DB *db_batch; /* database pointer for batch and accurate */
282 uint64_t nb_base_files; /* Number of base files */
283 uint64_t nb_base_files_used; /* Number of useful files in base */
285 ATTR_DBR *ar; /* DB attribute record */
286 guid_list *id_list; /* User/group id to name list */
288 bpContext *plugin_ctx_list; /* list of contexts for plugins */
289 bpContext *plugin_ctx; /* current plugin context */
290 Plugin *plugin; /* plugin instance */
291 save_pkt *plugin_sp; /* plugin save packet */
292 char *plugin_options; /* user set options for plugin */
293 POOLMEM *comment; /* Comment for this Job */
294 int64_t max_bandwidth; /* Bandwidth limit for this Job */
295 htable *path_list; /* Directory list (used by findlib) */
297 /* Daemon specific part of JCR */
298 /* This should be empty in the library */
300 #ifdef DIRECTOR_DAEMON
301 /* Director Daemon specific data part of JCR */
302 pthread_t SD_msg_chan; /* Message channel thread id */
303 pthread_cond_t term_wait; /* Wait for job termination */
304 workq_ele_t *work_item; /* Work queue item if scheduled */
305 BSOCK *ua; /* User agent */
306 JOB *job; /* Job resource */
307 JOB *verify_job; /* Job resource of verify previous job */
308 alist *rstorage; /* Read storage possibilities */
309 STORE *rstore; /* Selected read storage */
310 alist *wstorage; /* Write storage possibilities */
311 STORE *wstore; /* Selected write storage */
312 CLIENT *client; /* Client resource */
313 POOL *pool; /* Pool resource = write for migration */
314 POOL *rpool; /* Read pool. Used only in migration */
315 POOL *full_pool; /* Full backup pool resource */
316 POOL *inc_pool; /* Incremental backup pool resource */
317 POOL *diff_pool; /* Differential backup pool resource */
318 FILESET *fileset; /* FileSet resource */
319 CAT *catalog; /* Catalog resource */
320 MSGS *messages; /* Default message handler */
321 uint32_t SDJobFiles; /* Number of files written, this job */
322 uint64_t SDJobBytes; /* Number of bytes processed this job */
323 uint32_t SDErrors; /* Number of non-fatal errors */
324 volatile int32_t SDJobStatus; /* Storage Job Status */
325 volatile int32_t FDJobStatus; /* File daemon Job Status */
326 uint32_t ExpectedFiles; /* Expected restore files */
327 uint32_t MediaId; /* DB record IDs associated with this job */
328 uint32_t FileIndex; /* Last FileIndex processed */
329 utime_t MaxRunSchedTime; /* max run time in seconds from Scheduled time*/
330 POOLMEM *fname; /* name to put into catalog */
331 JOB_DBR jr; /* Job DB record for current job */
332 JOB_DBR previous_jr; /* previous job database record */
333 JOB *previous_job; /* Job resource of migration previous job */
334 JCR *mig_jcr; /* JCR for migration/copy job */
335 char FSCreateTime[MAX_TIME_LENGTH]; /* FileSet CreateTime as returned from DB */
336 char since[MAX_TIME_LENGTH]; /* since time */
338 JobId_t RestoreJobId; /* Id specified by UA */
339 JobId_t MigrateJobId;
341 POOLMEM *client_uname; /* client uname */
342 POOLMEM *pool_source; /* Where pool came from */
343 POOLMEM *rpool_source; /* Where migrate read pool came from */
344 POOLMEM *rstore_source; /* Where read storage came from */
345 POOLMEM *wstore_source; /* Where write storage came from */
346 POOLMEM *catalog_source; /* Where catalog came from */
347 uint32_t replace; /* Replace option */
348 int32_t NumVols; /* Number of Volume used in pool */
349 int32_t reschedule_count; /* Number of times rescheduled */
350 int32_t FDVersion; /* File daemon version number */
351 int64_t spool_size; /* Spool size for this job */
352 volatile bool sd_msg_thread_done; /* Set when Storage message thread done */
353 bool wasVirtualFull; /* set if job was VirtualFull */
354 bool IgnoreDuplicateJobChecking; /* set in migration jobs */
355 bool spool_data; /* Spool data in SD */
356 bool acquired_resource_locks; /* set if resource locks acquired */
357 bool term_wait_inited; /* Set when cond var inited */
358 bool fn_printed; /* printed filename */
359 bool write_part_after_job; /* Write part after job in SD */
360 bool needs_sd; /* set if SD needed by Job */
361 bool cloned; /* set if cloned */
362 bool unlink_bsr; /* Unlink bsr file created */
363 bool VSS; /* VSS used by FD */
364 bool Encrypt; /* Encryption used by FD */
365 bool stats_enabled; /* Keep all job records in a table for long term statistics */
366 bool no_maxtime; /* Don't check Max*Time for this JCR */
367 bool keep_sd_auth_key; /* Clear or not the SD auth key after connection*/
368 bool use_accurate_chksum; /* Use or not checksum option in accurate code */
369 bool run_pool_override;
370 bool run_full_pool_override;
371 bool run_inc_pool_override;
372 bool run_diff_pool_override;
373 bool sd_canceled; /* set if SD canceled */
374 bool RescheduleIncompleteJobs; /* set if incomplete can be rescheduled */
375 #endif /* DIRECTOR_DAEMON */
379 /* File Daemon specific part of JCR */
380 uint32_t num_files_examined; /* files examined this job */
381 POOLMEM *last_fname; /* last file saved/verified */
382 POOLMEM *job_metadata; /* VSS job metadata */
383 acl_data_t *acl_data; /* ACLs for backup/restore */
384 xattr_data_t *xattr_data; /* Extended Attributes for backup/restore */
385 int32_t last_type; /* type of last file saved/verified */
386 int incremental; /* set if incremental for SINCE */
387 utime_t mtime; /* begin time for SINCE */
388 int listing; /* job listing in estimate */
389 long Ticket; /* Ticket */
390 char *big_buf; /* I/O buffer */
391 POOLMEM *compress_buf; /* Compression buffer */
392 int32_t compress_buf_size; /* Length of compression buffer */
393 void *pZLIB_compress_workset; /* zlib compression session data */
394 void *LZO_compress_workset; /* lzo compression session data */
395 int32_t replace; /* Replace options */
396 int32_t buf_size; /* length of buffer */
397 FF_PKT *ff; /* Find Files packet */
398 char stored_addr[MAX_NAME_LENGTH]; /* storage daemon address */
403 pthread_t heartbeat_id; /* id of heartbeat thread */
404 volatile bool hb_started; /* heartbeat running */
405 BSOCK *hb_bsock; /* duped SD socket */
406 BSOCK *hb_dir_bsock; /* duped DIR socket */
407 alist *RunScripts; /* Commands to run before and after job */
408 CRYPTO_CTX crypto; /* Crypto ctx */
409 DIRRES* director; /* Director resource */
410 bool VSS; /* VSS used by FD */
411 bool multi_restore; /* Dir can do multiple storage restore */
412 htable *file_list; /* Previous file list (accurate mode) */
413 uint64_t base_size; /* compute space saved with base job */
414 #endif /* FILE_DAEMON */
417 #ifdef STORAGE_DAEMON
418 /* Storage Daemon specific part of JCR */
419 JCR *next_dev; /* next JCR attached to device */
420 JCR *prev_dev; /* previous JCR attached to device */
421 char *dir_auth_key; /* Dir auth key */
422 pthread_cond_t job_start_wait; /* Wait for FD to start Job */
424 DCR *read_dcr; /* device context for reading */
425 DCR *dcr; /* device context record */
426 alist *dcrs; /* list of dcrs open */
427 POOLMEM *job_name; /* base Job name (not unique) */
428 POOLMEM *fileset_name; /* FileSet */
429 POOLMEM *fileset_md5; /* MD5 for FileSet */
430 VOL_LIST *VolList; /* list to read */
431 int32_t NumWriteVolumes; /* number of volumes written */
432 int32_t NumReadVolumes; /* total number of volumes to read */
433 int32_t CurReadVolume; /* current read volume number */
434 int32_t label_errors; /* count of label errors */
436 long Ticket; /* ticket for this job */
437 bool ignore_label_errors; /* ignore Volume label errors */
438 bool spool_attributes; /* set if spooling attributes */
439 bool no_attributes; /* set if no attributes wanted */
440 int64_t spool_size; /* Spool size for this job */
441 bool spool_data; /* set to spool data */
442 int32_t CurVol; /* Current Volume count */
443 DIRRES* director; /* Director resource */
444 alist *write_store; /* list of write storage devices sent by DIR */
445 alist *read_store; /* list of read devices sent by DIR */
446 alist *reserve_msgs; /* reserve fail messages */
447 bool write_part_after_job; /* Set to write part after job */
448 bool PreferMountedVols; /* Prefer mounted vols rather than new */
449 bool Resched; /* Job may be rescheduled */
450 bool bscan_insert_jobmedia_records; /*Bscan: needs to insert job media records */
452 /* Parmaters for Open Read Session */
453 BSR *bsr; /* Bootstrap record -- has everything */
454 bool mount_next_volume; /* set to cause next volume mount */
455 uint32_t read_VolSessionId;
456 uint32_t read_VolSessionTime;
457 uint32_t read_StartFile;
458 uint32_t read_EndFile;
459 uint32_t read_StartBlock;
460 uint32_t read_EndBlock;
461 /* Device wait times */
464 int32_t max_num_wait;
466 int32_t rem_wait_sec;
468 #endif /* STORAGE_DAEMON */
473 * Setting a NULL in tsd doesn't clear the tsd but instead tells
474 * pthreads not to call the tsd destructor. Consequently, we
475 * define this *invalid* jcr address and stuff it in the tsd
476 * when the jcr is not valid.
478 #define INVALID_JCR ((JCR *)(-1))
482 * Structure for all daemons that keeps some summary
483 * info on the last job run.
487 int32_t Errors; /* FD/SD errors */
492 uint32_t VolSessionId;
493 uint32_t VolSessionTime;
498 char Job[MAX_NAME_LENGTH];
501 extern struct s_last_job last_job;
502 extern DLL_IMP_EXP dlist *last_jobs;
505 /* The following routines are found in lib/jcr.c */
506 extern int get_next_jobid_from_list(char **p, uint32_t *JobId);
507 extern bool init_jcr_subsystem(void);
508 extern JCR *new_jcr(int size, JCR_free_HANDLER *daemon_free_jcr);
509 extern JCR *get_jcr_by_id(uint32_t JobId);
510 extern JCR *get_jcr_by_session(uint32_t SessionId, uint32_t SessionTime);
511 extern JCR *get_jcr_by_partial_name(char *Job);
512 extern JCR *get_jcr_by_full_name(char *Job);
513 extern JCR *get_next_jcr(JCR *jcr);
514 extern void set_jcr_job_status(JCR *jcr, int JobStatus);
515 extern int DLL_IMP_EXP num_jobs_run;
518 extern void b_free_jcr(const char *file, int line, JCR *jcr);
519 #define free_jcr(jcr) b_free_jcr(__FILE__, __LINE__, (jcr))
521 extern void free_jcr(JCR *jcr);
524 /* Used to display specific job information after a fatal signal */
525 typedef void (dbg_jcr_hook_t)(JCR *jcr, FILE *fp);
526 extern void dbg_jcr_add_hook(dbg_jcr_hook_t *fct);
528 #endif /* __JCR_H_ */