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