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