vlib: move pci api types from vnet/pci to vlib/pci
[vpp.git] / src / vnet / snap / snap.h
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  * snap.h: SNAP definitions
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_snap_h
41 #define included_snap_h
42
43 #include <vnet/vnet.h>
44 #include <vnet/pg/pg.h>
45
46 #define foreach_ieee_oui                        \
47   _ (0x000000, ethernet)                        \
48   _ (0x00000c, cisco)
49
50 typedef enum
51 {
52 #define _(n,f) IEEE_OUI_##f = n,
53   foreach_ieee_oui
54 #undef _
55 } ieee_oui_t;
56
57 #define foreach_snap_cisco_protocol             \
58   _ (0x0102, drip)                              \
59   _ (0x0104, port_aggregation_protocol)         \
60   _ (0x0105, mls_hello)                         \
61   _ (0x010b, per_vlan_spanning_tree)            \
62   _ (0x010c, vlan_bridge)                       \
63   _ (0x0111, unidirectional_link_detection)     \
64   _ (0x2000, cdp)                               \
65   _ (0x2001, cgmp)                              \
66   _ (0x2003, vtp)                               \
67   _ (0x2004, dtp)                               \
68   _ (0x200a, stp_uplink_fast)
69
70 typedef enum
71 {
72 #define _(n,f) SNAP_cisco_##f = n,
73   foreach_snap_cisco_protocol
74 #undef _
75 } snap_cisco_protocol_t;
76
77 typedef union
78 {
79   /* *INDENT-OFF* */
80   CLIB_PACKED (struct {
81     /* OUI: organization unique identifier. */
82     u8 oui[3];
83
84     /* Per-OUI protocol. */
85     u16 protocol;
86   });
87   /* *INDENT-ON* */
88
89   u8 as_u8[5];
90 } snap_header_t;
91
92 typedef struct
93 {
94   u32 oui;
95   u32 protocol;
96 } snap_oui_and_protocol_t;
97
98 typedef struct
99 {
100   /* Name vector string. */
101   u8 *name;
102
103   snap_oui_and_protocol_t oui_and_protocol;
104
105   /* Node which handles this type. */
106   u32 node_index;
107
108   /* snap-input next index for this type. */
109   u32 next_index;
110 } snap_protocol_info_t;
111
112 always_inline void
113 snap_header_set_protocol (snap_header_t * h, snap_oui_and_protocol_t * p)
114 {
115   u16 protocol = p->protocol;
116   u32 oui = p->oui;
117   h->protocol = clib_host_to_net_u16 (protocol);
118   h->oui[0] = (oui >> 16) & 0xff;
119   h->oui[1] = (oui >> 8) & 0xff;
120   h->oui[2] = (oui >> 0) & 0xff;
121 }
122
123 #define foreach_snap_error                      \
124   _ (NONE, "no error")                          \
125   _ (UNKNOWN_PROTOCOL, "unknown oui/snap protocol")
126
127 typedef enum
128 {
129 #define _(f,s) SNAP_ERROR_##f,
130   foreach_snap_error
131 #undef _
132     SNAP_N_ERROR,
133 } snap_error_t;
134
135 typedef struct
136 {
137   vlib_main_t *vlib_main;
138
139   /* Vector of known SNAP oui/protocol pairs. */
140   snap_protocol_info_t *protocols;
141
142   /* Hash table mapping oui/protocol to protocol index. */
143   mhash_t protocol_hash;
144
145   /* Hash table mapping protocol by name. */
146   uword *protocol_info_by_name;
147 } snap_main_t;
148
149 always_inline u32
150 snap_header_get_oui (snap_header_t * h)
151 {
152   return (h->oui[0] << 16) | (h->oui[1] << 8) | h->oui[2];
153 }
154
155 always_inline snap_protocol_info_t *
156 snap_get_protocol_info (snap_main_t * sm, snap_header_t * h)
157 {
158   snap_oui_and_protocol_t key;
159   uword *p;
160
161   key.oui = snap_header_get_oui (h);
162   key.protocol = h->protocol;
163
164   p = mhash_get (&sm->protocol_hash, &key);
165   return p ? vec_elt_at_index (sm->protocols, p[0]) : 0;
166 }
167
168 extern snap_main_t snap_main;
169
170 /* Register given node index to take input for given snap type. */
171 void
172 snap_register_input_protocol (vlib_main_t * vm,
173                               char *name,
174                               u32 ieee_oui, u16 protocol, u32 node_index);
175
176 format_function_t format_snap_protocol;
177 format_function_t format_snap_header;
178 format_function_t format_snap_header_with_length;
179
180 /* Parse snap protocol as 0xXXXX or protocol name. */
181 unformat_function_t unformat_snap_protocol;
182
183 /* Parse snap header. */
184 unformat_function_t unformat_snap_header;
185 unformat_function_t unformat_pg_snap_header;
186
187 always_inline void
188 snap_setup_node (vlib_main_t * vm, u32 node_index)
189 {
190   vlib_node_t *n = vlib_get_node (vm, node_index);
191   pg_node_t *pn = pg_get_node (node_index);
192
193   n->format_buffer = format_snap_header_with_length;
194   n->unformat_buffer = unformat_snap_header;
195   pn->unformat_edit = unformat_pg_snap_header;
196 }
197
198 #endif /* included_snap_h */
199
200 /*
201  * fd.io coding-style-patch-verification: ON
202  *
203  * Local Variables:
204  * eval: (c-set-style "gnu")
205  * End:
206  */