fi_fabric(3)

NAME

fi_fabric - Fabric network operations

fi_fabric / fi_close
    Open / close a fabric network

fi_tostr / fi_tostr_r
    Convert fabric attributes, flags, and capabilities to printable string

SYNOPSIS

    #include <rdma/fabric.h>
    int fi_fabric(struct fi_fabric_attr *attr,
        struct fid_fabric **fabric, void *context);
    int fi_close(struct fid *fabric);
    char * fi_tostr(const void *data, enum fi_type datatype);
    char * fi_tostr(char *buf, size_t len, const void *data,
        enum fi_type datatype);

ARGUMENTS

attr
    Attributes of fabric to open.

fabric
    Fabric network

context
    User specified context associated with the opened object. This context is returned as part of any associated asynchronous event.

buf Output buffer to write string.

len Size in bytes of memory referenced by buf.

data
    Input data to convert into a string. The format of data is determined by the datatype parameter.

datatype
    Indicates the data to convert to a printable string.

DESCRIPTION

A fabric identifier is used to reference opened fabric resources and library related objects.

The fabric network represents a collection of hardware and software resources that access a single physical or virtual network. All network ports on a system that can communicate with each other through their attached networks belong to the same fabric. A fabric network shares network addresses and can span multiple providers. An application must open a fabric network prior to allocating other network resources, such as communication endpoints.

  fi_fabric

Opens a fabric network provider. The attributes of the fabric provider are specified through the open call, and may be obtained by calling fi_getinfo.

  fi_close

The fi_close call is used to release all resources associated with a fabric object. All items associated with the opened fabric must be released prior to calling fi_close.

  fi_tostr / fi_tostr_r

Converts fabric interface attributes, capabilities, flags, and enum values into a printable string. The data parameter accepts a pointer to the attribute or value(s) to display, with the datatype parameter indicating the type of data referenced by the data parameter. Valid values for the datatype are listed below, along with the corresponding datatype or field value.

FI_TYPE_INFO
    struct fi_info, including all substructures and fields

FI_TYPE_EP_TYPE
    struct fi_info::type field

FI_TYPE_EP_CAP
    struct fi_info::ep_cap field

FI_TYPE_OP_FLAGS
    struct fi_info::op_flags field, or general uint64_t flags

FI_TYPE_ADDR_FORMAT
    struct fi_info::addr_format field

FI_TYPE_TX_ATTR
    struct fi_tx_attr

FI_TYPE_RX_ATTR
    struct fi_rx_attr

FI_TYPE_EP_ATTR
    struct fi_ep_attr

FI_TYPE_DOMAIN_ATTR
    struct fi_domain_attr

FI_TYPE_FABRIC_ATTR
    struct fi_fabric_attr

FI_TYPE_THREADING
    enum fi_threading

FI_TYPE_PROGRESS
    enum fi_progress

FI_TYPE_PROTOCOL
    struct fi_ep_attr::protocol field

FI_TYPE_MSG_ORDER
    struct fi_ep_attr::msg_order field

FI_TYPE_MODE
    struct fi_info::mode field

FI_TYPE_AV_TYPE
    enum fi_av_type

FI_TYPE_ATOMIC_TYPE
    enum fi_datatype

FI_TYPE_ATOMIC_OP
    enum fi_op

FI_TYPE_VERSION
    Returns the library version of libfabric in string form. The data parameter is ignored.

FI_TYPE_EQ_EVENT
    uint32_t event parameter returned from fi_eq_read(). See fi_eq(3) for a list of known values.

FI_TYPE_CQ_EVENT_FLAGS
    uint64_t flags field in fi_cq_xxx_entry structures. See fi_cq(3) for valid flags.

FI_TYPE_MR_MODE
    struct fi_domain_attr::mr_mode flags

FI_TYPE_OP_TYPE
    enum fi_op_type

FI_TYPE_FID
    struct fid *

FI_TYPE_HMEM_IFACE
    enum fi_hmem_iface *

FI_TYPE_CQ_FORMAT
    enum fi_cq_format

fi_tostr() will return a pointer to an internal libfabric buffer that should not be modified, and will be overwritten the next time fi_tostr() is invoked. fi_tostr() is not thread safe.

The fi_tostr_r() function is a re-entrant and thread safe version of fi_tostr(). It writes the string into a buffer provided by the caller. fi_tostr_r() returns the start of the caller’s buffer.

NOTES

The following resources are associated with fabric domains: access domains, passive endpoints, and CM event queues.

FABRIC ATTRIBUTES

The fi_fabric_attr structure defines the set of attributes associated with a fabric and a fabric provider.

    struct fi_fabric_attr {
        struct fid_fabric *fabric;
        char              *name;
        char              *prov_name;
        uint32_t          prov_version;
        uint32_t          api_version;
    };

  fabric

On input to fi_getinfo, a user may set this to an opened fabric instance to restrict output to the given fabric. On output from fi_getinfo, if no fabric was specified, but the user has an opened instance of the named fabric, this will reference the first opened instance. If no instance has been opened, this field will be NULL.

The fabric instance returned by fi_getinfo should only be considered valid if the application does not close any fabric instances from another thread while fi_getinfo is being processed.

  name

A fabric identifier.

  prov_name - Provider Name

The name of the underlying fabric provider.

To request an utility provider layered over a specific core provider, both the provider names have to be specified using “;” as delimiter.

e.g. “ofi_rxm;verbs” or “verbs;ofi_rxm”

For debugging and administrative purposes, environment variables can be used to control which fabric providers will be registered with libfabric. Specifying “FI_PROVIDER=foo,bar” will allow any providers with the names “foo” or “bar” to be registered. Similarly, specifying “FI_PROVIDER=^foo,bar” will prevent any providers with the names “foo” or “bar” from being registered. Providers which are not registered will not appear in fi_getinfo results. Applications which need a specific set of providers should implement their own filtering of fi_getinfo’s results rather than relying on these environment variables in a production setting.

  prov_version - Provider Version

Version information for the fabric provider, in a major.minor format. The use of the FI_MAJOR() and FI_MINOR() version macros may be used to extract the major and minor version data. See fi_version(3).

In case of an utility provider layered over a core provider, the version would always refer to that of the utility provider.

  api_version

The interface version requested by the application. This value corresponds to the version parameter passed into fi_getinfo(3).

RETURN VALUE

Returns FI_SUCCESS on success. On error, a negative value corresponding to fabric errno is returned. Fabric errno values are defined in rdma/fi_errno.h.

ERRORS

SEE ALSO

fabric(7), fi_getinfo(3), fi_domain(3), fi_eq(3), fi_endpoint(3)

AUTHORS
OpenFabrics.