vnet/vnet/ppp/ppp.c

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