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.c: ppp support
17 *
18 * Copyright (c) 2010 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#include <vnet/vnet.h>
41#include <vnet/ppp/ppp.h>
42
43/* Global main structure. */
44ppp_main_t ppp_main;
45
46u8 *
47format_ppp_protocol (u8 * s, va_list * args)
48{
49  ppp_protocol_t p = va_arg (*args, u32);
50  ppp_main_t *pm = &ppp_main;
51  ppp_protocol_info_t *pi = ppp_get_protocol_info (pm, p);
52
53  if (pi)
54    s = format (s, "%s", pi->name);
55  else
56    s = format (s, "0x%04x", p);
57
58  return s;
59}
60
61u8 *
62format_ppp_header_with_length (u8 * s, va_list * args)
63{
64  ppp_main_t *pm = &ppp_main;
65  ppp_header_t *h = va_arg (*args, ppp_header_t *);
66  u32 max_header_bytes = va_arg (*args, u32);
67  ppp_protocol_t p = clib_net_to_host_u16 (h->protocol);
68  u32 indent, header_bytes;
69
70  header_bytes = sizeof (h[0]);
71  if (max_header_bytes != 0 && header_bytes > max_header_bytes)
72    return format (s, "ppp header truncated");
73
74  indent = format_get_indent (s);
75
76  s = format (s, "PPP %U", format_ppp_protocol, p);
77
78  if (h->address != 0xff)
79    s = format (s, ", address 0x%02x", h->address);
80  if (h->control != 0x03)
81    s = format (s, ", control 0x%02x", h->control);
82
83  if (max_header_bytes != 0 && header_bytes > max_header_bytes)
84    {
85      ppp_protocol_info_t *pi = ppp_get_protocol_info (pm, p);
86      vlib_node_t *node = vlib_get_node (pm->vlib_main, pi->node_index);
87      if (node->format_buffer)
88	s = format (s, "\n%U%U",
89		    format_white_space, indent,
90		    node->format_buffer, (void *) (h + 1),
91		    max_header_bytes - header_bytes);
92    }
93
94  return s;
95}
96
97u8 *
98format_ppp_header (u8 * s, va_list * args)
99{
100  ppp_header_t *h = va_arg (*args, ppp_header_t *);
101  return format (s, "%U", format_ppp_header_with_length, h, 0);
102}
103
104/* Returns ppp protocol as an int in host byte order. */
105uword
106unformat_ppp_protocol_host_byte_order (unformat_input_t * input,
107				       va_list * args)
108{
109  u16 *result = va_arg (*args, u16 *);
110  ppp_main_t *pm = &ppp_main;
111  int p, i;
112
113  /* Numeric type. */
114  if (unformat (input, "0x%x", &p) || unformat (input, "%d", &p))
115    {
116      if (p >= (1 << 16))
117	return 0;
118      *result = p;
119      return 1;
120    }
121
122  /* Named type. */
123  if (unformat_user (input, unformat_vlib_number_by_name,
124		     pm->protocol_info_by_name, &i))
125    {
126      ppp_protocol_info_t *pi = vec_elt_at_index (pm->protocol_infos, i);
127      *result = pi->protocol;
128      return 1;
129    }
130
131  return 0;
132}
133
134uword
135unformat_ppp_protocol_net_byte_order (unformat_input_t * input,
136				      va_list * args)
137{
138  u16 *result = va_arg (*args, u16 *);
139  if (!unformat_user (input, unformat_ppp_protocol_host_byte_order, result))
140    return 0;
141  *result = clib_host_to_net_u16 ((u16) * result);
142  return 1;
143}
144
145uword
146unformat_ppp_header (unformat_input_t * input, va_list * args)
147{
148  u8 **result = va_arg (*args, u8 **);
149  ppp_header_t _h, *h = &_h;
150  u16 p;
151
152  if (!unformat (input, "%U", unformat_ppp_protocol_host_byte_order, &p))
153    return 0;
154
155  h->address = 0xff;
156  h->control = 0x03;
157  h->protocol = clib_host_to_net_u16 (p);
158
159  /* Add header to result. */
160  {
161    void *p;
162    u32 n_bytes = sizeof (h[0]);
163
164    vec_add2 (*result, p, n_bytes);
165    clib_memcpy (p, h, n_bytes);
166  }
167
168  return 1;
169}
170
171static u8 *
172ppp_build_rewrite (vnet_main_t * vnm,
173		   u32 sw_if_index,
174		   vnet_link_t link_type, const void *dst_hw_address)
175{
176  ppp_header_t *h;
177  u8 *rewrite = NULL;
178  ppp_protocol_t protocol;
179
180  switch (link_type)
181    {
182#define _(a,b) case VNET_LINK_##a: protocol = PPP_PROTOCOL_##b; break
183      _(IP4, ip4);
184      _(IP6, ip6);
185      _(MPLS, mpls_unicast);
186#undef _
187    default:
188      return (NULL);
189    }
190
191  vec_validate (rewrite, sizeof (*h) - 1);
192  h = (ppp_header_t *) rewrite;
193  h->address = 0xff;
194  h->control = 0x03;
195  h->protocol = clib_host_to_net_u16 (protocol);
196
197  return (rewrite);
198}
199
200/* *INDENT-OFF* */
201VNET_HW_INTERFACE_CLASS (ppp_hw_interface_class) = {
202  .name = "PPP",
203  .format_header = format_ppp_header_with_length,
204  .unformat_header = unformat_ppp_header,
205  .build_rewrite = ppp_build_rewrite,
206  .flags = VNET_HW_INTERFACE_CLASS_FLAG_P2P,
207};
208/* *INDENT-ON* */
209
210static void
211add_protocol (ppp_main_t * pm, ppp_protocol_t protocol, char *protocol_name)
212{
213  ppp_protocol_info_t *pi;
214  u32 i;
215
216  vec_add2 (pm->protocol_infos, pi, 1);
217  i = pi - pm->protocol_infos;
218
219  pi->name = protocol_name;
220  pi->protocol = protocol;
221  pi->next_index = pi->node_index = ~0;
222
223  hash_set (pm->protocol_info_by_protocol, protocol, i);
224  hash_set_mem (pm->protocol_info_by_name, pi->name, i);
225}
226
227static clib_error_t *
228ppp_init (vlib_main_t * vm)
229{
230  ppp_main_t *pm = &ppp_main;
231
232  clib_memset (pm, 0, sizeof (pm[0]));
233  pm->vlib_main = vm;
234
235  pm->protocol_info_by_name = hash_create_string (0, sizeof (uword));
236  pm->protocol_info_by_protocol = hash_create (0, sizeof (uword));
237
238#define _(n,s) add_protocol (pm, PPP_PROTOCOL_##s, #s);
239  foreach_ppp_protocol;
240#undef _
241
242  return vlib_call_init_function (vm, ppp_input_init);
243}
244
245VLIB_INIT_FUNCTION (ppp_init);
246
247/*
248 * fd.io coding-style-patch-verification: ON
249 *
250 * Local Variables:
251 * eval: (c-set-style "gnu")
252 * End:
253 */
254