:orphan: .. index:: pair: group; BPF/XDP configuration of Test Agents .. _doxid-group__tapi__bpf: BPF/XDP configuration of Test Agents ==================================== .. toctree:: :hidden: group_tapi_bpf_rxq_stats.rst enum_tapi_bpf_link_point.rst enum_tapi_bpf_map_type.rst enum_tapi_bpf_prog_type.rst enum_tapi_bpf_state.rst enum_tapi_bpf_xdp_action.rst struct_tapi_bpf_lpm_trie_key.rst Overview ~~~~~~~~ Definition of API to configure BPF/XDP programs. :ref:`More...` | :ref:`Test API to control rxq_stats BPF program` .. ref-code-block:: cpp :class: doxyrest-overview-code-block // typedefs typedef enum :ref:`tapi_bpf_state` :ref:`tapi_bpf_state`; typedef enum :ref:`tapi_bpf_prog_type` :ref:`tapi_bpf_prog_type`; typedef enum :ref:`tapi_bpf_map_type` :ref:`tapi_bpf_map_type`; typedef enum :ref:`tapi_bpf_link_point` :ref:`tapi_bpf_link_point`; typedef enum :ref:`tapi_bpf_xdp_action` :ref:`tapi_bpf_xdp_action`; typedef struct :ref:`tapi_bpf_lpm_trie_key` :ref:`tapi_bpf_lpm_trie_key`; // enums enum :ref:`tapi_bpf_link_point`; enum :ref:`tapi_bpf_map_type`; enum :ref:`tapi_bpf_prog_type`; enum :ref:`tapi_bpf_state`; enum :ref:`tapi_bpf_xdp_action`; // structs struct :ref:`tapi_bpf_lpm_trie_key`; // global functions char* :ref:`tapi_bpf_build_bpf_obj_path`(const char* ta, const char* bpf_prog_name); :ref:`te_errno` :ref:`tapi_bpf_obj_add`(const char* ta, const char* fname, unsigned int* bpf_id); :ref:`te_errno` :ref:`tapi_bpf_obj_del`(const char* ta, unsigned int bpf_id); :ref:`te_errno` :ref:`tapi_bpf_obj_load`(const char* ta, unsigned int bpf_id); :ref:`te_errno` :ref:`tapi_bpf_obj_get_state`(const char* ta, unsigned int bpf_id, :ref:`tapi_bpf_state`* bpf_state); :ref:`te_errno` :ref:`tapi_bpf_obj_unload`(const char* ta, unsigned int bpf_id); :ref:`te_errno` :ref:`tapi_bpf_obj_get_type`(const char* ta, unsigned int bpf_id, :ref:`tapi_bpf_prog_type`* type); :ref:`te_errno` :ref:`tapi_bpf_obj_set_type`(const char* ta, unsigned int bpf_id, :ref:`tapi_bpf_prog_type` type); :ref:`te_errno` :ref:`tapi_bpf_prog_get_list`(const char* ta, unsigned int bpf_id, char*** prog, unsigned int* prog_count); :ref:`te_errno` :ref:`tapi_bpf_prog_link`(const char* ta, const char* ifname, unsigned int bpf_id, :ref:`tapi_bpf_link_point` link_type, const char* prog); :ref:`te_errno` :ref:`tapi_bpf_prog_unlink`(const char* ta, const char* ifname, :ref:`tapi_bpf_link_point` link_type); :ref:`te_errno` :ref:`tapi_bpf_map_get_list`(const char* ta, unsigned int bpf_id, char*** map, unsigned int* map_count); :ref:`te_errno` :ref:`tapi_bpf_map_get_type`(const char* ta, unsigned int bpf_id, const char* map, :ref:`tapi_bpf_map_type`* type); :ref:`te_errno` :ref:`tapi_bpf_map_get_key_size`(const char* ta, unsigned int bpf_id, const char* map, unsigned int* key_size); :ref:`te_errno` :ref:`tapi_bpf_map_get_val_size`(const char* ta, unsigned int bpf_id, const char* map, unsigned int* val_size); :ref:`te_errno` :ref:`tapi_bpf_map_get_max_entries`(const char* ta, unsigned int bpf_id, const char* map, unsigned int* max_entries); :ref:`te_errno` :ref:`tapi_bpf_map_get_writable_state`(const char* ta, unsigned int bpf_id, const char* map, bool* is_writable); :ref:`te_errno` :ref:`tapi_bpf_map_set_writable`(const char* ta, unsigned int bpf_id, const char* map); :ref:`te_errno` :ref:`tapi_bpf_map_unset_writable`(const char* ta, unsigned int bpf_id, const char* map); :ref:`te_errno` :ref:`tapi_bpf_map_update_kvpair`(const char* ta, unsigned int bpf_id, const char* map, const uint8_t* key, unsigned int key_size, const uint8_t* val, unsigned int val_size); :ref:`te_errno` :ref:`tapi_bpf_map_lookup_kvpair`(const char* ta, unsigned int bpf_id, const char* map, const uint8_t* key, unsigned int key_size, uint8_t* val, unsigned int val_size); :ref:`te_errno` :ref:`tapi_bpf_map_delete_kvpair`(const char* ta, unsigned int bpf_id, const char* map, const uint8_t* key, unsigned int key_size); :ref:`te_errno` :ref:`tapi_bpf_map_get_key_list`(const char* ta, unsigned int bpf_id, const char* map, unsigned int* key_size, uint8_t*** key, unsigned int* count); :ref:`te_errno` :ref:`tapi_bpf_map_set_pin`(const char* ta, unsigned int bpf_id, const char* map, const char* pin_path); :ref:`te_errno` :ref:`tapi_bpf_map_get_pin`(const char* ta, unsigned int bpf_id, const char* map, char** pin_path); :ref:`te_errno` :ref:`tapi_bpf_perf_event_init`(const char* ta, unsigned int bpf_id, const char* map, unsigned int event_size); :ref:`te_errno` :ref:`tapi_bpf_perf_event_deinit`(const char* ta, unsigned int bpf_id, const char* map); :ref:`te_errno` :ref:`tapi_bpf_perf_get_events`(const char* ta, unsigned int bpf_id, const char* map, unsigned int* num, uint8_t** data); :ref:`te_errno` :ref:`tapi_bpf_perf_map_get_list`(const char* ta, unsigned int bpf_id, char*** map, unsigned int* map_count); :ref:`te_errno` :ref:`tapi_bpf_obj_init`(const char* ta, const char* path, :ref:`tapi_bpf_prog_type` type, unsigned int* bpf_id); :ref:`te_errno` :ref:`tapi_bpf_obj_fini`(const char* ta, unsigned int bpf_id); :ref:`te_errno` :ref:`tapi_bpf_prog_name_check`(const char* ta, unsigned int bpf_id, const char* prog_name); :ref:`te_errno` :ref:`tapi_bpf_map_type_name_check`(const char* ta, unsigned int bpf_id, const char* map_name, :ref:`tapi_bpf_map_type` map_type); static :ref:`te_errno` :ref:`tapi_bpf_map_name_check`(const char* ta, unsigned int bpf_id, const char* map_name); :ref:`te_errno` :target:`tapi_bpf_map_check_type`(const char* ta, unsigned int bpf_id, const char* map_name, :ref:`tapi_bpf_map_type` exp_map_type); :ref:`te_errno` :ref:`tapi_bpf_ip_tcpudp_filter_from_sa`(:ref:`te_bpf_ip_tcpudp_filter`* filter, int family, int protocol, const struct sockaddr* src_addr, const struct sockaddr* dst_addr); // macros #define :target:`TE_BPF_U8` .. _details-group__tapi__bpf: Detailed Documentation ~~~~~~~~~~~~~~~~~~~~~~ Definition of API to configure BPF/XDP programs. Copyright (C) 2019-2022 OKTET Labs Ltd. All rights reserved. Typedefs -------- .. index:: pair: typedef; tapi_bpf_state .. _doxid-group__tapi__bpf_1gad1c38a13f138796db6393b77eebbd703: .. ref-code-block:: cpp :class: doxyrest-title-code-block typedef enum :ref:`tapi_bpf_state` tapi_bpf_state BPF object states .. index:: pair: typedef; tapi_bpf_prog_type .. _doxid-group__tapi__bpf_1gad2280f651d651c6f2491c8f240177749: .. ref-code-block:: cpp :class: doxyrest-title-code-block typedef enum :ref:`tapi_bpf_prog_type` tapi_bpf_prog_type BPF program types .. index:: pair: typedef; tapi_bpf_map_type .. _doxid-group__tapi__bpf_1gaca0f275d034edc38306862d173ad3047: .. ref-code-block:: cpp :class: doxyrest-title-code-block typedef enum :ref:`tapi_bpf_map_type` tapi_bpf_map_type BPF map types .. index:: pair: typedef; tapi_bpf_link_point .. _doxid-group__tapi__bpf_1gaaddc0bc3e7394cc7c2dbfaecd7603530: .. ref-code-block:: cpp :class: doxyrest-title-code-block typedef enum :ref:`tapi_bpf_link_point` tapi_bpf_link_point BPF program link point types. .. index:: pair: typedef; tapi_bpf_xdp_action .. _doxid-group__tapi__bpf_1ga31cbed6803444ba8d9157ba291078070: .. ref-code-block:: cpp :class: doxyrest-title-code-block typedef enum :ref:`tapi_bpf_xdp_action` tapi_bpf_xdp_action BPF XDP actions .. index:: pair: typedef; tapi_bpf_lpm_trie_key .. _doxid-group__tapi__bpf_1ga3bae0018b600bf4f364dda118fdc4c21: .. ref-code-block:: cpp :class: doxyrest-title-code-block typedef struct :ref:`tapi_bpf_lpm_trie_key` tapi_bpf_lpm_trie_key Key of a TAPI_BPF_MAP_TYPE_LPM_TRIE map entry Global Functions ---------------- .. index:: pair: function; tapi_bpf_build_bpf_obj_path .. _doxid-group__tapi__bpf_1gac09e3e39093a6b8120eeabe6c3231103: .. ref-code-block:: cpp :class: doxyrest-title-code-block char* tapi_bpf_build_bpf_obj_path(const char* ta, const char* bpf_prog_name) Get full path to BPF object on Test Agent. Return value should be freed when it is no longer needed. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - ta - Test Agent name * - bpf_prog_name - BPF object name .. rubric:: Returns: Path to BPF object or ``NULL`` in case of error. .. index:: pair: function; tapi_bpf_obj_add .. _doxid-group__tapi__bpf_1gabc13b4998d8f6c0706bf01a90c613725: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_bpf_obj_add(const char* ta, const char* fname, unsigned int* bpf_id) Add BPF object .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - ta - Test Agent name * - fname - File path on agent side, file should exist on agent * - bpf_id - Id of created BPF object .. rubric:: Returns: Status code .. index:: pair: function; tapi_bpf_obj_del .. _doxid-group__tapi__bpf_1gaf451253a59c2fa026b441382b433ce5e: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_bpf_obj_del(const char* ta, unsigned int bpf_id) Remove BPF object .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - ta - Test Agent name * - bpf_id - Bpf ID .. rubric:: Returns: Status code .. index:: pair: function; tapi_bpf_obj_load .. _doxid-group__tapi__bpf_1ga5a1b274e9537d6781c1eb8209cd79bbc: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_bpf_obj_load(const char* ta, unsigned int bpf_id) Load BPF object into the kernel. Only after the BPF object has been loaded into the kernel, it becomes possible to get list of programs/maps and attach an XDP program to network interface. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - ta - Test Agent name * - bpf_id - Bpf ID .. rubric:: Returns: Status code .. index:: pair: function; tapi_bpf_obj_get_state .. _doxid-group__tapi__bpf_1ga2f7ec7c10c9d305db0e6e0869416eb5f: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_bpf_obj_get_state(const char* ta, unsigned int bpf_id, :ref:`tapi_bpf_state`* bpf_state) Get state of BPF object .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - ta - Test Agent name * - bpf_id - Bpf ID * - bpf_state - Current BPF state .. rubric:: Returns: Status code .. rubric:: See also: :ref:`tapi_bpf_obj_load() ` .. index:: pair: function; tapi_bpf_obj_unload .. _doxid-group__tapi__bpf_1ga30fd27094c7301e35744d1d6ed9b2ad2: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_bpf_obj_unload(const char* ta, unsigned int bpf_id) Unload BPF object from kernel .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - ta - Test Agent name * - bpf_id - Bpf ID .. rubric:: Returns: Status code .. index:: pair: function; tapi_bpf_obj_get_type .. _doxid-group__tapi__bpf_1ga8306f715d7e590ace2a126131c0c1a6f: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_bpf_obj_get_type(const char* ta, unsigned int bpf_id, :ref:`tapi_bpf_prog_type`* type) Get program type for BPF object .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - ta - Test Agent name * - bpf_id - Bpf ID * - type - Type of BPF program .. rubric:: Returns: Status code .. index:: pair: function; tapi_bpf_obj_set_type .. _doxid-group__tapi__bpf_1gaa257da16d57acf8e2bf38df98cd31345: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_bpf_obj_set_type(const char* ta, unsigned int bpf_id, :ref:`tapi_bpf_prog_type` type) Set program type in bfp object .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - ta - Test Agent name * - bpf_id - Bpf ID * - type - Type of BPF program .. rubric:: Returns: Status code .. index:: pair: function; tapi_bpf_prog_get_list .. _doxid-group__tapi__bpf_1gaaca7853edcdd8e261e893e022d577cfd: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_bpf_prog_get_list(const char* ta, unsigned int bpf_id, char*** prog, unsigned int* prog_count) Get list of programs in BPF object, it means that BPF object was loaded before by calling :ref:`tapi_bpf_obj_load() ` unused if ``NULL`` .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - ta - Test Agent name * - bpf_id - Bpf ID * - prog - Array of program names, should be freed by user, see :ref:`te_str_free_array ` * - prog_count - Pointer to store number of programs in .. rubric:: Returns: Status code .. index:: pair: function; tapi_bpf_prog_link .. _doxid-group__tapi__bpf_1ga94eb4e5f49886d0f0ba97bb9eb0b5586: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_bpf_prog_link(const char* ta, const char* ifname, unsigned int bpf_id, :ref:`tapi_bpf_link_point` link_type, const char* prog) Link program to network interface. only one program can be linked to interface. clsact qdisc must be enabled in order to link BPF program to TC attach point. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - ta - Test Agent name * - ifname - Interface name * - bpf_id - Bpf ID * - link_type - Type of link point * - prog - Program name .. rubric:: Returns: Status code .. index:: pair: function; tapi_bpf_prog_unlink .. _doxid-group__tapi__bpf_1ga663b7f071a0d4573f6815e2b2c444463: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_bpf_prog_unlink(const char* ta, const char* ifname, :ref:`tapi_bpf_link_point` link_type) Unlink the XDP program from network interface .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - ta - Test Agent name * - ifname - Interface name * - link_type - Type of link point .. rubric:: Returns: Status code .. index:: pair: function; tapi_bpf_map_get_list .. _doxid-group__tapi__bpf_1ga9db4a38a42575cbf50222c8cf830c047: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_bpf_map_get_list(const char* ta, unsigned int bpf_id, char*** map, unsigned int* map_count) Get list of loaded maps from BPF object unused if ``NULL`` .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - ta - Test Agent name * - bpf_id - Bpf ID * - map - Array of map names, should be freed by user, see :ref:`te_str_free_array ` * - prog_count - Pointer to store number of maps in .. rubric:: Returns: Status code .. index:: pair: function; tapi_bpf_map_get_type .. _doxid-group__tapi__bpf_1gaa22eded53588691b12ec0f7fdf9e2f89: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_bpf_map_get_type(const char* ta, unsigned int bpf_id, const char* map, :ref:`tapi_bpf_map_type`* type) Get map type for BPF object .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - ta - Test Agent name * - bpf_id - Bpf ID * - map - Map name * - type - Pointer to store map type .. rubric:: Returns: Status code .. index:: pair: function; tapi_bpf_map_get_key_size .. _doxid-group__tapi__bpf_1ga095ad3bd67d68d48967833b6e5a48d48: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_bpf_map_get_key_size(const char* ta, unsigned int bpf_id, const char* map, unsigned int* key_size) Get size of key in the map .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - ta - Test Agent name * - bpf_id - Bpf ID * - map - Map name * - key_size - Size of keys in bytes .. rubric:: Returns: Status code .. index:: pair: function; tapi_bpf_map_get_val_size .. _doxid-group__tapi__bpf_1gaec3110ef1391d0ef981892175a3dd0e5: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_bpf_map_get_val_size(const char* ta, unsigned int bpf_id, const char* map, unsigned int* val_size) Get size of values in the map .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - ta - Test Agent name * - bpf_id - Bpf ID * - map - Map name * - val_size - Size of value in bytes .. rubric:: Returns: Status code .. index:: pair: function; tapi_bpf_map_get_max_entries .. _doxid-group__tapi__bpf_1gadf845c4d495ded1fab5bab908656cccf: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_bpf_map_get_max_entries(const char* ta, unsigned int bpf_id, const char* map, unsigned int* max_entries) Get maximum number of key/value entries in the map .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - ta - Test Agent name * - bpf_id - Bpf ID * - map - Map name * - max_entries - Maximum number of entries .. rubric:: Returns: Status code .. index:: pair: function; tapi_bpf_map_get_writable_state .. _doxid-group__tapi__bpf_1ga77d5df1bb2c28df714a41fe5397e6755: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_bpf_map_get_writable_state(const char* ta, unsigned int bpf_id, const char* map, bool* is_writable) Get current state of writable view of the map .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - ta - Test Agent name * - bpf_id - Bpf ID * - map - Map name * - is_writable - State of map .. rubric:: Returns: Status code .. index:: pair: function; tapi_bpf_map_set_writable .. _doxid-group__tapi__bpf_1gae7fff970e585dc27c74cd0d3aaeabbcb: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_bpf_map_set_writable(const char* ta, unsigned int bpf_id, const char* map) Enable writable view for the map .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - ta - Test Agent name * - bpf_id - Bpf ID * - map - Map name .. rubric:: Returns: Status code .. index:: pair: function; tapi_bpf_map_unset_writable .. _doxid-group__tapi__bpf_1gac1f3c429fd1bcf202c5cf792f7a2624f: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_bpf_map_unset_writable(const char* ta, unsigned int bpf_id, const char* map) Disable writable view for the map .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - ta - Test Agent name * - bpf_id - Bpf ID * - map - Map name .. rubric:: Returns: Status code .. index:: pair: function; tapi_bpf_map_update_kvpair .. _doxid-group__tapi__bpf_1gaf27471e0ee83347f4d4fdfda0792a7cd: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_bpf_map_update_kvpair(const char* ta, unsigned int bpf_id, const char* map, const uint8_t* key, unsigned int key_size, const uint8_t* val, unsigned int val_size) Update value for given key in the map .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - ta - Test Agent name * - bpf_id - Bpf ID * - map - Map name * - key - Pointer to key * - key_size - Size of ``key`` * - val - Pointer to value which be set to ``key`` * - val_size - Size of value .. rubric:: Returns: Status code .. index:: pair: function; tapi_bpf_map_lookup_kvpair .. _doxid-group__tapi__bpf_1ga2486b68916f10f67730e18c1edde0b95: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_bpf_map_lookup_kvpair(const char* ta, unsigned int bpf_id, const char* map, const uint8_t* key, unsigned int key_size, uint8_t* val, unsigned int val_size) Get raw key value for the map .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - ta - Test Agent name * - bpf_id - Bpf ID * - map - Map name * - key - Pointer to key * - key_size - Size of ``key`` * - val - Pointer to value of ``key`` * - val_size - Size of value .. rubric:: Returns: Status code .. index:: pair: function; tapi_bpf_map_delete_kvpair .. _doxid-group__tapi__bpf_1ga4adee58adf2e7709accd8b17e3b39af9: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_bpf_map_delete_kvpair(const char* ta, unsigned int bpf_id, const char* map, const uint8_t* key, unsigned int key_size) Delete key/value pair from the map .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - ta - Test Agent name * - bpf_id - Bpf ID * - map - Map name * - key - Pointer to key * - key_size - Size of ``key`` .. rubric:: Returns: Status code .. index:: pair: function; tapi_bpf_map_get_key_list .. _doxid-group__tapi__bpf_1ga5d08284050753b4855c9bb909fa4cc1a: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_bpf_map_get_key_list(const char* ta, unsigned int bpf_id, const char* map, unsigned int* key_size, uint8_t*** key, unsigned int* count) Get list of keys (raw value) in the map .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - ta - Test Agent name * - bpf_id - Bpf ID * - map - Map name * - key_size - The size of each item in array ``key`` (in bytes) * - key - Array of keys (raw value), should be freed by user * - count - Number of keys in array ``key`` .. rubric:: Returns: Status code .. index:: pair: function; tapi_bpf_map_set_pin .. _doxid-group__tapi__bpf_1ga9767de2a4dfc411d605cfbfca327295f: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_bpf_map_set_pin(const char* ta, unsigned int bpf_id, const char* map, const char* pin_path) Pin BPF map to a file that can be then opened from another process to obtain map descriptor and use it from there. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - ta - Test Agent name * - bpf_id - BPF ID * - map - Map name * - pin_path - Path to the file. It must be inside BPF file system (usually mounted at /sys/fs/bpf/). If empty, map is unpinned from the currently assigned file. .. rubric:: Returns: Status code. .. index:: pair: function; tapi_bpf_map_get_pin .. _doxid-group__tapi__bpf_1ga1e57e869e362b7b641d3311be588e865: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_bpf_map_get_pin(const char* ta, unsigned int bpf_id, const char* map, char** pin_path) Get path to a file to which a BPF map is currently pinned. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - ta - Test Agent name * - bpf_id - BPF ID * - map - Map name * - pin_path - Path to the file (``NULL`` if the map is not pinned) - should be released by caller .. rubric:: Returns: Status code. .. index:: pair: function; tapi_bpf_perf_event_init .. _doxid-group__tapi__bpf_1ga1a06233090ce706d6b8e28a4bd2af167: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_bpf_perf_event_init(const char* ta, unsigned int bpf_id, const char* map, unsigned int event_size) Initialize perf_event XDP map. Set size of event data and enable event processing. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - ta - Test Agent name * - bpf_id - Bpf ID * - map - Map name * - event_size - Size of data passed via an event .. rubric:: Returns: Status code .. index:: pair: function; tapi_bpf_perf_event_deinit .. _doxid-group__tapi__bpf_1ga2a8e555108713139ed23bebf1e71e77c: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_bpf_perf_event_deinit(const char* ta, unsigned int bpf_id, const char* map) Disable event processing for specified perf_event map. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - ta - Test Agent name * - bpf_id - Bpf ID * - map - Map name .. rubric:: Returns: Status code .. index:: pair: function; tapi_bpf_perf_get_events .. _doxid-group__tapi__bpf_1ga3d0f258a0de0ec7e2cd449f8e93b6005: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_bpf_perf_get_events(const char* ta, unsigned int bpf_id, const char* map, unsigned int* num, uint8_t** data) Get data from all processed events. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - ta - Test Agent name * - bpf_id - Bpf ID * - map - Map name * - num - Number of events * - data - Pointer to location for writing events data, memory for the data is allocated by the function using malloc(). .. rubric:: Returns: Status code .. index:: pair: function; tapi_bpf_perf_map_get_list .. _doxid-group__tapi__bpf_1ga073accdfafe181cdc8306819d524ecd2: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_bpf_perf_map_get_list(const char* ta, unsigned int bpf_id, char*** map, unsigned int* map_count) Get list of loaded perf_event maps from BPF object unused if ``NULL`` .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - ta - Test Agent name * - bpf_id - Bpf ID * - map - Array of map names, should be freed by user, see :ref:`te_str_free_array ` * - map_count - Pointer to store number of maps in .. rubric:: Returns: Status code .. index:: pair: function; tapi_bpf_obj_init .. _doxid-group__tapi__bpf_1ga8214330766cba844d9effbd5b1ca86c4: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_bpf_obj_init(const char* ta, const char* path, :ref:`tapi_bpf_prog_type` type, unsigned int* bpf_id) Add and load BPF object The function calls the following functions: * :ref:`tapi_bpf_obj_add ` * :ref:`tapi_bpf_obj_load ` * :ref:`tapi_bpf_obj_set_type ` .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - ta - Test Agent name * - fname - File path on agent side, file should be exist on agent * - type - Type of BPF program * - bpf_id - Id of created BPF object .. rubric:: Returns: Status code .. index:: pair: function; tapi_bpf_obj_fini .. _doxid-group__tapi__bpf_1gacc82a09b686da132458e7beb7a73746f: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_bpf_obj_fini(const char* ta, unsigned int bpf_id) Unload and delete BPF object .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - ta - Test Agent name * - bpf_id - Id of BPF object .. rubric:: Returns: Status code .. index:: pair: function; tapi_bpf_prog_name_check .. _doxid-group__tapi__bpf_1ga08e78e154cc4a6017d61f899997db30d: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_bpf_prog_name_check(const char* ta, unsigned int bpf_id, const char* prog_name) Check that program name is in list of loaded programs .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - ta - Test Agent name * - bpf_id - Id of BPF object * - prog_name - The name of program to search .. rubric:: Returns: Status code .. index:: pair: function; tapi_bpf_map_type_name_check .. _doxid-group__tapi__bpf_1ga22f916a72fa6ab983466802772b57950: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_bpf_map_type_name_check(const char* ta, unsigned int bpf_id, const char* map_name, :ref:`tapi_bpf_map_type` map_type) Check that map name is in list of loaded maps assuming its type. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - ta - Test Agent name * - bpf_id - Id of BPF object * - map_name - The name of map to search * - map_type - Type of the checked map .. rubric:: Returns: Status code .. index:: pair: function; tapi_bpf_map_name_check .. _doxid-group__tapi__bpf_1ga50a9a33e091a975fd214f2db38884b96: .. ref-code-block:: cpp :class: doxyrest-title-code-block static :ref:`te_errno` tapi_bpf_map_name_check(const char* ta, unsigned int bpf_id, const char* map_name) Check that map name is in list of loaded maps .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - ta - Test Agent name * - bpf_id - Id of BPF object * - map_name - The name of map to search .. rubric:: Returns: Status code .. index:: pair: function; tapi_bpf_ip_tcpudp_filter_from_sa .. _doxid-group__tapi__bpf_1ga399c83a5ff41007a849a4658816fd800: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_bpf_ip_tcpudp_filter_from_sa(:ref:`te_bpf_ip_tcpudp_filter`* filter, int family, int protocol, const struct sockaddr* src_addr, const struct sockaddr* dst_addr) Fill IP TCP/UDP filter for BPF/XDP hook from provided sockaddr structures. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - filter - Filter to fill * - family - ``AF_INET`` or ``AF_INET6`` * - protocol - ``IPPROTO_TCP`` or ``IPPROTO_UDP`` * - src_addr - Source address/port (may be ``NULL`` to match everything) * - dst_addr - Destination address/port (may be ``NULL`` to match everything) .. rubric:: Returns: Status code.