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

   1 /*
   2  * Bacula JCR Structure definition for Daemons and the Library
   3  *  This definition consists of a "Global" definition common
   4  *  to all daemons and used by the library routines, and a
   5  *  daemon specific part that is enabled with #defines.
   6  *
   7  * Kern Sibbald, Nov MM
   8  *
   9  *   Version $Id$
  10  */
  11 /*
  12    Copyright (C) 2000-2006 Kern Sibbald
  13
  14    This program is free software; you can redistribute it and/or
  15    modify it under the terms of the GNU General Public License
  16    version 2 as amended with additional clauses defined in the
  17    file LICENSE in the main source directory.
  18
  19    This program is distributed in the hope that it will be useful,
  20    but WITHOUT ANY WARRANTY; without even the implied warranty of
  21    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  22    the file LICENSE for additional details.
  23
  24  */
  25
  26
  27 #ifndef __JCR_H_
  28 #define __JCR_H_ 1
  29
  30 /* Backup/Verify level code. These are stored in the DB */
  31 #define L_FULL                   'F'  /* Full backup */
  32 #define L_INCREMENTAL            'I'  /* since last backup */
  33 #define L_DIFFERENTIAL           'D'  /* since last full backup */
  34 #define L_SINCE                  'S'
  35 #define L_VERIFY_CATALOG         'C'  /* verify from catalog */
  36 #define L_VERIFY_INIT            'V'  /* verify save (init DB) */
  37 #define L_VERIFY_VOLUME_TO_CATALOG 'O'  /* verify Volume to catalog entries */
  38 #define L_VERIFY_DISK_TO_CATALOG 'd'  /* verify Disk attributes to catalog */
  39 #define L_VERIFY_DATA            'A'  /* verify data on volume */
  40 #define L_BASE                   'B'  /* Base level job */
  41 #define L_NONE                   ' '  /* None, for Restore and Admin */
  42
  43
  44 /* Job Types. These are stored in the DB */
  45 #define JT_BACKUP                'B'  /* Backup Job */
  46 #define JT_VERIFY                'V'  /* Verify Job */
  47 #define JT_RESTORE               'R'  /* Restore Job */
  48 #define JT_CONSOLE               'c'  /* console program */
  49 #define JT_SYSTEM                'I'  /* internal system "job" */
  50 #define JT_ADMIN                 'D'  /* admin job */
  51 #define JT_ARCHIVE               'A'  /* Archive Job */
  52 #define JT_COPY                  'C'  /* Copy Job */
  53 #define JT_MIGRATE               'M'  /* Migration Job */
  54 #define JT_SCAN                  'S'  /* Scan Job */
  55
  56 /* Job Status. Some of these are stored in the DB */
  57 #define JS_Created               'C'  /* created but not yet running */
  58 #define JS_Running               'R'  /* running */
  59 #define JS_Blocked               'B'  /* blocked */
  60 #define JS_Terminated            'T'  /* terminated normally */
  61 #define JS_ErrorTerminated       'E'  /* Job terminated in error */
  62 #define JS_Error                 'e'  /* Non-fatal error */
  63 #define JS_FatalError            'f'  /* Fatal error */
  64 #define JS_Differences           'D'  /* Verify differences */
  65 #define JS_Canceled              'A'  /* canceled by user */
  66 #define JS_WaitFD                'F'  /* waiting on File daemon */
  67 #define JS_WaitSD                'S'  /* waiting on the Storage daemon */
  68 #define JS_WaitMedia             'm'  /* waiting for new media */
  69 #define JS_WaitMount             'M'  /* waiting for Mount */
  70 #define JS_WaitStoreRes          's'  /* Waiting for storage resource */
  71 #define JS_WaitJobRes            'j'  /* Waiting for job resource */
  72 #define JS_WaitClientRes         'c'  /* Waiting for Client resource */
  73 #define JS_WaitMaxJobs           'd'  /* Waiting for maximum jobs */
  74 #define JS_WaitStartTime         't'  /* Waiting for start time */
  75 #define JS_WaitPriority          'p'  /* Waiting for higher priority jobs to finish */
  76
  77 #define job_canceled(jcr) \
  78   (jcr->JobStatus == JS_Canceled || \
  79    jcr->JobStatus == JS_ErrorTerminated || \
  80    jcr->JobStatus == JS_FatalError)
  81
  82 #define foreach_jcr(jcr) \
  83    for (jcr=jcr_walk_start(); jcr; (jcr=jcr_walk_next(jcr)) )
  84
  85 #define endeach_jcr(jcr) jcr_walk_end(jcr)
  86
  87 #define SD_APPEND 1
  88 #define SD_READ   0
  89
  90 /* Forward referenced structures */
  91 class JCR;
  92 struct FF_PKT;
  93 struct B_DB;
  94 struct ATTR_DBR;
  95
  96 typedef void (JCR_free_HANDLER)(JCR *jcr);
  97
  98 /* Job Control Record (JCR) */
  99 class JCR {
 100 public:
 101    void inc_use_count(void) {P(mutex); use_count++; V(mutex); };
 102    void dec_use_count(void) {P(mutex); use_count--; V(mutex); };
 103
 104    /* Global part of JCR common to all daemons */
 105    dlink link;                        /* JCR chain link */
 106    volatile int use_count;            /* use count */
 107    pthread_t my_thread_id;            /* id of thread controlling jcr */
 108    pthread_mutex_t mutex;             /* jcr mutex */
 109    BSOCK *dir_bsock;                  /* Director bsock or NULL if we are him */
 110    BSOCK *store_bsock;                /* Storage connection socket */
 111    BSOCK *file_bsock;                 /* File daemon connection socket */
 112    JCR_free_HANDLER *daemon_free_jcr; /* Local free routine */
 113    dlist *msg_queue;                  /* Queued messages */
 114    alist job_end_push;                /* Job end pushed calls */
 115    bool dequeuing;                    /* dequeuing messages */
 116    POOLMEM *VolumeName;               /* Volume name desired -- pool_memory */
 117    POOLMEM *errmsg;                   /* edited error message */
 118    char Job[MAX_NAME_LENGTH];         /* Unique name of this Job */
 119    char event[MAX_NAME_LENGTH];       /* Current event */
 120    uint32_t JobId;                    /* Director's JobId */
 121    uint32_t VolSessionId;
 122    uint32_t VolSessionTime;
 123    uint32_t JobFiles;                 /* Number of files written, this job */
 124    uint32_t JobErrors;                /* */
 125    uint64_t JobBytes;                 /* Number of bytes processed this job */
 126    uint64_t ReadBytes;                /* Bytes read -- before compression */
 127    uint32_t Errors;                   /* Number of non-fatal errors */
 128    volatile int JobStatus;            /* ready, running, blocked, terminated */
 129    int JobType;                       /* backup, restore, verify ... */
 130    int JobLevel;                      /* Job level */
 131    int JobPriority;                   /* Job priority */
 132    time_t sched_time;                 /* job schedule time, i.e. when it should start */
 133    time_t start_time;                 /* when job actually started */
 134    time_t run_time;                   /* used for computing speed */
 135    time_t end_time;                   /* job end time */
 136    POOLMEM *client_name;              /* client name */
 137    POOLMEM *RestoreBootstrap;         /* Bootstrap file to restore */
 138    POOLMEM *stime;                    /* start time for incremental/differential */
 139    char *sd_auth_key;                 /* SD auth key */
 140    MSGS *jcr_msgs;                    /* Copy of message resource -- actually used */
 141    uint32_t ClientId;                 /* Client associated with Job */
 142    char *where;                       /* prefix to restore files to */
 143    int cached_pnl;                    /* cached path length */
 144    POOLMEM *cached_path;              /* cached path */
 145    bool prefix_links;                 /* Prefix links with Where path */
 146    bool gui;                          /* set if gui using console */
 147    bool authenticated;                /* set when client authenticated */
 148    void *Python_job;                  /* Python Job Object */
 149    void *Python_events;               /* Python Events Object */
 150
 151    bool cached_attribute;             /* set if attribute is cached */
 152    POOLMEM *attr;                     /* Attribute string from SD */
 153    B_DB *db;                          /* database pointer */
 154    ATTR_DBR *ar;                      /* DB attribute record */
 155
 156    /* Daemon specific part of JCR */
 157    /* This should be empty in the library */
 158
 159 #ifdef DIRECTOR_DAEMON
 160    /* Director Daemon specific part of JCR */
 161    pthread_t SD_msg_chan;             /* Message channel thread id */
 162    pthread_cond_t term_wait;          /* Wait for job termination */
 163    workq_ele_t *work_item;            /* Work queue item if scheduled */
 164    volatile bool sd_msg_thread_done;  /* Set when Storage message thread terms */
 165    BSOCK *ua;                         /* User agent */
 166    JOB *job;                          /* Job resource */
 167    JOB *verify_job;                   /* Job resource of verify target job */
 168    JOB *migration_job;                /* Job resource of migration target job */
 169    alist *storage;                    /* Storage possibilities */
 170    STORE *store;                      /* Storage daemon selected */
 171    CLIENT *client;                    /* Client resource */
 172    POOL *pool;                        /* Pool resource */
 173    POOL *full_pool;                   /* Full backup pool resource */
 174    POOL *inc_pool;                    /* Incremental backup pool resource */
 175    POOL *dif_pool;                    /* Differential backup pool resource */
 176    FILESET *fileset;                  /* FileSet resource */
 177    CAT *catalog;                      /* Catalog resource */
 178    MSGS *messages;                    /* Default message handler */
 179    uint32_t SDJobFiles;               /* Number of files written, this job */
 180    uint64_t SDJobBytes;               /* Number of bytes processed this job */
 181    uint32_t SDErrors;                 /* Number of non-fatal errors */
 182    volatile int SDJobStatus;          /* Storage Job Status */
 183    volatile int FDJobStatus;          /* File daemon Job Status */
 184    uint32_t ExpectedFiles;            /* Expected restore files */
 185    uint32_t MediaId;                  /* DB record IDs associated with this job */
 186    uint32_t PoolId;                   /* Pool record id */
 187    FileId_t FileId;                   /* Last file id inserted */
 188    uint32_t FileIndex;                /* Last FileIndex processed */
 189    POOLMEM *fname;                    /* name to put into catalog */
 190    JOB_DBR jr;                        /* Job DB record for current job */
 191    JOB_DBR target_jr;                 /* target job */
 192    char FSCreateTime[MAX_TIME_LENGTH]; /* FileSet CreateTime as returned from DB */
 193    char since[MAX_TIME_LENGTH];       /* since time */
 194    uint32_t RestoreJobId;             /* Id specified by UA */
 195    POOLMEM *client_uname;             /* client uname */
 196    int replace;                       /* Replace option */
 197    int NumVols;                       /* Number of Volume used in pool */
 198    int reschedule_count;              /* Number of times rescheduled */
 199    bool spool_data;                   /* Spool data in SD */
 200    bool acquired_resource_locks;      /* set if resource locks acquired */
 201    bool term_wait_inited;             /* Set when cond var inited */
 202    bool fn_printed;                   /* printed filename */
 203    bool write_part_after_job;         /* Write part after job in SD */
 204    bool needs_sd;                     /* set if SD needed by Job */
 205    bool cloned;                       /* set if cloned */
 206    bool unlink_bsr;                   /* Unlink bsr file created */
 207 #endif /* DIRECTOR_DAEMON */
 208
 209
 210 #ifdef FILE_DAEMON
 211    /* File Daemon specific part of JCR */
 212    uint32_t num_files_examined;       /* files examined this job */
 213    POOLMEM *last_fname;               /* last file saved/verified */
 214    POOLMEM *acl_text;                 /* text of ACL for backup */
 215    /*********FIXME********* add missing files and files to be retried */
 216    int incremental;                   /* set if incremental for SINCE */
 217    time_t mtime;                      /* begin time for SINCE */
 218    int listing;                       /* job listing in estimate */
 219    long Ticket;                       /* Ticket */
 220    char *big_buf;                     /* I/O buffer */
 221    POOLMEM *compress_buf;             /* Compression buffer */
 222    int32_t compress_buf_size;         /* Length of compression buffer */
 223    int replace;                       /* Replace options */
 224    int buf_size;                      /* length of buffer */
 225    FF_PKT *ff;                        /* Find Files packet */
 226    char stored_addr[MAX_NAME_LENGTH]; /* storage daemon address */
 227    uint32_t StartFile;
 228    uint32_t EndFile;
 229    uint32_t StartBlock;
 230    uint32_t EndBlock;
 231    pthread_t heartbeat_id;            /* id of heartbeat thread */
 232    volatile BSOCK *hb_bsock;          /* duped SD socket */
 233    volatile BSOCK *hb_dir_bsock;      /* duped DIR socket */
 234    POOLMEM *RunAfterJob;              /* Command to run after job */
 235    bool pki_sign;                     /* Enable PKI Signatures? */
 236    bool pki_encrypt;                  /* Enable PKI Encryption? */
 237    DIGEST *digest;                    /* Last file's digest context */
 238    X509_KEYPAIR *pki_keypair;         /* Encryption key pair */
 239    alist *pki_signers;                /* Trusted Signers */
 240    alist *pki_recipients;             /* Trusted Recipients */
 241    CRYPTO_SESSION *pki_session;       /* PKE Public Keys + Symmetric Session Keys */
 242    void *pki_session_encoded;         /* Cached DER-encoded copy of pki_session */
 243    size_t pki_session_encoded_size;   /* Size of DER-encoded pki_session */
 244    POOLMEM *crypto_buf;               /* Encryption/Decryption buffer */
 245    DIRRES* director;                  /* Director resource */
 246 #endif /* FILE_DAEMON */
 247
 248
 249 #ifdef STORAGE_DAEMON
 250    /* Storage Daemon specific part of JCR */
 251    JCR *next_dev;                     /* next JCR attached to device */
 252    JCR *prev_dev;                     /* previous JCR attached to device */
 253    pthread_cond_t job_start_wait;     /* Wait for FD to start Job */
 254    int type;
 255    DCR *read_dcr;                     /* device context for reading */
 256    DCR *dcr;                          /* device context record */
 257    alist *dcrs;                       /* list of dcrs open */
 258    POOLMEM *job_name;                 /* base Job name (not unique) */
 259    POOLMEM *fileset_name;             /* FileSet */
 260    POOLMEM *fileset_md5;              /* MD5 for FileSet */
 261    VOL_LIST *VolList;                 /* list to read */
 262    int32_t NumVolumes;                /* number of volumes used */
 263    int32_t CurVolume;                 /* current volume number */
 264    int label_errors;                  /* count of label errors */
 265    bool session_opened;
 266    long Ticket;                       /* ticket for this job */
 267    bool ignore_label_errors;          /* ignore Volume label errors */
 268    bool spool_attributes;             /* set if spooling attributes */
 269    bool no_attributes;                /* set if no attributes wanted */
 270    bool spool_data;                   /* set to spool data */
 271    int CurVol;                        /* Current Volume count */
 272    DIRRES* director;                  /* Director resource */
 273    alist *dirstore;                   /* list of storage devices sent by DIR */
 274    alist *reserve_msgs;               /* reserve fail messages */
 275    bool write_part_after_job;         /* Set to write part after job */
 276    bool PreferMountedVols;            /* Prefer mounted vols rather than new */
 277
 278    uint32_t FileId;                   /* Last file id inserted */
 279
 280    /* Parmaters for Open Read Session */
 281    BSR *bsr;                          /* Bootstrap record -- has everything */
 282    bool mount_next_volume;            /* set to cause next volume mount */
 283    uint32_t read_VolSessionId;
 284    uint32_t read_VolSessionTime;
 285    uint32_t read_StartFile;
 286    uint32_t read_EndFile;
 287    uint32_t read_StartBlock;
 288    uint32_t read_EndBlock;
 289    /* Device wait times */
 290    int min_wait;
 291    int max_wait;
 292    int max_num_wait;
 293    int wait_sec;
 294    int rem_wait_sec;
 295    int num_wait;
 296
 297 #endif /* STORAGE_DAEMON */
 298
 299 };
 300
 301
 302
 303 /*
 304  * Structure for all daemons that keeps some summary
 305  *  info on the last job run.
 306  */
 307 struct s_last_job {
 308    dlink link;
 309    int Errors;                        /* FD/SD errors */
 310    int JobType;
 311    int JobStatus;
 312    int JobLevel;
 313    uint32_t JobId;
 314    uint32_t VolSessionId;
 315    uint32_t VolSessionTime;
 316    uint32_t JobFiles;
 317    uint64_t JobBytes;
 318    time_t start_time;
 319    time_t end_time;
 320    char Job[MAX_NAME_LENGTH];
 321 };
 322
 323 extern struct s_last_job last_job;
 324 extern dlist *last_jobs;
 325
 326
 327 /* The following routines are found in lib/jcr.c */
 328 extern bool init_jcr_subsystem(void);
 329 extern JCR *new_jcr(int size, JCR_free_HANDLER *daemon_free_jcr);
 330 extern JCR *get_jcr_by_id(uint32_t JobId);
 331 extern JCR *get_jcr_by_session(uint32_t SessionId, uint32_t SessionTime);
 332 extern JCR *get_jcr_by_partial_name(char *Job);
 333 extern JCR *get_jcr_by_full_name(char *Job);
 334 extern JCR *get_next_jcr(JCR *jcr);
 335 extern void set_jcr_job_status(JCR *jcr, int JobStatus);
 336
 337 #ifdef DEBUG
 338 extern void b_free_jcr(const char *file, int line, JCR *jcr);
 339 #define free_jcr(jcr) b_free_jcr(__FILE__, __LINE__, (jcr))
 340 #else
 341 extern void free_jcr(JCR *jcr);
 342 #endif
 343
 344 #endif /* __JCR_H_ */