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 John Walker.
  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 #ifndef __CONFIG_H
  53 #define __CONFIG_H
  54 #include "config.h"
  55 #endif
  56 #include "bc_types.h"
  57 #include "lib/plugins.h"
  58 #include <sys/stat.h>
  59
  60 /*
  61  * This packet is used for file save info transfer.
  62 */
  63 struct save_pkt {
  64   char *fname;                        /* Full path and filename */
  65   char *link;                         /* Link name if any */
  66   struct stat statp;                  /* System stat() packet for file */
  67   int32_t type;                       /* FT_xx for this file */
  68   uint32_t flags;                     /* Bacula internal flags */
  69   bool portable;                      /* set if data format is portable */
  70   char *cmd;                          /* command */
  71 };
  72
  73 /*
  74  * This packet is used for file restore info transfer.
  75 */
  76 struct restore_pkt {
  77 };
  78
  79 enum {
  80    IO_OPEN = 1,
  81    IO_READ = 2,
  82    IO_WRITE = 3,
  83    IO_CLOSE = 4,
  84    IO_SEEK = 5
  85 };
  86
  87 struct io_pkt {
  88    int32_t func;                      /* Function code */
  89    int32_t count;                     /* read/write count */
  90    char *buf;                         /* read/write buffer */
  91    int32_t status;                    /* return status */
  92    int32_t io_errno;                  /* errno code */
  93    int32_t whence;
  94    boffset_t offset;
  95 };
  96
  97 /****************************************************************************
  98  *                                                                          *
  99  *                Bacula definitions                                        *
 100  *                                                                          *
 101  ****************************************************************************/
 102
 103 /* Bacula Variable Ids */
 104 typedef enum {
 105   bVarJobId     = 1,
 106   bVarFDName    = 2,
 107   bVarLevel     = 3,
 108   bVarType      = 4,
 109   bVarClient    = 5,
 110   bVarJobName   = 6,
 111   bVarJobStatus = 7,
 112   bVarSinceTime = 8
 113 } bVariable;
 114
 115 typedef enum {
 116   bEventJobStart      = 1,
 117   bEventJobEnd        = 2,
 118   bEventBackupStart   = 3,
 119   bEventBackupEnd     = 4,
 120   bEventRestoreStart  = 5,
 121   bEventRestoreEnd    = 6,
 122   bEventVerifyStart   = 7,
 123   bEventVerifyEnd     = 8,
 124   bEventPluginCommand = 9,
 125   bEventPluginFile    = 10,
 126   bEventLevel         = 11,
 127   bEventSince         = 12,
 128 } bEventType;
 129
 130 typedef struct s_bEvent {
 131    uint32_t eventType;
 132 } bEvent;
 133
 134 typedef struct s_baculaInfo {
 135    uint32_t size;
 136    uint32_t version;
 137 } bInfo;
 138
 139 /* Bacula Core Routines -- not used by plugins */
 140 struct BFILE;                   /* forward referenced */
 141 void load_fd_plugins(const char *plugin_dir);
 142 void new_plugins(JCR *jcr);
 143 void free_plugins(JCR *jcr);
 144 void generate_plugin_event(JCR *jcr, bEventType event, void *value=NULL);
 145 bool send_plugin_name(JCR *jcr, BSOCK *sd, bool start);
 146 void plugin_name_stream(JCR *jcr, char *name);
 147 int plugin_create_file(JCR *jcr, ATTR *attr, BFILE *bfd, int replace);
 148 bool plugin_set_attributes(JCR *jcr, ATTR *attr, BFILE *ofd);
 149
 150 #ifdef __cplusplus
 151 extern "C" {
 152 #endif
 153
 154 /*
 155  * Bacula interface version and function pointers --
 156  *  i.e. callbacks from the plugin to Bacula
 157  */
 158 typedef struct s_baculaFuncs {
 159    uint32_t size;
 160    uint32_t version;
 161    bRC (*registerBaculaEvents)(bpContext *ctx, ...);
 162    bRC (*getBaculaValue)(bpContext *ctx, bVariable var, void *value);
 163    bRC (*setBaculaValue)(bpContext *ctx, bVariable var, void *value);
 164    bRC (*JobMessage)(bpContext *ctx, const char *file, int line,
 165        int type, time_t mtime, const char *fmt, ...);
 166    bRC (*DebugMessage)(bpContext *ctx, const char *file, int line,
 167        int level, const char *fmt, ...);
 168 } bFuncs;
 169
 170
 171
 172
 173 /****************************************************************************
 174  *                                                                          *
 175  *                Plugin definitions                                        *
 176  *                                                                          *
 177  ****************************************************************************/
 178
 179 typedef enum {
 180   pVarName = 1,
 181   pVarDescription = 2
 182 } pVariable;
 183
 184
 185 #define PLUGIN_MAGIC     "*PluginData*"
 186 #define PLUGIN_INTERFACE_VERSION  1
 187
 188 typedef struct s_pluginInfo {
 189    uint32_t size;
 190    uint32_t version;
 191    char *plugin_magic;
 192    char *plugin_license;
 193    char *plugin_author;
 194    char *plugin_date;
 195    char *plugin_version;
 196    char *plugin_description;
 197 } pInfo;
 198
 199 /*
 200  * This is a set of function pointers that Bacula can call
 201  *  within the plugin.
 202  */
 203 typedef struct s_pluginFuncs {
 204    uint32_t size;
 205    uint32_t version;
 206    bRC (*newPlugin)(bpContext *ctx);
 207    bRC (*freePlugin)(bpContext *ctx);
 208    bRC (*getPluginValue)(bpContext *ctx, pVariable var, void *value);
 209    bRC (*setPluginValue)(bpContext *ctx, pVariable var, void *value);
 210    bRC (*handlePluginEvent)(bpContext *ctx, bEvent *event, void *value);
 211    bRC (*startPluginBackup)(bpContext *ctx, struct save_pkt *sp);
 212    bRC (*endPluginBackup)(bpContext *ctx);
 213    bRC (*startRestoreFile)(bpContext *ctx, const char *cmd);
 214    bRC (*endRestoreFile)(bpContext *ctx);
 215    bRC (*pluginIO)(bpContext *ctx, struct io_pkt *io);
 216    bRC (*createFile)(bpContext *ctx, struct restore_pkt *rp);
 217    bRC (*setFileAttributes)(bpContext *ctx, struct restore_pkt *rp);
 218 } pFuncs;
 219
 220 #define plug_func(plugin) ((pFuncs *)(plugin->pfuncs))
 221 #define plug_info(plugin) ((pInfo *)(plugin->pinfo))
 222
 223 #ifdef __cplusplus
 224 }
 225 #endif
 226
 227 #endif /* __FD_PLUGINS_H */