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