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