2 Bacula® - The Network Backup Solution
4 Copyright (C) 2000-2008 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_ErrorTerminated 'E' /* Job terminated in error */
78 #define JS_Error 'e' /* Non-fatal error */
79 #define JS_FatalError 'f' /* Fatal error */
80 #define JS_Differences 'D' /* Verify differences */
81 #define JS_Canceled 'A' /* canceled by user */
82 #define JS_WaitFD 'F' /* waiting on File daemon */
83 #define JS_WaitSD 'S' /* waiting on the Storage daemon */
84 #define JS_WaitMedia 'm' /* waiting for new media */
85 #define JS_WaitMount 'M' /* waiting for Mount */
86 #define JS_WaitStoreRes 's' /* Waiting for storage resource */
87 #define JS_WaitJobRes 'j' /* Waiting for job resource */
88 #define JS_WaitClientRes 'c' /* Waiting for Client resource */
89 #define JS_WaitMaxJobs 'd' /* Waiting for maximum jobs */
90 #define JS_WaitStartTime 't' /* Waiting for start time */
91 #define JS_WaitPriority 'p' /* Waiting for higher priority jobs to finish */
92 #define JS_AttrDespooling 'a' /* SD despooling attributes */
93 #define JS_AttrInserting 'i' /* Doing batch insert file records */
94 #define JS_DataDespooling 'l' /* Doing data despooling */
95 #define JS_DataCommitting 'L' /* Committing data (last despool) */
97 /* Migration selection types */
103 MT_POOL_UNCOPIED_JOBS,
110 #define job_canceled(jcr) \
111 (jcr->JobStatus == JS_Canceled || \
112 jcr->JobStatus == JS_ErrorTerminated || \
113 jcr->JobStatus == JS_FatalError)
115 #define job_waiting(jcr) \
116 (jcr->JobStatus == JS_WaitFD || \
117 jcr->JobStatus == JS_WaitSD || \
118 jcr->JobStatus == JS_WaitMedia || \
119 jcr->JobStatus == JS_WaitMount || \
120 jcr->JobStatus == JS_WaitStoreRes || \
121 jcr->JobStatus == JS_WaitJobRes || \
122 jcr->JobStatus == JS_WaitClientRes|| \
123 jcr->JobStatus == JS_WaitMaxJobs || \
124 jcr->JobStatus == JS_WaitPriority || \
125 jcr->SDJobStatus == JS_WaitMedia || \
126 jcr->SDJobStatus == JS_WaitMount || \
127 jcr->SDJobStatus == JS_WaitMaxJobs)
131 #define foreach_jcr(jcr) \
132 for (jcr=jcr_walk_start(); jcr; (jcr=jcr_walk_next(jcr)) )
134 #define endeach_jcr(jcr) jcr_walk_end(jcr)
139 /* Forward referenced structures */
152 bool pki_sign; /* Enable PKI Signatures? */
153 bool pki_encrypt; /* Enable PKI Encryption? */
154 DIGEST *digest; /* Last file's digest context */
155 X509_KEYPAIR *pki_keypair; /* Encryption key pair */
156 alist *pki_signers; /* Trusted Signers */
157 alist *pki_recipients; /* Trusted Recipients */
158 CRYPTO_SESSION *pki_session; /* PKE Public Keys + Symmetric Session Keys */
159 POOLMEM *pki_session_encoded; /* Cached DER-encoded copy of pki_session */
160 int32_t pki_session_encoded_size; /* Size of DER-encoded pki_session */
161 POOLMEM *crypto_buf; /* Encryption/Decryption buffer */
165 typedef void (JCR_free_HANDLER)(JCR *jcr);
167 /* Job Control Record (JCR) */
170 pthread_mutex_t mutex; /* jcr mutex */
171 volatile int32_t _use_count; /* use count */
172 int32_t m_JobType; /* backup, restore, verify ... */
173 int32_t m_JobLevel; /* Job level */
175 void lock() {P(mutex); };
176 void unlock() {V(mutex); };
177 void inc_use_count(void) {lock(); _use_count++; unlock(); };
178 void dec_use_count(void) {lock(); _use_count--; unlock(); };
179 int32_t use_count() { return _use_count; };
180 void init_mutex(void) {pthread_mutex_init(&mutex, NULL); };
181 void destroy_mutex(void) {pthread_mutex_destroy(&mutex); };
182 bool is_job_canceled() {return job_canceled(this); };
183 int32_t get_JobType() { return m_JobType; };
184 int32_t get_JobLevel() { return m_JobLevel; };
186 const char *get_OperationName(); /* in lib/jcr.c */
187 const char *get_ActionName(bool past); /* in lib/jcr.c */
188 void set_JobLevel(int32_t JobLevel); /* in lib/jcr.c */
189 void set_JobType(int32_t JobType); /* in lib/jcr.c */
190 bool JobReads(); /* in lib/jcr.c */
192 /* Global part of JCR common to all daemons */
193 dlink link; /* JCR chain link */
194 pthread_t my_thread_id; /* id of thread controlling jcr */
195 BSOCK *dir_bsock; /* Director bsock or NULL if we are him */
196 BSOCK *store_bsock; /* Storage connection socket */
197 BSOCK *file_bsock; /* File daemon connection socket */
198 JCR_free_HANDLER *daemon_free_jcr; /* Local free routine */
199 dlist *msg_queue; /* Queued messages */
200 alist job_end_push; /* Job end pushed calls */
201 bool dequeuing; /* dequeuing messages */
202 POOLMEM *VolumeName; /* Volume name desired -- pool_memory */
203 POOLMEM *errmsg; /* edited error message */
204 char Job[MAX_NAME_LENGTH]; /* Unique name of this Job */
205 char event[MAX_NAME_LENGTH]; /* Current event (python) */
206 uint32_t eventType; /* Current event type (plugin) */
208 uint32_t JobId; /* Director's JobId */
209 uint32_t VolSessionId;
210 uint32_t VolSessionTime;
211 uint32_t JobFiles; /* Number of files written, this job */
212 uint32_t JobErrors; /* */
213 uint64_t JobBytes; /* Number of bytes processed this job */
214 uint64_t ReadBytes; /* Bytes read -- before compression */
215 FileId_t FileId; /* Last FileId used */
216 uint32_t Errors; /* Number of non-fatal errors */
217 volatile int32_t JobStatus; /* ready, running, blocked, terminated */
218 int32_t JobPriority; /* Job priority */
219 time_t sched_time; /* job schedule time, i.e. when it should start */
220 time_t start_time; /* when job actually started */
221 time_t run_time; /* used for computing speed */
222 time_t end_time; /* job end time */
223 time_t wait_time_sum; /* cumulative wait time since job start */
224 time_t wait_time; /* timestamp when job have started to wait */
225 POOLMEM *client_name; /* client name */
226 POOLMEM *RestoreBootstrap; /* Bootstrap file to restore */
227 POOLMEM *stime; /* start time for incremental/differential */
228 char *sd_auth_key; /* SD auth key */
229 MSGS *jcr_msgs; /* Copy of message resource -- actually used */
230 uint32_t ClientId; /* Client associated with Job */
231 char *where; /* prefix to restore files to */
232 char *RegexWhere; /* file relocation in restore */
233 alist *where_bregexp; /* BREGEXP alist for path manipulation */
234 int32_t cached_pnl; /* cached path length */
235 POOLMEM *cached_path; /* cached path */
236 bool prefix_links; /* Prefix links with Where path */
237 bool gui; /* set if gui using console */
238 bool authenticated; /* set when client authenticated */
239 void *Python_job; /* Python Job Object */
240 void *Python_events; /* Python Events Object */
242 bool cached_attribute; /* set if attribute is cached */
243 POOLMEM *attr; /* Attribute string from SD */
244 B_DB *db; /* database pointer */
245 B_DB *db_batch; /* database pointer for batch and accurate */
246 bool batch_started; /* is batch mode already started ? */
247 ATTR_DBR *ar; /* DB attribute record */
248 guid_list *id_list; /* User/group id to name list */
249 bool accurate; /* true if job is accurate */
251 bpContext *plugin_ctx_list; /* list of contexts for plugins */
252 bpContext *plugin_ctx; /* current plugin context */
253 Plugin *plugin; /* plugin instance */
254 save_pkt *plugin_sp; /* plugin save packet */
255 char *plugin_options; /* user set options for plugin */
256 bool cmd_plugin; /* Set when processing a command Plugin = */
258 /* Daemon specific part of JCR */
259 /* This should be empty in the library */
261 #ifdef DIRECTOR_DAEMON
262 /* Director Daemon specific data part of JCR */
263 pthread_t SD_msg_chan; /* Message channel thread id */
264 pthread_cond_t term_wait; /* Wait for job termination */
265 workq_ele_t *work_item; /* Work queue item if scheduled */
266 volatile bool sd_msg_thread_done; /* Set when Storage message thread done */
267 BSOCK *ua; /* User agent */
268 JOB *job; /* Job resource */
269 JOB *verify_job; /* Job resource of verify previous job */
270 alist *rstorage; /* Read storage possibilities */
271 STORE *rstore; /* Selected read storage */
272 alist *wstorage; /* Write storage possibilities */
273 STORE *wstore; /* Selected write storage */
274 CLIENT *client; /* Client resource */
275 POOL *pool; /* Pool resource = write for migration */
276 POOL *rpool; /* Read pool. Used only in migration */
277 POOL *full_pool; /* Full backup pool resource */
278 POOL *inc_pool; /* Incremental backup pool resource */
279 POOL *diff_pool; /* Differential backup pool resource */
280 bool run_pool_override;
281 bool run_full_pool_override;
282 bool run_inc_pool_override;
283 bool run_diff_pool_override;
284 FILESET *fileset; /* FileSet resource */
285 CAT *catalog; /* Catalog resource */
286 MSGS *messages; /* Default message handler */
287 uint32_t SDJobFiles; /* Number of files written, this job */
288 uint64_t SDJobBytes; /* Number of bytes processed this job */
289 uint32_t SDErrors; /* Number of non-fatal errors */
290 volatile int32_t SDJobStatus; /* Storage Job Status */
291 volatile int32_t FDJobStatus; /* File daemon Job Status */
292 uint32_t ExpectedFiles; /* Expected restore files */
293 uint32_t MediaId; /* DB record IDs associated with this job */
294 uint32_t FileIndex; /* Last FileIndex processed */
295 POOLMEM *fname; /* name to put into catalog */
296 JOB_DBR jr; /* Job DB record for current job */
297 JOB_DBR previous_jr; /* previous job database record */
298 JOB *previous_job; /* Job resource of migration previous job */
299 JCR *mig_jcr; /* JCR for migration/copy job */
300 char FSCreateTime[MAX_TIME_LENGTH]; /* FileSet CreateTime as returned from DB */
301 char since[MAX_TIME_LENGTH]; /* since time */
303 JobId_t RestoreJobId; /* Id specified by UA */
304 JobId_t MigrateJobId;
306 POOLMEM *client_uname; /* client uname */
307 POOLMEM *pool_source; /* Where pool came from */
308 POOLMEM *rpool_source; /* Where migrate read pool came from */
309 POOLMEM *rstore_source; /* Where read storage came from */
310 POOLMEM *wstore_source; /* Where write storage came from */
311 POOLMEM *catalog_source; /* Where catalog came from */
312 uint32_t replace; /* Replace option */
313 int32_t NumVols; /* Number of Volume used in pool */
314 int32_t reschedule_count; /* Number of times rescheduled */
315 int32_t FDVersion; /* File daemon version number */
316 int64_t spool_size; /* Spool size for this job */
317 bool spool_data; /* Spool data in SD */
318 bool acquired_resource_locks; /* set if resource locks acquired */
319 bool term_wait_inited; /* Set when cond var inited */
320 bool fn_printed; /* printed filename */
321 bool write_part_after_job; /* Write part after job in SD */
322 bool needs_sd; /* set if SD needed by Job */
323 bool cloned; /* set if cloned */
324 bool unlink_bsr; /* Unlink bsr file created */
325 bool VSS; /* VSS used by FD */
326 bool Encrypt; /* Encryption used by FD */
327 bool stats_enabled; /* Keep all job records in a table for long term statistics */
328 #endif /* DIRECTOR_DAEMON */
332 /* File Daemon specific part of JCR */
333 uint32_t num_files_examined; /* files examined this job */
334 POOLMEM *last_fname; /* last file saved/verified */
335 POOLMEM *acl_data; /* data with ACLs for backup/restore */
336 uint32_t acl_data_len; /* length of acl data buffer */
337 POOLMEM *xattr_data; /* data with Extended Attributes for backup/restore */
338 uint32_t xattr_data_len; /* length of xattr_data buffer */
339 int32_t last_type; /* type of last file saved/verified */
340 int incremental; /* set if incremental for SINCE */
341 utime_t mtime; /* begin time for SINCE */
342 int listing; /* job listing in estimate */
343 long Ticket; /* Ticket */
344 char *big_buf; /* I/O buffer */
345 POOLMEM *compress_buf; /* Compression buffer */
346 int32_t compress_buf_size; /* Length of compression buffer */
347 void *pZLIB_compress_workset; /* zlib compression session data */
348 int32_t replace; /* Replace options */
349 int32_t buf_size; /* length of buffer */
350 FF_PKT *ff; /* Find Files packet */
351 char stored_addr[MAX_NAME_LENGTH]; /* storage daemon address */
356 pthread_t heartbeat_id; /* id of heartbeat thread */
357 volatile bool hb_started; /* heartbeat running */
358 BSOCK *hb_bsock; /* duped SD socket */
359 BSOCK *hb_dir_bsock; /* duped DIR socket */
360 alist *RunScripts; /* Commands to run before and after job */
361 CRYPTO_CTX crypto; /* Crypto ctx */
362 DIRRES* director; /* Director resource */
363 bool VSS; /* VSS used by FD */
364 htable *file_list; /* Previous file list (accurate mode) */
365 #endif /* FILE_DAEMON */
368 #ifdef STORAGE_DAEMON
369 /* Storage Daemon specific part of JCR */
370 JCR *next_dev; /* next JCR attached to device */
371 JCR *prev_dev; /* previous JCR attached to device */
372 char *dir_auth_key; /* Dir auth key */
373 pthread_cond_t job_start_wait; /* Wait for FD to start Job */
375 DCR *read_dcr; /* device context for reading */
376 DCR *dcr; /* device context record */
377 alist *dcrs; /* list of dcrs open */
378 POOLMEM *job_name; /* base Job name (not unique) */
379 POOLMEM *fileset_name; /* FileSet */
380 POOLMEM *fileset_md5; /* MD5 for FileSet */
381 VOL_LIST *VolList; /* list to read */
382 int32_t NumWriteVolumes; /* number of volumes written */
383 int32_t NumReadVolumes; /* total number of volumes to read */
384 int32_t CurReadVolume; /* current read volume number */
385 int32_t label_errors; /* count of label errors */
387 long Ticket; /* ticket for this job */
388 bool ignore_label_errors; /* ignore Volume label errors */
389 bool spool_attributes; /* set if spooling attributes */
390 bool no_attributes; /* set if no attributes wanted */
391 int64_t spool_size; /* Spool size for this job */
392 bool spool_data; /* set to spool data */
393 int32_t CurVol; /* Current Volume count */
394 DIRRES* director; /* Director resource */
395 alist *write_store; /* list of write storage devices sent by DIR */
396 alist *read_store; /* list of read devices sent by DIR */
397 alist *reserve_msgs; /* reserve fail messages */
398 bool write_part_after_job; /* Set to write part after job */
399 bool PreferMountedVols; /* Prefer mounted vols rather than new */
400 bool need_fd; /* set if we need FD connection */
402 /* Parmaters for Open Read Session */
403 BSR *bsr; /* Bootstrap record -- has everything */
404 bool mount_next_volume; /* set to cause next volume mount */
405 uint32_t read_VolSessionId;
406 uint32_t read_VolSessionTime;
407 uint32_t read_StartFile;
408 uint32_t read_EndFile;
409 uint32_t read_StartBlock;
410 uint32_t read_EndBlock;
411 /* Device wait times */
414 int32_t max_num_wait;
416 int32_t rem_wait_sec;
418 #endif /* STORAGE_DAEMON */
423 * Setting a NULL in tsd doesn't clear the tsd but instead tells
424 * pthreads not to call the tsd destructor. Consequently, we
425 * define this *invalid* jcr address and stuff it in the tsd
426 * when the jcr is not valid.
428 #define INVALID_JCR ((JCR *)(-1))
432 * Structure for all daemons that keeps some summary
433 * info on the last job run.
437 int32_t Errors; /* FD/SD errors */
442 uint32_t VolSessionId;
443 uint32_t VolSessionTime;
448 char Job[MAX_NAME_LENGTH];
451 extern struct s_last_job last_job;
452 extern DLL_IMP_EXP dlist * last_jobs;
455 /* The following routines are found in lib/jcr.c */
456 extern bool init_jcr_subsystem(void);
457 extern JCR *new_jcr(int size, JCR_free_HANDLER *daemon_free_jcr);
458 extern JCR *get_jcr_by_id(uint32_t JobId);
459 extern JCR *get_jcr_by_session(uint32_t SessionId, uint32_t SessionTime);
460 extern JCR *get_jcr_by_partial_name(char *Job);
461 extern JCR *get_jcr_by_full_name(char *Job);
462 extern JCR *get_next_jcr(JCR *jcr);
463 extern void set_jcr_job_status(JCR *jcr, int JobStatus);
464 extern int DLL_IMP_EXP num_jobs_run;
467 extern void b_free_jcr(const char *file, int line, JCR *jcr);
468 #define free_jcr(jcr) b_free_jcr(__FILE__, __LINE__, (jcr))
470 extern void free_jcr(JCR *jcr);
473 /* Used to display specific job information after a fatal signal */
474 typedef void (dbg_jcr_hook_t)(JCR *jcr, FILE *fp);
475 extern void dbg_jcr_add_hook(dbg_jcr_hook_t *fct);
477 #endif /* __JCR_H_ */