Loading...
iokit/Kernel/IOBufferMemoryDescriptor.cpp xnu-1228 xnu-124.1
--- xnu/xnu-1228/iokit/Kernel/IOBufferMemoryDescriptor.cpp
+++ xnu/xnu-124.1/iokit/Kernel/IOBufferMemoryDescriptor.cpp
@@ -1,52 +1,35 @@
 /*
  * Copyright (c) 1998-2000 Apple Computer, Inc. All rights reserved.
  *
- * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
+ * @APPLE_LICENSE_HEADER_START@
  * 
- * This file contains Original Code and/or Modifications of Original Code
- * as defined in and that are subject to the Apple Public Source License
- * Version 2.0 (the 'License'). You may not use this file except in
- * compliance with the License. The rights granted to you under the License
- * may not be used to create, or enable the creation or redistribution of,
- * unlawful or unlicensed copies of an Apple operating system, or to
- * circumvent, violate, or enable the circumvention or violation of, any
- * terms of an Apple operating system software license agreement.
+ * The contents of this file constitute Original Code as defined in and
+ * are subject to the Apple Public Source License Version 1.1 (the
+ * "License").  You may not use this file except in compliance with the
+ * License.  Please obtain a copy of the License at
+ * http://www.apple.com/publicsource and read it before using this file.
  * 
- * Please obtain a copy of the License at
- * http://www.opensource.apple.com/apsl/ and read it before using this file.
- * 
- * The Original Code and all software distributed under the License are
- * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
+ * This Original Code and all software distributed under the License are
+ * distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
- * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
- * Please see the License for the specific language governing rights and
- * limitations under the License.
+ * FITNESS FOR A PARTICULAR PURPOSE OR NON-INFRINGEMENT.  Please see the
+ * License for the specific language governing rights and limitations
+ * under the License.
  * 
- * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
+ * @APPLE_LICENSE_HEADER_END@
  */
 #include <IOKit/assert.h>
 #include <IOKit/system.h>
 
 #include <IOKit/IOLib.h>
-#include <IOKit/IOMapper.h>
 #include <IOKit/IOBufferMemoryDescriptor.h>
-
-#include "IOKitKernelInternal.h"
-#include "IOCopyMapper.h"
 
 __BEGIN_DECLS
 void ipc_port_release_send(ipc_port_t port);
-#include <vm/pmap.h>
-
-vm_map_t IOPageableMapForAddress( vm_address_t address );
 __END_DECLS
 
-/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
-
-volatile ppnum_t gIOHighestAllocatedPage;
-
-/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
+extern "C" vm_map_t IOPageableMapForAddress( vm_address_t address );
 
 #define super IOGeneralMemoryDescriptor
 OSDefineMetaClassAndStructors(IOBufferMemoryDescriptor,
@@ -99,27 +82,8 @@
 bool IOBufferMemoryDescriptor::initWithOptions(
                                IOOptionBits options,
                                vm_size_t    capacity,
-                               vm_offset_t  alignment,
-			       task_t	    inTask)
-{
-    mach_vm_address_t physicalMask = 0;
-    return (initWithPhysicalMask(inTask, options, capacity, alignment, physicalMask));
-}
-
-bool IOBufferMemoryDescriptor::initWithPhysicalMask(
-				task_t		  inTask,
-				IOOptionBits      options,
-				mach_vm_size_t    capacity,
-				mach_vm_address_t alignment,
-				mach_vm_address_t physicalMask)
-{
-    kern_return_t 	kr;
-    task_t		mapTask = NULL;
-    vm_map_t 		vmmap = NULL;
-    addr64_t            lastIOAddr;
-    IOAddressRange	range;
-    IOOptionBits	iomdOptions = kIOMemoryTypeVirtual64;
-
+                               vm_offset_t  alignment)
+{
     if (!capacity)
         return false;
 
@@ -128,286 +92,89 @@
     _physAddrs    = 0;
     _physSegCount = 0;
     _buffer	  = 0;
-    range.address = 0;
-    range.length  = 0;
-    _ranges.v64   = &range;
-
-    // Grab the direction and the Auto Prepare bits from the Buffer MD options
-    iomdOptions  |= options & (kIOMemoryDirectionMask | kIOMemoryAutoPrepare);
-
-    if ((options & (kIOMemorySharingTypeMask | kIOMapCacheMask)) && (alignment < page_size))
-	alignment = page_size;
-
-    if (physicalMask && (alignment <= 1))
-	alignment = ((physicalMask ^ PAGE_MASK) & PAGE_MASK) + 1;
+
+    if ((options & kIOMemorySharingTypeMask) && (alignment < page_size))
+        alignment = page_size;
 
     _alignment = alignment;
-
-    if (((inTask != kernel_task) && !(options & kIOMemoryPageable)) ||
-	(physicalMask && (options & kIOMapCacheMask)))
+    if (options & kIOMemoryPageable)
+        /* Allocate some kernel address space. */
+        _buffer = IOMallocPageable(capacity, alignment);
+    /* Allocate a wired-down buffer inside kernel space. */
+    else if (options & kIOMemoryPhysicallyContiguous)
+        _buffer = IOMallocContiguous(capacity, alignment, 0);
+    else if (alignment > 1)
+        _buffer = IOMallocAligned(capacity, alignment);
+    else
+        _buffer = IOMalloc(capacity);
+
+    if (!_buffer)
+        return false;
+
+    _singleRange.v.address = (vm_address_t) _buffer;
+    _singleRange.v.length  = capacity;
+
+    if (!super::initWithRanges(&_singleRange.v,	1,
+                                (IODirection) (options & kIOMemoryDirectionMask),
+                                kernel_task, true))
 	return false;
 
-    if ((options & kIOMemoryPhysicallyContiguous) && !physicalMask)
-	physicalMask = 0xFFFFFFFF;
-
-    // set flags for entry + object create
-    vm_prot_t memEntryCacheMode = VM_PROT_READ | VM_PROT_WRITE;
-
-    // set memory entry cache mode
-    switch (options & kIOMapCacheMask)
-    {
-	case kIOMapInhibitCache:
-	    SET_MAP_MEM(MAP_MEM_IO, memEntryCacheMode);
-	    break;
-
-	case kIOMapWriteThruCache:
-	    SET_MAP_MEM(MAP_MEM_WTHRU, memEntryCacheMode);
-	    break;
-
-	case kIOMapWriteCombineCache:
-	    SET_MAP_MEM(MAP_MEM_WCOMB, memEntryCacheMode);
-	    break;
-
-	case kIOMapCopybackCache:
-	    SET_MAP_MEM(MAP_MEM_COPYBACK, memEntryCacheMode);
-	    break;
-
-	case kIOMapDefaultCache:
-	default:
-	    SET_MAP_MEM(MAP_MEM_NOOP, memEntryCacheMode);
-	    break;
-    }
-
-    if (options & kIOMemoryPageable)
-    {
-	iomdOptions |= kIOMemoryBufferPageable;
-
-	// must create the entry before any pages are allocated
-
-	// set flags for entry + object create
-	memEntryCacheMode |= MAP_MEM_NAMED_CREATE;
-
-	if (options & kIOMemoryPurgeable)
-	    memEntryCacheMode |= MAP_MEM_PURGABLE;
-    }
-    else
-    {
-	memEntryCacheMode |= MAP_MEM_NAMED_REUSE;
-
-	if (IOMapper::gSystem)
-	    // assuming mapped space is 2G
-	    lastIOAddr = (1UL << 31) - PAGE_SIZE;
-	else
-	    lastIOAddr = ptoa_64(gIOHighestAllocatedPage);
-
-	if (physicalMask && (lastIOAddr != (lastIOAddr & physicalMask)))
-	{
-	    mach_vm_address_t address;
-	    iomdOptions &= ~kIOMemoryTypeVirtual64;
-	    iomdOptions |= kIOMemoryTypePhysical64;
-
-	    address = IOMallocPhysical(capacity, physicalMask);
-	    _buffer = (void *) address;
-	    if (!_buffer)
-		return false;
-
-	    mapTask = inTask;
-	    inTask = 0;
-	}
-	else
-	{
-	    vmmap = kernel_map;
-
-	    // Buffer shouldn't auto prepare they should be prepared explicitly
-	    // But it never was enforced so what are you going to do?
-	    iomdOptions |= kIOMemoryAutoPrepare;
-
-	    /* Allocate a wired-down buffer inside kernel space. */
-	    if (options & kIOMemoryPhysicallyContiguous)
-		_buffer = (void *) IOKernelAllocateContiguous(capacity, alignment);
-	    else if (alignment > 1)
-		_buffer = IOMallocAligned(capacity, alignment);
-	    else
-		_buffer = IOMalloc(capacity);
-	    if (!_buffer)
-		return false;
-	}
-    }
-
-    if( (kIOMemoryTypePhysical64 != (kIOMemoryTypeMask & iomdOptions)) 
-	&& (options & (kIOMemoryPageable | kIOMapCacheMask))) {
-	ipc_port_t	sharedMem;
-	vm_size_t	size = round_page_32(capacity);
-
-	kr = mach_make_memory_entry(vmmap,
-				    &size, (vm_offset_t)_buffer,
-				    memEntryCacheMode, &sharedMem,
-				    NULL );
-
-	if( (KERN_SUCCESS == kr) && (size != round_page_32(capacity))) {
-	    ipc_port_release_send( sharedMem );
-	    kr = kIOReturnVMError;
-	}
-	if( KERN_SUCCESS != kr)
-	    return( false );
-
-	_memEntry = (void *) sharedMem;
-
-	if( options & kIOMemoryPageable) {
-#if IOALLOCDEBUG
-	    debug_iomallocpageable_size += size;
-#endif
-	    mapTask = inTask;
-	    if (NULL == inTask)
-		inTask = kernel_task;
-	}
-	else if (options & kIOMapCacheMask)
-	{
-	    // Prefetch each page to put entries into the pmap
-	    volatile UInt8 *	startAddr = (UInt8 *)_buffer;
-	    volatile UInt8 *	endAddr   = (UInt8 *)_buffer + capacity;
-
-	    while (startAddr < endAddr)
-	    {
-		*startAddr;
-		startAddr += page_size;
-	    }
-	}
-    }
-
-    range.address = (mach_vm_address_t) _buffer;
-    range.length  = capacity;
-
-    if (!super::initWithOptions(&range, 1, 0,
-				inTask, iomdOptions, /* System mapper */ 0))
-	return false;
-
-    if (physicalMask && !IOMapper::gSystem)
-    {
-	IOMDDMACharacteristics mdSummary;
-
-	bzero(&mdSummary, sizeof(mdSummary));
-	IOReturn rtn = dmaCommandOperation(
-		kIOMDGetCharacteristics,
-		&mdSummary, sizeof(mdSummary));
-	if (rtn)
-	    return false;
-
-	if (mdSummary.fHighestPage)
-	{
-	    ppnum_t highest;
-	    while (mdSummary.fHighestPage > (highest = gIOHighestAllocatedPage))
-	    {
-		if (OSCompareAndSwap(highest, mdSummary.fHighestPage, 
-					(UInt32 *) &gIOHighestAllocatedPage))
-		    break;
-	    }
-	    lastIOAddr = ptoa_64(mdSummary.fHighestPage);
-	}
-	else
-	    lastIOAddr = ptoa_64(gIOLastPage);
-
-	if (lastIOAddr != (lastIOAddr & physicalMask))
-	{
-	    if (kIOMemoryTypePhysical64 != (_flags & kIOMemoryTypeMask))
-	    {
-		// flag a retry
-		_physSegCount = 1;
-	    }
-	    return false;
-	}
-    }
-
-    if (mapTask)
-    {
-	if (!reserved) {
-	    reserved = IONew( ExpansionData, 1 );
-	    if( !reserved)
-		return( false );
-	}
-	reserved->map = map(mapTask, 0, kIOMapAnywhere, 0, 0);
-	if (!reserved->map)
-	{
-	    _buffer = 0;
-	    return( false );
-	}
-	release();	    // map took a retain on this
-	mach_vm_address_t buffer = reserved->map->getAddress();
-	_buffer = (void *) buffer;
-	if (kIOMemoryTypeVirtual64 == (kIOMemoryTypeMask & iomdOptions))
-	    _ranges.v64->address = buffer;
+    if (options & kIOMemoryPageable) {
+        _flags |= kIOMemoryRequiresWire;
+
+        kern_return_t kr;
+        ipc_port_t sharedMem = (ipc_port_t) _memEntry;
+        vm_size_t size = _ranges.v[0].length;
+
+        // must create the entry before any pages are allocated
+        if( 0 == sharedMem) {
+            kr = mach_make_memory_entry( IOPageableMapForAddress( _ranges.v[0].address ),
+                        &size, _ranges.v[0].address,
+                        VM_PROT_READ | VM_PROT_WRITE, &sharedMem,
+                        NULL );
+            if( (KERN_SUCCESS == kr) && (size != _ranges.v[0].length)) {
+                ipc_port_release_send( sharedMem );
+                kr = kIOReturnVMError;
+            }
+            if( KERN_SUCCESS != kr)
+                sharedMem = 0;
+            _memEntry = (void *) sharedMem;
+        }
+        
+    } else {
+        /* Precompute virtual-to-physical page mappings. */
+        vm_address_t inBuffer = (vm_address_t) _buffer;
+        _physSegCount = atop(trunc_page(inBuffer + capacity - 1) -
+                            trunc_page(inBuffer)) + 1;
+        _physAddrs = IONew(IOPhysicalAddress, _physSegCount);
+        if (!_physAddrs)
+            return false;
+    
+        inBuffer = trunc_page(inBuffer);
+        for (unsigned i = 0; i < _physSegCount; i++) {
+            _physAddrs[i] = pmap_extract(get_task_pmap(kernel_task), inBuffer);
+            assert(_physAddrs[i]); /* supposed to be wired */
+            inBuffer += page_size;
+        }
     }
 
     setLength(capacity);
-
+    
     return true;
-}
-
-IOBufferMemoryDescriptor * IOBufferMemoryDescriptor::inTaskWithOptions(
-					    task_t       inTask,
-                                            IOOptionBits options,
-                                            vm_size_t    capacity,
-                                            vm_offset_t  alignment)
-{
-    IOBufferMemoryDescriptor *me = new IOBufferMemoryDescriptor;
-    
-    if (me && !me->initWithOptions(options, capacity, alignment, inTask)) {
-	bool retry = me->_physSegCount;
-	me->release();
-	me = 0;
-	if (retry)
-	{
-	    me = new IOBufferMemoryDescriptor;
-	    if (me && !me->initWithOptions(options, capacity, alignment, inTask))
-	    {
-		me->release();
-		me = 0;
-	    }
-	}
-    }
-    return me;
-}
-
-IOBufferMemoryDescriptor * IOBufferMemoryDescriptor::inTaskWithPhysicalMask(
-					    task_t	      inTask,
-                                            IOOptionBits      options,
-                                            mach_vm_size_t    capacity,
-                                            mach_vm_address_t physicalMask)
-{
-    IOBufferMemoryDescriptor *me = new IOBufferMemoryDescriptor;
-    
-    if (me && !me->initWithPhysicalMask(inTask, options, capacity, 1, physicalMask))
-    {
-	bool retry = me->_physSegCount;
-	me->release();
-	me = 0;
-	if (retry)
-	{
-	    me = new IOBufferMemoryDescriptor;
-	    if (me && !me->initWithPhysicalMask(inTask, options, capacity, 1, physicalMask))
-	    {
-		me->release();
-		me = 0;
-	    }
-	}
-    }
-    return me;
-}
-
-bool IOBufferMemoryDescriptor::initWithOptions(
-                               IOOptionBits options,
-                               vm_size_t    capacity,
-                               vm_offset_t  alignment)
-{
-    return( initWithOptions(options, capacity, alignment, kernel_task) );
 }
 
 IOBufferMemoryDescriptor * IOBufferMemoryDescriptor::withOptions(
                                             IOOptionBits options,
                                             vm_size_t    capacity,
-                                            vm_offset_t  alignment)
-{
-    return(IOBufferMemoryDescriptor::inTaskWithOptions(kernel_task, options, capacity, alignment));
+                                            vm_offset_t  alignment = 1)
+{
+    IOBufferMemoryDescriptor *me = new IOBufferMemoryDescriptor;
+    
+    if (me && !me->initWithOptions(options, capacity, alignment)) {
+	me->release();
+	me = 0;
+    }
+    return me;
 }
 
 
@@ -468,21 +235,9 @@
 {
     IOBufferMemoryDescriptor *me = new IOBufferMemoryDescriptor;
 
-    if (me && !me->initWithBytes(inBytes, inLength, inDirection, inContiguous))
-    {
-	bool retry = me->_physSegCount;
-	me->release();
-	me = 0;
-	if (retry)
-	{
-	    me = new IOBufferMemoryDescriptor;
-	    if (me && !me->initWithBytes(inBytes, inLength, inDirection, inContiguous))
-	    {
-		me->release();
-		me = 0;
-	    }
-	}
-
+    if (me && !me->initWithBytes(inBytes, inLength, inDirection, inContiguous)){
+        me->release();
+        me = 0;
     }
     return me;
 }
@@ -494,43 +249,28 @@
  */
 void IOBufferMemoryDescriptor::free()
 {
-    // Cache all of the relevant information on the stack for use
-    // after we call super::free()!
-    IOOptionBits     flags     = _flags;
-    IOOptionBits     options   = _options;
-    vm_size_t        size      = _capacity;
-    void *           buffer    = _buffer;
-    IOVirtualAddress source    = _ranges.v64->address;
-    IOMemoryMap *    map       = 0;
-    vm_offset_t      alignment = _alignment;
-
-    if (reserved)
-    {
-	map = reserved->map;
-        IODelete( reserved, ExpansionData, 1 );
-	if (map)
-	    map->release();
-    }
+    IOOptionBits options   = _options;
+    vm_size_t    size	   = _capacity;
+    void *       buffer	   = _buffer;
+    vm_offset_t  alignment = _alignment;
+
+    if (_physAddrs)
+        IODelete(_physAddrs, IOPhysicalAddress, _physSegCount);
 
     /* super::free may unwire - deallocate buffer afterwards */
     super::free();
 
-    if (options & kIOMemoryPageable)
-    {
-#if IOALLOCDEBUG
-	debug_iomallocpageable_size -= round_page_32(size);
-#endif
-    }
-    else if (buffer)
-    {
-	if (kIOMemoryTypePhysical64 == (flags & kIOMemoryTypeMask))
-	    IOFreePhysical((mach_vm_address_t) source, size);
-        else if (options & kIOMemoryPhysicallyContiguous)
-            IOKernelFreeContiguous((mach_vm_address_t) buffer, size);
-        else if (alignment > 1)
-            IOFreeAligned(buffer, size);
-        else
-            IOFree(buffer, size);
+    if (buffer) {
+        if (options & kIOMemoryPageable)
+            IOFreePageable(buffer, size);
+        else {
+            if (options & kIOMemoryPhysicallyContiguous)
+                IOFreeContiguous(buffer, size);
+            else if (alignment > 1)
+                IOFreeAligned(buffer, size);
+            else
+                IOFree(buffer, size);
+        }
     }
 }
 
@@ -559,7 +299,7 @@
     assert(length <= _capacity);
 
     _length = length;
-    _ranges.v64->length = length;
+    _singleRange.v.length = length;
 }
 
 /*
@@ -584,20 +324,13 @@
 bool
 IOBufferMemoryDescriptor::appendBytes(const void * bytes, vm_size_t withLength)
 {
-    vm_size_t   actualBytesToCopy = min(withLength, _capacity - _length);
-    IOByteCount offset;
+    vm_size_t actualBytesToCopy = min(withLength, _capacity - _length);
 
     assert(_length <= _capacity);
-
-    offset = _length;
+    bcopy(/* from */ bytes, (void *)(_singleRange.v.address + _length),
+          actualBytesToCopy);
     _length += actualBytesToCopy;
-    _ranges.v64->length += actualBytesToCopy;
-
-    if (_task == kernel_task)
-	bcopy(/* from */ bytes, (void *)(_ranges.v64->address + offset),
-	      actualBytesToCopy);
-    else
-	writeBytes(offset, bytes, actualBytesToCopy);
+    _singleRange.v.length += actualBytesToCopy;
 
     return true;
 }
@@ -609,12 +342,8 @@
  */
 void * IOBufferMemoryDescriptor::getBytesNoCopy()
 {
-    if (kIOMemoryTypePhysical64 == (_flags & kIOMemoryTypeMask))
-	return _buffer;
-    else
-	return (void *)_ranges.v64->address;
-}
-
+    return (void *)_singleRange.v.address;
+}
 
 /*
  * getBytesNoCopy:
@@ -624,30 +353,62 @@
 void *
 IOBufferMemoryDescriptor::getBytesNoCopy(vm_size_t start, vm_size_t withLength)
 {
-    IOVirtualAddress address;
-    if (kIOMemoryTypePhysical64 == (_flags & kIOMemoryTypeMask))
-	address = (IOVirtualAddress) _buffer;
-    else
-	address = _ranges.v64->address;
-
-   if (start < _length && (start + withLength) <= _length)
-        return (void *)(address + start);
+    if (start < _length && (start + withLength) <= _length)
+        return (void *)(_singleRange.v.address + start);
     return 0;
 }
 
-/* DEPRECATED */ void * IOBufferMemoryDescriptor::getVirtualSegment(IOByteCount offset,
-/* DEPRECATED */ 							IOByteCount * lengthOfSegment)
-{
-    void * bytes = getBytesNoCopy(offset, 0);
-    
-    if (bytes && lengthOfSegment)
-	*lengthOfSegment = _length - offset;
-
-    return bytes;
-}
-
-OSMetaClassDefineReservedUsed(IOBufferMemoryDescriptor, 0);
-OSMetaClassDefineReservedUsed(IOBufferMemoryDescriptor, 1);
+/*
+ * getPhysicalSegment:
+ *
+ * Get the physical address of the buffer, relative to the current position.
+ * If the current position is at the end of the buffer, a zero is returned.
+ */
+IOPhysicalAddress
+IOBufferMemoryDescriptor::getPhysicalSegment(IOByteCount offset,
+					IOByteCount * lengthOfSegment)
+{
+    IOPhysicalAddress physAddr;
+
+    if( offset != _position)
+	setPosition( offset );
+
+    assert(_position <= _length);
+
+    /* Fail gracefully if the position is at (or past) the end-of-buffer. */
+    if (_position >= _length) {
+        *lengthOfSegment = 0;
+        return 0;
+    }
+
+    if (_options & kIOMemoryPageable) {
+        physAddr = super::getPhysicalSegment(offset, lengthOfSegment);
+
+    } else {
+        /* Compute the largest contiguous physical length possible. */
+        vm_address_t actualPos  = _singleRange.v.address + _position;
+        vm_address_t actualPage = trunc_page(actualPos);
+        unsigned     physInd    = atop(actualPage-trunc_page(_singleRange.v.address));
+    
+        vm_size_t physicalLength = actualPage + page_size - actualPos;
+        for (unsigned index = physInd + 1; index < _physSegCount &&
+            _physAddrs[index] == _physAddrs[index-1] + page_size; index++) {
+            physicalLength += page_size;
+        }
+    
+        /* Clip contiguous physical length at the end-of-buffer. */
+        if (physicalLength > _length - _position)
+            physicalLength = _length - _position;
+    
+        *lengthOfSegment = physicalLength;
+        physAddr = _physAddrs[physInd] + (actualPos - actualPage);
+    }
+
+    return physAddr;
+}
+
+OSMetaClassDefineReservedUnused(IOBufferMemoryDescriptor, 0);
+OSMetaClassDefineReservedUnused(IOBufferMemoryDescriptor, 1);
 OSMetaClassDefineReservedUnused(IOBufferMemoryDescriptor, 2);
 OSMetaClassDefineReservedUnused(IOBufferMemoryDescriptor, 3);
 OSMetaClassDefineReservedUnused(IOBufferMemoryDescriptor, 4);