プログラミング – ページ 15 – サイゼントの技術ブログ

2020年8月15日

スタック・キューの説明と使い所

データをメモリに一時的に保持する仕組みとして、スタックとキューがあります。
今回はスタックとキューについて、どのようなものなのかの説明と使い所を書いていきます。

スタックは先入れ後出し、キューは先入れ先出し方式でデータを保持します。
例えば、a,b,cの順番でデータを投入する場合、スタックはc,b,a、キューはa,b,cの順番でデータが取りだされます。
なお、スタックにデータを入れる操作はプッシュ、スタックからデータを取り出す操作はポップ、キューにデータを入れる操作はエンキュー、キューからデータを取り出す操作はデキューと呼びます。
以下、イメージ図です。

・スタック

・キュー

スタックが使われる代表的な場面としては、関数呼び出し時に戻り先を保持する場面が挙げられます。
例えば、以下のような構造になっている場合

f() {
    g() //①
}
g() {
    h() //②
}
h() {
}

f() {

g() //①

}

g() {

h() //②

}

h() {

}

関数g()が呼び出された時点でスタックに①のアドレス、関数h()が呼び出された時点でスタックに②のアドレスが戻り先として保持されます。
そして、関数h()が終了した時点でスタックから戻り先として②のアドレスが取り出され、関数g()が終了した時点でスタックから戻り先として①のアドレスが取り出されます。

余談ですが、以下のように再帰呼び出しになっている時は注意が必要です。
ループ終了条件を満たさないまま大量の再帰呼び出しを行った場合、戻り先アドレスのサイズがスタックのサイズを超えてしまい、プログラムが異常終了してしまいます。

f() {
    ループ {
        f()
    }
}

f() {

ループ {

f()

}

キューが使われる代表的な場面としては、マルチスレッドの制御を行う場面が挙げられます。
１つのスレッドの処理が「①軽い処理→②重い処理」となっており、かつ①の処理を先に行ったスレッドが②の処理を先に行う必要がある場合、①と②の間にキューを入れて対応します。
①の処理は処理が終わるごとにキューの中にスレッドのオブジェクトを格納し、②の処理は処理が終わる毎にキューの中のスレッドのオブジェクトを取り出し次の処理に移ることで、①の処理と②の処理の速度差を吸収することができます。

いかがでしたでしょうか？

スタックやキューはITパスポートにも出題される基礎的な概念ですが、実際にプログラミングで意識する場面は少ないと思います。
今回の記事では、実際のプログラミングではどのような場面で意識するのかも参考のため書いてみました。

2020年8月7日

C#：await・asyncの簡単なサンプルコード

C#のawait・asyncは非同期処理のために用意された文法なのですが、Webで調べてみても難しく書かれていることが多く、そもそも何のための処理なのか理解するのが難しい感があります。
await・asyncを用いて関数を呼び出しても、その関数の処理が終わるまで待つという動きをするので、同期処理と何が違うのかいまいちわかりにくいというのもあると思います。
以上のような背景があるので、簡単なサンプルコードを書いてみることとしました。

await・asyncは、GUIアプリのために用意された文法と考えて良いです。
await・asyncを用いない場合、処理中はGUI操作ができなくなるのですが、await・asyncを用いて呼び出した関数を処理している間はGUI操作が可能になります。
GUI操作と並行で処理ができる、という意味で、await・asyncは非同期処理であると言えます。

以下、Windows Formのサンプルコードです。
３秒後にボタン押下時のシステム時刻をラベルに表示するというサンプルコードであり、await・asyncを用いたボタンとそうではないボタンを用意して挙動の違いを確認します。

【サンプルコード】

・From1.cs（デザイン）

・Form1.cs（ビジネスロジック）

using System;
using System.Collections.Generic;
using System.ComponentModel;
using System.Data;
using System.Drawing;
using System.Linq;
using System.Text;
using System.Threading;
using System.Threading.Tasks;
using System.Windows.Forms;

namespace AsyncAwaitTest
{
    public partial class Form1 : Form
    {
        public Form1()
        {
            InitializeComponent();
        }

        // Asyncボタン
        private async void button1_Click(object sender, EventArgs e)
        {
            String date = await AsyncProc();
            label1.Text = date;
        }

        private async Task＜String＞ AsyncProc()
        {
            DateTime dt = DateTime.Now;
            await Task.Delay(3000);
            return dt.ToString();
        }

        // NoAsyncボタン
        private void button2_Click(object sender, EventArgs e)
        {
            String date = NoAsyncProc();
            label2.Text = date;
        }

        private String NoAsyncProc()
        {
            DateTime dt = DateTime.Now;
            Thread.Sleep(3000);
            return dt.ToString();
        }
    }
}

using System;

using System.Collections.Generic;

using System.ComponentModel;

using System.Data;

using System.Drawing;

using System.Linq;

using System.Text;

using System.Threading;

using System.Threading.Tasks;

using System.Windows.Forms;

namespace AsyncAwaitTest

{

public partial class Form1 : Form

{

public Form1()

{

InitializeComponent();

}

// Asyncボタン

private async void button1_Click(object sender, EventArgs e)

{

String date = await AsyncProc();

label1.Text = date;

}

private async Task＜String＞ AsyncProc()

{

DateTime dt = DateTime.Now;

await Task.Delay(3000);

return dt.ToString();

}

// NoAsyncボタン

private void button2_Click(object sender, EventArgs e)

{

String date = NoAsyncProc();

label2.Text = date;

}

private String NoAsyncProc()

{

DateTime dt = DateTime.Now;

Thread.Sleep(3000);

return dt.ToString();

}

【実行結果】

・Asyncボタンを押してから１秒以内にNoAsyncボタンを押下

→Asyncボタンの処理中もNoAsyncボタンを押下可能であるため、２つのボタンに対応するラベルの表示上、時刻の差異は１秒以内です。

・NoAsyncボタンを押してから１秒以内にAsyncボタンを押下

→NoAsyncボタンの処理中はAsyncボタンを押下不可能であるため、２つのボタンに対応するラベルの表示上、時刻の差異は３秒以上となります。

いかがでしたでしょうか。

説明を読んでも関数の挙動や目的がわからなかったのですが、自分で簡単なプログラムを作って動かしてみて理解できました。
今回の記事はC#でGUIのプログラムを作っている人以外には参考にならない記事だったかもしれませんが、簡単なプログラムを作って理解を深める例を示すことはできたのではないかと思っています。

2020年7月24日

C#：セマフォを用いた排他制御

排他制御の仕組みとして先日Mutexを取り上げました。
今回は、同じく排他制御で使われるセマフォについて取り上げます。

セマフォがMutexと異なる点は、複数のプロセス・スレッドが資源を取得することができることです。
セマフォのコンストラクタで初期で解放する資源数や、解放できる資源の最大数を指定します。
WaitOne関数で資源取得待ちを行い、Release関数で資源解放を行います。Release関数の引数で資源解放数を指定することもできます。
（ただし、最大数を超える資源を開放するとSemaphoreFullExceptionとなるので注意が必要です）

セマフォは、同時に動くスレッド数を制限したいような重い処理がある時によく使われます。

以下は、セマフォを用いて同時に動くスレッド数を制限するサンプルです。

【サンプルコード】

・Controller.cs

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading.Tasks;
using System.Threading;
namespace Controller
{
    internal class Controller
    {
        public static void Main(string［］ args)
        {
            using(Semaphore sem = new Semaphore(0, 2, "semaphore"))
            {
                Console.WriteLine(DateTime.Now + 
                    "：セマフォを作りました。" + 
                    "初期で解放０個、最大で２つまで解放します。");
                Thread.Sleep(2000);
                sem.Release(2);
                Console.WriteLine(DateTime.Now + 
                    "：準備ができたので、セマフォを２つ解放しました。");
                Thread.Sleep(10000);
            }
            Console.ReadLine();
        }
    }
}

using System;

using System.Collections.Generic;

using System.Linq;

using System.Text;

using System.Threading.Tasks;

using System.Threading;

namespace Controller

{

internal class Controller

{

public static void Main(string［］ args)

{

using(Semaphore sem = new Semaphore(0, 2, "semaphore"))

{

Console.WriteLine(DateTime.Now +

"：セマフォを作りました。" +

"初期で解放０個、最大で２つまで解放します。");

Thread.Sleep(2000);

sem.Release(2);

Console.WriteLine(DateTime.Now +

"：準備ができたので、セマフォを２つ解放しました。");

Thread.Sleep(10000);

}

Console.ReadLine();

}

・Processor.cs

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading.Tasks;
using System.Threading;
namespace Processor
{
    internal class Processor
    {
        public static void Main(string［］ args)
        {
            const int N = 3;
            Parallel.For(0, N, id =＞ // id0～2のスレッドを生成
            {
                Semaphore sem;
                if (Semaphore.TryOpenExisting("semaphore", out sem))
                {
                    Console.WriteLine("ID" + id + ":" + DateTime.Now + 
                        "：セマフォ解放待ち。");
                    sem.WaitOne();
                    Console.WriteLine("ID" + id + ":" + DateTime.Now + 
                        "：セマフォ取得しました。処理開始します。");
                    Thread.Sleep(2000);
                    Console.WriteLine("ID" + id + ":" + DateTime.Now + 
                        "：処理終了しました。");
                    sem.Release();
                    Console.WriteLine("ID" + id + ":" + DateTime.Now + 
                        "：処理終了したので、セマフォを１つ解放しました。");
                }
                else
                {
                    Console.WriteLine("ID" + id + ":" + DateTime.Now + 
                        "：セマフォが見つかりません。");
                }
            });
            Console.ReadLine();
        }
    }
}

using System;

using System.Collections.Generic;

using System.Linq;

using System.Text;

using System.Threading.Tasks;

using System.Threading;

namespace Processor

{

internal class Processor

{

public static void Main(string［］ args)

{

const int N = 3;

Parallel.For(0, N, id =＞ // id0～2のスレッドを生成

{

Semaphore sem;

if (Semaphore.TryOpenExisting("semaphore", out sem))

{

Console.WriteLine("ID" + id + ":" + DateTime.Now +

"：セマフォ解放待ち。");

sem.WaitOne();

Console.WriteLine("ID" + id + ":" + DateTime.Now +

"：セマフォ取得しました。処理開始します。");

Thread.Sleep(2000);

Console.WriteLine("ID" + id + ":" + DateTime.Now +

"：処理終了しました。");

sem.Release();

Console.WriteLine("ID" + id + ":" + DateTime.Now +

"：処理終了したので、セマフォを１つ解放しました。");

}

else

{

Console.WriteLine("ID" + id + ":" + DateTime.Now +

"：セマフォが見つかりません。");

}

});

Console.ReadLine();

}

【実行用バッチ】

・test.bat

@echo off
echo 最大で２つのスレッドしか動かないようにするサンプルです。
echo 同時に動くスレッド数を制限したい重い処理がある時に使えます。
C:\Windows\Microsoft.NET\Framework\v4.0.30319\csc.exe Controller.cs
C:\Windows\Microsoft.NET\Framework\v4.0.30319\csc.exe Processor.cs
start Controller.exe
timeout 1
start Processor.exe
pause
exit

@echo off

echo 最大で２つのスレッドしか動かないようにするサンプルです。

echo 同時に動くスレッド数を制限したい重い処理がある時に使えます。

C:\Windows\Microsoft.NET\Framework\v4.0.30319\csc.exe Controller.cs

C:\Windows\Microsoft.NET\Framework\v4.0.30319\csc.exe Processor.cs

start Controller.exe

timeout 1

start Processor.exe

pause

exit

【実行結果】

・test.bat

最大で２つのスレッドしか動かないようにするサンプルです。
同時に動くスレッド数を制限したい重い処理がある時に使えます。
Microsoft (R) Visual C# Compiler version 4.7.3062.0
for C# 5
Copyright (C) Microsoft Corporation. All rights reserved.

This compiler is provided as part of the Microsoft (R) .NET Framework, but only supports language versions up to C# 5, w
hich is no longer the latest version. For compilers that support newer versions of the C# programming language, see http
://go.microsoft.com/fwlink/?LinkID=533240

Microsoft (R) Visual C# Compiler version 4.7.3062.0
for C# 5
Copyright (C) Microsoft Corporation. All rights reserved.

This compiler is provided as part of the Microsoft (R) .NET Framework, but only supports language versions up to C# 5, w
hich is no longer the latest version. For compilers that support newer versions of the C# programming language, see http
://go.microsoft.com/fwlink/?LinkID=533240


0 秒待っています。続行するには何かキーを押してください ...
続行するには何かキーを押してください . . .

最大で２つのスレッドしか動かないようにするサンプルです。

同時に動くスレッド数を制限したい重い処理がある時に使えます。

Microsoft (R) Visual C# Compiler version 4.7.3062.0

for C# 5

This compiler is provided as part of the Microsoft (R) .NET Framework, but only supports language versions up to C# 5, w

hich is no longer the latest version. For compilers that support newer versions of the C# programming language, see http

://go.microsoft.com/fwlink/?LinkID=533240

Microsoft (R) Visual C# Compiler version 4.7.3062.0

for C# 5

This compiler is provided as part of the Microsoft (R) .NET Framework, but only supports language versions up to C# 5, w

hich is no longer the latest version. For compilers that support newer versions of the C# programming language, see http

://go.microsoft.com/fwlink/?LinkID=533240

0 秒待っています。続行するには何かキーを押してください ...

続行するには何かキーを押してください . . .

・Controller.exe

2020/05/09 13:48:45：セマフォを作りました。初期で解放０個、最大で２つまで解放します。
2020/05/09 13:48:47：準備ができたので、セマフォを２つ解放しました。

1 2	2020/05/09 13:48:45：セマフォを作りました。初期で解放０個、最大で２つまで解放します。 2020/05/09 13:48:47：準備ができたので、セマフォを２つ解放しました。

・Processor.exe

ID0:2020/05/09 13:48:46：セマフォ解放待ち。
ID2:2020/05/09 13:48:46：セマフォ解放待ち。
ID1:2020/05/09 13:48:46：セマフォ解放待ち。
ID0:2020/05/09 13:48:47：セマフォ取得しました。処理開始します。
ID2:2020/05/09 13:48:47：セマフォ取得しました。処理開始します。
ID2:2020/05/09 13:48:49：処理終了しました。
ID0:2020/05/09 13:48:49：処理終了しました。
ID0:2020/05/09 13:48:49：処理終了したので、セマフォを１つ解放しました。
ID2:2020/05/09 13:48:49：処理終了したので、セマフォを１つ解放しました。
ID1:2020/05/09 13:48:49：セマフォ取得しました。処理開始します。
ID1:2020/05/09 13:48:51：処理終了しました。
ID1:2020/05/09 13:48:51：処理終了したので、セマフォを１つ解放しました。

ID0:2020/05/09 13:48:46：セマフォ解放待ち。

ID2:2020/05/09 13:48:46：セマフォ解放待ち。

ID1:2020/05/09 13:48:46：セマフォ解放待ち。

ID0:2020/05/09 13:48:47：セマフォ取得しました。処理開始します。

ID2:2020/05/09 13:48:47：セマフォ取得しました。処理開始します。

ID2:2020/05/09 13:48:49：処理終了しました。

ID0:2020/05/09 13:48:49：処理終了しました。

ID0:2020/05/09 13:48:49：処理終了したので、セマフォを１つ解放しました。

ID2:2020/05/09 13:48:49：処理終了したので、セマフォを１つ解放しました。

ID1:2020/05/09 13:48:49：セマフォ取得しました。処理開始します。

ID1:2020/05/09 13:48:51：処理終了しました。

ID1:2020/05/09 13:48:51：処理終了したので、セマフォを１つ解放しました。

いかがでしたでしょうか？

排他制御の仕組みとしてMutexを説明したので、ついでに代表的な方法の一つであるセマフォについても説明しました。
Mutexよりも使用頻度は少ないと思いますが、同時に動くスレッド数を制限するための書き方があるというのは覚えておいて損はないと思います。

2020年7月11日

C#：共有メモリで可変長データを繰り返し送受信する

共有メモリは、同一メモリ上で実行されるプロセス間でデータをやりとりする場合に使用する仕組みです。
通常、プロセスで確保しているメモリは他のプロセスから参照することができないのですが、プロセス間で予め共有メモリとして使用するメモリのアドレスを共有することで、そのメモリは他のプロセスから参照可能となります。
ファイル等を介したやりとりよりも高速なため、高速化が求められる時に使用することが多いです。

目的の一つが高速化のため、データが作成され次第次々と共有する、という使い方になることが多いと思います。
今回は、そのような使い方を想定して、可変長データを繰り返し送受信するサンプルプログラムを作成しました。
書き込んだデータのサイズを伝えること、共有メモリの読み取り位置をずらしていくことがポイントとなります。

なお、今回は省略していますが、本来であれば書き込み中の読み取りを防ぐため、Mutex等の排他制御の仕組みを併用するべきです。
（参考までに、Mutexについては前回の記事で取り上げています）

【サンプルコード】

・Sender.cs

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading.Tasks;
using System.IO.MemoryMappedFiles;

namespace Sender
{
    class Sender
    {
        // 本当はMutex等で排他制御するべき
        static void Main(string［］ args)
        {
            // 共有メモリの作成("HelloWorld"という名前で1024バイトで定義)
            MemoryMappedFile mmf = 
                MemoryMappedFile.CreateNew("HelloWorld", 1024);
            
            // 書き込みオブジェクトの生成
            MemoryMappedViewAccessor mmva = mmf.CreateViewAccessor();

            // 書き込みオブジェクトの現在のバイト位置
            int i = 0;

            // 書き込み１回目
            // 共有メモリの状態
            // |int(オブジェクトの数)|char［］(Hello )|
            string str1 = "Hello ";
            char［］ data1 = str1.ToCharArray();
            mmva.Write(i, data1.Length);
            i = i + sizeof(int);
            mmva.WriteArray&lt;char>(i, data1, 0, data1.Length);
            i = i + sizeof(char) * data1.Length;
            System.Threading.Thread.Sleep(1000);

            // 書き込み２回目
            // 共有メモリの状態
            // |(１回目の内容)|int(オブジェクトの数)|char［］(World)|
            string str2 = "World";
            char［］ data2 = str2.ToCharArray();
            mmva.Write(i, data2.Length);
            i = i + sizeof(int);
            mmva.WriteArray＜char＞(i, data2, 0, data2.Length);
            i = i + sizeof(char) * data2.Length;
            System.Threading.Thread.Sleep(1000);

            // 書き込み３回目
            // 共有メモリの状態
            // |(１～２回目の内容)|int(オブジェクトの数)|char［］(!)|
            string str3 = "!";
            char［］ data3 = str3.ToCharArray();
            mmva.Write(i, data3.Length);
            i = i + sizeof(int);
            mmva.WriteArray＜char＞(i, data3, 0, data3.Length);
            i = i + sizeof(char) * data3.Length;
            System.Threading.Thread.Sleep(1000);

            // 書き込みオブジェクトの破棄
            mmva.Dispose();

            // 共有メモリの破棄
            mmf.Dispose();
        }
    }
}

using System;

using System.Collections.Generic;

using System.Linq;

using System.Text;

using System.Threading.Tasks;

using System.IO.MemoryMappedFiles;

namespace Sender

{

class Sender

{

// 本当はMutex等で排他制御するべき

static void Main(string［］ args)

{

// 共有メモリの作成("HelloWorld"という名前で1024バイトで定義)

MemoryMappedFile mmf =

MemoryMappedFile.CreateNew("HelloWorld", 1024);

// 書き込みオブジェクトの生成

MemoryMappedViewAccessor mmva = mmf.CreateViewAccessor();

// 書き込みオブジェクトの現在のバイト位置

int i = 0;

// 書き込み１回目

// 共有メモリの状態

// |int(オブジェクトの数)|char［］(Hello )|

string str1 = "Hello ";

char［］ data1 = str1.ToCharArray();

mmva.Write(i, data1.Length);

i = i + sizeof(int);

mmva.WriteArray<char>(i, data1, 0, data1.Length);

i = i + sizeof(char) * data1.Length;

System.Threading.Thread.Sleep(1000);

// 書き込み２回目

// 共有メモリの状態

// |(１回目の内容)|int(オブジェクトの数)|char［］(World)|

string str2 = "World";

char［］ data2 = str2.ToCharArray();

mmva.Write(i, data2.Length);

i = i + sizeof(int);

mmva.WriteArray＜char＞(i, data2, 0, data2.Length);

i = i + sizeof(char) * data2.Length;

System.Threading.Thread.Sleep(1000);

// 書き込み３回目

// 共有メモリの状態

// |(１～２回目の内容)|int(オブジェクトの数)|char［］(!)|

string str3 = "!";

char［］ data3 = str3.ToCharArray();

mmva.Write(i, data3.Length);

i = i + sizeof(int);

mmva.WriteArray＜char＞(i, data3, 0, data3.Length);

i = i + sizeof(char) * data3.Length;

System.Threading.Thread.Sleep(1000);

// 書き込みオブジェクトの破棄

mmva.Dispose();

// 共有メモリの破棄

mmf.Dispose();

}

・Receiver.cs

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading.Tasks;
using System.IO.MemoryMappedFiles;

namespace Receiver
{
    class Receiver
    {
        // 本当はMutex等で排他制御するべき
        static void Main(string［］ args)
        {
            // 作成済み共有メモリ（"HelloWorld"）のオブジェクト生成
            MemoryMappedFile mmf = 
                MemoryMappedFile.OpenExisting("HelloWorld");
            
            // 読み込みオブジェクトの生成
            MemoryMappedViewAccessor mmva = mmf.CreateViewAccessor();

            // 読み込みオブジェクトの現在のバイト位置
            int i = 0;

            // 読み込み
            // オブジェクトの数が書き込まれていたらその分データを読む
            int size = 0;
            string str = "";
            while (!str.Equals("!"))
            {
                size = mmva.ReadInt32(i);
                if (size != 0)
                {
                    char［］ data = new char［size］;
                    i = i + sizeof(int);
                    mmva.ReadArray＜char＞(i, data, 0, data.Length);
                    str = new string(data);
                    Console.WriteLine(str);
                    i = i + sizeof(char) * data.Length;
                }
                System.Threading.Thread.Sleep(100);
            }
            
            // 読み込みオブジェクトの破棄
            mmva.Dispose();
            
            // コンソール表示を維持
            Console.ReadKey();
        }
    }
}

using System;

using System.Collections.Generic;

using System.Linq;

using System.Text;

using System.Threading.Tasks;

using System.IO.MemoryMappedFiles;

namespace Receiver

{

class Receiver

{

// 本当はMutex等で排他制御するべき

static void Main(string［］ args)

{

// 作成済み共有メモリ（"HelloWorld"）のオブジェクト生成

MemoryMappedFile mmf =

MemoryMappedFile.OpenExisting("HelloWorld");

// 読み込みオブジェクトの生成

MemoryMappedViewAccessor mmva = mmf.CreateViewAccessor();

// 読み込みオブジェクトの現在のバイト位置

int i = 0;

// 読み込み

// オブジェクトの数が書き込まれていたらその分データを読む

int size = 0;

string str = "";

while (!str.Equals("!"))

{

size = mmva.ReadInt32(i);

if (size != 0)

{

char［］ data = new char［size］;

i = i + sizeof(int);

mmva.ReadArray＜char＞(i, data, 0, data.Length);

str = new string(data);

Console.WriteLine(str);

i = i + sizeof(char) * data.Length;

}

System.Threading.Thread.Sleep(100);

}

// 読み込みオブジェクトの破棄

mmva.Dispose();

// コンソール表示を維持

Console.ReadKey();

}

【実行バッチ】

・test.bat

C:\Windows\Microsoft.NET\Framework\v4.0.30319\csc.exe Sender.cs
C:\Windows\Microsoft.NET\Framework\v4.0.30319\csc.exe Receiver.cs
start Sender.exe
timeout 1
start Receiver.exe
pause
exit

C:\Windows\Microsoft.NET\Framework\v4.0.30319\csc.exe Sender.cs

C:\Windows\Microsoft.NET\Framework\v4.0.30319\csc.exe Receiver.cs

start Sender.exe

timeout 1

start Receiver.exe

pause

exit

【実行結果】

・Receiverのコンソール

Hello
World
!

Hello

World

いかがでしたでしょうか。

今回は、共有メモリを用いたデータの受け渡しを紹介してみました。
記事ではjavaに書き方が近く理解しやすいC#で書きましたが、本当に性能が求められる場合はCやC++で書く場合が多いです。
しかし、その場合もロジックは同じなので、参考になるのではないかと思います。

2020年7月4日

C#：Mutexでの排他制御

排他制御の方法の一つとして、C#にはMutexと呼ばれる機能が用意されています。
何れか一つのスレッドがMutexによるロックを取得することができます。
他のスレッドによりロックが取得されている場合の処理を別途記述すれば、この機能を使用して排他制御が可能となります。

以下、サンプルコードです。

【サンプルコード】

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading;
using System.Threading.Tasks;

namespace MutexTest
{
    class Program
    {
        static void Main(string［］ args)
        {
            using (Mutex mutex = new Mutex(false)) // 使い終わったらスレッド解放
            {
                const int N = 3;
                // id0…0.7秒目～1.7秒目に掴む
                // id1…1.4秒目から待機、1.7～2.7秒目に掴む
                // id2…2.1秒目から待機、2.6秒目に諦める
                Parallel.For(0, N, id =＞ // id0～2のスレッドを生成
                {
                    Thread.Sleep(id * 700);
                    // ロック取得、成功ならtrue
                    // 第一引数は待ち時間
                    if (mutex.WaitOne(500, false))
                    {
                        try
                        {
                            Console.WriteLine("ID" + id + "が掴みました。");
                            Thread.Sleep(1000);
                        }
                        finally
                        {
                            // Mutex資源解放
                            // 忘れてCloseすると待機待ち側でAbandonedMutexException
                            // Disposeでは実行されないためusingに頼るのは不可
                            mutex.ReleaseMutex();
                            Console.WriteLine("ID" + id + "が解放しました。");
                        }
                    }
                    else
                    {
                        Console.WriteLine("ID" + id + "は掴めませんでした。");
                    }
                });
            }
            Console.ReadKey();
        }
    }
}

using System;

using System.Collections.Generic;

using System.Linq;

using System.Text;

using System.Threading;

using System.Threading.Tasks;

namespace MutexTest

{

class Program

{

static void Main(string［］ args)

{

using (Mutex mutex = new Mutex(false)) // 使い終わったらスレッド解放

{

const int N = 3;

// id0…0.7秒目～1.7秒目に掴む

// id1…1.4秒目から待機、1.7～2.7秒目に掴む

// id2…2.1秒目から待機、2.6秒目に諦める

Parallel.For(0, N, id =＞ // id0～2のスレッドを生成

{

Thread.Sleep(id * 700);

// ロック取得、成功ならtrue

// 第一引数は待ち時間

if (mutex.WaitOne(500, false))

{

try

{

Console.WriteLine("ID" + id + "が掴みました。");

Thread.Sleep(1000);

}

finally

{

// Mutex資源解放

// 忘れてCloseすると待機待ち側でAbandonedMutexException

// Disposeでは実行されないためusingに頼るのは不可

mutex.ReleaseMutex();

Console.WriteLine("ID" + id + "が解放しました。");

}

else

{

Console.WriteLine("ID" + id + "は掴めませんでした。");

}

});

}

Console.ReadKey();

}

【実行結果】

ID0が掴みました。
ID0が解放しました。
ID1が掴みました。
ID2は掴めませんでした。
ID1が解放しました。

ID0が掴みました。

ID0が解放しました。

ID1が掴みました。

ID2は掴めませんでした。

ID1が解放しました。

また、Mutexには、名前を付けることができます。
名前を付けることで、プロセス間でも排他制御が可能となります。
ただし、意図せずMutex名が被ると意図しないロックがかかってしまうため、扱いには注意が必要です。

【サンプルコード】

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading;
using System.Threading.Tasks;

namespace MutexTest2
{
    class Program
    {
        static void Main(string［］ args)
        {
            // 名前付きMutexだとプロセス間で共有できる
            //using (Mutex mutex = new Mutex(false))
            using (Mutex mutex = new Mutex(false,"hoge"))
            {
                // プロセス名取得（表示用）
                System.Diagnostics.Process p
                    = System.Diagnostics.Process.GetCurrentProcess();

                Console.WriteLine(DateTime.Now);
                Console.WriteLine(p.Id + "が掴もうとしています。");
                if (mutex.WaitOne(5000, false))
                {
                    try
                    {
                        Console.WriteLine(DateTime.Now);
                        Console.WriteLine(p.Id + "が掴みました。");
                        Thread.Sleep(10000);
                    }
                    finally
                    {
                        mutex.ReleaseMutex();
                        Console.WriteLine(DateTime.Now);
                        Console.WriteLine(p.Id + "が解放しました。");
                    }
                }
                else
                {
                    Console.WriteLine(DateTime.Now);
                    Console.WriteLine(p.Id + "は掴めませんでした。");
                }
            }
            Console.ReadKey();
        }
    }
}

using System;

using System.Collections.Generic;

using System.Linq;

using System.Text;

using System.Threading;

using System.Threading.Tasks;

namespace MutexTest2

{

class Program

{

static void Main(string［］ args)

{

// 名前付きMutexだとプロセス間で共有できる

//using (Mutex mutex = new Mutex(false))

using (Mutex mutex = new Mutex(false,"hoge"))

{

// プロセス名取得（表示用）

System.Diagnostics.Process p

= System.Diagnostics.Process.GetCurrentProcess();

Console.WriteLine(DateTime.Now);

Console.WriteLine(p.Id + "が掴もうとしています。");

if (mutex.WaitOne(5000, false))

{

try

{

Console.WriteLine(DateTime.Now);

Console.WriteLine(p.Id + "が掴みました。");

Thread.Sleep(10000);

}

finally

{

mutex.ReleaseMutex();

Console.WriteLine(DateTime.Now);

Console.WriteLine(p.Id + "が解放しました。");

}

else

{

Console.WriteLine(DateTime.Now);

Console.WriteLine(p.Id + "は掴めませんでした。");

}

Console.ReadKey();

}

【実行結果】

※exeファイルを３回起動した結果。
　１つ目のプロセス…掴んで解放
　２つ目のプロセス…解放を待って掴んで解放
　３つ目のプロセス…解放を待って掴めず諦める

2020/04/18 7:01:44
10420が掴もうとしています。
2020/04/18 7:01:44
10420が掴みました。
2020/04/18 7:01:54
10420が解放しました。

2020/04/18 7:01:50
2416が掴もうとしています。
2020/04/18 7:01:54
2416が掴みました。
2020/04/18 7:02:04
2416が解放しました。

2020/04/18 7:01:56
7524が掴もうとしています。
2020/04/18 7:02:01
7524は掴めませんでした。

2020/04/18 7:01:44

10420が掴もうとしています。

2020/04/18 7:01:44

10420が掴みました。

2020/04/18 7:01:54

10420が解放しました。

2020/04/18 7:01:50

2416が掴もうとしています。

2020/04/18 7:01:54

2416が掴みました。

2020/04/18 7:02:04

2416が解放しました。

2020/04/18 7:01:56

7524が掴もうとしています。

2020/04/18 7:02:01

7524は掴めませんでした。

いかがでしたでしょうか？

C#には排他制御のための機能が色々と用意されています。
その内の一つが今回紹介したMutexであり、名前を付けることでプロセス間の排他制御も可能になります。
名前付きMutexは、プロセスをまたいだスレッドの制御だけでなく、同じ画面が複数立ち上がらないようにする、といった使われ方もします。
仕組みが単純なので使用しやすく、排他制御の機能の中では使用頻度は高いと思います。

排他制御の機能は他にも色々と用意されているので、今後も紹介していきたいと思います！