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.12 2008/06/20 01:23:27 y0netan1 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 192 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 cpu_ktr_caller(struct ktr_entry *ktr); 93 94 /* 95 * Take advantage of constant integer optimizations by the compiler 96 * to optimize-out disabled code at compile-time. If KTR_ENABLE_<name> 97 * is 0, the compiler avoids generating all related code when KTR is enabled. 98 */ 99 100 #ifdef KTR 101 102 SYSCTL_DECL(_debug_ktr); 103 104 #define KTR_INFO_MASTER(master) \ 105 SYSCTL_NODE(_debug_ktr, OID_AUTO, master, CTLFLAG_RW, 0, ""); \ 106 int ktr_ ## master ## _enable = KTR_AUTO_ENABLE; \ 107 SYSCTL_INT(_debug_ktr, OID_AUTO, master ## _enable, CTLFLAG_RW, \ 108 &ktr_ ## master ## _enable, 0, "") 109 110 #define KTR_INFO_MASTER_EXTERN(master) \ 111 SYSCTL_DECL(_debug_ktr_ ## master); \ 112 extern int ktr_ ## master ## _enable \ 113 114 /* 115 * This creates a read-only sysctl so the user knows what the mask 116 * definitions are and a number of static const int's which are used 117 * by the compiler to optimize the trace logging at compile-time and 118 * run-time. 119 */ 120 #define KTR_INFO(compile, master, name, maskbit, format, datasize) \ 121 static const int ktr_ ## master ## _ ## name ## _mask = \ 122 1 << maskbit; \ 123 static const int ktr_ ## master ## _ ## name ## _enable = \ 124 compile; \ 125 static int ktr_ ## master ## _ ## name ## _mask_ro = \ 126 1 << maskbit; \ 127 SYSCTL_INT(_debug_ktr_ ## master, OID_AUTO, name ## _mask, \ 128 CTLFLAG_RD, &ktr_ ## master ## _ ## name ## _mask_ro, \ 129 0, ""); \ 130 static struct ktr_info ktr_info_ ## master ## _ ## name = { \ 131 #master "_" #name, \ 132 &ktr_ ## master ## _enable, \ 133 format, \ 134 datasize } 135 136 #define KTR_LOG(name, args...) \ 137 if (ktr_ ## name ## _enable && \ 138 (ktr_ ## name ## _mask & *ktr_info_ ## name .kf_master_enable)) \ 139 ktr_log(&ktr_info_ ## name, __FILE__, __LINE__, ##args) 140 141 #else 142 143 #define KTR_INFO_MASTER(master) \ 144 const static int ktr_ ## master ## _enable = 0 145 146 #define KTR_INFO_MASTER_EXTERN(master) \ 147 const static int ktr_ ## master ## _enable 148 149 #define KTR_INFO(compile, master, name, maskbit, format, datasize) \ 150 static const int ktr_ ## master ## _ ## name ## _mask = \ 151 1 << maskbit 152 153 #define KTR_LOG(info, args...) 154 155 #endif 156 157 #endif /* !LOCORE */ 158 #endif /* !_SYS_KTR_H_ */ 159