]> git.sur5r.net Git - bacula/bacula/blobdiff - bacula/src/jcr.h
- Put Dmsg() on inside if() to avoid calling subroutine.
[bacula/bacula] / bacula / src / jcr.h
index 01fb04b712079e45d0eb361b141643c44c7d163b..9fc06e81d56d0175ecd6932b28f0d9733d170019 100644 (file)
@@ -8,40 +8,37 @@
  *
  *   Version $Id$
  */
-
 /*
-   Copyright (C) 2000, 2001, 2002 Kern Sibbald and John Walker
+   Copyright (C) 2000-2005 Kern Sibbald
 
    This program is free software; you can redistribute it and/or
-   modify it under the terms of the GNU General Public License as
-   published by the Free Software Foundation; either version 2 of
-   the License, or (at your option) any later version.
+   modify it under the terms of the GNU General Public License
+   version 2 as ammended with additional clauses defined in the
+   file LICENSE in the main source directory.
 
    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
-   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
-   General Public License for more details.
-
-   You should have received a copy of the GNU General Public
-   License along with this program; if not, write to the Free
-   Software Foundation, Inc., 59 Temple Place - Suite 330, Boston,
-   MA 02111-1307, USA.
+   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 
+   the file LICENSE for additional details.
 
  */
+
+
 #ifndef __JCR_H_
 #define __JCR_H_ 1
 
 /* Backup/Verify level code. These are stored in the DB */
-#define L_FULL                   'F'
+#define L_FULL                   'F'  /* Full backup */
 #define L_INCREMENTAL            'I'  /* since last backup */
 #define L_DIFFERENTIAL           'D'  /* since last full backup */
-#define L_LEVEL                  'L'
 #define L_SINCE                  'S'
 #define L_VERIFY_CATALOG         'C'  /* verify from catalog */
 #define L_VERIFY_INIT            'V'  /* verify save (init DB) */
 #define L_VERIFY_VOLUME_TO_CATALOG 'O'  /* verify Volume to catalog entries */
+#define L_VERIFY_DISK_TO_CATALOG 'd'  /* verify Disk attributes to catalog */
 #define L_VERIFY_DATA            'A'  /* verify data on volume */
+#define L_BASE                   'B'  /* Base level job */
+#define L_NONE                   ' '  /* None, for Restore and Admin */
 
 
 /* Job Types. These are stored in the DB */
 #define JT_VERIFY                'V'  /* Verify Job */
 #define JT_RESTORE               'R'  /* Restore Job */
 #define JT_CONSOLE               'C'  /* console program */
+#define JT_SYSTEM                'I'  /* internal system "job" */
 #define JT_ADMIN                 'D'  /* admin job */
-#define JT_ARCHIVE               'A'
+#define JT_ARCHIVE               'A'  /* Archive Job */
+#define JT_COPY                  'Y'  /* Copy Job */
+#define JT_MIGRATION             'M'  /* Migration Job */
+#define JT_SCAN                  'S'  /* Scan Job */
 
 /* Job Status. Some of these are stored in the DB */
 #define JS_Created               'C'  /* created but not yet running */
 #define JS_Error                 'e'  /* Non-fatal error */
 #define JS_FatalError            'f'  /* Fatal error */
 #define JS_Differences           'D'  /* Verify differences */
-#define JS_Cancelled             'A'  /* cancelled by user */
+#define JS_Canceled              'A'  /* canceled by user */
 #define JS_WaitFD                'F'  /* waiting on File daemon */
 #define JS_WaitSD                'S'  /* waiting on the Storage daemon */
 #define JS_WaitMedia             'm'  /* waiting for new media */
 #define JS_WaitMount             'M'  /* waiting for Mount */
+#define JS_WaitStoreRes          's'  /* Waiting for storage resource */
+#define JS_WaitJobRes            'j'  /* Waiting for job resource */
+#define JS_WaitClientRes         'c'  /* Waiting for Client resource */
+#define JS_WaitMaxJobs           'd'  /* Waiting for maximum jobs */
+#define JS_WaitStartTime         't'  /* Waiting for start time */
+#define JS_WaitPriority          'p'  /* Waiting for higher priority jobs to finish */
 
-#define job_cancelled(jcr) \
-  (jcr->JobStatus == JS_Cancelled || \
+#define job_canceled(jcr) \
+  (jcr->JobStatus == JS_Canceled || \
    jcr->JobStatus == JS_ErrorTerminated || \
    jcr->JobStatus == JS_FatalError)
 
-typedef void (JCR_free_HANDLER)(struct s_jcr *jcr);
+#define foreach_jcr(jcr) \
+   for ((jcr)=NULL; ((jcr)=get_next_jcr(jcr)); )
+
+#define SD_APPEND 1
+#define SD_READ   0
+
+/* Forward referenced structures */
+struct JCR;
+struct FF_PKT;
+
+typedef void (JCR_free_HANDLER)(JCR *jcr);
 
 /* Job Control Record (JCR) */
-struct s_jcr {
+struct JCR {
    /* Global part of JCR common to all daemons */
-   struct s_jcr *next;
-   struct s_jcr *prev;
+   JCR *next;
+   JCR *prev;
+   volatile int use_count;            /* use count */
    pthread_t my_thread_id;            /* id of thread controlling jcr */
    pthread_mutex_t mutex;             /* jcr mutex */
    BSOCK *dir_bsock;                  /* Director bsock or NULL if we are him */
    BSOCK *store_bsock;                /* Storage connection socket */
    BSOCK *file_bsock;                 /* File daemon connection socket */
    JCR_free_HANDLER *daemon_free_jcr; /* Local free routine */
-   int use_count;                     /* use count */
+   dlist *msg_queue;                  /* Queued messages */
+   alist job_end_push;                /* Job end pushed calls */
+   bool dequeuing;                    /* dequeuing messages */
+   POOLMEM *VolumeName;               /* Volume name desired -- pool_memory */
    POOLMEM *errmsg;                   /* edited error message */
    char Job[MAX_NAME_LENGTH];         /* Unique name of this Job */
+   char event[MAX_NAME_LENGTH];       /* Current event */
    uint32_t JobId;                    /* Director's JobId */
    uint32_t VolSessionId;
    uint32_t VolSessionTime;
@@ -96,20 +118,31 @@ struct s_jcr {
    uint64_t JobBytes;                 /* Number of bytes processed this job */
    uint64_t ReadBytes;                /* Bytes read -- before compression */
    uint32_t Errors;                   /* Number of non-fatal errors */
-   int JobStatus;                     /* ready, running, blocked, terminated */ 
+   volatile int JobStatus;            /* ready, running, blocked, terminated */
    int JobType;                       /* backup, restore, verify ... */
    int JobLevel;                      /* Job level */
-   int authenticated;                 /* set when client authenticated */
+   int JobPriority;                   /* Job priority */
    time_t sched_time;                 /* job schedule time, i.e. when it should start */
    time_t start_time;                 /* when job actually started */
    time_t run_time;                   /* used for computing speed */
    time_t end_time;                   /* job end time */
-   POOLMEM *VolumeName;               /* Volume name desired -- pool_memory */
    POOLMEM *client_name;              /* client name */
-   char *RestoreBootstrap;            /* Bootstrap file to restore */
+   POOLMEM *RestoreBootstrap;         /* Bootstrap file to restore */
+   POOLMEM *stime;                    /* start time for incremental/differential */
    char *sd_auth_key;                 /* SD auth key */
    MSGS *jcr_msgs;                    /* Copy of message resource -- actually used */
    uint32_t ClientId;                 /* Client associated with Job */
+   char *where;                       /* prefix to restore files to */
+   int cached_pnl;                    /* cached path length */
+   POOLMEM *cached_path;              /* cached path */
+   bool prefix_links;                 /* Prefix links with Where path */
+   bool gui;                          /* set if gui using console */
+   bool authenticated;                /* set when client authenticated */
+   void *Python_job;                  /* Python Job Object */
+   void *Python_events;               /* Python Events Object */
+
+   bool cached_attribute;             /* set if attribute is cached */
+   POOLMEM *attr;                     /* Attribute string from SD */
 
    /* Daemon specific part of JCR */
    /* This should be empty in the library */
@@ -118,47 +151,67 @@ struct s_jcr {
    /* Director Daemon specific part of JCR */
    pthread_t SD_msg_chan;             /* Message channel thread id */
    pthread_cond_t term_wait;          /* Wait for job termination */
-   int msg_thread_done;               /* Set when Storage message thread terms */
+   workq_ele_t *work_item;            /* Work queue item if scheduled */
+   volatile bool sd_msg_thread_done;  /* Set when Storage message thread terms */
    BSOCK *ua;                         /* User agent */
    JOB *job;                          /* Job resource */
-   STORE *store;                      /* Storage resource */
+   JOB *verify_job;                   /* Job resource of verify target job */
+   alist *storage;                    /* Storage possibilities */
+   STORE *store;                      /* Storage daemon selected */
    CLIENT *client;                    /* Client resource */
    POOL *pool;                        /* Pool resource */
+   POOL *full_pool;                   /* Full backup pool resource */
+   POOL *inc_pool;                    /* Incremental backup pool resource */
+   POOL *dif_pool;                    /* Differential backup pool resource */
    FILESET *fileset;                  /* FileSet resource */
    CAT *catalog;                      /* Catalog resource */
    MSGS *messages;                    /* Default message handler */
-   int SDJobStatus;                   /* Storage Job Status */
-   int mode;                          /* manual/auto run */
+   uint32_t SDJobFiles;               /* Number of files written, this job */
+   uint64_t SDJobBytes;               /* Number of bytes processed this job */
+   uint32_t SDErrors;                 /* Number of non-fatal errors */
+   volatile int SDJobStatus;          /* Storage Job Status */
+   volatile int FDJobStatus;          /* File daemon Job Status */
+   uint32_t ExpectedFiles;            /* Expected restore files */
    B_DB *db;                          /* database pointer */
    uint32_t MediaId;                  /* DB record IDs associated with this job */
    uint32_t PoolId;                   /* Pool record id */
    FileId_t FileId;                   /* Last file id inserted */
    uint32_t FileIndex;                /* Last FileIndex processed */
    POOLMEM *fname;                    /* name to put into catalog */
-   int fn_printed;                    /* printed filename */
-   POOLMEM *stime;                    /* start time for incremental/differential */
-   JOB_DBR jr;                        /* Job record in Database */
+   JOB_DBR jr;                        /* Job DB record for current job */
+   JOB_DBR target_jr;                 /* target job */
+   char FSCreateTime[MAX_TIME_LENGTH]; /* FileSet CreateTime as returned from DB */
+   char since[MAX_TIME_LENGTH];       /* since time */
    uint32_t RestoreJobId;             /* Id specified by UA */
-   char *RestoreWhere;                /* Where to restore the files */
-   POOLMEM *client_uname;             /* client uname */ 
+   POOLMEM *client_uname;             /* client uname */
    int replace;                       /* Replace option */
+   int NumVols;                       /* Number of Volume used in pool */
+   int reschedule_count;              /* Number of times rescheduled */
+   bool spool_data;                   /* Spool data in SD */
+   bool acquired_resource_locks;      /* set if resource locks acquired */
+   bool term_wait_inited;             /* Set when cond var inited */
+   bool fn_printed;                   /* printed filename */
+   bool write_part_after_job;         /* Write part after job in SD */
+   bool needs_sd;                     /* set if SD needed by Job */
+   bool cloned;                       /* set if cloned */
+   bool unlink_bsr;                   /* Unlink bsr file created */
+   ATTR_DBR ar;                       /* DB attribute record */
 #endif /* DIRECTOR_DAEMON */
 
+
 #ifdef FILE_DAEMON
    /* File Daemon specific part of JCR */
    uint32_t num_files_examined;       /* files examined this job */
    POOLMEM *last_fname;               /* last file saved/verified */
+   POOLMEM *acl_text;                 /* text of ACL for backup */
    /*********FIXME********* add missing files and files to be retried */
    int incremental;                   /* set if incremental for SINCE */
    time_t mtime;                      /* begin time for SINCE */
-   int mode;                          /* manual/auto run */
-   int status;                        /* job status */
+   int listing;                       /* job listing in estimate */
    long Ticket;                       /* Ticket */
-   int save_level;                    /* save level */
    char *big_buf;                     /* I/O buffer */
    POOLMEM *compress_buf;             /* Compression buffer */
    int32_t compress_buf_size;         /* Length of compression buffer */
-   POOLMEM *where;                    /* Root where to restore */
    int replace;                       /* Replace options */
    int buf_size;                      /* length of buffer */
    FF_PKT *ff;                        /* Find Files packet */
@@ -167,63 +220,75 @@ struct s_jcr {
    uint32_t EndFile;
    uint32_t StartBlock;
    uint32_t EndBlock;
+   pthread_t heartbeat_id;            /* id of heartbeat thread */
+   volatile BSOCK *hb_bsock;          /* duped SD socket */
+   volatile BSOCK *hb_dir_bsock;      /* duped DIR socket */
+   POOLMEM *RunAfterJob;              /* Command to run after job */
+   DIRRES* director;                  /* Director resource */
 #endif /* FILE_DAEMON */
 
+
 #ifdef STORAGE_DAEMON
    /* Storage Daemon specific part of JCR */
-   struct s_jcr *next_dev;            /* next JCR attached to device */
-   struct s_jcr *prev_dev;            /* previous JCR attached to device */
+   JCR *next_dev;                     /* next JCR attached to device */
+   JCR *prev_dev;                     /* previous JCR attached to device */
    pthread_cond_t job_start_wait;     /* Wait for FD to start Job */
    int type;
-   DEVRES *device;                    /* device to use */
-   VOLUME_CAT_INFO VolCatInfo;        /* Catalog info for desired volume */
+   DCR *dcr;                          /* device context record */
+   alist *dcrs;                       /* list of dcrs open */
    POOLMEM *job_name;                 /* base Job name (not unique) */
    POOLMEM *fileset_name;             /* FileSet */
    POOLMEM *fileset_md5;              /* MD5 for FileSet */
-   POOLMEM *pool_name;                /* pool to use */
-   POOLMEM *pool_type;                /* pool type to use */
-   POOLMEM *media_type;               /* media type */
-   POOLMEM *dev_name;                 /* device name */
    VOL_LIST *VolList;                 /* list to read */
-   long NumVolumes;                   /* number of volumes used */
-   long CurVolume;                    /* current volume number */
-   int mode;                          /* manual/auto run */
-   int spool_attributes;              /* set if spooling attributes */
-   int no_attributes;                 /* set if no attributes wanted */
-   int label_status;                  /* device volume label status */
+   int32_t NumVolumes;                /* number of volumes used */
+   int32_t CurVolume;                 /* current volume number */
    int label_errors;                  /* count of label errors */
-   int session_opened;
-   DEV_RECORD rec;                    /* Read/Write record */
+   bool session_opened;
    long Ticket;                       /* ticket for this job */
-   uint32_t VolFirstFile;             /* First file index this Volume */
-   uint32_t FileIndex;                /* Current File Index */
-   uint32_t EndFile;                  /* End file written */
-   uint32_t StartFile;                /* Start write file */
-   uint32_t StartBlock;               /* Start write block */
-   uint32_t EndBlock;                 /* Ending block written */
+   bool ignore_label_errors;          /* ignore Volume label errors */
+   bool spool_attributes;             /* set if spooling attributes */
+   bool no_attributes;                /* set if no attributes wanted */
+   bool spool_data;                   /* set to spool data */
+   int CurVol;                        /* Current Volume count */
+   DIRRES* director;                  /* Director resource */
+   bool write_part_after_job;         /* Set to write part after job */
+   bool NewVolEachJob;                /* Allow using new volume */
+   
    uint32_t FileId;                   /* Last file id inserted */
 
    /* Parmaters for Open Read Session */
    BSR *bsr;                          /* Bootstrap record -- has everything */
+   bool mount_next_volume;            /* set to cause next volume mount */
    uint32_t read_VolSessionId;
    uint32_t read_VolSessionTime;
    uint32_t read_StartFile;
    uint32_t read_EndFile;
    uint32_t read_StartBlock;
    uint32_t read_EndBlock;
+   /* Device wait times */
+   int min_wait;
+   int max_wait;
+   int max_num_wait;
+   int wait_sec;
+   int rem_wait_sec;
+   int num_wait;
 
 #endif /* STORAGE_DAEMON */
 
-}; 
+};
+
+
 
-/* 
+/*
  * Structure for all daemons that keeps some summary
  *  info on the last job run.
  */
 struct s_last_job {
-   int NumJobs;
+   dlink link;
+   int Errors;                        /* FD/SD errors */
    int JobType;
    int JobStatus;
+   int JobLevel;
    uint32_t JobId;
    uint32_t VolSessionId;
    uint32_t VolSessionTime;
@@ -235,12 +300,11 @@ struct s_last_job {
 };
 
 extern struct s_last_job last_job;
-
-#undef JCR
-typedef struct s_jcr JCR;
+extern dlist *last_jobs;
 
 
 /* The following routines are found in lib/jcr.c */
+extern bool init_jcr_subsystem(void);
 extern JCR *new_jcr(int size, JCR_free_HANDLER *daemon_free_jcr);
 extern void free_locked_jcr(JCR *jcr);
 extern JCR *get_jcr_by_id(uint32_t JobId);
@@ -248,11 +312,20 @@ extern JCR *get_jcr_by_session(uint32_t SessionId, uint32_t SessionTime);
 extern JCR *get_jcr_by_partial_name(char *Job);
 extern JCR *get_jcr_by_full_name(char *Job);
 extern JCR *get_next_jcr(JCR *jcr);
+extern void set_jcr_job_status(JCR *jcr, int JobStatus);
+
+#ifdef TRACE_JCR_CHAIN
+extern void b_lock_jcr_chain(const char *filen, int line);
+extern void b_unlock_jcr_chain(const char *filen, int line);
+#define lock_jcr_chain() b_lock_jcr_chain(__FILE__, __LINE__);
+#define unlock_jcr_chain() b_unlock_jcr_chain(__FILE__, __LINE__);
+#else
 extern void lock_jcr_chain();
 extern void unlock_jcr_chain();
+#endif
 
 #ifdef DEBUG
-extern void b_free_jcr(char *file, int line, JCR *jcr);
+extern void b_free_jcr(const char *file, int line, JCR *jcr);
 #define free_jcr(jcr) b_free_jcr(__FILE__, __LINE__, (jcr))
 #else
 extern void free_jcr(JCR *jcr);