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