xref: /xnu-11215.41.3/iokit/IOKit/IOGuardPageMemoryDescriptor.h (revision 33de042d024d46de5ff4e89f2471de6608e37fa4)
1*33de042dSApple OSS Distributions /*
2*33de042dSApple OSS Distributions  * Copyright (c) 1998-2020 Apple Computer, Inc. All rights reserved.
3*33de042dSApple OSS Distributions  *
4*33de042dSApple OSS Distributions  * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
5*33de042dSApple OSS Distributions  *
6*33de042dSApple OSS Distributions  * This file contains Original Code and/or Modifications of Original Code
7*33de042dSApple OSS Distributions  * as defined in and that are subject to the Apple Public Source License
8*33de042dSApple OSS Distributions  * Version 2.0 (the 'License'). You may not use this file except in
9*33de042dSApple OSS Distributions  * compliance with the License. The rights granted to you under the License
10*33de042dSApple OSS Distributions  * may not be used to create, or enable the creation or redistribution of,
11*33de042dSApple OSS Distributions  * unlawful or unlicensed copies of an Apple operating system, or to
12*33de042dSApple OSS Distributions  * circumvent, violate, or enable the circumvention or violation of, any
13*33de042dSApple OSS Distributions  * terms of an Apple operating system software license agreement.
14*33de042dSApple OSS Distributions  *
15*33de042dSApple OSS Distributions  * Please obtain a copy of the License at
16*33de042dSApple OSS Distributions  * http://www.opensource.apple.com/apsl/ and read it before using this file.
17*33de042dSApple OSS Distributions  *
18*33de042dSApple OSS Distributions  * The Original Code and all software distributed under the License are
19*33de042dSApple OSS Distributions  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
20*33de042dSApple OSS Distributions  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
21*33de042dSApple OSS Distributions  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
22*33de042dSApple OSS Distributions  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
23*33de042dSApple OSS Distributions  * Please see the License for the specific language governing rights and
24*33de042dSApple OSS Distributions  * limitations under the License.
25*33de042dSApple OSS Distributions  *
26*33de042dSApple OSS Distributions  * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
27*33de042dSApple OSS Distributions  */
28*33de042dSApple OSS Distributions 
29*33de042dSApple OSS Distributions #ifndef _IOGUARDPAGEMEMORYDESCRIPTOR_H
30*33de042dSApple OSS Distributions #define _IOGUARDPAGEMEMORYDESCRIPTOR_H
31*33de042dSApple OSS Distributions 
32*33de042dSApple OSS Distributions #include <IOKit/IOMemoryDescriptor.h>
33*33de042dSApple OSS Distributions #include <libkern/c++/OSPtr.h>
34*33de042dSApple OSS Distributions 
35*33de042dSApple OSS Distributions /*!
36*33de042dSApple OSS Distributions  *   @class IOGuardPageMemoryDescriptor
37*33de042dSApple OSS Distributions  *   @abstract Provides a memory descriptor that allows for variable size guard regions. Use with
38*33de042dSApple OSS Distributions  *             IOMultiMemoryDescriptor to surround other memory descriptors with guard pages.
39*33de042dSApple OSS Distributions  */
40*33de042dSApple OSS Distributions class IOGuardPageMemoryDescriptor : public IOGeneralMemoryDescriptor
41*33de042dSApple OSS Distributions {
42*33de042dSApple OSS Distributions 	OSDeclareDefaultStructors(IOGuardPageMemoryDescriptor);
43*33de042dSApple OSS Distributions 
44*33de042dSApple OSS Distributions protected:
45*33de042dSApple OSS Distributions 	virtual void free() APPLE_KEXT_OVERRIDE;
46*33de042dSApple OSS Distributions 
47*33de042dSApple OSS Distributions 	vm_offset_t    _buffer;
48*33de042dSApple OSS Distributions 	vm_size_t      _size;
49*33de042dSApple OSS Distributions 
50*33de042dSApple OSS Distributions public:
51*33de042dSApple OSS Distributions 
52*33de042dSApple OSS Distributions 	/* @function withSize
53*33de042dSApple OSS Distributions 	 *  @discussion Create a IOGuardPageMemoryDescriptor with the specified size.
54*33de042dSApple OSS Distributions 	 *  @param Size of the guard region. This will be rounded up to the nearest multiple of page size.
55*33de042dSApple OSS Distributions 	 *  @return IOGuardPageMemoryDescriptor instance to be released by the caller, which will free the allocated
56*33de042dSApple OSS Distributions 	 *          virtual memory region.
57*33de042dSApple OSS Distributions 	 */
58*33de042dSApple OSS Distributions 	static OSPtr<IOGuardPageMemoryDescriptor> withSize(vm_size_t size);
59*33de042dSApple OSS Distributions 
60*33de042dSApple OSS Distributions 	virtual bool initWithSize(vm_size_t size);
61*33de042dSApple OSS Distributions 
62*33de042dSApple OSS Distributions private:
63*33de042dSApple OSS Distributions 	virtual IOReturn doMap(vm_map_t           addressMap,
64*33de042dSApple OSS Distributions 	    IOVirtualAddress * atAddress,
65*33de042dSApple OSS Distributions 	    IOOptionBits       options,
66*33de042dSApple OSS Distributions 	    IOByteCount        sourceOffset = 0,
67*33de042dSApple OSS Distributions 	    IOByteCount        length = 0 ) APPLE_KEXT_OVERRIDE;
68*33de042dSApple OSS Distributions };
69*33de042dSApple OSS Distributions 
70*33de042dSApple OSS Distributions #endif /* !_IOGUARDPAGEMEMORYDESCRIPTOR_H */
71