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 * 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
51 #include <sys/types.h>
57 #include "lib/plugins.h"
61 * This packet is used for file save info transfer.
64 char *fname; /* Full path and filename */
65 char *link; /* Link name if any */
66 struct stat statp; /* System stat() packet for file */
67 int32_t type; /* FT_xx for this file */
68 uint32_t flags; /* Bacula internal flags */
69 bool portable; /* set if data format is portable */
70 char *cmd; /* command */
74 * This packet is used for file restore info transfer.
77 int32_t stream; /* attribute stream id */
78 int32_t data_stream; /* id of data stream to follow */
79 int32_t type; /* file type FT */
80 int32_t file_index; /* file index */
81 int32_t LinkFI; /* file index to data if hard link */
82 uid_t uid; /* userid */
83 struct stat statp; /* decoded stat packet */
84 const char *attrEx; /* extended attributes if any */
85 const char *ofname; /* output filename */
86 const char *olname; /* output link name */
87 const char *where; /* where */
88 const char *RegexWhere; /* regex where */
89 int replace; /* replace flag */
101 int32_t func; /* Function code */
102 int32_t count; /* read/write count */
103 mode_t mode; /* permissions for created files */
104 int32_t flags; /* open flags (e.g. O_WRONLY ...) */
105 char *buf; /* read/write buffer */
106 int32_t status; /* return status */
107 int32_t io_errno; /* errno code */
112 /****************************************************************************
114 * Bacula definitions *
116 ****************************************************************************/
118 /* Bacula Variable Ids */
133 bEventStartBackupJob = 3,
134 bEventEndBackupJob = 4,
135 bEventStartRestoreJob = 5,
136 bEventEndRestoreJob = 6,
137 bEventStartVerifyJob = 7,
138 bEventEndVerifyJob = 8,
139 bEventBackupCommand = 9,
140 bEventRestoreCommand = 10,
145 typedef struct s_bEvent {
149 typedef struct s_baculaInfo {
154 /* Bacula Core Routines -- not used by plugins */
155 struct BFILE; /* forward referenced */
157 void load_fd_plugins(const char *plugin_dir);
158 void new_plugins(JCR *jcr);
159 void free_plugins(JCR *jcr);
160 void generate_plugin_event(JCR *jcr, bEventType event, void *value=NULL);
161 bool send_plugin_name(JCR *jcr, BSOCK *sd, bool start);
162 void plugin_name_stream(JCR *jcr, char *name);
163 int plugin_create_file(JCR *jcr, ATTR *attr, BFILE *bfd, int replace);
164 bool plugin_set_attributes(JCR *jcr, ATTR *attr, BFILE *ofd);
165 int plugin_save(JCR *jcr, FF_PKT *ff_pkt, bool top_level);
172 * Bacula interface version and function pointers --
173 * i.e. callbacks from the plugin to Bacula
175 typedef struct s_baculaFuncs {
178 bRC (*registerBaculaEvents)(bpContext *ctx, ...);
179 bRC (*getBaculaValue)(bpContext *ctx, bVariable var, void *value);
180 bRC (*setBaculaValue)(bpContext *ctx, bVariable var, void *value);
181 bRC (*JobMessage)(bpContext *ctx, const char *file, int line,
182 int type, time_t mtime, const char *fmt, ...);
183 bRC (*DebugMessage)(bpContext *ctx, const char *file, int line,
184 int level, const char *fmt, ...);
190 /****************************************************************************
192 * Plugin definitions *
194 ****************************************************************************/
202 #define FD_PLUGIN_MAGIC "*FDPluginData*"
203 #define FD_PLUGIN_INTERFACE_VERSION 1
205 typedef struct s_pluginInfo {
209 char *plugin_license;
212 char *plugin_version;
213 char *plugin_description;
217 * This is a set of function pointers that Bacula can call
220 typedef struct s_pluginFuncs {
223 bRC (*newPlugin)(bpContext *ctx);
224 bRC (*freePlugin)(bpContext *ctx);
225 bRC (*getPluginValue)(bpContext *ctx, pVariable var, void *value);
226 bRC (*setPluginValue)(bpContext *ctx, pVariable var, void *value);
227 bRC (*handlePluginEvent)(bpContext *ctx, bEvent *event, void *value);
228 bRC (*startBackupFile)(bpContext *ctx, struct save_pkt *sp);
229 bRC (*endBackupFile)(bpContext *ctx);
230 bRC (*startRestoreFile)(bpContext *ctx, const char *cmd);
231 bRC (*endRestoreFile)(bpContext *ctx);
232 bRC (*pluginIO)(bpContext *ctx, struct io_pkt *io);
233 bRC (*createFile)(bpContext *ctx, struct restore_pkt *rp);
234 bRC (*setFileAttributes)(bpContext *ctx, struct restore_pkt *rp);
237 #define plug_func(plugin) ((pFuncs *)(plugin->pfuncs))
238 #define plug_info(plugin) ((pInfo *)(plugin->pinfo))
244 #endif /* __FD_PLUGINS_H */