vnet/vnet/ip/tcp_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/tcp_format.c: tcp 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 static u8 * format_tcp_flags (u8 * s, va_list * args)
  43 {
  44   int flags = va_arg (*args, int);
  45
  46 #define _(f) if (flags & TCP_FLAG_##f) s = format (s, "%s, ", #f);
  47   foreach_tcp_flag
  48 #undef _
  49
  50   return s;
  51 }
  52
  53 /* Format TCP header. */
  54 u8 * format_tcp_header (u8 * s, va_list * args)
  55 {
  56   tcp_header_t * tcp = va_arg (*args, tcp_header_t *);
  57   u32 max_header_bytes = va_arg (*args, u32);
  58   u32 header_bytes;
  59   uword indent;
  60
  61   /* Nothing to do. */
  62   if (max_header_bytes < sizeof (tcp[0]))
  63     return format (s, "TCP header truncated");
  64
  65   indent = format_get_indent (s);
  66   indent += 2;
  67
  68   s = format (s, "TCP: %d -> %d",
  69               clib_net_to_host_u16 (tcp->ports.src),
  70               clib_net_to_host_u16 (tcp->ports.dst));
  71
  72   s = format (s, "\n%Useq. tx 0x%08x rx 0x%08x",
  73               format_white_space, indent,
  74               clib_net_to_host_u32 (tcp->seq_number),
  75               clib_net_to_host_u32 (tcp->ack_number));
  76
  77   s = format (s, "\n%Uflags %U, tcp header: %d bytes",
  78               format_white_space, indent,
  79               format_tcp_flags, tcp->flags,
  80               (tcp->tcp_header_u32s_and_reserved >> 4) * sizeof (u32));
  81
  82   s = format (s, "\n%Uwindow %d, checksum 0x%04x",
  83               format_white_space, indent,
  84               clib_net_to_host_u16 (tcp->window),
  85               clib_net_to_host_u16 (tcp->checksum));
  86
  87   header_bytes = tcp_header_bytes (tcp);
  88
  89   /* Format TCP options. */
  90 #if 0
  91   {
  92     u8 * o;
  93     u8 * option_start = (void *) (tcp + 1);
  94     u8 * option_end = (void *) tcp + header_bytes;
  95
  96     for (o = option_start; o < option_end; )
  97       {
  98         u32 length = o[1];
  99         switch (o[0])
 100           {
 101           case TCP_OPTION_END:
 102             length = 1;
 103             o = option_end;
 104             break;
 105
 106           case TCP_OPTION_NOP:
 107             length = 1;
 108             break;
 109
 110           }
 111       }
 112   }
 113 #endif
 114
 115   /* Recurse into next protocol layer. */
 116   if (max_header_bytes != 0 && header_bytes < max_header_bytes)
 117     {
 118       ip_main_t * im = &ip_main;
 119       tcp_udp_port_info_t * pi;
 120
 121       pi = ip_get_tcp_udp_port_info (im, tcp->ports.dst);
 122
 123       if (pi && pi->format_header)
 124         s = format (s, "\n%U%U",
 125                     format_white_space, indent - 2,
 126                     pi->format_header,
 127                     /* next protocol header */ (void*) tcp + header_bytes,
 128                     max_header_bytes - header_bytes);
 129     }
 130
 131   return s;
 132 }