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