apps: add name to LPM parameters
[dpdk.git] / examples / ip_pipeline / pipeline / pipeline_firewall_be.h
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_FIREWALL_BE_H__
35 #define __INCLUDE_PIPELINE_FIREWALL_BE_H__
36
37 #include "pipeline_common_be.h"
38
39 enum pipeline_firewall_key_type {
40         PIPELINE_FIREWALL_IPV4_5TUPLE,
41 };
42
43 struct pipeline_firewall_key_ipv4_5tuple {
44         uint32_t src_ip;
45         uint32_t src_ip_mask;
46         uint32_t dst_ip;
47         uint32_t dst_ip_mask;
48         uint16_t src_port_from;
49         uint16_t src_port_to;
50         uint16_t dst_port_from;
51         uint16_t dst_port_to;
52         uint8_t proto;
53         uint8_t proto_mask;
54 };
55
56 struct pipeline_firewall_key {
57         enum pipeline_firewall_key_type type;
58         union {
59                 struct pipeline_firewall_key_ipv4_5tuple ipv4_5tuple;
60         } key;
61 };
62
63 enum pipeline_firewall_msg_req_type {
64         PIPELINE_FIREWALL_MSG_REQ_ADD = 0,
65         PIPELINE_FIREWALL_MSG_REQ_DEL,
66         PIPELINE_FIREWALL_MSG_REQ_ADD_DEFAULT,
67         PIPELINE_FIREWALL_MSG_REQ_DEL_DEFAULT,
68         PIPELINE_FIREWALL_MSG_REQS
69 };
70
71 /*
72  * MSG ADD
73  */
74 struct pipeline_firewall_add_msg_req {
75         enum pipeline_msg_req_type type;
76         enum pipeline_firewall_msg_req_type subtype;
77
78         /* key */
79         struct pipeline_firewall_key key;
80
81         /* data */
82         int32_t priority;
83         uint32_t port_id;
84 };
85
86 struct pipeline_firewall_add_msg_rsp {
87         int status;
88         int key_found;
89         void *entry_ptr;
90 };
91
92 /*
93  * MSG DEL
94  */
95 struct pipeline_firewall_del_msg_req {
96         enum pipeline_msg_req_type type;
97         enum pipeline_firewall_msg_req_type subtype;
98
99         /* key */
100         struct pipeline_firewall_key key;
101 };
102
103 struct pipeline_firewall_del_msg_rsp {
104         int status;
105         int key_found;
106 };
107
108 /*
109  * MSG ADD DEFAULT
110  */
111 struct pipeline_firewall_add_default_msg_req {
112         enum pipeline_msg_req_type type;
113         enum pipeline_firewall_msg_req_type subtype;
114
115         /* data */
116         uint32_t port_id;
117 };
118
119 struct pipeline_firewall_add_default_msg_rsp {
120         int status;
121         void *entry_ptr;
122 };
123
124 /*
125  * MSG DEL DEFAULT
126  */
127 struct pipeline_firewall_del_default_msg_req {
128         enum pipeline_msg_req_type type;
129         enum pipeline_firewall_msg_req_type subtype;
130 };
131
132 struct pipeline_firewall_del_default_msg_rsp {
133         int status;
134 };
135
136 extern struct pipeline_be_ops pipeline_firewall_be_ops;
137
138 #endif