include/net/erspan.h

   1 #ifndef __LINUX_ERSPAN_H
   2 #define __LINUX_ERSPAN_H
   3
   4 /*
   5  * GRE header for ERSPAN encapsulation (8 octets [34:41]) -- 8 bytes
   6  *       0                   1                   2                   3
   7  *      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
   8  *     +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
   9  *     |0|0|0|1|0|00000|000000000|00000|    Protocol Type for ERSPAN   |
  10  *     +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  11  *     |      Sequence Number (increments per packet per session)      |
  12  *     +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  13  *
  14  *  Note that in the above GRE header [RFC1701] out of the C, R, K, S,
  15  *  s, Recur, Flags, Version fields only S (bit 03) is set to 1. The
  16  *  other fields are set to zero, so only a sequence number follows.
  17  *
  18  *  ERSPAN Version 1 (Type II) header (8 octets [42:49])
  19  *  0                   1                   2                   3
  20  *  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
  21  * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  22  * |  Ver  |          VLAN         | COS | En|T|    Session ID     |
  23  * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  24  * |      Reserved         |                  Index                |
  25  * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  26  *
  27  *
  28  *  ERSPAN Version 2 (Type III) header (12 octets [42:49])
  29  *  0                   1                   2                   3
  30  *  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
  31  * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  32  * |  Ver  |          VLAN         | COS |BSO|T|     Session ID    |
  33  * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  34  * |                          Timestamp                            |
  35  * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  36  * |             SGT               |P|    FT   |   Hw ID   |D|Gra|O|
  37  * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  38  *
  39  *      Platform Specific SubHeader (8 octets, optional)
  40  * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  41  * |  Platf ID |               Platform Specific Info              |
  42  * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  43  * |                  Platform Specific Info                       |
  44  * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  45  *
  46  * GRE proto ERSPAN type II = 0x88BE, type III = 0x22EB
  47  */
  48
  49 #define ERSPAN_VERSION  0x1     /* ERSPAN type II */
  50 #define VER_MASK        0xf000
  51 #define VLAN_MASK       0x0fff
  52 #define COS_MASK        0xe000
  53 #define EN_MASK         0x1800
  54 #define T_MASK          0x0400
  55 #define ID_MASK         0x03ff
  56 #define INDEX_MASK      0xfffff
  57
  58 #define ERSPAN_VERSION2 0x2     /* ERSPAN type III*/
  59 #define BSO_MASK        EN_MASK
  60 #define SGT_MASK        0xffff0000
  61 #define P_MASK          0x8000
  62 #define FT_MASK         0x7c00
  63 #define HWID_MASK       0x03f0
  64 #define DIR_MASK        0x0008
  65 #define GRA_MASK        0x0006
  66 #define O_MASK          0x0001
  67
  68 #define HWID_OFFSET    4
  69 #define DIR_OFFSET     3
  70
  71 /* ERSPAN version 2 metadata header */
  72 struct erspan_md2 {
  73         __be32 timestamp;
  74         __be16 sgt;     /* security group tag */
  75 #if defined(__LITTLE_ENDIAN_BITFIELD)
  76         __u8    hwid_upper:2,
  77                 ft:5,
  78                 p:1;
  79         __u8    o:1,
  80                 gra:2,
  81                 dir:1,
  82                 hwid:4;
  83 #elif defined(__BIG_ENDIAN_BITFIELD)
  84         __u8    p:1,
  85                 ft:5,
  86                 hwid_upper:2;
  87         __u8    hwid:4,
  88                 dir:1,
  89                 gra:2,
  90                 o:1;
  91 #endif
  92 };
  93
  94 enum erspan_encap_type {
  95         ERSPAN_ENCAP_NOVLAN = 0x0,      /* originally without VLAN tag */
  96         ERSPAN_ENCAP_ISL = 0x1,         /* originally ISL encapsulated */
  97         ERSPAN_ENCAP_8021Q = 0x2,       /* originally 802.1Q encapsulated */
  98         ERSPAN_ENCAP_INFRAME = 0x3,     /* VLAN tag perserved in frame */
  99 };
 100
 101 #define ERSPAN_V1_MDSIZE        4
 102 #define ERSPAN_V2_MDSIZE        8
 103 struct erspan_metadata {
 104         union {
 105                 __be32 index;           /* Version 1 (type II)*/
 106                 struct erspan_md2 md2;  /* Version 2 (type III) */
 107         } u;
 108         int version;
 109 };
 110
 111 struct erspan_base_hdr {
 112 #if defined(__LITTLE_ENDIAN_BITFIELD)
 113         __u8    vlan_upper:4,
 114                 ver:4;
 115         __u8    vlan:8;
 116         __u8    session_id_upper:2,
 117                 t:1,
 118                 en:2,
 119                 cos:3;
 120         __u8    session_id:8;
 121 #elif defined(__BIG_ENDIAN_BITFIELD)
 122         __u8    ver: 4,
 123                 vlan_upper:4;
 124         __u8    vlan:8;
 125         __u8    cos:3,
 126                 en:2,
 127                 t:1,
 128                 session_id_upper:2;
 129         __u8    session_id:8;
 130 #else
 131 #error "Please fix <asm/byteorder.h>"
 132 #endif
 133 };
 134
 135 static inline void set_session_id(struct erspan_base_hdr *ershdr, u16 id)
 136 {
 137         ershdr->session_id = id & 0xff;
 138         ershdr->session_id_upper = (id >> 8) & 0x3;
 139 }
 140
 141 static inline u16 get_session_id(const struct erspan_base_hdr *ershdr)
 142 {
 143         return (ershdr->session_id_upper << 8) + ershdr->session_id;
 144 }
 145
 146 static inline void set_vlan(struct erspan_base_hdr *ershdr, u16 vlan)
 147 {
 148         ershdr->vlan = vlan & 0xff;
 149         ershdr->vlan_upper = (vlan >> 8) & 0xf;
 150 }
 151
 152 static inline u16 get_vlan(const struct erspan_base_hdr *ershdr)
 153 {
 154         return (ershdr->vlan_upper << 8) + ershdr->vlan;
 155 }
 156
 157 static inline void set_hwid(struct erspan_md2 *md2, u8 hwid)
 158 {
 159         md2->hwid = hwid & 0xf;
 160         md2->hwid_upper = (hwid >> 4) & 0x3;
 161 }
 162
 163 static inline u8 get_hwid(const struct erspan_md2 *md2)
 164 {
 165         return (md2->hwid_upper << 4) + md2->hwid;
 166 }
 167
 168 static inline int erspan_hdr_len(int version)
 169 {
 170         return sizeof(struct erspan_base_hdr) +
 171                (version == 1 ? ERSPAN_V1_MDSIZE : ERSPAN_V2_MDSIZE);
 172 }
 173
 174 static inline u8 tos_to_cos(u8 tos)
 175 {
 176         u8 dscp, cos;
 177
 178         dscp = tos >> 2;
 179         cos = dscp >> 3;
 180         return cos;
 181 }
 182
 183 static inline void erspan_build_header(struct sk_buff *skb,
 184                                 u32 id, u32 index,
 185                                 bool truncate, bool is_ipv4)
 186 {
 187         struct ethhdr *eth = (struct ethhdr *)skb->data;
 188         enum erspan_encap_type enc_type;
 189         struct erspan_base_hdr *ershdr;
 190         struct erspan_metadata *ersmd;
 191         struct qtag_prefix {
 192                 __be16 eth_type;
 193                 __be16 tci;
 194         } *qp;
 195         u16 vlan_tci = 0;
 196         u8 tos;
 197
 198         tos = is_ipv4 ? ip_hdr(skb)->tos :
 199                         (ipv6_hdr(skb)->priority << 4) +
 200                         (ipv6_hdr(skb)->flow_lbl[0] >> 4);
 201
 202         enc_type = ERSPAN_ENCAP_NOVLAN;
 203
 204         /* If mirrored packet has vlan tag, extract tci and
 205          *  perserve vlan header in the mirrored frame.
 206          */
 207         if (eth->h_proto == htons(ETH_P_8021Q)) {
 208                 qp = (struct qtag_prefix *)(skb->data + 2 * ETH_ALEN);
 209                 vlan_tci = ntohs(qp->tci);
 210                 enc_type = ERSPAN_ENCAP_INFRAME;
 211         }
 212
 213         skb_push(skb, sizeof(*ershdr) + ERSPAN_V1_MDSIZE);
 214         ershdr = (struct erspan_base_hdr *)skb->data;
 215         memset(ershdr, 0, sizeof(*ershdr) + ERSPAN_V1_MDSIZE);
 216
 217         /* Build base header */
 218         ershdr->ver = ERSPAN_VERSION;
 219         ershdr->cos = tos_to_cos(tos);
 220         ershdr->en = enc_type;
 221         ershdr->t = truncate;
 222         set_vlan(ershdr, vlan_tci);
 223         set_session_id(ershdr, id);
 224
 225         /* Build metadata */
 226         ersmd = (struct erspan_metadata *)(ershdr + 1);
 227         ersmd->u.index = htonl(index & INDEX_MASK);
 228 }
 229
 230 /* ERSPAN GRA: timestamp granularity
 231  *   00b --> granularity = 100 microseconds
 232  *   01b --> granularity = 100 nanoseconds
 233  *   10b --> granularity = IEEE 1588
 234  * Here we only support 100 microseconds.
 235  */
 236 static inline __be32 erspan_get_timestamp(void)
 237 {
 238         u64 h_usecs;
 239         ktime_t kt;
 240
 241         kt = ktime_get_real();
 242         h_usecs = ktime_divns(kt, 100 * NSEC_PER_USEC);
 243
 244         /* ERSPAN base header only has 32-bit,
 245          * so it wraps around 4 days.
 246          */
 247         return htonl((u32)h_usecs);
 248 }
 249
 250 static inline void erspan_build_header_v2(struct sk_buff *skb,
 251                                           u32 id, u8 direction, u16 hwid,
 252                                           bool truncate, bool is_ipv4)
 253 {
 254         struct ethhdr *eth = (struct ethhdr *)skb->data;
 255         struct erspan_base_hdr *ershdr;
 256         struct erspan_metadata *md;
 257         struct qtag_prefix {
 258                 __be16 eth_type;
 259                 __be16 tci;
 260         } *qp;
 261         u16 vlan_tci = 0;
 262         u8 gra = 0; /* 100 usec */
 263         u8 bso = 0; /* Bad/Short/Oversized */
 264         u8 sgt = 0;
 265         u8 tos;
 266
 267         tos = is_ipv4 ? ip_hdr(skb)->tos :
 268                         (ipv6_hdr(skb)->priority << 4) +
 269                         (ipv6_hdr(skb)->flow_lbl[0] >> 4);
 270
 271         /* Unlike v1, v2 does not have En field,
 272          * so only extract vlan tci field.
 273          */
 274         if (eth->h_proto == htons(ETH_P_8021Q)) {
 275                 qp = (struct qtag_prefix *)(skb->data + 2 * ETH_ALEN);
 276                 vlan_tci = ntohs(qp->tci);
 277         }
 278
 279         skb_push(skb, sizeof(*ershdr) + ERSPAN_V2_MDSIZE);
 280         ershdr = (struct erspan_base_hdr *)skb->data;
 281         memset(ershdr, 0, sizeof(*ershdr) + ERSPAN_V2_MDSIZE);
 282
 283         /* Build base header */
 284         ershdr->ver = ERSPAN_VERSION2;
 285         ershdr->cos = tos_to_cos(tos);
 286         ershdr->en = bso;
 287         ershdr->t = truncate;
 288         set_vlan(ershdr, vlan_tci);
 289         set_session_id(ershdr, id);
 290
 291         /* Build metadata */
 292         md = (struct erspan_metadata *)(ershdr + 1);
 293         md->u.md2.timestamp = erspan_get_timestamp();
 294         md->u.md2.sgt = htons(sgt);
 295         md->u.md2.p = 1;
 296         md->u.md2.ft = 0;
 297         md->u.md2.dir = direction;
 298         md->u.md2.gra = gra;
 299         md->u.md2.o = 0;
 300         set_hwid(&md->u.md2, hwid);
 301 }
 302
 303 #endif