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