1 /* 2 * CDDL HEADER START 3 * 4 * The contents of this file are subject to the terms of the 5 * Common Development and Distribution License (the "License"). 6 * You may not use this file except in compliance with the License. 7 * 8 * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE 9 * or http://www.opensolaris.org/os/licensing. 10 * See the License for the specific language governing permissions 11 * and limitations under the License. 12 * 13 * When distributing Covered Code, include this CDDL HEADER in each 14 * file and include the License file at usr/src/OPENSOLARIS.LICENSE. 15 * If applicable, add the following below this CDDL HEADER, with the 16 * fields enclosed by brackets "[]" replaced with your own identifying 17 * information: Portions Copyright [yyyy] [name of copyright owner] 18 * 19 * CDDL HEADER END 20 */ 21 22 /* 23 * Copyright 2008 Sun Microsystems, Inc. All rights reserved. 24 * Use is subject to license terms. 25 */ 26 27 #ifndef _MISC_H 28 #define _MISC_H 29 30 #include <sys/types.h> 31 #include <sys/time.h> 32 #include <thread.h> 33 #include <pthread.h> 34 #include <stdarg.h> 35 #include <stddef.h> 36 37 #ifdef __cplusplus 38 extern "C" { 39 #endif 40 41 extern uint_t umem_abort; /* abort when errors occur */ 42 extern uint_t umem_output; /* output error messages to stderr */ 43 extern caddr_t umem_min_stack; /* max stack address for audit log */ 44 extern caddr_t umem_max_stack; /* min stack address for audit log */ 45 46 /* 47 * a safe printf -- do not use for error messages. 48 */ 49 void debug_printf(const char *format, ...); 50 51 /* 52 * adds a message to the log without writing it out. 53 */ 54 void log_message(const char *format, ...); 55 56 /* 57 * returns the index of the (high/low) bit + 1 58 */ 59 int highbit(ulong_t); 60 int lowbit(ulong_t); 61 #pragma no_side_effect(highbit, lowbit) 62 63 /* 64 * Converts a hrtime_t to a timestruc_t 65 */ 66 void hrt2ts(hrtime_t hrt, timestruc_t *tsp); 67 68 /* 69 * tries to print out the symbol and offset of a pointer using umem_error_info 70 */ 71 int print_sym(void *pointer); 72 73 /* 74 * Information about the current error. Can be called multiple times, should 75 * be followed eventually with a call to umem_err or umem_err_recoverable. 76 */ 77 void umem_printf(const char *format, ...); 78 void umem_vprintf(const char *format, va_list); 79 80 void umem_printf_warn(void *ignored, const char *format, ...); 81 82 void umem_error_enter(const char *); 83 84 /* 85 * prints error message and stack trace, then aborts. Cannot return. 86 */ 87 void umem_panic(const char *format, ...) __NORETURN; 88 #pragma does_not_return(umem_panic) 89 #pragma rarely_called(umem_panic) 90 91 /* 92 * like umem_err, but only aborts if umem_abort > 0 93 */ 94 void umem_err_recoverable(const char *format, ...); 95 96 /* 97 * We define our own assertion handling since libc's assert() calls malloc() 98 */ 99 #ifdef NDEBUG 100 #define ASSERT(assertion) (void)0 101 #else 102 #define ASSERT(assertion) (void)((assertion) || \ 103 __umem_assert_failed(#assertion, __FILE__, __LINE__)) 104 #endif 105 106 int __umem_assert_failed(const char *assertion, const char *file, int line); 107 #pragma does_not_return(__umem_assert_failed) 108 #pragma rarely_called(__umem_assert_failed) 109 /* 110 * These have architecture-specific implementations. 111 */ 112 113 /* 114 * Returns the current function's frame pointer. 115 */ 116 extern void *getfp(void); 117 118 /* 119 * puts a pc-only stack trace of up to pcstack_limit frames into pcstack. 120 * Returns the number of stacks written. 121 * 122 * if check_sighandler != 0, and we are in a signal context, calls 123 * umem_err_recoverable. 124 */ 125 extern int getpcstack(uintptr_t *pcstack, int pcstack_limit, 126 int check_sighandler); 127 128 #ifdef __cplusplus 129 } 130 #endif 131 132 #endif /* _MISC_H */ 133