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