TCP header description. More...

#include <stdint.h>
#include <assert.h>
#include "config.h"

Include dependency graph for tcp.h:

This graph shows which files directly or indirectly include this file:

Data Structures
struct	tcphdr
	The TCP base header without options. More...

struct	sack_block_t
	The Selective Acknowlegment TCP option. More...

struct	tcp_option_timestamp

struct	ipv4_static_t
	The IPv4 static part. More...

struct	ipv4_dynamic1_t
	The IPv4 dynamic part without IP-ID field. More...

struct	ipv4_dynamic2_t
	The IPv4 dynamic part with IP-ID field. More...

struct	ipv4_replicate_t
	The IPv4 replicate part. More...

struct	ip_opt_static_t

struct	ip_dest_opt_static_t

struct	ip_hop_opt_static_t

struct	ip_rout_opt_static_t

struct	ipv6_static1_t
	The IPv6 static part, null flow_label encoded with 1 bit. More...

struct	ipv6_static2_t
	The IPv6 static part, flow_label encoded with 1+20 bits. More...

struct	ipv6_dynamic_t
	The IPv6 dynamic part. More...

struct	ipv6_replicate1_t
	The IPv6 replicate part with short Flow Label. More...

struct	ipv6_replicate2_t
	The IPv6 replicate part with long Flow Label. More...

struct	tcp_static_t
	The TCP static part. More...

struct	tcp_dynamic_t
	The TCP dynamic part. More...

struct	tcp_replicate_t
	The TCP replicate part. More...

struct	co_common_t
	The Common compressed packet format. More...

struct	rnd_1_t
	The rnd_1 compressed packet format. More...

struct	rnd_2_t
	The rnd_2 compressed packet format. More...

struct	rnd_3_t
	The rnd_3 compressed packet format. More...

struct	rnd_4_t
	The rnd_4 compressed packet format. More...

struct	rnd_5_t
	The rnd_5 compressed packet format. More...

struct	rnd_6_t
	The rnd_6 compressed packet format. More...

struct	rnd_7_t
	The rnd_7 compressed packet format. More...

struct	rnd_8_t
	The rnd_8 compressed packet format. More...

struct	seq_1_t
	The seq_1 compressed packet format. More...

struct	seq_2_t
	The seq_2 compressed packet format. More...

struct	seq_3_t
	The seq_3 compressed packet format. More...

struct	seq_4_t
	The seq_4 compressed packet format. More...

struct	seq_5_t
	The seq_5 compressed packet format. More...

struct	seq_6_t
	The seq_6 compressed packet format. More...

struct	seq_7_t
	The seq_7 compressed packet format. More...

struct	seq_8_t
	The seq_8 compressed packet format. More...

Macros
#define	ROHC_PACKET_TYPE_IR 0xFD

#define	ROHC_PACKET_TYPE_IR_CR 0xfc

#define	ROHC_PACKET_TYPE_IR_DYN 0xF8

#define	ROHC_TCP_MAX_IP_HDRS 2U
	The maximum number of IP headers supported by the TCP profile. More...

#define	ROHC_TCP_MAX_IP_EXT_HDRS 5U
	The maximum number of IP extension header supported by the TCP profile. More...

#define	MAX_TCP_OPTION_INDEX 15U
	The largest index that may be used to identify one TCP option. More...

#define	ROHC_TCP_OPTS_MAX_PROTO 40U
	The maximum of TCP options supported by the TCP protocol. More...

#define	ROHC_TCP_OPTS_MAX 15U
	The maximum of TCP options supported by the TCP profile. More...

#define	RSF_RST_ONLY 0x04

#define	RSF_SYN_ONLY 0x02

#define	RSF_FIN_ONLY 0x01

#define	RSF_NONE 0x00

#define	TCP_OLEN_MSS 4U

#define	TCP_OLEN_WS 3U

#define	TCP_OLEN_SACK_PERM 2U

#define	TCP_OLEN_TS 10U

#define	TCP_INDEX_NOP 0U

#define	TCP_INDEX_EOL 1U

#define	TCP_INDEX_MSS 2U

#define	TCP_INDEX_WS 3U

#define	TCP_INDEX_TS 4U

#define	TCP_INDEX_SACK_PERM 5U

#define	TCP_INDEX_SACK 6U

#define	TCP_INDEX_GENERIC7 7U

#define	TCP_INDEX_GENERIC8 8U

#define	TCP_INDEX_GENERIC9 9U

#define	TCP_INDEX_GENERIC10 10U

#define	TCP_INDEX_GENERIC11 11U

#define	TCP_INDEX_GENERIC12 12U

#define	TCP_INDEX_GENERIC13 13U

#define	TCP_INDEX_GENERIC14 14U

#define	TCP_INDEX_GENERIC15 15U

#define	TCP_SACK_BLOCKS_MAX_NR 4U

Enumerations
enum	rohc_tcp_chain_t { ROHC_TCP_CHAIN_STATIC = 0, ROHC_TCP_CHAIN_DYNAMIC = 1, ROHC_TCP_CHAIN_REPLICATE = 2, ROHC_TCP_CHAIN_IRREGULAR = 3, ROHC_TCP_CHAIN_CO = 4 }
	The different chains used by the TCP profile. More...

enum	rohc_tcp_option_type_t { TCP_OPT_EOL = 0U, TCP_OPT_NOP = 1U, TCP_OPT_MSS = 2U, TCP_OPT_WS = 3U, TCP_OPT_SACK_PERM = 4U, TCP_OPT_SACK = 5U, TCP_OPT_TS = 8U, TCP_OPT_MAX = 255U }

enum	tcp_ip_id_behavior_t { IP_ID_BEHAVIOR_SEQ = 0, IP_ID_BEHAVIOR_SEQ_SWAP = 1, IP_ID_BEHAVIOR_RAND = 2, IP_ID_BEHAVIOR_ZERO = 3 }

enum	{ ROHC_TCP_PORT_STATIC = 0, ROHC_TCP_PORT_LSB8 = 1, ROHC_TCP_PORT_IRREGULAR = 2, ROHC_TCP_PORT_RESERVED = 3 }
	The different presence flags for port_replicate() encoding scheme. More...

Functions
static char *	tcp_ip_id_behavior_get_descr (const tcp_ip_id_behavior_t behavior)
	Get a string that describes the given IP-ID behavior. More...

static char *	tcp_opt_get_descr (const uint8_t opt_type)
	Get a string that describes the given option type. More...

Detailed Description

TCP header description.

Author: FWX rohc_.nosp@m.team.nosp@m.@dial.nosp@m.ine..nosp@m.fr; Didier Barvaux didie.nosp@m.r@ba.nosp@m.rvaux.nosp@m..org; Didier Barvaux didie.nosp@m.r.ba.nosp@m.rvaux.nosp@m.@tou.nosp@m.louse.nosp@m..viv.nosp@m.eris..nosp@m.com

Macro Definition Documentation

◆ MAX_TCP_OPTION_INDEX

#define MAX_TCP_OPTION_INDEX 15U

The largest index that may be used to identify one TCP option.

The ROHC standard defines that one TCP option is identified by an index. It also defines that index is in range [0 ; 15].

◆ ROHC_PACKET_TYPE_IR

#define ROHC_PACKET_TYPE_IR 0xFD

◆ ROHC_PACKET_TYPE_IR_CR

#define ROHC_PACKET_TYPE_IR_CR 0xfc

◆ ROHC_PACKET_TYPE_IR_DYN

#define ROHC_PACKET_TYPE_IR_DYN 0xF8

◆ ROHC_TCP_MAX_IP_EXT_HDRS

#define ROHC_TCP_MAX_IP_EXT_HDRS 5U

The maximum number of IP extension header supported by the TCP profile.

The limit value was chosen arbitrarily. It should handle most real-life case without hurting performances nor memory footprint.

◆ ROHC_TCP_MAX_IP_HDRS

#define ROHC_TCP_MAX_IP_HDRS 2U

The maximum number of IP headers supported by the TCP profile.

The limit value was chosen arbitrarily. It should handle most real-life case without hurting performances nor memory footprint.

◆ ROHC_TCP_OPTS_MAX

#define ROHC_TCP_OPTS_MAX 15U

The maximum of TCP options supported by the TCP profile.

One TCP header may contain up to 40 bytes of options, so it may contain up 40 1-byte options, so the ROHC (de)compressors should expect such TCP packets. However the m field in the compressed list of TCP options (see RFC 6846, section 6.3.3 for more details) cannot be larger than 15, so restrict the number of TCP options that value. One TCP packet with more than 15 TCP options will be compressed with the IP-only profile.

See also: ROHC_TCP_OPTS_MAX_PROTO

◆ ROHC_TCP_OPTS_MAX_PROTO

#define ROHC_TCP_OPTS_MAX_PROTO 40U

The maximum of TCP options supported by the TCP protocol.

One TCP header may contain up to 40 bytes of options, so it may contain up 40 1-byte options.

See also: ROHC_TCP_OPTS_MAX

◆ RSF_FIN_ONLY

#define RSF_FIN_ONLY 0x01

◆ RSF_NONE

#define RSF_NONE 0x00

◆ RSF_RST_ONLY

#define RSF_RST_ONLY 0x04

◆ RSF_SYN_ONLY

#define RSF_SYN_ONLY 0x02

◆ TCP_INDEX_EOL

#define TCP_INDEX_EOL 1U

◆ TCP_INDEX_GENERIC10

#define TCP_INDEX_GENERIC10 10U

◆ TCP_INDEX_GENERIC11

#define TCP_INDEX_GENERIC11 11U

◆ TCP_INDEX_GENERIC12

#define TCP_INDEX_GENERIC12 12U

◆ TCP_INDEX_GENERIC13

#define TCP_INDEX_GENERIC13 13U

◆ TCP_INDEX_GENERIC14

#define TCP_INDEX_GENERIC14 14U

◆ TCP_INDEX_GENERIC15

#define TCP_INDEX_GENERIC15 15U

◆ TCP_INDEX_GENERIC7

#define TCP_INDEX_GENERIC7 7U

◆ TCP_INDEX_GENERIC8

#define TCP_INDEX_GENERIC8 8U

◆ TCP_INDEX_GENERIC9

#define TCP_INDEX_GENERIC9 9U

◆ TCP_INDEX_MSS

#define TCP_INDEX_MSS 2U

◆ TCP_INDEX_NOP

#define TCP_INDEX_NOP 0U

◆ TCP_INDEX_SACK

#define TCP_INDEX_SACK 6U

◆ TCP_INDEX_SACK_PERM

#define TCP_INDEX_SACK_PERM 5U

◆ TCP_INDEX_TS

#define TCP_INDEX_TS 4U

◆ TCP_INDEX_WS

#define TCP_INDEX_WS 3U

◆ TCP_OLEN_MSS

#define TCP_OLEN_MSS 4U

◆ TCP_OLEN_SACK_PERM

#define TCP_OLEN_SACK_PERM 2U

◆ TCP_OLEN_TS

#define TCP_OLEN_TS 10U

◆ TCP_OLEN_WS

#define TCP_OLEN_WS 3U

◆ TCP_SACK_BLOCKS_MAX_NR

#define TCP_SACK_BLOCKS_MAX_NR 4U

The maximum number of SACK blocks in the TCP SACK option

Enumeration Type Documentation

◆ anonymous enum

anonymous enum

The different presence flags for port_replicate() encoding scheme.

Enumerator
ROHC_TCP_PORT_STATIC	port is static, so it is not transmitted
ROHC_TCP_PORT_LSB8	port is not static and it is compressible
ROHC_TCP_PORT_IRREGULAR	port is not static and it is not compressible
ROHC_TCP_PORT_RESERVED	reserved value

◆ rohc_tcp_chain_t

enum rohc_tcp_chain_t

The different chains used by the TCP profile.

Enumerator
ROHC_TCP_CHAIN_STATIC	The TCP static chain
ROHC_TCP_CHAIN_DYNAMIC	The TCP dynamic chain
ROHC_TCP_CHAIN_REPLICATE	The TCP replicate chain
ROHC_TCP_CHAIN_IRREGULAR	The TCP irregular chain
ROHC_TCP_CHAIN_CO	Not a chain, but in CO packet

◆ rohc_tcp_option_type_t

enum rohc_tcp_option_type_t

The different TCP options

Enumerator
TCP_OPT_EOL	The End of Option List (EOL) TCP option
TCP_OPT_NOP	The No OPeration (NOP) TCP option
TCP_OPT_MSS	The Maximum Segment Size (MSS) TCP option
TCP_OPT_WS	The Window Scale (WS) TCP option
TCP_OPT_SACK_PERM	The SACK Permitted TCP option
TCP_OPT_SACK	The Selective ACKnowledgement (SACK) TCP option
TCP_OPT_TS	The TimeStamp (TS) TCP option
TCP_OPT_MAX	The maximum TCP option

◆ tcp_ip_id_behavior_t

enum tcp_ip_id_behavior_t

The different IP-ID behaviors

Enumerator
IP_ID_BEHAVIOR_SEQ	IP-ID increases
IP_ID_BEHAVIOR_SEQ_SWAP	IP-ID increases in little endian
IP_ID_BEHAVIOR_RAND	IP-ID is random
IP_ID_BEHAVIOR_ZERO	IP-ID is constant zero

Function Documentation

◆ tcp_ip_id_behavior_get_descr()

static char * tcp_ip_id_behavior_get_descr ( const tcp_ip_id_behavior_t behavior )

inlinestatic

Get a string that describes the given IP-ID behavior.

Parameters

behavior The type of the option to get a description for

Returns: The description of the option

◆ tcp_opt_get_descr()

static char * tcp_opt_get_descr ( const uint8_t opt_type )