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  * @is_data - Options in __data, rather than skb
  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         unsigned char   optlen;
  45         unsigned char   srr;
  46         unsigned char   rr;
  47         unsigned char   ts;
  48         unsigned char   is_strictroute:1,
  49                         srr_is_hit:1,
  50                         is_changed:1,
  51                         rr_needaddr:1,
  52                         ts_needtime:1,
  53                         ts_needaddr:1;
  54         unsigned char   router_alert;
  55         unsigned char   cipso;
  56         unsigned char   __pad2;
  57         unsigned char   __data[0];
  58 };
  59
  60 #define optlength(opt) (sizeof(struct ip_options) + opt->optlen)
  61
  62 struct inet_request_sock {
  63         struct request_sock     req;
  64 #if defined(CONFIG_IPV6) || defined(CONFIG_IPV6_MODULE)
  65         u16                     inet6_rsk_offset;
  66 #endif
  67         __be16                  loc_port;
  68         __be32                  loc_addr;
  69         __be32                  rmt_addr;
  70         __be16                  rmt_port;
  71         kmemcheck_bitfield_begin(flags);
  72         u16                     snd_wscale : 4,
  73                                 rcv_wscale : 4,
  74                                 tstamp_ok  : 1,
  75                                 sack_ok    : 1,
  76                                 wscale_ok  : 1,
  77                                 ecn_ok     : 1,
  78                                 acked      : 1,
  79                                 no_srccheck: 1;
  80         kmemcheck_bitfield_end(flags);
  81         struct ip_options       *opt;
  82 };
  83
  84 static inline struct inet_request_sock *inet_rsk(const struct request_sock *sk)
  85 {
  86         return (struct inet_request_sock *)sk;
  87 }
  88
  89 struct ip_mc_socklist;
  90 struct ipv6_pinfo;
  91 struct rtable;
  92
  93 /** struct inet_sock - representation of INET sockets
  94  *
  95  * @sk - ancestor class
  96  * @pinet6 - pointer to IPv6 control block
  97  * @inet_daddr - Foreign IPv4 addr
  98  * @inet_rcv_saddr - Bound local IPv4 addr
  99  * @inet_dport - Destination port
 100  * @inet_num - Local port
 101  * @inet_saddr - Sending source
 102  * @uc_ttl - Unicast TTL
 103  * @inet_sport - Source port
 104  * @inet_id - ID counter for DF pkts
 105  * @rxhash - flow hash received from netif layer
 106  * @tos - TOS
 107  * @mc_ttl - Multicasting TTL
 108  * @is_icsk - is this an inet_connection_sock?
 109  * @mc_index - Multicast device index
 110  * @mc_list - Group array
 111  * @cork - info to build ip hdr on each ip frag while socket is corked
 112  */
 113 struct inet_sock {
 114         /* sk and pinet6 has to be the first two members of inet_sock */
 115         struct sock             sk;
 116 #if defined(CONFIG_IPV6) || defined(CONFIG_IPV6_MODULE)
 117         struct ipv6_pinfo       *pinet6;
 118 #endif
 119         /* Socket demultiplex comparisons on incoming packets. */
 120         __be32                  inet_daddr;
 121         __be32                  inet_rcv_saddr;
 122         __be16                  inet_dport;
 123         __u16                   inet_num;
 124         __be32                  inet_saddr;
 125         __s16                   uc_ttl;
 126         __u16                   cmsg_flags;
 127         __be16                  inet_sport;
 128         __u16                   inet_id;
 129 #ifdef CONFIG_RPS
 130         __u32                   rxhash;
 131 #endif
 132
 133         struct ip_options       *opt;
 134         __u8                    tos;
 135         __u8                    min_ttl;
 136         __u8                    mc_ttl;
 137         __u8                    pmtudisc;
 138         __u8                    recverr:1,
 139                                 is_icsk:1,
 140                                 freebind:1,
 141                                 hdrincl:1,
 142                                 mc_loop:1,
 143                                 transparent:1,
 144                                 mc_all:1;
 145         int                     mc_index;
 146         __be32                  mc_addr;
 147         struct ip_mc_socklist   *mc_list;
 148         struct {
 149                 unsigned int            flags;
 150                 unsigned int            fragsize;
 151                 struct ip_options       *opt;
 152                 struct dst_entry        *dst;
 153                 int                     length; /* Total length of all frames */
 154                 __be32                  addr;
 155                 struct flowi            fl;
 156         } cork;
 157 };
 158
 159 #define IPCORK_OPT      1       /* ip-options has been held in ipcork.opt */
 160 #define IPCORK_ALLFRAG  2       /* always fragment (for ipv6 for now) */
 161
 162 static inline struct inet_sock *inet_sk(const struct sock *sk)
 163 {
 164         return (struct inet_sock *)sk;
 165 }
 166
 167 static inline void __inet_sk_copy_descendant(struct sock *sk_to,
 168                                              const struct sock *sk_from,
 169                                              const int ancestor_size)
 170 {
 171         memcpy(inet_sk(sk_to) + 1, inet_sk(sk_from) + 1,
 172                sk_from->sk_prot->obj_size - ancestor_size);
 173 }
 174 #if !(defined(CONFIG_IPV6) || defined(CONFIG_IPV6_MODULE))
 175 static inline void inet_sk_copy_descendant(struct sock *sk_to,
 176                                            const struct sock *sk_from)
 177 {
 178         __inet_sk_copy_descendant(sk_to, sk_from, sizeof(struct inet_sock));
 179 }
 180 #endif
 181
 182 extern int inet_sk_rebuild_header(struct sock *sk);
 183
 184 extern u32 inet_ehash_secret;
 185 extern void build_ehash_secret(void);
 186
 187 static inline unsigned int inet_ehashfn(struct net *net,
 188                                         const __be32 laddr, const __u16 lport,
 189                                         const __be32 faddr, const __be16 fport)
 190 {
 191         return jhash_3words((__force __u32) laddr,
 192                             (__force __u32) faddr,
 193                             ((__u32) lport) << 16 | (__force __u32)fport,
 194                             inet_ehash_secret + net_hash_mix(net));
 195 }
 196
 197 static inline int inet_sk_ehashfn(const struct sock *sk)
 198 {
 199         const struct inet_sock *inet = inet_sk(sk);
 200         const __be32 laddr = inet->inet_rcv_saddr;
 201         const __u16 lport = inet->inet_num;
 202         const __be32 faddr = inet->inet_daddr;
 203         const __be16 fport = inet->inet_dport;
 204         struct net *net = sock_net(sk);
 205
 206         return inet_ehashfn(net, laddr, lport, faddr, fport);
 207 }
 208
 209 static inline struct request_sock *inet_reqsk_alloc(struct request_sock_ops *ops)
 210 {
 211         struct request_sock *req = reqsk_alloc(ops);
 212         struct inet_request_sock *ireq = inet_rsk(req);
 213
 214         if (req != NULL) {
 215                 kmemcheck_annotate_bitfield(ireq, flags);
 216                 ireq->opt = NULL;
 217         }
 218
 219         return req;
 220 }
 221
 222 static inline __u8 inet_sk_flowi_flags(const struct sock *sk)
 223 {
 224         return inet_sk(sk)->transparent ? FLOWI_FLAG_ANYSRC : 0;
 225 }
 226
 227 static inline void inet_rps_record_flow(const struct sock *sk)
 228 {
 229 #ifdef CONFIG_RPS
 230         struct rps_sock_flow_table *sock_flow_table;
 231
 232         rcu_read_lock();
 233         sock_flow_table = rcu_dereference(rps_sock_flow_table);
 234         rps_record_sock_flow(sock_flow_table, inet_sk(sk)->rxhash);
 235         rcu_read_unlock();
 236 #endif
 237 }
 238
 239 static inline void inet_rps_reset_flow(const struct sock *sk)
 240 {
 241 #ifdef CONFIG_RPS
 242         struct rps_sock_flow_table *sock_flow_table;
 243
 244         rcu_read_lock();
 245         sock_flow_table = rcu_dereference(rps_sock_flow_table);
 246         rps_reset_sock_flow(sock_flow_table, inet_sk(sk)->rxhash);
 247         rcu_read_unlock();
 248 #endif
 249 }
 250
 251 static inline void inet_rps_save_rxhash(struct sock *sk, u32 rxhash)
 252 {
 253 #ifdef CONFIG_RPS
 254         if (unlikely(inet_sk(sk)->rxhash != rxhash)) {
 255                 inet_rps_reset_flow(sk);
 256                 inet_sk(sk)->rxhash = rxhash;
 257         }
 258 #endif
 259 }
 260 #endif  /* _INET_SOCK_H */