FD.io VPP  v19.04.4-rc0-5-ge88582fac
Vector Packet Processing
ppp.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  * ppp.h: types/functions for ppp.
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_ppp_h
41 #define included_ppp_h
42 
43 #include <vnet/vnet.h>
44 #include <vnet/ppp/packet.h>
45 #include <vnet/pg/pg.h>
46 
48 
49 typedef enum
50 {
51 #define ppp_error(n,s) PPP_ERROR_##n,
52 #include <vnet/ppp/error.def>
53 #undef ppp_error
55 } ppp_error_t;
56 
57 typedef struct
58 {
59  /* Name (a c string). */
60  char *name;
61 
62  /* PPP protocol type in host byte order. */
64 
65  /* Node which handles this type. */
67 
68  /* Next index for this type. */
71 
72 typedef struct
73 {
75 
77 
78  /* Hash tables mapping name/protocol to protocol info index. */
79  uword *protocol_info_by_name, *protocol_info_by_protocol;
80 } ppp_main_t;
81 
84 {
85  uword *p = hash_get (em->protocol_info_by_protocol, protocol);
86  return p ? vec_elt_at_index (em->protocol_infos, p[0]) : 0;
87 }
88 
89 extern ppp_main_t ppp_main;
90 
91 /* Register given node index to take input for given ppp type. */
92 void
94  ppp_protocol_t protocol, u32 node_index);
95 
99 
100 /* Parse ppp protocol as 0xXXXX or protocol name.
101  In either host or network byte order. */
104 
105 /* Parse ppp header. */
108 
109 always_inline void
110 ppp_setup_node (vlib_main_t * vm, u32 node_index)
111 {
112  vlib_node_t *n = vlib_get_node (vm, node_index);
113  pg_node_t *pn = pg_get_node (node_index);
114 
118 }
119 
120 void
122  ppp_protocol_t protocol, u32 node_index);
123 
124 #endif /* included_ppp_h */
125 
126 /*
127  * fd.io coding-style-patch-verification: ON
128  *
129  * Local Variables:
130  * eval: (c-set-style "gnu")
131  * End:
132  */
unformat_function_t unformat_ppp_header
Definition: ppp.h:106
static void ppp_setup_node(vlib_main_t *vm, u32 node_index)
Definition: ppp.h:110
uword * protocol_info_by_protocol
Definition: ppp.h:79
u32 next_index
Definition: ppp.h:69
unformat_function_t unformat_ppp_protocol_host_byte_order
Definition: ppp.h:102
ppp_protocol_t
Definition: packet.h:150
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
#define always_inline
Definition: clib.h:98
unformat_function_t unformat_pg_ppp_header
Definition: ppp.h:107
format_function_t format_ppp_header
Definition: ppp.h:97
#define vec_elt_at_index(v, i)
Get vector value at index i checking that i is in bounds.
unformat_function_t unformat_ppp_protocol_net_byte_order
Definition: ppp.h:103
unsigned int u32
Definition: types.h:88
#define hash_get(h, key)
Definition: hash.h:249
void ppp_register_input_type(vlib_main_t *vm, ppp_protocol_t protocol, u32 node_index)
void ppp_register_input_protocol(vlib_main_t *vm, ppp_protocol_t protocol, u32 node_index)
Definition: node.c:338
format_function_t * format_buffer
Definition: node.h:356
uword() unformat_function_t(unformat_input_t *input, va_list *args)
Definition: format.h:232
ppp_main_t ppp_main
Definition: ppp.c:44
u32 node_index
Definition: ppp.h:66
static ppp_protocol_info_t * ppp_get_protocol_info(ppp_main_t *em, ppp_protocol_t protocol)
Definition: ppp.h:83
ppp_protocol_info_t * protocol_infos
Definition: ppp.h:76
unformat_function_t * unformat_buffer
Definition: node.h:357
unformat_function_t * unformat_edit
Definition: pg.h:310
ppp_error_t
Definition: ppp.h:49
Definition: ppp.h:72
format_function_t format_ppp_header_with_length
Definition: ppp.h:98
vlib_main_t * vlib_main
Definition: ppp.h:74
ppp_protocol_t protocol
Definition: ppp.h:63
char * name
Definition: ppp.h:60
struct _vnet_hw_interface_class vnet_hw_interface_class_t
u64 uword
Definition: types.h:112
format_function_t format_ppp_protocol
Definition: ppp.h:96
vnet_hw_interface_class_t ppp_hw_interface_class
static vlib_node_t * vlib_get_node(vlib_main_t *vm, u32 i)
Get vlib node by index.
Definition: node_funcs.h:59
Definition: pg.h:307
u8 protocol
Definition: ipsec.api:96