FreeBSD/Linux Kernel Cross Reference
sys/netinet/in_pcb.h

     /*
      * Copyright (c) 1982, 1986, 1990, 1993
      *      The Regents of the University of California.  All rights reserved.
      *
      * Redistribution and use in source and binary forms, with or without
      * modification, are permitted provided that the following conditions
      * are met:
      * 1. Redistributions of source code must retain the above copyright
      *    notice, this list of conditions and the following disclaimer.
     * 2. Redistributions in binary form must reproduce the above copyright
     *    notice, this list of conditions and the following disclaimer in the
     *    documentation and/or other materials provided with the distribution.
     * 3. All advertising materials mentioning features or use of this software
     *    must display the following acknowledgement:
     *      This product includes software developed by the University of
     *      California, Berkeley and its contributors.
     * 4. Neither the name of the University nor the names of its contributors
     *    may be used to endorse or promote products derived from this software
     *    without specific prior written permission.
     *
     * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
     * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
     * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
     * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
     * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
     * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
     * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
     * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
     * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
     * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
     * SUCH DAMAGE.
     *
     *      @(#)in_pcb.h    8.1 (Berkeley) 6/10/93
     * $FreeBSD$
     */
    
    #ifndef _NETINET_IN_PCB_H_
    #define _NETINET_IN_PCB_H_
    
    #include <sys/queue.h>
    
    /*
     * Common structure pcb for internet protocol implementation.
     * Here are stored pointers to local and foreign host table
     * entries, local and foreign socket numbers, and pointers
     * up (to a socket structure) and down (to a protocol-specific)
     * control block.
     */
    LIST_HEAD(inpcbhead, inpcb);
    LIST_HEAD(inpcbporthead, inpcbport);
    typedef u_quad_t        inp_gen_t;
    
    /*
     * NB: the zone allocator is type-stable EXCEPT FOR THE FIRST TWO LONGS
     * of the structure.  Therefore, it is important that the members in
     * that position not contain any information which is required to be
     * stable.
     */
    struct inpcb {
            LIST_ENTRY(inpcb) inp_hash;     /* hash list */
            struct  in_addr inp_faddr;      /* foreign host table entry */
            struct  in_addr inp_laddr;      /* local host table entry */
            u_short inp_fport;              /* foreign port */
            u_short inp_lport;              /* local port */
            LIST_ENTRY(inpcb) inp_list;     /* list for all PCBs of this proto */
            caddr_t inp_ppcb;               /* pointer to per-protocol pcb */
            struct  inpcbinfo *inp_pcbinfo; /* PCB list info */
            struct  socket *inp_socket;     /* back pointer to socket */
            struct  mbuf *inp_options;      /* IP options */
            struct  route inp_route;        /* placeholder for routing entry */
            int     inp_flags;              /* generic IP/datagram flags */
            u_char  inp_ip_tos;             /* type of service proto */
            u_char  inp_ip_ttl;             /* time to live proto */
            u_char  inp_ip_p;               /* protocol proto */
            u_char  pad[1];                 /* alignment */
            struct  ip_moptions *inp_moptions; /* IP multicast options */
            LIST_ENTRY(inpcb) inp_portlist; /* list for this PCB's local port */
            struct  inpcbport *inp_phd;     /* head of this list */
            inp_gen_t inp_gencnt;           /* generation count of this instance */
    };
    /*
     * The range of the generation count, as used in this implementation,
     * is 9e19.  We would have to create 300 billion connections per
     * second for this number to roll over in a year.  This seems sufficiently
     * unlikely that we simply don't concern ourselves with that possibility.
     */
    
    /*
     * Interface exported to userland by various protocols which use
     * inpcbs.  Hack alert -- only define if struct xsocket is in scope.
     */
    #ifdef _SYS_SOCKETVAR_H_
    struct  xinpcb {
            size_t  xi_len;         /* length of this structure */
            struct  inpcb xi_inp;
            struct  xsocket xi_socket;
            u_quad_t        xi_alignment_hack;
    };
    
   struct  xinpgen {
           size_t  xig_len;        /* length of this structure */
           u_int   xig_count;      /* number of PCBs at this time */
           inp_gen_t xig_gen;      /* generation count at this time */
           so_gen_t xig_sogen;     /* socket generation count at this time */
   };
   #endif /* _SYS_SOCKETVAR_H_ */
   
   struct inpcbport {
           LIST_ENTRY(inpcbport) phd_hash;
           struct inpcbhead phd_pcblist;
           u_short phd_port;
   };
   
   struct inpcbinfo {              /* XXX documentation, prefixes */
           struct  inpcbhead *hashbase;
           u_long  hashmask;
           struct  inpcbporthead *porthashbase;
           u_long  porthashmask;
           struct  inpcbhead *listhead;
           u_short lastport;
           u_short lastlow;
           u_short lasthi;
           struct  vm_zone *ipi_zone; /* zone to allocate pcbs from */
           u_int   ipi_count;      /* number of pcbs in this list */
           u_quad_t ipi_gencnt;    /* current generation count */
   };
   
   #define INP_PCBHASH(faddr, lport, fport, mask) \
           (((faddr) ^ ((faddr) >> 16) ^ ntohs((lport) ^ (fport))) & (mask))
   #define INP_PCBPORTHASH(lport, mask) \
           (ntohs((lport)) & (mask))
   
   /* flags in inp_flags: */
   #define INP_RECVOPTS            0x01    /* receive incoming IP options */
   #define INP_RECVRETOPTS         0x02    /* receive IP options for reply */
   #define INP_RECVDSTADDR         0x04    /* receive IP dst address */
   #define INP_HDRINCL             0x08    /* user supplies entire IP header */
   #define INP_HIGHPORT            0x10    /* user wants "high" port binding */
   #define INP_LOWPORT             0x20    /* user wants "low" port binding */
   #define INP_ANONPORT            0x40    /* port chosen for user */
   #define INP_RECVIF              0x80    /* receive incoming interface */
   #define INP_MTUDISC             0x100   /* user can do MTU discovery */
   #define INP_CONTROLOPTS         (INP_RECVOPTS|INP_RECVRETOPTS|INP_RECVDSTADDR|\
                                           INP_RECVIF)
   
   #define INPLOOKUP_WILDCARD      1
   
   #define sotoinpcb(so)   ((struct inpcb *)(so)->so_pcb)
   
   #ifdef KERNEL
   void    in_losing __P((struct inpcb *));
   void    in_rtchange __P((struct inpcb *, int));
   int     in_pcballoc __P((struct socket *, struct inpcbinfo *, struct proc *));
   int     in_pcbbind __P((struct inpcb *, struct sockaddr *, struct proc *));
   int     in_pcbconnect __P((struct inpcb *, struct sockaddr *, struct proc *));
   void    in_pcbdetach __P((struct inpcb *));
   void    in_pcbdisconnect __P((struct inpcb *));
   int     in_pcbinshash __P((struct inpcb *));
   int     in_pcbladdr __P((struct inpcb *, struct sockaddr *,
               struct sockaddr_in **));
   struct inpcb *
           in_pcblookup_local __P((struct inpcbinfo *,
               struct in_addr, u_int, int));
   struct inpcb *
           in_pcblookup_hash __P((struct inpcbinfo *,
               struct in_addr, u_int, struct in_addr, u_int, int));
   void    in_pcbnotify __P((struct inpcbhead *, struct sockaddr *,
               u_int, struct in_addr, u_int, int, void (*)(struct inpcb *, int)));
   void    in_pcbnotifyall __P((struct inpcbhead *, struct sockaddr *,
               int, void (*)(struct inpcb *, int)));
   void    in_pcbrehash __P((struct inpcb *));
   int     in_setpeeraddr __P((struct socket *so, struct sockaddr **nam));
   int     in_setsockaddr __P((struct socket *so, struct sockaddr **nam));
   #endif /* KERNEL */
   
   #endif /* !_NETINET_IN_PCB_H_ */

Cache object: 51e186b028f92709514c949e04934fc3