misc: deprecate gbp and its dependents
[vpp.git] / src / vnet / vxlan-gbp / vxlan_gbp_packet.h
diff --git a/src/vnet/vxlan-gbp/vxlan_gbp_packet.h b/src/vnet/vxlan-gbp/vxlan_gbp_packet.h
deleted file mode 100644 (file)
index e655b33..0000000
+++ /dev/null
@@ -1,173 +0,0 @@
-/*
- * Copyright (c) 2018 Cisco and/or its affiliates.
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at:
- *
- *     http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-#ifndef __included_vxlan_gbp_packet_h__
-#define __included_vxlan_gbp_packet_h__ 1
-
-#include <vlib/vlib.h>
-
-/*
- * From draft-smith-vxlan-group-policy-04.txt
- *
- *  0                   1                   2                   3
- *  0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
- * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
- * |G|R|R|R|I|R|R|R|R|D|E|S|A|R|R|R|        Group Policy ID        |
- * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
- * |                VXLAN Network Identifier (VNI) |   Reserved    |
- * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
- *
- * G bit: Bit 0 of the initial word is defined as the G (Group Based
- *   Policy Extension) bit.
- *
- * I bit: where the I flag MUST be set to 1 for a valid
- *   VXLAN Network ID (VNI).
- *
- * D bit: Bit 9 of the initial word is defined as the Don't Learn bit.
- *   When set, this bit indicates that the egress VTEP MUST NOT learn the
- *   source address of the encapsulated frame.
- *
- * E bit: Bit 10 of the initial word is defined as the bounce packet.
- *   When set, this bit indicates that packet is bounced and must be
- *   dropped.
- *
- * S bit: Bit 11 of the initial word is defined as the source policy
- *   applied bit.
- *
- * A bit: Bit 12 of the initial word is defined as the A (Policy
- *   Applied) bit.  This bit is only defined as the A bit when the G bit
- *   is set to 1.
- *
- *    A = 1 indicates that the group policy has already been applied to
- *    this packet.  Policies MUST NOT be applied by devices when the A
- *    bit is set.
- *
- *    A = 0 indicates that the group policy has not been applied to this
- *    packet.  Group policies MUST be applied by devices when the A bit
- *    is set to 0 and the destination Group has been determined.
- *    Devices that apply the Group policy MUST set the A bit to 1 after
- *    the policy has been applied.
- *
- * Group Policy ID: 16 bit identifier that indicates the source TSI
- *   Group membership being encapsulated by VXLAN. Its value is source
- *   class id.
- *
- * FOR INTERNAL USE ONLY
- * R bit: Bit 12 of the initial word is defined as the reflection bit
- *   Set on packet rx checked on tx and dropped if set. this prevents
- *   packets recieved on an iVXLAN tunnel being reflected back to
- *   another.
- */
-
-typedef struct
-{
-  union
-  {
-    struct
-    {
-      union
-      {
-       struct
-       {
-         u8 flag_g_i;
-         u8 gpflags;
-       };
-       u16 flags;
-      };
-      u16 sclass;
-    };
-    u32 flags_sclass_as_u32;
-  };
-  u32 vni_reserved;
-} vxlan_gbp_header_t;
-
-#define foreach_vxlan_gbp_flags    \
-  _ (0x80, G)                      \
-  _ (0x08, I)
-
-typedef enum
-{
-  VXLAN_GBP_FLAGS_NONE = 0,
-#define _(n,f) VXLAN_GBP_FLAGS_##f = n,
-  foreach_vxlan_gbp_flags
-#undef _
-} __attribute__ ((packed)) vxlan_gbp_flags_t;
-
-#define VXLAN_GBP_FLAGS_GI (VXLAN_GBP_FLAGS_G|VXLAN_GBP_FLAGS_I)
-
-#define foreach_vxlan_gbp_gpflags \
-_ (0x40, D)                       \
-_ (0x20, E)                       \
-_ (0x10, S)                       \
-_ (0x08, A)                       \
-_ (0x04, R)
-
-typedef enum
-{
-  VXLAN_GBP_GPFLAGS_NONE = 0,
-#define _(n,f) VXLAN_GBP_GPFLAGS_##f = n,
-  foreach_vxlan_gbp_gpflags
-#undef _
-} __attribute__ ((packed)) vxlan_gbp_gpflags_t;
-
-static inline u32
-vxlan_gbp_get_vni (vxlan_gbp_header_t * h)
-{
-  u32 vni_reserved_host_byte_order;
-
-  vni_reserved_host_byte_order = clib_net_to_host_u32 (h->vni_reserved);
-  return vni_reserved_host_byte_order >> 8;
-}
-
-static inline u16
-vxlan_gbp_get_sclass (vxlan_gbp_header_t * h)
-{
-  u16 sclass_host_byte_order;
-
-  sclass_host_byte_order = clib_net_to_host_u16 (h->sclass);
-  return sclass_host_byte_order;
-}
-
-static inline vxlan_gbp_gpflags_t
-vxlan_gbp_get_gpflags (vxlan_gbp_header_t * h)
-{
-  return h->gpflags;
-}
-
-static inline vxlan_gbp_flags_t
-vxlan_gbp_get_flags (vxlan_gbp_header_t * h)
-{
-  return h->flag_g_i;
-}
-
-static inline void
-vxlan_gbp_set_header (vxlan_gbp_header_t * h, u32 vni)
-{
-  h->vni_reserved = clib_host_to_net_u32 (vni << 8);
-  h->flags_sclass_as_u32 = 0;
-  h->flag_g_i = VXLAN_GBP_FLAGS_I | VXLAN_GBP_FLAGS_G;
-}
-
-extern u8 *format_vxlan_gbp_header_flags (u8 * s, va_list * args);
-extern u8 *format_vxlan_gbp_header_gpflags (u8 * s, va_list * args);
-
-#endif /* __included_vxlan_gbp_packet_h__ */
-
-/*
- * fd.io coding-style-patch-verification: ON
- *
- * Local Variables:
- * eval: (c-set-style "gnu")
- * End:
- */