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