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