src/Device/Renderer.hpp - SwiftShader - Git at Google

 // 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 sw_Renderer_hpp
 #define sw_Renderer_hpp

 #include "VertexProcessor.hpp"
 #include "PixelProcessor.hpp"
 #include "SetupProcessor.hpp"
 #include "Plane.hpp"
 #include "Blitter.hpp"
 #include "System/MutexLock.hpp"
 #include "System/Thread.hpp"
 #include "Device/Config.hpp"
 #include "Vulkan/VkDescriptorSet.hpp"

 #include <list>

 namespace vk
 {
 	class DescriptorSet;
 	struct Query;
 }

 namespace sw
 {
 	class Clipper;
 	struct DrawCall;
 	class PixelShader;
 	class VertexShader;
 	class SwiftConfig;
 	struct Task;
 	class Resource;
 	struct Constants;

 	enum TranscendentalPrecision
 	{
 		APPROXIMATE,
 		PARTIAL,	// 2^-10
 		ACCURATE,
 		WHQL,		// 2^-21
 		IEEE		// 2^-23
 	};

 	extern TranscendentalPrecision logPrecision;
 	extern TranscendentalPrecision expPrecision;
 	extern TranscendentalPrecision rcpPrecision;
 	extern TranscendentalPrecision rsqPrecision;
 	extern bool perspectiveCorrection;

 	struct Conventions  // FIXME(capn): Eliminate. Only support Vulkan 1.1 conventions.
 	{
 		bool halfIntegerCoordinates;
 		bool symmetricNormalizedDepth;
 		bool booleanFaceRegister;
 		bool fullPixelPositionRegister;
 	};

 	static const Conventions OpenGL =
 	{
 		true,    // halfIntegerCoordinates
 		true,    // symmetricNormalizedDepth
 		true,    // booleanFaceRegister
 		true,    // fullPixelPositionRegister
 	};

 	static const Conventions Direct3D =
 	{
 		false,   // halfIntegerCoordinates
 		false,   // symmetricNormalizedDepth
 		false,   // booleanFaceRegister
 		false,   // fullPixelPositionRegister
 	};

 	struct DrawData
 	{
 		const Constants *constants;

 		vk::DescriptorSet::Bindings descriptorSets = {};
 		vk::DescriptorSet::DynamicOffsets descriptorDynamicOffsets = {};

 		const void *input[MAX_VERTEX_INPUTS];
 		unsigned int stride[MAX_VERTEX_INPUTS];
 		Texture mipmap[TOTAL_IMAGE_UNITS];
 		const void *indices;

 		int instanceID;
 		int baseVertex;
 		float lineWidth;

 		PixelProcessor::Stencil stencil[2];   // clockwise, counterclockwise
 		PixelProcessor::Factor factor;
 		unsigned int occlusion[16];   // Number of pixels passing depth test

 		#if PERF_PROFILE
 			int64_t cycles[PERF_TIMERS][16];
 		#endif

 		float4 Wx16;
 		float4 Hx16;
 		float4 X0x16;
 		float4 Y0x16;
 		float4 halfPixelX;
 		float4 halfPixelY;
 		float viewportHeight;
 		float slopeDepthBias;
 		float depthRange;
 		float depthNear;
 		Plane clipPlane[6];

 		unsigned int *colorBuffer[RENDERTARGETS];
 		int colorPitchB[RENDERTARGETS];
 		int colorSliceB[RENDERTARGETS];
 		float *depthBuffer;
 		int depthPitchB;
 		int depthSliceB;
 		unsigned char *stencilBuffer;
 		int stencilPitchB;
 		int stencilSliceB;

 		int scissorX0;
 		int scissorX1;
 		int scissorY0;
 		int scissorY1;

 		float4 a2c0;
 		float4 a2c1;
 		float4 a2c2;
 		float4 a2c3;

 		PushConstantStorage pushConstants;
 	};

 	class Renderer : public VertexProcessor, public PixelProcessor, public SetupProcessor
 	{
 		struct Task
 		{
 			enum Type
 			{
 				PRIMITIVES,
 				PIXELS,

 				RESUME,
 				SUSPEND
 			};

 			AtomicInt type;
 			AtomicInt primitiveUnit;
 			AtomicInt pixelCluster;
 		};

 		struct PrimitiveProgress
 		{
 			void init()
 			{
 				drawCall = 0;
 				firstPrimitive = 0;
 				primitiveCount = 0;
 				visible = 0;
 				references = 0;
 			}

 			AtomicInt drawCall;
 			AtomicInt firstPrimitive;
 			AtomicInt primitiveCount;
 			AtomicInt visible;
 			AtomicInt references;
 		};

 		struct PixelProgress
 		{
 			void init()
 			{
 				drawCall = 0;
 				processedPrimitives = 0;
 				executing = false;
 			}

 			AtomicInt drawCall;
 			AtomicInt processedPrimitives;
 			AtomicInt executing;
 		};

 	public:
 		Renderer(Context *context, Conventions conventions, bool exactColorRounding);

 		virtual ~Renderer();

 		void *operator new(size_t size);
 		void operator delete(void * mem);

 		void draw(VkPrimitiveTopology topology, VkIndexType indexType, unsigned int count, int baseVertex, bool update = true);

 		void setContext(const sw::Context& context);

 		void setMultiSampleMask(unsigned int mask);
 		void setTransparencyAntialiasing(TransparencyAntialiasing transparencyAntialiasing);

 		void setLineWidth(float width);

 		void setDepthBias(float bias);
 		void setSlopeDepthBias(float slopeBias);

 		void setRasterizerDiscard(bool rasterizerDiscard);

 		// Programmable pipelines
 		void setPixelShader(const SpirvShader *shader);
 		void setVertexShader(const SpirvShader *shader);

 		// Viewport & Clipper
 		void setViewport(const VkViewport &viewport);
 		void setScissor(const VkRect2D &scissor);

 		void addQuery(vk::Query *query);
 		void removeQuery(vk::Query *query);

 		void advanceInstanceAttributes();

 		void synchronize();

 		#if PERF_HUD
 			// Performance timers
 			int getThreadCount();
 			int64_t getVertexTime(int thread);
 			int64_t getSetupTime(int thread);
 			int64_t getPixelTime(int thread);
 			void resetTimers();
 		#endif

 		static int getClusterCount() { return clusterCount; }

 	private:
 		static void threadFunction(void *parameters);
 		void threadLoop(int threadIndex);
 		void taskLoop(int threadIndex);
 		void findAvailableTasks();
 		void scheduleTask(int threadIndex);
 		void executeTask(int threadIndex);
 		void finishRendering(Task &pixelTask);

 		void processPrimitiveVertices(int unit, unsigned int start, unsigned int count, unsigned int loop, int thread);

 		int setupTriangles(int batch, int count);
 		int setupLines(int batch, int count);
 		int setupPoints(int batch, int count);

 		bool setupLine(Primitive &primitive, Triangle &triangle, const DrawCall &draw);
 		bool setupPoint(Primitive &primitive, Triangle &triangle, const DrawCall &draw);

 		void updateConfiguration(bool initialUpdate = false);
 		void initializeThreads();
 		void terminateThreads();

 		Context *context;
 		Clipper *clipper;
 		Blitter *blitter;
 		VkViewport viewport;
 		VkRect2D scissor;
 		int clipFlags;

 		Triangle *triangleBatch[16];
 		Primitive *primitiveBatch[16];

 		AtomicInt exitThreads;
 		AtomicInt threadsAwake;
 		Thread *worker[16];
 		Event *resume[16];         // Events for resuming threads
 		Event *suspend[16];        // Events for suspending threads
 		Event *resumeApp;          // Event for resuming the application thread

 		PrimitiveProgress primitiveProgress[16];
 		PixelProgress pixelProgress[16];
 		Task task[16];   // Current tasks for threads

 		enum {
 			DRAW_COUNT = 16,   // Number of draw calls buffered (must be power of 2)
 			DRAW_COUNT_BITS = DRAW_COUNT - 1,
 		};
 		DrawCall *drawCall[DRAW_COUNT];
 		DrawCall *drawList[DRAW_COUNT];

 		AtomicInt currentDraw;
 		AtomicInt nextDraw;

 		enum {
 			TASK_COUNT = 32,   // Size of the task queue (must be power of 2)
 			TASK_COUNT_BITS = TASK_COUNT - 1,
 		};
 		Task taskQueue[TASK_COUNT];
 		AtomicInt qHead;
 		AtomicInt qSize;

 		static AtomicInt unitCount;
 		static AtomicInt clusterCount;

 		MutexLock schedulerMutex;

 		#if PERF_HUD
 			int64_t vertexTime[16];
 			int64_t setupTime[16];
 			int64_t pixelTime[16];
 		#endif

 		VertexTask *vertexTask[16];

 		SwiftConfig *swiftConfig;

 		std::list<vk::Query*> queries;
 		Resource *sync;

 		VertexProcessor::State vertexState;
 		SetupProcessor::State setupState;
 		PixelProcessor::State pixelState;

 		Routine *vertexRoutine;
 		Routine *setupRoutine;
 		Routine *pixelRoutine;
 	};

 	struct DrawCall
 	{
 		DrawCall();

 		~DrawCall();

 		AtomicInt topology;
 		AtomicInt indexType;
 		AtomicInt batchSize;

 		Routine *vertexRoutine;
 		Routine *setupRoutine;
 		Routine *pixelRoutine;

 		VertexProcessor::RoutinePointer vertexPointer;
 		SetupProcessor::RoutinePointer setupPointer;
 		PixelProcessor::RoutinePointer pixelPointer;

 		int (Renderer::*setupPrimitives)(int batch, int count);
 		SetupProcessor::State setupState;

 		vk::ImageView *renderTarget[RENDERTARGETS];
 		vk::ImageView *depthBuffer;
 		vk::ImageView *stencilBuffer;

 		std::list<vk::Query*> *queries;

 		AtomicInt primitive;    // Current primitive to enter pipeline
 		AtomicInt count;        // Number of primitives to render
 		AtomicInt references;   // Remaining references to this draw call, 0 when done drawing, -1 when resources unlocked and slot is free

 		DrawData *data;
 	};
 }

 #endif   // sw_Renderer_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 sw_Renderer_hpp
	#define sw_Renderer_hpp

	#include "VertexProcessor.hpp"
	#include "PixelProcessor.hpp"
	#include "SetupProcessor.hpp"
	#include "Plane.hpp"
	#include "Blitter.hpp"
	#include "System/MutexLock.hpp"
	#include "System/Thread.hpp"
	#include "Device/Config.hpp"
	#include "Vulkan/VkDescriptorSet.hpp"

	#include <list>

	namespace vk
	{
	class DescriptorSet;
	struct Query;
	}

	namespace sw
	{
	class Clipper;
	struct DrawCall;
	class PixelShader;
	class VertexShader;
	class SwiftConfig;
	struct Task;
	class Resource;
	struct Constants;

	enum TranscendentalPrecision
	{
	APPROXIMATE,
	PARTIAL, // 2^-10
	ACCURATE,
	WHQL, // 2^-21
	IEEE // 2^-23
	};

	extern TranscendentalPrecision logPrecision;
	extern TranscendentalPrecision expPrecision;
	extern TranscendentalPrecision rcpPrecision;
	extern TranscendentalPrecision rsqPrecision;
	extern bool perspectiveCorrection;

	struct Conventions // FIXME(capn): Eliminate. Only support Vulkan 1.1 conventions.
	{
	bool halfIntegerCoordinates;
	bool symmetricNormalizedDepth;
	bool booleanFaceRegister;
	bool fullPixelPositionRegister;
	};

	static const Conventions OpenGL =
	{
	true, // halfIntegerCoordinates
	true, // symmetricNormalizedDepth
	true, // booleanFaceRegister
	true, // fullPixelPositionRegister
	};

	static const Conventions Direct3D =
	{
	false, // halfIntegerCoordinates
	false, // symmetricNormalizedDepth
	false, // booleanFaceRegister
	false, // fullPixelPositionRegister
	};

	struct DrawData
	{
	const Constants *constants;

	vk::DescriptorSet::Bindings descriptorSets = {};
	vk::DescriptorSet::DynamicOffsets descriptorDynamicOffsets = {};

	const void *input[MAX_VERTEX_INPUTS];
	unsigned int stride[MAX_VERTEX_INPUTS];
	Texture mipmap[TOTAL_IMAGE_UNITS];
	const void *indices;

	int instanceID;
	int baseVertex;
	float lineWidth;

	PixelProcessor::Stencil stencil[2]; // clockwise, counterclockwise
	PixelProcessor::Factor factor;
	unsigned int occlusion[16]; // Number of pixels passing depth test

	#if PERF_PROFILE
	int64_t cycles[PERF_TIMERS][16];
	#endif

	float4 Wx16;
	float4 Hx16;
	float4 X0x16;
	float4 Y0x16;
	float4 halfPixelX;
	float4 halfPixelY;
	float viewportHeight;
	float slopeDepthBias;
	float depthRange;
	float depthNear;
	Plane clipPlane[6];

	unsigned int *colorBuffer[RENDERTARGETS];
	int colorPitchB[RENDERTARGETS];
	int colorSliceB[RENDERTARGETS];
	float *depthBuffer;
	int depthPitchB;
	int depthSliceB;
	unsigned char *stencilBuffer;
	int stencilPitchB;
	int stencilSliceB;

	int scissorX0;
	int scissorX1;
	int scissorY0;
	int scissorY1;

	float4 a2c0;
	float4 a2c1;
	float4 a2c2;
	float4 a2c3;

	PushConstantStorage pushConstants;
	};

	class Renderer : public VertexProcessor, public PixelProcessor, public SetupProcessor
	{
	struct Task
	{
	enum Type
	{
	PRIMITIVES,
	PIXELS,

	RESUME,
	SUSPEND
	};

	AtomicInt type;
	AtomicInt primitiveUnit;
	AtomicInt pixelCluster;
	};

	struct PrimitiveProgress
	{
	void init()
	{
	drawCall = 0;
	firstPrimitive = 0;
	primitiveCount = 0;
	visible = 0;
	references = 0;
	}

	AtomicInt drawCall;
	AtomicInt firstPrimitive;
	AtomicInt primitiveCount;
	AtomicInt visible;
	AtomicInt references;
	};

	struct PixelProgress
	{
	void init()
	{
	drawCall = 0;
	processedPrimitives = 0;
	executing = false;
	}

	AtomicInt drawCall;
	AtomicInt processedPrimitives;
	AtomicInt executing;
	};

	public:
	Renderer(Context *context, Conventions conventions, bool exactColorRounding);

	virtual ~Renderer();

	void *operator new(size_t size);
	void operator delete(void * mem);

	void draw(VkPrimitiveTopology topology, VkIndexType indexType, unsigned int count, int baseVertex, bool update = true);

	void setContext(const sw::Context& context);

	void setMultiSampleMask(unsigned int mask);
	void setTransparencyAntialiasing(TransparencyAntialiasing transparencyAntialiasing);

	void setLineWidth(float width);

	void setDepthBias(float bias);
	void setSlopeDepthBias(float slopeBias);

	void setRasterizerDiscard(bool rasterizerDiscard);

	// Programmable pipelines
	void setPixelShader(const SpirvShader *shader);
	void setVertexShader(const SpirvShader *shader);

	// Viewport & Clipper
	void setViewport(const VkViewport &viewport);
	void setScissor(const VkRect2D &scissor);

	void addQuery(vk::Query *query);
	void removeQuery(vk::Query *query);

	void advanceInstanceAttributes();

	void synchronize();

	#if PERF_HUD
	// Performance timers
	int getThreadCount();
	int64_t getVertexTime(int thread);
	int64_t getSetupTime(int thread);
	int64_t getPixelTime(int thread);
	void resetTimers();
	#endif

	static int getClusterCount() { return clusterCount; }

	private:
	static void threadFunction(void *parameters);
	void threadLoop(int threadIndex);
	void taskLoop(int threadIndex);
	void findAvailableTasks();
	void scheduleTask(int threadIndex);
	void executeTask(int threadIndex);
	void finishRendering(Task &pixelTask);

	void processPrimitiveVertices(int unit, unsigned int start, unsigned int count, unsigned int loop, int thread);

	int setupTriangles(int batch, int count);
	int setupLines(int batch, int count);
	int setupPoints(int batch, int count);

	bool setupLine(Primitive &primitive, Triangle &triangle, const DrawCall &draw);
	bool setupPoint(Primitive &primitive, Triangle &triangle, const DrawCall &draw);

	void updateConfiguration(bool initialUpdate = false);
	void initializeThreads();
	void terminateThreads();

	Context *context;
	Clipper *clipper;
	Blitter *blitter;
	VkViewport viewport;
	VkRect2D scissor;
	int clipFlags;

	Triangle *triangleBatch[16];
	Primitive *primitiveBatch[16];

	AtomicInt exitThreads;
	AtomicInt threadsAwake;
	Thread *worker[16];
	Event *resume[16]; // Events for resuming threads
	Event *suspend[16]; // Events for suspending threads
	Event *resumeApp; // Event for resuming the application thread

	PrimitiveProgress primitiveProgress[16];
	PixelProgress pixelProgress[16];
	Task task[16]; // Current tasks for threads

	enum {
	DRAW_COUNT = 16, // Number of draw calls buffered (must be power of 2)
	DRAW_COUNT_BITS = DRAW_COUNT - 1,
	};
	DrawCall *drawCall[DRAW_COUNT];
	DrawCall *drawList[DRAW_COUNT];

	AtomicInt currentDraw;
	AtomicInt nextDraw;

	enum {
	TASK_COUNT = 32, // Size of the task queue (must be power of 2)
	TASK_COUNT_BITS = TASK_COUNT - 1,
	};
	Task taskQueue[TASK_COUNT];
	AtomicInt qHead;
	AtomicInt qSize;

	static AtomicInt unitCount;
	static AtomicInt clusterCount;

	MutexLock schedulerMutex;

	#if PERF_HUD
	int64_t vertexTime[16];
	int64_t setupTime[16];
	int64_t pixelTime[16];
	#endif

	VertexTask *vertexTask[16];

	SwiftConfig *swiftConfig;

	std::list<vk::Query*> queries;
	Resource *sync;

	VertexProcessor::State vertexState;
	SetupProcessor::State setupState;
	PixelProcessor::State pixelState;

	Routine *vertexRoutine;
	Routine *setupRoutine;
	Routine *pixelRoutine;
	};

	struct DrawCall
	{
	DrawCall();

	~DrawCall();

	AtomicInt topology;
	AtomicInt indexType;
	AtomicInt batchSize;

	Routine *vertexRoutine;
	Routine *setupRoutine;
	Routine *pixelRoutine;

	VertexProcessor::RoutinePointer vertexPointer;
	SetupProcessor::RoutinePointer setupPointer;
	PixelProcessor::RoutinePointer pixelPointer;

	int (Renderer::*setupPrimitives)(int batch, int count);
	SetupProcessor::State setupState;

	vk::ImageView *renderTarget[RENDERTARGETS];
	vk::ImageView *depthBuffer;
	vk::ImageView *stencilBuffer;

	std::list<vk::Query> queries;

	AtomicInt primitive; // Current primitive to enter pipeline
	AtomicInt count; // Number of primitives to render
	AtomicInt references; // Remaining references to this draw call, 0 when done drawing, -1 when resources unlocked and slot is free

	DrawData *data;
	};
	}

	#endif // sw_Renderer_hpp