xref: /f-stack/tools/netstat/unix.c (revision ebf5cedb)
1 /*-
2  * Copyright (c) 1983, 1988, 1993
3  *	The Regents of the University of California.  All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  * 1. Redistributions of source code must retain the above copyright
9  *    notice, this list of conditions and the following disclaimer.
10  * 2. Redistributions in binary form must reproduce the above copyright
11  *    notice, this list of conditions and the following disclaimer in the
12  *    documentation and/or other materials provided with the distribution.
13  * 4. Neither the name of the University nor the names of its contributors
14  *    may be used to endorse or promote products derived from this software
15  *    without specific prior written permission.
16  *
17  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
18  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
21  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
27  * SUCH DAMAGE.
28  */
29 
30 #if 0
31 #ifndef lint
32 static char sccsid[] = "@(#)unix.c	8.1 (Berkeley) 6/6/93";
33 #endif /* not lint */
34 #endif
35 
36 #include <sys/cdefs.h>
37 __FBSDID("$FreeBSD$");
38 
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 #include <sys/socketvar.h>
47 #include <sys/mbuf.h>
48 #include <sys/sysctl.h>
49 #include <sys/un.h>
50 #include <sys/unpcb.h>
51 
52 #include <netinet/in.h>
53 
54 #include <errno.h>
55 #include <err.h>
56 #include <stddef.h>
57 #include <stdint.h>
58 #include <stdio.h>
59 #include <stdlib.h>
60 #include <stdbool.h>
61 #include <strings.h>
62 #ifndef FSTACK
63 #include <kvm.h>
64 #endif
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 	sprintf(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 #ifndef FSTACK
102 static int
103 pcblist_kvm(u_long count_off, u_long gencnt_off, u_long head_off, char **bufp)
104 {
105 	struct unp_head head;
106 	struct unpcb *unp, unp_conn;
107 	u_char sun_len;
108 	struct socket so;
109 	struct xunpgen xug;
110 	struct xunpcb xu;
111 	unp_gen_t unp_gencnt;
112 	u_int	unp_count;
113 	char 	*buf, *p;
114 	size_t	len;
115 
116 	if (count_off == 0 || gencnt_off == 0)
117 		return (-2);
118 	if (head_off == 0)
119 		return (-1);
120 	kread(count_off, &unp_count, sizeof(unp_count));
121 	len = 2 * sizeof(xug) + (unp_count + unp_count / 8) * sizeof(xu);
122 	if ((buf = malloc(len)) == NULL) {
123 		xo_warnx("malloc %lu bytes", (u_long)len);
124 		return (-2);
125 	}
126 	p = buf;
127 
128 #define	COPYOUT(obj, size) do {						\
129 	if (len < (size)) {						\
130 		xo_warnx("buffer size exceeded");			\
131 		goto fail;						\
132 	}								\
133 	bcopy((obj), p, (size));					\
134 	len -= (size);							\
135 	p += (size);							\
136 } while (0)
137 
138 #define	KREAD(off, buf, len) do {					\
139 	if (kread((uintptr_t)(off), (buf), (len)) != 0)			\
140 		goto fail;						\
141 } while (0)
142 
143 	/* Write out header. */
144 	kread(gencnt_off, &unp_gencnt, sizeof(unp_gencnt));
145 	xug.xug_len = sizeof xug;
146 	xug.xug_count = unp_count;
147 	xug.xug_gen = unp_gencnt;
148 	xug.xug_sogen = 0;
149 	COPYOUT(&xug, sizeof xug);
150 
151 	/* Walk the PCB list. */
152 	xu.xu_len = sizeof xu;
153 	KREAD(head_off, &head, sizeof(head));
154 	LIST_FOREACH(unp, &head, unp_link) {
155 		xu.xu_unpp = unp;
156 		KREAD(unp, &xu.xu_unp, sizeof (*unp));
157 		unp = &xu.xu_unp;
158 
159 		if (unp->unp_gencnt > unp_gencnt)
160 			continue;
161 		if (unp->unp_addr != NULL) {
162 			KREAD(unp->unp_addr, &sun_len, sizeof(sun_len));
163 			KREAD(unp->unp_addr, &xu.xu_addr, sun_len);
164 		}
165 		if (unp->unp_conn != NULL) {
166 			KREAD(unp->unp_conn, &unp_conn, sizeof(unp_conn));
167 			if (unp_conn.unp_addr != NULL) {
168 				KREAD(unp_conn.unp_addr, &sun_len,
169 				    sizeof(sun_len));
170 				KREAD(unp_conn.unp_addr, &xu.xu_caddr, sun_len);
171 			}
172 		}
173 		KREAD(unp->unp_socket, &so, sizeof(so));
174 		if (sotoxsocket(&so, &xu.xu_socket) != 0)
175 			goto fail;
176 		COPYOUT(&xu, sizeof(xu));
177 	}
178 
179 	/* Reread the counts and write the footer. */
180 	kread(count_off, &unp_count, sizeof(unp_count));
181 	kread(gencnt_off, &unp_gencnt, sizeof(unp_gencnt));
182 	xug.xug_count = unp_count;
183 	xug.xug_gen = unp_gencnt;
184 	COPYOUT(&xug, sizeof xug);
185 
186 	*bufp = buf;
187 	return (0);
188 
189 fail:
190 	free(buf);
191 	return (-1);
192 #undef COPYOUT
193 #undef KREAD
194 }
195 #endif
196 
197 void
198 unixpr(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 #ifndef FSTACK
207 	u_long	head_off;
208 #endif
209 
210 	buf = NULL;
211 	for (type = SOCK_STREAM; type <= SOCK_SEQPACKET; type++) {
212 		if (live)
213 			ret = pcblist_sysctl(type, &buf);
214 		else {
215 #ifndef FSTACK
216 			head_off = 0;
217 			switch (type) {
218 			case SOCK_STREAM:
219 				head_off = shead_off;
220 				break;
221 
222 			case SOCK_DGRAM:
223 				head_off = dhead_off;
224 				break;
225 
226 			case SOCK_SEQPACKET:
227 				head_off = sphead_off;
228 				break;
229 			}
230 			ret = pcblist_kvm(count_off, gencnt_off, head_off,
231 			    &buf);
232 #endif
233 		}
234 		if (ret == -1)
235 			continue;
236 		if (ret < 0)
237 			return;
238 
239 		oxug = xug = (struct xunpgen *)buf;
240 		for (xug = (struct xunpgen *)((char *)xug + xug->xug_len);
241 		    xug->xug_len > sizeof(struct xunpgen);
242 		    xug = (struct xunpgen *)((char *)xug + xug->xug_len)) {
243 			xunp = (struct xunpcb *)xug;
244 			so = &xunp->xu_socket;
245 
246 			/* Ignore PCBs which were freed during copyout. */
247 			if (xunp->xu_unp.unp_gencnt > oxug->xug_gen)
248 				continue;
249 			if (*first) {
250 				xo_open_list("socket");
251 				*first = false;
252 			}
253 			xo_open_instance("socket");
254 			unixdomainpr(xunp, so);
255 			xo_close_instance("socket");
256 		}
257 		if (xug != oxug && xug->xug_gen != oxug->xug_gen) {
258 			if (oxug->xug_count > xug->xug_count) {
259 				xo_emit("Some {:type/%s} sockets may have "
260 				    "been {:action/deleted}.\n",
261 				    socktype[type]);
262 			} else if (oxug->xug_count < xug->xug_count) {
263 				xo_emit("Some {:type/%s} sockets may have "
264 				    "been {:action/created}.\n",
265 				    socktype[type]);
266 			} else {
267 				xo_emit("Some {:type/%s} sockets may have "
268 				    "been {:action/created or deleted}",
269 				    socktype[type]);
270 			}
271 		}
272 		free(buf);
273 	}
274 }
275 
276 static void
277 unixdomainpr(struct xunpcb *xunp, struct xsocket *so)
278 {
279 	struct unpcb *unp;
280 	struct sockaddr_un *sa;
281 	static int first = 1;
282 	char buf1[33];
283 	static const char *titles[2] = {
284 	    "{T:/%-8.8s} {T:/%-6.6s} {T:/%-6.6s} {T:/%-6.6s} {T:/%8.8s} "
285 	    "{T:/%8.8s} {T:/%8.8s} {T:/%8.8s} {T:Addr}\n",
286 	    "{T:/%-16.16s} {T:/%-6.6s} {T:/%-6.6s} {T:/%-6.6s} {T:/%16.16s} "
287 	    "{T:/%16.16s} {T:/%16.16s} {T:/%16.16s} {T:Addr}\n"
288 	};
289 	static const char *format[2] = {
290 	    "{q:address/%8lx} {t:type/%-6.6s} "
291 	    "{:receive-bytes-waiting/%6u} "
292 	    "{:send-bytes-waiting/%6u} "
293 	    "{q:vnode/%8lx} {q:connection/%8lx} "
294 	    "{q:first-reference/%8lx} {q:next-reference/%8lx}",
295 	    "{q:address/%16lx} {t:type/%-6.6s} "
296 	    "{:receive-bytes-waiting/%6u} "
297 	    "{:send-bytes-waiting/%6u} "
298 	    "{q:vnode/%16lx} {q:connection/%16lx} "
299 	    "{q:first-reference/%16lx} {q:next-reference/%16lx}"
300 	};
301 	int fmt = (sizeof(void *) == 8) ? 1 : 0;
302 
303 	unp = &xunp->xu_unp;
304 	if (unp->unp_addr)
305 		sa = &xunp->xu_addr;
306 	else
307 		sa = (struct sockaddr_un *)0;
308 
309 	if (first && !Lflag) {
310 		xo_emit("{T:Active UNIX domain sockets}\n");
311 		xo_emit(titles[fmt],
312 		    "Address", "Type", "Recv-Q", "Send-Q",
313 		    "Inode", "Conn", "Refs", "Nextref");
314 		first = 0;
315 	}
316 
317 	if (Lflag && so->so_qlimit == 0)
318 		return;
319 
320 	if (Lflag) {
321 		snprintf(buf1, sizeof buf1, "%u/%u/%u", so->so_qlen,
322 		    so->so_incqlen, so->so_qlimit);
323 		xo_emit("unix  {d:socket/%-32.32s}{e:queue-length/%u}"
324 		    "{e:incomplete-queue-length/%u}{e:queue-limit/%u}",
325 		    buf1, so->so_qlen, so->so_incqlen, so->so_qlimit);
326 	} else {
327 		xo_emit(format[fmt],
328 		    (long)so->so_pcb, socktype[so->so_type], so->so_rcv.sb_cc,
329 		    so->so_snd.sb_cc, (long)unp->unp_vnode,
330 		    (long)unp->unp_conn,
331 		    (long)LIST_FIRST(&unp->unp_refs),
332 		    (long)LIST_NEXT(unp, unp_reflink));
333 	}
334 	if (sa)
335 		xo_emit(" {:path/%.*s}",
336 		    (int)(sa->sun_len - offsetof(struct sockaddr_un, sun_path)),
337 		    sa->sun_path);
338 	xo_emit("\n");
339 }
340