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.
13 Copyright (C) 2000-2005 Kern Sibbald
15 This program is free software; you can redistribute it and/or
16 modify it under the terms of the GNU General Public License as
17 published by the Free Software Foundation; either version 2 of
18 the License, or (at your option) any later version.
20 This program is distributed in the hope that it will be useful,
21 but WITHOUT ANY WARRANTY; without even the implied warranty of
22 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
23 General Public License for more details.
25 You should have received a copy of the GNU General Public
26 License along with this program; if not, write to the Free
27 Software Foundation, Inc., 59 Temple Place - Suite 330, Boston,
35 /* Backup/Verify level code. These are stored in the DB */
36 #define L_FULL 'F' /* Full backup */
37 #define L_INCREMENTAL 'I' /* since last backup */
38 #define L_DIFFERENTIAL 'D' /* since last full backup */
40 #define L_VERIFY_CATALOG 'C' /* verify from catalog */
41 #define L_VERIFY_INIT 'V' /* verify save (init DB) */
42 #define L_VERIFY_VOLUME_TO_CATALOG 'O' /* verify Volume to catalog entries */
43 #define L_VERIFY_DISK_TO_CATALOG 'd' /* verify Disk attributes to catalog */
44 #define L_VERIFY_DATA 'A' /* verify data on volume */
45 #define L_BASE 'B' /* Base level job */
46 #define L_NONE ' ' /* None, for Restore and Admin */
49 /* Job Types. These are stored in the DB */
50 #define JT_BACKUP 'B' /* Backup Job */
51 #define JT_VERIFY 'V' /* Verify Job */
52 #define JT_RESTORE 'R' /* Restore Job */
53 #define JT_CONSOLE 'C' /* console program */
54 #define JT_SYSTEM 'I' /* internal system "job" */
55 #define JT_ADMIN 'D' /* admin job */
56 #define JT_ARCHIVE 'A' /* Archive Job */
57 #define JT_COPY 'Y' /* Copy Job */
58 #define JT_MIGRATION 'M' /* Migration Job */
59 #define JT_SCAN 'S' /* Scan Job */
61 /* Job Status. Some of these are stored in the DB */
62 #define JS_Created 'C' /* created but not yet running */
63 #define JS_Running 'R' /* running */
64 #define JS_Blocked 'B' /* blocked */
65 #define JS_Terminated 'T' /* terminated normally */
66 #define JS_ErrorTerminated 'E' /* Job terminated in error */
67 #define JS_Error 'e' /* Non-fatal error */
68 #define JS_FatalError 'f' /* Fatal error */
69 #define JS_Differences 'D' /* Verify differences */
70 #define JS_Canceled 'A' /* canceled by user */
71 #define JS_WaitFD 'F' /* waiting on File daemon */
72 #define JS_WaitSD 'S' /* waiting on the Storage daemon */
73 #define JS_WaitMedia 'm' /* waiting for new media */
74 #define JS_WaitMount 'M' /* waiting for Mount */
75 #define JS_WaitStoreRes 's' /* Waiting for storage resource */
76 #define JS_WaitJobRes 'j' /* Waiting for job resource */
77 #define JS_WaitClientRes 'c' /* Waiting for Client resource */
78 #define JS_WaitMaxJobs 'd' /* Waiting for maximum jobs */
79 #define JS_WaitStartTime 't' /* Waiting for start time */
80 #define JS_WaitPriority 'p' /* Waiting for higher priority jobs to finish */
82 #define job_canceled(jcr) \
83 (jcr->JobStatus == JS_Canceled || \
84 jcr->JobStatus == JS_ErrorTerminated || \
85 jcr->JobStatus == JS_FatalError)
87 #define foreach_jcr(jcr) \
88 for ((jcr)=NULL; ((jcr)=get_next_jcr(jcr)); )
93 /* Forward referenced structures */
97 typedef void (JCR_free_HANDLER)(JCR *jcr);
99 /* Job Control Record (JCR) */
101 /* Global part of JCR common to all daemons */
104 volatile int use_count; /* use count */
105 pthread_t my_thread_id; /* id of thread controlling jcr */
106 pthread_mutex_t mutex; /* jcr mutex */
107 BSOCK *dir_bsock; /* Director bsock or NULL if we are him */
108 BSOCK *store_bsock; /* Storage connection socket */
109 BSOCK *file_bsock; /* File daemon connection socket */
110 JCR_free_HANDLER *daemon_free_jcr; /* Local free routine */
111 dlist *msg_queue; /* Queued messages */
112 alist job_end_push; /* Job end pushed calls */
113 bool dequeuing; /* dequeuing messages */
114 POOLMEM *VolumeName; /* Volume name desired -- pool_memory */
115 POOLMEM *errmsg; /* edited error message */
116 char Job[MAX_NAME_LENGTH]; /* Unique name of this Job */
117 char event[MAX_NAME_LENGTH]; /* Current event */
118 uint32_t JobId; /* Director's JobId */
119 uint32_t VolSessionId;
120 uint32_t VolSessionTime;
121 uint32_t JobFiles; /* Number of files written, this job */
122 uint32_t JobErrors; /* */
123 uint64_t JobBytes; /* Number of bytes processed this job */
124 uint64_t ReadBytes; /* Bytes read -- before compression */
125 uint32_t Errors; /* Number of non-fatal errors */
126 volatile int JobStatus; /* ready, running, blocked, terminated */
127 int JobType; /* backup, restore, verify ... */
128 int JobLevel; /* Job level */
129 int JobPriority; /* Job priority */
130 time_t sched_time; /* job schedule time, i.e. when it should start */
131 time_t start_time; /* when job actually started */
132 time_t run_time; /* used for computing speed */
133 time_t end_time; /* job end time */
134 POOLMEM *client_name; /* client name */
135 POOLMEM *RestoreBootstrap; /* Bootstrap file to restore */
136 POOLMEM *stime; /* start time for incremental/differential */
137 char *sd_auth_key; /* SD auth key */
138 MSGS *jcr_msgs; /* Copy of message resource -- actually used */
139 uint32_t ClientId; /* Client associated with Job */
140 char *where; /* prefix to restore files to */
141 int cached_pnl; /* cached path length */
142 POOLMEM *cached_path; /* cached path */
143 bool prefix_links; /* Prefix links with Where path */
144 bool gui; /* set if gui using console */
145 bool authenticated; /* set when client authenticated */
146 void *Python_jcr; /* Python Job Object */
148 /* Daemon specific part of JCR */
149 /* This should be empty in the library */
151 #ifdef DIRECTOR_DAEMON
152 /* Director Daemon specific part of JCR */
153 pthread_t SD_msg_chan; /* Message channel thread id */
154 pthread_cond_t term_wait; /* Wait for job termination */
155 workq_ele_t *work_item; /* Work queue item if scheduled */
156 volatile bool sd_msg_thread_done; /* Set when Storage message thread terms */
157 BSOCK *ua; /* User agent */
158 JOB *job; /* Job resource */
159 JOB *verify_job; /* Job resource of verify target job */
160 alist *storage; /* Storage possibilities */
161 STORE *store; /* Storage daemon selected */
162 CLIENT *client; /* Client resource */
163 POOL *pool; /* Pool resource */
164 POOL *full_pool; /* Full backup pool resource */
165 POOL *inc_pool; /* Incremental backup pool resource */
166 POOL *dif_pool; /* Differential backup pool resource */
167 FILESET *fileset; /* FileSet resource */
168 CAT *catalog; /* Catalog resource */
169 MSGS *messages; /* Default message handler */
170 uint32_t SDJobFiles; /* Number of files written, this job */
171 uint64_t SDJobBytes; /* Number of bytes processed this job */
172 uint32_t SDErrors; /* Number of non-fatal errors */
173 volatile int SDJobStatus; /* Storage Job Status */
174 volatile int FDJobStatus; /* File daemon Job Status */
175 uint32_t ExpectedFiles; /* Expected restore files */
176 B_DB *db; /* database pointer */
177 uint32_t MediaId; /* DB record IDs associated with this job */
178 uint32_t PoolId; /* Pool record id */
179 FileId_t FileId; /* Last file id inserted */
180 uint32_t FileIndex; /* Last FileIndex processed */
181 POOLMEM *fname; /* name to put into catalog */
182 JOB_DBR jr; /* Job DB record for current job */
183 JOB_DBR target_jr; /* target job */
184 char FSCreateTime[MAX_TIME_LENGTH]; /* FileSet CreateTime as returned from DB */
185 char since[MAX_TIME_LENGTH]; /* since time */
186 uint32_t RestoreJobId; /* Id specified by UA */
187 POOLMEM *client_uname; /* client uname */
188 int replace; /* Replace option */
189 int NumVols; /* Number of Volume used in pool */
190 int reschedule_count; /* Number of times rescheduled */
191 bool spool_data; /* Spool data in SD */
192 bool acquired_resource_locks; /* set if resource locks acquired */
193 bool term_wait_inited; /* Set when cond var inited */
194 bool fn_printed; /* printed filename */
195 bool write_part_after_job; /* Write part after job in SD */
196 bool needs_sd; /* set if SD needed by Job */
197 bool cloned; /* set if cloned */
198 #endif /* DIRECTOR_DAEMON */
202 /* File Daemon specific part of JCR */
203 uint32_t num_files_examined; /* files examined this job */
204 POOLMEM *last_fname; /* last file saved/verified */
205 POOLMEM *acl_text; /* text of ACL for backup */
206 /*********FIXME********* add missing files and files to be retried */
207 int incremental; /* set if incremental for SINCE */
208 time_t mtime; /* begin time for SINCE */
209 int listing; /* job listing in estimate */
210 long Ticket; /* Ticket */
211 char *big_buf; /* I/O buffer */
212 POOLMEM *compress_buf; /* Compression buffer */
213 int32_t compress_buf_size; /* Length of compression buffer */
214 int replace; /* Replace options */
215 int buf_size; /* length of buffer */
216 FF_PKT *ff; /* Find Files packet */
217 char stored_addr[MAX_NAME_LENGTH]; /* storage daemon address */
222 pthread_t heartbeat_id; /* id of heartbeat thread */
223 volatile BSOCK *hb_bsock; /* duped SD socket */
224 POOLMEM *RunAfterJob; /* Command to run after job */
225 DIRRES* director; /* Director resource */
226 #endif /* FILE_DAEMON */
229 #ifdef STORAGE_DAEMON
230 /* Storage Daemon specific part of JCR */
231 JCR *next_dev; /* next JCR attached to device */
232 JCR *prev_dev; /* previous JCR attached to device */
233 pthread_cond_t job_start_wait; /* Wait for FD to start Job */
235 DCR *dcr; /* device context record */
236 alist *dcrs; /* list of dcrs open */
237 // DEVRES *device; /* device resource to use */
238 POOLMEM *job_name; /* base Job name (not unique) */
239 POOLMEM *fileset_name; /* FileSet */
240 POOLMEM *fileset_md5; /* MD5 for FileSet */
241 VOL_LIST *VolList; /* list to read */
242 int32_t NumVolumes; /* number of volumes used */
243 int32_t CurVolume; /* current volume number */
244 int label_errors; /* count of label errors */
246 long Ticket; /* ticket for this job */
247 bool ignore_label_errors; /* ignore Volume label errors */
248 bool spool_attributes; /* set if spooling attributes */
249 bool no_attributes; /* set if no attributes wanted */
250 bool spool_data; /* set to spool data */
251 int CurVol; /* Current Volume count */
252 DIRRES* director; /* Director resource */
253 bool write_part_after_job; /* Set to write part after job */
254 bool NewVolEachJob; /* Allow using new volume */
256 uint32_t FileId; /* Last file id inserted */
258 /* Parmaters for Open Read Session */
259 BSR *bsr; /* Bootstrap record -- has everything */
260 bool mount_next_volume; /* set to cause next volume mount */
261 uint32_t read_VolSessionId;
262 uint32_t read_VolSessionTime;
263 uint32_t read_StartFile;
264 uint32_t read_EndFile;
265 uint32_t read_StartBlock;
266 uint32_t read_EndBlock;
267 /* Device wait times */
275 #endif /* STORAGE_DAEMON */
282 * Structure for all daemons that keeps some summary
283 * info on the last job run.
287 int Errors; /* FD/SD errors */
292 uint32_t VolSessionId;
293 uint32_t VolSessionTime;
298 char Job[MAX_NAME_LENGTH];
301 extern struct s_last_job last_job;
302 extern dlist *last_jobs;
305 /* The following routines are found in lib/jcr.c */
306 extern bool init_jcr_subsystem(void);
307 extern JCR *new_jcr(int size, JCR_free_HANDLER *daemon_free_jcr);
308 extern void free_locked_jcr(JCR *jcr);
309 extern JCR *get_jcr_by_id(uint32_t JobId);
310 extern JCR *get_jcr_by_session(uint32_t SessionId, uint32_t SessionTime);
311 extern JCR *get_jcr_by_partial_name(char *Job);
312 extern JCR *get_jcr_by_full_name(char *Job);
313 extern JCR *get_next_jcr(JCR *jcr);
314 extern void set_jcr_job_status(JCR *jcr, int JobStatus);
316 #ifdef TRACE_JCR_CHAIN
317 extern void b_lock_jcr_chain(const char *filen, int line);
318 extern void b_unlock_jcr_chain(const char *filen, int line);
319 #define lock_jcr_chain() b_lock_jcr_chain(__FILE__, __LINE__);
320 #define unlock_jcr_chain() b_unlock_jcr_chain(__FILE__, __LINE__);
322 extern void lock_jcr_chain();
323 extern void unlock_jcr_chain();
327 extern void b_free_jcr(const char *file, int line, JCR *jcr);
328 #define free_jcr(jcr) b_free_jcr(__FILE__, __LINE__, (jcr))
330 extern void free_jcr(JCR *jcr);
333 #endif /* __JCR_H_ */