feedc0de/esp-idf
1
0
Fork 0
forked from espressif/esp-idf
Code Pull Requests Activity

Merge branch 'feature/ws_trans_buf_cfg' into 'master'

Browse Source 
websocket: add configurable ws_transport buffer size

Closes IDFGH-3566

See merge request espressif/esp-idf!9415
This commit is contained in:
David Čermák
2020-07-20 22:39:21 +08:00
parent 789e99a37d a392e4e57b
commit 84051f82c8
2 changed files with 38 additions and 29 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
components/tcp_transport/Kconfig Normal file
View File

@@ -0,0 +1,9 @@
menu "TCP Transport"
config WS_BUFFER_SIZE
int "Websocket transport buffer size"
default 1024
help
Size of the buffer used for constructing the HTTP Upgrade request during connect
endmenu

58
components/tcp_transport/transport_ws.c
View File

@@ -12,21 +12,21 @@
static const char *TAG = "TRANSPORT_WS"; static const char *TAG = "TRANSPORT_WS";
#define DEFAULT_WS_BUFFER (1024) #define WS_BUFFER_SIZE CONFIG_WS_BUFFER_SIZE
#define WS_FIN 0x80 #define WS_FIN 0x80
#define WS_OPCODE_CONT 0x00 #define WS_OPCODE_CONT 0x00
#define WS_OPCODE_TEXT 0x01 #define WS_OPCODE_TEXT 0x01
#define WS_OPCODE_BINARY 0x02 #define WS_OPCODE_BINARY 0x02
#define WS_OPCODE_CLOSE 0x08 #define WS_OPCODE_CLOSE 0x08
#define WS_OPCODE_PING 0x09 #define WS_OPCODE_PING 0x09
#define WS_OPCODE_PONG 0x0a #define WS_OPCODE_PONG 0x0a
// Second byte // Second byte
#define WS_MASK 0x80 #define WS_MASK 0x80
#define WS_SIZE16 126 #define WS_SIZE16 126
#define WS_SIZE64 127 #define WS_SIZE64 127
#define MAX_WEBSOCKET_HEADER_SIZE 16 #define MAX_WEBSOCKET_HEADER_SIZE 16
#define WS_RESPONSE_OK 101 #define WS_RESPONSE_OK 101
typedef struct { typedef struct {
@@ -116,7 +116,7 @@ static int ws_connect(esp_transport_handle_t t, const char *host, int port, int
size_t outlen = 0; size_t outlen = 0;
mbedtls_base64_encode(client_key, sizeof(client_key), &outlen, random_key, sizeof(random_key)); mbedtls_base64_encode(client_key, sizeof(client_key), &outlen, random_key, sizeof(random_key));
int len = snprintf(ws->buffer, DEFAULT_WS_BUFFER, int len = snprintf(ws->buffer, WS_BUFFER_SIZE,
"GET %s HTTP/1.1\r\n" "GET %s HTTP/1.1\r\n"
"Connection: Upgrade\r\n" "Connection: Upgrade\r\n"
"Host: %s:%d\r\n" "Host: %s:%d\r\n"
@@ -127,52 +127,52 @@ static int ws_connect(esp_transport_handle_t t, const char *host, int port, int
ws->path, ws->path,
host, port, user_agent_ptr, host, port, user_agent_ptr,
client_key); client_key);
if (len <= 0 || len >= DEFAULT_WS_BUFFER) { if (len <= 0 || len >= WS_BUFFER_SIZE) {
ESP_LOGE(TAG, "Error in request generation, %d", len); ESP_LOGE(TAG, "Error in request generation, desired request len: %d, buffer size: %d", len, WS_BUFFER_SIZE);
return -1; return -1;
} }
if (ws->sub_protocol) { if (ws->sub_protocol) {
ESP_LOGD(TAG, "sub_protocol: %s", ws->sub_protocol); ESP_LOGD(TAG, "sub_protocol: %s", ws->sub_protocol);
int r = snprintf(ws->buffer + len, DEFAULT_WS_BUFFER - len, "Sec-WebSocket-Protocol: %s\r\n", ws->sub_protocol); int r = snprintf(ws->buffer + len, WS_BUFFER_SIZE - len, "Sec-WebSocket-Protocol: %s\r\n", ws->sub_protocol);
len += r; len += r;
if (r <= 0 || len >= DEFAULT_WS_BUFFER) { if (r <= 0 || len >= WS_BUFFER_SIZE) {
ESP_LOGE(TAG, "Error in request generation" ESP_LOGE(TAG, "Error in request generation"
"(snprintf of subprotocol returned %d, desired request len: %d, buffer size: %d", r, len, DEFAULT_WS_BUFFER); "(snprintf of subprotocol returned %d, desired request len: %d, buffer size: %d", r, len, WS_BUFFER_SIZE);
return -1; return -1;
} }
} }
if (ws->headers) { if (ws->headers) {
ESP_LOGD(TAG, "headers: %s", ws->headers); ESP_LOGD(TAG, "headers: %s", ws->headers);
int r = snprintf(ws->buffer + len, DEFAULT_WS_BUFFER - len, "%s", ws->headers); int r = snprintf(ws->buffer + len, WS_BUFFER_SIZE - len, "%s", ws->headers);
len += r; len += r;
if (r <= 0 || len >= DEFAULT_WS_BUFFER) { if (r <= 0 || len >= WS_BUFFER_SIZE) {
ESP_LOGE(TAG, "Error in request generation" ESP_LOGE(TAG, "Error in request generation"
"(strncpy of headers returned %d, desired request len: %d, buffer size: %d", r, len, DEFAULT_WS_BUFFER); "(strncpy of headers returned %d, desired request len: %d, buffer size: %d", r, len, WS_BUFFER_SIZE);
return -1; return -1;
} }
} }
int r = snprintf(ws->buffer + len, DEFAULT_WS_BUFFER - len, "\r\n"); int r = snprintf(ws->buffer + len, WS_BUFFER_SIZE - len, "\r\n");
len += r; len += r;
if (r <= 0 || len >= DEFAULT_WS_BUFFER) { if (r <= 0 || len >= WS_BUFFER_SIZE) {
ESP_LOGE(TAG, "Error in request generation" ESP_LOGE(TAG, "Error in request generation"
"(snprintf of header terminal returned %d, desired request len: %d, buffer size: %d", r, len, DEFAULT_WS_BUFFER); "(snprintf of header terminal returned %d, desired request len: %d, buffer size: %d", r, len, WS_BUFFER_SIZE);
return -1; return -1;
} }
ESP_LOGD(TAG, "Write upgrate request\r\n%s", ws->buffer); ESP_LOGD(TAG, "Write upgrade request\r\n%s", ws->buffer);
if (esp_transport_write(ws->parent, ws->buffer, len, timeout_ms) <= 0) { if (esp_transport_write(ws->parent, ws->buffer, len, timeout_ms) <= 0) {
ESP_LOGE(TAG, "Error write Upgrade header %s", ws->buffer); ESP_LOGE(TAG, "Error write Upgrade header %s", ws->buffer);
return -1; return -1;
} }
int header_len = 0; int header_len = 0;
do { do {
if ((len = esp_transport_read(ws->parent, ws->buffer + header_len, DEFAULT_WS_BUFFER - header_len, timeout_ms)) <= 0) { if ((len = esp_transport_read(ws->parent, ws->buffer + header_len, WS_BUFFER_SIZE - header_len, timeout_ms)) <= 0) {
ESP_LOGE(TAG, "Error read response for Upgrade header %s", ws->buffer); ESP_LOGE(TAG, "Error read response for Upgrade header %s", ws->buffer);
return -1; return -1;
} }
header_len += len; header_len += len;
ws->buffer[header_len] = '\0'; ws->buffer[header_len] = '\0';
ESP_LOGD(TAG, "Read header chunk %d, current header size: %d", len, header_len); ESP_LOGD(TAG, "Read header chunk %d, current header size: %d", len, header_len);
} while (NULL == strstr(ws->buffer, "\r\n\r\n") && header_len < DEFAULT_WS_BUFFER); } while (NULL == strstr(ws->buffer, "\r\n\r\n") && header_len < WS_BUFFER_SIZE);
char *server_key = get_http_header(ws->buffer, "Sec-WebSocket-Accept:"); char *server_key = get_http_header(ws->buffer, "Sec-WebSocket-Accept:");
if (server_key == NULL) { if (server_key == NULL) {
@@ -461,7 +461,7 @@ esp_transport_handle_t esp_transport_ws_init(esp_transport_handle_t parent_handl
free(ws); free(ws);
return NULL; return NULL;
}); });
ws->buffer = malloc(DEFAULT_WS_BUFFER); ws->buffer = malloc(WS_BUFFER_SIZE);
ESP_TRANSPORT_MEM_CHECK(TAG, ws->buffer, { ESP_TRANSPORT_MEM_CHECK(TAG, ws->buffer, {
free(ws->path); free(ws->path);
free(ws); free(ws);