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