wiretap: Add support for Busmaster log file format

Only CAN protocol is supported. Extra information available in J1939
entries is ignored since the J1939 wireshark dissector works with
raw CAN frames and makes no use of this extra information.
The log format may also encapsulate LIN messages which are not
supported by wireshark and thus are ignored.

The only limitation is that relative timestamp format is not
supported. If a file defines relative format of timestamps, packets
are extracted, but timestamps are omitted, since random access deems
impossible without reparsing the whole file up to the packet of
interest. In order to support relative timestamps we need to parse
the whole file at once on open and either dump into a temporary
PCAP file or keep messages in a private list and provide access
to them on read()/seek_read().

The change also creates a separate header for CAN frame structure
definitions which are used by several file readers (candump and
busmaster for now).

Bug: 15939
Change-Id: I87c5555e4e5e1b142b9984b24544b2591d494fbc
Reviewed-on: https://code.wireshark.org/review/34083
Petri-Dish: Anders Broman <a.broman58@gmail.com>
Tested-by: Petri Dish Buildbot
Reviewed-by: Anders Broman <a.broman58@gmail.com>

1 files changed, 136 insertions, 0 deletions

diff --git a/wiretap/busmaster_priv.h b/wiretap/busmaster_priv.h
new file mode 100644
index 0000000000..36ce70e994
--- /dev/null
+++ b/wiretap/busmaster_priv.h
@@ -0,0 +1,136 @@
+/* busmaster_priv.h
+ *
+ * Wiretap Library
+ * Copyright (c) 1998 by Gilbert Ramirez <gram@alumni.rice.edu>
+ *
+ * Support for Busmaster log file format
+ * Copyright (c) 2019 by Maksim Salau <maksim.salau@gmail.com>
+ *
+ * SPDX-License-Identifier: GPL-2.0-or-later
+ */
+
+#ifndef BUSMASTER_PRIV_H__
+#define BUSMASTER_PRIV_H__
+
+#include <gmodule.h>
+#include <wiretap/wtap.h>
+#include <wiretap/socketcan.h>
+#include <wsutil/ws_printf.h>
+
+//#define BUSMASTER_DEBUG
+//#define BUSMASTER_PARSER_TRACE
+
+typedef enum {
+    LOG_ENTRY_ERROR = -1,
+    LOG_ENTRY_NONE = 0,
+    LOG_ENTRY_EMPTY,
+    LOG_ENTRY_HEADER,
+    LOG_ENTRY_FOOTER,
+    LOG_ENTRY_FOOTER_AND_HEADER,
+    LOG_ENTRY_MSG,
+    LOG_ENTRY_EOF,
+} log_entry_type_t;
+
+typedef enum {
+    PROTOCOL_UNKNOWN = 0,
+    PROTOCOL_CAN,
+    PROTOCOL_LIN,
+    PROTOCOL_J1939,
+} protocol_t;
+
+typedef enum {
+    DATA_MODE_UNKNOWN = 0,
+    DATA_MODE_HEX,
+    DATA_MODE_DEC,
+} data_mode_t;
+
+typedef enum {
+    TIME_MODE_UNKNOWN = 0,
+    TIME_MODE_ABSOLUTE,
+    TIME_MODE_SYSTEM,
+    TIME_MODE_RELATIVE,
+} time_mode_t;
+
+typedef enum {
+    MSG_TYPE_STD,
+    MSG_TYPE_EXT,
+    MSG_TYPE_STD_RTR,
+    MSG_TYPE_EXT_RTR,
+    MSG_TYPE_STD_FD,
+    MSG_TYPE_EXT_FD,
+    MSG_TYPE_ERR,
+} msg_type_t;
+
+typedef struct {
+    guint year;
+    guint month;
+    guint day;
+} msg_date_t;
+
+typedef struct {
+    guint hours;
+    guint minutes;
+    guint seconds;
+    guint micros;
+} msg_time_t;
+
+typedef struct {
+    msg_date_t date;
+    msg_time_t time;
+} msg_date_time_t;
+
+typedef struct {
+    guint      length;
+    guint8     data[CANFD_MAX_DLEN];
+} msg_data_t;
+
+typedef struct {
+    msg_time_t timestamp;
+    msg_type_t type;
+    guint32    id;
+    msg_data_t data;
+} msg_t;
+
+typedef struct {
+    gint64 v0;
+    gint64 v1;
+    gint64 v2;
+    gint64 v3;
+} token_t;
+
+typedef struct {
+    gint64      file_start_offset;
+    gint64      file_end_offset;
+    protocol_t  protocol;
+    data_mode_t data_mode;
+    time_mode_t time_mode;
+    msg_date_t  start_date;
+    msg_time_t  start_time;
+} busmaster_priv_t;
+
+typedef struct {
+    FILE_T   fh;
+    gint64   file_bytes_read;
+
+    gchar   *parse_error;
+    int      err;
+    gchar   *err_info;
+
+    token_t  token;
+
+    log_entry_type_t entry_type;
+    busmaster_priv_t header;
+    msg_t            msg;
+} busmaster_state_t;
+
+gboolean
+run_busmaster_parser(busmaster_state_t *state,
+                     int               *err, gchar **err_info);
+
+#ifdef BUSMASTER_DEBUG
+#define busmaster_debug_printf(...) ws_debug_printf(__VA_ARGS__)
+#else
+#define busmaster_debug_printf(...) (void)0
+#endif
+
+#endif  /* BUSMASTER_PRIV_H__ */