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 */
41 #define L_VERIFY_CATALOG 'C' /* verify from catalog */
42 #define L_VERIFY_INIT 'V' /* verify save (init DB) */
43 #define L_VERIFY_VOLUME_TO_CATALOG 'O' /* verify Volume to catalog entries */
44 #define L_VERIFY_DATA 'A' /* verify data on volume */
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_Cancelled 'A' /* cancelled 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 */
70 #define job_cancelled(jcr) \
71 (jcr->JobStatus == JS_Cancelled || \
72 jcr->JobStatus == JS_ErrorTerminated || \
73 jcr->JobStatus == JS_FatalError)
75 typedef void (JCR_free_HANDLER)(struct s_jcr *jcr);
77 /* Job Control Record (JCR) */
79 /* Global part of JCR common to all daemons */
82 pthread_t my_thread_id; /* id of thread controlling jcr */
83 pthread_mutex_t mutex; /* jcr mutex */
84 BSOCK *dir_bsock; /* Director bsock or NULL if we are him */
85 BSOCK *store_bsock; /* Storage connection socket */
86 BSOCK *file_bsock; /* File daemon connection socket */
87 JCR_free_HANDLER *daemon_free_jcr; /* Local free routine */
88 int use_count; /* use count */
89 POOLMEM *errmsg; /* edited error message */
90 char Job[MAX_NAME_LENGTH]; /* Unique name of this Job */
91 uint32_t JobId; /* Director's JobId */
92 uint32_t VolSessionId;
93 uint32_t VolSessionTime;
94 uint32_t JobFiles; /* Number of files written, this job */
95 uint32_t JobErrors; /* */
96 uint64_t JobBytes; /* Number of bytes processed this job */
97 uint32_t Errors; /* Number of non-fatal errors */
98 int JobStatus; /* ready, running, blocked, terminated */
99 int JobType; /* backup, restore, verify ... */
100 int JobLevel; /* Job level */
101 int authenticated; /* set when client authenticated */
102 time_t sched_time; /* job schedule time, i.e. when it should start */
103 time_t start_time; /* when job actually started */
104 time_t run_time; /* used for computing speed */
105 time_t end_time; /* job end time */
106 POOLMEM *VolumeName; /* Volume name desired -- pool_memory */
107 POOLMEM *client_name; /* client name */
108 char *RestoreBootstrap; /* Bootstrap file to restore */
109 char *sd_auth_key; /* SD auth key */
110 MSGS *jcr_msgs; /* Copy of message resource -- actually used */
111 uint32_t ClientId; /* Client associated with Job */
113 /* Daemon specific part of JCR */
114 /* This should be empty in the library */
116 #ifdef DIRECTOR_DAEMON
117 /* Director Daemon specific part of JCR */
118 pthread_t SD_msg_chan; /* Message channel thread id */
119 pthread_cond_t term_wait; /* Wait for job termination */
120 int msg_thread_done; /* Set when Storage message thread terms */
121 BSOCK *ua; /* User agent */
122 JOB *job; /* Job resource */
123 STORE *store; /* Storage resource */
124 CLIENT *client; /* Client resource */
125 POOL *pool; /* Pool resource */
126 FILESET *fileset; /* FileSet resource */
127 CAT *catalog; /* Catalog resource */
128 MSGS *messages; /* Default message handler */
129 int SDJobStatus; /* Storage Job Status */
130 int mode; /* manual/auto run */
131 B_DB *db; /* database pointer */
132 uint32_t MediaId; /* DB record IDs associated with this job */
133 uint32_t PoolId; /* Pool record id */
134 FileId_t FileId; /* Last file id inserted */
135 uint32_t FileIndex; /* Last FileIndex processed */
136 POOLMEM *fname; /* name to put into catalog */
137 int fn_printed; /* printed filename */
138 POOLMEM *stime; /* start time for incremental/differential */
139 JOB_DBR jr; /* Job record in Database */
140 uint32_t RestoreJobId; /* Id specified by UA */
141 char *RestoreWhere; /* Where to restore the files */
142 #endif /* DIRECTOR_DAEMON */
145 /* File Daemon specific part of JCR */
146 uint32_t num_files_examined; /* files examined this job */
147 POOLMEM *last_fname; /* last file saved/verified */
148 /*********FIXME********* add missing files and files to be retried */
149 int incremental; /* set if incremental for SINCE */
150 time_t mtime; /* begin time for SINCE */
151 int mode; /* manual/auto run */
152 int status; /* job status */
153 long Ticket; /* Ticket */
154 int save_level; /* save level */
155 char *big_buf; /* I/O buffer */
156 POOLMEM *compress_buf; /* Compression buffer */
157 int32_t compress_buf_size; /* Length of compression buffer */
158 POOLMEM *where; /* Root where to restore */
159 int buf_size; /* length of buffer */
160 FF_PKT *ff; /* Find Files packet */
161 char stored_addr[MAX_NAME_LENGTH]; /* storage daemon address */
166 #endif /* FILE_DAEMON */
168 #ifdef STORAGE_DAEMON
169 /* Storage Daemon specific part of JCR */
170 struct s_jcr *next_dev; /* next JCR attached to device */
171 struct s_jcr *prev_dev; /* previous JCR attached to device */
172 pthread_cond_t job_start_wait; /* Wait for FD to start Job */
174 DEVRES *device; /* device to use */
175 VOLUME_CAT_INFO VolCatInfo; /* Catalog info for desired volume */
176 POOLMEM *job_name; /* base Job name (not unique) */
177 POOLMEM *fileset_name; /* FileSet */
178 POOLMEM *pool_name; /* pool to use */
179 POOLMEM *pool_type; /* pool type to use */
180 POOLMEM *media_type; /* media type */
181 POOLMEM *dev_name; /* device name */
182 VOL_LIST *VolList; /* list to read */
183 long NumVolumes; /* number of volumes used */
184 long CurVolume; /* current volume number */
185 int mode; /* manual/auto run */
186 int spool_attributes; /* set if spooling attributes */
187 int no_attributes; /* set if no attributes wanted */
188 int label_status; /* device volume label status */
189 int label_errors; /* count of label errors */
191 DEV_RECORD rec; /* Read/Write record */
192 long Ticket; /* ticket for this job */
193 uint32_t VolFirstFile; /* First file index this Volume */
194 uint32_t FileIndex; /* Current File Index */
195 uint32_t EndFile; /* End file written */
196 uint32_t StartFile; /* Start write file */
197 uint32_t StartBlock; /* Start write block */
198 uint32_t EndBlock; /* Ending block written */
199 uint32_t FileId; /* Last file id inserted */
201 /* Parmaters for Open Read Session */
202 BSR *bsr; /* Bootstrap record -- has everything */
203 uint32_t read_VolSessionId;
204 uint32_t read_VolSessionTime;
205 uint32_t read_StartFile;
206 uint32_t read_EndFile;
207 uint32_t read_StartBlock;
208 uint32_t read_EndBlock;
210 #endif /* STORAGE_DAEMON */
215 * Structure for all daemons that keeps some summary
216 * info on the last job run.
223 uint32_t VolSessionId;
224 uint32_t VolSessionTime;
229 char Job[MAX_NAME_LENGTH];
232 extern struct s_last_job last_job;
235 typedef struct s_jcr JCR;
238 /* The following routines are found in lib/jcr.c */
239 extern JCR *new_jcr(int size, JCR_free_HANDLER *daemon_free_jcr);
240 extern void free_jcr(JCR *jcr);
241 extern void free_locked_jcr(JCR *jcr);
242 extern JCR *get_jcr_by_id(uint32_t JobId);
243 extern JCR *get_jcr_by_session(uint32_t SessionId, uint32_t SessionTime);
244 extern JCR *get_jcr_by_partial_name(char *Job);
245 extern JCR *get_jcr_by_full_name(char *Job);
246 extern JCR *get_next_jcr(JCR *jcr);
247 extern void lock_jcr_chain();
248 extern void unlock_jcr_chain();
250 #endif /* __JCR_H_ */