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