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   bVarWhere      = 14,
 180   bVarRegexWhere = 15
 181 } bVariable;
 182
 183 /* Events that are passed to plugin */
 184 typedef enum {
 185   bEventJobStart                        = 1,
 186   bEventJobEnd                          = 2,
 187   bEventStartBackupJob                  = 3,
 188   bEventEndBackupJob                    = 4,
 189   bEventStartRestoreJob                 = 5,
 190   bEventEndRestoreJob                   = 6,
 191   bEventStartVerifyJob                  = 7,
 192   bEventEndVerifyJob                    = 8,
 193   bEventBackupCommand                   = 9,
 194   bEventRestoreCommand                  = 10,
 195   bEventLevel                           = 11,
 196   bEventSince                           = 12,
 197   bEventCancelCommand                   = 13, /* Executed by an other thread */
 198   bEventVssBackupAddComponents          = 14,
 199   bEventVssRestoreLoadComponentMetadata = 15,
 200   bEventVssRestoreSetComponentsSelected = 16,
 201   bEventRestoreObject                   = 17,
 202   bEventEndFileSet                      = 18,
 203   bEventPluginCommand                   = 19  /* Sent during FileSet creation */
 204 } bEventType;
 205
 206 typedef struct s_bEvent {
 207    uint32_t eventType;
 208 } bEvent;
 209
 210 typedef struct s_baculaInfo {
 211    uint32_t size;
 212    uint32_t version;
 213 } bInfo;
 214
 215 /* Bacula Core Routines -- not used within a plugin */
 216 #ifdef FILE_DAEMON
 217 struct BFILE;                   /* forward referenced */
 218 struct FF_PKT;
 219 void load_fd_plugins(const char *plugin_dir);
 220 void new_plugins(JCR *jcr);
 221 void free_plugins(JCR *jcr);
 222 void generate_plugin_event(JCR *jcr, bEventType event, void *value=NULL);
 223 bool send_plugin_name(JCR *jcr, BSOCK *sd, bool start);
 224 bool plugin_name_stream(JCR *jcr, char *name);
 225 int plugin_create_file(JCR *jcr, ATTR *attr, BFILE *bfd, int replace);
 226 bool plugin_set_attributes(JCR *jcr, ATTR *attr, BFILE *ofd);
 227 int plugin_save(JCR *jcr, FF_PKT *ff_pkt, bool top_level);
 228 bool plugin_check_file(JCR *jcr, char *fname);
 229 #endif
 230
 231 #ifdef __cplusplus
 232 extern "C" {
 233 #endif
 234
 235 /*
 236  * Bacula interface version and function pointers --
 237  *  i.e. callbacks from the plugin to Bacula
 238  */
 239 typedef struct s_baculaFuncs {
 240    uint32_t size;
 241    uint32_t version;
 242    bRC (*registerBaculaEvents)(bpContext *ctx, ...);
 243    bRC (*getBaculaValue)(bpContext *ctx, bVariable var, void *value);
 244    bRC (*setBaculaValue)(bpContext *ctx, bVariable var, void *value);
 245    bRC (*JobMessage)(bpContext *ctx, const char *file, int line,
 246        int type, utime_t mtime, const char *fmt, ...);
 247    bRC (*DebugMessage)(bpContext *ctx, const char *file, int line,
 248        int level, const char *fmt, ...);
 249    void *(*baculaMalloc)(bpContext *ctx, const char *file, int line,
 250        size_t size);
 251    void (*baculaFree)(bpContext *ctx, const char *file, int line, void *mem);
 252    bRC (*AddExclude)(bpContext *ctx, const char *file);
 253    bRC (*AddInclude)(bpContext *ctx, const char *file);
 254    bRC (*AddOptions)(bpContext *ctx, const char *opts);
 255    bRC (*AddRegex)(bpContext *ctx, const char *item, int type);
 256    bRC (*AddWild)(bpContext *ctx, const char *item, int type);
 257    bRC (*NewOptions)(bpContext *ctx);
 258    bRC (*NewInclude)(bpContext *ctx);
 259    bRC (*checkChanges)(bpContext *ctx, struct save_pkt *sp);
 260 } bFuncs;
 261
 262
 263
 264
 265 /****************************************************************************
 266  *                                                                          *
 267  *                Plugin definitions                                        *
 268  *                                                                          *
 269  ****************************************************************************/
 270
 271 typedef enum {
 272   pVarName = 1,
 273   pVarDescription = 2
 274 } pVariable;
 275
 276
 277 #define FD_PLUGIN_MAGIC     "*FDPluginData*"
 278 #define FD_PLUGIN_INTERFACE_VERSION  5
 279
 280 typedef struct s_pluginInfo {
 281    uint32_t size;
 282    uint32_t version;
 283    const char *plugin_magic;
 284    const char *plugin_license;
 285    const char *plugin_author;
 286    const char *plugin_date;
 287    const char *plugin_version;
 288    const char *plugin_description;
 289 } pInfo;
 290
 291 /*
 292  * This is a set of function pointers that Bacula can call
 293  *  within the plugin.
 294  */
 295 typedef struct s_pluginFuncs {
 296    uint32_t size;
 297    uint32_t version;
 298    bRC (*newPlugin)(bpContext *ctx);
 299    bRC (*freePlugin)(bpContext *ctx);
 300    bRC (*getPluginValue)(bpContext *ctx, pVariable var, void *value);
 301    bRC (*setPluginValue)(bpContext *ctx, pVariable var, void *value);
 302    bRC (*handlePluginEvent)(bpContext *ctx, bEvent *event, void *value);
 303    bRC (*startBackupFile)(bpContext *ctx, struct save_pkt *sp);
 304    bRC (*endBackupFile)(bpContext *ctx);
 305    bRC (*startRestoreFile)(bpContext *ctx, const char *cmd);
 306    bRC (*endRestoreFile)(bpContext *ctx);
 307    bRC (*pluginIO)(bpContext *ctx, struct io_pkt *io);
 308    bRC (*createFile)(bpContext *ctx, struct restore_pkt *rp);
 309    bRC (*setFileAttributes)(bpContext *ctx, struct restore_pkt *rp);
 310    bRC (*checkFile)(bpContext *ctx, char *fname);
 311 } pFuncs;
 312
 313 #define plug_func(plugin) ((pFuncs *)(plugin->pfuncs))
 314 #define plug_info(plugin) ((pInfo *)(plugin->pinfo))
 315
 316 #ifdef __cplusplus
 317 }
 318 #endif
 319
 320 #endif /* __FD_PLUGINS_H */