usr.bin/netstat/unix.c

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