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-2010 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 Kern Sibbald.
  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  /* ! _BACULA_H */
  50
  51 #include <sys/types.h>
  52
  53 #if defined(HAVE_WIN32)
  54 #if defined(HAVE_MINGW)
  55 #include "mingwconfig.h"
  56 #else
  57 #include "winconfig.h"
  58 #endif
  59 #else  /* !HAVE_WIN32 */
  60 #ifndef __CONFIG_H
  61 #include "config.h"
  62 #define __CONFIG_H
  63 #endif
  64 #endif
  65
  66 #include "bc_types.h"
  67 #include "lib/plugins.h"
  68 #include <sys/stat.h>
  69 #ifdef HAVE_WIN32
  70 #include "../win32/filed/vss.h"
  71 #endif
  72
  73 /*
  74  * This packet is used for the restore objects
  75  *  It is passed to the plugin when restoring
  76  *  the object.
  77  */
  78 struct restore_object_pkt {
  79    int32_t pkt_size;                  /* size of this packet */
  80    char *object_name;                 /* Object name */
  81    char *object;                      /* restore object data to save */
  82    int32_t object_type;               /* FT_xx for this file */
  83    int32_t object_len;                /* restore object length */
  84    int32_t object_index;              /* restore object index */
  85    int32_t stream;                    /* attribute stream id */
  86    uint32_t JobId;                    /* JobId object came from */
  87    int32_t pkt_end;                   /* end packet sentinel */
  88 };
  89
  90 /*
  91  * This packet is used for file save info transfer.
  92 */
  93 struct save_pkt {
  94    int32_t pkt_size;                  /* size of this packet */
  95    char *fname;                       /* Full path and filename */
  96    char *link;                        /* Link name if any */
  97    struct stat statp;                 /* System stat() packet for file */
  98    int32_t type;                      /* FT_xx for this file */
  99    uint32_t flags;                    /* Bacula internal flags */
 100    bool portable;                     /* set if data format is portable */
 101    char *cmd;                         /* command */
 102    char *object;                      /* restore object data to save */
 103    int32_t object_len;                /* restore object length */
 104    int32_t index;                     /* restore object index */
 105    int32_t pkt_end;                   /* end packet sentinel */
 106 };
 107
 108 /*
 109  * This packet is used for file restore info transfer.
 110 */
 111 struct restore_pkt {
 112    int32_t pkt_size;                  /* size of this packet */
 113    int32_t stream;                    /* attribute stream id */
 114    int32_t data_stream;               /* id of data stream to follow */
 115    int32_t type;                      /* file type FT */
 116    int32_t file_index;                /* file index */
 117    int32_t LinkFI;                    /* file index to data if hard link */
 118    uid_t uid;                         /* userid */
 119    struct stat statp;                 /* decoded stat packet */
 120    const char *attrEx;                /* extended attributes if any */
 121    const char *ofname;                /* output filename */
 122    const char *olname;                /* output link name */
 123    const char *where;                 /* where */
 124    const char *RegexWhere;            /* regex where */
 125    int replace;                       /* replace flag */
 126    int create_status;                 /* status from createFile() */
 127    int32_t pkt_end;                   /* end packet sentinel */
 128 };
 129
 130 enum {
 131    IO_OPEN = 1,
 132    IO_READ = 2,
 133    IO_WRITE = 3,
 134    IO_CLOSE = 4,
 135    IO_SEEK = 5
 136 };
 137
 138 struct io_pkt {
 139    int32_t pkt_size;                  /* Size of this packet */
 140    int32_t func;                      /* Function code */
 141    int32_t count;                     /* read/write count */
 142    int32_t flags;                     /* Open flags */
 143    mode_t mode;                       /* permissions for created files */
 144    char *buf;                         /* read/write buffer */
 145    const char *fname;                 /* open filename */
 146    int32_t status;                    /* return status */
 147    int32_t io_errno;                  /* errno code */
 148    int32_t lerror;                    /* Win32 error code */
 149    int32_t whence;                    /* lseek argument */
 150    boffset_t offset;                  /* lseek argument */
 151    bool win32;                        /* Win32 GetLastError returned */
 152    int32_t pkt_end;                   /* end packet sentinel */
 153 };
 154
 155 /****************************************************************************
 156  *                                                                          *
 157  *                Bacula definitions                                        *
 158  *                                                                          *
 159  ****************************************************************************/
 160
 161 /* Bacula Variable Ids */
 162 typedef enum {
 163   bVarJobId     = 1,
 164   bVarFDName    = 2,
 165   bVarLevel     = 3,
 166   bVarType      = 4,
 167   bVarClient    = 5,
 168   bVarJobName   = 6,
 169   bVarJobStatus = 7,
 170   bVarSinceTime = 8,
 171   bVarAccurate  = 9,
 172   bVarFileSeen  = 10,
 173   bVarVssObject = 11,
 174   bVarVssDllHandle = 12
 175 } bVariable;
 176
 177 /* Events that are passed to plugin */
 178 typedef enum {
 179   bEventJobStart                        = 1,
 180   bEventJobEnd                          = 2,
 181   bEventStartBackupJob                  = 3,
 182   bEventEndBackupJob                    = 4,
 183   bEventStartRestoreJob                 = 5,
 184   bEventEndRestoreJob                   = 6,
 185   bEventStartVerifyJob                  = 7,
 186   bEventEndVerifyJob                    = 8,
 187   bEventBackupCommand                   = 9,
 188   bEventRestoreCommand                  = 10,
 189   bEventLevel                           = 11,
 190   bEventSince                           = 12,
 191   bEventCancelCommand                   = 13,
 192   bEventVssBackupAddComponents          = 14,
 193   bEventVssRestoreLoadComponentMetadata = 15,
 194   bEventVssRestoreSetComponentsSelected = 16,
 195   bEventRestoreObject                   = 17,
 196 } bEventType;
 197
 198 typedef struct s_bEvent {
 199    uint32_t eventType;
 200 } bEvent;
 201
 202 typedef struct s_baculaInfo {
 203    uint32_t size;
 204    uint32_t version;
 205 } bInfo;
 206
 207 /* Bacula Core Routines -- not used within a plugin */
 208 #ifdef FILE_DAEMON
 209 struct BFILE;                   /* forward referenced */
 210 struct FF_PKT;
 211 void load_fd_plugins(const char *plugin_dir);
 212 void new_plugins(JCR *jcr);
 213 void free_plugins(JCR *jcr);
 214 void generate_plugin_event(JCR *jcr, bEventType event, void *value=NULL);
 215 bool send_plugin_name(JCR *jcr, BSOCK *sd, bool start);
 216 bool plugin_name_stream(JCR *jcr, char *name);
 217 int plugin_create_file(JCR *jcr, ATTR *attr, BFILE *bfd, int replace);
 218 bool plugin_set_attributes(JCR *jcr, ATTR *attr, BFILE *ofd);
 219 int plugin_save(JCR *jcr, FF_PKT *ff_pkt, bool top_level);
 220 bool plugin_check_file(JCR *jcr, char *fname);
 221 #endif
 222
 223 #ifdef __cplusplus
 224 extern "C" {
 225 #endif
 226
 227 /*
 228  * Bacula interface version and function pointers --
 229  *  i.e. callbacks from the plugin to Bacula
 230  */
 231 typedef struct s_baculaFuncs {
 232    uint32_t size;
 233    uint32_t version;
 234    bRC (*registerBaculaEvents)(bpContext *ctx, ...);
 235    bRC (*getBaculaValue)(bpContext *ctx, bVariable var, void *value);
 236    bRC (*setBaculaValue)(bpContext *ctx, bVariable var, void *value);
 237    bRC (*JobMessage)(bpContext *ctx, const char *file, int line,
 238        int type, utime_t mtime, const char *fmt, ...);
 239    bRC (*DebugMessage)(bpContext *ctx, const char *file, int line,
 240        int level, const char *fmt, ...);
 241    void *(*baculaMalloc)(bpContext *ctx, const char *file, int line,
 242        size_t size);
 243    void (*baculaFree)(bpContext *ctx, const char *file, int line, void *mem);
 244    bRC (*AddExclude)(bpContext *ctx, const char *file);
 245 } bFuncs;
 246
 247
 248
 249
 250 /****************************************************************************
 251  *                                                                          *
 252  *                Plugin definitions                                        *
 253  *                                                                          *
 254  ****************************************************************************/
 255
 256 typedef enum {
 257   pVarName = 1,
 258   pVarDescription = 2
 259 } pVariable;
 260
 261
 262 #define FD_PLUGIN_MAGIC     "*FDPluginData*"
 263 #define FD_PLUGIN_INTERFACE_VERSION  4
 264
 265 typedef struct s_pluginInfo {
 266    uint32_t size;
 267    uint32_t version;
 268    const char *plugin_magic;
 269    const char *plugin_license;
 270    const char *plugin_author;
 271    const char *plugin_date;
 272    const char *plugin_version;
 273    const char *plugin_description;
 274 } pInfo;
 275
 276 /*
 277  * This is a set of function pointers that Bacula can call
 278  *  within the plugin.
 279  */
 280 typedef struct s_pluginFuncs {
 281    uint32_t size;
 282    uint32_t version;
 283    bRC (*newPlugin)(bpContext *ctx);
 284    bRC (*freePlugin)(bpContext *ctx);
 285    bRC (*getPluginValue)(bpContext *ctx, pVariable var, void *value);
 286    bRC (*setPluginValue)(bpContext *ctx, pVariable var, void *value);
 287    bRC (*handlePluginEvent)(bpContext *ctx, bEvent *event, void *value);
 288    bRC (*startBackupFile)(bpContext *ctx, struct save_pkt *sp);
 289    bRC (*endBackupFile)(bpContext *ctx);
 290    bRC (*startRestoreFile)(bpContext *ctx, const char *cmd);
 291    bRC (*endRestoreFile)(bpContext *ctx);
 292    bRC (*pluginIO)(bpContext *ctx, struct io_pkt *io);
 293    bRC (*createFile)(bpContext *ctx, struct restore_pkt *rp);
 294    bRC (*setFileAttributes)(bpContext *ctx, struct restore_pkt *rp);
 295    bRC (*checkFile)(bpContext *ctx, char *fname);
 296 } pFuncs;
 297
 298 #define plug_func(plugin) ((pFuncs *)(plugin->pfuncs))
 299 #define plug_info(plugin) ((pInfo *)(plugin->pinfo))
 300
 301 #ifdef __cplusplus
 302 }
 303 #endif
 304
 305 #endif /* __FD_PLUGINS_H */