examples/ip_pipeline/pipeline/pipeline_flow_classification.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_FLOW_CLASSIFICATION_H__
  35 #define __INCLUDE_PIPELINE_FLOW_CLASSIFICATION_H__
  36
  37 #include "pipeline.h"
  38 #include "pipeline_flow_classification_be.h"
  39
  40 enum flow_key_type {
  41         FLOW_KEY_QINQ,
  42         FLOW_KEY_IPV4_5TUPLE,
  43         FLOW_KEY_IPV6_5TUPLE,
  44 };
  45
  46 struct flow_key_qinq {
  47         uint16_t svlan;
  48         uint16_t cvlan;
  49 };
  50
  51 struct flow_key_ipv4_5tuple {
  52         uint32_t ip_src;
  53         uint32_t ip_dst;
  54         uint16_t port_src;
  55         uint16_t port_dst;
  56         uint32_t proto;
  57 };
  58
  59 struct flow_key_ipv6_5tuple {
  60         uint8_t ip_src[16];
  61         uint8_t ip_dst[16];
  62         uint16_t port_src;
  63         uint16_t port_dst;
  64         uint32_t proto;
  65 };
  66
  67 struct pipeline_fc_key {
  68         enum flow_key_type type;
  69         union {
  70                 struct flow_key_qinq qinq;
  71                 struct flow_key_ipv4_5tuple ipv4_5tuple;
  72                 struct flow_key_ipv6_5tuple ipv6_5tuple;
  73         } key;
  74 };
  75
  76 int
  77 app_pipeline_fc_add(struct app_params *app,
  78         uint32_t pipeline_id,
  79         struct pipeline_fc_key *key,
  80         uint32_t port_id,
  81         uint32_t flow_id);
  82
  83 int
  84 app_pipeline_fc_add_bulk(struct app_params *app,
  85         uint32_t pipeline_id,
  86         struct pipeline_fc_key *key,
  87         uint32_t *port_id,
  88         uint32_t *flow_id,
  89         uint32_t n_keys);
  90
  91 int
  92 app_pipeline_fc_del(struct app_params *app,
  93         uint32_t pipeline_id,
  94         struct pipeline_fc_key *key);
  95
  96 int
  97 app_pipeline_fc_add_default(struct app_params *app,
  98         uint32_t pipeline_id,
  99         uint32_t port_id);
 100
 101 int
 102 app_pipeline_fc_del_default(struct app_params *app,
 103         uint32_t pipeline_id);
 104
 105 #ifndef APP_PIPELINE_FC_MAX_FLOWS_IN_FILE
 106 #define APP_PIPELINE_FC_MAX_FLOWS_IN_FILE       (16 * 1024 * 1024)
 107 #endif
 108
 109 int
 110 app_pipeline_fc_load_file_qinq(char *filename,
 111         struct pipeline_fc_key *keys,
 112         uint32_t *port_ids,
 113         uint32_t *flow_ids,
 114         uint32_t *n_keys,
 115         uint32_t *line);
 116
 117 int
 118 app_pipeline_fc_load_file_ipv4(char *filename,
 119         struct pipeline_fc_key *keys,
 120         uint32_t *port_ids,
 121         uint32_t *flow_ids,
 122         uint32_t *n_keys,
 123         uint32_t *line);
 124
 125 int
 126 app_pipeline_fc_load_file_ipv6(char *filename,
 127         struct pipeline_fc_key *keys,
 128         uint32_t *port_ids,
 129         uint32_t *flow_ids,
 130         uint32_t *n_keys,
 131         uint32_t *line);
 132
 133 extern struct pipeline_type pipeline_flow_classification;
 134
 135 #endif