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