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