:orphan:

.. index:: pair: group; IP stack headers
.. _doxid-group__te__tools__te__ipstack:

IP stack headers
================

.. toctree::
	:hidden:

	struct_te_ipstack_pseudo_header_ip.rst
	struct_te_ipstack_pseudo_header_ip6.rst
	struct_vlanhdr.rst

Overview
~~~~~~~~

Definition of the auxiliary data structures and functions to operate the IP stack headers and checksums

Copyright (C) 2004-2022 OKTET Labs Ltd. :ref:`More...<details-group__te__tools__te__ipstack>`


.. ref-code-block:: cpp
	:class: doxyrest-overview-code-block

	
	// structs

	struct :ref:`te_ipstack_pseudo_header_ip<doxid-structte__ipstack__pseudo__header__ip>`;
	struct :ref:`te_ipstack_pseudo_header_ip6<doxid-structte__ipstack__pseudo__header__ip6>`;
	struct :ref:`vlanhdr<doxid-structvlanhdr>`;

	// global functions

	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` :ref:`te_ipstack_calc_l4_cksum<doxid-group__te__tools__te__ipstack_1ga6be71c31bc5217323d0b01a81d48b973>`(const struct sockaddr* ip_dst_addr, const struct sockaddr* ip_src_addr, const uint8_t next_hdr, const uint8_t* datagram, const size_t datagram_len, uint16_t* cksum_out);
	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` :ref:`te_ipstack_prepare_raw_tcpv4_packet<doxid-group__te__tools__te__ipstack_1gac19a024996fa3441837dc358bedb7fca>`(uint8_t* raw_packet, ssize_t* total_size, bool remove_vlan_hdr, struct sockaddr_ll* sadr_ll);
	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` :ref:`te_ipstack_mirror_udp_packet<doxid-group__te__tools__te__ipstack_1gab76e47f22e0a36b64e02770918db2f1e>`(uint8_t* pkt, size_t len);

.. _details-group__te__tools__te__ipstack:

Detailed Documentation
~~~~~~~~~~~~~~~~~~~~~~

Definition of the auxiliary data structures and functions to operate the IP stack headers and checksums

Copyright (C) 2004-2022 OKTET Labs Ltd. All rights reserved.

Global Functions
----------------

.. index:: pair: function; te_ipstack_calc_l4_cksum
.. _doxid-group__te__tools__te__ipstack_1ga6be71c31bc5217323d0b01a81d48b973:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` te_ipstack_calc_l4_cksum(const struct sockaddr* ip_dst_addr, const struct sockaddr* ip_src_addr, const uint8_t next_hdr, const uint8_t* datagram, const size_t datagram_len, uint16_t* cksum_out)

Auxiliary function to calculate checksums for L4 datagrams (UDP, TCP) using a so-called pseudo-header in accordance with principles of checksum calculation defined by RFC 793 (in case of underlying IPv4 network) and RFC 2460 (i.e., it takes into account pseudo-header composition peculiarities brought by IPv6) but without taking into account any possible IPv6 routing headers (i.e., it uses IPv6 DST address from the main header)



.. rubric:: Parameters:

.. list-table::
	:widths: 20 80

	*
		- ip_dst_addr

		- Destination IPv4/6 address

	*
		- ip_src_addr

		- Source IPv4/6 address

	*
		- next_hdr

		- L4 protocol ID (i.e., IPPROTO_UDP)

	*
		- datagram

		- Buffer containing L4 header and L4 payload

	*
		- datagram_len

		- Buffer length

	*
		- cksum_out

		- Location for the resulting checksum



.. rubric:: Returns:

Status code

.. index:: pair: function; te_ipstack_prepare_raw_tcpv4_packet
.. _doxid-group__te__tools__te__ipstack_1gac19a024996fa3441837dc358bedb7fca:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` te_ipstack_prepare_raw_tcpv4_packet(uint8_t* raw_packet, ssize_t* total_size, bool remove_vlan_hdr, struct sockaddr_ll* sadr_ll)

Function to prepare raw TCPv4 packet for sending via raw socket. This includes checking headers, filling checksums and removing of the VLAN header to avoid duplication during sending via raw socket. In addition, it prepares the address for sending based on given headers.



.. rubric:: Parameters:

.. list-table::
	:widths: 20 80

	*
		- raw_packet

		- Pointer to buffer with headers and payload

	*
		- total_size

		- Total size of raw packet

	*
		- remove_vlan_hdr

		- Remove all VLAN headers if ``true``

	*
		- sadr_ll

		- Link local address to filling. May be ``NULL``.



.. rubric:: Returns:

Status code

.. index:: pair: function; te_ipstack_mirror_udp_packet
.. _doxid-group__te__tools__te__ipstack_1gab76e47f22e0a36b64e02770918db2f1e:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` te_ipstack_mirror_udp_packet(uint8_t* pkt, size_t len)

Reverse addresses and ports of a RAW Ethernet/IP[4,6]/UDP packet, so that it can be echoed back.



.. rubric:: Parameters:

.. list-table::
	:widths: 20 80

	*
		- pkt

		- UDP packet.

	*
		- len

		- Packet length.



.. rubric:: Returns:

Status code.