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 John Walker.
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 */
57 /* Job Types. These are stored in the DB */
58 #define JT_BACKUP 'B' /* Backup Job */
59 #define JT_MIGRATED_JOB 'M' /* A previous backup job that was migrated */
60 #define JT_VERIFY 'V' /* Verify Job */
61 #define JT_RESTORE 'R' /* Restore Job */
62 #define JT_CONSOLE 'c' /* console program */
63 #define JT_SYSTEM 'I' /* internal system "job" */
64 #define JT_ADMIN 'D' /* admin job */
65 #define JT_ARCHIVE 'A' /* Archive Job */
66 #define JT_COPY 'C' /* Copy Job */
67 #define JT_MIGRATE 'g' /* Migration Job */
68 #define JT_SCAN 'S' /* Scan Job */
70 /* Job Status. Some of these are stored in the DB */
71 #define JS_Created 'C' /* created but not yet running */
72 #define JS_Running 'R' /* running */
73 #define JS_Blocked 'B' /* blocked */
74 #define JS_Terminated 'T' /* terminated normally */
75 #define JS_ErrorTerminated 'E' /* Job terminated in error */
76 #define JS_Error 'e' /* Non-fatal error */
77 #define JS_FatalError 'f' /* Fatal error */
78 #define JS_Differences 'D' /* Verify differences */
79 #define JS_Canceled 'A' /* canceled by user */
80 #define JS_WaitFD 'F' /* waiting on File daemon */
81 #define JS_WaitSD 'S' /* waiting on the Storage daemon */
82 #define JS_WaitMedia 'm' /* waiting for new media */
83 #define JS_WaitMount 'M' /* waiting for Mount */
84 #define JS_WaitStoreRes 's' /* Waiting for storage resource */
85 #define JS_WaitJobRes 'j' /* Waiting for job resource */
86 #define JS_WaitClientRes 'c' /* Waiting for Client resource */
87 #define JS_WaitMaxJobs 'd' /* Waiting for maximum jobs */
88 #define JS_WaitStartTime 't' /* Waiting for start time */
89 #define JS_WaitPriority 'p' /* Waiting for higher priority jobs to finish */
90 #define JS_AttrDespooling 'a' /* SD despooling attributes */
91 #define JS_AttrInserting 'i' /* Doing batch insert file records */
92 #define JS_DataDespooling 'l' /* Doing data despooling */
93 #define JS_DataCommitting 'L' /* Committing data (last despool) */
95 /* Migration selection types */
107 #define job_canceled(jcr) \
108 (jcr->JobStatus == JS_Canceled || \
109 jcr->JobStatus == JS_ErrorTerminated || \
110 jcr->JobStatus == JS_FatalError)
112 #define foreach_jcr(jcr) \
113 for (jcr=jcr_walk_start(); jcr; (jcr=jcr_walk_next(jcr)) )
115 #define endeach_jcr(jcr) jcr_walk_end(jcr)
120 /* Forward referenced structures */
132 bool pki_sign; /* Enable PKI Signatures? */
133 bool pki_encrypt; /* Enable PKI Encryption? */
134 DIGEST *digest; /* Last file's digest context */
135 X509_KEYPAIR *pki_keypair; /* Encryption key pair */
136 alist *pki_signers; /* Trusted Signers */
137 alist *pki_recipients; /* Trusted Recipients */
138 CRYPTO_SESSION *pki_session; /* PKE Public Keys + Symmetric Session Keys */
139 POOLMEM *pki_session_encoded; /* Cached DER-encoded copy of pki_session */
140 int32_t pki_session_encoded_size; /* Size of DER-encoded pki_session */
141 POOLMEM *crypto_buf; /* Encryption/Decryption buffer */
145 typedef void (JCR_free_HANDLER)(JCR *jcr);
147 /* Job Control Record (JCR) */
150 pthread_mutex_t mutex; /* jcr mutex */
151 volatile int _use_count; /* use count */
153 void lock() {P(mutex); };
154 void unlock() {V(mutex); };
155 void inc_use_count(void) {lock(); _use_count++; unlock(); };
156 void dec_use_count(void) {lock(); _use_count--; unlock(); };
157 int use_count() { return _use_count; };
158 void init_mutex(void) {pthread_mutex_init(&mutex, NULL); };
159 void destroy_mutex(void) {pthread_mutex_destroy(&mutex); };
160 bool is_job_canceled() {return job_canceled(this); };
162 /* Global part of JCR common to all daemons */
163 dlink link; /* JCR chain link */
164 pthread_t my_thread_id; /* id of thread controlling jcr */
165 BSOCK *dir_bsock; /* Director bsock or NULL if we are him */
166 BSOCK *store_bsock; /* Storage connection socket */
167 BSOCK *file_bsock; /* File daemon connection socket */
168 JCR_free_HANDLER *daemon_free_jcr; /* Local free routine */
169 dlist *msg_queue; /* Queued messages */
170 alist job_end_push; /* Job end pushed calls */
171 bool dequeuing; /* dequeuing messages */
172 POOLMEM *VolumeName; /* Volume name desired -- pool_memory */
173 POOLMEM *errmsg; /* edited error message */
174 char Job[MAX_NAME_LENGTH]; /* Unique name of this Job */
175 char event[MAX_NAME_LENGTH]; /* Current event */
176 uint32_t JobId; /* Director's JobId */
177 uint32_t VolSessionId;
178 uint32_t VolSessionTime;
179 uint32_t JobFiles; /* Number of files written, this job */
180 uint32_t JobErrors; /* */
181 uint64_t JobBytes; /* Number of bytes processed this job */
182 uint64_t ReadBytes; /* Bytes read -- before compression */
183 uint32_t Errors; /* Number of non-fatal errors */
184 volatile int JobStatus; /* ready, running, blocked, terminated */
185 int JobType; /* backup, restore, verify ... */
186 int JobLevel; /* Job level */
187 int JobPriority; /* Job priority */
188 time_t sched_time; /* job schedule time, i.e. when it should start */
189 time_t start_time; /* when job actually started */
190 time_t run_time; /* used for computing speed */
191 time_t end_time; /* job end time */
192 POOLMEM *client_name; /* client name */
193 POOLMEM *RestoreBootstrap; /* Bootstrap file to restore */
194 POOLMEM *stime; /* start time for incremental/differential */
195 char *sd_auth_key; /* SD auth key */
196 MSGS *jcr_msgs; /* Copy of message resource -- actually used */
197 uint32_t ClientId; /* Client associated with Job */
198 char *where; /* prefix to restore files to */
199 char *RegexWhere; /* file relocation in restore */
200 alist *where_bregexp; /* BREGEXP alist for path manipulation */
201 int cached_pnl; /* cached path length */
202 POOLMEM *cached_path; /* cached path */
203 bool prefix_links; /* Prefix links with Where path */
204 bool gui; /* set if gui using console */
205 bool authenticated; /* set when client authenticated */
206 void *Python_job; /* Python Job Object */
207 void *Python_events; /* Python Events Object */
209 bool cached_attribute; /* set if attribute is cached */
210 POOLMEM *attr; /* Attribute string from SD */
211 B_DB *db; /* database pointer */
212 B_DB *db_batch; /* database pointer for batch insert */
213 ATTR_DBR *ar; /* DB attribute record */
214 guid_list *id_list; /* User/group id to name list */
215 bool accurate; /* true if job is accurate */
217 void *plugin_ctx_list; /* list of contexts for plugins */
218 void *plugin_ctx; /* current plugin context */
219 Plugin *plugin; /* plugin instance */
220 save_pkt *plugin_sp; /* plugin save packet */
221 char *plugin_options; /* user set options for plugin */
223 /* Daemon specific part of JCR */
224 /* This should be empty in the library */
226 #ifdef DIRECTOR_DAEMON
227 /* Director Daemon specific data part of JCR */
228 pthread_t SD_msg_chan; /* Message channel thread id */
229 pthread_cond_t term_wait; /* Wait for job termination */
230 workq_ele_t *work_item; /* Work queue item if scheduled */
231 volatile bool sd_msg_thread_done; /* Set when Storage message thread terms */
232 BSOCK *ua; /* User agent */
233 JOB *job; /* Job resource */
234 JOB *verify_job; /* Job resource of verify previous job */
235 alist *rstorage; /* Read storage possibilities */
236 STORE *rstore; /* Selected read storage */
237 alist *wstorage; /* Write storage possibilities */
238 STORE *wstore; /* Selected write storage */
239 CLIENT *client; /* Client resource */
240 POOL *pool; /* Pool resource = write for migration */
241 POOL *rpool; /* Read pool. Used only in migration */
242 POOL *full_pool; /* Full backup pool resource */
243 POOL *inc_pool; /* Incremental backup pool resource */
244 POOL *diff_pool; /* Differential backup pool resource */
245 bool run_pool_override;
246 bool run_full_pool_override;
247 bool run_inc_pool_override;
248 bool run_diff_pool_override;
249 FILESET *fileset; /* FileSet resource */
250 CAT *catalog; /* Catalog resource */
251 MSGS *messages; /* Default message handler */
252 uint32_t SDJobFiles; /* Number of files written, this job */
253 uint64_t SDJobBytes; /* Number of bytes processed this job */
254 uint32_t SDErrors; /* Number of non-fatal errors */
255 volatile int SDJobStatus; /* Storage Job Status */
256 volatile int FDJobStatus; /* File daemon Job Status */
257 uint32_t ExpectedFiles; /* Expected restore files */
258 uint32_t MediaId; /* DB record IDs associated with this job */
259 FileId_t FileId; /* Last file id inserted */
260 uint32_t FileIndex; /* Last FileIndex processed */
261 POOLMEM *fname; /* name to put into catalog */
262 JOB_DBR jr; /* Job DB record for current job */
263 JOB_DBR previous_jr; /* previous job database record */
264 JOB *previous_job; /* Job resource of migration previous job */
265 JCR *mig_jcr; /* JCR for migration/copy job */
266 char FSCreateTime[MAX_TIME_LENGTH]; /* FileSet CreateTime as returned from DB */
267 char since[MAX_TIME_LENGTH]; /* since time */
269 JobId_t RestoreJobId; /* Id specified by UA */
270 JobId_t MigrateJobId;
272 POOLMEM *client_uname; /* client uname */
273 POOLMEM *pool_source; /* Where pool came from */
274 POOLMEM *rpool_source; /* Where migrate read pool came from */
275 POOLMEM *rstore_source; /* Where read storage came from */
276 POOLMEM *wstore_source; /* Where write storage came from */
277 POOLMEM *catalog_source; /* Where catalog came from */
278 int replace; /* Replace option */
279 int NumVols; /* Number of Volume used in pool */
280 int reschedule_count; /* Number of times rescheduled */
281 int FDVersion; /* File daemon version number */
282 int64_t spool_size; /* Spool size for this job */
283 bool spool_data; /* Spool data in SD */
284 bool acquired_resource_locks; /* set if resource locks acquired */
285 bool term_wait_inited; /* Set when cond var inited */
286 bool fn_printed; /* printed filename */
287 bool write_part_after_job; /* Write part after job in SD */
288 bool needs_sd; /* set if SD needed by Job */
289 bool cloned; /* set if cloned */
290 bool unlink_bsr; /* Unlink bsr file created */
291 bool VSS; /* VSS used by FD */
292 bool Encrypt; /* Encryption used by FD */
293 bool stats_enabled; /* Keep all job records in a table for long term statistics */
294 #endif /* DIRECTOR_DAEMON */
298 /* File Daemon specific part of JCR */
299 uint32_t num_files_examined; /* files examined this job */
300 POOLMEM *last_fname; /* last file saved/verified */
301 POOLMEM *acl_text; /* text of ACL for backup */
302 int last_type; /* type of last file saved/verified */
303 /*********FIXME********* add missing files and files to be retried */
304 int incremental; /* set if incremental for SINCE */
305 time_t mtime; /* begin time for SINCE */
306 int listing; /* job listing in estimate */
307 long Ticket; /* Ticket */
308 char *big_buf; /* I/O buffer */
309 POOLMEM *compress_buf; /* Compression buffer */
310 int32_t compress_buf_size; /* Length of compression buffer */
311 void *pZLIB_compress_workset; /* zlib compression session data */
312 int replace; /* Replace options */
313 int buf_size; /* length of buffer */
314 FF_PKT *ff; /* Find Files packet */
315 char stored_addr[MAX_NAME_LENGTH]; /* storage daemon address */
320 pthread_t heartbeat_id; /* id of heartbeat thread */
321 BSOCK *hb_bsock; /* duped SD socket */
322 BSOCK *hb_dir_bsock; /* duped DIR socket */
323 alist *RunScripts; /* Commands to run before and after job */
324 CRYPTO_CTX crypto; /* Crypto ctx */
325 DIRRES* director; /* Director resource */
326 bool VSS; /* VSS used by FD */
328 TCHDB *file_list; /* Previous file list (accurate mode) */
330 htable *file_list; /* Previous file list (accurate mode) */
332 #endif /* FILE_DAEMON */
335 #ifdef STORAGE_DAEMON
336 /* Storage Daemon specific part of JCR */
337 JCR *next_dev; /* next JCR attached to device */
338 JCR *prev_dev; /* previous JCR attached to device */
339 char *dir_auth_key; /* Dir auth key */
340 pthread_cond_t job_start_wait; /* Wait for FD to start Job */
342 DCR *read_dcr; /* device context for reading */
343 DCR *dcr; /* device context record */
344 alist *dcrs; /* list of dcrs open */
345 POOLMEM *job_name; /* base Job name (not unique) */
346 POOLMEM *fileset_name; /* FileSet */
347 POOLMEM *fileset_md5; /* MD5 for FileSet */
348 VOL_LIST *VolList; /* list to read */
349 int32_t NumWriteVolumes; /* number of volumes written */
350 int32_t NumReadVolumes; /* total number of volumes to read */
351 int32_t CurReadVolume; /* current read volume number */
352 int label_errors; /* count of label errors */
354 long Ticket; /* ticket for this job */
355 bool ignore_label_errors; /* ignore Volume label errors */
356 bool spool_attributes; /* set if spooling attributes */
357 bool no_attributes; /* set if no attributes wanted */
358 int64_t spool_size; /* Spool size for this job */
359 bool spool_data; /* set to spool data */
360 int CurVol; /* Current Volume count */
361 DIRRES* director; /* Director resource */
362 alist *write_store; /* list of write storage devices sent by DIR */
363 alist *read_store; /* list of read devices sent by DIR */
364 alist *reserve_msgs; /* reserve fail messages */
365 bool write_part_after_job; /* Set to write part after job */
366 bool PreferMountedVols; /* Prefer mounted vols rather than new */
368 uint32_t FileId; /* Last file id inserted */
370 /* Parmaters for Open Read Session */
371 BSR *bsr; /* Bootstrap record -- has everything */
372 bool mount_next_volume; /* set to cause next volume mount */
373 uint32_t read_VolSessionId;
374 uint32_t read_VolSessionTime;
375 uint32_t read_StartFile;
376 uint32_t read_EndFile;
377 uint32_t read_StartBlock;
378 uint32_t read_EndBlock;
379 /* Device wait times */
387 #endif /* STORAGE_DAEMON */
392 * Structure for all daemons that keeps some summary
393 * info on the last job run.
397 int Errors; /* FD/SD errors */
402 uint32_t VolSessionId;
403 uint32_t VolSessionTime;
408 char Job[MAX_NAME_LENGTH];
411 extern struct s_last_job last_job;
412 extern DLL_IMP_EXP dlist * last_jobs;
415 /* The following routines are found in lib/jcr.c */
416 extern bool init_jcr_subsystem(void);
417 extern JCR *new_jcr(int size, JCR_free_HANDLER *daemon_free_jcr);
418 extern JCR *get_jcr_by_id(uint32_t JobId);
419 extern JCR *get_jcr_by_session(uint32_t SessionId, uint32_t SessionTime);
420 extern JCR *get_jcr_by_partial_name(char *Job);
421 extern JCR *get_jcr_by_full_name(char *Job);
422 extern JCR *get_next_jcr(JCR *jcr);
423 extern void set_jcr_job_status(JCR *jcr, int JobStatus);
424 extern int DLL_IMP_EXP num_jobs_run;
427 extern void b_free_jcr(const char *file, int line, JCR *jcr);
428 #define free_jcr(jcr) b_free_jcr(__FILE__, __LINE__, (jcr))
430 extern void free_jcr(JCR *jcr);
433 #endif /* __JCR_H_ */