doc: move FAQ
[dpdk.git] / lib / librte_port / rte_port_frag.h
1 /*-
2  *   BSD LICENSE
3  *
4  *   Copyright(c) 2010-2014 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 __INCLUDE_RTE_PORT_IP_FRAG_H__
35 #define __INCLUDE_RTE_PORT_IP_FRAG_H__
36
37 #ifdef __cplusplus
38 extern "C" {
39 #endif
40
41 /**
42  * @file
43  * RTE Port for IPv4 Fragmentation
44  *
45  * This port is built on top of pre-initialized single consumer rte_ring. In
46  * order to minimize the amount of packets stored in the ring at any given
47  * time, the IP fragmentation functionality is executed on ring read operation,
48  * hence this port is implemented as an input port. A regular ring_writer port
49  * can be created to write to the same ring.
50  *
51  * The packets written to the ring are either complete IP datagrams or jumbo
52  * frames (i.e. IP packets with length bigger than provided MTU value). The
53  * packets read from the ring are all non-jumbo frames. The complete IP
54  * datagrams written to the ring are not changed. The jumbo frames are
55  * fragmented into several IP packets with length less or equal to MTU.
56  *
57  ***/
58
59 #include <stdint.h>
60
61 #include <rte_ring.h>
62
63 #include "rte_port.h"
64
65 /** ring_reader_ipv4_frag port parameters */
66 struct rte_port_ring_reader_frag_params {
67         /** Underlying single consumer ring that has to be pre-initialized. */
68         struct rte_ring *ring;
69
70         /** Maximum Transfer Unit (MTU). Maximum IP packet size (in bytes). */
71         uint32_t mtu;
72
73         /** Size of application dependent meta-data stored per each input packet
74             that has to be copied to each of the fragments originating from the
75             same input IP datagram. */
76         uint32_t metadata_size;
77
78         /** Pre-initialized buffer pool used for allocating direct buffers for
79             the output fragments. */
80         struct rte_mempool *pool_direct;
81
82         /** Pre-initialized buffer pool used for allocating indirect buffers for
83             the output fragments. */
84         struct rte_mempool *pool_indirect;
85 };
86
87 #define rte_port_ring_reader_ipv4_frag_params rte_port_ring_reader_frag_params
88
89 #define rte_port_ring_reader_ipv6_frag_params rte_port_ring_reader_frag_params
90
91 /** ring_reader_ipv4_frag port operations */
92 extern struct rte_port_in_ops rte_port_ring_reader_ipv4_frag_ops;
93
94 /** ring_reader_ipv6_frag port operations */
95 extern struct rte_port_in_ops rte_port_ring_reader_ipv6_frag_ops;
96
97 #ifdef __cplusplus
98 }
99 #endif
100
101 #endif