git.sur5r.net Git - bacula/bacula/blob - bacula/src/filed/fd_plugins.h

   1 /*
   2    Bacula® - The Network Backup Solution
   3
   4    Copyright (C) 2007-2008 Free Software Foundation Europe e.V.
   5
   6    The main author of Bacula is Kern Sibbald, with contributions from
   7    many others, a complete list can be found in the file AUTHORS.
   8    This program is Free Software; you can redistribute it and/or
   9    modify it under the terms of version two of the GNU General Public
  10    License as published by the Free Software Foundation, which is
  11    listed in the file LICENSE.
  12
  13    This program is distributed in the hope that it will be useful, but
  14    WITHOUT ANY WARRANTY; without even the implied warranty of
  15    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  16    General Public License for more details.
  17
  18    You should have received a copy of the GNU General Public License
  19    along with this program; if not, write to the Free Software
  20    Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  21    02110-1301, USA.
  22
  23    Bacula® is a registered trademark of John Walker.
  24    The licensor of Bacula is the Free Software Foundation Europe
  25    (FSFE), Fiduciary Program, Sumatrastrasse 25, 8006 Zürich,
  26    Switzerland, email:ftf@fsfeurope.org.
  27 */
  28 /*
  29  * Application Programming Interface (API) definition for Bacula Plugins
  30  *
  31  * Kern Sibbald, October 2007
  32  *
  33  */
  34
  35 #ifndef __FD_PLUGINS_H
  36 #define __FD_PLUGINS_H
  37
  38 #ifndef _BACULA_H
  39 #ifdef __cplusplus
  40 /* Workaround for SGI IRIX 6.5 */
  41 #define _LANGUAGE_C_PLUS_PLUS 1
  42 #endif
  43 #define _REENTRANT    1
  44 #define _THREAD_SAFE  1
  45 #define _POSIX_PTHREAD_SEMANTICS 1
  46 #define _FILE_OFFSET_BITS 64
  47 #define _LARGEFILE_SOURCE 1
  48 #define _LARGE_FILES 1
  49 #endif
  50
  51 #include <sys/types.h>
  52 #ifndef __CONFIG_H
  53 #define __CONFIG_H
  54 #include "config.h"
  55 #endif
  56 #include "bc_types.h"
  57 #include "lib/plugins.h"
  58 #include <sys/stat.h>
  59
  60 /*
  61  * This packet is used for file save info transfer.
  62 */
  63 struct save_pkt {
  64   char *fname;                        /* Full path and filename */
  65   char *link;                         /* Link name if any */
  66   struct stat statp;                  /* System stat() packet for file */
  67   int32_t type;                       /* FT_xx for this file */
  68   uint32_t flags;                     /* Bacula internal flags */
  69   bool portable;                      /* set if data format is portable */
  70   char *cmd;                          /* command */
  71 };
  72
  73 /*
  74  * This packet is used for file restore info transfer.
  75 */
  76 struct restore_pkt {
  77    int32_t stream;                    /* attribute stream id */
  78    int32_t data_stream;               /* id of data stream to follow */
  79    int32_t type;                      /* file type FT */
  80    int32_t file_index;                /* file index */
  81    int32_t LinkFI;                    /* file index to data if hard link */
  82    uid_t uid;                         /* userid */
  83    struct stat statp;                 /* decoded stat packet */
  84    const char *attrEx;                /* extended attributes if any */
  85    const char *ofname;                /* output filename */
  86    const char *olname;                /* output link name */
  87    const char *where;                 /* where */
  88    const char *RegexWhere;            /* regex where */
  89    int replace;                       /* replace flag */
  90 };
  91
  92 enum {
  93    IO_OPEN = 1,
  94    IO_READ = 2,
  95    IO_WRITE = 3,
  96    IO_CLOSE = 4,
  97    IO_SEEK = 5
  98 };
  99
 100 struct io_pkt {
 101    int32_t func;                      /* Function code */
 102    int32_t count;                     /* read/write count */
 103    mode_t mode;                       /* permissions for created files */
 104    int32_t flags;                     /* open flags (e.g. O_WRONLY ...) */
 105    char *buf;                         /* read/write buffer */
 106    int32_t status;                    /* return status */
 107    int32_t io_errno;                  /* errno code */
 108    int32_t whence;
 109    boffset_t offset;
 110 };
 111
 112 /****************************************************************************
 113  *                                                                          *
 114  *                Bacula definitions                                        *
 115  *                                                                          *
 116  ****************************************************************************/
 117
 118 /* Bacula Variable Ids */
 119 typedef enum {
 120   bVarJobId     = 1,
 121   bVarFDName    = 2,
 122   bVarLevel     = 3,
 123   bVarType      = 4,
 124   bVarClient    = 5,
 125   bVarJobName   = 6,
 126   bVarJobStatus = 7,
 127   bVarSinceTime = 8
 128 } bVariable;
 129
 130 typedef enum {
 131   bEventJobStart        = 1,
 132   bEventJobEnd          = 2,
 133   bEventStartBackupJob  = 3,
 134   bEventEndBackupJob    = 4,
 135   bEventStartRestoreJob = 5,
 136   bEventEndRestoreJob   = 6,
 137   bEventStartVerifyJob  = 7,
 138   bEventEndVerifyJob    = 8,
 139   bEventBackupCommand   = 9,
 140   bEventRestoreCommand  = 10,
 141   bEventLevel           = 11,
 142   bEventSince           = 12,
 143 } bEventType;
 144
 145 typedef struct s_bEvent {
 146    uint32_t eventType;
 147 } bEvent;
 148
 149 typedef struct s_baculaInfo {
 150    uint32_t size;
 151    uint32_t version;
 152 } bInfo;
 153
 154 /* Bacula Core Routines -- not used by plugins */
 155 struct BFILE;                   /* forward referenced */
 156 struct FF_PKT;
 157 void load_fd_plugins(const char *plugin_dir);
 158 void new_plugins(JCR *jcr);
 159 void free_plugins(JCR *jcr);
 160 void generate_plugin_event(JCR *jcr, bEventType event, void *value=NULL);
 161 bool send_plugin_name(JCR *jcr, BSOCK *sd, bool start);
 162 void plugin_name_stream(JCR *jcr, char *name);
 163 int plugin_create_file(JCR *jcr, ATTR *attr, BFILE *bfd, int replace);
 164 bool plugin_set_attributes(JCR *jcr, ATTR *attr, BFILE *ofd);
 165 int plugin_save(JCR *jcr, FF_PKT *ff_pkt, bool top_level);
 166
 167 #ifdef __cplusplus
 168 extern "C" {
 169 #endif
 170
 171 /*
 172  * Bacula interface version and function pointers --
 173  *  i.e. callbacks from the plugin to Bacula
 174  */
 175 typedef struct s_baculaFuncs {
 176    uint32_t size;
 177    uint32_t version;
 178    bRC (*registerBaculaEvents)(bpContext *ctx, ...);
 179    bRC (*getBaculaValue)(bpContext *ctx, bVariable var, void *value);
 180    bRC (*setBaculaValue)(bpContext *ctx, bVariable var, void *value);
 181    bRC (*JobMessage)(bpContext *ctx, const char *file, int line,
 182        int type, time_t mtime, const char *fmt, ...);
 183    bRC (*DebugMessage)(bpContext *ctx, const char *file, int line,
 184        int level, const char *fmt, ...);
 185 } bFuncs;
 186
 187
 188
 189
 190 /****************************************************************************
 191  *                                                                          *
 192  *                Plugin definitions                                        *
 193  *                                                                          *
 194  ****************************************************************************/
 195
 196 typedef enum {
 197   pVarName = 1,
 198   pVarDescription = 2
 199 } pVariable;
 200
 201
 202 #define FD_PLUGIN_MAGIC     "*FDPluginData*"
 203 #define FD_PLUGIN_INTERFACE_VERSION  1
 204
 205 typedef struct s_pluginInfo {
 206    uint32_t size;
 207    uint32_t version;
 208    char *plugin_magic;
 209    char *plugin_license;
 210    char *plugin_author;
 211    char *plugin_date;
 212    char *plugin_version;
 213    char *plugin_description;
 214 } pInfo;
 215
 216 /*
 217  * This is a set of function pointers that Bacula can call
 218  *  within the plugin.
 219  */
 220 typedef struct s_pluginFuncs {
 221    uint32_t size;
 222    uint32_t version;
 223    bRC (*newPlugin)(bpContext *ctx);
 224    bRC (*freePlugin)(bpContext *ctx);
 225    bRC (*getPluginValue)(bpContext *ctx, pVariable var, void *value);
 226    bRC (*setPluginValue)(bpContext *ctx, pVariable var, void *value);
 227    bRC (*handlePluginEvent)(bpContext *ctx, bEvent *event, void *value);
 228    bRC (*startBackupFile)(bpContext *ctx, struct save_pkt *sp);
 229    bRC (*endBackupFile)(bpContext *ctx);
 230    bRC (*startRestoreFile)(bpContext *ctx, const char *cmd);
 231    bRC (*endRestoreFile)(bpContext *ctx);
 232    bRC (*pluginIO)(bpContext *ctx, struct io_pkt *io);
 233    bRC (*createFile)(bpContext *ctx, struct restore_pkt *rp);
 234    bRC (*setFileAttributes)(bpContext *ctx, struct restore_pkt *rp);
 235 } pFuncs;
 236
 237 #define plug_func(plugin) ((pFuncs *)(plugin->pfuncs))
 238 #define plug_info(plugin) ((pInfo *)(plugin->pinfo))
 239
 240 #ifdef __cplusplus
 241 }
 242 #endif
 243
 244 #endif /* __FD_PLUGINS_H */