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_BULK,
  67         PIPELINE_FIREWALL_MSG_REQ_DEL_BULK,
  68         PIPELINE_FIREWALL_MSG_REQ_ADD_DEFAULT,
  69         PIPELINE_FIREWALL_MSG_REQ_DEL_DEFAULT,
  70         PIPELINE_FIREWALL_MSG_REQS
  71 };
  72
  73 /*
  74  * MSG ADD
  75  */
  76 struct pipeline_firewall_add_msg_req {
  77         enum pipeline_msg_req_type type;
  78         enum pipeline_firewall_msg_req_type subtype;
  79
  80         /* key */
  81         struct pipeline_firewall_key key;
  82
  83         /* data */
  84         int32_t priority;
  85         uint32_t port_id;
  86 };
  87
  88 struct pipeline_firewall_add_msg_rsp {
  89         int status;
  90         int key_found;
  91         void *entry_ptr;
  92 };
  93
  94 /*
  95  * MSG DEL
  96  */
  97 struct pipeline_firewall_del_msg_req {
  98         enum pipeline_msg_req_type type;
  99         enum pipeline_firewall_msg_req_type subtype;
 100
 101         /* key */
 102         struct pipeline_firewall_key key;
 103 };
 104
 105 struct pipeline_firewall_del_msg_rsp {
 106         int status;
 107         int key_found;
 108 };
 109
 110 /*
 111  * MSG ADD BULK
 112  */
 113 struct pipeline_firewall_add_bulk_msg_req {
 114         enum pipeline_msg_req_type type;
 115         enum pipeline_firewall_msg_req_type subtype;
 116
 117         struct pipeline_firewall_key *keys;
 118         uint32_t n_keys;
 119
 120         uint32_t *priorities;
 121         uint32_t *port_ids;
 122         int *keys_found;
 123         void **entries_ptr;
 124 };
 125 struct pipeline_firewall_add_bulk_msg_rsp {
 126         int status;
 127 };
 128
 129 /*
 130  * MSG DEL BULK
 131  */
 132 struct pipeline_firewall_del_bulk_msg_req {
 133         enum pipeline_msg_req_type type;
 134         enum pipeline_firewall_msg_req_type subtype;
 135
 136         /* key */
 137         struct pipeline_firewall_key *keys;
 138         uint32_t n_keys;
 139         int *keys_found;
 140 };
 141
 142 struct pipeline_firewall_del_bulk_msg_rsp {
 143         int status;
 144 };
 145
 146 /*
 147  * MSG ADD DEFAULT
 148  */
 149 struct pipeline_firewall_add_default_msg_req {
 150         enum pipeline_msg_req_type type;
 151         enum pipeline_firewall_msg_req_type subtype;
 152
 153         /* data */
 154         uint32_t port_id;
 155 };
 156
 157 struct pipeline_firewall_add_default_msg_rsp {
 158         int status;
 159         void *entry_ptr;
 160 };
 161
 162 /*
 163  * MSG DEL DEFAULT
 164  */
 165 struct pipeline_firewall_del_default_msg_req {
 166         enum pipeline_msg_req_type type;
 167         enum pipeline_firewall_msg_req_type subtype;
 168 };
 169
 170 struct pipeline_firewall_del_default_msg_rsp {
 171         int status;
 172 };
 173
 174 extern struct pipeline_be_ops pipeline_firewall_be_ops;
 175
 176 #endif