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-2008 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 two of the GNU 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 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
  70 /*
  71  * This packet is used for file save info transfer.
  72 */
  73 struct save_pkt {
  74    int32_t pkt_size;                  /* size of this packet */
  75    char *fname;                       /* Full path and filename */
  76    char *link;                        /* Link name if any */
  77    struct stat statp;                 /* System stat() packet for file */
  78    int32_t type;                      /* FT_xx for this file */
  79    uint32_t flags;                    /* Bacula internal flags */
  80    bool portable;                     /* set if data format is portable */
  81    char *cmd;                         /* command */
  82    int32_t pkt_end;                   /* end packet sentinel */
  83 };
  84
  85 /*
  86  * This packet is used for file restore info transfer.
  87 */
  88 struct restore_pkt {
  89    int32_t pkt_size;                  /* size of this packet */
  90    int32_t stream;                    /* attribute stream id */
  91    int32_t data_stream;               /* id of data stream to follow */
  92    int32_t type;                      /* file type FT */
  93    int32_t file_index;                /* file index */
  94    int32_t LinkFI;                    /* file index to data if hard link */
  95    uid_t uid;                         /* userid */
  96    struct stat statp;                 /* decoded stat packet */
  97    const char *attrEx;                /* extended attributes if any */
  98    const char *ofname;                /* output filename */
  99    const char *olname;                /* output link name */
 100    const char *where;                 /* where */
 101    const char *RegexWhere;            /* regex where */
 102    int replace;                       /* replace flag */
 103    int create_status;                 /* status from createFile() */
 104    int32_t pkt_end;                   /* end packet sentinel */
 105 };
 106
 107 enum {
 108    IO_OPEN = 1,
 109    IO_READ = 2,
 110    IO_WRITE = 3,
 111    IO_CLOSE = 4,
 112    IO_SEEK = 5
 113 };
 114
 115 struct io_pkt {
 116    int32_t pkt_size;                  /* Size of this packet */
 117    int32_t func;                      /* Function code */
 118    int32_t count;                     /* read/write count */
 119    int32_t flags;                     /* Open flags */
 120    mode_t mode;                       /* permissions for created files */
 121    char *buf;                         /* read/write buffer */
 122    const char *fname;                 /* open filename */
 123    int32_t status;                    /* return status */
 124    int32_t io_errno;                  /* errno code */
 125    int32_t lerror;                    /* Win32 error code */
 126    int32_t whence;                    /* lseek argument */
 127    boffset_t offset;                  /* lseek argument */
 128    bool win32;                        /* Win32 GetLastError returned */
 129    int32_t pkt_end;                   /* end packet sentinel */
 130 };
 131
 132 /****************************************************************************
 133  *                                                                          *
 134  *                Bacula definitions                                        *
 135  *                                                                          *
 136  ****************************************************************************/
 137
 138 /* Bacula Variable Ids */
 139 typedef enum {
 140   bVarJobId     = 1,
 141   bVarFDName    = 2,
 142   bVarLevel     = 3,
 143   bVarType      = 4,
 144   bVarClient    = 5,
 145   bVarJobName   = 6,
 146   bVarJobStatus = 7,
 147   bVarSinceTime = 8
 148 } bVariable;
 149
 150 /* Events that are passed to plugin */
 151 typedef enum {
 152   bEventJobStart        = 1,
 153   bEventJobEnd          = 2,
 154   bEventStartBackupJob  = 3,
 155   bEventEndBackupJob    = 4,
 156   bEventStartRestoreJob = 5,
 157   bEventEndRestoreJob   = 6,
 158   bEventStartVerifyJob  = 7,
 159   bEventEndVerifyJob    = 8,
 160   bEventBackupCommand   = 9,
 161   bEventRestoreCommand  = 10,
 162   bEventLevel           = 11,
 163   bEventSince           = 12,
 164   bEventCancelCommand   = 13,
 165 } bEventType;
 166
 167 typedef struct s_bEvent {
 168    uint32_t eventType;
 169 } bEvent;
 170
 171 typedef struct s_baculaInfo {
 172    uint32_t size;
 173    uint32_t version;
 174 } bInfo;
 175
 176 /* Bacula Core Routines -- not used within a plugin */
 177 #ifdef FILE_DAEMON
 178 struct BFILE;                   /* forward referenced */
 179 struct FF_PKT;
 180 void load_fd_plugins(const char *plugin_dir);
 181 void new_plugins(JCR *jcr);
 182 void free_plugins(JCR *jcr);
 183 void generate_plugin_event(JCR *jcr, bEventType event, void *value=NULL);
 184 bool send_plugin_name(JCR *jcr, BSOCK *sd, bool start);
 185 bool plugin_name_stream(JCR *jcr, char *name);
 186 int plugin_create_file(JCR *jcr, ATTR *attr, BFILE *bfd, int replace);
 187 bool plugin_set_attributes(JCR *jcr, ATTR *attr, BFILE *ofd);
 188 int plugin_save(JCR *jcr, FF_PKT *ff_pkt, bool top_level);
 189 #endif
 190
 191 #ifdef __cplusplus
 192 extern "C" {
 193 #endif
 194
 195 /*
 196  * Bacula interface version and function pointers --
 197  *  i.e. callbacks from the plugin to Bacula
 198  */
 199 typedef struct s_baculaFuncs {
 200    uint32_t size;
 201    uint32_t version;
 202    bRC (*registerBaculaEvents)(bpContext *ctx, ...);
 203    bRC (*getBaculaValue)(bpContext *ctx, bVariable var, void *value);
 204    bRC (*setBaculaValue)(bpContext *ctx, bVariable var, void *value);
 205    bRC (*JobMessage)(bpContext *ctx, const char *file, int line,
 206        int type, utime_t mtime, const char *fmt, ...);
 207    bRC (*DebugMessage)(bpContext *ctx, const char *file, int line,
 208        int level, const char *fmt, ...);
 209    void *(*baculaMalloc)(bpContext *ctx, const char *file, int line,
 210        size_t size);
 211    void (*baculaFree)(bpContext *ctx, const char *file, int line, void *mem);
 212 } bFuncs;
 213
 214
 215
 216
 217 /****************************************************************************
 218  *                                                                          *
 219  *                Plugin definitions                                        *
 220  *                                                                          *
 221  ****************************************************************************/
 222
 223 typedef enum {
 224   pVarName = 1,
 225   pVarDescription = 2
 226 } pVariable;
 227
 228
 229 #define FD_PLUGIN_MAGIC     "*FDPluginData*"
 230 #define FD_PLUGIN_INTERFACE_VERSION  2
 231
 232 typedef struct s_pluginInfo {
 233    uint32_t size;
 234    uint32_t version;
 235    const char *plugin_magic;
 236    const char *plugin_license;
 237    const char *plugin_author;
 238    const char *plugin_date;
 239    const char *plugin_version;
 240    const char *plugin_description;
 241 } pInfo;
 242
 243 /*
 244  * This is a set of function pointers that Bacula can call
 245  *  within the plugin.
 246  */
 247 typedef struct s_pluginFuncs {
 248    uint32_t size;
 249    uint32_t version;
 250    bRC (*newPlugin)(bpContext *ctx);
 251    bRC (*freePlugin)(bpContext *ctx);
 252    bRC (*getPluginValue)(bpContext *ctx, pVariable var, void *value);
 253    bRC (*setPluginValue)(bpContext *ctx, pVariable var, void *value);
 254    bRC (*handlePluginEvent)(bpContext *ctx, bEvent *event, void *value);
 255    bRC (*startBackupFile)(bpContext *ctx, struct save_pkt *sp);
 256    bRC (*endBackupFile)(bpContext *ctx);
 257    bRC (*startRestoreFile)(bpContext *ctx, const char *cmd);
 258    bRC (*endRestoreFile)(bpContext *ctx);
 259    bRC (*pluginIO)(bpContext *ctx, struct io_pkt *io);
 260    bRC (*createFile)(bpContext *ctx, struct restore_pkt *rp);
 261    bRC (*setFileAttributes)(bpContext *ctx, struct restore_pkt *rp);
 262 } pFuncs;
 263
 264 #define plug_func(plugin) ((pFuncs *)(plugin->pfuncs))
 265 #define plug_info(plugin) ((pInfo *)(plugin->pinfo))
 266
 267 #ifdef __cplusplus
 268 }
 269 #endif
 270
 271 #endif /* __FD_PLUGINS_H */