xref: /dpdk/examples/ip_pipeline/pipeline.h (revision 0499793854f52d0a42aa39a6b8036700f3719735)
1 /*-
2  *   BSD LICENSE
3  *
4  *   Copyright(c) 2010-2015 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_PIPELINE_H__
35 #define __INCLUDE_PIPELINE_H__
36 
37 #include <cmdline_parse.h>
38 
39 #include "pipeline_be.h"
40 
41 /*
42  * Pipeline type front-end operations
43  */
44 
45 typedef void* (*pipeline_fe_op_init)(struct pipeline_params *params,
46 	void *arg);
47 
48 typedef int (*pipeline_fe_op_post_init)(void *pipeline);
49 
50 typedef int (*pipeline_fe_op_free)(void *pipeline);
51 
52 typedef int (*pipeline_fe_op_track)(struct pipeline_params *params,
53 	uint32_t port_in,
54 	uint32_t *port_out);
55 
56 struct pipeline_fe_ops {
57 	pipeline_fe_op_init f_init;
58 	pipeline_fe_op_post_init f_post_init;
59 	pipeline_fe_op_free f_free;
60 	pipeline_fe_op_track f_track;
61 	cmdline_parse_ctx_t *cmds;
62 };
63 
64 /*
65  * Pipeline type
66  */
67 
68 struct pipeline_type {
69 	const char *name;
70 
71 	/* pipeline back-end */
72 	struct pipeline_be_ops *be_ops;
73 
74 	/* pipeline front-end */
75 	struct pipeline_fe_ops *fe_ops;
76 };
77 
78 static inline uint32_t
79 pipeline_type_cmds_count(struct pipeline_type *ptype)
80 {
81 	cmdline_parse_ctx_t *cmds;
82 	uint32_t n_cmds;
83 
84 	if (ptype->fe_ops == NULL)
85 		return 0;
86 
87 	cmds = ptype->fe_ops->cmds;
88 	if (cmds == NULL)
89 		return 0;
90 
91 	for (n_cmds = 0; cmds[n_cmds]; n_cmds++);
92 
93 	return n_cmds;
94 }
95 
96 int
97 parse_pipeline_core(uint32_t *socket,
98 	uint32_t *core,
99 	uint32_t *ht,
100 	const char *entry);
101 
102 #endif
103