Information for Khelp Module Implementors¶

struct helper {
	int (*mod_init) (void);
	int (*mod_destroy) (void);
#define	HELPER_NAME_MAXLEN 16
	char			h_name[HELPER_NAME_MAXLEN];
	uma_zone_t		h_zone;
	struct hookinfo		*h_hooks;
	uint32_t		h_nhooks;
	uint32_t		h_classes;
	int32_t			h_id;
	volatile uint32_t	h_refcount;
	uint16_t		h_flags;
	TAILQ_ENTRY(helper)	h_next;
};

Modules must instantiate a struct helper, but are only required to set the h_classes field, and may optionally set the h_flags, mod_init and mod_destroy fields where required. The framework takes care of all other fields and modules should refrain from manipulating them. Using the C99 designated initialiser feature to set fields is encouraged.

If specified, the mod_init function will be run by the khelp framework prior to completing the registration process. Returning a non-zero value from the mod_init function will abort the registration process and fail to load the module. If specified, the mod_destroy function will be run by the khelp framework during the deregistration process, after the module has been deregistered by the khelp framework. The return value is currently ignored. Valid khelp classes are defined in <sys/khelp.h>. Valid flags are defined in <sys/module_khelp.h>. The HELPER_NEEDS_OSD flag should be set in the h_flags field if the khelp module requires persistent per-object data storage. There is no programmatic way (yet) to check if a khelp class provides the ability for khelp modules to associate persistent per-object data, so a manual check is required.

The KHELP_DECLARE_MOD() and KHELP_DECLARE_MOD_UMA() macros provide convenient wrappers around the DECLARE_MODULE(9) macro, and are used to register a khelp module with the khelp framework. KHELP_DECLARE_MOD_UMA() should only be used by modules which require the use of persistent per-object storage i.e. modules which set the HELPER_NEEDS_OSD flag in their struct helper's h_flags field.

The first four arguments common to both macros are as follows. The hname argument specifies the unique ascii(7) name for the khelp module. It should be no longer than HELPER_NAME_MAXLEN-1 characters in length. The hdata argument is a pointer to the module's struct helper. The hhooks argument points to a static array of struct hookinfo structures. The array should contain a struct hookinfo for each hhook(9) point the module wishes to hook, even when using the same hook function multiple times for different hhook(9) points. The version argument specifies a version number for the module which will be passed to MODULE_VERSION(9). The KHELP_DECLARE_MOD_UMA() macro takes the additional ctor and dtor arguments, which specify optional uma(9) constructor and destructor functions. NULL should be passed where the functionality is not required.

The khelp_get_id() function returns the numeric identifier for the khelp module with name hname.

The khelp_get_osd() function is used to obtain the per-object data pointer for a specified khelp module. The hosd argument is a pointer to the underlying subsystem object's struct osd. This is provided by the hhook(9) framework when calling into a khelp module's hook function. The id argument specifies the numeric identifier for the khelp module to extract the data pointer from hosd for. The id is obtained using the khelp_get_id() function.

The khelp_add_hhook() and khelp_remove_hhook() functions allow a khelp module to dynamically hook/unhook hhook(9) points at run time. The hki argument specifies a pointer to a struct hookinfo which encapsulates the required information about the hhook(9) point and hook function being manipulated. The HHOOK_WAITOK flag may be passed in via the flags argument of khelp_add_hhook() if malloc(9) is allowed to sleep waiting for memory to become available.

Integrating Khelp Into a Kernel Subsystem¶

• Embed a struct osd pointer in the structure definition for the object.
• Add calls to khelp_init_osd() and khelp_destroy_osd() to the subsystem code paths which are responsible for respectively initialising and destroying the object.

The khelp_init_osd() function initialises the per-object data storage for all currently loaded khelp modules of appropriate classes which have set the HELPER_NEEDS_OSD flag in their h_flags field. The classes argument specifies a bitmask of khelp classes which this subsystem associates with. If a khelp module matches any of the classes in the bitmask, that module will be associated with the object. The hosd argument specifies the pointer to the object's struct osd which will be used to provide the persistent storage for use by khelp modules.

The khelp_destroy_osd() function frees all memory that was associated with an object's struct osd by a previous call to khelp_init_osd(). The hosd argument specifies the pointer to the object's struct osd which will be purged in preparation for destruction.