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, <bir7@leland.Stanford.Edu>
  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/config.h>
  44 #include <linux/list.h>
  45 #include <linux/timer.h>
  46 #include <linux/cache.h>
  47 #include <linux/module.h>
  48 #include <linux/netdevice.h>
  49 #include <linux/skbuff.h>       /* struct sk_buff */
  50 #include <linux/security.h>
  51
  52 #include <linux/filter.h>
  53
  54 #include <asm/atomic.h>
  55 #include <net/dst.h>
  56
  57 /*
  58  * This structure really needs to be cleaned up.
  59  * Most of it is for TCP, and not used by any of
  60  * the other protocols.
  61  */
  62
  63 /* Define this to get the sk->sk_debug debugging facility. */
  64 //#define SOCK_DEBUGGING
  65 #ifdef SOCK_DEBUGGING
  66 #define SOCK_DEBUG(sk, msg...) do { if ((sk) && ((sk)->sk_debug)) \
  67                                         printk(KERN_DEBUG msg); } while (0)
  68 #else
  69 #define SOCK_DEBUG(sk, msg...) do { } while (0)
  70 #endif
  71
  72 /* This is the per-socket lock.  The spinlock provides a synchronization
  73  * between user contexts and software interrupt processing, whereas the
  74  * mini-semaphore synchronizes multiple users amongst themselves.
  75  */
  76 struct sock_iocb;
  77 typedef struct {
  78         spinlock_t              slock;
  79         struct sock_iocb        *owner;
  80         wait_queue_head_t       wq;
  81 } socket_lock_t;
  82
  83 #define sock_lock_init(__sk) \
  84 do {    spin_lock_init(&((__sk)->sk_lock.slock)); \
  85         (__sk)->sk_lock.owner = NULL; \
  86         init_waitqueue_head(&((__sk)->sk_lock.wq)); \
  87 } while(0)
  88
  89 struct sock;
  90
  91 /**
  92   *     struct sock_common - minimal network layer representation of sockets
  93   *     @skc_family - network address family
  94   *     @skc_state - Connection state
  95   *     @skc_reuse - %SO_REUSEADDR setting
  96   *     @skc_bound_dev_if - bound device index if != 0
  97   *     @skc_node - main hash linkage for various protocol lookup tables
  98   *     @skc_bind_node - bind hash linkage for various protocol lookup tables
  99   *     @skc_refcnt - reference count
 100   *
 101   *     This is the minimal network layer representation of sockets, the header
 102   *     for struct sock and struct tcp_tw_bucket.
 103   */
 104 struct sock_common {
 105         unsigned short          skc_family;
 106         volatile unsigned char  skc_state;
 107         unsigned char           skc_reuse;
 108         int                     skc_bound_dev_if;
 109         struct hlist_node       skc_node;
 110         struct hlist_node       skc_bind_node;
 111         atomic_t                skc_refcnt;
 112 };
 113
 114 /**
 115   *     struct sock - network layer representation of sockets
 116   *     @__sk_common - shared layout with tcp_tw_bucket
 117   *     @sk_zapped - ax25 & ipx means !linked
 118   *     @sk_shutdown - mask of %SEND_SHUTDOWN and/or %RCV_SHUTDOWN
 119   *     @sk_use_write_queue - wheter to call sk->sk_write_space in sock_wfree
 120   *     @sk_userlocks - %SO_SNDBUF and %SO_RCVBUF settings
 121   *     @sk_lock -      synchronizer
 122   *     @sk_rcvbuf - size of receive buffer in bytes
 123   *     @sk_sleep - sock wait queue
 124   *     @sk_dst_cache - destination cache
 125   *     @sk_dst_lock - destination cache lock
 126   *     @sk_policy - flow policy
 127   *     @sk_rmem_alloc - receive queue bytes committed
 128   *     @sk_receive_queue - incoming packets
 129   *     @sk_wmem_alloc - transmit queue bytes committed
 130   *     @sk_write_queue - Packet sending queue
 131   *     @sk_omem_alloc - "o" is "option" or "other"
 132   *     @sk_wmem_queued - persistent queue size
 133   *     @sk_forward_alloc - space allocated forward
 134   *     @sk_allocation - allocation mode
 135   *     @sk_sndbuf - size of send buffer in bytes
 136   *     @sk_flags - %SO_LINGER (l_onoff), %SO_BROADCAST, %SO_KEEPALIVE, %SO_OOBINLINE settings
 137   *     @sk_no_check - %SO_NO_CHECK setting, wether or not checkup packets
 138   *     @sk_debug - %SO_DEBUG setting
 139   *     @sk_rcvtstamp - %SO_TIMESTAMP setting
 140   *     @sk_no_largesend - whether to sent large segments or not
 141   *     @sk_route_caps - route capabilities (e.g. %NETIF_F_TSO)
 142   *     @sk_lingertime - %SO_LINGER l_linger setting
 143   *     @sk_hashent - hash entry in several tables (e.g. tcp_ehash)
 144   *     @sk_pair - socket pair (e.g. AF_UNIX/unix_peer)
 145   *     @sk_backlog - always used with the per-socket spinlock held
 146   *     @sk_callback_lock - used with the callbacks in the end of this struct
 147   *     @sk_error_queue - rarely used
 148   *     @sk_prot - protocol handlers inside a network family
 149   *     @sk_err - last error
 150   *     @sk_err_soft - errors that don't cause failure but are the cause of a persistent failure not just 'timed out'
 151   *     @sk_ack_backlog - current listen backlog
 152   *     @sk_max_ack_backlog - listen backlog set in listen()
 153   *     @sk_priority - %SO_PRIORITY setting
 154   *     @sk_type - socket type (%SOCK_STREAM, etc)
 155   *     @sk_localroute - route locally only, %SO_DONTROUTE setting
 156   *     @sk_protocol - which protocol this socket belongs in this network family
 157   *     @sk_peercred - %SO_PEERCRED setting
 158   *     @sk_rcvlowat - %SO_RCVLOWAT setting
 159   *     @sk_rcvtimeo - %SO_RCVTIMEO setting
 160   *     @sk_sndtimeo - %SO_SNDTIMEO setting
 161   *     @sk_filter - socket filtering instructions
 162   *     @sk_protinfo - private area, net family specific, when not using slab
 163   *     @sk_slab - the slabcache this instance was allocated from
 164   *     @sk_timer - sock cleanup timer
 165   *     @sk_stamp - time stamp of last packet received
 166   *     @sk_socket - Identd and reporting IO signals
 167   *     @sk_user_data - RPC and Tux layer private data
 168   *     @sk_owner - module that owns this socket
 169   *     @sk_state_change - callback to indicate change in the state of the sock
 170   *     @sk_data_ready - callback to indicate there is data to be processed
 171   *     @sk_write_space - callback to indicate there is bf sending space available
 172   *     @sk_error_report - callback to indicate errors (e.g. %MSG_ERRQUEUE)
 173   *     @sk_create_child - callback to get new socket events
 174   *     @sk_backlog_rcv - callback to process the backlog
 175   *     @sk_destruct - called at sock freeing time, i.e. when all refcnt == 0
 176  */
 177 struct sock {
 178         /*
 179          * Now struct tcp_tw_bucket also uses sock_common, so please just
 180          * don't add nothing before this first member (__sk_common) --acme
 181          */
 182         struct sock_common      __sk_common;
 183 #define sk_family               __sk_common.skc_family
 184 #define sk_state                __sk_common.skc_state
 185 #define sk_reuse                __sk_common.skc_reuse
 186 #define sk_bound_dev_if         __sk_common.skc_bound_dev_if
 187 #define sk_node                 __sk_common.skc_node
 188 #define sk_bind_node            __sk_common.skc_bind_node
 189 #define sk_refcnt               __sk_common.skc_refcnt
 190         volatile unsigned char  sk_zapped;
 191         unsigned char           sk_shutdown;
 192         unsigned char           sk_use_write_queue;
 193         unsigned char           sk_userlocks;
 194         socket_lock_t           sk_lock;
 195         int                     sk_rcvbuf;
 196         wait_queue_head_t       *sk_sleep;
 197         struct dst_entry        *sk_dst_cache;
 198         rwlock_t                sk_dst_lock;
 199         struct xfrm_policy      *sk_policy[2];
 200         atomic_t                sk_rmem_alloc;
 201         struct sk_buff_head     sk_receive_queue;
 202         atomic_t                sk_wmem_alloc;
 203         struct sk_buff_head     sk_write_queue;
 204         atomic_t                sk_omem_alloc;
 205         int                     sk_wmem_queued;
 206         int                     sk_forward_alloc;
 207         unsigned int            sk_allocation;
 208         int                     sk_sndbuf;
 209         unsigned long           sk_flags;
 210         char                    sk_no_check;
 211         unsigned char           sk_debug;
 212         unsigned char           sk_rcvtstamp;
 213         unsigned char           sk_no_largesend;
 214         int                     sk_route_caps;
 215         unsigned long           sk_lingertime;
 216         int                     sk_hashent;
 217         struct sock             *sk_pair;
 218         /*
 219          * The backlog queue is special, it is always used with
 220          * the per-socket spinlock held and requires low latency
 221          * access. Therefore we special case it's implementation.
 222          */
 223         struct {
 224                 struct sk_buff *head;
 225                 struct sk_buff *tail;
 226         } sk_backlog;
 227         rwlock_t                sk_callback_lock;
 228         struct sk_buff_head     sk_error_queue;
 229         struct proto            *sk_prot;
 230         int                     sk_err,
 231                                 sk_err_soft;
 232         unsigned short          sk_ack_backlog;
 233         unsigned short          sk_max_ack_backlog;
 234         __u32                   sk_priority;
 235         unsigned short          sk_type;
 236         unsigned char           sk_localroute;
 237         unsigned char           sk_protocol;
 238         struct ucred            sk_peercred;
 239         int                     sk_rcvlowat;
 240         long                    sk_rcvtimeo;
 241         long                    sk_sndtimeo;
 242         struct sk_filter        *sk_filter;
 243         void                    *sk_protinfo;
 244         kmem_cache_t            *sk_slab;
 245         struct timer_list       sk_timer;
 246         struct timeval          sk_stamp;
 247         struct socket           *sk_socket;
 248         void                    *sk_user_data;
 249         struct module           *sk_owner;
 250         void                    *sk_security;
 251         void                    (*sk_state_change)(struct sock *sk);
 252         void                    (*sk_data_ready)(struct sock *sk, int bytes);
 253         void                    (*sk_write_space)(struct sock *sk);
 254         void                    (*sk_error_report)(struct sock *sk);
 255         int                     (*sk_backlog_rcv)(struct sock *sk,
 256                                                   struct sk_buff *skb);
 257         void                    (*sk_create_child)(struct sock *sk, struct sock *newsk);
 258         void                    (*sk_destruct)(struct sock *sk);
 259 };
 260
 261 /*
 262  * Hashed lists helper routines
 263  */
 264 static inline struct sock *__sk_head(struct hlist_head *head)
 265 {
 266         return hlist_entry(head->first, struct sock, sk_node);
 267 }
 268
 269 static inline struct sock *sk_head(struct hlist_head *head)
 270 {
 271         return hlist_empty(head) ? NULL : __sk_head(head);
 272 }
 273
 274 static inline struct sock *sk_next(struct sock *sk)
 275 {
 276         return sk->sk_node.next ?
 277                 hlist_entry(sk->sk_node.next, struct sock, sk_node) : NULL;
 278 }
 279
 280 static inline int sk_unhashed(struct sock *sk)
 281 {
 282         return hlist_unhashed(&sk->sk_node);
 283 }
 284
 285 static inline int sk_hashed(struct sock *sk)
 286 {
 287         return sk->sk_node.pprev != NULL;
 288 }
 289
 290 static __inline__ void sk_node_init(struct hlist_node *node)
 291 {
 292         node->pprev = NULL;
 293 }
 294
 295 static __inline__ void __sk_del_node(struct sock *sk)
 296 {
 297         __hlist_del(&sk->sk_node);
 298 }
 299
 300 static __inline__ int __sk_del_node_init(struct sock *sk)
 301 {
 302         if (sk_hashed(sk)) {
 303                 __sk_del_node(sk);
 304                 sk_node_init(&sk->sk_node);
 305                 return 1;
 306         }
 307         return 0;
 308 }
 309
 310 /* Grab socket reference count. This operation is valid only
 311    when sk is ALREADY grabbed f.e. it is found in hash table
 312    or a list and the lookup is made under lock preventing hash table
 313    modifications.
 314  */
 315
 316 static inline void sock_hold(struct sock *sk)
 317 {
 318         atomic_inc(&sk->sk_refcnt);
 319 }
 320
 321 /* Ungrab socket in the context, which assumes that socket refcnt
 322    cannot hit zero, f.e. it is true in context of any socketcall.
 323  */
 324 static inline void __sock_put(struct sock *sk)
 325 {
 326         atomic_dec(&sk->sk_refcnt);
 327 }
 328
 329 static __inline__ int sk_del_node_init(struct sock *sk)
 330 {
 331         int rc = __sk_del_node_init(sk);
 332
 333         if (rc) {
 334                 /* paranoid for a while -acme */
 335                 WARN_ON(atomic_read(&sk->sk_refcnt) == 1);
 336                 __sock_put(sk);
 337         }
 338         return rc;
 339 }
 340
 341 static __inline__ void __sk_add_node(struct sock *sk, struct hlist_head *list)
 342 {
 343         hlist_add_head(&sk->sk_node, list);
 344 }
 345
 346 static __inline__ void sk_add_node(struct sock *sk, struct hlist_head *list)
 347 {
 348         sock_hold(sk);
 349         __sk_add_node(sk, list);
 350 }
 351
 352 static __inline__ void __sk_del_bind_node(struct sock *sk)
 353 {
 354         __hlist_del(&sk->sk_bind_node);
 355 }
 356
 357 static __inline__ void sk_add_bind_node(struct sock *sk,
 358                                         struct hlist_head *list)
 359 {
 360         hlist_add_head(&sk->sk_bind_node, list);
 361 }
 362
 363 #define sk_for_each(__sk, node, list) \
 364         hlist_for_each_entry(__sk, node, list, sk_node)
 365 #define sk_for_each_from(__sk, node) \
 366         if (__sk && ({ node = &(__sk)->sk_node; 1; })) \
 367                 hlist_for_each_entry_from(__sk, node, sk_node)
 368 #define sk_for_each_continue(__sk, node) \
 369         if (__sk && ({ node = &(__sk)->sk_node; 1; })) \
 370                 hlist_for_each_entry_continue(__sk, node, sk_node)
 371 #define sk_for_each_safe(__sk, node, tmp, list) \
 372         hlist_for_each_entry_safe(__sk, node, tmp, list, sk_node)
 373 #define sk_for_each_bound(__sk, node, list) \
 374         hlist_for_each_entry(__sk, node, list, sk_bind_node)
 375
 376 /* Sock flags */
 377 enum sock_flags {
 378         SOCK_DEAD,
 379         SOCK_DONE,
 380         SOCK_URGINLINE,
 381         SOCK_KEEPOPEN,
 382         SOCK_LINGER,
 383         SOCK_DESTROY,
 384         SOCK_BROADCAST,
 385         SOCK_TIMESTAMP,
 386 };
 387
 388 static inline void sock_set_flag(struct sock *sk, enum sock_flags flag)
 389 {
 390         __set_bit(flag, &sk->sk_flags);
 391 }
 392
 393 static inline void sock_reset_flag(struct sock *sk, enum sock_flags flag)
 394 {
 395         __clear_bit(flag, &sk->sk_flags);
 396 }
 397
 398 static inline int sock_flag(struct sock *sk, enum sock_flags flag)
 399 {
 400         return test_bit(flag, &sk->sk_flags);
 401 }
 402
 403 /* The per-socket spinlock must be held here. */
 404 #define sk_add_backlog(__sk, __skb)                             \
 405 do {    if (!(__sk)->sk_backlog.tail) {                         \
 406                 (__sk)->sk_backlog.head =                       \
 407                      (__sk)->sk_backlog.tail = (__skb);         \
 408         } else {                                                \
 409                 ((__sk)->sk_backlog.tail)->next = (__skb);      \
 410                 (__sk)->sk_backlog.tail = (__skb);              \
 411         }                                                       \
 412         (__skb)->next = NULL;                                   \
 413 } while(0)
 414
 415 /* IP protocol blocks we attach to sockets.
 416  * socket layer -> transport layer interface
 417  * transport -> network interface is defined by struct inet_proto
 418  */
 419 struct proto {
 420         void                    (*close)(struct sock *sk,
 421                                         long timeout);
 422         int                     (*connect)(struct sock *sk,
 423                                         struct sockaddr *uaddr,
 424                                         int addr_len);
 425         int                     (*disconnect)(struct sock *sk, int flags);
 426
 427         struct sock *           (*accept) (struct sock *sk, int flags, int *err);
 428
 429         int                     (*ioctl)(struct sock *sk, int cmd,
 430                                          unsigned long arg);
 431         int                     (*init)(struct sock *sk);
 432         int                     (*destroy)(struct sock *sk);
 433         void                    (*shutdown)(struct sock *sk, int how);
 434         int                     (*setsockopt)(struct sock *sk, int level,
 435                                         int optname, char __user *optval,
 436                                         int optlen);
 437         int                     (*getsockopt)(struct sock *sk, int level,
 438                                         int optname, char __user *optval,
 439                                         int __user *option);
 440         int                     (*sendmsg)(struct kiocb *iocb, struct sock *sk,
 441                                            struct msghdr *msg, size_t len);
 442         int                     (*recvmsg)(struct kiocb *iocb, struct sock *sk,
 443                                            struct msghdr *msg,
 444                                         size_t len, int noblock, int flags,
 445                                         int *addr_len);
 446         int                     (*sendpage)(struct sock *sk, struct page *page,
 447                                         int offset, size_t size, int flags);
 448         int                     (*bind)(struct sock *sk,
 449                                         struct sockaddr *uaddr, int addr_len);
 450
 451         int                     (*backlog_rcv) (struct sock *sk,
 452                                                 struct sk_buff *skb);
 453
 454         /* Keeping track of sk's, looking them up, and port selection methods. */
 455         void                    (*hash)(struct sock *sk);
 456         void                    (*unhash)(struct sock *sk);
 457         int                     (*get_port)(struct sock *sk, unsigned short snum);
 458
 459         char                    name[32];
 460
 461         struct {
 462                 int inuse;
 463                 u8  __pad[SMP_CACHE_BYTES - sizeof(int)];
 464         } stats[NR_CPUS];
 465 };
 466
 467 static __inline__ void sk_set_owner(struct sock *sk, struct module *owner)
 468 {
 469         /*
 470          * One should use sk_set_owner just once, after struct sock creation,
 471          * be it shortly after sk_alloc or after a function that returns a new
 472          * struct sock (and that down the call chain called sk_alloc), e.g. the
 473          * IPv4 and IPv6 modules share tcp_create_openreq_child, so if
 474          * tcp_create_openreq_child called sk_set_owner IPv6 would have to
 475          * change the ownership of this struct sock, with one not needed
 476          * transient sk_set_owner call.
 477          */
 478         BUG_ON(sk->sk_owner != NULL);
 479
 480         sk->sk_owner = owner;
 481         __module_get(owner);
 482 }
 483
 484 /* Called with local bh disabled */
 485 static __inline__ void sock_prot_inc_use(struct proto *prot)
 486 {
 487         prot->stats[smp_processor_id()].inuse++;
 488 }
 489
 490 static __inline__ void sock_prot_dec_use(struct proto *prot)
 491 {
 492         prot->stats[smp_processor_id()].inuse--;
 493 }
 494
 495 /* About 10 seconds */
 496 #define SOCK_DESTROY_TIME (10*HZ)
 497
 498 /* Sockets 0-1023 can't be bound to unless you are superuser */
 499 #define PROT_SOCK       1024
 500
 501 #define SHUTDOWN_MASK   3
 502 #define RCV_SHUTDOWN    1
 503 #define SEND_SHUTDOWN   2
 504
 505 #define SOCK_SNDBUF_LOCK        1
 506 #define SOCK_RCVBUF_LOCK        2
 507 #define SOCK_BINDADDR_LOCK      4
 508 #define SOCK_BINDPORT_LOCK      8
 509
 510 /* sock_iocb: used to kick off async processing of socket ios */
 511 struct sock_iocb {
 512         struct list_head        list;
 513
 514         int                     flags;
 515         int                     size;
 516         struct socket           *sock;
 517         struct sock             *sk;
 518         struct scm_cookie       *scm;
 519         struct msghdr           *msg, async_msg;
 520         struct iovec            async_iov;
 521 };
 522
 523 static inline struct sock_iocb *kiocb_to_siocb(struct kiocb *iocb)
 524 {
 525         BUG_ON(sizeof(struct sock_iocb) > KIOCB_PRIVATE_SIZE);
 526         return (struct sock_iocb *)iocb->private;
 527 }
 528
 529 static inline struct kiocb *siocb_to_kiocb(struct sock_iocb *si)
 530 {
 531         return container_of((void *)si, struct kiocb, private);
 532 }
 533
 534 struct socket_alloc {
 535         struct socket socket;
 536         struct inode vfs_inode;
 537 };
 538
 539 static inline struct socket *SOCKET_I(struct inode *inode)
 540 {
 541         return &container_of(inode, struct socket_alloc, vfs_inode)->socket;
 542 }
 543
 544 static inline struct inode *SOCK_INODE(struct socket *socket)
 545 {
 546         return &container_of(socket, struct socket_alloc, socket)->vfs_inode;
 547 }
 548
 549 /* Used by processes to "lock" a socket state, so that
 550  * interrupts and bottom half handlers won't change it
 551  * from under us. It essentially blocks any incoming
 552  * packets, so that we won't get any new data or any
 553  * packets that change the state of the socket.
 554  *
 555  * While locked, BH processing will add new packets to
 556  * the backlog queue.  This queue is processed by the
 557  * owner of the socket lock right before it is released.
 558  *
 559  * Since ~2.3.5 it is also exclusive sleep lock serializing
 560  * accesses from user process context.
 561  */
 562 extern void __lock_sock(struct sock *sk);
 563 extern void __release_sock(struct sock *sk);
 564 #define sock_owned_by_user(sk)  ((sk)->sk_lock.owner)
 565
 566 extern void FASTCALL(lock_sock(struct sock *sk));
 567 extern void FASTCALL(release_sock(struct sock *sk));
 568
 569 /* BH context may only use the following locking interface. */
 570 #define bh_lock_sock(__sk)      spin_lock(&((__sk)->sk_lock.slock))
 571 #define bh_unlock_sock(__sk)    spin_unlock(&((__sk)->sk_lock.slock))
 572
 573 extern struct sock *            sk_alloc(int family, int priority, int zero_it,
 574                                          kmem_cache_t *slab);
 575 extern void                     sk_free(struct sock *sk);
 576
 577 extern struct sk_buff           *sock_wmalloc(struct sock *sk,
 578                                               unsigned long size, int force,
 579                                               int priority);
 580 extern struct sk_buff           *sock_rmalloc(struct sock *sk,
 581                                               unsigned long size, int force,
 582                                               int priority);
 583 extern void                     sock_wfree(struct sk_buff *skb);
 584 extern void                     sock_rfree(struct sk_buff *skb);
 585
 586 extern int                      sock_setsockopt(struct socket *sock, int level,
 587                                                 int op, char __user *optval,
 588                                                 int optlen);
 589
 590 extern int                      sock_getsockopt(struct socket *sock, int level,
 591                                                 int op, char __user *optval,
 592                                                 int __user *optlen);
 593 extern struct sk_buff           *sock_alloc_send_skb(struct sock *sk,
 594                                                      unsigned long size,
 595                                                      int noblock,
 596                                                      int *errcode);
 597 extern struct sk_buff           *sock_alloc_send_pskb(struct sock *sk,
 598                                                       unsigned long header_len,
 599                                                       unsigned long data_len,
 600                                                       int noblock,
 601                                                       int *errcode);
 602 extern void *sock_kmalloc(struct sock *sk, int size, int priority);
 603 extern void sock_kfree_s(struct sock *sk, void *mem, int size);
 604 extern void sk_send_sigurg(struct sock *sk);
 605
 606 /*
 607  * Functions to fill in entries in struct proto_ops when a protocol
 608  * does not implement a particular function.
 609  */
 610 extern int                      sock_no_release(struct socket *);
 611 extern int                      sock_no_bind(struct socket *,
 612                                              struct sockaddr *, int);
 613 extern int                      sock_no_connect(struct socket *,
 614                                                 struct sockaddr *, int, int);
 615 extern int                      sock_no_socketpair(struct socket *,
 616                                                    struct socket *);
 617 extern int                      sock_no_accept(struct socket *,
 618                                                struct socket *, int);
 619 extern int                      sock_no_getname(struct socket *,
 620                                                 struct sockaddr *, int *, int);
 621 extern unsigned int             sock_no_poll(struct file *, struct socket *,
 622                                              struct poll_table_struct *);
 623 extern int                      sock_no_ioctl(struct socket *, unsigned int,
 624                                               unsigned long);
 625 extern int                      sock_no_listen(struct socket *, int);
 626 extern int                      sock_no_shutdown(struct socket *, int);
 627 extern int                      sock_no_getsockopt(struct socket *, int , int,
 628                                                    char __user *, int __user *);
 629 extern int                      sock_no_setsockopt(struct socket *, int, int,
 630                                                    char __user *, int);
 631 extern int                      sock_no_sendmsg(struct kiocb *, struct socket *,
 632                                                 struct msghdr *, size_t);
 633 extern int                      sock_no_recvmsg(struct kiocb *, struct socket *,
 634                                                 struct msghdr *, size_t, int);
 635 extern int                      sock_no_mmap(struct file *file,
 636                                              struct socket *sock,
 637                                              struct vm_area_struct *vma);
 638 extern ssize_t                  sock_no_sendpage(struct socket *sock,
 639                                                 struct page *page,
 640                                                 int offset, size_t size,
 641                                                 int flags);
 642
 643 /*
 644  *      Default socket callbacks and setup code
 645  */
 646
 647 extern void sock_def_destruct(struct sock *);
 648
 649 /* Initialise core socket variables */
 650 extern void sock_init_data(struct socket *sock, struct sock *sk);
 651
 652 /**
 653  *      sk_filter - run a packet through a socket filter
 654  *      @sk: sock associated with &sk_buff
 655  *      @skb: buffer to filter
 656  *      @needlock: set to 1 if the sock is not locked by caller.
 657  *
 658  * Run the filter code and then cut skb->data to correct size returned by
 659  * sk_run_filter. If pkt_len is 0 we toss packet. If skb->len is smaller
 660  * than pkt_len we keep whole skb->data. This is the socket level
 661  * wrapper to sk_run_filter. It returns 0 if the packet should
 662  * be accepted or -EPERM if the packet should be tossed.
 663  *
 664  */
 665
 666 static inline int sk_filter(struct sock *sk, struct sk_buff *skb, int needlock)
 667 {
 668         int err;
 669
 670         err = security_sock_rcv_skb(sk, skb);
 671         if (err)
 672                 return err;
 673
 674         if (sk->sk_filter) {
 675                 struct sk_filter *filter;
 676
 677                 if (needlock)
 678                         bh_lock_sock(sk);
 679
 680                 filter = sk->sk_filter;
 681                 if (filter) {
 682                         int pkt_len = sk_run_filter(skb, filter->insns,
 683                                                     filter->len);
 684                         if (!pkt_len)
 685                                 err = -EPERM;
 686                         else
 687                                 skb_trim(skb, pkt_len);
 688                 }
 689
 690                 if (needlock)
 691                         bh_unlock_sock(sk);
 692         }
 693         return err;
 694 }
 695
 696 /**
 697  *      sk_filter_release: Release a socket filter
 698  *      @sk: socket
 699  *      @fp: filter to remove
 700  *
 701  *      Remove a filter from a socket and release its resources.
 702  */
 703
 704 static inline void sk_filter_release(struct sock *sk, struct sk_filter *fp)
 705 {
 706         unsigned int size = sk_filter_len(fp);
 707
 708         atomic_sub(size, &sk->sk_omem_alloc);
 709
 710         if (atomic_dec_and_test(&fp->refcnt))
 711                 kfree(fp);
 712 }
 713
 714 static inline void sk_filter_charge(struct sock *sk, struct sk_filter *fp)
 715 {
 716         atomic_inc(&fp->refcnt);
 717         atomic_add(sk_filter_len(fp), &sk->sk_omem_alloc);
 718 }
 719
 720 /*
 721  * Socket reference counting postulates.
 722  *
 723  * * Each user of socket SHOULD hold a reference count.
 724  * * Each access point to socket (an hash table bucket, reference from a list,
 725  *   running timer, skb in flight MUST hold a reference count.
 726  * * When reference count hits 0, it means it will never increase back.
 727  * * When reference count hits 0, it means that no references from
 728  *   outside exist to this socket and current process on current CPU
 729  *   is last user and may/should destroy this socket.
 730  * * sk_free is called from any context: process, BH, IRQ. When
 731  *   it is called, socket has no references from outside -> sk_free
 732  *   may release descendant resources allocated by the socket, but
 733  *   to the time when it is called, socket is NOT referenced by any
 734  *   hash tables, lists etc.
 735  * * Packets, delivered from outside (from network or from another process)
 736  *   and enqueued on receive/error queues SHOULD NOT grab reference count,
 737  *   when they sit in queue. Otherwise, packets will leak to hole, when
 738  *   socket is looked up by one cpu and unhasing is made by another CPU.
 739  *   It is true for udp/raw, netlink (leak to receive and error queues), tcp
 740  *   (leak to backlog). Packet socket does all the processing inside
 741  *   BR_NETPROTO_LOCK, so that it has not this race condition. UNIX sockets
 742  *   use separate SMP lock, so that they are prone too.
 743  */
 744
 745 /* Ungrab socket and destroy it, if it was the last reference. */
 746 static inline void sock_put(struct sock *sk)
 747 {
 748         if (atomic_dec_and_test(&sk->sk_refcnt))
 749                 sk_free(sk);
 750 }
 751
 752 /* Detach socket from process context.
 753  * Announce socket dead, detach it from wait queue and inode.
 754  * Note that parent inode held reference count on this struct sock,
 755  * we do not release it in this function, because protocol
 756  * probably wants some additional cleanups or even continuing
 757  * to work with this socket (TCP).
 758  */
 759 static inline void sock_orphan(struct sock *sk)
 760 {
 761         write_lock_bh(&sk->sk_callback_lock);
 762         sock_set_flag(sk, SOCK_DEAD);
 763         sk->sk_socket = NULL;
 764         sk->sk_sleep  = NULL;
 765         write_unlock_bh(&sk->sk_callback_lock);
 766 }
 767
 768 static inline void sock_graft(struct sock *sk, struct socket *parent)
 769 {
 770         write_lock_bh(&sk->sk_callback_lock);
 771         sk->sk_sleep = &parent->wait;
 772         parent->sk = sk;
 773         sk->sk_socket = parent;
 774         write_unlock_bh(&sk->sk_callback_lock);
 775 }
 776
 777 static inline int sock_i_uid(struct sock *sk)
 778 {
 779         int uid;
 780
 781         read_lock(&sk->sk_callback_lock);
 782         uid = sk->sk_socket ? SOCK_INODE(sk->sk_socket)->i_uid : 0;
 783         read_unlock(&sk->sk_callback_lock);
 784         return uid;
 785 }
 786
 787 static inline unsigned long sock_i_ino(struct sock *sk)
 788 {
 789         unsigned long ino;
 790
 791         read_lock(&sk->sk_callback_lock);
 792         ino = sk->sk_socket ? SOCK_INODE(sk->sk_socket)->i_ino : 0;
 793         read_unlock(&sk->sk_callback_lock);
 794         return ino;
 795 }
 796
 797 static inline struct dst_entry *
 798 __sk_dst_get(struct sock *sk)
 799 {
 800         return sk->sk_dst_cache;
 801 }
 802
 803 static inline struct dst_entry *
 804 sk_dst_get(struct sock *sk)
 805 {
 806         struct dst_entry *dst;
 807
 808         read_lock(&sk->sk_dst_lock);
 809         dst = sk->sk_dst_cache;
 810         if (dst)
 811                 dst_hold(dst);
 812         read_unlock(&sk->sk_dst_lock);
 813         return dst;
 814 }
 815
 816 static inline void
 817 __sk_dst_set(struct sock *sk, struct dst_entry *dst)
 818 {
 819         struct dst_entry *old_dst;
 820
 821         old_dst = sk->sk_dst_cache;
 822         sk->sk_dst_cache = dst;
 823         dst_release(old_dst);
 824 }
 825
 826 static inline void
 827 sk_dst_set(struct sock *sk, struct dst_entry *dst)
 828 {
 829         write_lock(&sk->sk_dst_lock);
 830         __sk_dst_set(sk, dst);
 831         write_unlock(&sk->sk_dst_lock);
 832 }
 833
 834 static inline void
 835 __sk_dst_reset(struct sock *sk)
 836 {
 837         struct dst_entry *old_dst;
 838
 839         old_dst = sk->sk_dst_cache;
 840         sk->sk_dst_cache = NULL;
 841         dst_release(old_dst);
 842 }
 843
 844 static inline void
 845 sk_dst_reset(struct sock *sk)
 846 {
 847         write_lock(&sk->sk_dst_lock);
 848         __sk_dst_reset(sk);
 849         write_unlock(&sk->sk_dst_lock);
 850 }
 851
 852 static inline struct dst_entry *
 853 __sk_dst_check(struct sock *sk, u32 cookie)
 854 {
 855         struct dst_entry *dst = sk->sk_dst_cache;
 856
 857         if (dst && dst->obsolete && dst->ops->check(dst, cookie) == NULL) {
 858                 sk->sk_dst_cache = NULL;
 859                 return NULL;
 860         }
 861
 862         return dst;
 863 }
 864
 865 static inline struct dst_entry *
 866 sk_dst_check(struct sock *sk, u32 cookie)
 867 {
 868         struct dst_entry *dst = sk_dst_get(sk);
 869
 870         if (dst && dst->obsolete && dst->ops->check(dst, cookie) == NULL) {
 871                 sk_dst_reset(sk);
 872                 return NULL;
 873         }
 874
 875         return dst;
 876 }
 877
 878
 879 /*
 880  *      Queue a received datagram if it will fit. Stream and sequenced
 881  *      protocols can't normally use this as they need to fit buffers in
 882  *      and play with them.
 883  *
 884  *      Inlined as it's very short and called for pretty much every
 885  *      packet ever received.
 886  */
 887
 888 static inline void skb_set_owner_w(struct sk_buff *skb, struct sock *sk)
 889 {
 890         sock_hold(sk);
 891         skb->sk = sk;
 892         skb->destructor = sock_wfree;
 893         atomic_add(skb->truesize, &sk->sk_wmem_alloc);
 894 }
 895
 896 static inline void skb_set_owner_r(struct sk_buff *skb, struct sock *sk)
 897 {
 898         skb->sk = sk;
 899         skb->destructor = sock_rfree;
 900         atomic_add(skb->truesize, &sk->sk_rmem_alloc);
 901 }
 902
 903 static inline int sock_queue_rcv_skb(struct sock *sk, struct sk_buff *skb)
 904 {
 905         int err = 0;
 906         int skb_len;
 907
 908         /* Cast skb->rcvbuf to unsigned... It's pointless, but reduces
 909            number of warnings when compiling with -W --ANK
 910          */
 911         if (atomic_read(&sk->sk_rmem_alloc) + skb->truesize >=
 912             (unsigned)sk->sk_rcvbuf) {
 913                 err = -ENOMEM;
 914                 goto out;
 915         }
 916
 917         /* It would be deadlock, if sock_queue_rcv_skb is used
 918            with socket lock! We assume that users of this
 919            function are lock free.
 920         */
 921         err = sk_filter(sk, skb, 1);
 922         if (err)
 923                 goto out;
 924
 925         skb->dev = NULL;
 926         skb_set_owner_r(skb, sk);
 927
 928         /* Cache the SKB length before we tack it onto the receive
 929          * queue.  Once it is added it no longer belongs to us and
 930          * may be freed by other threads of control pulling packets
 931          * from the queue.
 932          */
 933         skb_len = skb->len;
 934
 935         skb_queue_tail(&sk->sk_receive_queue, skb);
 936
 937         if (!sock_flag(sk, SOCK_DEAD))
 938                 sk->sk_data_ready(sk, skb_len);
 939 out:
 940         return err;
 941 }
 942
 943 static inline int sock_queue_err_skb(struct sock *sk, struct sk_buff *skb)
 944 {
 945         /* Cast skb->rcvbuf to unsigned... It's pointless, but reduces
 946            number of warnings when compiling with -W --ANK
 947          */
 948         if (atomic_read(&sk->sk_rmem_alloc) + skb->truesize >=
 949             (unsigned)sk->sk_rcvbuf)
 950                 return -ENOMEM;
 951         skb_set_owner_r(skb, sk);
 952         skb_queue_tail(&sk->sk_error_queue, skb);
 953         if (!sock_flag(sk, SOCK_DEAD))
 954                 sk->sk_data_ready(sk, skb->len);
 955         return 0;
 956 }
 957
 958 /*
 959  *      Recover an error report and clear atomically
 960  */
 961
 962 static inline int sock_error(struct sock *sk)
 963 {
 964         int err = xchg(&sk->sk_err, 0);
 965         return -err;
 966 }
 967
 968 static inline unsigned long sock_wspace(struct sock *sk)
 969 {
 970         int amt = 0;
 971
 972         if (!(sk->sk_shutdown & SEND_SHUTDOWN)) {
 973                 amt = sk->sk_sndbuf - atomic_read(&sk->sk_wmem_alloc);
 974                 if (amt < 0)
 975                         amt = 0;
 976         }
 977         return amt;
 978 }
 979
 980 static inline void sk_wake_async(struct sock *sk, int how, int band)
 981 {
 982         if (sk->sk_socket && sk->sk_socket->fasync_list)
 983                 sock_wake_async(sk->sk_socket, how, band);
 984 }
 985
 986 #define SOCK_MIN_SNDBUF 2048
 987 #define SOCK_MIN_RCVBUF 256
 988
 989 /*
 990  *      Default write policy as shown to user space via poll/select/SIGIO
 991  */
 992 static inline int sock_writeable(struct sock *sk)
 993 {
 994         return atomic_read(&sk->sk_wmem_alloc) < (sk->sk_sndbuf / 2);
 995 }
 996
 997 static inline int gfp_any(void)
 998 {
 999         return in_softirq() ? GFP_ATOMIC : GFP_KERNEL;
1000 }
1001
1002 static inline long sock_rcvtimeo(struct sock *sk, int noblock)
1003 {
1004         return noblock ? 0 : sk->sk_rcvtimeo;
1005 }
1006
1007 static inline long sock_sndtimeo(struct sock *sk, int noblock)
1008 {
1009         return noblock ? 0 : sk->sk_sndtimeo;
1010 }
1011
1012 static inline int sock_rcvlowat(struct sock *sk, int waitall, int len)
1013 {
1014         return (waitall ? len : min_t(int, sk->sk_rcvlowat, len)) ? : 1;
1015 }
1016
1017 /* Alas, with timeout socket operations are not restartable.
1018  * Compare this to poll().
1019  */
1020 static inline int sock_intr_errno(long timeo)
1021 {
1022         return timeo == MAX_SCHEDULE_TIMEOUT ? -ERESTARTSYS : -EINTR;
1023 }
1024
1025 static __inline__ void
1026 sock_recv_timestamp(struct msghdr *msg, struct sock *sk, struct sk_buff *skb)
1027 {
1028         struct timeval *stamp = &skb->stamp;
1029         if (sk->sk_rcvtstamp) {
1030                 /* Race occurred between timestamp enabling and packet
1031                    receiving.  Fill in the current time for now. */
1032                 if (stamp->tv_sec == 0)
1033                         do_gettimeofday(stamp);
1034                 put_cmsg(msg, SOL_SOCKET, SO_TIMESTAMP, sizeof(struct timeval),
1035                          stamp);
1036         } else
1037                 sk->sk_stamp = *stamp;
1038 }
1039
1040 extern atomic_t netstamp_needed;
1041 extern void sock_enable_timestamp(struct sock *sk);
1042 extern void sock_disable_timestamp(struct sock *sk);
1043
1044 static inline void net_timestamp(struct timeval *stamp)
1045 {
1046         if (atomic_read(&netstamp_needed))
1047                 do_gettimeofday(stamp);
1048         else {
1049                 stamp->tv_sec = 0;
1050                 stamp->tv_usec = 0;
1051         }
1052 }
1053
1054 extern int sock_get_timestamp(struct sock *, struct timeval __user *);
1055
1056 /*
1057  *      Enable debug/info messages
1058  */
1059
1060 #if 0
1061 #define NETDEBUG(x)     do { } while (0)
1062 #define LIMIT_NETDEBUG(x) do {} while(0)
1063 #else
1064 #define NETDEBUG(x)     do { x; } while (0)
1065 #define LIMIT_NETDEBUG(x) do { if (net_ratelimit()) { x; } } while(0)
1066 #endif
1067
1068 /*
1069  * Macros for sleeping on a socket. Use them like this:
1070  *
1071  * SOCK_SLEEP_PRE(sk)
1072  * if (condition)
1073  *      schedule();
1074  * SOCK_SLEEP_POST(sk)
1075  *
1076  * N.B. These are now obsolete and were, afaik, only ever used in DECnet
1077  * and when the last use of them in DECnet has gone, I'm intending to
1078  * remove them.
1079  */
1080
1081 #define SOCK_SLEEP_PRE(sk)      { struct task_struct *tsk = current; \
1082                                 DECLARE_WAITQUEUE(wait, tsk); \
1083                                 tsk->state = TASK_INTERRUPTIBLE; \
1084                                 add_wait_queue((sk)->sk_sleep, &wait); \
1085                                 release_sock(sk);
1086
1087 #define SOCK_SLEEP_POST(sk)     tsk->state = TASK_RUNNING; \
1088                                 remove_wait_queue((sk)->sk_sleep, &wait); \
1089                                 lock_sock(sk); \
1090                                 }
1091
1092 static inline void sock_valbool_flag(struct sock *sk, int bit, int valbool)
1093 {
1094         if (valbool)
1095                 sock_set_flag(sk, bit);
1096         else
1097                 sock_reset_flag(sk, bit);
1098 }
1099
1100 extern __u32 sysctl_wmem_max;
1101 extern __u32 sysctl_rmem_max;
1102
1103 int siocdevprivate_ioctl(unsigned int fd, unsigned int cmd, unsigned long arg);
1104
1105 #endif  /* _SOCK_H */