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
  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
  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 typedef enum {
 151   bEventJobStart        = 1,
 152   bEventJobEnd          = 2,
 153   bEventStartBackupJob  = 3,
 154   bEventEndBackupJob    = 4,
 155   bEventStartRestoreJob = 5,
 156   bEventEndRestoreJob   = 6,
 157   bEventStartVerifyJob  = 7,
 158   bEventEndVerifyJob    = 8,
 159   bEventBackupCommand   = 9,
 160   bEventRestoreCommand  = 10,
 161   bEventLevel           = 11,
 162   bEventSince           = 12,
 163   bEventCancelCommand   = 13,
 164 } bEventType;
 165
 166 typedef struct s_bEvent {
 167    uint32_t eventType;
 168 } bEvent;
 169
 170 typedef struct s_baculaInfo {
 171    uint32_t size;
 172    uint32_t version;
 173 } bInfo;
 174
 175 /* Bacula Core Routines -- not used within a plugin */
 176 #ifdef FILE_DAEMON
 177 struct BFILE;                   /* forward referenced */
 178 struct FF_PKT;
 179 void load_fd_plugins(const char *plugin_dir);
 180 void new_plugins(JCR *jcr);
 181 void free_plugins(JCR *jcr);
 182 void generate_plugin_event(JCR *jcr, bEventType event, void *value=NULL);
 183 bool send_plugin_name(JCR *jcr, BSOCK *sd, bool start);
 184 bool plugin_name_stream(JCR *jcr, char *name);
 185 int plugin_create_file(JCR *jcr, ATTR *attr, BFILE *bfd, int replace);
 186 bool plugin_set_attributes(JCR *jcr, ATTR *attr, BFILE *ofd);
 187 int plugin_save(JCR *jcr, FF_PKT *ff_pkt, bool top_level);
 188 #endif
 189
 190 #ifdef __cplusplus
 191 extern "C" {
 192 #endif
 193
 194 /*
 195  * Bacula interface version and function pointers --
 196  *  i.e. callbacks from the plugin to Bacula
 197  */
 198 typedef struct s_baculaFuncs {
 199    uint32_t size;
 200    uint32_t version;
 201    bRC (*registerBaculaEvents)(bpContext *ctx, ...);
 202    bRC (*getBaculaValue)(bpContext *ctx, bVariable var, void *value);
 203    bRC (*setBaculaValue)(bpContext *ctx, bVariable var, void *value);
 204    bRC (*JobMessage)(bpContext *ctx, const char *file, int line,
 205        int type, time_t mtime, const char *fmt, ...);
 206    bRC (*DebugMessage)(bpContext *ctx, const char *file, int line,
 207        int level, const char *fmt, ...);
 208 } bFuncs;
 209
 210
 211
 212
 213 /****************************************************************************
 214  *                                                                          *
 215  *                Plugin definitions                                        *
 216  *                                                                          *
 217  ****************************************************************************/
 218
 219 typedef enum {
 220   pVarName = 1,
 221   pVarDescription = 2
 222 } pVariable;
 223
 224
 225 #define FD_PLUGIN_MAGIC     "*FDPluginData*"
 226 #define FD_PLUGIN_INTERFACE_VERSION  1
 227
 228 typedef struct s_pluginInfo {
 229    uint32_t size;
 230    uint32_t version;
 231    const char *plugin_magic;
 232    const char *plugin_license;
 233    const char *plugin_author;
 234    const char *plugin_date;
 235    const char *plugin_version;
 236    const char *plugin_description;
 237 } pInfo;
 238
 239 /*
 240  * This is a set of function pointers that Bacula can call
 241  *  within the plugin.
 242  */
 243 typedef struct s_pluginFuncs {
 244    uint32_t size;
 245    uint32_t version;
 246    bRC (*newPlugin)(bpContext *ctx);
 247    bRC (*freePlugin)(bpContext *ctx);
 248    bRC (*getPluginValue)(bpContext *ctx, pVariable var, void *value);
 249    bRC (*setPluginValue)(bpContext *ctx, pVariable var, void *value);
 250    bRC (*handlePluginEvent)(bpContext *ctx, bEvent *event, void *value);
 251    bRC (*startBackupFile)(bpContext *ctx, struct save_pkt *sp);
 252    bRC (*endBackupFile)(bpContext *ctx);
 253    bRC (*startRestoreFile)(bpContext *ctx, const char *cmd);
 254    bRC (*endRestoreFile)(bpContext *ctx);
 255    bRC (*pluginIO)(bpContext *ctx, struct io_pkt *io);
 256    bRC (*createFile)(bpContext *ctx, struct restore_pkt *rp);
 257    bRC (*setFileAttributes)(bpContext *ctx, struct restore_pkt *rp);
 258 } pFuncs;
 259
 260 #define plug_func(plugin) ((pFuncs *)(plugin->pfuncs))
 261 #define plug_info(plugin) ((pInfo *)(plugin->pinfo))
 262
 263 #ifdef __cplusplus
 264 }
 265 #endif
 266
 267 #endif /* __FD_PLUGINS_H */