include/net/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 the AF_INET socket handler.
   7  *
   8  * Version:     @(#)sock.h      1.0.4   05/13/93
   9  *
  10  * Authors:     Ross Biro
  11  *              Fred N. van Kempen, <waltje@uWalt.NL.Mugnet.ORG>
  12  *              Corey Minyard <wf-rch!minyard@relay.EU.net>
  13  *              Florian La Roche <flla@stud.uni-sb.de>
  14  *
  15  * Fixes:
  16  *              Alan Cox        :       Volatiles in skbuff pointers. See
  17  *                                      skbuff comments. May be overdone,
  18  *                                      better to prove they can be removed
  19  *                                      than the reverse.
  20  *              Alan Cox        :       Added a zapped field for tcp to note
  21  *                                      a socket is reset and must stay shut up
  22  *              Alan Cox        :       New fields for options
  23  *      Pauline Middelink       :       identd support
  24  *              Alan Cox        :       Eliminate low level recv/recvfrom
  25  *              David S. Miller :       New socket lookup architecture.
  26  *              Steve Whitehouse:       Default routines for sock_ops
  27  *              Arnaldo C. Melo :       removed net_pinfo, tp_pinfo and made
  28  *                                      protinfo be just a void pointer, as the
  29  *                                      protocol specific parts were moved to
  30  *                                      respective headers and ipv4/v6, etc now
  31  *                                      use private slabcaches for its socks
  32  *              Pedro Hortas    :       New flags field for socket options
  33  *
  34  *
  35  *              This program is free software; you can redistribute it and/or
  36  *              modify it under the terms of the GNU General Public License
  37  *              as published by the Free Software Foundation; either version
  38  *              2 of the License, or (at your option) any later version.
  39  */
  40 #ifndef _SOCK_H
  41 #define _SOCK_H
  42
  43 #include <linux/hardirq.h>
  44 #include <linux/kernel.h>
  45 #include <linux/list.h>
  46 #include <linux/list_nulls.h>
  47 #include <linux/timer.h>
  48 #include <linux/cache.h>
  49 #include <linux/bitops.h>
  50 #include <linux/lockdep.h>
  51 #include <linux/netdevice.h>
  52 #include <linux/skbuff.h>       /* struct sk_buff */
  53 #include <linux/mm.h>
  54 #include <linux/security.h>
  55 #include <linux/slab.h>
  56 #include <linux/uaccess.h>
  57 #include <linux/page_counter.h>
  58 #include <linux/memcontrol.h>
  59 #include <linux/static_key.h>
  60 #include <linux/sched.h>
  61 #include <linux/wait.h>
  62 #include <linux/cgroup-defs.h>
  63
  64 #include <linux/filter.h>
  65 #include <linux/rculist_nulls.h>
  66 #include <linux/poll.h>
  67
  68 #include <linux/atomic.h>
  69 #include <net/dst.h>
  70 #include <net/checksum.h>
  71 #include <net/tcp_states.h>
  72 #include <linux/net_tstamp.h>
  73
  74 /*
  75  * This structure really needs to be cleaned up.
  76  * Most of it is for TCP, and not used by any of
  77  * the other protocols.
  78  */
  79
  80 /* Define this to get the SOCK_DBG debugging facility. */
  81 #define SOCK_DEBUGGING
  82 #ifdef SOCK_DEBUGGING
  83 #define SOCK_DEBUG(sk, msg...) do { if ((sk) && sock_flag((sk), SOCK_DBG)) \
  84                                         printk(KERN_DEBUG msg); } while (0)
  85 #else
  86 /* Validate arguments and do nothing */
  87 static inline __printf(2, 3)
  88 void SOCK_DEBUG(const struct sock *sk, const char *msg, ...)
  89 {
  90 }
  91 #endif
  92
  93 /* This is the per-socket lock.  The spinlock provides a synchronization
  94  * between user contexts and software interrupt processing, whereas the
  95  * mini-semaphore synchronizes multiple users amongst themselves.
  96  */
  97 typedef struct {
  98         spinlock_t              slock;
  99         int                     owned;
 100         wait_queue_head_t       wq;
 101         /*
 102          * We express the mutex-alike socket_lock semantics
 103          * to the lock validator by explicitly managing
 104          * the slock as a lock variant (in addition to
 105          * the slock itself):
 106          */
 107 #ifdef CONFIG_DEBUG_LOCK_ALLOC
 108         struct lockdep_map dep_map;
 109 #endif
 110 } socket_lock_t;
 111
 112 struct sock;
 113 struct proto;
 114 struct net;
 115
 116 typedef __u32 __bitwise __portpair;
 117 typedef __u64 __bitwise __addrpair;
 118
 119 /**
 120  *      struct sock_common - minimal network layer representation of sockets
 121  *      @skc_daddr: Foreign IPv4 addr
 122  *      @skc_rcv_saddr: Bound local IPv4 addr
 123  *      @skc_hash: hash value used with various protocol lookup tables
 124  *      @skc_u16hashes: two u16 hash values used by UDP lookup tables
 125  *      @skc_dport: placeholder for inet_dport/tw_dport
 126  *      @skc_num: placeholder for inet_num/tw_num
 127  *      @skc_family: network address family
 128  *      @skc_state: Connection state
 129  *      @skc_reuse: %SO_REUSEADDR setting
 130  *      @skc_reuseport: %SO_REUSEPORT setting
 131  *      @skc_bound_dev_if: bound device index if != 0
 132  *      @skc_bind_node: bind hash linkage for various protocol lookup tables
 133  *      @skc_portaddr_node: second hash linkage for UDP/UDP-Lite protocol
 134  *      @skc_prot: protocol handlers inside a network family
 135  *      @skc_net: reference to the network namespace of this socket
 136  *      @skc_node: main hash linkage for various protocol lookup tables
 137  *      @skc_nulls_node: main hash linkage for TCP/UDP/UDP-Lite protocol
 138  *      @skc_tx_queue_mapping: tx queue number for this connection
 139  *      @skc_flags: place holder for sk_flags
 140  *              %SO_LINGER (l_onoff), %SO_BROADCAST, %SO_KEEPALIVE,
 141  *              %SO_OOBINLINE settings, %SO_TIMESTAMPING settings
 142  *      @skc_incoming_cpu: record/match cpu processing incoming packets
 143  *      @skc_refcnt: reference count
 144  *
 145  *      This is the minimal network layer representation of sockets, the header
 146  *      for struct sock and struct inet_timewait_sock.
 147  */
 148 struct sock_common {
 149         /* skc_daddr and skc_rcv_saddr must be grouped on a 8 bytes aligned
 150          * address on 64bit arches : cf INET_MATCH()
 151          */
 152         union {
 153                 __addrpair      skc_addrpair;
 154                 struct {
 155                         __be32  skc_daddr;
 156                         __be32  skc_rcv_saddr;
 157                 };
 158         };
 159         union  {
 160                 unsigned int    skc_hash;
 161                 __u16           skc_u16hashes[2];
 162         };
 163         /* skc_dport && skc_num must be grouped as well */
 164         union {
 165                 __portpair      skc_portpair;
 166                 struct {
 167                         __be16  skc_dport;
 168                         __u16   skc_num;
 169                 };
 170         };
 171
 172         unsigned short          skc_family;
 173         volatile unsigned char  skc_state;
 174         unsigned char           skc_reuse:4;
 175         unsigned char           skc_reuseport:1;
 176         unsigned char           skc_ipv6only:1;
 177         unsigned char           skc_net_refcnt:1;
 178         int                     skc_bound_dev_if;
 179         union {
 180                 struct hlist_node       skc_bind_node;
 181                 struct hlist_node       skc_portaddr_node;
 182         };
 183         struct proto            *skc_prot;
 184         possible_net_t          skc_net;
 185
 186 #if IS_ENABLED(CONFIG_IPV6)
 187         struct in6_addr         skc_v6_daddr;
 188         struct in6_addr         skc_v6_rcv_saddr;
 189 #endif
 190
 191         atomic64_t              skc_cookie;
 192
 193         /* following fields are padding to force
 194          * offset(struct sock, sk_refcnt) == 128 on 64bit arches
 195          * assuming IPV6 is enabled. We use this padding differently
 196          * for different kind of 'sockets'
 197          */
 198         union {
 199                 unsigned long   skc_flags;
 200                 struct sock     *skc_listener; /* request_sock */
 201                 struct inet_timewait_death_row *skc_tw_dr; /* inet_timewait_sock */
 202         };
 203         /*
 204          * fields between dontcopy_begin/dontcopy_end
 205          * are not copied in sock_copy()
 206          */
 207         /* private: */
 208         int                     skc_dontcopy_begin[0];
 209         /* public: */
 210         union {
 211                 struct hlist_node       skc_node;
 212                 struct hlist_nulls_node skc_nulls_node;
 213         };
 214         int                     skc_tx_queue_mapping;
 215         union {
 216                 int             skc_incoming_cpu;
 217                 u32             skc_rcv_wnd;
 218                 u32             skc_tw_rcv_nxt; /* struct tcp_timewait_sock  */
 219         };
 220
 221         atomic_t                skc_refcnt;
 222         /* private: */
 223         int                     skc_dontcopy_end[0];
 224         union {
 225                 u32             skc_rxhash;
 226                 u32             skc_window_clamp;
 227                 u32             skc_tw_snd_nxt; /* struct tcp_timewait_sock */
 228         };
 229         /* public: */
 230 };
 231
 232 /**
 233   *     struct sock - network layer representation of sockets
 234   *     @__sk_common: shared layout with inet_timewait_sock
 235   *     @sk_shutdown: mask of %SEND_SHUTDOWN and/or %RCV_SHUTDOWN
 236   *     @sk_userlocks: %SO_SNDBUF and %SO_RCVBUF settings
 237   *     @sk_lock:       synchronizer
 238   *     @sk_rcvbuf: size of receive buffer in bytes
 239   *     @sk_wq: sock wait queue and async head
 240   *     @sk_rx_dst: receive input route used by early demux
 241   *     @sk_dst_cache: destination cache
 242   *     @sk_policy: flow policy
 243   *     @sk_receive_queue: incoming packets
 244   *     @sk_wmem_alloc: transmit queue bytes committed
 245   *     @sk_write_queue: Packet sending queue
 246   *     @sk_omem_alloc: "o" is "option" or "other"
 247   *     @sk_wmem_queued: persistent queue size
 248   *     @sk_forward_alloc: space allocated forward
 249   *     @sk_napi_id: id of the last napi context to receive data for sk
 250   *     @sk_ll_usec: usecs to busypoll when there is no data
 251   *     @sk_allocation: allocation mode
 252   *     @sk_pacing_rate: Pacing rate (if supported by transport/packet scheduler)
 253   *     @sk_max_pacing_rate: Maximum pacing rate (%SO_MAX_PACING_RATE)
 254   *     @sk_sndbuf: size of send buffer in bytes
 255   *     @sk_no_check_tx: %SO_NO_CHECK setting, set checksum in TX packets
 256   *     @sk_no_check_rx: allow zero checksum in RX packets
 257   *     @sk_route_caps: route capabilities (e.g. %NETIF_F_TSO)
 258   *     @sk_route_nocaps: forbidden route capabilities (e.g NETIF_F_GSO_MASK)
 259   *     @sk_gso_type: GSO type (e.g. %SKB_GSO_TCPV4)
 260   *     @sk_gso_max_size: Maximum GSO segment size to build
 261   *     @sk_gso_max_segs: Maximum number of GSO segments
 262   *     @sk_lingertime: %SO_LINGER l_linger setting
 263   *     @sk_backlog: always used with the per-socket spinlock held
 264   *     @sk_callback_lock: used with the callbacks in the end of this struct
 265   *     @sk_error_queue: rarely used
 266   *     @sk_prot_creator: sk_prot of original sock creator (see ipv6_setsockopt,
 267   *                       IPV6_ADDRFORM for instance)
 268   *     @sk_err: last error
 269   *     @sk_err_soft: errors that don't cause failure but are the cause of a
 270   *                   persistent failure not just 'timed out'
 271   *     @sk_drops: raw/udp drops counter
 272   *     @sk_ack_backlog: current listen backlog
 273   *     @sk_max_ack_backlog: listen backlog set in listen()
 274   *     @sk_priority: %SO_PRIORITY setting
 275   *     @sk_type: socket type (%SOCK_STREAM, etc)
 276   *     @sk_protocol: which protocol this socket belongs in this network family
 277   *     @sk_peer_pid: &struct pid for this socket's peer
 278   *     @sk_peer_cred: %SO_PEERCRED setting
 279   *     @sk_rcvlowat: %SO_RCVLOWAT setting
 280   *     @sk_rcvtimeo: %SO_RCVTIMEO setting
 281   *     @sk_sndtimeo: %SO_SNDTIMEO setting
 282   *     @sk_txhash: computed flow hash for use on transmit
 283   *     @sk_filter: socket filtering instructions
 284   *     @sk_timer: sock cleanup timer
 285   *     @sk_stamp: time stamp of last packet received
 286   *     @sk_tsflags: SO_TIMESTAMPING socket options
 287   *     @sk_tskey: counter to disambiguate concurrent tstamp requests
 288   *     @sk_socket: Identd and reporting IO signals
 289   *     @sk_user_data: RPC layer private data
 290   *     @sk_frag: cached page frag
 291   *     @sk_peek_off: current peek_offset value
 292   *     @sk_send_head: front of stuff to transmit
 293   *     @sk_security: used by security modules
 294   *     @sk_mark: generic packet mark
 295   *     @sk_cgrp_data: cgroup data for this cgroup
 296   *     @sk_memcg: this socket's memory cgroup association
 297   *     @sk_write_pending: a write to stream socket waits to start
 298   *     @sk_state_change: callback to indicate change in the state of the sock
 299   *     @sk_data_ready: callback to indicate there is data to be processed
 300   *     @sk_write_space: callback to indicate there is bf sending space available
 301   *     @sk_error_report: callback to indicate errors (e.g. %MSG_ERRQUEUE)
 302   *     @sk_backlog_rcv: callback to process the backlog
 303   *     @sk_destruct: called at sock freeing time, i.e. when all refcnt == 0
 304   *     @sk_reuseport_cb: reuseport group container
 305  */
 306 struct sock {
 307         /*
 308          * Now struct inet_timewait_sock also uses sock_common, so please just
 309          * don't add nothing before this first member (__sk_common) --acme
 310          */
 311         struct sock_common      __sk_common;
 312 #define sk_node                 __sk_common.skc_node
 313 #define sk_nulls_node           __sk_common.skc_nulls_node
 314 #define sk_refcnt               __sk_common.skc_refcnt
 315 #define sk_tx_queue_mapping     __sk_common.skc_tx_queue_mapping
 316
 317 #define sk_dontcopy_begin       __sk_common.skc_dontcopy_begin
 318 #define sk_dontcopy_end         __sk_common.skc_dontcopy_end
 319 #define sk_hash                 __sk_common.skc_hash
 320 #define sk_portpair             __sk_common.skc_portpair
 321 #define sk_num                  __sk_common.skc_num
 322 #define sk_dport                __sk_common.skc_dport
 323 #define sk_addrpair             __sk_common.skc_addrpair
 324 #define sk_daddr                __sk_common.skc_daddr
 325 #define sk_rcv_saddr            __sk_common.skc_rcv_saddr
 326 #define sk_family               __sk_common.skc_family
 327 #define sk_state                __sk_common.skc_state
 328 #define sk_reuse                __sk_common.skc_reuse
 329 #define sk_reuseport            __sk_common.skc_reuseport
 330 #define sk_ipv6only             __sk_common.skc_ipv6only
 331 #define sk_net_refcnt           __sk_common.skc_net_refcnt
 332 #define sk_bound_dev_if         __sk_common.skc_bound_dev_if
 333 #define sk_bind_node            __sk_common.skc_bind_node
 334 #define sk_prot                 __sk_common.skc_prot
 335 #define sk_net                  __sk_common.skc_net
 336 #define sk_v6_daddr             __sk_common.skc_v6_daddr
 337 #define sk_v6_rcv_saddr __sk_common.skc_v6_rcv_saddr
 338 #define sk_cookie               __sk_common.skc_cookie
 339 #define sk_incoming_cpu         __sk_common.skc_incoming_cpu
 340 #define sk_flags                __sk_common.skc_flags
 341 #define sk_rxhash               __sk_common.skc_rxhash
 342
 343         socket_lock_t           sk_lock;
 344         struct sk_buff_head     sk_receive_queue;
 345         /*
 346          * The backlog queue is special, it is always used with
 347          * the per-socket spinlock held and requires low latency
 348          * access. Therefore we special case it's implementation.
 349          * Note : rmem_alloc is in this structure to fill a hole
 350          * on 64bit arches, not because its logically part of
 351          * backlog.
 352          */
 353         struct {
 354                 atomic_t        rmem_alloc;
 355                 int             len;
 356                 struct sk_buff  *head;
 357                 struct sk_buff  *tail;
 358         } sk_backlog;
 359 #define sk_rmem_alloc sk_backlog.rmem_alloc
 360         int                     sk_forward_alloc;
 361
 362         __u32                   sk_txhash;
 363 #ifdef CONFIG_NET_RX_BUSY_POLL
 364         unsigned int            sk_napi_id;
 365         unsigned int            sk_ll_usec;
 366 #endif
 367         atomic_t                sk_drops;
 368         int                     sk_rcvbuf;
 369
 370         struct sk_filter __rcu  *sk_filter;
 371         union {
 372                 struct socket_wq __rcu  *sk_wq;
 373                 struct socket_wq        *sk_wq_raw;
 374         };
 375 #ifdef CONFIG_XFRM
 376         struct xfrm_policy __rcu *sk_policy[2];
 377 #endif
 378         struct dst_entry        *sk_rx_dst;
 379         struct dst_entry __rcu  *sk_dst_cache;
 380         /* Note: 32bit hole on 64bit arches */
 381         atomic_t                sk_wmem_alloc;
 382         atomic_t                sk_omem_alloc;
 383         int                     sk_sndbuf;
 384         struct sk_buff_head     sk_write_queue;
 385         kmemcheck_bitfield_begin(flags);
 386         unsigned int            sk_shutdown  : 2,
 387                                 sk_no_check_tx : 1,
 388                                 sk_no_check_rx : 1,
 389                                 sk_userlocks : 4,
 390                                 sk_protocol  : 8,
 391                                 sk_type      : 16;
 392 #define SK_PROTOCOL_MAX U8_MAX
 393         kmemcheck_bitfield_end(flags);
 394         int                     sk_wmem_queued;
 395         gfp_t                   sk_allocation;
 396         u32                     sk_pacing_rate; /* bytes per second */
 397         u32                     sk_max_pacing_rate;
 398         netdev_features_t       sk_route_caps;
 399         netdev_features_t       sk_route_nocaps;
 400         int                     sk_gso_type;
 401         unsigned int            sk_gso_max_size;
 402         u16                     sk_gso_max_segs;
 403         int                     sk_rcvlowat;
 404         unsigned long           sk_lingertime;
 405         struct sk_buff_head     sk_error_queue;
 406         struct proto            *sk_prot_creator;
 407         rwlock_t                sk_callback_lock;
 408         int                     sk_err,
 409                                 sk_err_soft;
 410         u32                     sk_ack_backlog;
 411         u32                     sk_max_ack_backlog;
 412         __u32                   sk_priority;
 413         __u32                   sk_mark;
 414         struct pid              *sk_peer_pid;
 415         const struct cred       *sk_peer_cred;
 416         long                    sk_rcvtimeo;
 417         long                    sk_sndtimeo;
 418         struct timer_list       sk_timer;
 419         ktime_t                 sk_stamp;
 420         u16                     sk_tsflags;
 421         u32                     sk_tskey;
 422         struct socket           *sk_socket;
 423         void                    *sk_user_data;
 424         struct page_frag        sk_frag;
 425         struct sk_buff          *sk_send_head;
 426         __s32                   sk_peek_off;
 427         int                     sk_write_pending;
 428 #ifdef CONFIG_SECURITY
 429         void                    *sk_security;
 430 #endif
 431         struct sock_cgroup_data sk_cgrp_data;
 432         struct mem_cgroup       *sk_memcg;
 433         void                    (*sk_state_change)(struct sock *sk);
 434         void                    (*sk_data_ready)(struct sock *sk);
 435         void                    (*sk_write_space)(struct sock *sk);
 436         void                    (*sk_error_report)(struct sock *sk);
 437         int                     (*sk_backlog_rcv)(struct sock *sk,
 438                                                   struct sk_buff *skb);
 439         void                    (*sk_destruct)(struct sock *sk);
 440         struct sock_reuseport __rcu     *sk_reuseport_cb;
 441         struct rcu_head         sk_rcu;
 442 };
 443
 444 #define __sk_user_data(sk) ((*((void __rcu **)&(sk)->sk_user_data)))
 445
 446 #define rcu_dereference_sk_user_data(sk)        rcu_dereference(__sk_user_data((sk)))
 447 #define rcu_assign_sk_user_data(sk, ptr)        rcu_assign_pointer(__sk_user_data((sk)), ptr)
 448
 449 /*
 450  * SK_CAN_REUSE and SK_NO_REUSE on a socket mean that the socket is OK
 451  * or not whether his port will be reused by someone else. SK_FORCE_REUSE
 452  * on a socket means that the socket will reuse everybody else's port
 453  * without looking at the other's sk_reuse value.
 454  */
 455
 456 #define SK_NO_REUSE     0
 457 #define SK_CAN_REUSE    1
 458 #define SK_FORCE_REUSE  2
 459
 460 static inline int sk_peek_offset(struct sock *sk, int flags)
 461 {
 462         if ((flags & MSG_PEEK) && (sk->sk_peek_off >= 0))
 463                 return sk->sk_peek_off;
 464         else
 465                 return 0;
 466 }
 467
 468 static inline void sk_peek_offset_bwd(struct sock *sk, int val)
 469 {
 470         if (sk->sk_peek_off >= 0) {
 471                 if (sk->sk_peek_off >= val)
 472                         sk->sk_peek_off -= val;
 473                 else
 474                         sk->sk_peek_off = 0;
 475         }
 476 }
 477
 478 static inline void sk_peek_offset_fwd(struct sock *sk, int val)
 479 {
 480         if (sk->sk_peek_off >= 0)
 481                 sk->sk_peek_off += val;
 482 }
 483
 484 /*
 485  * Hashed lists helper routines
 486  */
 487 static inline struct sock *sk_entry(const struct hlist_node *node)
 488 {
 489         return hlist_entry(node, struct sock, sk_node);
 490 }
 491
 492 static inline struct sock *__sk_head(const struct hlist_head *head)
 493 {
 494         return hlist_entry(head->first, struct sock, sk_node);
 495 }
 496
 497 static inline struct sock *sk_head(const struct hlist_head *head)
 498 {
 499         return hlist_empty(head) ? NULL : __sk_head(head);
 500 }
 501
 502 static inline struct sock *__sk_nulls_head(const struct hlist_nulls_head *head)
 503 {
 504         return hlist_nulls_entry(head->first, struct sock, sk_nulls_node);
 505 }
 506
 507 static inline struct sock *sk_nulls_head(const struct hlist_nulls_head *head)
 508 {
 509         return hlist_nulls_empty(head) ? NULL : __sk_nulls_head(head);
 510 }
 511
 512 static inline struct sock *sk_next(const struct sock *sk)
 513 {
 514         return sk->sk_node.next ?
 515                 hlist_entry(sk->sk_node.next, struct sock, sk_node) : NULL;
 516 }
 517
 518 static inline struct sock *sk_nulls_next(const struct sock *sk)
 519 {
 520         return (!is_a_nulls(sk->sk_nulls_node.next)) ?
 521                 hlist_nulls_entry(sk->sk_nulls_node.next,
 522                                   struct sock, sk_nulls_node) :
 523                 NULL;
 524 }
 525
 526 static inline bool sk_unhashed(const struct sock *sk)
 527 {
 528         return hlist_unhashed(&sk->sk_node);
 529 }
 530
 531 static inline bool sk_hashed(const struct sock *sk)
 532 {
 533         return !sk_unhashed(sk);
 534 }
 535
 536 static inline void sk_node_init(struct hlist_node *node)
 537 {
 538         node->pprev = NULL;
 539 }
 540
 541 static inline void sk_nulls_node_init(struct hlist_nulls_node *node)
 542 {
 543         node->pprev = NULL;
 544 }
 545
 546 static inline void __sk_del_node(struct sock *sk)
 547 {
 548         __hlist_del(&sk->sk_node);
 549 }
 550
 551 /* NB: equivalent to hlist_del_init_rcu */
 552 static inline bool __sk_del_node_init(struct sock *sk)
 553 {
 554         if (sk_hashed(sk)) {
 555                 __sk_del_node(sk);
 556                 sk_node_init(&sk->sk_node);
 557                 return true;
 558         }
 559         return false;
 560 }
 561
 562 /* Grab socket reference count. This operation is valid only
 563    when sk is ALREADY grabbed f.e. it is found in hash table
 564    or a list and the lookup is made under lock preventing hash table
 565    modifications.
 566  */
 567
 568 static inline void sock_hold(struct sock *sk)
 569 {
 570         atomic_inc(&sk->sk_refcnt);
 571 }
 572
 573 /* Ungrab socket in the context, which assumes that socket refcnt
 574    cannot hit zero, f.e. it is true in context of any socketcall.
 575  */
 576 static inline void __sock_put(struct sock *sk)
 577 {
 578         atomic_dec(&sk->sk_refcnt);
 579 }
 580
 581 static inline bool sk_del_node_init(struct sock *sk)
 582 {
 583         bool rc = __sk_del_node_init(sk);
 584
 585         if (rc) {
 586                 /* paranoid for a while -acme */
 587                 WARN_ON(atomic_read(&sk->sk_refcnt) == 1);
 588                 __sock_put(sk);
 589         }
 590         return rc;
 591 }
 592 #define sk_del_node_init_rcu(sk)        sk_del_node_init(sk)
 593
 594 static inline bool __sk_nulls_del_node_init_rcu(struct sock *sk)
 595 {
 596         if (sk_hashed(sk)) {
 597                 hlist_nulls_del_init_rcu(&sk->sk_nulls_node);
 598                 return true;
 599         }
 600         return false;
 601 }
 602
 603 static inline bool sk_nulls_del_node_init_rcu(struct sock *sk)
 604 {
 605         bool rc = __sk_nulls_del_node_init_rcu(sk);
 606
 607         if (rc) {
 608                 /* paranoid for a while -acme */
 609                 WARN_ON(atomic_read(&sk->sk_refcnt) == 1);
 610                 __sock_put(sk);
 611         }
 612         return rc;
 613 }
 614
 615 static inline void __sk_add_node(struct sock *sk, struct hlist_head *list)
 616 {
 617         hlist_add_head(&sk->sk_node, list);
 618 }
 619
 620 static inline void sk_add_node(struct sock *sk, struct hlist_head *list)
 621 {
 622         sock_hold(sk);
 623         __sk_add_node(sk, list);
 624 }
 625
 626 static inline void sk_add_node_rcu(struct sock *sk, struct hlist_head *list)
 627 {
 628         sock_hold(sk);
 629         hlist_add_head_rcu(&sk->sk_node, list);
 630 }
 631
 632 static inline void __sk_nulls_add_node_rcu(struct sock *sk, struct hlist_nulls_head *list)
 633 {
 634         hlist_nulls_add_head_rcu(&sk->sk_nulls_node, list);
 635 }
 636
 637 static inline void sk_nulls_add_node_rcu(struct sock *sk, struct hlist_nulls_head *list)
 638 {
 639         sock_hold(sk);
 640         __sk_nulls_add_node_rcu(sk, list);
 641 }
 642
 643 static inline void __sk_del_bind_node(struct sock *sk)
 644 {
 645         __hlist_del(&sk->sk_bind_node);
 646 }
 647
 648 static inline void sk_add_bind_node(struct sock *sk,
 649                                         struct hlist_head *list)
 650 {
 651         hlist_add_head(&sk->sk_bind_node, list);
 652 }
 653
 654 #define sk_for_each(__sk, list) \
 655         hlist_for_each_entry(__sk, list, sk_node)
 656 #define sk_for_each_rcu(__sk, list) \
 657         hlist_for_each_entry_rcu(__sk, list, sk_node)
 658 #define sk_nulls_for_each(__sk, node, list) \
 659         hlist_nulls_for_each_entry(__sk, node, list, sk_nulls_node)
 660 #define sk_nulls_for_each_rcu(__sk, node, list) \
 661         hlist_nulls_for_each_entry_rcu(__sk, node, list, sk_nulls_node)
 662 #define sk_for_each_from(__sk) \
 663         hlist_for_each_entry_from(__sk, sk_node)
 664 #define sk_nulls_for_each_from(__sk, node) \
 665         if (__sk && ({ node = &(__sk)->sk_nulls_node; 1; })) \
 666                 hlist_nulls_for_each_entry_from(__sk, node, sk_nulls_node)
 667 #define sk_for_each_safe(__sk, tmp, list) \
 668         hlist_for_each_entry_safe(__sk, tmp, list, sk_node)
 669 #define sk_for_each_bound(__sk, list) \
 670         hlist_for_each_entry(__sk, list, sk_bind_node)
 671
 672 /**
 673  * sk_for_each_entry_offset_rcu - iterate over a list at a given struct offset
 674  * @tpos:       the type * to use as a loop cursor.
 675  * @pos:        the &struct hlist_node to use as a loop cursor.
 676  * @head:       the head for your list.
 677  * @offset:     offset of hlist_node within the struct.
 678  *
 679  */
 680 #define sk_for_each_entry_offset_rcu(tpos, pos, head, offset)                  \
 681         for (pos = rcu_dereference((head)->first);                             \
 682              pos != NULL &&                                                    \
 683                 ({ tpos = (typeof(*tpos) *)((void *)pos - offset); 1;});       \
 684              pos = rcu_dereference(pos->next))
 685
 686 static inline struct user_namespace *sk_user_ns(struct sock *sk)
 687 {
 688         /* Careful only use this in a context where these parameters
 689          * can not change and must all be valid, such as recvmsg from
 690          * userspace.
 691          */
 692         return sk->sk_socket->file->f_cred->user_ns;
 693 }
 694
 695 /* Sock flags */
 696 enum sock_flags {
 697         SOCK_DEAD,
 698         SOCK_DONE,
 699         SOCK_URGINLINE,
 700         SOCK_KEEPOPEN,
 701         SOCK_LINGER,
 702         SOCK_DESTROY,
 703         SOCK_BROADCAST,
 704         SOCK_TIMESTAMP,
 705         SOCK_ZAPPED,
 706         SOCK_USE_WRITE_QUEUE, /* whether to call sk->sk_write_space in sock_wfree */
 707         SOCK_DBG, /* %SO_DEBUG setting */
 708         SOCK_RCVTSTAMP, /* %SO_TIMESTAMP setting */
 709         SOCK_RCVTSTAMPNS, /* %SO_TIMESTAMPNS setting */
 710         SOCK_LOCALROUTE, /* route locally only, %SO_DONTROUTE setting */
 711         SOCK_QUEUE_SHRUNK, /* write queue has been shrunk recently */
 712         SOCK_MEMALLOC, /* VM depends on this socket for swapping */
 713         SOCK_TIMESTAMPING_RX_SOFTWARE,  /* %SOF_TIMESTAMPING_RX_SOFTWARE */
 714         SOCK_FASYNC, /* fasync() active */
 715         SOCK_RXQ_OVFL,
 716         SOCK_ZEROCOPY, /* buffers from userspace */
 717         SOCK_WIFI_STATUS, /* push wifi status to userspace */
 718         SOCK_NOFCS, /* Tell NIC not to do the Ethernet FCS.
 719                      * Will use last 4 bytes of packet sent from
 720                      * user-space instead.
 721                      */
 722         SOCK_FILTER_LOCKED, /* Filter cannot be changed anymore */
 723         SOCK_SELECT_ERR_QUEUE, /* Wake select on error queue */
 724         SOCK_RCU_FREE, /* wait rcu grace period in sk_destruct() */
 725 };
 726
 727 #define SK_FLAGS_TIMESTAMP ((1UL << SOCK_TIMESTAMP) | (1UL << SOCK_TIMESTAMPING_RX_SOFTWARE))
 728
 729 static inline void sock_copy_flags(struct sock *nsk, struct sock *osk)
 730 {
 731         nsk->sk_flags = osk->sk_flags;
 732 }
 733
 734 static inline void sock_set_flag(struct sock *sk, enum sock_flags flag)
 735 {
 736         __set_bit(flag, &sk->sk_flags);
 737 }
 738
 739 static inline void sock_reset_flag(struct sock *sk, enum sock_flags flag)
 740 {
 741         __clear_bit(flag, &sk->sk_flags);
 742 }
 743
 744 static inline bool sock_flag(const struct sock *sk, enum sock_flags flag)
 745 {
 746         return test_bit(flag, &sk->sk_flags);
 747 }
 748
 749 #ifdef CONFIG_NET
 750 extern struct static_key memalloc_socks;
 751 static inline int sk_memalloc_socks(void)
 752 {
 753         return static_key_false(&memalloc_socks);
 754 }
 755 #else
 756
 757 static inline int sk_memalloc_socks(void)
 758 {
 759         return 0;
 760 }
 761
 762 #endif
 763
 764 static inline gfp_t sk_gfp_mask(const struct sock *sk, gfp_t gfp_mask)
 765 {
 766         return gfp_mask | (sk->sk_allocation & __GFP_MEMALLOC);
 767 }
 768
 769 static inline void sk_acceptq_removed(struct sock *sk)
 770 {
 771         sk->sk_ack_backlog--;
 772 }
 773
 774 static inline void sk_acceptq_added(struct sock *sk)
 775 {
 776         sk->sk_ack_backlog++;
 777 }
 778
 779 static inline bool sk_acceptq_is_full(const struct sock *sk)
 780 {
 781         return sk->sk_ack_backlog > sk->sk_max_ack_backlog;
 782 }
 783
 784 /*
 785  * Compute minimal free write space needed to queue new packets.
 786  */
 787 static inline int sk_stream_min_wspace(const struct sock *sk)
 788 {
 789         return sk->sk_wmem_queued >> 1;
 790 }
 791
 792 static inline int sk_stream_wspace(const struct sock *sk)
 793 {
 794         return sk->sk_sndbuf - sk->sk_wmem_queued;
 795 }
 796
 797 void sk_stream_write_space(struct sock *sk);
 798
 799 /* OOB backlog add */
 800 static inline void __sk_add_backlog(struct sock *sk, struct sk_buff *skb)
 801 {
 802         /* dont let skb dst not refcounted, we are going to leave rcu lock */
 803         skb_dst_force_safe(skb);
 804
 805         if (!sk->sk_backlog.tail)
 806                 sk->sk_backlog.head = skb;
 807         else
 808                 sk->sk_backlog.tail->next = skb;
 809
 810         sk->sk_backlog.tail = skb;
 811         skb->next = NULL;
 812 }
 813
 814 /*
 815  * Take into account size of receive queue and backlog queue
 816  * Do not take into account this skb truesize,
 817  * to allow even a single big packet to come.
 818  */
 819 static inline bool sk_rcvqueues_full(const struct sock *sk, unsigned int limit)
 820 {
 821         unsigned int qsize = sk->sk_backlog.len + atomic_read(&sk->sk_rmem_alloc);
 822
 823         return qsize > limit;
 824 }
 825
 826 /* The per-socket spinlock must be held here. */
 827 static inline __must_check int sk_add_backlog(struct sock *sk, struct sk_buff *skb,
 828                                               unsigned int limit)
 829 {
 830         if (sk_rcvqueues_full(sk, limit))
 831                 return -ENOBUFS;
 832
 833         /*
 834          * If the skb was allocated from pfmemalloc reserves, only
 835          * allow SOCK_MEMALLOC sockets to use it as this socket is
 836          * helping free memory
 837          */
 838         if (skb_pfmemalloc(skb) && !sock_flag(sk, SOCK_MEMALLOC))
 839                 return -ENOMEM;
 840
 841         __sk_add_backlog(sk, skb);
 842         sk->sk_backlog.len += skb->truesize;
 843         return 0;
 844 }
 845
 846 int __sk_backlog_rcv(struct sock *sk, struct sk_buff *skb);
 847
 848 static inline int sk_backlog_rcv(struct sock *sk, struct sk_buff *skb)
 849 {
 850         if (sk_memalloc_socks() && skb_pfmemalloc(skb))
 851                 return __sk_backlog_rcv(sk, skb);
 852
 853         return sk->sk_backlog_rcv(sk, skb);
 854 }
 855
 856 static inline void sk_incoming_cpu_update(struct sock *sk)
 857 {
 858         sk->sk_incoming_cpu = raw_smp_processor_id();
 859 }
 860
 861 static inline void sock_rps_record_flow_hash(__u32 hash)
 862 {
 863 #ifdef CONFIG_RPS
 864         struct rps_sock_flow_table *sock_flow_table;
 865
 866         rcu_read_lock();
 867         sock_flow_table = rcu_dereference(rps_sock_flow_table);
 868         rps_record_sock_flow(sock_flow_table, hash);
 869         rcu_read_unlock();
 870 #endif
 871 }
 872
 873 static inline void sock_rps_record_flow(const struct sock *sk)
 874 {
 875 #ifdef CONFIG_RPS
 876         sock_rps_record_flow_hash(sk->sk_rxhash);
 877 #endif
 878 }
 879
 880 static inline void sock_rps_save_rxhash(struct sock *sk,
 881                                         const struct sk_buff *skb)
 882 {
 883 #ifdef CONFIG_RPS
 884         if (unlikely(sk->sk_rxhash != skb->hash))
 885                 sk->sk_rxhash = skb->hash;
 886 #endif
 887 }
 888
 889 static inline void sock_rps_reset_rxhash(struct sock *sk)
 890 {
 891 #ifdef CONFIG_RPS
 892         sk->sk_rxhash = 0;
 893 #endif
 894 }
 895
 896 #define sk_wait_event(__sk, __timeo, __condition)                       \
 897         ({      int __rc;                                               \
 898                 release_sock(__sk);                                     \
 899                 __rc = __condition;                                     \
 900                 if (!__rc) {                                            \
 901                         *(__timeo) = schedule_timeout(*(__timeo));      \
 902                 }                                                       \
 903                 sched_annotate_sleep();                                         \
 904                 lock_sock(__sk);                                        \
 905                 __rc = __condition;                                     \
 906                 __rc;                                                   \
 907         })
 908
 909 int sk_stream_wait_connect(struct sock *sk, long *timeo_p);
 910 int sk_stream_wait_memory(struct sock *sk, long *timeo_p);
 911 void sk_stream_wait_close(struct sock *sk, long timeo_p);
 912 int sk_stream_error(struct sock *sk, int flags, int err);
 913 void sk_stream_kill_queues(struct sock *sk);
 914 void sk_set_memalloc(struct sock *sk);
 915 void sk_clear_memalloc(struct sock *sk);
 916
 917 int sk_wait_data(struct sock *sk, long *timeo, const struct sk_buff *skb);
 918
 919 struct request_sock_ops;
 920 struct timewait_sock_ops;
 921 struct inet_hashinfo;
 922 struct raw_hashinfo;
 923 struct module;
 924
 925 /*
 926  * caches using SLAB_DESTROY_BY_RCU should let .next pointer from nulls nodes
 927  * un-modified. Special care is taken when initializing object to zero.
 928  */
 929 static inline void sk_prot_clear_nulls(struct sock *sk, int size)
 930 {
 931         if (offsetof(struct sock, sk_node.next) != 0)
 932                 memset(sk, 0, offsetof(struct sock, sk_node.next));
 933         memset(&sk->sk_node.pprev, 0,
 934                size - offsetof(struct sock, sk_node.pprev));
 935 }
 936
 937 /* Networking protocol blocks we attach to sockets.
 938  * socket layer -> transport layer interface
 939  */
 940 struct proto {
 941         void                    (*close)(struct sock *sk,
 942                                         long timeout);
 943         int                     (*connect)(struct sock *sk,
 944                                         struct sockaddr *uaddr,
 945                                         int addr_len);
 946         int                     (*disconnect)(struct sock *sk, int flags);
 947
 948         struct sock *           (*accept)(struct sock *sk, int flags, int *err);
 949
 950         int                     (*ioctl)(struct sock *sk, int cmd,
 951                                          unsigned long arg);
 952         int                     (*init)(struct sock *sk);
 953         void                    (*destroy)(struct sock *sk);
 954         void                    (*shutdown)(struct sock *sk, int how);
 955         int                     (*setsockopt)(struct sock *sk, int level,
 956                                         int optname, char __user *optval,
 957                                         unsigned int optlen);
 958         int                     (*getsockopt)(struct sock *sk, int level,
 959                                         int optname, char __user *optval,
 960                                         int __user *option);
 961 #ifdef CONFIG_COMPAT
 962         int                     (*compat_setsockopt)(struct sock *sk,
 963                                         int level,
 964                                         int optname, char __user *optval,
 965                                         unsigned int optlen);
 966         int                     (*compat_getsockopt)(struct sock *sk,
 967                                         int level,
 968                                         int optname, char __user *optval,
 969                                         int __user *option);
 970         int                     (*compat_ioctl)(struct sock *sk,
 971                                         unsigned int cmd, unsigned long arg);
 972 #endif
 973         int                     (*sendmsg)(struct sock *sk, struct msghdr *msg,
 974                                            size_t len);
 975         int                     (*recvmsg)(struct sock *sk, struct msghdr *msg,
 976                                            size_t len, int noblock, int flags,
 977                                            int *addr_len);
 978         int                     (*sendpage)(struct sock *sk, struct page *page,
 979                                         int offset, size_t size, int flags);
 980         int                     (*bind)(struct sock *sk,
 981                                         struct sockaddr *uaddr, int addr_len);
 982
 983         int                     (*backlog_rcv) (struct sock *sk,
 984                                                 struct sk_buff *skb);
 985
 986         void            (*release_cb)(struct sock *sk);
 987
 988         /* Keeping track of sk's, looking them up, and port selection methods. */
 989         int                     (*hash)(struct sock *sk);
 990         void                    (*unhash)(struct sock *sk);
 991         void                    (*rehash)(struct sock *sk);
 992         int                     (*get_port)(struct sock *sk, unsigned short snum);
 993         void                    (*clear_sk)(struct sock *sk, int size);
 994
 995         /* Keeping track of sockets in use */
 996 #ifdef CONFIG_PROC_FS
 997         unsigned int            inuse_idx;
 998 #endif
 999
1000         bool                    (*stream_memory_free)(const struct sock *sk);
1001         /* Memory pressure */
1002         void                    (*enter_memory_pressure)(struct sock *sk);
1003         atomic_long_t           *memory_allocated;      /* Current allocated memory. */
1004         struct percpu_counter   *sockets_allocated;     /* Current number of sockets. */
1005         /*
1006          * Pressure flag: try to collapse.
1007          * Technical note: it is used by multiple contexts non atomically.
1008          * All the __sk_mem_schedule() is of this nature: accounting
1009          * is strict, actions are advisory and have some latency.
1010          */
1011         int                     *memory_pressure;
1012         long                    *sysctl_mem;
1013         int                     *sysctl_wmem;
1014         int                     *sysctl_rmem;
1015         int                     max_header;
1016         bool                    no_autobind;
1017
1018         struct kmem_cache       *slab;
1019         unsigned int            obj_size;
1020         int                     slab_flags;
1021
1022         struct percpu_counter   *orphan_count;
1023
1024         struct request_sock_ops *rsk_prot;
1025         struct timewait_sock_ops *twsk_prot;
1026
1027         union {
1028                 struct inet_hashinfo    *hashinfo;
1029                 struct udp_table        *udp_table;
1030                 struct raw_hashinfo     *raw_hash;
1031         } h;
1032
1033         struct module           *owner;
1034
1035         char                    name[32];
1036
1037         struct list_head        node;
1038 #ifdef SOCK_REFCNT_DEBUG
1039         atomic_t                socks;
1040 #endif
1041         int                     (*diag_destroy)(struct sock *sk, int err);
1042 };
1043
1044 int proto_register(struct proto *prot, int alloc_slab);
1045 void proto_unregister(struct proto *prot);
1046
1047 #ifdef SOCK_REFCNT_DEBUG
1048 static inline void sk_refcnt_debug_inc(struct sock *sk)
1049 {
1050         atomic_inc(&sk->sk_prot->socks);
1051 }
1052
1053 static inline void sk_refcnt_debug_dec(struct sock *sk)
1054 {
1055         atomic_dec(&sk->sk_prot->socks);
1056         printk(KERN_DEBUG "%s socket %p released, %d are still alive\n",
1057                sk->sk_prot->name, sk, atomic_read(&sk->sk_prot->socks));
1058 }
1059
1060 static inline void sk_refcnt_debug_release(const struct sock *sk)
1061 {
1062         if (atomic_read(&sk->sk_refcnt) != 1)
1063                 printk(KERN_DEBUG "Destruction of the %s socket %p delayed, refcnt=%d\n",
1064                        sk->sk_prot->name, sk, atomic_read(&sk->sk_refcnt));
1065 }
1066 #else /* SOCK_REFCNT_DEBUG */
1067 #define sk_refcnt_debug_inc(sk) do { } while (0)
1068 #define sk_refcnt_debug_dec(sk) do { } while (0)
1069 #define sk_refcnt_debug_release(sk) do { } while (0)
1070 #endif /* SOCK_REFCNT_DEBUG */
1071
1072 static inline bool sk_stream_memory_free(const struct sock *sk)
1073 {
1074         if (sk->sk_wmem_queued >= sk->sk_sndbuf)
1075                 return false;
1076
1077         return sk->sk_prot->stream_memory_free ?
1078                 sk->sk_prot->stream_memory_free(sk) : true;
1079 }
1080
1081 static inline bool sk_stream_is_writeable(const struct sock *sk)
1082 {
1083         return sk_stream_wspace(sk) >= sk_stream_min_wspace(sk) &&
1084                sk_stream_memory_free(sk);
1085 }
1086
1087
1088 static inline bool sk_has_memory_pressure(const struct sock *sk)
1089 {
1090         return sk->sk_prot->memory_pressure != NULL;
1091 }
1092
1093 static inline bool sk_under_memory_pressure(const struct sock *sk)
1094 {
1095         if (!sk->sk_prot->memory_pressure)
1096                 return false;
1097
1098         if (mem_cgroup_sockets_enabled && sk->sk_memcg &&
1099             mem_cgroup_under_socket_pressure(sk->sk_memcg))
1100                 return true;
1101
1102         return !!*sk->sk_prot->memory_pressure;
1103 }
1104
1105 static inline void sk_leave_memory_pressure(struct sock *sk)
1106 {
1107         int *memory_pressure = sk->sk_prot->memory_pressure;
1108
1109         if (!memory_pressure)
1110                 return;
1111
1112         if (*memory_pressure)
1113                 *memory_pressure = 0;
1114 }
1115
1116 static inline void sk_enter_memory_pressure(struct sock *sk)
1117 {
1118         if (!sk->sk_prot->enter_memory_pressure)
1119                 return;
1120
1121         sk->sk_prot->enter_memory_pressure(sk);
1122 }
1123
1124 static inline long sk_prot_mem_limits(const struct sock *sk, int index)
1125 {
1126         return sk->sk_prot->sysctl_mem[index];
1127 }
1128
1129 static inline long
1130 sk_memory_allocated(const struct sock *sk)
1131 {
1132         return atomic_long_read(sk->sk_prot->memory_allocated);
1133 }
1134
1135 static inline long
1136 sk_memory_allocated_add(struct sock *sk, int amt)
1137 {
1138         return atomic_long_add_return(amt, sk->sk_prot->memory_allocated);
1139 }
1140
1141 static inline void
1142 sk_memory_allocated_sub(struct sock *sk, int amt)
1143 {
1144         atomic_long_sub(amt, sk->sk_prot->memory_allocated);
1145 }
1146
1147 static inline void sk_sockets_allocated_dec(struct sock *sk)
1148 {
1149         percpu_counter_dec(sk->sk_prot->sockets_allocated);
1150 }
1151
1152 static inline void sk_sockets_allocated_inc(struct sock *sk)
1153 {
1154         percpu_counter_inc(sk->sk_prot->sockets_allocated);
1155 }
1156
1157 static inline int
1158 sk_sockets_allocated_read_positive(struct sock *sk)
1159 {
1160         return percpu_counter_read_positive(sk->sk_prot->sockets_allocated);
1161 }
1162
1163 static inline int
1164 proto_sockets_allocated_sum_positive(struct proto *prot)
1165 {
1166         return percpu_counter_sum_positive(prot->sockets_allocated);
1167 }
1168
1169 static inline long
1170 proto_memory_allocated(struct proto *prot)
1171 {
1172         return atomic_long_read(prot->memory_allocated);
1173 }
1174
1175 static inline bool
1176 proto_memory_pressure(struct proto *prot)
1177 {
1178         if (!prot->memory_pressure)
1179                 return false;
1180         return !!*prot->memory_pressure;
1181 }
1182
1183
1184 #ifdef CONFIG_PROC_FS
1185 /* Called with local bh disabled */
1186 void sock_prot_inuse_add(struct net *net, struct proto *prot, int inc);
1187 int sock_prot_inuse_get(struct net *net, struct proto *proto);
1188 #else
1189 static inline void sock_prot_inuse_add(struct net *net, struct proto *prot,
1190                 int inc)
1191 {
1192 }
1193 #endif
1194
1195
1196 /* With per-bucket locks this operation is not-atomic, so that
1197  * this version is not worse.
1198  */
1199 static inline int __sk_prot_rehash(struct sock *sk)
1200 {
1201         sk->sk_prot->unhash(sk);
1202         return sk->sk_prot->hash(sk);
1203 }
1204
1205 void sk_prot_clear_portaddr_nulls(struct sock *sk, int size);
1206
1207 /* About 10 seconds */
1208 #define SOCK_DESTROY_TIME (10*HZ)
1209
1210 /* Sockets 0-1023 can't be bound to unless you are superuser */
1211 #define PROT_SOCK       1024
1212
1213 #define SHUTDOWN_MASK   3
1214 #define RCV_SHUTDOWN    1
1215 #define SEND_SHUTDOWN   2
1216
1217 #define SOCK_SNDBUF_LOCK        1
1218 #define SOCK_RCVBUF_LOCK        2
1219 #define SOCK_BINDADDR_LOCK      4
1220 #define SOCK_BINDPORT_LOCK      8
1221
1222 struct socket_alloc {
1223         struct socket socket;
1224         struct inode vfs_inode;
1225 };
1226
1227 static inline struct socket *SOCKET_I(struct inode *inode)
1228 {
1229         return &container_of(inode, struct socket_alloc, vfs_inode)->socket;
1230 }
1231
1232 static inline struct inode *SOCK_INODE(struct socket *socket)
1233 {
1234         return &container_of(socket, struct socket_alloc, socket)->vfs_inode;
1235 }
1236
1237 /*
1238  * Functions for memory accounting
1239  */
1240 int __sk_mem_schedule(struct sock *sk, int size, int kind);
1241 void __sk_mem_reclaim(struct sock *sk, int amount);
1242
1243 #define SK_MEM_QUANTUM ((int)PAGE_SIZE)
1244 #define SK_MEM_QUANTUM_SHIFT ilog2(SK_MEM_QUANTUM)
1245 #define SK_MEM_SEND     0
1246 #define SK_MEM_RECV     1
1247
1248 static inline int sk_mem_pages(int amt)
1249 {
1250         return (amt + SK_MEM_QUANTUM - 1) >> SK_MEM_QUANTUM_SHIFT;
1251 }
1252
1253 static inline bool sk_has_account(struct sock *sk)
1254 {
1255         /* return true if protocol supports memory accounting */
1256         return !!sk->sk_prot->memory_allocated;
1257 }
1258
1259 static inline bool sk_wmem_schedule(struct sock *sk, int size)
1260 {
1261         if (!sk_has_account(sk))
1262                 return true;
1263         return size <= sk->sk_forward_alloc ||
1264                 __sk_mem_schedule(sk, size, SK_MEM_SEND);
1265 }
1266
1267 static inline bool
1268 sk_rmem_schedule(struct sock *sk, struct sk_buff *skb, int size)
1269 {
1270         if (!sk_has_account(sk))
1271                 return true;
1272         return size<= sk->sk_forward_alloc ||
1273                 __sk_mem_schedule(sk, size, SK_MEM_RECV) ||
1274                 skb_pfmemalloc(skb);
1275 }
1276
1277 static inline void sk_mem_reclaim(struct sock *sk)
1278 {
1279         if (!sk_has_account(sk))
1280                 return;
1281         if (sk->sk_forward_alloc >= SK_MEM_QUANTUM)
1282                 __sk_mem_reclaim(sk, sk->sk_forward_alloc);
1283 }
1284
1285 static inline void sk_mem_reclaim_partial(struct sock *sk)
1286 {
1287         if (!sk_has_account(sk))
1288                 return;
1289         if (sk->sk_forward_alloc > SK_MEM_QUANTUM)
1290                 __sk_mem_reclaim(sk, sk->sk_forward_alloc - 1);
1291 }
1292
1293 static inline void sk_mem_charge(struct sock *sk, int size)
1294 {
1295         if (!sk_has_account(sk))
1296                 return;
1297         sk->sk_forward_alloc -= size;
1298 }
1299
1300 static inline void sk_mem_uncharge(struct sock *sk, int size)
1301 {
1302         if (!sk_has_account(sk))
1303                 return;
1304         sk->sk_forward_alloc += size;
1305 }
1306
1307 static inline void sk_wmem_free_skb(struct sock *sk, struct sk_buff *skb)
1308 {
1309         sock_set_flag(sk, SOCK_QUEUE_SHRUNK);
1310         sk->sk_wmem_queued -= skb->truesize;
1311         sk_mem_uncharge(sk, skb->truesize);
1312         __kfree_skb(skb);
1313 }
1314
1315 /* Used by processes to "lock" a socket state, so that
1316  * interrupts and bottom half handlers won't change it
1317  * from under us. It essentially blocks any incoming
1318  * packets, so that we won't get any new data or any
1319  * packets that change the state of the socket.
1320  *
1321  * While locked, BH processing will add new packets to
1322  * the backlog queue.  This queue is processed by the
1323  * owner of the socket lock right before it is released.
1324  *
1325  * Since ~2.3.5 it is also exclusive sleep lock serializing
1326  * accesses from user process context.
1327  */
1328 #define sock_owned_by_user(sk)  ((sk)->sk_lock.owned)
1329
1330 static inline void sock_release_ownership(struct sock *sk)
1331 {
1332         sk->sk_lock.owned = 0;
1333 }
1334
1335 /*
1336  * Macro so as to not evaluate some arguments when
1337  * lockdep is not enabled.
1338  *
1339  * Mark both the sk_lock and the sk_lock.slock as a
1340  * per-address-family lock class.
1341  */
1342 #define sock_lock_init_class_and_name(sk, sname, skey, name, key)       \
1343 do {                                                                    \
1344         sk->sk_lock.owned = 0;                                          \
1345         init_waitqueue_head(&sk->sk_lock.wq);                           \
1346         spin_lock_init(&(sk)->sk_lock.slock);                           \
1347         debug_check_no_locks_freed((void *)&(sk)->sk_lock,              \
1348                         sizeof((sk)->sk_lock));                         \
1349         lockdep_set_class_and_name(&(sk)->sk_lock.slock,                \
1350                                 (skey), (sname));                               \
1351         lockdep_init_map(&(sk)->sk_lock.dep_map, (name), (key), 0);     \
1352 } while (0)
1353
1354 void lock_sock_nested(struct sock *sk, int subclass);
1355
1356 static inline void lock_sock(struct sock *sk)
1357 {
1358         lock_sock_nested(sk, 0);
1359 }
1360
1361 void release_sock(struct sock *sk);
1362
1363 /* BH context may only use the following locking interface. */
1364 #define bh_lock_sock(__sk)      spin_lock(&((__sk)->sk_lock.slock))
1365 #define bh_lock_sock_nested(__sk) \
1366                                 spin_lock_nested(&((__sk)->sk_lock.slock), \
1367                                 SINGLE_DEPTH_NESTING)
1368 #define bh_unlock_sock(__sk)    spin_unlock(&((__sk)->sk_lock.slock))
1369
1370 bool lock_sock_fast(struct sock *sk);
1371 /**
1372  * unlock_sock_fast - complement of lock_sock_fast
1373  * @sk: socket
1374  * @slow: slow mode
1375  *
1376  * fast unlock socket for user context.
1377  * If slow mode is on, we call regular release_sock()
1378  */
1379 static inline void unlock_sock_fast(struct sock *sk, bool slow)
1380 {
1381         if (slow)
1382                 release_sock(sk);
1383         else
1384                 spin_unlock_bh(&sk->sk_lock.slock);
1385 }
1386
1387
1388 struct sock *sk_alloc(struct net *net, int family, gfp_t priority,
1389                       struct proto *prot, int kern);
1390 void sk_free(struct sock *sk);
1391 void sk_destruct(struct sock *sk);
1392 struct sock *sk_clone_lock(const struct sock *sk, const gfp_t priority);
1393
1394 struct sk_buff *sock_wmalloc(struct sock *sk, unsigned long size, int force,
1395                              gfp_t priority);
1396 void sock_wfree(struct sk_buff *skb);
1397 void skb_orphan_partial(struct sk_buff *skb);
1398 void sock_rfree(struct sk_buff *skb);
1399 void sock_efree(struct sk_buff *skb);
1400 #ifdef CONFIG_INET
1401 void sock_edemux(struct sk_buff *skb);
1402 #else
1403 #define sock_edemux(skb) sock_efree(skb)
1404 #endif
1405
1406 int sock_setsockopt(struct socket *sock, int level, int op,
1407                     char __user *optval, unsigned int optlen);
1408
1409 int sock_getsockopt(struct socket *sock, int level, int op,
1410                     char __user *optval, int __user *optlen);
1411 struct sk_buff *sock_alloc_send_skb(struct sock *sk, unsigned long size,
1412                                     int noblock, int *errcode);
1413 struct sk_buff *sock_alloc_send_pskb(struct sock *sk, unsigned long header_len,
1414                                      unsigned long data_len, int noblock,
1415                                      int *errcode, int max_page_order);
1416 void *sock_kmalloc(struct sock *sk, int size, gfp_t priority);
1417 void sock_kfree_s(struct sock *sk, void *mem, int size);
1418 void sock_kzfree_s(struct sock *sk, void *mem, int size);
1419 void sk_send_sigurg(struct sock *sk);
1420
1421 struct sockcm_cookie {
1422         u32 mark;
1423         u16 tsflags;
1424 };
1425
1426 int __sock_cmsg_send(struct sock *sk, struct msghdr *msg, struct cmsghdr *cmsg,
1427                      struct sockcm_cookie *sockc);
1428 int sock_cmsg_send(struct sock *sk, struct msghdr *msg,
1429                    struct sockcm_cookie *sockc);
1430
1431 /*
1432  * Functions to fill in entries in struct proto_ops when a protocol
1433  * does not implement a particular function.
1434  */
1435 int sock_no_bind(struct socket *, struct sockaddr *, int);
1436 int sock_no_connect(struct socket *, struct sockaddr *, int, int);
1437 int sock_no_socketpair(struct socket *, struct socket *);
1438 int sock_no_accept(struct socket *, struct socket *, int);
1439 int sock_no_getname(struct socket *, struct sockaddr *, int *, int);
1440 unsigned int sock_no_poll(struct file *, struct socket *,
1441                           struct poll_table_struct *);
1442 int sock_no_ioctl(struct socket *, unsigned int, unsigned long);
1443 int sock_no_listen(struct socket *, int);
1444 int sock_no_shutdown(struct socket *, int);
1445 int sock_no_getsockopt(struct socket *, int , int, char __user *, int __user *);
1446 int sock_no_setsockopt(struct socket *, int, int, char __user *, unsigned int);
1447 int sock_no_sendmsg(struct socket *, struct msghdr *, size_t);
1448 int sock_no_recvmsg(struct socket *, struct msghdr *, size_t, int);
1449 int sock_no_mmap(struct file *file, struct socket *sock,
1450                  struct vm_area_struct *vma);
1451 ssize_t sock_no_sendpage(struct socket *sock, struct page *page, int offset,
1452                          size_t size, int flags);
1453
1454 /*
1455  * Functions to fill in entries in struct proto_ops when a protocol
1456  * uses the inet style.
1457  */
1458 int sock_common_getsockopt(struct socket *sock, int level, int optname,
1459                                   char __user *optval, int __user *optlen);
1460 int sock_common_recvmsg(struct socket *sock, struct msghdr *msg, size_t size,
1461                         int flags);
1462 int sock_common_setsockopt(struct socket *sock, int level, int optname,
1463                                   char __user *optval, unsigned int optlen);
1464 int compat_sock_common_getsockopt(struct socket *sock, int level,
1465                 int optname, char __user *optval, int __user *optlen);
1466 int compat_sock_common_setsockopt(struct socket *sock, int level,
1467                 int optname, char __user *optval, unsigned int optlen);
1468
1469 void sk_common_release(struct sock *sk);
1470
1471 /*
1472  *      Default socket callbacks and setup code
1473  */
1474
1475 /* Initialise core socket variables */
1476 void sock_init_data(struct socket *sock, struct sock *sk);
1477
1478 /*
1479  * Socket reference counting postulates.
1480  *
1481  * * Each user of socket SHOULD hold a reference count.
1482  * * Each access point to socket (an hash table bucket, reference from a list,
1483  *   running timer, skb in flight MUST hold a reference count.
1484  * * When reference count hits 0, it means it will never increase back.
1485  * * When reference count hits 0, it means that no references from
1486  *   outside exist to this socket and current process on current CPU
1487  *   is last user and may/should destroy this socket.
1488  * * sk_free is called from any context: process, BH, IRQ. When
1489  *   it is called, socket has no references from outside -> sk_free
1490  *   may release descendant resources allocated by the socket, but
1491  *   to the time when it is called, socket is NOT referenced by any
1492  *   hash tables, lists etc.
1493  * * Packets, delivered from outside (from network or from another process)
1494  *   and enqueued on receive/error queues SHOULD NOT grab reference count,
1495  *   when they sit in queue. Otherwise, packets will leak to hole, when
1496  *   socket is looked up by one cpu and unhasing is made by another CPU.
1497  *   It is true for udp/raw, netlink (leak to receive and error queues), tcp
1498  *   (leak to backlog). Packet socket does all the processing inside
1499  *   BR_NETPROTO_LOCK, so that it has not this race condition. UNIX sockets
1500  *   use separate SMP lock, so that they are prone too.
1501  */
1502
1503 /* Ungrab socket and destroy it, if it was the last reference. */
1504 static inline void sock_put(struct sock *sk)
1505 {
1506         if (atomic_dec_and_test(&sk->sk_refcnt))
1507                 sk_free(sk);
1508 }
1509 /* Generic version of sock_put(), dealing with all sockets
1510  * (TCP_TIMEWAIT, TCP_NEW_SYN_RECV, ESTABLISHED...)
1511  */
1512 void sock_gen_put(struct sock *sk);
1513
1514 int sk_receive_skb(struct sock *sk, struct sk_buff *skb, const int nested);
1515
1516 static inline void sk_tx_queue_set(struct sock *sk, int tx_queue)
1517 {
1518         sk->sk_tx_queue_mapping = tx_queue;
1519 }
1520
1521 static inline void sk_tx_queue_clear(struct sock *sk)
1522 {
1523         sk->sk_tx_queue_mapping = -1;
1524 }
1525
1526 static inline int sk_tx_queue_get(const struct sock *sk)
1527 {
1528         return sk ? sk->sk_tx_queue_mapping : -1;
1529 }
1530
1531 static inline void sk_set_socket(struct sock *sk, struct socket *sock)
1532 {
1533         sk_tx_queue_clear(sk);
1534         sk->sk_socket = sock;
1535 }
1536
1537 static inline wait_queue_head_t *sk_sleep(struct sock *sk)
1538 {
1539         BUILD_BUG_ON(offsetof(struct socket_wq, wait) != 0);
1540         return &rcu_dereference_raw(sk->sk_wq)->wait;
1541 }
1542 /* Detach socket from process context.
1543  * Announce socket dead, detach it from wait queue and inode.
1544  * Note that parent inode held reference count on this struct sock,
1545  * we do not release it in this function, because protocol
1546  * probably wants some additional cleanups or even continuing
1547  * to work with this socket (TCP).
1548  */
1549 static inline void sock_orphan(struct sock *sk)
1550 {
1551         write_lock_bh(&sk->sk_callback_lock);
1552         sock_set_flag(sk, SOCK_DEAD);
1553         sk_set_socket(sk, NULL);
1554         sk->sk_wq  = NULL;
1555         write_unlock_bh(&sk->sk_callback_lock);
1556 }
1557
1558 static inline void sock_graft(struct sock *sk, struct socket *parent)
1559 {
1560         write_lock_bh(&sk->sk_callback_lock);
1561         sk->sk_wq = parent->wq;
1562         parent->sk = sk;
1563         sk_set_socket(sk, parent);
1564         security_sock_graft(sk, parent);
1565         write_unlock_bh(&sk->sk_callback_lock);
1566 }
1567
1568 kuid_t sock_i_uid(struct sock *sk);
1569 unsigned long sock_i_ino(struct sock *sk);
1570
1571 static inline u32 net_tx_rndhash(void)
1572 {
1573         u32 v = prandom_u32();
1574
1575         return v ?: 1;
1576 }
1577
1578 static inline void sk_set_txhash(struct sock *sk)
1579 {
1580         sk->sk_txhash = net_tx_rndhash();
1581 }
1582
1583 static inline void sk_rethink_txhash(struct sock *sk)
1584 {
1585         if (sk->sk_txhash)
1586                 sk_set_txhash(sk);
1587 }
1588
1589 static inline struct dst_entry *
1590 __sk_dst_get(struct sock *sk)
1591 {
1592         return rcu_dereference_check(sk->sk_dst_cache, sock_owned_by_user(sk) ||
1593                                                        lockdep_is_held(&sk->sk_lock.slock));
1594 }
1595
1596 static inline struct dst_entry *
1597 sk_dst_get(struct sock *sk)
1598 {
1599         struct dst_entry *dst;
1600
1601         rcu_read_lock();
1602         dst = rcu_dereference(sk->sk_dst_cache);
1603         if (dst && !atomic_inc_not_zero(&dst->__refcnt))
1604                 dst = NULL;
1605         rcu_read_unlock();
1606         return dst;
1607 }
1608
1609 static inline void dst_negative_advice(struct sock *sk)
1610 {
1611         struct dst_entry *ndst, *dst = __sk_dst_get(sk);
1612
1613         sk_rethink_txhash(sk);
1614
1615         if (dst && dst->ops->negative_advice) {
1616                 ndst = dst->ops->negative_advice(dst);
1617
1618                 if (ndst != dst) {
1619                         rcu_assign_pointer(sk->sk_dst_cache, ndst);
1620                         sk_tx_queue_clear(sk);
1621                 }
1622         }
1623 }
1624
1625 static inline void
1626 __sk_dst_set(struct sock *sk, struct dst_entry *dst)
1627 {
1628         struct dst_entry *old_dst;
1629
1630         sk_tx_queue_clear(sk);
1631         /*
1632          * This can be called while sk is owned by the caller only,
1633          * with no state that can be checked in a rcu_dereference_check() cond
1634          */
1635         old_dst = rcu_dereference_raw(sk->sk_dst_cache);
1636         rcu_assign_pointer(sk->sk_dst_cache, dst);
1637         dst_release(old_dst);
1638 }
1639
1640 static inline void
1641 sk_dst_set(struct sock *sk, struct dst_entry *dst)
1642 {
1643         struct dst_entry *old_dst;
1644
1645         sk_tx_queue_clear(sk);
1646         old_dst = xchg((__force struct dst_entry **)&sk->sk_dst_cache, dst);
1647         dst_release(old_dst);
1648 }
1649
1650 static inline void
1651 __sk_dst_reset(struct sock *sk)
1652 {
1653         __sk_dst_set(sk, NULL);
1654 }
1655
1656 static inline void
1657 sk_dst_reset(struct sock *sk)
1658 {
1659         sk_dst_set(sk, NULL);
1660 }
1661
1662 struct dst_entry *__sk_dst_check(struct sock *sk, u32 cookie);
1663
1664 struct dst_entry *sk_dst_check(struct sock *sk, u32 cookie);
1665
1666 bool sk_mc_loop(struct sock *sk);
1667
1668 static inline bool sk_can_gso(const struct sock *sk)
1669 {
1670         return net_gso_ok(sk->sk_route_caps, sk->sk_gso_type);
1671 }
1672
1673 void sk_setup_caps(struct sock *sk, struct dst_entry *dst);
1674
1675 static inline void sk_nocaps_add(struct sock *sk, netdev_features_t flags)
1676 {
1677         sk->sk_route_nocaps |= flags;
1678         sk->sk_route_caps &= ~flags;
1679 }
1680
1681 static inline bool sk_check_csum_caps(struct sock *sk)
1682 {
1683         return (sk->sk_route_caps & NETIF_F_HW_CSUM) ||
1684                (sk->sk_family == PF_INET &&
1685                 (sk->sk_route_caps & NETIF_F_IP_CSUM)) ||
1686                (sk->sk_family == PF_INET6 &&
1687                 (sk->sk_route_caps & NETIF_F_IPV6_CSUM));
1688 }
1689
1690 static inline int skb_do_copy_data_nocache(struct sock *sk, struct sk_buff *skb,
1691                                            struct iov_iter *from, char *to,
1692                                            int copy, int offset)
1693 {
1694         if (skb->ip_summed == CHECKSUM_NONE) {
1695                 __wsum csum = 0;
1696                 if (csum_and_copy_from_iter(to, copy, &csum, from) != copy)
1697                         return -EFAULT;
1698                 skb->csum = csum_block_add(skb->csum, csum, offset);
1699         } else if (sk->sk_route_caps & NETIF_F_NOCACHE_COPY) {
1700                 if (copy_from_iter_nocache(to, copy, from) != copy)
1701                         return -EFAULT;
1702         } else if (copy_from_iter(to, copy, from) != copy)
1703                 return -EFAULT;
1704
1705         return 0;
1706 }
1707
1708 static inline int skb_add_data_nocache(struct sock *sk, struct sk_buff *skb,
1709                                        struct iov_iter *from, int copy)
1710 {
1711         int err, offset = skb->len;
1712
1713         err = skb_do_copy_data_nocache(sk, skb, from, skb_put(skb, copy),
1714                                        copy, offset);
1715         if (err)
1716                 __skb_trim(skb, offset);
1717
1718         return err;
1719 }
1720
1721 static inline int skb_copy_to_page_nocache(struct sock *sk, struct iov_iter *from,
1722                                            struct sk_buff *skb,
1723                                            struct page *page,
1724                                            int off, int copy)
1725 {
1726         int err;
1727
1728         err = skb_do_copy_data_nocache(sk, skb, from, page_address(page) + off,
1729                                        copy, skb->len);
1730         if (err)
1731                 return err;
1732
1733         skb->len             += copy;
1734         skb->data_len        += copy;
1735         skb->truesize        += copy;
1736         sk->sk_wmem_queued   += copy;
1737         sk_mem_charge(sk, copy);
1738         return 0;
1739 }
1740
1741 /**
1742  * sk_wmem_alloc_get - returns write allocations
1743  * @sk: socket
1744  *
1745  * Returns sk_wmem_alloc minus initial offset of one
1746  */
1747 static inline int sk_wmem_alloc_get(const struct sock *sk)
1748 {
1749         return atomic_read(&sk->sk_wmem_alloc) - 1;
1750 }
1751
1752 /**
1753  * sk_rmem_alloc_get - returns read allocations
1754  * @sk: socket
1755  *
1756  * Returns sk_rmem_alloc
1757  */
1758 static inline int sk_rmem_alloc_get(const struct sock *sk)
1759 {
1760         return atomic_read(&sk->sk_rmem_alloc);
1761 }
1762
1763 /**
1764  * sk_has_allocations - check if allocations are outstanding
1765  * @sk: socket
1766  *
1767  * Returns true if socket has write or read allocations
1768  */
1769 static inline bool sk_has_allocations(const struct sock *sk)
1770 {
1771         return sk_wmem_alloc_get(sk) || sk_rmem_alloc_get(sk);
1772 }
1773
1774 /**
1775  * skwq_has_sleeper - check if there are any waiting processes
1776  * @wq: struct socket_wq
1777  *
1778  * Returns true if socket_wq has waiting processes
1779  *
1780  * The purpose of the skwq_has_sleeper and sock_poll_wait is to wrap the memory
1781  * barrier call. They were added due to the race found within the tcp code.
1782  *
1783  * Consider following tcp code paths:
1784  *
1785  * CPU1                  CPU2
1786  *
1787  * sys_select            receive packet
1788  *   ...                 ...
1789  *   __add_wait_queue    update tp->rcv_nxt
1790  *   ...                 ...
1791  *   tp->rcv_nxt check   sock_def_readable
1792  *   ...                 {
1793  *   schedule               rcu_read_lock();
1794  *                          wq = rcu_dereference(sk->sk_wq);
1795  *                          if (wq && waitqueue_active(&wq->wait))
1796  *                              wake_up_interruptible(&wq->wait)
1797  *                          ...
1798  *                       }
1799  *
1800  * The race for tcp fires when the __add_wait_queue changes done by CPU1 stay
1801  * in its cache, and so does the tp->rcv_nxt update on CPU2 side.  The CPU1
1802  * could then endup calling schedule and sleep forever if there are no more
1803  * data on the socket.
1804  *
1805  */
1806 static inline bool skwq_has_sleeper(struct socket_wq *wq)
1807 {
1808         return wq && wq_has_sleeper(&wq->wait);
1809 }
1810
1811 /**
1812  * sock_poll_wait - place memory barrier behind the poll_wait call.
1813  * @filp:           file
1814  * @wait_address:   socket wait queue
1815  * @p:              poll_table
1816  *
1817  * See the comments in the wq_has_sleeper function.
1818  */
1819 static inline void sock_poll_wait(struct file *filp,
1820                 wait_queue_head_t *wait_address, poll_table *p)
1821 {
1822         if (!poll_does_not_wait(p) && wait_address) {
1823                 poll_wait(filp, wait_address, p);
1824                 /* We need to be sure we are in sync with the
1825                  * socket flags modification.
1826                  *
1827                  * This memory barrier is paired in the wq_has_sleeper.
1828                  */
1829                 smp_mb();
1830         }
1831 }
1832
1833 static inline void skb_set_hash_from_sk(struct sk_buff *skb, struct sock *sk)
1834 {
1835         if (sk->sk_txhash) {
1836                 skb->l4_hash = 1;
1837                 skb->hash = sk->sk_txhash;
1838         }
1839 }
1840
1841 void skb_set_owner_w(struct sk_buff *skb, struct sock *sk);
1842
1843 /*
1844  *      Queue a received datagram if it will fit. Stream and sequenced
1845  *      protocols can't normally use this as they need to fit buffers in
1846  *      and play with them.
1847  *
1848  *      Inlined as it's very short and called for pretty much every
1849  *      packet ever received.
1850  */
1851 static inline void skb_set_owner_r(struct sk_buff *skb, struct sock *sk)
1852 {
1853         skb_orphan(skb);
1854         skb->sk = sk;
1855         skb->destructor = sock_rfree;
1856         atomic_add(skb->truesize, &sk->sk_rmem_alloc);
1857         sk_mem_charge(sk, skb->truesize);
1858 }
1859
1860 void sk_reset_timer(struct sock *sk, struct timer_list *timer,
1861                     unsigned long expires);
1862
1863 void sk_stop_timer(struct sock *sk, struct timer_list *timer);
1864
1865 int sock_queue_rcv_skb(struct sock *sk, struct sk_buff *skb);
1866
1867 int sock_queue_err_skb(struct sock *sk, struct sk_buff *skb);
1868 struct sk_buff *sock_dequeue_err_skb(struct sock *sk);
1869
1870 /*
1871  *      Recover an error report and clear atomically
1872  */
1873
1874 static inline int sock_error(struct sock *sk)
1875 {
1876         int err;
1877         if (likely(!sk->sk_err))
1878                 return 0;
1879         err = xchg(&sk->sk_err, 0);
1880         return -err;
1881 }
1882
1883 static inline unsigned long sock_wspace(struct sock *sk)
1884 {
1885         int amt = 0;
1886
1887         if (!(sk->sk_shutdown & SEND_SHUTDOWN)) {
1888                 amt = sk->sk_sndbuf - atomic_read(&sk->sk_wmem_alloc);
1889                 if (amt < 0)
1890                         amt = 0;
1891         }
1892         return amt;
1893 }
1894
1895 /* Note:
1896  *  We use sk->sk_wq_raw, from contexts knowing this
1897  *  pointer is not NULL and cannot disappear/change.
1898  */
1899 static inline void sk_set_bit(int nr, struct sock *sk)
1900 {
1901         set_bit(nr, &sk->sk_wq_raw->flags);
1902 }
1903
1904 static inline void sk_clear_bit(int nr, struct sock *sk)
1905 {
1906         clear_bit(nr, &sk->sk_wq_raw->flags);
1907 }
1908
1909 static inline void sk_wake_async(const struct sock *sk, int how, int band)
1910 {
1911         if (sock_flag(sk, SOCK_FASYNC)) {
1912                 rcu_read_lock();
1913                 sock_wake_async(rcu_dereference(sk->sk_wq), how, band);
1914                 rcu_read_unlock();
1915         }
1916 }
1917
1918 /* Since sk_{r,w}mem_alloc sums skb->truesize, even a small frame might
1919  * need sizeof(sk_buff) + MTU + padding, unless net driver perform copybreak.
1920  * Note: for send buffers, TCP works better if we can build two skbs at
1921  * minimum.
1922  */
1923 #define TCP_SKB_MIN_TRUESIZE    (2048 + SKB_DATA_ALIGN(sizeof(struct sk_buff)))
1924
1925 #define SOCK_MIN_SNDBUF         (TCP_SKB_MIN_TRUESIZE * 2)
1926 #define SOCK_MIN_RCVBUF          TCP_SKB_MIN_TRUESIZE
1927
1928 static inline void sk_stream_moderate_sndbuf(struct sock *sk)
1929 {
1930         if (!(sk->sk_userlocks & SOCK_SNDBUF_LOCK)) {
1931                 sk->sk_sndbuf = min(sk->sk_sndbuf, sk->sk_wmem_queued >> 1);
1932                 sk->sk_sndbuf = max_t(u32, sk->sk_sndbuf, SOCK_MIN_SNDBUF);
1933         }
1934 }
1935
1936 struct sk_buff *sk_stream_alloc_skb(struct sock *sk, int size, gfp_t gfp,
1937                                     bool force_schedule);
1938
1939 /**
1940  * sk_page_frag - return an appropriate page_frag
1941  * @sk: socket
1942  *
1943  * If socket allocation mode allows current thread to sleep, it means its
1944  * safe to use the per task page_frag instead of the per socket one.
1945  */
1946 static inline struct page_frag *sk_page_frag(struct sock *sk)
1947 {
1948         if (gfpflags_allow_blocking(sk->sk_allocation))
1949                 return &current->task_frag;
1950
1951         return &sk->sk_frag;
1952 }
1953
1954 bool sk_page_frag_refill(struct sock *sk, struct page_frag *pfrag);
1955
1956 /*
1957  *      Default write policy as shown to user space via poll/select/SIGIO
1958  */
1959 static inline bool sock_writeable(const struct sock *sk)
1960 {
1961         return atomic_read(&sk->sk_wmem_alloc) < (sk->sk_sndbuf >> 1);
1962 }
1963
1964 static inline gfp_t gfp_any(void)
1965 {
1966         return in_softirq() ? GFP_ATOMIC : GFP_KERNEL;
1967 }
1968
1969 static inline long sock_rcvtimeo(const struct sock *sk, bool noblock)
1970 {
1971         return noblock ? 0 : sk->sk_rcvtimeo;
1972 }
1973
1974 static inline long sock_sndtimeo(const struct sock *sk, bool noblock)
1975 {
1976         return noblock ? 0 : sk->sk_sndtimeo;
1977 }
1978
1979 static inline int sock_rcvlowat(const struct sock *sk, int waitall, int len)
1980 {
1981         return (waitall ? len : min_t(int, sk->sk_rcvlowat, len)) ? : 1;
1982 }
1983
1984 /* Alas, with timeout socket operations are not restartable.
1985  * Compare this to poll().
1986  */
1987 static inline int sock_intr_errno(long timeo)
1988 {
1989         return timeo == MAX_SCHEDULE_TIMEOUT ? -ERESTARTSYS : -EINTR;
1990 }
1991
1992 struct sock_skb_cb {
1993         u32 dropcount;
1994 };
1995
1996 /* Store sock_skb_cb at the end of skb->cb[] so protocol families
1997  * using skb->cb[] would keep using it directly and utilize its
1998  * alignement guarantee.
1999  */
2000 #define SOCK_SKB_CB_OFFSET ((FIELD_SIZEOF(struct sk_buff, cb) - \
2001                             sizeof(struct sock_skb_cb)))
2002
2003 #define SOCK_SKB_CB(__skb) ((struct sock_skb_cb *)((__skb)->cb + \
2004                             SOCK_SKB_CB_OFFSET))
2005
2006 #define sock_skb_cb_check_size(size) \
2007         BUILD_BUG_ON((size) > SOCK_SKB_CB_OFFSET)
2008
2009 static inline void
2010 sock_skb_set_dropcount(const struct sock *sk, struct sk_buff *skb)
2011 {
2012         SOCK_SKB_CB(skb)->dropcount = atomic_read(&sk->sk_drops);
2013 }
2014
2015 void __sock_recv_timestamp(struct msghdr *msg, struct sock *sk,
2016                            struct sk_buff *skb);
2017 void __sock_recv_wifi_status(struct msghdr *msg, struct sock *sk,
2018                              struct sk_buff *skb);
2019
2020 static inline void
2021 sock_recv_timestamp(struct msghdr *msg, struct sock *sk, struct sk_buff *skb)
2022 {
2023         ktime_t kt = skb->tstamp;
2024         struct skb_shared_hwtstamps *hwtstamps = skb_hwtstamps(skb);
2025
2026         /*
2027          * generate control messages if
2028          * - receive time stamping in software requested
2029          * - software time stamp available and wanted
2030          * - hardware time stamps available and wanted
2031          */
2032         if (sock_flag(sk, SOCK_RCVTSTAMP) ||
2033             (sk->sk_tsflags & SOF_TIMESTAMPING_RX_SOFTWARE) ||
2034             (kt.tv64 && sk->sk_tsflags & SOF_TIMESTAMPING_SOFTWARE) ||
2035             (hwtstamps->hwtstamp.tv64 &&
2036              (sk->sk_tsflags & SOF_TIMESTAMPING_RAW_HARDWARE)))
2037                 __sock_recv_timestamp(msg, sk, skb);
2038         else
2039                 sk->sk_stamp = kt;
2040
2041         if (sock_flag(sk, SOCK_WIFI_STATUS) && skb->wifi_acked_valid)
2042                 __sock_recv_wifi_status(msg, sk, skb);
2043 }
2044
2045 void __sock_recv_ts_and_drops(struct msghdr *msg, struct sock *sk,
2046                               struct sk_buff *skb);
2047
2048 static inline void sock_recv_ts_and_drops(struct msghdr *msg, struct sock *sk,
2049                                           struct sk_buff *skb)
2050 {
2051 #define FLAGS_TS_OR_DROPS ((1UL << SOCK_RXQ_OVFL)                       | \
2052                            (1UL << SOCK_RCVTSTAMP))
2053 #define TSFLAGS_ANY       (SOF_TIMESTAMPING_SOFTWARE                    | \
2054                            SOF_TIMESTAMPING_RAW_HARDWARE)
2055
2056         if (sk->sk_flags & FLAGS_TS_OR_DROPS || sk->sk_tsflags & TSFLAGS_ANY)
2057                 __sock_recv_ts_and_drops(msg, sk, skb);
2058         else
2059                 sk->sk_stamp = skb->tstamp;
2060 }
2061
2062 void __sock_tx_timestamp(__u16 tsflags, __u8 *tx_flags);
2063
2064 /**
2065  * sock_tx_timestamp - checks whether the outgoing packet is to be time stamped
2066  * @sk:         socket sending this packet
2067  * @tsflags:    timestamping flags to use
2068  * @tx_flags:   completed with instructions for time stamping
2069  *
2070  * Note : callers should take care of initial *tx_flags value (usually 0)
2071  */
2072 static inline void sock_tx_timestamp(const struct sock *sk, __u16 tsflags,
2073                                      __u8 *tx_flags)
2074 {
2075         if (unlikely(tsflags))
2076                 __sock_tx_timestamp(tsflags, tx_flags);
2077         if (unlikely(sock_flag(sk, SOCK_WIFI_STATUS)))
2078                 *tx_flags |= SKBTX_WIFI_STATUS;
2079 }
2080
2081 /**
2082  * sk_eat_skb - Release a skb if it is no longer needed
2083  * @sk: socket to eat this skb from
2084  * @skb: socket buffer to eat
2085  *
2086  * This routine must be called with interrupts disabled or with the socket
2087  * locked so that the sk_buff queue operation is ok.
2088 */
2089 static inline void sk_eat_skb(struct sock *sk, struct sk_buff *skb)
2090 {
2091         __skb_unlink(skb, &sk->sk_receive_queue);
2092         __kfree_skb(skb);
2093 }
2094
2095 static inline
2096 struct net *sock_net(const struct sock *sk)
2097 {
2098         return read_pnet(&sk->sk_net);
2099 }
2100
2101 static inline
2102 void sock_net_set(struct sock *sk, struct net *net)
2103 {
2104         write_pnet(&sk->sk_net, net);
2105 }
2106
2107 static inline struct sock *skb_steal_sock(struct sk_buff *skb)
2108 {
2109         if (skb->sk) {
2110                 struct sock *sk = skb->sk;
2111
2112                 skb->destructor = NULL;
2113                 skb->sk = NULL;
2114                 return sk;
2115         }
2116         return NULL;
2117 }
2118
2119 /* This helper checks if a socket is a full socket,
2120  * ie _not_ a timewait or request socket.
2121  */
2122 static inline bool sk_fullsock(const struct sock *sk)
2123 {
2124         return (1 << sk->sk_state) & ~(TCPF_TIME_WAIT | TCPF_NEW_SYN_RECV);
2125 }
2126
2127 /* This helper checks if a socket is a LISTEN or NEW_SYN_RECV
2128  * SYNACK messages can be attached to either ones (depending on SYNCOOKIE)
2129  */
2130 static inline bool sk_listener(const struct sock *sk)
2131 {
2132         return (1 << sk->sk_state) & (TCPF_LISTEN | TCPF_NEW_SYN_RECV);
2133 }
2134
2135 /**
2136  * sk_state_load - read sk->sk_state for lockless contexts
2137  * @sk: socket pointer
2138  *
2139  * Paired with sk_state_store(). Used in places we do not hold socket lock :
2140  * tcp_diag_get_info(), tcp_get_info(), tcp_poll(), get_tcp4_sock() ...
2141  */
2142 static inline int sk_state_load(const struct sock *sk)
2143 {
2144         return smp_load_acquire(&sk->sk_state);
2145 }
2146
2147 /**
2148  * sk_state_store - update sk->sk_state
2149  * @sk: socket pointer
2150  * @newstate: new state
2151  *
2152  * Paired with sk_state_load(). Should be used in contexts where
2153  * state change might impact lockless readers.
2154  */
2155 static inline void sk_state_store(struct sock *sk, int newstate)
2156 {
2157         smp_store_release(&sk->sk_state, newstate);
2158 }
2159
2160 void sock_enable_timestamp(struct sock *sk, int flag);
2161 int sock_get_timestamp(struct sock *, struct timeval __user *);
2162 int sock_get_timestampns(struct sock *, struct timespec __user *);
2163 int sock_recv_errqueue(struct sock *sk, struct msghdr *msg, int len, int level,
2164                        int type);
2165
2166 bool sk_ns_capable(const struct sock *sk,
2167                    struct user_namespace *user_ns, int cap);
2168 bool sk_capable(const struct sock *sk, int cap);
2169 bool sk_net_capable(const struct sock *sk, int cap);
2170
2171 extern __u32 sysctl_wmem_max;
2172 extern __u32 sysctl_rmem_max;
2173
2174 extern int sysctl_tstamp_allow_data;
2175 extern int sysctl_optmem_max;
2176
2177 extern __u32 sysctl_wmem_default;
2178 extern __u32 sysctl_rmem_default;
2179
2180 #endif  /* _SOCK_H */