src/vnet/ip/ip4_format.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  * ip/ip4_format.c: ip4 formatting
  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 #include <vnet/ip/ip.h>
  41
  42 /* Format an IP4 address. */
  43 u8 *
  44 format_ip4_address (u8 * s, va_list * args)
  45 {
  46   u8 *a = va_arg (*args, u8 *);
  47   return format (s, "%d.%d.%d.%d", a[0], a[1], a[2], a[3]);
  48 }
  49
  50 /* Format an IP4 route destination and length. */
  51 u8 *
  52 format_ip4_address_and_length (u8 * s, va_list * args)
  53 {
  54   u8 *a = va_arg (*args, u8 *);
  55   u8 l = va_arg (*args, u32);
  56   return format (s, "%U/%d", format_ip4_address, a, l);
  57 }
  58
  59 u8 *
  60 format_ip4_address_and_mask (u8 * s, va_list * args)
  61 {
  62   ip4_address_and_mask_t *am = va_arg (*args, ip4_address_and_mask_t *);
  63
  64   if (am->addr.as_u32 == 0 && am->mask.as_u32 == 0)
  65     return format (s, "any");
  66
  67   if (am->mask.as_u32 == ~0)
  68     return format (s, "%U", format_ip4_address, &am->addr);
  69
  70   return format (s, "%U/%U", format_ip4_address, &am->addr,
  71                  format_ip4_address, &am->mask);
  72 }
  73
  74 /* Parse an IP4 address %d.%d.%d.%d. */
  75 uword
  76 unformat_ip4_address (unformat_input_t * input, va_list * args)
  77 {
  78   u8 *result = va_arg (*args, u8 *);
  79   unsigned a[4];
  80
  81   if (!unformat (input, "%d.%d.%d.%d", &a[0], &a[1], &a[2], &a[3]))
  82     return 0;
  83
  84   if (a[0] >= 256 || a[1] >= 256 || a[2] >= 256 || a[3] >= 256)
  85     return 0;
  86
  87   result[0] = a[0];
  88   result[1] = a[1];
  89   result[2] = a[2];
  90   result[3] = a[3];
  91
  92   return 1;
  93 }
  94
  95 uword
  96 unformat_ip4_address_and_mask (unformat_input_t * input, va_list * args)
  97 {
  98   ip4_address_and_mask_t *am = va_arg (*args, ip4_address_and_mask_t *);
  99   u32 addr = 0, mask = 0;
 100
 101   if (unformat (input, "any"))
 102     ;
 103   else if (unformat (input, "%U/%U", unformat_ip4_address, &addr,
 104                      unformat_ip4_address, &mask))
 105     ;
 106   else if (unformat (input, "%U", unformat_ip4_address, &addr))
 107     mask = ~0;
 108   else
 109     return 0;
 110
 111   am->addr.as_u32 = addr;
 112   am->mask.as_u32 = mask;
 113   return 1;
 114 }
 115
 116 /* Format an IP4 header. */
 117 u8 *
 118 format_ip4_header (u8 * s, va_list * args)
 119 {
 120   ip4_header_t *ip = va_arg (*args, ip4_header_t *);
 121   u32 max_header_bytes = va_arg (*args, u32);
 122   u32 ip_version, header_bytes;
 123   u32 indent;
 124
 125   /* Nothing to do. */
 126   if (max_header_bytes < sizeof (ip[0]))
 127     return format (s, "IP header truncated");
 128
 129   indent = format_get_indent (s);
 130   indent += 2;
 131
 132   ip_version = (ip->ip_version_and_header_length >> 4);
 133   header_bytes = (ip->ip_version_and_header_length & 0xf) * sizeof (u32);
 134
 135   s = format (s, "%U: %U -> %U",
 136               format_ip_protocol, ip->protocol,
 137               format_ip4_address, ip->src_address.data,
 138               format_ip4_address, ip->dst_address.data);
 139
 140   /* Show IP version and header length only with unexpected values. */
 141   if (ip_version != 4 || header_bytes != sizeof (ip4_header_t))
 142     s = format (s, "\n%Uversion %d, header length %d",
 143                 format_white_space, indent, ip_version, header_bytes);
 144
 145   s = format (s, "\n%Utos 0x%02x, ttl %d, length %d, checksum 0x%04x",
 146               format_white_space, indent,
 147               ip->tos, ip->ttl,
 148               clib_net_to_host_u16 (ip->length),
 149               clib_net_to_host_u16 (ip->checksum));
 150
 151   /* Check and report invalid checksums. */
 152   {
 153     u16 c = ip4_header_checksum (ip);
 154     if (c != ip->checksum)
 155       s = format (s, " (should be 0x%04x)", clib_net_to_host_u16 (c));
 156   }
 157
 158   s = format (s, " dscp %U ecn %U",
 159               format_ip_dscp, ip4_header_get_dscp (ip),
 160               format_ip_ecn, ip4_header_get_ecn (ip));
 161
 162   {
 163     u32 f = clib_net_to_host_u16 (ip->flags_and_fragment_offset);
 164     u32 o;
 165
 166     s = format (s, "\n%Ufragment id 0x%04x",
 167                 format_white_space, indent,
 168                 clib_net_to_host_u16 (ip->fragment_id));
 169
 170     /* Fragment offset. */
 171     o = 8 * (f & 0x1fff);
 172     f ^= f & 0x1fff;
 173     if (o != 0)
 174       s = format (s, " offset %d", o);
 175
 176     if (f != 0)
 177       {
 178         s = format (s, ", flags ");
 179 #define _(l) if (f & IP4_HEADER_FLAG_##l) s = format (s, #l);
 180         _(MORE_FRAGMENTS);
 181         _(DONT_FRAGMENT);
 182         _(CONGESTION);
 183 #undef _
 184       }
 185     /* Fragment packet but not the first. */
 186     if (o != 0)
 187       return s;
 188   }
 189
 190   /* Recurse into next protocol layer. */
 191   if (max_header_bytes != 0 && header_bytes < max_header_bytes)
 192     {
 193       ip_main_t *im = &ip_main;
 194       ip_protocol_info_t *pi = ip_get_protocol_info (im, ip->protocol);
 195
 196       if (pi && pi->format_header)
 197         s = format (s, "\n%U%U",
 198                     format_white_space, indent - 2, pi->format_header,
 199                     /* next protocol header */ (void *) ip + header_bytes,
 200                     max_header_bytes - header_bytes);
 201     }
 202
 203   return s;
 204 }
 205
 206 /* Parse an IP4 header. */
 207 uword
 208 unformat_ip4_header (unformat_input_t * input, va_list * args)
 209 {
 210   u8 **result = va_arg (*args, u8 **);
 211   ip4_header_t *ip;
 212   int old_length;
 213
 214   /* Allocate space for IP header. */
 215   {
 216     void *p;
 217
 218     old_length = vec_len (*result);
 219     vec_add2 (*result, p, sizeof (ip4_header_t));
 220     ip = p;
 221   }
 222
 223   clib_memset (ip, 0, sizeof (ip[0]));
 224   ip->ip_version_and_header_length = IP4_VERSION_AND_HEADER_LENGTH_NO_OPTIONS;
 225
 226   if (!unformat (input, "%U: %U -> %U",
 227                  unformat_ip_protocol, &ip->protocol,
 228                  unformat_ip4_address, &ip->src_address,
 229                  unformat_ip4_address, &ip->dst_address))
 230     return 0;
 231
 232   /* Parse options. */
 233   while (1)
 234     {
 235       int i, j;
 236
 237       if (unformat (input, "tos %U", unformat_vlib_number, &i))
 238         ip->tos = i;
 239
 240       else if (unformat (input, "ttl %U", unformat_vlib_number, &i))
 241         ip->ttl = i;
 242
 243       else if (unformat (input, "fragment id %U offset %U",
 244                          unformat_vlib_number, &i, unformat_vlib_number, &j))
 245         {
 246           ip->fragment_id = clib_host_to_net_u16 (i);
 247           ip->flags_and_fragment_offset |=
 248             clib_host_to_net_u16 ((i / 8) & 0x1fff);
 249         }
 250
 251       /* Flags. */
 252       else if (unformat (input, "mf") || unformat (input, "MF"))
 253         ip->flags_and_fragment_offset |=
 254           clib_host_to_net_u16 (IP4_HEADER_FLAG_MORE_FRAGMENTS);
 255
 256       else if (unformat (input, "df") || unformat (input, "DF"))
 257         ip->flags_and_fragment_offset |=
 258           clib_host_to_net_u16 (IP4_HEADER_FLAG_DONT_FRAGMENT);
 259
 260       else if (unformat (input, "ce") || unformat (input, "CE"))
 261         ip->flags_and_fragment_offset |=
 262           clib_host_to_net_u16 (IP4_HEADER_FLAG_CONGESTION);
 263
 264       /* Can't parse input: try next protocol level. */
 265       else
 266         break;
 267     }
 268
 269   /* Fill in checksum. */
 270   ip->checksum = ip4_header_checksum (ip);
 271
 272   /* Recurse into next protocol layer. */
 273   {
 274     ip_main_t *im = &ip_main;
 275     ip_protocol_info_t *pi = ip_get_protocol_info (im, ip->protocol);
 276
 277     if (pi && pi->unformat_header)
 278       {
 279         if (!unformat_user (input, pi->unformat_header, result))
 280           return 0;
 281
 282         /* Result may have moved. */
 283         ip = (void *) *result + old_length;
 284       }
 285   }
 286
 287   /* Fill in IP length. */
 288   ip->length = clib_host_to_net_u16 (vec_len (*result) - old_length);
 289
 290   return 1;
 291 }
 292
 293 /*
 294  * fd.io coding-style-patch-verification: ON
 295  *
 296  * Local Variables:
 297  * eval: (c-set-style "gnu")
 298  * End:
 299  */