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