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. Neither the name of the University nor the names of its contributors
14 * may be used to endorse or promote products derived from this software
15 * without specific prior written permission.
17 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
18 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
21 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
29 * @(#)socketvar.h 8.3 (Berkeley) 2/19/95
30 * $FreeBSD: src/sys/sys/socketvar.h,v 1.46.2.10 2003/08/24 08:24:39 hsu Exp $
31 * $DragonFly: src/sys/sys/socketvar.h,v 1.35 2008/08/28 23:15:45 dillon Exp $
34 #ifndef _SYS_SOCKETVAR_H_
35 #define _SYS_SOCKETVAR_H_
38 #include <sys/types.h>
41 #include <sys/queue.h> /* for TAILQ macros */
44 #include <sys/event.h> /* for struct kqinfo */
46 #ifndef _SYS_THREAD_H_
47 #include <sys/thread.h> /* for struct lwkt_token */
49 #ifndef _SYS_SOCKBUF_H_
50 #include <sys/sockbuf.h>
53 #if defined(_KERNEL) || defined(_KERNEL_STRUCTURES)
55 #ifndef _NET_NETMSG_H_
56 #include <net/netmsg.h>
59 #ifndef _SYS_SPINLOCK_H_
60 #include <sys/spinlock.h>
66 * Signaling socket buffers contain additional elements for locking
67 * and signaling conditions. These are used primarily by sockets.
69 * WARNING: See partial clearing of fields in kern/uipc_socket.c
70 * sorflush() and sowflush().
72 struct signalsockbuf
{
74 struct kqinfo ssb_kq
; /* process selecting read/write */
75 struct notifymsglist ssb_mlist
; /* list of pending predicate messages */
76 uint32_t ssb_flags
; /* flags, see below (use atomic ops) */
77 u_int ssb_timeo
; /* timeout for read/write */
78 long ssb_lowat
; /* low water mark */
79 u_long ssb_hiwat
; /* high water mark / max actual char count */
80 u_long ssb_mbmax
; /* max chars of mbufs to use */
81 struct lwkt_token ssb_token
; /* frontend/backend serializer */
84 #define ssb_cc sb.sb_cc /* commonly used fields */
85 #define ssb_mb sb.sb_mb /* commonly used fields */
86 #define ssb_mbcnt sb.sb_mbcnt /* commonly used fields */
87 #define ssb_cc_prealloc sb.sb_cc_prealloc
88 #define ssb_mbcnt_prealloc sb.sb_mbcnt_prealloc
90 #define SSB_LOCK 0x0001 /* lock on data queue */
91 #define SSB_WANT 0x0002 /* someone is waiting to lock */
92 #define SSB_WAIT 0x0004 /* someone is waiting for data/space */
93 #define SSB_ASYNC 0x0010 /* ASYNC I/O, need signals */
94 #define SSB_UPCALL 0x0020 /* someone wants an upcall */
95 #define SSB_NOINTR 0x0040 /* operations not interruptible */
96 /*#define SSB_AIO 0x0080*/ /* AIO operations queued */
97 #define SSB_KNOTE 0x0100 /* kernel note attached */
98 #define SSB_MEVENT 0x0200 /* need message event notification */
99 #define SSB_STOP 0x0400 /* backpressure indicator */
100 #define SSB_AUTOSIZE 0x0800 /* automatically size socket buffer */
101 #define SSB_AUTOLOWAT 0x1000 /* automatically scale lowat */
102 #define SSB_WAKEUP 0x2000 /* wakeup event race */
103 #define SSB_PREALLOC 0x4000 /* prealloc supported */
104 #define SSB_STOPSUPP 0x8000 /* SSB_STOP supported */
106 #define SSB_CLEAR_MASK (SSB_ASYNC | SSB_UPCALL | SSB_STOP | \
107 SSB_AUTOSIZE | SSB_AUTOLOWAT)
109 #define SSB_NOTIFY_MASK (SSB_WAIT | SSB_ASYNC | SSB_UPCALL | \
110 SSB_KNOTE | SSB_MEVENT)
113 * Per-socket kernel structure. Contains universal send and receive queues,
114 * protocol control handle, and error information.
117 short so_type
; /* generic type, see socket.h */
118 short so_options
; /* from socket call, see socket.h */
119 short so_linger
; /* time to linger while closing */
120 short so_state
; /* internal state flags SS_*, below */
121 void *so_pcb
; /* protocol control block */
122 struct protosw
*so_proto
; /* protocol handle */
123 struct socket
*so_head
; /* back pointer to accept socket */
124 lwkt_port_t so_port
; /* message port */
127 * These fields are used to manage sockets capable of accepting
130 TAILQ_HEAD(, socket
) so_incomp
; /* in-progress, incomplete */
131 TAILQ_HEAD(, socket
) so_comp
; /* completed but not yet accepted */
132 TAILQ_ENTRY(socket
) so_list
; /* list of unaccepted connections */
133 short so_qlen
; /* so_comp count */
134 short so_incqlen
; /* so_incomp count */
135 short so_qlimit
; /* max number queued connections */
138 * Misc socket support
140 short so_timeo
; /* connection timeout */
141 u_short so_error
; /* error affecting connection */
142 u_short so_rerror
; /* error affecting receiving */
143 struct sigio
*so_sigio
; /* information for async I/O or
144 out of band data (SIGURG) */
145 u_long so_oobmark
; /* chars to oob mark */
146 TAILQ_HEAD(, aiocblist
) so_aiojobq
; /* AIO ops waiting on socket */
147 struct signalsockbuf so_rcv
;
148 struct signalsockbuf so_snd
;
150 void (*so_upcall
) (struct socket
*, void *, int);
152 struct ucred
*so_cred
; /* user credentials */
153 /* NB: generation count must not be first; easiest to make it last. */
154 void *so_emuldata
; /* private data for emulators */
155 int so_refs
; /* shutdown refs */
158 struct accept_filter
*so_accept_filter
;
159 void *so_accept_filter_arg
; /* saved filter args */
160 char *so_accept_filter_str
; /* saved user args */
163 struct netmsg_base so_clomsg
;
164 struct sockaddr
*so_faddr
;
166 struct spinlock so_rcvd_spin
;
167 struct netmsg_pru_rcvd so_rcvd_msg
;
169 lwkt_port_t so_orig_port
;
173 uint32_t so_user_cookie
; /* user-specified metadata */
181 * NOTE: The following states are interlocked with so_refs:
183 * SS_NOFDREF so_refs while not set
184 * (so_pcb) so_refs while set
186 #define SS_NOFDREF 0x0001 /* no file table ref any more */
187 #define SS_ISCONNECTED 0x0002 /* socket connected to a peer */
188 #define SS_ISCONNECTING 0x0004 /* in process of connecting to peer */
189 #define SS_ISDISCONNECTING 0x0008 /* in process of disconnecting */
190 #define SS_CANTSENDMORE 0x0010 /* can't send more data to peer */
191 #define SS_CANTRCVMORE 0x0020 /* can't receive more data from peer */
192 #define SS_RCVATMARK 0x0040 /* at mark on input */
194 #define SS_ISCLOSING 0x0080 /* in process of closing */
195 #define SS_ASSERTINPROG 0x0100 /* sonewconn race debugging */
196 #define SS_ASYNC 0x0200 /* async i/o notify */
197 #define SS_ISCONFIRMING 0x0400 /* deciding to accept connection req */
199 #define SS_INCOMP 0x0800 /* unaccepted, incomplete connection */
200 #define SS_COMP 0x1000 /* unaccepted, complete connection */
201 #define SS_ISDISCONNECTED 0x2000 /* socket disconnected from peer */
202 #define SS_ACCEPTMECH 0x4000 /* allow bind override vs accepted */
205 * Externalized form of struct socket used by the sysctl(3) interface.
208 size_t xso_len
; /* length of this structure */
209 struct socket
*xso_so
; /* makes a convenient handle sometimes */
214 void *so_pcb
; /* another convenient handle */
233 uid_t so_uid
; /* XXX */
237 * Macros for sockets and socket buffering.
240 #define sosendallatonce(so) \
241 ((so)->so_proto->pr_flags & PR_ATOMIC)
243 /* can we read something from so? */
244 #define soreadable(so) \
245 ((so)->so_rcv.ssb_cc >= (so)->so_rcv.ssb_lowat || \
246 ((so)->so_state & SS_CANTRCVMORE) || \
247 !TAILQ_EMPTY(&(so)->so_comp) || (so)->so_error || (so)->so_rerror)
249 /* can we write something to so? */
250 #define sowriteable(so) \
251 ((ssb_space(&(so)->so_snd) >= (so)->so_snd.ssb_lowat && \
252 (((so)->so_state&SS_ISCONNECTED) || \
253 ((so)->so_proto->pr_flags&PR_CONNREQUIRED)==0)) || \
254 ((so)->so_state & SS_CANTSENDMORE) || \
257 /* do we have to send all at once on a socket? */
262 * How much space is there in a socket buffer (so->so_snd or so->so_rcv)?
263 * This is problematical if the fields are unsigned, as the space might
264 * still be negative (cc > hiwat or mbcnt > mbmax). Should detect
265 * overflow and return 0.
267 * SSB_STOP ignores cc/hiwat and returns 0. This is used by unix domain
268 * stream sockets to signal backpressure.
272 ssb_space(struct signalsockbuf
*ssb
)
277 if (ssb
->ssb_flags
& SSB_STOP
)
279 bleft
= ssb
->ssb_hiwat
- ssb
->ssb_cc
;
280 mleft
= ssb
->ssb_mbmax
- ssb
->ssb_mbcnt
;
281 return((bleft
< mleft
) ? bleft
: mleft
);
285 ssb_space_prealloc(struct signalsockbuf
*ssb
)
287 long bleft
, bleft_prealloc
;
288 long mleft
, mleft_prealloc
;
290 if (ssb
->ssb_flags
& SSB_STOP
)
293 bleft
= ssb
->ssb_hiwat
- ssb
->ssb_cc
;
294 bleft_prealloc
= ssb
->ssb_hiwat
- ssb
->ssb_cc_prealloc
;
295 if (bleft_prealloc
< bleft
)
296 bleft
= bleft_prealloc
;
298 mleft
= ssb
->ssb_mbmax
- ssb
->ssb_mbcnt
;
299 mleft_prealloc
= ssb
->ssb_mbmax
- ssb
->ssb_mbcnt_prealloc
;
300 if (mleft_prealloc
< mleft
)
301 mleft
= mleft_prealloc
;
303 return((bleft
< mleft
) ? bleft
: mleft
);
307 * NOTE: Only works w/ later ssb_appendstream() on m
310 ssb_preallocstream(struct signalsockbuf
*ssb
, struct mbuf
*m
)
314 sbprealloc(&ssb
->sb
, m
);
319 #define ssb_append(ssb, m) \
320 sbappend(&(ssb)->sb, m)
322 #define ssb_appendstream(ssb, m) \
323 sbappendstream(&(ssb)->sb, m)
325 #define ssb_appendrecord(ssb, m) \
326 sbappendrecord(&(ssb)->sb, m)
328 #define ssb_appendaddr(ssb, src, m, control) \
329 ((ssb_space(ssb) <= 0) ? 0 : sbappendaddr(&(ssb)->sb, src, m, control))
331 #define ssb_appendcontrol(ssb, m, control) \
332 ((ssb_space(ssb) <= 0) ? 0 : sbappendcontrol(&(ssb)->sb, m, control))
334 #define ssb_insert_knote(ssb, kn) do { \
335 knote_insert(&(ssb)->ssb_kq.ki_note, kn); \
336 atomic_set_int(&(ssb)->ssb_flags, SSB_KNOTE); \
339 #define ssb_remove_knote(ssb, kn) do { \
340 knote_remove(&(ssb)->ssb_kq.ki_note, kn); \
341 if (SLIST_EMPTY(&(ssb)->ssb_kq.ki_note)) \
342 atomic_clear_int(&(ssb)->ssb_flags, SSB_KNOTE); \
345 #define sorwakeup(so) sowakeup((so), &(so)->so_rcv)
346 #define sowwakeup(so) sowakeup((so), &(so)->so_snd)
351 * Argument structure for sosetopt et seq. This is in the KERNEL
352 * section because it will never be visible to user code.
354 enum sopt_dir
{ SOPT_GET
, SOPT_SET
};
356 enum sopt_dir sopt_dir
; /* is this a get or a set? */
357 int sopt_level
; /* second arg of [gs]etsockopt */
358 int sopt_name
; /* third arg of [gs]etsockopt */
359 void *sopt_val
; /* fourth arg of [gs]etsockopt */
360 size_t sopt_valsize
; /* (almost) fifth arg of [gs]etsockopt */
361 struct thread
*sopt_td
; /* calling thread or null if kernel */
364 struct accept_filter
{
366 void (*accf_callback
)
367 (struct socket
*so
, void *arg
, int waitflag
);
368 void * (*accf_create
)
369 (struct socket
*so
, char *arg
);
372 SLIST_ENTRY(accept_filter
) accf_next
; /* next on the list */
375 #ifdef MALLOC_DECLARE
376 MALLOC_DECLARE(M_PCB
);
377 MALLOC_DECLARE(M_SONAME
);
378 MALLOC_DECLARE(M_ACCF
);
381 extern int maxsockets
;
382 extern u_long sb_max
; /* nominal limit */
383 extern u_long sb_max_adj
; /* actual limit used by sbreserve() */
397 * File operations on sockets.
399 int soo_read (struct file
*fp
, struct uio
*uio
, struct ucred
*cred
,
401 int soo_write (struct file
*fp
, struct uio
*uio
, struct ucred
*cred
,
403 int soo_close (struct file
*fp
);
404 int soo_shutdown (struct file
*fp
, int how
);
405 int soo_ioctl (struct file
*fp
, u_long cmd
, caddr_t data
,
406 struct ucred
*cred
, struct sysmsg
*msg
);
407 int soo_stat (struct file
*fp
, struct stat
*ub
, struct ucred
*cred
);
408 int sokqfilter (struct file
*fp
, struct knote
*kn
);
411 * From uipc_socket and friends
413 struct sockaddr
*dup_sockaddr (const struct sockaddr
*sa
);
414 int getsockaddr (struct sockaddr
**namp
, caddr_t uaddr
, size_t len
);
416 void ssb_release (struct signalsockbuf
*ssb
, struct socket
*so
);
417 int ssb_reserve (struct signalsockbuf
*ssb
, u_long cc
, struct socket
*so
,
419 void ssbtoxsockbuf (struct signalsockbuf
*sb
, struct xsockbuf
*xsb
);
420 int ssb_wait (struct signalsockbuf
*sb
);
421 int _ssb_lock (struct signalsockbuf
*sb
);
423 void soabort_async (struct socket
*so
, boolean_t clr_head
);
424 void soabort_direct (struct socket
*so
);
425 int soaccept (struct socket
*so
, struct sockaddr
**nam
);
426 void soaccept_generic (struct socket
*so
);
427 struct socket
*soalloc (int waitok
, struct protosw
*);
428 int sobind (struct socket
*so
, struct sockaddr
*nam
, struct thread
*td
);
429 void socantrcvmore (struct socket
*so
);
430 void socantsendmore (struct socket
*so
);
431 void soroverflow(struct socket
*so
);
432 int socket_wait (struct socket
*so
, struct timespec
*ts
, int *res
);
433 int soclose (struct socket
*so
, int fflags
);
434 int soconnect (struct socket
*so
, struct sockaddr
*nam
, struct thread
*td
,
436 int soconnect2 (struct socket
*so1
, struct socket
*so2
, struct ucred
*cred
);
437 int socreate (int dom
, struct socket
**aso
, int type
, int proto
,
439 int sodisconnect (struct socket
*so
);
440 void sodiscard (struct socket
*so
);
441 void sofree (struct socket
*so
);
442 int sogetopt (struct socket
*so
, struct sockopt
*sopt
);
443 void sohasoutofband (struct socket
*so
);
444 void soisconnected (struct socket
*so
);
445 void soisconnecting (struct socket
*so
);
446 void soisdisconnected (struct socket
*so
);
447 void soisdisconnecting (struct socket
*so
);
448 void soisreconnected (struct socket
*so
);
449 void soisreconnecting (struct socket
*so
);
450 void sosetport (struct socket
*so
, struct lwkt_port
*port
);
451 int solisten (struct socket
*so
, int backlog
, struct thread
*td
);
452 struct socket
*sonewconn (struct socket
*head
, int connstatus
);
453 struct socket
*sonewconn_faddr (struct socket
*head
, int connstatus
,
454 const struct sockaddr
*faddr
, boolean_t keep_ref
);
455 void soinherit(struct socket
*so
, struct socket
*so_inh
);
456 int sooptcopyin (struct sockopt
*sopt
, void *buf
, size_t len
,
458 int soopt_to_kbuf (struct sockopt
*sopt
, void *buf
, size_t len
,
460 int sooptcopyout (struct sockopt
*sopt
, const void *buf
, size_t len
);
461 void soopt_from_kbuf (struct sockopt
*sopt
, const void *buf
, size_t len
);
463 /* XXX; prepare mbuf for (__FreeBSD__ < 3) routines. */
464 int soopt_getm (struct sockopt
*sopt
, struct mbuf
**mp
);
465 int soopt_mcopyin (struct sockopt
*sopt
, struct mbuf
*m
);
466 void soopt_to_mbuf (struct sockopt
*sopt
, struct mbuf
*m
);
467 int soopt_mcopyout (struct sockopt
*sopt
, struct mbuf
*m
);
468 int soopt_from_mbuf (struct sockopt
*sopt
, struct mbuf
*m
);
470 int soreceive (struct socket
*so
, struct sockaddr
**paddr
,
471 struct uio
*uio
, struct sockbuf
*sio
,
472 struct mbuf
**controlp
, int *flagsp
);
473 int sorecvtcp (struct socket
*so
, struct sockaddr
**paddr
,
474 struct uio
*uio
, struct sockbuf
*sio
,
475 struct mbuf
**controlp
, int *flagsp
);
476 int soreserve (struct socket
*so
, u_long sndcc
, u_long rcvcc
,
478 void sorflush (struct socket
*so
);
479 int sosend (struct socket
*so
, struct sockaddr
*addr
, struct uio
*uio
,
480 struct mbuf
*top
, struct mbuf
*control
, int flags
,
482 int sosendudp (struct socket
*so
, struct sockaddr
*addr
, struct uio
*uio
,
483 struct mbuf
*top
, struct mbuf
*control
, int flags
,
485 int sosendtcp (struct socket
*so
, struct sockaddr
*addr
, struct uio
*uio
,
486 struct mbuf
*top
, struct mbuf
*control
, int flags
,
488 int sosetopt (struct socket
*so
, struct sockopt
*sopt
);
489 int soshutdown (struct socket
*so
, int how
);
490 void sotoxsocket (struct socket
*so
, struct xsocket
*xso
);
491 void sowakeup (struct socket
*so
, struct signalsockbuf
*sb
);
493 /* accept filter functions */
494 int accept_filt_add (struct accept_filter
*filt
);
495 int accept_filt_del (char *name
);
496 struct accept_filter
* accept_filt_get (char *name
);
497 #ifdef ACCEPT_FILTER_MOD
498 int accept_filt_generic_mod_event (module_t mod
, int event
, void *data
);
499 SYSCTL_DECL(_net_inet_accf
);
500 #endif /* ACCEPT_FILTER_MOD */
504 #endif /* !_SYS_SOCKETVAR_H_ */