xref: /freebsd/sys/kern/uipc_sockbuf.c (revision 335654d73e2c46b04b41961ab1d52bb8445f8c02)
1df8bae1dSRodney W. Grimes /*
2df8bae1dSRodney W. Grimes  * Copyright (c) 1982, 1986, 1988, 1990, 1993
3df8bae1dSRodney W. Grimes  *	The Regents of the University of California.  All rights reserved.
4df8bae1dSRodney W. Grimes  *
5df8bae1dSRodney W. Grimes  * Redistribution and use in source and binary forms, with or without
6df8bae1dSRodney W. Grimes  * modification, are permitted provided that the following conditions
7df8bae1dSRodney W. Grimes  * are met:
8df8bae1dSRodney W. Grimes  * 1. Redistributions of source code must retain the above copyright
9df8bae1dSRodney W. Grimes  *    notice, this list of conditions and the following disclaimer.
10df8bae1dSRodney W. Grimes  * 2. Redistributions in binary form must reproduce the above copyright
11df8bae1dSRodney W. Grimes  *    notice, this list of conditions and the following disclaimer in the
12df8bae1dSRodney W. Grimes  *    documentation and/or other materials provided with the distribution.
13df8bae1dSRodney W. Grimes  * 3. All advertising materials mentioning features or use of this software
14df8bae1dSRodney W. Grimes  *    must display the following acknowledgement:
15df8bae1dSRodney W. Grimes  *	This product includes software developed by the University of
16df8bae1dSRodney W. Grimes  *	California, Berkeley and its contributors.
17df8bae1dSRodney W. Grimes  * 4. Neither the name of the University nor the names of its contributors
18df8bae1dSRodney W. Grimes  *    may be used to endorse or promote products derived from this software
19df8bae1dSRodney W. Grimes  *    without specific prior written permission.
20df8bae1dSRodney W. Grimes  *
21df8bae1dSRodney W. Grimes  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
22df8bae1dSRodney W. Grimes  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
23df8bae1dSRodney W. Grimes  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
24df8bae1dSRodney W. Grimes  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
25df8bae1dSRodney W. Grimes  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
26df8bae1dSRodney W. Grimes  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
27df8bae1dSRodney W. Grimes  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
28df8bae1dSRodney W. Grimes  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
29df8bae1dSRodney W. Grimes  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
30df8bae1dSRodney W. Grimes  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
31df8bae1dSRodney W. Grimes  * SUCH DAMAGE.
32df8bae1dSRodney W. Grimes  *
33df8bae1dSRodney W. Grimes  *	@(#)uipc_socket2.c	8.1 (Berkeley) 6/10/93
34c3aac50fSPeter Wemm  * $FreeBSD$
35df8bae1dSRodney W. Grimes  */
36df8bae1dSRodney W. Grimes 
37335654d7SRobert Watson #include "opt_mac.h"
385b86eac4SJesper Skriver #include "opt_param.h"
39335654d7SRobert Watson 
40df8bae1dSRodney W. Grimes #include <sys/param.h>
41960ed29cSSeigo Tanimura #include <sys/aio.h> /* for aio_swake proto */
4298271db4SGarrett Wollman #include <sys/domain.h>
43960ed29cSSeigo Tanimura #include <sys/event.h>
44134c934cSMike Smith #include <sys/file.h>	/* for maxfiles */
45ff5c09daSGarrett Wollman #include <sys/kernel.h>
46fb919e4dSMark Murray #include <sys/lock.h>
47df8bae1dSRodney W. Grimes #include <sys/malloc.h>
48335654d7SRobert Watson #include <sys/mac.h>
49df8bae1dSRodney W. Grimes #include <sys/mbuf.h>
50960ed29cSSeigo Tanimura #include <sys/mutex.h>
51fb919e4dSMark Murray #include <sys/proc.h>
52df8bae1dSRodney W. Grimes #include <sys/protosw.h>
532f9a2132SBrian Feldman #include <sys/resourcevar.h>
54960ed29cSSeigo Tanimura #include <sys/signalvar.h>
55df8bae1dSRodney W. Grimes #include <sys/socket.h>
56df8bae1dSRodney W. Grimes #include <sys/socketvar.h>
57960ed29cSSeigo Tanimura #include <sys/stat.h>
58ff5c09daSGarrett Wollman #include <sys/sysctl.h>
59960ed29cSSeigo Tanimura #include <sys/systm.h>
6026f9a767SRodney W. Grimes 
6154d77689SJeff Roberson int	maxsockets;
6254d77689SJeff Roberson 
6321d56e9cSAlfred Perlstein void (*aio_swake)(struct socket *, struct sockbuf *);
6421d56e9cSAlfred Perlstein 
65df8bae1dSRodney W. Grimes /*
66df8bae1dSRodney W. Grimes  * Primitive routines for operating on sockets and socket buffers
67df8bae1dSRodney W. Grimes  */
68df8bae1dSRodney W. Grimes 
69ff5c09daSGarrett Wollman u_long	sb_max = SB_MAX;		/* XXX should be static */
70df8bae1dSRodney W. Grimes 
714b29bc4fSGarrett Wollman static	u_long sb_efficiency = 8;	/* parameter for sbreserve() */
724b29bc4fSGarrett Wollman 
73df8bae1dSRodney W. Grimes /*
74df8bae1dSRodney W. Grimes  * Procedures to manipulate state flags of socket
75df8bae1dSRodney W. Grimes  * and do appropriate wakeups.  Normal sequence from the
76df8bae1dSRodney W. Grimes  * active (originating) side is that soisconnecting() is
77df8bae1dSRodney W. Grimes  * called during processing of connect() call,
78df8bae1dSRodney W. Grimes  * resulting in an eventual call to soisconnected() if/when the
79df8bae1dSRodney W. Grimes  * connection is established.  When the connection is torn down
80df8bae1dSRodney W. Grimes  * soisdisconnecting() is called during processing of disconnect() call,
81df8bae1dSRodney W. Grimes  * and soisdisconnected() is called when the connection to the peer
82df8bae1dSRodney W. Grimes  * is totally severed.  The semantics of these routines are such that
83df8bae1dSRodney W. Grimes  * connectionless protocols can call soisconnected() and soisdisconnected()
84df8bae1dSRodney W. Grimes  * only, bypassing the in-progress calls when setting up a ``connection''
85df8bae1dSRodney W. Grimes  * takes no time.
86df8bae1dSRodney W. Grimes  *
87df8bae1dSRodney W. Grimes  * From the passive side, a socket is created with
88dc97381eSPeter Wemm  * two queues of sockets: so_incomp for connections in progress
89dc97381eSPeter Wemm  * and so_comp for connections already made and awaiting user acceptance.
90df8bae1dSRodney W. Grimes  * As a protocol is preparing incoming connections, it creates a socket
91dc97381eSPeter Wemm  * structure queued on so_incomp by calling sonewconn().  When the connection
92df8bae1dSRodney W. Grimes  * is established, soisconnected() is called, and transfers the
93dc97381eSPeter Wemm  * socket structure to so_comp, making it available to accept().
94df8bae1dSRodney W. Grimes  *
95df8bae1dSRodney W. Grimes  * If a socket is closed with sockets on either
96dc97381eSPeter Wemm  * so_incomp or so_comp, these sockets are dropped.
97df8bae1dSRodney W. Grimes  *
98df8bae1dSRodney W. Grimes  * If higher level protocols are implemented in
99df8bae1dSRodney W. Grimes  * the kernel, the wakeups done here will sometimes
100df8bae1dSRodney W. Grimes  * cause software-interrupt process scheduling.
101df8bae1dSRodney W. Grimes  */
102df8bae1dSRodney W. Grimes 
10326f9a767SRodney W. Grimes void
104df8bae1dSRodney W. Grimes soisconnecting(so)
105df8bae1dSRodney W. Grimes 	register struct socket *so;
106df8bae1dSRodney W. Grimes {
107df8bae1dSRodney W. Grimes 
108df8bae1dSRodney W. Grimes 	so->so_state &= ~(SS_ISCONNECTED|SS_ISDISCONNECTING);
109df8bae1dSRodney W. Grimes 	so->so_state |= SS_ISCONNECTING;
110df8bae1dSRodney W. Grimes }
111df8bae1dSRodney W. Grimes 
11226f9a767SRodney W. Grimes void
113d48d4b25SSeigo Tanimura soisconnected(so)
114d48d4b25SSeigo Tanimura 	struct socket *so;
115d48d4b25SSeigo Tanimura {
1164cc20ab1SSeigo Tanimura 	struct socket *head = so->so_head;
117d48d4b25SSeigo Tanimura 
118d48d4b25SSeigo Tanimura 	so->so_state &= ~(SS_ISCONNECTING|SS_ISDISCONNECTING|SS_ISCONFIRMING);
119d48d4b25SSeigo Tanimura 	so->so_state |= SS_ISCONNECTED;
120d48d4b25SSeigo Tanimura 	if (head && (so->so_state & SS_INCOMP)) {
121d48d4b25SSeigo Tanimura 		if ((so->so_options & SO_ACCEPTFILTER) != 0) {
1224cc20ab1SSeigo Tanimura 			so->so_upcall = head->so_accf->so_accept_filter->accf_callback;
1234cc20ab1SSeigo Tanimura 			so->so_upcallarg = head->so_accf->so_accept_filter_arg;
124d48d4b25SSeigo Tanimura 			so->so_rcv.sb_flags |= SB_UPCALL;
125d48d4b25SSeigo Tanimura 			so->so_options &= ~SO_ACCEPTFILTER;
1264cc20ab1SSeigo Tanimura 			so->so_upcall(so, so->so_upcallarg, 0);
127a79b7128SAlfred Perlstein 			return;
128a79b7128SAlfred Perlstein 		}
129be24e9e8SDavid Greenman 		TAILQ_REMOVE(&head->so_incomp, so, so_list);
130a51764a8SPaul Traina 		head->so_incqlen--;
1314cc20ab1SSeigo Tanimura 		so->so_state &= ~SS_INCOMP;
132be24e9e8SDavid Greenman 		TAILQ_INSERT_TAIL(&head->so_comp, so, so_list);
133e1f1827fSMike Silbersack 		head->so_qlen++;
1344cc20ab1SSeigo Tanimura 		so->so_state |= SS_COMP;
13503e49181SSeigo Tanimura 		sorwakeup(head);
136a91b8721SDavid Greenman 		wakeup_one(&head->so_timeo);
137df8bae1dSRodney W. Grimes 	} else {
138a91b8721SDavid Greenman 		wakeup(&so->so_timeo);
13903e49181SSeigo Tanimura 		sorwakeup(so);
14003e49181SSeigo Tanimura 		sowwakeup(so);
141df8bae1dSRodney W. Grimes 	}
142df8bae1dSRodney W. Grimes }
143df8bae1dSRodney W. Grimes 
14426f9a767SRodney W. Grimes void
145df8bae1dSRodney W. Grimes soisdisconnecting(so)
146df8bae1dSRodney W. Grimes 	register struct socket *so;
147df8bae1dSRodney W. Grimes {
148df8bae1dSRodney W. Grimes 
149df8bae1dSRodney W. Grimes 	so->so_state &= ~SS_ISCONNECTING;
150df8bae1dSRodney W. Grimes 	so->so_state |= (SS_ISDISCONNECTING|SS_CANTRCVMORE|SS_CANTSENDMORE);
15180208239SAlfred Perlstein 	wakeup(&so->so_timeo);
15203e49181SSeigo Tanimura 	sowwakeup(so);
15303e49181SSeigo Tanimura 	sorwakeup(so);
154df8bae1dSRodney W. Grimes }
155df8bae1dSRodney W. Grimes 
15626f9a767SRodney W. Grimes void
157df8bae1dSRodney W. Grimes soisdisconnected(so)
158df8bae1dSRodney W. Grimes 	register struct socket *so;
159df8bae1dSRodney W. Grimes {
160df8bae1dSRodney W. Grimes 
16103e49181SSeigo Tanimura 	so->so_state &= ~(SS_ISCONNECTING|SS_ISCONNECTED|SS_ISDISCONNECTING);
16203e49181SSeigo Tanimura 	so->so_state |= (SS_CANTRCVMORE|SS_CANTSENDMORE|SS_ISDISCONNECTED);
16380208239SAlfred Perlstein 	wakeup(&so->so_timeo);
16425dec747SDavid Malone 	sbdrop(&so->so_snd, so->so_snd.sb_cc);
16503e49181SSeigo Tanimura 	sowwakeup(so);
16603e49181SSeigo Tanimura 	sorwakeup(so);
167df8bae1dSRodney W. Grimes }
168df8bae1dSRodney W. Grimes 
169df8bae1dSRodney W. Grimes /*
170df8bae1dSRodney W. Grimes  * When an attempt at a new connection is noted on a socket
171df8bae1dSRodney W. Grimes  * which accepts connections, sonewconn is called.  If the
172df8bae1dSRodney W. Grimes  * connection is possible (subject to space constraints, etc.)
173df8bae1dSRodney W. Grimes  * then we allocate a new structure, propoerly linked into the
174df8bae1dSRodney W. Grimes  * data structure of the original socket, and return this.
175df8bae1dSRodney W. Grimes  * Connstatus may be 0, or SO_ISCONFIRMING, or SO_ISCONNECTED.
176b1e4abd2SMatthew Dillon  *
177b1e4abd2SMatthew Dillon  * note: the ref count on the socket is 0 on return
178df8bae1dSRodney W. Grimes  */
179df8bae1dSRodney W. Grimes struct socket *
180548af278SBill Fenner sonewconn(head, connstatus)
181df8bae1dSRodney W. Grimes 	register struct socket *head;
182df8bae1dSRodney W. Grimes 	int connstatus;
183df8bae1dSRodney W. Grimes {
184df8bae1dSRodney W. Grimes 	register struct socket *so;
185df8bae1dSRodney W. Grimes 
186ebb0cbeaSPaul Traina 	if (head->so_qlen > 3 * head->so_qlimit / 2)
187df8bae1dSRodney W. Grimes 		return ((struct socket *)0);
18898271db4SGarrett Wollman 	so = soalloc(0);
189df8bae1dSRodney W. Grimes 	if (so == NULL)
190df8bae1dSRodney W. Grimes 		return ((struct socket *)0);
191205b2b61SPeter Wemm 	if ((head->so_options & SO_ACCEPTFILTER) != 0)
192205b2b61SPeter Wemm 		connstatus = 0;
193be24e9e8SDavid Greenman 	so->so_head = head;
194df8bae1dSRodney W. Grimes 	so->so_type = head->so_type;
195df8bae1dSRodney W. Grimes 	so->so_options = head->so_options &~ SO_ACCEPTCONN;
196df8bae1dSRodney W. Grimes 	so->so_linger = head->so_linger;
197df8bae1dSRodney W. Grimes 	so->so_state = head->so_state | SS_NOFDREF;
198df8bae1dSRodney W. Grimes 	so->so_proto = head->so_proto;
199df8bae1dSRodney W. Grimes 	so->so_timeo = head->so_timeo;
200bd78ceceSJohn Baldwin 	so->so_cred = crhold(head->so_cred);
201335654d7SRobert Watson #ifdef MAC
202335654d7SRobert Watson 	mac_create_socket_from_socket(head, so);
203335654d7SRobert Watson #endif
2042f9a2132SBrian Feldman 	if (soreserve(so, head->so_snd.sb_hiwat, head->so_rcv.sb_hiwat) ||
2052f9a2132SBrian Feldman 	    (*so->so_proto->pr_usrreqs->pru_attach)(so, 0, NULL)) {
206b1e4abd2SMatthew Dillon 		sotryfree(so);
207b1396a35SGarrett Wollman 		return ((struct socket *)0);
208b1396a35SGarrett Wollman 	}
209b1396a35SGarrett Wollman 
210be24e9e8SDavid Greenman 	if (connstatus) {
211be24e9e8SDavid Greenman 		TAILQ_INSERT_TAIL(&head->so_comp, so, so_list);
212be24e9e8SDavid Greenman 		so->so_state |= SS_COMP;
213e1f1827fSMike Silbersack 		head->so_qlen++;
214be24e9e8SDavid Greenman 	} else {
215184fec1aSMike Silbersack 		if (head->so_incqlen > head->so_qlimit) {
216e1f1827fSMike Silbersack 			struct socket *sp;
217e1f1827fSMike Silbersack 			sp = TAILQ_FIRST(&head->so_incomp);
218e1f1827fSMike Silbersack 			(void) soabort(sp);
219e1f1827fSMike Silbersack 		}
220be24e9e8SDavid Greenman 		TAILQ_INSERT_TAIL(&head->so_incomp, so, so_list);
221be24e9e8SDavid Greenman 		so->so_state |= SS_INCOMP;
222ebb0cbeaSPaul Traina 		head->so_incqlen++;
223be24e9e8SDavid Greenman 	}
224df8bae1dSRodney W. Grimes 	if (connstatus) {
22503e49181SSeigo Tanimura 		sorwakeup(head);
22680208239SAlfred Perlstein 		wakeup(&head->so_timeo);
227acbbcc5fSSeigo Tanimura 		so->so_state |= connstatus;
228df8bae1dSRodney W. Grimes 	}
229df8bae1dSRodney W. Grimes 	return (so);
230df8bae1dSRodney W. Grimes }
231df8bae1dSRodney W. Grimes 
232df8bae1dSRodney W. Grimes /*
233df8bae1dSRodney W. Grimes  * Socantsendmore indicates that no more data will be sent on the
234df8bae1dSRodney W. Grimes  * socket; it would normally be applied to a socket when the user
235df8bae1dSRodney W. Grimes  * informs the system that no more data is to be sent, by the protocol
236df8bae1dSRodney W. Grimes  * code (in case PRU_SHUTDOWN).  Socantrcvmore indicates that no more data
237df8bae1dSRodney W. Grimes  * will be received, and will normally be applied to the socket by a
238df8bae1dSRodney W. Grimes  * protocol when it detects that the peer will send no more data.
239df8bae1dSRodney W. Grimes  * Data queued for reading in the socket may yet be read.
240df8bae1dSRodney W. Grimes  */
241df8bae1dSRodney W. Grimes 
24226f9a767SRodney W. Grimes void
243df8bae1dSRodney W. Grimes socantsendmore(so)
244df8bae1dSRodney W. Grimes 	struct socket *so;
245df8bae1dSRodney W. Grimes {
246df8bae1dSRodney W. Grimes 
247df8bae1dSRodney W. Grimes 	so->so_state |= SS_CANTSENDMORE;
24803e49181SSeigo Tanimura 	sowwakeup(so);
249df8bae1dSRodney W. Grimes }
250df8bae1dSRodney W. Grimes 
25126f9a767SRodney W. Grimes void
252df8bae1dSRodney W. Grimes socantrcvmore(so)
253df8bae1dSRodney W. Grimes 	struct socket *so;
254df8bae1dSRodney W. Grimes {
255df8bae1dSRodney W. Grimes 
256df8bae1dSRodney W. Grimes 	so->so_state |= SS_CANTRCVMORE;
25703e49181SSeigo Tanimura 	sorwakeup(so);
258df8bae1dSRodney W. Grimes }
259df8bae1dSRodney W. Grimes 
260df8bae1dSRodney W. Grimes /*
261df8bae1dSRodney W. Grimes  * Wait for data to arrive at/drain from a socket buffer.
262df8bae1dSRodney W. Grimes  */
26326f9a767SRodney W. Grimes int
264df8bae1dSRodney W. Grimes sbwait(sb)
265df8bae1dSRodney W. Grimes 	struct sockbuf *sb;
266df8bae1dSRodney W. Grimes {
267df8bae1dSRodney W. Grimes 
268df8bae1dSRodney W. Grimes 	sb->sb_flags |= SB_WAIT;
26980208239SAlfred Perlstein 	return (tsleep(&sb->sb_cc,
27047daf5d5SBruce Evans 	    (sb->sb_flags & SB_NOINTR) ? PSOCK : PSOCK | PCATCH, "sbwait",
271df8bae1dSRodney W. Grimes 	    sb->sb_timeo));
272df8bae1dSRodney W. Grimes }
273df8bae1dSRodney W. Grimes 
274df8bae1dSRodney W. Grimes /*
275df8bae1dSRodney W. Grimes  * Lock a sockbuf already known to be locked;
276df8bae1dSRodney W. Grimes  * return any error returned from sleep (EINTR).
277df8bae1dSRodney W. Grimes  */
27826f9a767SRodney W. Grimes int
279df8bae1dSRodney W. Grimes sb_lock(sb)
280df8bae1dSRodney W. Grimes 	register struct sockbuf *sb;
281df8bae1dSRodney W. Grimes {
282df8bae1dSRodney W. Grimes 	int error;
283df8bae1dSRodney W. Grimes 
284df8bae1dSRodney W. Grimes 	while (sb->sb_flags & SB_LOCK) {
285df8bae1dSRodney W. Grimes 		sb->sb_flags |= SB_WANT;
28680208239SAlfred Perlstein 		error = tsleep(&sb->sb_flags,
287df8bae1dSRodney W. Grimes 		    (sb->sb_flags & SB_NOINTR) ? PSOCK : PSOCK|PCATCH,
28847daf5d5SBruce Evans 		    "sblock", 0);
289797f2d22SPoul-Henning Kamp 		if (error)
290df8bae1dSRodney W. Grimes 			return (error);
291df8bae1dSRodney W. Grimes 	}
292df8bae1dSRodney W. Grimes 	sb->sb_flags |= SB_LOCK;
293df8bae1dSRodney W. Grimes 	return (0);
294df8bae1dSRodney W. Grimes }
295df8bae1dSRodney W. Grimes 
296df8bae1dSRodney W. Grimes /*
297df8bae1dSRodney W. Grimes  * Wakeup processes waiting on a socket buffer.
298df8bae1dSRodney W. Grimes  * Do asynchronous notification via SIGIO
299df8bae1dSRodney W. Grimes  * if the socket has the SS_ASYNC flag set.
300df8bae1dSRodney W. Grimes  */
30126f9a767SRodney W. Grimes void
302df8bae1dSRodney W. Grimes sowakeup(so, sb)
303df8bae1dSRodney W. Grimes 	register struct socket *so;
304df8bae1dSRodney W. Grimes 	register struct sockbuf *sb;
305df8bae1dSRodney W. Grimes {
306d48d4b25SSeigo Tanimura 
307df8bae1dSRodney W. Grimes 	selwakeup(&sb->sb_sel);
308df8bae1dSRodney W. Grimes 	sb->sb_flags &= ~SB_SEL;
309df8bae1dSRodney W. Grimes 	if (sb->sb_flags & SB_WAIT) {
310df8bae1dSRodney W. Grimes 		sb->sb_flags &= ~SB_WAIT;
31180208239SAlfred Perlstein 		wakeup(&sb->sb_cc);
312df8bae1dSRodney W. Grimes 	}
3134cc20ab1SSeigo Tanimura 	if ((so->so_state & SS_ASYNC) && so->so_sigio != NULL)
314f1320723SAlfred Perlstein 		pgsigio(&so->so_sigio, SIGIO, 0);
3154cc20ab1SSeigo Tanimura 	if (sb->sb_flags & SB_UPCALL)
3164dc75870SPeter Wemm 		(*so->so_upcall)(so, so->so_upcallarg, M_DONTWAIT);
3174cc20ab1SSeigo Tanimura 	if (sb->sb_flags & SB_AIO)
318bfbbc4aaSJason Evans 		aio_swake(so, sb);
319cb679c38SJonathan Lemon 	KNOTE(&sb->sb_sel.si_note, 0);
320df8bae1dSRodney W. Grimes }
321df8bae1dSRodney W. Grimes 
322df8bae1dSRodney W. Grimes /*
323df8bae1dSRodney W. Grimes  * Socket buffer (struct sockbuf) utility routines.
324df8bae1dSRodney W. Grimes  *
325df8bae1dSRodney W. Grimes  * Each socket contains two socket buffers: one for sending data and
326df8bae1dSRodney W. Grimes  * one for receiving data.  Each buffer contains a queue of mbufs,
327df8bae1dSRodney W. Grimes  * information about the number of mbufs and amount of data in the
328df8bae1dSRodney W. Grimes  * queue, and other fields allowing select() statements and notification
329df8bae1dSRodney W. Grimes  * on data availability to be implemented.
330df8bae1dSRodney W. Grimes  *
331df8bae1dSRodney W. Grimes  * Data stored in a socket buffer is maintained as a list of records.
332df8bae1dSRodney W. Grimes  * Each record is a list of mbufs chained together with the m_next
333df8bae1dSRodney W. Grimes  * field.  Records are chained together with the m_nextpkt field. The upper
334df8bae1dSRodney W. Grimes  * level routine soreceive() expects the following conventions to be
335df8bae1dSRodney W. Grimes  * observed when placing information in the receive buffer:
336df8bae1dSRodney W. Grimes  *
337df8bae1dSRodney W. Grimes  * 1. If the protocol requires each message be preceded by the sender's
338df8bae1dSRodney W. Grimes  *    name, then a record containing that name must be present before
339df8bae1dSRodney W. Grimes  *    any associated data (mbuf's must be of type MT_SONAME).
340df8bae1dSRodney W. Grimes  * 2. If the protocol supports the exchange of ``access rights'' (really
341df8bae1dSRodney W. Grimes  *    just additional data associated with the message), and there are
342df8bae1dSRodney W. Grimes  *    ``rights'' to be received, then a record containing this data
343df8bae1dSRodney W. Grimes  *    should be present (mbuf's must be of type MT_RIGHTS).
344df8bae1dSRodney W. Grimes  * 3. If a name or rights record exists, then it must be followed by
345df8bae1dSRodney W. Grimes  *    a data record, perhaps of zero length.
346df8bae1dSRodney W. Grimes  *
347df8bae1dSRodney W. Grimes  * Before using a new socket structure it is first necessary to reserve
348df8bae1dSRodney W. Grimes  * buffer space to the socket, by calling sbreserve().  This should commit
349df8bae1dSRodney W. Grimes  * some of the available buffer space in the system buffer pool for the
350df8bae1dSRodney W. Grimes  * socket (currently, it does nothing but enforce limits).  The space
351df8bae1dSRodney W. Grimes  * should be released by calling sbrelease() when the socket is destroyed.
352df8bae1dSRodney W. Grimes  */
353df8bae1dSRodney W. Grimes 
35426f9a767SRodney W. Grimes int
355df8bae1dSRodney W. Grimes soreserve(so, sndcc, rcvcc)
356df8bae1dSRodney W. Grimes 	register struct socket *so;
357df8bae1dSRodney W. Grimes 	u_long sndcc, rcvcc;
358df8bae1dSRodney W. Grimes {
359b40ce416SJulian Elischer 	struct thread *td = curthread;
360df8bae1dSRodney W. Grimes 
361b40ce416SJulian Elischer 	if (sbreserve(&so->so_snd, sndcc, so, td) == 0)
362df8bae1dSRodney W. Grimes 		goto bad;
363b40ce416SJulian Elischer 	if (sbreserve(&so->so_rcv, rcvcc, so, td) == 0)
364df8bae1dSRodney W. Grimes 		goto bad2;
365df8bae1dSRodney W. Grimes 	if (so->so_rcv.sb_lowat == 0)
366df8bae1dSRodney W. Grimes 		so->so_rcv.sb_lowat = 1;
367df8bae1dSRodney W. Grimes 	if (so->so_snd.sb_lowat == 0)
368df8bae1dSRodney W. Grimes 		so->so_snd.sb_lowat = MCLBYTES;
369df8bae1dSRodney W. Grimes 	if (so->so_snd.sb_lowat > so->so_snd.sb_hiwat)
370df8bae1dSRodney W. Grimes 		so->so_snd.sb_lowat = so->so_snd.sb_hiwat;
371df8bae1dSRodney W. Grimes 	return (0);
372df8bae1dSRodney W. Grimes bad2:
373ecf72308SBrian Feldman 	sbrelease(&so->so_snd, so);
374df8bae1dSRodney W. Grimes bad:
375df8bae1dSRodney W. Grimes 	return (ENOBUFS);
376df8bae1dSRodney W. Grimes }
377df8bae1dSRodney W. Grimes 
378df8bae1dSRodney W. Grimes /*
379df8bae1dSRodney W. Grimes  * Allot mbufs to a sockbuf.
380df8bae1dSRodney W. Grimes  * Attempt to scale mbmax so that mbcnt doesn't become limiting
381df8bae1dSRodney W. Grimes  * if buffering efficiency is near the normal case.
382df8bae1dSRodney W. Grimes  */
38326f9a767SRodney W. Grimes int
384b40ce416SJulian Elischer sbreserve(sb, cc, so, td)
385df8bae1dSRodney W. Grimes 	struct sockbuf *sb;
386df8bae1dSRodney W. Grimes 	u_long cc;
387ecf72308SBrian Feldman 	struct socket *so;
388b40ce416SJulian Elischer 	struct thread *td;
389df8bae1dSRodney W. Grimes {
390ecf72308SBrian Feldman 
391ecf72308SBrian Feldman 	/*
392b40ce416SJulian Elischer 	 * td will only be NULL when we're in an interrupt
393ecf72308SBrian Feldman 	 * (e.g. in tcp_input())
394ecf72308SBrian Feldman 	 */
3959f5193caSMike Silbersack 	if ((u_quad_t)cc > (u_quad_t)sb_max * MCLBYTES / (MSIZE + MCLBYTES))
396df8bae1dSRodney W. Grimes 		return (0);
397f535380cSDon Lewis 	if (!chgsbsize(so->so_cred->cr_uidinfo, &sb->sb_hiwat, cc,
398b40ce416SJulian Elischer 	    td ? td->td_proc->p_rlimit[RLIMIT_SBSIZE].rlim_cur : RLIM_INFINITY)) {
399ecf72308SBrian Feldman 		return (0);
400c6362551SAlfred Perlstein 	}
4014b29bc4fSGarrett Wollman 	sb->sb_mbmax = min(cc * sb_efficiency, sb_max);
402df8bae1dSRodney W. Grimes 	if (sb->sb_lowat > sb->sb_hiwat)
403df8bae1dSRodney W. Grimes 		sb->sb_lowat = sb->sb_hiwat;
404df8bae1dSRodney W. Grimes 	return (1);
405df8bae1dSRodney W. Grimes }
406df8bae1dSRodney W. Grimes 
407df8bae1dSRodney W. Grimes /*
408df8bae1dSRodney W. Grimes  * Free mbufs held by a socket, and reserved mbuf space.
409df8bae1dSRodney W. Grimes  */
41026f9a767SRodney W. Grimes void
411ecf72308SBrian Feldman sbrelease(sb, so)
412df8bae1dSRodney W. Grimes 	struct sockbuf *sb;
413ecf72308SBrian Feldman 	struct socket *so;
414df8bae1dSRodney W. Grimes {
415df8bae1dSRodney W. Grimes 
416df8bae1dSRodney W. Grimes 	sbflush(sb);
417f535380cSDon Lewis 	(void)chgsbsize(so->so_cred->cr_uidinfo, &sb->sb_hiwat, 0,
418f535380cSDon Lewis 	    RLIM_INFINITY);
4196aef685fSBrian Feldman 	sb->sb_mbmax = 0;
420df8bae1dSRodney W. Grimes }
421df8bae1dSRodney W. Grimes 
422df8bae1dSRodney W. Grimes /*
423df8bae1dSRodney W. Grimes  * Routines to add and remove
424df8bae1dSRodney W. Grimes  * data from an mbuf queue.
425df8bae1dSRodney W. Grimes  *
426df8bae1dSRodney W. Grimes  * The routines sbappend() or sbappendrecord() are normally called to
427df8bae1dSRodney W. Grimes  * append new mbufs to a socket buffer, after checking that adequate
428df8bae1dSRodney W. Grimes  * space is available, comparing the function sbspace() with the amount
429df8bae1dSRodney W. Grimes  * of data to be added.  sbappendrecord() differs from sbappend() in
430df8bae1dSRodney W. Grimes  * that data supplied is treated as the beginning of a new record.
431df8bae1dSRodney W. Grimes  * To place a sender's address, optional access rights, and data in a
432df8bae1dSRodney W. Grimes  * socket receive buffer, sbappendaddr() should be used.  To place
433df8bae1dSRodney W. Grimes  * access rights and data in a socket receive buffer, sbappendrights()
434df8bae1dSRodney W. Grimes  * should be used.  In either case, the new data begins a new record.
435df8bae1dSRodney W. Grimes  * Note that unlike sbappend() and sbappendrecord(), these routines check
436df8bae1dSRodney W. Grimes  * for the caller that there will be enough space to store the data.
437df8bae1dSRodney W. Grimes  * Each fails if there is not enough space, or if it cannot find mbufs
438df8bae1dSRodney W. Grimes  * to store additional information in.
439df8bae1dSRodney W. Grimes  *
440df8bae1dSRodney W. Grimes  * Reliable protocols may use the socket send buffer to hold data
441df8bae1dSRodney W. Grimes  * awaiting acknowledgement.  Data is normally copied from a socket
442df8bae1dSRodney W. Grimes  * send buffer in a protocol with m_copy for output to a peer,
443df8bae1dSRodney W. Grimes  * and then removing the data from the socket buffer with sbdrop()
444df8bae1dSRodney W. Grimes  * or sbdroprecord() when the data is acknowledged by the peer.
445df8bae1dSRodney W. Grimes  */
446df8bae1dSRodney W. Grimes 
447df8bae1dSRodney W. Grimes /*
448df8bae1dSRodney W. Grimes  * Append mbuf chain m to the last record in the
449df8bae1dSRodney W. Grimes  * socket buffer sb.  The additional space associated
450df8bae1dSRodney W. Grimes  * the mbuf chain is recorded in sb.  Empty mbufs are
451df8bae1dSRodney W. Grimes  * discarded and mbufs are compacted where possible.
452df8bae1dSRodney W. Grimes  */
45326f9a767SRodney W. Grimes void
454df8bae1dSRodney W. Grimes sbappend(sb, m)
455df8bae1dSRodney W. Grimes 	struct sockbuf *sb;
456df8bae1dSRodney W. Grimes 	struct mbuf *m;
457df8bae1dSRodney W. Grimes {
458df8bae1dSRodney W. Grimes 	register struct mbuf *n;
459df8bae1dSRodney W. Grimes 
460df8bae1dSRodney W. Grimes 	if (m == 0)
461df8bae1dSRodney W. Grimes 		return;
462797f2d22SPoul-Henning Kamp 	n = sb->sb_mb;
463797f2d22SPoul-Henning Kamp 	if (n) {
464df8bae1dSRodney W. Grimes 		while (n->m_nextpkt)
465df8bae1dSRodney W. Grimes 			n = n->m_nextpkt;
466df8bae1dSRodney W. Grimes 		do {
467df8bae1dSRodney W. Grimes 			if (n->m_flags & M_EOR) {
468df8bae1dSRodney W. Grimes 				sbappendrecord(sb, m); /* XXXXXX!!!! */
469df8bae1dSRodney W. Grimes 				return;
470df8bae1dSRodney W. Grimes 			}
471df8bae1dSRodney W. Grimes 		} while (n->m_next && (n = n->m_next));
472df8bae1dSRodney W. Grimes 	}
473df8bae1dSRodney W. Grimes 	sbcompress(sb, m, n);
474df8bae1dSRodney W. Grimes }
475df8bae1dSRodney W. Grimes 
476df8bae1dSRodney W. Grimes #ifdef SOCKBUF_DEBUG
47726f9a767SRodney W. Grimes void
478df8bae1dSRodney W. Grimes sbcheck(sb)
479df8bae1dSRodney W. Grimes 	register struct sockbuf *sb;
480df8bae1dSRodney W. Grimes {
481df8bae1dSRodney W. Grimes 	register struct mbuf *m;
4820931333fSBill Fenner 	register struct mbuf *n = 0;
4830931333fSBill Fenner 	register u_long len = 0, mbcnt = 0;
484df8bae1dSRodney W. Grimes 
4850931333fSBill Fenner 	for (m = sb->sb_mb; m; m = n) {
4860931333fSBill Fenner 	    n = m->m_nextpkt;
4870931333fSBill Fenner 	    for (; m; m = m->m_next) {
488df8bae1dSRodney W. Grimes 		len += m->m_len;
489df8bae1dSRodney W. Grimes 		mbcnt += MSIZE;
490313861b8SJulian Elischer 		if (m->m_flags & M_EXT) /*XXX*/ /* pretty sure this is bogus */
491df8bae1dSRodney W. Grimes 			mbcnt += m->m_ext.ext_size;
4920931333fSBill Fenner 	    }
493df8bae1dSRodney W. Grimes 	}
494df8bae1dSRodney W. Grimes 	if (len != sb->sb_cc || mbcnt != sb->sb_mbcnt) {
4950931333fSBill Fenner 		printf("cc %ld != %ld || mbcnt %ld != %ld\n", len, sb->sb_cc,
496df8bae1dSRodney W. Grimes 		    mbcnt, sb->sb_mbcnt);
497df8bae1dSRodney W. Grimes 		panic("sbcheck");
498df8bae1dSRodney W. Grimes 	}
499df8bae1dSRodney W. Grimes }
500df8bae1dSRodney W. Grimes #endif
501df8bae1dSRodney W. Grimes 
502df8bae1dSRodney W. Grimes /*
503df8bae1dSRodney W. Grimes  * As above, except the mbuf chain
504df8bae1dSRodney W. Grimes  * begins a new record.
505df8bae1dSRodney W. Grimes  */
50626f9a767SRodney W. Grimes void
507df8bae1dSRodney W. Grimes sbappendrecord(sb, m0)
508df8bae1dSRodney W. Grimes 	register struct sockbuf *sb;
509df8bae1dSRodney W. Grimes 	register struct mbuf *m0;
510df8bae1dSRodney W. Grimes {
511df8bae1dSRodney W. Grimes 	register struct mbuf *m;
512df8bae1dSRodney W. Grimes 
513df8bae1dSRodney W. Grimes 	if (m0 == 0)
514df8bae1dSRodney W. Grimes 		return;
515797f2d22SPoul-Henning Kamp 	m = sb->sb_mb;
516797f2d22SPoul-Henning Kamp 	if (m)
517df8bae1dSRodney W. Grimes 		while (m->m_nextpkt)
518df8bae1dSRodney W. Grimes 			m = m->m_nextpkt;
519df8bae1dSRodney W. Grimes 	/*
520df8bae1dSRodney W. Grimes 	 * Put the first mbuf on the queue.
521df8bae1dSRodney W. Grimes 	 * Note this permits zero length records.
522df8bae1dSRodney W. Grimes 	 */
523df8bae1dSRodney W. Grimes 	sballoc(sb, m0);
524df8bae1dSRodney W. Grimes 	if (m)
525df8bae1dSRodney W. Grimes 		m->m_nextpkt = m0;
526df8bae1dSRodney W. Grimes 	else
527df8bae1dSRodney W. Grimes 		sb->sb_mb = m0;
528df8bae1dSRodney W. Grimes 	m = m0->m_next;
529df8bae1dSRodney W. Grimes 	m0->m_next = 0;
530df8bae1dSRodney W. Grimes 	if (m && (m0->m_flags & M_EOR)) {
531df8bae1dSRodney W. Grimes 		m0->m_flags &= ~M_EOR;
532df8bae1dSRodney W. Grimes 		m->m_flags |= M_EOR;
533df8bae1dSRodney W. Grimes 	}
534df8bae1dSRodney W. Grimes 	sbcompress(sb, m, m0);
535df8bae1dSRodney W. Grimes }
536df8bae1dSRodney W. Grimes 
537df8bae1dSRodney W. Grimes /*
538df8bae1dSRodney W. Grimes  * As above except that OOB data
539df8bae1dSRodney W. Grimes  * is inserted at the beginning of the sockbuf,
540df8bae1dSRodney W. Grimes  * but after any other OOB data.
541df8bae1dSRodney W. Grimes  */
54226f9a767SRodney W. Grimes void
543df8bae1dSRodney W. Grimes sbinsertoob(sb, m0)
544df8bae1dSRodney W. Grimes 	register struct sockbuf *sb;
545df8bae1dSRodney W. Grimes 	register struct mbuf *m0;
546df8bae1dSRodney W. Grimes {
547df8bae1dSRodney W. Grimes 	register struct mbuf *m;
548df8bae1dSRodney W. Grimes 	register struct mbuf **mp;
549df8bae1dSRodney W. Grimes 
550df8bae1dSRodney W. Grimes 	if (m0 == 0)
551df8bae1dSRodney W. Grimes 		return;
552797f2d22SPoul-Henning Kamp 	for (mp = &sb->sb_mb; *mp ; mp = &((*mp)->m_nextpkt)) {
553797f2d22SPoul-Henning Kamp 	    m = *mp;
554df8bae1dSRodney W. Grimes 	    again:
555df8bae1dSRodney W. Grimes 		switch (m->m_type) {
556df8bae1dSRodney W. Grimes 
557df8bae1dSRodney W. Grimes 		case MT_OOBDATA:
558df8bae1dSRodney W. Grimes 			continue;		/* WANT next train */
559df8bae1dSRodney W. Grimes 
560df8bae1dSRodney W. Grimes 		case MT_CONTROL:
561797f2d22SPoul-Henning Kamp 			m = m->m_next;
562797f2d22SPoul-Henning Kamp 			if (m)
563df8bae1dSRodney W. Grimes 				goto again;	/* inspect THIS train further */
564df8bae1dSRodney W. Grimes 		}
565df8bae1dSRodney W. Grimes 		break;
566df8bae1dSRodney W. Grimes 	}
567df8bae1dSRodney W. Grimes 	/*
568df8bae1dSRodney W. Grimes 	 * Put the first mbuf on the queue.
569df8bae1dSRodney W. Grimes 	 * Note this permits zero length records.
570df8bae1dSRodney W. Grimes 	 */
571df8bae1dSRodney W. Grimes 	sballoc(sb, m0);
572df8bae1dSRodney W. Grimes 	m0->m_nextpkt = *mp;
573df8bae1dSRodney W. Grimes 	*mp = m0;
574df8bae1dSRodney W. Grimes 	m = m0->m_next;
575df8bae1dSRodney W. Grimes 	m0->m_next = 0;
576df8bae1dSRodney W. Grimes 	if (m && (m0->m_flags & M_EOR)) {
577df8bae1dSRodney W. Grimes 		m0->m_flags &= ~M_EOR;
578df8bae1dSRodney W. Grimes 		m->m_flags |= M_EOR;
579df8bae1dSRodney W. Grimes 	}
580df8bae1dSRodney W. Grimes 	sbcompress(sb, m, m0);
581df8bae1dSRodney W. Grimes }
582df8bae1dSRodney W. Grimes 
583df8bae1dSRodney W. Grimes /*
584df8bae1dSRodney W. Grimes  * Append address and data, and optionally, control (ancillary) data
585df8bae1dSRodney W. Grimes  * to the receive queue of a socket.  If present,
586df8bae1dSRodney W. Grimes  * m0 must include a packet header with total length.
587df8bae1dSRodney W. Grimes  * Returns 0 if no space in sockbuf or insufficient mbufs.
588df8bae1dSRodney W. Grimes  */
58926f9a767SRodney W. Grimes int
590df8bae1dSRodney W. Grimes sbappendaddr(sb, asa, m0, control)
591df8bae1dSRodney W. Grimes 	register struct sockbuf *sb;
592df8bae1dSRodney W. Grimes 	struct sockaddr *asa;
593df8bae1dSRodney W. Grimes 	struct mbuf *m0, *control;
594df8bae1dSRodney W. Grimes {
595df8bae1dSRodney W. Grimes 	register struct mbuf *m, *n;
596df8bae1dSRodney W. Grimes 	int space = asa->sa_len;
597df8bae1dSRodney W. Grimes 
598df8bae1dSRodney W. Grimes 	if (m0 && (m0->m_flags & M_PKTHDR) == 0)
599df8bae1dSRodney W. Grimes 		panic("sbappendaddr");
600df8bae1dSRodney W. Grimes 	if (m0)
601df8bae1dSRodney W. Grimes 		space += m0->m_pkthdr.len;
602df8bae1dSRodney W. Grimes 	for (n = control; n; n = n->m_next) {
603df8bae1dSRodney W. Grimes 		space += n->m_len;
604df8bae1dSRodney W. Grimes 		if (n->m_next == 0)	/* keep pointer to last control buf */
605df8bae1dSRodney W. Grimes 			break;
606df8bae1dSRodney W. Grimes 	}
607df8bae1dSRodney W. Grimes 	if (space > sbspace(sb))
608df8bae1dSRodney W. Grimes 		return (0);
609df8bae1dSRodney W. Grimes 	if (asa->sa_len > MLEN)
610df8bae1dSRodney W. Grimes 		return (0);
611df8bae1dSRodney W. Grimes 	MGET(m, M_DONTWAIT, MT_SONAME);
612df8bae1dSRodney W. Grimes 	if (m == 0)
613df8bae1dSRodney W. Grimes 		return (0);
614df8bae1dSRodney W. Grimes 	m->m_len = asa->sa_len;
61580208239SAlfred Perlstein 	bcopy(asa, mtod(m, caddr_t), asa->sa_len);
616df8bae1dSRodney W. Grimes 	if (n)
617df8bae1dSRodney W. Grimes 		n->m_next = m0;		/* concatenate data to control */
618df8bae1dSRodney W. Grimes 	else
619df8bae1dSRodney W. Grimes 		control = m0;
620df8bae1dSRodney W. Grimes 	m->m_next = control;
621df8bae1dSRodney W. Grimes 	for (n = m; n; n = n->m_next)
622df8bae1dSRodney W. Grimes 		sballoc(sb, n);
623797f2d22SPoul-Henning Kamp 	n = sb->sb_mb;
624797f2d22SPoul-Henning Kamp 	if (n) {
625df8bae1dSRodney W. Grimes 		while (n->m_nextpkt)
626df8bae1dSRodney W. Grimes 			n = n->m_nextpkt;
627df8bae1dSRodney W. Grimes 		n->m_nextpkt = m;
628df8bae1dSRodney W. Grimes 	} else
629df8bae1dSRodney W. Grimes 		sb->sb_mb = m;
630df8bae1dSRodney W. Grimes 	return (1);
631df8bae1dSRodney W. Grimes }
632df8bae1dSRodney W. Grimes 
63326f9a767SRodney W. Grimes int
634df8bae1dSRodney W. Grimes sbappendcontrol(sb, m0, control)
635df8bae1dSRodney W. Grimes 	struct sockbuf *sb;
636df8bae1dSRodney W. Grimes 	struct mbuf *control, *m0;
637df8bae1dSRodney W. Grimes {
638df8bae1dSRodney W. Grimes 	register struct mbuf *m, *n;
639df8bae1dSRodney W. Grimes 	int space = 0;
640df8bae1dSRodney W. Grimes 
641df8bae1dSRodney W. Grimes 	if (control == 0)
642df8bae1dSRodney W. Grimes 		panic("sbappendcontrol");
643df8bae1dSRodney W. Grimes 	for (m = control; ; m = m->m_next) {
644df8bae1dSRodney W. Grimes 		space += m->m_len;
645df8bae1dSRodney W. Grimes 		if (m->m_next == 0)
646df8bae1dSRodney W. Grimes 			break;
647df8bae1dSRodney W. Grimes 	}
648df8bae1dSRodney W. Grimes 	n = m;			/* save pointer to last control buffer */
649df8bae1dSRodney W. Grimes 	for (m = m0; m; m = m->m_next)
650df8bae1dSRodney W. Grimes 		space += m->m_len;
651df8bae1dSRodney W. Grimes 	if (space > sbspace(sb))
652df8bae1dSRodney W. Grimes 		return (0);
653df8bae1dSRodney W. Grimes 	n->m_next = m0;			/* concatenate data to control */
654df8bae1dSRodney W. Grimes 	for (m = control; m; m = m->m_next)
655df8bae1dSRodney W. Grimes 		sballoc(sb, m);
656797f2d22SPoul-Henning Kamp 	n = sb->sb_mb;
657797f2d22SPoul-Henning Kamp 	if (n) {
658df8bae1dSRodney W. Grimes 		while (n->m_nextpkt)
659df8bae1dSRodney W. Grimes 			n = n->m_nextpkt;
660df8bae1dSRodney W. Grimes 		n->m_nextpkt = control;
661df8bae1dSRodney W. Grimes 	} else
662df8bae1dSRodney W. Grimes 		sb->sb_mb = control;
663df8bae1dSRodney W. Grimes 	return (1);
664df8bae1dSRodney W. Grimes }
665df8bae1dSRodney W. Grimes 
666df8bae1dSRodney W. Grimes /*
667df8bae1dSRodney W. Grimes  * Compress mbuf chain m into the socket
668df8bae1dSRodney W. Grimes  * buffer sb following mbuf n.  If n
669df8bae1dSRodney W. Grimes  * is null, the buffer is presumed empty.
670df8bae1dSRodney W. Grimes  */
67126f9a767SRodney W. Grimes void
672df8bae1dSRodney W. Grimes sbcompress(sb, m, n)
673df8bae1dSRodney W. Grimes 	register struct sockbuf *sb;
674df8bae1dSRodney W. Grimes 	register struct mbuf *m, *n;
675df8bae1dSRodney W. Grimes {
676df8bae1dSRodney W. Grimes 	register int eor = 0;
677df8bae1dSRodney W. Grimes 	register struct mbuf *o;
678df8bae1dSRodney W. Grimes 
679df8bae1dSRodney W. Grimes 	while (m) {
680df8bae1dSRodney W. Grimes 		eor |= m->m_flags & M_EOR;
681df8bae1dSRodney W. Grimes 		if (m->m_len == 0 &&
682df8bae1dSRodney W. Grimes 		    (eor == 0 ||
683df8bae1dSRodney W. Grimes 		     (((o = m->m_next) || (o = n)) &&
684df8bae1dSRodney W. Grimes 		      o->m_type == m->m_type))) {
685df8bae1dSRodney W. Grimes 			m = m_free(m);
686df8bae1dSRodney W. Grimes 			continue;
687df8bae1dSRodney W. Grimes 		}
68832af0d74SDavid Malone 		if (n && (n->m_flags & M_EOR) == 0 &&
68932af0d74SDavid Malone 		    M_WRITABLE(n) &&
69032af0d74SDavid Malone 		    m->m_len <= MCLBYTES / 4 && /* XXX: Don't copy too much */
69132af0d74SDavid Malone 		    m->m_len <= M_TRAILINGSPACE(n) &&
692df8bae1dSRodney W. Grimes 		    n->m_type == m->m_type) {
693df8bae1dSRodney W. Grimes 			bcopy(mtod(m, caddr_t), mtod(n, caddr_t) + n->m_len,
694df8bae1dSRodney W. Grimes 			    (unsigned)m->m_len);
695df8bae1dSRodney W. Grimes 			n->m_len += m->m_len;
696df8bae1dSRodney W. Grimes 			sb->sb_cc += m->m_len;
697df8bae1dSRodney W. Grimes 			m = m_free(m);
698df8bae1dSRodney W. Grimes 			continue;
699df8bae1dSRodney W. Grimes 		}
700df8bae1dSRodney W. Grimes 		if (n)
701df8bae1dSRodney W. Grimes 			n->m_next = m;
702df8bae1dSRodney W. Grimes 		else
703df8bae1dSRodney W. Grimes 			sb->sb_mb = m;
704df8bae1dSRodney W. Grimes 		sballoc(sb, m);
705df8bae1dSRodney W. Grimes 		n = m;
706df8bae1dSRodney W. Grimes 		m->m_flags &= ~M_EOR;
707df8bae1dSRodney W. Grimes 		m = m->m_next;
708df8bae1dSRodney W. Grimes 		n->m_next = 0;
709df8bae1dSRodney W. Grimes 	}
710df8bae1dSRodney W. Grimes 	if (eor) {
711df8bae1dSRodney W. Grimes 		if (n)
712df8bae1dSRodney W. Grimes 			n->m_flags |= eor;
713df8bae1dSRodney W. Grimes 		else
714df8bae1dSRodney W. Grimes 			printf("semi-panic: sbcompress\n");
715df8bae1dSRodney W. Grimes 	}
716df8bae1dSRodney W. Grimes }
717df8bae1dSRodney W. Grimes 
718df8bae1dSRodney W. Grimes /*
719df8bae1dSRodney W. Grimes  * Free all mbufs in a sockbuf.
720df8bae1dSRodney W. Grimes  * Check that all resources are reclaimed.
721df8bae1dSRodney W. Grimes  */
72226f9a767SRodney W. Grimes void
723df8bae1dSRodney W. Grimes sbflush(sb)
724df8bae1dSRodney W. Grimes 	register struct sockbuf *sb;
725df8bae1dSRodney W. Grimes {
726df8bae1dSRodney W. Grimes 
727df8bae1dSRodney W. Grimes 	if (sb->sb_flags & SB_LOCK)
728253ab668SAndrey A. Chernov 		panic("sbflush: locked");
72923f84772SPierre Beyssac 	while (sb->sb_mbcnt) {
73023f84772SPierre Beyssac 		/*
73123f84772SPierre Beyssac 		 * Don't call sbdrop(sb, 0) if the leading mbuf is non-empty:
73223f84772SPierre Beyssac 		 * we would loop forever. Panic instead.
73323f84772SPierre Beyssac 		 */
73423f84772SPierre Beyssac 		if (!sb->sb_cc && (sb->sb_mb == NULL || sb->sb_mb->m_len))
73523f84772SPierre Beyssac 			break;
736df8bae1dSRodney W. Grimes 		sbdrop(sb, (int)sb->sb_cc);
73723f84772SPierre Beyssac 	}
7380931333fSBill Fenner 	if (sb->sb_cc || sb->sb_mb || sb->sb_mbcnt)
739e25dadb0SRobert Drehmel 		panic("sbflush: cc %u || mb %p || mbcnt %u", sb->sb_cc, (void *)sb->sb_mb, sb->sb_mbcnt);
740df8bae1dSRodney W. Grimes }
741df8bae1dSRodney W. Grimes 
742df8bae1dSRodney W. Grimes /*
743df8bae1dSRodney W. Grimes  * Drop data from (the front of) a sockbuf.
744df8bae1dSRodney W. Grimes  */
74526f9a767SRodney W. Grimes void
746df8bae1dSRodney W. Grimes sbdrop(sb, len)
747df8bae1dSRodney W. Grimes 	register struct sockbuf *sb;
748df8bae1dSRodney W. Grimes 	register int len;
749df8bae1dSRodney W. Grimes {
750ecde8f7cSMatthew Dillon 	register struct mbuf *m;
751df8bae1dSRodney W. Grimes 	struct mbuf *next;
752df8bae1dSRodney W. Grimes 
753df8bae1dSRodney W. Grimes 	next = (m = sb->sb_mb) ? m->m_nextpkt : 0;
754df8bae1dSRodney W. Grimes 	while (len > 0) {
755df8bae1dSRodney W. Grimes 		if (m == 0) {
756df8bae1dSRodney W. Grimes 			if (next == 0)
757df8bae1dSRodney W. Grimes 				panic("sbdrop");
758df8bae1dSRodney W. Grimes 			m = next;
759df8bae1dSRodney W. Grimes 			next = m->m_nextpkt;
760df8bae1dSRodney W. Grimes 			continue;
761df8bae1dSRodney W. Grimes 		}
762df8bae1dSRodney W. Grimes 		if (m->m_len > len) {
763df8bae1dSRodney W. Grimes 			m->m_len -= len;
764df8bae1dSRodney W. Grimes 			m->m_data += len;
765df8bae1dSRodney W. Grimes 			sb->sb_cc -= len;
766df8bae1dSRodney W. Grimes 			break;
767df8bae1dSRodney W. Grimes 		}
768df8bae1dSRodney W. Grimes 		len -= m->m_len;
769df8bae1dSRodney W. Grimes 		sbfree(sb, m);
770ecde8f7cSMatthew Dillon 		m = m_free(m);
771df8bae1dSRodney W. Grimes 	}
772df8bae1dSRodney W. Grimes 	while (m && m->m_len == 0) {
773df8bae1dSRodney W. Grimes 		sbfree(sb, m);
774ecde8f7cSMatthew Dillon 		m = m_free(m);
775df8bae1dSRodney W. Grimes 	}
776df8bae1dSRodney W. Grimes 	if (m) {
777df8bae1dSRodney W. Grimes 		sb->sb_mb = m;
778df8bae1dSRodney W. Grimes 		m->m_nextpkt = next;
779df8bae1dSRodney W. Grimes 	} else
780df8bae1dSRodney W. Grimes 		sb->sb_mb = next;
781df8bae1dSRodney W. Grimes }
782df8bae1dSRodney W. Grimes 
783df8bae1dSRodney W. Grimes /*
784df8bae1dSRodney W. Grimes  * Drop a record off the front of a sockbuf
785df8bae1dSRodney W. Grimes  * and move the next record to the front.
786df8bae1dSRodney W. Grimes  */
78726f9a767SRodney W. Grimes void
788df8bae1dSRodney W. Grimes sbdroprecord(sb)
789df8bae1dSRodney W. Grimes 	register struct sockbuf *sb;
790df8bae1dSRodney W. Grimes {
791ecde8f7cSMatthew Dillon 	register struct mbuf *m;
792df8bae1dSRodney W. Grimes 
793df8bae1dSRodney W. Grimes 	m = sb->sb_mb;
794df8bae1dSRodney W. Grimes 	if (m) {
795df8bae1dSRodney W. Grimes 		sb->sb_mb = m->m_nextpkt;
796df8bae1dSRodney W. Grimes 		do {
797df8bae1dSRodney W. Grimes 			sbfree(sb, m);
798ecde8f7cSMatthew Dillon 			m = m_free(m);
799797f2d22SPoul-Henning Kamp 		} while (m);
800df8bae1dSRodney W. Grimes 	}
801df8bae1dSRodney W. Grimes }
8021e4ad9ceSGarrett Wollman 
80382c23ebaSBill Fenner /*
80482c23ebaSBill Fenner  * Create a "control" mbuf containing the specified data
80582c23ebaSBill Fenner  * with the specified type for presentation on a socket buffer.
80682c23ebaSBill Fenner  */
80782c23ebaSBill Fenner struct mbuf *
80882c23ebaSBill Fenner sbcreatecontrol(p, size, type, level)
80982c23ebaSBill Fenner 	caddr_t p;
81082c23ebaSBill Fenner 	register int size;
81182c23ebaSBill Fenner 	int type, level;
81282c23ebaSBill Fenner {
81382c23ebaSBill Fenner 	register struct cmsghdr *cp;
81482c23ebaSBill Fenner 	struct mbuf *m;
81582c23ebaSBill Fenner 
81659bdd405SDavid Malone 	if (CMSG_SPACE((u_int)size) > MCLBYTES)
8170b97e97cSYoshinobu Inoue 		return ((struct mbuf *) NULL);
81882c23ebaSBill Fenner 	if ((m = m_get(M_DONTWAIT, MT_CONTROL)) == NULL)
81982c23ebaSBill Fenner 		return ((struct mbuf *) NULL);
82059bdd405SDavid Malone 	if (CMSG_SPACE((u_int)size) > MLEN) {
82159bdd405SDavid Malone 		MCLGET(m, M_DONTWAIT);
82259bdd405SDavid Malone 		if ((m->m_flags & M_EXT) == 0) {
82359bdd405SDavid Malone 			m_free(m);
82459bdd405SDavid Malone 			return ((struct mbuf *) NULL);
82559bdd405SDavid Malone 		}
82659bdd405SDavid Malone 	}
82782c23ebaSBill Fenner 	cp = mtod(m, struct cmsghdr *);
82859bdd405SDavid Malone 	m->m_len = 0;
82959bdd405SDavid Malone 	KASSERT(CMSG_SPACE((u_int)size) <= M_TRAILINGSPACE(m),
83059bdd405SDavid Malone 	    ("sbcreatecontrol: short mbuf"));
83159bdd405SDavid Malone 	if (p != NULL)
83282c23ebaSBill Fenner 		(void)memcpy(CMSG_DATA(cp), p, size);
8337d0d8dc3SYoshinobu Inoue 	m->m_len = CMSG_SPACE(size);
8347d0d8dc3SYoshinobu Inoue 	cp->cmsg_len = CMSG_LEN(size);
83582c23ebaSBill Fenner 	cp->cmsg_level = level;
83682c23ebaSBill Fenner 	cp->cmsg_type = type;
83782c23ebaSBill Fenner 	return (m);
83882c23ebaSBill Fenner }
83982c23ebaSBill Fenner 
8401e4ad9ceSGarrett Wollman /*
8412c37256eSGarrett Wollman  * Some routines that return EOPNOTSUPP for entry points that are not
8422c37256eSGarrett Wollman  * supported by a protocol.  Fill in as needed.
8431e4ad9ceSGarrett Wollman  */
8441e4ad9ceSGarrett Wollman int
84557bf258eSGarrett Wollman pru_accept_notsupp(struct socket *so, struct sockaddr **nam)
846d8392c6cSGarrett Wollman {
847d8392c6cSGarrett Wollman 	return EOPNOTSUPP;
848d8392c6cSGarrett Wollman }
849d8392c6cSGarrett Wollman 
850d8392c6cSGarrett Wollman int
851b40ce416SJulian Elischer pru_connect_notsupp(struct socket *so, struct sockaddr *nam, struct thread *td)
8529f907986SPeter Wemm {
8539f907986SPeter Wemm 	return EOPNOTSUPP;
8549f907986SPeter Wemm }
8559f907986SPeter Wemm 
8569f907986SPeter Wemm int
8572c37256eSGarrett Wollman pru_connect2_notsupp(struct socket *so1, struct socket *so2)
8581e4ad9ceSGarrett Wollman {
8592c37256eSGarrett Wollman 	return EOPNOTSUPP;
8601e4ad9ceSGarrett Wollman }
861d8392c6cSGarrett Wollman 
862d8392c6cSGarrett Wollman int
863ecbb00a2SDoug Rabson pru_control_notsupp(struct socket *so, u_long cmd, caddr_t data,
864b40ce416SJulian Elischer 		    struct ifnet *ifp, struct thread *td)
865a29f300eSGarrett Wollman {
866a29f300eSGarrett Wollman 	return EOPNOTSUPP;
867a29f300eSGarrett Wollman }
868a29f300eSGarrett Wollman 
869a29f300eSGarrett Wollman int
870b40ce416SJulian Elischer pru_listen_notsupp(struct socket *so, struct thread *td)
871d8392c6cSGarrett Wollman {
872d8392c6cSGarrett Wollman 	return EOPNOTSUPP;
873d8392c6cSGarrett Wollman }
874d8392c6cSGarrett Wollman 
875d8392c6cSGarrett Wollman int
876d8392c6cSGarrett Wollman pru_rcvd_notsupp(struct socket *so, int flags)
877d8392c6cSGarrett Wollman {
878d8392c6cSGarrett Wollman 	return EOPNOTSUPP;
879d8392c6cSGarrett Wollman }
880d8392c6cSGarrett Wollman 
881d8392c6cSGarrett Wollman int
882d8392c6cSGarrett Wollman pru_rcvoob_notsupp(struct socket *so, struct mbuf *m, int flags)
883d8392c6cSGarrett Wollman {
884d8392c6cSGarrett Wollman 	return EOPNOTSUPP;
885d8392c6cSGarrett Wollman }
886d8392c6cSGarrett Wollman 
887d8392c6cSGarrett Wollman /*
888d8392c6cSGarrett Wollman  * This isn't really a ``null'' operation, but it's the default one
889d8392c6cSGarrett Wollman  * and doesn't do anything destructive.
890d8392c6cSGarrett Wollman  */
891d8392c6cSGarrett Wollman int
892d8392c6cSGarrett Wollman pru_sense_null(struct socket *so, struct stat *sb)
893d8392c6cSGarrett Wollman {
894d8392c6cSGarrett Wollman 	sb->st_blksize = so->so_snd.sb_hiwat;
895d8392c6cSGarrett Wollman 	return 0;
896d8392c6cSGarrett Wollman }
897639acc13SGarrett Wollman 
898639acc13SGarrett Wollman /*
89957bf258eSGarrett Wollman  * Make a copy of a sockaddr in a malloced buffer of type M_SONAME.
90057bf258eSGarrett Wollman  */
90157bf258eSGarrett Wollman struct sockaddr *
90257bf258eSGarrett Wollman dup_sockaddr(sa, canwait)
90357bf258eSGarrett Wollman 	struct sockaddr *sa;
90457bf258eSGarrett Wollman 	int canwait;
90557bf258eSGarrett Wollman {
90657bf258eSGarrett Wollman 	struct sockaddr *sa2;
90757bf258eSGarrett Wollman 
90857bf258eSGarrett Wollman 	MALLOC(sa2, struct sockaddr *, sa->sa_len, M_SONAME,
90957bf258eSGarrett Wollman 	       canwait ? M_WAITOK : M_NOWAIT);
91057bf258eSGarrett Wollman 	if (sa2)
91157bf258eSGarrett Wollman 		bcopy(sa, sa2, sa->sa_len);
91257bf258eSGarrett Wollman 	return sa2;
91357bf258eSGarrett Wollman }
91457bf258eSGarrett Wollman 
91557bf258eSGarrett Wollman /*
91698271db4SGarrett Wollman  * Create an external-format (``xsocket'') structure using the information
91798271db4SGarrett Wollman  * in the kernel-format socket structure pointed to by so.  This is done
91898271db4SGarrett Wollman  * to reduce the spew of irrelevant information over this interface,
91998271db4SGarrett Wollman  * to isolate user code from changes in the kernel structure, and
92098271db4SGarrett Wollman  * potentially to provide information-hiding if we decide that
92198271db4SGarrett Wollman  * some of this information should be hidden from users.
92298271db4SGarrett Wollman  */
92398271db4SGarrett Wollman void
92498271db4SGarrett Wollman sotoxsocket(struct socket *so, struct xsocket *xso)
92598271db4SGarrett Wollman {
92698271db4SGarrett Wollman 	xso->xso_len = sizeof *xso;
92798271db4SGarrett Wollman 	xso->xso_so = so;
92898271db4SGarrett Wollman 	xso->so_type = so->so_type;
92998271db4SGarrett Wollman 	xso->so_options = so->so_options;
93098271db4SGarrett Wollman 	xso->so_linger = so->so_linger;
93198271db4SGarrett Wollman 	xso->so_state = so->so_state;
93298271db4SGarrett Wollman 	xso->so_pcb = so->so_pcb;
93398271db4SGarrett Wollman 	xso->xso_protocol = so->so_proto->pr_protocol;
93498271db4SGarrett Wollman 	xso->xso_family = so->so_proto->pr_domain->dom_family;
93598271db4SGarrett Wollman 	xso->so_qlen = so->so_qlen;
93698271db4SGarrett Wollman 	xso->so_incqlen = so->so_incqlen;
93798271db4SGarrett Wollman 	xso->so_qlimit = so->so_qlimit;
93898271db4SGarrett Wollman 	xso->so_timeo = so->so_timeo;
93998271db4SGarrett Wollman 	xso->so_error = so->so_error;
940831d27a9SDon Lewis 	xso->so_pgid = so->so_sigio ? so->so_sigio->sio_pgid : 0;
94198271db4SGarrett Wollman 	xso->so_oobmark = so->so_oobmark;
94298271db4SGarrett Wollman 	sbtoxsockbuf(&so->so_snd, &xso->so_snd);
94398271db4SGarrett Wollman 	sbtoxsockbuf(&so->so_rcv, &xso->so_rcv);
9442f9a2132SBrian Feldman 	xso->so_uid = so->so_cred->cr_uid;
94598271db4SGarrett Wollman }
94698271db4SGarrett Wollman 
94798271db4SGarrett Wollman /*
94898271db4SGarrett Wollman  * This does the same for sockbufs.  Note that the xsockbuf structure,
94998271db4SGarrett Wollman  * since it is always embedded in a socket, does not include a self
95098271db4SGarrett Wollman  * pointer nor a length.  We make this entry point public in case
95198271db4SGarrett Wollman  * some other mechanism needs it.
95298271db4SGarrett Wollman  */
95398271db4SGarrett Wollman void
95498271db4SGarrett Wollman sbtoxsockbuf(struct sockbuf *sb, struct xsockbuf *xsb)
95598271db4SGarrett Wollman {
95698271db4SGarrett Wollman 	xsb->sb_cc = sb->sb_cc;
95798271db4SGarrett Wollman 	xsb->sb_hiwat = sb->sb_hiwat;
95898271db4SGarrett Wollman 	xsb->sb_mbcnt = sb->sb_mbcnt;
95998271db4SGarrett Wollman 	xsb->sb_mbmax = sb->sb_mbmax;
96098271db4SGarrett Wollman 	xsb->sb_lowat = sb->sb_lowat;
96198271db4SGarrett Wollman 	xsb->sb_flags = sb->sb_flags;
96298271db4SGarrett Wollman 	xsb->sb_timeo = sb->sb_timeo;
96398271db4SGarrett Wollman }
96498271db4SGarrett Wollman 
96598271db4SGarrett Wollman /*
966639acc13SGarrett Wollman  * Here is the definition of some of the basic objects in the kern.ipc
967639acc13SGarrett Wollman  * branch of the MIB.
968639acc13SGarrett Wollman  */
969639acc13SGarrett Wollman SYSCTL_NODE(_kern, KERN_IPC, ipc, CTLFLAG_RW, 0, "IPC");
970639acc13SGarrett Wollman 
971639acc13SGarrett Wollman /* This takes the place of kern.maxsockbuf, which moved to kern.ipc. */
972639acc13SGarrett Wollman static int dummy;
973639acc13SGarrett Wollman SYSCTL_INT(_kern, KERN_DUMMY, dummy, CTLFLAG_RW, &dummy, 0, "");
974639acc13SGarrett Wollman 
9753d177f46SBill Fumerola SYSCTL_INT(_kern_ipc, KIPC_MAXSOCKBUF, maxsockbuf, CTLFLAG_RW,
9763d177f46SBill Fumerola     &sb_max, 0, "Maximum socket buffer size");
97754d77689SJeff Roberson SYSCTL_INT(_kern_ipc, OID_AUTO, maxsockets, CTLFLAG_RD,
97854d77689SJeff Roberson     &maxsockets, 0, "Maximum number of sockets avaliable");
979639acc13SGarrett Wollman SYSCTL_INT(_kern_ipc, KIPC_SOCKBUF_WASTE, sockbuf_waste_factor, CTLFLAG_RW,
980639acc13SGarrett Wollman     &sb_efficiency, 0, "");
98154d77689SJeff Roberson 
98254d77689SJeff Roberson /*
98354d77689SJeff Roberson  * Initialise maxsockets
98454d77689SJeff Roberson  */
98554d77689SJeff Roberson static void init_maxsockets(void *ignored)
98654d77689SJeff Roberson {
98754d77689SJeff Roberson 	TUNABLE_INT_FETCH("kern.ipc.maxsockets", &maxsockets);
98854d77689SJeff Roberson 	maxsockets = imax(maxsockets, imax(maxfiles, nmbclusters));
98954d77689SJeff Roberson }
99054d77689SJeff Roberson SYSINIT(param, SI_SUB_TUNABLES, SI_ORDER_ANY, init_maxsockets, NULL);
991