tcp_helper.h File Reference

#include "../lwip_check.h"
#include "lwip/arch.h"
#include "lwip/tcp.h"
#include "lwip/netif.h"

Include dependency graph for tcp_helper.h:

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

Go to the source code of this file.

Classes
struct	test_tcp_counters
struct	test_tcp_txcounters

Macros
#define	TEST_REMOTE_PORT   0x100
#define	TEST_LOCAL_PORT   0x101

Functions
void	tcp_remove_all (void)
struct pbuf *	tcp_create_segment (ip_addr_t *src_ip, ip_addr_t *dst_ip, u16_t src_port, u16_t dst_port, void *data, size_t data_len, u32_t seqno, u32_t ackno, u8_t headerflags)
struct pbuf *	tcp_create_rx_segment (struct tcp_pcb *pcb, void *data, size_t data_len, u32_t seqno_offset, u32_t ackno_offset, u8_t headerflags)
struct pbuf *	tcp_create_rx_segment_wnd (struct tcp_pcb *pcb, void *data, size_t data_len, u32_t seqno_offset, u32_t ackno_offset, u8_t headerflags, u16_t wnd)
void	tcp_set_state (struct tcp_pcb *pcb, enum tcp_state state, const ip_addr_t *local_ip, const ip_addr_t *remote_ip, u16_t local_port, u16_t remote_port)
void	test_tcp_counters_err (void *arg, err_t err)
err_t	test_tcp_counters_recv (void *arg, struct tcp_pcb *pcb, struct pbuf *p, err_t err)
struct tcp_pcb *	test_tcp_new_counters_pcb (struct test_tcp_counters *counters)
void	test_tcp_input (struct pbuf *p, struct netif *inp)
void	test_tcp_init_netif (struct netif *netif, struct test_tcp_txcounters *txcounters, const ip_addr_t *ip_addr, const ip_addr_t *netmask)

Variables
const ip_addr_t	test_local_ip
const ip_addr_t	test_remote_ip
const ip_addr_t	test_netmask

Macro Definition Documentation

TEST_LOCAL_PORT

#define TEST_LOCAL_PORT   0x101

Definition at line 33 of file tcp_helper.h.

TEST_REMOTE_PORT

#define TEST_REMOTE_PORT   0x100

Definition at line 32 of file tcp_helper.h.

Function Documentation

tcp_create_rx_segment()

struct pbuf * tcp_create_rx_segment	(	struct tcp_pcb *	pcb,
		void *	data,
		size_t	data_len,
		u32_t	seqno_offset,
		u32_t	ackno_offset,
		u8_t	headerflags
	)

Create a TCP segment usable for passing to tcp_input

• IP-addresses, ports, seqno and ackno are taken from pcb
• seqno and ackno can be altered with an offset

Definition at line 130 of file tcp_helper.c.

{
  return tcp_create_segment(&pcb->remote_ip, &pcb->local_ip, pcb->remote_port, pcb->local_port,
    data, data_len, pcb->rcv_nxt + seqno_offset, pcb->lastack + ackno_offset, headerflags);
}

Referenced by START_TEST(), test_tcp_recv_ooseq_double_FINs(), and test_tcp_tx_full_window_lost().

tcp_create_rx_segment_wnd()

struct pbuf * tcp_create_rx_segment_wnd	(	struct tcp_pcb *	pcb,
		void *	data,
		size_t	data_len,
		u32_t	seqno_offset,
		u32_t	ackno_offset,
		u8_t	headerflags,
		u16_t	wnd
	)

Create a TCP segment usable for passing to tcp_input

• IP-addresses, ports, seqno and ackno are taken from pcb
• seqno and ackno can be altered with an offset
• TCP window can be adjusted

Definition at line 142 of file tcp_helper.c.

{
  return tcp_create_segment_wnd(&pcb->remote_ip, &pcb->local_ip, pcb->remote_port, pcb->local_port,
    data, data_len, pcb->rcv_nxt + seqno_offset, pcb->lastack + ackno_offset, headerflags, wnd);
}

Referenced by START_TEST(), test_tcp_tx_full_window_lost(), and test_tcp_zwp_timeout_impl().

tcp_create_segment()

struct pbuf * tcp_create_segment	(	ip_addr_t *	src_ip,
		ip_addr_t *	dst_ip,
		u16_t	src_port,
		u16_t	dst_port,
		void *	data,
		size_t	data_len,
		u32_t	seqno,
		u32_t	ackno,
		u8_t	headerflags
	)

Create a TCP segment usable for passing to tcp_input

Definition at line 117 of file tcp_helper.c.

{
  return tcp_create_segment_wnd(src_ip, dst_ip, src_port, dst_port, data,
    data_len, seqno, ackno, headerflags, TCP_WND);
}

Referenced by START_TEST(), and tcp_create_rx_segment().

tcp_remove_all()

void tcp_remove_all

(

void

)

Remove all pcbs on listen-, active- and time-wait-list (bound- isn't exported).

Definition at line 38 of file tcp_helper.c.

{
  tcp_remove(tcp_listen_pcbs.pcbs);
  tcp_remove(tcp_bound_pcbs);
  tcp_remove(tcp_active_pcbs);
  tcp_remove(tcp_tw_pcbs);
  fail_unless(MEMP_STATS_GET(used, MEMP_TCP_PCB) == 0);
  fail_unless(MEMP_STATS_GET(used, MEMP_TCP_PCB_LISTEN) == 0);
  fail_unless(MEMP_STATS_GET(used, MEMP_TCP_SEG) == 0);
  fail_unless(MEMP_STATS_GET(used, MEMP_PBUF_POOL) == 0);
}

Referenced by tcp_oos_setup(), tcp_oos_teardown(), tcp_setup(), tcp_state_setup(), tcp_state_teardown(), and tcp_teardown().

tcp_set_state()

void tcp_set_state	(	struct tcp_pcb *	pcb,
		enum tcp_state	state,
		const ip_addr_t *	local_ip,
		const ip_addr_t *	remote_ip,
		u16_t	local_port,
		u16_t	remote_port
	)

Safely bring a tcp_pcb into the requested state

Definition at line 151 of file tcp_helper.c.

{
  u32_t iss;
 
  /* @todo: are these all states? */
  /* @todo: remove from previous list */
  pcb->state = state;
  
  iss = tcp_next_iss(pcb);
  pcb->snd_wl2 = iss;
  pcb->snd_nxt = iss;
  pcb->lastack = iss;
  pcb->snd_lbb = iss;
  
  if (state == ESTABLISHED) {
    TCP_REG(&tcp_active_pcbs, pcb);
    ip_addr_copy(pcb->local_ip, *local_ip);
    pcb->local_port = local_port;
    ip_addr_copy(pcb->remote_ip, *remote_ip);
    pcb->remote_port = remote_port;
  } else if(state == LISTEN) {
    TCP_REG(&tcp_listen_pcbs.pcbs, pcb);
    ip_addr_copy(pcb->local_ip, *local_ip);
    pcb->local_port = local_port;
  } else if(state == TIME_WAIT) {
    TCP_REG(&tcp_tw_pcbs, pcb);
    ip_addr_copy(pcb->local_ip, *local_ip);
    pcb->local_port = local_port;
    ip_addr_copy(pcb->remote_ip, *remote_ip);
    pcb->remote_port = remote_port;
  } else {
    fail();
  }
}

test_tcp_counters_err()

void test_tcp_counters_err	(	void *	arg,
		err_t	err
	)

Definition at line 188 of file tcp_helper.c.

{
  struct test_tcp_counters* counters = (struct test_tcp_counters*)arg;
  EXPECT_RET(arg != NULL);
  counters->err_calls++;
  counters->last_err = err;
}

Referenced by test_tcp_new_counters_pcb().

test_tcp_counters_recv()

err_t test_tcp_counters_recv	(	void *	arg,
		struct tcp_pcb *	pcb,
		struct pbuf *	p,
		err_t	err
	)

Definition at line 218 of file tcp_helper.c.

{
  struct test_tcp_counters* counters = (struct test_tcp_counters*)arg;
  EXPECT_RETX(arg != NULL, ERR_OK);
  EXPECT_RETX(pcb != NULL, ERR_OK);
  EXPECT_RETX(err == ERR_OK, ERR_OK);
 
  if (p != NULL) {
    if (counters->close_calls == 0) {
      counters->recv_calls++;
      test_tcp_counters_check_rxdata(counters, p);
      counters->recved_bytes += p->tot_len;
    } else {
      counters->recv_calls_after_close++;
      counters->recved_bytes_after_close += p->tot_len;
    }
    pbuf_free(p);
  } else {
    counters->close_calls++;
  }
  EXPECT(counters->recv_calls_after_close == 0 && counters->recved_bytes_after_close == 0);
  return ERR_OK;
}

Referenced by test_tcp_new_counters_pcb().

test_tcp_init_netif()

void test_tcp_init_netif	(	struct netif *	netif,
		struct test_tcp_txcounters *	txcounters,
		const ip_addr_t *	ip_addr,
		const ip_addr_t *	netmask
	)

Definition at line 305 of file tcp_helper.c.

{
  struct netif *n;
  memset(netif, 0, sizeof(struct netif));
  if (txcounters != NULL) {
    memset(txcounters, 0, sizeof(struct test_tcp_txcounters));
    netif->state = txcounters;
  }
  netif->output = test_tcp_netif_output;
  netif->flags |= NETIF_FLAG_UP | NETIF_FLAG_LINK_UP;
  ip_addr_copy_from_ip4(netif->netmask, *ip_2_ip4(netmask));
  ip_addr_copy_from_ip4(netif->ip_addr, *ip_2_ip4(ip_addr));
  for (n = netif_list; n != NULL; n = n->next) {
    if (n == netif) {
      return;
    }
  }
  netif->next = NULL;
  netif_list = netif;
}

Referenced by START_TEST(), tcp_state_setup(), test_tcp_recv_ooseq_double_FINs(), test_tcp_rto_timeout_impl(), test_tcp_rto_timeout_syn_sent_impl(), test_tcp_tx_full_window_lost(), and test_tcp_zwp_timeout_impl().

test_tcp_input()

void test_tcp_input	(	struct pbuf *	p,
		struct netif *	inp
	)

Calls tcp_input() after adjusting current_iphdr_dest

Definition at line 259 of file tcp_helper.c.

{
  struct ip_hdr *iphdr = (struct ip_hdr*)p->payload;
  /* these lines are a hack, don't use them as an example :-) */
  ip_addr_copy_from_ip4(*ip_current_dest_addr(), iphdr->dest);
  ip_addr_copy_from_ip4(*ip_current_src_addr(), iphdr->src);
  ip_current_netif() = inp;
  ip_data.current_ip4_header = iphdr;
  ip_data.current_input_netif = inp;
 
  /* since adding IPv6, p->payload must point to tcp header, not ip header */
  pbuf_header(p, -(s16_t)sizeof(struct ip_hdr));
 
  tcp_input(p, inp);
 
  ip_addr_set_zero(ip_current_dest_addr());
  ip_addr_set_zero(ip_current_src_addr());
  ip_current_netif() = NULL;
  ip_data.current_ip4_header = NULL;
}

Referenced by START_TEST(), test_rst_generation_with_incoming_packet(), test_tcp_recv_ooseq_double_FINs(), test_tcp_tx_full_window_lost(), and test_tcp_zwp_timeout_impl().

test_tcp_new_counters_pcb()

struct tcp_pcb * test_tcp_new_counters_pcb

(

struct test_tcp_counters *

counters

)

Allocate a pcb and set up the test_tcp_counters_* callbacks

Definition at line 244 of file tcp_helper.c.

{
  struct tcp_pcb* pcb = tcp_new();
  if (pcb != NULL) {
    /* set up args and callbacks */
    tcp_arg(pcb, counters);
    tcp_recv(pcb, test_tcp_counters_recv);
    tcp_err(pcb, test_tcp_counters_err);
    pcb->snd_wnd = TCP_WND;
    pcb->snd_wnd_max = TCP_WND;
  }
  return pcb;
}

Referenced by create_listening_pcb(), START_TEST(), test_tcp_recv_ooseq_double_FINs(), test_tcp_rto_timeout_impl(), test_tcp_rto_timeout_syn_sent_impl(), test_tcp_tx_full_window_lost(), and test_tcp_zwp_timeout_impl().

Variable Documentation

test_local_ip

const ip_addr_t test_local_ip

extern

Definition at line 14 of file tcp_helper.c.

Referenced by START_TEST(), tcp_state_setup(), test_tcp_recv_ooseq_double_FINs(), test_tcp_rto_timeout_impl(), test_tcp_rto_timeout_syn_sent_impl(), test_tcp_tx_full_window_lost(), and test_tcp_zwp_timeout_impl().

test_netmask

const ip_addr_t test_netmask

extern

Definition at line 16 of file tcp_helper.c.

test_remote_ip

const ip_addr_t test_remote_ip

extern

Definition at line 15 of file tcp_helper.c.

Referenced by START_TEST(), test_tcp_recv_ooseq_double_FINs(), test_tcp_rto_timeout_impl(), test_tcp_tx_full_window_lost(), and test_tcp_zwp_timeout_impl().