Programmer’s Guide¶

• 1. Introduction
  • 1.1. Documentation Roadmap
  • 1.2. Related Publications
• 2. Overview
  • 2.1. Development Environment
  • 2.2. Components
    • 2.2.1. Cloud Native Environment (cne)
    • 2.2.2. Events
    • 2.2.3. Hash
    • 2.2.4. Key Value
    • 2.2.5. Log
    • 2.2.6. Memory Pool Manager
    • 2.2.7. Memory Map (mmap)
    • 2.2.8. OS Abstraction Layer (osal)
    • 2.2.9. Network Packet Buffer Management (pktmbuf)
    • 2.2.10. Poll-Mode Drivers (pmds)
    • 2.2.11. Ring
    • 2.2.12. Tx Buffer (txbuff)
    • 2.2.13. xskdev
    • 2.2.14. pktdev
    • 2.2.15. Application Libraries (lib/usr/app)
    • 2.2.16. C Language Libraries (clib)
  • 2.3. CNET - Cloud Native Network stack (lib/cnet)
• 3. Ring Library
  • 3.1. Lockless Ring Buffer in Linux*
  • 3.2. Additional Features
    • 3.2.1. Name
  • 3.3. Use Cases
  • 3.4. Anatomy of a Ring Buffer
    • 3.4.1. Single Producer Enqueue
    • 3.4.2. Single Consumer Dequeue
    • 3.4.3. Multiple Producers Enqueue
    • 3.4.4. Modulo 32-bit Indexes
  • 3.5. References
• 4. Mempool Library
  • 4.1. Local Cache
  • 4.2. Use Cases
• 5. MsgChan Library
  • 5.1. Use Cases
  • 5.2. Anatomy of a MsgChan
• 6. Pktmbuf Library
  • 6.1. Design of Packet Buffers
  • 6.2. Pktmbuf and UMEM layout
  • 6.3. Buffers Stored in Memory Pools (UMEM)
  • 6.4. Constructors
  • 6.5. Allocating and Freeing pktmbufs
  • 6.6. Manipulating pktmbufs
  • 6.7. Meta Information
• 7. Graph Library and Inbuilt Nodes
  • 7.1. Features
  • 7.2. Advantages of Graph architecture
  • 7.3. Performance tuning parameters
  • 7.4. Programming model
    • 7.4.1. Anatomy of Node:
    • 7.4.2. Node creation and registration
    • 7.4.3. Link the Nodes to create the graph topology
    • 7.4.4. Create the graph object
    • 7.4.5. Multicore graph processing
    • 7.4.6. In fast path
    • 7.4.7. Context update when graph walk in action
    • 7.4.8. Get the node statistics using graph cluster
    • 7.4.9. Node writing guidelines
    • 7.4.10. Static nodes
    • 7.4.11. Intermediate nodes
  • 7.5. Graph object memory layout
  • 7.6. Inbuilt Nodes
    • 7.6.1. pktdev_rx
    • 7.6.2. pktdev_tx
    • 7.6.3. pkt_drop
    • 7.6.4. ip4_lookup
    • 7.6.5. ip4_rewrite
    • 7.6.6. null
• 8. Crypto Libraries
  • 8.1. OpenSSL*
  • 8.2. Intel(R) Multi-Buffer Crypto for IPsec Library
  • 8.3. Legal Acknowledgements
• 9. xskdev Buffer Management
• 10. CNET Stack Library
  • 10.1. Overview
  • 10.2. CNET Pod/Container Overview
  • 10.3. CNET Graph nodes
    • 10.3.1. CNET nodes
    • 10.3.2. Input Nodes
  • 10.4. Anatomy of CNET processing
    • 10.4.1. CNET Structure
    • 10.4.2. CNET Stack Structure
    • 10.4.3. CNET Channel Structure
    • 10.4.4. Protocol Control Block (PCB)
• 11. Glossary