src/vnet/tcp/tcp_pg.c

   1 /*
   2  * Copyright (c) 2016-2019 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_pg: TCP packet-generator interface
  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 #include <vnet/pg/pg.h>
  42
  43 /* TCP flags bit 0 first. */
  44 #define foreach_tcp_flag                        \
  45   _ (FIN)                                       \
  46   _ (SYN)                                       \
  47   _ (RST)                                       \
  48   _ (PSH)                                       \
  49   _ (ACK)                                       \
  50   _ (URG)                                       \
  51   _ (ECE)                                       \
  52   _ (CWR)
  53
  54 static void
  55 tcp_pg_edit_function (pg_main_t * pg,
  56                       pg_stream_t * s,
  57                       pg_edit_group_t * g, u32 * packets, u32 n_packets)
  58 {
  59   vlib_main_t *vm = vlib_get_main ();
  60   u32 ip_offset, tcp_offset;
  61
  62   tcp_offset = g->start_byte_offset;
  63   ip_offset = (g - 1)->start_byte_offset;
  64
  65   while (n_packets >= 1)
  66     {
  67       vlib_buffer_t *p0;
  68       ip4_header_t *ip0;
  69       tcp_header_t *tcp0;
  70       ip_csum_t sum0;
  71       u32 tcp_len0;
  72
  73       p0 = vlib_get_buffer (vm, packets[0]);
  74       n_packets -= 1;
  75       packets += 1;
  76
  77       ASSERT (p0->current_data == 0);
  78       ip0 = (void *) (p0->data + ip_offset);
  79       tcp0 = (void *) (p0->data + tcp_offset);
  80       /* if IP length has been specified, then calculate the length based on buffer */
  81       if (ip0->length == 0)
  82         tcp_len0 = vlib_buffer_length_in_chain (vm, p0) - tcp_offset;
  83       else
  84         tcp_len0 = clib_net_to_host_u16 (ip0->length) - tcp_offset;
  85
  86       /* Initialize checksum with header. */
  87       if (BITS (sum0) == 32)
  88         {
  89           sum0 = clib_mem_unaligned (&ip0->src_address, u32);
  90           sum0 =
  91             ip_csum_with_carry (sum0,
  92                                 clib_mem_unaligned (&ip0->dst_address, u32));
  93         }
  94       else
  95         sum0 = clib_mem_unaligned (&ip0->src_address, u64);
  96
  97       sum0 = ip_csum_with_carry
  98         (sum0, clib_host_to_net_u32 (tcp_len0 + (ip0->protocol << 16)));
  99
 100       /* Invalidate possibly old checksum. */
 101       tcp0->checksum = 0;
 102
 103       sum0 =
 104         ip_incremental_checksum_buffer (vm, p0, tcp_offset, tcp_len0, sum0);
 105
 106       tcp0->checksum = ~ip_csum_fold (sum0);
 107     }
 108 }
 109
 110 typedef struct
 111 {
 112   pg_edit_t src, dst;
 113   pg_edit_t seq_number, ack_number;
 114   pg_edit_t data_offset_and_reserved;
 115 #define _(f) pg_edit_t f##_flag;
 116     foreach_tcp_flag
 117 #undef _
 118     pg_edit_t window;
 119   pg_edit_t checksum;
 120   pg_edit_t urgent_pointer;
 121 } pg_tcp_header_t;
 122
 123 static inline void
 124 pg_tcp_header_init (pg_tcp_header_t * p)
 125 {
 126   /* Initialize fields that are not bit fields in the IP header. */
 127 #define _(f) pg_edit_init (&p->f, tcp_header_t, f);
 128   _(src);
 129   _(dst);
 130   _(seq_number);
 131   _(ack_number);
 132   _(window);
 133   _(checksum);
 134   _(urgent_pointer);
 135 #undef _
 136
 137   /* Initialize bit fields. */
 138 #define _(f)                                            \
 139   pg_edit_init_bitfield (&p->f##_flag, tcp_header_t,    \
 140                          flags,                         \
 141                          TCP_FLAG_BIT_##f, 1);
 142
 143   foreach_tcp_flag
 144 #undef _
 145     pg_edit_init_bitfield (&p->data_offset_and_reserved, tcp_header_t,
 146                            data_offset_and_reserved, 4, 4);
 147 }
 148
 149 uword
 150 unformat_pg_tcp_header (unformat_input_t * input, va_list * args)
 151 {
 152   pg_stream_t *s = va_arg (*args, pg_stream_t *);
 153   pg_tcp_header_t *p;
 154   u32 group_index;
 155
 156   p = pg_create_edit_group (s, sizeof (p[0]), sizeof (tcp_header_t),
 157                             &group_index);
 158   pg_tcp_header_init (p);
 159
 160   /* Defaults. */
 161   pg_edit_set_fixed (&p->seq_number, 0);
 162   pg_edit_set_fixed (&p->ack_number, 0);
 163
 164   pg_edit_set_fixed (&p->data_offset_and_reserved,
 165                      sizeof (tcp_header_t) / sizeof (u32));
 166
 167   pg_edit_set_fixed (&p->window, 4096);
 168   pg_edit_set_fixed (&p->urgent_pointer, 0);
 169
 170 #define _(f) pg_edit_set_fixed (&p->f##_flag, 0);
 171   foreach_tcp_flag
 172 #undef _
 173     p->checksum.type = PG_EDIT_UNSPECIFIED;
 174
 175   if (!unformat (input, "TCP: %U -> %U",
 176                  unformat_pg_edit,
 177                  unformat_tcp_udp_port, &p->src,
 178                  unformat_pg_edit, unformat_tcp_udp_port, &p->dst))
 179     goto error;
 180
 181   /* Parse options. */
 182   while (1)
 183     {
 184       if (unformat (input, "window %U",
 185                     unformat_pg_edit, unformat_pg_number, &p->window))
 186         ;
 187
 188       else if (unformat (input, "checksum %U",
 189                          unformat_pg_edit, unformat_pg_number, &p->checksum))
 190         ;
 191
 192       else if (unformat (input, "seqnum %U", unformat_pg_edit,
 193                          unformat_pg_number, &p->seq_number))
 194         ;
 195       else if (unformat (input, "acknum %U", unformat_pg_edit,
 196                          unformat_pg_number, &p->ack_number))
 197         ;
 198       /* Flags. */
 199 #define _(f) else if (unformat (input, #f)) pg_edit_set_fixed (&p->f##_flag, 1);
 200       foreach_tcp_flag
 201 #undef _
 202         /* Can't parse input: try next protocol level. */
 203         else
 204         break;
 205     }
 206
 207   {
 208     ip_main_t *im = &ip_main;
 209     u16 dst_port;
 210     tcp_udp_port_info_t *pi;
 211
 212     pi = 0;
 213     if (p->dst.type == PG_EDIT_FIXED)
 214       {
 215         dst_port = pg_edit_get_value (&p->dst, PG_EDIT_LO);
 216         pi = ip_get_tcp_udp_port_info (im, dst_port);
 217       }
 218
 219     if (pi && pi->unformat_pg_edit
 220         && unformat_user (input, pi->unformat_pg_edit, s))
 221       ;
 222
 223     else if (!unformat_user (input, unformat_pg_payload, s))
 224       goto error;
 225
 226     if (p->checksum.type == PG_EDIT_UNSPECIFIED)
 227       {
 228         pg_edit_group_t *g = pg_stream_get_group (s, group_index);
 229         g->edit_function = tcp_pg_edit_function;
 230         g->edit_function_opaque = 0;
 231       }
 232
 233     return 1;
 234   }
 235
 236 error:
 237   /* Free up any edits we may have added. */
 238   pg_free_edit_group (s);
 239   return 0;
 240 }
 241
 242 /*
 243  * fd.io coding-style-patch-verification: ON
 244  *
 245  * Local Variables:
 246  * eval: (c-set-style "gnu")
 247  * End:
 248  */