メモリマップトファイル

[アーティクル]
05/10/2023

メモリマップトファイルには、仮想メモリ内のファイルの内容が含まれています。ファイルとメモリ空間の間のこのマッピングによって、複数のプロセスを含むアプリケーションは、メモリを直接読み書きすることでファイルを変更できます。「メモリマップファイルの管理」で説明されているように、マネージドコードを使用して、ネイティブ Windows 関数がメモリマップ済みファイルにアクセスする場合と同じ方法でメモリマップ済みファイルにアクセスできます。

メモリマップトファイルには次の 2 種類があります。

永続化メモリマップトファイル

永続化ファイルは、ディスク上のソースファイルに関連付けられているメモリマップトファイルです。最後のプロセスがファイルの操作を終了すると、データがディスク上のソースファイルに保存されます。これらのメモリマップトファイルは、きわめて大きなソースファイルの操作に適しています。
非永続化メモリマップトファイル

非永続化ファイルは、ディスク上のファイルに関連付けられていないメモリマップトファイルです。最後のプロセスがファイルの操作を終了すると、データが失われ、ガベージコレクションによってファイルが解放されます。これらのファイルは、プロセス間通信 (IPC) 用の共有メモリの作成に適しています。

プロセス、ビュー、およびメモリ管理

メモリマップトファイルは、複数のプロセス間で共有できます。ファイルを作成したプロセスによって割り当てられている共通名を使用して、複数のプロセスを同じメモリマップトファイルにマップできます。

メモリマップトファイルを操作するには、メモリマップトファイル全体またはその一部のビューを作成する必要があります。また、メモリマップトファイルの同じ部分に対するマルチビューを作成し、それによって同時実行メモリを作成することもできます。 2 つのビューが同時実行されるには、それらのビューを同じメモリマップトファイルから作成する必要があります。

ファイルがメモリマッピングで使用できるアプリケーションの論理メモリ空間のサイズ (32 ビットコンピューターでは 2 GB) よりも大きい場合にも、マルチビューが必要になる可能性があります。

ビューには、ストリームアクセスビューとランダムアクセスビューの 2 種類があります。ファイルへの順次アクセスにはストリームアクセスビューを使用します。これは、非永続化ファイルと IPC に推奨されます。ランダムアクセスビューは、永続化ファイルの操作に適しています。

メモリマップトファイルへは、オペレーティングシステムのメモリマネージャーを通じてアクセスするため、ファイルは複数のページに自動的に分割され、必要に応じてアクセスされます。メモリ管理を自分で行う必要はありません。

次の図に、複数のプロセスがどのように同じメモリマップトファイルへの複数の重なるビューを同時に持つことができるかを示します。

次の画像では、メモリマップトファイルへの複数の重なるビューを確認できます。

Screenshot that shows views to a memory-mapped file.

メモリマップトファイルのプログラミング

メモリマップトファイルオブジェクトとそのメンバーを使用するための手引きを次の表に示します。

タスク	使用するメソッドまたはプロパティ
ディスク上のファイルからの永続化メモリマップトファイルを表す MemoryMappedFile オブジェクトを取得する。	MemoryMappedFile.CreateFromFile メソッド
(ディスク上のファイルに関連付けられていない) 非永続化メモリマップトファイルを表す MemoryMappedFile オブジェクトを取得する。	MemoryMappedFile.CreateNew メソッドまたは MemoryMappedFile.CreateOrOpen メソッド
既存の (永続化または非永続化) メモリマップトファイルの MemoryMappedFile オブジェクトを取得する。	MemoryMappedFile.OpenExisting メソッド
メモリマップトファイルへの順次アクセスビューを表す UnmanagedMemoryStream オブジェクトを取得する。	MemoryMappedFile.CreateViewStream メソッド
メモリマップトファイルへのランダムアクセスを確認するための UnmanagedMemoryAccessor オブジェクトを取得する。	MemoryMappedFile.CreateViewAccessor メソッド
アンマネージコードで使用するために SafeMemoryMappedViewHandle オブジェクトを取得する。	MemoryMappedFile.SafeMemoryMappedFileHandle プロパティ。または MemoryMappedViewAccessor.SafeMemoryMappedViewHandle プロパティ。または MemoryMappedViewStream.SafeMemoryMappedViewHandle プロパティ。
ビューが作成されるまで、メモリ割り当てを延期する (非永続化ファイルのみ)。 (現在のシステムページサイズを確認するには、Environment.SystemPageSize プロパティを使用します)。	CreateNew 値を持つ MemoryMappedFileOptions.DelayAllocatePages メソッドまたは CreateOrOpen 列挙体をパラメーターとして持つ MemoryMappedFileOptions メソッド。

セキュリティ

MemoryMappedFileAccess 列挙体をパラメーターとして受け取る次のメソッドを使用して、メモリマップトファイルの作成時にアクセス権を適用できます。

OpenExisting をパラメーターとして受け取る MemoryMappedFileRights メソッドを使用して、既存のメモリマップトファイルを開く操作に対するアクセス権を指定できます。

また、定義済みのアクセス規則が格納されている MemoryMappedFileSecurity オブジェクトを含めることもできます。

メモリマップトファイルに新規または変更済みのアクセス規則を適用するには、SetAccessControl メソッドを使用します。既存のファイルからアクセス規則または監査規則を取得するには、GetAccessControl メソッドを使用します。

使用例

永続化メモリマップトファイル

CreateFromFile メソッドは、ディスク上の既存のファイルからメモリマップトファイルを作成します。

次の例では、きわめて大きなファイルの一部のメモリマップトビューを作成し、その一部分を操作します。

using System;
using System.IO;
using System.IO.MemoryMappedFiles;
using System.Runtime.InteropServices;

class Program
{
    static void Main(string[] args)
    {
        long offset = 0x10000000; // 256 megabytes
        long length = 0x20000000; // 512 megabytes

        // Create the memory-mapped file.
        using (var mmf = MemoryMappedFile.CreateFromFile(@"c:\ExtremelyLargeImage.data", FileMode.Open,"ImgA"))
        {
            // Create a random access view, from the 256th megabyte (the offset)
            // to the 768th megabyte (the offset plus length).
            using (var accessor = mmf.CreateViewAccessor(offset, length))
            {
                int colorSize = Marshal.SizeOf(typeof(MyColor));
                MyColor color;

                // Make changes to the view.
                for (long i = 0; i < length; i += colorSize)
                {
                    accessor.Read(i, out color);
                    color.Brighten(10);
                    accessor.Write(i, ref color);
                }
            }
        }
    }
}

public struct MyColor
{
    public short Red;
    public short Green;
    public short Blue;
    public short Alpha;

    // Make the view brighter.
    public void Brighten(short value)
    {
        Red = (short)Math.Min(short.MaxValue, (int)Red + value);
        Green = (short)Math.Min(short.MaxValue, (int)Green + value);
        Blue = (short)Math.Min(short.MaxValue, (int)Blue + value);
        Alpha = (short)Math.Min(short.MaxValue, (int)Alpha + value);
    }
}

Imports System.IO
Imports System.IO.MemoryMappedFiles
Imports System.Runtime.InteropServices

Class Program

    Sub Main()
        Dim offset As Long = &H10000000 ' 256 megabytes
        Dim length As Long = &H20000000 ' 512 megabytes

        ' Create the memory-mapped file.
        Using mmf = MemoryMappedFile.CreateFromFile("c:\ExtremelyLargeImage.data", FileMode.Open, "ImgA")
            ' Create a random access view, from the 256th megabyte (the offset)
            ' to the 768th megabyte (the offset plus length).
            Using accessor = mmf.CreateViewAccessor(offset, length)
                Dim colorSize As Integer = Marshal.SizeOf(GetType(MyColor))
                Dim color As MyColor
                Dim i As Long = 0

                ' Make changes to the view.
                Do While (i < length)
                    accessor.Read(i, color)
                    color.Brighten(10)
                    accessor.Write(i, color)
                    i += colorSize
                Loop
            End Using
        End Using
    End Sub
End Class

Public Structure MyColor
    Public Red As Short
    Public Green As Short
    Public Blue As Short
    Public Alpha As Short

    ' Make the view brighter.
    Public Sub Brighten(ByVal value As Short)
        Red = CType(Math.Min(Short.MaxValue, (CType(Red, Integer) + value)), Short)
        Green = CType(Math.Min(Short.MaxValue, (CType(Green, Integer) + value)), Short)
        Blue = CType(Math.Min(Short.MaxValue, (CType(Blue, Integer) + value)), Short)
        Alpha = CType(Math.Min(Short.MaxValue, (CType(Alpha, Integer) + value)), Short)
    End Sub
End Structure

別のプロセスに対して同じメモリマップトファイルを開く例を、次に示します。

using System;
using System.IO.MemoryMappedFiles;
using System.Runtime.InteropServices;

class Program
{
    static void Main(string[] args)
    {
        // Assumes another process has created the memory-mapped file.
        using (var mmf = MemoryMappedFile.OpenExisting("ImgA"))
        {
            using (var accessor = mmf.CreateViewAccessor(4000000, 2000000))
            {
                int colorSize = Marshal.SizeOf(typeof(MyColor));
                MyColor color;

                // Make changes to the view.
                for (long i = 0; i < 1500000; i += colorSize)
                {
                    accessor.Read(i, out color);
                    color.Brighten(20);
                    accessor.Write(i, ref color);
                }
            }
        }
    }
}

public struct MyColor
{
    public short Red;
    public short Green;
    public short Blue;
    public short Alpha;

    // Make the view brigher.
    public void Brighten(short value)
    {
        Red = (short)Math.Min(short.MaxValue, (int)Red + value);
        Green = (short)Math.Min(short.MaxValue, (int)Green + value);
        Blue = (short)Math.Min(short.MaxValue, (int)Blue + value);
        Alpha = (short)Math.Min(short.MaxValue, (int)Alpha + value);
    }
}

Imports System.IO.MemoryMappedFiles
Imports System.Runtime.InteropServices

Class Program
    Public Shared Sub Main(ByVal args As String())
        ' Assumes another process has created the memory-mapped file.
        Using mmf = MemoryMappedFile.OpenExisting("ImgA")
            Using accessor = mmf.CreateViewAccessor(4000000, 2000000)
                Dim colorSize As Integer = Marshal.SizeOf(GetType(MyColor))
                Dim color As MyColor

                ' Make changes to the view.
                Dim i As Long = 0
                While i < 1500000
                    accessor.Read(i, color)
                    color.Brighten(30)
                    accessor.Write(i, color)
                    i += colorSize
                End While
            End Using
        End Using
    End Sub
End Class

Public Structure MyColor
    Public Red As Short
    Public Green As Short
    Public Blue As Short
    Public Alpha As Short

    ' Make the view brigher.
    Public Sub Brighten(ByVal value As Short)
        Red = CShort(Math.Min(Short.MaxValue, CInt(Red) + value))
        Green = CShort(Math.Min(Short.MaxValue, CInt(Green) + value))
        Blue = CShort(Math.Min(Short.MaxValue, CInt(Blue) + value))
        Alpha = CShort(Math.Min(Short.MaxValue, CInt(Alpha) + value))
    End Sub
End Structure

非永続化メモリマップトファイル

CreateNew メソッドおよび CreateOrOpen メソッドは、ディスク上の既存のファイルに対応付けられないメモリマップトファイルを作成します。

次の例は、メモリマップトファイルにブール値を書き込む、3 つの独立したプロセス (コンソールアプリケーション) で構成されます。次の順序で処理が実行されます。

Process A がメモリマップトファイルを作成し、値を書き込みます。
Process B がメモリマップトファイルを開き、値を書き込みます。
Process C がメモリマップトファイルを開き、値を書き込みます。
Process A がメモリマップトファイルの値を読み込み、表示します。
Process A がメモリマップトファイルの処理を終了すると、ガベージコレクションによってファイルが直ちにクリアされます。

この例を実行するには、次の手順に従います。

アプリケーションをコンパイルし、3 つのコマンドプロンプトウィンドウを開きます。
最初のコマンドプロンプトウィンドウで、Process A を実行します。
2 つ目のコマンドプロンプトウィンドウで、Process B を実行します。
Process A に戻り、Enter キーを押します。
3 つ目のコマンドプロンプトウィンドウで、Process C を実行します。
Process A に戻り、Enter キーを押します。

Process A の出力は次のとおりです。

Start Process B and press ENTER to continue.  
Start Process C and press ENTER to continue.  
Process A says: True  
Process B says: False  
Process C says: True

プロセス A

using System;
using System.IO;
using System.IO.MemoryMappedFiles;
using System.Threading;

class Program
{
    // Process A:
    static void Main(string[] args)
    {
        using (MemoryMappedFile mmf = MemoryMappedFile.CreateNew("testmap", 10000))
        {
            bool mutexCreated;
            Mutex mutex = new Mutex(true, "testmapmutex", out mutexCreated);
            using (MemoryMappedViewStream stream = mmf.CreateViewStream())
            {
                BinaryWriter writer = new BinaryWriter(stream);
                writer.Write(1);
            }
            mutex.ReleaseMutex();

            Console.WriteLine("Start Process B and press ENTER to continue.");
            Console.ReadLine();

            Console.WriteLine("Start Process C and press ENTER to continue.");
            Console.ReadLine();

            mutex.WaitOne();
            using (MemoryMappedViewStream stream = mmf.CreateViewStream())
            {
                BinaryReader reader = new BinaryReader(stream);
                Console.WriteLine("Process A says: {0}", reader.ReadBoolean());
                Console.WriteLine("Process B says: {0}", reader.ReadBoolean());
                Console.WriteLine("Process C says: {0}", reader.ReadBoolean());
            }
            mutex.ReleaseMutex();
        }
    }
}

Imports System.IO
Imports System.IO.MemoryMappedFiles
Imports System.Threading

Module Module1

    ' Process A:
    Sub Main()
        Using mmf As MemoryMappedFile = MemoryMappedFile.CreateNew("testmap", 10000)
            Dim mutexCreated As Boolean
            Dim mTex As Mutex = New Mutex(True, "testmapmutex", mutexCreated)
            Using Stream As MemoryMappedViewStream = mmf.CreateViewStream()
                Dim writer As BinaryWriter = New BinaryWriter(Stream)
                writer.Write(1)
            End Using
            mTex.ReleaseMutex()
            Console.WriteLine("Start Process B and press ENTER to continue.")
            Console.ReadLine()

            Console.WriteLine("Start Process C and press ENTER to continue.")
            Console.ReadLine()

            mTex.WaitOne()
            Using Stream As MemoryMappedViewStream = mmf.CreateViewStream()
                Dim reader As BinaryReader = New BinaryReader(Stream)
                Console.WriteLine("Process A says: {0}", reader.ReadBoolean())
                Console.WriteLine("Process B says: {0}", reader.ReadBoolean())
                Console.WriteLine("Process C says: {0}", reader.ReadBoolean())
            End Using
            mTex.ReleaseMutex()

        End Using

    End Sub

End Module

プロセス B

using System;
using System.IO;
using System.IO.MemoryMappedFiles;
using System.Threading;

class Program
{
    // Process B:
    static void Main(string[] args)
    {
        try
        {
            using (MemoryMappedFile mmf = MemoryMappedFile.OpenExisting("testmap"))
            {

                Mutex mutex = Mutex.OpenExisting("testmapmutex");
                mutex.WaitOne();

                using (MemoryMappedViewStream stream = mmf.CreateViewStream(1, 0))
                {
                    BinaryWriter writer = new BinaryWriter(stream);
                    writer.Write(0);
                }
                mutex.ReleaseMutex();
            }
        }
        catch (FileNotFoundException)
        {
            Console.WriteLine("Memory-mapped file does not exist. Run Process A first.");
        }
    }
}

Imports System.IO
Imports System.IO.MemoryMappedFiles
Imports System.Threading

Module Module1
    ' Process B:
    Sub Main()
        Try
            Using mmf As MemoryMappedFile = MemoryMappedFile.OpenExisting("testmap")
                Dim mTex As Mutex = Mutex.OpenExisting("testmapmutex")
                mTex.WaitOne()
                Using Stream As MemoryMappedViewStream = mmf.CreateViewStream(1, 0)
                    Dim writer As BinaryWriter = New BinaryWriter(Stream)
                    writer.Write(0)
                End Using
                mTex.ReleaseMutex()
            End Using
        Catch noFile As FileNotFoundException
            Console.WriteLine("Memory-mapped file does not exist. Run Process A first." & vbCrLf & noFile.Message)
        End Try

    End Sub

End Module

プロセス C

using System;
using System.IO;
using System.IO.MemoryMappedFiles;
using System.Threading;

class Program
{
    // Process C:
    static void Main(string[] args)
    {
        try
        {
            using (MemoryMappedFile mmf = MemoryMappedFile.OpenExisting("testmap"))
            {

                Mutex mutex = Mutex.OpenExisting("testmapmutex");
                mutex.WaitOne();

                using (MemoryMappedViewStream stream = mmf.CreateViewStream(2, 0))
                {
                    BinaryWriter writer = new BinaryWriter(stream);
                    writer.Write(1);
                }
                mutex.ReleaseMutex();
            }
        }
        catch (FileNotFoundException)
        {
            Console.WriteLine("Memory-mapped file does not exist. Run Process A first, then B.");
        }
    }
}

Imports System.IO
Imports System.IO.MemoryMappedFiles
Imports System.Threading

Module Module1
    ' Process C:
    Sub Main()
        Try
            Using mmf As MemoryMappedFile = MemoryMappedFile.OpenExisting("testmap")
                Dim mTex As Mutex = Mutex.OpenExisting("testmapmutex")
                mTex.WaitOne()
                Using Stream As MemoryMappedViewStream = mmf.CreateViewStream(2, 0)
                    Dim writer As BinaryWriter = New BinaryWriter(Stream)
                    writer.Write(1)
                End Using
                mTex.ReleaseMutex()
            End Using
        Catch noFile As FileNotFoundException
            Console.WriteLine("Memory-mapped file does not exist. Run Process A first, then B." & vbCrLf & noFile.Message)
        End Try

    End Sub

End Module

次の方法で共有

メモリマップトファイル

プロセス、ビュー、およびメモリ管理

メモリマップトファイルのプログラミング

セキュリティ

使用例

永続化メモリマップトファイル

非永続化メモリマップトファイル

関連項目

その他のリソース

次の方法で共有

メモリ マップト ファイル

プロセス、ビュー、およびメモリ管理

メモリ マップト ファイルのプログラミング

セキュリティ

使用例

永続化メモリ マップト ファイル

非永続化メモリ マップト ファイル

関連項目

その他のリソース

メモリマップトファイル

メモリマップトファイルのプログラミング

永続化メモリマップトファイル

非永続化メモリマップトファイル