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 static inline void sk_acceptq_removed(struct sock *sk)
 402 {
 403         sk->sk_ack_backlog--;
 404 }
 405
 406 static inline void sk_acceptq_added(struct sock *sk)
 407 {
 408         sk->sk_ack_backlog++;
 409 }
 410
 411 static inline int sk_acceptq_is_full(struct sock *sk)
 412 {
 413         return sk->sk_ack_backlog > sk->sk_max_ack_backlog;
 414 }
 415
 416 /* The per-socket spinlock must be held here. */
 417 #define sk_add_backlog(__sk, __skb)                             \
 418 do {    if (!(__sk)->sk_backlog.tail) {                         \
 419                 (__sk)->sk_backlog.head =                       \
 420                      (__sk)->sk_backlog.tail = (__skb);         \
 421         } else {                                                \
 422                 ((__sk)->sk_backlog.tail)->next = (__skb);      \
 423                 (__sk)->sk_backlog.tail = (__skb);              \
 424         }                                                       \
 425         (__skb)->next = NULL;                                   \
 426 } while(0)
 427
 428 #define sk_wait_event(__sk, __timeo, __condition)               \
 429 ({      int rc;                                                 \
 430         release_sock(__sk);                                     \
 431         rc = __condition;                                       \
 432         if (!rc) {                                              \
 433                 *(__timeo) = schedule_timeout(*(__timeo));      \
 434                 rc = __condition;                               \
 435         }                                                       \
 436         lock_sock(__sk);                                        \
 437         rc;                                                     \
 438 })
 439
 440 extern int sk_wait_data(struct sock *sk, long *timeo);
 441
 442 /* IP protocol blocks we attach to sockets.
 443  * socket layer -> transport layer interface
 444  * transport -> network interface is defined by struct inet_proto
 445  */
 446 struct proto {
 447         void                    (*close)(struct sock *sk,
 448                                         long timeout);
 449         int                     (*connect)(struct sock *sk,
 450                                         struct sockaddr *uaddr,
 451                                         int addr_len);
 452         int                     (*disconnect)(struct sock *sk, int flags);
 453
 454         struct sock *           (*accept) (struct sock *sk, int flags, int *err);
 455
 456         int                     (*ioctl)(struct sock *sk, int cmd,
 457                                          unsigned long arg);
 458         int                     (*init)(struct sock *sk);
 459         int                     (*destroy)(struct sock *sk);
 460         void                    (*shutdown)(struct sock *sk, int how);
 461         int                     (*setsockopt)(struct sock *sk, int level,
 462                                         int optname, char __user *optval,
 463                                         int optlen);
 464         int                     (*getsockopt)(struct sock *sk, int level,
 465                                         int optname, char __user *optval,
 466                                         int __user *option);
 467         int                     (*sendmsg)(struct kiocb *iocb, struct sock *sk,
 468                                            struct msghdr *msg, size_t len);
 469         int                     (*recvmsg)(struct kiocb *iocb, struct sock *sk,
 470                                            struct msghdr *msg,
 471                                         size_t len, int noblock, int flags,
 472                                         int *addr_len);
 473         int                     (*sendpage)(struct sock *sk, struct page *page,
 474                                         int offset, size_t size, int flags);
 475         int                     (*bind)(struct sock *sk,
 476                                         struct sockaddr *uaddr, int addr_len);
 477
 478         int                     (*backlog_rcv) (struct sock *sk,
 479                                                 struct sk_buff *skb);
 480
 481         /* Keeping track of sk's, looking them up, and port selection methods. */
 482         void                    (*hash)(struct sock *sk);
 483         void                    (*unhash)(struct sock *sk);
 484         int                     (*get_port)(struct sock *sk, unsigned short snum);
 485
 486         char                    name[32];
 487
 488         struct {
 489                 int inuse;
 490                 u8  __pad[SMP_CACHE_BYTES - sizeof(int)];
 491         } stats[NR_CPUS];
 492 };
 493
 494 static __inline__ void sk_set_owner(struct sock *sk, struct module *owner)
 495 {
 496         /*
 497          * One should use sk_set_owner just once, after struct sock creation,
 498          * be it shortly after sk_alloc or after a function that returns a new
 499          * struct sock (and that down the call chain called sk_alloc), e.g. the
 500          * IPv4 and IPv6 modules share tcp_create_openreq_child, so if
 501          * tcp_create_openreq_child called sk_set_owner IPv6 would have to
 502          * change the ownership of this struct sock, with one not needed
 503          * transient sk_set_owner call.
 504          */
 505         BUG_ON(sk->sk_owner != NULL);
 506
 507         sk->sk_owner = owner;
 508         __module_get(owner);
 509 }
 510
 511 /* Called with local bh disabled */
 512 static __inline__ void sock_prot_inc_use(struct proto *prot)
 513 {
 514         prot->stats[smp_processor_id()].inuse++;
 515 }
 516
 517 static __inline__ void sock_prot_dec_use(struct proto *prot)
 518 {
 519         prot->stats[smp_processor_id()].inuse--;
 520 }
 521
 522 /* About 10 seconds */
 523 #define SOCK_DESTROY_TIME (10*HZ)
 524
 525 /* Sockets 0-1023 can't be bound to unless you are superuser */
 526 #define PROT_SOCK       1024
 527
 528 #define SHUTDOWN_MASK   3
 529 #define RCV_SHUTDOWN    1
 530 #define SEND_SHUTDOWN   2
 531
 532 #define SOCK_SNDBUF_LOCK        1
 533 #define SOCK_RCVBUF_LOCK        2
 534 #define SOCK_BINDADDR_LOCK      4
 535 #define SOCK_BINDPORT_LOCK      8
 536
 537 /* sock_iocb: used to kick off async processing of socket ios */
 538 struct sock_iocb {
 539         struct list_head        list;
 540
 541         int                     flags;
 542         int                     size;
 543         struct socket           *sock;
 544         struct sock             *sk;
 545         struct scm_cookie       *scm;
 546         struct msghdr           *msg, async_msg;
 547         struct iovec            async_iov;
 548 };
 549
 550 static inline struct sock_iocb *kiocb_to_siocb(struct kiocb *iocb)
 551 {
 552         BUG_ON(sizeof(struct sock_iocb) > KIOCB_PRIVATE_SIZE);
 553         return (struct sock_iocb *)iocb->private;
 554 }
 555
 556 static inline struct kiocb *siocb_to_kiocb(struct sock_iocb *si)
 557 {
 558         return container_of((void *)si, struct kiocb, private);
 559 }
 560
 561 struct socket_alloc {
 562         struct socket socket;
 563         struct inode vfs_inode;
 564 };
 565
 566 static inline struct socket *SOCKET_I(struct inode *inode)
 567 {
 568         return &container_of(inode, struct socket_alloc, vfs_inode)->socket;
 569 }
 570
 571 static inline struct inode *SOCK_INODE(struct socket *socket)
 572 {
 573         return &container_of(socket, struct socket_alloc, socket)->vfs_inode;
 574 }
 575
 576 /* Used by processes to "lock" a socket state, so that
 577  * interrupts and bottom half handlers won't change it
 578  * from under us. It essentially blocks any incoming
 579  * packets, so that we won't get any new data or any
 580  * packets that change the state of the socket.
 581  *
 582  * While locked, BH processing will add new packets to
 583  * the backlog queue.  This queue is processed by the
 584  * owner of the socket lock right before it is released.
 585  *
 586  * Since ~2.3.5 it is also exclusive sleep lock serializing
 587  * accesses from user process context.
 588  */
 589 extern void __lock_sock(struct sock *sk);
 590 extern void __release_sock(struct sock *sk);
 591 #define sock_owned_by_user(sk)  ((sk)->sk_lock.owner)
 592
 593 extern void FASTCALL(lock_sock(struct sock *sk));
 594 extern void FASTCALL(release_sock(struct sock *sk));
 595
 596 /* BH context may only use the following locking interface. */
 597 #define bh_lock_sock(__sk)      spin_lock(&((__sk)->sk_lock.slock))
 598 #define bh_unlock_sock(__sk)    spin_unlock(&((__sk)->sk_lock.slock))
 599
 600 extern struct sock *            sk_alloc(int family, int priority, int zero_it,
 601                                          kmem_cache_t *slab);
 602 extern void                     sk_free(struct sock *sk);
 603
 604 extern struct sk_buff           *sock_wmalloc(struct sock *sk,
 605                                               unsigned long size, int force,
 606                                               int priority);
 607 extern struct sk_buff           *sock_rmalloc(struct sock *sk,
 608                                               unsigned long size, int force,
 609                                               int priority);
 610 extern void                     sock_wfree(struct sk_buff *skb);
 611 extern void                     sock_rfree(struct sk_buff *skb);
 612
 613 extern int                      sock_setsockopt(struct socket *sock, int level,
 614                                                 int op, char __user *optval,
 615                                                 int optlen);
 616
 617 extern int                      sock_getsockopt(struct socket *sock, int level,
 618                                                 int op, char __user *optval,
 619                                                 int __user *optlen);
 620 extern struct sk_buff           *sock_alloc_send_skb(struct sock *sk,
 621                                                      unsigned long size,
 622                                                      int noblock,
 623                                                      int *errcode);
 624 extern struct sk_buff           *sock_alloc_send_pskb(struct sock *sk,
 625                                                       unsigned long header_len,
 626                                                       unsigned long data_len,
 627                                                       int noblock,
 628                                                       int *errcode);
 629 extern void *sock_kmalloc(struct sock *sk, int size, int priority);
 630 extern void sock_kfree_s(struct sock *sk, void *mem, int size);
 631 extern void sk_send_sigurg(struct sock *sk);
 632
 633 /*
 634  * Functions to fill in entries in struct proto_ops when a protocol
 635  * does not implement a particular function.
 636  */
 637 extern int                      sock_no_release(struct socket *);
 638 extern int                      sock_no_bind(struct socket *,
 639                                              struct sockaddr *, int);
 640 extern int                      sock_no_connect(struct socket *,
 641                                                 struct sockaddr *, int, int);
 642 extern int                      sock_no_socketpair(struct socket *,
 643                                                    struct socket *);
 644 extern int                      sock_no_accept(struct socket *,
 645                                                struct socket *, int);
 646 extern int                      sock_no_getname(struct socket *,
 647                                                 struct sockaddr *, int *, int);
 648 extern unsigned int             sock_no_poll(struct file *, struct socket *,
 649                                              struct poll_table_struct *);
 650 extern int                      sock_no_ioctl(struct socket *, unsigned int,
 651                                               unsigned long);
 652 extern int                      sock_no_listen(struct socket *, int);
 653 extern int                      sock_no_shutdown(struct socket *, int);
 654 extern int                      sock_no_getsockopt(struct socket *, int , int,
 655                                                    char __user *, int __user *);
 656 extern int                      sock_no_setsockopt(struct socket *, int, int,
 657                                                    char __user *, int);
 658 extern int                      sock_no_sendmsg(struct kiocb *, struct socket *,
 659                                                 struct msghdr *, size_t);
 660 extern int                      sock_no_recvmsg(struct kiocb *, struct socket *,
 661                                                 struct msghdr *, size_t, int);
 662 extern int                      sock_no_mmap(struct file *file,
 663                                              struct socket *sock,
 664                                              struct vm_area_struct *vma);
 665 extern ssize_t                  sock_no_sendpage(struct socket *sock,
 666                                                 struct page *page,
 667                                                 int offset, size_t size,
 668                                                 int flags);
 669
 670 /*
 671  *      Default socket callbacks and setup code
 672  */
 673
 674 extern void sock_def_destruct(struct sock *);
 675
 676 /* Initialise core socket variables */
 677 extern void sock_init_data(struct socket *sock, struct sock *sk);
 678
 679 /**
 680  *      sk_filter - run a packet through a socket filter
 681  *      @sk: sock associated with &sk_buff
 682  *      @skb: buffer to filter
 683  *      @needlock: set to 1 if the sock is not locked by caller.
 684  *
 685  * Run the filter code and then cut skb->data to correct size returned by
 686  * sk_run_filter. If pkt_len is 0 we toss packet. If skb->len is smaller
 687  * than pkt_len we keep whole skb->data. This is the socket level
 688  * wrapper to sk_run_filter. It returns 0 if the packet should
 689  * be accepted or -EPERM if the packet should be tossed.
 690  *
 691  */
 692
 693 static inline int sk_filter(struct sock *sk, struct sk_buff *skb, int needlock)
 694 {
 695         int err;
 696
 697         err = security_sock_rcv_skb(sk, skb);
 698         if (err)
 699                 return err;
 700
 701         if (sk->sk_filter) {
 702                 struct sk_filter *filter;
 703
 704                 if (needlock)
 705                         bh_lock_sock(sk);
 706
 707                 filter = sk->sk_filter;
 708                 if (filter) {
 709                         int pkt_len = sk_run_filter(skb, filter->insns,
 710                                                     filter->len);
 711                         if (!pkt_len)
 712                                 err = -EPERM;
 713                         else
 714                                 skb_trim(skb, pkt_len);
 715                 }
 716
 717                 if (needlock)
 718                         bh_unlock_sock(sk);
 719         }
 720         return err;
 721 }
 722
 723 /**
 724  *      sk_filter_release: Release a socket filter
 725  *      @sk: socket
 726  *      @fp: filter to remove
 727  *
 728  *      Remove a filter from a socket and release its resources.
 729  */
 730
 731 static inline void sk_filter_release(struct sock *sk, struct sk_filter *fp)
 732 {
 733         unsigned int size = sk_filter_len(fp);
 734
 735         atomic_sub(size, &sk->sk_omem_alloc);
 736
 737         if (atomic_dec_and_test(&fp->refcnt))
 738                 kfree(fp);
 739 }
 740
 741 static inline void sk_filter_charge(struct sock *sk, struct sk_filter *fp)
 742 {
 743         atomic_inc(&fp->refcnt);
 744         atomic_add(sk_filter_len(fp), &sk->sk_omem_alloc);
 745 }
 746
 747 /*
 748  * Socket reference counting postulates.
 749  *
 750  * * Each user of socket SHOULD hold a reference count.
 751  * * Each access point to socket (an hash table bucket, reference from a list,
 752  *   running timer, skb in flight MUST hold a reference count.
 753  * * When reference count hits 0, it means it will never increase back.
 754  * * When reference count hits 0, it means that no references from
 755  *   outside exist to this socket and current process on current CPU
 756  *   is last user and may/should destroy this socket.
 757  * * sk_free is called from any context: process, BH, IRQ. When
 758  *   it is called, socket has no references from outside -> sk_free
 759  *   may release descendant resources allocated by the socket, but
 760  *   to the time when it is called, socket is NOT referenced by any
 761  *   hash tables, lists etc.
 762  * * Packets, delivered from outside (from network or from another process)
 763  *   and enqueued on receive/error queues SHOULD NOT grab reference count,
 764  *   when they sit in queue. Otherwise, packets will leak to hole, when
 765  *   socket is looked up by one cpu and unhasing is made by another CPU.
 766  *   It is true for udp/raw, netlink (leak to receive and error queues), tcp
 767  *   (leak to backlog). Packet socket does all the processing inside
 768  *   BR_NETPROTO_LOCK, so that it has not this race condition. UNIX sockets
 769  *   use separate SMP lock, so that they are prone too.
 770  */
 771
 772 /* Ungrab socket and destroy it, if it was the last reference. */
 773 static inline void sock_put(struct sock *sk)
 774 {
 775         if (atomic_dec_and_test(&sk->sk_refcnt))
 776                 sk_free(sk);
 777 }
 778
 779 /* Detach socket from process context.
 780  * Announce socket dead, detach it from wait queue and inode.
 781  * Note that parent inode held reference count on this struct sock,
 782  * we do not release it in this function, because protocol
 783  * probably wants some additional cleanups or even continuing
 784  * to work with this socket (TCP).
 785  */
 786 static inline void sock_orphan(struct sock *sk)
 787 {
 788         write_lock_bh(&sk->sk_callback_lock);
 789         sock_set_flag(sk, SOCK_DEAD);
 790         sk->sk_socket = NULL;
 791         sk->sk_sleep  = NULL;
 792         write_unlock_bh(&sk->sk_callback_lock);
 793 }
 794
 795 static inline void sock_graft(struct sock *sk, struct socket *parent)
 796 {
 797         write_lock_bh(&sk->sk_callback_lock);
 798         sk->sk_sleep = &parent->wait;
 799         parent->sk = sk;
 800         sk->sk_socket = parent;
 801         write_unlock_bh(&sk->sk_callback_lock);
 802 }
 803
 804 static inline int sock_i_uid(struct sock *sk)
 805 {
 806         int uid;
 807
 808         read_lock(&sk->sk_callback_lock);
 809         uid = sk->sk_socket ? SOCK_INODE(sk->sk_socket)->i_uid : 0;
 810         read_unlock(&sk->sk_callback_lock);
 811         return uid;
 812 }
 813
 814 static inline unsigned long sock_i_ino(struct sock *sk)
 815 {
 816         unsigned long ino;
 817
 818         read_lock(&sk->sk_callback_lock);
 819         ino = sk->sk_socket ? SOCK_INODE(sk->sk_socket)->i_ino : 0;
 820         read_unlock(&sk->sk_callback_lock);
 821         return ino;
 822 }
 823
 824 static inline struct dst_entry *
 825 __sk_dst_get(struct sock *sk)
 826 {
 827         return sk->sk_dst_cache;
 828 }
 829
 830 static inline struct dst_entry *
 831 sk_dst_get(struct sock *sk)
 832 {
 833         struct dst_entry *dst;
 834
 835         read_lock(&sk->sk_dst_lock);
 836         dst = sk->sk_dst_cache;
 837         if (dst)
 838                 dst_hold(dst);
 839         read_unlock(&sk->sk_dst_lock);
 840         return dst;
 841 }
 842
 843 static inline void
 844 __sk_dst_set(struct sock *sk, struct dst_entry *dst)
 845 {
 846         struct dst_entry *old_dst;
 847
 848         old_dst = sk->sk_dst_cache;
 849         sk->sk_dst_cache = dst;
 850         dst_release(old_dst);
 851 }
 852
 853 static inline void
 854 sk_dst_set(struct sock *sk, struct dst_entry *dst)
 855 {
 856         write_lock(&sk->sk_dst_lock);
 857         __sk_dst_set(sk, dst);
 858         write_unlock(&sk->sk_dst_lock);
 859 }
 860
 861 static inline void
 862 __sk_dst_reset(struct sock *sk)
 863 {
 864         struct dst_entry *old_dst;
 865
 866         old_dst = sk->sk_dst_cache;
 867         sk->sk_dst_cache = NULL;
 868         dst_release(old_dst);
 869 }
 870
 871 static inline void
 872 sk_dst_reset(struct sock *sk)
 873 {
 874         write_lock(&sk->sk_dst_lock);
 875         __sk_dst_reset(sk);
 876         write_unlock(&sk->sk_dst_lock);
 877 }
 878
 879 static inline struct dst_entry *
 880 __sk_dst_check(struct sock *sk, u32 cookie)
 881 {
 882         struct dst_entry *dst = sk->sk_dst_cache;
 883
 884         if (dst && dst->obsolete && dst->ops->check(dst, cookie) == NULL) {
 885                 sk->sk_dst_cache = NULL;
 886                 return NULL;
 887         }
 888
 889         return dst;
 890 }
 891
 892 static inline struct dst_entry *
 893 sk_dst_check(struct sock *sk, u32 cookie)
 894 {
 895         struct dst_entry *dst = sk_dst_get(sk);
 896
 897         if (dst && dst->obsolete && dst->ops->check(dst, cookie) == NULL) {
 898                 sk_dst_reset(sk);
 899                 return NULL;
 900         }
 901
 902         return dst;
 903 }
 904
 905
 906 /*
 907  *      Queue a received datagram if it will fit. Stream and sequenced
 908  *      protocols can't normally use this as they need to fit buffers in
 909  *      and play with them.
 910  *
 911  *      Inlined as it's very short and called for pretty much every
 912  *      packet ever received.
 913  */
 914
 915 static inline void skb_set_owner_w(struct sk_buff *skb, struct sock *sk)
 916 {
 917         sock_hold(sk);
 918         skb->sk = sk;
 919         skb->destructor = sock_wfree;
 920         atomic_add(skb->truesize, &sk->sk_wmem_alloc);
 921 }
 922
 923 static inline void skb_set_owner_r(struct sk_buff *skb, struct sock *sk)
 924 {
 925         skb->sk = sk;
 926         skb->destructor = sock_rfree;
 927         atomic_add(skb->truesize, &sk->sk_rmem_alloc);
 928 }
 929
 930 extern void sk_reset_timer(struct sock *sk, struct timer_list* timer,
 931                            unsigned long expires);
 932
 933 extern void sk_stop_timer(struct sock *sk, struct timer_list* timer);
 934
 935 static inline int sock_queue_rcv_skb(struct sock *sk, struct sk_buff *skb)
 936 {
 937         int err = 0;
 938         int skb_len;
 939
 940         /* Cast skb->rcvbuf to unsigned... It's pointless, but reduces
 941            number of warnings when compiling with -W --ANK
 942          */
 943         if (atomic_read(&sk->sk_rmem_alloc) + skb->truesize >=
 944             (unsigned)sk->sk_rcvbuf) {
 945                 err = -ENOMEM;
 946                 goto out;
 947         }
 948
 949         /* It would be deadlock, if sock_queue_rcv_skb is used
 950            with socket lock! We assume that users of this
 951            function are lock free.
 952         */
 953         err = sk_filter(sk, skb, 1);
 954         if (err)
 955                 goto out;
 956
 957         skb->dev = NULL;
 958         skb_set_owner_r(skb, sk);
 959
 960         /* Cache the SKB length before we tack it onto the receive
 961          * queue.  Once it is added it no longer belongs to us and
 962          * may be freed by other threads of control pulling packets
 963          * from the queue.
 964          */
 965         skb_len = skb->len;
 966
 967         skb_queue_tail(&sk->sk_receive_queue, skb);
 968
 969         if (!sock_flag(sk, SOCK_DEAD))
 970                 sk->sk_data_ready(sk, skb_len);
 971 out:
 972         return err;
 973 }
 974
 975 static inline int sock_queue_err_skb(struct sock *sk, struct sk_buff *skb)
 976 {
 977         /* Cast skb->rcvbuf to unsigned... It's pointless, but reduces
 978            number of warnings when compiling with -W --ANK
 979          */
 980         if (atomic_read(&sk->sk_rmem_alloc) + skb->truesize >=
 981             (unsigned)sk->sk_rcvbuf)
 982                 return -ENOMEM;
 983         skb_set_owner_r(skb, sk);
 984         skb_queue_tail(&sk->sk_error_queue, skb);
 985         if (!sock_flag(sk, SOCK_DEAD))
 986                 sk->sk_data_ready(sk, skb->len);
 987         return 0;
 988 }
 989
 990 /*
 991  *      Recover an error report and clear atomically
 992  */
 993
 994 static inline int sock_error(struct sock *sk)
 995 {
 996         int err = xchg(&sk->sk_err, 0);
 997         return -err;
 998 }
 999
1000 static inline unsigned long sock_wspace(struct sock *sk)
1001 {
1002         int amt = 0;
1003
1004         if (!(sk->sk_shutdown & SEND_SHUTDOWN)) {
1005                 amt = sk->sk_sndbuf - atomic_read(&sk->sk_wmem_alloc);
1006                 if (amt < 0)
1007                         amt = 0;
1008         }
1009         return amt;
1010 }
1011
1012 static inline void sk_wake_async(struct sock *sk, int how, int band)
1013 {
1014         if (sk->sk_socket && sk->sk_socket->fasync_list)
1015                 sock_wake_async(sk->sk_socket, how, band);
1016 }
1017
1018 #define SOCK_MIN_SNDBUF 2048
1019 #define SOCK_MIN_RCVBUF 256
1020
1021 /*
1022  *      Default write policy as shown to user space via poll/select/SIGIO
1023  */
1024 static inline int sock_writeable(struct sock *sk)
1025 {
1026         return atomic_read(&sk->sk_wmem_alloc) < (sk->sk_sndbuf / 2);
1027 }
1028
1029 static inline int gfp_any(void)
1030 {
1031         return in_softirq() ? GFP_ATOMIC : GFP_KERNEL;
1032 }
1033
1034 static inline long sock_rcvtimeo(struct sock *sk, int noblock)
1035 {
1036         return noblock ? 0 : sk->sk_rcvtimeo;
1037 }
1038
1039 static inline long sock_sndtimeo(struct sock *sk, int noblock)
1040 {
1041         return noblock ? 0 : sk->sk_sndtimeo;
1042 }
1043
1044 static inline int sock_rcvlowat(struct sock *sk, int waitall, int len)
1045 {
1046         return (waitall ? len : min_t(int, sk->sk_rcvlowat, len)) ? : 1;
1047 }
1048
1049 /* Alas, with timeout socket operations are not restartable.
1050  * Compare this to poll().
1051  */
1052 static inline int sock_intr_errno(long timeo)
1053 {
1054         return timeo == MAX_SCHEDULE_TIMEOUT ? -ERESTARTSYS : -EINTR;
1055 }
1056
1057 static __inline__ void
1058 sock_recv_timestamp(struct msghdr *msg, struct sock *sk, struct sk_buff *skb)
1059 {
1060         struct timeval *stamp = &skb->stamp;
1061         if (sk->sk_rcvtstamp) {
1062                 /* Race occurred between timestamp enabling and packet
1063                    receiving.  Fill in the current time for now. */
1064                 if (stamp->tv_sec == 0)
1065                         do_gettimeofday(stamp);
1066                 put_cmsg(msg, SOL_SOCKET, SO_TIMESTAMP, sizeof(struct timeval),
1067                          stamp);
1068         } else
1069                 sk->sk_stamp = *stamp;
1070 }
1071
1072 /**
1073  * sk_eat_skb - Release a skb if it is no longer needed
1074  * @sk - socket to eat this skb from
1075  * @skb - socket buffer to eat
1076  *
1077  * This routine must be called with interrupts disabled or with the socket
1078  * locked so that the sk_buff queue operation is ok.
1079 */
1080 static inline void sk_eat_skb(struct sock *sk, struct sk_buff *skb)
1081 {
1082         __skb_unlink(skb, &sk->sk_receive_queue);
1083         __kfree_skb(skb);
1084 }
1085
1086 extern atomic_t netstamp_needed;
1087 extern void sock_enable_timestamp(struct sock *sk);
1088 extern void sock_disable_timestamp(struct sock *sk);
1089
1090 static inline void net_timestamp(struct timeval *stamp)
1091 {
1092         if (atomic_read(&netstamp_needed))
1093                 do_gettimeofday(stamp);
1094         else {
1095                 stamp->tv_sec = 0;
1096                 stamp->tv_usec = 0;
1097         }
1098 }
1099
1100 extern int sock_get_timestamp(struct sock *, struct timeval __user *);
1101
1102 /*
1103  *      Enable debug/info messages
1104  */
1105
1106 #if 0
1107 #define NETDEBUG(x)     do { } while (0)
1108 #define LIMIT_NETDEBUG(x) do {} while(0)
1109 #else
1110 #define NETDEBUG(x)     do { x; } while (0)
1111 #define LIMIT_NETDEBUG(x) do { if (net_ratelimit()) { x; } } while(0)
1112 #endif
1113
1114 /*
1115  * Macros for sleeping on a socket. Use them like this:
1116  *
1117  * SOCK_SLEEP_PRE(sk)
1118  * if (condition)
1119  *      schedule();
1120  * SOCK_SLEEP_POST(sk)
1121  *
1122  * N.B. These are now obsolete and were, afaik, only ever used in DECnet
1123  * and when the last use of them in DECnet has gone, I'm intending to
1124  * remove them.
1125  */
1126
1127 #define SOCK_SLEEP_PRE(sk)      { struct task_struct *tsk = current; \
1128                                 DECLARE_WAITQUEUE(wait, tsk); \
1129                                 tsk->state = TASK_INTERRUPTIBLE; \
1130                                 add_wait_queue((sk)->sk_sleep, &wait); \
1131                                 release_sock(sk);
1132
1133 #define SOCK_SLEEP_POST(sk)     tsk->state = TASK_RUNNING; \
1134                                 remove_wait_queue((sk)->sk_sleep, &wait); \
1135                                 lock_sock(sk); \
1136                                 }
1137
1138 static inline void sock_valbool_flag(struct sock *sk, int bit, int valbool)
1139 {
1140         if (valbool)
1141                 sock_set_flag(sk, bit);
1142         else
1143                 sock_reset_flag(sk, bit);
1144 }
1145
1146 extern __u32 sysctl_wmem_max;
1147 extern __u32 sysctl_rmem_max;
1148
1149 int siocdevprivate_ioctl(unsigned int fd, unsigned int cmd, unsigned long arg);
1150
1151 #endif  /* _SOCK_H */