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