git.sur5r.net Git - bacula/bacula/blob - bacula/src/jcr.h

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