moonlight-stream/moonlight-common-c
1
0
Fork 0
mirror of https://github.com/moonlight-stream/moonlight-common-c.git synced 2025-08-18 01:15:46 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add support for client-side connectivity testing

Browse Source
This commit is contained in:
Cameron Gutman 2020-07-19 14:39:42 -07:00
parent 5c9935e11b
commit 84f2421fbf
2 changed files with 353 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

309
src/ConnectionTester.c Normal file
View File

@ -0,0 +1,309 @@
#include "Limelight-internal.h"
#define TEST_PORT_TIMEOUT_SEC 3
#define VALID_PORT_FLAG_MASK (ML_PORT_FLAG_TCP_47984 | \
ML_PORT_FLAG_TCP_47989 | \
ML_PORT_FLAG_TCP_48010 | \
ML_PORT_FLAG_UDP_47998 | \
ML_PORT_FLAG_UDP_47999 | \
ML_PORT_FLAG_UDP_48000 | \
ML_PORT_FLAG_UDP_48010)
#define PORT_FLAGS_MAX_COUNT 32
unsigned int LiGetPortFlagsFromStage(int stage)
{
switch (stage)
{
case STAGE_RTSP_HANDSHAKE:
return ML_PORT_FLAG_TCP_48010 | ML_PORT_FLAG_UDP_48010;
case STAGE_CONTROL_STREAM_START:
return ML_PORT_FLAG_UDP_47999;
default:
return 0;
}
}
int LiGetProtocolFromPortFlagIndex(int portFlagIndex)
{
// The lower byte is reserved for TCP
return (portFlagIndex >= 8) ? IPPROTO_UDP : IPPROTO_TCP;
}
unsigned short LiGetPortFromPortFlagIndex(int portFlagIndex)
{
switch (portFlagIndex)
{
// TCP ports
case ML_PORT_INDEX_TCP_47984:
return 47984;
case ML_PORT_INDEX_TCP_47989:
return 47989;
case ML_PORT_INDEX_TCP_48010:
return 48010;
// UDP ports
case ML_PORT_INDEX_UDP_47998:
return 47998;
case ML_PORT_INDEX_UDP_47999:
return 47999;
case ML_PORT_INDEX_UDP_48000:
return 48000;
case ML_PORT_INDEX_UDP_48010:
return 48010;
default:
LC_ASSERT(0);
return 0;
}
}
unsigned int LiTestClientConnectivity(const char* testServer, unsigned short referencePort, unsigned int testPortFlags)
{
unsigned int failingPortFlags;
struct addrinfo* serverAddrs;
struct addrinfo* current;
struct addrinfo hints;
int i;
int err;
SOCKET sockets[PORT_FLAGS_MAX_COUNT];
// Mask out invalid ports from the port flags
testPortFlags &= VALID_PORT_FLAG_MASK;
failingPortFlags = testPortFlags;
// Initialize sockets array to -1
memset(sockets, 0xFF, sizeof(sockets));
err = initializePlatformSockets();
if (err != 0) {
Limelog("Failed to initialize sockets: %d\n", err);
return ML_TEST_RESULT_INCONCLUSIVE;
}
memset(&hints, 0, sizeof(hints));
hints.ai_family = AF_INET;
hints.ai_flags = AI_ADDRCONFIG;
err = getaddrinfo(testServer, NULL, &hints, &serverAddrs);
if (err != 0 || serverAddrs == NULL) {
Limelog("Failed to resolve test server: %d\n", err);
serverAddrs = NULL;
failingPortFlags = ML_TEST_RESULT_INCONCLUSIVE;
goto Exit;
}
for (current = serverAddrs; failingPortFlags != 0 && current != NULL; current = current->ai_next) {
// Test to see if this address is even reachable on a standard port.
// This will let us distinguish between port-specific blocks and IP-specific blocks.
SOCKET testSocket = connectTcpSocket((struct sockaddr_storage*)current->ai_addr,
current->ai_addrlen,
referencePort,
TEST_PORT_TIMEOUT_SEC);
if (testSocket == INVALID_SOCKET) {
Limelog("Skipping unavailable test host\n");
continue;
}
else {
closeSocket(testSocket);
}
for (i = 0; i < PORT_FLAGS_MAX_COUNT; i++) {
if (testPortFlags & (1 << i)) {
sockets[i] = socket(hints.ai_family,
LiGetProtocolFromPortFlagIndex(i) == IPPROTO_UDP ? SOCK_DGRAM : SOCK_STREAM,
LiGetProtocolFromPortFlagIndex(i));
if (sockets[i] == INVALID_SOCKET) {
err = LastSocketFail();
Limelog("Failed to create socket: %d\n", err);
failingPortFlags = ML_TEST_RESULT_INCONCLUSIVE;
goto Exit;
}
#ifdef LC_DARWIN
{
// Disable SIGPIPE on iOS
int val = 1;
setsockopt(sockets[i], SOL_SOCKET, SO_NOSIGPIPE, (char*)&val, sizeof(val));
}
#endif
((struct sockaddr_in6*)current->ai_addr)->sin6_port = htons(LiGetPortFromPortFlagIndex(i));
if (LiGetProtocolFromPortFlagIndex(i) == IPPROTO_TCP) {
// Enable non-blocking I/O for connect timeout support
if (setSocketNonBlocking(sockets[i] , 1) != 0) {
// If non-blocking sockets are not available, TCP tests are not supported
err = LastSocketFail();
Limelog("Failed to enable non-blocking I/O: %d\n", err);
failingPortFlags = ML_TEST_RESULT_INCONCLUSIVE;
goto Exit;
}
// Initiate an asynchronous connection
err = connect(sockets[i], current->ai_addr, current->ai_addrlen);
if (err < 0) {
err = (int)LastSocketError();
if (err != EWOULDBLOCK && err != EAGAIN) {
Limelog("Failed to start async connect to TCP %u: %d\n", LiGetPortFromPortFlagIndex(i), err);
// Mask off this bit so we don't try to include it in select() below
testPortFlags &= ~(1 << i);
}
}
}
else {
const char buf[] = {'C', 'T', 'E', 'S', 'T'};
int j;
// Send a few packets since UDP is unreliable
for (j = 0; j < 3; j++) {
err = sendto(sockets[i], buf, sizeof(buf), 0, current->ai_addr, current->ai_addrlen);
if (err < 0) {
err = (int)LastSocketError();
Limelog("Failed to send test packet to UDP %u: %d\n", LiGetPortFromPortFlagIndex(i), err);
// Mask off this bit so we don't try to include it in select() below
testPortFlags &= ~(1 << i);
break;
}
PltSleepMs(50);
}
}
}
}
// Continue to call select() until we have no more sockets to wait for,
// or our select() call times out.
while (testPortFlags != 0) {
SOCKET nfds;
fd_set readfds, writefds, exceptfds;
struct timeval tv;
nfds = 0;
FD_ZERO(&readfds);
FD_ZERO(&writefds);
FD_ZERO(&exceptfds);
// Fill out our FD sets
for (i = 0; i < PORT_FLAGS_MAX_COUNT; i++) {
if (testPortFlags & (1 << i)) {
if (LiGetProtocolFromPortFlagIndex(i) == IPPROTO_UDP) {
// Watch for readability on UDP sockets
FD_SET(sockets[i], &readfds);
if (sockets[i] + 1 > nfds) {
nfds = sockets[i] + 1;
}
}
else {
// Watch for writeability or exceptions on TCP sockets
FD_SET(sockets[i], &writefds);
FD_SET(sockets[i], &exceptfds);
if (sockets[i] + 1 > nfds) {
nfds = sockets[i] + 1;
}
}
}
}
tv.tv_sec = TEST_PORT_TIMEOUT_SEC;
tv.tv_usec = 0;
// Wait for the to complete or the timeout to elapse.
// NB: The timeout resets each time we get a valid response on a port,
// but that's probably fine.
err = select((int)nfds, &readfds, &writefds, &exceptfds, &tv);
if (err < 0) {
// select() failed
err = LastSocketError();
Limelog("select() failed: %d\n", err);
failingPortFlags = ML_TEST_RESULT_INCONCLUSIVE;
goto Exit;
}
else if (err == 0) {
// select() timed out
Limelog("select() timed out after %d seconds\n", TEST_PORT_TIMEOUT_SEC);
break;
}
// We know something was signalled. Now we just need to find out what.
for (i = 0; i < PORT_FLAGS_MAX_COUNT; i++) {
if (testPortFlags & (1 << i)) {
if (FD_ISSET(sockets[i], &writefds) || FD_ISSET(sockets[i], &exceptfds)) {
// A TCP socket was signalled
SOCKADDR_LEN len = sizeof(err);
getsockopt(sockets[i], SOL_SOCKET, SO_ERROR, (char*)&err, &len);
if (err != 0 || FD_ISSET(sockets[i], &exceptfds)) {
// Get the error code
err = (err != 0) ? err : LastSocketFail();
}
// The TCP test has completed for this port
testPortFlags &= ~(1 << i);
if (err == 0) {
// The TCP test was a success
failingPortFlags &= ~(1 << i);
Limelog("TCP port %u test successful\n", LiGetPortFromPortFlagIndex(i));
}
else {
Limelog("TCP port %u test failed: %d\n", LiGetPortFromPortFlagIndex(i), err);
}
}
else if (FD_ISSET(sockets[i], &readfds)) {
char buf[32];
// A UDP socket was signalled. This could be because we got
// a packet from the test server, or it could be because we
// received an ICMP error which will be given to us from
// recvfrom().
testPortFlags &= ~(1 << i);
// Check if the socket can be successfully read now
err = recvfrom(sockets[i], buf, sizeof(buf), 0, NULL, NULL);
if (err >= 0) {
// The UDP test was a success.
failingPortFlags &= ~(1 << i);
Limelog("UDP port %u test successful\n", LiGetPortFromPortFlagIndex(i));
}
else {
err = LastSocketError();
Limelog("UDP port %u test failed: %d\n", LiGetPortFromPortFlagIndex(i), err);
}
}
}
}
// Next iteration, we'll remove the matching sockets from our FD set and
// call select() again to wait on the remaining sockets.
}
// We don't need to try another server if we got this far
break;
}
if (current == NULL) {
// None of the addresses we were given worked
failingPortFlags = ML_TEST_RESULT_INCONCLUSIVE;
goto Exit;
}
Exit:
for (i = 0; i < PORT_FLAGS_MAX_COUNT; i++) {
if (sockets[i] != INVALID_SOCKET) {
closeSocket(sockets[i]);
}
}
if (serverAddrs != NULL) {
freeaddrinfo(serverAddrs);
}
cleanupPlatformSockets();
return failingPortFlags;
}

44
src/Limelight.h
View File

@ -536,6 +536,50 @@ int LiGetPendingAudioFrames(void);
// negotiated audio frame duration.
int LiGetPendingAudioDuration(void);
// Port index flags for use with LiGetPortFromPortFlagIndex() and LiGetProtocolFromPortFlagIndex()
#define ML_PORT_INDEX_TCP_47984 0
#define ML_PORT_INDEX_TCP_47989 1
#define ML_PORT_INDEX_TCP_48010 2
#define ML_PORT_INDEX_UDP_47998 8
#define ML_PORT_INDEX_UDP_47999 9
#define ML_PORT_INDEX_UDP_48000 10
#define ML_PORT_INDEX_UDP_48010 11
// Port flags for use with LiTestClientConnectivity()
#define ML_PORT_FLAG_ALL 0xFFFFFFFF
#define ML_PORT_FLAG_TCP_47984 0x0001
#define ML_PORT_FLAG_TCP_47989 0x0002
#define ML_PORT_FLAG_TCP_48010 0x0004
#define ML_PORT_FLAG_UDP_47998 0x0100
#define ML_PORT_FLAG_UDP_47999 0x0200
#define ML_PORT_FLAG_UDP_48000 0x0400
#define ML_PORT_FLAG_UDP_48010 0x0800
// Returns the port flags that correspond to ports involved in a failing connection stage.
// This may be used to specifically test the ports that could have caused the connection failure.
// If no ports are likely involved with a given stage failure, this function returns 0.
unsigned int LiGetPortFlagsFromStage(int stage);
// Returns the IPPROTO_* value for the specified port index
int LiGetProtocolFromPortFlagIndex(int portFlagIndex);
// Returns the port number for the specified port index
unsigned short LiGetPortFromPortFlagIndex(int portFlagIndex);
// This function may be used to test if the local network is blocking Moonlight's ports. It requires
// a test server running on an Internet-reachable host. To perform a test, pass in the DNS hostname
// of the test server, a reference TCP port to ensure the test host is reachable at all (something
// very unlikely to blocked, like 80 or 443), and a set of ML_PORT_FLAG_* values corresponding to
// the ports you'd like to test. On return, it returns ML_TEST_RESULT_INCONCLUSIVE on catastrophic error,
// or the set of port flags that failed to validate. If all ports validate successfully, it returns 0.
//
// It's encouraged to not use the port flags explicitly (because GameStream ports may change in the future),
// but to instead use ML_PORT_FLAG_ALL or LiGetPortFlagsFromStage() on connection failure.
//
// The test server is available at https://github.com/cgutman/gfe-loopback
#define ML_TEST_RESULT_INCONCLUSIVE 0xFFFFFFFF
unsigned int LiTestClientConnectivity(const char* testServer, unsigned short referencePort, unsigned int testPortFlags);
#ifdef __cplusplus
}
#endif