---
name: "fi_rstream"
section: "7"
platform: "linux"
package: "libfabric-dev"
version: "1.17.0-3"
release: "Debian 12 (Bookworm)"
platforms: ["linux"]
url: "https://new.carta.tech/fi_rstream"
---

# fi\_rstream(7)

The Rstream Fabric Provider

## NAME

fi\_rstream - The Rstream Fabric Provider

## OVERVIEW

The rstream provider supports stream messaging over message based RMA. It maps stream to message over a core RMA-based OFI provider. Only Endpoints and EQs are needed for connection start-up and messaging. Unlike other OFI providers, rstream does not support CQs or memory registration of any kind. In order to asynchronously wait for a completion (cm/msg), one can use fi\_control on the endpoint/eq to get an fd to use in a poll call. For messaging completions, use FI\_PEEK on send/recv after poll to see what type of transaction has transpired.

## SUPPORTED FEATURES

The rstream provider currently supports *FI\_MSG* capabilities.

- *Endpoint types*

  The provider supports only endpoint type *FI\_EP\_SOCK\_STREAM*.

*Endpoint capabilities* : The following data transfer interface is supported: *fi\_msg*.

- *Modes*

  The provider does not require the use of any mode bits but supports core providers that require FI\_CONTEXT and FI\_RX\_CQ\_DATA.

- *Progress*

  The rstream provider only supports *FI\_PROGRESS\_MANUAL*.

- *Threading Model*

  The provider supports FI\_THREAD\_SAFE

- *Verbs-iWarp*

  The provider has added features to enable iWarp. To use this feature, the ep protocol iWarp must be requested in an fi\_getinfo call.

## LIMITATIONS

The rstream provider is experimental and lacks performance validation and extensive testing. The iWarp protocol may need extra initialization work to re-enable. Currently the rstream provider is used to by the rsockets-OFI library as a ULP and hooks into the core provider verbs. It is not interoperable with the previous rsockets(v1) protocol. There are default settings that limit the message stream (provider memory region size and CQ size). These can be modified by fi\_setopt.

## SETTINGS

The *rstream* provider settings can be modified via fi\_setopt on the endpoint (FI\_OPT\_ENDPOINT) along with the following parameters:

- *FI\_OPT\_SEND\_BUF\_SIZE*

  Size of the send buffer. Default is 32KB.

- *FI\_OPT\_RECV\_BUF\_SIZE*

  Size of the recv buffer. Default is 32KB.

- *FI\_OPT\_TX\_SIZE*

  Size of the send queue. Default is 384.

- *FI\_OPT\_RX\_SIZE*

  Size of the recv queue. Default is 384.

## OFI EXTENSIONS

The rstream provider has extended the current OFI API set in order to enable a user implementation of Poll. Specifically sendmsg(FI\_PEEK) is supported which replicates the behavior of the recvmsg(FI\_PEEK) feature.

## SEE ALSO

[`fabric`(7)](/fabric/7.md), [`fi_provider`(7)](/fi_provider/7.md), [`fi_getinfo`(3)](/fi_getinfo/3.md)

## AUTHORS

OpenFabrics.