root/usr.bin/netstat/mbuf.c
/*      $OpenBSD: mbuf.c,v 1.47 2025/06/22 11:34:40 bluhm Exp $ */
/*      $NetBSD: mbuf.c,v 1.9 1996/05/07 02:55:03 thorpej Exp $ */

/*
 * Copyright (c) 1983, 1988, 1993
 *      The Regents of the University of California.  All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 * 3. Neither the name of the University nor the names of its contributors
 *    may be used to endorse or promote products derived from this software
 *    without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 */

#include <sys/socket.h>
#include <sys/queue.h>
#include <sys/mbuf.h>
#include <sys/protosw.h>
#include <sys/pool.h>
#include <sys/sysctl.h>
#include <net/if.h>
#include <netinet/in.h>

#include <errno.h>
#include <limits.h>
#include <stdio.h>
#include <string.h>
#include <unistd.h>
#include "netstat.h"

#define YES     1
typedef int bool;

struct  mbstat mbstat;
struct kinfo_pool mbpool, mclpools[MCLPOOLS];
int     mclp;
char    *mclnames[] = {
        "mcl2k",
        "mcl2k2",
        "mcl4k",
        "mcl8k",
        "mcl9k",
        "mcl12k",
        "mcl16k",
        "mcl64k"
};
char    **mclnamep = mclnames;

static struct mbtypes {
        int     mt_type;
        char    *mt_name;
} mbtypes[] = {
        { MT_DATA,      "data" },
        { MT_OOBDATA,   "oob data" },
        { MT_CONTROL,   "ancillary data" },
        { MT_HEADER,    "packet headers" },
        { MT_FTABLE,    "fragment reassembly queue headers" },  /* XXX */
        { MT_SONAME,    "socket names and addresses" },
        { MT_SOOPTS,    "socket options" },
        { 0, 0 }
};

int nmbtypes = sizeof(mbstat.m_mtypes) / sizeof(u_long);
bool seen[MT_NTYPES];           /* "have we seen this type yet?" */

/*
 * Print mbuf statistics.
 */
void
mbpr(void)
{
        unsigned long totmem, totpeak, totmbufs;
        int i, maxclusters, mib[4], npools;
        struct kinfo_pool pool;
        struct mbtypes *mp;
        size_t size;

        if (nmbtypes != MT_NTYPES) {
                fprintf(stderr,
                    "%s: unexpected change to mbstat; check source\n",
                    __progname);
                return;
        }

        mib[0] = CTL_KERN;
        mib[1] = KERN_MAXCLUSTERS;
        size = sizeof(maxclusters);

        if (sysctl(mib, 2, &maxclusters, &size, NULL, 0) == -1) {
                printf("Can't retrieve value of maxclusters from the "
                    "kernel: %s\n",  strerror(errno));
                return;
        }

        mib[0] = CTL_KERN;
        mib[1] = KERN_MBSTAT;
        size = sizeof(mbstat);

        if (sysctl(mib, 2, &mbstat, &size, NULL, 0) == -1) {
                printf("Can't retrieve mbuf statistics from the kernel: %s\n",
                    strerror(errno));
                return;
        }

        mib[0] = CTL_KERN;
        mib[1] = KERN_POOL;
        mib[2] = KERN_POOL_NPOOLS;
        size = sizeof(npools);

        if (sysctl(mib, 3, &npools, &size, NULL, 0) == -1) {
                printf("Can't figure out number of pools in kernel: %s\n",
                    strerror(errno));
                return;
        }

        for (i = 1; npools; i++) {
                char name[32];

                mib[0] = CTL_KERN;
                mib[1] = KERN_POOL;
                mib[2] = KERN_POOL_POOL;
                mib[3] = i;
                size = sizeof(pool);
                if (sysctl(mib, 4, &pool, &size, NULL, 0) == -1) {
                        if (errno == ENOENT)
                                continue;
                        printf("error getting pool: %s\n",
                            strerror(errno));
                        return;
                }
                npools--;
                mib[2] = KERN_POOL_NAME;
                size = sizeof(name);
                if (sysctl(mib, 4, &name, &size, NULL, 0) == -1) {
                        printf("error getting pool name: %s\n",
                            strerror(errno));
                        return;
                }

                if (!strncmp(name, "mbufpl", strlen("mbufpl")))
                        bcopy(&pool, &mbpool, sizeof(pool));
                else if (mclp < sizeof(mclpools) / sizeof(mclpools[0]) &&
                    !strncmp(name, *mclnamep, strlen(*mclnamep))) {
                        bcopy(&pool, &mclpools[mclp++],
                            sizeof(pool));
                        mclnamep++;
                }
        }

        totmbufs = 0;
        for (mp = mbtypes; mp->mt_name; mp++)
                totmbufs += (unsigned int)mbstat.m_mtypes[mp->mt_type];
        printf("%lu mbuf%s in use:\n", totmbufs, plural(totmbufs));
        for (mp = mbtypes; mp->mt_name; mp++)
                if (mbstat.m_mtypes[mp->mt_type]) {
                        seen[mp->mt_type] = YES;
                        printf("\t%lu mbuf%s allocated to %s\n",
                            mbstat.m_mtypes[mp->mt_type],
                            plural(mbstat.m_mtypes[mp->mt_type]),
                            mp->mt_name);
                }
        seen[MT_FREE] = YES;
        for (i = 0; i < nmbtypes; i++)
                if (!seen[i] && mbstat.m_mtypes[i]) {
                        printf("\t%lu mbuf%s allocated to <mbuf type %d>\n",
                            mbstat.m_mtypes[i],
                            plural(mbstat.m_mtypes[i]), i);
                }
        totmem = (unsigned long)mbpool.pr_npages * mbpool.pr_pgsize;
        totpeak = (unsigned long)mbpool.pr_hiwat * mbpool.pr_pgsize;
        for (i = 0; i < mclp; i++) {
                printf("%u/%lu mbuf %d byte clusters in use"
                    " (current/peak)\n",
                    mclpools[i].pr_nout,
                    (unsigned long)
                    mclpools[i].pr_hiwat * mclpools[i].pr_itemsperpage,
                    mclpools[i].pr_size);
                totmem += (unsigned long)
                    mclpools[i].pr_npages * mclpools[i].pr_pgsize;
                totpeak += (unsigned long)
                    mclpools[i].pr_hiwat * mclpools[i].pr_pgsize;
        }

        printf("%lu/%lu/%lu Kbytes allocated to network "
            "(current/peak/max)\n", totmem / 1024, totpeak / 1024,
            ((unsigned long)maxclusters * MCLBYTES) / 1024);
        printf("%lu requests for memory denied\n", mbstat.m_drops);
        printf("%lu requests for memory delayed\n", mbstat.m_wait);
        printf("%lu calls to protocol drain routines\n", mbstat.m_drain);
        printf("%lu defrag mbuf allocation\n", mbstat.m_defrag_alloc);
        printf("%lu prepend mbuf allocation\n", mbstat.m_prepend_alloc);
        printf("%lu pullup mbuf allocation\n", mbstat.m_pullup_alloc);
        printf("%lu pullup memory copy\n", mbstat.m_pullup_copy);
        printf("%lu pulldown mbuf allocation\n", mbstat.m_pulldown_alloc);
        printf("%lu pulldown memory copy\n", mbstat.m_pulldown_copy);
}