]> git.sur5r.net Git - bacula/bacula/blob - bacula/src/jcr.h
ebl Add '*' when volume is online when displaying volume list in restore.
[bacula/bacula] / bacula / src / jcr.h
1 /*
2    Bacula® - The Network Backup Solution
3
4    Copyright (C) 2000-2009 Free Software Foundation Europe e.V.
5
6    The main author of Bacula is Kern Sibbald, with contributions from
7    many others, a complete list can be found in the file AUTHORS.
8    This program is Free Software; you can redistribute it and/or
9    modify it under the terms of version two of the GNU General Public
10    License as published by the Free Software Foundation and included
11    in the file LICENSE.
12
13    This program is distributed in the hope that it will be useful, but
14    WITHOUT ANY WARRANTY; without even the implied warranty of
15    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16    General Public License for more details.
17
18    You should have received a copy of the GNU General Public License
19    along with this program; if not, write to the Free Software
20    Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
21    02110-1301, USA.
22
23    Bacula® is a registered trademark of Kern Sibbald.
24    The licensor of Bacula is the Free Software Foundation Europe
25    (FSFE), Fiduciary Program, Sumatrastrasse 25, 8006 Zürich,
26    Switzerland, email:ftf@fsfeurope.org.
27 */
28 /*
29  * Bacula JCR Structure definition for Daemons and the Library
30  *  This definition consists of a "Global" definition common
31  *  to all daemons and used by the library routines, and a
32  *  daemon specific part that is enabled with #defines.
33  *
34  * Kern Sibbald, Nov MM
35  *
36  *   Version $Id$
37  */
38
39
40 #ifndef __JCR_H_
41 #define __JCR_H_ 1
42
43 /* Backup/Verify level code. These are stored in the DB */
44 #define L_FULL                   'F'  /* Full backup */
45 #define L_INCREMENTAL            'I'  /* since last backup */
46 #define L_DIFFERENTIAL           'D'  /* since last full backup */
47 #define L_SINCE                  'S'
48 #define L_VERIFY_CATALOG         'C'  /* verify from catalog */
49 #define L_VERIFY_INIT            'V'  /* verify save (init DB) */
50 #define L_VERIFY_VOLUME_TO_CATALOG 'O'  /* verify Volume to catalog entries */
51 #define L_VERIFY_DISK_TO_CATALOG 'd'  /* verify Disk attributes to catalog */
52 #define L_VERIFY_DATA            'A'  /* verify data on volume */
53 #define L_BASE                   'B'  /* Base level job */
54 #define L_NONE                   ' '  /* None, for Restore and Admin */
55 #define L_VIRTUAL_FULL           'f'  /* Virtual full backup */
56
57
58 /* Job Types. These are stored in the DB */
59 #define JT_BACKUP                'B'  /* Backup Job */
60 #define JT_MIGRATED_JOB          'M'  /* A previous backup job that was migrated */
61 #define JT_VERIFY                'V'  /* Verify Job */
62 #define JT_RESTORE               'R'  /* Restore Job */
63 #define JT_CONSOLE               'U'  /* console program */
64 #define JT_SYSTEM                'I'  /* internal system "job" */
65 #define JT_ADMIN                 'D'  /* admin job */
66 #define JT_ARCHIVE               'A'  /* Archive Job */
67 #define JT_JOB_COPY              'C'  /* Copy of a Job */
68 #define JT_COPY                  'c'  /* Copy Job */
69 #define JT_MIGRATE               'g'  /* Migration Job */
70 #define JT_SCAN                  'S'  /* Scan Job */
71
72 /* Job Status. Some of these are stored in the DB */
73 #define JS_Created               'C'  /* created but not yet running */
74 #define JS_Running               'R'  /* running */
75 #define JS_Blocked               'B'  /* blocked */
76 #define JS_Terminated            'T'  /* terminated normally */
77 #define JS_Warnings              'W'  /* Terminated normally with warnings */
78 #define JS_ErrorTerminated       'E'  /* Job terminated in error */
79 #define JS_Error                 'e'  /* Non-fatal error */
80 #define JS_FatalError            'f'  /* Fatal error */
81 #define JS_Differences           'D'  /* Verify differences */
82 #define JS_Canceled              'A'  /* canceled by user */
83 #define JS_WaitFD                'F'  /* waiting on File daemon */
84 #define JS_WaitSD                'S'  /* waiting on the Storage daemon */
85 #define JS_WaitMedia             'm'  /* waiting for new media */
86 #define JS_WaitMount             'M'  /* waiting for Mount */
87 #define JS_WaitStoreRes          's'  /* Waiting for storage resource */
88 #define JS_WaitJobRes            'j'  /* Waiting for job resource */
89 #define JS_WaitClientRes         'c'  /* Waiting for Client resource */
90 #define JS_WaitMaxJobs           'd'  /* Waiting for maximum jobs */
91 #define JS_WaitStartTime         't'  /* Waiting for start time */
92 #define JS_WaitPriority          'p'  /* Waiting for higher priority jobs to finish */
93 #define JS_AttrDespooling        'a'  /* SD despooling attributes */
94 #define JS_AttrInserting         'i'  /* Doing batch insert file records */
95 #define JS_DataDespooling        'l'  /* Doing data despooling */
96 #define JS_DataCommitting        'L'  /* Committing data (last despool) */
97
98 /* Migration selection types */
99 enum {
100    MT_SMALLEST_VOL = 1,
101    MT_OLDEST_VOL,
102    MT_POOL_OCCUPANCY,
103    MT_POOL_TIME,
104    MT_POOL_UNCOPIED_JOBS,
105    MT_CLIENT,
106    MT_VOLUME,
107    MT_JOB,
108    MT_SQLQUERY
109 };
110
111 #define job_canceled(jcr) \
112   (jcr->JobStatus == JS_Canceled || \
113    jcr->JobStatus == JS_ErrorTerminated || \
114    jcr->JobStatus == JS_FatalError)
115
116 #define job_waiting(jcr) \
117   (jcr->JobStatus == JS_WaitFD       || \
118    jcr->JobStatus == JS_WaitSD       || \
119    jcr->JobStatus == JS_WaitMedia    || \
120    jcr->JobStatus == JS_WaitMount    || \
121    jcr->JobStatus == JS_WaitStoreRes || \
122    jcr->JobStatus == JS_WaitJobRes   || \
123    jcr->JobStatus == JS_WaitClientRes|| \
124    jcr->JobStatus == JS_WaitMaxJobs  || \
125    jcr->JobStatus == JS_WaitPriority || \
126    jcr->SDJobStatus == JS_WaitMedia  || \
127    jcr->SDJobStatus == JS_WaitMount  || \
128    jcr->SDJobStatus == JS_WaitMaxJobs)
129
130
131
132 #define foreach_jcr(jcr) \
133    for (jcr=jcr_walk_start(); jcr; (jcr=jcr_walk_next(jcr)) )
134
135 #define endeach_jcr(jcr) jcr_walk_end(jcr)
136
137 #define SD_APPEND 1
138 #define SD_READ   0
139
140 /* Forward referenced structures */
141 class JCR;
142 struct FF_PKT;
143 struct B_DB;
144 struct ATTR_DBR;
145 struct Plugin;
146 struct save_pkt;
147 struct bpContext;
148
149 #ifdef FILE_DAEMON
150 class htable;
151
152 struct CRYPTO_CTX {
153    bool pki_sign;                     /* Enable PKI Signatures? */
154    bool pki_encrypt;                  /* Enable PKI Encryption? */
155    DIGEST *digest;                    /* Last file's digest context */
156    X509_KEYPAIR *pki_keypair;         /* Encryption key pair */
157    alist *pki_signers;                /* Trusted Signers */
158    alist *pki_recipients;             /* Trusted Recipients */
159    CRYPTO_SESSION *pki_session;       /* PKE Public Keys + Symmetric Session Keys */
160    POOLMEM *pki_session_encoded;      /* Cached DER-encoded copy of pki_session */
161    int32_t pki_session_encoded_size;  /* Size of DER-encoded pki_session */
162    POOLMEM *crypto_buf;               /* Encryption/Decryption buffer */
163 };
164 #endif
165
166 typedef void (JCR_free_HANDLER)(JCR *jcr);
167
168 /* Job Control Record (JCR) */
169 class JCR {
170 private:
171    pthread_mutex_t mutex;             /* jcr mutex */
172    volatile int32_t _use_count;       /* use count */
173    int32_t m_JobType;                 /* backup, restore, verify ... */
174    int32_t m_JobLevel;                /* Job level */
175 public:
176    void lock() {P(mutex); };
177    void unlock() {V(mutex); };
178    void inc_use_count(void) {lock(); _use_count++; unlock(); };
179    void dec_use_count(void) {lock(); _use_count--; unlock(); };
180    int32_t use_count() { return _use_count; };
181    void init_mutex(void) {pthread_mutex_init(&mutex, NULL); };
182    void destroy_mutex(void) {pthread_mutex_destroy(&mutex); };
183    bool is_job_canceled() {return job_canceled(this); };
184    int32_t get_JobType() { return m_JobType; };
185    int32_t get_JobLevel() { return m_JobLevel; };
186
187    const char *get_OperationName();    /* in lib/jcr.c */
188    const char *get_ActionName(bool past); /* in lib/jcr.c */
189    void set_JobLevel(int32_t JobLevel); /* in lib/jcr.c */
190    void set_JobType(int32_t JobType);  /* in lib/jcr.c */
191    bool JobReads();                    /* in lib/jcr.c */
192
193    /* Global part of JCR common to all daemons */
194    dlink link;                        /* JCR chain link */
195    pthread_t my_thread_id;            /* id of thread controlling jcr */
196    BSOCK *dir_bsock;                  /* Director bsock or NULL if we are him */
197    BSOCK *store_bsock;                /* Storage connection socket */
198    BSOCK *file_bsock;                 /* File daemon connection socket */
199    JCR_free_HANDLER *daemon_free_jcr; /* Local free routine */
200    dlist *msg_queue;                  /* Queued messages */
201    alist job_end_push;                /* Job end pushed calls */
202    bool dequeuing;                    /* dequeuing messages */
203    POOLMEM *VolumeName;               /* Volume name desired -- pool_memory */
204    POOLMEM *errmsg;                   /* edited error message */
205    char Job[MAX_NAME_LENGTH];         /* Unique name of this Job */
206    char event[MAX_NAME_LENGTH];       /* Current event (python) */
207    uint32_t eventType;                /* Current event type (plugin) */
208
209    uint32_t JobId;                    /* Director's JobId */
210    uint32_t VolSessionId;
211    uint32_t VolSessionTime;
212    uint32_t JobFiles;                 /* Number of files written, this job */
213    uint32_t JobErrors;                /* Number of non-fatal errors this job */
214    uint32_t JobWarnings;              /* Number of warning messages */
215    uint64_t JobBytes;                 /* Number of bytes processed this job */
216    uint64_t ReadBytes;                /* Bytes read -- before compression */
217    FileId_t FileId;                   /* Last FileId used */
218    volatile int32_t JobStatus;        /* ready, running, blocked, terminated */
219    int32_t JobPriority;               /* Job priority */
220    time_t sched_time;                 /* job schedule time, i.e. when it should start */
221    time_t start_time;                 /* when job actually started */
222    time_t run_time;                   /* used for computing speed */
223    time_t end_time;                   /* job end time */
224    time_t wait_time_sum;              /* cumulative wait time since job start */
225    time_t wait_time;                  /* timestamp when job have started to wait */
226    POOLMEM *client_name;              /* client name */
227    POOLMEM *RestoreBootstrap;         /* Bootstrap file to restore */
228    POOLMEM *stime;                    /* start time for incremental/differential */
229    char *sd_auth_key;                 /* SD auth key */
230    MSGS *jcr_msgs;                    /* Copy of message resource -- actually used */
231    uint32_t ClientId;                 /* Client associated with Job */
232    char *where;                       /* prefix to restore files to */
233    char *RegexWhere;                  /* file relocation in restore */
234    alist *where_bregexp;              /* BREGEXP alist for path manipulation */
235    int32_t cached_pnl;                /* cached path length */
236    POOLMEM *cached_path;              /* cached path */
237    bool prefix_links;                 /* Prefix links with Where path */
238    bool gui;                          /* set if gui using console */
239    bool authenticated;                /* set when client authenticated */
240    void *Python_job;                  /* Python Job Object */
241    void *Python_events;               /* Python Events Object */
242
243    bool cached_attribute;             /* set if attribute is cached */
244    POOLMEM *attr;                     /* Attribute string from SD */
245    B_DB *db;                          /* database pointer */
246    B_DB *db_batch;                    /* database pointer for batch and accurate */
247    bool batch_started;                /* is batch mode already started ? */
248    ATTR_DBR *ar;                      /* DB attribute record */
249    guid_list *id_list;                /* User/group id to name list */
250    bool accurate;                     /* true if job is accurate */
251
252    bpContext *plugin_ctx_list;        /* list of contexts for plugins */
253    bpContext *plugin_ctx;             /* current plugin context */
254    Plugin *plugin;                    /* plugin instance */
255    save_pkt *plugin_sp;               /* plugin save packet */
256    char *plugin_options;              /* user set options for plugin */
257    bool cmd_plugin;                   /* Set when processing a command Plugin = */
258
259    /* Daemon specific part of JCR */
260    /* This should be empty in the library */
261
262 #ifdef DIRECTOR_DAEMON
263    /* Director Daemon specific data part of JCR */
264    pthread_t SD_msg_chan;             /* Message channel thread id */
265    pthread_cond_t term_wait;          /* Wait for job termination */
266    workq_ele_t *work_item;            /* Work queue item if scheduled */
267    volatile bool sd_msg_thread_done;  /* Set when Storage message thread done */
268    BSOCK *ua;                         /* User agent */
269    JOB *job;                          /* Job resource */
270    JOB *verify_job;                   /* Job resource of verify previous job */
271    alist *rstorage;                   /* Read storage possibilities */
272    STORE *rstore;                     /* Selected read storage */
273    alist *wstorage;                   /* Write storage possibilities */
274    STORE *wstore;                     /* Selected write storage */
275    CLIENT *client;                    /* Client resource */
276    POOL *pool;                        /* Pool resource = write for migration */
277    POOL *rpool;                       /* Read pool. Used only in migration */
278    POOL *full_pool;                   /* Full backup pool resource */
279    POOL *inc_pool;                    /* Incremental backup pool resource */
280    POOL *diff_pool;                   /* Differential backup pool resource */
281    bool run_pool_override;
282    bool run_full_pool_override;
283    bool run_inc_pool_override;
284    bool run_diff_pool_override;
285    FILESET *fileset;                  /* FileSet resource */
286    CAT *catalog;                      /* Catalog resource */
287    MSGS *messages;                    /* Default message handler */
288    uint32_t SDJobFiles;               /* Number of files written, this job */
289    uint64_t SDJobBytes;               /* Number of bytes processed this job */
290    uint32_t SDErrors;                 /* Number of non-fatal errors */
291    volatile int32_t SDJobStatus;      /* Storage Job Status */
292    volatile int32_t FDJobStatus;      /* File daemon Job Status */
293    uint32_t ExpectedFiles;            /* Expected restore files */
294    uint32_t MediaId;                  /* DB record IDs associated with this job */
295    uint32_t FileIndex;                /* Last FileIndex processed */
296    POOLMEM *fname;                    /* name to put into catalog */
297    JOB_DBR jr;                        /* Job DB record for current job */
298    JOB_DBR previous_jr;               /* previous job database record */
299    JOB *previous_job;                 /* Job resource of migration previous job */
300    JCR *mig_jcr;                      /* JCR for migration/copy job */
301    char FSCreateTime[MAX_TIME_LENGTH]; /* FileSet CreateTime as returned from DB */
302    char since[MAX_TIME_LENGTH];       /* since time */
303    union {
304       JobId_t RestoreJobId;           /* Id specified by UA */
305       JobId_t MigrateJobId;
306    };
307    POOLMEM *client_uname;             /* client uname */
308    POOLMEM *pool_source;              /* Where pool came from */
309    POOLMEM *rpool_source;             /* Where migrate read pool came from */
310    POOLMEM *rstore_source;            /* Where read storage came from */
311    POOLMEM *wstore_source;            /* Where write storage came from */
312    POOLMEM *catalog_source;           /* Where catalog came from */
313    uint32_t replace;                  /* Replace option */
314    int32_t NumVols;                   /* Number of Volume used in pool */
315    int32_t reschedule_count;          /* Number of times rescheduled */
316    int32_t FDVersion;                 /* File daemon version number */
317    int64_t spool_size;                /* Spool size for this job */
318    bool spool_data;                   /* Spool data in SD */
319    bool acquired_resource_locks;      /* set if resource locks acquired */
320    bool term_wait_inited;             /* Set when cond var inited */
321    bool fn_printed;                   /* printed filename */
322    bool write_part_after_job;         /* Write part after job in SD */
323    bool needs_sd;                     /* set if SD needed by Job */
324    bool cloned;                       /* set if cloned */
325    bool unlink_bsr;                   /* Unlink bsr file created */
326    bool VSS;                          /* VSS used by FD */
327    bool Encrypt;                      /* Encryption used by FD */
328    bool stats_enabled;                /* Keep all job records in a table for long term statistics */
329    bool no_maxtime;                   /* Don't check Max*Time for this JCR */
330 #endif /* DIRECTOR_DAEMON */
331
332
333 #ifdef FILE_DAEMON
334    /* File Daemon specific part of JCR */
335    uint32_t num_files_examined;       /* files examined this job */
336    POOLMEM *last_fname;               /* last file saved/verified */
337    POOLMEM *acl_data;                 /* data with ACLs for backup/restore */
338    uint32_t acl_data_len;             /* length of acl data buffer */
339    POOLMEM *xattr_data;               /* data with Extended Attributes for backup/restore */
340    uint32_t xattr_data_len;           /* length of xattr_data buffer */
341    int32_t last_type;                 /* type of last file saved/verified */
342    int incremental;                   /* set if incremental for SINCE */
343    utime_t mtime;                     /* begin time for SINCE */
344    int listing;                       /* job listing in estimate */
345    long Ticket;                       /* Ticket */
346    char *big_buf;                     /* I/O buffer */
347    POOLMEM *compress_buf;             /* Compression buffer */
348    int32_t compress_buf_size;         /* Length of compression buffer */
349    void *pZLIB_compress_workset;      /* zlib compression session data */
350    int32_t replace;                   /* Replace options */
351    int32_t buf_size;                  /* length of buffer */
352    FF_PKT *ff;                        /* Find Files packet */
353    char stored_addr[MAX_NAME_LENGTH]; /* storage daemon address */
354    uint32_t StartFile;
355    uint32_t EndFile;
356    uint32_t StartBlock;
357    uint32_t EndBlock;
358    pthread_t heartbeat_id;            /* id of heartbeat thread */
359    volatile bool hb_started;          /* heartbeat running */
360    BSOCK *hb_bsock;                   /* duped SD socket */
361    BSOCK *hb_dir_bsock;               /* duped DIR socket */
362    alist *RunScripts;                 /* Commands to run before and after job */
363    CRYPTO_CTX crypto;                 /* Crypto ctx */
364    DIRRES* director;                  /* Director resource */
365    bool VSS;                          /* VSS used by FD */
366    htable *file_list;                 /* Previous file list (accurate mode) */
367 #endif /* FILE_DAEMON */
368
369
370 #ifdef STORAGE_DAEMON
371    /* Storage Daemon specific part of JCR */
372    JCR *next_dev;                     /* next JCR attached to device */
373    JCR *prev_dev;                     /* previous JCR attached to device */
374    char *dir_auth_key;                /* Dir auth key */
375    pthread_cond_t job_start_wait;     /* Wait for FD to start Job */
376    int32_t type;
377    DCR *read_dcr;                     /* device context for reading */
378    DCR *dcr;                          /* device context record */
379    alist *dcrs;                       /* list of dcrs open */
380    POOLMEM *job_name;                 /* base Job name (not unique) */
381    POOLMEM *fileset_name;             /* FileSet */
382    POOLMEM *fileset_md5;              /* MD5 for FileSet */
383    VOL_LIST *VolList;                 /* list to read */
384    int32_t NumWriteVolumes;           /* number of volumes written */
385    int32_t NumReadVolumes;            /* total number of volumes to read */
386    int32_t CurReadVolume;             /* current read volume number */
387    int32_t label_errors;              /* count of label errors */
388    bool session_opened;
389    long Ticket;                       /* ticket for this job */
390    bool ignore_label_errors;          /* ignore Volume label errors */
391    bool spool_attributes;             /* set if spooling attributes */
392    bool no_attributes;                /* set if no attributes wanted */
393    int64_t spool_size;                /* Spool size for this job */
394    bool spool_data;                   /* set to spool data */
395    int32_t CurVol;                    /* Current Volume count */
396    DIRRES* director;                  /* Director resource */
397    alist *write_store;                /* list of write storage devices sent by DIR */ 
398    alist *read_store;                 /* list of read devices sent by DIR */
399    alist *reserve_msgs;               /* reserve fail messages */
400    bool write_part_after_job;         /* Set to write part after job */
401    bool PreferMountedVols;            /* Prefer mounted vols rather than new */
402    bool need_fd;                      /* set if we need FD connection */
403
404    /* Parmaters for Open Read Session */
405    BSR *bsr;                          /* Bootstrap record -- has everything */
406    bool mount_next_volume;            /* set to cause next volume mount */
407    uint32_t read_VolSessionId;
408    uint32_t read_VolSessionTime;
409    uint32_t read_StartFile;
410    uint32_t read_EndFile;
411    uint32_t read_StartBlock;
412    uint32_t read_EndBlock;
413    /* Device wait times */
414    int32_t min_wait;
415    int32_t max_wait;
416    int32_t max_num_wait;
417    int32_t wait_sec;
418    int32_t rem_wait_sec;
419    int32_t num_wait;
420 #endif /* STORAGE_DAEMON */
421
422 };
423
424 /*
425  * Setting a NULL in tsd doesn't clear the tsd but instead tells
426  *   pthreads not to call the tsd destructor. Consequently, we 
427  *   define this *invalid* jcr address and stuff it in the tsd
428  *   when the jcr is not valid.
429  */
430 #define INVALID_JCR ((JCR *)(-1))
431
432
433 /*
434  * Structure for all daemons that keeps some summary
435  *  info on the last job run.
436  */
437 struct s_last_job {
438    dlink link;
439    int32_t Errors;                    /* FD/SD errors */
440    int32_t JobType;
441    int32_t JobStatus;
442    int32_t JobLevel;
443    uint32_t JobId;
444    uint32_t VolSessionId;
445    uint32_t VolSessionTime;
446    uint32_t JobFiles;
447    uint64_t JobBytes;
448    utime_t start_time;
449    utime_t end_time;
450    char Job[MAX_NAME_LENGTH];
451 };
452
453 extern struct s_last_job last_job;
454 extern DLL_IMP_EXP dlist * last_jobs;
455
456
457 /* The following routines are found in lib/jcr.c */
458 extern bool init_jcr_subsystem(void);
459 extern JCR *new_jcr(int size, JCR_free_HANDLER *daemon_free_jcr);
460 extern JCR *get_jcr_by_id(uint32_t JobId);
461 extern JCR *get_jcr_by_session(uint32_t SessionId, uint32_t SessionTime);
462 extern JCR *get_jcr_by_partial_name(char *Job);
463 extern JCR *get_jcr_by_full_name(char *Job);
464 extern JCR *get_next_jcr(JCR *jcr);
465 extern void set_jcr_job_status(JCR *jcr, int JobStatus);
466 extern int DLL_IMP_EXP num_jobs_run;
467
468 #ifdef DEBUG
469 extern void b_free_jcr(const char *file, int line, JCR *jcr);
470 #define free_jcr(jcr) b_free_jcr(__FILE__, __LINE__, (jcr))
471 #else
472 extern void free_jcr(JCR *jcr);
473 #endif
474
475 /* Used to display specific job information after a fatal signal */
476 typedef void (dbg_jcr_hook_t)(JCR *jcr, FILE *fp);
477 extern void dbg_jcr_add_hook(dbg_jcr_hook_t *fct);
478
479 #endif /* __JCR_H_ */