From c45466daf05fef298687716c5a1374441b680da5 Mon Sep 17 00:00:00 2001 From: Kern Sibbald Date: Sun, 3 Feb 2008 11:47:29 +0000 Subject: [PATCH] Update git-svn-id: https://bacula.svn.sourceforge.net/svnroot/bacula/trunk@6360 91ce42f0-d328-0410-95d8-f526ca767f89 --- bacula/src/plugins/fd/Makefile | 17 +- bacula/src/plugins/fd/fd-plugins.c | 258 ----------------------------- bacula/src/plugins/fd/fd-plugins.h | 155 ----------------- 3 files changed, 12 insertions(+), 418 deletions(-) delete mode 100644 bacula/src/plugins/fd/fd-plugins.c delete mode 100644 bacula/src/plugins/fd/fd-plugins.h diff --git a/bacula/src/plugins/fd/Makefile b/bacula/src/plugins/fd/Makefile index 190b934148..68a47544c0 100644 --- a/bacula/src/plugins/fd/Makefile +++ b/bacula/src/plugins/fd/Makefile @@ -5,17 +5,24 @@ # No optimization for now for easy debugging CC = g++ -g -O0 -Wall +FDDIR=../../filed +SRCDIR=../.. +LIBDIR=../../lib + .SUFFIXES: .c .o .c.o: - $(CC) -I../.. -I../../filed -DTEST_PROGRAM -c $< + $(CC) -I${SRCDIR} -I${FDDOR} -DTEST_PROGRAM -c $< all: fd-plugins example-plugin-fd.so -fd-plugins: fd-plugins.o fd-plugins.h - $(CC) -L../../lib fd-plugins.o -o main -lbac -lpthread -lssl -l crypto -ldl +fd-plugins.o: ${FDDIR}/fd-plugins.h + $(CC) -I${SRCDIR} -I${FDDOR} -DTEST_PROGRAM -c ${FDDIR}/fd-plugins.c -o fd-plugins.o + +fd-plugins: fd-plugins.o ${FDDIR}/fd-plugins.h + $(CC) -L${LIBDIR} fd-plugins.o -o main -lbac -lpthread -lssl -l crypto -ldl -example-plugin-fd.o: example-plugin-fd.c ../../filed/fd-plugins.h - $(CC) -fPIC -I../.. -c example-plugin-fd.c +example-plugin-fd.o: example-plugin-fd.c ${FDDIR}/fd-plugins.h + $(CC) -fPIC -I../.. -I${FDDIR} -c example-plugin-fd.c example-plugin-fd.so: example-plugin-fd.o $(CC) -shared example-plugin-fd.o -o example-plugin-fd.so diff --git a/bacula/src/plugins/fd/fd-plugins.c b/bacula/src/plugins/fd/fd-plugins.c deleted file mode 100644 index 1547f14a52..0000000000 --- a/bacula/src/plugins/fd/fd-plugins.c +++ /dev/null @@ -1,258 +0,0 @@ -/* - Bacula® - The Network Backup Solution - - Copyright (C) 2007-2008 Free Software Foundation Europe e.V. - - The main author of Bacula is Kern Sibbald, with contributions from - many others, a complete list can be found in the file AUTHORS. - This program is Free Software; you can redistribute it and/or - modify it under the terms of version two of the GNU General Public - License as published by the Free Software Foundation, which is - listed in the file LICENSE. - - This program is distributed in the hope that it will be useful, but - WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU - General Public License for more details. - - You should have received a copy of the GNU General Public License - along with this program; if not, write to the Free Software - Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA - 02110-1301, USA. - - Bacula® is a registered trademark of John Walker. - The licensor of Bacula is the Free Software Foundation Europe - (FSFE), Fiduciary Program, Sumatrastrasse 25, 8006 Zürich, - Switzerland, email:ftf@fsfeurope.org. -*/ -/* - * Main program to test loading and running Bacula plugins. - * Destined to become Bacula pluginloader, ... - * - * Kern Sibbald, October 2007 - */ -#include "bacula.h" -#include "jcr.h" -#include "fd-plugins.h" - -const int dbglvl = 0; -const char *plugin_type = "-fd.so"; - - -/* 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, - int type, time_t mtime, const char *msg); -static bpError baculaDebugMsg(bpContext *ctx, const char *file, int line, - int level, const char *msg); - - -/* Bacula info */ -static bInfo binfo = { - sizeof(bFuncs), - PLUGIN_INTERFACE, -}; - -/* Bacula entry points */ -static bFuncs bfuncs = { - sizeof(bFuncs), - PLUGIN_INTERFACE, - baculaRegisterEvents, - baculaGetValue, - baculaSetValue, - baculaJobMsg, - baculaDebugMsg -}; - -/* - * Create a plugin event - */ -void generate_plugin_event(JCR *jcr, bEventType eventType) -{ - bEvent event; - Plugin *plugin; - int i = 0; - - if (!plugin_list) { - return; - } - - bpContext *plugin_ctx = (bpContext *)jcr->plugin_ctx; - Dmsg2(dbglvl, "plugin_ctx=%p JobId=%d\n", jcr->plugin_ctx, jcr->JobId); - event.eventType = eventType; - foreach_alist(plugin, plugin_list) { - plug_func(plugin)->handlePluginEvent(&plugin_ctx[i++], &event); - } -} - -void load_fd_plugins(const char *plugin_dir) -{ - if (!plugin_dir) { - return; - } - - plugin_list = New(alist(10, not_owned_by_alist)); - load_plugins((void *)&binfo, (void *)&bfuncs, plugin_dir, plugin_type); -} - -/* - * Create a new instance of each plugin for this Job - */ -void new_plugins(JCR *jcr) -{ - Plugin *plugin; - int i = 0; - - if (!plugin_list) { - return; - } - - int num = plugin_list->size(); - - if (num == 0) { - return; - } - - jcr->plugin_ctx = (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); - 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++]); - } -} - -/* - * Free the plugin instances for this Job - */ -void free_plugins(JCR *jcr) -{ - Plugin *plugin; - int i = 0; - - if (!plugin_list) { - return; - } - - bpContext *plugin_ctx = (bpContext *)jcr->plugin_ctx; - Dmsg2(dbglvl, "Free instance plugin_ctx=%p JobId=%d\n", jcr->plugin_ctx, jcr->JobId); - foreach_alist(plugin, plugin_list) { - /* Free the plugin instance */ - plug_func(plugin)->freePlugin(&plugin_ctx[i++]); - } - free(plugin_ctx); - jcr->plugin_ctx = NULL; -} - - -/* ============================================================== - * - * Callbacks from the plugin - * - * ============================================================== - */ -static bpError baculaGetValue(bpContext *ctx, bVariable var, void *value) -{ - JCR *jcr = (JCR *)(ctx->bContext); -// Dmsg1(dbglvl, "bacula: baculaGetValue var=%d\n", var); - if (!value) { - return 1; - } -// Dmsg1(dbglvl, "Bacula: jcr=%p\n", jcr); - switch (var) { - case bVarJobId: - *((int *)value) = jcr->JobId; - Dmsg1(dbglvl, "Bacula: return bVarJobId=%d\n", jcr->JobId); - break; - case bVarFDName: - *((char **)value) = my_name; - Dmsg1(dbglvl, "Bacula: return my_name=%s\n", my_name); - break; - case bVarLevel: - case bVarType: - case bVarClient: - case bVarJobName: - case bVarJobStatus: - case bVarSinceTime: - break; - } - return 0; -} - -static bpError baculaSetValue(bpContext *ctx, bVariable var, void *value) -{ - Dmsg1(dbglvl, "bacula: baculaSetValue var=%d\n", var); - return 0; -} - -static bpError baculaRegisterEvents(bpContext *ctx, ...) -{ - va_list args; - uint32_t event; - - va_start(args, ctx); - while ((event = va_arg(args, uint32_t))) { - Dmsg1(dbglvl, "Plugin wants event=%u\n", event); - } - va_end(args); - return 0; -} - -static bpError 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; -} - -static bpError 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; -} - -#ifdef TEST_PROGRAM - - -int main(int argc, char *argv[]) -{ - char plugin_dir[1000]; - 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); - - jcr1->JobId = 111; - new_plugins(jcr1); - - jcr2->JobId = 222; - new_plugins(jcr2); - - generate_plugin_event(jcr1, bEventJobStart); - generate_plugin_event(jcr1, bEventJobEnd); - generate_plugin_event(jcr2, bEventJobStart); - free_plugins(jcr1); - generate_plugin_event(jcr2, bEventJobEnd); - free_plugins(jcr2); - - unload_plugins(); - - Dmsg0(dbglvl, "bacula: OK ...\n"); - close_memory_pool(); - sm_dump(false); - return 0; -} - -#endif /* TEST_PROGRAM */ diff --git a/bacula/src/plugins/fd/fd-plugins.h b/bacula/src/plugins/fd/fd-plugins.h deleted file mode 100644 index 92e8eccef4..0000000000 --- a/bacula/src/plugins/fd/fd-plugins.h +++ /dev/null @@ -1,155 +0,0 @@ -/* - Bacula® - The Network Backup Solution - - Copyright (C) 2007-2008 Free Software Foundation Europe e.V. - - The main author of Bacula is Kern Sibbald, with contributions from - many others, a complete list can be found in the file AUTHORS. - This program is Free Software; you can redistribute it and/or - modify it under the terms of version two of the GNU General Public - License as published by the Free Software Foundation, which is - listed in the file LICENSE. - - This program is distributed in the hope that it will be useful, but - WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU - General Public License for more details. - - You should have received a copy of the GNU General Public License - along with this program; if not, write to the Free Software - Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA - 02110-1301, USA. - - Bacula® is a registered trademark of John Walker. - The licensor of Bacula is the Free Software Foundation Europe - (FSFE), Fiduciary Program, Sumatrastrasse 25, 8006 Zürich, - Switzerland, email:ftf@fsfeurope.org. -*/ -/* - * Interface definition for Bacula Plugins - * - * Kern Sibbald, October 2007 - * - */ - -#ifndef __FD_PLUGINS_H -#define __FD_PLUGINS_H - -#include -#ifndef __CONFIG_H -#define __CONFIG_H -#include "config.h" -#endif -#include "bc_types.h" -#include "lib/plugins.h" - -#ifdef __cplusplus -extern "C" { -#endif - - - - -/**************************************************************************** - * * - * Bacula definitions * - * * - ****************************************************************************/ - -/* Bacula Variable Ids */ -typedef enum { - bVarJobId = 1, - bVarFDName = 2, - bVarLevel = 3, - bVarType = 4, - bVarClient = 5, - bVarJobName = 6, - bVarJobStatus = 7, - bVarSinceTime = 8 -} bVariable; - -typedef enum { - bEventJobStart = 1, - bEventJobEnd = 2, - bEventBackupStart = 3, - bEventBackupEnd = 4, - bEventRestoreStart = 5, - bEventRestoreEnd = 6, - bEventPluginCommand = 7, - bEventPluginFile = 8 -} bEventType; - -typedef struct s_bEvent { - uint32_t eventType; -} bEvent; - -typedef struct s_baculaInfo { - uint32_t size; - uint32_t version; -} bInfo; - -/* Bacula interface version and function pointers */ -typedef struct s_baculaFuncs { - uint32_t size; - uint32_t version; - bpError (*registerBaculaEvents)(bpContext *ctx, ...); - bpError (*getBaculaValue)(bpContext *ctx, bVariable var, void *value); - bpError (*setBaculaValue)(bpContext *ctx, bVariable var, void *value); - bpError (*JobMessage)(bpContext *ctx, const char *file, int line, - int type, time_t mtime, const char *msg); - bpError (*DebugMessage)(bpContext *ctx, const char *file, int line, - int level, const char *msg); -} bFuncs; - -/* Bacula Subroutines */ -void load_fd_plugins(const char *plugin_dir); -void new_plugins(JCR *jcr); -void free_plugins(JCR *jcr); -void generate_plugin_event(JCR *jcr, bEventType event); - - - -/**************************************************************************** - * * - * Plugin definitions * - * * - ****************************************************************************/ - -typedef enum { - pVarName = 1, - pVarDescription = 2 -} pVariable; - - -#define PLUGIN_MAGIC "*PluginData*" -#define PLUGIN_INTERFACE 1 - -typedef struct s_pluginInfo { - uint32_t size; - uint32_t version; - char *plugin_magic; - char *plugin_license; - char *plugin_author; - char *plugin_date; - char *plugin_version; - char *plugin_description; -} pInfo; - -typedef struct s_pluginFuncs { - uint32_t size; - uint32_t version; - bpError (*newPlugin)(bpContext *ctx); - bpError (*freePlugin)(bpContext *ctx); - bpError (*getPluginValue)(bpContext *ctx, pVariable var, void *value); - bpError (*setPluginValue)(bpContext *ctx, pVariable var, void *value); - bpError (*handlePluginEvent)(bpContext *ctx, bEvent *event); -} pFuncs; - -#define plug_func(plugin) ((pFuncs *)(plugin->pfuncs)) -#define plug_info(plugin) ((pInfo *)(plugin->pinfo)) - -#ifdef __cplusplus -} -#endif - -#endif /* __FD_PLUGINS_H */ -- 2.39.5