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