C# プログラミング

【C#】共有メモリを使ってプロセス間でデータを共有する方法

今回はC#を使ってプロセス間でデータを共有する方法を調べてみたので、その覚え書きです。

やりたかったことは、「あるプロセス内で処理した情報を別のプロセスから取得する」ということだったのですが、共有メモリを使えばそれができることが分かりました。

MemoryMappedFileを使う

C#で共有メモリを扱うには、MemoryMappedFileという仕組みを使います。これはC言語のmmapみたいなもので、ファイルをメモリ上にマッピングすることができます。メモリ上にマッピングされた1つのファイルを2つのプロセスから覗くことで、データを共有できるわけですね。

書き込み側(サーバー)

まず、書き込み側(以下、サーバー側)です。1つの整数値を共有メモリに書き込むサンプルは以下のような感じになります。

using System.IO.MemoryMappedFiles;

namespace MemoryMappedFileServer
{
	class Program
	{
		static void Main(string[] args)
		{
			// Open shared memory
			MemoryMappedFile share_mem = MemoryMappedFile.CreateNew("shared_memory", 1024);
			MemoryMappedViewAccessor accessor = share_mem.CreateViewAccessor();

			// Write data to shared memory
			accessor.Write(0, 256);

			// Dispose accessor
			accessor.Dispose();

			// Sleep
			while (true) System.Threading.Thread.Sleep(1000);
		}
	}
}

このサンプルでしていることは大きく以下の2つです。

  • 共有メモリの作成
  • 共有メモリへの書き込み

共有メモリを作成するには、MemoryMappedFileクラスのCreateNewメソッドを使います。引数には共有メモリ名とそのサイズを指定してあげます。今回は「shared_memory」という名前で1024バイトのメモリを確保しています。

次に共有メモリへの書き込みです。共有メモリにデータを書き込むには、CreateViewAccessorメソッドでMemoryMappedViewAccessorのインスタンスを生成し、それを経由して書き込む形になります。Writeメソッドの引数は書き込む位置(先頭からオフセット)と書き込むデータです。

今回だと、共有メモリの先頭に256という整数値を書き込んでいます。書き込みが済んだらMemoryMappedViewAccessorのインスタンスは破棄しておきます。

読み取り側(クライアント)

次は読み取り側(以下、クライアント側)です。サーバー側で作った共有メモリからデータを読み込むサンプルは以下のようになります。

using System;
using System.IO.MemoryMappedFiles;

namespace MemoryMappedFileClient
{
	class Program
	{
		static void Main(string[] args)
		{
			// Open shared memory
			MemoryMappedFile share_mem = MemoryMappedFile.OpenExisting("shared_memory");
			MemoryMappedViewAccessor accessor = share_mem.CreateViewAccessor();

			// Write data to shared memory
			int data = accessor.ReadInt32(0);
			Console.WriteLine("Data = " + data);

			// Dispose resource
			accessor.Dispose();
			share_mem.Dispose();
		}
	}
}

クライアント側でもサーバー側同様にMempryMappedFileのインスタンスを生成するのですが、ここでは作成済みの共有メモリを開くので、OpenExistingメソッドを使います。引数にサーバー側で指定したのと同じ名前を渡せば、共有メモリを開くことができます。

あとは同様にMemoryMappedViewAccssorのインスタンスを取得して読み込むだけです。今回は整数値が書き込まれていることを期待しているので、ReadInt32メソッドを使います。

サーバー側を実行している状態でクライアント側を実行すると、以下のように2つのプロセス間でデータが共有できていることが確認できます。

Data = 256

もう少し高度な使い方

先のサンプルでは1つの整数値を共有しましたが、これだけではあまり実用性がありません。次はもっと複雑なデータ、例えば文字列を共有する方法を考えてみます。

書き込み側(サーバー側)

まずはサーバー側のサンプルです。

using System.IO.MemoryMappedFiles;

namespace MemoryMappedFileServer
{
	class Program
	{
		static void Main(string[] args)
		{
			// Open shared memory
			MemoryMappedFile share_mem = MemoryMappedFile.CreateNew("shared_memory", 1024);
			MemoryMappedViewAccessor accessor = share_mem.CreateViewAccessor();

			// Write data to shared memory
			string str = "Hello World";
			char[] data = str.ToCharArray();
			accessor.Write(0, data.Length);
			accessor.WriteArray<char>(sizeof(int), data, 0, data.Length);

			// Dispose accessor
			accessor.Dispose();

			// Sleep
			while (true) System.Threading.Thread.Sleep(1000);
		}
	}
}

文字列を書き込む場合は、string型ではなくcharの配列として書き込むことになります。このとき、メモリの先頭に文字列の長さを書き込んだ後、WriteArrayメソッドでデータ列を書き込むのがポイントです。WriteArrayに指定する開始位置はメモリ先頭にデータ長が書いてあることを考慮して、sizeof(int)バイトだけずらしています。

読み込み側(クライアント側)

続いてクライアント側のサンプルです。

using System;
using System.IO.MemoryMappedFiles;

namespace MemoryMappedFileClient
{
	class Program
	{
		static void Main(string[] args)
		{
			// Open shared memory
			MemoryMappedFile share_mem = MemoryMappedFile.OpenExisting("shared_memory");
			MemoryMappedViewAccessor accessor = share_mem.CreateViewAccessor();

			// Write data to shared memory
			int size = accessor.ReadInt32(0);
			char[] data = new char[size];
			accessor.ReadArray<char>(sizeof(int), data, 0, data.Length);
			string str = new string(data);

			Console.WriteLine("Data = " + str);

			// Dispose resource
			accessor.Dispose();
			share_mem.Dispose();
		}
	}
}

クライアント側でデータ列を読み込むにはそのサイズを知る必要がありますが、データ列のサイズはサーバー側がメモリ先頭に書いてくれています。そこで、ここではReadInt32メソッドでデータ長を取得した後、その分だけReadArrayメソッドでデータ列を読み込むようにしています。このときもReadArrayの読み込み開始位置に注意です。

実行した結果がこんな感じ。サーバー側から書いたデータ列をクライアント側から過不足なく読み取ることができました。

Data = Hello World

この他にも、シリアライズ/デシリアライズに対応したクラスであれば、クラスのインスタンス自体の共有も可能になります。そこまでできれば色々と応用が利きますね。

ではではノシ

関連記事

Flutter プログラミング

2021/8/2

【Flutter】アプリ内の設定値を実装する方法

アプリ内で独自の設定を作る場合、そのデータを保持する方法を考える必要があります。 SQL、テキストファイルなど選択肢は多々ありますが、shared_preferencesというパッケージを使えば簡単に実装することができます。 Dart packages  2 Users 31 Pocketsshared_preferences | Flutter PackageFlutter plugin for reading and writing simple key-value pairs. Wraps ...

この記事を読む

RaspberryPi Linux

2021/4/18

YoctoでRaspberryPi4のイメージをビルドしてみた

昨今、様々なデバイスでLinuxが動くようになっている中、組み込みLinuxのデファクトスタンダードとなりつつあるのが「Yocto」と呼ばれるビルドシステムです。 組み込みの現場ではその名前を聞くことが増えましたが、まだまだ日本ではドキュメントも乏しくイマイチ掴み所がありません。そこで、まずは使ってみようということでRaspberry Pi4のイメージをビルドしてみることにしました。 目次1 Yoctoとは?2 Raspberry Pi4のイメージを作ってみる2.1 下準備2.2 Yocto本体+ラズパイ ...

この記事を読む

C++ 自作物

2021/8/1

言語処理系をつくろう(第7回):比較演算子を実装する

自作の言語処理系開発日記の第7回です。前回までで変数の実装が終わったので、ここからはいよいよ制御構文を実装…と思ったのですが、制御のためには比較演算子を実装する必要がありました。 ということで、今回は比較演算子を実装していきます。基本的には四則演算と変わりないのであまり難しくはありません。 目次1 比較演算子の仕様2 実装してみる2.1 トークナイザ2.2 構文解析器2.3 コード生成器2.4 実行系(仮想マシン) 比較演算子の仕様 比較演算子を実装する前に、その仕様について少し考えておきます。 比較演算 ...

この記事を読む

C++ 自作物

2021/8/1

言語処理系をつくろう(第6回):変数を実装する

自作の言語処理系開発日記、第6回です。 これまでは四則演算など、電卓レベルの機能実装に取り組んでいましたが、いよいよ変数を扱えるようにしていきたいと思います。これでかなりプログラミング言語っぽくなるかも(・∀・) 今回は新しい仕組みを入れたりと、割と修正がごちゃごちゃしてしまったので、うまくまとめきれていません。ごめんなさい…。 目次1 変数の実装について2 実装してみる2.1 トークナイザ2.2 構文解析器2.3 コード生成器2.4 実行系(仮想マシン) 変数の実装について これまでは即値しか扱っていな ...

この記事を読む

C++ 自作物

2021/8/1

言語処理系をつくろう(第5回):連続した式の実行

自作の言語処理系開発日記の第5回です。 前回までで括弧を含んだ四則演算ができるようになりましたが、このままでは単なる電卓止まりです。ということで、今回は複数の式を連続して実行できる仕組みを実装していきたいと思います。 目次1 生成規則を考える2 実装してみる2.1 構文解析器2.2 コード生成 生成規則を考える これまでは入力全体を1つの式として解釈していましたが、今回は式の区切りを定義して複数の式として解釈できるようにします。 C言語だと「;」や「,」が区切り文字として使われますが、開発中の言語(roo ...

この記事を読む

  • このブログの中の人

Ryo Yoneyama

とある会社でソフトウェアエンジニアをしています。技術的な備忘録を中心にまとめてます。ネタがあれば日記も書きます。

-C#, プログラミング

© 2021 Corgi Lab. ~備忘録のための技術ブログ~