[C++] C++20: 코루틴

코루틴은 비동기 처리를 위해 도입된 신기능이다.

다른 언어들에서 사용하는 코루틴과 비교하면 신택스가 상당히 복잡한 것 같다.
참으로 C++답다고 할 수 있다.

타입 정의

먼저 코루틴에 사용할 코루틴용 타입을 정의한다.

코루틴 타입은 문법에 따르면 promise라는 내부 타입을 가져야 한다.
자잘한 세부사항을 다 처리하고 싶지 않다면 coroutine_handler라는 녀석을 상속받아도 좋다.

그럼 이런 식으로 된다.

프로미스 타입의 규격에 대해서는 바로 다음 문단에서 다룬다.

프로미스 정의

이게 좀 복잡하다.
다음과 같이 총 4가지의 메서드를 구현해야 한다.

특별하게 커스텀애야 하는 부분이 없다면, 일단 이런식으로만 구현하면 된다.

struct promise {
	coroutine get_return_object()
	{
		return coroutine{ coroutine::from_promise(*this) };
	}

	std::suspend_always initial_suspend() noexcept 
	{
		return std::suspend_always{}; 
	}

	std::suspend_always final_suspend() noexcept 
	{ 
		return std::suspend_always{};
	}

	std::suspend_never return_void() {
		return std::suspend_never{};
	}

	void unhandled_exception() { std::puts("예외 발생"); }
};

C++의 코루틴은 하나의 정해진 형태가 있는건 아니고, 총 3가지의 형태가 있다고 할 수 있다.
사실 위에서 정의한 코루틴 타입을 코루틴이라고 하지는 않고, co_yield, co_await, co_return 중 하나 이상을 사용한 함수를 코루틴이라고 부른다.

하나씩 다뤄보겠다.

co_yield 구문

co_yield 구문을 사용해서 점진적인 상태 처리를 수행하는 법을 간략히 다뤄보겠다.

co_yield는 다른 언어의 코루틴 신택스와 동일하게, 함수 내에서 상태를 만들고 임시로 리턴을 해주는 기능이다.
그래서 코루틴을 다시 호출하면 그때 임시로 리턴했던 지점으로 돌아가서 로직을 마저 처리한다.

이를 이용하면 iterator 등을 구현하기 적절하다.

내 경우에는 간단한 카운터 객체를 만들어보았다.

// 코루틴 객체
template <class T>
struct coroutine: std::coroutine_handle<promise>{
	struct promise {
		coroutine get_return_object()
		{
			return coroutine(std::coroutine_handle<promise>::from_promise(*this));
		}

		std::suspend_always initial_suspend() noexcept
		{
			return {};
		}

		std::suspend_always final_suspend() noexcept
		{
			return {};
		}

		void return_void() {
		}

		void unhandled_exception() { std::puts("예외 발생"); }

		T value;

		std::suspend_always yield_value(T from) {
			this->value = from; // caching the result in promise
			return {};
		}
	};

	using promise_type = struct promise;
	std::coroutine_handle<promise> handle;

	coroutine(std::coroutine_handle<promise> handle) {
		this->handle = handle;
	}

	T operator()() {
		handle(); // resume
		auto result = handle.promise();
		return result.value;
	}
};

코드 형태가 좀 달라졌다.

프로미스 타입에는 yield_value라는 함수와 멤버변수 T value;가 추가되었는데, 외부에서 co_yield를 호출하면 그 값이 yield_value라는 함수로 넘어오게 된다.

그래서 그걸 저장해놓고, coroutine에서 펑터를 호출하면 그걸 다시 꺼내주는 형태가 되었다.

이제 밑준비는 되었으니, 함수만 정의하면 된다.

coroutine<int> new_counter() {
	int count = 0;

	while (true) {
		count++;
		co_yield count; // 반환한 후, 다시 실행되면 다시 돌아옴
	}
}

변수를 하나 깔고 무한루프를 돌면서 계속 반환하게 했다. 간단하다.

그럼 이제 사용자단에서는 이렇게 사용할 수 있다.

그렇다.

co_return 구문

co_return은 코루틴을 종료시키는 명령이다.
co_yield가 임시로 반환만 해서 다시 돌아올 수 있었다면, co_return은 아예 종료를 시켜버린다.

만약 위 카운터 코드에서 숫자가 3에 도달했을때 종료를 시키고 싶다면, 다음과 같이 할 수 있다.

그럼 코루틴이 done 상태가 되는데, 이 상태에서 resume을 시도하면 예외도 아니고 프로그램이 터진다.
이해는 안되지만 그렇다.

그래서 추가처리를 해주고

돌리면

이렇게 동작할 것이다.

co_await 구문

이건 다른 언어에서 사용하는 async/await 신택스와 흡사하다고 할 수 있다.

코루틴이 일단 실행되게 냅두다가, co_await를 호출하면 호출자는 피호출자(코루틴)가 끝나기까지 기다린다.

그다음에는 awaitable한 타입을 정의한다.
사실 위에서 쓴 suspend_never와 suspend_always 등도 이와 같은 구조의 awaitable 구현일 뿐이다.

await_ready는 현재 코루틴이 완전히 종료돼서 co_await를 받아들일 수 있는지를 체크하는 메서드다.
끝났을때 true를 던지면 된다.

await_suspend는 co_await를 완료할 수 없을때(await_ready가 false일때), await_resume은 co_await를 완료할 수 있을 때(await_ready가 true일때) 호출된다.
여기서는 굳이 사용할일이 없어서 비워뒀다.

그다음에 스레드 스폰은 이런식으로 구성했고

이렇게 스레드를 총 2개 띄웠다,

총 2개의 스레드를 올리지만, co_await으로 핸들링을 해서 첫번째 스레드가 종료되어 await된 후에 두번째 스레드가 실행되도록 했다.

그럼 이렇게 동작할 것이다.

참조
https://en.cppreference.com/w/cpp/language/coroutines
https://kukuta.tistory.com/222
https://kukuta.tistory.com/224