File: TraversalClient.cpp

package info (click to toggle)
dolphin-emu 2512%2Bdfsg-2
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 76,328 kB
  • sloc: cpp: 499,023; ansic: 119,674; python: 6,547; sh: 2,338; makefile: 1,093; asm: 726; pascal: 257; javascript: 183; perl: 97; objc: 75; xml: 30
file content (482 lines) | stat: -rw-r--r-- 13,333 bytes parent folder | download | duplicates (2)
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
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
// SPDX-License-Identifier: CC0-1.0

#include "Common/TraversalClient.h"

#include <cstddef>
#include <cstring>
#include <string>

#include "Common/CommonTypes.h"
#include "Common/Logging/Log.h"
#include "Common/MsgHandler.h"
#include "Common/Random.h"
#include "Core/NetPlayProto.h"

namespace Common
{
TraversalClient::TraversalClient(ENetHost* netHost, const std::string& server, const u16 port,
                                 const u16 port_alt)
    : m_NetHost(netHost), m_Server(server), m_port(port), m_portAlt(port_alt)
{
  netHost->intercept = TraversalClient::InterceptCallback;

  Reset();

  ReconnectToServer();
}

TraversalClient::~TraversalClient() = default;

TraversalHostId TraversalClient::GetHostID() const
{
  return m_HostId;
}

TraversalInetAddress TraversalClient::GetExternalAddress() const
{
  return m_external_address;
}

TraversalClient::State TraversalClient::GetState() const
{
  return m_State;
}

TraversalClient::FailureReason TraversalClient::GetFailureReason() const
{
  return m_FailureReason;
}

void TraversalClient::ReconnectToServer()
{
  if (enet_address_set_host(&m_ServerAddress, m_Server.c_str()))
  {
    OnFailure(FailureReason::BadHost);
    return;
  }
  m_ServerAddress.port = m_port;

  m_State = State::Connecting;

  TraversalPacket hello = {};
  hello.type = TraversalPacketType::HelloFromClient;
  hello.helloFromClient.protoVersion = TraversalProtoVersion;
  SendTraversalPacket(hello);
  if (m_Client)
    m_Client->OnTraversalStateChanged();
}

static ENetAddress MakeENetAddress(const TraversalInetAddress& address)
{
  ENetAddress eaddr{};
  if (address.isIPV6)
  {
    eaddr.port = 0;  // no support yet :(
  }
  else
  {
    eaddr.host = address.address[0];
    eaddr.port = ntohs(address.port);
  }
  return eaddr;
}

void TraversalClient::ConnectToClient(std::string_view host)
{
  if (host.size() > sizeof(TraversalHostId))
  {
    PanicAlertFmt("Host too long");
    return;
  }
  TraversalPacket packet = {};
  packet.type = TraversalPacketType::ConnectPlease;
  memcpy(packet.connectPlease.hostId.data(), host.data(), host.size());
  m_ConnectRequestId = SendTraversalPacket(packet);
  m_PendingConnect = true;
}

bool TraversalClient::TestPacket(u8* data, size_t size, ENetAddress* from)
{
  if (from->host == m_ServerAddress.host && from->port == m_ServerAddress.port)
  {
    if (size < sizeof(TraversalPacket))
    {
      ERROR_LOG_FMT(NETPLAY, "Received too-short traversal packet.");
    }
    else
    {
      HandleServerPacket((TraversalPacket*)data);
      return true;
    }
  }
  return false;
}

//--Temporary until more of the old netplay branch is moved over
void TraversalClient::Update()
{
  ENetEvent netEvent;
  if (enet_host_service(m_NetHost, &netEvent, 4) > 0)
  {
    switch (netEvent.type)
    {
    case ENET_EVENT_TYPE_RECEIVE:
      TestPacket(netEvent.packet->data, netEvent.packet->dataLength, &netEvent.peer->address);

      enet_packet_destroy(netEvent.packet);
      break;
    default:
      break;
    }
  }
  HandleResends();
}

void TraversalClient::HandleServerPacket(TraversalPacket* packet)
{
  u8 ok = 1;
  switch (packet->type)
  {
  case TraversalPacketType::Ack:
    if (!packet->ack.ok)
    {
      OnFailure(FailureReason::ServerForgotAboutUs);
      break;
    }
    for (auto it = m_OutgoingTraversalPackets.begin(); it != m_OutgoingTraversalPackets.end(); ++it)
    {
      if (it->packet.requestId == packet->requestId)
      {
        if (packet->requestId == m_TestRequestId)
          HandleTraversalTest();
        m_OutgoingTraversalPackets.erase(it);
        break;
      }
    }
    break;
  case TraversalPacketType::HelloFromServer:
    if (!IsConnecting())
      break;
    if (!packet->helloFromServer.ok)
    {
      OnFailure(FailureReason::VersionTooOld);
      break;
    }
    m_HostId = packet->helloFromServer.yourHostId;
    m_external_address = packet->helloFromServer.yourAddress;
    NewTraversalTest();
    m_State = State::Connected;
    if (m_Client)
      m_Client->OnTraversalStateChanged();
    break;
  case TraversalPacketType::PleaseSendPacket:
  {
    // security is overrated.
    ENetAddress addr = MakeENetAddress(packet->pleaseSendPacket.address);
    if (addr.port != 0)
    {
      char message[] = "Hello from Dolphin Netplay...";
      ENetBuffer buf;
      buf.data = message;
      buf.dataLength = sizeof(message) - 1;
      if (m_ttlReady)
      {
        int oldttl;
        enet_socket_get_option(m_NetHost->socket, ENET_SOCKOPT_TTL, &oldttl);
        enet_socket_set_option(m_NetHost->socket, ENET_SOCKOPT_TTL, m_ttl);
        enet_socket_send(m_NetHost->socket, &addr, &buf, 1);
        enet_socket_set_option(m_NetHost->socket, ENET_SOCKOPT_TTL, oldttl);
      }
      else
      {
        enet_socket_send(m_NetHost->socket, &addr, &buf, 1);
      }
    }
    else
    {
      // invalid IPV6
      ok = 0;
    }
    break;
  }
  case TraversalPacketType::ConnectReady:
  case TraversalPacketType::ConnectFailed:
  {
    if (!m_PendingConnect || packet->connectReady.requestId != m_ConnectRequestId)
      break;

    m_PendingConnect = false;

    if (!m_Client)
      break;

    if (packet->type == TraversalPacketType::ConnectReady)
      m_Client->OnConnectReady(MakeENetAddress(packet->connectReady.address));
    else
      m_Client->OnConnectFailed(packet->connectFailed.reason);
    break;
  }
  default:
    WARN_LOG_FMT(NETPLAY, "Received unknown packet with type {}", static_cast<int>(packet->type));
    break;
  }
  if (packet->type != TraversalPacketType::Ack)
  {
    TraversalPacket ack = {};
    ack.type = TraversalPacketType::Ack;
    ack.requestId = packet->requestId;
    ack.ack.ok = ok;

    ENetBuffer buf;
    buf.data = &ack;
    buf.dataLength = sizeof(ack);
    if (enet_socket_send(m_NetHost->socket, &m_ServerAddress, &buf, 1) == -1)
      OnFailure(FailureReason::SocketSendError);
  }
}

void TraversalClient::OnFailure(FailureReason reason)
{
  m_State = State::Failure;
  m_FailureReason = reason;

  if (m_Client)
    m_Client->OnTraversalStateChanged();
}

void TraversalClient::ResendPacket(OutgoingTraversalPacketInfo* info)
{
  bool testPacket =
      m_TestSocket != ENET_SOCKET_NULL && info->packet.type == TraversalPacketType::TestPlease;
  info->sendTime = enet_time_get();
  info->tries++;
  ENetBuffer buf;
  buf.data = &info->packet;
  buf.dataLength = sizeof(info->packet);
  if (enet_socket_send(testPacket ? m_TestSocket : m_NetHost->socket, &m_ServerAddress, &buf, 1) ==
      -1)
    OnFailure(FailureReason::SocketSendError);
}

void TraversalClient::HandleResends()
{
  const u32 now = enet_time_get();
  for (auto& tpi : m_OutgoingTraversalPackets)
  {
    if (now - tpi.sendTime >= (u32)(300 * tpi.tries))
    {
      if (tpi.tries >= 5)
      {
        OnFailure(FailureReason::ResendTimeout);
        m_OutgoingTraversalPackets.clear();
        break;
      }
      else
      {
        ResendPacket(&tpi);
      }
    }
  }
  HandlePing();
}

void TraversalClient::HandlePing()
{
  const u32 now = enet_time_get();
  if (IsConnected() && now - m_PingTime >= 500)
  {
    TraversalPacket ping = {};
    ping.type = TraversalPacketType::Ping;
    ping.ping.hostId = m_HostId;
    SendTraversalPacket(ping);
    m_PingTime = now;
  }
}

void TraversalClient::NewTraversalTest()
{
  // create test socket
  if (m_TestSocket != ENET_SOCKET_NULL)
    enet_socket_destroy(m_TestSocket);
  m_TestSocket = enet_socket_create(ENET_SOCKET_TYPE_DATAGRAM);
  ENetAddress addr = {ENET_HOST_ANY, 0};
  if (m_TestSocket == ENET_SOCKET_NULL || enet_socket_bind(m_TestSocket, &addr) < 0)
  {
    // error, abort
    if (m_TestSocket != ENET_SOCKET_NULL)
    {
      enet_socket_destroy(m_TestSocket);
      m_TestSocket = ENET_SOCKET_NULL;
    }
    return;
  }
  enet_socket_set_option(m_TestSocket, ENET_SOCKOPT_NONBLOCK, 1);
  // create holepunch packet
  TraversalPacket packet = {};
  packet.type = TraversalPacketType::Ping;
  packet.ping.hostId = m_HostId;
  packet.requestId = Common::Random::GenerateValue<TraversalRequestId>();
  // create buffer
  ENetBuffer buf;
  buf.data = &packet;
  buf.dataLength = sizeof(packet);
  // send to alt port
  ENetAddress altAddress = m_ServerAddress;
  altAddress.port = m_portAlt;
  // set up ttl and send
  int oldttl;
  enet_socket_get_option(m_TestSocket, ENET_SOCKOPT_TTL, &oldttl);
  enet_socket_set_option(m_TestSocket, ENET_SOCKOPT_TTL, m_ttl);
  if (enet_socket_send(m_TestSocket, &altAddress, &buf, 1) == -1)
  {
    // error, abort
    enet_socket_destroy(m_TestSocket);
    m_TestSocket = ENET_SOCKET_NULL;
    return;
  }
  enet_socket_set_option(m_TestSocket, ENET_SOCKOPT_TTL, oldttl);
  // send the test request
  packet.type = TraversalPacketType::TestPlease;
  m_TestRequestId = SendTraversalPacket(packet);
}

void TraversalClient::HandleTraversalTest()
{
  if (m_TestSocket != ENET_SOCKET_NULL)
  {
    // check for packet on test socket (with timeout)
    u32 deadline = enet_time_get() + 50;
    u32 waitCondition;
    do
    {
      waitCondition = ENET_SOCKET_WAIT_RECEIVE | ENET_SOCKET_WAIT_INTERRUPT;
      u32 currentTime = enet_time_get();
      if (currentTime > deadline ||
          enet_socket_wait(m_TestSocket, &waitCondition, deadline - currentTime) != 0)
      {
        // error or timeout, exit the loop and assume test failure
        waitCondition = 0;
        break;
      }
      else if (waitCondition & ENET_SOCKET_WAIT_RECEIVE)
      {
        // try reading the packet and see if it's relevant
        ENetAddress raddr;
        TraversalPacket packet;
        ENetBuffer buf;
        buf.data = &packet;
        buf.dataLength = sizeof(packet);
        int rv = enet_socket_receive(m_TestSocket, &raddr, &buf, 1);
        if (rv < 0)
        {
          // error, exit the loop and assume test failure
          waitCondition = 0;
          break;
        }
        else if (rv < int(sizeof(packet)) || raddr.host != m_ServerAddress.host ||
                 raddr.host != m_portAlt || packet.requestId != m_TestRequestId)
        {
          // irrelevant packet, ignore
          continue;
        }
      }
    } while (waitCondition & ENET_SOCKET_WAIT_INTERRUPT);
    // regardless of what happens next, we can throw out the socket
    enet_socket_destroy(m_TestSocket);
    m_TestSocket = ENET_SOCKET_NULL;
    if (waitCondition & ENET_SOCKET_WAIT_RECEIVE)
    {
      // success, we can stop now
      m_ttlReady = true;
      m_Client->OnTtlDetermined(m_ttl);
    }
    else
    {
      // fail, increment and retry
      if (++m_ttl < 32)
        NewTraversalTest();
    }
  }
}

TraversalRequestId TraversalClient::SendTraversalPacket(const TraversalPacket& packet)
{
  OutgoingTraversalPacketInfo info;
  info.packet = packet;
  info.packet.requestId = Common::Random::GenerateValue<TraversalRequestId>();
  info.tries = 0;
  m_OutgoingTraversalPackets.push_back(info);
  ResendPacket(&m_OutgoingTraversalPackets.back());
  return info.packet.requestId;
}

void TraversalClient::Reset()
{
  m_PendingConnect = false;
  m_Client = nullptr;
}

int ENET_CALLBACK TraversalClient::InterceptCallback(ENetHost* host, ENetEvent* event)
{
  auto traversalClient = g_TraversalClient.get();
  if (traversalClient->TestPacket(host->receivedData, host->receivedDataLength,
                                  &host->receivedAddress) ||
      (host->receivedDataLength == 1 && host->receivedData[0] == 0))
  {
    event->type = static_cast<ENetEventType>(Common::ENet::SKIPPABLE_EVENT);
    return 1;
  }
  return 0;
}

std::unique_ptr<TraversalClient> g_TraversalClient;
ENet::ENetHostPtr g_MainNetHost;

// The settings at the previous TraversalClient reset - notably, we
// need to know not just what port it's on, but whether it was
// explicitly requested.
static std::string g_OldServer;
static u16 g_OldServerPort;
static u16 g_OldServerPortAlt;
static u16 g_OldListenPort;

bool EnsureTraversalClient(const std::string& server, u16 server_port, u16 server_port_alt,
                           u16 listen_port)
{
  if (!g_MainNetHost || !g_TraversalClient || server != g_OldServer ||
      server_port != g_OldServerPort || server_port_alt != g_OldServerPortAlt ||
      listen_port != g_OldListenPort)
  {
    g_OldServer = server;
    g_OldServerPort = server_port;
    g_OldServerPortAlt = server_port_alt;
    g_OldListenPort = listen_port;

    ENetAddress addr = {ENET_HOST_ANY, listen_port};
    auto host = Common::ENet::ENetHostPtr{enet_host_create(&addr,                   // address
                                                           50,                      // peerCount
                                                           NetPlay::CHANNEL_COUNT,  // channelLimit
                                                           0,    // incomingBandwidth
                                                           0)};  // outgoingBandwidth
    if (!host)
    {
      g_MainNetHost.reset();
      return false;
    }
    host->mtu = std::min(host->mtu, NetPlay::MAX_ENET_MTU);
    g_MainNetHost = std::move(host);
    g_TraversalClient.reset(
        new TraversalClient(g_MainNetHost.get(), server, server_port, server_port_alt));
  }
  return true;
}

void ReleaseTraversalClient()
{
  if (!g_TraversalClient)
    return;

  g_TraversalClient.reset();
  g_MainNetHost.reset();
}
}  // namespace Common