C# - IValueTaskSource로 인해 주의가 필요한 ValueTask 호출
지난 글에서,
C# - 간단하게 구현해 보는 IValueTaskSource 예제
; https://www.sysnet.pe.kr/2/0/13950
IValueTaskSource의 간단한 구현체를 다뤄봤는데요, 그렇다면 이제
"ValueTask를 multiple await 하지 말라는데"에 대한 답변을 해보겠습니다. ^^
이를 위해 지난번의 예제 코드를 약간 수정할 텐데요, 다름 아닌 반환값을 갖는 유형으로 바꿔보겠습니다.
public class DelayTaskSource : IValueTaskSource<int>
{
System.Threading.Timer? _timer;
Action? _action;
ObjectPool<DelayTaskSource>? _pool;
int _milliSeconds;
public DelayTaskSource()
{
Program.Log($"DelayTaskSource created ({RuntimeHelpers.GetHashCode(this)})");
}
public DelayTaskSource(int milliSeconds)
{
_milliSeconds = milliSeconds;
_timer = new Timer(ExpiredCallback, null, milliSeconds, 0);
}
public void Delay(int milliSeconds, ObjectPool<DelayTaskSource> pool)
{
_milliSeconds = milliSeconds;
_timer?.Dispose();
_pool = pool;
_timer = new System.Threading.Timer(ExpiredCallback, null, milliSeconds, 0);
}
public int GetResult(short token)
{
Program.Log($"GetResult called: {_milliSeconds} ({RuntimeHelpers.GetHashCode(this)})");
return _milliSeconds;
}
public ValueTaskSourceStatus GetStatus(short token)
{
return (_timer == null) ? ValueTaskSourceStatus.Succeeded : ValueTaskSourceStatus.Pending;
}
public void OnCompleted(Action<object?> continuation, object? state, short token, ValueTaskSourceOnCompletedFlags flags)
{
if (_timer == null)
{
continuation?.Invoke(state);
_pool?.Return(this);
Program.Log($"DelayTaskSource Return at OnCompleted: {_milliSeconds} ({RuntimeHelpers.GetHashCode(this)})");
return;
}
_action = () => { continuation(state); };
}
private void ExpiredCallback(object? _)
{
if (_timer != null)
{
_timer.Dispose();
_timer = null;
}
if (_action != null)
{
_action.Invoke();
_action = null;
}
_pool?.Return(this);
Program.Log($"DelayTaskSource Return at ExpiredCallback: {_milliSeconds} ({RuntimeHelpers.GetHashCode(this)})");
}
}
보는 바와 같이, 단순히 Sleep 시간을 반환하는 기능만 추가한 것이라 이해가 어렵지는 않을 것입니다.
자, 그럼 위의 코드를 반영한 ThreadSleep 메서드를 호출해 중간중간 넣어두었던 로그 출력을 확인해 보겠습니다.
static async Task Main(string[] _)
{
int sleptTime = await ThreadSleep(500);
Log($"ThreadSleep: {sleptTime}");
}
// Install-Package Microsoft.Extensions.ObjectPool
readonly static ObjectPool<DelayTaskSource> _pool = new DefaultObjectPool<DelayTaskSource>(new DefaultPooledObjectPolicy<DelayTaskSource>(), 10);
private static ValueTask<int> ThreadSleep(int sleep)
{
if (sleep == 0)
{
return new ValueTask<int>(0);
}
DelayTaskSource delayTask = _pool.Get();
delayTask.Delay(sleep, _pool);
return new ValueTask<int>(delayTask, 0);
}
/* 출력 결과:
[오후 10:59:22, 1] DelayTaskSource created
[오후 10:59:22, 6] GetResult called: 500
[오후 10:59:22, 6] ThreadSleep: 500
[오후 10:59:22, 6] DelayTaskSource Return at ExpiredCallback: 500
*/
위의 출력에서 의미 있는 것은 IValueTaskSource의 GetResult 메서드가 호출된 시점인데요, Pool에 반환되기 전 GetResult가 호출돼 결과를 반환했기 때문에 안전한 문맥 내에서 반환값이 처리된 것을 알 수 있습니다.
그리하여, 이제야 "
Understanding the Whys, Whats, and Whens of ValueTask" 글에서 언급한 경고 사례를 살펴볼 수 있게 됐는데요,
// GOOD
int result = await SomeValueTaskReturningMethodAsync();
// WARNING
ValueTask<int> vt = SomeValueTaskReturningMethodAsync();
... // storing the instance into a local makes it much more likely it'll be misused,
// but it could still be ok
첫 번째 "GOOD" 코드는 위에서 우리가 테스트했던 경우인 반면, 두 번째 "WARNING" 코드는 우리가 만든 코드에서 다음과 같이 재현할 수 있습니다.
// WARNING
ValueTask<int> sleepTask = ThreadSleep(900);
int result = await sleepTask;
Log($"Sleep 900: {result}");
/* 출력 결과:
[오후 11:26:20, 1] DelayTaskSource created (54267293)
[오후 11:26:21, 6] GetResult called: 900 (54267293)
[오후 11:26:21, 6] Sleep 900 == 900
[오후 11:26:21, 6] DelayTaskSource Return at ExpiredCallback: 900 (54267293)
*/
보는 바와 같이, 900ms를 대기했고 반환값이 900으로 잘 나왔습니다. 그런데 이게 왜 WARNING일까요? 그 이유는 await을 메서드 호출에 붙이지 않고 떼어냈기 때문입니다. 문제가 발생할 수 있는 상황은, 자칫 await을 한 시점이 너무 늦어 풀에 반환된 다음 호출될 가능성이 있는데요, 이것을 다음과 같이 재현할 수 있습니다.
// WARNING
ValueTask<int> sleepTask = ThreadSleep(900);
Thread.Sleep(2000); // Simulate some work
int result = await sleepTask;
Log($"Sleep 900 == {result}");
/* 출력 결과:
[오전 10:39:02, 1] DelayTaskSource created (54267293)
[오전 10:39:03, 6] DelayTaskSource Return at ExpiredCallback: 900 (54267293)
[오전 10:39:04, 1] GetResult called: 900 (54267293)
[오전 10:39:04, 1] Sleep 900 == 900
*/
보는 바와 같이, DelayTaskSource가 이미 풀에 반환된 후 GetResult가 호출됐는데요, 만약 저 개체가 다른 곳에서 재사용됐다면 결과는 잘못된 값이 나올 수 있습니다. 실제로 이것을 다음과 같이 재현할 수 있습니다.
// INVALID
ValueTask<int> sleepTask = ThreadSleep(900);
ThreadPool.QueueUserWorkItem(async (arg) =>
{
Thread.Sleep(2000); // 이전의 sleepTask가 풀에 반환될 시간을 주기 위해.
var result = await ThreadSleep(1000); // 여기서, sleepTask에 사용된 개체가 재사용
Log($"Sleep 1000: {result}");
});
Thread.Sleep(5000); // sleepTask가 재사용되도록 충분한 시간 대기
int slept = await sleepTask; // 여기서, 재사용된 개체의 GetResult가 호출되므로 문제 발생
Log($"Sleep 900 == {slept}");
/* 출력 결과:
[오전 10:40:21, 1] DelayTaskSource created (54267293)
[오전 10:40:22, 7] DelayTaskSource Return at ExpiredCallback: 900 (54267293)
[오전 10:40:24, 6] GetResult called: 1000 (54267293)
[오전 10:40:24, 6] Sleep 1000: 1000
[오전 10:40:24, 6] DelayTaskSource Return at ExpiredCallback: 1000 (54267293)
[오전 10:40:26, 1] GetResult called: 1000 (54267293)
[오전 10:40:26, 1] Sleep 900 == 1000
*/
보는 바와 같이, 이전에는 900이 나왔던 반환값이, 중간에 개체가 재사용되면서 1000이 나왔습니다.
사실 위의 문제로 인해 "
ValueTask를 multiple await 하지 말라는데"의 제약은 이미 더 설명할 필요를 없게 만듭니다. 왜냐하면, 다중 await을 하려면 해당 메서드에 직접적인 await을 사용하지 않고 ValueTask로 받아야 하므로,
// BAD: awaits multiple times
ValueTask<int> vt = SomeValueTaskReturningMethodAsync();
// 이미 이렇게 분리한 것 자체가 위에서 설명한 문제를 유발하므로!
int result = await vt;
// (다중 await의 문제가 있든 없든)
int result2 = await vt;
multiple await을 해야 하는 상황 자체가 이미 WARNING 단계에 속합니다. 참고로, 굳이 저 2개의 await에 문제가 있는 테스트를 구성하고 싶다면 대충 이런 식으로 할 수 있습니다.
static async Task Main(string[] _)
{
ValueTask<int> firstSleep = ThreadSleep(200);
int slept = await firstSleep; // 첫 번째 호출의 반환값은 200이지만,
Log($"Sleep 200 == {slept}");
ThreadPool.QueueUserWorkItem(async (arg) =>
{
Thread.Sleep(2000); // 이전 firstSleep이 풀에 반환될 시간을 주기 위해.
var result = await ThreadSleep(1000); // 여기서, fisrtSleep에 사용된 개체가 재사용
Log($"Sleep 1000 == {result}");
});
await Task.Delay(5000); // firstSleep의 continuation 실행이 다시 한번 ThreadPool의 영향을 받도록.
slept = await firstSleep; // 여기서, 재사용된 개체의 GetResult가 호출되므로 문제 발생
Log($"Sleep 200 == {slept}"); // 두 번째 호출의 반환값은 1000
}
/* 출력 결과
[오전 10:36:00, 1] DelayTaskSource created (54267293)
[오전 10:36:00, 6] GetResult called: 200 (54267293)
[오전 10:36:00, 6] Sleep 200 == 200
[오전 10:36:00, 6] DelayTaskSource Return at ExpiredCallback: 200 (54267293)
[오전 10:36:03, 7] GetResult called: 1000 (54267293)
[오전 10:36:03, 7] Sleep 1000 == 1000
[오전 10:36:03, 7] DelayTaskSource Return at ExpiredCallback: 1000 (54267293)
[오전 10:36:05, 7] GetResult called: 1000 (54267293)
[오전 10:36:05, 7] Sleep 200 == 1000
*/
한 가지 재미있는 건, 실제 글에서 예를 든 await 연속 호출의 경우에는,
// BAD: awaits multiple times
ValueTask<int> vt = SomeValueTaskReturningMethodAsync();
int result = await vt;
int result2 = await vt;
문제가 발생하는 경우를 찾기 어렵다는 점입니다. 왜냐하면, 첫 번째 await로 인해 호출되는 continuation 호출과 Pool의 반환은 다음과 같은 식으로 이뤄지는데요,
public void OnCompleted(Action<object?> continuation, object? state, short token, ValueTaskSourceOnCompletedFlags flags)
{
if (_timer == null)
{
continuation?.Invoke(state);
_pool?.Return(this);
Program.Log($"DelayTaskSource Return at OnCompleted: {_milliSeconds} ({RuntimeHelpers.GetHashCode(this)})");
return;
}
_action = () => { continuation(state); };
}
private void ExpiredCallback(object? _)
{
if (_timer != null)
{
_timer.Dispose();
_timer = null;
}
if (_action != null)
{
_action.Invoke();
_action = null;
}
_pool?.Return(this);
Program.Log($"DelayTaskSource Return at ExpiredCallback: {_milliSeconds} ({RuntimeHelpers.GetHashCode(this)})");
}
즉, await 이후 분리되는 코드의 continuation이 호출되고 나서야 Pool에 반환되므로, 두 번째 await의 호출이 첫 번째 await의 continuation에 중첩돼 실행되므로 Pool 반환이 일어나지 않습니다.
실제로 위의 문제라고 제시했던 코드도 중간에 await을 제거하면 재현이 안됩니다.
ValueTask<int> firstSleep = ThreadSleep(200);
int slept = await firstSleep;
// ...[생략]...
await Task.Delay(5000); // 이 코드로 인해 스레드가 달라지므로!
// 만약 Thread.Sleep(5000)으로 바꾸면 정상 동작
slept = await firstSleep;
Log($"Sleep 200 == {slept}");
그러니까 엄밀히 말해서 await이 2번 연속되는 상황에서 첫 번째 await 이후 곧바로 Pool에 반환되는 식은 (버그가 있는 IValueTaskSource 구현체가 아닌 이상) 코드상으로는 불가능합니다. (혹은 정상 구현인 경우에도 그럴 수 있는 시나리오가 있다면 덧글 부탁드립니다.)
(
첨부 파일은 이 글의 예제 코드를 포함합니다.)
정리하면, IValueTaskSource의 등장으로 인해 ValueTask를 반환하는 비동기 메서드를 사용 시 가능한 await을 직접 붙여서 사용하는 것이 권장된다는 점입니다.
[이 글에 대해서 여러분들과 의견을 공유하고 싶습니다. 틀리거나 미흡한 부분 또는 의문 사항이 있으시면 언제든 댓글 남겨주십시오.]