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.35 2008/08/28 23:15:45 dillon Exp $ 36 */ 37 38 #ifndef _SYS_SOCKETVAR_H_ 39 #define _SYS_SOCKETVAR_H_ 40 41 #ifndef _SYS_TYPES_H_ 42 #include <sys/types.h> 43 #endif 44 #ifndef _SYS_QUEUE_H_ 45 #include <sys/queue.h> /* for TAILQ macros */ 46 #endif 47 #ifndef _SYS_SELINFO_H_ 48 #include <sys/selinfo.h> /* for struct selinfo */ 49 #endif 50 #ifndef _SYS_SOCKBUF_H_ 51 #include <sys/sockbuf.h> 52 #endif 53 54 #if defined(_KERNEL) || defined(_KERNEL_STRUCTURES) 55 56 struct accept_filter; 57 58 /* 59 * Signaling socket buffers contain additional elements for locking 60 * and signaling conditions. These are used primarily by sockets. 61 */ 62 struct signalsockbuf { 63 struct sockbuf sb; 64 struct selinfo ssb_sel; /* process selecting read/write */ 65 short ssb_flags; /* flags, see below */ 66 short ssb_timeo; /* timeout for read/write */ 67 long ssb_lowat; /* low water mark */ 68 u_long ssb_hiwat; /* high water mark / max actual char count */ 69 u_long ssb_mbmax; /* max chars of mbufs to use */ 70 }; 71 72 #define ssb_cc sb.sb_cc /* commonly used fields */ 73 #define ssb_mb sb.sb_mb /* commonly used fields */ 74 #define ssb_mbcnt sb.sb_mbcnt /* commonly used fields */ 75 76 #define SSB_LOCK 0x01 /* lock on data queue */ 77 #define SSB_WANT 0x02 /* someone is waiting to lock */ 78 #define SSB_WAIT 0x04 /* someone is waiting for data/space */ 79 #define SSB_SEL 0x08 /* someone is selecting */ 80 #define SSB_ASYNC 0x10 /* ASYNC I/O, need signals */ 81 #define SSB_UPCALL 0x20 /* someone wants an upcall */ 82 #define SSB_NOINTR 0x40 /* operations not interruptible */ 83 #define SSB_AIO 0x80 /* AIO operations queued */ 84 #define SSB_KNOTE 0x100 /* kernel note attached */ 85 #define SSB_MEVENT 0x200 /* need message event notification */ 86 #define SSB_STOP 0x400 /* backpressure indicator */ 87 #define SSB_AUTOSIZE 0x800 /* automatically size socket buffer */ 88 #define SSB_AUTOLOWAT 0x1000 /* automatically scale lowat */ 89 90 /* 91 * Per-socket kernel structure. Contains universal send and receive queues, 92 * protocol control handle, and error information. 93 */ 94 struct socket { 95 short so_type; /* generic type, see socket.h */ 96 short so_options; /* from socket call, see socket.h */ 97 short so_linger; /* time to linger while closing */ 98 short so_state; /* internal state flags SS_*, below */ 99 void *so_pcb; /* protocol control block */ 100 struct protosw *so_proto; /* protocol handle */ 101 struct socket *so_head; /* back pointer to accept socket */ 102 lwkt_port_t so_port; /* message port */ 103 104 /* 105 * These fields are used to manage sockets capable of accepting 106 * new connections. 107 */ 108 TAILQ_HEAD(, socket) so_incomp; /* in-progress, incomplete */ 109 TAILQ_HEAD(, socket) so_comp; /* completed but not yet accepted */ 110 TAILQ_ENTRY(socket) so_list; /* list of unaccepted connections */ 111 short so_qlen; /* so_comp count */ 112 short so_incqlen; /* so_incomp count */ 113 short so_qlimit; /* max number queued connections */ 114 115 /* 116 * Misc socket support 117 */ 118 short so_timeo; /* connection timeout */ 119 u_short so_error; /* error affecting connection */ 120 struct sigio *so_sigio; /* information for async I/O or 121 out of band data (SIGURG) */ 122 u_long so_oobmark; /* chars to oob mark */ 123 TAILQ_HEAD(, aiocblist) so_aiojobq; /* AIO ops waiting on socket */ 124 struct signalsockbuf so_rcv; 125 struct signalsockbuf so_snd; 126 127 void (*so_upcall) (struct socket *, void *, int); 128 void *so_upcallarg; 129 struct ucred *so_cred; /* user credentials */ 130 /* NB: generation count must not be first; easiest to make it last. */ 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 #endif 140 141 /* 142 * Socket state bits. 143 */ 144 #define SS_NOFDREF 0x0001 /* no file table ref any more */ 145 #define SS_ISCONNECTED 0x0002 /* socket connected to a peer */ 146 #define SS_ISCONNECTING 0x0004 /* in process of connecting to peer */ 147 #define SS_ISDISCONNECTING 0x0008 /* in process of disconnecting */ 148 #define SS_CANTSENDMORE 0x0010 /* can't send more data to peer */ 149 #define SS_CANTRCVMORE 0x0020 /* can't receive more data from peer */ 150 #define SS_RCVATMARK 0x0040 /* at mark on input */ 151 152 #define SS_ABORTING 0x0100 /* so_abort() in progress */ 153 #define SS_ASYNC 0x0200 /* async i/o notify */ 154 #define SS_ISCONFIRMING 0x0400 /* deciding to accept connection req */ 155 156 #define SS_INCOMP 0x0800 /* unaccepted, incomplete connection */ 157 #define SS_COMP 0x1000 /* unaccepted, complete connection */ 158 #define SS_ISDISCONNECTED 0x2000 /* socket disconnected from peer */ 159 160 /* 161 * Externalized form of struct socket used by the sysctl(3) interface. 162 */ 163 struct xsocket { 164 size_t xso_len; /* length of this structure */ 165 struct socket *xso_so; /* makes a convenient handle sometimes */ 166 short so_type; 167 short so_options; 168 short so_linger; 169 short so_state; 170 void *so_pcb; /* another convenient handle */ 171 int xso_protocol; 172 int xso_family; 173 short so_qlen; 174 short so_incqlen; 175 short so_qlimit; 176 short so_timeo; 177 u_short so_error; 178 pid_t so_pgid; 179 u_long so_oobmark; 180 struct xsockbuf { 181 u_long sb_cc; 182 u_long sb_hiwat; 183 u_long sb_mbcnt; 184 u_long sb_mbmax; 185 long sb_lowat; 186 short sb_flags; 187 short sb_timeo; 188 } so_rcv, so_snd; 189 uid_t so_uid; /* XXX */ 190 }; 191 192 /* 193 * Macros for sockets and socket buffering. 194 */ 195 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.ssb_cc >= (so)->so_rcv.ssb_lowat || \ 202 ((so)->so_state & SS_CANTRCVMORE) || \ 203 !TAILQ_EMPTY(&(so)->so_comp) || (so)->so_error) 204 205 /* can we write something to so? */ 206 #define sowriteable(so) \ 207 ((ssb_space(&(so)->so_snd) >= (so)->so_snd.ssb_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 /* 214 * Do we need to notify the other side when I/O is possible? 215 */ 216 #define ssb_notify(ssb) \ 217 (((ssb)->ssb_flags & \ 218 (SSB_WAIT | SSB_SEL | SSB_ASYNC | SSB_UPCALL | \ 219 SSB_AIO | SSB_KNOTE | SSB_MEVENT))) 220 221 /* do we have to send all at once on a socket? */ 222 223 #ifdef _KERNEL 224 225 /* 226 * How much space is there in a socket buffer (so->so_snd or so->so_rcv)? 227 * This is problematical if the fields are unsigned, as the space might 228 * still be negative (cc > hiwat or mbcnt > mbmax). Should detect 229 * overflow and return 0. 230 * 231 * SSB_STOP ignores cc/hiwat and returns 0. This is used by unix domain 232 * stream sockets to signal backpressure. 233 */ 234 static __inline 235 long 236 ssb_space(struct signalsockbuf *ssb) 237 { 238 long bleft; 239 long mleft; 240 241 if (ssb->ssb_flags & SSB_STOP) 242 return(0); 243 bleft = ssb->ssb_hiwat - ssb->ssb_cc; 244 mleft = ssb->ssb_mbmax - ssb->ssb_mbcnt; 245 return((bleft < mleft) ? bleft : mleft); 246 } 247 248 #endif 249 250 #define ssb_append(ssb, m) \ 251 sbappend(&(ssb)->sb, m) 252 253 #define ssb_appendstream(ssb, m) \ 254 sbappendstream(&(ssb)->sb, m) 255 256 #define ssb_appendrecord(ssb, m) \ 257 sbappendrecord(&(ssb)->sb, m) 258 259 #define ssb_appendaddr(ssb, src, m, control) \ 260 ((ssb_space(ssb) <= 0) ? 0 : sbappendaddr(&(ssb)->sb, src, m, control)) 261 262 #define ssb_appendcontrol(ssb, m, control) \ 263 ((ssb_space(ssb) <= 0) ? 0 : sbappendcontrol(&(ssb)->sb, m, control)) 264 265 #define ssb_insert_knote(ssb, kn) { \ 266 SLIST_INSERT_HEAD(&(ssb)->ssb_sel.si_note, kn, kn_selnext); \ 267 (ssb)->ssb_flags |= SSB_KNOTE; \ 268 } 269 270 #define ssb_remove_knote(ssb, kn) { \ 271 SLIST_REMOVE(&(ssb)->ssb_sel.si_note, kn, knote, kn_selnext); \ 272 if (SLIST_EMPTY(&(ssb)->ssb_sel.si_note)) \ 273 (ssb)->ssb_flags &= ~SSB_KNOTE; \ 274 } 275 276 #define sorwakeup(so) do { \ 277 if (ssb_notify(&(so)->so_rcv)) \ 278 sowakeup((so), &(so)->so_rcv); \ 279 } while (0) 280 281 #define sowwakeup(so) do { \ 282 if (ssb_notify(&(so)->so_snd)) \ 283 sowakeup((so), &(so)->so_snd); \ 284 } while (0) 285 286 #ifdef _KERNEL 287 288 /* 289 * Argument structure for sosetopt et seq. This is in the KERNEL 290 * section because it will never be visible to user code. 291 */ 292 enum sopt_dir { SOPT_GET, SOPT_SET }; 293 struct sockopt { 294 enum sopt_dir sopt_dir; /* is this a get or a set? */ 295 int sopt_level; /* second arg of [gs]etsockopt */ 296 int sopt_name; /* third arg of [gs]etsockopt */ 297 void *sopt_val; /* fourth arg of [gs]etsockopt */ 298 size_t sopt_valsize; /* (almost) fifth arg of [gs]etsockopt */ 299 struct thread *sopt_td; /* calling thread or null if kernel */ 300 }; 301 302 struct accept_filter { 303 char accf_name[16]; 304 void (*accf_callback) 305 (struct socket *so, void *arg, int waitflag); 306 void * (*accf_create) 307 (struct socket *so, char *arg); 308 void (*accf_destroy) 309 (struct socket *so); 310 SLIST_ENTRY(accept_filter) accf_next; /* next on the list */ 311 }; 312 313 #ifdef MALLOC_DECLARE 314 MALLOC_DECLARE(M_PCB); 315 MALLOC_DECLARE(M_SONAME); 316 MALLOC_DECLARE(M_ACCF); 317 #endif 318 319 extern int maxsockets; 320 extern u_long sb_max; /* nominal limit */ 321 extern u_long sb_max_adj; /* actual limit used by sbreserve() */ 322 323 struct file; 324 struct filedesc; 325 struct mbuf; 326 struct rlimit; 327 struct sockaddr; 328 struct stat; 329 struct ucred; 330 struct uio; 331 struct knote; 332 struct sysmsg; 333 334 /* 335 * File operations on sockets. 336 */ 337 int soo_read (struct file *fp, struct uio *uio, struct ucred *cred, 338 int flags); 339 int soo_write (struct file *fp, struct uio *uio, struct ucred *cred, 340 int flags); 341 int soo_close (struct file *fp); 342 int soo_shutdown (struct file *fp, int how); 343 int soo_ioctl (struct file *fp, u_long cmd, caddr_t data, 344 struct ucred *cred, struct sysmsg *msg); 345 int soo_poll (struct file *fp, int events, struct ucred *cred); 346 int soo_stat (struct file *fp, struct stat *ub, struct ucred *cred); 347 int sokqfilter (struct file *fp, struct knote *kn); 348 349 /* 350 * From uipc_socket and friends 351 */ 352 struct sockaddr *dup_sockaddr (const struct sockaddr *sa); 353 int getsockaddr (struct sockaddr **namp, caddr_t uaddr, size_t len); 354 355 void ssb_release (struct signalsockbuf *ssb, struct socket *so); 356 int ssb_reserve (struct signalsockbuf *ssb, u_long cc, struct socket *so, 357 struct rlimit *rl); 358 void ssbtoxsockbuf (struct signalsockbuf *sb, struct xsockbuf *xsb); 359 int ssb_wait (struct signalsockbuf *sb); 360 int _ssb_lock (struct signalsockbuf *sb); 361 362 void soabort (struct socket *so); 363 void soaborta (struct socket *so); 364 void soabort_oncpu (struct socket *so); 365 int soaccept (struct socket *so, struct sockaddr **nam); 366 struct socket *soalloc (int waitok); 367 int sobind (struct socket *so, struct sockaddr *nam, struct thread *td); 368 void socantrcvmore (struct socket *so); 369 void socantsendmore (struct socket *so); 370 int soclose (struct socket *so, int fflags); 371 int soconnect (struct socket *so, struct sockaddr *nam, struct thread *td); 372 int soconnect2 (struct socket *so1, struct socket *so2); 373 int socreate (int dom, struct socket **aso, int type, int proto, 374 struct thread *td); 375 void sodealloc (struct socket *so); 376 int sodisconnect (struct socket *so); 377 void sofree (struct socket *so); 378 int sogetopt (struct socket *so, struct sockopt *sopt); 379 void sohasoutofband (struct socket *so); 380 void soisconnected (struct socket *so); 381 void soisconnecting (struct socket *so); 382 void soisdisconnected (struct socket *so); 383 void soisdisconnecting (struct socket *so); 384 void sosetport (struct socket *so, struct lwkt_port *port); 385 int solisten (struct socket *so, int backlog, struct thread *td); 386 struct socket *sonewconn (struct socket *head, int connstatus); 387 int sooptcopyin (struct sockopt *sopt, void *buf, size_t len, 388 size_t minlen); 389 int soopt_to_kbuf (struct sockopt *sopt, void *buf, size_t len, 390 size_t minlen); 391 int sooptcopyout (struct sockopt *sopt, const void *buf, size_t len); 392 void soopt_from_kbuf (struct sockopt *sopt, const void *buf, size_t len); 393 394 /* XXX; prepare mbuf for (__FreeBSD__ < 3) routines. */ 395 int soopt_getm (struct sockopt *sopt, struct mbuf **mp); 396 int soopt_mcopyin (struct sockopt *sopt, struct mbuf *m); 397 void soopt_to_mbuf (struct sockopt *sopt, struct mbuf *m); 398 int soopt_mcopyout (struct sockopt *sopt, struct mbuf *m); 399 int soopt_from_mbuf (struct sockopt *sopt, struct mbuf *m); 400 401 int sopoll (struct socket *so, int events, struct ucred *cred, 402 struct thread *td); 403 int soreceive (struct socket *so, struct sockaddr **paddr, 404 struct uio *uio, struct sockbuf *sio, 405 struct mbuf **controlp, int *flagsp); 406 int soreserve (struct socket *so, u_long sndcc, u_long rcvcc, 407 struct rlimit *rl); 408 void sorflush (struct socket *so); 409 int sosend (struct socket *so, struct sockaddr *addr, struct uio *uio, 410 struct mbuf *top, struct mbuf *control, int flags, 411 struct thread *td); 412 int sosendudp (struct socket *so, struct sockaddr *addr, struct uio *uio, 413 struct mbuf *top, struct mbuf *control, int flags, 414 struct thread *td); 415 int sosetopt (struct socket *so, struct sockopt *sopt); 416 int soshutdown (struct socket *so, int how); 417 void sotoxsocket (struct socket *so, struct xsocket *xso); 418 void sowakeup (struct socket *so, struct signalsockbuf *sb); 419 420 /* accept filter functions */ 421 int accept_filt_add (struct accept_filter *filt); 422 int accept_filt_del (char *name); 423 struct accept_filter * accept_filt_get (char *name); 424 #ifdef ACCEPT_FILTER_MOD 425 int accept_filt_generic_mod_event (module_t mod, int event, void *data); 426 SYSCTL_DECL(_net_inet_accf); 427 #endif /* ACCEPT_FILTER_MOD */ 428 429 #endif /* _KERNEL */ 430 431 #endif /* !_SYS_SOCKETVAR_H_ */ 432