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 */
131 bool pki_sign; /* Enable PKI Signatures? */
132 bool pki_encrypt; /* Enable PKI Encryption? */
133 DIGEST *digest; /* Last file's digest context */
134 X509_KEYPAIR *pki_keypair; /* Encryption key pair */
135 alist *pki_signers; /* Trusted Signers */
136 alist *pki_recipients; /* Trusted Recipients */
137 CRYPTO_SESSION *pki_session; /* PKE Public Keys + Symmetric Session Keys */
138 POOLMEM *pki_session_encoded; /* Cached DER-encoded copy of pki_session */
139 int32_t pki_session_encoded_size; /* Size of DER-encoded pki_session */
140 POOLMEM *crypto_buf; /* Encryption/Decryption buffer */
144 typedef void (JCR_free_HANDLER)(JCR *jcr);
146 /* Job Control Record (JCR) */
149 pthread_mutex_t mutex; /* jcr mutex */
150 volatile int _use_count; /* use count */
152 void lock() {P(mutex); };
153 void unlock() {V(mutex); };
154 void inc_use_count(void) {lock(); _use_count++; unlock(); };
155 void dec_use_count(void) {lock(); _use_count--; unlock(); };
156 int use_count() { return _use_count; };
157 void init_mutex(void) {pthread_mutex_init(&mutex, NULL); };
158 void destroy_mutex(void) {pthread_mutex_destroy(&mutex); };
159 bool is_job_canceled() {return job_canceled(this); };
161 /* Global part of JCR common to all daemons */
162 dlink link; /* JCR chain link */
163 pthread_t my_thread_id; /* id of thread controlling jcr */
164 BSOCK *dir_bsock; /* Director bsock or NULL if we are him */
165 BSOCK *store_bsock; /* Storage connection socket */
166 BSOCK *file_bsock; /* File daemon connection socket */
167 JCR_free_HANDLER *daemon_free_jcr; /* Local free routine */
168 dlist *msg_queue; /* Queued messages */
169 alist job_end_push; /* Job end pushed calls */
170 bool dequeuing; /* dequeuing messages */
171 POOLMEM *VolumeName; /* Volume name desired -- pool_memory */
172 POOLMEM *errmsg; /* edited error message */
173 char Job[MAX_NAME_LENGTH]; /* Unique name of this Job */
174 char event[MAX_NAME_LENGTH]; /* Current event */
175 uint32_t JobId; /* Director's JobId */
176 uint32_t VolSessionId;
177 uint32_t VolSessionTime;
178 uint32_t JobFiles; /* Number of files written, this job */
179 uint32_t JobErrors; /* */
180 uint64_t JobBytes; /* Number of bytes processed this job */
181 uint64_t ReadBytes; /* Bytes read -- before compression */
182 uint32_t Errors; /* Number of non-fatal errors */
183 volatile int JobStatus; /* ready, running, blocked, terminated */
184 int JobType; /* backup, restore, verify ... */
185 int JobLevel; /* Job level */
186 int JobPriority; /* Job priority */
187 time_t sched_time; /* job schedule time, i.e. when it should start */
188 time_t start_time; /* when job actually started */
189 time_t run_time; /* used for computing speed */
190 time_t end_time; /* job end time */
191 POOLMEM *client_name; /* client name */
192 POOLMEM *RestoreBootstrap; /* Bootstrap file to restore */
193 POOLMEM *stime; /* start time for incremental/differential */
194 char *sd_auth_key; /* SD auth key */
195 MSGS *jcr_msgs; /* Copy of message resource -- actually used */
196 uint32_t ClientId; /* Client associated with Job */
197 char *where; /* prefix to restore files to */
198 char *RegexWhere; /* file relocation in restore */
199 alist *where_bregexp; /* BREGEXP alist for path manipulation */
200 int cached_pnl; /* cached path length */
201 POOLMEM *cached_path; /* cached path */
202 bool prefix_links; /* Prefix links with Where path */
203 bool gui; /* set if gui using console */
204 bool authenticated; /* set when client authenticated */
205 void *Python_job; /* Python Job Object */
206 void *Python_events; /* Python Events Object */
208 bool cached_attribute; /* set if attribute is cached */
209 POOLMEM *attr; /* Attribute string from SD */
210 B_DB *db; /* database pointer */
211 B_DB *db_batch; /* database pointer for batch insert */
212 ATTR_DBR *ar; /* DB attribute record */
213 guid_list *id_list; /* User/group id to name list */
214 bool accurate; /* true if job is accurate */
216 void *plugin_ctx_list; /* list of contexts for plugins */
217 void *plugin_ctx; /* current plugin context */
218 Plugin *plugin; /* plugin instance */
219 save_pkt *plugin_sp; /* plugin save packet */
220 char *plugin_options; /* user set options for plugin */
222 /* Daemon specific part of JCR */
223 /* This should be empty in the library */
225 #ifdef DIRECTOR_DAEMON
226 /* Director Daemon specific data part of JCR */
227 pthread_t SD_msg_chan; /* Message channel thread id */
228 pthread_cond_t term_wait; /* Wait for job termination */
229 workq_ele_t *work_item; /* Work queue item if scheduled */
230 volatile bool sd_msg_thread_done; /* Set when Storage message thread terms */
231 BSOCK *ua; /* User agent */
232 JOB *job; /* Job resource */
233 JOB *verify_job; /* Job resource of verify previous job */
234 alist *rstorage; /* Read storage possibilities */
235 STORE *rstore; /* Selected read storage */
236 alist *wstorage; /* Write storage possibilities */
237 STORE *wstore; /* Selected write storage */
238 CLIENT *client; /* Client resource */
239 POOL *pool; /* Pool resource = write for migration */
240 POOL *rpool; /* Read pool. Used only in migration */
241 POOL *full_pool; /* Full backup pool resource */
242 POOL *inc_pool; /* Incremental backup pool resource */
243 POOL *diff_pool; /* Differential backup pool resource */
244 bool run_pool_override;
245 bool run_full_pool_override;
246 bool run_inc_pool_override;
247 bool run_diff_pool_override;
248 FILESET *fileset; /* FileSet resource */
249 CAT *catalog; /* Catalog resource */
250 MSGS *messages; /* Default message handler */
251 uint32_t SDJobFiles; /* Number of files written, this job */
252 uint64_t SDJobBytes; /* Number of bytes processed this job */
253 uint32_t SDErrors; /* Number of non-fatal errors */
254 volatile int SDJobStatus; /* Storage Job Status */
255 volatile int FDJobStatus; /* File daemon Job Status */
256 uint32_t ExpectedFiles; /* Expected restore files */
257 uint32_t MediaId; /* DB record IDs associated with this job */
258 FileId_t FileId; /* Last file id inserted */
259 uint32_t FileIndex; /* Last FileIndex processed */
260 POOLMEM *fname; /* name to put into catalog */
261 JOB_DBR jr; /* Job DB record for current job */
262 JOB_DBR previous_jr; /* previous job database record */
263 JOB *previous_job; /* Job resource of migration previous job */
264 JCR *mig_jcr; /* JCR for migration/copy job */
265 char FSCreateTime[MAX_TIME_LENGTH]; /* FileSet CreateTime as returned from DB */
266 char since[MAX_TIME_LENGTH]; /* since time */
268 JobId_t RestoreJobId; /* Id specified by UA */
269 JobId_t MigrateJobId;
271 POOLMEM *client_uname; /* client uname */
272 POOLMEM *pool_source; /* Where pool came from */
273 POOLMEM *rpool_source; /* Where migrate read pool came from */
274 POOLMEM *rstore_source; /* Where read storage came from */
275 POOLMEM *wstore_source; /* Where write storage came from */
276 POOLMEM *catalog_source; /* Where catalog came from */
277 int replace; /* Replace option */
278 int NumVols; /* Number of Volume used in pool */
279 int reschedule_count; /* Number of times rescheduled */
280 int FDVersion; /* File daemon version number */
281 int64_t spool_size; /* Spool size for this job */
282 bool spool_data; /* Spool data in SD */
283 bool acquired_resource_locks; /* set if resource locks acquired */
284 bool term_wait_inited; /* Set when cond var inited */
285 bool fn_printed; /* printed filename */
286 bool write_part_after_job; /* Write part after job in SD */
287 bool needs_sd; /* set if SD needed by Job */
288 bool cloned; /* set if cloned */
289 bool unlink_bsr; /* Unlink bsr file created */
290 bool VSS; /* VSS used by FD */
291 bool Encrypt; /* Encryption used by FD */
292 #endif /* DIRECTOR_DAEMON */
296 /* File Daemon specific part of JCR */
297 uint32_t num_files_examined; /* files examined this job */
298 POOLMEM *last_fname; /* last file saved/verified */
299 POOLMEM *acl_text; /* text of ACL for backup */
300 int last_type; /* type of last file saved/verified */
301 /*********FIXME********* add missing files and files to be retried */
302 int incremental; /* set if incremental for SINCE */
303 time_t mtime; /* begin time for SINCE */
304 int listing; /* job listing in estimate */
305 long Ticket; /* Ticket */
306 char *big_buf; /* I/O buffer */
307 POOLMEM *compress_buf; /* Compression buffer */
308 int32_t compress_buf_size; /* Length of compression buffer */
309 void *pZLIB_compress_workset; /* zlib compression session data */
310 int replace; /* Replace options */
311 int buf_size; /* length of buffer */
312 FF_PKT *ff; /* Find Files packet */
313 char stored_addr[MAX_NAME_LENGTH]; /* storage daemon address */
318 pthread_t heartbeat_id; /* id of heartbeat thread */
319 BSOCK *hb_bsock; /* duped SD socket */
320 BSOCK *hb_dir_bsock; /* duped DIR socket */
321 alist *RunScripts; /* Commands to run before and after job */
322 CRYPTO_CTX crypto; /* Crypto ctx */
323 DIRRES* director; /* Director resource */
324 bool VSS; /* VSS used by FD */
325 htable *file_list; /* Previous file list (accurate mode) */
326 #endif /* FILE_DAEMON */
329 #ifdef STORAGE_DAEMON
330 /* Storage Daemon specific part of JCR */
331 JCR *next_dev; /* next JCR attached to device */
332 JCR *prev_dev; /* previous JCR attached to device */
333 char *dir_auth_key; /* Dir auth key */
334 pthread_cond_t job_start_wait; /* Wait for FD to start Job */
336 DCR *read_dcr; /* device context for reading */
337 DCR *dcr; /* device context record */
338 alist *dcrs; /* list of dcrs open */
339 POOLMEM *job_name; /* base Job name (not unique) */
340 POOLMEM *fileset_name; /* FileSet */
341 POOLMEM *fileset_md5; /* MD5 for FileSet */
342 VOL_LIST *VolList; /* list to read */
343 int32_t NumWriteVolumes; /* number of volumes written */
344 int32_t NumReadVolumes; /* total number of volumes to read */
345 int32_t CurReadVolume; /* current read volume number */
346 int label_errors; /* count of label errors */
348 long Ticket; /* ticket for this job */
349 bool ignore_label_errors; /* ignore Volume label errors */
350 bool spool_attributes; /* set if spooling attributes */
351 bool no_attributes; /* set if no attributes wanted */
352 int64_t spool_size; /* Spool size for this job */
353 bool spool_data; /* set to spool data */
354 int CurVol; /* Current Volume count */
355 DIRRES* director; /* Director resource */
356 alist *write_store; /* list of write storage devices sent by DIR */
357 alist *read_store; /* list of read devices sent by DIR */
358 alist *reserve_msgs; /* reserve fail messages */
359 bool write_part_after_job; /* Set to write part after job */
360 bool PreferMountedVols; /* Prefer mounted vols rather than new */
362 uint32_t FileId; /* Last file id inserted */
364 /* Parmaters for Open Read Session */
365 BSR *bsr; /* Bootstrap record -- has everything */
366 bool mount_next_volume; /* set to cause next volume mount */
367 uint32_t read_VolSessionId;
368 uint32_t read_VolSessionTime;
369 uint32_t read_StartFile;
370 uint32_t read_EndFile;
371 uint32_t read_StartBlock;
372 uint32_t read_EndBlock;
373 /* Device wait times */
381 #endif /* STORAGE_DAEMON */
386 * Structure for all daemons that keeps some summary
387 * info on the last job run.
391 int Errors; /* FD/SD errors */
396 uint32_t VolSessionId;
397 uint32_t VolSessionTime;
402 char Job[MAX_NAME_LENGTH];
405 extern struct s_last_job last_job;
406 extern DLL_IMP_EXP dlist * last_jobs;
409 /* The following routines are found in lib/jcr.c */
410 extern bool init_jcr_subsystem(void);
411 extern JCR *new_jcr(int size, JCR_free_HANDLER *daemon_free_jcr);
412 extern JCR *get_jcr_by_id(uint32_t JobId);
413 extern JCR *get_jcr_by_session(uint32_t SessionId, uint32_t SessionTime);
414 extern JCR *get_jcr_by_partial_name(char *Job);
415 extern JCR *get_jcr_by_full_name(char *Job);
416 extern JCR *get_next_jcr(JCR *jcr);
417 extern void set_jcr_job_status(JCR *jcr, int JobStatus);
418 extern int DLL_IMP_EXP num_jobs_run;
421 extern void b_free_jcr(const char *file, int line, JCR *jcr);
422 #define free_jcr(jcr) b_free_jcr(__FILE__, __LINE__, (jcr))
424 extern void free_jcr(JCR *jcr);
427 #endif /* __JCR_H_ */