OSX/utilities/src/debugging.h

   1 /*
   2  * Copyright (c) 2006-2007,2009-2010,2012-2014 Apple Inc. All Rights Reserved.
   3  *
   4  * @APPLE_LICENSE_HEADER_START@
   5  *
   6  * This file contains Original Code and/or Modifications of Original Code
   7  * as defined in and that are subject to the Apple Public Source License
   8  * Version 2.0 (the 'License'). You may not use this file except in
   9  * compliance with the License. Please obtain a copy of the License at
  10  * http://www.opensource.apple.com/apsl/ and read it before using this
  11  * file.
  12  *
  13  * The Original Code and all software distributed under the License are
  14  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  15  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  16  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
  17  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
  18  * Please see the License for the specific language governing rights and
  19  * limitations under the License.
  20  *
  21  * @APPLE_LICENSE_HEADER_END@
  22  */
  23
  24 /*
  25  * debugging.h - non-trivial debug support
  26  */
  27
  28 /*
  29  * CONFIGURING DEFAULT DEBUG SCOPES
  30  *
  31  * Default debug "scope" inclusion / exclusion is configured in  com.apple.securityd.plist (iOS) and
  32  * com.apple.secd.plist (OSX) in the Environmental Variable "DEBUGSCOPE".  The current value for that
  33  * variable begins with a dash ("-") indicating an "exclusion list".  If you add a scope for a
  34  * secnotice, etc that you don't want to always be "on" add the new string to the DEBUGSCOPE variable
  35  * in both plists.
  36  */
  37
  38 #ifndef _SECURITY_UTILITIES_DEBUGGING_H_
  39 #define _SECURITY_UTILITIES_DEBUGGING_H_
  40
  41 #if TARGET_OS_OSX
  42 #include <security_utilities/debugging_internal.h>
  43 #endif
  44
  45 #ifdef KERNEL
  46         #include <libkern/libkern.h>
  47         #define secalert(format, ...) printf((format), ## __VA_ARGS__)
  48         #define secemergency(format, ...) printf((format), ## __VA_ARGS__)
  49         #define seccritical(format, ...) printf((format), ## __VA_ARGS__)
  50         #define secerror(format, ...) printf((format), ## __VA_ARGS__)
  51         #define secwarning(format, ...) printf((format), ## __VA_ARGS__)
  52         #define secnotice(scope, format, ...) printf((format), ## __VA_ARGS__)
  53         #define secnoticeq(scope, format, ...) printf((format), ## __VA_ARGS__)
  54         #define secinfo(scope, format, ...) printf((format), ## __VA_ARGS__)
  55     #undef secdebug
  56     #if !defined(NDEBUG)
  57         #define secdebug(scope, format, ...) printf((format), ## __VA_ARGS__)
  58     #else // NDEBUG
  59         #define secdebug(scope, format, ...)    /* nothing */
  60     #endif // NDEBUG
  61 #else // !KERNEL
  62
  63 #include <TargetConditionals.h>
  64 #include <CoreFoundation/CFString.h>
  65 #include <asl.h>
  66
  67 __BEGIN_DECLS
  68
  69 #define SECLOG_LEVEL_EMERG  0
  70 #define SECLOG_LEVEL_ALERT  1
  71 #define SECLOG_LEVEL_CRIT   2
  72 #define SECLOG_LEVEL_ERR    3
  73 #define SECLOG_LEVEL_WARNING 4
  74 #define SECLOG_LEVEL_NOTICE 5
  75 #define SECLOG_LEVEL_INFO   6
  76 #define SECLOG_LEVEL_DEBUG  7
  77
  78 #include <os/log_private.h>
  79 extern os_log_t secLogObjForScope(const char *scope);
  80 extern os_log_t secLogObjForCFScope(CFStringRef scope);
  81 extern bool secLogEnabled(void);
  82 extern void secLogDisable(void);
  83 extern void secLogEnable(void);
  84
  85 #if TARGET_OS_OSX
  86 // Downstream projects link these, but we no longer use them internally. Keep them here for now.
  87 // <rdar://problem/31765903> Remove weak-linked os_log functions
  88 void weak_os_log_impl(void *dso, os_log_t log, os_log_type_t type, const char *format, uint8_t *buf, unsigned int size);
  89 os_log_t weak_os_log_create(const char *subsystem, const char *category);
  90 bool weak_os_log_type_enabled(os_log_t oslog, os_log_type_t type);
  91 #endif // TARGET_OS_OSX
  92
  93 CFStringRef SecLogAPICreate(bool apiIn, const char *api, CFStringRef format, ...)
  94     CF_FORMAT_FUNCTION(3, 4);
  95
  96 extern const char *api_trace;
  97
  98 #define sec_trace_enter_api(format...) { \
  99     CFStringRef info = SecLogAPICreate(true, __FUNCTION__, format, NULL); \
 100     secinfo(api_trace, "%@",  info); CFReleaseNull(info); \
 101 }
 102
 103 #define sec_trace_return_api(rtype, body, format...) { \
 104     rtype _r = body(); \
 105     CFStringRef info = SecLogAPICreate(true, __FUNCTION__, format, _r); \
 106     secinfo(api_trace, "%@",  info); \
 107     CFReleaseNull(info); return _r; \
 108 }
 109
 110 #define sec_trace_return_bool_api(body, format...) { \
 111     bool _r = body(); \
 112     CFStringRef info = SecLogAPICreate(true, __FUNCTION__, format ? format : CFSTR("return=%d"), _r); \
 113     secinfo(api_trace, "%@",  info); \
 114     CFReleaseNull(info); return _r; \
 115 }
 116
 117 #define secemergency(format, ...)       os_log_error(secLogObjForScope("SecEmergency"), format, ## __VA_ARGS__)
 118 #define secalert(format, ...)           os_log_error(secLogObjForScope("SecAlert"), format, ## __VA_ARGS__)
 119 #define seccritical(format, ...)        os_log(secLogObjForScope("SecCritical"), format, ## __VA_ARGS__)
 120 #define secerror(format, ...)           os_log(secLogObjForScope("SecError"), format, ## __VA_ARGS__)
 121 #define secerrorq(format, ...)          os_log(secLogObjForScope("SecError"), format, ## __VA_ARGS__)
 122 #define secwarning(format, ...)         os_log(secLogObjForScope("SecWarning"), format, ## __VA_ARGS__)
 123 #define secnotice(scope, format, ...)   os_log(secLogObjForScope(scope), format, ## __VA_ARGS__)
 124 #define secnoticeq(scope, format, ...)  os_log(secLogObjForScope(scope), format, ## __VA_ARGS__)
 125 #define secinfo(scope, format, ...)     os_log_debug(secLogObjForScope(scope), format, ## __VA_ARGS__)
 126
 127 #define secinfoenabled(scope)           os_log_debug_enabled(secLogObjForScope(scope))
 128
 129 // secdebug is used for things that might not be privacy safe at all, so only debug builds can have these traces
 130 #undef secdebug
 131 #if !defined(NDEBUG)
 132 #define secdebug(scope, format, ...)    os_log_debug(secLogObjForScope(scope), format, ## __VA_ARGS__)
 133 #else
 134 # define secdebug(scope,...)    /* nothing */
 135 #endif
 136
 137 typedef void (^security_log_handler)(int level, CFStringRef scope, const char *function,
 138                                      const char *file, int line, CFStringRef message);
 139
 140 /* To simulate a process crash in some conditions */
 141 void __security_simulatecrash(CFStringRef reason, uint32_t code);
 142 void __security_stackshotreport(CFStringRef reason, uint32_t code);
 143
 144 /* predefined simulate crash exception codes */
 145 #define __sec_exception_code(x) (0x53c00000+x)
 146 /* 1 was __sec_exception_code_CorruptDb */
 147 #define __sec_exception_code_CorruptItem            __sec_exception_code(2)
 148 #define __sec_exception_code_OTRError               __sec_exception_code(3)
 149 #define __sec_exception_code_DbItemDescribe         __sec_exception_code(4)
 150 #define __sec_exception_code_TwiceCorruptDb(db)     __sec_exception_code(5|((db)<<8))
 151 #define __sec_exception_code_AuthLoop               __sec_exception_code(6)
 152 #define __sec_exception_code_MissingEntitlements    __sec_exception_code(7)
 153 #define __sec_exception_code_LostInMist             __sec_exception_code(8)
 154 #define __sec_exception_code_CKD_nil_pending_keys   __sec_exception_code(9)
 155 #define __sec_exception_code_SQLiteBusy             __sec_exception_code(10)
 156 #define __sec_exception_code_CorruptDb(rc)          __sec_exception_code(11|((rc)<<8))
 157 #define __sec_exception_code_Watchdog               __sec_exception_code(12)
 158
 159 /* For testing only, turns off/on simulated crashes, when turning on, returns number of
 160    simulated crashes which were not reported since last turned off. */
 161 int __security_simulatecrash_enable(bool enable);
 162
 163 /* Logging control functions */
 164
 165 typedef enum {
 166     kScopeIDEnvironment = 0,
 167     kScopeIDDefaults = 1,
 168     kScopeIDConfig = 2,
 169     kScopeIDXPC = 3,
 170     kScopeIDCircle = 4,
 171     kScopeIDMax = 4,
 172 } SecDebugScopeID;
 173
 174 void ApplyScopeListForID(CFStringRef scopeList, SecDebugScopeID whichID);
 175 void ApplyScopeDictionaryForID(CFDictionaryRef scopeList, SecDebugScopeID whichID);
 176 CFPropertyListRef CopyCurrentScopePlist(void);
 177
 178 __END_DECLS
 179
 180 #endif // !KERNEL
 181
 182 #endif /* _SECURITY_UTILITIES_DEBUGGING_H_ */