networked_multiplayer_enet.cpp 26 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884
  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-2019 Juan Linietsky, Ariel Manzur. */
  9. /* Copyright (c) 2014-2019 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(!active, 1);
  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(!active, -1);
  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(!active, -1);
  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(active, ERR_ALREADY_IN_USE);
  60. ERR_FAIL_COND_V(p_port < 0 || p_port > 65535, ERR_INVALID_PARAMETER);
  61. ERR_FAIL_COND_V(p_max_clients < 0, ERR_INVALID_PARAMETER);
  62. ERR_FAIL_COND_V(p_in_bandwidth < 0, ERR_INVALID_PARAMETER);
  63. ERR_FAIL_COND_V(p_out_bandwidth < 0, ERR_INVALID_PARAMETER);
  64. ENetAddress address;
  65. #ifdef GODOT_ENET
  66. if (bind_ip.is_wildcard()) {
  67. address.wildcard = 1;
  68. } else {
  69. enet_address_set_ip(&address, bind_ip.get_ipv6(), 16);
  70. }
  71. #else
  72. if (bind_ip.is_wildcard()) {
  73. address.host = 0;
  74. } else {
  75. ERR_FAIL_COND_V(!bind_ip.is_ipv4(), ERR_INVALID_PARAMETER);
  76. address.host = *(uint32_t *)bind_ip.get_ipv4();
  77. }
  78. #endif
  79. address.port = p_port;
  80. host = enet_host_create(&address /* the address to bind the server host to */,
  81. p_max_clients /* allow up to 32 clients and/or outgoing connections */,
  82. channel_count /* allow up to channel_count to be used */,
  83. p_in_bandwidth /* limit incoming bandwidth if > 0 */,
  84. p_out_bandwidth /* limit outgoing bandwidth if > 0 */);
  85. ERR_FAIL_COND_V(!host, ERR_CANT_CREATE);
  86. _setup_compressor();
  87. active = true;
  88. server = true;
  89. refuse_connections = false;
  90. unique_id = 1;
  91. connection_status = CONNECTION_CONNECTED;
  92. return OK;
  93. }
  94. Error NetworkedMultiplayerENet::create_client(const String &p_address, int p_port, int p_in_bandwidth, int p_out_bandwidth, int p_client_port) {
  95. ERR_FAIL_COND_V(active, ERR_ALREADY_IN_USE);
  96. ERR_FAIL_COND_V(p_port < 0 || p_port > 65535, ERR_INVALID_PARAMETER);
  97. ERR_FAIL_COND_V(p_client_port < 0 || p_client_port > 65535, ERR_INVALID_PARAMETER);
  98. ERR_FAIL_COND_V(p_in_bandwidth < 0, ERR_INVALID_PARAMETER);
  99. ERR_FAIL_COND_V(p_out_bandwidth < 0, ERR_INVALID_PARAMETER);
  100. if (p_client_port != 0) {
  101. ENetAddress c_client;
  102. #ifdef GODOT_ENET
  103. if (bind_ip.is_wildcard()) {
  104. c_client.wildcard = 1;
  105. } else {
  106. enet_address_set_ip(&c_client, bind_ip.get_ipv6(), 16);
  107. }
  108. #else
  109. if (bind_ip.is_wildcard()) {
  110. c_client.host = 0;
  111. } else {
  112. ERR_FAIL_COND_V(!bind_ip.is_ipv4(), ERR_INVALID_PARAMETER);
  113. c_client.host = *(uint32_t *)bind_ip.get_ipv4();
  114. }
  115. #endif
  116. c_client.port = p_client_port;
  117. host = enet_host_create(&c_client /* create a client host */,
  118. 1 /* only allow 1 outgoing connection */,
  119. channel_count /* allow up to channel_count to be used */,
  120. p_in_bandwidth /* limit incoming bandwidth if > 0 */,
  121. p_out_bandwidth /* limit outgoing bandwidth if > 0 */);
  122. } else {
  123. host = enet_host_create(NULL /* create a client host */,
  124. 1 /* only allow 1 outgoing connection */,
  125. channel_count /* allow up to channel_count to be used */,
  126. p_in_bandwidth /* limit incoming bandwidth if > 0 */,
  127. p_out_bandwidth /* limit outgoing bandwidth if > 0 */);
  128. }
  129. ERR_FAIL_COND_V(!host, ERR_CANT_CREATE);
  130. _setup_compressor();
  131. IP_Address ip;
  132. if (p_address.is_valid_ip_address()) {
  133. ip = p_address;
  134. } else {
  135. #ifdef GODOT_ENET
  136. ip = IP::get_singleton()->resolve_hostname(p_address);
  137. #else
  138. ip = IP::get_singleton()->resolve_hostname(p_address, IP::TYPE_IPV4);
  139. #endif
  140. ERR_FAIL_COND_V(!ip.is_valid(), ERR_CANT_RESOLVE);
  141. }
  142. ENetAddress address;
  143. #ifdef GODOT_ENET
  144. enet_address_set_ip(&address, ip.get_ipv6(), 16);
  145. #else
  146. ERR_FAIL_COND_V(!ip.is_ipv4(), ERR_INVALID_PARAMETER);
  147. address.host = *(uint32_t *)ip.get_ipv4();
  148. #endif
  149. address.port = p_port;
  150. unique_id = _gen_unique_id();
  151. // Initiate connection, allocating enough channels
  152. ENetPeer *peer = enet_host_connect(host, &address, channel_count, unique_id);
  153. if (peer == NULL) {
  154. enet_host_destroy(host);
  155. ERR_FAIL_COND_V(!peer, ERR_CANT_CREATE);
  156. }
  157. // Technically safe to ignore the peer or anything else.
  158. connection_status = CONNECTION_CONNECTING;
  159. active = true;
  160. server = false;
  161. refuse_connections = false;
  162. return OK;
  163. }
  164. void NetworkedMultiplayerENet::poll() {
  165. ERR_FAIL_COND(!active);
  166. _pop_current_packet();
  167. ENetEvent event;
  168. /* Keep servicing until there are no available events left in queue. */
  169. while (true) {
  170. if (!host || !active) // Might have been disconnected while emitting a notification
  171. return;
  172. int ret = enet_host_service(host, &event, 0);
  173. if (ret < 0) {
  174. // Error, do something?
  175. break;
  176. } else if (ret == 0) {
  177. break;
  178. }
  179. switch (event.type) {
  180. case ENET_EVENT_TYPE_CONNECT: {
  181. // Store any relevant client information here.
  182. if (server && refuse_connections) {
  183. enet_peer_reset(event.peer);
  184. break;
  185. }
  186. int *new_id = memnew(int);
  187. *new_id = event.data;
  188. if (*new_id == 0) { // Data zero is sent by server (enet won't let you configure this). Server is always 1.
  189. *new_id = 1;
  190. }
  191. event.peer->data = new_id;
  192. peer_map[*new_id] = event.peer;
  193. connection_status = CONNECTION_CONNECTED; // If connecting, this means it connected to something!
  194. emit_signal("peer_connected", *new_id);
  195. if (server) {
  196. // Someone connected, notify all the peers available
  197. for (Map<int, ENetPeer *>::Element *E = peer_map.front(); E; E = E->next()) {
  198. if (E->key() == *new_id)
  199. continue;
  200. // Send existing peers to new peer
  201. ENetPacket *packet = enet_packet_create(NULL, 8, ENET_PACKET_FLAG_RELIABLE);
  202. encode_uint32(SYSMSG_ADD_PEER, &packet->data[0]);
  203. encode_uint32(E->key(), &packet->data[4]);
  204. enet_peer_send(event.peer, SYSCH_CONFIG, packet);
  205. // Send the new peer to existing peers
  206. packet = enet_packet_create(NULL, 8, ENET_PACKET_FLAG_RELIABLE);
  207. encode_uint32(SYSMSG_ADD_PEER, &packet->data[0]);
  208. encode_uint32(*new_id, &packet->data[4]);
  209. enet_peer_send(E->get(), SYSCH_CONFIG, packet);
  210. }
  211. } else {
  212. emit_signal("connection_succeeded");
  213. }
  214. } break;
  215. case ENET_EVENT_TYPE_DISCONNECT: {
  216. // Reset the peer's client information.
  217. int *id = (int *)event.peer->data;
  218. if (!id) {
  219. if (!server) {
  220. emit_signal("connection_failed");
  221. }
  222. } else {
  223. if (server) {
  224. // Someone disconnected, notify everyone else
  225. for (Map<int, ENetPeer *>::Element *E = peer_map.front(); E; E = E->next()) {
  226. if (E->key() == *id)
  227. continue;
  228. ENetPacket *packet = enet_packet_create(NULL, 8, ENET_PACKET_FLAG_RELIABLE);
  229. encode_uint32(SYSMSG_REMOVE_PEER, &packet->data[0]);
  230. encode_uint32(*id, &packet->data[4]);
  231. enet_peer_send(E->get(), SYSCH_CONFIG, packet);
  232. }
  233. } else {
  234. emit_signal("server_disconnected");
  235. close_connection();
  236. return;
  237. }
  238. emit_signal("peer_disconnected", *id);
  239. peer_map.erase(*id);
  240. memdelete(id);
  241. }
  242. } break;
  243. case ENET_EVENT_TYPE_RECEIVE: {
  244. if (event.channelID == SYSCH_CONFIG) {
  245. // Some config message
  246. ERR_CONTINUE(event.packet->dataLength < 8);
  247. // Only server can send config messages
  248. ERR_CONTINUE(server);
  249. int msg = decode_uint32(&event.packet->data[0]);
  250. int id = decode_uint32(&event.packet->data[4]);
  251. switch (msg) {
  252. case SYSMSG_ADD_PEER: {
  253. peer_map[id] = NULL;
  254. emit_signal("peer_connected", id);
  255. } break;
  256. case SYSMSG_REMOVE_PEER: {
  257. peer_map.erase(id);
  258. emit_signal("peer_disconnected", id);
  259. } break;
  260. }
  261. enet_packet_destroy(event.packet);
  262. } else if (event.channelID < channel_count) {
  263. Packet packet;
  264. packet.packet = event.packet;
  265. uint32_t *id = (uint32_t *)event.peer->data;
  266. ERR_CONTINUE(event.packet->dataLength < 8)
  267. uint32_t source = decode_uint32(&event.packet->data[0]);
  268. int target = decode_uint32(&event.packet->data[4]);
  269. packet.from = source;
  270. packet.channel = event.channelID;
  271. if (server) {
  272. // Someone is cheating and trying to fake the source!
  273. ERR_CONTINUE(source != *id);
  274. packet.from = *id;
  275. if (target == 0) {
  276. // Re-send to everyone but sender :|
  277. incoming_packets.push_back(packet);
  278. // And make copies for sending
  279. for (Map<int, ENetPeer *>::Element *E = peer_map.front(); E; E = E->next()) {
  280. if (uint32_t(E->key()) == source) // Do not resend to self
  281. continue;
  282. ENetPacket *packet2 = enet_packet_create(packet.packet->data, packet.packet->dataLength, packet.packet->flags);
  283. enet_peer_send(E->get(), event.channelID, packet2);
  284. }
  285. } else if (target < 0) {
  286. // To all but one
  287. // And make copies for sending
  288. for (Map<int, ENetPeer *>::Element *E = peer_map.front(); E; E = E->next()) {
  289. if (uint32_t(E->key()) == source || E->key() == -target) // Do not resend to self, also do not send to excluded
  290. continue;
  291. ENetPacket *packet2 = enet_packet_create(packet.packet->data, packet.packet->dataLength, packet.packet->flags);
  292. enet_peer_send(E->get(), event.channelID, packet2);
  293. }
  294. if (-target != 1) {
  295. // Server is not excluded
  296. incoming_packets.push_back(packet);
  297. } else {
  298. // Server is excluded, erase packet
  299. enet_packet_destroy(packet.packet);
  300. }
  301. } else if (target == 1) {
  302. // To myself and only myself
  303. incoming_packets.push_back(packet);
  304. } else {
  305. // To someone else, specifically
  306. ERR_CONTINUE(!peer_map.has(target));
  307. enet_peer_send(peer_map[target], event.channelID, packet.packet);
  308. }
  309. } else {
  310. incoming_packets.push_back(packet);
  311. }
  312. // Destroy packet later
  313. } else {
  314. ERR_CONTINUE(true);
  315. }
  316. } break;
  317. case ENET_EVENT_TYPE_NONE: {
  318. // Do nothing
  319. } break;
  320. }
  321. }
  322. }
  323. bool NetworkedMultiplayerENet::is_server() const {
  324. ERR_FAIL_COND_V(!active, false);
  325. return server;
  326. }
  327. void NetworkedMultiplayerENet::close_connection(uint32_t wait_usec) {
  328. ERR_FAIL_COND(!active);
  329. ERR_FAIL_COND(wait_usec < 0);
  330. _pop_current_packet();
  331. bool peers_disconnected = false;
  332. for (Map<int, ENetPeer *>::Element *E = peer_map.front(); E; E = E->next()) {
  333. if (E->get()) {
  334. enet_peer_disconnect_now(E->get(), unique_id);
  335. peers_disconnected = true;
  336. }
  337. }
  338. if (peers_disconnected) {
  339. enet_host_flush(host);
  340. if (wait_usec > 0) {
  341. OS::get_singleton()->delay_usec(wait_usec); // Wait for disconnection packets to send
  342. }
  343. }
  344. enet_host_destroy(host);
  345. active = false;
  346. incoming_packets.clear();
  347. unique_id = 1; // Server is 1
  348. connection_status = CONNECTION_DISCONNECTED;
  349. }
  350. void NetworkedMultiplayerENet::disconnect_peer(int p_peer, bool now) {
  351. ERR_FAIL_COND(!active);
  352. ERR_FAIL_COND(!is_server());
  353. ERR_FAIL_COND(!peer_map.has(p_peer))
  354. if (now) {
  355. enet_peer_disconnect_now(peer_map[p_peer], 0);
  356. // enet_peer_disconnect_now doesn't generate ENET_EVENT_TYPE_DISCONNECT,
  357. // notify everyone else, send disconnect signal & remove from peer_map like in poll()
  358. for (Map<int, ENetPeer *>::Element *E = peer_map.front(); E; E = E->next()) {
  359. if (E->key() == p_peer)
  360. continue;
  361. ENetPacket *packet = enet_packet_create(NULL, 8, ENET_PACKET_FLAG_RELIABLE);
  362. encode_uint32(SYSMSG_REMOVE_PEER, &packet->data[0]);
  363. encode_uint32(p_peer, &packet->data[4]);
  364. enet_peer_send(E->get(), SYSCH_CONFIG, packet);
  365. }
  366. emit_signal("peer_disconnected", p_peer);
  367. peer_map.erase(p_peer);
  368. } else {
  369. enet_peer_disconnect_later(peer_map[p_peer], 0);
  370. }
  371. }
  372. int NetworkedMultiplayerENet::get_available_packet_count() const {
  373. return incoming_packets.size();
  374. }
  375. Error NetworkedMultiplayerENet::get_packet(const uint8_t **r_buffer, int &r_buffer_size) {
  376. ERR_FAIL_COND_V(incoming_packets.size() == 0, ERR_UNAVAILABLE);
  377. _pop_current_packet();
  378. current_packet = incoming_packets.front()->get();
  379. incoming_packets.pop_front();
  380. *r_buffer = (const uint8_t *)(&current_packet.packet->data[8]);
  381. r_buffer_size = current_packet.packet->dataLength - 8;
  382. return OK;
  383. }
  384. Error NetworkedMultiplayerENet::put_packet(const uint8_t *p_buffer, int p_buffer_size) {
  385. ERR_FAIL_COND_V(!active, ERR_UNCONFIGURED);
  386. ERR_FAIL_COND_V(connection_status != CONNECTION_CONNECTED, ERR_UNCONFIGURED);
  387. int packet_flags = 0;
  388. int channel = SYSCH_RELIABLE;
  389. switch (transfer_mode) {
  390. case TRANSFER_MODE_UNRELIABLE: {
  391. if (always_ordered)
  392. packet_flags = 0;
  393. else
  394. packet_flags = ENET_PACKET_FLAG_UNSEQUENCED;
  395. channel = SYSCH_UNRELIABLE;
  396. } break;
  397. case TRANSFER_MODE_UNRELIABLE_ORDERED: {
  398. packet_flags = 0;
  399. channel = SYSCH_UNRELIABLE;
  400. } break;
  401. case TRANSFER_MODE_RELIABLE: {
  402. packet_flags = ENET_PACKET_FLAG_RELIABLE;
  403. channel = SYSCH_RELIABLE;
  404. } break;
  405. }
  406. if (transfer_channel > SYSCH_CONFIG)
  407. channel = transfer_channel;
  408. Map<int, ENetPeer *>::Element *E = NULL;
  409. if (target_peer != 0) {
  410. E = peer_map.find(ABS(target_peer));
  411. if (!E) {
  412. ERR_EXPLAIN("Invalid Target Peer: " + itos(target_peer));
  413. ERR_FAIL_V(ERR_INVALID_PARAMETER);
  414. }
  415. }
  416. ENetPacket *packet = enet_packet_create(NULL, p_buffer_size + 8, packet_flags);
  417. encode_uint32(unique_id, &packet->data[0]); // Source ID
  418. encode_uint32(target_peer, &packet->data[4]); // Dest ID
  419. copymem(&packet->data[8], p_buffer, p_buffer_size);
  420. if (server) {
  421. if (target_peer == 0) {
  422. enet_host_broadcast(host, channel, packet);
  423. } else if (target_peer < 0) {
  424. // Send to all but one
  425. // and make copies for sending
  426. int exclude = -target_peer;
  427. for (Map<int, ENetPeer *>::Element *F = peer_map.front(); F; F = F->next()) {
  428. if (F->key() == exclude) // Exclude packet
  429. continue;
  430. ENetPacket *packet2 = enet_packet_create(packet->data, packet->dataLength, packet_flags);
  431. enet_peer_send(F->get(), channel, packet2);
  432. }
  433. enet_packet_destroy(packet); // Original packet no longer needed
  434. } else {
  435. enet_peer_send(E->get(), channel, packet);
  436. }
  437. } else {
  438. ERR_FAIL_COND_V(!peer_map.has(1), ERR_BUG);
  439. enet_peer_send(peer_map[1], channel, packet); // Send to server for broadcast
  440. }
  441. enet_host_flush(host);
  442. return OK;
  443. }
  444. int NetworkedMultiplayerENet::get_max_packet_size() const {
  445. return 1 << 24; // Anything is good
  446. }
  447. void NetworkedMultiplayerENet::_pop_current_packet() {
  448. if (current_packet.packet) {
  449. enet_packet_destroy(current_packet.packet);
  450. current_packet.packet = NULL;
  451. current_packet.from = 0;
  452. current_packet.channel = -1;
  453. }
  454. }
  455. NetworkedMultiplayerPeer::ConnectionStatus NetworkedMultiplayerENet::get_connection_status() const {
  456. return connection_status;
  457. }
  458. uint32_t NetworkedMultiplayerENet::_gen_unique_id() const {
  459. uint32_t hash = 0;
  460. while (hash == 0 || hash == 1) {
  461. hash = hash_djb2_one_32(
  462. (uint32_t)OS::get_singleton()->get_ticks_usec());
  463. hash = hash_djb2_one_32(
  464. (uint32_t)OS::get_singleton()->get_unix_time(), hash);
  465. hash = hash_djb2_one_32(
  466. (uint32_t)OS::get_singleton()->get_user_data_dir().hash64(), hash);
  467. hash = hash_djb2_one_32(
  468. (uint32_t)((uint64_t)this), hash); // Rely on ASLR heap
  469. hash = hash_djb2_one_32(
  470. (uint32_t)((uint64_t)&hash), hash); // Rely on ASLR stack
  471. hash = hash & 0x7FFFFFFF; // Make it compatible with unsigned, since negative ID is used for exclusion
  472. }
  473. return hash;
  474. }
  475. int NetworkedMultiplayerENet::get_unique_id() const {
  476. ERR_FAIL_COND_V(!active, 0);
  477. return unique_id;
  478. }
  479. void NetworkedMultiplayerENet::set_refuse_new_connections(bool p_enable) {
  480. refuse_connections = p_enable;
  481. }
  482. bool NetworkedMultiplayerENet::is_refusing_new_connections() const {
  483. return refuse_connections;
  484. }
  485. void NetworkedMultiplayerENet::set_compression_mode(CompressionMode p_mode) {
  486. compression_mode = p_mode;
  487. }
  488. NetworkedMultiplayerENet::CompressionMode NetworkedMultiplayerENet::get_compression_mode() const {
  489. return compression_mode;
  490. }
  491. size_t NetworkedMultiplayerENet::enet_compress(void *context, const ENetBuffer *inBuffers, size_t inBufferCount, size_t inLimit, enet_uint8 *outData, size_t outLimit) {
  492. NetworkedMultiplayerENet *enet = (NetworkedMultiplayerENet *)(context);
  493. if (size_t(enet->src_compressor_mem.size()) < inLimit) {
  494. enet->src_compressor_mem.resize(inLimit);
  495. }
  496. int total = inLimit;
  497. int ofs = 0;
  498. while (total) {
  499. for (size_t i = 0; i < inBufferCount; i++) {
  500. int to_copy = MIN(total, int(inBuffers[i].dataLength));
  501. copymem(&enet->src_compressor_mem.write[ofs], inBuffers[i].data, to_copy);
  502. ofs += to_copy;
  503. total -= to_copy;
  504. }
  505. }
  506. Compression::Mode mode;
  507. switch (enet->compression_mode) {
  508. case COMPRESS_FASTLZ: {
  509. mode = Compression::MODE_FASTLZ;
  510. } break;
  511. case COMPRESS_ZLIB: {
  512. mode = Compression::MODE_DEFLATE;
  513. } break;
  514. case COMPRESS_ZSTD: {
  515. mode = Compression::MODE_ZSTD;
  516. } break;
  517. default: { ERR_FAIL_V(0); }
  518. }
  519. int req_size = Compression::get_max_compressed_buffer_size(ofs, mode);
  520. if (enet->dst_compressor_mem.size() < req_size) {
  521. enet->dst_compressor_mem.resize(req_size);
  522. }
  523. int ret = Compression::compress(enet->dst_compressor_mem.ptrw(), enet->src_compressor_mem.ptr(), ofs, mode);
  524. if (ret < 0)
  525. return 0;
  526. if (ret > int(outLimit))
  527. return 0; // Do not bother
  528. copymem(outData, enet->dst_compressor_mem.ptr(), ret);
  529. return ret;
  530. }
  531. size_t NetworkedMultiplayerENet::enet_decompress(void *context, const enet_uint8 *inData, size_t inLimit, enet_uint8 *outData, size_t outLimit) {
  532. NetworkedMultiplayerENet *enet = (NetworkedMultiplayerENet *)(context);
  533. int ret = -1;
  534. switch (enet->compression_mode) {
  535. case COMPRESS_FASTLZ: {
  536. ret = Compression::decompress(outData, outLimit, inData, inLimit, Compression::MODE_FASTLZ);
  537. } break;
  538. case COMPRESS_ZLIB: {
  539. ret = Compression::decompress(outData, outLimit, inData, inLimit, Compression::MODE_DEFLATE);
  540. } break;
  541. case COMPRESS_ZSTD: {
  542. ret = Compression::decompress(outData, outLimit, inData, inLimit, Compression::MODE_ZSTD);
  543. } break;
  544. default: {}
  545. }
  546. if (ret < 0) {
  547. return 0;
  548. } else {
  549. return ret;
  550. }
  551. }
  552. void NetworkedMultiplayerENet::_setup_compressor() {
  553. switch (compression_mode) {
  554. case COMPRESS_NONE: {
  555. enet_host_compress(host, NULL);
  556. } break;
  557. case COMPRESS_RANGE_CODER: {
  558. enet_host_compress_with_range_coder(host);
  559. } break;
  560. case COMPRESS_FASTLZ:
  561. case COMPRESS_ZLIB:
  562. case COMPRESS_ZSTD: {
  563. enet_host_compress(host, &enet_compressor);
  564. } break;
  565. }
  566. }
  567. void NetworkedMultiplayerENet::enet_compressor_destroy(void *context) {
  568. // Nothing to do
  569. }
  570. IP_Address NetworkedMultiplayerENet::get_peer_address(int p_peer_id) const {
  571. ERR_FAIL_COND_V(!peer_map.has(p_peer_id), IP_Address());
  572. ERR_FAIL_COND_V(!is_server() && p_peer_id != 1, IP_Address());
  573. ERR_FAIL_COND_V(peer_map[p_peer_id] == NULL, IP_Address());
  574. IP_Address out;
  575. #ifdef GODOT_ENET
  576. out.set_ipv6((uint8_t *)&(peer_map[p_peer_id]->address.host));
  577. #else
  578. out.set_ipv4((uint8_t *)&(peer_map[p_peer_id]->address.host));
  579. #endif
  580. return out;
  581. }
  582. int NetworkedMultiplayerENet::get_peer_port(int p_peer_id) const {
  583. ERR_FAIL_COND_V(!peer_map.has(p_peer_id), 0);
  584. ERR_FAIL_COND_V(!is_server() && p_peer_id != 1, 0);
  585. ERR_FAIL_COND_V(peer_map[p_peer_id] == NULL, 0);
  586. #ifdef GODOT_ENET
  587. return peer_map[p_peer_id]->address.port;
  588. #else
  589. return peer_map[p_peer_id]->address.port;
  590. #endif
  591. }
  592. void NetworkedMultiplayerENet::set_transfer_channel(int p_channel) {
  593. ERR_FAIL_COND(p_channel < -1 || p_channel >= channel_count);
  594. if (p_channel == SYSCH_CONFIG) {
  595. ERR_EXPLAIN("Channel " + itos(SYSCH_CONFIG) + " is reserved");
  596. ERR_FAIL();
  597. }
  598. transfer_channel = p_channel;
  599. }
  600. int NetworkedMultiplayerENet::get_transfer_channel() const {
  601. return transfer_channel;
  602. }
  603. void NetworkedMultiplayerENet::set_channel_count(int p_channel) {
  604. ERR_FAIL_COND(active);
  605. ERR_FAIL_COND(p_channel < SYSCH_MAX);
  606. channel_count = p_channel;
  607. }
  608. int NetworkedMultiplayerENet::get_channel_count() const {
  609. return channel_count;
  610. }
  611. void NetworkedMultiplayerENet::set_always_ordered(bool p_ordered) {
  612. always_ordered = p_ordered;
  613. }
  614. bool NetworkedMultiplayerENet::is_always_ordered() const {
  615. return always_ordered;
  616. }
  617. void NetworkedMultiplayerENet::_bind_methods() {
  618. ClassDB::bind_method(D_METHOD("create_server", "port", "max_clients", "in_bandwidth", "out_bandwidth"), &NetworkedMultiplayerENet::create_server, DEFVAL(32), DEFVAL(0), DEFVAL(0));
  619. ClassDB::bind_method(D_METHOD("create_client", "address", "port", "in_bandwidth", "out_bandwidth", "client_port"), &NetworkedMultiplayerENet::create_client, DEFVAL(0), DEFVAL(0), DEFVAL(0));
  620. ClassDB::bind_method(D_METHOD("close_connection", "wait_usec"), &NetworkedMultiplayerENet::close_connection, DEFVAL(100));
  621. ClassDB::bind_method(D_METHOD("disconnect_peer", "id", "now"), &NetworkedMultiplayerENet::disconnect_peer, DEFVAL(false));
  622. ClassDB::bind_method(D_METHOD("set_compression_mode", "mode"), &NetworkedMultiplayerENet::set_compression_mode);
  623. ClassDB::bind_method(D_METHOD("get_compression_mode"), &NetworkedMultiplayerENet::get_compression_mode);
  624. ClassDB::bind_method(D_METHOD("set_bind_ip", "ip"), &NetworkedMultiplayerENet::set_bind_ip);
  625. ClassDB::bind_method(D_METHOD("get_peer_address", "id"), &NetworkedMultiplayerENet::get_peer_address);
  626. ClassDB::bind_method(D_METHOD("get_peer_port", "id"), &NetworkedMultiplayerENet::get_peer_port);
  627. ClassDB::bind_method(D_METHOD("get_packet_channel"), &NetworkedMultiplayerENet::get_packet_channel);
  628. ClassDB::bind_method(D_METHOD("get_last_packet_channel"), &NetworkedMultiplayerENet::get_last_packet_channel);
  629. ClassDB::bind_method(D_METHOD("set_transfer_channel", "channel"), &NetworkedMultiplayerENet::set_transfer_channel);
  630. ClassDB::bind_method(D_METHOD("get_transfer_channel"), &NetworkedMultiplayerENet::get_transfer_channel);
  631. ClassDB::bind_method(D_METHOD("set_channel_count", "channels"), &NetworkedMultiplayerENet::set_channel_count);
  632. ClassDB::bind_method(D_METHOD("get_channel_count"), &NetworkedMultiplayerENet::get_channel_count);
  633. ClassDB::bind_method(D_METHOD("set_always_ordered", "ordered"), &NetworkedMultiplayerENet::set_always_ordered);
  634. ClassDB::bind_method(D_METHOD("is_always_ordered"), &NetworkedMultiplayerENet::is_always_ordered);
  635. ADD_PROPERTY(PropertyInfo(Variant::INT, "compression_mode", PROPERTY_HINT_ENUM, "None,Range Coder,FastLZ,ZLib,ZStd"), "set_compression_mode", "get_compression_mode");
  636. ADD_PROPERTY(PropertyInfo(Variant::INT, "transfer_channel"), "set_transfer_channel", "get_transfer_channel");
  637. ADD_PROPERTY(PropertyInfo(Variant::INT, "channel_count"), "set_channel_count", "get_channel_count");
  638. ADD_PROPERTY(PropertyInfo(Variant::BOOL, "always_ordered"), "set_always_ordered", "is_always_ordered");
  639. BIND_ENUM_CONSTANT(COMPRESS_NONE);
  640. BIND_ENUM_CONSTANT(COMPRESS_RANGE_CODER);
  641. BIND_ENUM_CONSTANT(COMPRESS_FASTLZ);
  642. BIND_ENUM_CONSTANT(COMPRESS_ZLIB);
  643. BIND_ENUM_CONSTANT(COMPRESS_ZSTD);
  644. }
  645. NetworkedMultiplayerENet::NetworkedMultiplayerENet() {
  646. active = false;
  647. server = false;
  648. refuse_connections = false;
  649. unique_id = 0;
  650. target_peer = 0;
  651. current_packet.packet = NULL;
  652. transfer_mode = TRANSFER_MODE_RELIABLE;
  653. channel_count = SYSCH_MAX;
  654. transfer_channel = -1;
  655. always_ordered = false;
  656. connection_status = CONNECTION_DISCONNECTED;
  657. compression_mode = COMPRESS_NONE;
  658. enet_compressor.context = this;
  659. enet_compressor.compress = enet_compress;
  660. enet_compressor.decompress = enet_decompress;
  661. enet_compressor.destroy = enet_compressor_destroy;
  662. bind_ip = IP_Address("*");
  663. }
  664. NetworkedMultiplayerENet::~NetworkedMultiplayerENet() {
  665. close_connection();
  666. }
  667. // Sets IP for ENet to bind when using create_server or create_client
  668. // if no IP is set, then ENet bind to ENET_HOST_ANY
  669. void NetworkedMultiplayerENet::set_bind_ip(const IP_Address &p_ip) {
  670. ERR_FAIL_COND(!p_ip.is_valid() && !p_ip.is_wildcard());
  671. bind_ip = p_ip;
  672. }