The Design and Implementation of the FreeBSD Operating System, Second Edition
Now available: The Design and Implementation of the FreeBSD Operating System (Second Edition)


[ source navigation ] [ diff markup ] [ identifier search ] [ freetext search ] [ file search ] [ list types ] [ track identifier ]

FreeBSD/Linux Kernel Cross Reference
sys/dev/lockstat.h

Version: -  FREEBSD  -  FREEBSD-13-STABLE  -  FREEBSD-13-0  -  FREEBSD-12-STABLE  -  FREEBSD-12-0  -  FREEBSD-11-STABLE  -  FREEBSD-11-0  -  FREEBSD-10-STABLE  -  FREEBSD-10-0  -  FREEBSD-9-STABLE  -  FREEBSD-9-0  -  FREEBSD-8-STABLE  -  FREEBSD-8-0  -  FREEBSD-7-STABLE  -  FREEBSD-7-0  -  FREEBSD-6-STABLE  -  FREEBSD-6-0  -  FREEBSD-5-STABLE  -  FREEBSD-5-0  -  FREEBSD-4-STABLE  -  FREEBSD-3-STABLE  -  FREEBSD22  -  l41  -  OPENBSD  -  linux-2.6  -  MK84  -  PLAN9  -  xnu-8792 
SearchContext: -  none  -  3  -  10 

    1 /*      $NetBSD: lockstat.h,v 1.1 2006/09/07 00:20:28 ad Exp $  */
    2 
    3 /*-
    4  * Copyright (c) 2006 The NetBSD Foundation, Inc.
    5  * All rights reserved.
    6  *
    7  * This code is derived from software contributed to The NetBSD Foundation
    8  * by Andrew Doran.
    9  *
   10  * Redistribution and use in source and binary forms, with or without
   11  * modification, are permitted provided that the following conditions
   12  * are met:
   13  * 1. Redistributions of source code must retain the above copyright
   14  *    notice, this list of conditions and the following disclaimer.
   15  * 2. Redistributions in binary form must reproduce the above copyright
   16  *    notice, this list of conditions and the following disclaimer in the
   17  *    documentation and/or other materials provided with the distribution.
   18  * 3. All advertising materials mentioning features or use of this software
   19  *    must display the following acknowledgement:
   20  *      This product includes software developed by the NetBSD
   21  *      Foundation, Inc. and its contributors.
   22  * 4. Neither the name of The NetBSD Foundation nor the names of its
   23  *    contributors may be used to endorse or promote products derived
   24  *    from this software without specific prior written permission.
   25  *
   26  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
   27  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
   28  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
   29  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
   30  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
   31  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
   32  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
   33  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
   34  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
   35  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
   36  * POSSIBILITY OF SUCH DAMAGE.
   37  */
   38 
   39 #ifndef _SYS_LOCKSTAT_H_
   40 #define _SYS_LOCKSTAT_H_
   41 
   42 #ifdef _KERNEL_OPT
   43 #include <lockstat.h>
   44 #endif
   45 
   46 #include <sys/types.h>
   47 #include <sys/ioccom.h>
   48 #include <sys/queue.h>
   49 #include <sys/types.h>
   50 #include <sys/time.h>
   51 
   52 #if defined(_KERNEL) && defined(__HAVE_CPU_COUNTER)
   53 #include <machine/cpu_counter.h>
   54 #endif
   55 
   56 /*
   57  * Interface version.  The interface is not designed to provide
   58  * compatibility across NetBSD releases.
   59  */
   60 
   61 #define IOC_LOCKSTAT_GVERSION   _IOR('L', 0, int)
   62 
   63 #define LS_VERSION      0
   64 
   65 /*
   66  * Enable request.  We can limit tracing by the call site and by
   67  * the lock.  We also specify the number of event buffers to
   68  * allocate up front, and what kind of events to track.
   69  */
   70 
   71 #define IOC_LOCKSTAT_ENABLE     _IOW('L', 1, lsenable_t)
   72 
   73 #define LE_CALLSITE     0x01            /* track call sites */
   74 #define LE_ONE_CALLSITE 0x02            /* specific call site */
   75 #define LE_ONE_LOCK     0x04            /* specific lock */
   76 
   77 typedef struct lsenable {
   78         uintptr_t       le_csstart;     /* callsite start */
   79         uintptr_t       le_csend;       /* callsite end */
   80         uintptr_t       le_lock;        /* lock address */
   81         uintptr_t       le_nbufs;       /* buffers to allocate, 0 = default */
   82         u_int           le_flags;       /* request flags */
   83         u_int           le_mask;        /* event mask (LB_*) */
   84 } lsenable_t;
   85 
   86 /*
   87  * Disable request.
   88  */
   89 
   90 #define IOC_LOCKSTAT_DISABLE    _IOR('L', 2, lsdisable_t)
   91 
   92 typedef struct lsdisable {
   93         size_t          ld_size;        /* buffer space allocated */
   94         struct timespec ld_time;        /* time spent enabled */
   95         uint64_t        ld_freq[64];    /* counter HZ by CPU number */
   96 } lsdisable_t;
   97 
   98 /*
   99  * Event buffers returned from reading from the devices.
  100  */
  101 
  102 /*
  103  * Event types, for lockstat_event().  Stored in lb_flags but should be
  104  * meaningless to the consumer, also provided with the enable request
  105  * in le_mask.
  106  */
  107 #define LB_SPIN                 0x00000001
  108 #define LB_SLEEP                0x00000002
  109 #define LB_NEVENT               0x00000002
  110 #define LB_EVENT_MASK           0x000000ff
  111 
  112 /*
  113  * Lock types, the only part of lb_flags that should be inspected.  Also
  114  * provided with the enable request in le_mask.
  115  */
  116 #define LB_ADAPTIVE_MUTEX       0x00000100
  117 #define LB_ADAPTIVE_RWLOCK      0x00000200
  118 #define LB_SPIN_MUTEX           0x00000300
  119 #define LB_SPIN_RWLOCK          0x00000400
  120 #define LB_LOCKMGR              0x00000500
  121 #define LB_NLOCK                0x00000500
  122 #define LB_LOCK_MASK            0x0000ff00
  123 #define LB_LOCK_SHIFT           8
  124 
  125 typedef struct lsbuf {
  126         union {
  127                 LIST_ENTRY(lsbuf) list;
  128                 SLIST_ENTRY(lsbuf) slist;
  129                 TAILQ_ENTRY(lsbuf) tailq;
  130         } lb_chain;
  131         uintptr_t       lb_lock;                /* lock address */
  132         uintptr_t       lb_callsite;            /* call site */
  133         uint64_t        lb_times[LB_NEVENT];    /* cumulative times */
  134         uint32_t        lb_counts[LB_NEVENT];   /* count of events */
  135         uint16_t        lb_flags;               /* lock type */
  136         uint16_t        lb_cpu;                 /* CPU number */
  137 } lsbuf_t;
  138 
  139 /*
  140  * Tracing stubs used by lock providers, e.g. lockmgr().
  141  */
  142 
  143 #if defined(_KERNEL) && defined(__HAVE_CPU_COUNTER) && NLOCKSTAT > 0
  144 
  145 #define LOCKSTAT_EVENT(lock, type, count, time)                         \
  146 do {                                                                    \
  147         if (__predict_false(lockstat_enabled))                          \
  148                 lockstat_event((uintptr_t)(lock),                       \
  149                     (uintptr_t)__builtin_return_address(0),             \
  150                     (type), (count), (time));                           \
  151 } while (/* CONSTCOND */ 0);
  152 
  153 #define LOCKSTAT_EVENT_RA(lock, type, count, time, ra)                  \
  154 do {                                                                    \
  155         if (__predict_false(lockstat_enabled))                          \
  156                 lockstat_event((uintptr_t)(lock), (uintptr_t)ra,        \
  157                     (type), (count), (time));                           \
  158 } while (/* CONSTCOND */ 0);
  159 
  160 #define LOCKSTAT_TIMER(name)    uint64_t name = 0
  161 #define LOCKSTAT_COUNTER(name)  uint64_t name = 0
  162 
  163 #define LOCKSTAT_START_TIMER(name)                                      \
  164 do {                                                                    \
  165         (name) -= cpu_counter();                                        \
  166 } while (/* CONSTCOND */ 0)
  167 
  168 #define LOCKSTAT_STOP_TIMER(name)                                       \
  169 do {                                                                    \
  170         (name) += cpu_counter();                                        \
  171 } while (/* CONSTCOND */ 0)
  172 
  173 #define LOCKSTAT_COUNT(name, inc)                                       \
  174 do {                                                                    \
  175         (name) += (inc);                                                \
  176 } while (/* CONSTCOND */ 0)
  177 
  178 void    lockstat_event(uintptr_t, uintptr_t, u_int, u_int, uint64_t);
  179 
  180 extern volatile u_int   lockstat_enabled;
  181 
  182 #else
  183 
  184 #define LOCKSTAT_EVENT(lock, type, count, time)         /* nothing */
  185 #define LOCKSTAT_EVENT_RA(lock, type, count, time, ra)  /* nothing */
  186 #define LOCKSTAT_TIMER(void)                            /* nothing */
  187 #define LOCKSTAT_COUNTER(void)                          /* nothing */
  188 #define LOCKSTAT_START_TIMER(void)                      /* nothing */
  189 #define LOCKSTAT_STOP_TIMER(void)                       /* nothing */
  190 #define LOCKSTAT_COUNT(name, int)                       /* nothing */
  191 
  192 #endif
  193 
  194 #endif  /* _SYS_LOCKSTAT_H_ */

Cache object: 7218c58d726c8efaba05be3b953874eb


[ source navigation ] [ diff markup ] [ identifier search ] [ freetext search ] [ file search ] [ list types ] [ track identifier ]


This page is part of the FreeBSD/Linux Linux Kernel Cross-Reference, and was automatically generated using a modified version of the LXR engine.