DOCA Library APIs

Table of Contents

• 1. Change Log
• 2. Modules
  • 2.1. DOCA AES-GCM Engine
  • 2.2. DOCA App Shield
    • 2.2.1. DOCA App Shield Attributes
  • 2.3. DOCA Arg Parser
  • 2.4. DOCA Core
    • 2.4.1. operations for DOCA Types
    • 2.4.2. DOCA Buffer
    • 2.4.3. DOCA Buffer Array
    • 2.4.4. DOCA Buffer Inventory
    • 2.4.5. DOCA Buffer Pool
    • 2.4.6. DOCA Context
    • 2.4.7. DOCA Device
    • 2.4.8. DOCA DPDK Bridge
    • 2.4.9. DOCA Error
    • 2.4.10. DOCA Graph
    • 2.4.11. DOCA Memory Map
    • 2.4.12. DOCA MMAP advise
    • 2.4.13. DOCA Progress Engine
    • 2.4.14. DOCA RDMA Bridge
    • 2.4.15. DOCA Sync Event
    • 2.4.16. DOCA Types
    • 2.4.17. DOCA uar
    • 2.4.18. DOCA umem
  • 2.5. DOCA Comch
    • 2.5.1. DOCA Comch Consumer
    • 2.5.2. DOCA Comch MsgQ
    • 2.5.3. DOCA Comch Producer
  • 2.6. DOCA Compatibility Management
  • 2.7. DOCA Compress Engine
  • 2.8. DOCA Environment Configurations
  • 2.9. DOCA Device Emulation
    • 2.9.1. DOCA Device Emulation - PCI Devices
      • 2.9.1.1. DOCA Device Emulation - PCI Device Types
    • 2.9.2. DOCA Device Emulation - Virtio FS Devices
      • 2.9.2.1. DOCA Device Emulation - Virtio FS IO Context
      • 2.9.2.2. DOCA Device Emulation - Virtio FS Device Types
    • 2.9.3. DOCA Device Emulation - Virtio Devices
      • 2.9.3.1. DOCA Device Emulation - Virtio IO Context
      • 2.9.3.2. DOCA Device Emulation - Virtio Device Types
  • 2.10. DOCA DMA Engine
  • 2.11. DOCA DPA
    • 2.11.1. DOCA DPA Host
    • 2.11.2. DOCA DPA Device
      • 2.11.2.1. DOCA DPA Device - Buffer
      • 2.11.2.2. DOCA DPA Device - Comch MsgQ
      • 2.11.2.3. DOCA DPA Device - Device Emulation for PCI devices
      • 2.11.2.4. DOCA DPA Device - RDMA
      • 2.11.2.5. DOCA DPA Device - Sync Event
  • 2.12. DOCA Erasure Coding Engine
  • 2.13. DOCA ETH
    • 2.13.1. DOCA ETH RXQ
      • 2.13.1.1. DOCA ETH RXQ CPU Data Path
    • 2.13.2. DOCA ETH TXQ
      • 2.13.2.1. DOCA ETH TXQ CPU Data Path
      • 2.13.2.2. DOCA ETH TXQ GPU Data Path
  • 2.14. DOCA Flow
    • 2.14.1. Doca Flow Crypto
    • 2.14.2. Doca Flow CT
    • 2.14.3. Doca Flow Net
    • 2.14.4. DOCA Flow Tune Server
  • 2.15. DOCA GPUNetIO Engine
    • 2.15.1. DOCA GPUNetIO Device - Buffer
    • 2.15.2. DOCA GPUNetIO Device - Ethernet RXQ
    • 2.15.3. DOCA GPUNetIO Device - Ethernet TXQ
    • 2.15.4. DOCA GPUNetIO Device - RDMA
    • 2.15.5. DOCA GPUNetIO Device - Semaphore
  • 2.16. DOCA GPUNetIO engine
  • 2.17. DOCA Logging Management
  • 2.18. DOCA PCC Device
    • 2.18.1. DOCA PCC Device Algorithm Access
    • 2.18.2. DOCA PCC Device Common
    • 2.18.3. DOCA PCC Device Event
    • 2.18.4. DOCA PCC Device Services
    • 2.18.5. DOCA PCC Device Utilities
    • 2.18.6. DOCA PCC Device Notification Point
  • 2.19. DOCA RDMA
  • 2.20. DOCA RMAX Engine
  • 2.21. DOCA SHA Engine
  • 2.22. DOCA Telemetry Diagnostics
  • 2.23. DOCA telemetry DPA
  • 2.24. DOCA Telemetry Exporter
    • 2.24.1. DOCA Telemetry NetFlow
  • 2.25. DOCA Telemetry PCC
  • 2.26. DOCA UROM (Unified Resource and Offload Manager)
    • 2.26.1. DOCA UROM Services
    • 2.26.2. DOCA UROM Environment Variables
    • 2.26.3. DOCA UROM Workers
    • 2.26.4. DOCA UROM Worker Tasks
    • 2.26.5. DOCA UROM Domains
    • 2.26.6. DOCA UROM Plugins
  • 2.27. DOCA Version Management
• 3. Data Structures
  • 3.1. doca_data
  • 3.2. doca_dpa_dev_buf
  • 3.3. doca_dpa_dev_buf_arr
  • 3.4. doca_flow_action_desc
  • 3.5. doca_flow_action_descs
  • 3.6. doca_flow_actions
  • 3.7. doca_flow_crypto_action
  • 3.8. doca_flow_crypto_encap_action
  • 3.9. doca_flow_crypto_key_cfg
  • 3.10. doca_flow_ct_actions
  • 3.11. doca_flow_ct_aging_conn
  • 3.12. doca_flow_ct_aging_conn_event
  • 3.13. doca_flow_ct_aging_conn_update_info
  • 3.14. doca_flow_ct_aging_counter
  • 3.15. doca_flow_ct_aging_counter_state
  • 3.16. doca_flow_ct_aging_ctx
  • 3.17. doca_flow_ct_aging_ops
  • 3.18. doca_flow_ct_ip4
  • 3.19. doca_flow_ct_ip6
  • 3.20. doca_flow_ct_match
  • 3.21. doca_flow_ct_match4
  • 3.22. doca_flow_ct_match6
  • 3.23. doca_flow_desc_field
  • 3.24. doca_flow_encap_action
  • 3.25. doca_flow_entropy_format
  • 3.26. doca_flow_fwd
  • 3.27. doca_flow_geneve_option
  • 3.28. doca_flow_header_eth
  • 3.29. doca_flow_header_eth_vlan
  • 3.30. doca_flow_header_format
  • 3.31. doca_flow_header_geneve
  • 3.32. doca_flow_header_ib_bth
  • 3.33. doca_flow_header_icmp
  • 3.34. doca_flow_header_ip4
  • 3.35. doca_flow_header_ip6
  • 3.36. doca_flow_header_l4_port
  • 3.37. doca_flow_header_mpls
  • 3.38. doca_flow_header_psp
  • 3.39. doca_flow_header_roce_v2
  • 3.40. doca_flow_header_tcp
  • 3.41. doca_flow_header_udp
  • 3.42. doca_flow_ip_addr
  • 3.43. doca_flow_match
  • 3.44. doca_flow_match_condition
  • 3.45. doca_flow_meta
  • 3.46. doca_flow_mirror_target
  • 3.47. doca_flow_monitor
  • 3.48. doca_flow_nat64_action
  • 3.49. doca_flow_ordered_list
  • 3.50. doca_flow_ordered_list_element
  • 3.51. doca_flow_parser_geneve_opt_cfg
  • 3.52. doca_flow_parser_meta
  • 3.53. doca_flow_push_action
  • 3.54. doca_flow_push_vlan_action
  • 3.55. doca_flow_resource_decap_cfg
  • 3.56. doca_flow_resource_encap_cfg
  • 3.57. doca_flow_resource_ipsec_sa_cfg
  • 3.58. doca_flow_resource_meter_cfg
  • 3.59. doca_flow_resource_mirror_cfg
  • 3.60. doca_flow_resource_psp_cfg
  • 3.61. doca_flow_resource_query
  • 3.62. doca_flow_resource_rss_cfg
  • 3.63. doca_flow_shared_resource_cfg
  • 3.64. doca_flow_tun
  • 3.65. doca_gather_list
  • 3.66. doca_log_registrator
  • 3.67. doca_pcc_dev_algo_meta_data
  • 3.68. doca_pcc_dev_results_t
  • 3.69. doca_pcc_np_dev_response_packet
  • 3.70. doca_rdma_gid
  • 3.71. doca_rmax_in_stream_result
  • 3.72. doca_rmax_stream_error
  • 3.73. doca_telemetry_diag_data_sample_format_0
  • 3.74. doca_telemetry_diag_data_sample_format_0_value
  • 3.75. doca_telemetry_diag_data_sample_format_1
  • 3.76. doca_telemetry_diag_data_sample_format_2
  • 3.77. doca_telemetry_dpa_cumul_info_t
  • 3.78. doca_telemetry_dpa_event_sample_t
  • 3.79. doca_telemetry_dpa_process_info_t
  • 3.80. doca_telemetry_dpa_thread_info_t
  • 3.81. doca_urom_domain_oob_coll
  • 3.82. doca_urom_service_plugin_info
  • 3.83. urom_domain_lookups_iface
  • 3.84. urom_plugin_iface
  • 3.85. urom_worker_cmd
  • 3.86. urom_worker_cmd_desc
  • 3.87. urom_worker_ctx
  • 3.88. urom_worker_notif_desc
  • 3.89. urom_worker_notify
• 4. Data Fields