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