]> git.sur5r.net Git - bacula/bacula/blob - bacula/src/jcr.h
Second cut ANSI labels
[bacula/bacula] / bacula / src / jcr.h
1 /*
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.
6  *
7  * Kern Sibbald, Nov MM
8  *
9  *   Version $Id$
10  */
11
12 /*
13    Copyright (C) 2000-2005 Kern Sibbald
14
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.
19
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.
24
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,
28    MA 02111-1307, USA.
29
30  */
31
32 #ifndef __JCR_H_
33 #define __JCR_H_ 1
34
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 */
39 #define L_SINCE                  'S'
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 */
47
48
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_SYSTEM                'S'  /* internal system "job" */
55 #define JT_ADMIN                 'D'  /* admin job */
56 #define JT_ARCHIVE               'A'  /* Archive Job */
57 #define JT_COPY                  'Y'  /* Copy Job */
58 #define JT_MIGRATION             'M'  /* Migration Job */
59
60 /* Job Status. Some of these are stored in the DB */
61 #define JS_Created               'C'  /* created but not yet running */
62 #define JS_Running               'R'  /* running */
63 #define JS_Blocked               'B'  /* blocked */
64 #define JS_Terminated            'T'  /* terminated normally */
65 #define JS_ErrorTerminated       'E'  /* Job terminated in error */
66 #define JS_Error                 'e'  /* Non-fatal error */
67 #define JS_FatalError            'f'  /* Fatal error */
68 #define JS_Differences           'D'  /* Verify differences */
69 #define JS_Canceled              'A'  /* canceled by user */
70 #define JS_WaitFD                'F'  /* waiting on File daemon */
71 #define JS_WaitSD                'S'  /* waiting on the Storage daemon */
72 #define JS_WaitMedia             'm'  /* waiting for new media */
73 #define JS_WaitMount             'M'  /* waiting for Mount */
74 #define JS_WaitStoreRes          's'  /* Waiting for storage resource */
75 #define JS_WaitJobRes            'j'  /* Waiting for job resource */
76 #define JS_WaitClientRes         'c'  /* Waiting for Client resource */
77 #define JS_WaitMaxJobs           'd'  /* Waiting for maximum jobs */
78 #define JS_WaitStartTime         't'  /* Waiting for start time */
79 #define JS_WaitPriority          'p'  /* Waiting for higher priority jobs to finish */
80
81 #define job_canceled(jcr) \
82   (jcr->JobStatus == JS_Canceled || \
83    jcr->JobStatus == JS_ErrorTerminated || \
84    jcr->JobStatus == JS_FatalError)
85
86 #define foreach_jcr(jcr) \
87    for ((jcr)=NULL; ((jcr)=get_next_jcr(jcr)); )
88
89 #define SD_APPEND 1
90 #define SD_READ   0
91
92
93 struct JCR;
94 typedef void (JCR_free_HANDLER)(JCR *jcr);
95
96 /* Job Control Record (JCR) */
97 struct JCR {
98    /* Global part of JCR common to all daemons */
99    JCR *next;
100    JCR *prev;
101    volatile int use_count;            /* use count */
102    pthread_t my_thread_id;            /* id of thread controlling jcr */
103    pthread_mutex_t mutex;             /* jcr mutex */
104    BSOCK *dir_bsock;                  /* Director bsock or NULL if we are him */
105    BSOCK *store_bsock;                /* Storage connection socket */
106    BSOCK *file_bsock;                 /* File daemon connection socket */
107    JCR_free_HANDLER *daemon_free_jcr; /* Local free routine */
108    dlist *msg_queue;                  /* Queued messages */
109    alist job_end_push;                /* Job end pushed calls */
110    bool dequeuing;                    /* dequeuing messages */
111    POOLMEM *VolumeName;               /* Volume name desired -- pool_memory */
112    POOLMEM *errmsg;                   /* edited error message */
113    char Job[MAX_NAME_LENGTH];         /* Unique name of this Job */
114    uint32_t JobId;                    /* Director's JobId */
115    uint32_t VolSessionId;
116    uint32_t VolSessionTime;
117    uint32_t JobFiles;                 /* Number of files written, this job */
118    uint32_t JobErrors;                /* */
119    uint64_t JobBytes;                 /* Number of bytes processed this job */
120    uint64_t ReadBytes;                /* Bytes read -- before compression */
121    uint32_t Errors;                   /* Number of non-fatal errors */
122    volatile int JobStatus;            /* ready, running, blocked, terminated */
123    int JobType;                       /* backup, restore, verify ... */
124    int JobLevel;                      /* Job level */
125    int JobPriority;                   /* Job priority */
126    time_t sched_time;                 /* job schedule time, i.e. when it should start */
127    time_t start_time;                 /* when job actually started */
128    time_t run_time;                   /* used for computing speed */
129    time_t end_time;                   /* job end time */
130    POOLMEM *client_name;              /* client name */
131    POOLMEM *RestoreBootstrap;         /* Bootstrap file to restore */
132    char *sd_auth_key;                 /* SD auth key */
133    MSGS *jcr_msgs;                    /* Copy of message resource -- actually used */
134    uint32_t ClientId;                 /* Client associated with Job */
135    char *where;                       /* prefix to restore files to */
136    int cached_pnl;                    /* cached path length */
137    POOLMEM *cached_path;              /* cached path */
138    bool prefix_links;                 /* Prefix links with Where path */
139    bool gui;                          /* set if gui using console */
140    bool authenticated;                /* set when client authenticated */
141
142    /* Daemon specific part of JCR */
143    /* This should be empty in the library */
144
145 #ifdef DIRECTOR_DAEMON
146    /* Director Daemon specific part of JCR */
147    pthread_t SD_msg_chan;             /* Message channel thread id */
148    pthread_cond_t term_wait;          /* Wait for job termination */
149    workq_ele_t *work_item;            /* Work queue item if scheduled */
150    volatile bool sd_msg_thread_done;  /* Set when Storage message thread terms */
151    BSOCK *ua;                         /* User agent */
152    JOB *job;                          /* Job resource */
153    JOB *verify_job;                   /* Job resource of verify target job */
154    alist *storage;                    /* Storage possibilities */
155    STORE *store;                      /* Storage daemon selected */
156    CLIENT *client;                    /* Client resource */
157    POOL *pool;                        /* Pool resource */
158    POOL *full_pool;                   /* Full backup pool resource */
159    POOL *inc_pool;                    /* Incremental backup pool resource */
160    POOL *dif_pool;                    /* Differential backup pool resource */
161    FILESET *fileset;                  /* FileSet resource */
162    CAT *catalog;                      /* Catalog resource */
163    MSGS *messages;                    /* Default message handler */
164    uint32_t SDJobFiles;               /* Number of files written, this job */
165    uint64_t SDJobBytes;               /* Number of bytes processed this job */
166    uint32_t SDErrors;                 /* Number of non-fatal errors */
167    volatile int SDJobStatus;          /* Storage Job Status */
168    volatile int FDJobStatus;          /* File daemon Job Status */
169    uint32_t ExpectedFiles;            /* Expected restore files */
170    B_DB *db;                          /* database pointer */
171    uint32_t MediaId;                  /* DB record IDs associated with this job */
172    uint32_t PoolId;                   /* Pool record id */
173    FileId_t FileId;                   /* Last file id inserted */
174    uint32_t FileIndex;                /* Last FileIndex processed */
175    POOLMEM *fname;                    /* name to put into catalog */
176    POOLMEM *stime;                    /* start time for incremental/differential */
177    JOB_DBR jr;                        /* Job DB record for current job */
178    JOB_DBR *verify_jr;                /* Pointer to target job */
179    uint32_t RestoreJobId;             /* Id specified by UA */
180    POOLMEM *client_uname;             /* client uname */
181    int replace;                       /* Replace option */
182    int saveMaxConcurrentJobs;         /* save for restore jobs */
183    int NumVols;                       /* Number of Volume used in pool */
184    int reschedule_count;              /* Number of times rescheduled */
185    bool spool_data;                   /* Spool data in SD */
186    bool acquired_resource_locks;      /* set if resource locks acquired */
187    bool term_wait_inited;             /* Set when cond var inited */
188    bool fn_printed;                   /* printed filename */
189    bool write_part_after_job;         /* Write part after job in SD */
190 #endif /* DIRECTOR_DAEMON */
191
192
193 #ifdef FILE_DAEMON
194    /* File Daemon specific part of JCR */
195    uint32_t num_files_examined;       /* files examined this job */
196    POOLMEM *last_fname;               /* last file saved/verified */
197    POOLMEM *acl_text;                 /* text of ACL for backup */
198    /*********FIXME********* add missing files and files to be retried */
199    int incremental;                   /* set if incremental for SINCE */
200    time_t mtime;                      /* begin time for SINCE */
201    int listing;                       /* job listing in estimate */
202    long Ticket;                       /* Ticket */
203    char *big_buf;                     /* I/O buffer */
204    POOLMEM *compress_buf;             /* Compression buffer */
205    int32_t compress_buf_size;         /* Length of compression buffer */
206    int replace;                       /* Replace options */
207    int buf_size;                      /* length of buffer */
208    void *ff;                          /* Find Files packet */
209    char stored_addr[MAX_NAME_LENGTH]; /* storage daemon address */
210    uint32_t StartFile;
211    uint32_t EndFile;
212    uint32_t StartBlock;
213    uint32_t EndBlock;
214    pthread_t heartbeat_id;            /* id of heartbeat thread */
215    volatile BSOCK *hb_bsock;          /* duped SD socket */
216    POOLMEM *RunAfterJob;              /* Command to run after job */
217    DIRRES* director;                  /* Director resource */
218 #endif /* FILE_DAEMON */
219
220
221 #ifdef STORAGE_DAEMON
222    /* Storage Daemon specific part of JCR */
223    JCR *next_dev;                     /* next JCR attached to device */
224    JCR *prev_dev;                     /* previous JCR attached to device */
225    pthread_cond_t job_start_wait;     /* Wait for FD to start Job */
226    int type;
227    DCR *dcr;                          /* device context record */
228    alist *dcrs;                       /* list of dcrs open */
229 // DEVRES *device;                    /* device resource to use */
230    POOLMEM *job_name;                 /* base Job name (not unique) */
231    POOLMEM *fileset_name;             /* FileSet */
232    POOLMEM *fileset_md5;              /* MD5 for FileSet */
233    VOL_LIST *VolList;                 /* list to read */
234    int32_t NumVolumes;                /* number of volumes used */
235    int32_t CurVolume;                 /* current volume number */
236    int label_errors;                  /* count of label errors */
237    bool session_opened;
238    long Ticket;                       /* ticket for this job */
239    bool ignore_label_errors;          /* ignore Volume label errors */
240    bool spool_attributes;             /* set if spooling attributes */
241    bool no_attributes;                /* set if no attributes wanted */
242    bool spool_data;                   /* set to spool data */
243    int CurVol;                        /* Current Volume count */
244    DIRRES* director;                  /* Director resource */
245    bool write_part_after_job;         /* Set to write part after job */
246    
247    uint32_t FileId;                   /* Last file id inserted */
248
249    /* Parmaters for Open Read Session */
250    BSR *bsr;                          /* Bootstrap record -- has everything */
251    uint32_t read_VolSessionId;
252    uint32_t read_VolSessionTime;
253    uint32_t read_StartFile;
254    uint32_t read_EndFile;
255    uint32_t read_StartBlock;
256    uint32_t read_EndBlock;
257
258 #endif /* STORAGE_DAEMON */
259
260 };
261
262
263
264 /*
265  * Structure for all daemons that keeps some summary
266  *  info on the last job run.
267  */
268 struct s_last_job {
269    dlink link;
270    int Errors;                        /* FD/SD errors */
271    int JobType;
272    int JobStatus;
273    int JobLevel;
274    uint32_t JobId;
275    uint32_t VolSessionId;
276    uint32_t VolSessionTime;
277    uint32_t JobFiles;
278    uint64_t JobBytes;
279    time_t start_time;
280    time_t end_time;
281    char Job[MAX_NAME_LENGTH];
282 };
283
284 extern struct s_last_job last_job;
285 extern dlist *last_jobs;
286
287
288 /* The following routines are found in lib/jcr.c */
289 extern bool init_jcr_subsystem(void);
290 extern JCR *new_jcr(int size, JCR_free_HANDLER *daemon_free_jcr);
291 extern void free_locked_jcr(JCR *jcr);
292 extern JCR *get_jcr_by_id(uint32_t JobId);
293 extern JCR *get_jcr_by_session(uint32_t SessionId, uint32_t SessionTime);
294 extern JCR *get_jcr_by_partial_name(char *Job);
295 extern JCR *get_jcr_by_full_name(char *Job);
296 extern JCR *get_next_jcr(JCR *jcr);
297 extern void set_jcr_job_status(JCR *jcr, int JobStatus);
298
299 #ifdef TRACE_JCR_CHAIN
300 extern void b_lock_jcr_chain(const char *filen, int line);
301 extern void b_unlock_jcr_chain(const char *filen, int line);
302 #define lock_jcr_chain() b_lock_jcr_chain(__FILE__, __LINE__);
303 #define unlock_jcr_chain() b_unlock_jcr_chain(__FILE__, __LINE__);
304 #else
305 extern void lock_jcr_chain();
306 extern void unlock_jcr_chain();
307 #endif
308
309 #ifdef DEBUG
310 extern void b_free_jcr(const char *file, int line, JCR *jcr);
311 #define free_jcr(jcr) b_free_jcr(__FILE__, __LINE__, (jcr))
312 #else
313 extern void free_jcr(JCR *jcr);
314 #endif
315
316 #endif /* __JCR_H_ */