aboutsummaryrefslogtreecommitdiffstats
path: root/examples/ip_pipeline/pipeline_be.h
blob: b562472bc1bdb1fe68d4ac3da52d22600761ac3e (plain)
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
/*-
 *   BSD LICENSE
 *
 *   Copyright(c) 2010-2016 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 __INCLUDE_PIPELINE_BE_H__
#define __INCLUDE_PIPELINE_BE_H__

#include <rte_port_ethdev.h>
#include <rte_port_ring.h>
#include <rte_port_frag.h>
#include <rte_port_ras.h>
#include <rte_port_sched.h>
#include <rte_port_source_sink.h>
#ifdef RTE_LIBRTE_KNI
#include <rte_port_kni.h>
#endif
#include <rte_pipeline.h>

enum pipeline_port_in_type {
	PIPELINE_PORT_IN_ETHDEV_READER,
	PIPELINE_PORT_IN_RING_READER,
	PIPELINE_PORT_IN_RING_MULTI_READER,
	PIPELINE_PORT_IN_RING_READER_IPV4_FRAG,
	PIPELINE_PORT_IN_RING_READER_IPV6_FRAG,
	PIPELINE_PORT_IN_SCHED_READER,
	PIPELINE_PORT_IN_KNI_READER,
	PIPELINE_PORT_IN_SOURCE,
};

struct pipeline_port_in_params {
	enum pipeline_port_in_type type;
	union {
		struct rte_port_ethdev_reader_params ethdev;
		struct rte_port_ring_reader_params ring;
		struct rte_port_ring_multi_reader_params ring_multi;
		struct rte_port_ring_reader_ipv4_frag_params ring_ipv4_frag;
		struct rte_port_ring_reader_ipv6_frag_params ring_ipv6_frag;
		struct rte_port_sched_reader_params sched;
#ifdef RTE_LIBRTE_KNI
		struct rte_port_kni_reader_params kni;
#endif
		struct rte_port_source_params source;
	} params;
	uint32_t burst_size;
};

static inline void *
pipeline_port_in_params_convert(struct pipeline_port_in_params  *p)
{
	switch (p->type) {
	case PIPELINE_PORT_IN_ETHDEV_READER:
		return (void *) &p->params.ethdev;
	case PIPELINE_PORT_IN_RING_READER:
		return (void *) &p->params.ring;
	case PIPELINE_PORT_IN_RING_MULTI_READER:
		return (void *) &p->params.ring_multi;
	case PIPELINE_PORT_IN_RING_READER_IPV4_FRAG:
		return (void *) &p->params.ring_ipv4_frag;
	case PIPELINE_PORT_IN_RING_READER_IPV6_FRAG:
		return (void *) &p->params.ring_ipv6_frag;
	case PIPELINE_PORT_IN_SCHED_READER:
		return (void *) &p->params.sched;
#ifdef RTE_LIBRTE_KNI
	case PIPELINE_PORT_IN_KNI_READER:
		return (void *) &p->params.kni;
#endif
	case PIPELINE_PORT_IN_SOURCE:
		return (void *) &p->params.source;
	default:
		return NULL;
	}
}

static inline struct rte_port_in_ops *
pipeline_port_in_params_get_ops(struct pipeline_port_in_params  *p)
{
	switch (p->type) {
	case PIPELINE_PORT_IN_ETHDEV_READER:
		return &rte_port_ethdev_reader_ops;
	case PIPELINE_PORT_IN_RING_READER:
		return &rte_port_ring_reader_ops;
	case PIPELINE_PORT_IN_RING_MULTI_READER:
		return &rte_port_ring_multi_reader_ops;
	case PIPELINE_PORT_IN_RING_READER_IPV4_FRAG:
		return &rte_port_ring_reader_ipv4_frag_ops;
	case PIPELINE_PORT_IN_RING_READER_IPV6_FRAG:
		return &rte_port_ring_reader_ipv6_frag_ops;
	case PIPELINE_PORT_IN_SCHED_READER:
		return &rte_port_sched_reader_ops;
#ifdef RTE_LIBRTE_KNI
	case PIPELINE_PORT_IN_KNI_READER:
		return &rte_port_kni_reader_ops;
#endif
	case PIPELINE_PORT_IN_SOURCE:
		return &rte_port_source_ops;
	default:
		return NULL;
	}
}

enum pipeline_port_out_type {
	PIPELINE_PORT_OUT_ETHDEV_WRITER,
	PIPELINE_PORT_OUT_ETHDEV_WRITER_NODROP,
	PIPELINE_PORT_OUT_RING_WRITER,
	PIPELINE_PORT_OUT_RING_MULTI_WRITER,
	PIPELINE_PORT_OUT_RING_WRITER_NODROP,
	PIPELINE_PORT_OUT_RING_MULTI_WRITER_NODROP,
	PIPELINE_PORT_OUT_RING_WRITER_IPV4_RAS,
	PIPELINE_PORT_OUT_RING_WRITER_IPV6_RAS,
	PIPELINE_PORT_OUT_SCHED_WRITER,
	PIPELINE_PORT_OUT_KNI_WRITER,
	PIPELINE_PORT_OUT_KNI_WRITER_NODROP,
	PIPELINE_PORT_OUT_SINK,
};

struct pipeline_port_out_params {
	enum pipeline_port_out_type type;
	union {
		struct rte_port_ethdev_writer_params ethdev;
		struct rte_port_ethdev_writer_nodrop_params ethdev_nodrop;
		struct rte_port_ring_writer_params ring;
		struct rte_port_ring_multi_writer_params ring_multi;
		struct rte_port_ring_writer_nodrop_params ring_nodrop;
		struct rte_port_ring_multi_writer_nodrop_params ring_multi_nodrop;
		struct rte_port_ring_writer_ipv4_ras_params ring_ipv4_ras;
		struct rte_port_ring_writer_ipv6_ras_params ring_ipv6_ras;
		struct rte_port_sched_writer_params sched;
#ifdef RTE_LIBRTE_KNI
		struct rte_port_kni_writer_params kni;
		struct rte_port_kni_writer_nodrop_params kni_nodrop;
#endif
		struct rte_port_sink_params sink;
	} params;
};

static inline void *
pipeline_port_out_params_convert(struct pipeline_port_out_params  *p)
{
	switch (p->type) {
	case PIPELINE_PORT_OUT_ETHDEV_WRITER:
		return (void *) &p->params.ethdev;
	case PIPELINE_PORT_OUT_ETHDEV_WRITER_NODROP:
		return (void *) &p->params.ethdev_nodrop;
	case PIPELINE_PORT_OUT_RING_WRITER:
		return (void *) &p->params.ring;
	case PIPELINE_PORT_OUT_RING_MULTI_WRITER:
		return (void *) &p->params.ring_multi;
	case PIPELINE_PORT_OUT_RING_WRITER_NODROP:
		return (void *) &p->params.ring_nodrop;
	case PIPELINE_PORT_OUT_RING_MULTI_WRITER_NODROP:
		return (void *) &p->params.ring_multi_nodrop;
	case PIPELINE_PORT_OUT_RING_WRITER_IPV4_RAS:
		return (void *) &p->params.ring_ipv4_ras;
	case PIPELINE_PORT_OUT_RING_WRITER_IPV6_RAS:
		return (void *) &p->params.ring_ipv6_ras;
	case PIPELINE_PORT_OUT_SCHED_WRITER:
		return (void *) &p->params.sched;
#ifdef RTE_LIBRTE_KNI
	case PIPELINE_PORT_OUT_KNI_WRITER:
		return (void *) &p->params.kni;
	case PIPELINE_PORT_OUT_KNI_WRITER_NODROP:
		return (void *) &p->params.kni_nodrop;
#endif
	case PIPELINE_PORT_OUT_SINK:
		return (void *) &p->params.sink;
	default:
		return NULL;
	}
}

static inline void *
pipeline_port_out_params_get_ops(struct pipeline_port_out_params  *p)
{
	switch (p->type) {
	case PIPELINE_PORT_OUT_ETHDEV_WRITER:
		return &rte_port_ethdev_writer_ops;
	case PIPELINE_PORT_OUT_ETHDEV_WRITER_NODROP:
		return &rte_port_ethdev_writer_nodrop_ops;
	case PIPELINE_PORT_OUT_RING_WRITER:
		return &rte_port_ring_writer_ops;
	case PIPELINE_PORT_OUT_RING_MULTI_WRITER:
		return &rte_port_ring_multi_writer_ops;
	case PIPELINE_PORT_OUT_RING_WRITER_NODROP:
		return &rte_port_ring_writer_nodrop_ops;
	case PIPELINE_PORT_OUT_RING_MULTI_WRITER_NODROP:
		return &rte_port_ring_multi_writer_nodrop_ops;
	case PIPELINE_PORT_OUT_RING_WRITER_IPV4_RAS:
		return &rte_port_ring_writer_ipv4_ras_ops;
	case PIPELINE_PORT_OUT_RING_WRITER_IPV6_RAS:
		return &rte_port_ring_writer_ipv6_ras_ops;
	case PIPELINE_PORT_OUT_SCHED_WRITER:
		return &rte_port_sched_writer_ops;
#ifdef RTE_LIBRTE_KNI
	case PIPELINE_PORT_OUT_KNI_WRITER:
		return &rte_port_kni_writer_ops;
	case PIPELINE_PORT_OUT_KNI_WRITER_NODROP:
		return &rte_port_kni_writer_nodrop_ops;
#endif
	case PIPELINE_PORT_OUT_SINK:
		return &rte_port_sink_ops;
	default:
		return NULL;
	}
}

#ifndef PIPELINE_NAME_SIZE
#define PIPELINE_NAME_SIZE                       64
#endif

#ifndef PIPELINE_TYPE_SIZE
#define PIPELINE_TYPE_SIZE                       64
#endif

#ifndef PIPELINE_MAX_PORT_IN
#define PIPELINE_MAX_PORT_IN                     64
#endif

#ifndef PIPELINE_MAX_PORT_OUT
#define PIPELINE_MAX_PORT_OUT                    64
#endif

#ifndef PIPELINE_MAX_TABLES
#define PIPELINE_MAX_TABLES                      16
#endif

#ifndef PIPELINE_MAX_MSGQ_IN
#define PIPELINE_MAX_MSGQ_IN                     16
#endif

#ifndef PIPELINE_MAX_MSGQ_OUT
#define PIPELINE_MAX_MSGQ_OUT                    16
#endif

#ifndef PIPELINE_MAX_ARGS
#define PIPELINE_MAX_ARGS                        64
#endif

struct pipeline_params {
	char name[PIPELINE_NAME_SIZE];
	char type[PIPELINE_TYPE_SIZE];

	struct pipeline_port_in_params port_in[PIPELINE_MAX_PORT_IN];
	struct pipeline_port_out_params port_out[PIPELINE_MAX_PORT_OUT];
	struct rte_ring *msgq_in[PIPELINE_MAX_MSGQ_IN];
	struct rte_ring *msgq_out[PIPELINE_MAX_MSGQ_OUT];

	uint32_t n_ports_in;
	uint32_t n_ports_out;
	uint32_t n_msgq;

	int socket_id;

	char *args_name[PIPELINE_MAX_ARGS];
	char *args_value[PIPELINE_MAX_ARGS];
	uint32_t n_args;

	uint32_t log_level;
};

/*
 * Pipeline type back-end operations
 */

typedef void* (*pipeline_be_op_init)(struct pipeline_params *params,
	void *arg);

typedef int (*pipeline_be_op_free)(void *pipeline);

typedef int (*pipeline_be_op_run)(void *pipeline);

typedef int (*pipeline_be_op_timer)(void *pipeline);

struct pipeline_be_ops {
	pipeline_be_op_init f_init;
	pipeline_be_op_free f_free;
	pipeline_be_op_run f_run;
	pipeline_be_op_timer f_timer;
};

/* Pipeline specific config parse error messages */
#define PIPELINE_ARG_CHECK(exp, fmt, ...)				\
do {									\
	if (!(exp)) {							\
		fprintf(stderr, fmt "\n", ## __VA_ARGS__);		\
		return -1;						\
	}								\
} while (0)

#define PIPELINE_PARSE_ERR_INV_VAL(exp, section, entry, val)		\
PIPELINE_ARG_CHECK(exp, "Parse error in section \"%s\": entry \"%s\" "	\
	"has invalid value (\"%s\")", section, entry, val)

#define PIPELINE_PARSE_ERR_OUT_RNG(exp, section, entry, val)		\
PIPELINE_ARG_CHECK(exp, "Parse error in section \"%s\": entry \"%s\" "	\
	"value is out of range (\"%s\")", section, entry, val)

#define PIPELINE_PARSE_ERR_DUPLICATE(exp, section, entry)		\
PIPELINE_ARG_CHECK(exp, "Parse error in section \"%s\": duplicated "	\
	"entry \"%s\"", section, entry)

#define PIPELINE_PARSE_ERR_INV_ENT(exp, section, entry)			\
PIPELINE_ARG_CHECK(exp, "Parse error in section \"%s\": invalid entry "	\
	"\"%s\"", section, entry)

#define PIPELINE_PARSE_ERR_MANDATORY(exp, section, entry)		\
PIPELINE_ARG_CHECK(exp, "Parse error in section \"%s\": mandatory "	\
	"entry \"%s\" is missing", section, entry)

#endif