FD.io VPP  v18.01.2-1-g9b554f3
Vector Packet Processing
packet.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2015 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  * ethernet/packet.h: ethernet packet format.
17  *
18  * Copyright (c) 2008 Eliot Dresselhaus
19  *
20  * Permission is hereby granted, free of charge, to any person obtaining
21  * a copy of this software and associated documentation files (the
22  * "Software"), to deal in the Software without restriction, including
23  * without limitation the rights to use, copy, modify, merge, publish,
24  * distribute, sublicense, and/or sell copies of the Software, and to
25  * permit persons to whom the Software is furnished to do so, subject to
26  * the following conditions:
27  *
28  * The above copyright notice and this permission notice shall be
29  * included in all copies or substantial portions of the Software.
30  *
31  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
32  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
33  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
34  * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
35  * LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
36  * OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
37  * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
38  */
39 
40 #ifndef included_ethernet_packet_h
41 #define included_ethernet_packet_h
42 
43 typedef enum
44 {
45 #define ethernet_type(n,s) ETHERNET_TYPE_##s = n,
46 #include <vnet/ethernet/types.def>
47 #undef ethernet_type
49 
50 typedef struct
51 {
52  /* Source/destination address. */
53  u8 dst_address[6];
54  u8 src_address[6];
55 
56  /* Ethernet type. */
59 
60 #define ETHERNET_ADDRESS_UNICAST 0
61 #define ETHERNET_ADDRESS_MULTICAST 1
62 
63 /* I/G bit: individual (unicast)/group (broadcast/multicast). */
66 {
67  return (a[0] >> 0) & 1;
68 }
69 
72 {
73  return (a[0] >> 1) & 1;
74 }
75 
76 always_inline void
78 {
79  a[0] |= 1 << 1;
80 }
81 
82 /* For VLAN ethernet type. */
83 typedef struct
84 {
85  /* 3 bit priority, 1 bit CFI and 12 bit vlan id. */
87 
88 #define ETHERNET_N_VLAN (1 << 12)
89 
90  /* Inner ethernet type. */
93 
94 
95 /* VLAN with ethertype first and vlan id second */
96 typedef struct
97 {
98  /* vlan type */
100 
101  /* 3 bit priority, 1 bit CFI and 12 bit vlan id. */
104 
105 /* PBB header with B-TAG - backbone VLAN indicator and I-TAG - service encapsulation */
106 typedef struct
107 {
108  /* Backbone source/destination address. */
109  u8 b_dst_address[6];
110  u8 b_src_address[6];
111 
112  /* B-tag */
114  /* 3 bit priority, 1 bit DEI and 12 bit vlan id */
116 
117  /* I-tag */
119  /* 3 bit priority, 1 bit DEI, 1 bit UCA, 3 bit RES and 24 bit I_SID (service identifier) */
121 
122 #define ETHERNET_N_PBB (1 << 24)
124 
125 /* *INDENT-OFF* */
126 typedef CLIB_PACKED (struct
127 {
128  /* Backbone source/destination address. */
129  u8 b_dst_address[6];
130  u8 b_src_address[6];
131 
132  /* B-tag */
133  u16 b_type;
134  /* 3 bit priority, 1 bit DEI and 12 bit vlan id */
135  u16 priority_dei_id;
136 
137  /* I-tag */
138  u16 i_type;
139  /* 3 bit priority, 1 bit DEI, 1 bit UCA, 3 bit RES and 24 bit I_SID (service identifier) */
140  u32 priority_dei_uca_res_sid;
141 }) ethernet_pbb_header_packed_t;
142 /* *INDENT-ON* */
143 
144 #endif /* included_ethernet_packet_h */
145 
146 /*
147  * fd.io coding-style-patch-verification: ON
148  *
149  * Local Variables:
150  * eval: (c-set-style "gnu")
151  * End:
152  */
a
Definition: bitmap.h:516
ethernet_type_t
Definition: packet.h:43
static uword ethernet_address_is_locally_administered(u8 *a)
Definition: packet.h:71
static uword ethernet_address_cast(u8 *a)
Definition: packet.h:65
#define always_inline
Definition: clib.h:92
static void ethernet_address_set_locally_administered(u8 *a)
Definition: packet.h:77
typedef CLIB_PACKED(struct{u8 b_dst_address[6];u8 b_src_address[6];u16 b_type;u16 priority_dei_id;u16 i_type;u32 priority_dei_uca_res_sid;}) ethernet_pbb_header_packed_t
unsigned int u32
Definition: types.h:88
u64 uword
Definition: types.h:112
unsigned short u16
Definition: types.h:57
unsigned char u8
Definition: types.h:56
u32 priority_dei_uca_res_sid
Definition: packet.h:120