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 * 7 * Redistribution and use in source and binary forms, with or without 8 * modification, are permitted provided that the following conditions 9 * are met: 10 * 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 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 32 * SUCH DAMAGE. 33 * 34 * $DragonFly: src/sys/sys/ktr.h,v 1.11 2007/06/07 18:03:15 dillon Exp $ 35 */ 36 /* 37 * Generic Kernel trace buffer support. 38 * 39 */ 40 41 #ifndef _SYS_KTR_H_ 42 #define _SYS_KTR_H_ 43 44 #ifndef _SYS_TYPES_H_ 45 #include <sys/types.h> 46 #endif 47 #ifndef _SYS_SYSCTL_H_ 48 #include <sys/sysctl.h> 49 #endif 50 51 #ifdef _KERNEL 52 #include "opt_ktr.h" 53 #endif 54 55 /* 56 * Conveniently auto-enable KTRs when particular KTRs are specified 57 * in kernel options. This way we can get logging during boot. 58 * However, if KTR_ALL is optioned, just disable everything by default. 59 * The user can enable individual masks via sysctl. 60 */ 61 #if defined(KTR_ALL) 62 #define KTR_AUTO_ENABLE 0 63 #else 64 #define KTR_ALL 0 65 #define KTR_AUTO_ENABLE -1 66 #endif 67 68 #define KTR_BUFSIZE 48 69 #define KTR_VERSION 3 70 71 #ifndef LOCORE 72 73 struct ktr_info { 74 const char *kf_name; /* human-interpreted subsystem name */ 75 int32_t *kf_master_enable; /* the master enable variable */ 76 const char *kf_format; /* data format */ 77 int kf_data_size; /* relevance of the data buffer */ 78 }; 79 80 struct ktr_entry { 81 u_int64_t ktr_timestamp; 82 struct ktr_info *ktr_info; 83 const char *ktr_file; 84 void *ktr_caller1; 85 void *ktr_caller2; 86 int32_t ktr_line; 87 int32_t ktr_unused; 88 int32_t ktr_data[KTR_BUFSIZE / sizeof(int32_t)]; 89 }; 90 91 void ktr_log(struct ktr_info *info, const char *file, int line, ...); 92 void ktr_log_ptr(struct ktr_info *info, const char *file, int line, const void *ptr); 93 void cpu_ktr_caller(struct ktr_entry *ktr); 94 95 /* 96 * Take advantage of constant integer optimizations by the compiler 97 * to optimize-out disabled code at compile-time. If KTR_ENABLE_<name> 98 * is 0, the compiler avoids generating all related code when KTR is enabled. 99 */ 100 101 #ifdef KTR 102 103 SYSCTL_DECL(_debug_ktr); 104 105 #define KTR_INFO_MASTER(master) \ 106 SYSCTL_NODE(_debug_ktr, OID_AUTO, master, CTLFLAG_RW, 0, ""); \ 107 int ktr_ ## master ## _enable = KTR_AUTO_ENABLE; \ 108 SYSCTL_INT(_debug_ktr, OID_AUTO, master ## _enable, CTLFLAG_RW, \ 109 &ktr_ ## master ## _enable, 0, "") 110 111 #define KTR_INFO_MASTER_EXTERN(master) \ 112 SYSCTL_DECL(_debug_ktr_ ## master); \ 113 extern int ktr_ ## master ## _enable \ 114 115 /* 116 * This creates a read-only sysctl so the user knows what the mask 117 * definitions are and a number of static const int's which are used 118 * by the compiler to optimize the trace logging at compile-time and 119 * run-time. 120 */ 121 #define KTR_INFO(compile, master, name, maskbit, format, datasize) \ 122 static const int ktr_ ## master ## _ ## name ## _mask = \ 123 1 << maskbit; \ 124 static const int ktr_ ## master ## _ ## name ## _enable = \ 125 compile; \ 126 static int ktr_ ## master ## _ ## name ## _mask_ro = \ 127 1 << maskbit; \ 128 SYSCTL_INT(_debug_ktr_ ## master, OID_AUTO, name ## _mask, \ 129 CTLFLAG_RD, &ktr_ ## master ## _ ## name ## _mask_ro, \ 130 0, ""); \ 131 static struct ktr_info ktr_info_ ## master ## _ ## name = { \ 132 #master "_" #name, \ 133 &ktr_ ## master ## _enable, \ 134 format, \ 135 datasize } 136 137 #define KTR_LOG(name, args...) \ 138 if (ktr_ ## name ## _enable && \ 139 (ktr_ ## name ## _mask & *ktr_info_ ## name .kf_master_enable)) \ 140 ktr_log(&ktr_info_ ## name, __FILE__, __LINE__, ##args) 141 142 #define KTR_LOG_PTR(name, ptr) \ 143 if (ktr_ ## name ## _enable && \ 144 (ktr_ ## name ## _mask & *ktr_info_ ## name .kf_master_enable)) \ 145 ktr_log_ptr(&ktr_info_ ## name, __FILE__, __LINE__, ptr) 146 147 #else 148 149 #define KTR_INFO_MASTER(master) \ 150 const static int ktr_ ## master ## _enable = 0 151 152 #define KTR_INFO_MASTER_EXTERN(master) \ 153 const static int ktr_ ## master ## _enable = 0 154 155 #define KTR_INFO(compile, master, name, maskbit, format, datasize) \ 156 static const int ktr_ ## master ## _ ## name ## _mask = \ 157 1 << maskbit 158 159 #define KTR_LOG(info, args...) 160 #define KTR_LOG_PTR(info, ptr) 161 162 #endif 163 164 #endif /* !LOCORE */ 165 #endif /* !_SYS_KTR_H_ */ 166