newPlugin(bpContext *ctx)

This is the entry point that Bacula will call when a new “instance” of the plugin is created. This typically happens at the beginning of a Job. If 10 Jobs are running simultaneously, there will be at least 10 instances of the plugin.

The bpContext structure will be passed to the plugin, and during this call, if the plugin needs to have its private working storage that is associated with the particular instance of the plugin, it should create it from the heap (malloc the memory) and store a pointer to its private working storage in the pContext variable. Note: since Bacula is a multi-threaded program, you must not keep any variable data in your plugin unless it is truly meant to apply globally to the whole plugin. In addition, you must be aware that except the first and last call to the plugin (loadPlugin and unloadPlugin) all the other calls will be made by threads that correspond to a Bacula job. The bpContext that will be passed for each thread will remain the same throughout the Job thus you can keep your private Job specific data in it (bContext).

typedef struct s_bpContext {
  void *pContext;   /* Plugin private context */
  void *bContext;   /* Bacula private context */
} bpContext;

This context pointer will be passed as the first argument to all the entry points that Bacula calls within the plugin. Needless to say, the plugin should not change the bContext variable, which is Bacula’s private context pointer for this instance (Job) of this plugin.

See also

• freePlugin(bpContext *ctx)

• getPluginValue(bpContext *ctx, pVariable var, void *value)

• setPluginValue(bpContext *ctx, pVariable var, void *value)

• handlePluginEvent(bpContext *ctx, bEvent *event, void *value)

• startBackupFile(bpContext *ctx, struct save_pkt *sp)

• endBackupFile(bpContext *ctx)

• startVerifyFile(bpContext *ctx, struct save_pkt *sp)

• startRestoreFile(bpContext *ctx, const char *cmd)

• createFile(bpContext *ctx, struct restore_pkt *rp)

• setFileAttributes(bpContext *ctx, struct restore_pkt *rp)

• endRestoreFile(bpContext *ctx)

• pluginIO(bpContext *ctx, struct io_pkt *io)

• bool checkFile(bpContext *ctx, char *fname)

• bRC queryParameter(bpContext *ctx, struct query_pkt *qp)

Possible Next Steps

Go back to Plugin EntryPoints.

Go back to Bacula FD Plugin API.

Go back to Developer Guide.