Projects/Plugin support improvements
Motivations, Priorities & Requirements
Motivations: there are a number of motivations behind the creation of the plugin architecture framework.
- Desire to separate pluggable interface from its implementation;
- Desire to provide simple and clear mechanism that facilitates additions of new pluggable interfaces and their implementations (modules);
- Handles both built-in and dynamic plugin modules;
- Allows multiple implementation of the same pluggable interface;
- Provides uniform way to supply parameters for plugin configuration;
- Allows one plugin implementation (module) to use services provided by the other plugin implementations.
Requirements: from these items we have developed a more formal set of requirements covering the design and the implementation of the framework to support the plugins. These are as follows:
- Allow third parties to implement multiple plugin modules for each pluggable interface.
- Allow a plugin module to build as dynamic or built-in from the same source code.
- Allow third parties to more easily create new plugin modules.
- Provide a uniform method for configuring discovery of plugin modules.
- Improve readability of code that calls pluggable interfaces.
- Allow easier creation of new pluggable interfaces.
- Allow incremental transition of existing pluggable interfaces to the new framework.
Architecture Overview and Concepts
The architecture for the plugin framework is shown in the following figure. The participants and components are described in the section below.
The following is a summary of participants and components within the architecture. Further details are provided in the sections below.
Plugin Manager: The plugin manager provides a set of generic capabilities that are independent of individual plugin interfaces. The plugin manager implements operations that manage plugin configuration and plugin registry services. It is responsible for managing plugin handles and provides discovery capabilities for consumers or callers.
Pluggable Interface: A pluggable interface is an interface that can be implemented by a third party in a modular manner. An implementation of a pluggable interface is referred to as a plugin module. Furthermore, a pluggable interface itself consist of a consumer interface and provider interface (see below).
Plugin Module: A plugin module is an implementation of a pluggable interface. For example, in the Figure Plugin_A is shown to have two implementations (modules).
Consumer: The consumer or caller is the entity that uses the plugin module. The consumer or caller may also perform discovery of available modules prior to using them.
As shown in the above Figure, the plugin architecture is designed based on the notion of pluggable interfaces, each of which are defined based on an abstract design.
When a third party wishes to develop a loadable plugin module (e.g. Plugin_Module_A1) that implements a specific task (e.g. implement password quality check), the developer of the module must conform to the pluggable interface (Pluggable Interface A) defined for that "family" of plugin modules.
The consumer (or caller) that later makes use of the plugin module, must invoke functions implemented in that module through a specific consumer interface (Consumer_Interface_A). Discovery (and filtering) is triggered by the first load operation (within a krb5_context).
(Note: The previous version of the architecture, the abstract design was explain in terms of object-oriented classes. However, in order to avoid confusion with respect to the language of the implementation, in the current architecture we have intentionally used the term "abstract definition". The intent here is to denote the fact that abstract definitions are logical constructs that are not implemented).
In this section we provide further details on the components of the architecture, describing its features and behaviors.
The plugin manager provides a set of generic support capabilities that are independent of individual pluggable interfaces. It centralizes the discovery process for plugin modules. Typically, consumers of pluggable interfaces do not call it directly. Instead a consumer calls a loader function (of the specific pluggable interface) which in-turn calls the plugin manager.
In this architecture, the
krb5_init_context() functions will create and configure a plugin manager context that will exist in the krb5_context. A consumer application may use
krb5_get_plm() to retrieve the plugin manager context so it can register its own built-in plugin modules. Libraries such as libkadm5 register their own built-in plugin modules this way also.
The plugin manager locates plugin modules using both a numeric identifier (that designates a plugin interface) and a string (that names a module which implements that pluggable interface). The primary way to use the plugin manager is to query it for the vtable constructor for a specified module (or a set of vtable constructors for all modules of that interface).
As a lower-level interface that supports backward compatibility for older loadable-module provider interfaces, the plugin manager can create an opaque locator handle for a specified module. The plugin manager also supports looking up sets of locator handles (for all modules implementing a specified pluggable interface).
Additional functions in the plugin manager interface allow for lookups of symbols in the plugin module (if supported by that module).
The plugin manager keeps track of modules through its registries. These are discussed as follows.
Registry of built-in modules
This registry keeps track of built-in modules. Typically, libkrb5 will initialize this with locators for all of the built-in modules that are linked into it. Applications can also register private built-in plugin modules using this registry.
Registry of loadable modules
This registry keeps track of a few additional items needed for locating loadable modules. This includes a base directory pathname to a directory tree of plugin modules. Each subdirectory of the base directory has a name that corresponds to the pluggable interface identifier for the modules that intended to be in that subdirectory. Caching of vtable constructors of previously-loaded dynamically loadable modules can occur.
A pluggable interface is an interface (possibly internal to a library) that can be implemented by a third party in a modular, well-compartmentalized manner. These implementations of pluggable interfaces are called plugin modules. Pluggable interfaces allow a consumer to use the capabilities of the interface without needing to be aware of the implementation details. In particular, a pluggable interface prevents the consumer from needing to know whether the module is a built-in or a dynamically loadable module.
Pluggable interfaces can be one-to-one, or one-to-many. An example of one-to-one is the DAL, and an example of one-to-many is preauth.
A pluggable interface has two parts: a consumer interface and a provider interface. Typically, library code implements the consumer interface, and application code or other library code calls the functions of the consumer interface.
The consumer interface isolates the consumer from implementation details of the pluggable interface. The consumer does not generally need to know about whether a given module is built-in or dynamically loaded. The implementation of a consumer interface is essentially a glue layer, and can make use of domain-independent (not specific to any pluggable interface) capabilities of the plugin framework. The consumer might explicitly register a new plugin module that it implements: this capability is part of the plugin manager.
A consumer of a pluggable interface uses an opaque handle (obtained from a loader function that is part of the pluggable interface) to call the methods of a plugin module. Each method of the consumer interface is an ordinary C function that takes the opaque handle either explicitly as its first argument or implicitly by some means such as a module name. In essence, these pluggable interface functions in the architecture are wrapper functions that call through function pointers contained in the opaque plugin module handle object.
A handle can represent:
- the plugin module itself
- a resource to which the plugin module provides access (e.g., a ccache handle)
- a set of plugin modules (e.g., the set of all available preauth mechanisms)
One rationale for using wrapper functions instead of having the consumer directly invoke methods through a function pointer is to make it easier for debuggers and analysis tools to recognize when a particular interface method is being called. (Function pointers might have identifier names that look nothing like the actual name of the function they point to, in addition to enabling confusing aliasing.)
The loader function is specific to the pluggable interface. One reason is for type safety: there will be a distinct opaque handle type for each pluggable interface, allowing compile-time checking to catch some sorts of programming errors. Another reason is backward compatibility: it allows a pluggable interface to support plugin modules that implement an older provider interface.
A plugin module is a unit of code that implements (among others) the provider interface portion of a pluggable interface. Plugin modules can be built in or dynamically loaded. Several alternatives exist for the form of the provider interface, but some have significant advantages in allowing the plugin module to use identical source code for both built-in and loadable modules.
A built-in module is a module whose executable code is located within the library shared object or executable program file, or behaves as if it were. (While separate library shared objects that the calling library depends on can contain "built-in" modules for the calling library, this can cause problems with cyclic references.) The distinguishing characteristic of a built-in module is that, as part of program startup, the operating system automatically maps the executable code of the module into the address space of the process that calls it, without any explicit action by the library or program.
A dynamically loaded module is a module whose executable code is located within a file that is distinct from the library or program that calls it. The plugin framework uses the runtime linker (or equivalent) to explicitly map the executable code of the module into the process address space. (In POSIX systems, this is typically done using
Loadable module provider interface
The domain-independent part of the provider interface of a loadable module consists of a single exported function symbol, which denotes the vtable constructor function for that module. The signature of the constructor is specific to the plugin interface the module implements. The contents of the vtable are also specific to the plugin interface.
The constructor usually takes as arguments the following:
- an interface version number
- a pointer to a caller-allocated vtable structure for the interface,
- the size of the structure (as an added precaution against version mismatches).
The name of the function symbol is constructed from the name of the plugin interface and the name of the plugin module. This allows the caller to see just from the symbol name which interface and plugin it is calling.
DELETE- Although the caller (actually the plugin support code) allocates the vtable structure in the above description, one alternative is to have the module perform the allocation of the structure itself. This can cause problems if the module uses a different memory allocator than the caller.
DELETE - Another alternative is to have the vtable constructor instead return a pointer to a compiled-in vtable. This might cause performance problems related to copy relocations.
Built-in-module provider interface
A built-in module provides the same interface as a loadable module. In this architecture we use an exported function symbol for each loadable module implementing a pluggable interface.
Domain Specific and Domain-Independent Modules
The architecture recognizes two "types" of plugin modules, namely domain-independent (not specific to a particular pluggable interface) modules and domain-specific modules. The intent here is to have a number of pluggable interfaces, each encapsulating a set of related capabilities in a way that allows third parties to implement the interfaces easily (both domain-specific and domain-independent).
- plugin manager
- generic plugin registry and support services
- provider interface
- the generic interface that a plugin module implements to interact with the plugin manager
- this includes the pluggable interfaces
- consumer interface
- the interface that a user of a plugin accesses
- provider interface
- the interface that a plugin module implements to interact with the consumer
A consumer of a pluggable interface initializes the plugin manager (usually implicitly via
krb5_init_context()) and uses the consumer interface to access the services of the plugin moudle. The bulk of the consumer interface is a set of ordinary C functions that takes an opaque plugin module handle as a parameter (which may be provided implicitly, depending on interface). Typically the consumer obtains an opaque plugin module handle by calling a domain-specific plugin loader, which is part of the consumer interface.
The provider interface has both a domain-independent part and a domain-specific part. The plugin manager interacts with the domain-independent part of a plugin module, while the consumer interface implementation interacts with the domain-specific part of a plugin module. The same plugin module source code can be built as either a built-in or dynamically loaded module.
krb5_init_context()function initializes a plugin manager context that resides in the krb5_context.
- It registers libkrb5 built-in modules (from static tables), and reads location parameters of dynamically-loaded plugin modules (if any) from the
krb5.conf(or other configuration profile).
- It calls the plugin manager methods to configure the locations of dynamically-loaded plugin modules.
- The consumer calls the plugin loader function (for the desired pluggable interface).
- The loader function calls the plugin manager to retrieve the vtable constructor function for the appropriate module and builds an opaque module handle to give to the consumer.
- The plugin manager looks up the vtable constructor to give to the loader function of the pluggable interface.
- The consumer calls the wrapper functions (of the pluggable interface), passing the opaque module handle in order to access the capabilities of the pluggable interface.
Adding new modules at run time
An application can register its own plugin modules at run time by calling the plugin manager function to update the registry.
Older dynamically loadable modules that don't conform to the "vtable constructor function" provider model can be handled with specialized loader functions. If a pluggable interface needs to support a legacy loadable module of this sort, it can contain a more elaborate loader function that uses the lower-level capabilities of the plugin manager to:
- obtain an opaque locator handle for a module (or set of modules)
- look up data or function symbols from a module locator handle (or set of locator handles)
he following functions are meant to be used by a consumer of pluggable interfaces:
- initialize a plugin manager context
- shut down a plugin manager context
- register a vtable constructor (e.g., for a built-in module)
- set the base directory for dynamic plugin modules
- set the search path for dynamic plugin modules of a specific interface
The following functions are meant to be used by a loader function of a pluggable interface:
- get a vtable constructor
- get a set of vtable constructors
The following functions are meant to be used by a loader function that needs to do lower-level operations (particularly for backward compatibility with older loadable modules). They are typically not implemented by registries that only track built-in modules:
- retrieve a module locator handle
- retrieve a set of module locator handles
- get a vtable constructor function from a module locator
- get a data symbol from a module locator
- get a function symbol from a module locator
- get a set of vtable constructor functions from a module locator set
- get a set of data symbol from a module locator set
- get a set of function symbol from a module locator set