aboutsummaryrefslogtreecommitdiff
path: root/src/zenhorde/hordeagentmessage.cpp
blob: 31498972f565509defa06966ac5a914422a8d1ae (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
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
// Copyright Epic Games, Inc. All Rights Reserved.

#include "hordeagentmessage.h"

#include <zencore/intmath.h>

ZEN_THIRD_PARTY_INCLUDES_START
#include <asio.hpp>
ZEN_THIRD_PARTY_INCLUDES_END

#include <cassert>
#include <cstring>

namespace zen::horde {

// --- AsyncAgentMessageChannel ---

AsyncAgentMessageChannel::AsyncAgentMessageChannel(std::shared_ptr<AsyncComputeSocket> Socket, int ChannelId, asio::io_context& IoContext)
: m_Socket(std::move(Socket))
, m_ChannelId(ChannelId)
, m_IoContext(IoContext)
, m_TimeoutTimer(std::make_unique<asio::steady_timer>(IoContext))
{
}

AsyncAgentMessageChannel::~AsyncAgentMessageChannel()
{
	if (m_TimeoutTimer)
	{
		m_TimeoutTimer->cancel();
	}
}

// --- Message building helpers ---

std::vector<uint8_t>
AsyncAgentMessageChannel::BeginMessage(AgentMessageType Type, size_t ReservePayload)
{
	std::vector<uint8_t> Buf;
	Buf.reserve(MessageHeaderLength + ReservePayload);
	Buf.push_back(static_cast<uint8_t>(Type));
	Buf.resize(MessageHeaderLength);  // 1 byte type + 4 bytes length placeholder
	return Buf;
}

void
AsyncAgentMessageChannel::FinalizeAndSend(std::vector<uint8_t> Msg)
{
	const uint32_t PayloadSize = static_cast<uint32_t>(Msg.size() - MessageHeaderLength);
	memcpy(&Msg[1], &PayloadSize, sizeof(uint32_t));
	m_Socket->AsyncSendFrame(m_ChannelId, std::move(Msg));
}

void
AsyncAgentMessageChannel::WriteInt32(std::vector<uint8_t>& Buf, int Value)
{
	const uint8_t* Ptr = reinterpret_cast<const uint8_t*>(&Value);
	Buf.insert(Buf.end(), Ptr, Ptr + sizeof(int));
}

int
AsyncAgentMessageChannel::ReadInt32(const uint8_t** Pos)
{
	int Value;
	memcpy(&Value, *Pos, sizeof(int));
	*Pos += sizeof(int);
	return Value;
}

void
AsyncAgentMessageChannel::WriteFixedLengthBytes(std::vector<uint8_t>& Buf, const uint8_t* Data, size_t Length)
{
	Buf.insert(Buf.end(), Data, Data + Length);
}

const uint8_t*
AsyncAgentMessageChannel::ReadFixedLengthBytes(const uint8_t** Pos, size_t Length)
{
	const uint8_t* Data = *Pos;
	*Pos += Length;
	return Data;
}

size_t
AsyncAgentMessageChannel::MeasureUnsignedVarInt(size_t Value)
{
	if (Value == 0)
	{
		return 1;
	}
	return (FloorLog2_64(static_cast<uint64_t>(Value)) / 7) + 1;
}

void
AsyncAgentMessageChannel::WriteUnsignedVarInt(std::vector<uint8_t>& Buf, size_t Value)
{
	const size_t ByteCount = MeasureUnsignedVarInt(Value);
	const size_t StartPos  = Buf.size();
	Buf.resize(StartPos + ByteCount);

	uint8_t* Output = Buf.data() + StartPos;
	for (size_t i = 1; i < ByteCount; ++i)
	{
		Output[ByteCount - i] = static_cast<uint8_t>(Value);
		Value >>= 8;
	}
	Output[0] = static_cast<uint8_t>((0xFF << (9 - static_cast<int>(ByteCount))) | static_cast<uint8_t>(Value));
}

size_t
AsyncAgentMessageChannel::ReadUnsignedVarInt(const uint8_t** Pos)
{
	const uint8_t* Data		 = *Pos;
	const uint8_t  FirstByte = Data[0];
	const size_t   NumBytes	 = CountLeadingZeros(0xFF & (~static_cast<unsigned int>(FirstByte))) + 1 - 24;

	size_t Value = static_cast<size_t>(FirstByte & (0xFF >> NumBytes));
	for (size_t i = 1; i < NumBytes; ++i)
	{
		Value <<= 8;
		Value |= Data[i];
	}

	*Pos += NumBytes;
	return Value;
}

void
AsyncAgentMessageChannel::WriteString(std::vector<uint8_t>& Buf, const char* Text)
{
	const size_t Length = strlen(Text);
	WriteUnsignedVarInt(Buf, Length);
	WriteFixedLengthBytes(Buf, reinterpret_cast<const uint8_t*>(Text), Length);
}

void
AsyncAgentMessageChannel::WriteString(std::vector<uint8_t>& Buf, std::string_view Text)
{
	WriteUnsignedVarInt(Buf, Text.size());
	WriteFixedLengthBytes(Buf, reinterpret_cast<const uint8_t*>(Text.data()), Text.size());
}

std::string_view
AsyncAgentMessageChannel::ReadString(const uint8_t** Pos)
{
	const size_t Length = ReadUnsignedVarInt(Pos);
	const char*	 Start	= reinterpret_cast<const char*>(ReadFixedLengthBytes(Pos, Length));
	return std::string_view(Start, Length);
}

void
AsyncAgentMessageChannel::WriteOptionalString(std::vector<uint8_t>& Buf, const char* Text)
{
	if (!Text)
	{
		WriteUnsignedVarInt(Buf, 0);
	}
	else
	{
		const size_t Length = strlen(Text);
		WriteUnsignedVarInt(Buf, Length + 1);
		WriteFixedLengthBytes(Buf, reinterpret_cast<const uint8_t*>(Text), Length);
	}
}

// --- Send methods ---

void
AsyncAgentMessageChannel::Close()
{
	auto Msg = BeginMessage(AgentMessageType::None, 0);
	FinalizeAndSend(std::move(Msg));
}

void
AsyncAgentMessageChannel::Ping()
{
	auto Msg = BeginMessage(AgentMessageType::Ping, 0);
	FinalizeAndSend(std::move(Msg));
}

void
AsyncAgentMessageChannel::Fork(int ChannelId, int BufferSize)
{
	auto Msg = BeginMessage(AgentMessageType::Fork, sizeof(int) + sizeof(int));
	WriteInt32(Msg, ChannelId);
	WriteInt32(Msg, BufferSize);
	FinalizeAndSend(std::move(Msg));
}

void
AsyncAgentMessageChannel::Attach()
{
	auto Msg = BeginMessage(AgentMessageType::Attach, 0);
	FinalizeAndSend(std::move(Msg));
}

void
AsyncAgentMessageChannel::UploadFiles(const char* Path, const char* Locator)
{
	auto Msg = BeginMessage(AgentMessageType::WriteFiles, strlen(Path) + strlen(Locator) + 20);
	WriteString(Msg, Path);
	WriteString(Msg, Locator);
	FinalizeAndSend(std::move(Msg));
}

void
AsyncAgentMessageChannel::Execute(const char*		  Exe,
								  const char* const*  Args,
								  size_t			  NumArgs,
								  const char*		  WorkingDir,
								  const char* const*  EnvVars,
								  size_t			  NumEnvVars,
								  ExecuteProcessFlags Flags)
{
	size_t ReserveSize = 50 + strlen(Exe);
	for (size_t i = 0; i < NumArgs; ++i)
	{
		ReserveSize += strlen(Args[i]) + 10;
	}
	if (WorkingDir)
	{
		ReserveSize += strlen(WorkingDir) + 10;
	}
	for (size_t i = 0; i < NumEnvVars; ++i)
	{
		ReserveSize += strlen(EnvVars[i]) + 20;
	}

	auto Msg = BeginMessage(AgentMessageType::ExecuteV2, ReserveSize);
	WriteString(Msg, Exe);

	WriteUnsignedVarInt(Msg, NumArgs);
	for (size_t i = 0; i < NumArgs; ++i)
	{
		WriteString(Msg, Args[i]);
	}

	WriteOptionalString(Msg, WorkingDir);

	WriteUnsignedVarInt(Msg, NumEnvVars);
	for (size_t i = 0; i < NumEnvVars; ++i)
	{
		const char* Eq = strchr(EnvVars[i], '=');
		assert(Eq != nullptr);

		WriteString(Msg, std::string_view(EnvVars[i], Eq - EnvVars[i]));
		if (*(Eq + 1) == '\0')
		{
			WriteOptionalString(Msg, nullptr);
		}
		else
		{
			WriteOptionalString(Msg, Eq + 1);
		}
	}

	WriteInt32(Msg, static_cast<int>(Flags));
	FinalizeAndSend(std::move(Msg));
}

void
AsyncAgentMessageChannel::Blob(const uint8_t* Data, size_t Length)
{
	static constexpr size_t MaxBlobChunkSize = 512 * 1024;

	for (size_t ChunkOffset = 0; ChunkOffset < Length;)
	{
		const size_t ChunkLength = std::min(Length - ChunkOffset, MaxBlobChunkSize);

		auto Msg = BeginMessage(AgentMessageType::ReadBlobResponse, ChunkLength + 128);
		WriteInt32(Msg, static_cast<int>(ChunkOffset));
		WriteInt32(Msg, static_cast<int>(Length));
		WriteFixedLengthBytes(Msg, Data + ChunkOffset, ChunkLength);
		FinalizeAndSend(std::move(Msg));

		ChunkOffset += ChunkLength;
	}
}

// --- Async response reading ---

void
AsyncAgentMessageChannel::AsyncReadResponse(int32_t TimeoutMs, AsyncResponseHandler Handler)
{
	// If frames are already queued, dispatch immediately
	if (!m_IncomingFrames.empty())
	{
		std::vector<uint8_t> Frame = std::move(m_IncomingFrames.front());
		m_IncomingFrames.pop_front();

		if (Frame.size() >= MessageHeaderLength)
		{
			AgentMessageType Type = static_cast<AgentMessageType>(Frame[0]);
			const uint8_t*	 Data = Frame.data() + MessageHeaderLength;
			size_t			 Size = Frame.size() - MessageHeaderLength;
			asio::post(m_IoContext, [Handler = std::move(Handler), Type, Frame = std::move(Frame), Data, Size]() mutable {
				// The Frame is captured to keep Data pointer valid
				Handler(Type, Data, Size);
			});
		}
		else
		{
			asio::post(m_IoContext, [Handler = std::move(Handler)] { Handler(AgentMessageType::None, nullptr, 0); });
		}
		return;
	}

	if (m_Detached)
	{
		asio::post(m_IoContext, [Handler = std::move(Handler)] { Handler(AgentMessageType::None, nullptr, 0); });
		return;
	}

	// No frames queued — store pending handler and arm timeout
	m_PendingHandler = std::move(Handler);

	if (TimeoutMs >= 0)
	{
		m_TimeoutTimer->expires_after(std::chrono::milliseconds(TimeoutMs));
		m_TimeoutTimer->async_wait([this](const asio::error_code& Ec) {
			if (Ec)
			{
				return;	 // Cancelled — frame arrived before timeout
			}

			if (m_PendingHandler)
			{
				AsyncResponseHandler Handler = std::move(m_PendingHandler);
				m_PendingHandler			 = nullptr;
				Handler(AgentMessageType::None, nullptr, 0);
			}
		});
	}
}

void
AsyncAgentMessageChannel::OnFrame(std::vector<uint8_t> Data)
{
	if (m_PendingHandler)
	{
		// Cancel the timeout timer
		m_TimeoutTimer->cancel();

		AsyncResponseHandler Handler = std::move(m_PendingHandler);
		m_PendingHandler			 = nullptr;

		if (Data.size() >= MessageHeaderLength)
		{
			AgentMessageType Type		 = static_cast<AgentMessageType>(Data[0]);
			const uint8_t*	 Payload	 = Data.data() + MessageHeaderLength;
			size_t			 PayloadSize = Data.size() - MessageHeaderLength;
			Handler(Type, Payload, PayloadSize);
		}
		else
		{
			Handler(AgentMessageType::None, nullptr, 0);
		}
	}
	else
	{
		m_IncomingFrames.push_back(std::move(Data));
	}
}

void
AsyncAgentMessageChannel::OnDetach()
{
	m_Detached = true;

	if (m_PendingHandler)
	{
		m_TimeoutTimer->cancel();
		AsyncResponseHandler Handler = std::move(m_PendingHandler);
		m_PendingHandler			 = nullptr;
		Handler(AgentMessageType::None, nullptr, 0);
	}
}

// --- Response parsing helpers ---

void
AsyncAgentMessageChannel::ReadException(const uint8_t* Data, size_t /*Size*/, ExceptionInfo& Ex)
{
	const uint8_t* Pos = Data;
	Ex.Message		   = ReadString(&Pos);
	Ex.Description	   = ReadString(&Pos);
}

int
AsyncAgentMessageChannel::ReadExecuteResult(const uint8_t* Data, size_t /*Size*/)
{
	const uint8_t* Pos = Data;
	return ReadInt32(&Pos);
}

void
AsyncAgentMessageChannel::ReadBlobRequest(const uint8_t* Data, size_t /*Size*/, BlobRequest& Req)
{
	const uint8_t* Pos = Data;
	Req.Locator		   = ReadString(&Pos);
	Req.Offset		   = ReadUnsignedVarInt(&Pos);
	Req.Length		   = ReadUnsignedVarInt(&Pos);
}

}  // namespace zen::horde