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 char *object; /* restore object data to save */
86 int32_t object_len; /* restore object length */
87 int32_t index; /* restore object index */
88 int32_t pkt_end; /* end packet sentinel */
92 * This packet is used for file restore info transfer.
95 int32_t pkt_size; /* size of this packet */
96 int32_t stream; /* attribute stream id */
97 int32_t data_stream; /* id of data stream to follow */
98 int32_t type; /* file type FT */
99 int32_t file_index; /* file index */
100 int32_t LinkFI; /* file index to data if hard link */
101 uid_t uid; /* userid */
102 struct stat statp; /* decoded stat packet */
103 const char *attrEx; /* extended attributes if any */
104 const char *ofname; /* output filename */
105 const char *olname; /* output link name */
106 const char *where; /* where */
107 const char *RegexWhere; /* regex where */
108 int replace; /* replace flag */
109 int create_status; /* status from createFile() */
110 int32_t pkt_end; /* end packet sentinel */
122 int32_t pkt_size; /* Size of this packet */
123 int32_t func; /* Function code */
124 int32_t count; /* read/write count */
125 int32_t flags; /* Open flags */
126 mode_t mode; /* permissions for created files */
127 char *buf; /* read/write buffer */
128 const char *fname; /* open filename */
129 int32_t status; /* return status */
130 int32_t io_errno; /* errno code */
131 int32_t lerror; /* Win32 error code */
132 int32_t whence; /* lseek argument */
133 boffset_t offset; /* lseek argument */
134 bool win32; /* Win32 GetLastError returned */
135 int32_t pkt_end; /* end packet sentinel */
138 /****************************************************************************
140 * Bacula definitions *
142 ****************************************************************************/
144 /* Bacula Variable Ids */
157 bVarVssDllHandle = 12
160 /* Events that are passed to plugin */
164 bEventStartBackupJob = 3,
165 bEventEndBackupJob = 4,
166 bEventStartRestoreJob = 5,
167 bEventEndRestoreJob = 6,
168 bEventStartVerifyJob = 7,
169 bEventEndVerifyJob = 8,
170 bEventBackupCommand = 9,
171 bEventRestoreCommand = 10,
174 bEventCancelCommand = 13,
175 bEventVssBackupAddComponents = 14,
176 bEventVssRestoreLoadComponentMetadata = 15,
177 bEventVssRestoreSetComponentsSelected = 16,
180 typedef struct s_bEvent {
184 typedef struct s_baculaInfo {
189 /* Bacula Core Routines -- not used within a plugin */
191 struct BFILE; /* forward referenced */
193 void load_fd_plugins(const char *plugin_dir);
194 void new_plugins(JCR *jcr);
195 void free_plugins(JCR *jcr);
196 void generate_plugin_event(JCR *jcr, bEventType event, void *value=NULL);
197 bool send_plugin_name(JCR *jcr, BSOCK *sd, bool start);
198 bool plugin_name_stream(JCR *jcr, char *name);
199 int plugin_create_file(JCR *jcr, ATTR *attr, BFILE *bfd, int replace);
200 bool plugin_set_attributes(JCR *jcr, ATTR *attr, BFILE *ofd);
201 int plugin_save(JCR *jcr, FF_PKT *ff_pkt, bool top_level);
202 bool plugin_check_file(JCR *jcr, char *fname);
210 * Bacula interface version and function pointers --
211 * i.e. callbacks from the plugin to Bacula
213 typedef struct s_baculaFuncs {
216 bRC (*registerBaculaEvents)(bpContext *ctx, ...);
217 bRC (*getBaculaValue)(bpContext *ctx, bVariable var, void *value);
218 bRC (*setBaculaValue)(bpContext *ctx, bVariable var, void *value);
219 bRC (*JobMessage)(bpContext *ctx, const char *file, int line,
220 int type, utime_t mtime, const char *fmt, ...);
221 bRC (*DebugMessage)(bpContext *ctx, const char *file, int line,
222 int level, const char *fmt, ...);
223 void *(*baculaMalloc)(bpContext *ctx, const char *file, int line,
225 void (*baculaFree)(bpContext *ctx, const char *file, int line, void *mem);
226 bRC (*AddExclude)(bpContext *ctx, const char *file);
232 /****************************************************************************
234 * Plugin definitions *
236 ****************************************************************************/
244 #define FD_PLUGIN_MAGIC "*FDPluginData*"
245 #define FD_PLUGIN_INTERFACE_VERSION 4
247 typedef struct s_pluginInfo {
250 const char *plugin_magic;
251 const char *plugin_license;
252 const char *plugin_author;
253 const char *plugin_date;
254 const char *plugin_version;
255 const char *plugin_description;
259 * This is a set of function pointers that Bacula can call
262 typedef struct s_pluginFuncs {
265 bRC (*newPlugin)(bpContext *ctx);
266 bRC (*freePlugin)(bpContext *ctx);
267 bRC (*getPluginValue)(bpContext *ctx, pVariable var, void *value);
268 bRC (*setPluginValue)(bpContext *ctx, pVariable var, void *value);
269 bRC (*handlePluginEvent)(bpContext *ctx, bEvent *event, void *value);
270 bRC (*startBackupFile)(bpContext *ctx, struct save_pkt *sp);
271 bRC (*endBackupFile)(bpContext *ctx);
272 bRC (*startRestoreFile)(bpContext *ctx, const char *cmd);
273 bRC (*endRestoreFile)(bpContext *ctx);
274 bRC (*pluginIO)(bpContext *ctx, struct io_pkt *io);
275 bRC (*createFile)(bpContext *ctx, struct restore_pkt *rp);
276 bRC (*setFileAttributes)(bpContext *ctx, struct restore_pkt *rp);
277 bRC (*checkFile)(bpContext *ctx, char *fname);
280 #define plug_func(plugin) ((pFuncs *)(plugin->pfuncs))
281 #define plug_info(plugin) ((pInfo *)(plugin->pinfo))
287 #endif /* __FD_PLUGINS_H */