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