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