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