git.sur5r.net Git - bacula/bacula/blob - bacula/src/lib/plugins.h

   1 /*
   2    Bacula® - The Network Backup Solution
   3
   4    Copyright (C) 2007-2008 Free Software Foundation Europe e.V.
   5
   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.
  12
  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.
  17
  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
  21    02110-1301, USA.
  22
  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.
  27 */
  28 /*
  29  * Common plugin definitions
  30  *
  31  * Kern Sibbald, October 2007
  32  */
  33 #ifndef __PLUGINS_H
  34 #define __PLUGINS_H
  35
  36 /****************************************************************************
  37  *                                                                          *
  38  *                Common definitions for all plugins                        *
  39  *                                                                          *
  40  ****************************************************************************/
  41
  42 #ifndef BUILD_PLUGIN
  43 extern DLL_IMP_EXP alist *plugin_list;
  44 #endif
  45
  46 /* Universal return codes from all plugin functions */
  47 typedef enum {
  48   bRC_OK     = 0,                        /* OK */
  49   bRC_Stop   = 1,                        /* Stop calling other plugins */
  50   bRC_Error  = 2,                        /* Some kind of error */
  51   bRC_More   = 3,                        /* More files to backup */
  52   bRC_Term   = 4                         /* Unload me */
  53 } bRC;
  54
  55
  56 /* Context packet as first argument of all functions */
  57 struct bpContext {
  58   void *bContext;                        /* Bacula private context */
  59   void *pContext;                        /* Plugin private context */
  60 };
  61
  62 extern "C" {
  63 typedef bRC (*t_loadPlugin)(void *binfo, void *bfuncs, void **pinfo, void **pfuncs);
  64 typedef bRC (*t_unloadPlugin)(void);
  65 }
  66
  67 class Plugin {
  68 public:
  69    char *file;
  70    t_unloadPlugin unloadPlugin;
  71    void *pinfo;
  72    void *pfuncs;
  73    void *pHandle;
  74    bool disabled;
  75 };
  76
  77 /* Functions */
  78 extern Plugin *new_plugin();
  79 extern bool load_plugins(void *binfo, void *bfuncs, const char *plugin_dir, const char *type);
  80 extern void unload_plugins();
  81
  82 /* Each daemon can register a debug hook that will be called
  83  * after a fatal signal
  84  */
  85 typedef void (dbg_plugin_hook_t)(Plugin *plug, FILE *fp);
  86 extern void dbg_plugin_add_hook(dbg_plugin_hook_t *fct);
  87
  88 #endif /* __PLUGINS_H */