aboutsummaryrefslogtreecommitdiffstats
path: root/drivers/net/bonding/rte_eth_bond_alb.h
blob: fd7c3aeb4e3469694d5c6f0b61f0514030a0c709 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
/*-
 *   BSD LICENSE
 *
 *   Copyright(c) 2010-2015 Intel Corporation. All rights reserved.
 *   All rights reserved.
 *
 *   Redistribution and use in source and binary forms, with or without
 *   modification, are permitted provided that the following conditions
 *   are met:
 *
 *     * Redistributions of source code must retain the above copyright
 *       notice, this list of conditions and the following disclaimer.
 *     * Redistributions in binary form must reproduce the above copyright
 *       notice, this list of conditions and the following disclaimer in
 *       the documentation and/or other materials provided with the
 *       distribution.
 *     * Neither the name of Intel Corporation nor the names of its
 *       contributors may be used to endorse or promote products derived
 *       from this software without specific prior written permission.
 *
 *   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 *   "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 *   LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 *   A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 *   OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 *   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 *   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 *   DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 *   THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 *   (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 *   OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

#ifndef RTE_ETH_BOND_ALB_H_
#define RTE_ETH_BOND_ALB_H_

#include <rte_ether.h>
#include <rte_arp.h>

#define ALB_HASH_TABLE_SIZE	256
#define ALB_NULL_INDEX		0xFFFFFFFF

struct client_data {
	/** ARP data of single client */
	struct ether_addr app_mac;
	/**< MAC address of application running DPDK */
	uint32_t app_ip;
	/**< IP address of application running DPDK */
	struct ether_addr cli_mac;
	/**< Client MAC address */
	uint32_t cli_ip;
	/**< Client IP address */

	uint8_t slave_idx;
	/**< Index of slave on which we connect with that client */
	uint8_t in_use;
	/**< Flag indicating if entry in client table is currently used */
	uint8_t ntt;
	/**< Flag indicating if we need to send update to this client on next tx */

	struct vlan_hdr vlan[2];
	/**< Content of vlan headers */
	uint8_t vlan_count;
	/**< Number of nested vlan headers */
};

struct mode_alb_private {
	struct client_data client_table[ALB_HASH_TABLE_SIZE];
	/**< Hash table storing ARP data of every client connected */
	struct rte_mempool *mempool;
	/**< Mempool for creating ARP update packets */
	uint8_t ntt;
	/**< Flag indicating if we need to send update to any client on next tx */
	uint32_t last_slave;
	/**< Index of last used slave in client table */
	rte_spinlock_t lock;
};

/**
 * ALB mode initialization.
 *
 * @param bond_dev		Pointer to bonding device.
 *
 * @return
 * Error code - 0 on success.
 */
int
bond_mode_alb_enable(struct rte_eth_dev *bond_dev);

/**
 * Function handles ARP packet reception. If received ARP request, it is
 * forwarded to application without changes. If it is ARP reply, client table
 * is updated.
 *
 * @param eth_h			ETH header of received packet.
 * @param offset		Vlan header offset.
 * @param internals		Bonding data.
 */
void
bond_mode_alb_arp_recv(struct ether_hdr *eth_h, uint16_t offset,
		struct bond_dev_private *internals);

/**
 * Function handles ARP packet transmission. It also decides on which slave
 * send that packet. If packet is ARP Request, it is send on primary slave.
 * If it is ARP Reply, it is send on slave stored in client table for that
 * connection. On Reply function also updates data in client table.
 *
 * @param eth_h			ETH header of transmitted packet.
 * @param offset		Vlan header offset.
 * @param internals		Bonding data.
 *
 * @return
 * Index of slave on which packet should be sent.
 */
uint8_t
bond_mode_alb_arp_xmit(struct ether_hdr *eth_h, uint16_t offset,
		struct bond_dev_private *internals);

/**
 * Function fills packet with ARP data from client_info.
 *
 * @param client_info	Data of client to which packet is sent.
 * @param pkt			Pointer to packet which is sent.
 * @param internals		Bonding data.
 *
 * @return
 * Index of slawe on which packet should be sent.
 */
uint8_t
bond_mode_alb_arp_upd(struct client_data *client_info,
		struct rte_mbuf *pkt, struct bond_dev_private *internals);

/**
 * Function updates slave indexes of active connections.
 *
 * @param bond_dev		Pointer to bonded device struct.
 */
void
bond_mode_alb_client_list_upd(struct rte_eth_dev *bond_dev);

#endif /* RTE_ETH_BOND_ALB_H_ */