2 * Copyright (c) 1982, 1986, 1990, 1993
3 * The Regents of the University of California. All rights reserved.
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
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.
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
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 $
38 #ifndef _SYS_SOCKETVAR_H_
39 #define _SYS_SOCKETVAR_H_
42 #include <sys/types.h>
45 #include <sys/queue.h> /* for TAILQ macros */
47 #ifndef _SYS_SELINFO_H_
48 #include <sys/selinfo.h> /* for struct selinfo */
50 #ifndef _SYS_SOCKBUF_H_
51 #include <sys/sockbuf.h>
54 #if defined(_KERNEL) || defined(_KERNEL_STRUCTURES)
59 * Signaling socket buffers contain additional elements for locking
60 * and signaling conditions. These are used primarily by sockets.
62 struct signalsockbuf {
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 */
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 */
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 */
90 * Per-socket kernel structure. Contains universal send and receive queues,
91 * protocol control handle, and error information.
94 short so_type; /* generic type, see socket.h */
95 short so_options; /* from socket call, see socket.h */
96 short so_linger; /* time to linger while closing */
97 short so_state; /* internal state flags SS_*, below */
98 void *so_pcb; /* protocol control block */
99 struct protosw *so_proto; /* protocol handle */
100 struct socket *so_head; /* back pointer to accept socket */
103 * These fields are used to manage sockets capable of accepting
106 TAILQ_HEAD(, socket) so_incomp; /* in-progress, incomplete */
107 TAILQ_HEAD(, socket) so_comp; /* completed but not yet accepted */
108 TAILQ_ENTRY(socket) so_list; /* list of unaccepted connections */
109 short so_qlen; /* so_comp count */
110 short so_incqlen; /* so_incomp count */
111 short so_qlimit; /* max number queued connections */
114 * Misc socket support
116 short so_timeo; /* connection timeout */
117 u_short so_error; /* error affecting connection */
118 struct sigio *so_sigio; /* information for async I/O or
119 out of band data (SIGURG) */
120 u_long so_oobmark; /* chars to oob mark */
121 TAILQ_HEAD(, aiocblist) so_aiojobq; /* AIO ops waiting on socket */
122 struct signalsockbuf so_rcv;
123 struct signalsockbuf so_snd;
125 void (*so_upcall) (struct socket *, void *, int);
127 struct ucred *so_cred; /* user credentials */
128 /* NB: generation count must not be first; easiest to make it last. */
129 void *so_emuldata; /* private data for emulators */
131 struct accept_filter *so_accept_filter;
132 void *so_accept_filter_arg; /* saved filter args */
133 char *so_accept_filter_str; /* saved user args */
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 */
150 #define SS_ABORTING 0x0100 /* so_abort() in progress */
151 #define SS_ASYNC 0x0200 /* async i/o notify */
152 #define SS_ISCONFIRMING 0x0400 /* deciding to accept connection req */
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 */
159 * Externalized form of struct socket used by the sysctl(3) interface.
162 size_t xso_len; /* length of this structure */
163 struct socket *xso_so; /* makes a convenient handle sometimes */
168 void *so_pcb; /* another convenient handle */
187 uid_t so_uid; /* XXX */
191 * Macros for sockets and socket buffering.
194 #define sosendallatonce(so) \
195 ((so)->so_proto->pr_flags & PR_ATOMIC)
197 /* can we read something from so? */
198 #define soreadable(so) \
199 ((so)->so_rcv.ssb_cc >= (so)->so_rcv.ssb_lowat || \
200 ((so)->so_state & SS_CANTRCVMORE) || \
201 !TAILQ_EMPTY(&(so)->so_comp) || (so)->so_error)
203 /* can we write something to so? */
204 #define sowriteable(so) \
205 ((ssb_space(&(so)->so_snd) >= (so)->so_snd.ssb_lowat && \
206 (((so)->so_state&SS_ISCONNECTED) || \
207 ((so)->so_proto->pr_flags&PR_CONNREQUIRED)==0)) || \
208 ((so)->so_state & SS_CANTSENDMORE) || \
212 * Do we need to notify the other side when I/O is possible?
214 #define ssb_notify(ssb) \
215 (((ssb)->ssb_flags & \
216 (SSB_WAIT | SSB_SEL | SSB_ASYNC | SSB_UPCALL | \
217 SSB_AIO | SSB_KNOTE | SSB_MEVENT)))
219 /* do we have to send all at once on a socket? */
224 * How much space is there in a socket buffer (so->so_snd or so->so_rcv)?
225 * This is problematical if the fields are unsigned, as the space might
226 * still be negative (cc > hiwat or mbcnt > mbmax). Should detect
227 * overflow and return 0.
229 * SSB_STOP ignores cc/hiwat and returns 0. This is used by unix domain
230 * stream sockets to signal backpressure.
234 ssb_space(struct signalsockbuf *ssb)
239 if (ssb->ssb_flags & SSB_STOP)
241 bleft = ssb->ssb_hiwat - ssb->ssb_cc;
242 mleft = ssb->ssb_mbmax - ssb->ssb_mbcnt;
243 return((bleft < mleft) ? bleft : mleft);
248 #define ssb_append(ssb, m) \
249 sbappend(&(ssb)->sb, m)
251 #define ssb_appendstream(ssb, m) \
252 sbappendstream(&(ssb)->sb, m)
254 #define ssb_appendrecord(ssb, m) \
255 sbappendrecord(&(ssb)->sb, m)
257 #define ssb_appendaddr(ssb, src, m, control) \
258 ((ssb_space(ssb) <= 0) ? 0 : sbappendaddr(&(ssb)->sb, src, m, control))
260 #define ssb_appendcontrol(ssb, m, control) \
261 ((ssb_space(ssb) <= 0) ? 0 : sbappendcontrol(&(ssb)->sb, m, control))
263 #define ssb_insert_knote(ssb, kn) { \
264 SLIST_INSERT_HEAD(&(ssb)->ssb_sel.si_note, kn, kn_selnext); \
265 (ssb)->ssb_flags |= SSB_KNOTE; \
268 #define ssb_remove_knote(ssb, kn) { \
269 SLIST_REMOVE(&(ssb)->ssb_sel.si_note, kn, knote, kn_selnext); \
270 if (SLIST_EMPTY(&(ssb)->ssb_sel.si_note)) \
271 (ssb)->ssb_flags &= ~SSB_KNOTE; \
274 #define sorwakeup(so) do { \
275 if (ssb_notify(&(so)->so_rcv)) \
276 sowakeup((so), &(so)->so_rcv); \
279 #define sowwakeup(so) do { \
280 if (ssb_notify(&(so)->so_snd)) \
281 sowakeup((so), &(so)->so_snd); \
287 * Argument structure for sosetopt et seq. This is in the KERNEL
288 * section because it will never be visible to user code.
290 enum sopt_dir { SOPT_GET, SOPT_SET };
292 enum sopt_dir sopt_dir; /* is this a get or a set? */
293 int sopt_level; /* second arg of [gs]etsockopt */
294 int sopt_name; /* third arg of [gs]etsockopt */
295 void *sopt_val; /* fourth arg of [gs]etsockopt */
296 size_t sopt_valsize; /* (almost) fifth arg of [gs]etsockopt */
297 struct thread *sopt_td; /* calling thread or null if kernel */
300 struct accept_filter {
302 void (*accf_callback)
303 (struct socket *so, void *arg, int waitflag);
304 void * (*accf_create)
305 (struct socket *so, char *arg);
308 SLIST_ENTRY(accept_filter) accf_next; /* next on the list */
311 #ifdef MALLOC_DECLARE
312 MALLOC_DECLARE(M_PCB);
313 MALLOC_DECLARE(M_SONAME);
314 MALLOC_DECLARE(M_ACCF);
317 extern int maxsockets;
318 extern u_long sb_max; /* nominal limit */
319 extern u_long sb_max_adj; /* actual limit used by sbreserve() */
333 * File operations on sockets.
335 int soo_read (struct file *fp, struct uio *uio, struct ucred *cred,
337 int soo_write (struct file *fp, struct uio *uio, struct ucred *cred,
339 int soo_close (struct file *fp);
340 int soo_shutdown (struct file *fp, int how);
341 int soo_ioctl (struct file *fp, u_long cmd, caddr_t data,
342 struct ucred *cred, struct sysmsg *msg);
343 int soo_poll (struct file *fp, int events, struct ucred *cred);
344 int soo_stat (struct file *fp, struct stat *ub, struct ucred *cred);
345 int sokqfilter (struct file *fp, struct knote *kn);
348 * From uipc_socket and friends
350 struct sockaddr *dup_sockaddr (const struct sockaddr *sa);
351 int getsockaddr (struct sockaddr **namp, caddr_t uaddr, size_t len);
353 void ssb_release (struct signalsockbuf *ssb, struct socket *so);
354 int ssb_reserve (struct signalsockbuf *ssb, u_long cc, struct socket *so,
356 void ssbtoxsockbuf (struct signalsockbuf *sb, struct xsockbuf *xsb);
357 int ssb_wait (struct signalsockbuf *sb);
358 int _ssb_lock (struct signalsockbuf *sb);
360 void soabort (struct socket *so);
361 void soaborta (struct socket *so);
362 void soabort_oncpu (struct socket *so);
363 int soaccept (struct socket *so, struct sockaddr **nam);
364 struct socket *soalloc (int waitok);
365 int sobind (struct socket *so, struct sockaddr *nam, struct thread *td);
366 void socantrcvmore (struct socket *so);
367 void socantsendmore (struct socket *so);
368 int soclose (struct socket *so, int fflags);
369 int soconnect (struct socket *so, struct sockaddr *nam, struct thread *td);
370 int soconnect2 (struct socket *so1, struct socket *so2);
371 int socreate (int dom, struct socket **aso, int type, int proto,
373 void sodealloc (struct socket *so);
374 int sodisconnect (struct socket *so);
375 void sofree (struct socket *so);
376 int sogetopt (struct socket *so, struct sockopt *sopt);
377 void sohasoutofband (struct socket *so);
378 void soisconnected (struct socket *so);
379 void soisconnecting (struct socket *so);
380 void soisdisconnected (struct socket *so);
381 void soisdisconnecting (struct socket *so);
382 int solisten (struct socket *so, int backlog, struct thread *td);
383 struct socket *sonewconn (struct socket *head, int connstatus);
384 int sooptcopyin (struct sockopt *sopt, void *buf, size_t len,
386 int soopt_to_kbuf (struct sockopt *sopt, void *buf, size_t len,
388 int sooptcopyout (struct sockopt *sopt, const void *buf, size_t len);
389 void soopt_from_kbuf (struct sockopt *sopt, const void *buf, size_t len);
391 /* XXX; prepare mbuf for (__FreeBSD__ < 3) routines. */
392 int soopt_getm (struct sockopt *sopt, struct mbuf **mp);
393 int soopt_mcopyin (struct sockopt *sopt, struct mbuf *m);
394 void soopt_to_mbuf (struct sockopt *sopt, struct mbuf *m);
395 int soopt_mcopyout (struct sockopt *sopt, struct mbuf *m);
396 int soopt_from_mbuf (struct sockopt *sopt, struct mbuf *m);
398 int sopoll (struct socket *so, int events, struct ucred *cred,
400 int soreceive (struct socket *so, struct sockaddr **paddr,
401 struct uio *uio, struct sockbuf *sio,
402 struct mbuf **controlp, int *flagsp);
403 int soreserve (struct socket *so, u_long sndcc, u_long rcvcc,
405 void sorflush (struct socket *so);
406 int sosend (struct socket *so, struct sockaddr *addr, struct uio *uio,
407 struct mbuf *top, struct mbuf *control, int flags,
409 int sosendudp (struct socket *so, struct sockaddr *addr, struct uio *uio,
410 struct mbuf *top, struct mbuf *control, int flags,
412 int sosetopt (struct socket *so, struct sockopt *sopt);
413 int soshutdown (struct socket *so, int how);
414 void sotoxsocket (struct socket *so, struct xsocket *xso);
415 void sowakeup (struct socket *so, struct signalsockbuf *sb);
417 /* accept filter functions */
418 int accept_filt_add (struct accept_filter *filt);
419 int accept_filt_del (char *name);
420 struct accept_filter * accept_filt_get (char *name);
421 #ifdef ACCEPT_FILTER_MOD
422 int accept_filt_generic_mod_event (module_t mod, int event, void *data);
423 SYSCTL_DECL(_net_inet_accf);
424 #endif /* ACCEPT_FILTER_MOD */
428 #endif /* !_SYS_SOCKETVAR_H_ */