# xilinx-cns/onload architecture

> Architecture diagram of the GitHub repository xilinx-cns/onload, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-10-07). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/xilinx-cns/onload
- Repository: https://github.com/xilinx-cns/onload

## Overview

OpenOnload accelerates Linux BSD-socket networking by intercepting application calls and implementing TCP/UDP in a user-level stack, with kernel support and NIC datapaths. The README documents launching applications with `onload`, native Solarflare `ef_vi`, and AF_XDP as an alternative for other adapters. The graph preserves the control-plane, resource-management, and driver subsystems visible in the tree; several internal links are dashed because their call paths were not shown in the sampled source.

Main entry points: [`src/lib/transport/ip/tcp_rx.c`](https://github.com/xilinx-cns/onload/blob/master/src/lib/transport/ip/tcp_rx.c) (TCP/UDP stack), [`src/lib/ciul/ef_vi_internal.h`](https://github.com/xilinx-cns/onload/blob/master/src/lib/ciul/ef_vi_internal.h) (ef_vi interface), [`src/tools/onload_helper/main.c`](https://github.com/xilinx-cns/onload/blob/master/src/tools/onload_helper/main.c) (Onload launcher), [`src/driver/linux_onload/ossock_calls.c`](https://github.com/xilinx-cns/onload/blob/master/src/driver/linux_onload/ossock_calls.c) (Socket interception)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_app_stack["Application and stack"]
  node_launcher["Onload launcher<br/>[main.c]"]
  node_syscall_intercept["Socket interception<br/>[ossock_calls.c]"]
  node_protocol_stack["TCP/UDP stack<br/>[tcp_rx.c]"]
end

subgraph group_control["Control plane"]
  node_control_server["Control-plane server<br/>[server.c]"]
  node_control_services["Service DNAT<br/>[services.c]"]
  node_control_client["Control-plane client<br/>[client.c]"]
  node_kernel_cplane["Kernel control plane<br/>[cplane.c]"]
end

subgraph group_resources["Kernel resources"]
  node_char_manager["Resource interface<br/>[efch_manager.c]"]
  node_efch_api["Character API<br/>[efch.h]"]
  node_resource_manager["Resource managers<br/>[resource_manager.c]"]
  node_buffer_tables["Buffer tables<br/>[bt_manager.c]"]
end

subgraph group_datapath["NIC datapaths"]
  node_ef_vi["ef_vi interface<br/>[ef_vi_internal.h]"]
  node_sfc_driver["SFC network driver<br/>[net_driver.h]"]
  node_sfc_clients["NIC client management<br/>[efx_client.c]"]
  node_af_xdp["AF_XDP backend<br/>[af_xdp.c]"]
  node_shrub_client["Shrub client<br/>[shrub_client.c]"]
end

node_application(("Linux application"))
node_nic{{"Network adapter"}}

node_application -->|"launches via"| node_launcher
node_launcher -.->|"starts accelerated"| node_syscall_intercept
node_syscall_intercept -.->|"dispatches sockets"| node_protocol_stack
node_protocol_stack -.->|"uses native datapath"| node_ef_vi
node_protocol_stack -.->|"uses alternate datapath"| node_af_xdp
node_sfc_driver -.->|"drives"| node_nic
node_af_xdp -.->|"transfers packets"| node_nic
node_ef_vi -.->|"transfers packets"| node_nic
node_char_manager -->|"implements resources"| node_efch_api
node_resource_manager -.->|"manages alongside"| node_buffer_tables
node_control_server -->|"maintains services"| node_control_services
node_control_client -.->|"exchanges state"| node_kernel_cplane
node_sfc_clients -->|"manages NIC clients"| node_sfc_driver
node_shrub_client -.->|"supports client API"| node_ef_vi

click node_launcher "https://github.com/xilinx-cns/onload/blob/master/src/tools/onload_helper/main.c"
click node_syscall_intercept "https://github.com/xilinx-cns/onload/blob/master/src/driver/linux_onload/ossock_calls.c"
click node_protocol_stack "https://github.com/xilinx-cns/onload/blob/master/src/lib/transport/ip/tcp_rx.c"
click node_control_server "https://github.com/xilinx-cns/onload/blob/master/src/tools/cplane/server.c"
click node_control_services "https://github.com/xilinx-cns/onload/blob/master/src/tools/cplane/services.c"
click node_control_client "https://github.com/xilinx-cns/onload/blob/master/src/tools/cplane/client.c"
click node_kernel_cplane "https://github.com/xilinx-cns/onload/blob/master/src/driver/linux_onload/cplane.c"
click node_char_manager "https://github.com/xilinx-cns/onload/blob/master/src/driver/linux_char/efch_manager.c"
click node_efch_api "https://github.com/xilinx-cns/onload/blob/master/src/driver/linux_char/efch.h"
click node_resource_manager "https://github.com/xilinx-cns/onload/blob/master/src/lib/efrm/resource_manager.c"
click node_buffer_tables "https://github.com/xilinx-cns/onload/blob/master/src/lib/efrm/bt_manager.c"
click node_ef_vi "https://github.com/xilinx-cns/onload/blob/master/src/lib/ciul/ef_vi_internal.h"
click node_sfc_driver "https://github.com/xilinx-cns/onload/blob/master/src/driver/linux_net/drivers/net/ethernet/sfc/net_driver.h"
click node_sfc_clients "https://github.com/xilinx-cns/onload/blob/master/src/driver/linux_net/drivers/net/ethernet/sfc/efx_client.c"
click node_af_xdp "https://github.com/xilinx-cns/onload/blob/master/src/lib/efhw/af_xdp.c"
click node_shrub_client "https://github.com/xilinx-cns/onload/blob/master/src/lib/ciul/shrub_client.c"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_launcher,node_syscall_intercept,node_protocol_stack toneBlue
class node_control_server,node_control_services,node_control_client,node_kernel_cplane toneAmber
class node_char_manager,node_efch_api,node_resource_manager,node_buffer_tables toneMint
class node_ef_vi,node_sfc_driver,node_sfc_clients,node_af_xdp,node_shrub_client toneRose
class node_application,node_nic toneIndigo
```

## Components

### Application and stack

- [Onload launcher](https://github.com/xilinx-cns/onload/blob/master/src/tools/onload_helper/main.c): `src/tools/onload_helper/main.c`
- [Socket interception](https://github.com/xilinx-cns/onload/blob/master/src/driver/linux_onload/ossock_calls.c): `src/driver/linux_onload/ossock_calls.c`
- [TCP/UDP stack](https://github.com/xilinx-cns/onload/blob/master/src/lib/transport/ip/tcp_rx.c): `src/lib/transport/ip/tcp_rx.c`

### Control plane

- [Control-plane server](https://github.com/xilinx-cns/onload/blob/master/src/tools/cplane/server.c): `src/tools/cplane/server.c`
- [Service DNAT](https://github.com/xilinx-cns/onload/blob/master/src/tools/cplane/services.c): `src/tools/cplane/services.c`
- [Control-plane client](https://github.com/xilinx-cns/onload/blob/master/src/tools/cplane/client.c): `src/tools/cplane/client.c`
- [Kernel control plane](https://github.com/xilinx-cns/onload/blob/master/src/driver/linux_onload/cplane.c): `src/driver/linux_onload/cplane.c`

### Kernel resources

- [Resource interface](https://github.com/xilinx-cns/onload/blob/master/src/driver/linux_char/efch_manager.c): `src/driver/linux_char/efch_manager.c`
- [Character API](https://github.com/xilinx-cns/onload/blob/master/src/driver/linux_char/efch.h): `src/driver/linux_char/efch.h`
- [Resource managers](https://github.com/xilinx-cns/onload/blob/master/src/lib/efrm/resource_manager.c): `src/lib/efrm/resource_manager.c`
- [Buffer tables](https://github.com/xilinx-cns/onload/blob/master/src/lib/efrm/bt_manager.c): `src/lib/efrm/bt_manager.c`

### NIC datapaths

- [ef_vi interface](https://github.com/xilinx-cns/onload/blob/master/src/lib/ciul/ef_vi_internal.h): `src/lib/ciul/ef_vi_internal.h`
- [SFC network driver](https://github.com/xilinx-cns/onload/blob/master/src/driver/linux_net/drivers/net/ethernet/sfc/net_driver.h): `src/driver/linux_net/drivers/net/ethernet/sfc/net_driver.h`
- [NIC client management](https://github.com/xilinx-cns/onload/blob/master/src/driver/linux_net/drivers/net/ethernet/sfc/efx_client.c): `src/driver/linux_net/drivers/net/ethernet/sfc/efx_client.c`
- [AF_XDP backend](https://github.com/xilinx-cns/onload/blob/master/src/lib/efhw/af_xdp.c): `src/lib/efhw/af_xdp.c`
- [Shrub client](https://github.com/xilinx-cns/onload/blob/master/src/lib/ciul/shrub_client.c): `src/lib/ciul/shrub_client.c`

### Other components

- **Linux application**
- **Network adapter**

## Connections

- Linux application → Onload launcher: launches via
- Onload launcher → Socket interception: starts accelerated
- Socket interception → TCP/UDP stack: dispatches sockets
- TCP/UDP stack → ef_vi interface: uses native datapath
- TCP/UDP stack → AF_XDP backend: uses alternate datapath
- SFC network driver → Network adapter: drives
- AF_XDP backend → Network adapter: transfers packets
- ef_vi interface → Network adapter: transfers packets
- Resource interface → Character API: implements resources (evidence: `src/driver/linux_char/efch_manager.c`)
- Resource managers → Buffer tables: manages alongside
- Control-plane server → Service DNAT: maintains services (evidence: `src/tools/cplane/services.c`)
- Control-plane client → Kernel control plane: exchanges state
- NIC client management → SFC network driver: manages NIC clients (evidence: `src/driver/linux_net/drivers/net/ethernet/sfc/efx_client.c`)
- Shrub client → ef_vi interface: supports client API (evidence: `src/lib/ciul/shrub_client.c`)
