Use the KTR facility to trace token operations.
[dragonfly.git] / sys / sys / ktr.h
CommitLineData
d3776285
MD
1/*
2 * Copyright (c) 2005 The DragonFly Project. All rights reserved.
3 *
4 * This code is derived from software contributed to The DragonFly Project
5 * by Matthew Dillon <dillon@backplane.com>
6 *
81540c2d
EN
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
9 * are met:
d3776285 10 *
81540c2d
EN
11 * 1. Redistributions of source code must retain the above copyright
12 * notice, this list of conditions and the following disclaimer.
13 * 2. Redistributions in binary form must reproduce the above copyright
d3776285
MD
14 * notice, this list of conditions and the following disclaimer in
15 * the documentation and/or other materials provided with the
16 * distribution.
17 * 3. Neither the name of The DragonFly Project nor the names of its
18 * contributors may be used to endorse or promote products derived
19 * from this software without specific, prior written permission.
20 *
21 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
22 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
23 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
24 * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
25 * COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
26 * INCIDENTAL, SPECIAL, EXEMPLARY OR CONSEQUENTIAL DAMAGES (INCLUDING,
27 * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
28 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
29 * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
30 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
31 * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
81540c2d 32 * SUCH DAMAGE.
d3776285
MD
33 *
34 * $DragonFly: src/sys/sys/ktr.h,v 1.5 2005/06/20 17:59:30 dillon Exp $
81540c2d 35 */
81540c2d 36/*
d3776285
MD
37 * Generic Kernel trace buffer support.
38 *
81540c2d
EN
39 */
40
41#ifndef _SYS_KTR_H_
42#define _SYS_KTR_H_
43
282a0149 44#ifdef _KERNEL
81540c2d 45#include "opt_ktr.h"
282a0149 46#endif
81540c2d 47
d3776285
MD
48#if !defined(KTR_ALL)
49#define KTR_ALL 0
81540c2d
EN
50#endif
51
d3776285
MD
52#define KTR_BUFSIZE 48
53#define KTR_VERSION 2
81540c2d
EN
54
55#ifndef LOCORE
56
d3776285
MD
57struct ktr_info {
58 const char *kf_name; /* human-interpreted subsystem name */
59 int32_t *kf_master_enable; /* the master enable variable */
60 const char *kf_format; /* data format */
61 int kf_data_size; /* relevance of the data buffer */
62};
63
81540c2d
EN
64struct ktr_entry {
65 u_int64_t ktr_timestamp;
d3776285 66 struct ktr_info *ktr_info;
81540c2d 67 const char *ktr_file;
d3776285
MD
68 void *ktr_caller1;
69 void *ktr_caller2;
70 int32_t ktr_line;
71 int32_t ktr_unused;
72 char ktr_data[KTR_BUFSIZE];
81540c2d
EN
73};
74
d3776285
MD
75void ktr_log(struct ktr_info *info, const char *file, int line, ...);
76void ktr_log_ptr(struct ktr_info *info, const char *file, int line, const void *ptr);
81540c2d 77
d3776285
MD
78/*
79 * Take advantage of constant integer optimizations by the compiler
80 * to optimize-out disabled code at compile-time. If KTR_ENABLE_<name>
81 * is 0, the compiler avoids generating all related code when KTR is enabled.
82 */
81540c2d
EN
83
84#ifdef KTR
85
d3776285
MD
86SYSCTL_DECL(_debug_ktr);
87
88#define KTR_INFO_MASTER(master) \
89 SYSCTL_NODE(_debug_ktr, OID_AUTO, master, CTLFLAG_RW, 0, ""); \
90 int ktr_ ## master ## _enable = -1; \
91 SYSCTL_INT(_debug_ktr, OID_AUTO, master ## _enable, CTLFLAG_RW, \
92 &ktr_ ## master ## _enable, 0, "")
93
94#define KTR_INFO_MASTER_EXTERN(master) \
95 SYSCTL_DECL(_debug_ktr_ ## master); \
96 extern int ktr_ ## master ## _enable \
81540c2d
EN
97
98/*
d3776285
MD
99 * This creates a read-only sysctl so the user knows what the mask
100 * definitions are and a number of static const int's which are used
101 * by the compiler to optimize the trace logging at compile-time and
102 * run-time.
81540c2d 103 */
d3776285
MD
104#define KTR_INFO(compile, master, name, maskbit, format, datasize) \
105 static const int ktr_ ## master ## _ ## name ## _mask = \
106 1 << maskbit; \
107 static const int ktr_ ## master ## _ ## name ## _enable = \
108 compile; \
109 static int ktr_ ## master ## _ ## name ## _mask_ro = \
110 1 << maskbit; \
111 SYSCTL_INT(_debug_ktr_ ## master, OID_AUTO, name ## _mask, \
112 CTLFLAG_RD, &ktr_ ## master ## _ ## name ## _mask_ro, \
113 0, ""); \
114 static struct ktr_info ktr_info_ ## master ## _ ## name = { \
115 #master "_" #name, \
116 &ktr_ ## master ## _enable, \
117 format, \
118 datasize }
119
120#define KTR_LOG(name, args...) \
121 if (ktr_ ## name ## _enable && \
122 (ktr_ ## name ## _mask & *ktr_info_ ## name .kf_master_enable)) \
123 ktr_log(&ktr_info_ ## name, __FILE__, __LINE__, ##args)
124
125#define KTR_LOG_PTR(name, ptr) \
126 if (ktr_ ## name ## _enable && \
127 (ktr_ ## name ## _mask & *ktr_info_ ## name .kf_master_enable)) \
128 ktr_log_ptr(&ktr_info_ ## name, __FILE__, __LINE__, ptr)
129
81540c2d 130#else
d3776285
MD
131
132#define KTR_INFO_MASTER(master) \
133 const static int ktr_ ## master ## _enable = 0
134
135#define KTR_INFO_MASTER_EXTERN(master) \
136 const static int ktr_ ## master ## _enable = 0
137
138#define KTR_INFO(master, name, maskbit, format, datasize) \
139 static const int ktr_ ## master ## _ ## name ## _mask = \
140 1 << maskbit
141
142#define KTR_LOG(info, args...)
143#define KTR_LOG_PTR(info, ptr)
144
81540c2d
EN
145#endif
146
d3776285 147#endif /* !LOCORE */
81540c2d 148#endif /* !_SYS_KTR_H_ */