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 */
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() { 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 get_JobType() { return m_JobType; };
195 int32_t getJobType() { return m_JobType; };
196 int32_t get_JobLevel() { return m_JobLevel; };
197 int32_t getJobLevel() { return m_JobLevel; };
198 bool no_client_used() {
199 return (m_JobType == JT_MIGRATE || m_JobType == JT_COPY ||
200 m_JobLevel == L_VIRTUAL_FULL);
202 const char *get_OperationName(); /* in lib/jcr.c */
203 const char *get_ActionName(bool past); /* in lib/jcr.c */
204 void setJobStatus(int JobStatus); /* in lib/jcr.c */
205 bool JobReads(); /* in lib/jcr.c */
208 /* Global part of JCR common to all daemons */
209 dlink link; /* JCR chain link */
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 alist job_end_push; /* Job end pushed calls */
217 bool dequeuing; /* dequeuing messages */
218 POOLMEM *VolumeName; /* Volume name desired -- pool_memory */
219 POOLMEM *errmsg; /* edited error message */
220 char Job[MAX_NAME_LENGTH]; /* Unique name of this Job */
221 char event[MAX_NAME_LENGTH]; /* Current event (python) */
222 uint32_t eventType; /* Current event type (plugin) */
224 uint32_t JobId; /* Director's JobId */
225 uint32_t VolSessionId;
226 uint32_t VolSessionTime;
227 uint32_t JobFiles; /* Number of files written, this job */
228 uint32_t JobErrors; /* Number of non-fatal errors this job */
229 uint32_t JobWarnings; /* Number of warning messages */
230 uint64_t JobBytes; /* Number of bytes processed this job */
231 uint64_t ReadBytes; /* Bytes read -- before compression */
232 FileId_t FileId; /* Last FileId used */
233 volatile int32_t JobStatus; /* ready, running, blocked, terminated */
234 int32_t JobPriority; /* Job priority */
235 time_t sched_time; /* job schedule time, i.e. when it should start */
236 time_t start_time; /* when job actually started */
237 time_t run_time; /* used for computing speed */
238 time_t end_time; /* job end time */
239 time_t wait_time_sum; /* cumulative wait time since job start */
240 time_t wait_time; /* timestamp when job have started to wait */
241 POOLMEM *client_name; /* client name */
242 POOLMEM *RestoreBootstrap; /* Bootstrap file to restore */
243 POOLMEM *stime; /* start time for incremental/differential */
244 char *sd_auth_key; /* SD auth key */
245 MSGS *jcr_msgs; /* Copy of message resource -- actually used */
246 uint32_t ClientId; /* Client associated with Job */
247 char *where; /* prefix to restore files to */
248 char *RegexWhere; /* file relocation in restore */
249 alist *where_bregexp; /* BREGEXP alist for path manipulation */
250 int32_t cached_pnl; /* cached path length */
251 POOLMEM *cached_path; /* cached path */
252 bool prefix_links; /* Prefix links with Where path */
253 bool gui; /* set if gui using console */
254 bool authenticated; /* set when client authenticated */
255 void *Python_job; /* Python Job Object */
256 void *Python_events; /* Python Events Object */
258 bool cached_attribute; /* set if attribute is cached */
259 POOLMEM *attr; /* Attribute string from SD */
260 B_DB *db; /* database pointer */
261 B_DB *db_batch; /* database pointer for batch and accurate */
262 bool batch_started; /* is batch mode already started ? */
263 ATTR_DBR *ar; /* DB attribute record */
264 guid_list *id_list; /* User/group id to name list */
265 bool accurate; /* true if job is accurate */
267 bpContext *plugin_ctx_list; /* list of contexts for plugins */
268 bpContext *plugin_ctx; /* current plugin context */
269 Plugin *plugin; /* plugin instance */
270 save_pkt *plugin_sp; /* plugin save packet */
271 char *plugin_options; /* user set options for plugin */
272 bool cmd_plugin; /* Set when processing a command Plugin = */
274 /* Daemon specific part of JCR */
275 /* This should be empty in the library */
277 #ifdef DIRECTOR_DAEMON
278 /* Director Daemon specific data part of JCR */
279 pthread_t SD_msg_chan; /* Message channel thread id */
280 pthread_cond_t term_wait; /* Wait for job termination */
281 workq_ele_t *work_item; /* Work queue item if scheduled */
282 volatile bool sd_msg_thread_done; /* Set when Storage message thread done */
283 BSOCK *ua; /* User agent */
284 JOB *job; /* Job resource */
285 JOB *verify_job; /* Job resource of verify previous job */
286 alist *rstorage; /* Read storage possibilities */
287 STORE *rstore; /* Selected read storage */
288 alist *wstorage; /* Write storage possibilities */
289 STORE *wstore; /* Selected write storage */
290 CLIENT *client; /* Client resource */
291 POOL *pool; /* Pool resource = write for migration */
292 POOL *rpool; /* Read pool. Used only in migration */
293 POOL *full_pool; /* Full backup pool resource */
294 POOL *inc_pool; /* Incremental backup pool resource */
295 POOL *diff_pool; /* Differential backup pool resource */
296 bool run_pool_override;
297 bool run_full_pool_override;
298 bool run_inc_pool_override;
299 bool run_diff_pool_override;
300 FILESET *fileset; /* FileSet resource */
301 CAT *catalog; /* Catalog resource */
302 MSGS *messages; /* Default message handler */
303 uint32_t SDJobFiles; /* Number of files written, this job */
304 uint64_t SDJobBytes; /* Number of bytes processed this job */
305 uint32_t SDErrors; /* Number of non-fatal errors */
306 volatile int32_t SDJobStatus; /* Storage Job Status */
307 volatile int32_t FDJobStatus; /* File daemon Job Status */
308 uint32_t ExpectedFiles; /* Expected restore files */
309 uint32_t MediaId; /* DB record IDs associated with this job */
310 uint32_t FileIndex; /* Last FileIndex processed */
311 POOLMEM *fname; /* name to put into catalog */
312 JOB_DBR jr; /* Job DB record for current job */
313 JOB_DBR previous_jr; /* previous job database record */
314 JOB *previous_job; /* Job resource of migration previous job */
315 JCR *mig_jcr; /* JCR for migration/copy job */
316 char FSCreateTime[MAX_TIME_LENGTH]; /* FileSet CreateTime as returned from DB */
317 char since[MAX_TIME_LENGTH]; /* since time */
319 JobId_t RestoreJobId; /* Id specified by UA */
320 JobId_t MigrateJobId;
322 POOLMEM *client_uname; /* client uname */
323 POOLMEM *pool_source; /* Where pool came from */
324 POOLMEM *rpool_source; /* Where migrate read pool came from */
325 POOLMEM *rstore_source; /* Where read storage came from */
326 POOLMEM *wstore_source; /* Where write storage came from */
327 POOLMEM *catalog_source; /* Where catalog came from */
328 uint32_t replace; /* Replace option */
329 int32_t NumVols; /* Number of Volume used in pool */
330 int32_t reschedule_count; /* Number of times rescheduled */
331 int32_t FDVersion; /* File daemon version number */
332 int64_t spool_size; /* Spool size for this job */
333 bool spool_data; /* Spool data in SD */
334 bool acquired_resource_locks; /* set if resource locks acquired */
335 bool term_wait_inited; /* Set when cond var inited */
336 bool fn_printed; /* printed filename */
337 bool write_part_after_job; /* Write part after job in SD */
338 bool needs_sd; /* set if SD needed by Job */
339 bool cloned; /* set if cloned */
340 bool unlink_bsr; /* Unlink bsr file created */
341 bool VSS; /* VSS used by FD */
342 bool Encrypt; /* Encryption used by FD */
343 bool stats_enabled; /* Keep all job records in a table for long term statistics */
344 bool no_maxtime; /* Don't check Max*Time for this JCR */
345 bool keep_sd_auth_key; /* Clear or not the SD auth key after connection*/
346 #endif /* DIRECTOR_DAEMON */
350 /* File Daemon specific part of JCR */
351 uint32_t num_files_examined; /* files examined this job */
352 POOLMEM *last_fname; /* last file saved/verified */
353 acl_data_t *acl_data; /* ACLs for backup/restore */
354 xattr_data_t *xattr_data; /* Extended Attributes for backup/restore */
355 int32_t last_type; /* type of last file saved/verified */
356 int incremental; /* set if incremental for SINCE */
357 utime_t mtime; /* begin time for SINCE */
358 int listing; /* job listing in estimate */
359 long Ticket; /* Ticket */
360 char *big_buf; /* I/O buffer */
361 POOLMEM *compress_buf; /* Compression buffer */
362 int32_t compress_buf_size; /* Length of compression buffer */
363 void *pZLIB_compress_workset; /* zlib compression session data */
364 int32_t replace; /* Replace options */
365 int32_t buf_size; /* length of buffer */
366 FF_PKT *ff; /* Find Files packet */
367 char stored_addr[MAX_NAME_LENGTH]; /* storage daemon address */
372 pthread_t heartbeat_id; /* id of heartbeat thread */
373 volatile bool hb_started; /* heartbeat running */
374 BSOCK *hb_bsock; /* duped SD socket */
375 BSOCK *hb_dir_bsock; /* duped DIR socket */
376 alist *RunScripts; /* Commands to run before and after job */
377 CRYPTO_CTX crypto; /* Crypto ctx */
378 DIRRES* director; /* Director resource */
379 bool VSS; /* VSS used by FD */
380 bool multi_restore; /* Dir can do multiple storage restore */
381 htable *file_list; /* Previous file list (accurate mode) */
382 #endif /* FILE_DAEMON */
385 #ifdef STORAGE_DAEMON
386 /* Storage Daemon specific part of JCR */
387 JCR *next_dev; /* next JCR attached to device */
388 JCR *prev_dev; /* previous JCR attached to device */
389 char *dir_auth_key; /* Dir auth key */
390 pthread_cond_t job_start_wait; /* Wait for FD to start Job */
392 DCR *read_dcr; /* device context for reading */
393 DCR *dcr; /* device context record */
394 alist *dcrs; /* list of dcrs open */
395 POOLMEM *job_name; /* base Job name (not unique) */
396 POOLMEM *fileset_name; /* FileSet */
397 POOLMEM *fileset_md5; /* MD5 for FileSet */
398 VOL_LIST *VolList; /* list to read */
399 int32_t NumWriteVolumes; /* number of volumes written */
400 int32_t NumReadVolumes; /* total number of volumes to read */
401 int32_t CurReadVolume; /* current read volume number */
402 int32_t label_errors; /* count of label errors */
404 long Ticket; /* ticket for this job */
405 bool ignore_label_errors; /* ignore Volume label errors */
406 bool spool_attributes; /* set if spooling attributes */
407 bool no_attributes; /* set if no attributes wanted */
408 int64_t spool_size; /* Spool size for this job */
409 bool spool_data; /* set to spool data */
410 int32_t CurVol; /* Current Volume count */
411 DIRRES* director; /* Director resource */
412 alist *write_store; /* list of write storage devices sent by DIR */
413 alist *read_store; /* list of read devices sent by DIR */
414 alist *reserve_msgs; /* reserve fail messages */
415 bool write_part_after_job; /* Set to write part after job */
416 bool PreferMountedVols; /* Prefer mounted vols rather than new */
418 /* Parmaters for Open Read Session */
419 BSR *bsr; /* Bootstrap record -- has everything */
420 bool mount_next_volume; /* set to cause next volume mount */
421 uint32_t read_VolSessionId;
422 uint32_t read_VolSessionTime;
423 uint32_t read_StartFile;
424 uint32_t read_EndFile;
425 uint32_t read_StartBlock;
426 uint32_t read_EndBlock;
427 /* Device wait times */
430 int32_t max_num_wait;
432 int32_t rem_wait_sec;
434 #endif /* STORAGE_DAEMON */
439 * Setting a NULL in tsd doesn't clear the tsd but instead tells
440 * pthreads not to call the tsd destructor. Consequently, we
441 * define this *invalid* jcr address and stuff it in the tsd
442 * when the jcr is not valid.
444 #define INVALID_JCR ((JCR *)(-1))
448 * Structure for all daemons that keeps some summary
449 * info on the last job run.
453 int32_t Errors; /* FD/SD errors */
458 uint32_t VolSessionId;
459 uint32_t VolSessionTime;
464 char Job[MAX_NAME_LENGTH];
467 extern struct s_last_job last_job;
468 extern DLL_IMP_EXP dlist * last_jobs;
471 /* The following routines are found in lib/jcr.c */
472 extern int get_next_jobid_from_list(char **p, uint32_t *JobId);
473 extern bool init_jcr_subsystem(void);
474 extern JCR *new_jcr(int size, JCR_free_HANDLER *daemon_free_jcr);
475 extern JCR *get_jcr_by_id(uint32_t JobId);
476 extern JCR *get_jcr_by_session(uint32_t SessionId, uint32_t SessionTime);
477 extern JCR *get_jcr_by_partial_name(char *Job);
478 extern JCR *get_jcr_by_full_name(char *Job);
479 extern JCR *get_next_jcr(JCR *jcr);
480 extern void set_jcr_job_status(JCR *jcr, int JobStatus);
481 extern int DLL_IMP_EXP num_jobs_run;
484 extern void b_free_jcr(const char *file, int line, JCR *jcr);
485 #define free_jcr(jcr) b_free_jcr(__FILE__, __LINE__, (jcr))
487 extern void free_jcr(JCR *jcr);
490 /* Used to display specific job information after a fatal signal */
491 typedef void (dbg_jcr_hook_t)(JCR *jcr, FILE *fp);
492 extern void dbg_jcr_add_hook(dbg_jcr_hook_t *fct);
494 #endif /* __JCR_H_ */