1/*-
2 * SPDX-License-Identifier: BSD-3-Clause
3 *
4 * Copyright (c) 1983, 1988, 1993
5 *	The Regents of the University of California.  All rights reserved.
6 *
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
9 * are met:
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 * 3. 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.
18 *
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
29 * SUCH DAMAGE.
30 */
31
32#if 0
33#ifndef lint
34static char sccsid[] = "@(#)unix.c	8.1 (Berkeley) 6/6/93";
35#endif /* not lint */
36#endif
37
38#include <sys/cdefs.h>
39__FBSDID("$FreeBSD$");
40
41/*
42 * Display protocol blocks in the unix domain.
43 */
44#include <sys/param.h>
45#include <sys/queue.h>
46#include <sys/protosw.h>
47#include <sys/socket.h>
48#define	_WANT_SOCKET
49#include <sys/socketvar.h>
50#include <sys/mbuf.h>
51#include <sys/sysctl.h>
52#include <sys/un.h>
53#define	_WANT_UNPCB
54#include <sys/unpcb.h>
55
56#include <netinet/in.h>
57
58#include <errno.h>
59#include <err.h>
60#include <stddef.h>
61#include <stdint.h>
62#include <stdio.h>
63#include <stdlib.h>
64#include <stdbool.h>
65#include <strings.h>
66#include <kvm.h>
67#include <libxo/xo.h>
68#include "netstat.h"
69
70static	void unixdomainpr(struct xunpcb *, struct xsocket *);
71
72static	const char *const socktype[] =
73    { "#0", "stream", "dgram", "raw", "rdm", "seqpacket" };
74
75static int
76pcblist_sysctl(int type, char **bufp)
77{
78	char 	*buf;
79	size_t	len;
80	char mibvar[sizeof "net.local.seqpacket.pcblist"];
81
82	snprintf(mibvar, sizeof(mibvar), "net.local.%s.pcblist", socktype[type]);
83
84	len = 0;
85	if (sysctlbyname(mibvar, 0, &len, 0, 0) < 0) {
86		if (errno != ENOENT)
87			xo_warn("sysctl: %s", mibvar);
88		return (-1);
89	}
90	if ((buf = malloc(len)) == NULL) {
91		xo_warnx("malloc %lu bytes", (u_long)len);
92		return (-2);
93	}
94	if (sysctlbyname(mibvar, buf, &len, 0, 0) < 0) {
95		xo_warn("sysctl: %s", mibvar);
96		free(buf);
97		return (-2);
98	}
99	*bufp = buf;
100	return (0);
101}
102
103static int
104pcblist_kvm(u_long count_off, u_long gencnt_off, u_long head_off, char **bufp)
105{
106	struct unp_head head;
107	struct unpcb *unp, unp0, unp_conn;
108	u_char sun_len;
109	struct socket so;
110	struct xunpgen xug;
111	struct xunpcb xu;
112	unp_gen_t unp_gencnt;
113	u_int	unp_count;
114	char 	*buf, *p;
115	size_t	len;
116
117	if (count_off == 0 || gencnt_off == 0)
118		return (-2);
119	if (head_off == 0)
120		return (-1);
121	kread(count_off, &unp_count, sizeof(unp_count));
122	len = 2 * sizeof(xug) + (unp_count + unp_count / 8) * sizeof(xu);
123	if ((buf = malloc(len)) == NULL) {
124		xo_warnx("malloc %lu bytes", (u_long)len);
125		return (-2);
126	}
127	p = buf;
128
129#define	COPYOUT(obj, size) do {						\
130	if (len < (size)) {						\
131		xo_warnx("buffer size exceeded");			\
132		goto fail;						\
133	}								\
134	bcopy((obj), p, (size));					\
135	len -= (size);							\
136	p += (size);							\
137} while (0)
138
139#define	KREAD(off, buf, len) do {					\
140	if (kread((uintptr_t)(off), (buf), (len)) != 0)			\
141		goto fail;						\
142} while (0)
143
144	/* Write out header. */
145	kread(gencnt_off, &unp_gencnt, sizeof(unp_gencnt));
146	xug.xug_len = sizeof xug;
147	xug.xug_count = unp_count;
148	xug.xug_gen = unp_gencnt;
149	xug.xug_sogen = 0;
150	COPYOUT(&xug, sizeof xug);
151
152	/* Walk the PCB list. */
153	xu.xu_len = sizeof xu;
154	KREAD(head_off, &head, sizeof(head));
155	LIST_FOREACH(unp, &head, unp_link) {
156		xu.xu_unpp = (uintptr_t)unp;
157		KREAD(unp, &unp0, sizeof (*unp));
158		unp = &unp0;
159
160		if (unp->unp_gencnt > unp_gencnt)
161			continue;
162		if (unp->unp_addr != NULL) {
163			KREAD(unp->unp_addr, &sun_len, sizeof(sun_len));
164			KREAD(unp->unp_addr, &xu.xu_addr, sun_len);
165		}
166		if (unp->unp_conn != NULL) {
167			KREAD(unp->unp_conn, &unp_conn, sizeof(unp_conn));
168			if (unp_conn.unp_addr != NULL) {
169				KREAD(unp_conn.unp_addr, &sun_len,
170				    sizeof(sun_len));
171				KREAD(unp_conn.unp_addr, &xu.xu_caddr, sun_len);
172			}
173		}
174		KREAD(unp->unp_socket, &so, sizeof(so));
175		if (sotoxsocket(&so, &xu.xu_socket) != 0)
176			goto fail;
177		COPYOUT(&xu, sizeof(xu));
178	}
179
180	/* Reread the counts and write the footer. */
181	kread(count_off, &unp_count, sizeof(unp_count));
182	kread(gencnt_off, &unp_gencnt, sizeof(unp_gencnt));
183	xug.xug_count = unp_count;
184	xug.xug_gen = unp_gencnt;
185	COPYOUT(&xug, sizeof xug);
186
187	*bufp = buf;
188	return (0);
189
190fail:
191	free(buf);
192	return (-1);
193#undef COPYOUT
194#undef KREAD
195}
196
197void
198unixpr(u_long count_off, u_long gencnt_off, u_long dhead_off, u_long shead_off,
199    u_long sphead_off, bool *first)
200{
201	char 	*buf;
202	int	ret, type;
203	struct	xsocket *so;
204	struct	xunpgen *xug, *oxug;
205	struct	xunpcb *xunp;
206	u_long	head_off;
207
208	buf = NULL;
209	for (type = SOCK_STREAM; type <= SOCK_SEQPACKET; type++) {
210		if (live)
211			ret = pcblist_sysctl(type, &buf);
212		else {
213			head_off = 0;
214			switch (type) {
215			case SOCK_STREAM:
216				head_off = shead_off;
217				break;
218
219			case SOCK_DGRAM:
220				head_off = dhead_off;
221				break;
222
223			case SOCK_SEQPACKET:
224				head_off = sphead_off;
225				break;
226			}
227			ret = pcblist_kvm(count_off, gencnt_off, head_off,
228			    &buf);
229		}
230		if (ret == -1)
231			continue;
232		if (ret < 0)
233			return;
234
235		oxug = xug = (struct xunpgen *)buf;
236		for (xug = (struct xunpgen *)((char *)xug + xug->xug_len);
237		    xug->xug_len > sizeof(struct xunpgen);
238		    xug = (struct xunpgen *)((char *)xug + xug->xug_len)) {
239			xunp = (struct xunpcb *)xug;
240			so = &xunp->xu_socket;
241
242			/* Ignore PCBs which were freed during copyout. */
243			if (xunp->unp_gencnt > oxug->xug_gen)
244				continue;
245			if (*first) {
246				xo_open_list("socket");
247				*first = false;
248			}
249			xo_open_instance("socket");
250			unixdomainpr(xunp, so);
251			xo_close_instance("socket");
252		}
253		if (xug != oxug && xug->xug_gen != oxug->xug_gen) {
254			if (oxug->xug_count > xug->xug_count) {
255				xo_emit("Some {:type/%s} sockets may have "
256				    "been {:action/deleted}.\n",
257				    socktype[type]);
258			} else if (oxug->xug_count < xug->xug_count) {
259				xo_emit("Some {:type/%s} sockets may have "
260				    "been {:action/created}.\n",
261				    socktype[type]);
262			} else {
263				xo_emit("Some {:type/%s} sockets may have "
264				    "been {:action/created or deleted}",
265				    socktype[type]);
266			}
267		}
268		free(buf);
269	}
270}
271
272static void
273unixdomainpr(struct xunpcb *xunp, struct xsocket *so)
274{
275	struct sockaddr_un *sa;
276	static int first = 1;
277	char buf1[33];
278	static const char *titles[2] = {
279	    "{T:/%-8.8s} {T:/%-6.6s} {T:/%-6.6s} {T:/%-6.6s} {T:/%8.8s} "
280	    "{T:/%8.8s} {T:/%8.8s} {T:/%8.8s} {T:Addr}\n",
281	    "{T:/%-16.16s} {T:/%-6.6s} {T:/%-6.6s} {T:/%-6.6s} {T:/%16.16s} "
282	    "{T:/%16.16s} {T:/%16.16s} {T:/%16.16s} {T:Addr}\n"
283	};
284	static const char *format[2] = {
285	    "{q:address/%8lx} {t:type/%-6.6s} "
286	    "{:receive-bytes-waiting/%6u} "
287	    "{:send-bytes-waiting/%6u} "
288	    "{q:vnode/%8lx} {q:connection/%8lx} "
289	    "{q:first-reference/%8lx} {q:next-reference/%8lx}",
290	    "{q:address/%16lx} {t:type/%-6.6s} "
291	    "{:receive-bytes-waiting/%6u} "
292	    "{:send-bytes-waiting/%6u} "
293	    "{q:vnode/%16lx} {q:connection/%16lx} "
294	    "{q:first-reference/%16lx} {q:next-reference/%16lx}"
295	};
296	int fmt = (sizeof(void *) == 8) ? 1 : 0;
297
298	sa = (xunp->xu_addr.sun_family == AF_UNIX) ? &xunp->xu_addr : NULL;
299
300	if (first && !Lflag) {
301		xo_emit("{T:Active UNIX domain sockets}\n");
302		xo_emit(titles[fmt],
303		    "Address", "Type", "Recv-Q", "Send-Q",
304		    "Inode", "Conn", "Refs", "Nextref");
305		first = 0;
306	}
307
308	if (Lflag && so->so_qlimit == 0)
309		return;
310
311	if (Lflag) {
312		snprintf(buf1, sizeof buf1, "%u/%u/%u", so->so_qlen,
313		    so->so_incqlen, so->so_qlimit);
314		xo_emit("unix  {d:socket/%-32.32s}{e:queue-length/%u}"
315		    "{e:incomplete-queue-length/%u}{e:queue-limit/%u}",
316		    buf1, so->so_qlen, so->so_incqlen, so->so_qlimit);
317	} else {
318		xo_emit(format[fmt],
319		    (long)so->so_pcb, socktype[so->so_type], so->so_rcv.sb_cc,
320		    so->so_snd.sb_cc, (long)xunp->unp_vnode,
321		    (long)xunp->unp_conn, (long)xunp->xu_firstref,
322		    (long)xunp->xu_nextref);
323	}
324	if (sa)
325		xo_emit(" {:path/%.*s}",
326		    (int)(sa->sun_len - offsetof(struct sockaddr_un, sun_path)),
327		    sa->sun_path);
328	xo_emit("\n");
329}
330