2 Bacula® - The Network Backup Solution
4 Copyright (C) 2007-2008 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 two of the GNU 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 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 John Walker.
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 __FD_PLUGINS_H
36 #define __FD_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"
61 * This packet is used for file save/restore info transfer */
63 char *fname; /* Full path and filename */
64 char *link; /* Link name if any */
65 struct stat statp; /* System stat() packet for file */
66 int32_t type; /* FT_xx for this file */
67 uint32_t flags; /* Bacula internal flags */
68 bool portable; /* set if data format is portable */
69 char *cmd; /* command */
79 int32_t func; /* Function code */
80 int32_t count; /* read/write count */
81 char *buf; /* read/write buffer */
82 int32_t status; /* return status */
83 int32_t io_errno; /* errno code */
88 /****************************************************************************
90 * Bacula definitions *
92 ****************************************************************************/
94 /* Bacula Variable Ids */
109 bEventBackupStart = 3,
111 bEventRestoreStart = 5,
112 bEventRestoreEnd = 6,
113 bEventVerifyStart = 7,
115 bEventPluginCommand = 9,
116 bEventPluginFile = 10,
121 typedef struct s_bEvent {
125 typedef struct s_baculaInfo {
130 /* Bacula Core Routines -- not used by plugins */
131 void load_fd_plugins(const char *plugin_dir);
132 void new_plugins(JCR *jcr);
133 void free_plugins(JCR *jcr);
134 void generate_plugin_event(JCR *jcr, bEventType event, void *value=NULL);
135 bool send_plugin_name(JCR *jcr, BSOCK *sd, bool start);
141 /* Bacula interface version and function pointers */
142 typedef struct s_baculaFuncs {
145 bRC (*registerBaculaEvents)(bpContext *ctx, ...);
146 bRC (*getBaculaValue)(bpContext *ctx, bVariable var, void *value);
147 bRC (*setBaculaValue)(bpContext *ctx, bVariable var, void *value);
148 bRC (*JobMessage)(bpContext *ctx, const char *file, int line,
149 int type, time_t mtime, const char *msg);
150 bRC (*DebugMessage)(bpContext *ctx, const char *file, int line,
151 int level, const char *msg);
157 /****************************************************************************
159 * Plugin definitions *
161 ****************************************************************************/
169 #define PLUGIN_MAGIC "*PluginData*"
170 #define PLUGIN_INTERFACE_VERSION 1
172 typedef struct s_pluginInfo {
176 char *plugin_license;
179 char *plugin_version;
180 char *plugin_description;
183 typedef struct s_pluginFuncs {
186 bRC (*newPlugin)(bpContext *ctx);
187 bRC (*freePlugin)(bpContext *ctx);
188 bRC (*getPluginValue)(bpContext *ctx, pVariable var, void *value);
189 bRC (*setPluginValue)(bpContext *ctx, pVariable var, void *value);
190 bRC (*handlePluginEvent)(bpContext *ctx, bEvent *event, void *value);
191 bRC (*startPluginBackup)(bpContext *ctx, struct save_pkt *sp);
192 bRC (*pluginIO)(bpContext *ctx, struct io_pkt *io);
195 #define plug_func(plugin) ((pFuncs *)(plugin->pfuncs))
196 #define plug_info(plugin) ((pInfo *)(plugin->pinfo))
202 #endif /* __FD_PLUGINS_H */