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