git.sur5r.net Git - bacula/bacula/blob - bacula/src/dird/dir_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 __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
  59 #ifdef __cplusplus
  60 extern "C" {
  61 #endif
  62
  63
  64
  65
  66 /****************************************************************************
  67  *                                                                          *
  68  *                Bacula definitions                                        *
  69  *                                                                          *
  70  ****************************************************************************/
  71
  72 /* Bacula Variable Ids */       /* return value */
  73 typedef enum {
  74   bVarJob       = 1,            // string
  75   bVarLevel     = 2,            // int
  76   bVarType      = 3,            // int
  77   bVarJobId     = 4,            // int
  78   bVarClient    = 5,            // string
  79   bVarNumVols   = 6,            // int
  80   bVarPool      = 7,            // string
  81   bVarStorage   = 8,            // string
  82   bVarWriteStorage = 9,         // string
  83   bVarReadStorage  = 10,        // string
  84   bVarCatalog   = 11,           // string
  85   bVarMediaType = 12,           // string
  86   bVarJobName   = 13,           // string
  87   bVarJobStatus = 14,           // int
  88   bVarPriority  = 15,           // int
  89   bVarVolumeName = 16,          // string
  90   bVarCatalogRes = 17,          // NYI
  91   bVarJobErrors  = 18,          // int
  92   bVarJobFiles   = 19,          // int
  93   bVarSDJobFiles = 20,          // int
  94   bVarSDErrors   = 21,          // int
  95   bVarFDJobStatus = 22,         // int
  96   bVarSDJobStatus = 23          // int
  97 } brVariable;
  98
  99 typedef enum {
 100   bwVarJobReport  = 1,
 101   bwVarVolumeName = 2,
 102   bwVarPriority   = 3,
 103   bwVarJobLevel   = 4
 104 } bwVariable;
 105
 106
 107 typedef enum {
 108   bEventJobStart      = 1,
 109   bEventJobEnd        = 2,
 110   bEventJobInit       = 3,
 111   bEventJobRun        = 4,
 112   bEventVolumePurged  = 5,
 113   bEventNewVolume     = 6,
 114   bEventNeedVolume    = 7,
 115   bEventVolumeFull    = 8,
 116   bEventRecyle        = 9,
 117   bEventGetScratch    = 10
 118 } bEventType;
 119
 120 typedef struct s_bEvent {
 121    uint32_t eventType;
 122 } bEvent;
 123
 124 typedef struct s_baculaInfo {
 125    uint32_t size;
 126    uint32_t version;
 127 } bInfo;
 128
 129 /* Bacula interface version and function pointers */
 130 typedef struct s_baculaFuncs {
 131    uint32_t size;
 132    uint32_t version;
 133    bRC (*registerBaculaEvents)(bpContext *ctx, ...);
 134    bRC (*getBaculaValue)(bpContext *ctx, brVariable var, void *value);
 135    bRC (*setBaculaValue)(bpContext *ctx, bwVariable var, void *value);
 136    bRC (*JobMessage)(bpContext *ctx, const char *file, int line,
 137        int type, utime_t mtime, const char *msg);
 138    bRC (*DebugMessage)(bpContext *ctx, const char *file, int line,
 139        int level, const char *msg);
 140 } bFuncs;
 141
 142 /* Bacula Core Routines -- not used within a plugin */
 143 #ifdef DIRECTOR_DAEMON
 144 void load_dir_plugins(const char *plugin_dir);
 145 void new_plugins(JCR *jcr);
 146 void free_plugins(JCR *jcr);
 147 void generate_plugin_event(JCR *jcr, bEventType event, void *value=NULL);
 148 #endif
 149
 150
 151 /****************************************************************************
 152  *                                                                          *
 153  *                Plugin definitions                                        *
 154  *                                                                          *
 155  ****************************************************************************/
 156
 157 typedef enum {
 158   pVarName = 1,
 159   pVarDescription = 2
 160 } pVariable;
 161
 162
 163 #define DIR_PLUGIN_MAGIC     "*DirPluginData*"
 164 #define DIR_PLUGIN_INTERFACE_VERSION  1
 165
 166 typedef struct s_pluginInfo {
 167    uint32_t size;
 168    uint32_t version;
 169    const char *plugin_magic;
 170    const char *plugin_license;
 171    const char *plugin_author;
 172    const char *plugin_date;
 173    const char *plugin_version;
 174    const char *plugin_description;
 175 } pInfo;
 176
 177 typedef struct s_pluginFuncs {
 178    uint32_t size;
 179    uint32_t version;
 180    bRC (*newPlugin)(bpContext *ctx);
 181    bRC (*freePlugin)(bpContext *ctx);
 182    bRC (*getPluginValue)(bpContext *ctx, pVariable var, void *value);
 183    bRC (*setPluginValue)(bpContext *ctx, pVariable var, void *value);
 184    bRC (*handlePluginEvent)(bpContext *ctx, bEvent *event, void *value);
 185 } pFuncs;
 186
 187 #define plug_func(plugin) ((pFuncs *)(plugin->pfuncs))
 188 #define plug_info(plugin) ((pInfo *)(plugin->pinfo))
 189
 190 #ifdef __cplusplus
 191 }
 192 #endif
 193
 194 #endif /* __FD_PLUGINS_H */