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 */
  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_LEVEL                  'L'
  40 #define L_SINCE                  'S'
  41 #define L_VERIFY_CATALOG         'C'  /* verify from catalog */
  42 #define L_VERIFY_INIT            'V'  /* verify save (init DB) */
  43 #define L_VERIFY_VOLUME          'O'  /* verify we can read volume */
  44 #define L_VERIFY_DATA            'A'  /* verify data on volume */
  45
  46
  47 /* Job Types */
  48 #define JT_BACKUP                'B'
  49 #define JT_VERIFY                'V'
  50 #define JT_RESTORE               'R'
  51 #define JT_CONSOLE               'C'  /* console program */
  52 #define JT_ADMIN                 'D'  /* admin job */
  53 #define JT_ARCHIVE               'A'
  54
  55 /* Job Status */
  56 #define JS_Created               'C'
  57 #define JS_Running               'R'
  58 #define JS_Blocked               'B'
  59 #define JS_Terminated            'T'  /* terminated normally */
  60 #define JS_ErrorTerminated       'E'
  61 #define JS_Errored               'E'
  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 || jcr->JobStatus == JS_ErrorTerminated)
  71
  72 typedef void (JCR_free_HANDLER)(struct s_jcr *jcr);
  73
  74 /* Job Control Record (JCR) */
  75 struct s_jcr {
  76    /* Global part of JCR common to all daemons */
  77    struct s_jcr *next;
  78    struct s_jcr *prev;
  79    pthread_t my_thread_id;            /* id of thread controlling jcr */
  80    pthread_mutex_t mutex;             /* jcr mutex */
  81    BSOCK *dir_bsock;                  /* Director bsock or NULL if we are him */
  82    BSOCK *store_bsock;                /* Storage connection socket */
  83    BSOCK *file_bsock;                 /* File daemon connection socket */
  84    JCR_free_HANDLER *daemon_free_jcr; /* Local free routine */
  85    int use_count;                     /* use count */
  86    char *errmsg;                      /* edited error message */
  87    char Job[MAX_NAME_LENGTH];         /* Job name */
  88    uint32_t JobId;                    /* Director's JobId */
  89    uint32_t VolSessionId;
  90    uint32_t VolSessionTime;
  91    uint32_t JobFiles;                 /* Number of files written, this job */
  92    uint32_t JobErrors;
  93    uint64_t JobBytes;                 /* Number of bytes processed this job */
  94    int JobStatus;                     /* ready, running, blocked, terminated */
  95    int JobTermCode;                   /* termination code */
  96    int JobType;                       /* backup, restore, verify ... */
  97    int level;
  98    int authenticated;                 /* set when client authenticated */
  99    time_t sched_time;                 /* job schedule time, i.e. when it should start */
 100    time_t start_time;                 /* when job actually started */
 101    time_t run_time;                   /* used for computing speed */
 102    time_t end_time;                   /* job end time */
 103    POOLMEM *VolumeName;               /* Volume name desired -- pool_memory */
 104    char *client_name;                 /* client name */
 105    char *sd_auth_key;                 /* SD auth key */
 106    MSGS *msgs;                        /* Message resource */
 107
 108    /* Daemon specific part of JCR */
 109    /* This should be empty in the library */
 110
 111 #ifdef DIRECTOR_DAEMON
 112    /* Director Daemon specific part of JCR */
 113    pthread_t SD_msg_chan;             /* Message channel thread id */
 114    pthread_cond_t term_wait;          /* Wait for job termination */
 115    int msg_thread_done;               /* Set when Storage message thread terms */
 116    BSOCK *ua;                         /* User agent */
 117    JOB *job;                          /* Job resource */
 118    STORE *store;                      /* Storage resource */
 119    CLIENT *client;                    /* Client resource */
 120    POOL *pool;                        /* Pool resource */
 121    FILESET *fileset;                  /* FileSet resource */
 122    CAT *catalog;                      /* Catalog resource */
 123    int SDJobStatus;                   /* Storage Job Status */
 124    int mode;                          /* manual/auto run */
 125    B_DB *db;                          /* database pointer */
 126    int MediaId;                       /* DB record IDs associated with this job */
 127    int ClientId;                      /* Client associated with file */
 128    uint32_t PoolId;                   /* Pool record id */
 129    FileId_t FileId;                   /* Last file id inserted */
 130    uint32_t FileIndex;                /* Last FileIndex processed */
 131    char *fname;                       /* name to put into catalog */
 132    int fn_printed;                    /* printed filename */
 133    char *stime;                       /* start time for incremental/differential */
 134    JOB_DBR jr;                        /* Job record in Database */
 135    int RestoreJobId;                  /* Id specified by UA */
 136    char *RestoreWhere;                /* Where to restore the files */
 137 #endif /* DIRECTOR_DAEMON */
 138
 139 #ifdef FILE_DAEMON
 140    /* File Daemon specific part of JCR */
 141    uint32_t num_files_examined;       /* files examined this job */
 142    char *last_fname;                  /* last file saved */
 143    /*********FIXME********* add missing files and files to be retried */
 144    int incremental;                   /* set if incremental for SINCE */
 145    time_t mtime;                      /* begin time for SINCE */
 146    int mode;                          /* manual/auto run */
 147    int status;                        /* job status */
 148    long Ticket;                       /* Ticket */
 149    int save_level;                    /* save level */
 150    char *big_buf;                     /* I/O buffer */
 151    char *compress_buf;                /* Compression buffer */
 152    char *where;                       /* Root where to restore */
 153    int buf_size;                      /* length of buffer */
 154    FF_PKT *ff;                        /* Find Files packet */
 155    char stored_addr[MAX_NAME_LENGTH]; /* storage daemon address */
 156    uint32_t StartFile;
 157    uint32_t EndFile;
 158    uint32_t StartBlock;
 159    uint32_t EndBlock;
 160 #endif /* FILE_DAEMON */
 161
 162 #ifdef STORAGE_DAEMON
 163    /* Storage Daemon specific part of JCR */
 164    pthread_cond_t job_start_wait;     /* Wait for FD to start Job */
 165    int type;
 166    DEVRES *device;                    /* device to use */
 167    VOLUME_CAT_INFO VolCatInfo;        /* Catalog info for desired volume */
 168    char *pool_name;                   /* pool to use */
 169    char *pool_type;                   /* pool type to use */
 170    char *job_name;                    /* job name */
 171    char *media_type;                  /* media type */
 172    char *dev_name;                    /* device name */
 173    long NumVolumes;                   /* number of volumes used */
 174    long CurVolume;                    /* current volume number */
 175    int mode;                          /* manual/auto run */
 176    int label_status;                  /* device volume label status */
 177    int session_opened;
 178    DEV_RECORD rec;                    /* Read/Write record */
 179    long Ticket;                       /* ticket for this job */
 180    uint32_t VolFirstFile;             /* First file index this Volume */
 181    uint32_t start_block;              /* Start write block */
 182    uint32_t start_file;               /* Start write file */
 183    uint32_t end_block;                /* Ending block written */
 184    uint32_t end_file;                 /* End file written */
 185
 186    /* Parmaters for Open Read Session */
 187    uint32_t read_VolSessionId;
 188    uint32_t read_VolSessionTime;
 189    uint32_t read_StartFile;
 190    uint32_t read_EndFile;
 191    uint32_t read_StartBlock;
 192    uint32_t read_EndBlock;
 193
 194 #endif /* STORAGE_DAEMON */
 195
 196 };
 197
 198 /*
 199  * Structure for all daemons that keeps some summary
 200  *  info on the last job run.
 201  */
 202 struct s_last_job {
 203    int NumJobs;
 204    int JobType;
 205    int JobStatus;
 206    uint32_t JobId;
 207    uint32_t VolSessionId;
 208    uint32_t VolSessionTime;
 209    uint32_t JobFiles;
 210    uint64_t JobBytes;
 211    time_t start_time;
 212    time_t end_time;
 213    char Job[MAX_NAME_LENGTH];
 214 };
 215
 216 extern struct s_last_job last_job;
 217
 218 #undef JCR
 219 typedef struct s_jcr JCR;
 220
 221
 222 /* The following routines are found in lib/jcr.c */
 223 extern JCR *new_jcr(int size, JCR_free_HANDLER *daemon_free_jcr);
 224 extern void free_jcr(JCR *jcr);
 225 extern void free_locked_jcr(JCR *jcr);
 226 extern JCR *get_jcr_by_id(uint32_t JobId);
 227 extern JCR *get_jcr_by_partial_name(char *Job);
 228 extern JCR *get_jcr_by_full_name(char *Job);
 229 extern JCR *get_next_jcr(JCR *jcr);
 230 extern void lock_jcr_chain();
 231 extern void unlock_jcr_chain();
 232
 233 #endif /* __JCR_H_ */