src/plugins/gbp/gbp.h

   1 /*
   2  * Copyright (c) 2018 Cisco and/or its affiliates.
   3  * Licensed under the Apache License, Version 2.0 (the "License");
   4  * you may not use this file except in compliance with the License.
   5  * You may obtain a copy of the License at:
   6  *
   7  *     http://www.apache.org/licenses/LICENSE-2.0
   8  *
   9  * Unless required by applicable law or agreed to in writing, software
  10  * distributed under the License is distributed on an "AS IS" BASIS,
  11  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  12  * See the License for the specific language governing permissions and
  13  * limitations under the License.
  14  */
  15
  16 /**
  17  * Group Base Policy (GBP) defines:
  18  *  - endpoints: typically a VM or container that is connected to the
  19  *               virtual switch/router (i.e. to VPP)
  20  *  - endpoint-group: (EPG) a collection of endpoints
  21  *  - policy: rules determining which traffic can pass between EPGs a.k.a
  22  *            a 'contract'
  23  *
  24  * Here, policy is implemented via an ACL.
  25  * EPG classification for transit packets is determined by:
  26  *  - source EPG: from the packet's input interface
  27  *  - destination EPG: from the packet's destination IP address.
  28  *
  29  */
  30
  31 #ifndef __GBP_H__
  32 #define __GBP_H__
  33
  34 #include <plugins/acl/exports.h>
  35
  36 #include <plugins/gbp/gbp_types.h>
  37 #include <plugins/gbp/gbp_endpoint.h>
  38 #include <plugins/gbp/gbp_endpoint_group.h>
  39 #include <plugins/gbp/gbp_contract.h>
  40 #include <plugins/gbp/gbp_subnet.h>
  41 #include <plugins/gbp/gbp_recirc.h>
  42
  43 typedef struct
  44 {
  45   u32 gbp_acl_user_id;
  46   acl_plugin_methods_t acl_plugin;
  47 } gbp_main_t;
  48
  49 extern gbp_main_t gbp_main;
  50
  51 typedef enum gbp_policy_type_t_
  52 {
  53   GBP_POLICY_PORT,
  54   GBP_POLICY_MAC,
  55   GBP_POLICY_LPM,
  56   GBP_N_POLICY
  57 #define GBP_N_POLICY GBP_N_POLICY
  58 } gbp_policy_type_t;
  59
  60 /**
  61  * Grouping of global data for the GBP source EPG classification feature
  62  */
  63 typedef struct gbp_policy_main_t_
  64 {
  65   /**
  66    * Next nodes for L2 output features
  67    */
  68   u32 l2_output_feat_next[GBP_N_POLICY][32];
  69 } gbp_policy_main_t;
  70
  71 extern gbp_policy_main_t gbp_policy_main;
  72
  73 #endif
  74
  75 /*
  76  * fd.io coding-style-patch-verification: ON
  77  *
  78  * Local Variables:
  79  * eval: (c-set-style "gnu")
  80  * End:
  81  */