src/Reactor/Routine.hpp

// Copyright 2016 The SwiftShader Authors. All Rights Reserved.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//    http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

#ifndef rr_Routine_hpp
#define rr_Routine_hpp

// A Clang extension to determine compiler features.
// We use it to detect Sanitizer builds (e.g. -fsanitize=memory).
#ifndef __has_feature
#	define __has_feature(x) 0
#endif

#if __has_feature(memory_sanitizer)
#	include "sanitizer/msan_interface.h"
#endif

#include <memory>

namespace rr {

class Routine
{
public:
	Routine() = default;
	virtual ~Routine() = default;

	virtual const void *getEntry(int index = 0) const = 0;
};

// RoutineT is a type-safe wrapper around a Routine and its function entry, returned by FunctionT
template<typename FunctionType>
class RoutineT;

template<typename Return, typename... Arguments>
class RoutineT<Return(Arguments...)>
{
public:
	using FunctionType = Return (*)(Arguments...);

	RoutineT() = default;

	explicit RoutineT(const std::shared_ptr<Routine> &routine)
	    : routine(routine)
	{
		if(routine)
		{
			function = reinterpret_cast<FunctionType>(const_cast<void *>(routine->getEntry(0)));
		}
	}

	operator bool() const
	{
		return function != nullptr;
	}

	template<typename... Args>
	Return operator()(Args... args) const
	{
#if __has_feature(memory_sanitizer)
		// TODO(b/228253151): Fix support for detecting uninitialized parameters.
		__msan_unpoison_param(sizeof...(args));
#endif

		return function(args...);
	}

	const FunctionType getEntry() const
	{
		return function;
	}

private:
	std::shared_ptr<Routine> routine;
	FunctionType function = nullptr;
};

}  // namespace rr

#endif  // rr_Routine_hpp