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/kernel.h>
  44 #include <linux/list.h>
  45 #include <linux/list_nulls.h>
  46 #include <linux/timer.h>
  47 #include <linux/cache.h>
  48 #include <linux/module.h>
  49 #include <linux/lockdep.h>
  50 #include <linux/netdevice.h>
  51 #include <linux/skbuff.h>       /* struct sk_buff */
  52 #include <linux/mm.h>
  53 #include <linux/security.h>
  54
  55 #include <linux/filter.h>
  56 #include <linux/rculist_nulls.h>
  57 #include <linux/poll.h>
  58
  59 #include <asm/atomic.h>
  60 #include <net/dst.h>
  61 #include <net/checksum.h>
  62
  63 /*
  64  * This structure really needs to be cleaned up.
  65  * Most of it is for TCP, and not used by any of
  66  * the other protocols.
  67  */
  68
  69 /* Define this to get the SOCK_DBG debugging facility. */
  70 #define SOCK_DEBUGGING
  71 #ifdef SOCK_DEBUGGING
  72 #define SOCK_DEBUG(sk, msg...) do { if ((sk) && sock_flag((sk), SOCK_DBG)) \
  73                                         printk(KERN_DEBUG msg); } while (0)
  74 #else
  75 /* Validate arguments and do nothing */
  76 static void inline int __attribute__ ((format (printf, 2, 3)))
  77 SOCK_DEBUG(struct sock *sk, const char *msg, ...)
  78 {
  79 }
  80 #endif
  81
  82 /* This is the per-socket lock.  The spinlock provides a synchronization
  83  * between user contexts and software interrupt processing, whereas the
  84  * mini-semaphore synchronizes multiple users amongst themselves.
  85  */
  86 typedef struct {
  87         spinlock_t              slock;
  88         int                     owned;
  89         wait_queue_head_t       wq;
  90         /*
  91          * We express the mutex-alike socket_lock semantics
  92          * to the lock validator by explicitly managing
  93          * the slock as a lock variant (in addition to
  94          * the slock itself):
  95          */
  96 #ifdef CONFIG_DEBUG_LOCK_ALLOC
  97         struct lockdep_map dep_map;
  98 #endif
  99 } socket_lock_t;
 100
 101 struct sock;
 102 struct proto;
 103 struct net;
 104
 105 /**
 106  *      struct sock_common - minimal network layer representation of sockets
 107  *      @skc_node: main hash linkage for various protocol lookup tables
 108  *      @skc_nulls_node: main hash linkage for UDP/UDP-Lite protocol
 109  *      @skc_refcnt: reference count
 110  *      @skc_hash: hash value used with various protocol lookup tables
 111  *      @skc_family: network address family
 112  *      @skc_state: Connection state
 113  *      @skc_reuse: %SO_REUSEADDR setting
 114  *      @skc_bound_dev_if: bound device index if != 0
 115  *      @skc_bind_node: bind hash linkage for various protocol lookup tables
 116  *      @skc_prot: protocol handlers inside a network family
 117  *      @skc_net: reference to the network namespace of this socket
 118  *
 119  *      This is the minimal network layer representation of sockets, the header
 120  *      for struct sock and struct inet_timewait_sock.
 121  */
 122 struct sock_common {
 123         /*
 124          * first fields are not copied in sock_copy()
 125          */
 126         union {
 127                 struct hlist_node       skc_node;
 128                 struct hlist_nulls_node skc_nulls_node;
 129         };
 130         atomic_t                skc_refcnt;
 131
 132         unsigned int            skc_hash;
 133         unsigned short          skc_family;
 134         volatile unsigned char  skc_state;
 135         unsigned char           skc_reuse;
 136         int                     skc_bound_dev_if;
 137         struct hlist_node       skc_bind_node;
 138         struct proto            *skc_prot;
 139 #ifdef CONFIG_NET_NS
 140         struct net              *skc_net;
 141 #endif
 142 };
 143
 144 /**
 145   *     struct sock - network layer representation of sockets
 146   *     @__sk_common: shared layout with inet_timewait_sock
 147   *     @sk_shutdown: mask of %SEND_SHUTDOWN and/or %RCV_SHUTDOWN
 148   *     @sk_userlocks: %SO_SNDBUF and %SO_RCVBUF settings
 149   *     @sk_lock:       synchronizer
 150   *     @sk_rcvbuf: size of receive buffer in bytes
 151   *     @sk_sleep: sock wait queue
 152   *     @sk_dst_cache: destination cache
 153   *     @sk_dst_lock: destination cache lock
 154   *     @sk_policy: flow policy
 155   *     @sk_rmem_alloc: receive queue bytes committed
 156   *     @sk_receive_queue: incoming packets
 157   *     @sk_wmem_alloc: transmit queue bytes committed
 158   *     @sk_write_queue: Packet sending queue
 159   *     @sk_async_wait_queue: DMA copied packets
 160   *     @sk_omem_alloc: "o" is "option" or "other"
 161   *     @sk_wmem_queued: persistent queue size
 162   *     @sk_forward_alloc: space allocated forward
 163   *     @sk_allocation: allocation mode
 164   *     @sk_sndbuf: size of send buffer in bytes
 165   *     @sk_flags: %SO_LINGER (l_onoff), %SO_BROADCAST, %SO_KEEPALIVE,
 166   *                %SO_OOBINLINE settings, %SO_TIMESTAMPING settings
 167   *     @sk_no_check: %SO_NO_CHECK setting, wether or not checkup packets
 168   *     @sk_route_caps: route capabilities (e.g. %NETIF_F_TSO)
 169   *     @sk_gso_type: GSO type (e.g. %SKB_GSO_TCPV4)
 170   *     @sk_gso_max_size: Maximum GSO segment size to build
 171   *     @sk_lingertime: %SO_LINGER l_linger setting
 172   *     @sk_backlog: always used with the per-socket spinlock held
 173   *     @sk_callback_lock: used with the callbacks in the end of this struct
 174   *     @sk_error_queue: rarely used
 175   *     @sk_prot_creator: sk_prot of original sock creator (see ipv6_setsockopt,
 176   *                       IPV6_ADDRFORM for instance)
 177   *     @sk_err: last error
 178   *     @sk_err_soft: errors that don't cause failure but are the cause of a
 179   *                   persistent failure not just 'timed out'
 180   *     @sk_drops: raw/udp drops counter
 181   *     @sk_ack_backlog: current listen backlog
 182   *     @sk_max_ack_backlog: listen backlog set in listen()
 183   *     @sk_priority: %SO_PRIORITY setting
 184   *     @sk_type: socket type (%SOCK_STREAM, etc)
 185   *     @sk_protocol: which protocol this socket belongs in this network family
 186   *     @sk_peercred: %SO_PEERCRED setting
 187   *     @sk_rcvlowat: %SO_RCVLOWAT setting
 188   *     @sk_rcvtimeo: %SO_RCVTIMEO setting
 189   *     @sk_sndtimeo: %SO_SNDTIMEO setting
 190   *     @sk_filter: socket filtering instructions
 191   *     @sk_protinfo: private area, net family specific, when not using slab
 192   *     @sk_timer: sock cleanup timer
 193   *     @sk_stamp: time stamp of last packet received
 194   *     @sk_socket: Identd and reporting IO signals
 195   *     @sk_user_data: RPC layer private data
 196   *     @sk_sndmsg_page: cached page for sendmsg
 197   *     @sk_sndmsg_off: cached offset for sendmsg
 198   *     @sk_send_head: front of stuff to transmit
 199   *     @sk_security: used by security modules
 200   *     @sk_mark: generic packet mark
 201   *     @sk_write_pending: a write to stream socket waits to start
 202   *     @sk_state_change: callback to indicate change in the state of the sock
 203   *     @sk_data_ready: callback to indicate there is data to be processed
 204   *     @sk_write_space: callback to indicate there is bf sending space available
 205   *     @sk_error_report: callback to indicate errors (e.g. %MSG_ERRQUEUE)
 206   *     @sk_backlog_rcv: callback to process the backlog
 207   *     @sk_destruct: called at sock freeing time, i.e. when all refcnt == 0
 208  */
 209 struct sock {
 210         /*
 211          * Now struct inet_timewait_sock also uses sock_common, so please just
 212          * don't add nothing before this first member (__sk_common) --acme
 213          */
 214         struct sock_common      __sk_common;
 215 #define sk_node                 __sk_common.skc_node
 216 #define sk_nulls_node           __sk_common.skc_nulls_node
 217 #define sk_refcnt               __sk_common.skc_refcnt
 218
 219 #define sk_copy_start           __sk_common.skc_hash
 220 #define sk_hash                 __sk_common.skc_hash
 221 #define sk_family               __sk_common.skc_family
 222 #define sk_state                __sk_common.skc_state
 223 #define sk_reuse                __sk_common.skc_reuse
 224 #define sk_bound_dev_if         __sk_common.skc_bound_dev_if
 225 #define sk_bind_node            __sk_common.skc_bind_node
 226 #define sk_prot                 __sk_common.skc_prot
 227 #define sk_net                  __sk_common.skc_net
 228         kmemcheck_bitfield_begin(flags);
 229         unsigned int            sk_shutdown  : 2,
 230                                 sk_no_check  : 2,
 231                                 sk_userlocks : 4,
 232                                 sk_protocol  : 8,
 233                                 sk_type      : 16;
 234         kmemcheck_bitfield_end(flags);
 235         int                     sk_rcvbuf;
 236         socket_lock_t           sk_lock;
 237         /*
 238          * The backlog queue is special, it is always used with
 239          * the per-socket spinlock held and requires low latency
 240          * access. Therefore we special case it's implementation.
 241          */
 242         struct {
 243                 struct sk_buff *head;
 244                 struct sk_buff *tail;
 245         } sk_backlog;
 246         wait_queue_head_t       *sk_sleep;
 247         struct dst_entry        *sk_dst_cache;
 248 #ifdef CONFIG_XFRM
 249         struct xfrm_policy      *sk_policy[2];
 250 #endif
 251         rwlock_t                sk_dst_lock;
 252         atomic_t                sk_rmem_alloc;
 253         atomic_t                sk_wmem_alloc;
 254         atomic_t                sk_omem_alloc;
 255         int                     sk_sndbuf;
 256         struct sk_buff_head     sk_receive_queue;
 257         struct sk_buff_head     sk_write_queue;
 258 #ifdef CONFIG_NET_DMA
 259         struct sk_buff_head     sk_async_wait_queue;
 260 #endif
 261         int                     sk_wmem_queued;
 262         int                     sk_forward_alloc;
 263         gfp_t                   sk_allocation;
 264         int                     sk_route_caps;
 265         int                     sk_gso_type;
 266         unsigned int            sk_gso_max_size;
 267         int                     sk_rcvlowat;
 268         unsigned long           sk_flags;
 269         unsigned long           sk_lingertime;
 270         struct sk_buff_head     sk_error_queue;
 271         struct proto            *sk_prot_creator;
 272         rwlock_t                sk_callback_lock;
 273         int                     sk_err,
 274                                 sk_err_soft;
 275         atomic_t                sk_drops;
 276         unsigned short          sk_ack_backlog;
 277         unsigned short          sk_max_ack_backlog;
 278         __u32                   sk_priority;
 279         struct ucred            sk_peercred;
 280         long                    sk_rcvtimeo;
 281         long                    sk_sndtimeo;
 282         struct sk_filter        *sk_filter;
 283         void                    *sk_protinfo;
 284         struct timer_list       sk_timer;
 285         ktime_t                 sk_stamp;
 286         struct socket           *sk_socket;
 287         void                    *sk_user_data;
 288         struct page             *sk_sndmsg_page;
 289         struct sk_buff          *sk_send_head;
 290         __u32                   sk_sndmsg_off;
 291         int                     sk_write_pending;
 292 #ifdef CONFIG_SECURITY
 293         void                    *sk_security;
 294 #endif
 295         __u32                   sk_mark;
 296         /* XXX 4 bytes hole on 64 bit */
 297         void                    (*sk_state_change)(struct sock *sk);
 298         void                    (*sk_data_ready)(struct sock *sk, int bytes);
 299         void                    (*sk_write_space)(struct sock *sk);
 300         void                    (*sk_error_report)(struct sock *sk);
 301         int                     (*sk_backlog_rcv)(struct sock *sk,
 302                                                   struct sk_buff *skb);
 303         void                    (*sk_destruct)(struct sock *sk);
 304 };
 305
 306 /*
 307  * Hashed lists helper routines
 308  */
 309 static inline struct sock *__sk_head(const struct hlist_head *head)
 310 {
 311         return hlist_entry(head->first, struct sock, sk_node);
 312 }
 313
 314 static inline struct sock *sk_head(const struct hlist_head *head)
 315 {
 316         return hlist_empty(head) ? NULL : __sk_head(head);
 317 }
 318
 319 static inline struct sock *__sk_nulls_head(const struct hlist_nulls_head *head)
 320 {
 321         return hlist_nulls_entry(head->first, struct sock, sk_nulls_node);
 322 }
 323
 324 static inline struct sock *sk_nulls_head(const struct hlist_nulls_head *head)
 325 {
 326         return hlist_nulls_empty(head) ? NULL : __sk_nulls_head(head);
 327 }
 328
 329 static inline struct sock *sk_next(const struct sock *sk)
 330 {
 331         return sk->sk_node.next ?
 332                 hlist_entry(sk->sk_node.next, struct sock, sk_node) : NULL;
 333 }
 334
 335 static inline struct sock *sk_nulls_next(const struct sock *sk)
 336 {
 337         return (!is_a_nulls(sk->sk_nulls_node.next)) ?
 338                 hlist_nulls_entry(sk->sk_nulls_node.next,
 339                                   struct sock, sk_nulls_node) :
 340                 NULL;
 341 }
 342
 343 static inline int sk_unhashed(const struct sock *sk)
 344 {
 345         return hlist_unhashed(&sk->sk_node);
 346 }
 347
 348 static inline int sk_hashed(const struct sock *sk)
 349 {
 350         return !sk_unhashed(sk);
 351 }
 352
 353 static __inline__ void sk_node_init(struct hlist_node *node)
 354 {
 355         node->pprev = NULL;
 356 }
 357
 358 static __inline__ void sk_nulls_node_init(struct hlist_nulls_node *node)
 359 {
 360         node->pprev = NULL;
 361 }
 362
 363 static __inline__ void __sk_del_node(struct sock *sk)
 364 {
 365         __hlist_del(&sk->sk_node);
 366 }
 367
 368 static __inline__ int __sk_del_node_init(struct sock *sk)
 369 {
 370         if (sk_hashed(sk)) {
 371                 __sk_del_node(sk);
 372                 sk_node_init(&sk->sk_node);
 373                 return 1;
 374         }
 375         return 0;
 376 }
 377
 378 /* Grab socket reference count. This operation is valid only
 379    when sk is ALREADY grabbed f.e. it is found in hash table
 380    or a list and the lookup is made under lock preventing hash table
 381    modifications.
 382  */
 383
 384 static inline void sock_hold(struct sock *sk)
 385 {
 386         atomic_inc(&sk->sk_refcnt);
 387 }
 388
 389 /* Ungrab socket in the context, which assumes that socket refcnt
 390    cannot hit zero, f.e. it is true in context of any socketcall.
 391  */
 392 static inline void __sock_put(struct sock *sk)
 393 {
 394         atomic_dec(&sk->sk_refcnt);
 395 }
 396
 397 static __inline__ int sk_del_node_init(struct sock *sk)
 398 {
 399         int rc = __sk_del_node_init(sk);
 400
 401         if (rc) {
 402                 /* paranoid for a while -acme */
 403                 WARN_ON(atomic_read(&sk->sk_refcnt) == 1);
 404                 __sock_put(sk);
 405         }
 406         return rc;
 407 }
 408
 409 static __inline__ int __sk_nulls_del_node_init_rcu(struct sock *sk)
 410 {
 411         if (sk_hashed(sk)) {
 412                 hlist_nulls_del_init_rcu(&sk->sk_nulls_node);
 413                 return 1;
 414         }
 415         return 0;
 416 }
 417
 418 static __inline__ int sk_nulls_del_node_init_rcu(struct sock *sk)
 419 {
 420         int rc = __sk_nulls_del_node_init_rcu(sk);
 421
 422         if (rc) {
 423                 /* paranoid for a while -acme */
 424                 WARN_ON(atomic_read(&sk->sk_refcnt) == 1);
 425                 __sock_put(sk);
 426         }
 427         return rc;
 428 }
 429
 430 static __inline__ void __sk_add_node(struct sock *sk, struct hlist_head *list)
 431 {
 432         hlist_add_head(&sk->sk_node, list);
 433 }
 434
 435 static __inline__ void sk_add_node(struct sock *sk, struct hlist_head *list)
 436 {
 437         sock_hold(sk);
 438         __sk_add_node(sk, list);
 439 }
 440
 441 static __inline__ void __sk_nulls_add_node_rcu(struct sock *sk, struct hlist_nulls_head *list)
 442 {
 443         hlist_nulls_add_head_rcu(&sk->sk_nulls_node, list);
 444 }
 445
 446 static __inline__ void sk_nulls_add_node_rcu(struct sock *sk, struct hlist_nulls_head *list)
 447 {
 448         sock_hold(sk);
 449         __sk_nulls_add_node_rcu(sk, list);
 450 }
 451
 452 static __inline__ void __sk_del_bind_node(struct sock *sk)
 453 {
 454         __hlist_del(&sk->sk_bind_node);
 455 }
 456
 457 static __inline__ void sk_add_bind_node(struct sock *sk,
 458                                         struct hlist_head *list)
 459 {
 460         hlist_add_head(&sk->sk_bind_node, list);
 461 }
 462
 463 #define sk_for_each(__sk, node, list) \
 464         hlist_for_each_entry(__sk, node, list, sk_node)
 465 #define sk_nulls_for_each(__sk, node, list) \
 466         hlist_nulls_for_each_entry(__sk, node, list, sk_nulls_node)
 467 #define sk_nulls_for_each_rcu(__sk, node, list) \
 468         hlist_nulls_for_each_entry_rcu(__sk, node, list, sk_nulls_node)
 469 #define sk_for_each_from(__sk, node) \
 470         if (__sk && ({ node = &(__sk)->sk_node; 1; })) \
 471                 hlist_for_each_entry_from(__sk, node, sk_node)
 472 #define sk_nulls_for_each_from(__sk, node) \
 473         if (__sk && ({ node = &(__sk)->sk_nulls_node; 1; })) \
 474                 hlist_nulls_for_each_entry_from(__sk, node, sk_nulls_node)
 475 #define sk_for_each_continue(__sk, node) \
 476         if (__sk && ({ node = &(__sk)->sk_node; 1; })) \
 477                 hlist_for_each_entry_continue(__sk, node, sk_node)
 478 #define sk_for_each_safe(__sk, node, tmp, list) \
 479         hlist_for_each_entry_safe(__sk, node, tmp, list, sk_node)
 480 #define sk_for_each_bound(__sk, node, list) \
 481         hlist_for_each_entry(__sk, node, list, sk_bind_node)
 482
 483 /* Sock flags */
 484 enum sock_flags {
 485         SOCK_DEAD,
 486         SOCK_DONE,
 487         SOCK_URGINLINE,
 488         SOCK_KEEPOPEN,
 489         SOCK_LINGER,
 490         SOCK_DESTROY,
 491         SOCK_BROADCAST,
 492         SOCK_TIMESTAMP,
 493         SOCK_ZAPPED,
 494         SOCK_USE_WRITE_QUEUE, /* whether to call sk->sk_write_space in sock_wfree */
 495         SOCK_DBG, /* %SO_DEBUG setting */
 496         SOCK_RCVTSTAMP, /* %SO_TIMESTAMP setting */
 497         SOCK_RCVTSTAMPNS, /* %SO_TIMESTAMPNS setting */
 498         SOCK_LOCALROUTE, /* route locally only, %SO_DONTROUTE setting */
 499         SOCK_QUEUE_SHRUNK, /* write queue has been shrunk recently */
 500         SOCK_TIMESTAMPING_TX_HARDWARE,  /* %SOF_TIMESTAMPING_TX_HARDWARE */
 501         SOCK_TIMESTAMPING_TX_SOFTWARE,  /* %SOF_TIMESTAMPING_TX_SOFTWARE */
 502         SOCK_TIMESTAMPING_RX_HARDWARE,  /* %SOF_TIMESTAMPING_RX_HARDWARE */
 503         SOCK_TIMESTAMPING_RX_SOFTWARE,  /* %SOF_TIMESTAMPING_RX_SOFTWARE */
 504         SOCK_TIMESTAMPING_SOFTWARE,     /* %SOF_TIMESTAMPING_SOFTWARE */
 505         SOCK_TIMESTAMPING_RAW_HARDWARE, /* %SOF_TIMESTAMPING_RAW_HARDWARE */
 506         SOCK_TIMESTAMPING_SYS_HARDWARE, /* %SOF_TIMESTAMPING_SYS_HARDWARE */
 507         SOCK_FASYNC, /* fasync() active */
 508         SOCK_RXQ_OVFL,
 509 };
 510
 511 static inline void sock_copy_flags(struct sock *nsk, struct sock *osk)
 512 {
 513         nsk->sk_flags = osk->sk_flags;
 514 }
 515
 516 static inline void sock_set_flag(struct sock *sk, enum sock_flags flag)
 517 {
 518         __set_bit(flag, &sk->sk_flags);
 519 }
 520
 521 static inline void sock_reset_flag(struct sock *sk, enum sock_flags flag)
 522 {
 523         __clear_bit(flag, &sk->sk_flags);
 524 }
 525
 526 static inline int sock_flag(struct sock *sk, enum sock_flags flag)
 527 {
 528         return test_bit(flag, &sk->sk_flags);
 529 }
 530
 531 static inline void sk_acceptq_removed(struct sock *sk)
 532 {
 533         sk->sk_ack_backlog--;
 534 }
 535
 536 static inline void sk_acceptq_added(struct sock *sk)
 537 {
 538         sk->sk_ack_backlog++;
 539 }
 540
 541 static inline int sk_acceptq_is_full(struct sock *sk)
 542 {
 543         return sk->sk_ack_backlog > sk->sk_max_ack_backlog;
 544 }
 545
 546 /*
 547  * Compute minimal free write space needed to queue new packets.
 548  */
 549 static inline int sk_stream_min_wspace(struct sock *sk)
 550 {
 551         return sk->sk_wmem_queued >> 1;
 552 }
 553
 554 static inline int sk_stream_wspace(struct sock *sk)
 555 {
 556         return sk->sk_sndbuf - sk->sk_wmem_queued;
 557 }
 558
 559 extern void sk_stream_write_space(struct sock *sk);
 560
 561 static inline int sk_stream_memory_free(struct sock *sk)
 562 {
 563         return sk->sk_wmem_queued < sk->sk_sndbuf;
 564 }
 565
 566 /* The per-socket spinlock must be held here. */
 567 static inline void sk_add_backlog(struct sock *sk, struct sk_buff *skb)
 568 {
 569         if (!sk->sk_backlog.tail) {
 570                 sk->sk_backlog.head = sk->sk_backlog.tail = skb;
 571         } else {
 572                 sk->sk_backlog.tail->next = skb;
 573                 sk->sk_backlog.tail = skb;
 574         }
 575         skb->next = NULL;
 576 }
 577
 578 static inline int sk_backlog_rcv(struct sock *sk, struct sk_buff *skb)
 579 {
 580         return sk->sk_backlog_rcv(sk, skb);
 581 }
 582
 583 #define sk_wait_event(__sk, __timeo, __condition)                       \
 584         ({      int __rc;                                               \
 585                 release_sock(__sk);                                     \
 586                 __rc = __condition;                                     \
 587                 if (!__rc) {                                            \
 588                         *(__timeo) = schedule_timeout(*(__timeo));      \
 589                 }                                                       \
 590                 lock_sock(__sk);                                        \
 591                 __rc = __condition;                                     \
 592                 __rc;                                                   \
 593         })
 594
 595 extern int sk_stream_wait_connect(struct sock *sk, long *timeo_p);
 596 extern int sk_stream_wait_memory(struct sock *sk, long *timeo_p);
 597 extern void sk_stream_wait_close(struct sock *sk, long timeo_p);
 598 extern int sk_stream_error(struct sock *sk, int flags, int err);
 599 extern void sk_stream_kill_queues(struct sock *sk);
 600
 601 extern int sk_wait_data(struct sock *sk, long *timeo);
 602
 603 struct request_sock_ops;
 604 struct timewait_sock_ops;
 605 struct inet_hashinfo;
 606 struct raw_hashinfo;
 607
 608 /* Networking protocol blocks we attach to sockets.
 609  * socket layer -> transport layer interface
 610  * transport -> network interface is defined by struct inet_proto
 611  */
 612 struct proto {
 613         void                    (*close)(struct sock *sk,
 614                                         long timeout);
 615         int                     (*connect)(struct sock *sk,
 616                                         struct sockaddr *uaddr,
 617                                         int addr_len);
 618         int                     (*disconnect)(struct sock *sk, int flags);
 619
 620         struct sock *           (*accept) (struct sock *sk, int flags, int *err);
 621
 622         int                     (*ioctl)(struct sock *sk, int cmd,
 623                                          unsigned long arg);
 624         int                     (*init)(struct sock *sk);
 625         void                    (*destroy)(struct sock *sk);
 626         void                    (*shutdown)(struct sock *sk, int how);
 627         int                     (*setsockopt)(struct sock *sk, int level,
 628                                         int optname, char __user *optval,
 629                                         unsigned int optlen);
 630         int                     (*getsockopt)(struct sock *sk, int level,
 631                                         int optname, char __user *optval,
 632                                         int __user *option);
 633 #ifdef CONFIG_COMPAT
 634         int                     (*compat_setsockopt)(struct sock *sk,
 635                                         int level,
 636                                         int optname, char __user *optval,
 637                                         unsigned int optlen);
 638         int                     (*compat_getsockopt)(struct sock *sk,
 639                                         int level,
 640                                         int optname, char __user *optval,
 641                                         int __user *option);
 642 #endif
 643         int                     (*sendmsg)(struct kiocb *iocb, struct sock *sk,
 644                                            struct msghdr *msg, size_t len);
 645         int                     (*recvmsg)(struct kiocb *iocb, struct sock *sk,
 646                                            struct msghdr *msg,
 647                                         size_t len, int noblock, int flags,
 648                                         int *addr_len);
 649         int                     (*sendpage)(struct sock *sk, struct page *page,
 650                                         int offset, size_t size, int flags);
 651         int                     (*bind)(struct sock *sk,
 652                                         struct sockaddr *uaddr, int addr_len);
 653
 654         int                     (*backlog_rcv) (struct sock *sk,
 655                                                 struct sk_buff *skb);
 656
 657         /* Keeping track of sk's, looking them up, and port selection methods. */
 658         void                    (*hash)(struct sock *sk);
 659         void                    (*unhash)(struct sock *sk);
 660         int                     (*get_port)(struct sock *sk, unsigned short snum);
 661
 662         /* Keeping track of sockets in use */
 663 #ifdef CONFIG_PROC_FS
 664         unsigned int            inuse_idx;
 665 #endif
 666
 667         /* Memory pressure */
 668         void                    (*enter_memory_pressure)(struct sock *sk);
 669         atomic_t                *memory_allocated;      /* Current allocated memory. */
 670         struct percpu_counter   *sockets_allocated;     /* Current number of sockets. */
 671         /*
 672          * Pressure flag: try to collapse.
 673          * Technical note: it is used by multiple contexts non atomically.
 674          * All the __sk_mem_schedule() is of this nature: accounting
 675          * is strict, actions are advisory and have some latency.
 676          */
 677         int                     *memory_pressure;
 678         int                     *sysctl_mem;
 679         int                     *sysctl_wmem;
 680         int                     *sysctl_rmem;
 681         int                     max_header;
 682
 683         struct kmem_cache       *slab;
 684         unsigned int            obj_size;
 685         int                     slab_flags;
 686
 687         struct percpu_counter   *orphan_count;
 688
 689         struct request_sock_ops *rsk_prot;
 690         struct timewait_sock_ops *twsk_prot;
 691
 692         union {
 693                 struct inet_hashinfo    *hashinfo;
 694                 struct udp_table        *udp_table;
 695                 struct raw_hashinfo     *raw_hash;
 696         } h;
 697
 698         struct module           *owner;
 699
 700         char                    name[32];
 701
 702         struct list_head        node;
 703 #ifdef SOCK_REFCNT_DEBUG
 704         atomic_t                socks;
 705 #endif
 706 };
 707
 708 extern int proto_register(struct proto *prot, int alloc_slab);
 709 extern void proto_unregister(struct proto *prot);
 710
 711 #ifdef SOCK_REFCNT_DEBUG
 712 static inline void sk_refcnt_debug_inc(struct sock *sk)
 713 {
 714         atomic_inc(&sk->sk_prot->socks);
 715 }
 716
 717 static inline void sk_refcnt_debug_dec(struct sock *sk)
 718 {
 719         atomic_dec(&sk->sk_prot->socks);
 720         printk(KERN_DEBUG "%s socket %p released, %d are still alive\n",
 721                sk->sk_prot->name, sk, atomic_read(&sk->sk_prot->socks));
 722 }
 723
 724 static inline void sk_refcnt_debug_release(const struct sock *sk)
 725 {
 726         if (atomic_read(&sk->sk_refcnt) != 1)
 727                 printk(KERN_DEBUG "Destruction of the %s socket %p delayed, refcnt=%d\n",
 728                        sk->sk_prot->name, sk, atomic_read(&sk->sk_refcnt));
 729 }
 730 #else /* SOCK_REFCNT_DEBUG */
 731 #define sk_refcnt_debug_inc(sk) do { } while (0)
 732 #define sk_refcnt_debug_dec(sk) do { } while (0)
 733 #define sk_refcnt_debug_release(sk) do { } while (0)
 734 #endif /* SOCK_REFCNT_DEBUG */
 735
 736
 737 #ifdef CONFIG_PROC_FS
 738 /* Called with local bh disabled */
 739 extern void sock_prot_inuse_add(struct net *net, struct proto *prot, int inc);
 740 extern int sock_prot_inuse_get(struct net *net, struct proto *proto);
 741 #else
 742 static void inline sock_prot_inuse_add(struct net *net, struct proto *prot,
 743                 int inc)
 744 {
 745 }
 746 #endif
 747
 748
 749 /* With per-bucket locks this operation is not-atomic, so that
 750  * this version is not worse.
 751  */
 752 static inline void __sk_prot_rehash(struct sock *sk)
 753 {
 754         sk->sk_prot->unhash(sk);
 755         sk->sk_prot->hash(sk);
 756 }
 757
 758 /* About 10 seconds */
 759 #define SOCK_DESTROY_TIME (10*HZ)
 760
 761 /* Sockets 0-1023 can't be bound to unless you are superuser */
 762 #define PROT_SOCK       1024
 763
 764 #define SHUTDOWN_MASK   3
 765 #define RCV_SHUTDOWN    1
 766 #define SEND_SHUTDOWN   2
 767
 768 #define SOCK_SNDBUF_LOCK        1
 769 #define SOCK_RCVBUF_LOCK        2
 770 #define SOCK_BINDADDR_LOCK      4
 771 #define SOCK_BINDPORT_LOCK      8
 772
 773 /* sock_iocb: used to kick off async processing of socket ios */
 774 struct sock_iocb {
 775         struct list_head        list;
 776
 777         int                     flags;
 778         int                     size;
 779         struct socket           *sock;
 780         struct sock             *sk;
 781         struct scm_cookie       *scm;
 782         struct msghdr           *msg, async_msg;
 783         struct kiocb            *kiocb;
 784 };
 785
 786 static inline struct sock_iocb *kiocb_to_siocb(struct kiocb *iocb)
 787 {
 788         return (struct sock_iocb *)iocb->private;
 789 }
 790
 791 static inline struct kiocb *siocb_to_kiocb(struct sock_iocb *si)
 792 {
 793         return si->kiocb;
 794 }
 795
 796 struct socket_alloc {
 797         struct socket socket;
 798         struct inode vfs_inode;
 799 };
 800
 801 static inline struct socket *SOCKET_I(struct inode *inode)
 802 {
 803         return &container_of(inode, struct socket_alloc, vfs_inode)->socket;
 804 }
 805
 806 static inline struct inode *SOCK_INODE(struct socket *socket)
 807 {
 808         return &container_of(socket, struct socket_alloc, socket)->vfs_inode;
 809 }
 810
 811 /*
 812  * Functions for memory accounting
 813  */
 814 extern int __sk_mem_schedule(struct sock *sk, int size, int kind);
 815 extern void __sk_mem_reclaim(struct sock *sk);
 816
 817 #define SK_MEM_QUANTUM ((int)PAGE_SIZE)
 818 #define SK_MEM_QUANTUM_SHIFT ilog2(SK_MEM_QUANTUM)
 819 #define SK_MEM_SEND     0
 820 #define SK_MEM_RECV     1
 821
 822 static inline int sk_mem_pages(int amt)
 823 {
 824         return (amt + SK_MEM_QUANTUM - 1) >> SK_MEM_QUANTUM_SHIFT;
 825 }
 826
 827 static inline int sk_has_account(struct sock *sk)
 828 {
 829         /* return true if protocol supports memory accounting */
 830         return !!sk->sk_prot->memory_allocated;
 831 }
 832
 833 static inline int sk_wmem_schedule(struct sock *sk, int size)
 834 {
 835         if (!sk_has_account(sk))
 836                 return 1;
 837         return size <= sk->sk_forward_alloc ||
 838                 __sk_mem_schedule(sk, size, SK_MEM_SEND);
 839 }
 840
 841 static inline int sk_rmem_schedule(struct sock *sk, int size)
 842 {
 843         if (!sk_has_account(sk))
 844                 return 1;
 845         return size <= sk->sk_forward_alloc ||
 846                 __sk_mem_schedule(sk, size, SK_MEM_RECV);
 847 }
 848
 849 static inline void sk_mem_reclaim(struct sock *sk)
 850 {
 851         if (!sk_has_account(sk))
 852                 return;
 853         if (sk->sk_forward_alloc >= SK_MEM_QUANTUM)
 854                 __sk_mem_reclaim(sk);
 855 }
 856
 857 static inline void sk_mem_reclaim_partial(struct sock *sk)
 858 {
 859         if (!sk_has_account(sk))
 860                 return;
 861         if (sk->sk_forward_alloc > SK_MEM_QUANTUM)
 862                 __sk_mem_reclaim(sk);
 863 }
 864
 865 static inline void sk_mem_charge(struct sock *sk, int size)
 866 {
 867         if (!sk_has_account(sk))
 868                 return;
 869         sk->sk_forward_alloc -= size;
 870 }
 871
 872 static inline void sk_mem_uncharge(struct sock *sk, int size)
 873 {
 874         if (!sk_has_account(sk))
 875                 return;
 876         sk->sk_forward_alloc += size;
 877 }
 878
 879 static inline void sk_wmem_free_skb(struct sock *sk, struct sk_buff *skb)
 880 {
 881         sock_set_flag(sk, SOCK_QUEUE_SHRUNK);
 882         sk->sk_wmem_queued -= skb->truesize;
 883         sk_mem_uncharge(sk, skb->truesize);
 884         __kfree_skb(skb);
 885 }
 886
 887 /* Used by processes to "lock" a socket state, so that
 888  * interrupts and bottom half handlers won't change it
 889  * from under us. It essentially blocks any incoming
 890  * packets, so that we won't get any new data or any
 891  * packets that change the state of the socket.
 892  *
 893  * While locked, BH processing will add new packets to
 894  * the backlog queue.  This queue is processed by the
 895  * owner of the socket lock right before it is released.
 896  *
 897  * Since ~2.3.5 it is also exclusive sleep lock serializing
 898  * accesses from user process context.
 899  */
 900 #define sock_owned_by_user(sk)  ((sk)->sk_lock.owned)
 901
 902 /*
 903  * Macro so as to not evaluate some arguments when
 904  * lockdep is not enabled.
 905  *
 906  * Mark both the sk_lock and the sk_lock.slock as a
 907  * per-address-family lock class.
 908  */
 909 #define sock_lock_init_class_and_name(sk, sname, skey, name, key)       \
 910 do {                                                                    \
 911         sk->sk_lock.owned = 0;                                          \
 912         init_waitqueue_head(&sk->sk_lock.wq);                           \
 913         spin_lock_init(&(sk)->sk_lock.slock);                           \
 914         debug_check_no_locks_freed((void *)&(sk)->sk_lock,              \
 915                         sizeof((sk)->sk_lock));                         \
 916         lockdep_set_class_and_name(&(sk)->sk_lock.slock,                \
 917                         (skey), (sname));                               \
 918         lockdep_init_map(&(sk)->sk_lock.dep_map, (name), (key), 0);     \
 919 } while (0)
 920
 921 extern void lock_sock_nested(struct sock *sk, int subclass);
 922
 923 static inline void lock_sock(struct sock *sk)
 924 {
 925         lock_sock_nested(sk, 0);
 926 }
 927
 928 extern void release_sock(struct sock *sk);
 929
 930 /* BH context may only use the following locking interface. */
 931 #define bh_lock_sock(__sk)      spin_lock(&((__sk)->sk_lock.slock))
 932 #define bh_lock_sock_nested(__sk) \
 933                                 spin_lock_nested(&((__sk)->sk_lock.slock), \
 934                                 SINGLE_DEPTH_NESTING)
 935 #define bh_unlock_sock(__sk)    spin_unlock(&((__sk)->sk_lock.slock))
 936
 937 extern struct sock              *sk_alloc(struct net *net, int family,
 938                                           gfp_t priority,
 939                                           struct proto *prot);
 940 extern void                     sk_free(struct sock *sk);
 941 extern void                     sk_release_kernel(struct sock *sk);
 942 extern struct sock              *sk_clone(const struct sock *sk,
 943                                           const gfp_t priority);
 944
 945 extern struct sk_buff           *sock_wmalloc(struct sock *sk,
 946                                               unsigned long size, int force,
 947                                               gfp_t priority);
 948 extern struct sk_buff           *sock_rmalloc(struct sock *sk,
 949                                               unsigned long size, int force,
 950                                               gfp_t priority);
 951 extern void                     sock_wfree(struct sk_buff *skb);
 952 extern void                     sock_rfree(struct sk_buff *skb);
 953
 954 extern int                      sock_setsockopt(struct socket *sock, int level,
 955                                                 int op, char __user *optval,
 956                                                 unsigned int optlen);
 957
 958 extern int                      sock_getsockopt(struct socket *sock, int level,
 959                                                 int op, char __user *optval,
 960                                                 int __user *optlen);
 961 extern struct sk_buff           *sock_alloc_send_skb(struct sock *sk,
 962                                                      unsigned long size,
 963                                                      int noblock,
 964                                                      int *errcode);
 965 extern struct sk_buff           *sock_alloc_send_pskb(struct sock *sk,
 966                                                       unsigned long header_len,
 967                                                       unsigned long data_len,
 968                                                       int noblock,
 969                                                       int *errcode);
 970 extern void *sock_kmalloc(struct sock *sk, int size,
 971                           gfp_t priority);
 972 extern void sock_kfree_s(struct sock *sk, void *mem, int size);
 973 extern void sk_send_sigurg(struct sock *sk);
 974
 975 /*
 976  * Functions to fill in entries in struct proto_ops when a protocol
 977  * does not implement a particular function.
 978  */
 979 extern int                      sock_no_bind(struct socket *,
 980                                              struct sockaddr *, int);
 981 extern int                      sock_no_connect(struct socket *,
 982                                                 struct sockaddr *, int, int);
 983 extern int                      sock_no_socketpair(struct socket *,
 984                                                    struct socket *);
 985 extern int                      sock_no_accept(struct socket *,
 986                                                struct socket *, int);
 987 extern int                      sock_no_getname(struct socket *,
 988                                                 struct sockaddr *, int *, int);
 989 extern unsigned int             sock_no_poll(struct file *, struct socket *,
 990                                              struct poll_table_struct *);
 991 extern int                      sock_no_ioctl(struct socket *, unsigned int,
 992                                               unsigned long);
 993 extern int                      sock_no_listen(struct socket *, int);
 994 extern int                      sock_no_shutdown(struct socket *, int);
 995 extern int                      sock_no_getsockopt(struct socket *, int , int,
 996                                                    char __user *, int __user *);
 997 extern int                      sock_no_setsockopt(struct socket *, int, int,
 998                                                    char __user *, unsigned int);
 999 extern int                      sock_no_sendmsg(struct kiocb *, struct socket *,
1000                                                 struct msghdr *, size_t);
1001 extern int                      sock_no_recvmsg(struct kiocb *, struct socket *,
1002                                                 struct msghdr *, size_t, int);
1003 extern int                      sock_no_mmap(struct file *file,
1004                                              struct socket *sock,
1005                                              struct vm_area_struct *vma);
1006 extern ssize_t                  sock_no_sendpage(struct socket *sock,
1007                                                 struct page *page,
1008                                                 int offset, size_t size,
1009                                                 int flags);
1010
1011 /*
1012  * Functions to fill in entries in struct proto_ops when a protocol
1013  * uses the inet style.
1014  */
1015 extern int sock_common_getsockopt(struct socket *sock, int level, int optname,
1016                                   char __user *optval, int __user *optlen);
1017 extern int sock_common_recvmsg(struct kiocb *iocb, struct socket *sock,
1018                                struct msghdr *msg, size_t size, int flags);
1019 extern int sock_common_setsockopt(struct socket *sock, int level, int optname,
1020                                   char __user *optval, unsigned int optlen);
1021 extern int compat_sock_common_getsockopt(struct socket *sock, int level,
1022                 int optname, char __user *optval, int __user *optlen);
1023 extern int compat_sock_common_setsockopt(struct socket *sock, int level,
1024                 int optname, char __user *optval, unsigned int optlen);
1025
1026 extern void sk_common_release(struct sock *sk);
1027
1028 /*
1029  *      Default socket callbacks and setup code
1030  */
1031
1032 /* Initialise core socket variables */
1033 extern void sock_init_data(struct socket *sock, struct sock *sk);
1034
1035 /**
1036  *      sk_filter_release: Release a socket filter
1037  *      @fp: filter to remove
1038  *
1039  *      Remove a filter from a socket and release its resources.
1040  */
1041
1042 static inline void sk_filter_release(struct sk_filter *fp)
1043 {
1044         if (atomic_dec_and_test(&fp->refcnt))
1045                 kfree(fp);
1046 }
1047
1048 static inline void sk_filter_uncharge(struct sock *sk, struct sk_filter *fp)
1049 {
1050         unsigned int size = sk_filter_len(fp);
1051
1052         atomic_sub(size, &sk->sk_omem_alloc);
1053         sk_filter_release(fp);
1054 }
1055
1056 static inline void sk_filter_charge(struct sock *sk, struct sk_filter *fp)
1057 {
1058         atomic_inc(&fp->refcnt);
1059         atomic_add(sk_filter_len(fp), &sk->sk_omem_alloc);
1060 }
1061
1062 /*
1063  * Socket reference counting postulates.
1064  *
1065  * * Each user of socket SHOULD hold a reference count.
1066  * * Each access point to socket (an hash table bucket, reference from a list,
1067  *   running timer, skb in flight MUST hold a reference count.
1068  * * When reference count hits 0, it means it will never increase back.
1069  * * When reference count hits 0, it means that no references from
1070  *   outside exist to this socket and current process on current CPU
1071  *   is last user and may/should destroy this socket.
1072  * * sk_free is called from any context: process, BH, IRQ. When
1073  *   it is called, socket has no references from outside -> sk_free
1074  *   may release descendant resources allocated by the socket, but
1075  *   to the time when it is called, socket is NOT referenced by any
1076  *   hash tables, lists etc.
1077  * * Packets, delivered from outside (from network or from another process)
1078  *   and enqueued on receive/error queues SHOULD NOT grab reference count,
1079  *   when they sit in queue. Otherwise, packets will leak to hole, when
1080  *   socket is looked up by one cpu and unhasing is made by another CPU.
1081  *   It is true for udp/raw, netlink (leak to receive and error queues), tcp
1082  *   (leak to backlog). Packet socket does all the processing inside
1083  *   BR_NETPROTO_LOCK, so that it has not this race condition. UNIX sockets
1084  *   use separate SMP lock, so that they are prone too.
1085  */
1086
1087 /* Ungrab socket and destroy it, if it was the last reference. */
1088 static inline void sock_put(struct sock *sk)
1089 {
1090         if (atomic_dec_and_test(&sk->sk_refcnt))
1091                 sk_free(sk);
1092 }
1093
1094 extern int sk_receive_skb(struct sock *sk, struct sk_buff *skb,
1095                           const int nested);
1096
1097 static inline void sk_set_socket(struct sock *sk, struct socket *sock)
1098 {
1099         sk->sk_socket = sock;
1100 }
1101
1102 /* Detach socket from process context.
1103  * Announce socket dead, detach it from wait queue and inode.
1104  * Note that parent inode held reference count on this struct sock,
1105  * we do not release it in this function, because protocol
1106  * probably wants some additional cleanups or even continuing
1107  * to work with this socket (TCP).
1108  */
1109 static inline void sock_orphan(struct sock *sk)
1110 {
1111         write_lock_bh(&sk->sk_callback_lock);
1112         sock_set_flag(sk, SOCK_DEAD);
1113         sk_set_socket(sk, NULL);
1114         sk->sk_sleep  = NULL;
1115         write_unlock_bh(&sk->sk_callback_lock);
1116 }
1117
1118 static inline void sock_graft(struct sock *sk, struct socket *parent)
1119 {
1120         write_lock_bh(&sk->sk_callback_lock);
1121         sk->sk_sleep = &parent->wait;
1122         parent->sk = sk;
1123         sk_set_socket(sk, parent);
1124         security_sock_graft(sk, parent);
1125         write_unlock_bh(&sk->sk_callback_lock);
1126 }
1127
1128 extern int sock_i_uid(struct sock *sk);
1129 extern unsigned long sock_i_ino(struct sock *sk);
1130
1131 static inline struct dst_entry *
1132 __sk_dst_get(struct sock *sk)
1133 {
1134         return sk->sk_dst_cache;
1135 }
1136
1137 static inline struct dst_entry *
1138 sk_dst_get(struct sock *sk)
1139 {
1140         struct dst_entry *dst;
1141
1142         read_lock(&sk->sk_dst_lock);
1143         dst = sk->sk_dst_cache;
1144         if (dst)
1145                 dst_hold(dst);
1146         read_unlock(&sk->sk_dst_lock);
1147         return dst;
1148 }
1149
1150 static inline void
1151 __sk_dst_set(struct sock *sk, struct dst_entry *dst)
1152 {
1153         struct dst_entry *old_dst;
1154
1155         old_dst = sk->sk_dst_cache;
1156         sk->sk_dst_cache = dst;
1157         dst_release(old_dst);
1158 }
1159
1160 static inline void
1161 sk_dst_set(struct sock *sk, struct dst_entry *dst)
1162 {
1163         write_lock(&sk->sk_dst_lock);
1164         __sk_dst_set(sk, dst);
1165         write_unlock(&sk->sk_dst_lock);
1166 }
1167
1168 static inline void
1169 __sk_dst_reset(struct sock *sk)
1170 {
1171         struct dst_entry *old_dst;
1172
1173         old_dst = sk->sk_dst_cache;
1174         sk->sk_dst_cache = NULL;
1175         dst_release(old_dst);
1176 }
1177
1178 static inline void
1179 sk_dst_reset(struct sock *sk)
1180 {
1181         write_lock(&sk->sk_dst_lock);
1182         __sk_dst_reset(sk);
1183         write_unlock(&sk->sk_dst_lock);
1184 }
1185
1186 extern struct dst_entry *__sk_dst_check(struct sock *sk, u32 cookie);
1187
1188 extern struct dst_entry *sk_dst_check(struct sock *sk, u32 cookie);
1189
1190 static inline int sk_can_gso(const struct sock *sk)
1191 {
1192         return net_gso_ok(sk->sk_route_caps, sk->sk_gso_type);
1193 }
1194
1195 extern void sk_setup_caps(struct sock *sk, struct dst_entry *dst);
1196
1197 static inline int skb_copy_to_page(struct sock *sk, char __user *from,
1198                                    struct sk_buff *skb, struct page *page,
1199                                    int off, int copy)
1200 {
1201         if (skb->ip_summed == CHECKSUM_NONE) {
1202                 int err = 0;
1203                 __wsum csum = csum_and_copy_from_user(from,
1204                                                      page_address(page) + off,
1205                                                             copy, 0, &err);
1206                 if (err)
1207                         return err;
1208                 skb->csum = csum_block_add(skb->csum, csum, skb->len);
1209         } else if (copy_from_user(page_address(page) + off, from, copy))
1210                 return -EFAULT;
1211
1212         skb->len             += copy;
1213         skb->data_len        += copy;
1214         skb->truesize        += copy;
1215         sk->sk_wmem_queued   += copy;
1216         sk_mem_charge(sk, copy);
1217         return 0;
1218 }
1219
1220 /**
1221  * sk_wmem_alloc_get - returns write allocations
1222  * @sk: socket
1223  *
1224  * Returns sk_wmem_alloc minus initial offset of one
1225  */
1226 static inline int sk_wmem_alloc_get(const struct sock *sk)
1227 {
1228         return atomic_read(&sk->sk_wmem_alloc) - 1;
1229 }
1230
1231 /**
1232  * sk_rmem_alloc_get - returns read allocations
1233  * @sk: socket
1234  *
1235  * Returns sk_rmem_alloc
1236  */
1237 static inline int sk_rmem_alloc_get(const struct sock *sk)
1238 {
1239         return atomic_read(&sk->sk_rmem_alloc);
1240 }
1241
1242 /**
1243  * sk_has_allocations - check if allocations are outstanding
1244  * @sk: socket
1245  *
1246  * Returns true if socket has write or read allocations
1247  */
1248 static inline int sk_has_allocations(const struct sock *sk)
1249 {
1250         return sk_wmem_alloc_get(sk) || sk_rmem_alloc_get(sk);
1251 }
1252
1253 /**
1254  * sk_has_sleeper - check if there are any waiting processes
1255  * @sk: socket
1256  *
1257  * Returns true if socket has waiting processes
1258  *
1259  * The purpose of the sk_has_sleeper and sock_poll_wait is to wrap the memory
1260  * barrier call. They were added due to the race found within the tcp code.
1261  *
1262  * Consider following tcp code paths:
1263  *
1264  * CPU1                  CPU2
1265  *
1266  * sys_select            receive packet
1267  *   ...                 ...
1268  *   __add_wait_queue    update tp->rcv_nxt
1269  *   ...                 ...
1270  *   tp->rcv_nxt check   sock_def_readable
1271  *   ...                 {
1272  *   schedule               ...
1273  *                          if (sk->sk_sleep && waitqueue_active(sk->sk_sleep))
1274  *                              wake_up_interruptible(sk->sk_sleep)
1275  *                          ...
1276  *                       }
1277  *
1278  * The race for tcp fires when the __add_wait_queue changes done by CPU1 stay
1279  * in its cache, and so does the tp->rcv_nxt update on CPU2 side.  The CPU1
1280  * could then endup calling schedule and sleep forever if there are no more
1281  * data on the socket.
1282  *
1283  * The sk_has_sleeper is always called right after a call to read_lock, so we
1284  * can use smp_mb__after_lock barrier.
1285  */
1286 static inline int sk_has_sleeper(struct sock *sk)
1287 {
1288         /*
1289          * We need to be sure we are in sync with the
1290          * add_wait_queue modifications to the wait queue.
1291          *
1292          * This memory barrier is paired in the sock_poll_wait.
1293          */
1294         smp_mb__after_lock();
1295         return sk->sk_sleep && waitqueue_active(sk->sk_sleep);
1296 }
1297
1298 /**
1299  * sock_poll_wait - place memory barrier behind the poll_wait call.
1300  * @filp:           file
1301  * @wait_address:   socket wait queue
1302  * @p:              poll_table
1303  *
1304  * See the comments in the sk_has_sleeper function.
1305  */
1306 static inline void sock_poll_wait(struct file *filp,
1307                 wait_queue_head_t *wait_address, poll_table *p)
1308 {
1309         if (p && wait_address) {
1310                 poll_wait(filp, wait_address, p);
1311                 /*
1312                  * We need to be sure we are in sync with the
1313                  * socket flags modification.
1314                  *
1315                  * This memory barrier is paired in the sk_has_sleeper.
1316                 */
1317                 smp_mb();
1318         }
1319 }
1320
1321 /*
1322  *      Queue a received datagram if it will fit. Stream and sequenced
1323  *      protocols can't normally use this as they need to fit buffers in
1324  *      and play with them.
1325  *
1326  *      Inlined as it's very short and called for pretty much every
1327  *      packet ever received.
1328  */
1329
1330 static inline void skb_set_owner_w(struct sk_buff *skb, struct sock *sk)
1331 {
1332         skb_orphan(skb);
1333         skb->sk = sk;
1334         skb->destructor = sock_wfree;
1335         /*
1336          * We used to take a refcount on sk, but following operation
1337          * is enough to guarantee sk_free() wont free this sock until
1338          * all in-flight packets are completed
1339          */
1340         atomic_add(skb->truesize, &sk->sk_wmem_alloc);
1341 }
1342
1343 static inline void skb_set_owner_r(struct sk_buff *skb, struct sock *sk)
1344 {
1345         skb_orphan(skb);
1346         skb->sk = sk;
1347         skb->destructor = sock_rfree;
1348         atomic_add(skb->truesize, &sk->sk_rmem_alloc);
1349         sk_mem_charge(sk, skb->truesize);
1350 }
1351
1352 extern void sk_reset_timer(struct sock *sk, struct timer_list* timer,
1353                            unsigned long expires);
1354
1355 extern void sk_stop_timer(struct sock *sk, struct timer_list* timer);
1356
1357 extern int sock_queue_rcv_skb(struct sock *sk, struct sk_buff *skb);
1358
1359 static inline int sock_queue_err_skb(struct sock *sk, struct sk_buff *skb)
1360 {
1361         /* Cast skb->rcvbuf to unsigned... It's pointless, but reduces
1362            number of warnings when compiling with -W --ANK
1363          */
1364         if (atomic_read(&sk->sk_rmem_alloc) + skb->truesize >=
1365             (unsigned)sk->sk_rcvbuf)
1366                 return -ENOMEM;
1367         skb_set_owner_r(skb, sk);
1368         skb_queue_tail(&sk->sk_error_queue, skb);
1369         if (!sock_flag(sk, SOCK_DEAD))
1370                 sk->sk_data_ready(sk, skb->len);
1371         return 0;
1372 }
1373
1374 /*
1375  *      Recover an error report and clear atomically
1376  */
1377
1378 static inline int sock_error(struct sock *sk)
1379 {
1380         int err;
1381         if (likely(!sk->sk_err))
1382                 return 0;
1383         err = xchg(&sk->sk_err, 0);
1384         return -err;
1385 }
1386
1387 static inline unsigned long sock_wspace(struct sock *sk)
1388 {
1389         int amt = 0;
1390
1391         if (!(sk->sk_shutdown & SEND_SHUTDOWN)) {
1392                 amt = sk->sk_sndbuf - atomic_read(&sk->sk_wmem_alloc);
1393                 if (amt < 0)
1394                         amt = 0;
1395         }
1396         return amt;
1397 }
1398
1399 static inline void sk_wake_async(struct sock *sk, int how, int band)
1400 {
1401         if (sock_flag(sk, SOCK_FASYNC))
1402                 sock_wake_async(sk->sk_socket, how, band);
1403 }
1404
1405 #define SOCK_MIN_SNDBUF 2048
1406 #define SOCK_MIN_RCVBUF 256
1407
1408 static inline void sk_stream_moderate_sndbuf(struct sock *sk)
1409 {
1410         if (!(sk->sk_userlocks & SOCK_SNDBUF_LOCK)) {
1411                 sk->sk_sndbuf = min(sk->sk_sndbuf, sk->sk_wmem_queued >> 1);
1412                 sk->sk_sndbuf = max(sk->sk_sndbuf, SOCK_MIN_SNDBUF);
1413         }
1414 }
1415
1416 struct sk_buff *sk_stream_alloc_skb(struct sock *sk, int size, gfp_t gfp);
1417
1418 static inline struct page *sk_stream_alloc_page(struct sock *sk)
1419 {
1420         struct page *page = NULL;
1421
1422         page = alloc_pages(sk->sk_allocation, 0);
1423         if (!page) {
1424                 sk->sk_prot->enter_memory_pressure(sk);
1425                 sk_stream_moderate_sndbuf(sk);
1426         }
1427         return page;
1428 }
1429
1430 /*
1431  *      Default write policy as shown to user space via poll/select/SIGIO
1432  */
1433 static inline int sock_writeable(const struct sock *sk)
1434 {
1435         return atomic_read(&sk->sk_wmem_alloc) < (sk->sk_sndbuf >> 1);
1436 }
1437
1438 static inline gfp_t gfp_any(void)
1439 {
1440         return in_softirq() ? GFP_ATOMIC : GFP_KERNEL;
1441 }
1442
1443 static inline long sock_rcvtimeo(const struct sock *sk, int noblock)
1444 {
1445         return noblock ? 0 : sk->sk_rcvtimeo;
1446 }
1447
1448 static inline long sock_sndtimeo(const struct sock *sk, int noblock)
1449 {
1450         return noblock ? 0 : sk->sk_sndtimeo;
1451 }
1452
1453 static inline int sock_rcvlowat(const struct sock *sk, int waitall, int len)
1454 {
1455         return (waitall ? len : min_t(int, sk->sk_rcvlowat, len)) ? : 1;
1456 }
1457
1458 /* Alas, with timeout socket operations are not restartable.
1459  * Compare this to poll().
1460  */
1461 static inline int sock_intr_errno(long timeo)
1462 {
1463         return timeo == MAX_SCHEDULE_TIMEOUT ? -ERESTARTSYS : -EINTR;
1464 }
1465
1466 extern void __sock_recv_timestamp(struct msghdr *msg, struct sock *sk,
1467         struct sk_buff *skb);
1468
1469 static __inline__ void
1470 sock_recv_timestamp(struct msghdr *msg, struct sock *sk, struct sk_buff *skb)
1471 {
1472         ktime_t kt = skb->tstamp;
1473         struct skb_shared_hwtstamps *hwtstamps = skb_hwtstamps(skb);
1474
1475         /*
1476          * generate control messages if
1477          * - receive time stamping in software requested (SOCK_RCVTSTAMP
1478          *   or SOCK_TIMESTAMPING_RX_SOFTWARE)
1479          * - software time stamp available and wanted
1480          *   (SOCK_TIMESTAMPING_SOFTWARE)
1481          * - hardware time stamps available and wanted
1482          *   (SOCK_TIMESTAMPING_SYS_HARDWARE or
1483          *   SOCK_TIMESTAMPING_RAW_HARDWARE)
1484          */
1485         if (sock_flag(sk, SOCK_RCVTSTAMP) ||
1486             sock_flag(sk, SOCK_TIMESTAMPING_RX_SOFTWARE) ||
1487             (kt.tv64 && sock_flag(sk, SOCK_TIMESTAMPING_SOFTWARE)) ||
1488             (hwtstamps->hwtstamp.tv64 &&
1489              sock_flag(sk, SOCK_TIMESTAMPING_RAW_HARDWARE)) ||
1490             (hwtstamps->syststamp.tv64 &&
1491              sock_flag(sk, SOCK_TIMESTAMPING_SYS_HARDWARE)))
1492                 __sock_recv_timestamp(msg, sk, skb);
1493         else
1494                 sk->sk_stamp = kt;
1495 }
1496
1497 extern void sock_recv_ts_and_drops(struct msghdr *msg, struct sock *sk, struct sk_buff *skb);
1498
1499 /**
1500  * sock_tx_timestamp - checks whether the outgoing packet is to be time stamped
1501  * @msg:        outgoing packet
1502  * @sk:         socket sending this packet
1503  * @shtx:       filled with instructions for time stamping
1504  *
1505  * Currently only depends on SOCK_TIMESTAMPING* flags. Returns error code if
1506  * parameters are invalid.
1507  */
1508 extern int sock_tx_timestamp(struct msghdr *msg,
1509                              struct sock *sk,
1510                              union skb_shared_tx *shtx);
1511
1512
1513 /**
1514  * sk_eat_skb - Release a skb if it is no longer needed
1515  * @sk: socket to eat this skb from
1516  * @skb: socket buffer to eat
1517  * @copied_early: flag indicating whether DMA operations copied this data early
1518  *
1519  * This routine must be called with interrupts disabled or with the socket
1520  * locked so that the sk_buff queue operation is ok.
1521 */
1522 #ifdef CONFIG_NET_DMA
1523 static inline void sk_eat_skb(struct sock *sk, struct sk_buff *skb, int copied_early)
1524 {
1525         __skb_unlink(skb, &sk->sk_receive_queue);
1526         if (!copied_early)
1527                 __kfree_skb(skb);
1528         else
1529                 __skb_queue_tail(&sk->sk_async_wait_queue, skb);
1530 }
1531 #else
1532 static inline void sk_eat_skb(struct sock *sk, struct sk_buff *skb, int copied_early)
1533 {
1534         __skb_unlink(skb, &sk->sk_receive_queue);
1535         __kfree_skb(skb);
1536 }
1537 #endif
1538
1539 static inline
1540 struct net *sock_net(const struct sock *sk)
1541 {
1542 #ifdef CONFIG_NET_NS
1543         return sk->sk_net;
1544 #else
1545         return &init_net;
1546 #endif
1547 }
1548
1549 static inline
1550 void sock_net_set(struct sock *sk, struct net *net)
1551 {
1552 #ifdef CONFIG_NET_NS
1553         sk->sk_net = net;
1554 #endif
1555 }
1556
1557 /*
1558  * Kernel sockets, f.e. rtnl or icmp_socket, are a part of a namespace.
1559  * They should not hold a referrence to a namespace in order to allow
1560  * to stop it.
1561  * Sockets after sk_change_net should be released using sk_release_kernel
1562  */
1563 static inline void sk_change_net(struct sock *sk, struct net *net)
1564 {
1565         put_net(sock_net(sk));
1566         sock_net_set(sk, hold_net(net));
1567 }
1568
1569 static inline struct sock *skb_steal_sock(struct sk_buff *skb)
1570 {
1571         if (unlikely(skb->sk)) {
1572                 struct sock *sk = skb->sk;
1573
1574                 skb->destructor = NULL;
1575                 skb->sk = NULL;
1576                 return sk;
1577         }
1578         return NULL;
1579 }
1580
1581 extern void sock_enable_timestamp(struct sock *sk, int flag);
1582 extern int sock_get_timestamp(struct sock *, struct timeval __user *);
1583 extern int sock_get_timestampns(struct sock *, struct timespec __user *);
1584
1585 /*
1586  *      Enable debug/info messages
1587  */
1588 extern int net_msg_warn;
1589 #define NETDEBUG(fmt, args...) \
1590         do { if (net_msg_warn) printk(fmt,##args); } while (0)
1591
1592 #define LIMIT_NETDEBUG(fmt, args...) \
1593         do { if (net_msg_warn && net_ratelimit()) printk(fmt,##args); } while(0)
1594
1595 extern __u32 sysctl_wmem_max;
1596 extern __u32 sysctl_rmem_max;
1597
1598 extern void sk_init(void);
1599
1600 extern int sysctl_optmem_max;
1601
1602 extern __u32 sysctl_wmem_default;
1603 extern __u32 sysctl_rmem_default;
1604
1605 #endif  /* _SOCK_H */