xref: /xnu-11215.41.3/osfmk/corecrypto/fipspost_trace.h (revision 33de042d024d46de5ff4e89f2471de6608e37fa4)
1 /* Copyright (c) (2017,2019) 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 #ifndef _CORECRYPTO_FIPSPOST_TRACE_H_
37 #define _CORECRYPTO_FIPSPOST_TRACE_H_
38 
39 #if CC_FIPSPOST_TRACE
40 
41 /*
42  * Use this string to separate out tests.
43  */
44 #define FIPSPOST_TRACE_TEST_STR    "?"
45 
46 int fipspost_trace_is_active(void);
47 void fipspost_trace_call(const char *fname);
48 
49 /* Only trace when VERBOSE is set to avoid impacting normal boots. */
50 #define FIPSPOST_TRACE_EVENT do {                                       \
51     if (fipspost_trace_is_active()) {                                   \
52 	fipspost_trace_call(__FUNCTION__);                              \
53     }                                                                   \
54 } while (0);
55 
56 #define FIPSPOST_TRACE_MESSAGE(MSG) do {                                \
57     if (fipspost_trace_is_active()) {                                   \
58 	fipspost_trace_call(MSG);                                       \
59     }                                                                   \
60 } while (0);
61 
62 #else
63 
64 /* Not building a CC_FIPSPOST_TRACE-enabled, no TRACE operations. */
65 #define FIPSPOST_TRACE_EVENT
66 #define FIPSPOST_TRACE_MESSAGE(X)
67 
68 #endif
69 
70 #endif
71