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