xref: /qemu/hw/net/net_tx_pkt.h (revision 00f76608a68dcd832c4a1b66694ef3e9cb52912f)
1e263cd49SDmitry Fleytman /*
2605d52e6SDmitry Fleytman  * QEMU TX packets abstraction
3e263cd49SDmitry Fleytman  *
4e263cd49SDmitry Fleytman  * Copyright (c) 2012 Ravello Systems LTD (http://ravellosystems.com)
5e263cd49SDmitry Fleytman  *
6e263cd49SDmitry Fleytman  * Developed by Daynix Computing LTD (http://www.daynix.com)
7e263cd49SDmitry Fleytman  *
8e263cd49SDmitry Fleytman  * Authors:
9e263cd49SDmitry Fleytman  * Dmitry Fleytman <dmitry@daynix.com>
10e263cd49SDmitry Fleytman  * Tamir Shomer <tamirs@daynix.com>
11e263cd49SDmitry Fleytman  * Yan Vugenfirer <yan@daynix.com>
12e263cd49SDmitry Fleytman  *
13e263cd49SDmitry Fleytman  * This work is licensed under the terms of the GNU GPL, version 2 or later.
14e263cd49SDmitry Fleytman  * See the COPYING file in the top-level directory.
15e263cd49SDmitry Fleytman  *
16e263cd49SDmitry Fleytman  */
17e263cd49SDmitry Fleytman 
18605d52e6SDmitry Fleytman #ifndef NET_TX_PKT_H
19605d52e6SDmitry Fleytman #define NET_TX_PKT_H
20e263cd49SDmitry Fleytman 
21e263cd49SDmitry Fleytman #include "net/eth.h"
22e263cd49SDmitry Fleytman #include "exec/hwaddr.h"
23e263cd49SDmitry Fleytman 
24e263cd49SDmitry Fleytman /* define to enable packet dump functions */
25605d52e6SDmitry Fleytman /*#define NET_TX_PKT_DEBUG*/
26e263cd49SDmitry Fleytman 
27605d52e6SDmitry Fleytman struct NetTxPkt;
28e263cd49SDmitry Fleytman 
29a51db580SAkihiko Odaki typedef void (*NetTxPktFreeFrag)(void *, void *, size_t);
30a51db580SAkihiko Odaki typedef void (*NetTxPktSend)(void *, const struct iovec *, int, const struct iovec *, int);
31ffbd2dbdSAkihiko Odaki 
32e263cd49SDmitry Fleytman /**
33e263cd49SDmitry Fleytman  * Init function for tx packet functionality
34e263cd49SDmitry Fleytman  *
35e263cd49SDmitry Fleytman  * @pkt:            packet pointer
36e263cd49SDmitry Fleytman  * @max_frags:      max tx ip fragments
37e263cd49SDmitry Fleytman  */
38a51db580SAkihiko Odaki void net_tx_pkt_init(struct NetTxPkt **pkt, uint32_t max_frags);
39e263cd49SDmitry Fleytman 
40e263cd49SDmitry Fleytman /**
41e263cd49SDmitry Fleytman  * Clean all tx packet resources.
42e263cd49SDmitry Fleytman  *
43e263cd49SDmitry Fleytman  * @pkt:            packet.
44e263cd49SDmitry Fleytman  */
45605d52e6SDmitry Fleytman void net_tx_pkt_uninit(struct NetTxPkt *pkt);
46e263cd49SDmitry Fleytman 
47e263cd49SDmitry Fleytman /**
48e263cd49SDmitry Fleytman  * get virtio header
49e263cd49SDmitry Fleytman  *
50e263cd49SDmitry Fleytman  * @pkt:            packet
51e263cd49SDmitry Fleytman  * @ret:            virtio header
52e263cd49SDmitry Fleytman  */
53605d52e6SDmitry Fleytman struct virtio_net_hdr *net_tx_pkt_get_vhdr(struct NetTxPkt *pkt);
54e263cd49SDmitry Fleytman 
55e263cd49SDmitry Fleytman /**
56e263cd49SDmitry Fleytman  * build virtio header (will be stored in module context)
57e263cd49SDmitry Fleytman  *
58e263cd49SDmitry Fleytman  * @pkt:            packet
59e263cd49SDmitry Fleytman  * @tso_enable:     TSO enabled
60e263cd49SDmitry Fleytman  * @csum_enable:    CSO enabled
61e263cd49SDmitry Fleytman  * @gso_size:       MSS size for TSO
62f9a9eb16SAkihiko Odaki  * @ret:            operation result
63e263cd49SDmitry Fleytman  *
64e263cd49SDmitry Fleytman  */
65f9a9eb16SAkihiko Odaki bool net_tx_pkt_build_vheader(struct NetTxPkt *pkt, bool tso_enable,
66e263cd49SDmitry Fleytman     bool csum_enable, uint32_t gso_size);
67e263cd49SDmitry Fleytman 
68e263cd49SDmitry Fleytman /**
69eb700029SDmitry Fleytman * updates vlan tag, and adds vlan header with custom ethernet type
70eb700029SDmitry Fleytman * in case it is missing.
71eb700029SDmitry Fleytman *
72eb700029SDmitry Fleytman * @pkt:            packet
73eb700029SDmitry Fleytman * @vlan:           VLAN tag
74eb700029SDmitry Fleytman * @vlan_ethtype:   VLAN header Ethernet type
75eb700029SDmitry Fleytman *
76eb700029SDmitry Fleytman */
77eb700029SDmitry Fleytman void net_tx_pkt_setup_vlan_header_ex(struct NetTxPkt *pkt,
78eb700029SDmitry Fleytman     uint16_t vlan, uint16_t vlan_ethtype);
79eb700029SDmitry Fleytman 
80eb700029SDmitry Fleytman /**
81e263cd49SDmitry Fleytman * updates vlan tag, and adds vlan header in case it is missing
82e263cd49SDmitry Fleytman *
83e263cd49SDmitry Fleytman * @pkt:            packet
84e263cd49SDmitry Fleytman * @vlan:           VLAN tag
85e263cd49SDmitry Fleytman *
86e263cd49SDmitry Fleytman */
87eb700029SDmitry Fleytman static inline void
net_tx_pkt_setup_vlan_header(struct NetTxPkt * pkt,uint16_t vlan)88eb700029SDmitry Fleytman net_tx_pkt_setup_vlan_header(struct NetTxPkt *pkt, uint16_t vlan)
89eb700029SDmitry Fleytman {
90eb700029SDmitry Fleytman     net_tx_pkt_setup_vlan_header_ex(pkt, vlan, ETH_P_VLAN);
91eb700029SDmitry Fleytman }
92e263cd49SDmitry Fleytman 
93e263cd49SDmitry Fleytman /**
94e263cd49SDmitry Fleytman  * populate data fragment into pkt context.
95e263cd49SDmitry Fleytman  *
96e263cd49SDmitry Fleytman  * @pkt:            packet
97a51db580SAkihiko Odaki  * @base:           pointer to fragment
98e263cd49SDmitry Fleytman  * @len:            length of fragment
99e263cd49SDmitry Fleytman  *
100e263cd49SDmitry Fleytman  */
101a51db580SAkihiko Odaki bool net_tx_pkt_add_raw_fragment(struct NetTxPkt *pkt, void *base, size_t len);
102e263cd49SDmitry Fleytman 
103e263cd49SDmitry Fleytman /**
104eb700029SDmitry Fleytman  * Fix ip header fields and calculate IP header and pseudo header checksums.
105e263cd49SDmitry Fleytman  *
106e263cd49SDmitry Fleytman  * @pkt:            packet
107e263cd49SDmitry Fleytman  *
108e263cd49SDmitry Fleytman  */
109605d52e6SDmitry Fleytman void net_tx_pkt_update_ip_checksums(struct NetTxPkt *pkt);
110e263cd49SDmitry Fleytman 
111e263cd49SDmitry Fleytman /**
112eb700029SDmitry Fleytman  * Calculate the IP header checksum.
113eb700029SDmitry Fleytman  *
114eb700029SDmitry Fleytman  * @pkt:            packet
115eb700029SDmitry Fleytman  *
116eb700029SDmitry Fleytman  */
117eb700029SDmitry Fleytman void net_tx_pkt_update_ip_hdr_checksum(struct NetTxPkt *pkt);
118eb700029SDmitry Fleytman 
119eb700029SDmitry Fleytman /**
120*f199b13bSAkihiko Odaki  * Calculate the SCTP checksum.
121*f199b13bSAkihiko Odaki  *
122*f199b13bSAkihiko Odaki  * @pkt:            packet
123*f199b13bSAkihiko Odaki  *
124*f199b13bSAkihiko Odaki  */
125*f199b13bSAkihiko Odaki bool net_tx_pkt_update_sctp_checksum(struct NetTxPkt *pkt);
126*f199b13bSAkihiko Odaki 
127*f199b13bSAkihiko Odaki /**
128e263cd49SDmitry Fleytman  * get length of all populated data.
129e263cd49SDmitry Fleytman  *
130e263cd49SDmitry Fleytman  * @pkt:            packet
131e263cd49SDmitry Fleytman  * @ret:            total data length
132e263cd49SDmitry Fleytman  *
133e263cd49SDmitry Fleytman  */
134605d52e6SDmitry Fleytman size_t net_tx_pkt_get_total_len(struct NetTxPkt *pkt);
135e263cd49SDmitry Fleytman 
136e263cd49SDmitry Fleytman /**
137e263cd49SDmitry Fleytman  * get packet type
138e263cd49SDmitry Fleytman  *
139e263cd49SDmitry Fleytman  * @pkt:            packet
140e263cd49SDmitry Fleytman  * @ret:            packet type
141e263cd49SDmitry Fleytman  *
142e263cd49SDmitry Fleytman  */
143605d52e6SDmitry Fleytman eth_pkt_types_e net_tx_pkt_get_packet_type(struct NetTxPkt *pkt);
144e263cd49SDmitry Fleytman 
145e263cd49SDmitry Fleytman /**
146e263cd49SDmitry Fleytman  * prints packet data if debug is enabled
147e263cd49SDmitry Fleytman  *
148e263cd49SDmitry Fleytman  * @pkt:            packet
149e263cd49SDmitry Fleytman  *
150e263cd49SDmitry Fleytman  */
151605d52e6SDmitry Fleytman void net_tx_pkt_dump(struct NetTxPkt *pkt);
152e263cd49SDmitry Fleytman 
153e263cd49SDmitry Fleytman /**
154e263cd49SDmitry Fleytman  * reset tx packet private context (needed to be called between packets)
155e263cd49SDmitry Fleytman  *
156e263cd49SDmitry Fleytman  * @pkt:            packet
157a51db580SAkihiko Odaki  * @callback:       function to free the fragments
158a51db580SAkihiko Odaki  * @context:        pointer to be passed to the callback
159e263cd49SDmitry Fleytman  */
160a51db580SAkihiko Odaki void net_tx_pkt_reset(struct NetTxPkt *pkt,
161a51db580SAkihiko Odaki                       NetTxPktFreeFrag callback, void *context);
162e263cd49SDmitry Fleytman 
163e263cd49SDmitry Fleytman /**
164163246e1SAkihiko Odaki  * Unmap a fragment mapped from a PCI device.
165163246e1SAkihiko Odaki  *
166163246e1SAkihiko Odaki  * @context:        PCI device owning fragment
167163246e1SAkihiko Odaki  * @base:           pointer to fragment
168163246e1SAkihiko Odaki  * @len:            length of fragment
169163246e1SAkihiko Odaki  */
170163246e1SAkihiko Odaki void net_tx_pkt_unmap_frag_pci(void *context, void *base, size_t len);
171163246e1SAkihiko Odaki 
172163246e1SAkihiko Odaki /**
173a51db580SAkihiko Odaki  * map data fragment from PCI device and populate it into pkt context.
174a51db580SAkihiko Odaki  *
175a51db580SAkihiko Odaki  * @pci_dev:        PCI device owning fragment
176a51db580SAkihiko Odaki  * @pa:             physical address of fragment
177a51db580SAkihiko Odaki  * @len:            length of fragment
178a51db580SAkihiko Odaki  */
179a51db580SAkihiko Odaki bool net_tx_pkt_add_raw_fragment_pci(struct NetTxPkt *pkt, PCIDevice *pci_dev,
180a51db580SAkihiko Odaki                                      dma_addr_t pa, size_t len);
181a51db580SAkihiko Odaki 
182a51db580SAkihiko Odaki /**
183e263cd49SDmitry Fleytman  * Send packet to qemu. handles sw offloads if vhdr is not supported.
184e263cd49SDmitry Fleytman  *
185e263cd49SDmitry Fleytman  * @pkt:            packet
186e263cd49SDmitry Fleytman  * @nc:             NetClientState
187e263cd49SDmitry Fleytman  * @ret:            operation result
188e263cd49SDmitry Fleytman  *
189e263cd49SDmitry Fleytman  */
190605d52e6SDmitry Fleytman bool net_tx_pkt_send(struct NetTxPkt *pkt, NetClientState *nc);
191e263cd49SDmitry Fleytman 
192e263cd49SDmitry Fleytman /**
193ffbd2dbdSAkihiko Odaki  * Send packet with a custom function.
194eb700029SDmitry Fleytman  *
195eb700029SDmitry Fleytman  * @pkt:            packet
196ffbd2dbdSAkihiko Odaki  * @offload:        whether the callback implements offloading
197ffbd2dbdSAkihiko Odaki  * @callback:       a function to be called back for each transformed packet
198ffbd2dbdSAkihiko Odaki  * @context:        a pointer to be passed to the callback.
199eb700029SDmitry Fleytman  * @ret:            operation result
200eb700029SDmitry Fleytman  */
201ffbd2dbdSAkihiko Odaki bool net_tx_pkt_send_custom(struct NetTxPkt *pkt, bool offload,
202a51db580SAkihiko Odaki                             NetTxPktSend callback, void *context);
203eb700029SDmitry Fleytman 
204eb700029SDmitry Fleytman /**
205e263cd49SDmitry Fleytman  * parse raw packet data and analyze offload requirements.
206e263cd49SDmitry Fleytman  *
207e263cd49SDmitry Fleytman  * @pkt:            packet
208e263cd49SDmitry Fleytman  *
209e263cd49SDmitry Fleytman  */
210605d52e6SDmitry Fleytman bool net_tx_pkt_parse(struct NetTxPkt *pkt);
211e263cd49SDmitry Fleytman 
212eb700029SDmitry Fleytman /**
213eb700029SDmitry Fleytman * indicates if there are data fragments held by this packet object.
214eb700029SDmitry Fleytman *
215eb700029SDmitry Fleytman * @pkt:            packet
216eb700029SDmitry Fleytman *
217eb700029SDmitry Fleytman */
218eb700029SDmitry Fleytman bool net_tx_pkt_has_fragments(struct NetTxPkt *pkt);
219eb700029SDmitry Fleytman 
220e219d309SAndrew /**
221e219d309SAndrew  * Fix IPv6 'plen' field.
222e219d309SAndrew  * If ipv6 payload length field is 0 - then there should be Hop-by-Hop
223e219d309SAndrew  * option for packets greater than 65,535.
224e219d309SAndrew  * For packets with a payload less than 65,535: fix 'plen' field.
225e219d309SAndrew  * For backends with vheader, we need just one packet with proper
226e219d309SAndrew  * payload size. For now, qemu drops every packet with size greater 64K
227e219d309SAndrew  * (see net_tx_pkt_send()) so, there is no reason to add jumbo option to ip6
228e219d309SAndrew  * hop-by-hop extension if it's missed
229e219d309SAndrew  *
230e219d309SAndrew  * @pkt            packet
231e219d309SAndrew  */
232e219d309SAndrew void net_tx_pkt_fix_ip6_payload_len(struct NetTxPkt *pkt);
233e219d309SAndrew 
234e263cd49SDmitry Fleytman #endif
235