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