2 Bacula® - The Network Backup Solution
4 Copyright (C) 2007-2011 Free Software Foundation Europe e.V.
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.
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.
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
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.
29 * Interface definition for Bacula Plugins
31 * Kern Sibbald, October 2007
35 #ifndef __SD_PLUGINS_H
36 #define __SD_PLUGINS_H
40 /* Workaround for SGI IRIX 6.5 */
41 #define _LANGUAGE_C_PLUS_PLUS 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
51 #include <sys/types.h>
57 #include "lib/plugins.h"
66 /****************************************************************************
68 * Bacula definitions *
70 ****************************************************************************/
72 /* Bacula Variable Ids */
87 bsdVarVolumeName = 14,
88 bsdVarCatalogRes = 15,
91 bsdVarSDJobFiles = 18,
93 bsdVarFDJobStatus = 20,
94 bsdVarSDJobStatus = 21
99 bsdwVarVolumeName = 2,
106 bsdEventJobStart = 1,
108 bsdEventDeviceInit = 3,
109 bsdEventDeviceOpen = 4,
110 bsdEventDeviceTryOpen = 5,
111 bsdEventDeviceClose = 6
114 typedef struct s_bsdEvent {
118 typedef struct s_sdbaculaInfo {
123 /* Bacula interface version and function pointers */
124 typedef struct s_sdbaculaFuncs {
127 bRC (*registerBaculaEvents)(bpContext *ctx, ...);
128 bRC (*getBaculaValue)(bpContext *ctx, bsdrVariable var, void *value);
129 bRC (*setBaculaValue)(bpContext *ctx, bsdwVariable var, void *value);
130 bRC (*JobMessage)(bpContext *ctx, const char *file, int line,
131 int type, utime_t mtime, const char *fmt, ...);
132 bRC (*DebugMessage)(bpContext *ctx, const char *file, int line,
133 int level, const char *fmt, ...);
134 char *(*EditDeviceCodes)(DCR *dcr, char *omsg,
135 const char *imsg, const char *cmd);
138 /* Bacula Subroutines */
139 void load_sd_plugins(const char *plugin_dir);
140 void new_plugins(JCR *jcr);
141 void free_plugins(JCR *jcr);
142 int generate_plugin_event(JCR *jcr, bsdEventType event, void *value=NULL);
146 /****************************************************************************
148 * Plugin definitions *
150 ****************************************************************************/
154 psdVarDescription = 2
158 #define SD_PLUGIN_MAGIC "*SDPluginData*"
159 #define SD_PLUGIN_INTERFACE_VERSION 1
161 typedef struct s_sdpluginInfo {
164 const char *plugin_magic;
165 const char *plugin_license;
166 const char *plugin_author;
167 const char *plugin_date;
168 const char *plugin_version;
169 const char *plugin_description;
173 * Functions that must be defined in every plugin
175 typedef struct s_sdpluginFuncs {
178 bRC (*newPlugin)(bpContext *ctx);
179 bRC (*freePlugin)(bpContext *ctx);
180 bRC (*getPluginValue)(bpContext *ctx, psdVariable var, void *value);
181 bRC (*setPluginValue)(bpContext *ctx, psdVariable var, void *value);
182 bRC (*handlePluginEvent)(bpContext *ctx, bsdEvent *event, void *value);
185 #define sdplug_func(plugin) ((psdFuncs *)(plugin->pfuncs))
186 #define sdplug_info(plugin) ((psdInfo *)(plugin->pinfo))
192 #endif /* __SD_PLUGINS_H */