xref: /xnu-12377.1.9/libkern/os/firehose.h (revision f6217f891ac0bb64f3d375211650a4c1ff8ca1ea)
1*f6217f89SApple OSS Distributions /*
2*f6217f89SApple OSS Distributions  * Copyright (c) 2015 Apple Inc. All rights reserved.
3*f6217f89SApple OSS Distributions  *
4*f6217f89SApple OSS Distributions  * @APPLE_LICENSE_HEADER_START@
5*f6217f89SApple OSS Distributions  *
6*f6217f89SApple OSS Distributions  * This file contains Original Code and/or Modifications of Original Code
7*f6217f89SApple OSS Distributions  * as defined in and that are subject to the Apple Public Source License
8*f6217f89SApple OSS Distributions  * Version 2.0 (the 'License'). You may not use this file except in
9*f6217f89SApple OSS Distributions  * compliance with the License. Please obtain a copy of the License at
10*f6217f89SApple OSS Distributions  * http://www.opensource.apple.com/apsl/ and read it before using this
11*f6217f89SApple OSS Distributions  * file.
12*f6217f89SApple OSS Distributions  *
13*f6217f89SApple OSS Distributions  * The Original Code and all software distributed under the License are
14*f6217f89SApple OSS Distributions  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
15*f6217f89SApple OSS Distributions  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
16*f6217f89SApple OSS Distributions  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
17*f6217f89SApple OSS Distributions  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
18*f6217f89SApple OSS Distributions  * Please see the License for the specific language governing rights and
19*f6217f89SApple OSS Distributions  * limitations under the License.
20*f6217f89SApple OSS Distributions  *
21*f6217f89SApple OSS Distributions  * @APPLE_LICENSE_HEADER_END@
22*f6217f89SApple OSS Distributions  */
23*f6217f89SApple OSS Distributions 
24*f6217f89SApple OSS Distributions #ifndef __firehose_h
25*f6217f89SApple OSS Distributions #define __firehose_h
26*f6217f89SApple OSS Distributions 
27*f6217f89SApple OSS Distributions __BEGIN_DECLS
28*f6217f89SApple OSS Distributions 
29*f6217f89SApple OSS Distributions /*!
30*f6217f89SApple OSS Distributions  * @function __firehose_buffer_push_to_logd
31*f6217f89SApple OSS Distributions  *
32*f6217f89SApple OSS Distributions  * @abstract
33*f6217f89SApple OSS Distributions  * Called by the dispatch firehose apis to notify logd that a chunk is available
34*f6217f89SApple OSS Distributions  */
35*f6217f89SApple OSS Distributions __WATCHOS_AVAILABLE(3.0) __OSX_AVAILABLE(10.12) __IOS_AVAILABLE(10.0) __TVOS_AVAILABLE(10.0)
36*f6217f89SApple OSS Distributions void __firehose_buffer_push_to_logd(firehose_buffer_t fb, bool for_io);
37*f6217f89SApple OSS Distributions 
38*f6217f89SApple OSS Distributions /*!
39*f6217f89SApple OSS Distributions  * @function __firehose_allocate
40*f6217f89SApple OSS Distributions  *
41*f6217f89SApple OSS Distributions  * @abstract
42*f6217f89SApple OSS Distributions  * Wrapper to allocate kernel memory
43*f6217f89SApple OSS Distributions  */
44*f6217f89SApple OSS Distributions __WATCHOS_AVAILABLE(3.0) __OSX_AVAILABLE(10.12) __IOS_AVAILABLE(10.0) __TVOS_AVAILABLE(10.0)
45*f6217f89SApple OSS Distributions void __firehose_allocate(vm_offset_t *addr, vm_size_t size);
46*f6217f89SApple OSS Distributions 
47*f6217f89SApple OSS Distributions /*!
48*f6217f89SApple OSS Distributions  * @function __firehose_critical_region_enter
49*f6217f89SApple OSS Distributions  *
50*f6217f89SApple OSS Distributions  * @abstract
51*f6217f89SApple OSS Distributions  * Function that disables preemption
52*f6217f89SApple OSS Distributions  */
53*f6217f89SApple OSS Distributions __WATCHOS_AVAILABLE(3.0) __OSX_AVAILABLE(10.12) __IOS_AVAILABLE(10.0) __TVOS_AVAILABLE(10.0)
54*f6217f89SApple OSS Distributions extern void __firehose_critical_region_enter(void);
55*f6217f89SApple OSS Distributions 
56*f6217f89SApple OSS Distributions /*!
57*f6217f89SApple OSS Distributions  * @function __firehose_critical_region_leave
58*f6217f89SApple OSS Distributions  *
59*f6217f89SApple OSS Distributions  * @abstract
60*f6217f89SApple OSS Distributions  * Function that enables preemption
61*f6217f89SApple OSS Distributions  */
62*f6217f89SApple OSS Distributions __WATCHOS_AVAILABLE(3.0) __OSX_AVAILABLE(10.12) __IOS_AVAILABLE(10.0) __TVOS_AVAILABLE(10.0)
63*f6217f89SApple OSS Distributions extern void __firehose_critical_region_leave(void);
64*f6217f89SApple OSS Distributions 
65*f6217f89SApple OSS Distributions extern void oslogwakeup(void);
66*f6217f89SApple OSS Distributions 
67*f6217f89SApple OSS Distributions __END_DECLS
68*f6217f89SApple OSS Distributions 
69*f6217f89SApple OSS Distributions #endif /* __firehose_h */
70