Programmer’s Guide

• 1. Common Libraries
  • 1.1. Introduction
  • 1.2. Libraries Details
    • 1.2.1. DAO Logger
    • 1.2.2. DAO Utilities
    • 1.2.3. DAO DMA
    • 1.2.4. DAO Bitmap Helper
    • 1.2.5. DAO Assert Helper
• 2. Conntrack Library
  • 2.1. Introduction
  • 2.2. What it does
  • 2.3. How to use it
    • 2.3.1. Initialization
    • 2.3.2. Packet Processing
    • 2.3.3. Connection Cleanup
    • 2.3.4. Shutdown
    • 2.3.5. Debugging & Monitoring
• 3. DMA Library
  • 3.1. Initialization
  • 3.2. Packet Processing
• 4. Ethernet Transport Library
  • 4.1. Architecture Overview
  • 4.2. API Usage
  • 4.3. Transport Protocol
    • 4.3.1. TRS header format
    • 4.3.2. TRS packet format
  • 4.4. Usage Restrictions
• 5. Flow Library
  • 5.1. Introduction
  • 5.2. Flow Rule
  • 5.3. Programming Model
    • 5.3.1. Initialization
    • 5.3.2. Flow Creation
    • 5.3.3. Flow Lookup
    • 5.3.4. Flow Destruction
    • 5.3.5. Flow Query
    • 5.3.6. Flow Flush
    • 5.3.7. Flow Information
    • 5.3.8. Installing flow directly into hardware
    • 5.3.9. Removing a flow from hardware
• 6. Liquid Crypto Library
  • 6.1. Architecture Overview
  • 6.2. Features
    • 6.2.1. Asymmetric Cryptography
    • 6.2.2. Symmetric Cryptography
      • 6.2.2.1. Ciphering Algorithms
      • 6.2.2.2. Authentication Algorithms
      • 6.2.2.3. AEAD Algorithms
  • 6.3. Control Plane
    • 6.3.1. Setup Device and Queues
    • 6.3.2. Device Teardown
    • 6.3.3. Command Queue
  • 6.4. Data Plane
    • 6.4.1. Enqueue API - Asymmetric Crypto
    • 6.4.2. Enqueue API - Symmetric Crypto
    • 6.4.3. Dequeue API
  • 6.5. Known Limitations
• 7. Netlink Library
  • 7.1. Introduction
  • 7.2. Native netlink registration
    • 7.2.1. Netlink protocols
      • 7.2.1.1. Netlink Object
    • 7.2.2. Native parse callbacks
    • 7.2.3. Netlink multicast groups
    • 7.2.4. Notifier Object
      • 7.2.4.1. Application specific ops
      • 7.2.4.2. Application specific cookie
      • 7.2.4.3. Get notifier object for a given parse_cb
  • 7.3. High level netlink registration
    • 7.3.1. NETLINK_ROUTE
    • 7.3.2. NETLINK_XFRM
  • 7.4. Programming model
    • 7.4.1. Initialization
    • 7.4.2. Periodic Netlink polling
      • 7.4.2.1. dao_netlink_poll()
      • 7.4.2.2. dao_netlink_poll_complete()
      • 7.4.2.3. Pseudo-code
    • 7.4.3. Netlink Cleanup
• 8. PEM Library
  • 8.1. Prerequisites:
  • 8.2. Device Identification
  • 8.3. Device Initialization
  • 8.4. Memory regions registration for polling
  • 8.5. Get VF specific bar region info
• 9. Port Group Library
  • 9.1. Introduction
  • 9.2. Programming model
    • 9.2.1. Initializing Port group library
    • 9.2.2. Creating a Port Group
    • 9.2.3. Adding port to a Port Group
    • 9.2.4. Number of ports in Port group
    • 9.2.5. Port group lookup by name
    • 9.2.6. Iterating over Port group
    • 9.2.7. Deleting port from Port group
    • 9.2.8. Destroying a Port group
• 10. Port Queue Group Library
  • 10.1. Introduction
  • 10.2. Programming model
    • 10.2.1. Initializing Port queue group library
    • 10.2.2. Creating a Port queue group
    • 10.2.3. Assigning [port, queue] to a core within Port queue group
    • 10.2.4. Number of [port, queue] in Port queue group
    • 10.2.5. Port queue group lookup by name
    • 10.2.6. Iterating over Port queue group on fast path core
    • 10.2.7. Deleting port from Port queue group
    • 10.2.8. Destroying a Port queue group
• 11. VFIO Library
  • 11.1. Prerequisites for Platform Devices:
  • 11.2. Prerequisites for PCIe Devices:
  • 11.3. DAO VFIO device initialization
  • 11.4. DAO VFIO device cleanup
• 12. VirtIO Library
  • 12.1. VirtIO Device initialization
  • 12.2. Features
• 13. VirtIO Crypto Library
  • 13.1. Features
    • 13.1.1. VirtIO Common Feature Bits:
    • 13.1.2. VirtIO-crypto Feature Bits:
    • 13.1.3. VirtIO-crypto Services:
  • 13.2. VirtIO-crypto device identification
  • 13.3. Device initialization
  • 13.4. User callback APIs
  • 13.5. VirtIO Crypto Queue Overview
  • 13.6. Queue count
  • 13.7. VirtIO Descriptors Management API
  • 13.8. Host receive API
  • 13.9. Host transmit API
• 14. VirtIO Net Library
  • 14.1. Features
    • 14.1.1. VirtIO Common Feature Bits:
    • 14.1.2. VirtIO-net Feature Bits:
  • 14.2. VirtIO Emulation Architecture Overview
  • 14.3. VirtIO-net device identification
  • 14.4. Device initialization
  • 14.5. User callback APIs
  • 14.6. Queue count
  • 14.7. Link status update
  • 14.8. VirtIO descriptors Management API
  • 14.9. Enqueue Burst API
  • 14.10. Dequeue Burst API
• 15. VirtIO Block Library
  • 15.1. Features
    • 15.1.1. VirtIO Common Feature Bits
    • 15.1.2. VirtIO Block Feature Bits
    • 15.1.3. Notes on Supported Features
  • 15.2. VirtIO Emulation Architecture Overview
  • 15.3. VirtIO Block Device Usage
    • 15.3.1. VirtIO Block Device Identification
    • 15.3.2. VirtIO Block Device Initialization
    • 15.3.3. VirtIO Queues
    • 15.3.4. VirtIO Block Data Path
    • 15.3.5. Request Dequeue
    • 15.3.6. Request Completion Marking
    • 15.3.7. VirtIO Descriptors Management
• 16. Block Device Library
  • 16.1. Features
  • 16.2. Library APIs
    • 16.2.1. Control Path API
    • 16.2.2. Data Path API