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