Microsoft MVP성태의 닷넷 이야기
글쓴 사람
정성태 (techsharer at outlook.com)
홈페이지
첨부 파일
(연관된 글이 3개 있습니다.)

C# - CLR ThreadPool의 I/O 스레드에 작업을 맡기는 방법

답 먼저 이야기하면, ThreadPool에서 제공하는 RegisterWaitForSingleObject 정적 메서드를 이용하면 됩니다.

RegisterWaitForSingleObject function (winbase.h)
; https://learn.microsoft.com/en-us/windows/win32/api/winbase/nf-winbase-registerwaitforsingleobject

ThreadPool.RegisterWaitForSingleObject Method
; https://learn.microsoft.com/en-us/dotnet/api/system.threading.threadpool.registerwaitforsingleobject

ThreadPool.RegisterWaitForSingleObject의 경우 인자로 WaitHandle을 받아들이는데요, 따라서 그것을 상속한 System.Threading.EventWaitHandle, System.Threading.Mutex, System.Threading.Semaphore 개체와 연동할 수 있습니다.

예를 들어 볼까요?

EventWaitHandle을 이용해 작업을 추가하고, 별도로 생성한 스레드에서 그 이벤트를 대기해 처리하는 코드를 다음과 같이 만들 수 있습니다. (전형적인 Producer/Consumer 모델입니다.)

using System;
using System.Collections.Concurrent;
using System.Runtime.Versioning;

[assembly: SupportedOSPlatform("windows")]

internal class Program
{
    static EventWaitHandle _signal = new EventWaitHandle(false, EventResetMode.AutoReset);
    static ConcurrentQueue<string> _works = new ConcurrentQueue<string>();

    static void Main(string[] args)
    {
        Thread t = new Thread(consumerFunc);
        t.Start();

        while (true)
        {
            string? text = Console.ReadLine();
            if (string.IsNullOrEmpty(text))
            {
                break;
            }

            _works.Enqueue(text);
            _signal.Set();
        }
    }

    private static void doWork(string text)
    {
        Console.WriteLine($"echo: {text}");
    }

    private static void consumerFunc(object? obj)
    {
        while (true)
        {
            _signal.WaitOne();

            if (_works.TryDequeue(out var text) == true)
            {
                doWork(text);
            }
        }
    }
}

위의 코드를 보면, "Consumer" 역할을 위해 별도의 스레드를 생성했는데요, 사실 스레드를 하나 별도로 유지하는 게 은근히 귀찮은 작업입니다. (혹은 다중 스레드로 consumer 역할을 하는 경우까지 생각하면 더더욱 귀찮습니다. ^^;) 기왕이면, 기본적으로 활성화되어 있는 CLR ThreadPool에 작업을 맡기는 것도 좋을 텐데요, 바로 이런 처리를 ThreadPool.RegisterWaitForSingleObject로 할 수 있습니다.

실제로, 아래의 소스 코드는 ThreadPool.RegisterWaitForSingleObject를 이용해 동일한 기능을 구현한 것입니다.

using System.Collections.Concurrent;
using System.Runtime.Versioning;

[assembly: SupportedOSPlatform("windows")]

internal class Program
{
    static EventWaitHandle _signal = new EventWaitHandle(false, EventResetMode.AutoReset);
    static ConcurrentQueue<string> _works = new ConcurrentQueue<string>();

    static void Main(string[] args)
    {
        RegisteredWaitHandle rwh = ThreadPool.RegisterWaitForSingleObject(_signal, doWork, null, -1, false);

        while (true)
        {
            string? text = Console.ReadLine();
            if (string.IsNullOrEmpty(text))
            {
                break;
            }

            _works.Enqueue(text);
            _signal.Set();
        }

        rwh.Unregister(_signal);
    }

    private static void doWork(object? state, bool timedOut)
    {
        if (_works.TryDequeue(out var text) == true)
        {
            Console.WriteLine($"echo: {text}");
        }
    }
}

좀 더 간결해졌죠? ^^ 게다가 아래의 글에서는,

AutoReset, ManualReset, Monitor.Wait의 차이
; https://www.sysnet.pe.kr/2/0/1015#4

Consumer 역할의 스레드 제거를 우아하게 하기 위해 ManualReset 이벤트까지 활용했어야 하는데 ThreadPool.RegisterWaitForSingleObject를 이용하면 그것마저도 필요가 없습니다. (어찌 보면, BlockingCollection<T>을 이용하는 것보다 더 쉽습니다.)




해본 김에, 적당한 활용 사례를 하나 더 들어볼까요? 예전에 썼던 글이 하나 떠오르는데요,

PInvoke 호출을 이용한 비동기 파일 작업
; https://www.sysnet.pe.kr/2/0/1750

위의 코드는 C#의 FileStream.WriteAsync를 Win32 API를 이용해 직접 구현한 것입니다. 하지만 아쉽게도 비동기 동작으로 WriteFile API는 호출했지만, WaitHandle.WaitAny를 이용해 대기함으로써 사실상 처리는 동기 방식과 다를 바가 없었습니다.

이것을 ThreadPool.RegisterWaitForSingleObject을 이용해 처리하면 BCL의 WriteAsync 메서드와 유사하게 동작을 흉내 낼 수 있습니다.

using Microsoft.Win32.SafeHandles;
using System.Diagnostics.CodeAnalysis;
using System.Runtime.InteropServices;
using System.Runtime.Versioning;
using System.Text;

[assembly: SupportedOSPlatform("windows")]

class Program
{
    [DllImport("kernel32.dll", SetLastError = true)]
    public static extern SafeFileHandle CreateFile(
       String pipeName,
       uint dwDesiredAccess,
       uint dwShareMode,
       IntPtr lpSecurityAttributes,
       uint dwCreationDisposition,
       uint dwFlagsAndAttributes,
       IntPtr hTemplate);

    [DllImport("kernel32.dll", SetLastError = true)]
    static extern bool WriteFile(SafeFileHandle hFile, byte[] lpBuffer,
       int nNumberOfBytesToWrite, out uint lpNumberOfBytesWritten,
       [In] ref System.Threading.NativeOverlapped lpOverlapped);

    public const int FILE_FLAG_OVERLAPPED = 0x40000000;

    static void Main(string[] args)
    {
        string txt = new string('t', 1024 * 1024 * 600);
        byte[] buf = Encoding.ASCII.GetBytes(txt);

        File.Delete(@"C:\temp\test.txt");

        using (SafeFileHandle pHandle = CreateFile(@"c:\temp\test.txt",
                (uint)FileAccess.ReadWrite,
                0,
                IntPtr.Zero,
                (uint)2,
                FILE_FLAG_OVERLAPPED,
                IntPtr.Zero))
        {
            uint written;
            NativeOverlapped o = new NativeOverlapped();

            EventWaitHandle writeEvent = new EventWaitHandle(false, EventResetMode.AutoReset);
            o.EventHandle = writeEvent.SafeWaitHandle.DangerousGetHandle();

            if (WriteFile(pHandle, buf, buf.Length, out written, ref o) == false)
            {
                int lastError = Marshal.GetLastWin32Error();
                if (lastError == 997) //  ERROR_IO_PENDING == 997
                {
                    OverlappedParameter op = new OverlappedParameter()
                    {
                        Event = writeEvent,
                    };

                    op.WaitHandle = ThreadPool.RegisterWaitForSingleObject(writeEvent, WriteCompleted, op, -1, false);
                    op.TryUnregister();
                }
                else
                {
                    // Write File Error
                    Console.WriteLine("Write File Error");
                    writeEvent.Close();
                }
            }
        }

        Console.WriteLine("Press Enter to exit ...");
        Console.ReadLine();
    }

    public static void WriteCompleted(object? objState, bool timedOut)
    {
        OverlappedParameter? op = objState as OverlappedParameter;
        if (op == null)
        {
            return;
        }

        Console.WriteLine("async WriteCompleted");
        op.Done();
    }
}

public class OverlappedParameter
{
    [AllowNull]
    public EventWaitHandle Event { get; set; } = null;

    [AllowNull]
    public RegisteredWaitHandle WaitHandle { get; set; } = null;

    bool _done;
    bool _disposed;

    public void Done()
    {
        _done = true;
        TryUnregister();
    }

    public void TryUnregister()
    {
        if (_done == false)
        {
            return;
        }

        lock (Event)
        {
            if (_disposed == true)
            {
                return;
            }

            _disposed = true;

            WaitHandle.Unregister(Event);
            Event.Dispose();
        }
    }
}

오~~~ 좀 그럴 듯하게 바뀌었습니다. ^^




그나저나, ThreadPool.RegisterWaitForSingleObject로 인해 콜백을 호출하는 스레드는 Worker일까요? I/O일까요? ThreadPool.SetMaxThreads를 이용해 간단하게 테스트해 보면 됩니다. ^^

C# - ThreadPool.SetMaxThreads 사용법
; https://www.sysnet.pe.kr/2/0/13058

각각 다음과 같은 2가지 경우로 실행해 보면 될 텐데요,

// Worker 스레드 수를 최대 1개로 변경
ThreadPool.SetMinThreads(1, 4);
ThreadPool.SetMaxThreads(1, 4);

// I/O 스레드 수를 최대 1개로 변경
ThreadPool.SetMinThreads(4, 1);
ThreadPool.SetMaxThreads(4, 1);

위와 같은 설정 상태에서 WriteAsync를 2번 연이어 호출하고 콜백 메서드에서는 의도적으로 5초 정도 지연하면 결과를 금방 확인할 수 있습니다.

static void Main(string[] args)
{
    ThreadPool.SetMinThreads(...[스레드 제약]...);
    ThreadPool.SetMaxThreads(...[스레드 제약]...);

    // ...[생략]...
    WriteAsync(pHandle, buf); // RegisterWaitForSingleObject 호출을 이용한 비동기 파일 Write를 담고 있는 메서드 
    WriteAsync(pHandle, buf);

    // ...[생략]...
    Console.WriteLine("Press Enter to exit ...");
    Console.ReadLine();
}

public static void WriteCompleted(object? objState, bool timedOut)
{
    Console.WriteLine($"{DateTime.Now} async WriteCompleted");

    Thread.Sleep(1000 * 5);

    // ...[생략]...
}

우선, Worker 스레드를 1개로 제한했을 때는 이런 식으로 출력이 되었고,

2022-05-14 오전 12:25:42 async WriteCompleted
Press Enter to exit ...
2022-05-14 오전 12:25:42 async WriteCompleted

I/O 스레드를 1개로 제한했을 때는 이런 식으로 출력이 되었습니다.

2022-05-14 오전 12:26:01 async WriteCompleted
Press Enter to exit ...
2022-05-14 오전 12:27:06 async WriteCompleted

즉, ThreadPool.RegisterWaitForSingleObject로 인한 콜백은 I/O 스레드에서 호출되는 것입니다. 그렇다면, 다음과 같이 ThreadPool의 사용법이 정리가 됩니다.

[Worker 스레드에 작업을 할당] ThreadPool.QueueUserWorkItem
[I/O 스레드에 작업을 할당] ThreadPool.RegisterWaitForSingleObject

(첨부 파일은 이 글의 예제 코드를 포함합니다.)




[이 글에 대해서 여러분들과 의견을 공유하고 싶습니다. 틀리거나 미흡한 부분 또는 의문 사항이 있으시면 언제든 댓글 남겨주십시오.]

[연관 글]






[최초 등록일: ]
[최종 수정일: 11/4/2022]

Creative Commons License
이 저작물은 크리에이티브 커먼즈 코리아 저작자표시-비영리-변경금지 2.0 대한민국 라이센스에 따라 이용하실 수 있습니다.
by SeongTae Jeong, mailto:techsharer at outlook.com

비밀번호

댓글 작성자
 



2023-02-16 09시53분
What are the potentially-erroneous results if you don’t pass NULL as the lpNumberOfBytesRead when issuing overlapped I/O?
; https://devblogs.microsoft.com/oldnewthing/20230215-00/?p=107832

overlapped I/O 수행 시 굳이 lpNumber­Of­Bytes­Read 인자에 값을 넣을 필요는 필요는 없다고 합니다. 심지어, 자칫 Get­Overlapped­Result에 같은 변수가 사용되면 부작용까지 발생할 수 있습니다. 그래서 차라리 문서에서는 복잡한 설명을 추가하기보다는 그냥 lpNumber­Of­Bytes­Read에 null을 전달하라는 식으로 써졌다고 하는데요. ^^

그래도 lpNumber­Of­Bytes­Read 인자가 의미가 있을 때도 있다고 합니다. FILE_SKIP_COMPLETION_PORT_ON_SUCCESS 옵션으로 I/O를 수행 시에는 읽어낸 바이트 수를 알아내기 위해 별도로 Get­Overlapped­Result를 호출해야 하지만 그것 없이 lpNumber­Of­Bytes­Read 인자를 전달하면 성능상 micro-optimization 수준에서 의미가 있다고.
정성태

1  2  3  4  5  [6]  7  8  9  10  11  12  13  14  15  ...
NoWriterDateCnt.TitleFile(s)
13445정성태11/15/20232032Linux: 62. 리눅스/WSL에서 CA 인증서를 저장하는 방법
13444정성태11/15/20231863닷넷: 2160. C# 12 - Experimental 특성 지원
13443정성태11/14/20231857개발 환경 구성: 687. OpenSSL로 생성한 사용자 인증서를 ASP.NET Core 웹 사이트에 적용하는 방법
13442정성태11/13/20231753개발 환경 구성: 686. 비주얼 스튜디오로 실행한 ASP.NET Core 사이트를 WSL 2 인스턴스에서 https로 접속하는 방법
13441정성태11/12/20231960닷넷: 2159. C# - ASP.NET Core 프로젝트에서 서버 Socket을 직접 생성하는 방법파일 다운로드1
13440정성태11/11/20231712Windows: 253. 소켓 Listen 시 방화벽의 Public/Private 제어 기능이 비활성화된 경우
13439정성태11/10/20232069닷넷: 2158. C# - 소켓 포트를 미리 시스템에 등록/예약해 사용하는 방법(Port Exclusion Ranges)파일 다운로드1
13438정성태11/9/20231820닷넷: 2157. C# - WinRT 기능을 이용해 윈도우에서 실행 중인 Media App 제어
13437정성태11/8/20231979닷넷: 2156. .NET 7 이상의 콘솔 프로그램을 (dockerfile 없이) 로컬 docker에 배포하는 방법
13436정성태11/7/20232222닷넷: 2155. C# - .NET 8 런타임부터 (Reflection 없이) 특성을 이용해 public이 아닌 멤버 호출 가능
13435정성태11/6/20232210닷넷: 2154. C# - 네이티브 자원을 포함한 관리 개체(예: 스레드)의 GC 정리
13434정성태11/1/20232013스크립트: 62. 파이썬 - class의 정적 함수를 동적으로 교체
13433정성태11/1/20231756스크립트: 61. 파이썬 - 함수 오버로딩 미지원
13432정성태10/31/20231746오류 유형: 878. 탐색기의 WSL 디렉터리 접근 시 "Attempt to access invalid address." 오류 발생
13431정성태10/31/20232011스크립트: 60. 파이썬 - 비동기 FastAPI 앱을 gunicorn으로 호스팅
13430정성태10/30/20231975닷넷: 2153. C# - 사용자가 빌드한 ICU dll 파일을 사용하는 방법
13429정성태10/27/20232191닷넷: 2152. Win32 Interop - C/C++ DLL로부터 이중 포인터 버퍼를 C#으로 받는 예제파일 다운로드1
13428정성태10/25/20232243닷넷: 2151. C# 12 - ref readonly 매개변수
13427정성태10/18/20232430닷넷: 2150. C# 12 - 정적 문맥에서 인스턴스 멤버에 대한 nameof 접근 허용(Allow nameof to always access instance members from static context)
13426정성태10/13/20232490스크립트: 59. 파이썬 - 비동기 호출 함수(run_until_complete, run_in_executor, create_task, run_in_threadpool)
13425정성태10/11/20232423닷넷: 2149. C# - PLinq의 Partitioner<T>를 이용한 사용자 정의 분할파일 다운로드1
13423정성태10/6/20232427스크립트: 58. 파이썬 - async/await 기본 사용법
13422정성태10/5/20232600닷넷: 2148. C# - async 유무에 따른 awaitable 메서드의 병렬 및 예외 처리
13421정성태10/4/20232610닷넷: 2147. C# - 비동기 메서드의 async 예약어 유무에 따른 차이
13420정성태9/26/20233727스크립트: 57. 파이썬 - UnboundLocalError: cannot access local variable '...' where it is not associated with a value
13419정성태9/25/20232470스크립트: 56. 파이썬 - RuntimeError: dictionary changed size during iteration
1  2  3  4  5  [6]  7  8  9  10  11  12  13  14  15  ...