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