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