git.sur5r.net Git - bacula/bacula/blob - bacula/src/stored/sd_plugins.h

   1 /*
   2    Bacula® - The Network Backup Solution
   3
   4    Copyright (C) 2007-2011 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 three of the GNU Affero 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 Affero 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  * Interface definition for Bacula Plugins
  30  *
  31  * Kern Sibbald, October 2007
  32  *
  33  */
  34
  35 #ifndef __SD_PLUGINS_H
  36 #define __SD_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
  59 #ifdef __cplusplus
  60 extern "C" {
  61 #endif
  62
  63
  64
  65
  66 /****************************************************************************
  67  *                                                                          *
  68  *                Bacula definitions                                        *
  69  *                                                                          *
  70  ****************************************************************************/
  71
  72 /* Bacula Variable Ids */
  73 typedef enum {
  74   bsdVarJob       = 1,
  75   bsdVarLevel     = 2,
  76   bsdVarType      = 3,
  77   bsdVarJobId     = 4,
  78   bsdVarClient    = 5,
  79   bsdVarNumVols   = 6,
  80   bsdVarPool      = 7,
  81   bsdVarStorage   = 8,
  82   bsdVarCatalog   = 9,
  83   bsdVarMediaType = 10,
  84   bsdVarJobName   = 11,
  85   bsdVarJobStatus = 12,
  86   bsdVarPriority  = 13,
  87   bsdVarVolumeName = 14,
  88   bsdVarCatalogRes = 15,
  89   bsdVarJobErrors  = 16,
  90   bsdVarJobFiles   = 17,
  91   bsdVarSDJobFiles = 18,
  92   bsdVarSDErrors   = 19,
  93   bsdVarFDJobStatus = 20,
  94   bsdVarSDJobStatus = 21
  95 } bsdrVariable;
  96
  97 typedef enum {
  98   bsdwVarJobReport  = 1,
  99   bsdwVarVolumeName = 2,
 100   bsdwVarPriority   = 3,
 101   bsdwVarJobLevel   = 4
 102 } bsdwVariable;
 103
 104
 105 typedef enum {
 106   bsdEventJobStart       = 1,
 107   bsdEventJobEnd         = 2,
 108   bsdEventDeviceOpen     = 3,
 109   bsdEventDeviceTryOpen  = 4,
 110   bsdEventDeviceClose    = 5
 111 } bsdEventType;
 112
 113 typedef struct s_bsdEvent {
 114    uint32_t eventType;
 115 } bsdEvent;
 116
 117 typedef struct s_sdbaculaInfo {
 118    uint32_t size;
 119    uint32_t version;
 120 } bsdInfo;
 121
 122 /* Bacula interface version and function pointers */
 123 typedef struct s_sdbaculaFuncs {
 124    uint32_t size;
 125    uint32_t version;
 126    bRC (*registerBaculaEvents)(bpContext *ctx, ...);
 127    bRC (*getBaculaValue)(bpContext *ctx, bsdrVariable var, void *value);
 128    bRC (*setBaculaValue)(bpContext *ctx, bsdwVariable var, void *value);
 129    bRC (*JobMessage)(bpContext *ctx, const char *file, int line,
 130        int type, utime_t mtime, const char *fmt, ...);
 131    bRC (*DebugMessage)(bpContext *ctx, const char *file, int line,
 132        int level, const char *fmt, ...);
 133    char *(*EditDeviceCodes)(DCR *dcr, char *omsg,
 134        const char *imsg, const char *cmd);
 135 } bsdFuncs;
 136
 137 /* Bacula Subroutines */
 138 void load_sd_plugins(const char *plugin_dir);
 139 void new_plugins(JCR *jcr);
 140 void free_plugins(JCR *jcr);
 141 int generate_plugin_event(JCR *jcr, bsdEventType event, void *value=NULL);
 142
 143
 144
 145 /****************************************************************************
 146  *                                                                          *
 147  *                Plugin definitions                                        *
 148  *                                                                          *
 149  ****************************************************************************/
 150
 151 typedef enum {
 152   psdVarName = 1,
 153   psdVarDescription = 2
 154 } psdVariable;
 155
 156
 157 #define SD_PLUGIN_MAGIC     "*SDPluginData*"
 158 #define SD_PLUGIN_INTERFACE_VERSION  1
 159
 160 typedef struct s_sdpluginInfo {
 161    uint32_t size;
 162    uint32_t version;
 163    const char *plugin_magic;
 164    const char *plugin_license;
 165    const char *plugin_author;
 166    const char *plugin_date;
 167    const char *plugin_version;
 168    const char *plugin_description;
 169 } psdInfo;
 170
 171 /*
 172  * Functions that must be defined in every plugin
 173  */
 174 typedef struct s_sdpluginFuncs {
 175    uint32_t size;
 176    uint32_t version;
 177    bRC (*newPlugin)(bpContext *ctx);
 178    bRC (*freePlugin)(bpContext *ctx);
 179    bRC (*getPluginValue)(bpContext *ctx, psdVariable var, void *value);
 180    bRC (*setPluginValue)(bpContext *ctx, psdVariable var, void *value);
 181    bRC (*handlePluginEvent)(bpContext *ctx, bsdEvent *event, void *value);
 182 } psdFuncs;
 183
 184 #define sdplug_func(plugin) ((psdFuncs *)(plugin->pfuncs))
 185 #define sdplug_info(plugin) ((psdInfo *)(plugin->pinfo))
 186
 187 #ifdef __cplusplus
 188 }
 189 #endif
 190
 191 #endif /* __SD_PLUGINS_H */