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-2009 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 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   bVarJob       = 1,
  75   bVarLevel     = 2,
  76   bVarType      = 3,
  77   bVarJobId     = 4,
  78   bVarClient    = 5,
  79   bVarNumVols   = 6,
  80   bVarPool      = 7,
  81   bVarStorage   = 8,
  82   bVarCatalog   = 9,
  83   bVarMediaType = 10,
  84   bVarJobName   = 11,
  85   bVarJobStatus = 12,
  86   bVarPriority  = 13,
  87   bVarVolumeName = 14,
  88   bVarCatalogRes = 15,
  89   bVarJobErrors  = 16,
  90   bVarJobFiles   = 17,
  91   bVarSDJobFiles = 18,
  92   bVarSDErrors   = 19,
  93   bVarFDJobStatus = 20,
  94   bVarSDJobStatus = 21
  95 } brVariable;
  96
  97 typedef enum {
  98   bwVarJobReport  = 1,
  99   bwVarVolumeName = 2,
 100   bwVarPriority   = 3,
 101   bwVarJobLevel   = 4
 102 } bwVariable;
 103
 104
 105 typedef enum {
 106   bEventJobStart      = 1,
 107   bEventJobEnd        = 2
 108 } bEventType;
 109
 110 typedef struct s_bEvent {
 111    uint32_t eventType;
 112 } bEvent;
 113
 114 typedef struct s_baculaInfo {
 115    uint32_t size;
 116    uint32_t version;
 117 } bInfo;
 118
 119 /* Bacula interface version and function pointers */
 120 typedef struct s_baculaFuncs {
 121    uint32_t size;
 122    uint32_t version;
 123    bRC (*registerBaculaEvents)(bpContext *ctx, ...);
 124    bRC (*getBaculaValue)(bpContext *ctx, brVariable var, void *value);
 125    bRC (*setBaculaValue)(bpContext *ctx, bwVariable var, void *value);
 126    bRC (*JobMessage)(bpContext *ctx, const char *file, int line,
 127        int type, utime_t mtime, const char *msg);
 128    bRC (*DebugMessage)(bpContext *ctx, const char *file, int line,
 129        int level, const char *msg);
 130 } bFuncs;
 131
 132 /* Bacula Subroutines */
 133 void load_sd_plugins(const char *plugin_dir);
 134 void new_plugins(JCR *jcr);
 135 void free_plugins(JCR *jcr);
 136 void generate_plugin_event(JCR *jcr, bEventType event, void *value=NULL);
 137
 138
 139
 140 /****************************************************************************
 141  *                                                                          *
 142  *                Plugin definitions                                        *
 143  *                                                                          *
 144  ****************************************************************************/
 145
 146 typedef enum {
 147   pVarName = 1,
 148   pVarDescription = 2
 149 } pVariable;
 150
 151
 152 #define SD_PLUGIN_MAGIC     "*DirPluginData*"
 153 #define SD_PLUGIN_INTERFACE_VERSION  1
 154
 155 typedef struct s_pluginInfo {
 156    uint32_t size;
 157    uint32_t version;
 158    const char *plugin_magic;
 159    const char *plugin_license;
 160    const char *plugin_author;
 161    const char *plugin_date;
 162    const char *plugin_version;
 163    const char *plugin_description;
 164 } pInfo;
 165
 166 typedef struct s_pluginFuncs {
 167    uint32_t size;
 168    uint32_t version;
 169    bRC (*newPlugin)(bpContext *ctx);
 170    bRC (*freePlugin)(bpContext *ctx);
 171    bRC (*getPluginValue)(bpContext *ctx, pVariable var, void *value);
 172    bRC (*setPluginValue)(bpContext *ctx, pVariable var, void *value);
 173    bRC (*handlePluginEvent)(bpContext *ctx, bEvent *event, void *value);
 174 } pFuncs;
 175
 176 #define plug_func(plugin) ((pFuncs *)(plugin->pfuncs))
 177 #define plug_info(plugin) ((pInfo *)(plugin->pinfo))
 178
 179 #ifdef __cplusplus
 180 }
 181 #endif
 182
 183 #endif /* __SD_PLUGINS_H */