socketvar.h revision 106313
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 106313 2002-11-01 21:27:59Z kbyanc $ 35 */ 36 37#ifndef _SYS_SOCKETVAR_H_ 38#define _SYS_SOCKETVAR_H_ 39 40#include <sys/_label.h> /* for struct label */ 41#include <sys/queue.h> /* for TAILQ macros */ 42#include <sys/selinfo.h> /* for struct selinfo */ 43 44/* 45 * Kernel structure per socket. 46 * Contains send and receive buffer queues, 47 * handle on protocol and pointer to protocol 48 * private data and error information. 49 */ 50typedef u_quad_t so_gen_t; 51 52/* 53 * List of locks: 54 * (c) const, inited in either socreate() or sonewconn() 55 * (m) sb_mtx mutex 56 * (mr) so_rcv.sb_mtx mutex 57 * (sg) sigio_lock sx 58 * (sh) sohead_lock sx 59 * 60 * Lock of so_rcv.sb_mtx can duplicate, provided that sohead_lock 61 * is exclusively locked. 62 * 63 * Brackets mean that this data is not protected yet. 64 */ 65struct socket { 66 int so_count; /* reference count */ 67 short so_type; /* generic type, see socket.h */ 68 short so_options; /* from socket call, see socket.h */ 69 short so_linger; /* time to linger while closing */ 70 short so_state; /* internal state flags SS_*, below */ 71 void *so_pcb; /* protocol control block */ 72 struct protosw *so_proto; /* protocol handle */ 73/* 74 * Variables for connection queuing. 75 * Socket where accepts occur is so_head in all subsidiary sockets. 76 * If so_head is 0, socket is not related to an accept. 77 * For head socket so_incomp queues partially completed connections, 78 * while so_comp is a queue of connections ready to be accepted. 79 * If a connection is aborted and it has so_head set, then 80 * it has to be pulled out of either so_incomp or so_comp. 81 * We allow connections to queue up based on current queue lengths 82 * and limit on number of queued connections for this socket. 83 */ 84 struct socket *so_head; /* back pointer to accept socket */ 85 TAILQ_HEAD(, socket) so_incomp; /* queue of partial unaccepted connections */ 86 TAILQ_HEAD(, socket) so_comp; /* queue of complete unaccepted connections */ 87 TAILQ_ENTRY(socket) so_list; /* list of unaccepted connections */ 88 short so_qlen; /* number of unaccepted connections */ 89 short so_incqlen; /* number of unaccepted incomplete 90 connections */ 91 short so_qlimit; /* max number queued connections */ 92 short so_timeo; /* connection timeout */ 93 u_short so_error; /* error affecting connection */ 94 struct sigio *so_sigio; /* [sg] information for async I/O or 95 out of band data (SIGURG) */ 96 u_long so_oobmark; /* chars to oob mark */ 97 TAILQ_HEAD(, aiocblist) so_aiojobq; /* AIO ops waiting on socket */ 98/* 99 * Variables for socket buffering. 100 */ 101 struct sockbuf { 102 struct selinfo sb_sel; /* process selecting read/write */ 103 struct mbuf *sb_mb; /* the mbuf chain */ 104 u_int sb_cc; /* actual chars in buffer */ 105 u_int sb_hiwat; /* max actual char count */ 106 u_int sb_mbcnt; /* chars of mbufs used */ 107 u_int sb_mbmax; /* max chars of mbufs to use */ 108 u_int sb_ctl; /* non-data chars in buffer */ 109 int sb_lowat; /* low water mark */ 110 int sb_timeo; /* timeout for read/write */ 111 short sb_flags; /* flags, see below */ 112 } so_rcv, so_snd; 113#define SB_MAX (256*1024) /* default for max chars in sockbuf */ 114#define SB_LOCK 0x01 /* lock on data queue */ 115#define SB_WANT 0x02 /* someone is waiting to lock */ 116#define SB_WAIT 0x04 /* someone is waiting for data/space */ 117#define SB_SEL 0x08 /* someone is selecting */ 118#define SB_ASYNC 0x10 /* ASYNC I/O, need signals */ 119#define SB_UPCALL 0x20 /* someone wants an upcall */ 120#define SB_NOINTR 0x40 /* operations not interruptible */ 121#define SB_AIO 0x80 /* AIO operations queued */ 122#define SB_KNOTE 0x100 /* kernel note attached */ 123 124 void (*so_upcall)(struct socket *, void *, int); 125 void *so_upcallarg; 126 struct ucred *so_cred; /* user credentials */ 127 struct label so_label; /* MAC label for socket */ 128 struct label so_peerlabel; /* cached MAC label for socket peer */ 129 /* NB: generation count must not be first; easiest to make it last. */ 130 so_gen_t so_gencnt; /* generation count */ 131 void *so_emuldata; /* private data for emulators */ 132 struct so_accf { 133 struct accept_filter *so_accept_filter; 134 void *so_accept_filter_arg; /* saved filter args */ 135 char *so_accept_filter_str; /* saved user args */ 136 } *so_accf; 137}; 138 139/* 140 * Socket state bits. 141 */ 142#define SS_NOFDREF 0x0001 /* no file table ref any more */ 143#define SS_ISCONNECTED 0x0002 /* socket connected to a peer */ 144#define SS_ISCONNECTING 0x0004 /* in process of connecting to peer */ 145#define SS_ISDISCONNECTING 0x0008 /* in process of disconnecting */ 146#define SS_CANTSENDMORE 0x0010 /* can't send more data to peer */ 147#define SS_CANTRCVMORE 0x0020 /* can't receive more data from peer */ 148#define SS_RCVATMARK 0x0040 /* at mark on input */ 149 150#define SS_NBIO 0x0100 /* non-blocking ops */ 151#define SS_ASYNC 0x0200 /* async i/o notify */ 152#define SS_ISCONFIRMING 0x0400 /* deciding to accept connection req */ 153 154#define SS_INCOMP 0x0800 /* unaccepted, incomplete connection */ 155#define SS_COMP 0x1000 /* unaccepted, complete connection */ 156#define SS_ISDISCONNECTED 0x2000 /* socket disconnected from peer */ 157 158/* 159 * Externalized form of struct socket used by the sysctl(3) interface. 160 */ 161struct xsocket { 162 size_t xso_len; /* length of this structure */ 163 struct socket *xso_so; /* makes a convenient handle sometimes */ 164 short so_type; 165 short so_options; 166 short so_linger; 167 short so_state; 168 caddr_t so_pcb; /* another convenient handle */ 169 int xso_protocol; 170 int xso_family; 171 short so_qlen; 172 short so_incqlen; 173 short so_qlimit; 174 short so_timeo; 175 u_short so_error; 176 pid_t so_pgid; 177 u_long so_oobmark; 178 struct xsockbuf { 179 u_int sb_cc; 180 u_int sb_hiwat; 181 u_int sb_mbcnt; 182 u_int sb_mbmax; 183 int sb_lowat; 184 int sb_timeo; 185 short sb_flags; 186 } so_rcv, so_snd; 187 uid_t so_uid; /* XXX */ 188}; 189 190/* 191 * Macros for sockets and socket buffering. 192 */ 193 194/* 195 * Do we need to notify the other side when I/O is possible? 196 */ 197#define sb_notify(sb) (((sb)->sb_flags & (SB_WAIT | SB_SEL | SB_ASYNC | \ 198 SB_UPCALL | SB_AIO | SB_KNOTE)) != 0) 199 200/* 201 * How much space is there in a socket buffer (so->so_snd or so->so_rcv)? 202 * This is problematical if the fields are unsigned, as the space might 203 * still be negative (cc > hiwat or mbcnt > mbmax). Should detect 204 * overflow and return 0. Should use "lmin" but it doesn't exist now. 205 */ 206#define sbspace(sb) \ 207 ((long) imin((int)((sb)->sb_hiwat - (sb)->sb_cc), \ 208 (int)((sb)->sb_mbmax - (sb)->sb_mbcnt))) 209 210/* do we have to send all at once on a socket? */ 211#define sosendallatonce(so) \ 212 ((so)->so_proto->pr_flags & PR_ATOMIC) 213 214/* can we read something from so? */ 215#define soreadable(so) \ 216 ((so)->so_rcv.sb_cc >= (so)->so_rcv.sb_lowat || \ 217 ((so)->so_state & SS_CANTRCVMORE) || \ 218 !TAILQ_EMPTY(&(so)->so_comp) || (so)->so_error) 219 220/* can we write something to so? */ 221#define sowriteable(so) \ 222 ((sbspace(&(so)->so_snd) >= (so)->so_snd.sb_lowat && \ 223 (((so)->so_state&SS_ISCONNECTED) || \ 224 ((so)->so_proto->pr_flags&PR_CONNREQUIRED)==0)) || \ 225 ((so)->so_state & SS_CANTSENDMORE) || \ 226 (so)->so_error) 227 228/* adjust counters in sb reflecting allocation of m */ 229#define sballoc(sb, m) { \ 230 (sb)->sb_cc += (m)->m_len; \ 231 if ((m)->m_type != MT_DATA) \ 232 (sb)->sb_ctl += (m)->m_len; \ 233 (sb)->sb_mbcnt += MSIZE; \ 234 if ((m)->m_flags & M_EXT) \ 235 (sb)->sb_mbcnt += (m)->m_ext.ext_size; \ 236} 237 238/* adjust counters in sb reflecting freeing of m */ 239#define sbfree(sb, m) { \ 240 (sb)->sb_cc -= (m)->m_len; \ 241 if ((m)->m_type != MT_DATA) \ 242 (sb)->sb_ctl -= (m)->m_len; \ 243 (sb)->sb_mbcnt -= MSIZE; \ 244 if ((m)->m_flags & M_EXT) \ 245 (sb)->sb_mbcnt -= (m)->m_ext.ext_size; \ 246} 247 248/* 249 * Set lock on sockbuf sb; sleep if lock is already held. 250 * Unless SB_NOINTR is set on sockbuf, sleep is interruptible. 251 * Returns error without lock if sleep is interrupted. 252 */ 253#define sblock(sb, wf) ((sb)->sb_flags & SB_LOCK ? \ 254 (((wf) == M_WAITOK) ? sb_lock(sb) : EWOULDBLOCK) : \ 255 ((sb)->sb_flags |= SB_LOCK), 0) 256 257/* release lock on sockbuf sb */ 258#define sbunlock(sb) { \ 259 (sb)->sb_flags &= ~SB_LOCK; \ 260 if ((sb)->sb_flags & SB_WANT) { \ 261 (sb)->sb_flags &= ~SB_WANT; \ 262 wakeup((caddr_t)&(sb)->sb_flags); \ 263 } \ 264} 265 266/* 267 * soref()/sorele() ref-count the socket structure. Note that you must 268 * still explicitly close the socket, but the last ref count will free 269 * the structure. 270 */ 271#define soref(so) do { \ 272 ++(so)->so_count; \ 273 } while (0) 274 275#define sorele(so) do { \ 276 if ((so)->so_count <= 0) \ 277 panic("sorele");\ 278 if (--(so)->so_count == 0)\ 279 sofree(so); \ 280 } while (0) 281 282#define sotryfree(so) do { \ 283 if ((so)->so_count == 0) \ 284 sofree(so); \ 285 } while(0) 286 287#define sorwakeup(so) do { \ 288 if (sb_notify(&(so)->so_rcv)) \ 289 sowakeup((so), &(so)->so_rcv); \ 290 } while (0) 291 292#define sowwakeup(so) do { \ 293 if (sb_notify(&(so)->so_snd)) \ 294 sowakeup((so), &(so)->so_snd); \ 295 } while (0) 296 297#ifdef _KERNEL 298 299/* 300 * Argument structure for sosetopt et seq. This is in the KERNEL 301 * section because it will never be visible to user code. 302 */ 303enum sopt_dir { SOPT_GET, SOPT_SET }; 304struct sockopt { 305 enum sopt_dir sopt_dir; /* is this a get or a set? */ 306 int sopt_level; /* second arg of [gs]etsockopt */ 307 int sopt_name; /* third arg of [gs]etsockopt */ 308 void *sopt_val; /* fourth arg of [gs]etsockopt */ 309 size_t sopt_valsize; /* (almost) fifth arg of [gs]etsockopt */ 310 struct thread *sopt_td; /* calling thread or null if kernel */ 311}; 312 313struct sf_buf { 314 SLIST_ENTRY(sf_buf) free_list; /* list of free buffer slots */ 315 struct vm_page *m; /* currently mapped page */ 316 vm_offset_t kva; /* va of mapping */ 317}; 318 319struct accept_filter { 320 char accf_name[16]; 321 void (*accf_callback) 322 (struct socket *so, void *arg, int waitflag); 323 void * (*accf_create) 324 (struct socket *so, char *arg); 325 void (*accf_destroy) 326 (struct socket *so); 327 SLIST_ENTRY(accept_filter) accf_next; 328}; 329 330#ifdef MALLOC_DECLARE 331MALLOC_DECLARE(M_ACCF); 332MALLOC_DECLARE(M_PCB); 333MALLOC_DECLARE(M_SONAME); 334#endif 335 336extern int maxsockets; 337extern u_long sb_max; 338extern struct uma_zone *socket_zone; 339extern so_gen_t so_gencnt; 340 341struct file; 342struct filedesc; 343struct knote; 344struct mbuf; 345struct sockaddr; 346struct stat; 347struct ucred; 348struct uio; 349 350/* 351 * File operations on sockets. 352 */ 353int soo_read(struct file *fp, struct uio *uio, struct ucred *active_cred, 354 int flags, struct thread *td); 355int soo_write(struct file *fp, struct uio *uio, 356 struct ucred *active_cred, int flags, struct thread *td); 357int soo_close(struct file *fp, struct thread *td); 358int soo_ioctl(struct file *fp, u_long cmd, void *data, 359 struct ucred *active_cred, struct thread *td); 360int soo_poll(struct file *fp, int events, struct ucred *active_cred, 361 struct thread *td); 362int soo_stat(struct file *fp, struct stat *ub, struct ucred *active_cred, 363 struct thread *td); 364int sokqfilter(struct file *fp, struct knote *kn); 365 366/* 367 * From uipc_socket and friends 368 */ 369struct sockaddr *dup_sockaddr(struct sockaddr *sa, int canwait); 370int sockargs(struct mbuf **mp, caddr_t buf, int buflen, int type); 371int getsockaddr(struct sockaddr **namp, caddr_t uaddr, size_t len); 372void sbappend(struct sockbuf *sb, struct mbuf *m); 373int sbappendaddr(struct sockbuf *sb, struct sockaddr *asa, 374 struct mbuf *m0, struct mbuf *control); 375int sbappendcontrol(struct sockbuf *sb, struct mbuf *m0, 376 struct mbuf *control); 377void sbappendrecord(struct sockbuf *sb, struct mbuf *m0); 378void sbcheck(struct sockbuf *sb); 379void sbcompress(struct sockbuf *sb, struct mbuf *m, struct mbuf *n); 380struct mbuf * 381 sbcreatecontrol(caddr_t p, int size, int type, int level); 382void sbdrop(struct sockbuf *sb, int len); 383void sbdroprecord(struct sockbuf *sb); 384void sbflush(struct sockbuf *sb); 385void sbinsertoob(struct sockbuf *sb, struct mbuf *m0); 386void sbrelease(struct sockbuf *sb, struct socket *so); 387int sbreserve(struct sockbuf *sb, u_long cc, struct socket *so, 388 struct thread *td); 389void sbtoxsockbuf(struct sockbuf *sb, struct xsockbuf *xsb); 390int sbwait(struct sockbuf *sb); 391struct sf_buf * 392 sf_buf_alloc(void); 393void sf_buf_free(void *addr, void *args); 394int sb_lock(struct sockbuf *sb); 395int soabort(struct socket *so); 396int soaccept(struct socket *so, struct sockaddr **nam); 397int socheckuid(struct socket *so, uid_t uid); 398struct socket *soalloc(int waitok); 399int sobind(struct socket *so, struct sockaddr *nam, struct thread *td); 400void socantrcvmore(struct socket *so); 401void socantsendmore(struct socket *so); 402int soclose(struct socket *so); 403int soconnect(struct socket *so, struct sockaddr *nam, struct thread *td); 404int soconnect2(struct socket *so1, struct socket *so2); 405int socow_setup(struct mbuf *m0, struct uio *uio); 406int socreate(int dom, struct socket **aso, int type, int proto, 407 struct ucred *cred, struct thread *td); 408int sodisconnect(struct socket *so); 409void sofree(struct socket *so); 410int sogetopt(struct socket *so, struct sockopt *sopt); 411void sohasoutofband(struct socket *so); 412void soisconnected(struct socket *so); 413void soisconnecting(struct socket *so); 414void soisdisconnected(struct socket *so); 415void soisdisconnecting(struct socket *so); 416int solisten(struct socket *so, int backlog, struct thread *td); 417struct socket * 418 sonewconn(struct socket *head, int connstatus); 419int sooptcopyin(struct sockopt *sopt, void *buf, size_t len, size_t minlen); 420int sooptcopyout(struct sockopt *sopt, void *buf, size_t len); 421 422/* XXX; prepare mbuf for (__FreeBSD__ < 3) routines. */ 423int soopt_getm(struct sockopt *sopt, struct mbuf **mp); 424int soopt_mcopyin(struct sockopt *sopt, struct mbuf *m); 425int soopt_mcopyout(struct sockopt *sopt, struct mbuf *m); 426 427int sopoll(struct socket *so, int events, struct ucred *active_cred, 428 struct thread *td); 429int soreceive(struct socket *so, struct sockaddr **paddr, struct uio *uio, 430 struct mbuf **mp0, struct mbuf **controlp, int *flagsp); 431int soreserve(struct socket *so, u_long sndcc, u_long rcvcc); 432void sorflush(struct socket *so); 433int sosend(struct socket *so, struct sockaddr *addr, struct uio *uio, 434 struct mbuf *top, struct mbuf *control, int flags, 435 struct thread *td); 436int sosetopt(struct socket *so, struct sockopt *sopt); 437int soshutdown(struct socket *so, int how); 438void sotoxsocket(struct socket *so, struct xsocket *xso); 439void sowakeup(struct socket *so, struct sockbuf *sb); 440 441/* 442 * Accept filter functions (duh). 443 */ 444int accept_filt_add(struct accept_filter *filt); 445int accept_filt_del(char *name); 446struct accept_filter *accept_filt_get(char *name); 447#ifdef ACCEPT_FILTER_MOD 448#ifdef SYSCTL_DECL 449SYSCTL_DECL(_net_inet_accf); 450#endif 451int accept_filt_generic_mod_event(module_t mod, int event, void *data); 452#endif 453 454#endif /* _KERNEL */ 455 456#endif /* !_SYS_SOCKETVAR_H_ */ 457