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 /*
  13    Copyright (C) 2000, 2001, 2002 Kern Sibbald and John Walker
  14
  15    This program is free software; you can redistribute it and/or
  16    modify it under the terms of the GNU General Public License as
  17    published by the Free Software Foundation; either version 2 of
  18    the License, or (at your option) any later version.
  19
  20    This program is distributed in the hope that it will be useful,
  21    but WITHOUT ANY WARRANTY; without even the implied warranty of
  22    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  23    General Public License for more details.
  24
  25    You should have received a copy of the GNU General Public
  26    License along with this program; if not, write to the Free
  27    Software Foundation, Inc., 59 Temple Place - Suite 330, Boston,
  28    MA 02111-1307, USA.
  29
  30  */
  31
  32 #ifndef __JCR_H_
  33 #define __JCR_H_ 1
  34
  35 /* Backup/Verify level code. These are stored in the DB */
  36 #define L_FULL                   'F'
  37 #define L_INCREMENTAL            'I'  /* since last backup */
  38 #define L_DIFFERENTIAL           'D'  /* since last full backup */
  39 #define L_SINCE                  'S'
  40 #define L_VERIFY_CATALOG         'C'  /* verify from catalog */
  41 #define L_VERIFY_INIT            'V'  /* verify save (init DB) */
  42 #define L_VERIFY_VOLUME_TO_CATALOG 'O'  /* verify Volume to catalog entries */
  43 #define L_VERIFY_DATA            'A'  /* verify data on volume */
  44
  45
  46 /* Job Types. These are stored in the DB */
  47 #define JT_BACKUP                'B'  /* Backup Job */
  48 #define JT_VERIFY                'V'  /* Verify Job */
  49 #define JT_RESTORE               'R'  /* Restore Job */
  50 #define JT_CONSOLE               'C'  /* console program */
  51 #define JT_ADMIN                 'D'  /* admin job */
  52 #define JT_ARCHIVE               'A'
  53
  54 /* Job Status. Some of these are stored in the DB */
  55 #define JS_Created               'C'  /* created but not yet running */
  56 #define JS_Running               'R'  /* running */
  57 #define JS_Blocked               'B'  /* blocked */
  58 #define JS_Terminated            'T'  /* terminated normally */
  59 #define JS_ErrorTerminated       'E'  /* Job terminated in error */
  60 #define JS_Error                 'e'  /* Non-fatal error */
  61 #define JS_FatalError            'f'  /* Fatal error */
  62 #define JS_Differences           'D'  /* Verify differences */
  63 #define JS_Cancelled             'A'  /* cancelled by user */
  64 #define JS_WaitFD                'F'  /* waiting on File daemon */
  65 #define JS_WaitSD                'S'  /* waiting on the Storage daemon */
  66 #define JS_WaitMedia             'm'  /* waiting for new media */
  67 #define JS_WaitMount             'M'  /* waiting for Mount */
  68
  69 #define job_cancelled(jcr) \
  70   (jcr->JobStatus == JS_Cancelled || \
  71    jcr->JobStatus == JS_ErrorTerminated || \
  72    jcr->JobStatus == JS_FatalError)
  73
  74 typedef void (JCR_free_HANDLER)(struct s_jcr *jcr);
  75
  76 /* Job Control Record (JCR) */
  77 struct s_jcr {
  78    /* Global part of JCR common to all daemons */
  79    struct s_jcr *next;
  80    struct s_jcr *prev;
  81    pthread_t my_thread_id;            /* id of thread controlling jcr */
  82    pthread_mutex_t mutex;             /* jcr mutex */
  83    BSOCK *dir_bsock;                  /* Director bsock or NULL if we are him */
  84    BSOCK *store_bsock;                /* Storage connection socket */
  85    BSOCK *file_bsock;                 /* File daemon connection socket */
  86    JCR_free_HANDLER *daemon_free_jcr; /* Local free routine */
  87    int use_count;                     /* use count */
  88    POOLMEM *errmsg;                   /* edited error message */
  89    char Job[MAX_NAME_LENGTH];         /* Unique name of this Job */
  90    uint32_t JobId;                    /* Director's JobId */
  91    uint32_t VolSessionId;
  92    uint32_t VolSessionTime;
  93    uint32_t JobFiles;                 /* Number of files written, this job */
  94    uint32_t JobErrors;                /* */
  95    uint64_t JobBytes;                 /* Number of bytes processed this job */
  96    uint64_t ReadBytes;                /* Bytes read -- before compression */
  97    uint32_t Errors;                   /* Number of non-fatal errors */
  98    int JobStatus;                     /* ready, running, blocked, terminated */
  99    int JobType;                       /* backup, restore, verify ... */
 100    int JobLevel;                      /* Job level */
 101    int authenticated;                 /* set when client authenticated */
 102    time_t sched_time;                 /* job schedule time, i.e. when it should start */
 103    time_t start_time;                 /* when job actually started */
 104    time_t run_time;                   /* used for computing speed */
 105    time_t end_time;                   /* job end time */
 106    POOLMEM *VolumeName;               /* Volume name desired -- pool_memory */
 107    POOLMEM *client_name;              /* client name */
 108    char *RestoreBootstrap;            /* Bootstrap file to restore */
 109    char *sd_auth_key;                 /* SD auth key */
 110    MSGS *jcr_msgs;                    /* Copy of message resource -- actually used */
 111    uint32_t ClientId;                 /* Client associated with Job */
 112
 113    /* Daemon specific part of JCR */
 114    /* This should be empty in the library */
 115
 116 #ifdef DIRECTOR_DAEMON
 117    /* Director Daemon specific part of JCR */
 118    pthread_t SD_msg_chan;             /* Message channel thread id */
 119    pthread_cond_t term_wait;          /* Wait for job termination */
 120    int msg_thread_done;               /* Set when Storage message thread terms */
 121    BSOCK *ua;                         /* User agent */
 122    JOB *job;                          /* Job resource */
 123    STORE *store;                      /* Storage resource */
 124    CLIENT *client;                    /* Client resource */
 125    POOL *pool;                        /* Pool resource */
 126    FILESET *fileset;                  /* FileSet resource */
 127    CAT *catalog;                      /* Catalog resource */
 128    MSGS *messages;                    /* Default message handler */
 129    int SDJobStatus;                   /* Storage Job Status */
 130    int FDJobStatus;                   /* File daemon Job Status */
 131    int mode;                          /* manual/auto run */
 132    B_DB *db;                          /* database pointer */
 133    uint32_t MediaId;                  /* DB record IDs associated with this job */
 134    uint32_t PoolId;                   /* Pool record id */
 135    FileId_t FileId;                   /* Last file id inserted */
 136    uint32_t FileIndex;                /* Last FileIndex processed */
 137    POOLMEM *fname;                    /* name to put into catalog */
 138    int fn_printed;                    /* printed filename */
 139    POOLMEM *stime;                    /* start time for incremental/differential */
 140    JOB_DBR jr;                        /* Job record in Database */
 141    uint32_t RestoreJobId;             /* Id specified by UA */
 142    char *RestoreWhere;                /* Where to restore the files */
 143    POOLMEM *client_uname;             /* client uname */
 144    int replace;                       /* Replace option */
 145 #endif /* DIRECTOR_DAEMON */
 146
 147 #ifdef FILE_DAEMON
 148    /* File Daemon specific part of JCR */
 149    uint32_t num_files_examined;       /* files examined this job */
 150    POOLMEM *last_fname;               /* last file saved/verified */
 151    /*********FIXME********* add missing files and files to be retried */
 152    int incremental;                   /* set if incremental for SINCE */
 153    time_t mtime;                      /* begin time for SINCE */
 154    int mode;                          /* manual/auto run */
 155    int status;                        /* job status */
 156    long Ticket;                       /* Ticket */
 157    int save_level;                    /* save level */
 158    char *big_buf;                     /* I/O buffer */
 159    POOLMEM *compress_buf;             /* Compression buffer */
 160    int32_t compress_buf_size;         /* Length of compression buffer */
 161    POOLMEM *where;                    /* Root where to restore */
 162    int replace;                       /* Replace options */
 163    int prefix_links;                  /* Prefix links with Where path */
 164    int buf_size;                      /* length of buffer */
 165    void *ff;                          /* Find Files packet */
 166    char stored_addr[MAX_NAME_LENGTH]; /* storage daemon address */
 167    uint32_t StartFile;
 168    uint32_t EndFile;
 169    uint32_t StartBlock;
 170    uint32_t EndBlock;
 171 #endif /* FILE_DAEMON */
 172
 173 #ifdef STORAGE_DAEMON
 174    /* Storage Daemon specific part of JCR */
 175    struct s_jcr *next_dev;            /* next JCR attached to device */
 176    struct s_jcr *prev_dev;            /* previous JCR attached to device */
 177    pthread_cond_t job_start_wait;     /* Wait for FD to start Job */
 178    int type;
 179    DEVRES *device;                    /* device to use */
 180    VOLUME_CAT_INFO VolCatInfo;        /* Catalog info for desired volume */
 181    POOLMEM *job_name;                 /* base Job name (not unique) */
 182    POOLMEM *fileset_name;             /* FileSet */
 183    POOLMEM *fileset_md5;              /* MD5 for FileSet */
 184    POOLMEM *pool_name;                /* pool to use */
 185    POOLMEM *pool_type;                /* pool type to use */
 186    POOLMEM *media_type;               /* media type */
 187    POOLMEM *dev_name;                 /* device name */
 188    VOL_LIST *VolList;                 /* list to read */
 189    long NumVolumes;                   /* number of volumes used */
 190    long CurVolume;                    /* current volume number */
 191    int mode;                          /* manual/auto run */
 192    int spool_attributes;              /* set if spooling attributes */
 193    int no_attributes;                 /* set if no attributes wanted */
 194    int label_status;                  /* device volume label status */
 195    int label_errors;                  /* count of label errors */
 196    int session_opened;
 197    DEV_RECORD rec;                    /* Read/Write record */
 198    long Ticket;                       /* ticket for this job */
 199    uint32_t VolFirstFile;             /* First file index this Volume */
 200    uint32_t FileIndex;                /* Current File Index */
 201    uint32_t EndFile;                  /* End file written */
 202    uint32_t StartFile;                /* Start write file */
 203    uint32_t StartBlock;               /* Start write block */
 204    uint32_t EndBlock;                 /* Ending block written */
 205    uint32_t FileId;                   /* Last file id inserted */
 206
 207    /* Parmaters for Open Read Session */
 208    BSR *bsr;                          /* Bootstrap record -- has everything */
 209    uint32_t read_VolSessionId;
 210    uint32_t read_VolSessionTime;
 211    uint32_t read_StartFile;
 212    uint32_t read_EndFile;
 213    uint32_t read_StartBlock;
 214    uint32_t read_EndBlock;
 215
 216 #endif /* STORAGE_DAEMON */
 217
 218 };
 219
 220 /*
 221  * Structure for all daemons that keeps some summary
 222  *  info on the last job run.
 223  */
 224 struct s_last_job {
 225    int NumJobs;
 226    int JobType;
 227    int JobStatus;
 228    uint32_t JobId;
 229    uint32_t VolSessionId;
 230    uint32_t VolSessionTime;
 231    uint32_t JobFiles;
 232    uint64_t JobBytes;
 233    time_t start_time;
 234    time_t end_time;
 235    char Job[MAX_NAME_LENGTH];
 236 };
 237
 238 extern struct s_last_job last_job;
 239
 240 #undef JCR
 241 typedef struct s_jcr JCR;
 242
 243
 244 /* The following routines are found in lib/jcr.c */
 245 extern JCR *new_jcr(int size, JCR_free_HANDLER *daemon_free_jcr);
 246 extern void free_locked_jcr(JCR *jcr);
 247 extern JCR *get_jcr_by_id(uint32_t JobId);
 248 extern JCR *get_jcr_by_session(uint32_t SessionId, uint32_t SessionTime);
 249 extern JCR *get_jcr_by_partial_name(char *Job);
 250 extern JCR *get_jcr_by_full_name(char *Job);
 251 extern JCR *get_next_jcr(JCR *jcr);
 252 extern void lock_jcr_chain();
 253 extern void unlock_jcr_chain();
 254 extern void set_jcr_job_status(JCR *jcr, int JobStatus);
 255
 256 #ifdef DEBUG
 257 extern void b_free_jcr(char *file, int line, JCR *jcr);
 258 #define free_jcr(jcr) b_free_jcr(__FILE__, __LINE__, (jcr))
 259 #else
 260 extern void free_jcr(JCR *jcr);
 261 #endif
 262
 263 #endif /* __JCR_H_ */