networked_multiplayer_enet.cpp 33 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988
  1. /*************************************************************************/
  2. /* networked_multiplayer_enet.cpp */
  3. /*************************************************************************/
  4. /* This file is part of: */
  5. /* GODOT ENGINE */
  6. /* https://godotengine.org */
  7. /*************************************************************************/
  8. /* Copyright (c) 2007-2021 Juan Linietsky, Ariel Manzur. */
  9. /* Copyright (c) 2014-2021 Godot Engine contributors (cf. AUTHORS.md). */
  10. /* */
  11. /* Permission is hereby granted, free of charge, to any person obtaining */
  12. /* a copy of this software and associated documentation files (the */
  13. /* "Software"), to deal in the Software without restriction, including */
  14. /* without limitation the rights to use, copy, modify, merge, publish, */
  15. /* distribute, sublicense, and/or sell copies of the Software, and to */
  16. /* permit persons to whom the Software is furnished to do so, subject to */
  17. /* the following conditions: */
  18. /* */
  19. /* The above copyright notice and this permission notice shall be */
  20. /* included in all copies or substantial portions of the Software. */
  21. /* */
  22. /* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, */
  23. /* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF */
  24. /* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.*/
  25. /* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY */
  26. /* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, */
  27. /* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE */
  28. /* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */
  29. /*************************************************************************/
  30. #include "networked_multiplayer_enet.h"
  31. #include "core/io/ip.h"
  32. #include "core/io/marshalls.h"
  33. #include "core/os/os.h"
  34. void NetworkedMultiplayerENet::set_transfer_mode(TransferMode p_mode) {
  35. transfer_mode = p_mode;
  36. }
  37. NetworkedMultiplayerPeer::TransferMode NetworkedMultiplayerENet::get_transfer_mode() const {
  38. return transfer_mode;
  39. }
  40. void NetworkedMultiplayerENet::set_target_peer(int p_peer) {
  41. target_peer = p_peer;
  42. }
  43. int NetworkedMultiplayerENet::get_packet_peer() const {
  44. ERR_FAIL_COND_V_MSG(!active, 1, "The multiplayer instance isn't currently active.");
  45. ERR_FAIL_COND_V(incoming_packets.size() == 0, 1);
  46. return incoming_packets.front()->get().from;
  47. }
  48. int NetworkedMultiplayerENet::get_packet_channel() const {
  49. ERR_FAIL_COND_V_MSG(!active, -1, "The multiplayer instance isn't currently active.");
  50. ERR_FAIL_COND_V(incoming_packets.size() == 0, -1);
  51. return incoming_packets.front()->get().channel;
  52. }
  53. int NetworkedMultiplayerENet::get_last_packet_channel() const {
  54. ERR_FAIL_COND_V_MSG(!active, -1, "The multiplayer instance isn't currently active.");
  55. ERR_FAIL_COND_V(!current_packet.packet, -1);
  56. return current_packet.channel;
  57. }
  58. Error NetworkedMultiplayerENet::create_server(int p_port, int p_max_clients, int p_in_bandwidth, int p_out_bandwidth) {
  59. ERR_FAIL_COND_V_MSG(active, ERR_ALREADY_IN_USE, "The multiplayer instance is already active.");
  60. ERR_FAIL_COND_V_MSG(p_port < 0 || p_port > 65535, ERR_INVALID_PARAMETER, "The port number must be set between 0 and 65535 (inclusive).");
  61. ERR_FAIL_COND_V_MSG(p_max_clients < 1 || p_max_clients > 4095, ERR_INVALID_PARAMETER, "The number of clients must be set between 1 and 4095 (inclusive).");
  62. ERR_FAIL_COND_V_MSG(p_in_bandwidth < 0, ERR_INVALID_PARAMETER, "The incoming bandwidth limit must be greater than or equal to 0 (0 disables the limit).");
  63. ERR_FAIL_COND_V_MSG(p_out_bandwidth < 0, ERR_INVALID_PARAMETER, "The outgoing bandwidth limit must be greater than or equal to 0 (0 disables the limit).");
  64. ERR_FAIL_COND_V(dtls_enabled && (dtls_key.is_null() || dtls_cert.is_null()), ERR_INVALID_PARAMETER);
  65. ENetAddress address;
  66. memset(&address, 0, sizeof(address));
  67. #ifdef GODOT_ENET
  68. if (bind_ip.is_wildcard()) {
  69. address.wildcard = 1;
  70. } else {
  71. enet_address_set_ip(&address, bind_ip.get_ipv6(), 16);
  72. }
  73. #else
  74. if (bind_ip.is_wildcard()) {
  75. address.host = 0;
  76. } else {
  77. ERR_FAIL_COND_V(!bind_ip.is_ipv4(), ERR_INVALID_PARAMETER);
  78. address.host = *(uint32_t *)bind_ip.get_ipv4();
  79. }
  80. #endif
  81. address.port = p_port;
  82. host = enet_host_create(&address /* the address to bind the server host to */,
  83. p_max_clients /* allow up to 32 clients and/or outgoing connections */,
  84. channel_count /* allow up to channel_count to be used */,
  85. p_in_bandwidth /* limit incoming bandwidth if > 0 */,
  86. p_out_bandwidth /* limit outgoing bandwidth if > 0 */);
  87. ERR_FAIL_COND_V_MSG(!host, ERR_CANT_CREATE, "Couldn't create an ENet multiplayer server.");
  88. #ifdef GODOT_ENET
  89. if (dtls_enabled) {
  90. enet_host_dtls_server_setup(host, dtls_key.ptr(), dtls_cert.ptr());
  91. }
  92. enet_host_refuse_new_connections(host, refuse_connections);
  93. #endif
  94. _setup_compressor();
  95. active = true;
  96. server = true;
  97. refuse_connections = false;
  98. unique_id = 1;
  99. connection_status = CONNECTION_CONNECTED;
  100. return OK;
  101. }
  102. Error NetworkedMultiplayerENet::create_client(const String &p_address, int p_port, int p_in_bandwidth, int p_out_bandwidth, int p_client_port) {
  103. ERR_FAIL_COND_V_MSG(active, ERR_ALREADY_IN_USE, "The multiplayer instance is already active.");
  104. ERR_FAIL_COND_V_MSG(p_port < 0 || p_port > 65535, ERR_INVALID_PARAMETER, "The server port number must be set between 0 and 65535 (inclusive).");
  105. ERR_FAIL_COND_V_MSG(p_client_port < 0 || p_client_port > 65535, ERR_INVALID_PARAMETER, "The client port number must be set between 0 and 65535 (inclusive).");
  106. ERR_FAIL_COND_V_MSG(p_in_bandwidth < 0, ERR_INVALID_PARAMETER, "The incoming bandwidth limit must be greater than or equal to 0 (0 disables the limit).");
  107. ERR_FAIL_COND_V_MSG(p_out_bandwidth < 0, ERR_INVALID_PARAMETER, "The outgoing bandwidth limit must be greater than or equal to 0 (0 disables the limit).");
  108. if (p_client_port != 0) {
  109. ENetAddress c_client;
  110. #ifdef GODOT_ENET
  111. if (bind_ip.is_wildcard()) {
  112. c_client.wildcard = 1;
  113. } else {
  114. enet_address_set_ip(&c_client, bind_ip.get_ipv6(), 16);
  115. }
  116. #else
  117. if (bind_ip.is_wildcard()) {
  118. c_client.host = 0;
  119. } else {
  120. ERR_FAIL_COND_V_MSG(!bind_ip.is_ipv4(), ERR_INVALID_PARAMETER, "Wildcard IP addresses are only permitted in IPv4, not IPv6.");
  121. c_client.host = *(uint32_t *)bind_ip.get_ipv4();
  122. }
  123. #endif
  124. c_client.port = p_client_port;
  125. host = enet_host_create(&c_client /* create a client host */,
  126. 1 /* only allow 1 outgoing connection */,
  127. channel_count /* allow up to channel_count to be used */,
  128. p_in_bandwidth /* limit incoming bandwidth if > 0 */,
  129. p_out_bandwidth /* limit outgoing bandwidth if > 0 */);
  130. } else {
  131. host = enet_host_create(NULL /* create a client host */,
  132. 1 /* only allow 1 outgoing connection */,
  133. channel_count /* allow up to channel_count to be used */,
  134. p_in_bandwidth /* limit incoming bandwidth if > 0 */,
  135. p_out_bandwidth /* limit outgoing bandwidth if > 0 */);
  136. }
  137. ERR_FAIL_COND_V_MSG(!host, ERR_CANT_CREATE, "Couldn't create the ENet client host.");
  138. #ifdef GODOT_ENET
  139. if (dtls_enabled) {
  140. enet_host_dtls_client_setup(host, dtls_cert.ptr(), dtls_verify, p_address.utf8().get_data());
  141. }
  142. enet_host_refuse_new_connections(host, refuse_connections);
  143. #endif
  144. _setup_compressor();
  145. IP_Address ip;
  146. if (p_address.is_valid_ip_address()) {
  147. ip = p_address;
  148. } else {
  149. #ifdef GODOT_ENET
  150. ip = IP::get_singleton()->resolve_hostname(p_address);
  151. #else
  152. ip = IP::get_singleton()->resolve_hostname(p_address, IP::TYPE_IPV4);
  153. #endif
  154. ERR_FAIL_COND_V_MSG(!ip.is_valid(), ERR_CANT_RESOLVE, "Couldn't resolve the server IP address or domain name.");
  155. }
  156. ENetAddress address;
  157. #ifdef GODOT_ENET
  158. enet_address_set_ip(&address, ip.get_ipv6(), 16);
  159. #else
  160. ERR_FAIL_COND_V_MSG(!ip.is_ipv4(), ERR_INVALID_PARAMETER, "Connecting to an IPv6 server isn't supported when using vanilla ENet. Recompile Godot with the bundled ENet library.");
  161. address.host = *(uint32_t *)ip.get_ipv4();
  162. #endif
  163. address.port = p_port;
  164. unique_id = _gen_unique_id();
  165. // Initiate connection, allocating enough channels
  166. ENetPeer *peer = enet_host_connect(host, &address, channel_count, unique_id);
  167. if (peer == NULL) {
  168. enet_host_destroy(host);
  169. ERR_FAIL_COND_V_MSG(!peer, ERR_CANT_CREATE, "Couldn't connect to the ENet multiplayer server.");
  170. }
  171. // Technically safe to ignore the peer or anything else.
  172. connection_status = CONNECTION_CONNECTING;
  173. active = true;
  174. server = false;
  175. refuse_connections = false;
  176. return OK;
  177. }
  178. void NetworkedMultiplayerENet::poll() {
  179. ERR_FAIL_COND_MSG(!active, "The multiplayer instance isn't currently active.");
  180. _pop_current_packet();
  181. ENetEvent event;
  182. /* Keep servicing until there are no available events left in queue. */
  183. while (true) {
  184. if (!host || !active) // Might have been disconnected while emitting a notification
  185. return;
  186. int ret = enet_host_service(host, &event, 0);
  187. if (ret < 0) {
  188. // Error, do something?
  189. break;
  190. } else if (ret == 0) {
  191. break;
  192. }
  193. switch (event.type) {
  194. case ENET_EVENT_TYPE_CONNECT: {
  195. // Store any relevant client information here.
  196. if (server && refuse_connections) {
  197. enet_peer_reset(event.peer);
  198. break;
  199. }
  200. // A client joined with an invalid ID (negative values, 0, and 1 are reserved).
  201. // Probably trying to exploit us.
  202. if (server && ((int)event.data < 2 || peer_map.has((int)event.data))) {
  203. enet_peer_reset(event.peer);
  204. ERR_CONTINUE(true);
  205. }
  206. int *new_id = memnew(int);
  207. *new_id = event.data;
  208. if (*new_id == 0) { // Data zero is sent by server (enet won't let you configure this). Server is always 1.
  209. *new_id = 1;
  210. }
  211. event.peer->data = new_id;
  212. peer_map[*new_id] = event.peer;
  213. connection_status = CONNECTION_CONNECTED; // If connecting, this means it connected to something!
  214. emit_signal("peer_connected", *new_id);
  215. if (server) {
  216. // Do not notify other peers when server_relay is disabled.
  217. if (!server_relay)
  218. break;
  219. // Someone connected, notify all the peers available
  220. for (Map<int, ENetPeer *>::Element *E = peer_map.front(); E; E = E->next()) {
  221. if (E->key() == *new_id)
  222. continue;
  223. // Send existing peers to new peer
  224. ENetPacket *packet = enet_packet_create(NULL, 8, ENET_PACKET_FLAG_RELIABLE);
  225. encode_uint32(SYSMSG_ADD_PEER, &packet->data[0]);
  226. encode_uint32(E->key(), &packet->data[4]);
  227. enet_peer_send(event.peer, SYSCH_CONFIG, packet);
  228. // Send the new peer to existing peers
  229. packet = enet_packet_create(NULL, 8, ENET_PACKET_FLAG_RELIABLE);
  230. encode_uint32(SYSMSG_ADD_PEER, &packet->data[0]);
  231. encode_uint32(*new_id, &packet->data[4]);
  232. enet_peer_send(E->get(), SYSCH_CONFIG, packet);
  233. }
  234. } else {
  235. emit_signal("connection_succeeded");
  236. }
  237. } break;
  238. case ENET_EVENT_TYPE_DISCONNECT: {
  239. // Reset the peer's client information.
  240. int *id = (int *)event.peer->data;
  241. if (!id) {
  242. if (!server) {
  243. emit_signal("connection_failed");
  244. }
  245. // Never fully connected.
  246. break;
  247. }
  248. if (!server) {
  249. // Client just disconnected from server.
  250. emit_signal("server_disconnected");
  251. close_connection();
  252. return;
  253. } else if (server_relay) {
  254. // Server just received a client disconnect and is in relay mode, notify everyone else.
  255. for (Map<int, ENetPeer *>::Element *E = peer_map.front(); E; E = E->next()) {
  256. if (E->key() == *id)
  257. continue;
  258. ENetPacket *packet = enet_packet_create(NULL, 8, ENET_PACKET_FLAG_RELIABLE);
  259. encode_uint32(SYSMSG_REMOVE_PEER, &packet->data[0]);
  260. encode_uint32(*id, &packet->data[4]);
  261. enet_peer_send(E->get(), SYSCH_CONFIG, packet);
  262. }
  263. }
  264. emit_signal("peer_disconnected", *id);
  265. peer_map.erase(*id);
  266. memdelete(id);
  267. } break;
  268. case ENET_EVENT_TYPE_RECEIVE: {
  269. if (event.channelID == SYSCH_CONFIG) {
  270. // Some config message
  271. ERR_CONTINUE(event.packet->dataLength < 8);
  272. // Only server can send config messages
  273. ERR_CONTINUE(server);
  274. int msg = decode_uint32(&event.packet->data[0]);
  275. int id = decode_uint32(&event.packet->data[4]);
  276. switch (msg) {
  277. case SYSMSG_ADD_PEER: {
  278. peer_map[id] = NULL;
  279. emit_signal("peer_connected", id);
  280. } break;
  281. case SYSMSG_REMOVE_PEER: {
  282. peer_map.erase(id);
  283. emit_signal("peer_disconnected", id);
  284. } break;
  285. }
  286. enet_packet_destroy(event.packet);
  287. } else if (event.channelID < channel_count) {
  288. Packet packet;
  289. packet.packet = event.packet;
  290. uint32_t *id = (uint32_t *)event.peer->data;
  291. ERR_CONTINUE(event.packet->dataLength < 8);
  292. uint32_t source = decode_uint32(&event.packet->data[0]);
  293. int target = decode_uint32(&event.packet->data[4]);
  294. packet.from = source;
  295. packet.channel = event.channelID;
  296. if (server) {
  297. // Someone is cheating and trying to fake the source!
  298. ERR_CONTINUE(source != *id);
  299. packet.from = *id;
  300. if (target == 1) {
  301. // To myself and only myself
  302. incoming_packets.push_back(packet);
  303. } else if (!server_relay) {
  304. // No other destination is allowed when server is not relaying
  305. continue;
  306. } else if (target == 0) {
  307. // Re-send to everyone but sender :|
  308. incoming_packets.push_back(packet);
  309. // And make copies for sending
  310. for (Map<int, ENetPeer *>::Element *E = peer_map.front(); E; E = E->next()) {
  311. if (uint32_t(E->key()) == source) // Do not resend to self
  312. continue;
  313. ENetPacket *packet2 = enet_packet_create(packet.packet->data, packet.packet->dataLength, packet.packet->flags);
  314. enet_peer_send(E->get(), event.channelID, packet2);
  315. }
  316. } else if (target < 0) {
  317. // To all but one
  318. // And make copies for sending
  319. for (Map<int, ENetPeer *>::Element *E = peer_map.front(); E; E = E->next()) {
  320. if (uint32_t(E->key()) == source || E->key() == -target) // Do not resend to self, also do not send to excluded
  321. continue;
  322. ENetPacket *packet2 = enet_packet_create(packet.packet->data, packet.packet->dataLength, packet.packet->flags);
  323. enet_peer_send(E->get(), event.channelID, packet2);
  324. }
  325. if (-target != 1) {
  326. // Server is not excluded
  327. incoming_packets.push_back(packet);
  328. } else {
  329. // Server is excluded, erase packet
  330. enet_packet_destroy(packet.packet);
  331. }
  332. } else {
  333. // To someone else, specifically
  334. ERR_CONTINUE(!peer_map.has(target));
  335. enet_peer_send(peer_map[target], event.channelID, packet.packet);
  336. }
  337. } else {
  338. incoming_packets.push_back(packet);
  339. }
  340. // Destroy packet later
  341. } else {
  342. ERR_CONTINUE(true);
  343. }
  344. } break;
  345. case ENET_EVENT_TYPE_NONE: {
  346. // Do nothing
  347. } break;
  348. }
  349. }
  350. }
  351. bool NetworkedMultiplayerENet::is_server() const {
  352. ERR_FAIL_COND_V_MSG(!active, false, "The multiplayer instance isn't currently active.");
  353. return server;
  354. }
  355. void NetworkedMultiplayerENet::close_connection(uint32_t wait_usec) {
  356. ERR_FAIL_COND_MSG(!active, "The multiplayer instance isn't currently active.");
  357. _pop_current_packet();
  358. bool peers_disconnected = false;
  359. for (Map<int, ENetPeer *>::Element *E = peer_map.front(); E; E = E->next()) {
  360. if (E->get()) {
  361. enet_peer_disconnect_now(E->get(), unique_id);
  362. int *id = (int *)(E->get()->data);
  363. memdelete(id);
  364. peers_disconnected = true;
  365. }
  366. }
  367. if (peers_disconnected) {
  368. enet_host_flush(host);
  369. if (wait_usec > 0) {
  370. OS::get_singleton()->delay_usec(wait_usec); // Wait for disconnection packets to send
  371. }
  372. }
  373. enet_host_destroy(host);
  374. active = false;
  375. incoming_packets.clear();
  376. peer_map.clear();
  377. unique_id = 1; // Server is 1
  378. connection_status = CONNECTION_DISCONNECTED;
  379. }
  380. void NetworkedMultiplayerENet::disconnect_peer(int p_peer, bool now) {
  381. ERR_FAIL_COND_MSG(!active, "The multiplayer instance isn't currently active.");
  382. ERR_FAIL_COND_MSG(!is_server(), "Can't disconnect a peer when not acting as a server.");
  383. ERR_FAIL_COND_MSG(!peer_map.has(p_peer), vformat("Peer ID %d not found in the list of peers.", p_peer));
  384. if (now) {
  385. int *id = (int *)peer_map[p_peer]->data;
  386. enet_peer_disconnect_now(peer_map[p_peer], 0);
  387. // enet_peer_disconnect_now doesn't generate ENET_EVENT_TYPE_DISCONNECT,
  388. // notify everyone else, send disconnect signal & remove from peer_map like in poll()
  389. if (server_relay) {
  390. for (Map<int, ENetPeer *>::Element *E = peer_map.front(); E; E = E->next()) {
  391. if (E->key() == p_peer) {
  392. continue;
  393. }
  394. ENetPacket *packet = enet_packet_create(NULL, 8, ENET_PACKET_FLAG_RELIABLE);
  395. encode_uint32(SYSMSG_REMOVE_PEER, &packet->data[0]);
  396. encode_uint32(p_peer, &packet->data[4]);
  397. enet_peer_send(E->get(), SYSCH_CONFIG, packet);
  398. }
  399. }
  400. if (id)
  401. memdelete(id);
  402. emit_signal("peer_disconnected", p_peer);
  403. peer_map.erase(p_peer);
  404. } else {
  405. enet_peer_disconnect_later(peer_map[p_peer], 0);
  406. }
  407. }
  408. int NetworkedMultiplayerENet::get_available_packet_count() const {
  409. return incoming_packets.size();
  410. }
  411. Error NetworkedMultiplayerENet::get_packet(const uint8_t **r_buffer, int &r_buffer_size) {
  412. ERR_FAIL_COND_V_MSG(incoming_packets.size() == 0, ERR_UNAVAILABLE, "No incoming packets available.");
  413. _pop_current_packet();
  414. current_packet = incoming_packets.front()->get();
  415. incoming_packets.pop_front();
  416. *r_buffer = (const uint8_t *)(&current_packet.packet->data[8]);
  417. r_buffer_size = current_packet.packet->dataLength - 8;
  418. return OK;
  419. }
  420. Error NetworkedMultiplayerENet::put_packet(const uint8_t *p_buffer, int p_buffer_size) {
  421. ERR_FAIL_COND_V_MSG(!active, ERR_UNCONFIGURED, "The multiplayer instance isn't currently active.");
  422. ERR_FAIL_COND_V_MSG(connection_status != CONNECTION_CONNECTED, ERR_UNCONFIGURED, "The multiplayer instance isn't currently connected to any server or client.");
  423. int packet_flags = 0;
  424. int channel = SYSCH_RELIABLE;
  425. switch (transfer_mode) {
  426. case TRANSFER_MODE_UNRELIABLE: {
  427. if (always_ordered)
  428. packet_flags = 0;
  429. else
  430. packet_flags = ENET_PACKET_FLAG_UNSEQUENCED;
  431. channel = SYSCH_UNRELIABLE;
  432. } break;
  433. case TRANSFER_MODE_UNRELIABLE_ORDERED: {
  434. packet_flags = 0;
  435. channel = SYSCH_UNRELIABLE;
  436. } break;
  437. case TRANSFER_MODE_RELIABLE: {
  438. packet_flags = ENET_PACKET_FLAG_RELIABLE;
  439. channel = SYSCH_RELIABLE;
  440. } break;
  441. }
  442. if (transfer_channel > SYSCH_CONFIG)
  443. channel = transfer_channel;
  444. Map<int, ENetPeer *>::Element *E = NULL;
  445. if (target_peer != 0) {
  446. E = peer_map.find(ABS(target_peer));
  447. ERR_FAIL_COND_V_MSG(!E, ERR_INVALID_PARAMETER, vformat("Invalid target peer: %d", target_peer));
  448. }
  449. ENetPacket *packet = enet_packet_create(NULL, p_buffer_size + 8, packet_flags);
  450. encode_uint32(unique_id, &packet->data[0]); // Source ID
  451. encode_uint32(target_peer, &packet->data[4]); // Dest ID
  452. memcpy(&packet->data[8], p_buffer, p_buffer_size);
  453. if (server) {
  454. if (target_peer == 0) {
  455. enet_host_broadcast(host, channel, packet);
  456. } else if (target_peer < 0) {
  457. // Send to all but one
  458. // and make copies for sending
  459. int exclude = -target_peer;
  460. for (Map<int, ENetPeer *>::Element *F = peer_map.front(); F; F = F->next()) {
  461. if (F->key() == exclude) // Exclude packet
  462. continue;
  463. ENetPacket *packet2 = enet_packet_create(packet->data, packet->dataLength, packet_flags);
  464. enet_peer_send(F->get(), channel, packet2);
  465. }
  466. enet_packet_destroy(packet); // Original packet no longer needed
  467. } else {
  468. enet_peer_send(E->get(), channel, packet);
  469. }
  470. } else {
  471. ERR_FAIL_COND_V(!peer_map.has(1), ERR_BUG);
  472. enet_peer_send(peer_map[1], channel, packet); // Send to server for broadcast
  473. }
  474. enet_host_flush(host);
  475. return OK;
  476. }
  477. int NetworkedMultiplayerENet::get_max_packet_size() const {
  478. return 1 << 24; // Anything is good
  479. }
  480. void NetworkedMultiplayerENet::_pop_current_packet() {
  481. if (current_packet.packet) {
  482. enet_packet_destroy(current_packet.packet);
  483. current_packet.packet = NULL;
  484. current_packet.from = 0;
  485. current_packet.channel = -1;
  486. }
  487. }
  488. NetworkedMultiplayerPeer::ConnectionStatus NetworkedMultiplayerENet::get_connection_status() const {
  489. return connection_status;
  490. }
  491. uint32_t NetworkedMultiplayerENet::_gen_unique_id() const {
  492. uint32_t hash = 0;
  493. while (hash == 0 || hash == 1) {
  494. hash = hash_djb2_one_32(
  495. (uint32_t)OS::get_singleton()->get_ticks_usec());
  496. hash = hash_djb2_one_32(
  497. (uint32_t)OS::get_singleton()->get_unix_time(), hash);
  498. hash = hash_djb2_one_32(
  499. (uint32_t)OS::get_singleton()->get_user_data_dir().hash64(), hash);
  500. hash = hash_djb2_one_32(
  501. (uint32_t)((uint64_t)this), hash); // Rely on ASLR heap
  502. hash = hash_djb2_one_32(
  503. (uint32_t)((uint64_t)&hash), hash); // Rely on ASLR stack
  504. hash = hash & 0x7FFFFFFF; // Make it compatible with unsigned, since negative ID is used for exclusion
  505. }
  506. return hash;
  507. }
  508. int NetworkedMultiplayerENet::get_unique_id() const {
  509. ERR_FAIL_COND_V_MSG(!active, 0, "The multiplayer instance isn't currently active.");
  510. return unique_id;
  511. }
  512. void NetworkedMultiplayerENet::set_refuse_new_connections(bool p_enable) {
  513. refuse_connections = p_enable;
  514. #ifdef GODOT_ENET
  515. if (active) {
  516. enet_host_refuse_new_connections(host, p_enable);
  517. }
  518. #endif
  519. }
  520. bool NetworkedMultiplayerENet::is_refusing_new_connections() const {
  521. return refuse_connections;
  522. }
  523. void NetworkedMultiplayerENet::set_compression_mode(CompressionMode p_mode) {
  524. compression_mode = p_mode;
  525. }
  526. NetworkedMultiplayerENet::CompressionMode NetworkedMultiplayerENet::get_compression_mode() const {
  527. return compression_mode;
  528. }
  529. size_t NetworkedMultiplayerENet::enet_compress(void *context, const ENetBuffer *inBuffers, size_t inBufferCount, size_t inLimit, enet_uint8 *outData, size_t outLimit) {
  530. NetworkedMultiplayerENet *enet = (NetworkedMultiplayerENet *)(context);
  531. if (size_t(enet->src_compressor_mem.size()) < inLimit) {
  532. enet->src_compressor_mem.resize(inLimit);
  533. }
  534. int total = inLimit;
  535. int ofs = 0;
  536. while (total) {
  537. for (size_t i = 0; i < inBufferCount; i++) {
  538. int to_copy = MIN(total, int(inBuffers[i].dataLength));
  539. memcpy(&enet->src_compressor_mem.write[ofs], inBuffers[i].data, to_copy);
  540. ofs += to_copy;
  541. total -= to_copy;
  542. }
  543. }
  544. Compression::Mode mode;
  545. switch (enet->compression_mode) {
  546. case COMPRESS_FASTLZ: {
  547. mode = Compression::MODE_FASTLZ;
  548. } break;
  549. case COMPRESS_ZLIB: {
  550. mode = Compression::MODE_DEFLATE;
  551. } break;
  552. case COMPRESS_ZSTD: {
  553. mode = Compression::MODE_ZSTD;
  554. } break;
  555. default: {
  556. ERR_FAIL_V_MSG(0, vformat("Invalid ENet compression mode: %d", enet->compression_mode));
  557. }
  558. }
  559. int req_size = Compression::get_max_compressed_buffer_size(ofs, mode);
  560. if (enet->dst_compressor_mem.size() < req_size) {
  561. enet->dst_compressor_mem.resize(req_size);
  562. }
  563. int ret = Compression::compress(enet->dst_compressor_mem.ptrw(), enet->src_compressor_mem.ptr(), ofs, mode);
  564. if (ret < 0)
  565. return 0;
  566. if (ret > int(outLimit))
  567. return 0; // Do not bother
  568. memcpy(outData, enet->dst_compressor_mem.ptr(), ret);
  569. return ret;
  570. }
  571. size_t NetworkedMultiplayerENet::enet_decompress(void *context, const enet_uint8 *inData, size_t inLimit, enet_uint8 *outData, size_t outLimit) {
  572. NetworkedMultiplayerENet *enet = (NetworkedMultiplayerENet *)(context);
  573. int ret = -1;
  574. switch (enet->compression_mode) {
  575. case COMPRESS_FASTLZ: {
  576. ret = Compression::decompress(outData, outLimit, inData, inLimit, Compression::MODE_FASTLZ);
  577. } break;
  578. case COMPRESS_ZLIB: {
  579. ret = Compression::decompress(outData, outLimit, inData, inLimit, Compression::MODE_DEFLATE);
  580. } break;
  581. case COMPRESS_ZSTD: {
  582. ret = Compression::decompress(outData, outLimit, inData, inLimit, Compression::MODE_ZSTD);
  583. } break;
  584. default: {
  585. }
  586. }
  587. if (ret < 0) {
  588. return 0;
  589. } else {
  590. return ret;
  591. }
  592. }
  593. void NetworkedMultiplayerENet::_setup_compressor() {
  594. switch (compression_mode) {
  595. case COMPRESS_NONE: {
  596. enet_host_compress(host, NULL);
  597. } break;
  598. case COMPRESS_RANGE_CODER: {
  599. enet_host_compress_with_range_coder(host);
  600. } break;
  601. case COMPRESS_FASTLZ:
  602. case COMPRESS_ZLIB:
  603. case COMPRESS_ZSTD: {
  604. enet_host_compress(host, &enet_compressor);
  605. } break;
  606. }
  607. }
  608. void NetworkedMultiplayerENet::enet_compressor_destroy(void *context) {
  609. // Nothing to do
  610. }
  611. IP_Address NetworkedMultiplayerENet::get_peer_address(int p_peer_id) const {
  612. ERR_FAIL_COND_V_MSG(!peer_map.has(p_peer_id), IP_Address(), vformat("Peer ID %d not found in the list of peers.", p_peer_id));
  613. ERR_FAIL_COND_V_MSG(!is_server() && p_peer_id != 1, IP_Address(), "Can't get the address of peers other than the server (ID -1) when acting as a client.");
  614. ERR_FAIL_COND_V_MSG(peer_map[p_peer_id] == NULL, IP_Address(), vformat("Peer ID %d found in the list of peers, but is null.", p_peer_id));
  615. IP_Address out;
  616. #ifdef GODOT_ENET
  617. out.set_ipv6((uint8_t *)&(peer_map[p_peer_id]->address.host));
  618. #else
  619. out.set_ipv4((uint8_t *)&(peer_map[p_peer_id]->address.host));
  620. #endif
  621. return out;
  622. }
  623. int NetworkedMultiplayerENet::get_peer_port(int p_peer_id) const {
  624. ERR_FAIL_COND_V_MSG(!peer_map.has(p_peer_id), 0, vformat("Peer ID %d not found in the list of peers.", p_peer_id));
  625. ERR_FAIL_COND_V_MSG(!is_server() && p_peer_id != 1, 0, "Can't get the address of peers other than the server (ID -1) when acting as a client.");
  626. ERR_FAIL_COND_V_MSG(peer_map[p_peer_id] == NULL, 0, vformat("Peer ID %d found in the list of peers, but is null.", p_peer_id));
  627. #ifdef GODOT_ENET
  628. return peer_map[p_peer_id]->address.port;
  629. #else
  630. return peer_map[p_peer_id]->address.port;
  631. #endif
  632. }
  633. void NetworkedMultiplayerENet::set_peer_timeout(int p_peer_id, int p_timeout_limit, int p_timeout_min, int p_timeout_max) {
  634. ERR_FAIL_COND_MSG(!peer_map.has(p_peer_id), vformat("Peer ID %d not found in the list of peers.", p_peer_id));
  635. ERR_FAIL_COND_MSG(!is_server() && p_peer_id != 1, "Can't change the timeout of peers other then the server when acting as a client.");
  636. ERR_FAIL_COND_MSG(peer_map[p_peer_id] == nullptr, vformat("Peer ID %d found in the list of peers, but is null.", p_peer_id));
  637. ERR_FAIL_COND_MSG(p_timeout_limit > p_timeout_min || p_timeout_min > p_timeout_max, "Timeout limit must be less than minimum timeout, which itself must be less then maximum timeout");
  638. enet_peer_timeout(peer_map[p_peer_id], p_timeout_limit, p_timeout_min, p_timeout_max);
  639. }
  640. void NetworkedMultiplayerENet::set_transfer_channel(int p_channel) {
  641. ERR_FAIL_COND_MSG(p_channel < -1 || p_channel >= channel_count, vformat("The transfer channel must be set between 0 and %d, inclusive (got %d).", channel_count - 1, p_channel));
  642. ERR_FAIL_COND_MSG(p_channel == SYSCH_CONFIG, vformat("The channel %d is reserved.", SYSCH_CONFIG));
  643. transfer_channel = p_channel;
  644. }
  645. int NetworkedMultiplayerENet::get_transfer_channel() const {
  646. return transfer_channel;
  647. }
  648. void NetworkedMultiplayerENet::set_channel_count(int p_channel) {
  649. ERR_FAIL_COND_MSG(active, "The channel count can't be set while the multiplayer instance is active.");
  650. ERR_FAIL_COND_MSG(p_channel < SYSCH_MAX, vformat("The channel count must be greater than or equal to %d to account for reserved channels (got %d).", SYSCH_MAX, p_channel));
  651. channel_count = p_channel;
  652. }
  653. int NetworkedMultiplayerENet::get_channel_count() const {
  654. return channel_count;
  655. }
  656. void NetworkedMultiplayerENet::set_always_ordered(bool p_ordered) {
  657. always_ordered = p_ordered;
  658. }
  659. bool NetworkedMultiplayerENet::is_always_ordered() const {
  660. return always_ordered;
  661. }
  662. void NetworkedMultiplayerENet::set_server_relay_enabled(bool p_enabled) {
  663. ERR_FAIL_COND_MSG(active, "Server relaying can't be toggled while the multiplayer instance is active.");
  664. server_relay = p_enabled;
  665. }
  666. bool NetworkedMultiplayerENet::is_server_relay_enabled() const {
  667. return server_relay;
  668. }
  669. void NetworkedMultiplayerENet::_bind_methods() {
  670. ClassDB::bind_method(D_METHOD("create_server", "port", "max_clients", "in_bandwidth", "out_bandwidth"), &NetworkedMultiplayerENet::create_server, DEFVAL(32), DEFVAL(0), DEFVAL(0));
  671. ClassDB::bind_method(D_METHOD("create_client", "address", "port", "in_bandwidth", "out_bandwidth", "client_port"), &NetworkedMultiplayerENet::create_client, DEFVAL(0), DEFVAL(0), DEFVAL(0));
  672. ClassDB::bind_method(D_METHOD("close_connection", "wait_usec"), &NetworkedMultiplayerENet::close_connection, DEFVAL(100));
  673. ClassDB::bind_method(D_METHOD("disconnect_peer", "id", "now"), &NetworkedMultiplayerENet::disconnect_peer, DEFVAL(false));
  674. ClassDB::bind_method(D_METHOD("set_compression_mode", "mode"), &NetworkedMultiplayerENet::set_compression_mode);
  675. ClassDB::bind_method(D_METHOD("get_compression_mode"), &NetworkedMultiplayerENet::get_compression_mode);
  676. ClassDB::bind_method(D_METHOD("set_bind_ip", "ip"), &NetworkedMultiplayerENet::set_bind_ip);
  677. ClassDB::bind_method(D_METHOD("set_dtls_enabled", "enabled"), &NetworkedMultiplayerENet::set_dtls_enabled);
  678. ClassDB::bind_method(D_METHOD("is_dtls_enabled"), &NetworkedMultiplayerENet::is_dtls_enabled);
  679. ClassDB::bind_method(D_METHOD("set_dtls_key", "key"), &NetworkedMultiplayerENet::set_dtls_key);
  680. ClassDB::bind_method(D_METHOD("set_dtls_certificate", "certificate"), &NetworkedMultiplayerENet::set_dtls_certificate);
  681. ClassDB::bind_method(D_METHOD("set_dtls_verify_enabled", "enabled"), &NetworkedMultiplayerENet::set_dtls_verify_enabled);
  682. ClassDB::bind_method(D_METHOD("is_dtls_verify_enabled"), &NetworkedMultiplayerENet::is_dtls_verify_enabled);
  683. ClassDB::bind_method(D_METHOD("get_peer_address", "id"), &NetworkedMultiplayerENet::get_peer_address);
  684. ClassDB::bind_method(D_METHOD("get_peer_port", "id"), &NetworkedMultiplayerENet::get_peer_port);
  685. ClassDB::bind_method(D_METHOD("set_peer_timeout", "id", "timeout_limit", "timeout_min", "timeout_max"), &NetworkedMultiplayerENet::set_peer_timeout);
  686. ClassDB::bind_method(D_METHOD("get_packet_channel"), &NetworkedMultiplayerENet::get_packet_channel);
  687. ClassDB::bind_method(D_METHOD("get_last_packet_channel"), &NetworkedMultiplayerENet::get_last_packet_channel);
  688. ClassDB::bind_method(D_METHOD("set_transfer_channel", "channel"), &NetworkedMultiplayerENet::set_transfer_channel);
  689. ClassDB::bind_method(D_METHOD("get_transfer_channel"), &NetworkedMultiplayerENet::get_transfer_channel);
  690. ClassDB::bind_method(D_METHOD("set_channel_count", "channels"), &NetworkedMultiplayerENet::set_channel_count);
  691. ClassDB::bind_method(D_METHOD("get_channel_count"), &NetworkedMultiplayerENet::get_channel_count);
  692. ClassDB::bind_method(D_METHOD("set_always_ordered", "ordered"), &NetworkedMultiplayerENet::set_always_ordered);
  693. ClassDB::bind_method(D_METHOD("is_always_ordered"), &NetworkedMultiplayerENet::is_always_ordered);
  694. ClassDB::bind_method(D_METHOD("set_server_relay_enabled", "enabled"), &NetworkedMultiplayerENet::set_server_relay_enabled);
  695. ClassDB::bind_method(D_METHOD("is_server_relay_enabled"), &NetworkedMultiplayerENet::is_server_relay_enabled);
  696. ADD_PROPERTY(PropertyInfo(Variant::INT, "compression_mode", PROPERTY_HINT_ENUM, "None,Range Coder,FastLZ,ZLib,ZStd"), "set_compression_mode", "get_compression_mode");
  697. ADD_PROPERTY(PropertyInfo(Variant::INT, "transfer_channel"), "set_transfer_channel", "get_transfer_channel");
  698. ADD_PROPERTY(PropertyInfo(Variant::INT, "channel_count"), "set_channel_count", "get_channel_count");
  699. ADD_PROPERTY(PropertyInfo(Variant::BOOL, "always_ordered"), "set_always_ordered", "is_always_ordered");
  700. ADD_PROPERTY(PropertyInfo(Variant::BOOL, "server_relay"), "set_server_relay_enabled", "is_server_relay_enabled");
  701. ADD_PROPERTY(PropertyInfo(Variant::BOOL, "dtls_verify"), "set_dtls_verify_enabled", "is_dtls_verify_enabled");
  702. ADD_PROPERTY(PropertyInfo(Variant::BOOL, "use_dtls"), "set_dtls_enabled", "is_dtls_enabled");
  703. BIND_ENUM_CONSTANT(COMPRESS_NONE);
  704. BIND_ENUM_CONSTANT(COMPRESS_RANGE_CODER);
  705. BIND_ENUM_CONSTANT(COMPRESS_FASTLZ);
  706. BIND_ENUM_CONSTANT(COMPRESS_ZLIB);
  707. BIND_ENUM_CONSTANT(COMPRESS_ZSTD);
  708. }
  709. NetworkedMultiplayerENet::NetworkedMultiplayerENet() {
  710. active = false;
  711. server = false;
  712. refuse_connections = false;
  713. server_relay = true;
  714. unique_id = 0;
  715. target_peer = 0;
  716. current_packet.packet = NULL;
  717. transfer_mode = TRANSFER_MODE_RELIABLE;
  718. channel_count = SYSCH_MAX;
  719. transfer_channel = -1;
  720. always_ordered = false;
  721. connection_status = CONNECTION_DISCONNECTED;
  722. compression_mode = COMPRESS_NONE;
  723. enet_compressor.context = this;
  724. enet_compressor.compress = enet_compress;
  725. enet_compressor.decompress = enet_decompress;
  726. enet_compressor.destroy = enet_compressor_destroy;
  727. bind_ip = IP_Address("*");
  728. dtls_enabled = false;
  729. dtls_verify = true;
  730. }
  731. NetworkedMultiplayerENet::~NetworkedMultiplayerENet() {
  732. if (active) {
  733. close_connection();
  734. }
  735. }
  736. // Sets IP for ENet to bind when using create_server or create_client
  737. // if no IP is set, then ENet bind to ENET_HOST_ANY
  738. void NetworkedMultiplayerENet::set_bind_ip(const IP_Address &p_ip) {
  739. ERR_FAIL_COND_MSG(!p_ip.is_valid() && !p_ip.is_wildcard(), vformat("Invalid bind IP address: %s", String(p_ip)));
  740. bind_ip = p_ip;
  741. }
  742. void NetworkedMultiplayerENet::set_dtls_enabled(bool p_enabled) {
  743. ERR_FAIL_COND(active);
  744. dtls_enabled = p_enabled;
  745. }
  746. bool NetworkedMultiplayerENet::is_dtls_enabled() const {
  747. return dtls_enabled;
  748. }
  749. void NetworkedMultiplayerENet::set_dtls_verify_enabled(bool p_enabled) {
  750. ERR_FAIL_COND(active);
  751. dtls_verify = p_enabled;
  752. }
  753. bool NetworkedMultiplayerENet::is_dtls_verify_enabled() const {
  754. return dtls_verify;
  755. }
  756. void NetworkedMultiplayerENet::set_dtls_key(Ref<CryptoKey> p_key) {
  757. ERR_FAIL_COND(active);
  758. dtls_key = p_key;
  759. }
  760. void NetworkedMultiplayerENet::set_dtls_certificate(Ref<X509Certificate> p_cert) {
  761. ERR_FAIL_COND(active);
  762. dtls_cert = p_cert;
  763. }