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
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
|
/*-
* BSD LICENSE
*
* Copyright(c) 2010-2014 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_REORDER_H_
#define _RTE_REORDER_H_
/**
* @file
* RTE reorder
*
* Reorder library is a component which is designed to
* provide ordering of out of ordered packets based on
* sequence number present in mbuf.
*
*/
#ifdef __cplusplus
extern "C" {
#endif
struct rte_reorder_buffer;
/**
* Create a new reorder buffer instance
*
* Allocate memory and initialize a new reorder buffer in that
* memory, returning the reorder buffer pointer to the user
*
* @param name
* The name to be given to the reorder buffer instance.
* @param socket_id
* The NUMA node on which the memory for the reorder buffer
* instance is to be reserved.
* @param size
* Max number of elements that can be stored in the reorder buffer
* @return
* The initialized reorder buffer instance, or NULL on error
* On error case, rte_errno will be set appropriately:
* - ENOMEM - no appropriate memory area found in which to create memzone
* - EINVAL - invalid parameters
*/
struct rte_reorder_buffer *
rte_reorder_create(const char *name, unsigned socket_id, unsigned int size);
/**
* Initializes given reorder buffer instance
*
* @param b
* Reorder buffer instance to initialize
* @param bufsize
* Size of the reorder buffer
* @param name
* The name to be given to the reorder buffer
* @param size
* Number of elements that can be stored in reorder buffer
* @return
* The initialized reorder buffer instance, or NULL on error
* On error case, rte_errno will be set appropriately:
* - EINVAL - invalid parameters
*/
struct rte_reorder_buffer *
rte_reorder_init(struct rte_reorder_buffer *b, unsigned int bufsize,
const char *name, unsigned int size);
/**
* Find an existing reorder buffer instance
* and return a pointer to it.
*
* @param name
* Name of the reorder buffer instacne as passed to rte_reorder_create()
* @return
* Pointer to reorder buffer instance or NULL if object not found with rte_errno
* set appropriately. Possible rte_errno values include:
* - ENOENT - required entry not available to return.
* reorder instance list
*/
struct rte_reorder_buffer *
rte_reorder_find_existing(const char *name);
/**
* Reset the given reorder buffer instance with initial values.
*
* @param b
* Reorder buffer instance which has to be reset
*/
void
rte_reorder_reset(struct rte_reorder_buffer *b);
/**
* Free reorder buffer instance.
*
* @param b
* reorder buffer instance
* @return
* None
*/
void
rte_reorder_free(struct rte_reorder_buffer *b);
/**
* Insert given mbuf in reorder buffer in its correct position
*
* The given mbuf is to be reordered relative to other mbufs in the system.
* The mbuf must contain a sequence number which is then used to place
* the buffer in the correct position in the reorder buffer. Reordered
* packets can later be taken from the buffer using the rte_reorder_drain()
* API.
*
* @param b
* Reorder buffer where the mbuf has to be inserted.
* @param mbuf
* mbuf of packet that needs to be inserted in reorder buffer.
* @return
* 0 on success
* -1 on error
* On error case, rte_errno will be set appropriately:
* - ENOSPC - Cannot move existing mbufs from reorder buffer to accommodate
* ealry mbuf, but it can be accomodated by performing drain and then insert.
* - ERANGE - Too early or late mbuf which is vastly out of range of expected
* window should be ingnored without any handling.
*/
int
rte_reorder_insert(struct rte_reorder_buffer *b, struct rte_mbuf *mbuf);
/**
* Fetch reordered buffers
*
* Returns a set of in-order buffers from the reorder buffer structure. Gaps
* may be present in the sequence numbers of the mbuf if packets have been
* delayed too long before reaching the reorder window, or have been previously
* dropped by the system.
*
* @param b
* Reorder buffer instance from which packets are to be drained
* @param mbufs
* array of mbufs where reordered packets will be inserted from reorder buffer
* @param max_mbufs
* the number of elements in the mbufs array.
* @return
* number of mbuf pointers written to mbufs. 0 <= N < max_mbufs.
*/
unsigned int
rte_reorder_drain(struct rte_reorder_buffer *b, struct rte_mbuf **mbufs,
unsigned max_mbufs);
#ifdef __cplusplus
}
#endif
#endif /* _RTE_REORDER_H_ */
|
