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