vnet/vnet/ip/tcp_packet.h

   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  * ip4/tcp_packet.h: TCP packet format (see RFC 793)
  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 #ifndef included_tcp_packet_h
  41 #define included_tcp_packet_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 enum {
  55 #define _(f) TCP_FLAG_BIT_##f,
  56   foreach_tcp_flag
  57 #undef _
  58   TCP_N_FLAG_BITS,
  59
  60 #define _(f) TCP_FLAG_##f = 1 << TCP_FLAG_BIT_##f,
  61   foreach_tcp_flag
  62 #undef _
  63 };
  64
  65 typedef struct {
  66   /* Source and destination port. */
  67   union {
  68     struct {
  69       u16 src, dst;
  70     };
  71     u32 src_and_dst;
  72   } ports;
  73
  74   /* Sequence and acknowledgment number. */
  75   u32 seq_number, ack_number;
  76
  77   /* Size of TCP header in 32-bit units plus 4 reserved bits. */
  78   u8 tcp_header_u32s_and_reserved;
  79
  80   /* see foreach_tcp_flag for enumation of tcp flags. */
  81   u8 flags;
  82
  83   /* Current window advertised by sender.
  84      This is the number of bytes sender is willing to receive
  85      right now. */
  86   u16 window;
  87
  88   /* Checksum of TCP pseudo header and data. */
  89   u16 checksum;
  90
  91   u16 urgent_pointer;
  92 } tcp_header_t;
  93
  94 always_inline int
  95 tcp_header_bytes (tcp_header_t * t)
  96 { return (t->tcp_header_u32s_and_reserved >> 4) * sizeof (u32); }
  97
  98 /* TCP options. */
  99 typedef enum tcp_option_type {
 100   TCP_OPTION_END = 0,
 101   TCP_OPTION_NOP = 1,
 102   TCP_OPTION_MSS = 2,
 103   TCP_OPTION_WINDOW_SCALE = 3,
 104   TCP_OPTION_SACK_PERMITTED = 4,
 105   TCP_OPTION_SACK_BLOCK = 5,
 106   TCP_OPTION_TIME_STAMP = 8,
 107 } tcp_option_type_t;
 108
 109 /* All except NOP and END have 1 byte length field. */
 110 typedef struct {
 111   tcp_option_type_t type : 8;
 112
 113   /* Length of this option in bytes. */
 114   u8 length;
 115 } tcp_option_with_length_t;
 116
 117 #endif /* included_tcp_packet_h */
 118