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