socketvar.h revision 55943
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 55943 2000-01-14 02:53:29Z jasone $ 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 TAILQ_HEAD(, aiocblist) so_aiojobq; /* AIO ops waiting on socket */ 84/* 85 * Variables for socket buffering. 86 */ 87 struct sockbuf { 88 u_long sb_cc; /* actual chars in buffer */ 89 u_long sb_hiwat; /* max actual char count */ 90 u_long sb_mbcnt; /* chars of mbufs used */ 91 u_long sb_mbmax; /* max chars of mbufs to use */ 92 long sb_lowat; /* low water mark */ 93 struct mbuf *sb_mb; /* the mbuf chain */ 94 struct selinfo sb_sel; /* process selecting read/write */ 95 short sb_flags; /* flags, see below */ 96 short sb_timeo; /* timeout for read/write */ 97 } so_rcv, so_snd; 98#define SB_MAX (256*1024) /* default for max chars in sockbuf */ 99#define SB_LOCK 0x01 /* lock on data queue */ 100#define SB_WANT 0x02 /* someone is waiting to lock */ 101#define SB_WAIT 0x04 /* someone is waiting for data/space */ 102#define SB_SEL 0x08 /* someone is selecting */ 103#define SB_ASYNC 0x10 /* ASYNC I/O, need signals */ 104#define SB_UPCALL 0x20 /* someone wants an upcall */ 105#define SB_NOINTR 0x40 /* operations not interruptible */ 106#define SB_AIO 0x80 /* AIO operations queued */ 107 108 void (*so_upcall) __P((struct socket *, void *, int)); 109 void *so_upcallarg; 110 struct ucred *so_cred; /* user credentials */ 111 /* NB: generation count must not be first; easiest to make it last. */ 112 so_gen_t so_gencnt; /* generation count */ 113 void *so_emuldata; /* private data for emulators */ 114}; 115 116/* 117 * Socket state bits. 118 */ 119#define SS_NOFDREF 0x0001 /* no file table ref any more */ 120#define SS_ISCONNECTED 0x0002 /* socket connected to a peer */ 121#define SS_ISCONNECTING 0x0004 /* in process of connecting to peer */ 122#define SS_ISDISCONNECTING 0x0008 /* in process of disconnecting */ 123#define SS_CANTSENDMORE 0x0010 /* can't send more data to peer */ 124#define SS_CANTRCVMORE 0x0020 /* can't receive more data from peer */ 125#define SS_RCVATMARK 0x0040 /* at mark on input */ 126 127#define SS_NBIO 0x0100 /* non-blocking ops */ 128#define SS_ASYNC 0x0200 /* async i/o notify */ 129#define SS_ISCONFIRMING 0x0400 /* deciding to accept connection req */ 130 131#define SS_INCOMP 0x0800 /* unaccepted, incomplete connection */ 132#define SS_COMP 0x1000 /* unaccepted, complete connection */ 133#define SS_ISDISCONNECTED 0x2000 /* socket disconnected from peer */ 134 135/* 136 * Externalized form of struct socket used by the sysctl(3) interface. 137 */ 138struct xsocket { 139 size_t xso_len; /* length of this structure */ 140 struct socket *xso_so; /* makes a convenient handle sometimes */ 141 short so_type; 142 short so_options; 143 short so_linger; 144 short so_state; 145 caddr_t so_pcb; /* another convenient handle */ 146 int xso_protocol; 147 int xso_family; 148 short so_qlen; 149 short so_incqlen; 150 short so_qlimit; 151 short so_timeo; 152 u_short so_error; 153 pid_t so_pgid; 154 u_long so_oobmark; 155 struct xsockbuf { 156 u_long sb_cc; 157 u_long sb_hiwat; 158 u_long sb_mbcnt; 159 u_long sb_mbmax; 160 long sb_lowat; 161 short sb_flags; 162 short sb_timeo; 163 } so_rcv, so_snd; 164 uid_t so_uid; /* XXX */ 165}; 166 167/* 168 * Macros for sockets and socket buffering. 169 */ 170 171/* 172 * Do we need to notify the other side when I/O is possible? 173 */ 174#define sb_notify(sb) (((sb)->sb_flags & (SB_WAIT | SB_SEL | SB_ASYNC | \ 175 SB_UPCALL | SB_AIO)) != 0) 176 177/* 178 * How much space is there in a socket buffer (so->so_snd or so->so_rcv)? 179 * This is problematical if the fields are unsigned, as the space might 180 * still be negative (cc > hiwat or mbcnt > mbmax). Should detect 181 * overflow and return 0. Should use "lmin" but it doesn't exist now. 182 */ 183#define sbspace(sb) \ 184 ((long) imin((int)((sb)->sb_hiwat - (sb)->sb_cc), \ 185 (int)((sb)->sb_mbmax - (sb)->sb_mbcnt))) 186 187/* do we have to send all at once on a socket? */ 188#define sosendallatonce(so) \ 189 ((so)->so_proto->pr_flags & PR_ATOMIC) 190 191/* can we read something from so? */ 192#define soreadable(so) \ 193 ((so)->so_rcv.sb_cc >= (so)->so_rcv.sb_lowat || \ 194 ((so)->so_state & SS_CANTRCVMORE) || \ 195 (so)->so_comp.tqh_first || (so)->so_error) 196 197/* can we write something to so? */ 198#define sowriteable(so) \ 199 ((sbspace(&(so)->so_snd) >= (so)->so_snd.sb_lowat && \ 200 (((so)->so_state&SS_ISCONNECTED) || \ 201 ((so)->so_proto->pr_flags&PR_CONNREQUIRED)==0)) || \ 202 ((so)->so_state & SS_CANTSENDMORE) || \ 203 (so)->so_error) 204 205/* adjust counters in sb reflecting allocation of m */ 206#define sballoc(sb, m) { \ 207 (sb)->sb_cc += (m)->m_len; \ 208 (sb)->sb_mbcnt += MSIZE; \ 209 if ((m)->m_flags & M_EXT) \ 210 (sb)->sb_mbcnt += (m)->m_ext.ext_size; \ 211} 212 213/* adjust counters in sb reflecting freeing of m */ 214#define sbfree(sb, m) { \ 215 (sb)->sb_cc -= (m)->m_len; \ 216 (sb)->sb_mbcnt -= MSIZE; \ 217 if ((m)->m_flags & M_EXT) \ 218 (sb)->sb_mbcnt -= (m)->m_ext.ext_size; \ 219} 220 221/* 222 * Set lock on sockbuf sb; sleep if lock is already held. 223 * Unless SB_NOINTR is set on sockbuf, sleep is interruptible. 224 * Returns error without lock if sleep is interrupted. 225 */ 226#define sblock(sb, wf) ((sb)->sb_flags & SB_LOCK ? \ 227 (((wf) == M_WAITOK) ? sb_lock(sb) : EWOULDBLOCK) : \ 228 ((sb)->sb_flags |= SB_LOCK), 0) 229 230/* release lock on sockbuf sb */ 231#define sbunlock(sb) { \ 232 (sb)->sb_flags &= ~SB_LOCK; \ 233 if ((sb)->sb_flags & SB_WANT) { \ 234 (sb)->sb_flags &= ~SB_WANT; \ 235 wakeup((caddr_t)&(sb)->sb_flags); \ 236 } \ 237} 238 239#define sorwakeup(so) do { \ 240 if (sb_notify(&(so)->so_rcv)) \ 241 sowakeup((so), &(so)->so_rcv); \ 242 } while (0) 243 244#define sowwakeup(so) do { \ 245 if (sb_notify(&(so)->so_snd)) \ 246 sowakeup((so), &(so)->so_snd); \ 247 } while (0) 248 249#ifdef _KERNEL 250 251/* 252 * Argument structure for sosetopt et seq. This is in the KERNEL 253 * section because it will never be visible to user code. 254 */ 255enum sopt_dir { SOPT_GET, SOPT_SET }; 256struct sockopt { 257 enum sopt_dir sopt_dir; /* is this a get or a set? */ 258 int sopt_level; /* second arg of [gs]etsockopt */ 259 int sopt_name; /* third arg of [gs]etsockopt */ 260 void *sopt_val; /* fourth arg of [gs]etsockopt */ 261 size_t sopt_valsize; /* (almost) fifth arg of [gs]etsockopt */ 262 struct proc *sopt_p; /* calling process or null if kernel */ 263}; 264 265struct sf_buf { 266 SLIST_ENTRY(sf_buf) free_list; /* list of free buffer slots */ 267 int refcnt; /* reference count */ 268 struct vm_page *m; /* currently mapped page */ 269 vm_offset_t kva; /* va of mapping */ 270}; 271 272#ifdef MALLOC_DECLARE 273MALLOC_DECLARE(M_PCB); 274MALLOC_DECLARE(M_SONAME); 275#endif 276 277extern int maxsockets; 278extern u_long sb_max; 279extern struct vm_zone *socket_zone; 280extern so_gen_t so_gencnt; 281 282struct file; 283struct filedesc; 284struct mbuf; 285struct sockaddr; 286struct stat; 287struct ucred; 288struct uio; 289 290/* 291 * File operations on sockets. 292 */ 293int soo_read __P((struct file *fp, struct uio *uio, struct ucred *cred, 294 int flags, struct proc *p)); 295int soo_write __P((struct file *fp, struct uio *uio, struct ucred *cred, 296 int flags, struct proc *p)); 297int soo_close __P((struct file *fp, struct proc *p)); 298int soo_ioctl __P((struct file *fp, u_long cmd, caddr_t data, 299 struct proc *p)); 300int soo_poll __P((struct file *fp, int events, struct ucred *cred, 301 struct proc *p)); 302int soo_stat __P((struct file *fp, struct stat *ub, struct proc *p)); 303 304/* 305 * From uipc_socket and friends 306 */ 307struct sockaddr *dup_sockaddr __P((struct sockaddr *sa, int canwait)); 308int getsock __P((struct filedesc *fdp, int fdes, struct file **fpp)); 309int sockargs __P((struct mbuf **mp, caddr_t buf, int buflen, int type)); 310int getsockaddr __P((struct sockaddr **namp, caddr_t uaddr, size_t len)); 311void sbappend __P((struct sockbuf *sb, struct mbuf *m)); 312int sbappendaddr __P((struct sockbuf *sb, struct sockaddr *asa, 313 struct mbuf *m0, struct mbuf *control)); 314int sbappendcontrol __P((struct sockbuf *sb, struct mbuf *m0, 315 struct mbuf *control)); 316void sbappendrecord __P((struct sockbuf *sb, struct mbuf *m0)); 317void sbcheck __P((struct sockbuf *sb)); 318void sbcompress __P((struct sockbuf *sb, struct mbuf *m, struct mbuf *n)); 319struct mbuf * 320 sbcreatecontrol __P((caddr_t p, int size, int type, int level)); 321void sbdrop __P((struct sockbuf *sb, int len)); 322void sbdroprecord __P((struct sockbuf *sb)); 323void sbflush __P((struct sockbuf *sb)); 324void sbinsertoob __P((struct sockbuf *sb, struct mbuf *m0)); 325void sbrelease __P((struct sockbuf *sb, struct socket *so)); 326int sbreserve __P((struct sockbuf *sb, u_long cc, struct socket *so, 327 struct proc *p)); 328void sbtoxsockbuf __P((struct sockbuf *sb, struct xsockbuf *xsb)); 329int sbwait __P((struct sockbuf *sb)); 330int sb_lock __P((struct sockbuf *sb)); 331int soabort __P((struct socket *so)); 332int soaccept __P((struct socket *so, struct sockaddr **nam)); 333struct socket *soalloc __P((int waitok)); 334int sobind __P((struct socket *so, struct sockaddr *nam, struct proc *p)); 335void socantrcvmore __P((struct socket *so)); 336void socantsendmore __P((struct socket *so)); 337int soclose __P((struct socket *so)); 338int soconnect __P((struct socket *so, struct sockaddr *nam, struct proc *p)); 339int soconnect2 __P((struct socket *so1, struct socket *so2)); 340int socreate __P((int dom, struct socket **aso, int type, int proto, 341 struct proc *p)); 342void sodealloc __P((struct socket *so)); 343int sodisconnect __P((struct socket *so)); 344void sofree __P((struct socket *so)); 345int sogetopt __P((struct socket *so, struct sockopt *sopt)); 346void sohasoutofband __P((struct socket *so)); 347void soisconnected __P((struct socket *so)); 348void soisconnecting __P((struct socket *so)); 349void soisdisconnected __P((struct socket *so)); 350void soisdisconnecting __P((struct socket *so)); 351int solisten __P((struct socket *so, int backlog, struct proc *p)); 352struct socket * 353 sodropablereq __P((struct socket *head)); 354struct socket * 355 sonewconn __P((struct socket *head, int connstatus)); 356struct socket * 357 sonewconn3 __P((struct socket *head, int connstatus, struct proc *p)); 358int sooptcopyin __P((struct sockopt *sopt, void *buf, size_t len, 359 size_t minlen)); 360int sooptcopyout __P((struct sockopt *sopt, void *buf, size_t len)); 361 362/* XXX; prepare mbuf for (__FreeBSD__ < 3) routines. */ 363int soopt_getm __P((struct sockopt *sopt, struct mbuf **mp)); 364int soopt_mcopyin __P((struct sockopt *sopt, struct mbuf *m)); 365int soopt_mcopyout __P((struct sockopt *sopt, struct mbuf *m)); 366 367int sopoll __P((struct socket *so, int events, struct ucred *cred, 368 struct proc *p)); 369int soreceive __P((struct socket *so, struct sockaddr **paddr, 370 struct uio *uio, struct mbuf **mp0, 371 struct mbuf **controlp, int *flagsp)); 372int soreserve __P((struct socket *so, u_long sndcc, u_long rcvcc)); 373void sorflush __P((struct socket *so)); 374int sosend __P((struct socket *so, struct sockaddr *addr, struct uio *uio, 375 struct mbuf *top, struct mbuf *control, int flags, 376 struct proc *p)); 377int sosetopt __P((struct socket *so, struct sockopt *sopt)); 378int soshutdown __P((struct socket *so, int how)); 379void sotoxsocket __P((struct socket *so, struct xsocket *xso)); 380void sowakeup __P((struct socket *so, struct sockbuf *sb)); 381 382#endif /* _KERNEL */ 383 384#endif /* !_SYS_SOCKETVAR_H_ */ 385