* Kern Sibbald, October 2007
*/
#include "bacula.h"
-#include "jcr.h"
-#include "fd-plugins.h"
+#include "filed.h"
-const int dbglvl = 0;
+const int dbglvl = 50;
const char *plugin_type = "-fd.so";
+extern int save_file(JCR *jcr, FF_PKT *ff_pkt, bool top_level);
+
+
+/* Function pointers to be set here */
+extern DLL_IMP_EXP int (*plugin_bopen)(JCR *jcr, const char *fname, int flags, mode_t mode);
+extern DLL_IMP_EXP int (*plugin_bclose)(JCR *jcr);
+extern DLL_IMP_EXP ssize_t (*plugin_bread)(JCR *jcr, void *buf, size_t count);
+extern DLL_IMP_EXP ssize_t (*plugin_bwrite)(JCR *jcr, void *buf, size_t count);
+extern DLL_IMP_EXP boffset_t (*plugin_blseek)(JCR *jcr, boffset_t offset, int whence);
+
/* Forward referenced functions */
-static bpError baculaGetValue(bpContext *ctx, bVariable var, void *value);
-static bpError baculaSetValue(bpContext *ctx, bVariable var, void *value);
-static bpError baculaRegisterEvents(bpContext *ctx, ...);
-static bpError baculaJobMsg(bpContext *ctx, const char *file, int line,
+static bRC baculaGetValue(bpContext *ctx, bVariable var, void *value);
+static bRC baculaSetValue(bpContext *ctx, bVariable var, void *value);
+static bRC baculaRegisterEvents(bpContext *ctx, ...);
+static bRC baculaJobMsg(bpContext *ctx, const char *file, int line,
int type, time_t mtime, const char *msg);
-static bpError baculaDebugMsg(bpContext *ctx, const char *file, int line,
+static bRC baculaDebugMsg(bpContext *ctx, const char *file, int line,
int level, const char *msg);
+static int my_plugin_bopen(JCR *jcr, const char *fname, int flags, mode_t mode);
+static int my_plugin_bclose(JCR *jcr);
+static ssize_t my_plugin_bread(JCR *jcr, void *buf, size_t count);
+static ssize_t my_plugin_bwrite(JCR *jcr, void *buf, size_t count);
+static boffset_t my_plugin_blseek(JCR *jcr, boffset_t offset, int whence);
+
/* Bacula info */
static bInfo binfo = {
sizeof(bFuncs),
- PLUGIN_INTERFACE,
+ PLUGIN_INTERFACE_VERSION
};
/* Bacula entry points */
static bFuncs bfuncs = {
sizeof(bFuncs),
- PLUGIN_INTERFACE,
+ PLUGIN_INTERFACE_VERSION,
baculaRegisterEvents,
baculaGetValue,
baculaSetValue,
baculaDebugMsg
};
+/*
+ * Sequence of calls for a backup:
+ * 1. generate_plugin_event called with bEventPluginCommand
+ * the command string is passed as an argument.
+ * 2. we find the plugin requested on the command string
+ * 3. we generate a bEventPluginCommand event to the specified plugin
+ * 4. we make a startPluginBackup call to the plugin, which gives
+ * us the data we need in save_pkt
+ * 5. we call Bacula's save_file() subroutine to save the specified
+ * file. The plugin will be called at pluginIO() to supply the
+ * file data.
+ *
+ * Sequence of calls for restore:
+ * See subroutine plugin_name_stream() below.
+ */
+
/*
* Create a plugin event
*/
-void generate_plugin_event(JCR *jcr, bEventType eventType)
+void generate_plugin_event(JCR *jcr, bEventType eventType, void *value)
{
bEvent event;
Plugin *plugin;
int i = 0;
+ int len;
+ char *p;
+ char *cmd = (char *)value;
+ struct save_pkt sp;
+ FF_PKT *ff_pkt;
if (!plugin_list) {
return;
}
- bpContext *plugin_ctx = (bpContext *)jcr->plugin_ctx;
- Dmsg2(dbglvl, "plugin_ctx=%p JobId=%d\n", jcr->plugin_ctx, jcr->JobId);
+ bpContext *plugin_ctx_list = (bpContext *)jcr->plugin_ctx_list;
event.eventType = eventType;
+
+ Dmsg2(dbglvl, "plugin_ctx=%p JobId=%d\n", jcr->plugin_ctx_list, jcr->JobId);
+ switch (eventType) {
+ case bEventPluginCommand:
+ /* Handle plugin command here backup */
+ Dmsg1(100, "plugin cmd=%s\n", cmd);
+ if (!(p = strchr(cmd, ':'))) {
+ Jmsg1(jcr, M_ERROR, 0, "Malformed plugin command: %s\n", cmd);
+ goto bail_out;
+ }
+ len = p - cmd;
+ if (len <= 0) {
+ goto bail_out;
+ }
+
+ foreach_alist(plugin, plugin_list) {
+ Dmsg3(100, "plugin=%s cmd=%s len=%d\n", plugin->file, cmd, len);
+ if (strncmp(plugin->file, cmd, len) != 0) {
+ i++;
+ continue;
+ }
+ while (!job_canceled(jcr)) {
+ Dmsg1(100, "Command plugin = %s\n", cmd);
+ if (plug_func(plugin)->handlePluginEvent(&plugin_ctx_list[i], &event, value) != bRC_OK) {
+ goto bail_out;
+ }
+ memset(&sp, 0, sizeof(sp));
+ sp.type = FT_REG;
+ sp.portable = true;
+ sp.cmd = cmd;
+ Dmsg3(000, "startBackup st_size=%p st_blocks=%p sp=%p\n", &sp.statp.st_size, &sp.statp.st_blocks,
+ &sp);
+ if (plug_func(plugin)->startPluginBackup(&plugin_ctx_list[i], &sp) != bRC_OK) {
+ goto bail_out;
+ }
+ jcr->plugin_ctx = &plugin_ctx_list[i];
+ jcr->plugin = plugin;
+ jcr->plugin_sp = &sp;
+ ff_pkt = jcr->ff;
+ ff_pkt->fname = sp.fname;
+ ff_pkt->type = sp.type;
+ memcpy(&ff_pkt->statp, &sp.statp, sizeof(ff_pkt->statp));
+ Dmsg1(000, "Save_file: file=%s\n", ff_pkt->fname);
+ save_file(jcr, ff_pkt, true);
+ /* ***FIXME***/
+ /* add call to endPluginBackup() and loop on bRC_MORE */
+ goto bail_out;
+ }
+ }
+ Jmsg1(jcr, M_ERROR, 0, "Command plugin \"%s\" not found.\n", cmd);
+ break;
+
+ default:
+ /* Pass event to every plugin */
+ foreach_alist(plugin, plugin_list) {
+ bRC rc;
+ rc = plug_func(plugin)->handlePluginEvent(&plugin_ctx_list[i++], &event, value);
+ if (rc != bRC_OK) {
+ break;
+ }
+ }
+ break;
+ }
+
+
+bail_out:
+ return;
+}
+
+/*
+ * Send plugin name start/end record to SD
+ */
+bool send_plugin_name(JCR *jcr, BSOCK *sd, bool start)
+{
+ int stat;
+ struct save_pkt *sp = (struct save_pkt *)jcr->plugin_sp;
+
+ if (!sd->fsend("%ld %d %d", jcr->JobFiles, STREAM_PLUGIN_NAME, start)) {
+ Jmsg1(jcr, M_FATAL, 0, _("Network send error to SD. ERR=%s\n"),
+ sd->bstrerror());
+ return false;
+ }
+ stat = sd->fsend("%ld %d %d %s%c", jcr->JobFiles, start, sp->portable, sp->cmd, 0);
+ if (!stat) {
+ Jmsg1(jcr, M_FATAL, 0, _("Network send error to SD. ERR=%s\n"),
+ sd->bstrerror());
+ return false;
+ }
+ sd->signal(BNET_EOD); /* indicate end of plugin name data */
+ return true;
+}
+
+/*
+ * Plugin name stream found during restore. This is the record
+ * that was generated in send_plugin_name() above.
+ */
+void plugin_name_stream(JCR *jcr, char *name)
+{
+ char *p = name;
+ char *cmd;
+ bool start, portable;
+ bEvent event;
+ Plugin *plugin;
+ int len;
+ int i = 0;
+ bpContext *plugin_ctx_list;
+
+ Dmsg1(000, "plugin stream string=%s\n", name);
+ skip_nonspaces(&p); /* skip over jcr->JobFiles */
+ skip_spaces(&p);
+ start = *p == '1';
+ skip_nonspaces(&p); /* skip start/end flag */
+ skip_spaces(&p);
+ portable = *p == '1';
+ skip_nonspaces(&p); /* skip portable flag */
+ skip_spaces(&p);
+ cmd = p;
+ event.eventType = start ? bEventRestoreStart : bEventRestoreEnd;
+
+ /* Check for restore end */
+ if (!start) {
+ /*
+ * If end of restore, notify plugin, then clear flags
+ */
+ plugin = (Plugin *)jcr->plugin;
+ plug_func(plugin)->handlePluginEvent((bpContext *)jcr->plugin_ctx, &event, cmd);
+ jcr->plugin_ctx = NULL;
+ jcr->plugin = NULL;
+ goto bail_out;
+ }
+
+ /*
+ * After this point, we are dealing with a restore start
+ */
+
+ Dmsg1(000, "plugin cmd=%s\n", cmd);
+ if (!(p = strchr(cmd, ':'))) {
+ Jmsg1(jcr, M_ERROR, 0, "Malformed plugin command: %s\n", cmd);
+ goto bail_out;
+ }
+ len = p - cmd;
+ if (len <= 0) {
+ goto bail_out;
+ }
+
+
+ plugin_ctx_list = (bpContext *)jcr->plugin_ctx_list;
foreach_alist(plugin, plugin_list) {
- plug_func(plugin)->handlePluginEvent(&plugin_ctx[i++], &event);
+ Dmsg3(100, "plugin=%s cmd=%s len=%d\n", plugin->file, cmd, len);
+ if (strncmp(plugin->file, cmd, len) != 0) {
+ i++;
+ continue;
+ }
+ Dmsg1(100, "Command plugin = %s\n", cmd);
+ if (plug_func(plugin)->handlePluginEvent(&plugin_ctx_list[i],
+ &event, (void *)name) != bRC_OK) {
+ goto bail_out;
+ }
+ jcr->plugin_ctx = &plugin_ctx_list[i];
+ jcr->plugin = plugin;
+ goto bail_out;
}
+bail_out:
+ return;
}
+
void load_fd_plugins(const char *plugin_dir)
{
if (!plugin_dir) {
plugin_list = New(alist(10, not_owned_by_alist));
load_plugins((void *)&binfo, (void *)&bfuncs, plugin_dir, plugin_type);
+ plugin_bopen = my_plugin_bopen;
+ plugin_bclose = my_plugin_bclose;
+ plugin_bread = my_plugin_bread;
+ plugin_bwrite = my_plugin_bwrite;
+ plugin_blseek = my_plugin_blseek;
+
}
/*
return;
}
- jcr->plugin_ctx = (void *)malloc(sizeof(bpContext) * num);
+ jcr->plugin_ctx_list = (void *)malloc(sizeof(bpContext) * num);
- bpContext *plugin_ctx = (bpContext *)jcr->plugin_ctx;
- Dmsg2(dbglvl, "Instantiate plugin_ctx=%p JobId=%d\n", jcr->plugin_ctx, jcr->JobId);
+ bpContext *plugin_ctx_list = (bpContext *)jcr->plugin_ctx_list;
+ Dmsg2(dbglvl, "Instantiate plugin_ctx=%p JobId=%d\n", plugin_ctx_list, jcr->JobId);
foreach_alist(plugin, plugin_list) {
/* Start a new instance of each plugin */
- plugin_ctx[i].bContext = (void *)jcr;
- plugin_ctx[i].pContext = NULL;
- plug_func(plugin)->newPlugin(&plugin_ctx[i++]);
+ plugin_ctx_list[i].bContext = (void *)jcr;
+ plugin_ctx_list[i].pContext = NULL;
+ plug_func(plugin)->newPlugin(&plugin_ctx_list[i++]);
}
}
return;
}
- bpContext *plugin_ctx = (bpContext *)jcr->plugin_ctx;
- Dmsg2(dbglvl, "Free instance plugin_ctx=%p JobId=%d\n", jcr->plugin_ctx, jcr->JobId);
+ bpContext *plugin_ctx_list = (bpContext *)jcr->plugin_ctx_list;
+ Dmsg2(dbglvl, "Free instance plugin_ctx=%p JobId=%d\n", plugin_ctx_list, jcr->JobId);
foreach_alist(plugin, plugin_list) {
/* Free the plugin instance */
- plug_func(plugin)->freePlugin(&plugin_ctx[i++]);
+ plug_func(plugin)->freePlugin(&plugin_ctx_list[i++]);
}
- free(plugin_ctx);
- jcr->plugin_ctx = NULL;
+ free(plugin_ctx_list);
+ jcr->plugin_ctx_list = NULL;
}
+static int my_plugin_bopen(JCR *jcr, const char *fname, int flags, mode_t mode)
+{
+ Plugin *plugin = (Plugin *)jcr->plugin;
+ bpContext *plugin_ctx = (bpContext *)jcr->plugin_ctx;
+ struct io_pkt io;
+ Dmsg0(000, "plugin_bopen\n");
+ io.func = IO_OPEN;
+ io.count = 0;
+ io.buf = NULL;
+ plug_func(plugin)->pluginIO(plugin_ctx, &io);
+ return io.status;
+}
+
+static int my_plugin_bclose(JCR *jcr)
+{
+ Plugin *plugin = (Plugin *)jcr->plugin;
+ bpContext *plugin_ctx = (bpContext *)jcr->plugin_ctx;
+ struct io_pkt io;
+ Dmsg0(000, "plugin_bclose\n");
+ io.func = IO_CLOSE;
+ io.count = 0;
+ io.buf = NULL;
+ plug_func(plugin)->pluginIO(plugin_ctx, &io);
+ return io.status;
+}
+
+static ssize_t my_plugin_bread(JCR *jcr, void *buf, size_t count)
+{
+ Plugin *plugin = (Plugin *)jcr->plugin;
+ bpContext *plugin_ctx = (bpContext *)jcr->plugin_ctx;
+ struct io_pkt io;
+ Dmsg0(000, "plugin_bread\n");
+ io.func = IO_READ;
+ io.count = count;
+ io.buf = (char *)buf;
+ plug_func(plugin)->pluginIO(plugin_ctx, &io);
+ return (ssize_t)io.status;
+}
+
+static ssize_t my_plugin_bwrite(JCR *jcr, void *buf, size_t count)
+{
+ Plugin *plugin = (Plugin *)jcr->plugin;
+ bpContext *plugin_ctx = (bpContext *)jcr->plugin_ctx;
+ struct io_pkt io;
+ Dmsg0(000, "plugin_bwrite\n");
+ io.func = IO_WRITE;
+ io.count = count;
+ io.buf = (char *)buf;
+ plug_func(plugin)->pluginIO(plugin_ctx, &io);
+ return (ssize_t)io.status;
+}
+
+static boffset_t my_plugin_blseek(JCR *jcr, boffset_t offset, int whence)
+{
+ Plugin *plugin = (Plugin *)jcr->plugin;
+ bpContext *plugin_ctx = (bpContext *)jcr->plugin_ctx;
+ struct io_pkt io;
+ Dmsg0(000, "plugin_bseek\n");
+ io.func = IO_SEEK;
+ io.offset = offset;
+ io.whence = whence;
+ plug_func(plugin)->pluginIO(plugin_ctx, &io);
+ return (boffset_t)io.offset;
+}
/* ==============================================================
*
*
* ==============================================================
*/
-static bpError baculaGetValue(bpContext *ctx, bVariable var, void *value)
+static bRC baculaGetValue(bpContext *ctx, bVariable var, void *value)
{
JCR *jcr = (JCR *)(ctx->bContext);
// Dmsg1(dbglvl, "bacula: baculaGetValue var=%d\n", var);
if (!value) {
- return 1;
+ return bRC_Error;
}
// Dmsg1(dbglvl, "Bacula: jcr=%p\n", jcr);
switch (var) {
case bVarSinceTime:
break;
}
- return 0;
+ return bRC_OK;
}
-static bpError baculaSetValue(bpContext *ctx, bVariable var, void *value)
+static bRC baculaSetValue(bpContext *ctx, bVariable var, void *value)
{
Dmsg1(dbglvl, "bacula: baculaSetValue var=%d\n", var);
- return 0;
+ return bRC_OK;
}
-static bpError baculaRegisterEvents(bpContext *ctx, ...)
+static bRC baculaRegisterEvents(bpContext *ctx, ...)
{
va_list args;
uint32_t event;
Dmsg1(dbglvl, "Plugin wants event=%u\n", event);
}
va_end(args);
- return 0;
+ return bRC_OK;
}
-static bpError baculaJobMsg(bpContext *ctx, const char *file, int line,
+static bRC baculaJobMsg(bpContext *ctx, const char *file, int line,
int type, time_t mtime, const char *msg)
{
Dmsg5(dbglvl, "Job message: %s:%d type=%d time=%ld msg=%s\n",
file, line, type, mtime, msg);
- return 0;
+ return bRC_OK;
}
-static bpError baculaDebugMsg(bpContext *ctx, const char *file, int line,
+static bRC baculaDebugMsg(bpContext *ctx, const char *file, int line,
int level, const char *msg)
{
Dmsg4(dbglvl, "Debug message: %s:%d level=%d msg=%s\n",
file, line, level, msg);
- return 0;
+ return bRC_OK;
}
#ifdef TEST_PROGRAM
-char my_name = "test-fd";
+int (*plugin_bopen)(JCR *jcr, const char *fname, int flags, mode_t mode) = NULL;
+int (*plugin_bclose)(JCR *jcr) = NULL;
+ssize_t (*plugin_bread)(JCR *jcr, void *buf, size_t count) = NULL;
+ssize_t (*plugin_bwrite)(JCR *jcr, void *buf, size_t count) = NULL;
+boffset_t (*plugin_blseek)(JCR *jcr, boffset_t offset, int whence) = NULL;
+
+int save_file(FF_PKT *ff_pkt, void *vjcr, bool top_level)
+{
+ return 0;
+}
int main(int argc, char *argv[])
{
JCR mjcr1, mjcr2;
JCR *jcr1 = &mjcr1;
JCR *jcr2 = &mjcr2;
+
+ strcpy(my_name, "test-fd");
getcwd(plugin_dir, sizeof(plugin_dir)-1);
load_fd_plugins(plugin_dir);
projects / bacula / bacula / blobdiff