]> git.sur5r.net Git - bacula/bacula/blob - bacula/src/jcr.h
Modify setJobStatus so cancel has same priority as fatal errors
[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 getJobType() { return m_JobType; };
186    int32_t get_JobLevel() { return m_JobLevel; };
187    int32_t getJobLevel() { return m_JobLevel; };
188    bool no_client_used() {
189       return (m_JobType == JT_MIGRATE || m_JobType == JT_COPY ||
190               m_JobLevel == L_VIRTUAL_FULL);
191    };
192    const char *get_OperationName();       /* in lib/jcr.c */
193    const char *get_ActionName(bool past); /* in lib/jcr.c */
194    void set_JobLevel(int32_t JobLevel);   /* in lib/jcr.c */
195    void setJobLevel(int32_t JobLevel);    /* in lib/jcr.c */
196    void set_JobType(int32_t JobType);     /* in lib/jcr.c */
197    void setJobType(int32_t JobType);      /* in lib/jcr.c */
198    void setJobStatus(int JobStatus);      /* in lib/jcr.c */
199    bool JobReads();                       /* in lib/jcr.c */
200    
201
202    /* Global part of JCR common to all daemons */
203    dlink link;                        /* JCR chain link */
204    pthread_t my_thread_id;            /* id of thread controlling jcr */
205    BSOCK *dir_bsock;                  /* Director bsock or NULL if we are him */
206    BSOCK *store_bsock;                /* Storage connection socket */
207    BSOCK *file_bsock;                 /* File daemon connection socket */
208    JCR_free_HANDLER *daemon_free_jcr; /* Local free routine */
209    dlist *msg_queue;                  /* Queued messages */
210    alist job_end_push;                /* Job end pushed calls */
211    bool dequeuing;                    /* dequeuing messages */
212    POOLMEM *VolumeName;               /* Volume name desired -- pool_memory */
213    POOLMEM *errmsg;                   /* edited error message */
214    char Job[MAX_NAME_LENGTH];         /* Unique name of this Job */
215    char event[MAX_NAME_LENGTH];       /* Current event (python) */
216    uint32_t eventType;                /* Current event type (plugin) */
217
218    uint32_t JobId;                    /* Director's JobId */
219    uint32_t VolSessionId;
220    uint32_t VolSessionTime;
221    uint32_t JobFiles;                 /* Number of files written, this job */
222    uint32_t JobErrors;                /* Number of non-fatal errors this job */
223    uint32_t JobWarnings;              /* Number of warning messages */
224    uint64_t JobBytes;                 /* Number of bytes processed this job */
225    uint64_t ReadBytes;                /* Bytes read -- before compression */
226    FileId_t FileId;                   /* Last FileId used */
227    volatile int32_t JobStatus;        /* ready, running, blocked, terminated */
228    int32_t JobPriority;               /* Job priority */
229    time_t sched_time;                 /* job schedule time, i.e. when it should start */
230    time_t start_time;                 /* when job actually started */
231    time_t run_time;                   /* used for computing speed */
232    time_t end_time;                   /* job end time */
233    time_t wait_time_sum;              /* cumulative wait time since job start */
234    time_t wait_time;                  /* timestamp when job have started to wait */
235    POOLMEM *client_name;              /* client name */
236    POOLMEM *RestoreBootstrap;         /* Bootstrap file to restore */
237    POOLMEM *stime;                    /* start time for incremental/differential */
238    char *sd_auth_key;                 /* SD auth key */
239    MSGS *jcr_msgs;                    /* Copy of message resource -- actually used */
240    uint32_t ClientId;                 /* Client associated with Job */
241    char *where;                       /* prefix to restore files to */
242    char *RegexWhere;                  /* file relocation in restore */
243    alist *where_bregexp;              /* BREGEXP alist for path manipulation */
244    int32_t cached_pnl;                /* cached path length */
245    POOLMEM *cached_path;              /* cached path */
246    bool prefix_links;                 /* Prefix links with Where path */
247    bool gui;                          /* set if gui using console */
248    bool authenticated;                /* set when client authenticated */
249    void *Python_job;                  /* Python Job Object */
250    void *Python_events;               /* Python Events Object */
251
252    bool cached_attribute;             /* set if attribute is cached */
253    POOLMEM *attr;                     /* Attribute string from SD */
254    B_DB *db;                          /* database pointer */
255    B_DB *db_batch;                    /* database pointer for batch and accurate */
256    bool batch_started;                /* is batch mode already started ? */
257    ATTR_DBR *ar;                      /* DB attribute record */
258    guid_list *id_list;                /* User/group id to name list */
259    bool accurate;                     /* true if job is accurate */
260
261    bpContext *plugin_ctx_list;        /* list of contexts for plugins */
262    bpContext *plugin_ctx;             /* current plugin context */
263    Plugin *plugin;                    /* plugin instance */
264    save_pkt *plugin_sp;               /* plugin save packet */
265    char *plugin_options;              /* user set options for plugin */
266    bool cmd_plugin;                   /* Set when processing a command Plugin = */
267
268    /* Daemon specific part of JCR */
269    /* This should be empty in the library */
270
271 #ifdef DIRECTOR_DAEMON
272    /* Director Daemon specific data part of JCR */
273    pthread_t SD_msg_chan;             /* Message channel thread id */
274    pthread_cond_t term_wait;          /* Wait for job termination */
275    workq_ele_t *work_item;            /* Work queue item if scheduled */
276    volatile bool sd_msg_thread_done;  /* Set when Storage message thread done */
277    BSOCK *ua;                         /* User agent */
278    JOB *job;                          /* Job resource */
279    JOB *verify_job;                   /* Job resource of verify previous job */
280    alist *rstorage;                   /* Read storage possibilities */
281    STORE *rstore;                     /* Selected read storage */
282    alist *wstorage;                   /* Write storage possibilities */
283    STORE *wstore;                     /* Selected write storage */
284    CLIENT *client;                    /* Client resource */
285    POOL *pool;                        /* Pool resource = write for migration */
286    POOL *rpool;                       /* Read pool. Used only in migration */
287    POOL *full_pool;                   /* Full backup pool resource */
288    POOL *inc_pool;                    /* Incremental backup pool resource */
289    POOL *diff_pool;                   /* Differential backup pool resource */
290    bool run_pool_override;
291    bool run_full_pool_override;
292    bool run_inc_pool_override;
293    bool run_diff_pool_override;
294    FILESET *fileset;                  /* FileSet resource */
295    CAT *catalog;                      /* Catalog resource */
296    MSGS *messages;                    /* Default message handler */
297    uint32_t SDJobFiles;               /* Number of files written, this job */
298    uint64_t SDJobBytes;               /* Number of bytes processed this job */
299    uint32_t SDErrors;                 /* Number of non-fatal errors */
300    volatile int32_t SDJobStatus;      /* Storage Job Status */
301    volatile int32_t FDJobStatus;      /* File daemon Job Status */
302    uint32_t ExpectedFiles;            /* Expected restore files */
303    uint32_t MediaId;                  /* DB record IDs associated with this job */
304    uint32_t FileIndex;                /* Last FileIndex processed */
305    POOLMEM *fname;                    /* name to put into catalog */
306    JOB_DBR jr;                        /* Job DB record for current job */
307    JOB_DBR previous_jr;               /* previous job database record */
308    JOB *previous_job;                 /* Job resource of migration previous job */
309    JCR *mig_jcr;                      /* JCR for migration/copy job */
310    char FSCreateTime[MAX_TIME_LENGTH]; /* FileSet CreateTime as returned from DB */
311    char since[MAX_TIME_LENGTH];       /* since time */
312    union {
313       JobId_t RestoreJobId;           /* Id specified by UA */
314       JobId_t MigrateJobId;
315    };
316    POOLMEM *client_uname;             /* client uname */
317    POOLMEM *pool_source;              /* Where pool came from */
318    POOLMEM *rpool_source;             /* Where migrate read pool came from */
319    POOLMEM *rstore_source;            /* Where read storage came from */
320    POOLMEM *wstore_source;            /* Where write storage came from */
321    POOLMEM *catalog_source;           /* Where catalog came from */
322    uint32_t replace;                  /* Replace option */
323    int32_t NumVols;                   /* Number of Volume used in pool */
324    int32_t reschedule_count;          /* Number of times rescheduled */
325    int32_t FDVersion;                 /* File daemon version number */
326    int64_t spool_size;                /* Spool size for this job */
327    bool spool_data;                   /* Spool data in SD */
328    bool acquired_resource_locks;      /* set if resource locks acquired */
329    bool term_wait_inited;             /* Set when cond var inited */
330    bool fn_printed;                   /* printed filename */
331    bool write_part_after_job;         /* Write part after job in SD */
332    bool needs_sd;                     /* set if SD needed by Job */
333    bool cloned;                       /* set if cloned */
334    bool unlink_bsr;                   /* Unlink bsr file created */
335    bool VSS;                          /* VSS used by FD */
336    bool Encrypt;                      /* Encryption used by FD */
337    bool stats_enabled;                /* Keep all job records in a table for long term statistics */
338    bool no_maxtime;                   /* Don't check Max*Time for this JCR */
339 #endif /* DIRECTOR_DAEMON */
340
341
342 #ifdef FILE_DAEMON
343    /* File Daemon specific part of JCR */
344    uint32_t num_files_examined;       /* files examined this job */
345    POOLMEM *last_fname;               /* last file saved/verified */
346    POOLMEM *acl_data;                 /* data with ACLs for backup/restore */
347    uint32_t acl_data_len;             /* length of acl data buffer */
348    POOLMEM *xattr_data;               /* data with Extended Attributes for backup/restore */
349    uint32_t xattr_data_len;           /* length of xattr_data buffer */
350    int32_t last_type;                 /* type of last file saved/verified */
351    int incremental;                   /* set if incremental for SINCE */
352    utime_t mtime;                     /* begin time for SINCE */
353    int listing;                       /* job listing in estimate */
354    long Ticket;                       /* Ticket */
355    char *big_buf;                     /* I/O buffer */
356    POOLMEM *compress_buf;             /* Compression buffer */
357    int32_t compress_buf_size;         /* Length of compression buffer */
358    void *pZLIB_compress_workset;      /* zlib compression session data */
359    int32_t replace;                   /* Replace options */
360    int32_t buf_size;                  /* length of buffer */
361    FF_PKT *ff;                        /* Find Files packet */
362    char stored_addr[MAX_NAME_LENGTH]; /* storage daemon address */
363    uint32_t StartFile;
364    uint32_t EndFile;
365    uint32_t StartBlock;
366    uint32_t EndBlock;
367    pthread_t heartbeat_id;            /* id of heartbeat thread */
368    volatile bool hb_started;          /* heartbeat running */
369    BSOCK *hb_bsock;                   /* duped SD socket */
370    BSOCK *hb_dir_bsock;               /* duped DIR socket */
371    alist *RunScripts;                 /* Commands to run before and after job */
372    CRYPTO_CTX crypto;                 /* Crypto ctx */
373    DIRRES* director;                  /* Director resource */
374    bool VSS;                          /* VSS used by FD */
375    htable *file_list;                 /* Previous file list (accurate mode) */
376 #endif /* FILE_DAEMON */
377
378
379 #ifdef STORAGE_DAEMON
380    /* Storage Daemon specific part of JCR */
381    JCR *next_dev;                     /* next JCR attached to device */
382    JCR *prev_dev;                     /* previous JCR attached to device */
383    char *dir_auth_key;                /* Dir auth key */
384    pthread_cond_t job_start_wait;     /* Wait for FD to start Job */
385    int32_t type;
386    DCR *read_dcr;                     /* device context for reading */
387    DCR *dcr;                          /* device context record */
388    alist *dcrs;                       /* list of dcrs open */
389    POOLMEM *job_name;                 /* base Job name (not unique) */
390    POOLMEM *fileset_name;             /* FileSet */
391    POOLMEM *fileset_md5;              /* MD5 for FileSet */
392    VOL_LIST *VolList;                 /* list to read */
393    int32_t NumWriteVolumes;           /* number of volumes written */
394    int32_t NumReadVolumes;            /* total number of volumes to read */
395    int32_t CurReadVolume;             /* current read volume number */
396    int32_t label_errors;              /* count of label errors */
397    bool session_opened;
398    long Ticket;                       /* ticket for this job */
399    bool ignore_label_errors;          /* ignore Volume label errors */
400    bool spool_attributes;             /* set if spooling attributes */
401    bool no_attributes;                /* set if no attributes wanted */
402    int64_t spool_size;                /* Spool size for this job */
403    bool spool_data;                   /* set to spool data */
404    int32_t CurVol;                    /* Current Volume count */
405    DIRRES* director;                  /* Director resource */
406    alist *write_store;                /* list of write storage devices sent by DIR */ 
407    alist *read_store;                 /* list of read devices sent by DIR */
408    alist *reserve_msgs;               /* reserve fail messages */
409    bool write_part_after_job;         /* Set to write part after job */
410    bool PreferMountedVols;            /* Prefer mounted vols rather than new */
411
412    /* Parmaters for Open Read Session */
413    BSR *bsr;                          /* Bootstrap record -- has everything */
414    bool mount_next_volume;            /* set to cause next volume mount */
415    uint32_t read_VolSessionId;
416    uint32_t read_VolSessionTime;
417    uint32_t read_StartFile;
418    uint32_t read_EndFile;
419    uint32_t read_StartBlock;
420    uint32_t read_EndBlock;
421    /* Device wait times */
422    int32_t min_wait;
423    int32_t max_wait;
424    int32_t max_num_wait;
425    int32_t wait_sec;
426    int32_t rem_wait_sec;
427    int32_t num_wait;
428 #endif /* STORAGE_DAEMON */
429
430 };
431
432 /*
433  * Setting a NULL in tsd doesn't clear the tsd but instead tells
434  *   pthreads not to call the tsd destructor. Consequently, we 
435  *   define this *invalid* jcr address and stuff it in the tsd
436  *   when the jcr is not valid.
437  */
438 #define INVALID_JCR ((JCR *)(-1))
439
440
441 /*
442  * Structure for all daemons that keeps some summary
443  *  info on the last job run.
444  */
445 struct s_last_job {
446    dlink link;
447    int32_t Errors;                    /* FD/SD errors */
448    int32_t JobType;
449    int32_t JobStatus;
450    int32_t JobLevel;
451    uint32_t JobId;
452    uint32_t VolSessionId;
453    uint32_t VolSessionTime;
454    uint32_t JobFiles;
455    uint64_t JobBytes;
456    utime_t start_time;
457    utime_t end_time;
458    char Job[MAX_NAME_LENGTH];
459 };
460
461 extern struct s_last_job last_job;
462 extern DLL_IMP_EXP dlist * last_jobs;
463
464
465 /* The following routines are found in lib/jcr.c */
466 extern bool init_jcr_subsystem(void);
467 extern JCR *new_jcr(int size, JCR_free_HANDLER *daemon_free_jcr);
468 extern JCR *get_jcr_by_id(uint32_t JobId);
469 extern JCR *get_jcr_by_session(uint32_t SessionId, uint32_t SessionTime);
470 extern JCR *get_jcr_by_partial_name(char *Job);
471 extern JCR *get_jcr_by_full_name(char *Job);
472 extern JCR *get_next_jcr(JCR *jcr);
473 extern void set_jcr_job_status(JCR *jcr, int JobStatus);
474 extern int DLL_IMP_EXP num_jobs_run;
475
476 #ifdef DEBUG
477 extern void b_free_jcr(const char *file, int line, JCR *jcr);
478 #define free_jcr(jcr) b_free_jcr(__FILE__, __LINE__, (jcr))
479 #else
480 extern void free_jcr(JCR *jcr);
481 #endif
482
483 /* Used to display specific job information after a fatal signal */
484 typedef void (dbg_jcr_hook_t)(JCR *jcr, FILE *fp);
485 extern void dbg_jcr_add_hook(dbg_jcr_hook_t *fct);
486
487 #endif /* __JCR_H_ */