FreeBSD/Linux Kernel Cross Reference
sys/sys/ktr.h

     /*-
      * SPDX-License-Identifier: BSD-3-Clause
      *
      * Copyright (c) 1996 Berkeley Software Design, Inc. 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. Berkeley Software Design Inc's name may not be used to endorse or
     *    promote products derived from this software without specific prior
     *    written permission.
     *
     * THIS SOFTWARE IS PROVIDED BY BERKELEY SOFTWARE DESIGN INC ``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 BERKELEY SOFTWARE DESIGN INC 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.
     *
     *      from BSDI $Id: ktr.h,v 1.10.2.7 2000/03/16 21:44:42 cp Exp $
     * $FreeBSD$
     */
    
    /*
     *      Wraparound kernel trace buffer support.
     */
    
    #ifndef _SYS_KTR_H_
    #define _SYS_KTR_H_
    
    #include <sys/ktr_class.h>
    
    /*
     * Version number for ktr_entry struct.  Increment this when you break binary
     * compatibility.
     */
    #define KTR_VERSION     2
    
    #define KTR_PARMS       6
    
    #ifndef LOCORE
    
    #include <sys/param.h>
    #include <sys/_cpuset.h>
    
    struct ktr_entry {
            u_int64_t ktr_timestamp;
            int     ktr_cpu;
            int     ktr_line;
            const   char *ktr_file;
            const   char *ktr_desc;
            struct  thread *ktr_thread;
            u_long  ktr_parms[KTR_PARMS];
    };
    
    extern cpuset_t ktr_cpumask;
    extern uint64_t ktr_mask;
    extern int ktr_entries;
    extern int ktr_verbose;
    
    extern volatile int ktr_idx;
    extern struct ktr_entry *ktr_buf;
    
    #ifdef KTR
    
    void    ktr_tracepoint(uint64_t mask, const char *file, int line,
                const char *format, u_long arg1, u_long arg2, u_long arg3,
                u_long arg4, u_long arg5, u_long arg6);
    
    #define CTR6(m, format, p1, p2, p3, p4, p5, p6) do {                    \
            if (KTR_COMPILE & (m))                                          \
                    ktr_tracepoint((m), __FILE__, __LINE__, format,         \
                        (u_long)(p1), (u_long)(p2), (u_long)(p3),           \
                        (u_long)(p4), (u_long)(p5), (u_long)(p6));          \
            } while (0)
    #define CTR0(m, format)                 CTR6(m, format, 0, 0, 0, 0, 0, 0)
    #define CTR1(m, format, p1)             CTR6(m, format, p1, 0, 0, 0, 0, 0)
    #define CTR2(m, format, p1, p2)         CTR6(m, format, p1, p2, 0, 0, 0, 0)
    #define CTR3(m, format, p1, p2, p3)     CTR6(m, format, p1, p2, p3, 0, 0, 0)
    #define CTR4(m, format, p1, p2, p3, p4) CTR6(m, format, p1, p2, p3, p4, 0, 0)
    #define CTR5(m, format, p1, p2, p3, p4, p5)     CTR6(m, format, p1, p2, p3, p4, p5, 0)
    #else   /* KTR */
    #define CTR0(m, d)                      (void)0
    #define CTR1(m, d, p1)                  (void)0
    #define CTR2(m, d, p1, p2)              (void)0
    #define CTR3(m, d, p1, p2, p3)          (void)0
    #define CTR4(m, d, p1, p2, p3, p4)      (void)0
    #define CTR5(m, d, p1, p2, p3, p4, p5)  (void)0
    #define CTR6(m, d, p1, p2, p3, p4, p5, p6)      (void)0
   #endif  /* KTR */
   
   #define TR0(d)                          CTR0(KTR_GEN, d)
   #define TR1(d, p1)                      CTR1(KTR_GEN, d, p1)
   #define TR2(d, p1, p2)                  CTR2(KTR_GEN, d, p1, p2)
   #define TR3(d, p1, p2, p3)              CTR3(KTR_GEN, d, p1, p2, p3)
   #define TR4(d, p1, p2, p3, p4)          CTR4(KTR_GEN, d, p1, p2, p3, p4)
   #define TR5(d, p1, p2, p3, p4, p5)      CTR5(KTR_GEN, d, p1, p2, p3, p4, p5)
   #define TR6(d, p1, p2, p3, p4, p5, p6)  CTR6(KTR_GEN, d, p1, p2, p3, p4, p5, p6)
   
   #define _KTR_MACRO(m, format, _1, _2, _3, _4, _5, _6, NAME, ...)        \
           NAME
   #define CTR(...)                                                        \
           _KTR_MACRO(__VA_ARGS__, CTR6, CTR5, CTR4, CTR3, CTR2, CTR1,     \
               CTR0)(__VA_ARGS__)
   #define TR(...)                         CTR(KTR_GEN, __VA_ARGS__)
   
   /*
    * The event macros implement KTR graphic plotting facilities provided
    * by src/tools/sched/schedgraph.py.  Three generic types of events are
    * supported: states, counters, and points.
    *
    * m is the ktr class for ktr_mask.
    * ident is the string identifier that owns the event (ie: "thread 10001")
    * etype is the type of event to plot (state, counter, point)
    * edat is the event specific data (state name, counter value, point name)
    * up to four attributes may be supplied as a name, value pair of arguments.
    *
    * etype and attribute names must be string constants.  This minimizes the
    * number of ktr slots required by construction the final format strings
    * at compile time.  Both must also include a colon and format specifier
    * (ie. "prio:%d", prio).  It is recommended that string arguments be
    * contained within escaped quotes if they may contain ',' or ':' characters.
    *
    * The special attribute (KTR_ATTR_LINKED, ident) creates a reference to another
    * id on the graph for easy traversal of related graph elements.
    */
   
   #define KTR_ATTR_LINKED "linkedto:\"%s\""
   #define KTR_EFMT(egroup, ident, etype)                                  \
               "KTRGRAPH group:\"" egroup "\", id:\"%s\", " etype ", attributes: "
   
   #define KTR_EVENT0(m, egroup, ident, etype, edat)                       \
           CTR2(m, KTR_EFMT(egroup, ident, etype) "none", ident, edat)
   #define KTR_EVENT1(m, egroup, ident, etype, edat, a0, v0)               \
           CTR3(m, KTR_EFMT(egroup, ident, etype) a0, ident, edat, (v0))
   #define KTR_EVENT2(m, egroup, ident, etype, edat, a0, v0, a1, v1)       \
           CTR4(m, KTR_EFMT(egroup, ident, etype) a0 ", " a1,              \
               ident, edat, (v0), (v1))
   #define KTR_EVENT3(m, egroup, ident, etype, edat, a0, v0, a1, v1, a2, v2)\
           CTR5(m,KTR_EFMT(egroup, ident, etype) a0 ", " a1 ", " a2,       \
               ident, edat, (v0), (v1), (v2))
   #define KTR_EVENT4(m, egroup, ident, etype, edat,                       \
               a0, v0, a1, v1, a2, v2, a3, v3)                             \
           CTR6(m,KTR_EFMT(egroup, ident, etype) a0 ", " a1 ", " a2 ", " a3,\
                ident, edat, (v0), (v1), (v2), (v3))
   
   /*
    * State functions graph state changes on an ident.
    */
   #define KTR_STATE0(m, egroup, ident, state)                             \
           KTR_EVENT0(m, egroup, ident, "state:\"%s\"", state)
   #define KTR_STATE1(m, egroup, ident, state, a0, v0)                     \
           KTR_EVENT1(m, egroup, ident, "state:\"%s\"", state, a0, (v0))
   #define KTR_STATE2(m, egroup, ident, state, a0, v0, a1, v1)             \
           KTR_EVENT2(m, egroup, ident, "state:\"%s\"", state, a0, (v0), a1, (v1))
   #define KTR_STATE3(m, egroup, ident, state, a0, v0, a1, v1, a2, v2)     \
           KTR_EVENT3(m, egroup, ident, "state:\"%s\"",                    \
               state, a0, (v0), a1, (v1), a2, (v2))
   #define KTR_STATE4(m, egroup, ident, state, a0, v0, a1, v1, a2, v2, a3, v3)\
           KTR_EVENT4(m, egroup, ident, "state:\"%s\"",                    \
               state, a0, (v0), a1, (v1), a2, (v2), a3, (v3))
   
   /*
    * Counter functions graph counter values.  The counter id
    * must not be intermixed with a state id. 
    */
   #define KTR_COUNTER0(m, egroup, ident, counter)                         \
           KTR_EVENT0(m, egroup, ident, "counter:%d", counter)
   #define KTR_COUNTER1(m, egroup, ident, edat, a0, v0)                    \
           KTR_EVENT1(m, egroup, ident, "counter:%d", counter, a0, (v0))
   #define KTR_COUNTER2(m, egroup, ident, counter, a0, v0, a1, v1)         \
           KTR_EVENT2(m, egroup, ident, "counter:%d", counter, a0, (v0), a1, (v1))
   #define KTR_COUNTER3(m, egroup, ident, counter, a0, v0, a1, v1, a2, v2) \
           KTR_EVENT3(m, egroup, ident, "counter:%d",                      \
               counter, a0, (v0), a1, (v1), a2, (v2))
   #define KTR_COUNTER4(m, egroup, ident, counter, a0, v0, a1, v1, a2, v2, a3, v3)\
           KTR_EVENT4(m, egroup, ident, "counter:%d",                      \
               counter, a0, (v0), a1, (v1), a2, (v2), a3, (v3))
   
   /*
    * Point functions plot points of interest on counter or state graphs.
    */
   #define KTR_POINT0(m, egroup, ident, point)                             \
           KTR_EVENT0(m, egroup, ident, "point:\"%s\"", point)
   #define KTR_POINT1(m, egroup, ident, point, a0, v0)                     \
           KTR_EVENT1(m, egroup, ident, "point:\"%s\"", point, a0, (v0))
   #define KTR_POINT2(m, egroup, ident, point, a0, v0, a1, v1)             \
           KTR_EVENT2(m, egroup, ident, "point:\"%s\"", point, a0, (v0), a1, (v1))
   #define KTR_POINT3(m, egroup, ident, point, a0, v0, a1, v1, a2, v2)     \
           KTR_EVENT3(m, egroup, ident, "point:\"%s\"", point,             \
               a0, (v0), a1, (v1), a2, (v2))
   #define KTR_POINT4(m, egroup, ident, point, a0, v0, a1, v1, a2, v2, a3, v3)\
           KTR_EVENT4(m, egroup, ident, "point:\"%s\"",                    \
               point, a0, (v0), a1, (v1), a2, (v2), a3, (v3))
   
   /*
    * Start functions denote the start of a region of code or operation
    * and should be paired with stop functions for timing of nested
    * sequences.
    *
    * Specifying extra attributes with the name "key" will result in
    * multi-part keys.  For example a block device and offset pair
    * might be used to describe a buf undergoing I/O.
    */
   #define KTR_START0(m, egroup, ident, key)                               \
           KTR_EVENT0(m, egroup, ident, "start:0x%jX", (uintmax_t)key)
   #define KTR_START1(m, egroup, ident, key, a0, v0)                       \
           KTR_EVENT1(m, egroup, ident, "start:0x%jX", (uintmax_t)key, a0, (v0))
   #define KTR_START2(m, egroup, ident, key, a0, v0, a1, v1)               \
           KTR_EVENT2(m, egroup, ident, "start:0x%jX", (uintmax_t)key,     \
               a0, (v0), a1, (v1))
   #define KTR_START3(m, egroup, ident, key, a0, v0, a1, v1, a2, v2)\
           KTR_EVENT3(m, egroup, ident, "start:0x%jX", (uintmax_t)key,     \
               a0, (v0), a1, (v1), a2, (v2))
   #define KTR_START4(m, egroup, ident, key,                               \
               a0, v0, a1, v1, a2, v2, a3, v3)                             \
           KTR_EVENT4(m, egroup, ident, "start:0x%jX", (uintmax_t)key,     \
               a0, (v0), a1, (v1), a2, (v2), a3, (v3))
   
   /*
    * Stop functions denote the end of a region of code or operation
    * and should be paired with start functions for timing of nested
    * sequences.
    */
   #define KTR_STOP0(m, egroup, ident, key)                                \
           KTR_EVENT0(m, egroup, ident, "stop:0x%jX", (uintmax_t)key)
   #define KTR_STOP1(m, egroup, ident, key, a0, v0)                        \
           KTR_EVENT1(m, egroup, ident, "stop:0x%jX", (uintmax_t)key, a0, (v0))
   #define KTR_STOP2(m, egroup, ident, key, a0, v0, a1, v1)                \
           KTR_EVENT2(m, egroup, ident, "stop:0x%jX", (uintmax_t)key,      \
               a0, (v0), a1, (v1))
   #define KTR_STOP3(m, egroup, ident, key, a0, v0, a1, v1, a2, v2)\
           KTR_EVENT3(m, egroup, ident, "stop:0x%jX", (uintmax_t)key,      \
               a0, (v0), a1, (v1), a2, (v2))
   #define KTR_STOP4(m, egroup, ident,                                     \
               key, a0, v0, a1, v1, a2, v2, a3, v3)                        \
           KTR_EVENT4(m, egroup, ident, "stop:0x%jX", (uintmax_t)key,      \
               a0, (v0), a1, (v1), a2, (v2), a3, (v3))
   
   /*
    * Trace initialization events, similar to CTR with KTR_INIT, but
    * completely ifdef'ed out if KTR_INIT isn't in KTR_COMPILE (to
    * save string space, the compiler doesn't optimize out strings
    * for the conditional ones above).
    */
   #if (KTR_COMPILE & KTR_INIT) != 0
   #define ITR0(d)                         CTR0(KTR_INIT, d)
   #define ITR1(d, p1)                     CTR1(KTR_INIT, d, p1)
   #define ITR2(d, p1, p2)                 CTR2(KTR_INIT, d, p1, p2)
   #define ITR3(d, p1, p2, p3)             CTR3(KTR_INIT, d, p1, p2, p3)
   #define ITR4(d, p1, p2, p3, p4)         CTR4(KTR_INIT, d, p1, p2, p3, p4)
   #define ITR5(d, p1, p2, p3, p4, p5)     CTR5(KTR_INIT, d, p1, p2, p3, p4, p5)
   #define ITR6(d, p1, p2, p3, p4, p5, p6) CTR6(KTR_INIT, d, p1, p2, p3, p4, p5, p6)
   #else
   #define ITR0(d)
   #define ITR1(d, p1)
   #define ITR2(d, p1, p2)
   #define ITR3(d, p1, p2, p3)
   #define ITR4(d, p1, p2, p3, p4)
   #define ITR5(d, p1, p2, p3, p4, p5)
   #define ITR6(d, p1, p2, p3, p4, p5, p6)
   #endif
   
   #endif /* !LOCORE */
   
   #endif /* !_SYS_KTR_H_ */

Cache object: 2479d8810d55a239b7b37daa274db298