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-2005 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 ammended 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 'Y' /* Copy Job */
53 #define JT_MIGRATION '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)=NULL; ((jcr)=get_next_jcr(jcr)); )
88 /* Forward referenced structures */
92 typedef void (JCR_free_HANDLER)(JCR *jcr);
94 /* Job Control Record (JCR) */
96 /* Global part of JCR common to all daemons */
99 volatile int use_count; /* use count */
100 pthread_t my_thread_id; /* id of thread controlling jcr */
101 pthread_mutex_t mutex; /* jcr mutex */
102 BSOCK *dir_bsock; /* Director bsock or NULL if we are him */
103 BSOCK *store_bsock; /* Storage connection socket */
104 BSOCK *file_bsock; /* File daemon connection socket */
105 JCR_free_HANDLER *daemon_free_jcr; /* Local free routine */
106 dlist *msg_queue; /* Queued messages */
107 alist job_end_push; /* Job end pushed calls */
108 bool dequeuing; /* dequeuing messages */
109 POOLMEM *VolumeName; /* Volume name desired -- pool_memory */
110 POOLMEM *errmsg; /* edited error message */
111 char Job[MAX_NAME_LENGTH]; /* Unique name of this Job */
112 char event[MAX_NAME_LENGTH]; /* Current event */
113 uint32_t JobId; /* Director's JobId */
114 uint32_t VolSessionId;
115 uint32_t VolSessionTime;
116 uint32_t JobFiles; /* Number of files written, this job */
117 uint32_t JobErrors; /* */
118 uint64_t JobBytes; /* Number of bytes processed this job */
119 uint64_t ReadBytes; /* Bytes read -- before compression */
120 uint32_t Errors; /* Number of non-fatal errors */
121 volatile int JobStatus; /* ready, running, blocked, terminated */
122 int JobType; /* backup, restore, verify ... */
123 int JobLevel; /* Job level */
124 int JobPriority; /* Job priority */
125 time_t sched_time; /* job schedule time, i.e. when it should start */
126 time_t start_time; /* when job actually started */
127 time_t run_time; /* used for computing speed */
128 time_t end_time; /* job end time */
129 POOLMEM *client_name; /* client name */
130 POOLMEM *RestoreBootstrap; /* Bootstrap file to restore */
131 POOLMEM *stime; /* start time for incremental/differential */
132 char *sd_auth_key; /* SD auth key */
133 MSGS *jcr_msgs; /* Copy of message resource -- actually used */
134 uint32_t ClientId; /* Client associated with Job */
135 char *where; /* prefix to restore files to */
136 int cached_pnl; /* cached path length */
137 POOLMEM *cached_path; /* cached path */
138 bool prefix_links; /* Prefix links with Where path */
139 bool gui; /* set if gui using console */
140 bool authenticated; /* set when client authenticated */
141 void *Python_job; /* Python Job Object */
142 void *Python_events; /* Python Events Object */
144 bool cached_attribute; /* set if attribute is cached */
145 POOLMEM *attr; /* Attribute string from SD */
147 /* Daemon specific part of JCR */
148 /* This should be empty in the library */
150 #ifdef DIRECTOR_DAEMON
151 /* Director Daemon specific part of JCR */
152 pthread_t SD_msg_chan; /* Message channel thread id */
153 pthread_cond_t term_wait; /* Wait for job termination */
154 workq_ele_t *work_item; /* Work queue item if scheduled */
155 volatile bool sd_msg_thread_done; /* Set when Storage message thread terms */
156 BSOCK *ua; /* User agent */
157 JOB *job; /* Job resource */
158 JOB *verify_job; /* Job resource of verify target job */
159 alist *storage; /* Storage possibilities */
160 STORE *store; /* Storage daemon selected */
161 CLIENT *client; /* Client resource */
162 POOL *pool; /* Pool resource */
163 POOL *full_pool; /* Full backup pool resource */
164 POOL *inc_pool; /* Incremental backup pool resource */
165 POOL *dif_pool; /* Differential backup pool resource */
166 FILESET *fileset; /* FileSet resource */
167 CAT *catalog; /* Catalog resource */
168 MSGS *messages; /* Default message handler */
169 uint32_t SDJobFiles; /* Number of files written, this job */
170 uint64_t SDJobBytes; /* Number of bytes processed this job */
171 uint32_t SDErrors; /* Number of non-fatal errors */
172 volatile int SDJobStatus; /* Storage Job Status */
173 volatile int FDJobStatus; /* File daemon Job Status */
174 uint32_t ExpectedFiles; /* Expected restore files */
175 B_DB *db; /* database pointer */
176 uint32_t MediaId; /* DB record IDs associated with this job */
177 uint32_t PoolId; /* Pool record id */
178 FileId_t FileId; /* Last file id inserted */
179 uint32_t FileIndex; /* Last FileIndex processed */
180 POOLMEM *fname; /* name to put into catalog */
181 JOB_DBR jr; /* Job DB record for current job */
182 JOB_DBR target_jr; /* target job */
183 char FSCreateTime[MAX_TIME_LENGTH]; /* FileSet CreateTime as returned from DB */
184 char since[MAX_TIME_LENGTH]; /* since time */
185 uint32_t RestoreJobId; /* Id specified by UA */
186 POOLMEM *client_uname; /* client uname */
187 int replace; /* Replace option */
188 int NumVols; /* Number of Volume used in pool */
189 int reschedule_count; /* Number of times rescheduled */
190 bool spool_data; /* Spool data in SD */
191 bool acquired_resource_locks; /* set if resource locks acquired */
192 bool term_wait_inited; /* Set when cond var inited */
193 bool fn_printed; /* printed filename */
194 bool write_part_after_job; /* Write part after job in SD */
195 bool needs_sd; /* set if SD needed by Job */
196 bool cloned; /* set if cloned */
197 bool unlink_bsr; /* Unlink bsr file created */
198 ATTR_DBR ar; /* DB attribute record */
199 #endif /* DIRECTOR_DAEMON */
203 /* File Daemon specific part of JCR */
204 uint32_t num_files_examined; /* files examined this job */
205 POOLMEM *last_fname; /* last file saved/verified */
206 POOLMEM *acl_text; /* text of ACL for backup */
207 /*********FIXME********* add missing files and files to be retried */
208 int incremental; /* set if incremental for SINCE */
209 time_t mtime; /* begin time for SINCE */
210 int listing; /* job listing in estimate */
211 long Ticket; /* Ticket */
212 char *big_buf; /* I/O buffer */
213 POOLMEM *compress_buf; /* Compression buffer */
214 int32_t compress_buf_size; /* Length of compression buffer */
215 int replace; /* Replace options */
216 int buf_size; /* length of buffer */
217 FF_PKT *ff; /* Find Files packet */
218 char stored_addr[MAX_NAME_LENGTH]; /* storage daemon address */
223 pthread_t heartbeat_id; /* id of heartbeat thread */
224 volatile BSOCK *hb_bsock; /* duped SD socket */
225 volatile BSOCK *hb_dir_bsock; /* duped DIR socket */
226 POOLMEM *RunAfterJob; /* Command to run after job */
227 DIRRES* director; /* Director resource */
228 #endif /* FILE_DAEMON */
231 #ifdef STORAGE_DAEMON
232 /* Storage Daemon specific part of JCR */
233 JCR *next_dev; /* next JCR attached to device */
234 JCR *prev_dev; /* previous JCR attached to device */
235 pthread_cond_t job_start_wait; /* Wait for FD to start Job */
237 DCR *dcr; /* device context record */
238 alist *dcrs; /* list of dcrs open */
239 POOLMEM *job_name; /* base Job name (not unique) */
240 POOLMEM *fileset_name; /* FileSet */
241 POOLMEM *fileset_md5; /* MD5 for FileSet */
242 VOL_LIST *VolList; /* list to read */
243 int32_t NumVolumes; /* number of volumes used */
244 int32_t CurVolume; /* current volume number */
245 int label_errors; /* count of label errors */
247 long Ticket; /* ticket for this job */
248 bool ignore_label_errors; /* ignore Volume label errors */
249 bool spool_attributes; /* set if spooling attributes */
250 bool no_attributes; /* set if no attributes wanted */
251 bool spool_data; /* set to spool data */
252 int CurVol; /* Current Volume count */
253 DIRRES* director; /* Director resource */
254 bool write_part_after_job; /* Set to write part after job */
255 bool NewVolEachJob; /* Allow using new volume */
257 uint32_t FileId; /* Last file id inserted */
259 /* Parmaters for Open Read Session */
260 BSR *bsr; /* Bootstrap record -- has everything */
261 bool mount_next_volume; /* set to cause next volume mount */
262 uint32_t read_VolSessionId;
263 uint32_t read_VolSessionTime;
264 uint32_t read_StartFile;
265 uint32_t read_EndFile;
266 uint32_t read_StartBlock;
267 uint32_t read_EndBlock;
268 /* Device wait times */
276 #endif /* STORAGE_DAEMON */
283 * Structure for all daemons that keeps some summary
284 * info on the last job run.
288 int Errors; /* FD/SD errors */
293 uint32_t VolSessionId;
294 uint32_t VolSessionTime;
299 char Job[MAX_NAME_LENGTH];
302 extern struct s_last_job last_job;
303 extern dlist *last_jobs;
306 /* The following routines are found in lib/jcr.c */
307 extern bool init_jcr_subsystem(void);
308 extern JCR *new_jcr(int size, JCR_free_HANDLER *daemon_free_jcr);
309 extern void free_locked_jcr(JCR *jcr);
310 extern JCR *get_jcr_by_id(uint32_t JobId);
311 extern JCR *get_jcr_by_session(uint32_t SessionId, uint32_t SessionTime);
312 extern JCR *get_jcr_by_partial_name(char *Job);
313 extern JCR *get_jcr_by_full_name(char *Job);
314 extern JCR *get_next_jcr(JCR *jcr);
315 extern void set_jcr_job_status(JCR *jcr, int JobStatus);
317 #ifdef TRACE_JCR_CHAIN
318 extern void b_lock_jcr_chain(const char *filen, int line);
319 extern void b_unlock_jcr_chain(const char *filen, int line);
320 #define lock_jcr_chain() b_lock_jcr_chain(__FILE__, __LINE__);
321 #define unlock_jcr_chain() b_unlock_jcr_chain(__FILE__, __LINE__);
323 extern void lock_jcr_chain();
324 extern void unlock_jcr_chain();
328 extern void b_free_jcr(const char *file, int line, JCR *jcr);
329 #define free_jcr(jcr) b_free_jcr(__FILE__, __LINE__, (jcr))
331 extern void free_jcr(JCR *jcr);
334 #endif /* __JCR_H_ */