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