2 * Bacula JCR Structure definition for Daemons and the Library
3 * This definition consists of a "Global" definition common
4 * to all daemons and used by the library routines, and a
5 * daemon specific part that is enabled with #defines.
12 Copyright (C) 2000-2006 Kern Sibbald
14 This program is free software; you can redistribute it and/or
15 modify it under the terms of the GNU General Public License
16 version 2 as amended with additional clauses defined in the
17 file LICENSE in the main source directory.
19 This program is distributed in the hope that it will be useful,
20 but WITHOUT ANY WARRANTY; without even the implied warranty of
21 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
22 the file LICENSE for additional details.
30 /* Backup/Verify level code. These are stored in the DB */
31 #define L_FULL 'F' /* Full backup */
32 #define L_INCREMENTAL 'I' /* since last backup */
33 #define L_DIFFERENTIAL 'D' /* since last full backup */
35 #define L_VERIFY_CATALOG 'C' /* verify from catalog */
36 #define L_VERIFY_INIT 'V' /* verify save (init DB) */
37 #define L_VERIFY_VOLUME_TO_CATALOG 'O' /* verify Volume to catalog entries */
38 #define L_VERIFY_DISK_TO_CATALOG 'd' /* verify Disk attributes to catalog */
39 #define L_VERIFY_DATA 'A' /* verify data on volume */
40 #define L_BASE 'B' /* Base level job */
41 #define L_NONE ' ' /* None, for Restore and Admin */
44 /* Job Types. These are stored in the DB */
45 #define JT_BACKUP 'B' /* Backup Job */
46 #define JT_VERIFY 'V' /* Verify Job */
47 #define JT_RESTORE 'R' /* Restore Job */
48 #define JT_CONSOLE 'c' /* console program */
49 #define JT_SYSTEM 'I' /* internal system "job" */
50 #define JT_ADMIN 'D' /* admin job */
51 #define JT_ARCHIVE 'A' /* Archive Job */
52 #define JT_COPY 'C' /* Copy Job */
53 #define JT_MIGRATE 'M' /* Migration Job */
54 #define JT_SCAN 'S' /* Scan Job */
56 /* Job Status. Some of these are stored in the DB */
57 #define JS_Created 'C' /* created but not yet running */
58 #define JS_Running 'R' /* running */
59 #define JS_Blocked 'B' /* blocked */
60 #define JS_Terminated 'T' /* terminated normally */
61 #define JS_ErrorTerminated 'E' /* Job terminated in error */
62 #define JS_Error 'e' /* Non-fatal error */
63 #define JS_FatalError 'f' /* Fatal error */
64 #define JS_Differences 'D' /* Verify differences */
65 #define JS_Canceled 'A' /* canceled by user */
66 #define JS_WaitFD 'F' /* waiting on File daemon */
67 #define JS_WaitSD 'S' /* waiting on the Storage daemon */
68 #define JS_WaitMedia 'm' /* waiting for new media */
69 #define JS_WaitMount 'M' /* waiting for Mount */
70 #define JS_WaitStoreRes 's' /* Waiting for storage resource */
71 #define JS_WaitJobRes 'j' /* Waiting for job resource */
72 #define JS_WaitClientRes 'c' /* Waiting for Client resource */
73 #define JS_WaitMaxJobs 'd' /* Waiting for maximum jobs */
74 #define JS_WaitStartTime 't' /* Waiting for start time */
75 #define JS_WaitPriority 'p' /* Waiting for higher priority jobs to finish */
77 #define job_canceled(jcr) \
78 (jcr->JobStatus == JS_Canceled || \
79 jcr->JobStatus == JS_ErrorTerminated || \
80 jcr->JobStatus == JS_FatalError)
82 #define foreach_jcr(jcr) \
83 for (jcr=jcr_walk_start(); jcr; (jcr=jcr_walk_next(jcr)) )
85 #define endeach_jcr(jcr) jcr_walk_end(jcr)
90 /* Forward referenced structures */
96 typedef void (JCR_free_HANDLER)(JCR *jcr);
98 /* Job Control Record (JCR) */
101 void inc_use_count(void) {P(mutex); use_count++; V(mutex); };
102 void dec_use_count(void) {P(mutex); use_count--; V(mutex); };
104 /* Global part of JCR common to all daemons */
105 dlink link; /* JCR chain link */
106 volatile int use_count; /* use count */
107 pthread_t my_thread_id; /* id of thread controlling jcr */
108 pthread_mutex_t mutex; /* jcr mutex */
109 BSOCK *dir_bsock; /* Director bsock or NULL if we are him */
110 BSOCK *store_bsock; /* Storage connection socket */
111 BSOCK *file_bsock; /* File daemon connection socket */
112 JCR_free_HANDLER *daemon_free_jcr; /* Local free routine */
113 dlist *msg_queue; /* Queued messages */
114 alist job_end_push; /* Job end pushed calls */
115 bool dequeuing; /* dequeuing messages */
116 POOLMEM *VolumeName; /* Volume name desired -- pool_memory */
117 POOLMEM *errmsg; /* edited error message */
118 char Job[MAX_NAME_LENGTH]; /* Unique name of this Job */
119 char event[MAX_NAME_LENGTH]; /* Current event */
120 uint32_t JobId; /* Director's JobId */
121 uint32_t VolSessionId;
122 uint32_t VolSessionTime;
123 uint32_t JobFiles; /* Number of files written, this job */
124 uint32_t JobErrors; /* */
125 uint64_t JobBytes; /* Number of bytes processed this job */
126 uint64_t ReadBytes; /* Bytes read -- before compression */
127 uint32_t Errors; /* Number of non-fatal errors */
128 volatile int JobStatus; /* ready, running, blocked, terminated */
129 int JobType; /* backup, restore, verify ... */
130 int JobLevel; /* Job level */
131 int JobPriority; /* Job priority */
132 time_t sched_time; /* job schedule time, i.e. when it should start */
133 time_t start_time; /* when job actually started */
134 time_t run_time; /* used for computing speed */
135 time_t end_time; /* job end time */
136 POOLMEM *client_name; /* client name */
137 POOLMEM *RestoreBootstrap; /* Bootstrap file to restore */
138 POOLMEM *stime; /* start time for incremental/differential */
139 char *sd_auth_key; /* SD auth key */
140 MSGS *jcr_msgs; /* Copy of message resource -- actually used */
141 uint32_t ClientId; /* Client associated with Job */
142 char *where; /* prefix to restore files to */
143 int cached_pnl; /* cached path length */
144 POOLMEM *cached_path; /* cached path */
145 bool prefix_links; /* Prefix links with Where path */
146 bool gui; /* set if gui using console */
147 bool authenticated; /* set when client authenticated */
148 void *Python_job; /* Python Job Object */
149 void *Python_events; /* Python Events Object */
151 bool cached_attribute; /* set if attribute is cached */
152 POOLMEM *attr; /* Attribute string from SD */
153 B_DB *db; /* database pointer */
154 ATTR_DBR *ar; /* DB attribute record */
156 /* Daemon specific part of JCR */
157 /* This should be empty in the library */
159 #ifdef DIRECTOR_DAEMON
160 /* Director Daemon specific part of JCR */
161 pthread_t SD_msg_chan; /* Message channel thread id */
162 pthread_cond_t term_wait; /* Wait for job termination */
163 workq_ele_t *work_item; /* Work queue item if scheduled */
164 volatile bool sd_msg_thread_done; /* Set when Storage message thread terms */
165 BSOCK *ua; /* User agent */
166 JOB *job; /* Job resource */
167 JOB *verify_job; /* Job resource of verify target job */
168 alist *storage; /* Storage possibilities */
169 STORE *store; /* Storage daemon selected */
170 CLIENT *client; /* Client resource */
171 POOL *pool; /* Pool resource */
172 POOL *full_pool; /* Full backup pool resource */
173 POOL *inc_pool; /* Incremental backup pool resource */
174 POOL *dif_pool; /* Differential backup pool resource */
175 FILESET *fileset; /* FileSet resource */
176 CAT *catalog; /* Catalog resource */
177 MSGS *messages; /* Default message handler */
178 uint32_t SDJobFiles; /* Number of files written, this job */
179 uint64_t SDJobBytes; /* Number of bytes processed this job */
180 uint32_t SDErrors; /* Number of non-fatal errors */
181 volatile int SDJobStatus; /* Storage Job Status */
182 volatile int FDJobStatus; /* File daemon Job Status */
183 uint32_t ExpectedFiles; /* Expected restore files */
184 uint32_t MediaId; /* DB record IDs associated with this job */
185 uint32_t PoolId; /* Pool record id */
186 FileId_t FileId; /* Last file id inserted */
187 uint32_t FileIndex; /* Last FileIndex processed */
188 POOLMEM *fname; /* name to put into catalog */
189 JOB_DBR jr; /* Job DB record for current job */
190 JOB_DBR target_jr; /* target job */
191 char FSCreateTime[MAX_TIME_LENGTH]; /* FileSet CreateTime as returned from DB */
192 char since[MAX_TIME_LENGTH]; /* since time */
193 uint32_t RestoreJobId; /* Id specified by UA */
194 POOLMEM *client_uname; /* client uname */
195 int replace; /* Replace option */
196 int NumVols; /* Number of Volume used in pool */
197 int reschedule_count; /* Number of times rescheduled */
198 bool spool_data; /* Spool data in SD */
199 bool acquired_resource_locks; /* set if resource locks acquired */
200 bool term_wait_inited; /* Set when cond var inited */
201 bool fn_printed; /* printed filename */
202 bool write_part_after_job; /* Write part after job in SD */
203 bool needs_sd; /* set if SD needed by Job */
204 bool cloned; /* set if cloned */
205 bool unlink_bsr; /* Unlink bsr file created */
206 #endif /* DIRECTOR_DAEMON */
210 /* File Daemon specific part of JCR */
211 uint32_t num_files_examined; /* files examined this job */
212 POOLMEM *last_fname; /* last file saved/verified */
213 POOLMEM *acl_text; /* text of ACL for backup */
214 /*********FIXME********* add missing files and files to be retried */
215 int incremental; /* set if incremental for SINCE */
216 time_t mtime; /* begin time for SINCE */
217 int listing; /* job listing in estimate */
218 long Ticket; /* Ticket */
219 char *big_buf; /* I/O buffer */
220 POOLMEM *compress_buf; /* Compression buffer */
221 int32_t compress_buf_size; /* Length of compression buffer */
222 int replace; /* Replace options */
223 int buf_size; /* length of buffer */
224 FF_PKT *ff; /* Find Files packet */
225 char stored_addr[MAX_NAME_LENGTH]; /* storage daemon address */
230 pthread_t heartbeat_id; /* id of heartbeat thread */
231 volatile BSOCK *hb_bsock; /* duped SD socket */
232 volatile BSOCK *hb_dir_bsock; /* duped DIR socket */
233 POOLMEM *RunAfterJob; /* Command to run after job */
234 bool pki_sign; /* Enable PKI Signatures? */
235 bool pki_encrypt; /* Enable PKI Encryption? */
236 DIGEST *digest; /* Last file's digest context */
237 X509_KEYPAIR *pki_keypair; /* Encryption key pair */
238 alist *pki_signers; /* Trusted Signers */
239 alist *pki_readers; /* Trusted Readers */
240 CRYPTO_SESSION *pki_session; /* PKE Public Keys + Symmetric Session Keys */
241 void *pki_session_encoded; /* Cached DER-encoded copy of pki_session */
242 size_t pki_session_encoded_size; /* Size of DER-encoded pki_session */
243 DIRRES* director; /* Director resource */
244 #endif /* FILE_DAEMON */
247 #ifdef STORAGE_DAEMON
248 /* Storage Daemon specific part of JCR */
249 JCR *next_dev; /* next JCR attached to device */
250 JCR *prev_dev; /* previous JCR attached to device */
251 pthread_cond_t job_start_wait; /* Wait for FD to start Job */
253 DCR *read_dcr; /* device context for reading */
254 DCR *dcr; /* device context record */
255 alist *dcrs; /* list of dcrs open */
256 POOLMEM *job_name; /* base Job name (not unique) */
257 POOLMEM *fileset_name; /* FileSet */
258 POOLMEM *fileset_md5; /* MD5 for FileSet */
259 VOL_LIST *VolList; /* list to read */
260 int32_t NumVolumes; /* number of volumes used */
261 int32_t CurVolume; /* current volume number */
262 int label_errors; /* count of label errors */
264 long Ticket; /* ticket for this job */
265 bool ignore_label_errors; /* ignore Volume label errors */
266 bool spool_attributes; /* set if spooling attributes */
267 bool no_attributes; /* set if no attributes wanted */
268 bool spool_data; /* set to spool data */
269 int CurVol; /* Current Volume count */
270 DIRRES* director; /* Director resource */
271 alist *dirstore; /* list of storage devices sent by DIR */
272 alist *reserve_msgs; /* reserve fail messages */
273 bool write_part_after_job; /* Set to write part after job */
274 bool PreferMountedVols; /* Prefer mounted vols rather than new */
276 uint32_t FileId; /* Last file id inserted */
278 /* Parmaters for Open Read Session */
279 BSR *bsr; /* Bootstrap record -- has everything */
280 bool mount_next_volume; /* set to cause next volume mount */
281 uint32_t read_VolSessionId;
282 uint32_t read_VolSessionTime;
283 uint32_t read_StartFile;
284 uint32_t read_EndFile;
285 uint32_t read_StartBlock;
286 uint32_t read_EndBlock;
287 /* Device wait times */
295 #endif /* STORAGE_DAEMON */
302 * Structure for all daemons that keeps some summary
303 * info on the last job run.
307 int Errors; /* FD/SD errors */
312 uint32_t VolSessionId;
313 uint32_t VolSessionTime;
318 char Job[MAX_NAME_LENGTH];
321 extern struct s_last_job last_job;
322 extern dlist *last_jobs;
325 /* The following routines are found in lib/jcr.c */
326 extern bool init_jcr_subsystem(void);
327 extern JCR *new_jcr(int size, JCR_free_HANDLER *daemon_free_jcr);
328 extern JCR *get_jcr_by_id(uint32_t JobId);
329 extern JCR *get_jcr_by_session(uint32_t SessionId, uint32_t SessionTime);
330 extern JCR *get_jcr_by_partial_name(char *Job);
331 extern JCR *get_jcr_by_full_name(char *Job);
332 extern JCR *get_next_jcr(JCR *jcr);
333 extern void set_jcr_job_status(JCR *jcr, int JobStatus);
336 extern void b_free_jcr(const char *file, int line, JCR *jcr);
337 #define free_jcr(jcr) b_free_jcr(__FILE__, __LINE__, (jcr))
339 extern void free_jcr(JCR *jcr);
342 #endif /* __JCR_H_ */