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