:orphan: .. index:: pair: group; Network Data Notation (NDN) .. _doxid-group__tapi__ndn: Network Data Notation (NDN) =========================== .. toctree:: :hidden: enum_tapi_ndn_level_e.rst struct_receive_transform.rst struct_send_transform.rst struct_tapi_ndn_gso_conf.rst Overview ~~~~~~~~ Declarations of API for TAPI NDN. :ref:`More...` .. ref-code-block:: cpp :class: doxyrest-overview-code-block // typedefs typedef struct :ref:`send_transform` :target:`send_transform`; typedef struct :ref:`receive_transform` :target:`receive_transform`; typedef enum tapi_ndn_level_e :target:`tapi_ndn_level_t`; // enums enum :ref:`tapi_ndn_level_e`; // structs struct :ref:`receive_transform`; struct :ref:`send_transform`; struct :ref:`tapi_ndn_gso_conf`; // global functions :ref:`te_errno` :ref:`tapi_tad_init_asn_value`(:ref:`asn_value`** value, const :ref:`asn_type`* type); :ref:`te_errno` :ref:`tapi_tad_csap_add_layer`(:ref:`asn_value`** csap_spec, const :ref:`asn_type`* layer_type, const char* layer_choice, :ref:`asn_value`** layer_spec); :ref:`te_errno` :ref:`tapi_tad_tmpl_ptrn_add_layer`(:ref:`asn_value`** obj_spec, bool is_pattern, const :ref:`asn_type`* pdu_type, const char* pdu_choice, :ref:`asn_value`** pdu_spec); :ref:`te_errno` :ref:`tapi_tad_new_ptrn_unit`(:ref:`asn_value`** obj_spec, :ref:`asn_value`** unit_spec); :ref:`te_errno` :ref:`tapi_tad_tmpl_ptrn_set_payload_plain`(:ref:`asn_value`** obj_spec, bool is_pattern, const void* payload, size_t length); :ref:`te_errno` :ref:`tapi_pdus_free_fields_by_du_tag`(:ref:`asn_value`* pdus, :ref:`asn_tag_value` du_tag); :ref:`te_errno` :ref:`tapi_tad_pdus_relist_outer_inner`(:ref:`asn_value`* pdu_seq, unsigned int* nb_pdus_o_out, :ref:`asn_value`*** pdus_o_out, unsigned int* nb_pdus_i_out, :ref:`asn_value`*** pdus_i_out); :ref:`te_errno` :ref:`tapi_tad_tmpl_relist_outer_inner_pdus`(:ref:`asn_value`* tmpl, unsigned int* nb_pdus_o_out, :ref:`asn_value`*** pdus_o_out, unsigned int* nb_pdus_i_out, :ref:`asn_value`*** pdus_i_out); :ref:`asn_value`* :ref:`tapi_tad_mk_pattern_from_template`(:ref:`asn_value`* template); :ref:`te_errno` :ref:`tapi_tad_packets_to_pattern`(:ref:`asn_value`** packets, unsigned int n_packets, :ref:`send_transform`* transform, :ref:`asn_value`** pattern_out); :ref:`te_errno` :ref:`tapi_tad_concat_patterns`(:ref:`asn_value`* dst, :ref:`asn_value`* src); :ref:`te_errno` :ref:`tapi_tad_aggregate_patterns`(:ref:`asn_value`** patterns, unsigned int nb_patterns, :ref:`asn_value`** pattern_out); :ref:`te_errno` :ref:`tapi_ndn_subst_env`(:ref:`asn_value`* value, te_kvpair_h* params, struct :ref:`tapi_env`* env); :ref:`te_errno` :ref:`tapi_ndn_tmpl_classify`(const :ref:`asn_value`* tmpl, :ref:`te_tad_protocols_t` hdrs[TAPI_NDN_NLEVELS]); :ref:`te_errno` :ref:`tapi_ndn_tmpl_set_ip_cksum`(:ref:`asn_value`* tmpl, uint16_t cksum, tapi_ndn_level_t level); :ref:`te_errno` :ref:`tapi_ndn_tmpl_set_udp_cksum`(:ref:`asn_value`* tmpl, uint16_t cksum, tapi_ndn_level_t level); :ref:`te_errno` :ref:`tapi_ndn_tmpl_set_tcp_cksum`(:ref:`asn_value`* tmpl, uint16_t cksum); :ref:`te_errno` :ref:`tapi_ndn_tmpl_set_tcp_flags`(:ref:`asn_value`* tmpl, uint8_t flags); :ref:`te_errno` :ref:`tapi_ndn_tmpl_set_payload_len`(:ref:`asn_value`* tmpl, unsigned int payload_len); :ref:`te_errno` :ref:`tapi_ndn_pkt_inject_vlan_tag`(:ref:`asn_value`* pkt, uint16_t vlan_tci); :ref:`te_errno` :ref:`tapi_ndn_pdus_inject_vlan_tags`(:ref:`asn_value`* pdus, const uint16_t* vid, const uint16_t* prio, const uint16_t* cfi, size_t n_tags); :ref:`te_errno` :ref:`tapi_ndn_pdus_remove_vlan_tags`(:ref:`asn_value`* pdus, size_t n_tags); :ref:`te_errno` :ref:`tapi_ndn_eth_read_vlan_tci`(const :ref:`asn_value`* eth, size_t* n_tags, uint16_t* vid, uint16_t* prio, uint16_t* cfi); :ref:`te_errno` :ref:`tapi_ndn_pkt_demand_correct_ip_cksum`(:ref:`asn_value`* pkt, tapi_ndn_level_t level); :ref:`te_errno` :ref:`tapi_ndn_pkt_demand_correct_udp_cksum`(:ref:`asn_value`* pkt, bool can_be_zero, tapi_ndn_level_t level); :ref:`te_errno` :ref:`tapi_ndn_pkt_demand_correct_tcp_cksum`(:ref:`asn_value`* pkt); :ref:`te_errno` :ref:`tapi_ndn_superframe_gso`(:ref:`asn_value`* superframe, size_t seg_payload_len, const struct :ref:`tapi_ndn_gso_conf`* gso_conf, :ref:`asn_value`*** pkts_out, unsigned int* nb_pkts_out); :ref:`te_errno` :ref:`tapi_ndn_tso_pkts_edit`(:ref:`asn_value`** pkts, unsigned int nb_pkts); :ref:`te_errno` :ref:`tapi_ndn_gso_pkts_ip_len_edit`(:ref:`asn_value`** pkts, unsigned int nb_pkts, :ref:`te_tad_protocols_t` ip_te_proto, tapi_ndn_level_t level); :ref:`te_errno` :ref:`tapi_ndn_gso_pkts_ip_id_edit`(:ref:`asn_value`** pkts, unsigned int nb_pkts, tapi_ndn_level_t level); :ref:`te_errno` :ref:`tapi_ndn_gso_pkts_udp_len_edit`(:ref:`asn_value`** pkts, unsigned int nb_pkts, tapi_ndn_level_t level); :ref:`te_errno` :ref:`tapi_ndn_pkts_to_ptrn`(:ref:`asn_value`** pkts, unsigned int nb_pkts, :ref:`asn_value`** ptrn_out); :ref:`te_errno` :ref:`tapi_eth_transform_ptrn_on_rx`(:ref:`receive_transform`* rx_transform, :ref:`asn_value`** ptrn); // macros #define :target:`RX_XFRM_EFFECT_OUTER_VLAN_TCI` #define :target:`RX_XFRM_EFFECT_VLAN_TCI` #define :target:`RX_XFRM_HW_OFFL_QINQ_STRIP` #define :target:`RX_XFRM_HW_OFFL_VLAN_STRIP` #define :ref:`SEND_COND_HW_OFFL_IP_CKSUM` #define :target:`SEND_COND_HW_OFFL_L4_CKSUM` #define :target:`SEND_COND_HW_OFFL_OUTER_IP_CKSUM` #define :target:`SEND_COND_HW_OFFL_TSO` #define :target:`SEND_COND_HW_OFFL_VLAN` #define :ref:`TEST_GET_NDN_TRAFFIC_TEMPLATE`(_var_name) .. _details-group__tapi__ndn: Detailed Documentation ~~~~~~~~~~~~~~~~~~~~~~ Declarations of API for TAPI NDN. Copyright (C) 2004-2022 OKTET Labs Ltd. All rights reserved. Global Functions ---------------- .. index:: pair: function; tapi_tad_init_asn_value .. _doxid-group__tapi__ndn_1ga87300d280864dd5c23858e2a996ed98a: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_tad_init_asn_value(:ref:`asn_value`** value, const :ref:`asn_type`* type) Check ASN.1 value pointer. If it is NULL, initialize a new value of specified type. All errors are logged inside the function. There is no necessity to log them after call. Todo Check that ASN.1 value belongs to *type* .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - value - Location of ASN.1 value pointer * - type - ASN.1 type to which value should belong .. rubric:: Returns: Status code. .. index:: pair: function; tapi_tad_csap_add_layer .. _doxid-group__tapi__ndn_1gacfb5b1ed8cd555821ceda7adced7365a: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_tad_csap_add_layer(:ref:`asn_value`** csap_spec, const :ref:`asn_type`* layer_type, const char* layer_choice, :ref:`asn_value`** layer_spec) Add a new CSAP specification layer. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - csap_spec - Location of ASN.1 value with CSAP specification (if NULL pointer is stored in location, a new CSAP specification is initialized) * - layer_type - ASN.1 type of a new layer * - layer_choice - String name of a new layer as ASN.1 choice (including '#', e.g. "#eth") * - layer_spec - Location for a new ASN.1 value with layer specification (may be NULL) .. rubric:: Returns: Status code. .. index:: pair: function; tapi_tad_tmpl_ptrn_add_layer .. _doxid-group__tapi__ndn_1gab16af3f2bc1b788020bcaf5744c8aa9a: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_tad_tmpl_ptrn_add_layer(:ref:`asn_value`** obj_spec, bool is_pattern, const :ref:`asn_type`* pdu_type, const char* pdu_choice, :ref:`asn_value`** pdu_spec) Add a new layer specification in traffic template/pattern. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - obj_spec - Location of ASN.1 value with Template of pattern spec (if NULL pointer is stored in location, a new CSAP specification is initialized) * - is_pattern - Flag wheather required NDN is traffic pattern * - pdu_type - ASN.1 type of a new PDU * - pdu_choice - String name of a new PDU as ASN.1 choice (including '#', e.g. "#eth") * - pdu_spec - Location for a new ASN.1 value with PDU specification (may be NULL) .. rubric:: Returns: Status code. .. index:: pair: function; tapi_tad_new_ptrn_unit .. _doxid-group__tapi__ndn_1ga74167206e3c9ff2c02832df39ec29e5d: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_tad_new_ptrn_unit(:ref:`asn_value`** obj_spec, :ref:`asn_value`** unit_spec) Add a new unit in the traffic pattern specification. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - obj_spec - Location of ASN.1 value with Template of pattern spec (if NULL pointer is stored in location, a new CSAP specification is initialized) * - unit_spec - Location for a pointer to a new pattern unit or NULL .. rubric:: Returns: Status code. .. index:: pair: function; tapi_tad_tmpl_ptrn_set_payload_plain .. _doxid-group__tapi__ndn_1gac7766771c2e50a8ce30ffbe8eba5815f: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_tad_tmpl_ptrn_set_payload_plain(:ref:`asn_value`** obj_spec, bool is_pattern, const void* payload, size_t length) Set payload of the last unit in the traffic template or pattern specification. If *payload* is ``NULL`` and *length* is not ``0``, random payload contents is generated on sending and any payload of specified length is matched. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - obj_spec - Location of ASN.1 value with Template of Pattern specification (if NULL pointer is stored in location, a new one is initialized) * - is_pattern - Flag whether required NDN is traffic pattern or template * - payload - Pointer to payload data * - length - Payload length .. rubric:: Returns: Status code. .. index:: pair: function; tapi_pdus_free_fields_by_du_tag .. _doxid-group__tapi__ndn_1ga229e3ba2a7d1b48d1a5491dd23565ba4: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_pdus_free_fields_by_du_tag(:ref:`asn_value`* pdus, :ref:`asn_tag_value` du_tag) Free all the PDU fields of a choice denoted by a given DU tag (eg. NDN_DU_SCRIPT) from all the PDUs in a given PDU sequence .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - pdus - ASN.1 value contining a PDU sequence * - du_tag - DU tag value to designate a DU choice .. rubric:: Returns: Status code .. index:: pair: function; tapi_tad_pdus_relist_outer_inner .. _doxid-group__tapi__ndn_1ga500acac1bc2b9f27078c371955ce477a: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_tad_pdus_relist_outer_inner(:ref:`asn_value`* pdu_seq, unsigned int* nb_pdus_o_out, :ref:`asn_value`*** pdus_o_out, unsigned int* nb_pdus_i_out, :ref:`asn_value`*** pdus_i_out) Find outer and inner PDUs in a given PDU sequence ASN.1 value and provide them back to the caller in the form of two arrays. This function does not copy the PDU ASN.1 values it discovers. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - pdu_seq - PDU sequence ASN.1 value to process * - nb_pdus_o_out - Location for the number of outer PDU ASN.1 values * - pdus_o_out - Location for outer PDU ASN.1 values * - nb_pdus_i_out - Location for the number of inner PDU ASN.1 values * - pdus_i_out - Location for inner PDU ASN.1 values .. rubric:: Returns: Status code .. index:: pair: function; tapi_tad_tmpl_relist_outer_inner_pdus .. _doxid-group__tapi__ndn_1ga9a476f331aad7a0c303bf2cc7b9c71b2: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_tad_tmpl_relist_outer_inner_pdus(:ref:`asn_value`* tmpl, unsigned int* nb_pdus_o_out, :ref:`asn_value`*** pdus_o_out, unsigned int* nb_pdus_i_out, :ref:`asn_value`*** pdus_i_out) Convenient ``:ref:`tapi_tad_pdus_relist_outer_inner() ``` wrapper which assumes template ASN.1 value as its first argument. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - tmpl - Traffic template * - nb_pdus_o_out - Location for the number of outer PDU ASN.1 values * - pdus_o_out - Location for outer PDU ASN.1 values * - nb_pdus_i_out - Location for the number of inner PDU ASN.1 values * - pdus_i_out - Location for inner PDU ASN.1 values .. index:: pair: function; tapi_tad_mk_pattern_from_template .. _doxid-group__tapi__ndn_1gabc7456fc67c32d447779c399414552ff: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`asn_value`* tapi_tad_mk_pattern_from_template(:ref:`asn_value`* template) Convert an ASN.1 template to a pattern containing the same set of PDUs as ones in the template .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - template - ASN.1 template to be converted into a pattern .. rubric:: Returns: ASN.1 value containing a pattern or ``NULL`` .. index:: pair: function; tapi_tad_packets_to_pattern .. _doxid-group__tapi__ndn_1gac43a70c4ca33a79d99d8fcd1cea0545f: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_tad_packets_to_pattern(:ref:`asn_value`** packets, unsigned int n_packets, :ref:`send_transform`* transform, :ref:`asn_value`** pattern_out) Convert an array of ASN.1 'ndn_raw_packet'-s to a unified ASN.1 'ndn_traffic_pattern' carrying an exact sequence of 'ndn_traffic_pattern_unit'-s applicable to match definite packets which are to be received by the peer side in case if the initial 'ndn_raw_packet'-s are sent and (possibly) undergo some transformations (eg, HW offloads are active) Deprecated This API is not well-thought, and the implementation is mind-boggling. Please consider using better, granular helpers to do varios editing, namely: * ``:ref:`tapi_ndn_pkt_demand_correct_ip_cksum() ``` * ``:ref:`tapi_ndn_pkt_demand_correct_udp_cksum() ``` * ``:ref:`tapi_ndn_pkt_demand_correct_tcp_cksum() ``` * ``:ref:`tapi_ndn_superframe_gso() ``` * ``:ref:`tapi_ndn_tso_pkts_edit() ``` * ``:ref:`tapi_ndn_gso_pkts_ip_len_edit() ``` * ``:ref:`tapi_ndn_gso_pkts_ip_id_edit() ``` * ``:ref:`tapi_ndn_gso_pkts_udp_len_edit() ```. Please use ``:ref:`tapi_ndn_pkts_to_ptrn() ``` for the actual conversion. Consider removing this API and all connected helpers. The given set of possible transformations is only considered with respect to all 'ndn_raw_packet'-s in the array, i.e., some individual peculiarities of the items cannot be taken into account, hence, if one needs to process any of individual packets independently, separate calls should be performed (eg, if SEND_COND_HW_OFFL_TSO flag is present, it means that TSO shall be done for all the packets) .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - packets - An ASN.1 'ndn_raw_packet'-s to be processed * - n_packets - The number of items available within ``packets`` * - transform - A set of parameters describing some trasformations which are expected to affect the outgoing packets * - pattern_out - Location for the pattern which is to be produced .. rubric:: Returns: Status code .. index:: pair: function; tapi_tad_concat_patterns .. _doxid-group__tapi__ndn_1gafd16366faa932051251be86378313279: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_tad_concat_patterns(:ref:`asn_value`* dst, :ref:`asn_value`* src) Concatenate two traffic patterns ``src`` will be freed internally after successful concatenation only .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - dst - The first pattern to which ``src`` is to be appended * - src - The second pattern which is to be appended to ``dst`` .. rubric:: Returns: Status code .. index:: pair: function; tapi_tad_aggregate_patterns .. _doxid-group__tapi__ndn_1ga37ecd83472c5f274b0bf44f0dc4aef73: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_tad_aggregate_patterns(:ref:`asn_value`** patterns, unsigned int nb_patterns, :ref:`asn_value`** pattern_out) Aggregate the copies of pattern units from all the patterns within a given array to make a single pattern suitable for matching heterogeneous packets The function doesn't change or free the initial patterns; ``:ref:`tapi_tad_concat_patterns() ``` is fed by copies internally .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - patterns - An array containing initial patterns to be aggregated * - nb_patterns - The number of patterns available in ``patterns`` array * - pattern_out - Location for the new pattern which is to be produced .. rubric:: Returns: Status code .. index:: pair: function; tapi_ndn_subst_env .. _doxid-group__tapi__ndn_1ga652dc47cbd4a3ef74e680cb6f5fff13b: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_ndn_subst_env(:ref:`asn_value`* value, te_kvpair_h* params, struct :ref:`tapi_env`* env) The function iterates through ASN.1 value, find all data units with "#env" value choice and substitute it in accordance with ``params`` and ``env`` .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - value - ASN value, which content should be substituted * - params - Key-value pairs with test parameters or ``NULL`` * - env - Environment or ``NULL`` .. rubric:: Returns: Status code .. index:: pair: function; tapi_ndn_tmpl_classify .. _doxid-group__tapi__ndn_1ga22b7ed90b5add48e7a32218a8d7ba8f9: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_ndn_tmpl_classify(const :ref:`asn_value`* tmpl, :ref:`te_tad_protocols_t` hdrs[TAPI_NDN_NLEVELS]) Given a traffic template, inspect its PDUs and fill out the output array of header types to provide the caller with details about protocols in use. The API will indicate missing PDUs by ``TE_PROTO_INVALID``. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - tmpl - The traffic template * - hdrs - Array of size ``TAPI_NDN_NLEVELS`` to store the results in .. rubric:: Returns: Status code. .. index:: pair: function; tapi_ndn_tmpl_set_ip_cksum .. _doxid-group__tapi__ndn_1ga7363603304b543503f9dc9831bd6972a: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_ndn_tmpl_set_ip_cksum(:ref:`asn_value`* tmpl, uint16_t cksum, tapi_ndn_level_t level) Given a traffic template, set its IPv4 checksum plain value. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - tmpl - The traffic template * - cksum - The checksum value to be set (host byte order) * - level - ``TAPI_NDN_OUTER_L3`` or ``TAPI_NDN_INNER_L3`` .. rubric:: Returns: Status code. .. index:: pair: function; tapi_ndn_tmpl_set_udp_cksum .. _doxid-group__tapi__ndn_1ga0574a379c2f695afa2ed5c628ea1a38e: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_ndn_tmpl_set_udp_cksum(:ref:`asn_value`* tmpl, uint16_t cksum, tapi_ndn_level_t level) Given a traffic template, set its UDP checksum plain value. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - tmpl - The traffic template * - cksum - The checksum value to be set (host byte order) * - level - ``TAPI_NDN_OUTER_L4`` or ``TAPI_NDN_INNER_L4`` .. rubric:: Returns: Status code. .. index:: pair: function; tapi_ndn_tmpl_set_tcp_cksum .. _doxid-group__tapi__ndn_1gad10c1de0d061fa299feeee7f44e382ff: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_ndn_tmpl_set_tcp_cksum(:ref:`asn_value`* tmpl, uint16_t cksum) Given a traffic template, set its TCP checksum plain value. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - tmpl - The traffic template * - cksum - The checksum value to be set (host byte order) .. rubric:: Returns: Status code. .. index:: pair: function; tapi_ndn_tmpl_set_tcp_flags .. _doxid-group__tapi__ndn_1gae2662fe98e99d142c58cfb97f8441759: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_ndn_tmpl_set_tcp_flags(:ref:`asn_value`* tmpl, uint8_t flags) Given a traffic template, set its TCP flags plain value. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - tmpl - The traffic template * - flags - The flags value to be set .. rubric:: Returns: Status code. .. index:: pair: function; tapi_ndn_tmpl_set_payload_len .. _doxid-group__tapi__ndn_1ga3534c70c27bead4471d4bbf0d4b99794: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_ndn_tmpl_set_payload_len(:ref:`asn_value`* tmpl, unsigned int payload_len) Given a traffic template, set its payload length. This function doesn't set the payload data since random payload will be provided later by Tx CSAP. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - tmpl - The traffic template * - payload_len - Payload length value .. rubric:: Returns: Status code. .. index:: pair: function; tapi_ndn_pkt_inject_vlan_tag .. _doxid-group__tapi__ndn_1ga2dc672f1d3a39e73f71374a5995cf7c7: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_ndn_pkt_inject_vlan_tag(:ref:`asn_value`* pkt, uint16_t vlan_tci) Given an ASN.1 raw packet and VLAN TCI, inject a VLAN tag to the outer Ethernet PDU thus simulating a VLAN tag HW offload. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - pkt - The ASN.1 raw packet to be edited * - vlan_tci - VLAN TCI (host byte order) to be injected .. rubric:: Returns: Status code. .. index:: pair: function; tapi_ndn_pdus_inject_vlan_tags .. _doxid-group__tapi__ndn_1ga6722622a7eec6ad444aeab27bd6cb3f4: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_ndn_pdus_inject_vlan_tags(:ref:`asn_value`* pdus, const uint16_t* vid, const uint16_t* prio, const uint16_t* cfi, size_t n_tags) Inject VLAN tags to outer Ethernet PDU in a PDU sequence. The API works only with exactly specified or not set vlan headers. Ranged fields are not supported. ``UINT16_MAX`` for ``vid``, ``prio`` or ``cfi`` means that this value is not specified in the PDU .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - pdus - PDU sequence * - vid - VLAN IDs * - prio - VLAN priority fields * - cfi - VLAN CFI fields * - n_tags - Number of tags to be pushed, specifies size of ``vid``, ``prio``, ``cfi`` .. rubric:: Returns: Status code .. index:: pair: function; tapi_ndn_pdus_remove_vlan_tags .. _doxid-group__tapi__ndn_1ga3316fd168488aa113d20c66ceaed629b: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_ndn_pdus_remove_vlan_tags(:ref:`asn_value`* pdus, size_t n_tags) Remove VLAN tags from outer Ethernet PDU in a PDU sequence. The API works only with exactly specified or not set VLAN headers. Ranged fields are not supported. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - pdus - PDU sequence * - n_tags - Number of tags to remove .. rubric:: Returns: Status code .. index:: pair: function; tapi_ndn_eth_read_vlan_tci .. _doxid-group__tapi__ndn_1ga8dc0097f5dd5140c5a080c30660ec661: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_ndn_eth_read_vlan_tci(const :ref:`asn_value`* eth, size_t* n_tags, uint16_t* vid, uint16_t* prio, uint16_t* cfi) Read TCI value of VLAN tags of a Ethernet PDU. The API works only with exactly specified or not set vlan headers. Ranged fields are not supported. ``UINT16_MAX`` for ``vid``, ``prio`` or ``cfi`` means that this value is not specified in the PDU .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - eth - ASN.1 value of ethernet PDU * - n_tags - Size of the ``vid``, ``prio`` and ``cfi`` arrays, on success contains the number of tags that were read (may be ``0`` if ``eth`` does not have any VLAN tags) * - vid - VLAN IDs * - prio - VLAN priority fields * - cfi - VLAN CFI fields .. rubric:: Returns: Status code .. index:: pair: function; tapi_ndn_pkt_demand_correct_ip_cksum .. _doxid-group__tapi__ndn_1ga80312450996cf52e3ffd2087bf0637a4: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_ndn_pkt_demand_correct_ip_cksum(:ref:`asn_value`* pkt, tapi_ndn_level_t level) Take an ASN.1 raw packet which is going to be transformed to a pattern and override IPv4 checksum field to require correct checksum in the packet which is about to be received on peer. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - pkt - The ASN.1 raw packet to be edited * - level - ``TAPI_NDN_OUTER_L3`` or ``TAPI_NDN_INNER_L3`` .. rubric:: Returns: Status code. .. index:: pair: function; tapi_ndn_pkt_demand_correct_udp_cksum .. _doxid-group__tapi__ndn_1ga6e190c1e4e27698a5aa7b4ad2d9c0b05: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_ndn_pkt_demand_correct_udp_cksum(:ref:`asn_value`* pkt, bool can_be_zero, tapi_ndn_level_t level) Take an ASN.1 raw packet which is going to be transformed to a pattern and override UDP checksum field to require correct checksum in the packet which is about to be received on peer. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - pkt - The ASN.1 raw packet to be edited * - can_be_zero - If ``true``, allow for zero checksum value * - level - ``TAPI_NDN_OUTER_L4`` or ``TAPI_NDN_INNER_L4`` .. rubric:: Returns: Status code. .. index:: pair: function; tapi_ndn_pkt_demand_correct_tcp_cksum .. _doxid-group__tapi__ndn_1gac60e90d421fa1fcf2275c4e9959af181: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_ndn_pkt_demand_correct_tcp_cksum(:ref:`asn_value`* pkt) Take an ASN.1 raw packet which is going to be transformed to a pattern and override TCP checksum field to require correct checksum in the packet which is about to be received on peer. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - pkt - The ASN.1 raw packet to be edited .. rubric:: Returns: Status code. .. index:: pair: function; tapi_ndn_superframe_gso .. _doxid-group__tapi__ndn_1ga098d70ae35153bc251e29e62d6322138: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_ndn_superframe_gso(:ref:`asn_value`* superframe, size_t seg_payload_len, const struct :ref:`tapi_ndn_gso_conf`* gso_conf, :ref:`asn_value`*** pkts_out, unsigned int* nb_pkts_out) Take an ASN.1 raw packet containing a superframe and conduct GSO slicing to produce a burst of ASN.1 raw packets each one containing unchanged PDUs from the original superframe and a properly sized chunk of payload read out from the same frame. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - superframe - The superframe to undergo GSO slicing * - seg_payload_len - The desired length of a payload chunk * - gso_conf - Segmentation fine-tuning configuration * - pkts_out - Location for the resulting packets * - nb_pkts_out - Location for the number of the packets .. rubric:: Returns: Status code. .. index:: pair: function; tapi_ndn_tso_pkts_edit .. _doxid-group__tapi__ndn_1ga757944397540d8ce3755c26a692c9799: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_ndn_tso_pkts_edit(:ref:`asn_value`** pkts, unsigned int nb_pkts) Given a bunch of ASN.1 raw packets originating from some GSO transaction, conduct a very minimal TSO edit across TCP PDUs. Line up TCP sequence numbers as per GSO segment payload size and amend TCP flags so that all the packets but the last one have FIN and PSH bits cleared whilst CWR bit (if present) is retained intact solely in the very first packet of the array. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - pkts - The array of ASN.1 raw packets * - nb_pkts - The number of ASN.1 raw packets .. rubric:: Returns: Status code. .. index:: pair: function; tapi_ndn_gso_pkts_ip_len_edit .. _doxid-group__tapi__ndn_1gaf0c35af36f42f912f6591e8187f067c8: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_ndn_gso_pkts_ip_len_edit(:ref:`asn_value`** pkts, unsigned int nb_pkts, :ref:`te_tad_protocols_t` ip_te_proto, tapi_ndn_level_t level) Given a bunch of ASN.1 raw packets originating from some GSO transaction, fix IP inner / outer length field in each frame. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - pkts - The array of ASN.1 raw packets * - nb_pkts - The number of ASN.1 raw packets * - ip_te_proto - ``TE_PROTO_IP4`` or ``TE_PROTO_IP6`` * - level - ``TAPI_NDN_OUTER_L3`` or ``TAPI_NDN_INNER_L3`` .. rubric:: Returns: Status code. .. index:: pair: function; tapi_ndn_gso_pkts_ip_id_edit .. _doxid-group__tapi__ndn_1ga480b483d4fe896b1707e0b360da0215f: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_ndn_gso_pkts_ip_id_edit(:ref:`asn_value`** pkts, unsigned int nb_pkts, tapi_ndn_level_t level) Given a bunch of ASN.1 raw packets originating from some GSO transaction, line up IPv4 ID field values across the packets. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - pkts - The array of ASN.1 raw packets * - nb_pkts - The number of ASN.1 raw packets * - level - ``TAPI_NDN_OUTER_L3`` or ``TAPI_NDN_INNER_L3`` .. rubric:: Returns: Status code. .. index:: pair: function; tapi_ndn_gso_pkts_udp_len_edit .. _doxid-group__tapi__ndn_1ga1751ab10c7578d00b97ecbc013b2db28: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_ndn_gso_pkts_udp_len_edit(:ref:`asn_value`** pkts, unsigned int nb_pkts, tapi_ndn_level_t level) Given a bunch of ASN.1 raw packets originating from some GSO transaction, fix UDP inner / outer length field in each frame. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - pkts - The array of ASN.1 raw packets * - nb_pkts - The number of ASN.1 raw packets * - level - ``TAPI_NDN_OUTER_L4`` or ``TAPI_NDN_INNER_L4`` .. rubric:: Returns: Status code. .. index:: pair: function; tapi_ndn_pkts_to_ptrn .. _doxid-group__tapi__ndn_1gad9b9c304a40b7397cbbea8621607761d: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_ndn_pkts_to_ptrn(:ref:`asn_value`** pkts, unsigned int nb_pkts, :ref:`asn_value`** ptrn_out) Convert ASN.1 raw packets to a multi-unit traffic pattern. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - pkts - The array of ASN.1 raw packets * - nb_pkts - The number of ASN.1 raw packets * - ptrn_out - Location for the resulting pattern .. rubric:: Returns: Status code. .. index:: pair: function; tapi_eth_transform_ptrn_on_rx .. _doxid-group__tapi__ndn_1ga458d9293805d7e790fc26b54f3a8bae5: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_eth_transform_ptrn_on_rx(:ref:`receive_transform`* rx_transform, :ref:`asn_value`** ptrn) Transform a pattern of coming packets in accordance with receive effects .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - rx_transform - A set of parameters describing some trasformations which are expected to affect the packets on receive * - ptrn - Location of a pattern to be transformed .. rubric:: Returns: Status code. Macros ------ .. index:: pair: define; SEND_COND_HW_OFFL_IP_CKSUM .. _doxid-group__tapi__ndn_1ga2378f85b4b6cd249c76c74329f94a1b3: .. ref-code-block:: cpp :class: doxyrest-title-code-block #define SEND_COND_HW_OFFL_IP_CKSUM Flags used to designate transformations which take place in hardware .. index:: pair: define; TEST_GET_NDN_TRAFFIC_TEMPLATE .. _doxid-group__tapi__ndn_1ga5d7253c77dc013040bb5afdb9f3931c3: .. ref-code-block:: cpp :class: doxyrest-title-code-block #define TEST_GET_NDN_TRAFFIC_TEMPLATE(_var_name) Get ndn_traffic_template ASN.1 type test parameter. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - _var_name - Variable whose name is the same as the name of parameter we get the value