mcs/class/System.Core/System.IO.MemoryMappedFiles/MemoryMappedView.cs

   1 //
   2 // MemoryMappedView.cs
   3 //
   4 // Authors:
   5 //      Marcos Henrich (marcos.henrich@gmail.com)
   6 //
   7 // Copyright (C) 2015, Xamarin, Inc
   8 //
   9 // Permission is hereby granted, free of charge, to any person obtaining
  10 // a copy of this software and associated documentation files (the
  11 // "Software"), to deal in the Software without restriction, including
  12 // without limitation the rights to use, copy, modify, merge, publish,
  13 // distribute, sublicense, and/or sell copies of the Software, and to
  14 // permit persons to whom the Software is furnished to do so, subject to
  15 // the following conditions:
  16 //
  17 // The above copyright notice and this permission notice shall be
  18 // included in all copies or substantial portions of the Software.
  19 //
  20 // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
  21 // EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  22 // MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  23 // NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
  24 // LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
  25 // OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
  26 // WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  27 //
  28
  29
  30 using System;
  31 using System.IO;
  32 using System.Diagnostics;
  33 using System.Collections.Generic;
  34 using Microsoft.Win32.SafeHandles;
  35
  36 namespace System.IO.MemoryMappedFiles
  37 {
  38         internal class MemoryMappedView : IDisposable {
  39                 private SafeMemoryMappedViewHandle m_viewHandle;
  40                 private Int64 m_pointerOffset;
  41                 private Int64 m_size;
  42                 private MemoryMappedFileAccess m_access;
  43
  44                 [System.Security.SecurityCritical]
  45                 private unsafe MemoryMappedView(SafeMemoryMappedViewHandle viewHandle, Int64 pointerOffset,
  46                                                                                         Int64 size, MemoryMappedFileAccess access) {
  47
  48                         m_viewHandle = viewHandle;
  49                         m_pointerOffset = pointerOffset;
  50                         m_size = size;
  51                         m_access = access;
  52                 }
  53
  54                 internal SafeMemoryMappedViewHandle ViewHandle {
  55                         [System.Security.SecurityCritical]
  56                         get {
  57                                 return m_viewHandle;
  58                         }
  59                 }
  60
  61                 internal Int64 PointerOffset {
  62                         get {
  63                                 return m_pointerOffset;
  64                         }
  65                 }
  66
  67                 internal Int64 Size {
  68                         get {
  69                                 return m_size;
  70                         }
  71                 }
  72
  73                 internal MemoryMappedFileAccess Access {
  74                         get {
  75                                 return m_access;
  76                         }
  77                 }
  78
  79                 internal unsafe static MemoryMappedView Create (IntPtr handle, long offset, long size, MemoryMappedFileAccess access)
  80                 {
  81                         IntPtr base_address;
  82                         IntPtr mmap_handle;
  83
  84                         MemoryMapImpl.Map (handle, offset, ref size, access, out mmap_handle, out base_address);
  85
  86                         var safe_handle = new SafeMemoryMappedViewHandle (mmap_handle, base_address, size);
  87
  88                         // MemoryMapImpl.Map returns a base_address to the offset so MemoryMappedView is initiated
  89                         // no offset.
  90                         return new MemoryMappedView (safe_handle, 0, size, access);
  91                 }
  92
  93                 public void Flush (IntPtr capacity)
  94                 {
  95                         MemoryMapImpl.Flush (m_viewHandle.DangerousGetHandle ());
  96                 }
  97
  98                 protected virtual void Dispose (bool disposing)
  99                 {
 100                         if (m_viewHandle != null && !m_viewHandle.IsClosed) {
 101                                 m_viewHandle.Dispose ();
 102                         }
 103                 }
 104
 105                 public void Dispose ()
 106                 {
 107                         Dispose (true);
 108                         GC.SuppressFinalize (this);
 109                 }
 110
 111                 internal bool IsClosed {
 112                         get {
 113                                 return (m_viewHandle == null || m_viewHandle.IsClosed);
 114                         }
 115                 }
 116         }
 117 }
 118