The following table shows the revision history for this document.
| Section | Revision Summary |
|---|---|
| 01/22/2026 Version 1.4 | |
| New Features in OpenOnload-9.1.1 | Added. |
| Removing an Existing Installation | Added note about onload_cplane user. |
| Loading the Onload Drivers | Added X4 series adapters. |
| Allowlist and Denylist for Interfaces | Updated filepath and explanation. |
| X4 Filters | Added. |
| SDCI | Added. |
| Using SHRUB | Added. |
| Transmitted Packets | Corrected when timestamp is generated. |
| Urgent Data Processing | Added important note. |
| Multicast on the Express Datapath of X4-Series Adapters | Changed variable name to EF_SHRUB_CONTROLLER. |
| CTPIO Transmit Recovery | Added. |
| Environment Variables | Added EF_SHRUB_DEFAULT_AUTO_CLOSE_DELAY and EF_SHRUB_USE_INTERRUPTS. |
| Module Options | Added shrub_controller_path. |
| Adapter Net Drivers | Added Onload 9.1.1 release. |
| Module Options | Changed example to use current option. |
| EF_ACCEPTQ_MAX_BACKLOG | Updated default value. |
| EF_MCAST_JOIN_BINDTODEVICE | Updated description. |
| EF_SHRUB_AUTO_CLOSE_DELAY | Added. |
| EF_SHRUB_USE_INTERRUPTS | Added. |
| EF_TCP_URG_MODE | Added important note. |
| Common Components | Updated to recommend static linking. |
| onload_ordered_epoll_wait | Simplified description of return value. |
| 11/03/2025 Version 1.31 | |
| X4 Functionality | Removed. See Release Notes instead. |
| X4 Datapath Restrictions | Removed. See Release Notes instead. |
| X4 Known Issues | Removed. See Release Notes instead. |
| 10/27/2025 Version 1.3 | |
| New Features in OpenOnload-9.1.0 | Added. |
| New Features in OpenOnload-9.0.2 | Added. |
| New Features in OpenOnload-9.0.1 | Added. |
| New Features in OpenOnload-9.0.0 | Added. |
| New Features in OpenOnload-8.1.3 | Added. |
| New Features in OpenOnload-8.1.2 | Added. |
| New Features in OpenOnload-8.1.1 | Added. |
| New Features in OpenOnload-7.1.3 | Removed. |
| New Features in OpenOnload-7.1.2 | Removed. |
| New Features in OpenOnload-7.1.1 | Removed. |
| New Features in OpenOnload-7.1.0 | Removed. |
| New Features in OpenOnload-7.0.0 | Removed. |
| X4 Low Latency Quickstart | Added. |
| emg1648691074219.html#emg1648691074219__ae1555218 | Reordered to prioritize RPM and DEB installation. DKMS and tarball packages deprecated. |
| Cloud Build Profile | Moved. |
| Supported Network Adapters | Added X4. |
| Supported Operating Systems | Updated to reference Release Notes. |
| The sfc Driver | Retitled. |
| Removing Previously Installed sfc Drivers | Moved. |
| Choosing a Distribution and Format | Obsolete content removed, retitled. |
| Building and Installing from a Source RPM | Updated to describe new sub-packages. Added cloud build profile. |
| Building and Installing from a Source DEB | Updated to describe new sub-packages. Added cloud build profile. |
| Cloud Build Profile | Previous duplicate removed. |
| Building a Source RPM from a Tarball | Removed. |
| Loading the Onload Drivers | Replicated content merged into here. |
| Rebuilding the initramfs | Added. |
| Reducing Jitter from Memory Allocation | Retitled. Reordered content. |
| Processing at User-Level | Added EF_UL_EPOLL. |
| Virtual Network Interface (VNIC) | Updated for X4. |
| Changing Onload Control Plane Table Sizes | Removed obsolete method. |
| Example API for Wire Order Delivery | Updated installation instructions. |
| Stack Sharing | Updated for X3 and X4. |
| Application Clustering | Updated for X3 and X4. |
| eXpress Data Path (XDP) | Updated for X3 and X4. Updated installation instructions. |
| Debug and Logging | Updated installation instructions. |
| Hardware Timestamps | Reorganized. Updated for X3 and X4. |
| Example Timestamping Applications | Updated installation instructions. |
| TCP Striping | Removed. |
| Multicast Replication | Updated for X4. |
| Multicast on X3-Series Adapters | Added. |
| Multicast on the Express Datapath of X4-Series Adapters | Added. |
| Multicast Receive and Multiple Sockets | Updated for X4. |
| Hardware Multicast Loopback | Updated for X4. |
| Programmed I/O | Updated. |
| SOF_TIMESTAMPING_OPT_ID | Added versions where not supported. |
| Bonding, Link Aggregation | Added warning of duplicate packets. |
| VLANs | Updated for X4. |
| Duplicate IP or MAC Addresses | Added VLAN interfaces. |
| Mapping Onload Versions | Removed. |
| Features | Updated for X4. |
| Environment Variables | Added EF_ENABLE_TX_ERROR_RECOVERY, EF_SHRUB_BUFFER_COUNT, EF_SHRUB_CONTROLLER, EF_SHRUB_DEBUG, EF_SHRUB_UNICAST, EF_TPH_MODE, EF_CHALLENGE_ACK_LIMIT, EF_DUMP_STACK_ON_EXIT, EF_NO_HW, EF_RX_DATAPATH, EF_RX_TIMESTAMPING_ORDERING, EF_RX_TIMESTAMPING_TRAILER FORMAT, EF_TCP_RST_COOLDOWN, EF_TX_DATAPATH, EF_ACCEPTQ_MAX_BACKLOG, EF_LOG, and EF_SHARED_RXQ_NUM. |
| Module Options | Moved description of module options to new Module Options appendix. |
| Adapter Net Drivers | Added releases after Onload 8.1.0.15. |
| EF_ACCEPTQ_MAX_BACKLOG | Added. |
| EF_CHALLENGE_ACK_LIMIT | Removed. |
| EF_CTPIO_MAX_FRAME_LEN | Updated default value. |
| EF_DUMP_STACK_ON_EXIT | Added. |
| EF_ENABLE_TX_ERROR_RECOVERY | Added. |
| EF_LOG | Added more_config_warnings option. |
| EF_NO_HW | Added. |
| EF_RXQ_SIZE | Added note on using EF_LOG more_config_warnings option. |
| EF_RX_DATAPATH | Added. |
| EF_RX_TIMESTAMPING_ORDERING | Added trailer option. |
| EF_RX_TIMESTAMPING_TRAILER_FORMAT | Added. |
| EF_SHARED_RXQ_NUM | Added. |
| EF_SHRUB_BUFFER_COUNT | Added. |
| EF_SHRUB_CONTROLLER | Added. |
| EF_SHRUB_DEBUG | Added. |
| EF_SHRUB_UNICAST | ASdded. |
| EF_TCP_RST_COOLDOWN | Added. |
| EF_TPH_MODE | Added. |
| EF_TX_DATAPATH | Added. |
| onload_get_tcp_info | Added. |
| Templated Sends API | Updated for X4. |
| SolarCapture | Added URL for source. |
| eflatency | Added CTPIO. |
| eflatency | Updated installation instructions and help output. |
| X3 Low Latency Quickstart | Moved to appendix. |
| 07/31/2023 Version 1.2 | |
| New Features in OpenOnload-8.1.0 | Added. |
| New Features in OpenOnload-8.0.2 | Added. |
| New Features in OpenOnload-8.0.1 | Added. |
| Supported Operating Systems | Updated for Onload 8.1.0. |
| Features | Added features that are new in Onload 8.1.0. |
| Environment Variables | Added change to EF_CHALLENGE_ACK_LIMIT. |
| Module Options | Inserted line breaks in examples. |
| Adapter Net Drivers | Added releases after Onload 8.0.0.34. |
| EF_CHALLENGE_ACK_LIMIT | Increased default and maximum values. |
| EF_TCP_RCVBUF | Added minimum and maximum values. |
| EF_TCP_RCVBUF_ESTABLISHED_DEFAULT | Added minimum and maximum values. |
| EF_TCP_SNDBUF | Added minimum and maximum values. |
| EF_TCP_SNDBUF_ESTABLISHED_DEFAULT | Added minimum and maximum values. |
| EF_UDP_RCVBUF | Added minimum and maximum values. |
| EF_UDP_SNDBUF | Added minimum and maximum values. |
| 04/07/2023 Version 1.1 | |
| What’s New | Updated download locations in first note. |
| Onload and Network Adapter Drivers | Retitled and rearranged. Updated to emphasize that X3 drivers must be built and installed before Onload. |
| Table 1 | Updated PIO buffer sizes. |
| 10/18/2022 Version 1.0 | |
| Initial release. | N/A |