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 the restore objects
75 * It is passed to the plugin when restoring
78 struct restore_object_pkt {
79 int32_t pkt_size; /* size of this packet */
80 char *fname; /* Full path and filename */
81 int32_t object_type; /* FT_xx for this file */
82 char *object; /* restore object data to save */
83 int32_t object_len; /* restore object length */
84 int32_t object_index; /* restore object index */
85 uint32_t JobId; /* JobId object came from */
86 int32_t pkt_end; /* end packet sentinel */
90 * This packet is used for file save info transfer.
93 int32_t pkt_size; /* size of this packet */
94 char *fname; /* Full path and filename */
95 char *link; /* Link name if any */
96 struct stat statp; /* System stat() packet for file */
97 int32_t type; /* FT_xx for this file */
98 uint32_t flags; /* Bacula internal flags */
99 bool portable; /* set if data format is portable */
100 char *cmd; /* command */
101 char *object; /* restore object data to save */
102 int32_t object_len; /* restore object length */
103 int32_t index; /* restore object index */
104 int32_t pkt_end; /* end packet sentinel */
108 * This packet is used for file restore info transfer.
111 int32_t pkt_size; /* size of this packet */
112 int32_t stream; /* attribute stream id */
113 int32_t data_stream; /* id of data stream to follow */
114 int32_t type; /* file type FT */
115 int32_t file_index; /* file index */
116 int32_t LinkFI; /* file index to data if hard link */
117 uid_t uid; /* userid */
118 struct stat statp; /* decoded stat packet */
119 const char *attrEx; /* extended attributes if any */
120 const char *ofname; /* output filename */
121 const char *olname; /* output link name */
122 const char *where; /* where */
123 const char *RegexWhere; /* regex where */
124 int replace; /* replace flag */
125 int create_status; /* status from createFile() */
126 int32_t pkt_end; /* end packet sentinel */
138 int32_t pkt_size; /* Size of this packet */
139 int32_t func; /* Function code */
140 int32_t count; /* read/write count */
141 int32_t flags; /* Open flags */
142 mode_t mode; /* permissions for created files */
143 char *buf; /* read/write buffer */
144 const char *fname; /* open filename */
145 int32_t status; /* return status */
146 int32_t io_errno; /* errno code */
147 int32_t lerror; /* Win32 error code */
148 int32_t whence; /* lseek argument */
149 boffset_t offset; /* lseek argument */
150 bool win32; /* Win32 GetLastError returned */
151 int32_t pkt_end; /* end packet sentinel */
154 /****************************************************************************
156 * Bacula definitions *
158 ****************************************************************************/
160 /* Bacula Variable Ids */
173 bVarVssDllHandle = 12
176 /* Events that are passed to plugin */
180 bEventStartBackupJob = 3,
181 bEventEndBackupJob = 4,
182 bEventStartRestoreJob = 5,
183 bEventEndRestoreJob = 6,
184 bEventStartVerifyJob = 7,
185 bEventEndVerifyJob = 8,
186 bEventBackupCommand = 9,
187 bEventRestoreCommand = 10,
190 bEventCancelCommand = 13,
191 bEventVssBackupAddComponents = 14,
192 bEventVssRestoreLoadComponentMetadata = 15,
193 bEventVssRestoreSetComponentsSelected = 16,
194 bEventRestoreObject = 17,
197 typedef struct s_bEvent {
201 typedef struct s_baculaInfo {
206 /* Bacula Core Routines -- not used within a plugin */
208 struct BFILE; /* forward referenced */
210 void load_fd_plugins(const char *plugin_dir);
211 void new_plugins(JCR *jcr);
212 void free_plugins(JCR *jcr);
213 void generate_plugin_event(JCR *jcr, bEventType event, void *value=NULL);
214 bool send_plugin_name(JCR *jcr, BSOCK *sd, bool start);
215 bool plugin_name_stream(JCR *jcr, char *name);
216 int plugin_create_file(JCR *jcr, ATTR *attr, BFILE *bfd, int replace);
217 bool plugin_set_attributes(JCR *jcr, ATTR *attr, BFILE *ofd);
218 int plugin_save(JCR *jcr, FF_PKT *ff_pkt, bool top_level);
219 bool plugin_check_file(JCR *jcr, char *fname);
227 * Bacula interface version and function pointers --
228 * i.e. callbacks from the plugin to Bacula
230 typedef struct s_baculaFuncs {
233 bRC (*registerBaculaEvents)(bpContext *ctx, ...);
234 bRC (*getBaculaValue)(bpContext *ctx, bVariable var, void *value);
235 bRC (*setBaculaValue)(bpContext *ctx, bVariable var, void *value);
236 bRC (*JobMessage)(bpContext *ctx, const char *file, int line,
237 int type, utime_t mtime, const char *fmt, ...);
238 bRC (*DebugMessage)(bpContext *ctx, const char *file, int line,
239 int level, const char *fmt, ...);
240 void *(*baculaMalloc)(bpContext *ctx, const char *file, int line,
242 void (*baculaFree)(bpContext *ctx, const char *file, int line, void *mem);
243 bRC (*AddExclude)(bpContext *ctx, const char *file);
249 /****************************************************************************
251 * Plugin definitions *
253 ****************************************************************************/
261 #define FD_PLUGIN_MAGIC "*FDPluginData*"
262 #define FD_PLUGIN_INTERFACE_VERSION 4
264 typedef struct s_pluginInfo {
267 const char *plugin_magic;
268 const char *plugin_license;
269 const char *plugin_author;
270 const char *plugin_date;
271 const char *plugin_version;
272 const char *plugin_description;
276 * This is a set of function pointers that Bacula can call
279 typedef struct s_pluginFuncs {
282 bRC (*newPlugin)(bpContext *ctx);
283 bRC (*freePlugin)(bpContext *ctx);
284 bRC (*getPluginValue)(bpContext *ctx, pVariable var, void *value);
285 bRC (*setPluginValue)(bpContext *ctx, pVariable var, void *value);
286 bRC (*handlePluginEvent)(bpContext *ctx, bEvent *event, void *value);
287 bRC (*startBackupFile)(bpContext *ctx, struct save_pkt *sp);
288 bRC (*endBackupFile)(bpContext *ctx);
289 bRC (*startRestoreFile)(bpContext *ctx, const char *cmd);
290 bRC (*endRestoreFile)(bpContext *ctx);
291 bRC (*pluginIO)(bpContext *ctx, struct io_pkt *io);
292 bRC (*createFile)(bpContext *ctx, struct restore_pkt *rp);
293 bRC (*setFileAttributes)(bpContext *ctx, struct restore_pkt *rp);
294 bRC (*checkFile)(bpContext *ctx, char *fname);
297 #define plug_func(plugin) ((pFuncs *)(plugin->pfuncs))
298 #define plug_info(plugin) ((pInfo *)(plugin->pinfo))
304 #endif /* __FD_PLUGINS_H */