fi_prov_ini¶

This entry point must be defined by external providers. On loading, libfabric will invoke fi_prov_ini() to retrieve the provider’s fi_provider structure. Additional interactions between the libfabric core and the provider will be through the interfaces defined by that struct.

fi_param_define¶

Defines a configuration parameter for use by a specified provider. The help_string and param_name arguments must be non-NULL, help_string must additionally be non-empty. They are copied internally and may be freed after calling fi_param_define.

fi_param_get¶

Gets the value of a configuration parameter previously defined using fi_param_define(). The value comes from the environment variable name of the form FI__, all converted to upper case.

If the parameter was previously defined and the user set a value, FI_SUCCESS is returned and (*value) points to the retrieved value.

If the parameter name was previously defined, but the user did not set a value, -FI_ENODATA is returned and the value of (*value) is unchanged.

If the parameter name was not previously defined via fi_param_define(), -FI_ENOENT will be returned and the value of (*value) is unchanged.

If the value in the environment is not valid for the parameter type, -FI_EINVAL will be returned and the value of (*value) is unchanged.

fi_log_enabled / fi_log_ready / fi_log¶

These functions control debug and informational logging output. Providers typically access these functions through the FI_LOG and related macros in fi_log.h and do not call these function directly.

fi_open¶

Open a library resource using a well-known name. This feature allows applications and providers a mechanism which can be used to modify or enhance core library services and behavior. The details are specific based on the requested object name. Most applications will not need this level of control.

The library API version known to the application should be provided through the version parameter. The use of attributes is object dependent. If required, attributes should be provided through the attr parameter, with attr_len set to the size of the referenced attribute structure. The following is a list of published names, along with descriptions of the service or resource to which they correspond.

mr_cache

The mr_cache object references the internal memory registration cache used by the different providers. Additional information on the cache is available in the fi_mr(3) man page.

logging

The logging object references the internal logging subsystem used by the different providers. Once opened, custom logging callbacks may be installed. Can be opened only once and only the last import is used if imported multiple times.

fi_import¶

This helper function is a combination of fi_open and fi_import_fid. It may be used to import a fabric object created and owned by the libfabric user. This allows the upper level libraries or the application to override or define low-level libfabric behavior.

fi_import_log¶

Helper function to override the low-level libfabric’s logging system with new callback functions.

struct fi_ops_log {


    size_t size;


    int (*enabled)(const struct fi_provider *prov, enum fi_log_level level,


               enum fi_log_subsys subsys, uint64_t flags);


    int (*ready)(const struct fi_provider *prov, enum fi_log_level level,


             enum fi_log_subsys subsys, uint64_t flags, uint64_t *showtime);


    void (*log)(const struct fi_provider *prov, enum fi_log_level level,


            enum fi_log_subsys subsys, const char *func, int line,


            const char *msg);
};
struct fid_logging {


    struct fid          fid;


    struct fi_ops_log   *ops;
};
    

version¶

The provider version. For providers integrated with the library, this is often the same as the library version.

fi_version¶

The library interface version that the provider was implemented against. The provider’s fi_version must be greater than or equal to an application’s requested api version for the application to use the provider. It is a provider’s responsibility to support older versions of the api if it wishes to supports legacy applications. For integrated providers