socketvar.h revision 50477
1/*- 2 * Copyright (c) 1982, 1986, 1990, 1993 3 * The Regents of the University of California. All rights reserved. 4 * 5 * Redistribution and use in source and binary forms, with or without 6 * modification, are permitted provided that the following conditions 7 * are met: 8 * 1. Redistributions of source code must retain the above copyright 9 * notice, this list of conditions and the following disclaimer. 10 * 2. Redistributions in binary form must reproduce the above copyright 11 * notice, this list of conditions and the following disclaimer in the 12 * documentation and/or other materials provided with the distribution. 13 * 3. All advertising materials mentioning features or use of this software 14 * must display the following acknowledgement: 15 * This product includes software developed by the University of 16 * California, Berkeley and its contributors. 17 * 4. Neither the name of the University nor the names of its contributors 18 * may be used to endorse or promote products derived from this software 19 * without specific prior written permission. 20 * 21 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 22 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 23 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 24 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 25 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 26 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 27 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 28 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 29 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 30 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 31 * SUCH DAMAGE. 32 * 33 * @(#)socketvar.h 8.3 (Berkeley) 2/19/95 34 * $FreeBSD: head/sys/sys/socketvar.h 50477 1999-08-28 01:08:13Z peter $ 35 */ 36 37#ifndef _SYS_SOCKETVAR_H_ 38#define _SYS_SOCKETVAR_H_ 39 40#include <sys/queue.h> /* for TAILQ macros */ 41#include <sys/select.h> /* for struct selinfo */ 42 43/* 44 * Kernel structure per socket. 45 * Contains send and receive buffer queues, 46 * handle on protocol and pointer to protocol 47 * private data and error information. 48 */ 49typedef u_quad_t so_gen_t; 50 51struct socket { 52 struct vm_zone *so_zone; /* zone we were allocated from */ 53 short so_type; /* generic type, see socket.h */ 54 short so_options; /* from socket call, see socket.h */ 55 short so_linger; /* time to linger while closing */ 56 short so_state; /* internal state flags SS_*, below */ 57 caddr_t so_pcb; /* protocol control block */ 58 struct protosw *so_proto; /* protocol handle */ 59/* 60 * Variables for connection queuing. 61 * Socket where accepts occur is so_head in all subsidiary sockets. 62 * If so_head is 0, socket is not related to an accept. 63 * For head socket so_q0 queues partially completed connections, 64 * while so_q is a queue of connections ready to be accepted. 65 * If a connection is aborted and it has so_head set, then 66 * it has to be pulled out of either so_q0 or so_q. 67 * We allow connections to queue up based on current queue lengths 68 * and limit on number of queued connections for this socket. 69 */ 70 struct socket *so_head; /* back pointer to accept socket */ 71 TAILQ_HEAD(, socket) so_incomp; /* queue of partial unaccepted connections */ 72 TAILQ_HEAD(, socket) so_comp; /* queue of complete unaccepted connections */ 73 TAILQ_ENTRY(socket) so_list; /* list of unaccepted connections */ 74 short so_qlen; /* number of unaccepted connections */ 75 short so_incqlen; /* number of unaccepted incomplete 76 connections */ 77 short so_qlimit; /* max number queued connections */ 78 short so_timeo; /* connection timeout */ 79 u_short so_error; /* error affecting connection */ 80 struct sigio *so_sigio; /* information for async I/O or 81 out of band data (SIGURG) */ 82 u_long so_oobmark; /* chars to oob mark */ 83/* 84 * Variables for socket buffering. 85 */ 86 struct sockbuf { 87 u_long sb_cc; /* actual chars in buffer */ 88 u_long sb_hiwat; /* max actual char count */ 89 u_long sb_mbcnt; /* chars of mbufs used */ 90 u_long sb_mbmax; /* max chars of mbufs to use */ 91 long sb_lowat; /* low water mark */ 92 struct mbuf *sb_mb; /* the mbuf chain */ 93 struct selinfo sb_sel; /* process selecting read/write */ 94 short sb_flags; /* flags, see below */ 95 short sb_timeo; /* timeout for read/write */ 96 } so_rcv, so_snd; 97#define SB_MAX (256*1024) /* default for max chars in sockbuf */ 98#define SB_LOCK 0x01 /* lock on data queue */ 99#define SB_WANT 0x02 /* someone is waiting to lock */ 100#define SB_WAIT 0x04 /* someone is waiting for data/space */ 101#define SB_SEL 0x08 /* someone is selecting */ 102#define SB_ASYNC 0x10 /* ASYNC I/O, need signals */ 103#define SB_UPCALL 0x20 /* someone wants an upcall */ 104#define SB_NOINTR 0x40 /* operations not interruptible */ 105 106 void (*so_upcall) __P((struct socket *, void *, int)); 107 void *so_upcallarg; 108 struct pcred *so_cred; /* user credentials */ 109 /* NB: generation count must not be first; easiest to make it last. */ 110 so_gen_t so_gencnt; /* generation count */ 111 void *so_emuldata; /* private data for emulators */ 112}; 113 114/* 115 * Socket state bits. 116 */ 117#define SS_NOFDREF 0x0001 /* no file table ref any more */ 118#define SS_ISCONNECTED 0x0002 /* socket connected to a peer */ 119#define SS_ISCONNECTING 0x0004 /* in process of connecting to peer */ 120#define SS_ISDISCONNECTING 0x0008 /* in process of disconnecting */ 121#define SS_CANTSENDMORE 0x0010 /* can't send more data to peer */ 122#define SS_CANTRCVMORE 0x0020 /* can't receive more data from peer */ 123#define SS_RCVATMARK 0x0040 /* at mark on input */ 124 125#define SS_NBIO 0x0100 /* non-blocking ops */ 126#define SS_ASYNC 0x0200 /* async i/o notify */ 127#define SS_ISCONFIRMING 0x0400 /* deciding to accept connection req */ 128 129#define SS_INCOMP 0x0800 /* unaccepted, incomplete connection */ 130#define SS_COMP 0x1000 /* unaccepted, complete connection */ 131#define SS_ISDISCONNECTED 0x2000 /* socket disconnected from peer */ 132 133/* 134 * Externalized form of struct socket used by the sysctl(3) interface. 135 */ 136struct xsocket { 137 size_t xso_len; /* length of this structure */ 138 struct socket *xso_so; /* makes a convenient handle sometimes */ 139 short so_type; 140 short so_options; 141 short so_linger; 142 short so_state; 143 caddr_t so_pcb; /* another convenient handle */ 144 int xso_protocol; 145 int xso_family; 146 short so_qlen; 147 short so_incqlen; 148 short so_qlimit; 149 short so_timeo; 150 u_short so_error; 151 pid_t so_pgid; 152 u_long so_oobmark; 153 struct xsockbuf { 154 u_long sb_cc; 155 u_long sb_hiwat; 156 u_long sb_mbcnt; 157 u_long sb_mbmax; 158 long sb_lowat; 159 short sb_flags; 160 short sb_timeo; 161 } so_rcv, so_snd; 162 uid_t so_uid; /* XXX */ 163}; 164 165/* 166 * Macros for sockets and socket buffering. 167 */ 168 169/* 170 * Do we need to notify the other side when I/O is possible? 171 */ 172#define sb_notify(sb) (((sb)->sb_flags & (SB_WAIT|SB_SEL|SB_ASYNC|SB_UPCALL)) != 0) 173 174/* 175 * How much space is there in a socket buffer (so->so_snd or so->so_rcv)? 176 * This is problematical if the fields are unsigned, as the space might 177 * still be negative (cc > hiwat or mbcnt > mbmax). Should detect 178 * overflow and return 0. Should use "lmin" but it doesn't exist now. 179 */ 180#define sbspace(sb) \ 181 ((long) imin((int)((sb)->sb_hiwat - (sb)->sb_cc), \ 182 (int)((sb)->sb_mbmax - (sb)->sb_mbcnt))) 183 184/* do we have to send all at once on a socket? */ 185#define sosendallatonce(so) \ 186 ((so)->so_proto->pr_flags & PR_ATOMIC) 187 188/* can we read something from so? */ 189#define soreadable(so) \ 190 ((so)->so_rcv.sb_cc >= (so)->so_rcv.sb_lowat || \ 191 ((so)->so_state & SS_CANTRCVMORE) || \ 192 (so)->so_comp.tqh_first || (so)->so_error) 193 194/* can we write something to so? */ 195#define sowriteable(so) \ 196 ((sbspace(&(so)->so_snd) >= (so)->so_snd.sb_lowat && \ 197 (((so)->so_state&SS_ISCONNECTED) || \ 198 ((so)->so_proto->pr_flags&PR_CONNREQUIRED)==0)) || \ 199 ((so)->so_state & SS_CANTSENDMORE) || \ 200 (so)->so_error) 201 202/* adjust counters in sb reflecting allocation of m */ 203#define sballoc(sb, m) { \ 204 (sb)->sb_cc += (m)->m_len; \ 205 (sb)->sb_mbcnt += MSIZE; \ 206 if ((m)->m_flags & M_EXT) \ 207 (sb)->sb_mbcnt += (m)->m_ext.ext_size; \ 208} 209 210/* adjust counters in sb reflecting freeing of m */ 211#define sbfree(sb, m) { \ 212 (sb)->sb_cc -= (m)->m_len; \ 213 (sb)->sb_mbcnt -= MSIZE; \ 214 if ((m)->m_flags & M_EXT) \ 215 (sb)->sb_mbcnt -= (m)->m_ext.ext_size; \ 216} 217 218/* 219 * Set lock on sockbuf sb; sleep if lock is already held. 220 * Unless SB_NOINTR is set on sockbuf, sleep is interruptible. 221 * Returns error without lock if sleep is interrupted. 222 */ 223#define sblock(sb, wf) ((sb)->sb_flags & SB_LOCK ? \ 224 (((wf) == M_WAITOK) ? sb_lock(sb) : EWOULDBLOCK) : \ 225 ((sb)->sb_flags |= SB_LOCK), 0) 226 227/* release lock on sockbuf sb */ 228#define sbunlock(sb) { \ 229 (sb)->sb_flags &= ~SB_LOCK; \ 230 if ((sb)->sb_flags & SB_WANT) { \ 231 (sb)->sb_flags &= ~SB_WANT; \ 232 wakeup((caddr_t)&(sb)->sb_flags); \ 233 } \ 234} 235 236#define sorwakeup(so) do { \ 237 if (sb_notify(&(so)->so_rcv)) \ 238 sowakeup((so), &(so)->so_rcv); \ 239 } while (0) 240 241#define sowwakeup(so) do { \ 242 if (sb_notify(&(so)->so_snd)) \ 243 sowakeup((so), &(so)->so_snd); \ 244 } while (0) 245 246#ifdef KERNEL 247 248/* 249 * Argument structure for sosetopt et seq. This is in the KERNEL 250 * section because it will never be visible to user code. 251 */ 252enum sopt_dir { SOPT_GET, SOPT_SET }; 253struct sockopt { 254 enum sopt_dir sopt_dir; /* is this a get or a set? */ 255 int sopt_level; /* second arg of [gs]etsockopt */ 256 int sopt_name; /* third arg of [gs]etsockopt */ 257 void *sopt_val; /* fourth arg of [gs]etsockopt */ 258 size_t sopt_valsize; /* (almost) fifth arg of [gs]etsockopt */ 259 struct proc *sopt_p; /* calling process or null if kernel */ 260}; 261 262struct sf_buf { 263 SLIST_ENTRY(sf_buf) free_list; /* list of free buffer slots */ 264 int refcnt; /* reference count */ 265 struct vm_page *m; /* currently mapped page */ 266 vm_offset_t kva; /* va of mapping */ 267}; 268 269#ifdef MALLOC_DECLARE 270MALLOC_DECLARE(M_PCB); 271MALLOC_DECLARE(M_SONAME); 272#endif 273 274extern int maxsockets; 275extern u_long sb_max; 276extern struct vm_zone *socket_zone; 277extern so_gen_t so_gencnt; 278 279struct file; 280struct filedesc; 281struct mbuf; 282struct sockaddr; 283struct stat; 284struct ucred; 285struct uio; 286 287/* 288 * File operations on sockets. 289 */ 290int soo_read __P((struct file *fp, struct uio *uio, struct ucred *cred, 291 int flags)); 292int soo_write __P((struct file *fp, struct uio *uio, struct ucred *cred, 293 int flags)); 294int soo_close __P((struct file *fp, struct proc *p)); 295int soo_ioctl __P((struct file *fp, u_long cmd, caddr_t data, 296 struct proc *p)); 297int soo_poll __P((struct file *fp, int events, struct ucred *cred, 298 struct proc *p)); 299int soo_stat __P((struct socket *so, struct stat *ub)); 300 301/* 302 * From uipc_socket and friends 303 */ 304struct sockaddr *dup_sockaddr __P((struct sockaddr *sa, int canwait)); 305int getsock __P((struct filedesc *fdp, int fdes, struct file **fpp)); 306int sockargs __P((struct mbuf **mp, caddr_t buf, int buflen, int type)); 307int getsockaddr __P((struct sockaddr **namp, caddr_t uaddr, size_t len)); 308void sbappend __P((struct sockbuf *sb, struct mbuf *m)); 309int sbappendaddr __P((struct sockbuf *sb, struct sockaddr *asa, 310 struct mbuf *m0, struct mbuf *control)); 311int sbappendcontrol __P((struct sockbuf *sb, struct mbuf *m0, 312 struct mbuf *control)); 313void sbappendrecord __P((struct sockbuf *sb, struct mbuf *m0)); 314void sbcheck __P((struct sockbuf *sb)); 315void sbcompress __P((struct sockbuf *sb, struct mbuf *m, struct mbuf *n)); 316struct mbuf * 317 sbcreatecontrol __P((caddr_t p, int size, int type, int level)); 318void sbdrop __P((struct sockbuf *sb, int len)); 319void sbdroprecord __P((struct sockbuf *sb)); 320void sbflush __P((struct sockbuf *sb)); 321void sbinsertoob __P((struct sockbuf *sb, struct mbuf *m0)); 322void sbrelease __P((struct sockbuf *sb)); 323int sbreserve __P((struct sockbuf *sb, u_long cc)); 324void sbtoxsockbuf __P((struct sockbuf *sb, struct xsockbuf *xsb)); 325int sbwait __P((struct sockbuf *sb)); 326int sb_lock __P((struct sockbuf *sb)); 327int soabort __P((struct socket *so)); 328int soaccept __P((struct socket *so, struct sockaddr **nam)); 329struct socket *soalloc __P((int waitok)); 330int sobind __P((struct socket *so, struct sockaddr *nam, struct proc *p)); 331void socantrcvmore __P((struct socket *so)); 332void socantsendmore __P((struct socket *so)); 333int soclose __P((struct socket *so)); 334int soconnect __P((struct socket *so, struct sockaddr *nam, struct proc *p)); 335int soconnect2 __P((struct socket *so1, struct socket *so2)); 336int socreate __P((int dom, struct socket **aso, int type, int proto, 337 struct proc *p)); 338void sodealloc __P((struct socket *so)); 339int sodisconnect __P((struct socket *so)); 340void sofree __P((struct socket *so)); 341int sogetopt __P((struct socket *so, struct sockopt *sopt)); 342void sohasoutofband __P((struct socket *so)); 343void soisconnected __P((struct socket *so)); 344void soisconnecting __P((struct socket *so)); 345void soisdisconnected __P((struct socket *so)); 346void soisdisconnecting __P((struct socket *so)); 347int solisten __P((struct socket *so, int backlog, struct proc *p)); 348struct socket * 349 sodropablereq __P((struct socket *head)); 350struct socket * 351 sonewconn __P((struct socket *head, int connstatus)); 352int sooptcopyin __P((struct sockopt *sopt, void *buf, size_t len, 353 size_t minlen)); 354int sooptcopyout __P((struct sockopt *sopt, void *buf, size_t len)); 355int sopoll __P((struct socket *so, int events, struct ucred *cred, 356 struct proc *p)); 357int soreceive __P((struct socket *so, struct sockaddr **paddr, 358 struct uio *uio, struct mbuf **mp0, 359 struct mbuf **controlp, int *flagsp)); 360int soreserve __P((struct socket *so, u_long sndcc, u_long rcvcc)); 361void sorflush __P((struct socket *so)); 362int sosend __P((struct socket *so, struct sockaddr *addr, struct uio *uio, 363 struct mbuf *top, struct mbuf *control, int flags, 364 struct proc *p)); 365int sosetopt __P((struct socket *so, struct sockopt *sopt)); 366int soshutdown __P((struct socket *so, int how)); 367void sotoxsocket __P((struct socket *so, struct xsocket *xso)); 368void sowakeup __P((struct socket *so, struct sockbuf *sb)); 369 370#endif /* KERNEL */ 371 372#endif /* !_SYS_SOCKETVAR_H_ */ 373