2 * Copyright (c) 1984, 1985, 1986, 1987, 1993
3 * The Regents of the University of California.
4 * Copyright (c) 2004-2006 Robert N. M. Watson
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
10 * 1. Redistributions of source code must retain the above copyright
11 * notice, this list of conditions and the following disclaimer.
12 * 2. Redistributions in binary form must reproduce the above copyright
13 * notice, this list of conditions and the following disclaimer in the
14 * documentation and/or other materials provided with the distribution.
15 * 4. Neither the name of the University nor the names of its contributors
16 * may be used to endorse or promote products derived from this software
17 * without specific prior written permission.
19 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
20 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
21 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
22 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
23 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
24 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
25 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
26 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
27 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
28 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
31 * Copyright (c) 1995, Mike Mitchell
32 * All rights reserved.
34 * Redistribution and use in source and binary forms, with or without
35 * modification, are permitted provided that the following conditions
37 * 1. Redistributions of source code must retain the above copyright
38 * notice, this list of conditions and the following disclaimer.
39 * 2. Redistributions in binary form must reproduce the above copyright
40 * notice, this list of conditions and the following disclaimer in the
41 * documentation and/or other materials provided with the distribution.
42 * 3. All advertising materials mentioning features or use of this software
43 * must display the following acknowledgement:
44 * This product includes software developed by the University of
45 * California, Berkeley and its contributors.
46 * 4. Neither the name of the University nor the names of its contributors
47 * may be used to endorse or promote products derived from this software
48 * without specific prior written permission.
50 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
51 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
52 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
53 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
54 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
55 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
56 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
57 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
58 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
59 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
65 #include <sys/cdefs.h>
66 __FBSDID("$FreeBSD$");
70 #include <sys/param.h>
71 #include <sys/kernel.h>
75 #include <sys/protosw.h>
76 #include <sys/signalvar.h>
77 #include <sys/socket.h>
78 #include <sys/socketvar.h>
80 #include <sys/sysctl.h>
81 #include <sys/systm.h>
84 #include <net/route.h>
86 #include <netinet/in.h>
88 #include <netipx/ipx.h>
89 #include <netipx/ipx_if.h>
90 #include <netipx/ipx_pcb.h>
91 #include <netipx/ipx_var.h>
93 #include <security/mac/mac_framework.h>
96 * IPX protocol implementation.
99 static int ipxsendspace = IPXSNDQ;
100 SYSCTL_INT(_net_ipx_ipx, OID_AUTO, ipxsendspace, CTLFLAG_RW,
101 &ipxsendspace, 0, "Send buffer space");
102 static int ipxrecvspace = IPXRCVQ;
103 SYSCTL_INT(_net_ipx_ipx, OID_AUTO, ipxrecvspace, CTLFLAG_RW,
104 &ipxrecvspace, 0, "Receive buffer space");
106 static void ipx_usr_abort(struct socket *so);
107 static int ipx_attach(struct socket *so, int proto, struct thread *td);
108 static int ipx_bind(struct socket *so, struct sockaddr *nam, struct thread *td);
109 static int ipx_connect(struct socket *so, struct sockaddr *nam,
111 static void ipx_detach(struct socket *so);
112 static int ipx_disconnect(struct socket *so);
113 static int ipx_send(struct socket *so, int flags, struct mbuf *m,
114 struct sockaddr *addr, struct mbuf *control,
116 static int ipx_shutdown(struct socket *so);
117 static int ripx_attach(struct socket *so, int proto, struct thread *td);
118 static int ipx_output(struct ipxpcb *ipxp, struct mbuf *m0);
119 static void ipx_usr_close(struct socket *so);
121 struct pr_usrreqs ipx_usrreqs = {
122 .pru_abort = ipx_usr_abort,
123 .pru_attach = ipx_attach,
124 .pru_bind = ipx_bind,
125 .pru_connect = ipx_connect,
126 .pru_control = ipx_control,
127 .pru_detach = ipx_detach,
128 .pru_disconnect = ipx_disconnect,
129 .pru_peeraddr = ipx_peeraddr,
130 .pru_send = ipx_send,
131 .pru_shutdown = ipx_shutdown,
132 .pru_sockaddr = ipx_sockaddr,
133 .pru_close = ipx_usr_close,
136 struct pr_usrreqs ripx_usrreqs = {
137 .pru_abort = ipx_usr_abort,
138 .pru_attach = ripx_attach,
139 .pru_bind = ipx_bind,
140 .pru_connect = ipx_connect,
141 .pru_control = ipx_control,
142 .pru_detach = ipx_detach,
143 .pru_disconnect = ipx_disconnect,
144 .pru_peeraddr = ipx_peeraddr,
145 .pru_send = ipx_send,
146 .pru_shutdown = ipx_shutdown,
147 .pru_sockaddr = ipx_sockaddr,
148 .pru_close = ipx_usr_close,
152 * This may also be called for raw listeners.
155 ipx_input(struct mbuf *m, struct ipxpcb *ipxp)
157 struct ipx *ipx = mtod(m, struct ipx *);
158 struct ifnet *ifp = m->m_pkthdr.rcvif;
159 struct sockaddr_ipx ipx_ipx;
161 KASSERT(ipxp != NULL, ("ipx_input: NULL ipxpcb"));
162 IPX_LOCK_ASSERT(ipxp);
164 * Construct sockaddr format source address.
165 * Stuff source address and datagram in user buffer.
167 ipx_ipx.sipx_len = sizeof(ipx_ipx);
168 ipx_ipx.sipx_family = AF_IPX;
169 ipx_ipx.sipx_addr = ipx->ipx_sna;
170 ipx_ipx.sipx_zero[0] = '\0';
171 ipx_ipx.sipx_zero[1] = '\0';
172 if (ipx_neteqnn(ipx->ipx_sna.x_net, ipx_zeronet) && ifp != NULL) {
175 for (ifa = TAILQ_FIRST(&ifp->if_addrhead); ifa != NULL;
176 ifa = TAILQ_NEXT(ifa, ifa_link)) {
177 if (ifa->ifa_addr->sa_family == AF_IPX) {
178 ipx_ipx.sipx_addr.x_net =
179 IA_SIPX(ifa)->sipx_addr.x_net;
184 ipxp->ipxp_rpt = ipx->ipx_pt;
185 if ((ipxp->ipxp_flags & IPXP_RAWIN) == 0) {
186 m->m_len -= sizeof(struct ipx);
187 m->m_pkthdr.len -= sizeof(struct ipx);
188 m->m_data += sizeof(struct ipx);
191 if (mac_socket_check_deliver(ipxp->ipxp_socket, m) != 0) {
196 if (sbappendaddr(&ipxp->ipxp_socket->so_rcv,
197 (struct sockaddr *)&ipx_ipx, m, NULL) == 0)
200 sorwakeup(ipxp->ipxp_socket);
204 * Drop connection, reporting
205 * the specified error.
208 ipx_drop(struct ipxpcb *ipxp, int errno)
210 struct socket *so = ipxp->ipxp_socket;
212 IPX_LIST_LOCK_ASSERT();
213 IPX_LOCK_ASSERT(ipxp);
216 * someday, in the IPX world
217 * we will generate error protocol packets
218 * announcing that the socket has gone away.
220 * XXX Probably never. IPX does not have error packets.
222 /*if (TCPS_HAVERCVDSYN(tp->t_state)) {
223 tp->t_state = TCPS_CLOSED;
226 so->so_error = errno;
227 ipx_pcbdisconnect(ipxp);
228 soisdisconnected(so);
232 ipx_output(struct ipxpcb *ipxp, struct mbuf *m0)
239 struct mbuf *mprev = NULL;
241 IPX_LOCK_ASSERT(ipxp);
244 * Calculate data length.
246 for (m = m0; m != NULL; m = m->m_next) {
251 * Make sure packet is actually of even length.
256 if ((m->m_flags & M_EXT) == 0 &&
257 (m->m_len + m->m_data < &m->m_dat[MLEN])) {
258 mtod(m, char*)[m->m_len++] = 0;
260 struct mbuf *m1 = m_get(M_DONTWAIT, MT_DATA);
267 * mtod(m1, char *) = 0;
274 * Fill in mbuf with extended IPX header
275 * and addresses and length put into network format.
278 if (ipxp->ipxp_flags & IPXP_RAWOUT) {
279 ipx = mtod(m, struct ipx *);
281 M_PREPEND(m, sizeof(struct ipx), M_DONTWAIT);
284 ipx = mtod(m, struct ipx *);
286 ipx->ipx_pt = ipxp->ipxp_dpt;
287 ipx->ipx_sna = ipxp->ipxp_laddr;
288 ipx->ipx_dna = ipxp->ipxp_faddr;
289 len += sizeof(struct ipx);
292 ipx->ipx_len = htons((u_short)len);
294 if (ipxp->ipxp_flags & IPXP_CHECKSUM) {
295 ipx->ipx_sum = ipx_cksum(m, len);
297 ipx->ipx_sum = 0xffff;
302 so = ipxp->ipxp_socket;
303 if (so->so_options & SO_DONTROUTE)
304 return (ipx_outputfl(m, (struct route *)NULL,
305 (so->so_options & SO_BROADCAST) | IPX_ROUTETOIF));
307 * Use cached route for previous datagram if
308 * possible. If the previous net was the same
309 * and the interface was a broadcast medium, or
310 * if the previous destination was identical,
313 * NB: We don't handle broadcasts because that
314 * would require 3 subroutine calls.
316 ro = &ipxp->ipxp_route;
317 #ifdef ancient_history
319 * I think that this will all be handled in ipx_pcbconnect!
321 if (ro->ro_rt != NULL) {
322 if(ipx_neteq(ipxp->ipxp_lastdst, ipx->ipx_dna)) {
324 * This assumes we have no GH type routes
326 if (ro->ro_rt->rt_flags & RTF_HOST) {
327 if (!ipx_hosteq(ipxp->ipxp_lastdst, ipx->ipx_dna))
331 if ((ro->ro_rt->rt_flags & RTF_GATEWAY) == 0) {
332 struct ipx_addr *dst =
333 &satoipx_addr(ro->ro_dst);
334 dst->x_host = ipx->ipx_dna.x_host;
337 * Otherwise, we go through the same gateway
338 * and dst is already set up.
346 ipxp->ipxp_lastdst = ipx->ipx_dna;
347 #endif /* ancient_history */
348 return (ipx_outputfl(m, ro, so->so_options & SO_BROADCAST));
352 ipx_ctloutput(struct socket *so, struct sockopt *sopt)
354 struct ipxpcb *ipxp = sotoipxpcb(so);
355 int mask, error, optval;
360 KASSERT(ipxp != NULL, ("ipx_ctloutput: ipxp == NULL"));
363 switch (sopt->sopt_dir) {
365 switch (sopt->sopt_name) {
367 mask = IPXP_ALL_PACKETS;
370 case SO_HEADERS_ON_INPUT:
374 case SO_IPX_CHECKSUM:
375 mask = IPXP_CHECKSUM;
378 case SO_HEADERS_ON_OUTPUT:
382 soptval = ipxp->ipxp_flags & mask;
383 error = sooptcopyout(sopt, &soptval, sizeof soptval);
386 case SO_DEFAULT_HEADERS:
391 ioptval.ipx_pt = ipxp->ipxp_dpt;
392 ioptval.ipx_dna = ipxp->ipxp_faddr;
393 ioptval.ipx_sna = ipxp->ipxp_laddr;
395 error = sooptcopyout(sopt, &soptval, sizeof soptval);
403 error = sooptcopyout(sopt, &seq, sizeof seq);
412 switch (sopt->sopt_name) {
414 mask = IPXP_ALL_PACKETS;
417 case SO_HEADERS_ON_INPUT:
421 case SO_IPX_CHECKSUM:
422 mask = IPXP_CHECKSUM;
425 case SO_HEADERS_ON_OUTPUT:
428 error = sooptcopyin(sopt, &optval, sizeof optval,
434 ipxp->ipxp_flags |= mask;
436 ipxp->ipxp_flags &= ~mask;
440 case SO_DEFAULT_HEADERS:
441 error = sooptcopyin(sopt, &ioptval, sizeof ioptval,
445 /* Unlocked write. */
446 ipxp->ipxp_dpt = ioptval.ipx_pt;
457 ipx_usr_abort(struct socket *so)
460 /* XXXRW: Possibly ipx_disconnect() here? */
461 soisdisconnected(so);
465 ipx_attach(struct socket *so, int proto, struct thread *td)
468 struct ipxpcb *ipxp = sotoipxpcb(so);
472 KASSERT(ipxp == NULL, ("ipx_attach: ipxp != NULL"));
473 error = soreserve(so, ipxsendspace, ipxrecvspace);
477 error = ipx_pcballoc(so, &ipxpcb_list, td);
483 ipx_bind(struct socket *so, struct sockaddr *nam, struct thread *td)
485 struct ipxpcb *ipxp = sotoipxpcb(so);
488 KASSERT(ipxp != NULL, ("ipx_bind: ipxp == NULL"));
491 error = ipx_pcbbind(ipxp, nam, td);
498 ipx_usr_close(struct socket *so)
501 /* XXXRW: Possibly ipx_disconnect() here? */
502 soisdisconnected(so);
506 ipx_connect(struct socket *so, struct sockaddr *nam, struct thread *td)
508 struct ipxpcb *ipxp = sotoipxpcb(so);
511 KASSERT(ipxp != NULL, ("ipx_connect: ipxp == NULL"));
514 if (!ipx_nullhost(ipxp->ipxp_faddr)) {
518 error = ipx_pcbconnect(ipxp, nam, td);
528 ipx_detach(struct socket *so)
530 struct ipxpcb *ipxp = sotoipxpcb(so);
532 /* XXXRW: Should assert detached. */
533 KASSERT(ipxp != NULL, ("ipx_detach: ipxp == NULL"));
542 ipx_disconnect(struct socket *so)
544 struct ipxpcb *ipxp = sotoipxpcb(so);
547 KASSERT(ipxp != NULL, ("ipx_disconnect: ipxp == NULL"));
551 if (ipx_nullhost(ipxp->ipxp_faddr)) {
555 ipx_pcbdisconnect(ipxp);
556 soisdisconnected(so);
564 ipx_peeraddr(struct socket *so, struct sockaddr **nam)
566 struct ipxpcb *ipxp = sotoipxpcb(so);
568 KASSERT(ipxp != NULL, ("ipx_peeraddr: ipxp == NULL"));
569 ipx_getpeeraddr(ipxp, nam);
574 ipx_send(struct socket *so, int flags, struct mbuf *m, struct sockaddr *nam,
575 struct mbuf *control, struct thread *td)
578 struct ipxpcb *ipxp = sotoipxpcb(so);
579 struct ipx_addr laddr;
581 KASSERT(ipxp != NULL, ("ipxp_send: ipxp == NULL"));
583 * Attempt to only acquire the necessary locks: if the socket is
584 * already connected, we don't need to hold the IPX list lock to be
585 * used by ipx_pcbconnect() and ipx_pcbdisconnect(), just the IPX
589 mac_socket_create_mbuf(so, m);
594 laddr = ipxp->ipxp_laddr;
595 if (!ipx_nullhost(ipxp->ipxp_faddr)) {
602 * Must block input while temporarily connected.
604 error = ipx_pcbconnect(ipxp, nam, td);
612 if (ipx_nullhost(ipxp->ipxp_faddr)) {
618 error = ipx_output(ipxp, m);
621 ipx_pcbdisconnect(ipxp);
622 ipxp->ipxp_laddr = laddr;
639 KASSERT(so->so_pcb != NULL, ("ipx_shutdown: so_pcb == NULL"));
645 ipx_sockaddr(struct socket *so, struct sockaddr **nam)
647 struct ipxpcb *ipxp = sotoipxpcb(so);
649 KASSERT(ipxp != NULL, ("ipx_sockaddr: ipxp == NULL"));
650 ipx_getsockaddr(ipxp, nam);
655 ripx_attach(struct socket *so, int proto, struct thread *td)
658 struct ipxpcb *ipxp = sotoipxpcb(so);
660 KASSERT(ipxp == NULL, ("ripx_attach: ipxp != NULL"));
663 error = priv_check(td, PRIV_NETIPX_RAW);
669 * We hold the IPX list lock for the duration as address parameters
670 * of the IPX pcb are changed. Since no one else holds a reference
671 * to the ipxpcb yet, we don't need the ipxpcb lock here.
674 error = ipx_pcballoc(so, &ipxrawpcb_list, td);
677 ipxp = sotoipxpcb(so);
678 error = soreserve(so, ipxsendspace, ipxrecvspace);
681 ipxp->ipxp_faddr.x_host = ipx_broadhost;
682 ipxp->ipxp_flags = IPXP_RAWIN | IPXP_RAWOUT;