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-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 __DIR_PLUGINS_H
  36 #define __DIR_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   bDirVarJob       = 1,            // string
  75   bDirVarLevel     = 2,            // int
  76   bDirVarType      = 3,            // int
  77   bDirVarJobId     = 4,            // int
  78   bDirVarClient    = 5,            // string
  79   bDirVarNumVols   = 6,            // int
  80   bDirVarPool      = 7,            // string
  81   bDirVarStorage   = 8,            // string
  82   bDirVarWriteStorage = 9,         // string
  83   bDirVarReadStorage  = 10,        // string
  84   bDirVarCatalog   = 11,           // string
  85   bDirVarMediaType = 12,           // string
  86   bDirVarJobName   = 13,           // string
  87   bDirVarJobStatus = 14,           // int
  88   bDirVarPriority  = 15,           // int
  89   bDirVarVolumeName = 16,          // string
  90   bDirVarCatalogRes = 17,          // NYI
  91   bDirVarJobErrors  = 18,          // int
  92   bDirVarJobFiles   = 19,          // int
  93   bDirVarSDJobFiles = 20,          // int
  94   bDirVarSDErrors   = 21,          // int
  95   bDirVarFDJobStatus = 22,         // int
  96   bDirVarSDJobStatus = 23          // int
  97 } brDirVariable;
  98
  99 typedef enum {
 100   bwDirVarJobReport  = 1,
 101   bwDirVarVolumeName = 2,
 102   bwDirVarPriority   = 3,
 103   bwDirVarJobLevel   = 4
 104 } bwDirVariable;
 105
 106
 107 typedef enum {
 108   bDirEventJobStart      = 1,
 109   bDirEventJobEnd        = 2,
 110   bDirEventJobInit       = 3,
 111   bDirEventJobRun        = 4,
 112   bDirEventVolumePurged  = 5,
 113   bDirEventNewVolume     = 6,
 114   bDirEventNeedVolume    = 7,
 115   bDirEventVolumeFull    = 8,
 116   bDirEventRecyle        = 9,
 117   bDirEventGetScratch    = 10
 118 } bDirEventType;
 119
 120 typedef struct s_bDirEvent {
 121    uint32_t eventType;
 122 } bDirEvent;
 123
 124 typedef struct s_dirbaculaInfo {
 125    uint32_t size;
 126    uint32_t version;
 127 } bDirInfo;
 128
 129 /* Bacula interface version and function pointers */
 130 typedef struct s_dirbaculaFuncs {
 131    uint32_t size;
 132    uint32_t version;
 133    bRC (*registerBaculaEvents)(bpContext *ctx, ...);
 134    bRC (*getBaculaValue)(bpContext *ctx, brDirVariable var, void *value);
 135    bRC (*setBaculaValue)(bpContext *ctx, bwDirVariable var, void *value);
 136    bRC (*JobMessage)(bpContext *ctx, const char *file, int line,
 137                      int type, utime_t mtime, const char *fmt, ...);
 138    bRC (*DebugMessage)(bpContext *ctx, const char *file, int line,
 139                        int level, const char *fmt, ...);
 140 } bDirFuncs;
 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 int generate_plugin_event(JCR *jcr, bDirEventType event, void *value=NULL);
 148 #endif
 149
 150
 151 /****************************************************************************
 152  *                                                                          *
 153  *                Plugin definitions                                        *
 154  *                                                                          *
 155  ****************************************************************************/
 156
 157 typedef enum {
 158   pDirVarName = 1,
 159   pDirVarDescription = 2
 160 } pDirVariable;
 161
 162
 163 #define DIR_PLUGIN_MAGIC     "*DirPluginData*"
 164 #define DIR_PLUGIN_INTERFACE_VERSION  1
 165
 166 typedef struct s_dirpluginInfo {
 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 } pDirInfo;
 176
 177 typedef struct s_dirpluginFuncs {
 178    uint32_t size;
 179    uint32_t version;
 180    bRC (*newPlugin)(bpContext *ctx);
 181    bRC (*freePlugin)(bpContext *ctx);
 182    bRC (*getPluginValue)(bpContext *ctx, pDirVariable var, void *value);
 183    bRC (*setPluginValue)(bpContext *ctx, pDirVariable var, void *value);
 184    bRC (*handlePluginEvent)(bpContext *ctx, bDirEvent *event, void *value);
 185 } pDirFuncs;
 186
 187 #define dirplug_func(plugin) ((pDirFuncs *)(plugin->pfuncs))
 188 #define dirplug_info(plugin) ((pDirInfo *)(plugin->pinfo))
 189
 190 #ifdef __cplusplus
 191 }
 192 #endif
 193
 194 #endif /* __FD_PLUGINS_H */