18#include <freerdp/config.h>
24#include <winpr/stream.h>
25#include <winpr/thread.h>
27#include <freerdp/addin.h>
28#include <freerdp/autodetect.h>
29#include <freerdp/client.h>
30#include <freerdp/client/channels.h>
31#include <freerdp/freerdp.h>
33#if defined(CHANNEL_RDPGFX_CLIENT)
34#include <freerdp/channels/rdpgfx.h>
35#include <freerdp/client/rdpgfx.h>
36#include <freerdp/codec/zgfx.h>
37#include <freerdp/dvc.h>
38#include <freerdp/gdi/gdi.h>
43#include <netinet/in.h>
44#include <sys/socket.h>
49#define SESSION_STATS 8
54#if !defined(_WIN32) && !defined(__EMSCRIPTEN__) && defined(CHANNEL_RDPSND_CLIENT)
58#define TEST_CHECK(cond) \
63 (void)fprintf(stderr, "%s:%d: failed: %s\n", __func__, __LINE__, #cond); \
68static BOOL find_stat(
const char* name,
size_t* index)
70 for (
size_t x = 0; x < freerdp_client_stats_max_index(); x++)
72 if (strcmp(freerdp_client_stats_name_for_index(x), name) == 0)
78 (void)fprintf(stderr,
"no stat named %s\n", name);
82static uint64_t stat_value(
const rdpContext* context,
const char* name)
85 if (!find_stat(name, &index))
87 return freerdp_client_stats_value_for_index(context, index);
90static BOOL check_names(
void)
92 static const char*
const session[SESSION_STATS] = {
93 "NETWORK_BYTES_RECEIVED",
"NETWORK_BYTES_SENT",
"NETWORK_PACKETS_RECEIVED",
94 "NETWORK_PACKETS_SENT",
"NETWORK_BANDWIDTH_KBPS",
"NETWORK_RTT_BASE_MS",
95 "NETWORK_RTT_AVERAGE_MS",
"GFX_CAPS_VERSION"
98 const size_t max = freerdp_client_stats_max_index();
99#if defined(CHANNEL_RDPGFX_CLIENT)
100 TEST_CHECK(max == SESSION_STATS + rdpgfx_stats_max_index());
102 TEST_CHECK(max == SESSION_STATS);
105 for (
size_t x = 0; x < max; x++)
107 const char* name = freerdp_client_stats_name_for_index(x);
109 TEST_CHECK(strlen(name) > 0);
110 TEST_CHECK(strcmp(name,
"FREERDP_CLIENT_STATS_UNUSED") != 0);
112 TEST_CHECK(strcmp(freerdp_client_stats_name_for_index(max),
"FREERDP_CLIENT_STATS_UNUSED") ==
116 for (
size_t x = 0; x < ARRAYSIZE(session); x++)
119 for (
size_t y = 0; y < max; y++)
121 if (strcmp(freerdp_client_stats_name_for_index(y), session[x]) == 0)
124 TEST_CHECK(found == 1);
129static BOOL check_all_zero(
const rdpContext* context)
131 for (
size_t x = 0; x <= freerdp_client_stats_max_index(); x++)
132 TEST_CHECK(freerdp_client_stats_value_for_index(context, x) == 0);
136static BOOL check_autodetect(rdpContext* context)
139 TEST_CHECK(!context->gdi);
140 TEST_CHECK(check_all_zero(context));
142 context->autodetect->netCharBandwidth = 1001;
143 context->autodetect->netCharBaseRTT = 1002;
144 context->autodetect->netCharAverageRTT = 1003;
145 TEST_CHECK(stat_value(context,
"NETWORK_BANDWIDTH_KBPS") == 1001);
146 TEST_CHECK(stat_value(context,
"NETWORK_RTT_BASE_MS") == 1002);
147 TEST_CHECK(stat_value(context,
"NETWORK_RTT_AVERAGE_MS") == 1003);
149 context->autodetect->netCharBandwidth = 0;
150 context->autodetect->netCharBaseRTT = 0;
151 context->autodetect->netCharAverageRTT = 0;
152 TEST_CHECK(check_all_zero(context));
155 context->autodetect->netCharBandwidth = 1001;
156 rdpAutoDetect* autodetect = context->autodetect;
157 rdpRdp* rdp = context->rdp;
158 context->autodetect =
nullptr;
159 context->rdp =
nullptr;
160 const BOOL rc = check_all_zero(context);
161 context->autodetect = autodetect;
163 context->autodetect->netCharBandwidth = 0;
167#if defined(TEST_NETWORK)
168#define SERVER_BYTES 16
178static DWORD WINAPI test_server_thread(LPVOID arg)
180 test_server* server = (test_server*)arg;
181 BYTE buffer[256] = WINPR_C_ARRAY_INIT;
183 const int client = accept(server->listener,
nullptr,
nullptr);
186 (void)close(server->listener);
187 server->listener = -1;
191 if (recv(client, buffer,
sizeof(buffer), 0) > 0)
193 memset(buffer, 0xff, SERVER_BYTES);
194 if (send(client, buffer, SERVER_BYTES, 0) == SERVER_BYTES)
201static BOOL check_network(rdpContext* context)
204 test_server server = { .listener = -1, .rc = -1 };
205 struct sockaddr_in addr = WINPR_C_ARRAY_INIT;
206 socklen_t len =
sizeof(addr);
207 HANDLE thread =
nullptr;
209 addr.sin_family = AF_INET;
210 addr.sin_addr.s_addr = htonl(INADDR_LOOPBACK);
213 const struct timeval timeout = { .tv_sec = 30, .tv_usec = 0 };
215 server.listener = socket(AF_INET, SOCK_STREAM, 0);
216 if ((server.listener < 0) ||
217 (setsockopt(server.listener, SOL_SOCKET, SO_RCVTIMEO, &timeout,
sizeof(timeout)) != 0) ||
218 (bind(server.listener, (
struct sockaddr*)&addr,
sizeof(addr)) != 0) ||
219 (listen(server.listener, 1) != 0) ||
220 (getsockname(server.listener, (
struct sockaddr*)&addr, &len) != 0))
229 thread = CreateThread(
nullptr, 0, test_server_thread, &server, 0,
nullptr);
234 (void)freerdp_connect(context->instance);
235 (void)WaitForSingleObject(thread, INFINITE);
236 (void)CloseHandle(thread);
242 const uint64_t received = stat_value(context,
"NETWORK_BYTES_RECEIVED");
243 const uint64_t sent = stat_value(context,
"NETWORK_BYTES_SENT");
244 (void)printf(
"network: received %" PRIu64
", sent %" PRIu64
"\n", received, sent);
245 TEST_CHECK((received > 0) && (received <= SERVER_BYTES));
246 TEST_CHECK(sent > SERVER_BYTES);
250 if (server.listener >= 0)
251 (void)close(server.listener);
253 (void)fprintf(stderr,
"[%s] failed\n", __func__);
258#if defined(CHANNEL_RDPGFX_CLIENT)
261 IDRDYNVC_ENTRY_POINTS iface;
268 IWTSVirtualChannelManager iface;
269 IWTSListener listener;
270 IWTSListenerCallback* listenerCallback;
271} test_channel_manager;
273static UINT test_register_plugin(IDRDYNVC_ENTRY_POINTS* pEntryPoints,
274 WINPR_ATTR_UNUSED
const char* name, IWTSPlugin* pPlugin)
276 ((test_entry_points*)pEntryPoints)->plugin = pPlugin;
277 return CHANNEL_RC_OK;
280static IWTSPlugin* test_get_plugin(WINPR_ATTR_UNUSED IDRDYNVC_ENTRY_POINTS* pEntryPoints,
281 WINPR_ATTR_UNUSED
const char* name)
286static const ADDIN_ARGV* test_get_plugin_data(WINPR_ATTR_UNUSED IDRDYNVC_ENTRY_POINTS* pEntryPoints)
291static rdpSettings* test_get_rdp_settings(IDRDYNVC_ENTRY_POINTS* pEntryPoints)
293 return ((test_entry_points*)pEntryPoints)->context->settings;
296static rdpContext* test_get_rdp_context(IDRDYNVC_ENTRY_POINTS* pEntryPoints)
298 return ((test_entry_points*)pEntryPoints)->context;
301static UINT test_create_listener(IWTSVirtualChannelManager* pChannelMgr,
302 WINPR_ATTR_UNUSED
const char* pszChannelName,
303 WINPR_ATTR_UNUSED ULONG ulFlags,
304 IWTSListenerCallback* pListenerCallback, IWTSListener** ppListener)
306 test_channel_manager* mgr = (test_channel_manager*)pChannelMgr;
307 mgr->listenerCallback = pListenerCallback;
309 *ppListener = &mgr->listener;
310 return CHANNEL_RC_OK;
313static UINT test_destroy_listener(IWTSVirtualChannelManager* pChannelMgr,
314 WINPR_ATTR_UNUSED IWTSListener* pListener)
316 ((test_channel_manager*)pChannelMgr)->listenerCallback =
nullptr;
317 return CHANNEL_RC_OK;
320static UINT32 test_get_channel_id(WINPR_ATTR_UNUSED IWTSVirtualChannel* channel)
325static const char* test_get_channel_name(WINPR_ATTR_UNUSED IWTSVirtualChannel* channel)
327 return RDPGFX_DVC_CHANNEL_NAME;
330static IWTSVirtualChannel* test_find_channel_by_id(WINPR_ATTR_UNUSED IWTSVirtualChannelManager* mgr,
331 WINPR_ATTR_UNUSED UINT32 ChannelId)
336static UINT test_channel_write(WINPR_ATTR_UNUSED IWTSVirtualChannel* pChannel,
337 WINPR_ATTR_UNUSED ULONG cbSize,
338 WINPR_ATTR_UNUSED
const BYTE* pBuffer,
339 WINPR_ATTR_UNUSED
void* pReserved)
341 return CHANNEL_RC_OK;
344static UINT test_channel_close(WINPR_ATTR_UNUSED IWTSVirtualChannel* pChannel)
346 return CHANNEL_RC_OK;
349static UINT send_start_frame(IWTSVirtualChannelCallback* callback)
351 wStream* s = Stream_New(
nullptr, 2 + RDPGFX_HEADER_SIZE + RDPGFX_START_FRAME_PDU_SIZE);
353 return CHANNEL_RC_NO_MEMORY;
354 Stream_Write_UINT8(s, ZGFX_SEGMENTED_SINGLE);
355 Stream_Write_UINT8(s, ZGFX_PACKET_COMPR_TYPE_RDP8);
356 Stream_Write_UINT16(s, RDPGFX_CMDID_STARTFRAME);
357 Stream_Write_UINT16(s, 0);
358 Stream_Write_UINT32(s, RDPGFX_HEADER_SIZE + RDPGFX_START_FRAME_PDU_SIZE);
359 Stream_Write_UINT32(s, 0);
360 Stream_Write_UINT32(s, 1);
361 Stream_SealLength(s);
362 Stream_ResetPosition(s);
363 const UINT rc = callback->OnDataReceived(callback, s);
364 Stream_Free(s, TRUE);
369static BOOL check_gfx_channel(rdpContext* context, IWTSPlugin* plugin, test_channel_manager* mgr)
371 IWTSVirtualChannel channel = WINPR_C_ARRAY_INIT;
372 channel.Write = test_channel_write;
373 channel.Close = test_channel_close;
375 TEST_CHECK(plugin->Initialize(plugin, &mgr->iface) == CHANNEL_RC_OK);
376 TEST_CHECK(mgr->listenerCallback);
378 IWTSVirtualChannelCallback* callback =
nullptr;
380 TEST_CHECK(mgr->listenerCallback->OnNewChannelConnection(
381 mgr->listenerCallback, &channel,
nullptr, &accept, &callback) == CHANNEL_RC_OK);
382 TEST_CHECK(callback);
383 TEST_CHECK(callback->OnOpen(callback) == CHANNEL_RC_OK);
385 rdpGdi gdi = WINPR_C_ARRAY_INIT;
389 RdpgfxClientContext* gfx = (RdpgfxClientContext*)plugin->pInterface;
390 gfx->ConfirmedCaps.version = RDPGFX_CAPVERSION_107;
391 BOOL rc = (stat_value(context,
"RDPGFX_CMDID_STARTFRAME") == 0) &&
392 (stat_value(context,
"GFX_CAPS_VERSION") == 0);
397 rc = (stat_value(context,
"GFX_CAPS_VERSION") == RDPGFX_CAPVERSION_107) &&
398 (stat_value(context,
"RDPGFX_CMDID_STARTFRAME") == 0) &&
399 (send_start_frame(callback) == CHANNEL_RC_OK) &&
400 (stat_value(context,
"RDPGFX_CMDID_STARTFRAME") == 1) &&
401 (stat_value(context,
"RDPGFX_CMDID_ENDFRAME") == 0);
403 rc = rc && (stat_value(context,
"RDPGFX_CMDID_STARTFRAME") == 0) &&
404 (stat_value(context,
"GFX_CAPS_VERSION") == 0);
407 context->gdi =
nullptr;
408 (void)callback->OnClose(callback);
413static BOOL check_gfx(rdpContext* context)
415 PDVC_PLUGIN_ENTRY pluginEntry = WINPR_FUNC_PTR_CAST(
416 freerdp_channels_load_static_addin_entry(RDPGFX_CHANNEL_NAME,
nullptr,
nullptr,
417 FREERDP_ADDIN_CHANNEL_DYNAMIC),
419 TEST_CHECK(pluginEntry);
421 test_entry_points ep = WINPR_C_ARRAY_INIT;
422 ep.iface.RegisterPlugin = test_register_plugin;
423 ep.iface.GetPlugin = test_get_plugin;
424 ep.iface.GetPluginData = test_get_plugin_data;
425 ep.iface.GetRdpSettings = test_get_rdp_settings;
426 ep.iface.GetRdpContext = test_get_rdp_context;
427 ep.context = context;
429 TEST_CHECK(pluginEntry(&ep.iface) == CHANNEL_RC_OK);
430 TEST_CHECK(ep.plugin);
432 test_channel_manager mgr = WINPR_C_ARRAY_INIT;
433 mgr.iface.CreateListener = test_create_listener;
434 mgr.iface.DestroyListener = test_destroy_listener;
435 mgr.iface.GetChannelId = test_get_channel_id;
436 mgr.iface.GetChannelName = test_get_channel_name;
437 mgr.iface.FindChannelById = test_find_channel_by_id;
439 const BOOL rc = check_gfx_channel(context, ep.plugin, &mgr);
442 (void)ep.plugin->Terminated(ep.plugin);
447static rdpContext* new_context(
void)
449 RDP_CLIENT_ENTRY_POINTS entry = WINPR_C_ARRAY_INIT;
450 entry.Version = RDP_CLIENT_INTERFACE_VERSION;
451 entry.Size =
sizeof(RDP_CLIENT_ENTRY_POINTS_V1);
452 entry.ContextSize =
sizeof(rdpClientContext);
453 return freerdp_client_context_new(&entry);
456int TestClientStats(WINPR_ATTR_UNUSED
int argc, WINPR_ATTR_UNUSED
char* argv[])
460 if (!check_all_zero(
nullptr))
463 rdpContext* context = new_context();
467 BOOL rc = check_autodetect(context);
468#if defined(CHANNEL_RDPGFX_CLIENT)
469 rc = rc && check_gfx(context);
471#if defined(TEST_NETWORK)
472 rc = rc && check_network(context);
475 freerdp_client_context_free(context);
WINPR_ATTR_NODISCARD FREERDP_API BOOL freerdp_settings_set_bool(rdpSettings *settings, FreeRDP_Settings_Keys_Bool id, BOOL val)
Sets a BOOL settings value.
WINPR_ATTR_NODISCARD FREERDP_API BOOL freerdp_settings_set_uint32(rdpSettings *settings, FreeRDP_Settings_Keys_UInt32 id, UINT32 val)
Sets a UINT32 settings value.
WINPR_ATTR_NODISCARD FREERDP_API BOOL freerdp_settings_set_string(rdpSettings *settings, FreeRDP_Settings_Keys_String id, const char *val)
Sets a string settings value. The param is copied.