xref: /xnu-12377.41.6/osfmk/vm/vm_log.h (revision bbb1b6f9e71b8cdde6e5cd6f4841f207dee3d828)
1*bbb1b6f9SApple OSS Distributions /*
2*bbb1b6f9SApple OSS Distributions  * Copyright (c) 2024 Apple Inc. All rights reserved.
3*bbb1b6f9SApple OSS Distributions  *
4*bbb1b6f9SApple OSS Distributions  * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
5*bbb1b6f9SApple OSS Distributions  *
6*bbb1b6f9SApple OSS Distributions  * This file contains Original Code and/or Modifications of Original Code
7*bbb1b6f9SApple OSS Distributions  * as defined in and that are subject to the Apple Public Source License
8*bbb1b6f9SApple OSS Distributions  * Version 2.0 (the 'License'). You may not use this file except in
9*bbb1b6f9SApple OSS Distributions  * compliance with the License. The rights granted to you under the License
10*bbb1b6f9SApple OSS Distributions  * may not be used to create, or enable the creation or redistribution of,
11*bbb1b6f9SApple OSS Distributions  * unlawful or unlicensed copies of an Apple operating system, or to
12*bbb1b6f9SApple OSS Distributions  * circumvent, violate, or enable the circumvention or violation of, any
13*bbb1b6f9SApple OSS Distributions  * terms of an Apple operating system software license agreement.
14*bbb1b6f9SApple OSS Distributions  *
15*bbb1b6f9SApple OSS Distributions  * Please obtain a copy of the License at
16*bbb1b6f9SApple OSS Distributions  * http://www.opensource.apple.com/apsl/ and read it before using this file.
17*bbb1b6f9SApple OSS Distributions  *
18*bbb1b6f9SApple OSS Distributions  * The Original Code and all software distributed under the License are
19*bbb1b6f9SApple OSS Distributions  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
20*bbb1b6f9SApple OSS Distributions  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
21*bbb1b6f9SApple OSS Distributions  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
22*bbb1b6f9SApple OSS Distributions  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
23*bbb1b6f9SApple OSS Distributions  * Please see the License for the specific language governing rights and
24*bbb1b6f9SApple OSS Distributions  * limitations under the License.
25*bbb1b6f9SApple OSS Distributions  *
26*bbb1b6f9SApple OSS Distributions  * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
27*bbb1b6f9SApple OSS Distributions  */
28*bbb1b6f9SApple OSS Distributions #include <kern/macro_help.h>
29*bbb1b6f9SApple OSS Distributions #include <os/base_private.h>
30*bbb1b6f9SApple OSS Distributions #include <os/log.h>
31*bbb1b6f9SApple OSS Distributions #include <stdbool.h>
32*bbb1b6f9SApple OSS Distributions 
33*bbb1b6f9SApple OSS Distributions #pragma once
34*bbb1b6f9SApple OSS Distributions 
35*bbb1b6f9SApple OSS Distributions extern os_log_t vm_log_handle;
36*bbb1b6f9SApple OSS Distributions extern bool vm_log_debug_enabled;
37*bbb1b6f9SApple OSS Distributions extern bool vm_log_to_serial;
38*bbb1b6f9SApple OSS Distributions 
39*bbb1b6f9SApple OSS Distributions #define _vm_log_with_type(type, format, ...) MACRO_BEGIN \
40*bbb1b6f9SApple OSS Distributions 	if (os_unlikely(vm_log_to_serial)) { \
41*bbb1b6f9SApple OSS Distributions 	        printf("vm: " format, ##__VA_ARGS__); \
42*bbb1b6f9SApple OSS Distributions 	} else { \
43*bbb1b6f9SApple OSS Distributions 	        os_log_with_startup_serial_and_type(vm_log_handle, type, "vm: " format, ##__VA_ARGS__); \
44*bbb1b6f9SApple OSS Distributions 	} \
45*bbb1b6f9SApple OSS Distributions MACRO_END
46*bbb1b6f9SApple OSS Distributions #define vm_log(format, ...) _vm_log_with_type(OS_LOG_TYPE_DEFAULT, format, ##__VA_ARGS__)
47*bbb1b6f9SApple OSS Distributions #define vm_log_info(format, ...) _vm_log_with_type(OS_LOG_TYPE_INFO, format, ##__VA_ARGS__)
48*bbb1b6f9SApple OSS Distributions #define vm_log_debug(format, ...) \
49*bbb1b6f9SApple OSS Distributions MACRO_BEGIN \
50*bbb1b6f9SApple OSS Distributions 	if (os_unlikely(vm_log_debug_enabled)) { \
51*bbb1b6f9SApple OSS Distributions 	        _vm_log_with_type(OS_LOG_TYPE_DEBUG, format, ##__VA_ARGS__); \
52*bbb1b6f9SApple OSS Distributions 	} \
53*bbb1b6f9SApple OSS Distributions MACRO_END
54*bbb1b6f9SApple OSS Distributions #define vm_log_error(format, ...) _vm_log_with_type(OS_LOG_TYPE_ERROR, format, ##__VA_ARGS__)
55*bbb1b6f9SApple OSS Distributions #define vm_log_fault(format, ...) _vm_log_with_type(OS_LOG_TYPE_FAULT, format, ##__VA_ARGS__)
56