2 Bacula® - The Network Backup Solution
4 Copyright (C) 2007-2010 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 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 * Application Programming Interface (API) 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
49 #endif /* ! _BACULA_H */
51 #include <sys/types.h>
53 #if defined(HAVE_WIN32)
54 #if defined(HAVE_MINGW)
55 #include "mingwconfig.h"
57 #include "winconfig.h"
59 #else /* !HAVE_WIN32 */
67 #include "lib/plugins.h"
70 #include "../win32/filed/vss.h"
74 * This packet is used for file save info transfer.
77 int32_t pkt_size; /* size of this packet */
78 char *fname; /* Full path and filename */
79 char *link; /* Link name if any */
80 struct stat statp; /* System stat() packet for file */
81 int32_t type; /* FT_xx for this file */
82 uint32_t flags; /* Bacula internal flags */
83 bool portable; /* set if data format is portable */
84 char *cmd; /* command */
85 int32_t pkt_end; /* end packet sentinel */
89 * This packet is used for file restore info transfer.
92 int32_t pkt_size; /* size of this packet */
93 int32_t stream; /* attribute stream id */
94 int32_t data_stream; /* id of data stream to follow */
95 int32_t type; /* file type FT */
96 int32_t file_index; /* file index */
97 int32_t LinkFI; /* file index to data if hard link */
98 uid_t uid; /* userid */
99 struct stat statp; /* decoded stat packet */
100 const char *attrEx; /* extended attributes if any */
101 const char *ofname; /* output filename */
102 const char *olname; /* output link name */
103 const char *where; /* where */
104 const char *RegexWhere; /* regex where */
105 int replace; /* replace flag */
106 int create_status; /* status from createFile() */
107 int32_t pkt_end; /* end packet sentinel */
119 int32_t pkt_size; /* Size of this packet */
120 int32_t func; /* Function code */
121 int32_t count; /* read/write count */
122 int32_t flags; /* Open flags */
123 mode_t mode; /* permissions for created files */
124 char *buf; /* read/write buffer */
125 const char *fname; /* open filename */
126 int32_t status; /* return status */
127 int32_t io_errno; /* errno code */
128 int32_t lerror; /* Win32 error code */
129 int32_t whence; /* lseek argument */
130 boffset_t offset; /* lseek argument */
131 bool win32; /* Win32 GetLastError returned */
132 int32_t pkt_end; /* end packet sentinel */
135 /****************************************************************************
137 * Bacula definitions *
139 ****************************************************************************/
141 /* Bacula Variable Ids */
156 /* Events that are passed to plugin */
160 bEventStartBackupJob = 3,
161 bEventEndBackupJob = 4,
162 bEventStartRestoreJob = 5,
163 bEventEndRestoreJob = 6,
164 bEventStartVerifyJob = 7,
165 bEventEndVerifyJob = 8,
166 bEventBackupCommand = 9,
167 bEventRestoreCommand = 10,
170 bEventCancelCommand = 13
173 typedef struct s_bEvent {
177 typedef struct s_baculaInfo {
182 /* Bacula Core Routines -- not used within a plugin */
184 struct BFILE; /* forward referenced */
186 void load_fd_plugins(const char *plugin_dir);
187 void new_plugins(JCR *jcr);
188 void free_plugins(JCR *jcr);
189 void generate_plugin_event(JCR *jcr, bEventType event, void *value=NULL);
190 bool send_plugin_name(JCR *jcr, BSOCK *sd, bool start);
191 bool plugin_name_stream(JCR *jcr, char *name);
192 int plugin_create_file(JCR *jcr, ATTR *attr, BFILE *bfd, int replace);
193 bool plugin_set_attributes(JCR *jcr, ATTR *attr, BFILE *ofd);
194 int plugin_save(JCR *jcr, FF_PKT *ff_pkt, bool top_level);
195 bool plugin_check_file(JCR *jcr, char *fname);
203 * Bacula interface version and function pointers --
204 * i.e. callbacks from the plugin to Bacula
206 typedef struct s_baculaFuncs {
209 bRC (*registerBaculaEvents)(bpContext *ctx, ...);
210 bRC (*getBaculaValue)(bpContext *ctx, bVariable var, void *value);
211 bRC (*setBaculaValue)(bpContext *ctx, bVariable var, void *value);
212 bRC (*JobMessage)(bpContext *ctx, const char *file, int line,
213 int type, utime_t mtime, const char *fmt, ...);
214 bRC (*DebugMessage)(bpContext *ctx, const char *file, int line,
215 int level, const char *fmt, ...);
216 void *(*baculaMalloc)(bpContext *ctx, const char *file, int line,
218 void (*baculaFree)(bpContext *ctx, const char *file, int line, void *mem);
219 bRC (*AddExclude)(bpContext *ctx, const char *file);
225 /****************************************************************************
227 * Plugin definitions *
229 ****************************************************************************/
237 #define FD_PLUGIN_MAGIC "*FDPluginData*"
238 #define FD_PLUGIN_INTERFACE_VERSION 4
240 typedef struct s_pluginInfo {
243 const char *plugin_magic;
244 const char *plugin_license;
245 const char *plugin_author;
246 const char *plugin_date;
247 const char *plugin_version;
248 const char *plugin_description;
252 * This is a set of function pointers that Bacula can call
255 typedef struct s_pluginFuncs {
258 bRC (*newPlugin)(bpContext *ctx);
259 bRC (*freePlugin)(bpContext *ctx);
260 bRC (*getPluginValue)(bpContext *ctx, pVariable var, void *value);
261 bRC (*setPluginValue)(bpContext *ctx, pVariable var, void *value);
262 bRC (*handlePluginEvent)(bpContext *ctx, bEvent *event, void *value);
263 bRC (*startBackupFile)(bpContext *ctx, struct save_pkt *sp);
264 bRC (*endBackupFile)(bpContext *ctx);
265 bRC (*startRestoreFile)(bpContext *ctx, const char *cmd);
266 bRC (*endRestoreFile)(bpContext *ctx);
267 bRC (*pluginIO)(bpContext *ctx, struct io_pkt *io);
268 bRC (*createFile)(bpContext *ctx, struct restore_pkt *rp);
269 bRC (*setFileAttributes)(bpContext *ctx, struct restore_pkt *rp);
270 bRC (*checkFile)(bpContext *ctx, char *fname);
273 #define plug_func(plugin) ((pFuncs *)(plugin->pfuncs))
274 #define plug_info(plugin) ((pInfo *)(plugin->pinfo))
280 #endif /* __FD_PLUGINS_H */