Skip to content

Commit

Permalink
Clean up the code for timeout
Browse files Browse the repository at this point in the history
Rename UART_TCP_CLIENT_RX_TIMEOUT_MS to UART_NET_CLIENT_RX_TIMEOUT_MS
Add UART_UDP_LOCAL_CLIENT_RX_TIMEOUT_MS for shorter timeout
Check if the target address is local in uart_open()
  • Loading branch information
wh201906 committed Oct 25, 2023
1 parent 0e203fb commit de7b6f3
Show file tree
Hide file tree
Showing 5 changed files with 47 additions and 20 deletions.
18 changes: 7 additions & 11 deletions client/src/comms.c
Original file line number Diff line number Diff line change
Expand Up @@ -666,9 +666,9 @@ int TestProxmark(pm3_device_t *dev) {
g_conn.send_via_fpc_usart = g_pm3_capabilities.via_fpc;
g_conn.uart_speed = g_pm3_capabilities.baudrate;

bool is_tcp_conn = (memcmp(g_conn.serial_port_name, "tcp:", 4) == 0);
bool is_tcp_conn = (g_conn.send_via_ip == PM3_TCPv4 || g_conn.send_via_ip == PM3_TCPv6);
bool is_bt_conn = (memcmp(g_conn.serial_port_name, "bt:", 3) == 0);
bool is_udp_conn = (memcmp(g_conn.serial_port_name, "udp:", 4) == 0);
bool is_udp_conn = (g_conn.send_via_ip == PM3_UDPv4 || g_conn.send_via_ip == PM3_UDPv6);

PrintAndLogEx(INFO, "Communicating with PM3 over %s%s%s%s",
(g_conn.send_via_fpc_usart) ? _YELLOW_("FPC UART") : _YELLOW_("USB-CDC"),
Expand All @@ -680,15 +680,11 @@ int TestProxmark(pm3_device_t *dev) {
PrintAndLogEx(INFO, "PM3 UART serial baudrate: " _YELLOW_("%u") "\n", g_conn.uart_speed);
} else {
int res;
if (is_tcp_conn || is_udp_conn) {
if ((strstr(g_conn.serial_port_name, "localhost") != NULL) ||
(strstr(g_conn.serial_port_name, "127.0.0.1") != NULL) ||
(strstr(g_conn.serial_port_name, "[::1]") != NULL) ||
(strstr(g_conn.serial_port_name, "p:::1") != NULL)) {
res = uart_reconfigure_timeouts(UART_TCP_CLIENT_LOCAL_RX_TIMEOUT_MS);
} else {
res = uart_reconfigure_timeouts(UART_TCP_CLIENT_RX_TIMEOUT_MS);
}
if (g_conn.send_via_local_ip) {
// (g_conn.send_via_local_ip == true) -> ((is_tcp_conn || is_udp_conn) == true)
res = uart_reconfigure_timeouts(is_tcp_conn ? UART_TCP_LOCAL_CLIENT_RX_TIMEOUT_MS : UART_UDP_LOCAL_CLIENT_RX_TIMEOUT_MS);
} else if (is_tcp_conn || is_udp_conn) {
res = uart_reconfigure_timeouts(UART_NET_CLIENT_RX_TIMEOUT_MS);
} else {
res = uart_reconfigure_timeouts(UART_USB_CLIENT_RX_TIMEOUT_MS);
}
Expand Down
4 changes: 3 additions & 1 deletion client/src/comms.h
Original file line number Diff line number Diff line change
Expand Up @@ -70,8 +70,10 @@ typedef struct {
bool send_with_crc_on_fpc;
// "Session" flag, to tell via which interface next msgs are sent: USB or FPC USART
bool send_via_fpc_usart;
// to tell if we are using TCP/UDP/TCPv6
// to tell if we are using TCP/UDP/TCP(IPv6)/UDP(IPv6)
CommunicationProtocol_t send_via_ip;
// to tell if the target address is local address(127.0.0.1/localhost/::1)
bool send_via_local_ip;
// To memorise baudrate
uint32_t uart_speed;
uint16_t last_command;
Expand Down
20 changes: 17 additions & 3 deletions client/src/uart/uart_posix.c
Original file line number Diff line number Diff line change
Expand Up @@ -91,6 +91,8 @@ serial_port uart_open(const char *pcPortName, uint32_t speed) {
sp->udpBuffer = NULL;
// init timeouts
timeout.tv_usec = UART_FPC_CLIENT_RX_TIMEOUT_MS * 1000;
g_conn.send_via_local_ip = false;
g_conn.send_via_ip = PM3_NONE;

char *prefix = strdup(pcPortName);
if (prefix == NULL) {
Expand Down Expand Up @@ -119,7 +121,7 @@ serial_port uart_open(const char *pcPortName, uint32_t speed) {
return INVALID_SERIAL_PORT;
}

timeout.tv_usec = UART_TCP_CLIENT_RX_TIMEOUT_MS * 1000;
timeout.tv_usec = UART_NET_CLIENT_RX_TIMEOUT_MS * 1000;

// find the "bind" option
char *bindAddrPortStr = strstr(addrPortStr, ",bind=");
Expand Down Expand Up @@ -233,6 +235,12 @@ serial_port uart_open(const char *pcPortName, uint32_t speed) {
info.ai_family = PF_UNSPEC;
info.ai_socktype = SOCK_STREAM;

if ((strstr(addrstr, "localhost") != NULL) ||
(strstr(addrstr, "127.0.0.1") != NULL) ||
(strstr(addrstr, "::1") != NULL)) {
g_conn.send_via_local_ip = true;
}

int s = getaddrinfo(addrstr, portstr, &info, &addr);
if (s != 0) {
PrintAndLogEx(ERR, "error: getaddrinfo: %s", gai_strerror(s));
Expand Down Expand Up @@ -304,7 +312,7 @@ serial_port uart_open(const char *pcPortName, uint32_t speed) {
return INVALID_SERIAL_PORT;
}

timeout.tv_usec = UART_TCP_CLIENT_RX_TIMEOUT_MS * 1000;
timeout.tv_usec = UART_NET_CLIENT_RX_TIMEOUT_MS * 1000;

// find the "bind" option
char *bindAddrPortStr = strstr(addrPortStr, ",bind=");
Expand Down Expand Up @@ -417,6 +425,12 @@ serial_port uart_open(const char *pcPortName, uint32_t speed) {
info.ai_family = PF_UNSPEC;
info.ai_socktype = SOCK_DGRAM;

if ((strstr(addrstr, "localhost") != NULL) ||
(strstr(addrstr, "127.0.0.1") != NULL) ||
(strstr(addrstr, "::1") != NULL)) {
g_conn.send_via_local_ip = true;
}

int s = getaddrinfo(addrstr, portstr, &info, &addr);
if (s != 0) {
PrintAndLogEx(ERR, "error: getaddrinfo: %s", gai_strerror(s));
Expand Down Expand Up @@ -528,7 +542,7 @@ serial_port uart_open(const char *pcPortName, uint32_t speed) {
}

// we must use max timeout!
timeout.tv_usec = UART_TCP_CLIENT_RX_TIMEOUT_MS * 1000;
timeout.tv_usec = UART_NET_CLIENT_RX_TIMEOUT_MS * 1000;

size_t servernameLen = (strlen(pcPortName) - 7) + 1;
char serverNameBuf[servernameLen];
Expand Down
20 changes: 17 additions & 3 deletions client/src/uart/uart_win32.c
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ typedef struct {
// this is for TCP connection
struct timeval timeout = {
.tv_sec = 0, // 0 second
.tv_usec = UART_TCP_CLIENT_RX_TIMEOUT_MS * 1000
.tv_usec = UART_NET_CLIENT_RX_TIMEOUT_MS * 1000
};

uint32_t newtimeout_value = 0;
Expand Down Expand Up @@ -92,6 +92,8 @@ serial_port uart_open(const char *pcPortName, uint32_t speed) {
}

sp->udpBuffer = NULL;
g_conn.send_via_local_ip = false;
g_conn.send_via_ip = PM3_NONE;

char *prefix = strdup(pcPortName);
if (prefix == NULL) {
Expand Down Expand Up @@ -121,7 +123,7 @@ serial_port uart_open(const char *pcPortName, uint32_t speed) {
return INVALID_SERIAL_PORT;
}

timeout.tv_usec = UART_TCP_CLIENT_RX_TIMEOUT_MS * 1000;
timeout.tv_usec = UART_NET_CLIENT_RX_TIMEOUT_MS * 1000;

// find the "bind" option
char *bindAddrPortStr = strstr(addrPortStr, ",bind=");
Expand Down Expand Up @@ -244,6 +246,12 @@ serial_port uart_open(const char *pcPortName, uint32_t speed) {
info.ai_socktype = SOCK_STREAM;
info.ai_protocol = IPPROTO_TCP;

if ((strstr(addrstr, "localhost") != NULL) ||
(strstr(addrstr, "127.0.0.1") != NULL) ||
(strstr(addrstr, "::1") != NULL)) {
g_conn.send_via_local_ip = true;
}

int s = getaddrinfo(addrstr, portstr, &info, &addr);
if (s != 0) {
PrintAndLogEx(ERR, "error: getaddrinfo: %d: %s", s, gai_strerror(s));
Expand Down Expand Up @@ -322,7 +330,7 @@ serial_port uart_open(const char *pcPortName, uint32_t speed) {
return INVALID_SERIAL_PORT;
}

timeout.tv_usec = UART_TCP_CLIENT_RX_TIMEOUT_MS * 1000;
timeout.tv_usec = UART_NET_CLIENT_RX_TIMEOUT_MS * 1000;

// find the "bind" option
char *bindAddrPortStr = strstr(addrPortStr, ",bind=");
Expand Down Expand Up @@ -445,6 +453,12 @@ serial_port uart_open(const char *pcPortName, uint32_t speed) {
info.ai_socktype = SOCK_DGRAM;
info.ai_protocol = IPPROTO_UDP;

if ((strstr(addrstr, "localhost") != NULL) ||
(strstr(addrstr, "127.0.0.1") != NULL) ||
(strstr(addrstr, "::1") != NULL)) {
g_conn.send_via_local_ip = true;
}

int s = getaddrinfo(addrstr, portstr, &info, &addr);
if (s != 0) {
PrintAndLogEx(ERR, "error: getaddrinfo: %d: %s", s, gai_strerror(s));
Expand Down
5 changes: 3 additions & 2 deletions include/pm3_cmd.h
Original file line number Diff line number Diff line change
Expand Up @@ -831,8 +831,9 @@ typedef struct {
// uart_windows.c & uart_posix.c
# define UART_FPC_CLIENT_RX_TIMEOUT_MS 200
# define UART_USB_CLIENT_RX_TIMEOUT_MS 20
# define UART_TCP_CLIENT_RX_TIMEOUT_MS 500
# define UART_TCP_CLIENT_LOCAL_RX_TIMEOUT_MS 40
# define UART_NET_CLIENT_RX_TIMEOUT_MS 500
# define UART_TCP_LOCAL_CLIENT_RX_TIMEOUT_MS 40
# define UART_UDP_LOCAL_CLIENT_RX_TIMEOUT_MS 20


// CMD_DEVICE_INFO response packet has flags in arg[0], flag definitions:
Expand Down

0 comments on commit de7b6f3

Please sign in to comment.