Annotation of XNU/bsd/sys/unpcb.h, revision 1.1.1.1

1.1       root        1: /*
                      2:  * Copyright (c) 2000 Apple Computer, Inc. All rights reserved.
                      3:  *
                      4:  * @APPLE_LICENSE_HEADER_START@
                      5:  * 
                      6:  * The contents of this file constitute Original Code as defined in and
                      7:  * are subject to the Apple Public Source License Version 1.1 (the
                      8:  * "License").  You may not use this file except in compliance with the
                      9:  * License.  Please obtain a copy of the License at
                     10:  * http://www.apple.com/publicsource and read it before using this file.
                     11:  * 
                     12:  * This Original Code and all software distributed under the License are
                     13:  * distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY KIND, EITHER
                     14:  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
                     15:  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
                     16:  * FITNESS FOR A PARTICULAR PURPOSE OR NON-INFRINGEMENT.  Please see the
                     17:  * License for the specific language governing rights and limitations
                     18:  * under the License.
                     19:  * 
                     20:  * @APPLE_LICENSE_HEADER_END@
                     21:  */
                     22: /*
                     23:  * Copyright (c) 1982, 1986, 1989, 1993
                     24:  *     The Regents of the University of California.  All rights reserved.
                     25:  *
                     26:  * Redistribution and use in source and binary forms, with or without
                     27:  * modification, are permitted provided that the following conditions
                     28:  * are met:
                     29:  * 1. Redistributions of source code must retain the above copyright
                     30:  *    notice, this list of conditions and the following disclaimer.
                     31:  * 2. Redistributions in binary form must reproduce the above copyright
                     32:  *    notice, this list of conditions and the following disclaimer in the
                     33:  *    documentation and/or other materials provided with the distribution.
                     34:  * 3. All advertising materials mentioning features or use of this software
                     35:  *    must display the following acknowledgement:
                     36:  *     This product includes software developed by the University of
                     37:  *     California, Berkeley and its contributors.
                     38:  * 4. Neither the name of the University nor the names of its contributors
                     39:  *    may be used to endorse or promote products derived from this software
                     40:  *    without specific prior written permission.
                     41:  *
                     42:  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
                     43:  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
                     44:  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
                     45:  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
                     46:  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
                     47:  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
                     48:  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
                     49:  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
                     50:  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
                     51:  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
                     52:  * SUCH DAMAGE.
                     53:  *
                     54:  *     @(#)unpcb.h     8.1 (Berkeley) 6/2/93
                     55:  */
                     56: 
                     57: #ifndef _SYS_UNPCB_H_
                     58: #define _SYS_UNPCB_H_
                     59: 
                     60: #include <sys/queue.h>
                     61: #include <sys/un.h>
                     62: 
                     63: /*
                     64:  * Protocol control block for an active
                     65:  * instance of a UNIX internal protocol.
                     66:  *
                     67:  * A socket may be associated with an vnode in the
                     68:  * file system.  If so, the unp_vnode pointer holds
                     69:  * a reference count to this vnode, which should be irele'd
                     70:  * when the socket goes away.
                     71:  *
                     72:  * A socket may be connected to another socket, in which
                     73:  * case the control block of the socket to which it is connected
                     74:  * is given by unp_conn.
                     75:  *
                     76:  * A socket may be referenced by a number of sockets (e.g. several
                     77:  * sockets may be connected to a datagram socket.)  These sockets
                     78:  * are in a linked list starting with unp_refs, linked through
                     79:  * unp_nextref and null-terminated.  Note that a socket may be referenced
                     80:  * by a number of other sockets and may also reference a socket (not
                     81:  * necessarily one which is referencing it).  This generates
                     82:  * the need for unp_refs and unp_nextref to be separate fields.
                     83:  *
                     84:  * Stream sockets keep copies of receive sockbuf sb_cc and sb_mbcnt
                     85:  * so that changes in the sockbuf may be computed to modify
                     86:  * back pressure on the sender accordingly.
                     87:  */
                     88: typedef        u_quad_t        unp_gen_t;
                     89: LIST_HEAD(unp_head, unpcb);
                     90: 
                     91: struct unpcb {
                     92:        LIST_ENTRY(unpcb) unp_link;     /* glue on list of all PCBs */
                     93:        struct  socket *unp_socket;     /* pointer back to socket */
                     94:        struct  vnode *unp_vnode;       /* if associated with file */
                     95:        ino_t   unp_ino;                /* fake inode number */
                     96:        struct  unpcb *unp_conn;        /* control block of connected socket */
                     97:        struct  unp_head unp_refs;      /* referencing socket linked list */
                     98:        LIST_ENTRY(unpcb) unp_reflink;  /* link in unp_refs list */
                     99:        struct  sockaddr_un *unp_addr;  /* bound address of socket */
                    100:        int     unp_cc;                 /* copy of rcv.sb_cc */
                    101:        int     unp_mbcnt;              /* copy of rcv.sb_mbcnt */
                    102:        unp_gen_t unp_gencnt;           /* generation count of this instance */
                    103: };
                    104: 
                    105: #define        sotounpcb(so)   ((struct unpcb *)((so)->so_pcb))
                    106: 
                    107: /* Hack alert -- this structure depends on <sys/socketvar.h>. */
                    108: #ifdef _SYS_SOCKETVAR_H_
                    109: struct xunpcb {
                    110:        size_t  xu_len;                 /* length of this structure */
                    111:        struct  unpcb *xu_unpp;         /* to help netstat, fstat */
                    112:        struct  unpcb xu_unp;           /* our information */
                    113:        union {
                    114:                struct  sockaddr_un xuu_addr;   /* our bound address */
                    115:                char    xu_dummy1[256];
                    116:        } xu_au;
                    117: #define        xu_addr xu_au.xuu_addr
                    118:        union {
                    119:                struct  sockaddr_un xuu_caddr; /* their bound address */
                    120:                char    xu_dummy2[256];
                    121:        } xu_cau;
                    122: #define        xu_caddr xu_cau.xuu_caddr
                    123:        struct  xsocket xu_socket;
                    124:        u_quad_t        xu_alignment_hack;
                    125: };
                    126: 
                    127: struct xunpgen {
                    128:        size_t  xug_len;
                    129:        u_int   xug_count;
                    130:        unp_gen_t xug_gen;
                    131:        so_gen_t xug_sogen;
                    132: };
                    133: #endif /* _SYS_SOCKETVAR_H_ */
                    134: 
                    135: #endif /* _SYS_UNPCB_H_ */

unix.superglobalmegacorp.com

This archive runs on limited infrastructure. Preserving old code on modern bandwidth. Automated agents are requested to crawl responsibly.