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