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 <acme@mandriva.com>
  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
  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         struct ip_options_rcu   *opt;
  92         struct sk_buff          *pktopts;
  93         u32                     ir_mark;
  94 };
  95
  96 static inline struct inet_request_sock *inet_rsk(const struct request_sock *sk)
  97 {
  98         return (struct inet_request_sock *)sk;
  99 }
 100
 101 static inline u32 inet_request_mark(struct sock *sk, struct sk_buff *skb)
 102 {
 103         if (!sk->sk_mark && sock_net(sk)->ipv4.sysctl_tcp_fwmark_accept) {
 104                 return skb->mark;
 105         } else {
 106                 return sk->sk_mark;
 107         }
 108 }
 109
 110 struct inet_cork {
 111         unsigned int            flags;
 112         __be32                  addr;
 113         struct ip_options       *opt;
 114         unsigned int            fragsize;
 115         int                     length; /* Total length of all frames */
 116         struct dst_entry        *dst;
 117         u8                      tx_flags;
 118         __u8                    ttl;
 119         __s16                   tos;
 120         char                    priority;
 121 };
 122
 123 struct inet_cork_full {
 124         struct inet_cork        base;
 125         struct flowi            fl;
 126 };
 127
 128 struct ip_mc_socklist;
 129 struct ipv6_pinfo;
 130 struct rtable;
 131
 132 /** struct inet_sock - representation of INET sockets
 133  *
 134  * @sk - ancestor class
 135  * @pinet6 - pointer to IPv6 control block
 136  * @inet_daddr - Foreign IPv4 addr
 137  * @inet_rcv_saddr - Bound local IPv4 addr
 138  * @inet_dport - Destination port
 139  * @inet_num - Local port
 140  * @inet_saddr - Sending source
 141  * @uc_ttl - Unicast TTL
 142  * @inet_sport - Source port
 143  * @inet_id - ID counter for DF pkts
 144  * @tos - TOS
 145  * @mc_ttl - Multicasting TTL
 146  * @is_icsk - is this an inet_connection_sock?
 147  * @uc_index - Unicast outgoing device index
 148  * @mc_index - Multicast device index
 149  * @mc_list - Group array
 150  * @cork - info to build ip hdr on each ip frag while socket is corked
 151  */
 152 struct inet_sock {
 153         /* sk and pinet6 has to be the first two members of inet_sock */
 154         struct sock             sk;
 155 #if IS_ENABLED(CONFIG_IPV6)
 156         struct ipv6_pinfo       *pinet6;
 157 #endif
 158         /* Socket demultiplex comparisons on incoming packets. */
 159 #define inet_daddr              sk.__sk_common.skc_daddr
 160 #define inet_rcv_saddr          sk.__sk_common.skc_rcv_saddr
 161 #define inet_dport              sk.__sk_common.skc_dport
 162 #define inet_num                sk.__sk_common.skc_num
 163
 164         __be32                  inet_saddr;
 165         __s16                   uc_ttl;
 166         __u16                   cmsg_flags;
 167         __be16                  inet_sport;
 168         __u16                   inet_id;
 169
 170         struct ip_options_rcu __rcu     *inet_opt;
 171         int                     rx_dst_ifindex;
 172         __u8                    tos;
 173         __u8                    min_ttl;
 174         __u8                    mc_ttl;
 175         __u8                    pmtudisc;
 176         __u8                    recverr:1,
 177                                 is_icsk:1,
 178                                 freebind:1,
 179                                 hdrincl:1,
 180                                 mc_loop:1,
 181                                 transparent:1,
 182                                 mc_all:1,
 183                                 nodefrag:1;
 184         __u8                    rcv_tos;
 185         int                     uc_index;
 186         int                     mc_index;
 187         __be32                  mc_addr;
 188         struct ip_mc_socklist __rcu     *mc_list;
 189         struct inet_cork_full   cork;
 190 };
 191
 192 #define IPCORK_OPT      1       /* ip-options has been held in ipcork.opt */
 193 #define IPCORK_ALLFRAG  2       /* always fragment (for ipv6 for now) */
 194
 195 static inline struct inet_sock *inet_sk(const struct sock *sk)
 196 {
 197         return (struct inet_sock *)sk;
 198 }
 199
 200 static inline void __inet_sk_copy_descendant(struct sock *sk_to,
 201                                              const struct sock *sk_from,
 202                                              const int ancestor_size)
 203 {
 204         memcpy(inet_sk(sk_to) + 1, inet_sk(sk_from) + 1,
 205                sk_from->sk_prot->obj_size - ancestor_size);
 206 }
 207 #if !(IS_ENABLED(CONFIG_IPV6))
 208 static inline void inet_sk_copy_descendant(struct sock *sk_to,
 209                                            const struct sock *sk_from)
 210 {
 211         __inet_sk_copy_descendant(sk_to, sk_from, sizeof(struct inet_sock));
 212 }
 213 #endif
 214
 215 int inet_sk_rebuild_header(struct sock *sk);
 216
 217 static inline unsigned int __inet_ehashfn(const __be32 laddr,
 218                                           const __u16 lport,
 219                                           const __be32 faddr,
 220                                           const __be16 fport,
 221                                           u32 initval)
 222 {
 223         return jhash_3words((__force __u32) laddr,
 224                             (__force __u32) faddr,
 225                             ((__u32) lport) << 16 | (__force __u32)fport,
 226                             initval);
 227 }
 228
 229 static inline struct request_sock *inet_reqsk_alloc(struct request_sock_ops *ops)
 230 {
 231         struct request_sock *req = reqsk_alloc(ops);
 232         struct inet_request_sock *ireq = inet_rsk(req);
 233
 234         if (req != NULL) {
 235                 kmemcheck_annotate_bitfield(ireq, flags);
 236                 ireq->opt = NULL;
 237         }
 238
 239         return req;
 240 }
 241
 242 static inline __u8 inet_sk_flowi_flags(const struct sock *sk)
 243 {
 244         __u8 flags = 0;
 245
 246         if (inet_sk(sk)->transparent || inet_sk(sk)->hdrincl)
 247                 flags |= FLOWI_FLAG_ANYSRC;
 248         return flags;
 249 }
 250
 251 #endif  /* _INET_SOCK_H */