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