circuitpython/ports/esp32s2/common-hal/socketpool/Socket.c

310 lines
11 KiB
C
Raw Normal View History

2020-08-11 19:04:55 -04:00
/*
* This file is part of the MicroPython project, http://micropython.org/
*
* The MIT License (MIT)
*
* Copyright (c) 2020 Scott Shawcroft for Adafruit Industries
2020-12-14 12:57:39 -05:00
* Copyright (c) 2020 Lucian Copeland for Adafruit Industries
2020-08-11 19:04:55 -04:00
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in
* all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
* THE SOFTWARE.
*/
2020-08-12 19:57:39 -04:00
#include "shared-bindings/socketpool/Socket.h"
2020-08-21 16:32:59 -04:00
#include "bindings/espidf/__init__.h"
2020-08-19 20:51:33 -04:00
#include "lib/utils/interrupt_char.h"
2020-08-18 20:06:59 -04:00
#include "py/mperrno.h"
#include "py/runtime.h"
2020-08-19 20:51:33 -04:00
#include "supervisor/shared/tick.h"
#include "components/lwip/lwip/src/include/lwip/err.h"
#include "components/lwip/lwip/src/include/lwip/sockets.h"
#include "components/lwip/lwip/src/include/lwip/sys.h"
#include "components/lwip/lwip/src/include/lwip/netdb.h"
2020-12-14 12:57:39 -05:00
STATIC void _lazy_init_LWIP(socketpool_socket_obj_t* self) {
if (self->num != -1) {
return; //safe to call on existing socket
}
if (self->tls != NULL) {
mp_raise_RuntimeError(translate("Invalid use of TLS Socket"));
}
int socknum = -1;
socknum = lwip_socket(self->family, self->type, self->ipproto);
if (socknum < 0) {
mp_raise_RuntimeError(translate("Out of sockets"));
}
self->num = socknum;
2021-01-12 15:05:28 -05:00
lwip_fcntl(socknum, F_SETFL, O_NONBLOCK);
2020-12-14 12:57:39 -05:00
}
STATIC void _lazy_init_TLS(socketpool_socket_obj_t* self) {
if (self->type != SOCK_STREAM || self->num != -1) {
mp_raise_RuntimeError(translate("Invalid socket for TLS"));
}
esp_tls_t* tls_handle = esp_tls_init();
if (tls_handle == NULL) {
mp_raise_espidf_MemoryError();
}
self->tls = tls_handle;
}
2020-08-12 19:57:39 -04:00
void common_hal_socketpool_socket_settimeout(socketpool_socket_obj_t* self, mp_uint_t timeout_ms) {
self->timeout_ms = timeout_ms;
}
2020-12-14 12:57:39 -05:00
bool common_hal_socketpool_socket_bind(socketpool_socket_obj_t* self,
const char* host, size_t hostlen, uint8_t port) {
_lazy_init_LWIP(self);
struct sockaddr_in bind_addr;
bind_addr.sin_addr.s_addr = inet_addr(host);
bind_addr.sin_family = AF_INET;
bind_addr.sin_port = htons(port);
return lwip_bind(self->num, (struct sockaddr *)&bind_addr, sizeof(bind_addr)) == 0;
}
bool common_hal_socketpool_socket_listen(socketpool_socket_obj_t* self, int backlog) {
return lwip_listen(self->num, backlog) == 0;
}
int common_hal_socketpool_socket_accept(socketpool_socket_obj_t* self,
uint8_t* ip, uint *port) {
struct sockaddr_in accept_addr;
socklen_t socklen = sizeof(accept_addr);
2021-01-12 15:05:28 -05:00
int newsoc = -1;
//(self->timeout_ms == 0 || supervisor_ticks_ms64() - start_ticks <= self->timeout_ms)
while ((newsoc == -1) && !mp_hal_is_interrupted() ) {
RUN_BACKGROUND_TASKS;
newsoc = lwip_accept(self->num, (struct sockaddr *)&accept_addr, &socklen);
}
mp_printf(&mp_plat_print, "oldsoc:%d newsoc:%d\n",self->num, newsoc);
2020-12-14 12:57:39 -05:00
memcpy((void *)ip, (void*)&accept_addr.sin_addr.s_addr, sizeof(accept_addr.sin_addr.s_addr));
*port = accept_addr.sin_port;
if (newsoc > 0) {
2021-01-12 15:05:28 -05:00
lwip_fcntl(newsoc, F_SETFL, O_NONBLOCK);
2020-12-14 12:57:39 -05:00
return newsoc;
} else {
return 0;
}
}
bool common_hal_socketpool_socket_connect(socketpool_socket_obj_t* self,
const char* host, mp_uint_t hostlen, mp_int_t port) {
2020-08-12 19:57:39 -04:00
// For simplicity we use esp_tls for all TCP connections. If it's not SSL, ssl_context will be
// NULL and should still work. This makes regular TCP connections more memory expensive but TLS
// should become more and more common. Therefore, we optimize for the TLS case.
2020-12-14 12:57:39 -05:00
// Todo: move to SSL Wrapper and add lwip_connect()
_lazy_init_TLS(self);
2020-08-13 19:55:49 -04:00
esp_tls_cfg_t* tls_config = NULL;
if (self->ssl_context != NULL) {
tls_config = &self->ssl_context->ssl_config;
}
2020-12-14 12:57:39 -05:00
int result = esp_tls_conn_new_sync(host, hostlen, port, tls_config, self->tls);
2020-08-18 20:06:59 -04:00
self->connected = result >= 0;
if (result < 0) {
int esp_tls_code;
2020-08-19 20:51:33 -04:00
int flags;
2020-12-14 12:57:39 -05:00
esp_err_t err = esp_tls_get_and_clear_last_error(self->tls->error_handle, &esp_tls_code, &flags);
2020-08-18 20:06:59 -04:00
2020-08-21 14:00:02 -04:00
if (err == ESP_ERR_MBEDTLS_SSL_SETUP_FAILED) {
mp_raise_espidf_MemoryError();
} else if (ESP_ERR_MBEDTLS_SSL_HANDSHAKE_FAILED) {
mp_raise_OSError_msg_varg(translate("Failed SSL handshake"));
2020-08-21 14:00:02 -04:00
} else {
mp_raise_OSError_msg_varg(translate("Unhandled ESP TLS error %d %d %x %d"), esp_tls_code, flags, err, result);
2020-08-21 14:00:02 -04:00
}
} else {
// Connection successful, set the timeout on the underlying socket. We can't rely on the IDF
// to do it because the config structure is only used for TLS connections. Generally, we
// shouldn't hit this timeout because we try to only read available data. However, there is
// always a chance that we try to read something that is used internally.
int fd;
2020-12-14 12:57:39 -05:00
esp_tls_get_conn_sockfd(self->tls, &fd);
struct timeval tv;
tv.tv_sec = 2 * 60; // Two minutes
tv.tv_usec = 0;
setsockopt(fd, SOL_SOCKET, SO_RCVTIMEO, &tv, sizeof(tv));
setsockopt(fd, SOL_SOCKET, SO_SNDTIMEO, &tv, sizeof(tv));
2020-08-18 20:06:59 -04:00
}
2020-08-21 14:00:02 -04:00
2020-08-18 20:06:59 -04:00
return self->connected;
}
bool common_hal_socketpool_socket_get_connected(socketpool_socket_obj_t* self) {
return self->connected;
2020-08-12 19:57:39 -04:00
}
mp_uint_t common_hal_socketpool_socket_send(socketpool_socket_obj_t* self, const uint8_t* buf, mp_uint_t len) {
2020-12-14 12:57:39 -05:00
size_t sent = -1;
if (self->num != -1) {
// LWIP Socket
sent = lwip_send(self->num, buf, len, 0);
} else if (self->tls != NULL) {
// TLS Socket
sent = esp_tls_conn_write(self->tls, buf, len);
}
2020-08-12 19:57:39 -04:00
if (sent < 0) {
2020-08-18 20:06:59 -04:00
mp_raise_OSError(MP_ENOTCONN);
2020-08-12 19:57:39 -04:00
}
return sent;
}
mp_uint_t common_hal_socketpool_socket_recv_into(socketpool_socket_obj_t* self, const uint8_t* buf, mp_uint_t len) {
2020-08-19 20:51:33 -04:00
size_t received = 0;
2020-12-14 12:57:39 -05:00
if (self->num != -1) {
// LWIP Socket
2021-01-12 15:05:28 -05:00
mp_printf(&mp_plat_print, "lwip_recv:\n");
2020-12-14 12:57:39 -05:00
received = lwip_recv(self->num, (void*) buf, len - 1, 0);
2021-01-12 15:05:28 -05:00
mp_printf(&mp_plat_print, "received:%d\n",received);
2020-12-14 12:57:39 -05:00
} else if (self->tls != NULL) {
// TLS Socket
int status = 0;
uint64_t start_ticks = supervisor_ticks_ms64();
int sockfd;
esp_err_t err = esp_tls_get_conn_sockfd(self->tls, &sockfd);
if (err != ESP_OK) {
mp_raise_OSError(MP_EBADF);
2020-08-19 20:51:33 -04:00
}
2020-12-14 12:57:39 -05:00
while (received == 0 &&
status >= 0 &&
(self->timeout_ms == 0 || supervisor_ticks_ms64() - start_ticks <= self->timeout_ms) &&
!mp_hal_is_interrupted()) {
RUN_BACKGROUND_TASKS;
size_t available = esp_tls_get_bytes_avail(self->tls);
if (available == 0) {
// This reads the raw socket buffer and is used for non-TLS connections
// and between encrypted TLS blocks.
status = lwip_ioctl(sockfd, FIONREAD, &available);
}
2020-12-14 12:57:39 -05:00
size_t remaining = len - received;
if (available > remaining) {
available = remaining;
}
if (available > 0) {
status = esp_tls_conn_read(self->tls, (void*) buf + received, available);
if (status == 0) {
// Reading zero when something is available indicates a closed
// connection. (The available bytes could have been TLS internal.)
break;
}
if (status > 0) {
received += status;
}
}
2020-08-19 20:51:33 -04:00
}
}
2020-08-12 19:57:39 -04:00
if (received == 0) {
2020-08-12 19:57:39 -04:00
// socket closed
2020-12-21 13:04:52 -05:00
mp_raise_OSError(0);
2020-08-12 19:57:39 -04:00
}
return received;
}
2020-10-28 21:08:31 -04:00
mp_uint_t common_hal_socketpool_socket_sendto(socketpool_socket_obj_t* self,
const char* host, size_t hostlen, uint8_t port, const uint8_t* buf, mp_uint_t len) {
2020-12-14 12:57:39 -05:00
_lazy_init_LWIP(self);
// Get the IP address string
2020-10-28 21:08:31 -04:00
const struct addrinfo hints = {
.ai_family = AF_INET,
.ai_socktype = SOCK_STREAM,
};
struct addrinfo *result;
int error = lwip_getaddrinfo(host, NULL, &hints, &result);
if (error != 0 || result == NULL) {
return 0;
2020-10-28 21:08:31 -04:00
}
2020-12-14 12:57:39 -05:00
// Set parameters
struct sockaddr_in dest_addr;
2020-10-28 21:08:31 -04:00
#pragma GCC diagnostic push
#pragma GCC diagnostic ignored "-Wcast-align"
2020-12-14 12:57:39 -05:00
dest_addr.sin_addr.s_addr = ((struct sockaddr_in *)result->ai_addr)->sin_addr.s_addr;
2020-10-28 21:08:31 -04:00
#pragma GCC diagnostic pop
freeaddrinfo(result);
2020-10-28 21:08:31 -04:00
dest_addr.sin_family = AF_INET;
dest_addr.sin_port = htons(port);
2020-10-28 21:08:31 -04:00
int bytes_sent = lwip_sendto(self->num, buf, len, 0, (struct sockaddr *)&dest_addr, sizeof(dest_addr));
if (bytes_sent < 0) {
mp_raise_BrokenPipeError();
return 0;
}
return bytes_sent;
2020-10-28 21:08:31 -04:00
}
mp_uint_t common_hal_socketpool_socket_recvfrom_into(socketpool_socket_obj_t* self,
uint8_t* buf, mp_uint_t len, uint8_t* ip, uint *port) {
2020-10-28 21:08:31 -04:00
2020-12-14 12:57:39 -05:00
_lazy_init_LWIP(self);
struct sockaddr_in source_addr;
socklen_t socklen = sizeof(source_addr);
2021-01-12 15:05:28 -05:00
mp_printf(&mp_plat_print, "recvfrom_into\n");
int bytes_received = lwip_recvfrom(self->num, buf, len - 1, 0, (struct sockaddr *)&source_addr, &socklen);
2021-01-12 15:05:28 -05:00
mp_printf(&mp_plat_print, "received:%d\n",bytes_received);
2020-10-28 21:08:31 -04:00
2020-12-14 12:57:39 -05:00
memcpy((void *)ip, (void*)&source_addr.sin_addr.s_addr, sizeof(source_addr.sin_addr.s_addr));
*port = source_addr.sin_port;
if (bytes_received < 0) {
mp_raise_BrokenPipeError();
return 0;
} else {
buf[bytes_received] = 0; // Null-terminate whatever we received
return bytes_received;
}
2020-10-28 21:08:31 -04:00
}
2020-08-12 19:57:39 -04:00
void common_hal_socketpool_socket_close(socketpool_socket_obj_t* self) {
2020-09-03 19:32:12 -04:00
self->connected = false;
2020-12-14 12:57:39 -05:00
if (self->tls != NULL) {
esp_tls_conn_destroy(self->tls);
self->tls = NULL;
2020-08-12 19:57:39 -04:00
}
2020-10-28 21:08:31 -04:00
if (self->num >= 0) {
lwip_shutdown(self->num, 0);
lwip_close(self->num);
2020-11-24 14:51:06 -05:00
self->num = -1;
2020-10-28 21:08:31 -04:00
}
2020-08-12 19:57:39 -04:00
}
2020-08-18 20:06:59 -04:00
bool common_hal_socketpool_socket_get_closed(socketpool_socket_obj_t* self) {
2020-12-14 12:57:39 -05:00
return self->tls == NULL && self->num < 0;
2020-08-18 20:06:59 -04:00
}
mp_uint_t common_hal_socketpool_socket_get_hash(socketpool_socket_obj_t* self) {
return self->num;
}