xref: /xnu-11215/osfmk/corecrypto/cc_debug.h (revision 94d3b452)
1 /* Copyright (c) (2012,2014-2019,2021,2022) Apple Inc. All rights reserved.
2  *
3  * corecrypto is licensed under Apple Inc.’s Internal Use License Agreement (which
4  * is contained in the License.txt file distributed with corecrypto) and only to
5  * people who accept that license. IMPORTANT:  Any license rights granted to you by
6  * Apple Inc. (if any) are limited to internal use within your organization only on
7  * devices and computers you own or control, for the sole purpose of verifying the
8  * security characteristics and correct functioning of the Apple Software.  You may
9  * not, directly or indirectly, redistribute the Apple Software or any portions thereof.
10  *
11  * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
12  *
13  * This file contains Original Code and/or Modifications of Original Code
14  * as defined in and that are subject to the Apple Public Source License
15  * Version 2.0 (the 'License'). You may not use this file except in
16  * compliance with the License. The rights granted to you under the License
17  * may not be used to create, or enable the creation or redistribution of,
18  * unlawful or unlicensed copies of an Apple operating system, or to
19  * circumvent, violate, or enable the circumvention or violation of, any
20  * terms of an Apple operating system software license agreement.
21  *
22  * Please obtain a copy of the License at
23  * http://www.opensource.apple.com/apsl/ and read it before using this file.
24  *
25  * The Original Code and all software distributed under the License are
26  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
27  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
28  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
29  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
30  * Please see the License for the specific language governing rights and
31  * limitations under the License.
32  *
33  * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
34  */
35 
36 //debug configuration header file
37 #ifndef _CORECRYPTO_CCN_DEBUG_H_
38 #define _CORECRYPTO_CCN_DEBUG_H_
39 
40 #include <corecrypto/cc_config.h>
41 
42 // DO NOT INCLUDE this HEADER file in CoreCrypto files added for XNU project or headers
43 // included by external clients.
44 
45 // ========================
46 // Printf for corecrypto
47 // ========================
48 #if CC_KERNEL
49     #include <pexpert/pexpert.h>
50     #define cc_printf(x...) kprintf(x)
51     #if !CONFIG_EMBEDDED
52 extern int printf(const char *format, ...) __cc_printflike(1, 2);
53     #endif
54 #elif CC_IBOOT || CC_RTKIT || CC_RTKITROM
55     #include <stdio.h>
56     #define cc_printf(x...) printf(x)
57 #elif CC_SGX || CC_EFI
58     #define cc_printf(x...)
59 #elif CC_TXM
60     #define cc_printf(x...)
61 #elif CC_SPTM
62     #define cc_printf(x...)
63 #else
64     #include <stdio.h>
65     #define cc_printf(x...) fprintf(stderr, x)
66 #endif
67 
68 // ========================
69 // Integer types
70 // ========================
71 
72 #if CC_KERNEL
73 /* Those are not defined in libkern */
74 #define PRIx64 "llx"
75 #define PRIx32 "x"
76 #define PRIx16 "hx"
77 #define PRIx8  "hhx"
78 #else
79 #include <inttypes.h>
80 #endif
81 
82 #if  CCN_UNIT_SIZE == 8
83 #define CCPRIx_UNIT ".016" PRIx64
84 #elif  CCN_UNIT_SIZE == 4
85 #define CCPRIx_UNIT ".08" PRIx32
86 #else
87 #error invalid CCN_UNIT_SIZE
88 #endif
89 
90 // ========================
91 // Print utilities for corecrypto
92 // ========================
93 
94 #include <corecrypto/cc.h>
95 
96 /* Print a byte array of arbitrary size */
97 void cc_print(const char *label, size_t count, const uint8_t *s);
98 
99 #endif /* _CORECRYPTO_CCN_DEBUG_H_ */
100