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 */
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 'O' /* verify we can read volume */
44 #define L_VERIFY_DATA 'A' /* verify data on volume */
50 #define JT_RESTORE 'R'
51 #define JT_CONSOLE 'C' /* console program */
52 #define JT_ADMIN 'D' /* admin job */
53 #define JT_ARCHIVE 'A'
56 #define JS_Created 'C'
57 #define JS_Running 'R'
58 #define JS_Blocked 'B'
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 || jcr->JobStatus == JS_ErrorTerminated)
73 typedef void (JCR_free_HANDLER)(struct s_jcr *jcr);
75 /* Job Control Record (JCR) */
77 /* Global part of JCR common to all daemons */
80 pthread_t my_thread_id; /* id of thread controlling jcr */
81 pthread_mutex_t mutex; /* jcr mutex */
82 BSOCK *dir_bsock; /* Director bsock or NULL if we are him */
83 BSOCK *store_bsock; /* Storage connection socket */
84 BSOCK *file_bsock; /* File daemon connection socket */
85 JCR_free_HANDLER *daemon_free_jcr; /* Local free routine */
86 int use_count; /* use count */
87 POOLMEM *errmsg; /* edited error message */
88 char Job[MAX_NAME_LENGTH]; /* Unique name of this Job */
89 uint32_t JobId; /* Director's JobId */
90 uint32_t VolSessionId;
91 uint32_t VolSessionTime;
92 uint32_t JobFiles; /* Number of files written, this job */
93 uint32_t JobErrors; /* */
94 uint64_t JobBytes; /* Number of bytes processed this job */
95 uint32_t Errors; /* Number of non-fatal errors */
96 int JobStatus; /* ready, running, blocked, terminated */
97 int JobType; /* backup, restore, verify ... */
98 int JobLevel; /* Job level */
99 int authenticated; /* set when client authenticated */
100 time_t sched_time; /* job schedule time, i.e. when it should start */
101 time_t start_time; /* when job actually started */
102 time_t run_time; /* used for computing speed */
103 time_t end_time; /* job end time */
104 POOLMEM *VolumeName; /* Volume name desired -- pool_memory */
105 POOLMEM *client_name; /* client name */
106 char *sd_auth_key; /* SD auth key */
107 MSGS *msgs; /* Message resource */
109 /* Daemon specific part of JCR */
110 /* This should be empty in the library */
112 #ifdef DIRECTOR_DAEMON
113 /* Director Daemon specific part of JCR */
114 pthread_t SD_msg_chan; /* Message channel thread id */
115 pthread_cond_t term_wait; /* Wait for job termination */
116 int msg_thread_done; /* Set when Storage message thread terms */
117 BSOCK *ua; /* User agent */
118 JOB *job; /* Job resource */
119 STORE *store; /* Storage resource */
120 CLIENT *client; /* Client resource */
121 POOL *pool; /* Pool resource */
122 FILESET *fileset; /* FileSet resource */
123 CAT *catalog; /* Catalog resource */
124 int SDJobStatus; /* Storage Job Status */
125 int mode; /* manual/auto run */
126 B_DB *db; /* database pointer */
127 int MediaId; /* DB record IDs associated with this job */
128 int ClientId; /* Client associated with file */
129 uint32_t PoolId; /* Pool record id */
130 FileId_t FileId; /* Last file id inserted */
131 uint32_t FileIndex; /* Last FileIndex processed */
132 POOLMEM *fname; /* name to put into catalog */
133 int fn_printed; /* printed filename */
134 char *stime; /* start time for incremental/differential */
135 JOB_DBR jr; /* Job record in Database */
136 int RestoreJobId; /* Id specified by UA */
137 char *RestoreWhere; /* Where to restore the files */
138 #endif /* DIRECTOR_DAEMON */
141 /* File Daemon specific part of JCR */
142 uint32_t num_files_examined; /* files examined this job */
143 char *last_fname; /* last file saved */
144 /*********FIXME********* add missing files and files to be retried */
145 int incremental; /* set if incremental for SINCE */
146 time_t mtime; /* begin time for SINCE */
147 int mode; /* manual/auto run */
148 int status; /* job status */
149 long Ticket; /* Ticket */
150 int save_level; /* save level */
151 char *big_buf; /* I/O buffer */
152 POOLMEM *compress_buf; /* Compression buffer */
153 int32_t compress_buf_size; /* Length of compression buffer */
154 char *where; /* Root where to restore */
155 int buf_size; /* length of buffer */
156 FF_PKT *ff; /* Find Files packet */
157 char stored_addr[MAX_NAME_LENGTH]; /* storage daemon address */
162 #endif /* FILE_DAEMON */
164 #ifdef STORAGE_DAEMON
165 /* Storage Daemon specific part of JCR */
166 pthread_cond_t job_start_wait; /* Wait for FD to start Job */
168 DEVRES *device; /* device to use */
169 VOLUME_CAT_INFO VolCatInfo; /* Catalog info for desired volume */
170 POOLMEM *job_name; /* base Job name (not unique) */
171 POOLMEM *fileset_name; /* FileSet */
172 POOLMEM *pool_name; /* pool to use */
173 POOLMEM *pool_type; /* pool type to use */
174 POOLMEM *media_type; /* media type */
175 POOLMEM *dev_name; /* device name */
176 long NumVolumes; /* number of volumes used */
177 long CurVolume; /* current volume number */
178 int mode; /* manual/auto run */
179 int label_status; /* device volume label status */
180 int label_errors; /* count of label errors */
182 DEV_RECORD rec; /* Read/Write record */
183 long Ticket; /* ticket for this job */
184 uint32_t VolFirstFile; /* First file index this Volume */
185 uint32_t start_block; /* Start write block */
186 uint32_t start_file; /* Start write file */
187 uint32_t end_block; /* Ending block written */
188 uint32_t end_file; /* End file written */
190 /* Parmaters for Open Read Session */
191 uint32_t read_VolSessionId;
192 uint32_t read_VolSessionTime;
193 uint32_t read_StartFile;
194 uint32_t read_EndFile;
195 uint32_t read_StartBlock;
196 uint32_t read_EndBlock;
198 #endif /* STORAGE_DAEMON */
203 * Structure for all daemons that keeps some summary
204 * info on the last job run.
211 uint32_t VolSessionId;
212 uint32_t VolSessionTime;
217 char Job[MAX_NAME_LENGTH];
220 extern struct s_last_job last_job;
223 typedef struct s_jcr JCR;
226 /* The following routines are found in lib/jcr.c */
227 extern JCR *new_jcr(int size, JCR_free_HANDLER *daemon_free_jcr);
228 extern void free_jcr(JCR *jcr);
229 extern void free_locked_jcr(JCR *jcr);
230 extern JCR *get_jcr_by_id(uint32_t JobId);
231 extern JCR *get_jcr_by_partial_name(char *Job);
232 extern JCR *get_jcr_by_full_name(char *Job);
233 extern JCR *get_next_jcr(JCR *jcr);
234 extern void lock_jcr_chain();
235 extern void unlock_jcr_chain();
237 #endif /* __JCR_H_ */