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