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-2005 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)=NULL; ((jcr)=get_next_jcr(jcr)); )
  84
  85 #define SD_APPEND 1
  86 #define SD_READ   0
  87
  88 /* Forward referenced structures */
  89 class JCR;
  90 struct FF_PKT;
  91 struct B_DB;
  92 struct ATTR_DBR;
  93
  94 typedef void (JCR_free_HANDLER)(JCR *jcr);
  95
  96 /* Job Control Record (JCR) */
  97 class JCR {
  98 public:
  99    void inc_use_count(void) {P(mutex); use_count++; V(mutex); };
 100    void dec_use_count(void) {P(mutex); use_count--; V(mutex); };
 101
 102    /* Global part of JCR common to all daemons */
 103    dlink link;                        /* JCR chain link */
 104    volatile int use_count;            /* use count */
 105    pthread_t my_thread_id;            /* id of thread controlling jcr */
 106    pthread_mutex_t mutex;             /* jcr mutex */
 107    BSOCK *dir_bsock;                  /* Director bsock or NULL if we are him */
 108    BSOCK *store_bsock;                /* Storage connection socket */
 109    BSOCK *file_bsock;                 /* File daemon connection socket */
 110    JCR_free_HANDLER *daemon_free_jcr; /* Local free routine */
 111    dlist *msg_queue;                  /* Queued messages */
 112    alist job_end_push;                /* Job end pushed calls */
 113    bool dequeuing;                    /* dequeuing messages */
 114    POOLMEM *VolumeName;               /* Volume name desired -- pool_memory */
 115    POOLMEM *errmsg;                   /* edited error message */
 116    char Job[MAX_NAME_LENGTH];         /* Unique name of this Job */
 117    char event[MAX_NAME_LENGTH];       /* Current event */
 118    uint32_t JobId;                    /* Director's JobId */
 119    uint32_t VolSessionId;
 120    uint32_t VolSessionTime;
 121    uint32_t JobFiles;                 /* Number of files written, this job */
 122    uint32_t JobErrors;                /* */
 123    uint64_t JobBytes;                 /* Number of bytes processed this job */
 124    uint64_t ReadBytes;                /* Bytes read -- before compression */
 125    uint32_t Errors;                   /* Number of non-fatal errors */
 126    volatile int JobStatus;            /* ready, running, blocked, terminated */
 127    int JobType;                       /* backup, restore, verify ... */
 128    int JobLevel;                      /* Job level */
 129    int JobPriority;                   /* Job priority */
 130    time_t sched_time;                 /* job schedule time, i.e. when it should start */
 131    time_t start_time;                 /* when job actually started */
 132    time_t run_time;                   /* used for computing speed */
 133    time_t end_time;                   /* job end time */
 134    POOLMEM *client_name;              /* client name */
 135    POOLMEM *RestoreBootstrap;         /* Bootstrap file to restore */
 136    POOLMEM *stime;                    /* start time for incremental/differential */
 137    char *sd_auth_key;                 /* SD auth key */
 138    MSGS *jcr_msgs;                    /* Copy of message resource -- actually used */
 139    uint32_t ClientId;                 /* Client associated with Job */
 140    char *where;                       /* prefix to restore files to */
 141    int cached_pnl;                    /* cached path length */
 142    POOLMEM *cached_path;              /* cached path */
 143    bool prefix_links;                 /* Prefix links with Where path */
 144    bool gui;                          /* set if gui using console */
 145    bool authenticated;                /* set when client authenticated */
 146    void *Python_job;                  /* Python Job Object */
 147    void *Python_events;               /* Python Events Object */
 148
 149    bool cached_attribute;             /* set if attribute is cached */
 150    POOLMEM *attr;                     /* Attribute string from SD */
 151    B_DB *db;                          /* database pointer */
 152    ATTR_DBR *ar;                      /* DB attribute record */
 153
 154    /* Daemon specific part of JCR */
 155    /* This should be empty in the library */
 156
 157 #ifdef DIRECTOR_DAEMON
 158    /* Director Daemon specific part of JCR */
 159    pthread_t SD_msg_chan;             /* Message channel thread id */
 160    pthread_cond_t term_wait;          /* Wait for job termination */
 161    workq_ele_t *work_item;            /* Work queue item if scheduled */
 162    volatile bool sd_msg_thread_done;  /* Set when Storage message thread terms */
 163    BSOCK *ua;                         /* User agent */
 164    JOB *job;                          /* Job resource */
 165    JOB *verify_job;                   /* Job resource of verify target job */
 166    alist *storage;                    /* Storage possibilities */
 167    STORE *store;                      /* Storage daemon selected */
 168    CLIENT *client;                    /* Client resource */
 169    POOL *pool;                        /* Pool resource */
 170    POOL *full_pool;                   /* Full backup pool resource */
 171    POOL *inc_pool;                    /* Incremental backup pool resource */
 172    POOL *dif_pool;                    /* Differential backup pool resource */
 173    FILESET *fileset;                  /* FileSet resource */
 174    CAT *catalog;                      /* Catalog resource */
 175    MSGS *messages;                    /* Default message handler */
 176    uint32_t SDJobFiles;               /* Number of files written, this job */
 177    uint64_t SDJobBytes;               /* Number of bytes processed this job */
 178    uint32_t SDErrors;                 /* Number of non-fatal errors */
 179    volatile int SDJobStatus;          /* Storage Job Status */
 180    volatile int FDJobStatus;          /* File daemon Job Status */
 181    uint32_t ExpectedFiles;            /* Expected restore files */
 182    uint32_t MediaId;                  /* DB record IDs associated with this job */
 183    uint32_t PoolId;                   /* Pool record id */
 184    FileId_t FileId;                   /* Last file id inserted */
 185    uint32_t FileIndex;                /* Last FileIndex processed */
 186    POOLMEM *fname;                    /* name to put into catalog */
 187    JOB_DBR jr;                        /* Job DB record for current job */
 188    JOB_DBR target_jr;                 /* target job */
 189    char FSCreateTime[MAX_TIME_LENGTH]; /* FileSet CreateTime as returned from DB */
 190    char since[MAX_TIME_LENGTH];       /* since time */
 191    uint32_t RestoreJobId;             /* Id specified by UA */
 192    POOLMEM *client_uname;             /* client uname */
 193    int replace;                       /* Replace option */
 194    int NumVols;                       /* Number of Volume used in pool */
 195    int reschedule_count;              /* Number of times rescheduled */
 196    bool spool_data;                   /* Spool data in SD */
 197    bool acquired_resource_locks;      /* set if resource locks acquired */
 198    bool term_wait_inited;             /* Set when cond var inited */
 199    bool fn_printed;                   /* printed filename */
 200    bool write_part_after_job;         /* Write part after job in SD */
 201    bool needs_sd;                     /* set if SD needed by Job */
 202    bool cloned;                       /* set if cloned */
 203    bool unlink_bsr;                   /* Unlink bsr file created */
 204 #endif /* DIRECTOR_DAEMON */
 205
 206
 207 #ifdef FILE_DAEMON
 208    /* File Daemon specific part of JCR */
 209    uint32_t num_files_examined;       /* files examined this job */
 210    POOLMEM *last_fname;               /* last file saved/verified */
 211    POOLMEM *acl_text;                 /* text of ACL for backup */
 212    /*********FIXME********* add missing files and files to be retried */
 213    int incremental;                   /* set if incremental for SINCE */
 214    time_t mtime;                      /* begin time for SINCE */
 215    int listing;                       /* job listing in estimate */
 216    long Ticket;                       /* Ticket */
 217    char *big_buf;                     /* I/O buffer */
 218    POOLMEM *compress_buf;             /* Compression buffer */
 219    int32_t compress_buf_size;         /* Length of compression buffer */
 220    int replace;                       /* Replace options */
 221    int buf_size;                      /* length of buffer */
 222    FF_PKT *ff;                        /* Find Files packet */
 223    char stored_addr[MAX_NAME_LENGTH]; /* storage daemon address */
 224    uint32_t StartFile;
 225    uint32_t EndFile;
 226    uint32_t StartBlock;
 227    uint32_t EndBlock;
 228    pthread_t heartbeat_id;            /* id of heartbeat thread */
 229    volatile BSOCK *hb_bsock;          /* duped SD socket */
 230    volatile BSOCK *hb_dir_bsock;      /* duped DIR socket */
 231    POOLMEM *RunAfterJob;              /* Command to run after job */
 232    bool pki_sign;                     /* Enable PKI Signatures? */
 233    bool pki_encrypt;                  /* Enable PKI Encryption? */
 234    DIGEST *digest;                    /* Last file's digest context */
 235    X509_KEYPAIR *pki_keypair;         /* Encryption key pair */
 236    alist *pki_signers;                /* Trusted Signers */
 237    alist *pki_readers;                /* Trusted Readers */
 238    CRYPTO_RECIPIENTS *pki_recipients; /* PKE Public Keys + Symmetric Session Keys */
 239    DIRRES* director;                  /* Director resource */
 240 #endif /* FILE_DAEMON */
 241
 242
 243 #ifdef STORAGE_DAEMON
 244    /* Storage Daemon specific part of JCR */
 245    JCR *next_dev;                     /* next JCR attached to device */
 246    JCR *prev_dev;                     /* previous JCR attached to device */
 247    pthread_cond_t job_start_wait;     /* Wait for FD to start Job */
 248    int type;
 249    DCR *read_dcr;                     /* device context for reading */
 250    DCR *dcr;                          /* device context record */
 251    alist *dcrs;                       /* list of dcrs open */
 252    POOLMEM *job_name;                 /* base Job name (not unique) */
 253    POOLMEM *fileset_name;             /* FileSet */
 254    POOLMEM *fileset_md5;              /* MD5 for FileSet */
 255    VOL_LIST *VolList;                 /* list to read */
 256    int32_t NumVolumes;                /* number of volumes used */
 257    int32_t CurVolume;                 /* current volume number */
 258    int label_errors;                  /* count of label errors */
 259    bool session_opened;
 260    long Ticket;                       /* ticket for this job */
 261    bool ignore_label_errors;          /* ignore Volume label errors */
 262    bool spool_attributes;             /* set if spooling attributes */
 263    bool no_attributes;                /* set if no attributes wanted */
 264    bool spool_data;                   /* set to spool data */
 265    int CurVol;                        /* Current Volume count */
 266    DIRRES* director;                  /* Director resource */
 267    alist *dirstore;
 268    bool write_part_after_job;         /* Set to write part after job */
 269    bool PreferMountedVols;            /* Prefer mounted vols rather than new */
 270
 271    uint32_t FileId;                   /* Last file id inserted */
 272
 273    /* Parmaters for Open Read Session */
 274    BSR *bsr;                          /* Bootstrap record -- has everything */
 275    bool mount_next_volume;            /* set to cause next volume mount */
 276    uint32_t read_VolSessionId;
 277    uint32_t read_VolSessionTime;
 278    uint32_t read_StartFile;
 279    uint32_t read_EndFile;
 280    uint32_t read_StartBlock;
 281    uint32_t read_EndBlock;
 282    /* Device wait times */
 283    int min_wait;
 284    int max_wait;
 285    int max_num_wait;
 286    int wait_sec;
 287    int rem_wait_sec;
 288    int num_wait;
 289
 290 #endif /* STORAGE_DAEMON */
 291
 292 };
 293
 294
 295
 296 /*
 297  * Structure for all daemons that keeps some summary
 298  *  info on the last job run.
 299  */
 300 struct s_last_job {
 301    dlink link;
 302    int Errors;                        /* FD/SD errors */
 303    int JobType;
 304    int JobStatus;
 305    int JobLevel;
 306    uint32_t JobId;
 307    uint32_t VolSessionId;
 308    uint32_t VolSessionTime;
 309    uint32_t JobFiles;
 310    uint64_t JobBytes;
 311    time_t start_time;
 312    time_t end_time;
 313    char Job[MAX_NAME_LENGTH];
 314 };
 315
 316 extern struct s_last_job last_job;
 317 extern dlist *last_jobs;
 318
 319
 320 /* The following routines are found in lib/jcr.c */
 321 extern bool init_jcr_subsystem(void);
 322 extern JCR *new_jcr(int size, JCR_free_HANDLER *daemon_free_jcr);
 323 extern JCR *get_jcr_by_id(uint32_t JobId);
 324 extern JCR *get_jcr_by_session(uint32_t SessionId, uint32_t SessionTime);
 325 extern JCR *get_jcr_by_partial_name(char *Job);
 326 extern JCR *get_jcr_by_full_name(char *Job);
 327 extern JCR *get_next_jcr(JCR *jcr);
 328 extern void set_jcr_job_status(JCR *jcr, int JobStatus);
 329
 330 #ifdef DEBUG
 331 extern void b_free_jcr(const char *file, int line, JCR *jcr);
 332 #define free_jcr(jcr) b_free_jcr(__FILE__, __LINE__, (jcr))
 333 #else
 334 extern void free_jcr(JCR *jcr);
 335 #endif
 336
 337 #endif /* __JCR_H_ */