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