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
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
|
/* Copyright (c) 2014, Linaro Limited
* All rights reserved.
*
* SPDX-License-Identifier: BSD-3-Clause
*/
/**
* @file
*
* ODP packet flags
*/
#ifndef ODP_API_PACKET_FLAGS_H_
#define ODP_API_PACKET_FLAGS_H_
#ifdef __cplusplus
extern "C" {
#endif
#include <odp/std_types.h>
#include <odp/packet.h>
/** @addtogroup odp_packet
* Boolean operations on a packet.
* @{
*/
/**
* Check for packet errors
*
* Checks all error flags at once.
*
* @param pkt Packet handle
* @retval non-zero packet has errors
* @retval 0 packet has no errors
*/
int odp_packet_has_error(odp_packet_t pkt);
/**
* Check for L2 header, e.g. ethernet
*
* @param pkt Packet handle
* @retval non-zero if packet contains a valid & known L2 header
* @retval 0 if packet does not contain a valid & known L2 header
*/
int odp_packet_has_l2(odp_packet_t pkt);
/**
* Check for L3 header, e.g. IPv4, IPv6
*
* @param pkt Packet handle
* @retval non-zero if packet contains a valid & known L3 header
* @retval 0 if packet does not contain a valid & known L3 header
*/
int odp_packet_has_l3(odp_packet_t pkt);
/**
* Check for L4 header, e.g. UDP, TCP, SCTP (also ICMP)
*
* @param pkt Packet handle
* @retval non-zero if packet contains a valid & known L4 header
* @retval 0 if packet does not contain a valid & known L4 header
*/
int odp_packet_has_l4(odp_packet_t pkt);
/**
* Check for Ethernet header
*
* @param pkt Packet handle
* @retval non-zero if packet contains a valid eth header
* @retval 0 if packet does not contain a valid & known eth header
*/
int odp_packet_has_eth(odp_packet_t pkt);
/**
* Check for jumbo frame
*
* @param pkt Packet handle
* @retval non-zero if packet contains a jumbo frame
* @retval 0 if packet does not contain a jumbo frame
*/
int odp_packet_has_jumbo(odp_packet_t pkt);
/**
* Check for VLAN
*
* @param pkt Packet handle
* @retval non-zero if packet contains a VLAN header
* @retval 0 if packet does not contain a VLAN header
*/
int odp_packet_has_vlan(odp_packet_t pkt);
/**
* Check for VLAN QinQ (stacked VLAN)
*
* @param pkt Packet handle
* @retval non-zero if packet contains a VLAN QinQ header
* @retval 0 if packet does not contain a VLAN QinQ header
*/
int odp_packet_has_vlan_qinq(odp_packet_t pkt);
/**
* Check for ARP
*
* @param pkt Packet handle
* @retval non-zero if packet contains an ARP message
* @retval 0 if packet does not contain an ARP message
*/
int odp_packet_has_arp(odp_packet_t pkt);
/**
* Check for IPv4
*
* @param pkt Packet handle
* @retval non-zero if packet contains an IPv4 header
* @retval 0 if packet does not contain an IPv4 header
*/
int odp_packet_has_ipv4(odp_packet_t pkt);
/**
* Check for IPv6
*
* @param pkt Packet handle
* @retval non-zero if packet contains an IPv6 header
* @retval 0 if packet does not contain an IPv6 header
*/
int odp_packet_has_ipv6(odp_packet_t pkt);
/**
* Check for IP fragment
*
* @param pkt Packet handle
* @retval non-zero if packet is an IP fragment
* @retval 0 if packet is not an IP fragment
*/
int odp_packet_has_ipfrag(odp_packet_t pkt);
/**
* Check for IP options
*
* @param pkt Packet handle
* @retval non-zero if packet contains IP options
* @retval 0 if packet does not contain IP options
*/
int odp_packet_has_ipopt(odp_packet_t pkt);
/**
* Check for IPSec
*
* @param pkt Packet handle
* @retval non-zero if packet requires IPSec processing
* @retval 0 if packet does not require IPSec processing
*/
int odp_packet_has_ipsec(odp_packet_t pkt);
/**
* Check for UDP
*
* @param pkt Packet handle
* @retval non-zero if packet contains a UDP header
* @retval 0 if packet does not contain a UDP header
*/
int odp_packet_has_udp(odp_packet_t pkt);
/**
* Check for TCP
*
* @param pkt Packet handle
* @retval non-zero if packet contains a TCP header
* @retval 0 if packet does not contain a TCP header
*/
int odp_packet_has_tcp(odp_packet_t pkt);
/**
* Check for SCTP
*
* @param pkt Packet handle
* @retval non-zero if packet contains a SCTP header
* @retval 0 if packet does not contain a SCTP header
*/
int odp_packet_has_sctp(odp_packet_t pkt);
/**
* Check for ICMP
*
* @param pkt Packet handle
* @retval non-zero if packet contains an ICMP header
* @retval 0 if packet does not contain an ICMP header
*/
int odp_packet_has_icmp(odp_packet_t pkt);
/**
* Check for packet flow hash
*
* @param pkt Packet handle
* @retval non-zero if packet contains a hash value
* @retval 0 if packet does not contain a hash value
*/
int odp_packet_has_flow_hash(odp_packet_t pkt);
/**
* Set flag for L2 header, e.g. ethernet
*
* @param pkt Packet handle
* @param val Value
*/
void odp_packet_has_l2_set(odp_packet_t pkt, int val);
/**
* Set flag for L3 header, e.g. IPv4, IPv6
*
* @param pkt Packet handle
* @param val Value
*/
void odp_packet_has_l3_set(odp_packet_t pkt, int val);
/**
* Set flag for L4 header, e.g. UDP, TCP, SCTP (also ICMP)
*
* @param pkt Packet handle
* @param val Value
*/
void odp_packet_has_l4_set(odp_packet_t pkt, int val);
/**
* Set flag for Ethernet header
*
* @param pkt Packet handle
* @param val Value
*/
void odp_packet_has_eth_set(odp_packet_t pkt, int val);
/**
* Set flag for jumbo frame
*
* @param pkt Packet handle
* @param val Value
*/
void odp_packet_has_jumbo_set(odp_packet_t pkt, int val);
/**
* Set flag for VLAN
*
* @param pkt Packet handle
* @param val Value
*/
void odp_packet_has_vlan_set(odp_packet_t pkt, int val);
/**
* Set flag for VLAN QinQ (stacked VLAN)
*
* @param pkt Packet handle
* @param val Value
*/
void odp_packet_has_vlan_qinq_set(odp_packet_t pkt, int val);
/**
* Set flag for ARP
*
* @param pkt Packet handle
* @param val Value
*/
void odp_packet_has_arp_set(odp_packet_t pkt, int val);
/**
* Set flag for IPv4
*
* @param pkt Packet handle
* @param val Value
*/
void odp_packet_has_ipv4_set(odp_packet_t pkt, int val);
/**
* Set flag for IPv6
*
* @param pkt Packet handle
* @param val Value
*/
void odp_packet_has_ipv6_set(odp_packet_t pkt, int val);
/**
* Set flag for IP fragment
*
* @param pkt Packet handle
* @param val Value
*/
void odp_packet_has_ipfrag_set(odp_packet_t pkt, int val);
/**
* Set flag for IP options
*
* @param pkt Packet handle
* @param val Value
*/
void odp_packet_has_ipopt_set(odp_packet_t pkt, int val);
/**
* Set flag for IPSec
*
* @param pkt Packet handle
* @param val Value
*/
void odp_packet_has_ipsec_set(odp_packet_t pkt, int val);
/**
* Set flag for UDP
*
* @param pkt Packet handle
* @param val Value
*/
void odp_packet_has_udp_set(odp_packet_t pkt, int val);
/**
* Set flag for TCP
*
* @param pkt Packet handle
* @param val Value
*/
void odp_packet_has_tcp_set(odp_packet_t pkt, int val);
/**
* Set flag for SCTP
*
* @param pkt Packet handle
* @param val Value
*/
void odp_packet_has_sctp_set(odp_packet_t pkt, int val);
/**
* Set flag for ICMP
*
* @param pkt Packet handle
* @param val Value
*/
void odp_packet_has_icmp_set(odp_packet_t pkt, int val);
/**
* Clear flag for packet flow hash
*
* @param pkt Packet handle
*
* @note Set this flag is only possible through odp_packet_flow_hash_set()
*/
void odp_packet_has_flow_hash_clr(odp_packet_t pkt);
/**
* @}
*/
#ifdef __cplusplus
}
#endif
#endif
|
