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