aboutsummaryrefslogtreecommitdiff
path: root/sdk/extensions/serialization/source/NvBlastExtSerializationCAPN.h
blob: 2125a7cbcdfeb51cbaec36952b28c1a67c96c656 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
// This code contains NVIDIA Confidential Information and is disclosed to you
// under a form of NVIDIA software license agreement provided separately to you.
//
// Notice
// NVIDIA Corporation and its licensors retain all intellectual property and
// proprietary rights in and to this software and related documentation and
// any modifications thereto. Any use, reproduction, disclosure, or
// distribution of this software and related documentation without an express
// license agreement from NVIDIA Corporation is strictly prohibited.
//
// ALL NVIDIA DESIGN SPECIFICATIONS, CODE ARE PROVIDED "AS IS.". NVIDIA MAKES
// NO WARRANTIES, EXPRESSED, IMPLIED, STATUTORY, OR OTHERWISE WITH RESPECT TO
// THE MATERIALS, AND EXPRESSLY DISCLAIMS ALL IMPLIED WARRANTIES OF NONINFRINGEMENT,
// MERCHANTABILITY, AND FITNESS FOR A PARTICULAR PURPOSE.
//
// Information and code furnished is believed to be accurate and reliable.
// However, NVIDIA Corporation assumes no responsibility for the consequences of use of such
// information or for any infringement of patents or other rights of third parties that may
// result from its use. No license is granted by implication or otherwise under any patent
// or patent rights of NVIDIA Corporation. Details are subject to change without notice.
// This code supersedes and replaces all information previously supplied.
// NVIDIA Corporation products are not authorized for use as critical
// components in life support devices or systems without express written approval of
// NVIDIA Corporation.
//
// Copyright (c) 2018 NVIDIA Corporation. All rights reserved.


#pragma once

#include "capnp/serialize.h"
#include "NvBlastExtInputStream.h"
#include "NvBlastExtOutputStream.h"
#include "NvBlastArray.h"
#include "NvBlastExtSerialization.h"


namespace Nv
{
namespace Blast
{

template<typename TObject, typename TSerializationReader, typename TSerializationBuilder>
class ExtSerializationCAPN
{
public:
	static TObject*	deserializeFromBuffer(const unsigned char* input, uint64_t size);
	static TObject*	deserializeFromStream(std::istream& inputStream);

	static uint64_t	serializationBufferSize(const TObject* object);

	static bool		serializeIntoBuffer(const TObject* object, unsigned char* buffer, uint64_t maxSize, uint64_t& usedSize);
	static bool		serializeIntoBuffer(const TObject *object, unsigned char*& buffer, uint64_t& size, ExtSerialization::BufferProvider* bufferProvider = nullptr, uint64_t offset = 0);
	static bool		serializeIntoStream(const TObject* object, std::ostream& outputStream);

private:
	// Specialized
	static bool		serializeIntoBuilder(TSerializationBuilder& objectBuilder, const TObject* object);
	static bool		serializeIntoMessage(capnp::MallocMessageBuilder& message, const TObject* object);
	static TObject*	deserializeFromStreamReader(capnp::InputStreamMessageReader& message);
};


template<typename TObject, typename TSerializationReader, typename TSerializationBuilder>
TObject* ExtSerializationCAPN<TObject, TSerializationReader, TSerializationBuilder>::deserializeFromBuffer(const unsigned char* input, uint64_t size)
{
	kj::ArrayPtr<const unsigned char> source(input, size);

	kj::ArrayInputStream inputStream(source);

	Nv::Blast::Array<uint64_t>::type scratch(static_cast<uint32_t>(size));
	kj::ArrayPtr<capnp::word> scratchArray((capnp::word*) scratch.begin(), size);

	capnp::InputStreamMessageReader message(inputStream, capnp::ReaderOptions(), scratchArray);

	return deserializeFromStreamReader(message);
}


template<typename TObject, typename TSerializationReader, typename TSerializationBuilder>
TObject* ExtSerializationCAPN<TObject, TSerializationReader, TSerializationBuilder>::deserializeFromStream(std::istream& inputStream)
{
	ExtInputStream readStream(inputStream);

	capnp::InputStreamMessageReader message(readStream);

	return deserializeFromStreamReader(message);
}


template<typename TObject, typename TSerializationReader, typename TSerializationBuilder>
uint64_t ExtSerializationCAPN<TObject, TSerializationReader, TSerializationBuilder>::serializationBufferSize(const TObject* object)
{
	capnp::MallocMessageBuilder message;

	bool result = serializeIntoMessage(message, object);

	if (result == false)
	{
		return 0;
	}

	return computeSerializedSizeInWords(message) * sizeof(uint64_t);
}


template<typename TObject, typename TSerializationReader, typename TSerializationBuilder>
bool ExtSerializationCAPN<TObject, TSerializationReader, TSerializationBuilder>::serializeIntoBuffer(const TObject* object, unsigned char* buffer, uint64_t maxSize, uint64_t& usedSize)
{
	capnp::MallocMessageBuilder message;

	bool result = serializeIntoMessage(message, object);

	if (result == false)
	{
		usedSize = 0;
		return false;
	}

	uint64_t messageSize = computeSerializedSizeInWords(message) * sizeof(uint64_t);

	if (maxSize < messageSize)
	{
		NVBLAST_LOG_ERROR("When attempting to serialize into an existing buffer, the provided buffer was too small.");
		usedSize = 0;
		return false;
	}

	kj::ArrayPtr<unsigned char> outputBuffer(buffer, maxSize);
	kj::ArrayOutputStream outputStream(outputBuffer);

	capnp::writeMessage(outputStream, message);

	usedSize = messageSize;
	return true;
}


template<typename TObject, typename TSerializationReader, typename TSerializationBuilder>
bool ExtSerializationCAPN<TObject, TSerializationReader, TSerializationBuilder>::serializeIntoBuffer(const TObject *object, unsigned char*& buffer, uint64_t& size, ExtSerialization::BufferProvider* bufferProvider, uint64_t offset)
{
	capnp::MallocMessageBuilder message;

	bool result = serializeIntoMessage(message, object);

	if (result == false)
	{
		buffer = nullptr;
		size = 0;
		return false;
	}

	const uint64_t blockSize = computeSerializedSizeInWords(message) * sizeof(uint64_t);

	size = blockSize + offset;

	buffer = static_cast<unsigned char *>(bufferProvider != nullptr ? bufferProvider->requestBuffer(size) : NVBLAST_ALLOC(size));

	kj::ArrayPtr<unsigned char> outputBuffer(buffer + offset, blockSize);
	kj::ArrayOutputStream outputStream(outputBuffer);

	capnp::writeMessage(outputStream, message);

	return true;
}


template<typename TObject, typename TSerializationReader, typename TSerializationBuilder>
bool ExtSerializationCAPN<TObject, TSerializationReader, TSerializationBuilder>::serializeIntoStream(const TObject* object, std::ostream& outputStream)
{
	capnp::MallocMessageBuilder message;

	bool result = serializeIntoMessage(message, object);

	if (result == false)
	{
		return false;
	}

	ExtOutputStream blastOutputStream(outputStream);

	writeMessage(blastOutputStream, message);

	return true;
}

}	// namespace Blast
}	// namespace Nv