16 Nov
2022
16 Nov
'22
9:32 p.m.
laforge has uploaded this change for review. (
https://gerrit.osmocom.org/c/simtrace2/+/30201 )
Change subject: firmware/sniffer: Add performance/error counters
......................................................................
firmware/sniffer: Add performance/error counters
Let's add some counters for number of bytes/tpdu/pps/atr/reset
as well as for all the various error conditions from USART through
ring buffer and TPDU buffer overflows, timeouts, ...
Change-Id: Ic679664191259d321ad1f1829d5568fe0b297f39
---
M firmware/libcommon/include/simtrace_prot.h
M firmware/libcommon/source/sniffer.c
2 files changed, 56 insertions(+), 5 deletions(-)
git pull ssh://gerrit.osmocom.org:29418/simtrace2 refs/changes/01/30201/1
diff --git a/firmware/libcommon/include/simtrace_prot.h
b/firmware/libcommon/include/simtrace_prot.h
index d1eb89b..b269a27 100644
--- a/firmware/libcommon/include/simtrace_prot.h
+++ b/firmware/libcommon/include/simtrace_prot.h
@@ -1,6 +1,6 @@
/* SIMtrace2 USB protocol
*
- * (C) 2015-2017 by Harald Welte <hwelte(a)hmw-consulting.de>
+ * (C) 2015-2022 by Harald Welte <hwelte(a)hmw-consulting.de>
* (C) 2018 by sysmocom -s.f.m.c. GmbH, Author: Kevin Redon <kredon(a)sysmocom.de>
*
* This program is free software; you can redistribute it and/or modify
@@ -84,6 +84,8 @@
SIMTRACE_MSGT_SNIFF_PPS,
/* TPDU data */
SIMTRACE_MSGT_SNIFF_TPDU,
+ /* Statistics */
+ SIMTRACE_MSGT_DO_SNIFF_STATS,
};
/* common message header */
@@ -338,3 +340,24 @@
/* data */
uint8_t data[0];
} __attribute__ ((packed));
+
+/* SIMTRACE_MSGT_DO_SNIFF_STATS */
+struct st_sniff_stats {
+ uint32_t flags; /* RFU */
+ uint32_t num_bytes; /* total lnumber of bytes received */
+ uint32_t num_tpdu; /* total number of TPDUs received */
+ uint32_t num_atr; /* total number of ATRs received */
+ uint32_t num_pps; /* total number of PPS (req, resp) received */
+ uint32_t num_reset; /* total number of resets */
+ struct {
+ uint32_t overruns;
+ uint32_t framing_errs;
+ uint32_t parity_errs;
+ uint32_t breaks;
+ } num_usart;
+ uint32_t num_waiting_time_exp;
+ uint32_t num_tpdu_overflows; /* TPDU buffer overflows */
+ uint32_t num_csum_errors; /* ATR + PPS checksum */
+ uint32_t num_ringbuf_overflows; /* ISR->main ringbuffer overflows */
+ uint32_t num_tpdu_malformed;
+} __attribute__ ((packed));
diff --git a/firmware/libcommon/source/sniffer.c b/firmware/libcommon/source/sniffer.c
index 948eee8..4421fca 100644
--- a/firmware/libcommon/source/sniffer.c
+++ b/firmware/libcommon/source/sniffer.c
@@ -150,6 +150,9 @@
/* Flags to know is the card status changed (see SIMTRACE_MSGT_DT_SNIFF_CHANGE flags)
*/
static volatile uint32_t change_flags = 0;
+/* statistics for SIMTRACE_MSGT_DO_SNIFF_STATS */
+static struct st_sniff_stats g_stats;
+
/* ISO 7816 variables */
/*! ISO 7816-3 state */
static enum iso7816_3_sniff_state iso_state = ISO7816_S_RESET;
@@ -453,6 +456,7 @@
default:
TRACE_WARNING("Invalid TS received\n\r");
led_blink(LED_RED, BLINK_2F_O); /* indicate error to user */
+ g_stats.num_tpdu_malformed++;
usb_send_atr(SNIFF_DATA_FLAG_ERROR_MALFORMED); /* send ATR to host software using USB
*/
change_state(ISO7816_S_WAIT_ATR); /* reset state */
break;
@@ -523,9 +527,11 @@
/* We still consider the data as valid (e.g. for WT) even is the checksum is wrong.
* It is up to the reader to handle this error (e.g. by resetting)
*/
+ g_stats.num_csum_errors++;
}
}
usb_send_atr(flags); /* send ATR to host software using USB */
+ g_stats.num_atr++;
change_state(ISO7816_S_WAIT_TPDU); /* go to next state */
break;
default:
@@ -617,6 +623,7 @@
} else {
TRACE_INFO("Invalid PPSS received\n\r");
led_blink(LED_RED, BLINK_2F_O); /* indicate error to user */
+ g_stats.num_tpdu_malformed++;
usb_send_pps(SNIFF_DATA_FLAG_ERROR_MALFORMED); /* send ATR to host software using USB
*/
change_state(ISO7816_S_WAIT_TPDU); /* go back to TPDU state */
}
@@ -668,6 +675,7 @@
if (0 == check) { /* checksum is valid */
change_state(ISO7816_S_WAIT_PPS_RSP); /* go to next state */
} else { /* checksum is invalid */
+ g_stats.num_csum_errors++;
change_state(ISO7816_S_WAIT_TPDU); /* go to next state */
}
} else if (ISO7816_S_IN_PPS_RSP == iso_state) {
@@ -687,7 +695,9 @@
usb_send_fidi(pps_cur[2]); /* send Fi/Di change notification to host software over
USB */
} else { /* checksum is invalid */
TRACE_INFO("PPS negotiation failed\n\r");
+ g_stats.num_csum_errors++;
}
+ g_stats.num_pps++;
change_state(ISO7816_S_WAIT_TPDU); /* go to next state */
}
break;
@@ -724,6 +734,7 @@
return;
}
if (g_tpdu.packet_i >= ARRAY_SIZE(g_tpdu.packet)) {
+ g_stats.num_tpdu_overflows++;
TRACE_ERROR("TPDU data overflow\n\r");
return;
}
@@ -734,6 +745,7 @@
if (0xff == byte) {
TRACE_WARNING("0xff is not a valid class byte\n\r");
led_blink(LED_RED, BLINK_2F_O); /* indicate error to user */
+ g_stats.num_tpdu_malformed++;
usb_send_tpdu(SNIFF_DATA_FLAG_ERROR_MALFORMED); /* send ATR to host software using USB
*/
change_state(ISO7816_S_WAIT_TPDU); /* go back to TPDU state */
return;
@@ -746,6 +758,7 @@
if ((0x60 == (byte & 0xf0)) || (0x90 == (byte & 0xf0))) {
TRACE_WARNING("invalid INS 0x%02x\n\r", byte);
led_blink(LED_RED, BLINK_2F_O); /* indicate error to user */
+ g_stats.num_tpdu_malformed++;
usb_send_tpdu(SNIFF_DATA_FLAG_ERROR_MALFORMED); /* send ATR to host software using USB
*/
change_state(ISO7816_S_WAIT_TPDU); /* go back to TPDU state */
return;
@@ -786,6 +799,7 @@
} else {
TRACE_WARNING("invalid SW1 0x%02x\n\r", byte);
led_blink(LED_RED, BLINK_2F_O); /* indicate error to user */
+ g_stats.num_tpdu_malformed++;
usb_send_tpdu(SNIFF_DATA_FLAG_ERROR_MALFORMED); /* send ATR to host software using USB
*/
change_state(ISO7816_S_WAIT_TPDU); /* go back to TPDU state */
return;
@@ -794,6 +808,7 @@
case TPDU_S_SW2:
g_tpdu.packet[g_tpdu.packet_i++] = byte;
usb_send_tpdu(0); /* send TPDU to host software using USB */
+ g_stats.num_tpdu++;
change_state(ISO7816_S_WAIT_TPDU); /* this is the end of the TPDU */
break;
case TPDU_S_DATA_SINGLE:
@@ -832,17 +847,24 @@
if (csr & US_CSR_RXRDY) {
/* Read communication data byte between phone and SIM */
byte = RBUF16_F_DATA_BYTE | (sniff_usart.base->US_RHR & 0xff);
+ g_stats.num_bytes++;
/* Reset WT timer */
wt_remaining = g_wt;
}
/* Verify if there was an error */
- if (csr & US_CSR_OVRE)
+ if (csr & US_CSR_OVRE) {
+ g_stats.num_usart.overruns++;
byte |= RBUF16_F_OVERRUN;
- if (csr & US_CSR_FRAME)
+ }
+ if (csr & US_CSR_FRAME) {
+ g_stats.num_usart.framing_errs++;
byte |= RBUF16_F_FRAMING;
- if (csr & US_CSR_PARE)
+ }
+ if (csr & US_CSR_PARE) {
+ g_stats.num_usart.parity_errs++;
byte |= RBUF16_F_PARITY;
+ }
if (csr & (US_CSR_OVRE|US_CSR_FRAME|US_CSR_PARE))
sniff_usart.base->US_CR |= US_CR_RSTSTA;
@@ -856,6 +878,7 @@
change_flags |= SNIFF_CHANGE_FLAG_TIMEOUT_WT;
/* Reset timeout value */
wt_remaining = g_wt;
+ g_stats.num_waiting_time_exp++;
} else {
wt_remaining -= (sniff_usart.base->US_RTOR & 0xffff); /* be sure to subtract
the actual timeout since the new might not have been set and reloaded yet */
}
@@ -874,8 +897,10 @@
/* Store sniffed data (or error flags, or both) into buffer */
if (byte) {
- if (rbuf16_write(&sniff_buffer, byte) != 0)
+ if (rbuf16_write(&sniff_buffer, byte) != 0) {
+ g_stats.num_ringbuf_overflows++;
TRACE_ERROR("USART buffer full\n\r");
+ }
}
}
@@ -891,6 +916,7 @@
/* Update the ISO state according to the reset change (reset is active low) */
if (PIO_Get(&pin_rst)) {
change_flags |= SNIFF_CHANGE_FLAG_RESET_DEASSERT; /* set flag and let main loop send it
*/
+ g_stats.num_reset++;
} else {
change_flags |= SNIFF_CHANGE_FLAG_RESET_ASSERT; /* set flag and let main loop send it
*/
}
@@ -945,6 +971,8 @@
{
TRACE_INFO("Sniffer Init\n\r");
+ memset(&g_stats, 0, sizeof(g_stats));
+
/* Configure pins to sniff communication between phone and card */
PIO_Configure(pins_sniff, PIO_LISTSIZE(pins_sniff));
/* Configure pins to connect phone to card */
--
To view, visit https://gerrit.osmocom.org/c/simtrace2/+/30201
To unsubscribe, or for help writing mail filters, visit
https://gerrit.osmocom.org/settings
Gerrit-Project: simtrace2
Gerrit-Branch: master
Gerrit-Change-Id: Ic679664191259d321ad1f1829d5568fe0b297f39
Gerrit-Change-Number: 30201
Gerrit-PatchSet: 1
Gerrit-Owner: laforge <laforge(a)osmocom.org>
Gerrit-MessageType: newchange