include/net/sock.h

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