xref: /freebsd-current/share/dtrace/mbuf.d

/*
 * Copyright (c) 2016 George V. Neville-Neil
 * 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.
 *
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR 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 AUTHOR 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.
 *
 * Translators and flags for the mbuf structure.  FreeBSD specific code.
 */

#pragma D depends_on module kernel

/*
 * mbuf flags of global significance and layer crossing.
 * Those of only protocol/layer specific significance are to be mapped
 * to M_PROTO[1-12] and cleared at layer handoff boundaries.
 * NB: Limited to the lower 24 bits.
 */

#pragma D binding "1.6.3" M_EXT
inline int M_EXT =	0x00000001; /* has associated external storage */
#pragma D binding "1.6.3" M_PKTHDR
inline int M_PKTHDR =	0x00000002; /* start of record */
#pragma D binding "1.6.3" M_EOR
inline int M_EOR =	0x00000004; /* end of record */
#pragma D binding "1.6.3" M_RDONLY
inline int M_RDONLY =	0x00000008; /* associated data is marked read-only */
#pragma D binding "1.6.3" M_BCAST
inline int M_BCAST =	0x00000010; /* send/received as link-level broadcast */
#pragma D binding "1.6.3" M_MCAST
inline int M_MCAST =	0x00000020; /* send/received as link-level multicast */
#pragma D binding "1.6.3" M_PROMISC
inline int M_PROMISC =	0x00000040; /* packet was not for us */
#pragma D binding "1.6.3" M_VLANTAG
inline int M_VLANTAG =	0x00000080; /* ether_vtag is valid */
#pragma D binding "1.13" M_EXTPG
inline int M_EXTPG =	0x00000100; /* has array of unmapped pages and TLS */
#pragma D binding "1.6.3" M_NOFREE
inline int M_NOFREE =	0x00000200; /* do not free mbuf, embedded in cluster */
#pragma D binding "1.13" M_TSTMP
inline int M_TSTMP =	0x00000400; /* rcv_tstmp field is valid */
#pragma D binding "1.13" M_TSTMP_HPREC
inline int M_TSTMP_HPREC = 0x00000800; /* rcv_tstmp is high-prec */
#pragma D binding "1.13" M_TSTMP_LRO
inline int M_TSTMP_LRO = 0x00001000; /* Time LRO pushed in pkt is valid */

#pragma D binding "1.13" M_PROTO1
inline int M_PROTO1 =	0x00002000; /* protocol-specific */
#pragma D binding "1.13" M_PROTO2
inline int M_PROTO2 =	0x00004000; /* protocol-specific */
#pragma D binding "1.13" M_PROTO3
inline int M_PROTO3 =	0x00008000; /* protocol-specific */
#pragma D binding "1.13" M_PROTO4
inline int M_PROTO4 =	0x00010000; /* protocol-specific */
#pragma D binding "1.13" M_PROTO5
inline int M_PROTO5 =	0x00020000; /* protocol-specific */
#pragma D binding "1.13" M_PROTO6
inline int M_PROTO6 =	0x00040000; /* protocol-specific */
#pragma D binding "1.13" M_PROTO7
inline int M_PROTO7 =	0x00080000; /* protocol-specific */
#pragma D binding "1.13" M_PROTO8
inline int M_PROTO8 =	0x00100000; /* protocol-specific */
#pragma D binding "1.13" M_PROTO9
inline int M_PROTO9 =	0x00200000; /* protocol-specific */
#pragma D binding "1.13" M_PROTO10
inline int M_PROTO10 =	0x00400000; /* protocol-specific */
#pragma D binding "1.13" M_PROTO11
inline int M_PROTO11 =	0x00800000; /* protocol-specific */

#pragma D binding "1.13" mbufflags_string
inline string mbufflags_string[uint32_t flags] =
    flags & M_EXT ? "M_EXT" :
    flags & M_PKTHDR ? "M_PKTHDR" :
    flags & M_EOR  ? "M_EOR" :
    flags & M_RDONLY  ? "M_RDONLY" :
    flags & M_BCAST  ? "M_BCAST" :
    flags & M_MCAST 	? "M_MCAST" :
    flags & M_PROMISC 	? "M_PROMISC" :
    flags & M_VLANTAG 	? "M_VLANTAG" :
    flags & M_EXTPG 	? "M_EXTPG" :
    flags & M_NOFREE	? "M_NOFREE" :
    flags & M_TSTMP	? "M_TSTMP" :
    flags & M_TSTMP_HPREC ? "M_TSTMP_HPREC" :
    flags & M_TSTMP_LRO ? "M_TSTMP_LRO" :
    flags & M_PROTO1  ? "M_PROTO1" :
    flags & M_PROTO2 ? "M_PROTO2" :
    flags & M_PROTO3 ? "M_PROTO3" :
    flags & M_PROTO4 ? "M_PROTO4" :
    flags & M_PROTO5 ? "M_PROTO5" :
    flags & M_PROTO6 ? "M_PROTO6" :
    flags & M_PROTO7 ? "M_PROTO7" :
    flags & M_PROTO8 ? "M_PROTO8" :
    flags & M_PROTO9 ? "M_PROTO9" :
    flags & M_PROTO10 ? "M_PROTO10" :
    flags & M_PROTO11 ? "M_PROTO11" :
    "none" ;

typedef struct mbufinfo {
	uintptr_t mbuf_addr;
	caddr_t m_data;
	int32_t m_len;
	uint8_t m_type;
	uint32_t m_flags;
} mbufinfo_t;

translator mbufinfo_t < struct mbuf *p > {
	mbuf_addr = (uintptr_t)p;
	m_data = p->m_data;
	m_len = p->m_len;
	m_type = p->m_type & 0xff000000;
	m_flags = p->m_type & 0x00ffffff;
};