Libfabric release notes

This file contains the main features as well as overviews of specific bug fixes (and other actions) for each version of Libfabric since version 1.0.

v1.11.0, Fri Aug 14, 2020

Core

Add generalized hmem_ops interface for device ops
Add FI_HMEM_CUDA, FI_HMEM_ROCR, and FI_HMEM_ZE interfaces and device support
Add CUDA and ROCR memory monitors and support for multiple monitors
Add fi_tostr for FI_HMEM_* interfaces
Add utility interface and device support
Add documentation for hmem override ops
Save mr_map mem_desc as ofi_mr
Rework and reorganize memory monitor code
Add mr_cache argument flush_lru to ofi_mr_cache_flush
Fix 1.1 ABI domain, EP, and tx attributes
Add loading of DL providers by name
Add CMA wrappers and define CMA for OSX
Fix util getinfo: use base fi_info caps, altering mr_mode properly, FI_MR_HMEM support, NULL hints, set CQ FI_MSG flag, query FI_COLLECTIVE, list FI_MATCH_COMPLETE, select and request specific core provider
Add rbmap interface to get root node
Add support of AF_IB to addr manipulation functions
Windows: Map strtok_r() to strtok_s()
Define OFI_IB_IP_{PORT,PS}_MASK
Make fi_addr_format() public
Remove mr_cache entry subscribed field
Update memhooks brk and implement sbrk intercepts
Fix vrb_speed units
Fix possible null dereference in ofi_create_filter
Add ofi_idx_ordered_remove
Add functions ofi_generate_seed() and ofi_xorshift_random_r()
Call correct close fd call in util_wait_fd_close
Set a libfabric default universe size
Add compatibility with SUSE packaging
Windows: Handle socket API size limitations
Fix UBSAN warnings
Save and restore the errno in FI_LOG
Ensure that access to atomic handlers are in range
Ensure ifa_name is null terminated in ofi_get_list_of_addr
Buffer pools fallback to normal allocations when hugepage allocations fail

EFA

Add support to use user posted receive buffers with RDM EP when requested
Various fixes to FI_HMEM support
Added fork handler and abort if rdma-core is incorrectly configured
Fix bandwidth regression due to increased structure size
Reuse verbs protection domain when in same process address space
Periodically flush MR cache to reduce MR usage
Properly handle setting/unsetting RDMAV_HUGEPAGES_SAFE
Fix provider_version reported by EFA
Populate additional fields in fid_nic
Fix various bugs in the completion, info, and domain paths
Fix various memory leaks

PSM2

Treat dynamic connection errors as fatal
Add missing return status checking for PSM2 AM calls

RxD

updated AV design to be dynamically extensible using indexer and index map.
updated static allocation of peers with runtime allocation during rts.
added wrapper to fetch pointer to a peer from the peers data structure.
Updated to show correct msg_ordering.
Check datatype size when handling atomic ops.
Verify atomic opcode in range for fixing Klocwork issue.
Corrected use of addr in rxd_atomic_inject for retrieving rxd_addr.

RxM

Align reporting of FI_COLLECTIVE with man pages
Show correct ordering of atomic operations
Fix error handling inserting IP addresses into an AV
Minor code cleanups and bug fixes
Select different optimizations based on running over tcp vs verbs
Use SRX by default when using tcp to improve scaling
Correct CQ size calculation when using SRX
Fix MR registration error path when handling iov's
Allow selecting tcp wait objects separate from verbs
Only repost Rx buffers if necessary

SHM

Fix a CMA check bug
Fix shm provider signal handler calling the original handler
Add initial framework for IPC device copies
Add FI_HMEM support and integrate hmem_ops
Fix error handling path in smr_create
Fix AV insertion error handling
Verify atomic op value
Redefine shm addrlen to not use NAME_MAX
Fix snprintf to exclude byte for null terminator
Mark smr_region as volatile
Fix memory leaks

Sockets

Fix backwards compatibility accessing struct fi_mr_attr
Fix use after free error in CM threads
Free unclaimed messages during endpoint cleanup to avoid memory leaks
Improve handling of socket disconnection
Limit time spent in progress when expected list is long
Avoid thread starvation by converting spinlocks to mutex

TCP

Minor bug fixes
Verify received opcode values are valid
Avoid possible receive buffer overflow from malformed packets
Fix fi_cq_sread failing with ECANCELED
Optimize receive progress handling
Do not alter pseudo random sequence numbers
Increase default listen backlog size to improve scaling
Handle processing of NACK packets during connection setup
Fix wrong error handling during passive endpoint creation
Add logging messages during shutdown handling
Improve logging and error handling
Fix possible use after free issues during CM setup
Minor code restructuring

Util

Use internal flags in place of epoll flags for portability
Support HMEM with the mr_cache
Verify application requested FI_HMEM prior to accessing fi_mr_attr fields
Fix memory leak when using POLLFD wait sets
Ensure AV data is aligned even if address length is not
Fix handling of mr mode bits for API < 1.5
Allow user to force use of userfaultfd memory monitor

Verbs

Add support for AF_IB and native IB addressing
Minor code cleanups
Avoid possible string overrun parsing interface names
Fix memory leak handling duplication interface names
Add XRC shared Rx CQ credit reservation
Fix possible segfault when closing an XRC SRQ
Fix verbs speed units to MBps
Add flow control support to avoid RQ overruns
Fix memory leak of address data when creating endpoints

v1.10.1, Fri May 8, 2020

Core

Fixed library version

EFA

Allow endpoint to choose shm usage
Fix handling of REQ packets
Fix logic writing a Tx completion entry
Use correct Tx operation flags for msg sends

Fabtests

Use pax tar format when creating source packages

RxD

Use correct peer address for atomic_inject calls

SHM

Fix BSD build failure

TCP

Add locking around signaling a wait fd

v1.10.0, Fri Apr 24, 2020

Core

Added new pollfd wait object to API
Added ability to query for a fid's wait object type
Updated most providers to a new provider versioning format
Support using multiple fds for blocking calls, in place of epoll
Fix memory leak when destroying rbtrees
Record interface names and network names for IP addressable providers
Improved performance of timing calculations
Improvements to MR caching mechanism

EFA

Replaces custom admin commands with native use of rdma-core APIs
Added support for FI_RMA using RDMA Reads
Added rendezvous protocol for long messages using RDMA Reads
Added support for CUDA buffers (FI_HMEM)
Added medium-message protocol
Added support for atomic operations
Added randomized Queue Key assignment to endpoints
Improved support for client-server applications
Disables use of shared-memory if FI_LOCAL_COMM is not required
Updated protocol to v4
Refactor packet handling functions and headers for better extensibility
Added handshake protocol to negotiate protocol features with peers
Refactor send/recv paths for improved memory descriptor handling
Use inlined device sends for FI_INJECT
Removes fork() to detect CMA support from the init path
Better reuse of MRs keys across EFA and SHM control path
Squashes the MR functions in the RxR and EFA layers
Squashes the AV functions in the RxR and EFA layers
Use 0-based offset if FI_MR_VIRT_ADDR not set
Retries memory registration in MR cache error paths
Fixes to addr_format handling in the RDM endpoint
Fixes memory leaks
Fixes AV error handling paths
Fixes shm error handling paths
Fixes compiler warnings

PSM2

Improve source address translation for scalable endpoints

RxM

Add support for pollfd wait objects
Fix double free in error path
Report CQ errors for failed RMA transfers
Fixing locking in tagged receive path
Remove incorrect rx_attr capability bits
Handle unexpected messages when posting multi-recv buffers
Repost multi-recv buffers to the receive queue head
Fix unexpected message handling
Fix stall in collective progress caused by lost receive buffers
Add support for collection operations

RxD

Replace rxd_ep_wait_fd_add with direct call to ofi_wait_fd_add
Reorganize attr caps
Add rxd to fi_provider man page

SHM

Fix pointer ofi_cq_init progress pointer
Add CQ wait object support with new FI_WAIT_YIELD wait type
Include string terminator in addrlen
Fix av_insert address cast
Fix unexpected messaging processing on empty receive queue
Fix unexpected messaging locking
Progress unexpected queue for non-tagged receives
Move ep_name_list initialization/cleanup and fix signal handling
Reorganize attr caps
Warn once on peer mapping failures
Add FI_DELIVERY_COMPLETE support
Fix FI_MULTI_RECV reporting and allow writing to overflow CQ for unexpected MULTI_RECV
Refactor and simplify msg processing, formating, and recv posting
Rename ep_entry to rx_entry and add tx_entry for pending outgoing messages
Properly align cmd data
Return correct addrlen on av lookup
Fix id passed into rma fast path
Fix typo
Fix potential data ordering issue in atomic fetch path
Add proper RMA read protocol without CMA
Add runtime CMA check during mapping
Add mmap-based fallback protocol for large messages without CMA
Add large message segmentation fallback protocol for large messages without CMA and add FI_SHM_SAR_THRESHOLD to control switching between segmentation and mmap
Define macros for address translation
Allow building of shm provider on older kernels with x86 arch
Rename peer_addr to peer_data
Change locking when progressing response entries
Fix cmd_cnt increment on RMA ops
Add error handling when inserting more than SMR_MAX_PEERS
Add shm size space check
Fix locking when processing response from self
Add locking around the ep_name_list

TCP

Fix incorrect signaling of fd waking up thread in fi_cq_sread
Switch to using pollfd wait object instead of epoll as default
Add missing ep lock to fix possible ep list corruption
Remove incorrectly reported CQ events posted to EQ
Update domain name to IP network name
Improved socket processing to improve scalability and performance
Remove incorrect implementation of FI_MULTI_RECV support
Report error completions even if successful completion is suppressed
Report correct EQ event for aborted connections

Verbs

Fix XRC request identification
Fix small memory leak for XRC connections
Add retry logic for XRC connections
Fix mapping of domains to NICs when multiple NICs are present
Allow filtering of device names via environment variable
Fix compilation with -fno-common option
Code restructuring to improve maintenance

v1.9.1, Fri Mar 6, 2020

Core

Fix gcc 9.2 warnings
Fix thread hangs in MR cache when using userfaultfd monitor
Add missing header for FreeBSD build
Allow a core provider to discover and use filtered providers

EFA

Change MR cache count and size limits
Fixes to 32-bit msg_id wraparound handling
Adds address map to look up EFA address from shm address
Remove unnecessary EFA device name check
Detect availability of CMA directly from EFA provider
Use OFI_GETINFO_HIDDEN flag when querying for shm
Allow use of EFA when shm is unavailable
Fixes info and domain capabilities for RDM endpoint
Fixes to dest_addr returned with info objects
Fixes segfault in efa_mr_cache_entry_dereg()
Fixes compilation warning in DSO build of the provider
Fixes compilation errors with -fno-common
Fixes to send-side control path

PSM2

Clean up of AV entries that have been removed

RxM

Fix multi-recv buffer handling to use entire buffer
Consume entire multi-recv buffer before using buffer
Continue execution after handling transfer errors
Properly cleanup CM progress thread
Minor code cleanups and restructuring

SHM

Properly restore captured signals
Track ptrace_scope globally, and allow disabling
Properly initialize endpoint name list
Fix potential deadlock resulting from missed handling of unexpected messages
Fix multi-threading issue accessing unexpected messages
Handle multiple addresses passed to fi_av_insert
NULL terminate address strings
Pass correct pointer to ofi_cq_init

TCP

Removed incorrect implementation for multi-recv buffer support
Always report error completions
Report correct EQ event for aborted connection requests
Improve connection data corner cases

Verbs

Fix segfault handling error completions
Avoid null dereference handling EQ events
Remove possible deadlock in XRC error path
Enable credit tracking to avoid SQ, RQ, and CQ overruns
Verify that CQ space is available for bound EPs
Minor code cleanups and restructuring

v1.9.0, Fri Nov 22, 2019

Core

Add generic implementation for collective operations
Add support for traffic class selection
Fixes and enhancements to memory registration cache
Add support for older kernels to the MR cache (hook malloc related calls)
Fix setting loopback address byte ordering
Fix MR cache locking from spinlock to a mutex to avoid starvation
Add API enhancements for heterogeneous memory (e.g. GPUs)
Limit default size of MR cache to avoid out of memory errors
Fix g++ compile error
Enhanced the hooking provider infrastructure
Enhanced windows support for IPv6 and NIC selection
Fix timeout calculation in wait operations
Add simple spell checker for FI_PROVIDER
Fix red-black tree possible use after free issue
Fix segfault running libfabric within a linux container
Minor cleanups and bug fixes
Work-around possible long delay in getaddrinfo()

EFA

Introduce support for shared-memory communication using shm provider
Enable Memory Registration caching by default
Refactor TX and CQ handling functions to reduce branching
Use application-provided MR descriptors when available
Optimize progress engine polling loop for shm and EFA completions
Enable inline registration for emulated RMA reads
Inherit FI_UNIVERSE_SIZE for AV sizing
Increase default min AV size to 16K
Fix uninitialized objects with DSO build of the provider
Fix handling of FI_AV_UNSPEC
Fix crash and resource leak with fi_cancel() implementation
Fix issues with EFA's registration cache under efa;ofi_rxd
Fix MR allocation handlers to use correct pointer and size
Fix error handling in multi-recv completion code
Fix compilation errors when built with valgrind annotations
Fix compilation errors when packet poisoning was enabled
Fix incorrect parameter definitions
Fix leaks of internal resources
Miscellaneous cleanups and bug fixes

MRail

Renamed address control environment variable
Implement large message striping using rendezvous
Properly set tx/rx op flags

PSM2

Fix memory leaks
Add fi_nic support
Report correct value for max_order_raw_size
Report max_msg_size as a page aligned value
Fix potential multi-threaded race condition
Avoid potential deadlock in disconnect protocol

RxD

Fix default AV count
Minor cleanups and optimizations
Handle errors unpacking packets
Report all failures when inserting addresses into AV
Remove unneeded posted buffer tracking

RxM

Fix inject completion semantics
Fix MR key handling when mismatched with core provider
Add basic support for some collective operations
Fix senddata desc parameter mismatch
Serialize EQ processing to avoid use after free issue
Minor cleanup and optimizations
Remove atomic buffer limitations
Provide mechanism to force auto-progress for poorly designed apps
Fix high memory usage when using RMA
Fix segfault handling memory deregistration
Discard canceled receive buffers when closing msg ep
Fix memory leaks in connection management

SHM

Cleanup tmpfs after unclean shutdown
Increase the size of endpoint names
Align endpoint count attribute with maximum supported peer count
Add user ID to shared memory name
Only support small transfers if ptrace is restricted
Fix incorrect reporting of completion buffer
Return correct addrlen on fi_getname
Round tx/rx sizes up in case sizes are not already a power of two
Skip utility providers for shm provider

TCP

Report aborted requests as canceled
Fixed support for 0-length transfers
Return positive error code for CQ entries
Bind ports using SO_REUSEADDR
Properly check for correct recv completion length
Fix potential deadlock due to lock ordering issue

Verbs

Enable on-demand paging memory registration option
Enable send queue overflow optimization for mlx devices
Cleanup EQ when closing an associated endpoint
Minor optimizations and code restructuring
Avoid potential deadlock accessing EQ and EP
Speedup XRC connection setup
Handle IPv6 link local address scope id
Updates to support new versions of rdma-core libraries
XRC connection optimizations, cleanups, and error handling improvements
Fix possible segfault in error handling path
Remove support for vendor specific and experimental verbs
Handle 0-length memory registrations
Fix EQ trywait behavior to check for software events

v1.8.1, Mon Sep 30, 2019

Core

Limit default size of memory registration cache
Verify that correct entry is removed from MR cache

EFA

Fixes to fi_cancel() when used with multi-recv buffers
Fixes to registered memory handling after a fork()
Fixes to the long message flow-control protocol
Use FI_AV_TABLE as the preferred AV type
Fixes to the bufpool allocation handlers
Fixes to RTS handler
Fix to use correct arch detection preprocessor macro
Expose fid_nic information
Fix memory leaks

PSM2

Fix incorrect value of max_order_raw_size
Report page aligned max_msg_size
Always enable the lock accessed by the disconnection thread
Fix race condition with progress thread and FI_THREAD_DOMAIN
Avoid a potential deadlock in disconnection protocol

RxD

Fix default AV count with environment variable FI_OFI_RXD_MAX_PEERS

RxM

Fix connection handle shutdown/CQ processing race
Fix RMA ordering bits for FI_ATOMIC

SHM

Add correct reporting of FI_MR_BASIC
Add correct reporting and proper support of FI_DIRECTED_RECV

Verbs

Allow zero length memory registrations
Improve connection scale up by removing synchronous calls in fi_getinfo
Fix missing serialization to event channel during CM ID migration
Protect XRC EQ processing from EP API connect/accept calls
Fix XRC connection tag to EP return value in error case
return EAGAIN to user if an unhandled rdmacm event is received
handle IPv6 link local addresses correctly

v1.8.0, Fri Jun 28, 2019

Core

Reworked memory registration cache to use userfaultfd
Allow disabling atomic support as build option
Updated default provider priority
Define new data ordering bits to separate atomic from RMA ordering
Improved support for huge page allocations
Convert all python scripts to version 3
Add logging to report atomic implementation in use
Fix timeout calculation in util wait abstraction.
Fix hang when multiple threads wait on util counter.

EFA

New core provider for Amazon EC2 Elastic Fabric Adapter (EFA)

GNI

Fix handling of incorrect fi_addr_t value
Fix several problems when using FI_ADDR_STR format
Fix several problems when using multi-receive buffers
Fix problem with possible receive truncation
Fix possible overrunning of receive buffers
Implement fi_getopt/fi_setopt for scalable endpoints
Only generate FI_EADDRNOTAVAIL if FI_SOURCE_ERR enabled

MRAIL

Several performance enhancements and optimizations

PSM2

Disable some optional psm2 features due to instabilities
Work around possibly long delays in getaddrinfo()

RxD

Ensure that peers are initialized before sending data packets
Maintain a full posting of receive buffers to the DGRAM EP
Minor bug fixes and cleanups
Verify protocol versions and reject incompatible versions
Update and simplify protocol headers
Optimize packet initialization
Various improvements handling protocol messages
Remove pending_cnt tracking (moved to verbs provider)
Fix setting of mr_mode on getinfo
Handle error unpacking packet headers properly

RxM

Improved responsiveness to CM events with manual progress mode
Add proper versioning to CM data exchange protocol
Refactor how CQ and EQ errors are handled and reported
Minor code cleanups and bug fixes
Support atomic operations in auto progress mode
Fix high memory usage when a large number of RMA ops are posted without FI_COMPLETION

SHM

Fix possible segfault
Fix smr_freestack_pop to properly remove entry from stack

TCP

Enable multi-recv support
Allow restricting tcp to specific port range for firewall purposes

Verbs

Add NIC info (fi_nic) in fi_info
Improved support for UD QPs over RoCE
Added CQ resource tracking to avoid CQ overrun on HFI1
Enable memory registration cache by default
Reduce unnecessary log message noise
Bug fixes for EQ trywait, QP creation attributes.

Fabtests

Add new test to test memory registration caching correctness
Fix segfault with fi_pingpong
Allow specifying flags as command line arguments
Add threading level option to ubertest
Enable support for all endpoint types with multi_recv test
Add new AV insertion unit test
Allow for out-of-band address exchange with in-band test synchronization
Check for and use exclusion files by default if found
Use regular expressions for test exclusion files
Have test scripts use full test names
Replace socket provider with tcp and udp for default testing

v1.7.2, Fri Jun 14, 2019

Core

Rename variables that shadow global symbols
Set slist tail to NULL to handle iterators correctly
Add new locking to AV EP list to avoid potential deadlock
Add threadsafe AV implementation

GNI

Fix possible overrunning of receive buffers
Fix compile issue on CLE 7.0.UP01
Implement fi_getopt/fi_setopt for scalable endpoints
Only generate FI_EADDRNOTAVAIL if FI_SOURCE_ERR enabled

RxD

Align packet type declarations with debug prints
Track current unexpected messages per peer, rather than globally
Remove unneeded RXD_CANCELED flag
Remove unnecessary check of unexpected list
Support FI_CLAIM, FI_PEEK, and FI_DISCARD flags
Avoid double free on CQ error destruction path
Fix message windowing
Limit number of transfer entries that can be active
Use utility CQ calls to handle CQ overflow
Set correct opcode when completing read completions
Preset and fix tx and rx transfer flags
Fix segfault

RxM

Add missing serialization for RMA and atomics
Reject connection requests in shutdown state
Rework cmap and ep lock synchronization
Add CM events to improve debugging
Remove incorrect assertion
Progress EQ events from app thread to drive progress
Handle message segment ordering when buffering receives
Generate completions for claimed buffered messages
Minor other fixes and cleanups

TCP

Support FI_SELECTIVE_COMPLETION correctly
Fix transmit and delivery complete semantics
Verify fi_info when creating passive EP

Verbs

Remove XRC target QP from RDMA CM control
Fix XRC QP allocation failure return code
Fix EQ readerr locking
Add FI_ADDR_IB_UD to known address print format
Fix addressing return on fi_getifo for native IB addresses
Serialize access to EQ when destroying connections
Add serialization to XRC EQ/CM handling
Fix serialization between AV and cmap
Fix XRC connection tags
Remove racy fork support from provider
Minor other fixes

Fabtests

Exclude tests from OS X that require epoll support

v1.7.1, Mon Apr 8, 2019

Core

Support layered provider names with FI_PROVIDER filter
Minor cleanups to man pages
Add missing header for FreeBSD support
Fix built-in atomic tests
Do not overwrite CFLAGS during build

Fabtests

Fix memory leaks in fi_getinfo_test
Fix memory leak in fi_av_xfer error paths
Fix memory leaks in fi_cm_data
Fix memory leak in fi_poll
Add test configuration and exclude files for shm

GNI

Fix setting supported tag mask
Fall back to normal allocations when huge page support is unavailable

PSM2

Inline address translation function for performance
Create tagged ops specialization for FI_AV_MAP
Bring back true FI_AV_MAP support under certain conditions
Use psm2_epaddr_to_epid() for epaddr to epid conversion
Add runtime parameter for connection timeout

MXM

Disable provider by default as it is not actively maintained

RxD

Fix completion generation
Use correct flags for *msg APIs
Return correct error code if Tx is unable to be accepted
Add missing EP attributes
Fix use after free error opening an endpoint

RxM

Avoid unnecessary fi_getinfo calls to avoid possible failures
Discard Rx buffers for closed EPs to avoid segfaults
Repost receive buffers to avoid possible fabric deadlock
Fix crash accessing invalid Tx CQ
Use correct flags for *msg APIs
Report available inject size, rather than reducing value based on user hints
Fix endpoint configuration checks when enabling endpoint
Keep eager protocol limit separate from inject size
Increment correct atomic counter
Discard CQ entries generated by canceled receives
Initialize maximum atomic payload size
Add connection event progress
Fix SAR protocol truncation error
Fix setting FI_MSG and fi_RMA caps

TCP

Fix synchronization verifying MRs
Remove duplicate Rx queue removal
Return internal buffers to correct buffer pools to avoid data corruption
Free internal buffer pools and fix memory leaks
Handle peer socket disconnects properly
Pass signals through to application threads
Cleanup pending events when closing endpoints
Only adjust endianness when peers' endianness mismatches
Optimize header sizes based on message types to improve performance

Sockets

Fix acquiring the same lock twice
Fix accessing an uninitialized pointer handling CM events

SHM

Add support for selective completions
Fix addressing
Set MR key size
Fix memory corruption and memory leak

Verbs

Cleanup from use of memory registration cache
Do not update minimum RNR timer for XRC initiator QPs
Fix possible CQ overrun issues with hfi1 and qib devices
Fix synchronization issue accessing MR cache from multiple threads
Fix double free in XRC accept path
Add missing include file
Make fi_getinfo call thread safe
Fix CQ busy issue in MPI finalize when using XRC
Return correct attribute values when XRC is enabled
Fix sending atomic response protocol message
Report flushed receive operations (reverts to behavior in 1.4 and earlier)
Fix segfault reading CQ error entries
Fix double free of XRC connection request data
Set FI_RX_CQ_DATA mode bit correctly

v1.7.0, Mon Jan 7, 2019

The 1.7 release provides a few enhancements to the libfabric API. Notably, it extends the fi_info structure in order to report NIC attributes for domains that have a direct association with network hardware. The NIC attributes include details about the device, the system bus it's attached to, and link state. NIC attributes are automatically reported by the fi_info utility application. See the fi_nic.3 man page for additional details.

An experimental capability bit is added to optimize receive side processing. This is known as variable messages, and targets applications that do now know what size message a peer with send prior to the message arriving. Variable messages can be used to avoid receive side data copies and eliminate the need for applications to implement their own rendezvous protocol. See the fi_msg.3 man page for details on variable messages and it's sister, buffered messages.

Specific details on changes since the 1.6.2 release are outlined below.

Core

Add ability to report NIC details with fi_info data
Improve MR cache notification mechanisms
Set sockaddr address format correctly
Avoid possible null dereference in eq_read
Handle FI_PEEK in CQ/EQ readerr
Add debug messages to name server
Feature and performance enhancements added to internal buffer pool
Add support for huge pages
Decrease memory use for idle buffer pools
Refactor utility AV functionality
Generic counter support enhancements
Optimize EP and CQ locking based on application threading level
Enhance common support for EQ error handling
Add free/alloc memory notification hooks for MR cache support
Fix memory monitor unsubscribe handling
Add CQ fd wait support
Add CQ overflow protection
Enhance IPv6 addressing support for AVs
Enhancements to support for AV address lookup
Fixes for emulated epoll support
Allow layering of multiple utility providers
Minor bug fixes and optimization

Hook

Improved hooking infrastructure
Add support for installing multiple hooks
Support hooks provided by external libraries.

GNI

Fix CQ readfrom overwriting src_addr in case of multiple events
Signal wait set if error entry is added to CQ
Fix state data issue with SMSG buffers
Enhance and fix possible misuse of default authorization key
Add cancel support for SEP
Rework SEP setup
Suppress huge page counting for ARM
Fix incorrect check of FI_SYNC_ERR flag

MRAIL

Initial release of mrail provider. The current status is experimental: not all features are supported and performance is not guaranteed.
Enables increased bandwidth for an underlying provider by utilizing multiple network ports (rails).

NetDir

Fix crash in initialization code
Update references to NetworkDirect header packaged

PSM2

Requires PSM2 library version 10.2.260 or later
Clean up connection state in fi_av_remove
Use psm2_info_query to read HFI device info
Clean up CQ/counter poll list when endpoint is closed
Support shared address vector
Optimize CQ event conversion with psm2_mq_ipeek_dequeue_multi
Lock optimization for FI_THREAD_DOMAIN
Use new PSM2 fast path isend/irecv functions for large size RMA
Support building with latest PSM2 source code (version 11.2.68)
Support fabric direct

RxD

Initial release of RxD provider
Provides reliable datagram semantics over unreliable datagram EPs
Target is to improve scalability for very large clusters relative to RxM

RxM

Decrease memory use needed to maintain large number of connections
Set correct op_context and flags on CQ error completions
Fix file descriptor memory leaks
Introduce new protocol optimized for medium message transfers
Improve Rx software performance path
Use shared receive contexts if required by underlying provider
Handle addresses inserted multiple times into AV (for AV map)
Performance optimizations for single-thread applications
Rework deferred transmit processing
Separate and optimize eager and rendezvous protocol processing.
Fix passing incorrect addresses for AV insert/remove
Fix CM address handling
Fix race condition accessing connection handles
Simplify small RMA code path
Increment correct counter when processing FI_READ events
Dynamically grow the number of connections that can be supported
Fix padding in wire protocol structures
Report correct fi_addr when FI_SOURCE is requested
Fix truncating rendezvous messages
Fix use after free error in Rx buffer processing
Add support for manual progress
Make Tx/Rx queue sizes independent of MSG EP sizes
Decrease time needed to repost buffers to the MSG EP Rx queue.
Miscellaneous bug fixes

Sockets

Enable MSG EPs when user calls fi_accept
Fix fabric names to be underlying IP address
Add connection timeout environment variable.
Use size of addresses, not structures
Add debug messages to display selected addresses
Use loopback address in place of localhost
Simplify listen paths
Add support for IPv6
Code restructuring
Avoid unneeded address to string to address translations
Check length of iovec entries prior to access buffers
Fix segfault
Avoid acquiring nested spinlocks resulting in hangs
Fix use after free error in triggered op handling
New connection manager for MSG EPs to reduce number of threads
Avoid retrying recv operations if connection has been broken
Fixes for Windows socket support

TCP

Initial release of optimized socket based tcp provider
Supports MSG EPs, to be used in conjunction with RxM provider
Targets eventual replacement of sockets provider

Verbs

Remove RDM EP support. Use RxM and RxD for RDM EPs.
Improve address handling and report in fi_getinfo
Handle FI_PEER when calling CQ/EQ readerr functions
Add support for XRC QPs.
Ignore destination address when allocating a PEP
Add workaround for i40iw incorrect return values when posting sends
Fix completion handling for FI_SELECTIVE_COMPLETION EP setting
Change format of fabric name to use hex instead of decimal values
Fix handling of err_data with EQ readerr
Report correct size of max_err_data
Fast path performance improvements
Improve progress under high system load
Optimize completion processing when handling hidden completions
Optimize RMA and MSG transfers by pre-formatting work requests
Remove locks based on application threading model
Add overflow support for CQ error events
Minor cleanups and bug fixes

v1.6.2, Fri Sep 28, 2018

Core

Cleanup of debug messages

GNI

Fix problems with Scalable Endpoint creation
Fix interoperability problem with HPC toolkit
Improve configuration check for kdreg

PSM

Enforce FI_RMA_EVENT checking when updating counters
Fix race condition in fi_cq_readerr()
Always try to make progress when fi_cntr_read is called

PSM2

Revert "Avoid long delay in psm2_ep_close"
Fix memory corruption related to sendv
Performance tweak for bi-directional send/recv on KNL
Fix CPU detection
Enforce FI_RMA_EVENT checking when updating counters
Remove stale info from address vector when disconnecting
Fix race condition in fi_cq_readerr()
Adjust reported context numbers for special cases
Always try to make progress when fi_cntr_read is called
Support control functions related to MR mode
Unblock fi_cntr_wait on errors
Properly update error counters
Fix irregular performance drop for aggregated RMA operations
Reset Tx/Rx context counter when fabric is initialized
Fix incorrect completion event for iov send

RXM

Fix incorrect increments of error counters for small messages
Increment write completion counter for small transfers
Use FI_UNIVERSE_SIZE when defining MSG provider CQ size
Make TX, RX queue sizes independent of MSG provider
Make deferred requests opt-in
Fill missing rxm_conn in rx_buf when shared context is not used
Fix an issue where MSG endpoint recv queue got empty resulting in a hang
Set FI_ORDER_NONE for tx and rx completion ordering
Serialize access to repost_ready_list
Reprocess unexpected messages on av update
Fix a bug in matching directed receives
Fix desc field when postponing RMA ops
Fix incorrect reporting of mem_tag format
Don't include FI_DIRECTED_RECV, FI_SOURCE caps if they're not needed
Fix matching for RMA I/O vectors

Sockets

Increase maximum messages size as MPICH bug work-around

Verbs

Detect string format of wildcard address in node argument
Don't report unusable fi_info (no source IP address)
Don't assert when a verbs device exposes unsupported MTU types
Report correct rma_iov_limit
Add new variable - FI_VERBS_MR_CACHE_MERGE_REGIONS
eq->err.err must return a positive error code

v1.6.1, Wed May 8, 2018

Core

Fix compile issues with older compilers
Check that all debug compiler flags are supported by compiler

PSM2

Fix occasional assertion failure in psm2_ep_close
Avoid long delay in psm2_ep_close
Fix potential duplication of iov send completion
Replace some parameter checking with assertions
Check iov limit in sendmsg
Avoid adding FI_TRIGGER caps automatically
Avoid unnecessary calls to psmx2_am_progress()

RXM

Fix reading pointer after freeing it.
Avoid reading invalid AV entry
Handle deleting the same address multiple times
Fix crash in fi_av_remove if FI_SOURCE wasn't enabled

Sockets

Fix use after free error handling triggered ops.

v1.6.0, Wed Mar 14, 2018

Core

Introduces support for performing RMA operations to persistent memory See FI_RMA_PMEM capability in fi_getinfo.3
Define additional errno values
General code cleanups and restructuring
Force provider ordering when using dynamically loaded providers
Add const to fi_getinfo() hints parameter
Improve use of epoll for better scalability
Fixes to generic name service

GNI

Fix a problem with the GNI waitset implementation
Enable use of XPMEM for intra node data transfers
Fix a problem with usage of Crays UDREG registration cache
Fix a problem with an assert statement
Fix several memory leaks

PSM

Move environment variable reading out from fi_getinfo()
Shortcut obviously unsuccessful fi_getinfo() calls
Remove excessive name sever implementation
Enable ordering of RMA operations

PSM2

Requires psm2 library version 10.2.235 or later
Skip inactive units in round-robin context allocation
Allow contexts be shared by Tx-only and Rx-only endpoints
Use utility functions to check provider attributes
Turn on FI_THREAD_SAFE support
Make address vector operations thread-safe
Move environment variable reading out from fi_getinfo()
Reduce noise when optimizing tagged message functions
Shortcut obviously unsuccessful fi_getinfo() calls
Improve how Tx/Rx context limits are handled
Support auto selection from two different tag layout schemes
Add provider build options to debug output
Support remote CQ data for tagged messages, add specialization.
Support opening multiple domains
Put trigger implementation into a separate file
Update makefile and configure script
Replace allocated context with reserved space in psm2_mq_req
Limit exported symbols for DSO provider
Reduce HW context usage for certain TX only endpoints
Remove unnecessary dependencies from the configure script
Refactor the handling of op context type
Optimize the conversion between 96-bit and 64-bit tags
Code refactoring for completion generation
Remove obsolete feature checking code
Report correct source address for scalable endpoints
Allow binding any number of endpoints to a CQ/counter
Add shared Tx context support
Add alternative implementation for completion polling
Change the default value of FI_PSM2_DELAY to 0
Add an environment variable for automatic connection cleanup
Abstract the completion polling mechanism
Use the new psm2_am_register_handlers_2 function when available
Allow specialization when FI_COMPLETION op_flag is set.
Put Tx/Rx context related functions into a separate file
Enable PSM2 multi-ep feature by default
Add option to build with PSM2 source included
Simplify the code for checking endpoint capabilities
Simplify the handling of self-targeted RMA operations
Allow all free contexts be used for scalable endpoints
Enable ordering of RMA operations
Enable multiple endpoints over PSM2 multi-ep support
Support multiple Tx/Rx contexts in address vector
Remove the virtual lane mechanism
Less code duplication in tagged, add more specialization.
Allow PSM2 epid be reused within the same session
Turn on user adjustable inject size for all operations
Use pre-allocated memory pool for RMA requests
Add support for lazy connection
Various bug fixes

RXM

Add support for completion counters
Fix MR mode handling
Add support for FI_MULTI_RECV
Considerable performance optimizations
Report correct MR key size based on core provider's size
Fixes to endpoint address reporting to avoid wildcard addresses
Ensure progress after core provider returns EAGAIN on transfers
Fix crash when running of sockets provider
Bug fixes handling large message transfers
Report data ordering and limits based on core provider's
Set mode bits and capabilities correctly
General code restructuring and cleanups
Various additional bug fixes
Handle different API versions correctly
Expand support for tagged message transfers
Add support for auto progress on data transfers

SHM

Initial release of shared memory provider
See the fi_shm.7 man page for details on available features and limitations

Sockets

Scalability enhancements
Fix issue associating a connection with an AV entry that could result in application hangs
Add support for new persistent memory capabilities
Fix fi_cq_signal to unblock threads waiting on cq sread calls
Fix epoll_wait loop handling to avoid out of memory errors
Add support for TCP keepalives, controllable via environment variables
Reduce the number of threads allocated for handling connections
Several code cleanups in response to static code analysis reports
Fix reporting multiple completion events for the same request in error cases

usNIC

Minor adjustments to match new core MR mode bits functionality
Several code cleanups in response to static code analysis reports

Verbs

Code cleanups and simplifications
General code optimizations to improve performance
Fix handling of wildcard addresses
Check for fatal errors during connection establishment
Support larger inject sizes
Fix double locking issue
Add support for memory registration caching (disabled by default)
Enable setting thread affinity for CM threads
Fix hangs in MPI closing RDM endpoints
Add support for different CQ formats
Fix RMA read operations over iWarp devices
Optimize CM progress handling
Several bug fixes

v1.5.3, Wed Dec 20, 2017

Core

Handle malloc failures
Ensure global lock is initialized on Windows
Fix spelling and formatting errors in man pages

GNI

Fix segfault when using FI_MULTI_RECV
Fix rcache issue handling overlapping memory regions

NetDir

Fix fi_getname
Remove FI_LOCAL_MR mode bit, being reported erronously
Avoid crashing in fi_join

PSM

Fix print format mismatches
Remove 15 second startup delay when no hardware is installed
Preserve FI_MR_SCALABLE mode bit for backwards compatability

PSM2

Fix print format mismatches
Allow all to all communication between scalable endpoints
Preserve FI_MR_SCALABLE mode bit for backwards compatability
Fix reference counting issue with opened domains
Fix segfault for RMA/atomic operations to local scalable endpoints
Fix resource counting related issues for Tx/Rx contexts
Allow completion suppression when fi_context is non-NULL
Use correct queue for triggered operations with scalable endpoints

RXM

Fix out of bounds access to receive IOVs
Serialize access to connection map
Fix CQ error handling
Fix issue being unable to associate an fi_addr with a connection
Fix bug matching unexpected tagged messages
Indicate that FI_RMA is supported
Return correct r/w ordering size limits

Sockets

Fix check for invalid connection handle
Fix crash in fi_av_remove

Util

Fix number of bits used for connection index

Verbs

Fix incorrect CQ entry data for MSG endpoints
Properly check for errors from getifaddrs
Retry getifaddr on failure because of busy netlink sockets
Ack CM events on error paths

v1.5.2, Wed Nov 8, 2017

Core

Fix Power PC 32-bit build

RXM

Remove dependency on shared receive contexts
Switch to automatic data progress
Fix removing addresses from AV

Sockets

Fix incorrect reporting of counter attributes

Verbs

Fix reporting attributes based on device limits
Fix incorrect CQ size reported for iWarp NICs
Update man page with known issues for specific NICs
Fix FI_RX_CQ_DATA mode check
Disable on-demand paging by default (can cause data corruption)
Disable loopback (localhost) addressing (causing failures in MPI)

v1.5.1, Wed Oct 4, 2017

Core

Fix initialization used by DL providers to avoid crash
Add checks for null hints and improperly terminated strings
Check for invalid core names passed to fabric open
Provide consistent provider ordering when using DL providers
Fix OFI_LIKELY definitions when GNUC is not present

GNI

Add ability to detect local PE rank
Fix compiler/config problems
Fix CQ read error corruption
Remove tests of deprecated interfaces

PSM

Fix CQ corruption reporting errors
Always generate a completion on error

PSM2

Fix CQ corruption reporting errors
Always generate a completion on error
Add checks to handle out of memory errors
Add NULL check for iov in atomic readv/writev calls
Fix FI_PEEK src address matching
Fix bug in scalable endpoint address resolution
Fix segfault bug in RMA completion generation

Sockets

Fix missing FI_CLAIM src address data on completion
Fix CQ corruption reporting errors
Fix serialization issue wrt out of order CPU writes to Tx ring buffer

Verbs

Allow modifying rnr retry timout to improve performance
Add checks to handle out of memory errors
Fix crash using atomic operations for MSG EPs

v1.5.0, Wed Aug 9, 2017

The 1.5 release includes updates to the libfabric API and ABI. As a result, the ABI bumps from 1.0 to 1.1. All changes are backwards compatible with previous versions of the interface. The following features were added to the libfabric API. (Note that individual providers may not support all new features). For full details see the man pages.

Authorization keys Authorization keys, commonly referred to as job keys, are used to isolate processes from communicating with other processes for security purposes.
Multicast support Datagram endpoints can now support multicast communication.
(Experimental) socket-like endpoint types New FI_SOCK_STREAM and FI_SOCK_DGRAM endpoint types are introduced. These endpoint types target support of cloud and enterprise based middleware and applications.
Tagged atomic support Atomic operations can now target tagged receive buffers, in addition to RMA buffers.
(Experimental) deferred work queues Deferred work queues are enhanced triggerred operations. They target support for collective-based operations.
New mode bits: FI_RESTRICTED_COMP and FI_NOTIFY_FLAGS_ONLY These mode bits support optimized completion processing to minimize software overhead.
Multi-threaded error reporting Reading CQ and EQ errors now allow the application to provide the error buffer, eliminating the need for the application to synchronize between multiple threads when handling errors.
FI_SOURCE_ERR capability This feature allows the provider to validate and report the source address for any received messages.
FI_ADDR_STR string based addressing Applications can now request and use addresses provided using a standardized string format. This makes it easier to pass full addressing data through a command line, or handle address exchange through text files.
Communication scope capabilities: FI_LOCAL_COMM and FI_REMOTE_COMM Used to indicate if an application requires communication with peers on the same node and/or remote nodes.
New memory registration modes The FI_BASIC_MR and FI_SCALABLE_MR memory registration modes have been replaced by more refined registration mode bits. This allows applications to make better use of provider hardware capabilities when dealing with registered memory regions.
New mode bit: FI_CONTEXT2 Some providers need more than the size provided by the FI_CONTEXT mode bit setting. To accomodate such providers, an FI_CONTEXT2 mode bit was added. This mode bit doubles the amount of context space that an application allocates on behalf of the provider.

BGQ provider notes

The OFI 1.5 BGQ provider officially supports the Open Fabrics Interfaces utilized by the MPICH implementation of the MPI-3 standard. In addition to the MPICH test suite it has been tested by several scientific applications running MPICH on BGQ at scale, and several bugs in the provider and MPICH have been identified and fixed. At least one INCITE project is attempting to use it for production science. Support of this provider is a high- priority for ALCF, and MPICH users on BGQ are encouraged to utilize it to compare function and performance against the PAMI-based default toolchain. Any discovered bugs will be quickly addressed with high priority. Results so far have shown significant point-to-point and RMA latency improvements over PAMI as well as RMA functional improvements at scale. The only potential drawback is collective performance degradation against the PAMI optimizations, but at certain message and partition sizes, performance has been observed to be comparable or even better.

MLX provider notes

New provider to replace the deprecated mxm provider.
Targets Mellanox InfiniBand fabrics, through the UCX library.
Supports RDM endpoints with the tagged interfaces.
Requires FI_CONTEXT mode support.
See fi_mlx.7 man page for more details.

NetDir provider nodes

New provider for Windows that runs over the NetworkDirect API.
Supports FI_EP_MSG endpoints, with FI_MSG and FI_RMA interfaces.
Supports shared receive contexts
Supports FI_SOCKADDR, FI_SOCKADDR_IN, and FI_SOCKADDR_IN6 addressing
Asynchronous operations make forward progress automatically

PSM provider notes

Improve the name server functionality and move to the utility code
Handle updated mr_mode definitions
Add support of 32 and 64 bit atomic values

PSM2 provider notes

Add option to adjust the locking level
Improve the name server functionality and move to the utility code
Add support for string address format
Add an environment vaiable for message inject size
Handle FI_DISCARD in tagged receive functions
Handle updated mr_mode definitions
Add support for scalable endpoint
Add support of 32 and 64 bit atomic values
Add FI_SOURCE_ERR to the supported caps
Improve the method of checking device existence

Sockets provider notes

Updated and enhanced atomic operation support.
Add support for experimental deferred work queue operations.
Fixed counter signaling when used with wait sets.
Improved support on Windows.
Cleaned up event reporting for destroyed endpoints.
Fixed several possible crash scenarios.
Fixed handling socket disconnect events which could hang the provider.

RxM provider notes

Add OFI RxM provider. It is an utility provider that supports RDM endpoints emulated over a base provider that supports only MSG end- points.
The provider was earlier experimental. It's functional from this release onwards.
Please refer to the man page of the provider for more info.

UDP provider notes

Add support for multicast data transfers

usNIC provider notes

Only requires libibverbs when necessary
Updated to handle 1.5 interface changes.

Verbs provider notes

Fix an issue where if the user requests higher values for tx, rx context sizes than default it wasn't honored.
Introduce env variables for setting default tx, rx context sizes and iov limits.
Report correct completion ordering supported by MSG endpoints.

v1.4.2, Fri May 12, 2017

Core

Fix for OS X clock_gettime() portability issue.

PSM provider notes

Updated default counter wait object for improved performance
Fix multi-threaded RMA progress stalls

PSM2 provider notes

Updated default counter wait object for improved performance
Fix multi-threaded RMA progress stalls

Sockets provider notes

Fix error in fi_cq_sreadfrom aborting before timeout expires
Set atomic iov count correct correctly inside fi_atomicv

Verbs provider notes

Fix handling of apps that call fork. Move ibv_fork_init() before calling any other verbs call.
Fix crash in fi_write when connection is not yet established and write data size is below inline threshold.
Fix issues not handling multiple ipoib interfaces
Reduce lock contention on buffer pools in send/completion handling code.
To see verbs provider in fi_info output, configure the corresponding IPoIB interface with an IP address. This is a change in behavior from previous versions. Please refer fi_verbs man page for more info.

v1.4.1, Fri Feb 3, 2017

PSM provider notes

Defer initialization of the PSM library to allow runtime selection from different versions of the same provider before fi_getinfo is called.

PSM2 provider notes

Defer initialization of the PSM2 library to allow runtime selection from different versions of the same provider before fi_getinfo is called.
General bug fixes.

UDP provider notes

Fix setting address format in fi_getinfo call.

usNIC provider notes

Fixed compilation issues with newer versions of libibverbs.

v1.4.0, Fri Oct 28, 2016

Add new options, -f and -d, to fi_info that can be used to specify hints about the fabric and domain name. Change port to -P and provider to -p to be more in line with fi_pingpong.

GNI provider notes

General bug fixes, plugged memory leaks, performance improvements, improved error handling and warning messages, etc.
Additional API support:
- FI_THREAD_COMPLETION
- FI_RMA_EVENT
- iov length up to 8 for messaging data transfers
Provider-specific API support:
- Aries native AXOR atomic operation
- Memory registation cache flush operation
Memory registration cache improvements:
- IOMMU notifier support
- Alternatives to the internal cache
- Additional tuning knobs
On-node optimization for rendezvous message communication via XPMEM
Internal fixes to support accelerators and KNL processors
Better support for running in CCM mode (in support for fabtests)

MXM provider

The mxm provider has been deprecated and will be replaced in a future release.

PSM provider notes

General bug fixes
Use utility provider for EQ, wait object, and poll set
Allow multi-recv to post buffer larger than message size limit

PSM2 provider notes

General bug fixes
Add support for multi-iov RMA read and aromic operations
Allow multi-recv to post buffer larger than message size limit

Sockets provider notes

General code cleanup and bug fixes
Set tx/rx op_flags correctly to be consistent with manpage
Restructure struct sock_ep to support alias ep
Refactor CQ/Cntr bindings, CQ completion generation, and counter increments
Copy compare data to internal buffer when FI_INJECT is set in fi_compare_atomic
Correctly handle triggered operation when FI_INJECT is set or triggered op is enqueued or counter is incremented. Initialize counter threshold to INT_MAX
Refactor and cleanup connection management code, add locks to avoid race between main thread and progress thread, add logic to correctly handle FI_SHUTDOWN and FI_REJECT
Set fabric name as network address in the format of a.b.c.d/e and domain name as network interface name
Remove sock_compare_addr and add two utility functions ofi_equals_ipaddr and ofi_equals_sockaddr in fi.h
Refactor fi_getinfo to handle corner cases and add logic if a given src_addr matches to any local interface addr
Restructure acquiring/releasing the list_lock in progress thread so that it is only acquired once per iteration
Refactor connection management of MSG ep so that it uses TCP instead of UDP for connection management msg and new port for every MSG endpoint
Add sock_cq_sanitize_flags function to make sure only flags returned in CQ events are the ones that are listed on the manpage
Update fi_poll semantics for counters so that it returns success if the counter value is different from the last-read-value
Allow multiple threads to wait on one counter
Update code to use ofi_util_mr - the new MR structure added to util code
Fix fi_av_insert not to report error when the number of inserted addr exceeds the count attribute in fi_av_attr
Add garbage collection of AV indices after fi_av_remove, add ep list in AV and cleanup conn map during fi_av_remove
Use correct fi_tx_attr/fi_rx_attr for scalable ep

UDP provider notes

Enhance parameter checks for several function calls.
Fix memory leak freeing CQ structure.
Bind to a source address when enabling endpoint.
Reduce reported resource limits (domain attributes).

usNIC provider notes

Fix handling of EP_MSG peers on different IP subnets [PR #1988]
Fix handling of CM data. Fixes a bug where data received would overwrite parts of the connection management structure [PR #1991]
Fix bug in CM connect/accept handling that would cause a seg fault if data was sent as part of a connection request [PR #1991]
Fix invalid completion lengths in the MSG and RDM endpoint implementations of fi_recvv and fi_recvmsg [PR #2026]
Implement the FI_CM_DATA_SIZE option for fi_getopt on passive endpoints [PR #2033]
Add fi_reject implementation that supports data exchange [PR #2038]
Fix fi_av_straddr bug that reported port in network order [PR #2244]
Report -FI_EOPBADSTATE if the size left functions are used on an endpoint which has not been enabled [PR #2266]
Change the domain/fabric naming. The fabric is now represented as the network address in the form of a.b.c.d/e and the domain name is the usNIC device name. For more information see fi_usnic(7) [PR #2287]
Fix the domain name matching in fi_getinfo/fi_domain [PR #2298]
Fix issue with AV where it is fully closed before pending asynchronous inserts can finish leading to invalid data accesses [PR #2397]
Free all data associated with AV when fi_av_close is called [PR #2397]
Fail with -FI_EINVAL if a value of FI_ADDR_NOTAVAIL is given to fi_av_lookup. [PR #2397]
Verify AV attributes and return an error if anything that is unsupported is requested (FI_AV_TABLE, named AVs, FI_READ, etc.) [PR #2397]

Verbs provider notes

Add fork support. It is enabled by default and can be turned off by setting the FI_FORK_UNSAFE variable to "yes". This can improve performance of memory registrations but also makes fork unsafe. The following are the limitations of fork support:
- Fabric resources like endpoint, CQ, EQ, etc. should not be used in the forked process.
- The memory registered using fi_mr_reg has to be page aligned since ibv_reg_mr marks the entire page that a memory region belongs to as not to be re-mapped when the process is forked (MADV_DONTFORK).
Fix a bug where source address info was not being returned in fi_info when destination node is specified.
verbs/MSG
- Add fi_getopt for passive endpoints.
- Add support for shared RX contexts.
verbs/RDM
- General bug fixes
- Add FI_MSG capability
- Add FI_PEEK and FI_CLAIM flags support
- Add completion flags support
- Add selective completion support
- Add fi_cq_readerr support
- Add possibility to set IPoIB network interface via FI_VERBS_IFACE environment variable
- Add large data transfer support (> 1 GB)
- Add FI_AV_TABLE support
- Add fi_cntr support
- Add environment variables for the provider tuning: FI_VERBS_RDM_BUFFER_NUM, FI_VERBS_RDM_BUFFER_SIZE, FI_VERBS_RDM_RNDV_SEG_SIZE, FI_VERBS_RDM_CQREAD_BUNCH_SIZE, FI_VERBS_RDM_THREAD_TIMEOUT, FI_VERBS_RDM_EAGER_SEND_OPCODE
- Add iWarp support

v1.3.0, Mon Apr 11, 2016

General notes

See a list of provider features for this release

GNI provider notes

CLE 5.2UP04 required for building GNI provider
General bug fixes, plugged memory leaks, etc.
Improved error handling, warning messages, etc.
Added support for the following APIs:
- fi_endpoint: fi_getopt, fi_setopt, fi_rx_size_left, fi_tx_size_left, fi_stx_context
- fi_cq: fi_sread, fi_sreadfrom
- fi_msg: FI_MULTI_RECV (flag)
- fi_domain: FI_PROGRESS_AUTO (flag)
- fi_direct: FI_DIRECT
Added support for FI_EP_DGRAM (datagram endpoint):
- fi_msg, fi_tagged, fi_rma
Memory registration improvements:
- Improved performance
- Additional domain open_ops
Initial support for Cray Cluster Compatibility Mode (CCM)
Implemented strict API checking
Added hash list implementation for tag matching (available by domain open_ops)

Note: The current version of fabtests does not work with the GNI provider due to the job launch mechanism on Cray XC systems. Please see the GNI provider wiki for alternatives to validating your installation.

MXM provider notes

Initial release

PSM provider notes

Remove PSM2 related code.

PSM2 provider notes

Add support for multi-iov send, tagged send, and RMA write.
Use utility provider for EQ, wait object, and poll set.

Sockets provider notes

General code cleanup
Enable FABRIC_DIRECT
Enable sockets-provider to run on FreeBSD
Add support for fi_trywait
Add support for map_addr in shared-av creation
Add shared-av support on OSX
Allow FI_AV_UNSPEC type during av_open
Use loop-back address as source address if gethostname fails
Disable control-msg ack for inject operations that do not expect completions
Increase max_atomic_msg_size to 4096 bytes
Remove check for cq_size availability while calculating tx/rx_size_left
Use util-buffer pool for overflow entries in progress engine.
Synchronize accesses to memory-registration operations
Fix an issue that caused out-of-order arrival of messages
Fix a bug in processing RMA access error
Fix a bug that caused starvation in processing receive operations
Add reference counting for pollset
Fix a bug in connection port assignment

UDP provider notes

Initial release

usNIC provider notes

Implement fi_recvv and fi_recvmsg for FI_EP_RDM. [PR #1594]
Add support for FI_INJECT flag in the FI_EP_RDM implementation of fi_sendv. [PR #1594]
Fix crashes that occur in the FI_EP_RDM and the FI_EP_MSG implementations when messages are posted with the maximum IOV count. [PR #1784]
Fix crashes that occur in the FI_EP_RDM and the FI_EP_MSG implementations when posting messages with IOVs of varying lengths. [PR #1784]
Handle FI_PEEK flag in fi_eq_sread. [PR #1758]
Return -FI_ENOSYS if a named AV is requested. [PR #1749]
The ethernet header does not count against the MTU. Update reported max_msg_size when using FI_EP_DGRAM to reflect this. [PR #1738]
Set the DF (do not fragment) bit in the IP header. [PR #1665]
Fix crashes that may occur from improper handling of receive state tracking [PR #1809]
Fortify the receive side of libnl communication [PR #1655]
Fix handling of fi_info with passive endpoints. Connections opened on a passive endpoint now inherit the properties of the fi_info struct used to open the passive endpoint. [PR #1806]
Implement pollsets. [PR #1835]
Add version 2 of the usnic getinfo extension [PR #1866]
Implement waitsets [PR #1893]
Implement fi_trywait [PR #1893]
Fix progress thread deadlock [PR #1893]
Implement FD based CQ sread [PR #1893]

Verbs provider notes

Add support for fi_trywait
Support building on OSes which have older versions of librdmacm (v1.0.16 or lesser). The functionality of the provider when the user passes AF_IB addresses is not guaranteed though.
Added a workaround to support posting more than 'verbs send work queue length' number of fi_inject calls at a time.
Make CQ reads thread safe.
Support the case where the user creates only a send or recv queue for the endpoint.
Fix an issue where RMA reads were not working on iWARP cards.
verbs/RDM
- Add support for RMA operations.
- Add support for fi_cq_sread and fi_cq_sreadfrom
- Rework connection management to make it work with fabtests and also allow connection to self.
- Other bug fixes and performance improvements.

v1.2.0, Thu Jan 7, 2016

General notes

Added GNI provider
Added PSM2 provider

GNI provider notes

Initial release

PSM provider notes

General bug fixes
Support auto progress mode
Support more threading modes
Only set FI_CONTEXT mode if FI_TAGGED or FI_MSG is used
Support Intel Omni-Path Fabric via the psm2-compat library

PSM2 provider notes

Initial addition

Sockets provider notes

General bug fixes and code cleanup
Update memory registration to support 32-bit builds and fix build warnings
Initiate conn-msg on the same tx_ctx as the tx operation for scalable ep
Fix av mask calculation for scalable ep
Mask out context-id during connection lookup for scalable ep
Increase buffered receive limit
Ignore FI_INJECT flag for atomic read operation
Return -FI_EINVAL instead of -FI_ENODATA for fi_endpoint for invalid attributes
Set default tag format to FI_TAG_GENERIC
Set src/dest iov len correctly for readv operations
Fix random crashes while closing shared contexts
Fix an out of bound access when large multi-recv limit is specified by user
Reset tag field in CQ entry for send completion
Do not set prov_name in fabric_attr
Validate flags in CQ/Cntr bind operations
Scalability enhancements
Increase mr_key size to 64 bit
Use red-black tree for mr_key lookup

usNIC provider notes

The usNIC provider does not yet support asynchronous memory registration. Return -FI_EOPNOTSUPP if an event queue is bound to a domain with FI_REG_MR.
Set fi_usnic_info::ui_version correctly in calls to fi_usnic_ops_fabric::getinfo().
Improve fi_cq_sread performance.
Return -FI_EINVAL from av_open when given invalid paramters.
Fix bug in fi_av_remove that could lead to a seg fault.
Implement fi_av_insertsvc.
Report FI_PROTO_RUDP as protocol for EP_RDM.

Verbs provider notes

Add support for RDM EPs. Currently only FI_TAGGED capability is supported. RDM and MSG EPs would be reported in seperate domains since they don't share CQs. The RDM enpoint feature is currently experimental and no guarantees are given with regard to its functionality.
Refactor the code into several files to enable adding RDM support.
Consolidate send code paths to improve maintainability.
Fix a bug in fi_getinfo where wild card address was not used when service argument is given.
Fix fi_getinfo to always return -FI_ENODATA in case of failure.
Add support for fi_eq_write.
Other misc bug fixes.

v1.1.1, Fri Oct 2, 2015

General notes

PSM provider notes

General bug fixes
Proper termination of the name server thread
Add UUID and PSM epid to debug output
Add environment variable to control psm_ep_close timeout
Code refactoring of AM-based messaging
Check more fields of the hints passed to fi_getinfo
Generate error CQ entries for empty result of recv with FI_SEEK flag
Correctly handle overlapped local buffers in atomics
Handle duplicated addresses in fi_av_insert
Fix the return value of fi_cq_readerr
Call AM progress function only when AM is used
Detect MPI runs and turns off name server thread automatically

Sockets provider notes

General clean-up and restructuring
Add fallback mechanism for getting source address
Fix fi_getinfo to use user provided capabilities from hints
Fix hostname and port number and added checks in sock_av_insertsym
Add retry for connection timeout
Release av resources in the error path
Remove separate read/write CQ to be consistent with the man page
Increase default connection map size and added environment variable to specify AV, CQ, EQ and connection map size to run large scale tests
Fix FI_PEEK operation to be consistent with the man page
Fix remote write event not to generate CQ event
Fix CSWAP operation to return initial value
Use size_t for min_multi_recv and buffered_len
Set address size correctly in fi_getname/fi_getpeer

usNIC provider notes

Fix EP_RDM reassembly issue for large messages
Return correct number of read completions on error
Fix EP_RDM and EP_MSG data corruption issue when packets are actually corrupted on the wire
Fix EP_RDM and EP_MSG fi_tx_size_left/fi_rx_size_left functions

Verbs provider notes

Add more logging for errors
Bug fixes

v1.1.0, Wed Aug 5, 2015

General notes

Added fi_info utility tool
Added unified global environment variable support
Fixed configure issues with the clang/llvm compiler suite

PSM provider notes

General bug fixes
Move processing of triggered ops outside of AM handlers
Generate CQ entries for cancelled operations
Remove environment variable FI_PSM_VERSION_CHECK
Fix multi-recv completion generation
Environment variable tweaks

Sockets provider notes

General bug fixes and code cleanup
Add triggered operation suppport
Generate error completion event for successful fi_cancel
Support fi_cancel for tx operations
Enable option for setting affinity to progress thread
Improve error handling during connection management
Avoid reverse lookup for every received message
Avoid polling all connections while checking for incoming message
Use fast_lock for progress engine's list_lock
Handle disconnected sockets
Add rx entry pool
Mark tx entry as completed only if data is sent out to wire
Add rx control context for every tx context for progressing control messages
Set source address when addressing information is not passed by the application
Reset return value after polling CQ ring buffer
Reset FI_TRIGGER flag while triggering triggered operations
Ensure progress of control context

usNIC provider notes

General bug fixes
Add support for fi_getname/fi_setname, fi_cq_sread
Change FI_PREFIX behavior per fi_getinfo(3)
Fix to report correct lengths in all completions
Support fi_inject() with FI_PREFIX
Properly support iov_limit
Support FI_MORE
Fixed fi_tx_size_left() and fi_rx_size_left() usage
Fixed obscure error when posting cq_size operations without reading a completion

Verbs provider notes

AF_IB addreses can now be passed as node argument to fi_getinfo
Added support for fi_setname and migrating passive EP to active EP
Detect and report multiple verbs devices if present
Bug fixes

v1.0.0, Sun May 3, 2015

Initial public release, including the following providers:

PSM
Sockets
usNIC
Verbs

Files

NEWS.md

Latest commit

History

NEWS.md

File metadata and controls

Libfabric release notes

v1.11.0, Fri Aug 14, 2020

Core

EFA

PSM2

RxD

RxM

SHM

Sockets

TCP

Util

Verbs

v1.10.1, Fri May 8, 2020

Core

EFA

Fabtests

RxD

SHM

TCP

v1.10.0, Fri Apr 24, 2020

Core

EFA

PSM2

RxM

RxD

SHM

TCP

Verbs

v1.9.1, Fri Mar 6, 2020

Core

EFA

PSM2

RxM

SHM

TCP

Verbs

v1.9.0, Fri Nov 22, 2019

Core

EFA

MRail

PSM2

RxD

RxM

SHM

TCP

Verbs

v1.8.1, Mon Sep 30, 2019

Core

EFA

PSM2

RxD

RxM

SHM

Verbs

v1.8.0, Fri Jun 28, 2019

Core

EFA

GNI

MRAIL

PSM2

RxD

RxM

SHM

TCP

Verbs

Fabtests

v1.7.2, Fri Jun 14, 2019

Core

GNI

RxD

RxM

TCP

Verbs

Fabtests