include/net/inet_sock.h

   1 /*
   2  * INET         An implementation of the TCP/IP protocol suite for the LINUX
   3  *              operating system.  INET is implemented using the  BSD Socket
   4  *              interface as the means of communication with the user level.
   5  *
   6  *              Definitions for inet_sock
   7  *
   8  * Authors:     Many, reorganised here by
   9  *              Arnaldo Carvalho de Melo <[email protected]>
  10  *
  11  *              This program is free software; you can redistribute it and/or
  12  *              modify it under the terms of the GNU General Public License
  13  *              as published by the Free Software Foundation; either version
  14  *              2 of the License, or (at your option) any later version.
  15  */
  16 #ifndef _INET_SOCK_H
  17 #define _INET_SOCK_H
  18
  19 #include <linux/bitops.h>
  20 #include <linux/kmemcheck.h>
  21 #include <linux/string.h>
  22 #include <linux/types.h>
  23 #include <linux/jhash.h>
  24 #include <linux/netdevice.h>
  25
  26 #include <net/flow.h>
  27 #include <net/sock.h>
  28 #include <net/request_sock.h>
  29 #include <net/netns/hash.h>
  30
  31 /** struct ip_options - IP Options
  32  *
  33  * @faddr - Saved first hop address
  34  * @nexthop - Saved nexthop address in LSRR and SSRR
  35  * @is_strictroute - Strict source route
  36  * @srr_is_hit - Packet destination addr was our one
  37  * @is_changed - IP checksum more not valid
  38  * @rr_needaddr - Need to record addr of outgoing dev
  39  * @ts_needtime - Need to record timestamp
  40  * @ts_needaddr - Need to record addr of outgoing dev
  41  */
  42 struct ip_options {
  43         __be32          faddr;
  44         __be32          nexthop;
  45         unsigned char   optlen;
  46         unsigned char   srr;
  47         unsigned char   rr;
  48         unsigned char   ts;
  49         unsigned char   is_strictroute:1,
  50                         srr_is_hit:1,
  51                         is_changed:1,
  52                         rr_needaddr:1,
  53                         ts_needtime:1,
  54                         ts_needaddr:1;
  55         unsigned char   router_alert;
  56         unsigned char   cipso;
  57         unsigned char   __pad2;
  58         unsigned char   __data[0];
  59 };
  60
  61 struct ip_options_rcu {
  62         struct rcu_head rcu;
  63         struct ip_options opt;
  64 };
  65
  66 struct ip_options_data {
  67         struct ip_options_rcu   opt;
  68         char                    data[40];
  69 };
  70
  71 struct inet_request_sock {
  72         struct request_sock     req;
  73 #define ir_loc_addr             req.__req_common.skc_rcv_saddr
  74 #define ir_rmt_addr             req.__req_common.skc_daddr
  75 #define ir_num                  req.__req_common.skc_num
  76 #define ir_rmt_port             req.__req_common.skc_dport
  77 #define ir_v6_rmt_addr          req.__req_common.skc_v6_daddr
  78 #define ir_v6_loc_addr          req.__req_common.skc_v6_rcv_saddr
  79 #define ir_iif                  req.__req_common.skc_bound_dev_if
  80
  81         kmemcheck_bitfield_begin(flags);
  82         u16                     snd_wscale : 4,
  83                                 rcv_wscale : 4,
  84                                 tstamp_ok  : 1,
  85                                 sack_ok    : 1,
  86                                 wscale_ok  : 1,
  87                                 ecn_ok     : 1,
  88                                 acked      : 1,
  89                                 no_srccheck: 1;
  90         kmemcheck_bitfield_end(flags);
  91         union {
  92                 struct ip_options_rcu   *opt;
  93                 struct sk_buff          *pktopts;
  94         };
  95         u32                     ir_mark;
  96 };
  97
  98 static inline struct inet_request_sock *inet_rsk(const struct request_sock *sk)
  99 {
 100         return (struct inet_request_sock *)sk;
 101 }
 102
 103 static inline u32 inet_request_mark(struct sock *sk, struct sk_buff *skb)
 104 {
 105         if (!sk->sk_mark && sock_net(sk)->ipv4.sysctl_tcp_fwmark_accept) {
 106                 return skb->mark;
 107         } else {
 108                 return sk->sk_mark;
 109         }
 110 }
 111
 112 struct inet_cork {
 113         unsigned int            flags;
 114         __be32                  addr;
 115         struct ip_options       *opt;
 116         unsigned int            fragsize;
 117         int                     length; /* Total length of all frames */
 118         struct dst_entry        *dst;
 119         u8                      tx_flags;
 120         __u8                    ttl;
 121         __s16                   tos;
 122         char                    priority;
 123 };
 124
 125 struct inet_cork_full {
 126         struct inet_cork        base;
 127         struct flowi            fl;
 128 };
 129
 130 struct ip_mc_socklist;
 131 struct ipv6_pinfo;
 132 struct rtable;
 133
 134 /** struct inet_sock - representation of INET sockets
 135  *
 136  * @sk - ancestor class
 137  * @pinet6 - pointer to IPv6 control block
 138  * @inet_daddr - Foreign IPv4 addr
 139  * @inet_rcv_saddr - Bound local IPv4 addr
 140  * @inet_dport - Destination port
 141  * @inet_num - Local port
 142  * @inet_saddr - Sending source
 143  * @uc_ttl - Unicast TTL
 144  * @inet_sport - Source port
 145  * @inet_id - ID counter for DF pkts
 146  * @tos - TOS
 147  * @mc_ttl - Multicasting TTL
 148  * @is_icsk - is this an inet_connection_sock?
 149  * @uc_index - Unicast outgoing device index
 150  * @mc_index - Multicast device index
 151  * @mc_list - Group array
 152  * @cork - info to build ip hdr on each ip frag while socket is corked
 153  */
 154 struct inet_sock {
 155         /* sk and pinet6 has to be the first two members of inet_sock */
 156         struct sock             sk;
 157 #if IS_ENABLED(CONFIG_IPV6)
 158         struct ipv6_pinfo       *pinet6;
 159 #endif
 160         /* Socket demultiplex comparisons on incoming packets. */
 161 #define inet_daddr              sk.__sk_common.skc_daddr
 162 #define inet_rcv_saddr          sk.__sk_common.skc_rcv_saddr
 163 #define inet_dport              sk.__sk_common.skc_dport
 164 #define inet_num                sk.__sk_common.skc_num
 165
 166         __be32                  inet_saddr;
 167         __s16                   uc_ttl;
 168         __u16                   cmsg_flags;
 169         __be16                  inet_sport;
 170         __u16                   inet_id;
 171
 172         struct ip_options_rcu __rcu     *inet_opt;
 173         int                     rx_dst_ifindex;
 174         __u8                    tos;
 175         __u8                    min_ttl;
 176         __u8                    mc_ttl;
 177         __u8                    pmtudisc;
 178         __u8                    recverr:1,
 179                                 is_icsk:1,
 180                                 freebind:1,
 181                                 hdrincl:1,
 182                                 mc_loop:1,
 183                                 transparent:1,
 184                                 mc_all:1,
 185                                 nodefrag:1;
 186         __u8                    rcv_tos;
 187         __u8                    convert_csum;
 188         int                     uc_index;
 189         int                     mc_index;
 190         __be32                  mc_addr;
 191         struct ip_mc_socklist __rcu     *mc_list;
 192         struct inet_cork_full   cork;
 193 };
 194
 195 #define IPCORK_OPT      1       /* ip-options has been held in ipcork.opt */
 196 #define IPCORK_ALLFRAG  2       /* always fragment (for ipv6 for now) */
 197
 198 /* cmsg flags for inet */
 199 #define IP_CMSG_PKTINFO         BIT(0)
 200 #define IP_CMSG_TTL             BIT(1)
 201 #define IP_CMSG_TOS             BIT(2)
 202 #define IP_CMSG_RECVOPTS        BIT(3)
 203 #define IP_CMSG_RETOPTS         BIT(4)
 204 #define IP_CMSG_PASSSEC         BIT(5)
 205 #define IP_CMSG_ORIGDSTADDR     BIT(6)
 206 #define IP_CMSG_CHECKSUM        BIT(7)
 207
 208 static inline struct inet_sock *inet_sk(const struct sock *sk)
 209 {
 210         return (struct inet_sock *)sk;
 211 }
 212
 213 static inline void __inet_sk_copy_descendant(struct sock *sk_to,
 214                                              const struct sock *sk_from,
 215                                              const int ancestor_size)
 216 {
 217         memcpy(inet_sk(sk_to) + 1, inet_sk(sk_from) + 1,
 218                sk_from->sk_prot->obj_size - ancestor_size);
 219 }
 220 #if !(IS_ENABLED(CONFIG_IPV6))
 221 static inline void inet_sk_copy_descendant(struct sock *sk_to,
 222                                            const struct sock *sk_from)
 223 {
 224         __inet_sk_copy_descendant(sk_to, sk_from, sizeof(struct inet_sock));
 225 }
 226 #endif
 227
 228 int inet_sk_rebuild_header(struct sock *sk);
 229
 230 static inline unsigned int __inet_ehashfn(const __be32 laddr,
 231                                           const __u16 lport,
 232                                           const __be32 faddr,
 233                                           const __be16 fport,
 234                                           u32 initval)
 235 {
 236         return jhash_3words((__force __u32) laddr,
 237                             (__force __u32) faddr,
 238                             ((__u32) lport) << 16 | (__force __u32)fport,
 239                             initval);
 240 }
 241
 242 static inline struct request_sock *inet_reqsk_alloc(struct request_sock_ops *ops)
 243 {
 244         struct request_sock *req = reqsk_alloc(ops);
 245         struct inet_request_sock *ireq = inet_rsk(req);
 246
 247         if (req != NULL) {
 248                 kmemcheck_annotate_bitfield(ireq, flags);
 249                 ireq->opt = NULL;
 250         }
 251
 252         return req;
 253 }
 254
 255 static inline __u8 inet_sk_flowi_flags(const struct sock *sk)
 256 {
 257         __u8 flags = 0;
 258
 259         if (inet_sk(sk)->transparent || inet_sk(sk)->hdrincl)
 260                 flags |= FLOWI_FLAG_ANYSRC;
 261         return flags;
 262 }
 263
 264 static inline void inet_inc_convert_csum(struct sock *sk)
 265 {
 266         inet_sk(sk)->convert_csum++;
 267 }
 268
 269 static inline void inet_dec_convert_csum(struct sock *sk)
 270 {
 271         if (inet_sk(sk)->convert_csum > 0)
 272                 inet_sk(sk)->convert_csum--;
 273 }
 274
 275 static inline bool inet_get_convert_csum(struct sock *sk)
 276 {
 277         return !!inet_sk(sk)->convert_csum;
 278 }
 279
 280 #endif  /* _INET_SOCK_H */