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, 2001, 2002 Kern Sibbald and John Walker
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_ADMIN 'D' /* admin job */
55 #define JT_ARCHIVE 'A'
57 /* Job Status. Some of these are stored in the DB */
58 #define JS_Created 'C' /* created but not yet running */
59 #define JS_Running 'R' /* running */
60 #define JS_Blocked 'B' /* blocked */
61 #define JS_Terminated 'T' /* terminated normally */
62 #define JS_ErrorTerminated 'E' /* Job terminated in error */
63 #define JS_Error 'e' /* Non-fatal error */
64 #define JS_FatalError 'f' /* Fatal error */
65 #define JS_Differences 'D' /* Verify differences */
66 #define JS_Canceled 'A' /* canceled by user */
67 #define JS_WaitFD 'F' /* waiting on File daemon */
68 #define JS_WaitSD 'S' /* waiting on the Storage daemon */
69 #define JS_WaitMedia 'm' /* waiting for new media */
70 #define JS_WaitMount 'M' /* waiting for Mount */
71 #define JS_WaitStoreRes 's' /* Waiting for storage resource */
72 #define JS_WaitJobRes 'j' /* Waiting for job resource */
73 #define JS_WaitClientRes 'c' /* Waiting for Client resource */
74 #define JS_WaitMaxJobs 'd' /* Waiting for maximum jobs */
75 #define JS_WaitStartTime 't' /* Waiting for start time */
76 #define JS_WaitPriority 'p' /* Waiting for higher priority jobs to finish */
78 #define job_canceled(jcr) \
79 (jcr->JobStatus == JS_Canceled || \
80 jcr->JobStatus == JS_ErrorTerminated || \
81 jcr->JobStatus == JS_FatalError)
85 typedef void (JCR_free_HANDLER)(JCR *jcr);
87 /* Job Control Record (JCR) */
89 /* Global part of JCR common to all daemons */
92 volatile int use_count; /* use count */
93 pthread_t my_thread_id; /* id of thread controlling jcr */
94 pthread_mutex_t mutex; /* jcr mutex */
95 BSOCK *dir_bsock; /* Director bsock or NULL if we are him */
96 BSOCK *store_bsock; /* Storage connection socket */
97 BSOCK *file_bsock; /* File daemon connection socket */
98 JCR_free_HANDLER *daemon_free_jcr; /* Local free routine */
99 POOLMEM *errmsg; /* edited error message */
100 char Job[MAX_NAME_LENGTH]; /* Unique name of this Job */
101 uint32_t JobId; /* Director's JobId */
102 uint32_t VolSessionId;
103 uint32_t VolSessionTime;
104 uint32_t JobFiles; /* Number of files written, this job */
105 uint32_t JobErrors; /* */
106 uint64_t JobBytes; /* Number of bytes processed this job */
107 uint64_t ReadBytes; /* Bytes read -- before compression */
108 uint32_t Errors; /* Number of non-fatal errors */
109 volatile int JobStatus; /* ready, running, blocked, terminated */
110 int JobType; /* backup, restore, verify ... */
111 int JobLevel; /* Job level */
112 int JobPriority; /* Job priority */
113 int authenticated; /* set when client authenticated */
114 time_t sched_time; /* job schedule time, i.e. when it should start */
115 time_t start_time; /* when job actually started */
116 time_t run_time; /* used for computing speed */
117 time_t end_time; /* job end time */
118 POOLMEM *VolumeName; /* Volume name desired -- pool_memory */
119 POOLMEM *client_name; /* client name */
120 POOLMEM *RestoreBootstrap; /* Bootstrap file to restore */
121 char *sd_auth_key; /* SD auth key */
122 MSGS *jcr_msgs; /* Copy of message resource -- actually used */
123 uint32_t ClientId; /* Client associated with Job */
124 char *where; /* prefix to restore files to */
125 int prefix_links; /* Prefix links with Where path */
126 int cached_pnl; /* cached path length */
127 POOLMEM *cached_path; /* cached path */
129 /* Daemon specific part of JCR */
130 /* This should be empty in the library */
132 #ifdef DIRECTOR_DAEMON
133 /* Director Daemon specific part of JCR */
134 pthread_t SD_msg_chan; /* Message channel thread id */
135 pthread_cond_t term_wait; /* Wait for job termination */
136 workq_ele_t *work_item; /* Work queue item if scheduled */
137 volatile bool sd_msg_thread_done; /* Set when Storage message thread terms */
138 BSOCK *ua; /* User agent */
139 JOB *job; /* Job resource */
140 STORE *store; /* Storage resource */
141 CLIENT *client; /* Client resource */
142 POOL *pool; /* Pool resource */
143 FILESET *fileset; /* FileSet resource */
144 CAT *catalog; /* Catalog resource */
145 MSGS *messages; /* Default message handler */
146 uint32_t SDJobFiles; /* Number of files written, this job */
147 uint64_t SDJobBytes; /* Number of bytes processed this job */
148 uint32_t SDErrors; /* Number of non-fatal errors */
149 volatile int SDJobStatus; /* Storage Job Status */
150 volatile int FDJobStatus; /* File daemon Job Status */
151 B_DB *db; /* database pointer */
152 uint32_t MediaId; /* DB record IDs associated with this job */
153 uint32_t PoolId; /* Pool record id */
154 FileId_t FileId; /* Last file id inserted */
155 uint32_t FileIndex; /* Last FileIndex processed */
156 POOLMEM *fname; /* name to put into catalog */
157 int fn_printed; /* printed filename */
158 POOLMEM *stime; /* start time for incremental/differential */
159 JOB_DBR jr; /* Job DB record for current job */
160 JOB_DBR *verify_jr; /* Pointer to target job */
161 uint32_t RestoreJobId; /* Id specified by UA */
162 POOLMEM *client_uname; /* client uname */
163 int replace; /* Replace option */
164 bool acquired_resource_locks; /* set if resource locks acquired */
165 int NumVols; /* Number of Volume used in pool */
166 int reschedule_count; /* Number of times rescheduled */
167 #endif /* DIRECTOR_DAEMON */
171 /* File Daemon specific part of JCR */
172 uint32_t num_files_examined; /* files examined this job */
173 POOLMEM *last_fname; /* last file saved/verified */
174 /*********FIXME********* add missing files and files to be retried */
175 int incremental; /* set if incremental for SINCE */
176 time_t mtime; /* begin time for SINCE */
177 int mtime_only; /* compare only mtime and not ctime as well */
178 int listing; /* job listing in estimate */
179 long Ticket; /* Ticket */
180 char *big_buf; /* I/O buffer */
181 POOLMEM *compress_buf; /* Compression buffer */
182 int32_t compress_buf_size; /* Length of compression buffer */
183 int replace; /* Replace options */
184 int buf_size; /* length of buffer */
185 void *ff; /* Find Files packet */
186 char stored_addr[MAX_NAME_LENGTH]; /* storage daemon address */
191 pthread_t heartbeat_id; /* id of heartbeat thread */
192 volatile BSOCK *hb_bsock; /* duped SD socket */
193 POOLMEM *RunAfterJob; /* Command to run after job */
194 #endif /* FILE_DAEMON */
197 #ifdef STORAGE_DAEMON
198 /* Storage Daemon specific part of JCR */
199 JCR *next_dev; /* next JCR attached to device */
200 JCR *prev_dev; /* previous JCR attached to device */
201 pthread_cond_t job_start_wait; /* Wait for FD to start Job */
203 DEVRES *device; /* device to use */
204 VOLUME_CAT_INFO VolCatInfo; /* Catalog info for desired volume */
205 POOLMEM *job_name; /* base Job name (not unique) */
206 POOLMEM *fileset_name; /* FileSet */
207 POOLMEM *fileset_md5; /* MD5 for FileSet */
208 POOLMEM *pool_name; /* pool to use */
209 POOLMEM *pool_type; /* pool type to use */
210 POOLMEM *media_type; /* media type */
211 POOLMEM *dev_name; /* device name */
212 VOL_LIST *VolList; /* list to read */
213 int32_t NumVolumes; /* number of volumes used */
214 int32_t CurVolume; /* current volume number */
215 int spool_attributes; /* set if spooling attributes */
216 int no_attributes; /* set if no attributes wanted */
217 int label_status; /* device volume label status */
218 int label_errors; /* count of label errors */
220 DEV_RECORD rec; /* Read/Write record */
221 long Ticket; /* ticket for this job */
222 uint32_t VolFirstIndex; /* First file index this Volume */
223 uint32_t VolLastIndex; /* Last file index this Volume */
224 uint32_t FileIndex; /* Current File Index */
225 uint32_t EndFile; /* End file written */
226 uint32_t StartFile; /* Start write file */
227 uint32_t StartBlock; /* Start write block */
228 uint32_t EndBlock; /* Ending block written */
229 bool NewVol; /* set when new Volume mounted */
230 bool WroteVol; /* set when Volume written */
231 bool NewFile; /* set when EOF written */
232 int CurVol; /* Current Volume count */
234 uint32_t FileId; /* Last file id inserted */
236 /* Parmaters for Open Read Session */
237 BSR *bsr; /* Bootstrap record -- has everything */
238 uint32_t read_VolSessionId;
239 uint32_t read_VolSessionTime;
240 uint32_t read_StartFile;
241 uint32_t read_EndFile;
242 uint32_t read_StartBlock;
243 uint32_t read_EndBlock;
245 #endif /* STORAGE_DAEMON */
252 * Structure for all daemons that keeps some summary
253 * info on the last job run.
262 uint32_t VolSessionId;
263 uint32_t VolSessionTime;
268 char Job[MAX_NAME_LENGTH];
271 extern struct s_last_job last_job;
272 extern dlist *last_jobs;
275 /* The following routines are found in lib/jcr.c */
276 extern JCR *new_jcr(int size, JCR_free_HANDLER *daemon_free_jcr);
277 extern void free_locked_jcr(JCR *jcr);
278 extern JCR *get_jcr_by_id(uint32_t JobId);
279 extern JCR *get_jcr_by_session(uint32_t SessionId, uint32_t SessionTime);
280 extern JCR *get_jcr_by_partial_name(char *Job);
281 extern JCR *get_jcr_by_full_name(char *Job);
282 extern JCR *get_next_jcr(JCR *jcr);
283 extern void lock_jcr_chain();
284 extern void unlock_jcr_chain();
285 extern void set_jcr_job_status(JCR *jcr, int JobStatus);
288 extern void b_free_jcr(char *file, int line, JCR *jcr);
289 #define free_jcr(jcr) b_free_jcr(__FILE__, __LINE__, (jcr))
291 extern void free_jcr(JCR *jcr);
294 #endif /* __JCR_H_ */