쓰기 전용 파일(예: 로그 파일)의 동기화 방법
서문 필요 없이 바로 코드로 설명해보면, 보통 로그 파일을 쓰기 위한 코드는 아래와 같이 작성됩니다.
HANDLE hFile = ::CreateFile(filePath, GENERIC_WRITE, 0, NULL, OPEN_ALWAYS, FILE_ATTRIBUTE_NORMAL, NULL);
if (hFile != INVALID_HANDLE_VALUE)
{
::SetFilePointerEx(hFile, ..., FILE_END);
::WriteFile(hFile, ...);
CloseHandle(hFile);
}
그런데, 스레드가 끼어들면 - 여러분들은 어떻게 하셨는지 모르겠지만 - 제 경우에는 다음과 같이 꼭!!! 언제나 스레드 동기화를 해주었습니다.
EnterCriticalSection(...);
HANDLE hFile = ::CreateFile(filePath, GENERIC_WRITE, 0, NULL, OPEN_ALWAYS, FILE_ATTRIBUTE_NORMAL, NULL);
if (hFile != INVALID_HANDLE_VALUE)
{
...
}
LeaveCriticalSection(...);
만약 스레드가 아니라, 프로세스 간에 하나의 파일에 로그를 쓰려고 하는 경우가 발생하면 뮤텍스로 동기화를 해주었습니다.
WaitForSingleObject(mutexHandle, INFINITE);
HANDLE hFile = ::CreateFile(filePath, GENERIC_WRITE, 0, NULL, OPEN_ALWAYS, FILE_ATTRIBUTE_NORMAL, NULL);
if (hFile != INVALID_HANDLE_VALUE)
{
...
}
ReleaseMutex(mutexHandle);
그런데,,, 동기화 작업은 쓸데없는 코드에 불과했습니다. 이유는? ^^
최근에 정말 재미있게 읽고 있는 책인데요.
IT EXPERT 윈도우 디바이스 드라이버 (저자 : 이봉석)
; http://www.yes24.com/24/goods/3219701
아주 재미있는 것을 하나 배웠습니다. 바로, ReadFile/WriteFile은 그 동작 자체에 이미 "직렬화" 과정이 포함되어 있다는 것입니다.
사실, 그동안 제가 생각 없이 살았던 것이지요. 어쩌면 굳이 저 책을 읽지 않았어도 '상식적'인 수준에서 평소에도 알 수 있었을 만한 것입니다. 왜냐하면, WriteFile 요청이 2개가 전달되었을 때 하드 디스크에 하나씩 전달되어 처리가 되는 것이 맞을 것입니다. 그렇지 않고, 첫 번째 WriteFile 요청으로 전달된 바이트 배열의 일부만을 디스크에 기록하다가 두 번째로 전달된 WriteFile 요청을 처리한다는 것은 '상식적'으로 맞지 않는 동작 방식입니다.
아하... 정말 그렇다면, "하나의 EXE 프로세스"에서 생성된 "다중 스레드"들은 굳이 CriticalSection을 사용할 필요도 없고, 핸들을 모든 스레드 간에 공유해도 전혀 문제가 안됩니다.
HANDLE g_hFile;
void Main()
{
g_hFile = ::CreateFile(filePath, GENERIC_WRITE, 0, NULL, OPEN_ALWAYS, FILE_ATTRIBUTE_NORMAL, NULL);
}
DWORD WINAPI ThreadFunc1(LPVOID lpParam)
{
WriteFile(g_hFile, ...);
...
}
그런데, 핸들을 공유하지 않고 매번 파일을 열고 닫는 식으로 사용해야 한다면 CriticalSection을 사용해야 합니다. 왜냐하면, "쓰기" 작업 전에 파일 포인터를 끝으로 옮겨야 하는 동작까지를 하나의 atomic 작업으로 묶어주어야 하기 때문입니다. 대신 임계영역을 묶어주는 범위가 줄어듭니다.
DWORD WINAPI ThreadFunc1(LPVOID lpParam)
{
HANDLE hFile = ::CreateFile(filePath, GENERIC_WRITE, FILE_SHARE_WRITE, NULL, OPEN_ALWAYS, FILE_ATTRIBUTE_NORMAL, NULL);
if (hFile != INVALID_HANDLE_VALUE)
{
::EnterCriticalSection(&critic);
::SetFilePointerEx(hFile, ..., FILE_END);
::WriteFile(hFile, ...);
::LeaveCriticalSection(&critic);
CloseHandle(hFile);
}
}
그런데, 더욱 깔끔한 방법이 있습니다. SetFilePointerEx 작업을 생략하기 위해 파일 자체를 append 모드로 열면 되는데, 다음과 같이 FILE_APPEND_DATA 플래그가 이런 경우에 사용됩니다.
DWORD WINAPI ThreadFunc1(LPVOID lpParam)
{
HANDLE hFile = ::CreateFile(filePath, FILE_APPEND_DATA,
FILE_SHARE_WRITE, NULL, OPEN_ALWAYS, FILE_ATTRIBUTE_NORMAL, NULL);
if (hFile != INVALID_HANDLE_VALUE)
{
::WriteFile(hFile, ...);
CloseHandle(hFile);
}
}
자,,, 그럼 2개 이상의 프로세스에서 하나의 파일에 대해 로그 작업을 남기는 경우라면 어떻게 될까요? 이 경우에는 FILE_APPEND_DATA를 쓰느냐/안쓰느냐에 따라서 달라집니다. 안 쓰는 경우에는 SetFilePointer/WriteFile 단위를 Mutex로 묶어주어야 합니다.
하지만, FILE_APPEND_DATA를 사용하게 되면 Mutex가 필요하지 않습니다. 즉, 단일 프로세스에서 로그 작업을 하는 것과 동일하게 다중 프로세스에서도 코드를 그대로 사용할 수 있습니다.
그럼, 간단히 아래와 같이 정리되었군요.
- 동기화 작업을 하지 말고,
- FILE_APPEND_DATA 모드로 파일을 연다.
여기까지는, Win32 API를 직접 사용한 경우의 이야기이고, 그렇다면 .NET Framework에서는 어떻게 될까요?
아쉽게도, .NET에서는 FileStream의 생성자에 FILE_APPEND_DATA와 동일한 기능을 하는 옵션을 줄 수가 없습니다. 이 때문에, P/Invoke로 직접 Win32 API의 CreateFile로 파일 핸들을 생성하고 그것을 FileStream에 전달해 주어야 합니다.
SafeFileHandle fileHandle = CreateFile(filePath, NativeFileAccess.FILE_APPEND_DATA,
NativeFileShare.FILE_SHARE_READ | NativeFileShare.FILE_SHARE_WRITE,
IntPtr.Zero, NativeFileMode.OPEN_ALWAYS,
NativeFileFlag.FILE_ATTRIBUTE_NORMAL, IntPtr.Zero);
using (file = new FileStream(fileHandle, FileAccess.Write))
{
file.Write( ... );
}
첨부한 파일에는 위의 Win32 API와 .NET을 테스트한 예제 프로젝트가 들어 있습니다.
----------------
* 이래서... 공부는 끝이 없는 것 같습니다. ^^ 사실 이 맛에 또 공부하고!
* SetFilePointer(hFile, 0, 0, FILE_END);는 4GB가 넘는 파일에 대해서 정상적으로 파일 끝을 가리키지 못합니다. 대용량 파일을 다뤄야 할 필요가 있는 경우에는 필히 SetFilePointerEx를 사용하십시오. ^^
[이 토픽에 대해서 여러분들과 의견을 공유하고 싶습니다. 틀리거나 미흡한 부분 또는 의문 사항이 있으시면 언제든 댓글 남겨주십시오.]