Compare commits

...

4 Commits

Author SHA1 Message Date
Ben Gardiner e77be3b1d9
Merge 63500f8dd0 into 1f038b3cd8 2026-01-13 21:59:19 +09:00
Marc Kleine-Budde 1f038b3cd8
Merge pull request #614 from hartkopp/master
canxl extension: use plain union instead of typedef
2025-12-18 19:26:31 +01:00
Oliver Hartkopp 392ccc970b canxl extension: use plain union instead of typedef
"In general, a pointer, or a struct that has elements that can reasonably
be directly accessed should never be a typedef."

https://www.kernel.org/doc/html/v5.0/process/coding-style.html#typedefs

Signed-off-by: Oliver Hartkopp <socketcan@hartkopp.net>
2025-12-18 18:23:38 +01:00
Ben Gardiner 63500f8dd0 canplayer-bisect: introduce a tool to hunt for can packets by bisecting replays of candump logs 2016-04-25 20:14:28 -07:00
11 changed files with 229 additions and 24 deletions

View File

@ -84,7 +84,7 @@ static void print_usage(char *prg)
} }
static void prframe(FILE *file, struct timeval *tv, int dev, static void prframe(FILE *file, struct timeval *tv, int dev,
cu_t *cf, char dir) union cfu *cf, char dir)
{ {
static char abuf[BUFLEN]; static char abuf[BUFLEN];
@ -177,7 +177,7 @@ static void eval_can(char* buf, struct timeval *date_tvp, char timestamps,
cf.len = CAN_ERR_DLC; cf.len = CAN_ERR_DLC;
calc_tv(&tv, &read_tv, date_tvp, timestamps, dplace); calc_tv(&tv, &read_tv, date_tvp, timestamps, dplace);
prframe(outfile, &tv, interface, (cu_t *)&cf, NO_DIR); prframe(outfile, &tv, interface, (union cfu *)&cf, NO_DIR);
fflush(outfile); fflush(outfile);
return; return;
} }
@ -249,7 +249,7 @@ static void eval_can(char* buf, struct timeval *date_tvp, char timestamps,
cf.data[i] = data[i] & 0xFFU; cf.data[i] = data[i] & 0xFFU;
calc_tv(&tv, &read_tv, date_tvp, timestamps, dplace); calc_tv(&tv, &read_tv, date_tvp, timestamps, dplace);
prframe(outfile, &tv, interface, (cu_t *)&cf, dir[0]); prframe(outfile, &tv, interface, (union cfu *)&cf, dir[0]);
fflush(outfile); fflush(outfile);
} }
} }
@ -374,7 +374,7 @@ static void eval_canfd(char* buf, struct timeval *date_tvp, char timestamps,
} }
calc_tv(&tv, &read_tv, date_tvp, timestamps, dplace); calc_tv(&tv, &read_tv, date_tvp, timestamps, dplace);
prframe(outfile, &tv, interface, (cu_t *)&cf, dir[0]); prframe(outfile, &tv, interface, (union cfu *)&cf, dir[0]);
fflush(outfile); fflush(outfile);
/* No support for really strange CANFD ErrorFrames format m( */ /* No support for really strange CANFD ErrorFrames format m( */
@ -487,7 +487,7 @@ static void eval_canxl_cc(char* buf, struct timeval *date_tvp, char timestamps,
cf.len8_dlc = dlc; cf.len8_dlc = dlc;
calc_tv(&tv, &read_tv, date_tvp, timestamps, dplace); calc_tv(&tv, &read_tv, date_tvp, timestamps, dplace);
prframe(outfile, &tv, interface, (cu_t *)&cf, dir[0]); prframe(outfile, &tv, interface, (union cfu *)&cf, dir[0]);
fflush(outfile); fflush(outfile);
} }
@ -594,7 +594,7 @@ static void eval_canxl_fd(char* buf, struct timeval *date_tvp, char timestamps,
cf.flags |= CANFD_ESI; cf.flags |= CANFD_ESI;
calc_tv(&tv, &read_tv, date_tvp, timestamps, dplace); calc_tv(&tv, &read_tv, date_tvp, timestamps, dplace);
prframe(outfile, &tv, interface, (cu_t *)&cf, dir[0]); prframe(outfile, &tv, interface, (union cfu *)&cf, dir[0]);
fflush(outfile); fflush(outfile);
} }
@ -723,7 +723,7 @@ static void eval_canxl_xl(char* buf, struct timeval *date_tvp, char timestamps,
cf.flags |= CANXL_RRS; cf.flags |= CANXL_RRS;
calc_tv(&tv, &read_tv, date_tvp, timestamps, dplace); calc_tv(&tv, &read_tv, date_tvp, timestamps, dplace);
prframe(outfile, &tv, interface, (cu_t *)&cf, dir[0]); prframe(outfile, &tv, interface, (union cfu *)&cf, dir[0]);
fflush(outfile); fflush(outfile);
/* No support for CAN XL ErrorFrames */ /* No support for CAN XL ErrorFrames */

View File

@ -342,7 +342,7 @@ int main(int argc, char **argv)
struct cmsghdr *cmsg; struct cmsghdr *cmsg;
struct can_filter *rfilter; struct can_filter *rfilter;
can_err_mask_t err_mask; can_err_mask_t err_mask;
static cu_t cu; /* union for CAN CC/FD/XL frames */ static union cfu cu; /* union for CAN CC/FD/XL frames */
int nbytes, i; int nbytes, i;
struct ifreq ifr; struct ifreq ifr;
struct timespec ts, last_ts; struct timespec ts, last_ts;

View File

@ -299,7 +299,7 @@ static int setsockopt_txtime(int fd)
return 0; return 0;
} }
static int do_send_one(int fd, cu_t *cu, size_t len, int timeout) static int do_send_one(int fd, union cfu *cu, size_t len, int timeout)
{ {
uint8_t control[CMSG_SPACE(sizeof(uint64_t))] = { 0 }; uint8_t control[CMSG_SPACE(sizeof(uint64_t))] = { 0 };
struct iovec iov = { struct iovec iov = {
@ -494,7 +494,7 @@ int main(int argc, char **argv)
struct can_raw_vcid_options vcid_opts = { struct can_raw_vcid_options vcid_opts = {
.flags = CAN_RAW_XL_VCID_TX_PASS, .flags = CAN_RAW_XL_VCID_TX_PASS,
}; };
static cu_t cu; static union cfu cu;
int i; int i;
struct ifreq ifr = { 0 }; struct ifreq ifr = { 0 };
const int enable_canfx = 1; const int enable_canfx = 1;

View File

@ -191,7 +191,7 @@ int main(int argc, char **argv)
.rx_vcid_mask = 0, .rx_vcid_mask = 0,
}; };
struct can_filter rfilter; struct can_filter rfilter;
static cu_t cu; /* union for CAN CC/FD/XL frames */ static union cfu cu; /* union for CAN CC/FD/XL frames */
const int canfx_on = 1; const int canfx_on = 1;
int nbytes, i, j; int nbytes, i, j;
struct ifreq ifr; struct ifreq ifr;

205
canplayer-bisect 100755
View File

@ -0,0 +1,205 @@
#!/bin/bash
if [ -z "${CANPLAYER}" ]; then
CANPLAYER="canplayer"
fi
die() {
echo "$*" > /dev/stderr
exit 1
}
usage() {
echo "canplayer-bisect <start|stop|clean|good|yes|bad|no|again|where|undo> <logfile> <canplayer options>"
}
is_ready() {
if [ ! -d .canplayer-bisect ]; then
usage
exit 1
fi
return 0
}
setup() {
is_ready
LOGFILE=$(cat .canplayer-bisect/logfile |head -n 1)
SAVED_LEN="$(cat .canplayer-bisect/len|tail -n 1)"
LEN="$(wc -l ${LOGFILE} | awk '{ print $1 }')"
if [ "$LEN" != "$SAVED_LEN" ]; then
die "logfile has changed size. restart"
fi
CANPLAYER_ARGS=$(cat .canplayer-bisect/args |head -n 1)
HEAD="$(cat .canplayer-bisect/head |tail -n 1)"
TAIL="$(cat .canplayer-bisect/tail |tail -n 1)"
}
back() {
HEAD="$(cat .canplayer-bisect/head |tail -n 2 |head -n1)"
TAIL="$(cat .canplayer-bisect/tail |tail -n 2 |head -n1)"
}
do_undo() {
sed -i '$ d' .canplayer-bisect/head
sed -i '$ d' .canplayer-bisect/tail
}
teardown() {
mkdir -p .canplayer-bisect
echo $LEN > .canplayer-bisect/len
echo $LOGFILE > .canplayer-bisect/logfile
echo $CANPLAYER_ARGS > .canplayer-bisect/args
echo $HEAD >> .canplayer-bisect/head
echo $TAIL >> .canplayer-bisect/tail
}
show() {
cat $LOGFILE | sed -n ${HEAD},${TAIL}p
}
play() {
#we *could* pipe directly to canplayer, but then the user can't add -l i to CANPLAYER_ARGS to hunt for packets using looped playback
the_show="$(mktemp)"
trap "rm -rf \"${the_show}\"" EXIT
show > "${the_show}"
"${CANPLAYER}" ${CANPLAYER_ARGS} -I "${the_show}"
}
do_show() {
setup
show
}
check_heads_n_tails() {
if [ $HEAD -eq $TAIL ]; then
do_stop
fi
}
do_good() {
setup
check_heads_n_tails
if [ $(( $HEAD + 1 )) -eq $TAIL ]; then
TAIL=$HEAD
else
TAIL=$(( ( $TAIL - $HEAD ) / 2 + $HEAD - 1 ))
fi
teardown
play
}
do_bad() {
setup
check_heads_n_tails
back
if [ $(( $HEAD + 1 )) -eq $TAIL ]; then
HEAD=$TAIL
else
HEAD=$(( ( $TAIL - $HEAD ) / 2 + $HEAD ))
fi
teardown
play
}
do_again() {
setup
play
}
do_start() {
do_clean
LEN="$(wc -l ${LOGFILE} | awk '{ print $1 }')"
HEAD=1
TAIL=$LEN
echo "assuming logfile contains the packets you seek... bisecting to first half"
teardown
play
}
do_where() {
setup
echo "between $HEAD and $TAIL (+$(( $TAIL - $HEAD ))) of $LOGFILE"
}
do_stop() {
setup
if [ "$COMMAND" == "no" ]; then
echo "failed to find what you were looking for"
exit 1
else
echo "the packets you seek are:"
do_where
exit 0
fi
}
do_clean() {
rm -rf .canplayer-bisect
}
if [ -z "$1" ]; then
usage
exit 1
fi
COMMAND=$1
if [ ! -d .canplayer-bisect ] && [ ! -z "$2" ] && [ ! -e "$2" ]; then
usage
exit 1
fi
LOGFILE="$2"
shift
shift
CANPLAYER_ARGS="$*"
case "$COMMAND" in
start)
do_start
;;
stop)
do_stop
;;
clean)
do_clean
;;
good|yes)
do_good
;;
bad|no)
do_bad
;;
again)
do_again
;;
where)
do_where
;;
undo)
do_undo
;;
show)
do_show
;;
esac

View File

@ -261,7 +261,7 @@ int main(int argc, char **argv)
struct can_raw_vcid_options vcid_opts = { struct can_raw_vcid_options vcid_opts = {
.flags = CAN_RAW_XL_VCID_TX_PASS, .flags = CAN_RAW_XL_VCID_TX_PASS,
}; };
static cu_t cu; static union cfu cu;
static struct timeval today_tv, log_tv, last_log_tv, diff_tv; static struct timeval today_tv, log_tv, last_log_tv, diff_tv;
struct timespec sleep_ts; struct timespec sleep_ts;
int s; /* CAN_RAW socket */ int s; /* CAN_RAW socket */

View File

@ -117,7 +117,7 @@ int main(int argc, char **argv)
struct can_raw_vcid_options vcid_opts = { struct can_raw_vcid_options vcid_opts = {
.flags = CAN_RAW_XL_VCID_TX_PASS, .flags = CAN_RAW_XL_VCID_TX_PASS,
}; };
static cu_t cu; static union cfu cu;
struct ifreq ifr; struct ifreq ifr;
/* check command line options */ /* check command line options */

6
lib.c
View File

@ -155,7 +155,7 @@ int hexstring2data(char *arg, unsigned char *data, int maxdlen)
return 0; return 0;
} }
int parse_canframe(char *cs, cu_t *cu) int parse_canframe(char *cs, union cfu *cu)
{ {
/* documentation see lib.h */ /* documentation see lib.h */
@ -309,7 +309,7 @@ int parse_canframe(char *cs, cu_t *cu)
return mtu; return mtu;
} }
int snprintf_canframe(char *buf, size_t size, cu_t *cu, int sep) int snprintf_canframe(char *buf, size_t size, union cfu *cu, int sep)
{ {
/* documentation see lib.h */ /* documentation see lib.h */
@ -433,7 +433,7 @@ int snprintf_canframe(char *buf, size_t size, cu_t *cu, int sep)
return offset; return offset;
} }
int snprintf_long_canframe(char *buf, size_t size, cu_t *cu, int view) int snprintf_long_canframe(char *buf, size_t size, union cfu *cu, int view)
{ {
/* documentation see lib.h */ /* documentation see lib.h */

10
lib.h
View File

@ -59,11 +59,11 @@ static inline int pr_debug(const char* fmt, ...) {return 0;}
#endif #endif
/* CAN CC/FD/XL frame union */ /* CAN CC/FD/XL frame union */
typedef union { union cfu {
struct can_frame cc; struct can_frame cc;
struct canfd_frame fd; struct canfd_frame fd;
struct canxl_frame xl; struct canxl_frame xl;
} cu_t; };
/* /*
* The buffer size for ASCII CAN frame string representations * The buffer size for ASCII CAN frame string representations
@ -110,7 +110,7 @@ int hexstring2data(char *arg, unsigned char *data, int maxdlen);
* *
*/ */
int parse_canframe(char *cs, cu_t *cu); int parse_canframe(char *cs, union cfu *cu);
/* /*
* Transfers a valid ASCII string describing a CAN frame into the CAN union * Transfers a valid ASCII string describing a CAN frame into the CAN union
* containing CAN CC/FD/XL structs. * containing CAN CC/FD/XL structs.
@ -180,7 +180,7 @@ int parse_canframe(char *cs, cu_t *cu);
* - CAN FD frames do not have a RTR bit * - CAN FD frames do not have a RTR bit
*/ */
int snprintf_canframe(char *buf, size_t size, cu_t *cu, int sep); int snprintf_canframe(char *buf, size_t size, union cfu *cu, int sep);
/* /*
* Creates a CAN frame hexadecimal output in compact format. * Creates a CAN frame hexadecimal output in compact format.
* The CAN data[] is separated by '.' when sep != 0. * The CAN data[] is separated by '.' when sep != 0.
@ -213,7 +213,7 @@ int snprintf_canframe(char *buf, size_t size, cu_t *cu, int sep);
#define SWAP_DELIMITER '`' #define SWAP_DELIMITER '`'
int snprintf_long_canframe(char *buf, size_t size, cu_t *cu, int view); int snprintf_long_canframe(char *buf, size_t size, union cfu *cu, int view);
/* /*
* Creates a CAN frame hexadecimal output in user readable format. * Creates a CAN frame hexadecimal output in user readable format.
* *

View File

@ -183,7 +183,7 @@ static void canfd_asc(struct canfd_frame *cf, int devno, int mtu,
fprintf(outfile, " %8d %4d %8X 0 0 0 0 0", 130000, 130, flags); fprintf(outfile, " %8d %4d %8X 0 0 0 0 0", 130000, 130, flags);
} }
static void canxl_asc(cu_t *cu, int devno, int mtu, static void canxl_asc(union cfu *cu, int devno, int mtu,
char *extra_info, FILE *outfile) char *extra_info, FILE *outfile)
{ {
char id[10]; char id[10];
@ -314,7 +314,7 @@ int main(int argc, char **argv)
{ {
static char buf[BUFSZ], device[DEVSZ], afrbuf[AFRSZ], extra_info[EXTRASZ]; static char buf[BUFSZ], device[DEVSZ], afrbuf[AFRSZ], extra_info[EXTRASZ];
static cu_t cu; static union cfu cu;
static struct timeval tv, start_tv; static struct timeval tv, start_tv;
FILE *infile = stdin; FILE *infile = stdin;
FILE *outfile = stdout; FILE *outfile = stdout;

View File

@ -68,7 +68,7 @@
int main(void) int main(void)
{ {
static char buf[BUFSZ], timestamp[TIMESZ], device[DEVSZ], afrbuf[AFRSZ]; static char buf[BUFSZ], timestamp[TIMESZ], device[DEVSZ], afrbuf[AFRSZ];
static cu_t cu; static union cfu cu;
int mtu; int mtu;
while (fgets(buf, BUFSZ-1, stdin)) { while (fgets(buf, BUFSZ-1, stdin)) {