bond: add mode 6
[dpdk.git] / lib / librte_pmd_bond / rte_eth_bond_alb.h
1 /*-
2  *   BSD LICENSE
3  *
4  *   Copyright(c) 2010-2015 Intel Corporation. All rights reserved.
5  *   All rights reserved.
6  *
7  *   Redistribution and use in source and binary forms, with or without
8  *   modification, are permitted provided that the following conditions
9  *   are met:
10  *
11  *     * Redistributions of source code must retain the above copyright
12  *       notice, this list of conditions and the following disclaimer.
13  *     * Redistributions in binary form must reproduce the above copyright
14  *       notice, this list of conditions and the following disclaimer in
15  *       the documentation and/or other materials provided with the
16  *       distribution.
17  *     * Neither the name of Intel Corporation nor the names of its
18  *       contributors may be used to endorse or promote products derived
19  *       from this software without specific prior written permission.
20  *
21  *   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
22  *   "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
23  *   LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
24  *   A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
25  *   OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
26  *   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
27  *   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
28  *   DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
29  *   THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
30  *   (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
31  *   OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
32  */
33
34 #ifndef RTE_ETH_BOND_ALB_H_
35 #define RTE_ETH_BOND_ALB_H_
36
37 #include <rte_ether.h>
38 #include <rte_arp.h>
39
40 #define ALB_HASH_TABLE_SIZE     256
41 #define ALB_NULL_INDEX          0xFFFFFFFF
42
43 struct client_data {
44         /** ARP data of single client */
45         struct ether_addr app_mac;
46         /**< MAC address of application running DPDK */
47         uint32_t app_ip;
48         /**< IP address of application running DPDK */
49         struct ether_addr cli_mac;
50         /**< Client MAC address */
51         uint32_t cli_ip;
52         /**< Client IP address */
53
54         uint8_t slave_idx;
55         /**< Index of slave on which we connect with that client */
56         uint8_t in_use;
57         /**< Flag indicating if entry in client table is currently used */
58         uint8_t ntt;
59         /**< Flag indicating if we need to send update to this client on next tx */
60
61         struct vlan_hdr vlan[2];
62         /**< Content of vlan headers */
63         uint8_t vlan_count;
64         /**< Number of nested vlan headers */
65 };
66
67 struct mode_alb_private {
68         struct client_data client_table[ALB_HASH_TABLE_SIZE];
69         /**< Hash table storing ARP data of every client connected */
70         struct rte_mempool *mempool;
71         /**< Mempool for creating ARP update packets */
72         uint8_t ntt;
73         /**< Flag indicating if we need to send update to any client on next tx */
74         uint32_t last_slave;
75         /**< Index of last used slave in client table */
76         rte_spinlock_t lock;
77 };
78
79 /**
80  * ALB mode initialization.
81  *
82  * @param bond_dev              Pointer to bonding device.
83  *
84  * @return
85  * Error code - 0 on success.
86  */
87 int
88 bond_mode_alb_enable(struct rte_eth_dev *bond_dev);
89
90 /**
91  * Function handles ARP packet reception. If received ARP request, it is
92  * forwarded to application without changes. If it is ARP reply, client table
93  * is updated.
94  *
95  * @param eth_h                 ETH header of received packet.
96  * @param offset                Vlan header offset.
97  * @param internals             Bonding data.
98  */
99 void
100 bond_mode_alb_arp_recv(struct ether_hdr *eth_h, uint16_t offset,
101                 struct bond_dev_private *internals);
102
103 /**
104  * Function handles ARP packet transmission. It also decides on which slave
105  * send that packet. If packet is ARP Request, it is send on primary slave.
106  * If it is ARP Reply, it is send on slave stored in client table for that
107  * connection. On Reply function also updates data in client table.
108  *
109  * @param eth_h                 ETH header of transmitted packet.
110  * @param offset                Vlan header offset.
111  * @param internals             Bonding data.
112  *
113  * @return
114  * Index of slave on which packet should be sent.
115  */
116 uint8_t
117 bond_mode_alb_arp_xmit(struct ether_hdr *eth_h, uint16_t offset,
118                 struct bond_dev_private *internals);
119
120 /**
121  * Function fills packet with ARP data from client_info.
122  *
123  * @param client_info   Data of client to which packet is sent.
124  * @param pkt                   Pointer to packet which is sent.
125  * @param internals             Bonding data.
126  *
127  * @return
128  * Index of slawe on which packet should be sent.
129  */
130 uint8_t
131 bond_mode_alb_arp_upd(struct client_data *client_info,
132                 struct rte_mbuf *pkt, struct bond_dev_private *internals);
133
134 /**
135  * Function updates slave indexes of active connections.
136  *
137  * @param bond_dev              Pointer to bonded device struct.
138  */
139 void
140 bond_mode_alb_client_list_upd(struct rte_eth_dev *bond_dev);
141
142 #endif /* RTE_ETH_BOND_ALB_H_ */