FD.io VPP  v19.04.4-rc0-5-ge88582fac
Vector Packet Processing
osi.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  * osi.h: OSI 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_osi_h
41 #define included_osi_h
42 
43 #include <vnet/vnet.h>
44 #include <vnet/pg/pg.h>
45 
46 #define foreach_osi_protocol \
47  _ (null, 0x0) \
48  _ (x_29, 0x01) \
49  _ (x_633, 0x03) \
50  _ (q_931, 0x08) \
51  _ (q_933, 0x08) \
52  _ (q_2931, 0x09) \
53  _ (q_2119, 0x0c) \
54  _ (snap, 0x80) \
55  _ (clnp, 0x81) \
56  _ (esis, 0x82) \
57  _ (isis, 0x83) \
58  _ (idrp, 0x85) \
59  _ (x25_esis, 0x8a) \
60  _ (iso10030, 0x8c) \
61  _ (iso11577, 0x8d) \
62  _ (ip6, 0x8e) \
63  _ (compressed, 0xb0) \
64  _ (sndcf, 0xc1) \
65  _ (ip4, 0xcc) \
66  _ (ppp, 0xcf)
67 
68 typedef enum
69 {
70 #define _(f,n) OSI_PROTOCOL_##f = n,
72 #undef _
74 
75 typedef struct
76 {
78 
79  u8 payload[0];
80 } osi_header_t;
81 
82 typedef struct
83 {
84  /* Name (a c string). */
85  char *name;
86 
87  /* OSI protocol (SAP type). */
89 
90  /* Node which handles this type. */
92 
93  /* Next index for this type. */
96 
97 #define foreach_osi_error \
98  _ (NONE, "no error") \
99  _ (UNKNOWN_PROTOCOL, "unknown osi protocol")
100 
101 typedef enum
102 {
103 #define _(f,s) OSI_ERROR_##f,
105 #undef _
107 } osi_error_t;
108 
109 typedef struct
110 {
112 
114 
115  /* Hash tables mapping name/protocol to protocol info index. */
116  uword *protocol_info_by_name, *protocol_info_by_protocol;
117 
118  /* osi-input next index indexed by protocol. */
119  u8 input_next_by_protocol[256];
120 } osi_main_t;
121 
124 {
125  uword *p = hash_get (m->protocol_info_by_protocol, protocol);
126  return p ? vec_elt_at_index (m->protocol_infos, p[0]) : 0;
127 }
128 
129 extern osi_main_t osi_main;
130 
131 /* Register given node index to take input for given osi type. */
133 
137 
138 /* Parse osi protocol as 0xXXXX or protocol name. */
140 
141 /* Parse osi header. */
144 
145 always_inline void
147 {
148  vlib_node_t *n = vlib_get_node (vm, node_index);
149  pg_node_t *pn = pg_get_node (node_index);
150 
154 }
155 
157 
159 
160 #endif /* included_osi_h */
161 
162 /*
163  * fd.io coding-style-patch-verification: ON
164  *
165  * Local Variables:
166  * eval: (c-set-style "gnu")
167  * End:
168  */
u32 next_index
Definition: osi.h:94
u32 node_index
Definition: osi.h:91
unformat_function_t unformat_osi_header
Definition: osi.h:142
format_function_t format_osi_header_with_length
Definition: osi.h:136
osi_main_t osi_main
Definition: osi.c:44
u8 protocol
Definition: osi.h:77
unformat_function_t unformat_pg_osi_header
Definition: osi.h:143
osi_protocol_t protocol
Definition: osi.h:88
unsigned char u8
Definition: types.h:56
format_function_t format_osi_protocol
Definition: osi.h:134
#define foreach_osi_error
Definition: osi.h:97
static pg_node_t * pg_get_node(uword node_index)
Definition: pg.h:357
u8 *() format_function_t(u8 *s, va_list *args)
Definition: format.h:48
void osi_register_input_protocol(osi_protocol_t protocol, u32 node_index)
Definition: node.c:301
#define foreach_osi_protocol
Definition: osi.h:46
#define always_inline
Definition: clib.h:98
char * name
Definition: osi.h:85
#define vec_elt_at_index(v, i)
Get vector value at index i checking that i is in bounds.
unsigned int u32
Definition: types.h:88
osi_protocol_t
Definition: osi.h:68
vlib_main_t * vlib_main
Definition: osi.h:111
unformat_function_t unformat_osi_protocol
Definition: osi.h:139
#define hash_get(h, key)
Definition: hash.h:249
osi_error_t
Definition: osi.h:101
osi_protocol_info_t * protocol_infos
Definition: osi.h:113
static osi_protocol_info_t * osi_get_protocol_info(osi_main_t *m, osi_protocol_t protocol)
Definition: osi.h:123
static void osi_setup_node(vlib_main_t *vm, u32 node_index)
Definition: osi.h:146
format_function_t * format_buffer
Definition: node.h:356
uword() unformat_function_t(unformat_input_t *input, va_list *args)
Definition: format.h:232
vlib_main_t * vm
Definition: buffer.c:312
unformat_function_t * unformat_buffer
Definition: node.h:357
unformat_function_t * unformat_edit
Definition: pg.h:310
u64 uword
Definition: types.h:112
static vlib_node_t * vlib_get_node(vlib_main_t *vm, u32 i)
Get vlib node by index.
Definition: node_funcs.h:59
format_function_t format_osi_header
Definition: osi.h:135
Definition: pg.h:307
u8 protocol
Definition: ipsec.api:96
uword * protocol_info_by_protocol
Definition: osi.h:116