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