xref: /xnu-11215.61.5/iokit/Kernel/IOGuardPageMemoryDescriptor.cpp (revision 4f1223e81cd707a65cc109d0b8ad6653699da3c4)
1*4f1223e8SApple OSS Distributions /*
2*4f1223e8SApple OSS Distributions  * Copyright (c) 1998-2000 Apple Computer, Inc. All rights reserved.
3*4f1223e8SApple OSS Distributions  *
4*4f1223e8SApple OSS Distributions  * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
5*4f1223e8SApple OSS Distributions  *
6*4f1223e8SApple OSS Distributions  * This file contains Original Code and/or Modifications of Original Code
7*4f1223e8SApple OSS Distributions  * as defined in and that are subject to the Apple Public Source License
8*4f1223e8SApple OSS Distributions  * Version 2.0 (the 'License'). You may not use this file except in
9*4f1223e8SApple OSS Distributions  * compliance with the License. The rights granted to you under the License
10*4f1223e8SApple OSS Distributions  * may not be used to create, or enable the creation or redistribution of,
11*4f1223e8SApple OSS Distributions  * unlawful or unlicensed copies of an Apple operating system, or to
12*4f1223e8SApple OSS Distributions  * circumvent, violate, or enable the circumvention or violation of, any
13*4f1223e8SApple OSS Distributions  * terms of an Apple operating system software license agreement.
14*4f1223e8SApple OSS Distributions  *
15*4f1223e8SApple OSS Distributions  * Please obtain a copy of the License at
16*4f1223e8SApple OSS Distributions  * http://www.opensource.apple.com/apsl/ and read it before using this file.
17*4f1223e8SApple OSS Distributions  *
18*4f1223e8SApple OSS Distributions  * The Original Code and all software distributed under the License are
19*4f1223e8SApple OSS Distributions  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
20*4f1223e8SApple OSS Distributions  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
21*4f1223e8SApple OSS Distributions  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
22*4f1223e8SApple OSS Distributions  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
23*4f1223e8SApple OSS Distributions  * Please see the License for the specific language governing rights and
24*4f1223e8SApple OSS Distributions  * limitations under the License.
25*4f1223e8SApple OSS Distributions  *
26*4f1223e8SApple OSS Distributions  * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
27*4f1223e8SApple OSS Distributions  */
28*4f1223e8SApple OSS Distributions #define IOKIT_ENABLE_SHARED_PTR
29*4f1223e8SApple OSS Distributions #include <IOKit/IOGuardPageMemoryDescriptor.h>
30*4f1223e8SApple OSS Distributions #include <IOKit/IOMemoryDescriptor.h>
31*4f1223e8SApple OSS Distributions #include <IOKit/IOLib.h>
32*4f1223e8SApple OSS Distributions #include <vm/vm_kern_xnu.h>
33*4f1223e8SApple OSS Distributions #include <mach/mach_vm.h>
34*4f1223e8SApple OSS Distributions 
35*4f1223e8SApple OSS Distributions #define super IOGeneralMemoryDescriptor
36*4f1223e8SApple OSS Distributions 
37*4f1223e8SApple OSS Distributions OSDefineMetaClassAndStructorsWithZone(IOGuardPageMemoryDescriptor, IOGeneralMemoryDescriptor, ZC_ZFREE_CLEARMEM);
38*4f1223e8SApple OSS Distributions 
39*4f1223e8SApple OSS Distributions OSSharedPtr<IOGuardPageMemoryDescriptor>
withSize(vm_size_t size)40*4f1223e8SApple OSS Distributions IOGuardPageMemoryDescriptor::withSize(vm_size_t size)
41*4f1223e8SApple OSS Distributions {
42*4f1223e8SApple OSS Distributions 	OSSharedPtr<IOGuardPageMemoryDescriptor> me = OSMakeShared<IOGuardPageMemoryDescriptor>();
43*4f1223e8SApple OSS Distributions 
44*4f1223e8SApple OSS Distributions 	if (me && !me->initWithSize(size)) {
45*4f1223e8SApple OSS Distributions 		me.reset();
46*4f1223e8SApple OSS Distributions 	}
47*4f1223e8SApple OSS Distributions 	return me;
48*4f1223e8SApple OSS Distributions }
49*4f1223e8SApple OSS Distributions 
50*4f1223e8SApple OSS Distributions bool
initWithSize(vm_size_t size)51*4f1223e8SApple OSS Distributions IOGuardPageMemoryDescriptor::initWithSize(vm_size_t size)
52*4f1223e8SApple OSS Distributions {
53*4f1223e8SApple OSS Distributions 	mach_vm_address_t address;
54*4f1223e8SApple OSS Distributions 	kern_return_t kr;
55*4f1223e8SApple OSS Distributions 	IOOptionBits  iomdOptions = kIOMemoryTypeVirtual64 | kIOMemoryAsReference | kIODirectionOutIn;
56*4f1223e8SApple OSS Distributions 
57*4f1223e8SApple OSS Distributions 	size = round_page(size);
58*4f1223e8SApple OSS Distributions 
59*4f1223e8SApple OSS Distributions 	_ranges.v64 = IOMallocType(IOAddressRange);
60*4f1223e8SApple OSS Distributions 	if (!_ranges.v64) {
61*4f1223e8SApple OSS Distributions 		return false;
62*4f1223e8SApple OSS Distributions 	}
63*4f1223e8SApple OSS Distributions 
64*4f1223e8SApple OSS Distributions 	kr = mach_vm_allocate_kernel(kernel_map, &address, size,
65*4f1223e8SApple OSS Distributions 	    VM_MAP_KERNEL_FLAGS_ANYWHERE(.vm_tag = VM_KERN_MEMORY_IOKIT));
66*4f1223e8SApple OSS Distributions 	if (kr != KERN_SUCCESS) {
67*4f1223e8SApple OSS Distributions 		return false;
68*4f1223e8SApple OSS Distributions 	}
69*4f1223e8SApple OSS Distributions 
70*4f1223e8SApple OSS Distributions 
71*4f1223e8SApple OSS Distributions 	_ranges.v64->address = address;
72*4f1223e8SApple OSS Distributions 	_ranges.v64->length  = size;
73*4f1223e8SApple OSS Distributions 
74*4f1223e8SApple OSS Distributions 	if (!super::initWithOptions(_ranges.v64, 1, 0, kernel_task, iomdOptions, NULL)) {
75*4f1223e8SApple OSS Distributions 		return false;
76*4f1223e8SApple OSS Distributions 	}
77*4f1223e8SApple OSS Distributions 
78*4f1223e8SApple OSS Distributions 	_size = size;
79*4f1223e8SApple OSS Distributions 	_buffer = (vm_offset_t)address;
80*4f1223e8SApple OSS Distributions 
81*4f1223e8SApple OSS Distributions 	return true;
82*4f1223e8SApple OSS Distributions }
83*4f1223e8SApple OSS Distributions 
84*4f1223e8SApple OSS Distributions void
free()85*4f1223e8SApple OSS Distributions IOGuardPageMemoryDescriptor::free()
86*4f1223e8SApple OSS Distributions {
87*4f1223e8SApple OSS Distributions 	if (_buffer) {
88*4f1223e8SApple OSS Distributions 		vm_deallocate(kernel_map, _buffer, _size);
89*4f1223e8SApple OSS Distributions 		_buffer = 0;
90*4f1223e8SApple OSS Distributions 	}
91*4f1223e8SApple OSS Distributions 
92*4f1223e8SApple OSS Distributions 	if (_ranges.v64) {
93*4f1223e8SApple OSS Distributions 		IOFreeType(_ranges.v64, IOAddressRange);
94*4f1223e8SApple OSS Distributions 	}
95*4f1223e8SApple OSS Distributions 
96*4f1223e8SApple OSS Distributions 	super::free();
97*4f1223e8SApple OSS Distributions }
98*4f1223e8SApple OSS Distributions 
99*4f1223e8SApple OSS Distributions IOReturn
doMap(vm_map_t addressMap,IOVirtualAddress * atAddress,IOOptionBits options,IOByteCount sourceOffset,IOByteCount length)100*4f1223e8SApple OSS Distributions IOGuardPageMemoryDescriptor::doMap(vm_map_t           addressMap,
101*4f1223e8SApple OSS Distributions     IOVirtualAddress * atAddress,
102*4f1223e8SApple OSS Distributions     IOOptionBits       options,
103*4f1223e8SApple OSS Distributions     IOByteCount        sourceOffset,
104*4f1223e8SApple OSS Distributions     IOByteCount        length)
105*4f1223e8SApple OSS Distributions {
106*4f1223e8SApple OSS Distributions 	IOReturn ret = super::doMap(addressMap, atAddress, options, sourceOffset, length);
107*4f1223e8SApple OSS Distributions 	if (ret == kIOReturnSuccess) {
108*4f1223e8SApple OSS Distributions 		IOMemoryMap *     mapping = (IOMemoryMap *) *atAddress;
109*4f1223e8SApple OSS Distributions 		vm_map_t          map     = mapping->fAddressMap;
110*4f1223e8SApple OSS Distributions 		mach_vm_size_t    length  = mapping->fLength;
111*4f1223e8SApple OSS Distributions 		mach_vm_address_t address = mapping->fAddress;
112*4f1223e8SApple OSS Distributions 		kern_return_t kr = mach_vm_protect(map, address, length, true, VM_PROT_NONE);
113*4f1223e8SApple OSS Distributions 		if (kr != KERN_SUCCESS) {
114*4f1223e8SApple OSS Distributions 			doUnmap(map, (IOVirtualAddress) mapping, 0);
115*4f1223e8SApple OSS Distributions 			return kIOReturnError;
116*4f1223e8SApple OSS Distributions 		}
117*4f1223e8SApple OSS Distributions 	}
118*4f1223e8SApple OSS Distributions 	return ret;
119*4f1223e8SApple OSS Distributions }
120