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