xref: /xnu-12377.61.12/bsd/sys/os_log_coprocessor.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 /*
29  * @OSF_COPYRIGHT@
30  */
31 /*
32  */
33 
34 #ifndef _OS_LOG_COPROCESSOR_H_
35 #define _OS_LOG_COPROCESSOR_H_
36 
37 #include <stdbool.h>
38 #include <os/log.h>
39 #include <sys/types.h>
40 
41 /*
42  * Userspace coprocessor logging
43  *
44  * Description: sends a syscall ending up at the kernel `os_log_coprocessor` function
45  *
46  */
47 int os_log_coprocessor_as_kernel(void *buff, uint64_t buff_len, os_log_type_t type, const char *uuid, uint64_t timestamp, uint32_t offset, bool stream_log);
48 
49 /*
50  * Userspace coprocessor logging registration
51  *
52  * Description: sends a syscall ending up at the kernel `os_log_coprocessor_register_with_type` function
53  *
54  */
55 int os_log_coprocessor_register_as_kernel(const char *uuid, const char *file_path, size_t file_path_len);
56 
57 #endif /* _OS_LOG_COPROCESSOR_H_ */
58