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