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