Open Source Developement
TRDP
Train Real Time Data Protocol
TRDP-SPY Architecture and Design
Document reference no: TCN-TRDP3-D-BOM-024-02
Author :
Organisation :
Document date:
Revision:
Status:
Florian Weispfenning
Bombardier Transportation
17 Sept 2013
2
issued
Public
Dissemination Level
Restricted to other programme participants (including the Commission Services)
Restricted to a group specified by the consortium (including the Commission Services)
Confidential, only for members of the consortium (including the Commission Services)
PU
PP
RE
CO
This document is subject to the terms of the Mozilla Public License, v. 2.0. If a copy of the MPL was not distributed with this document, You can obtain one at http://mozilla.org/MPL/2.0/.
© 2013, Bombardier Inc. or its subsidiaries and others. All rights reserved.
DOCUMENT SUMMARY SHEET
This document describes the design specification of the TRDP-PD and TRDP-MD plug-in for
Wireshark. The IP-Train project is in need of a TRDP Wire Protocol Analysis Tool which
shall be made available as a plug-in to the popular Wireshark network protocol analyser.
Participants
Name and Surname
Organisation
Florian Weispfenning
BOM
History
Role
Participant
11 Sept 13 F. Weispfenning
Initial version
17 Sept 13 Armin-H. Weiss License note added, issued
V1
V2
This document is subject to the terms of the Mozilla Public License, v. 2.0. If a copy of the MPL was not distributed with this document, You can obtain one at http://mozilla.org/MPL/2.0/.
© 2013, Bombardier Inc. or its subsidiaries and others. All rights reserved.
PAGE 3/27
TCN-TRDP3-D-BOM-024-02
TRDP-SPY Architecture and Design
TRAIN REAL TIME DATA PROTOCOL
Table of Contents
TABLE OF CONTENTS ...................................................................................................................................... 3
TABLE OF FIGURES .......................................................................................................................................... 5
1. INTRODUCTION ............................................................................................................................................. 6
1.1. PURPOSE ....................................................................................................................................................... 6
1.2. INTENDED AUDIENCE ................................................................................................................................... 6
1.3. REFERENCES/RELATED DOCUMENTS ............................................................................................................ 6
1.4. ABBREVIATIONS AND DEFINITIONS .............................................................................................................. 7
2. OVERVIEW OF THE REQUIREMENTS ..................................................................................................... 8
2.1.1. Description ........................................................................................................................................... 8
3. ARCHITECTURE ............................................................................................................................................ 9
3.1. ANALYSIS ..................................................................................................................................................... 9
3.2. VISUALIZATION ............................................................................................................................................ 9
3.3. XML CONFIGURATION .................................................................................................................................. 9
4. DESIGN DESCRIPTION ............................................................................................................................... 10
4.1. ENVIRONMENT............................................................................................................................................ 10
4.1.1. System ................................................................................................................................................ 10
4.1.2. Operational Environment................................................................................................................... 10
4.1.3. Development Environment for Windows ............................................................................................ 11
4.1.3.1. Steps to compile for Windows ...................................................................................................................... 11
4.1.3.2. Files to be changed when a new plug-in is made .......................................................................................... 11
4.1.3.3. Prerequisite for Build Procedure................................................................................................................... 12
4.1.3.4. Build Procedure ............................................................................................................................................ 12
4.1.4. Development Environment for Linux ................................................................................................. 13
4.1.4.1. Steps to compile and install Wireshark on Linux: ........................................................................................ 13
4.1.4.2. Files to be changed when a new plug-in is made. ......................................................................................... 14
4.1.4.3. Prerequisite for Build Procedure................................................................................................................... 14
4.1.4.4. Build Procedure ............................................................................................................................................ 15
4.2. INTERFACES ................................................................................................................................................ 16
4.2.1. System Interface ................................................................................................................................. 16
4.2.2. User Interface .................................................................................................................................... 17
4.3. MODULARIZATION ...................................................................................................................................... 18
4.3.1. Display Filter ..................................................................................................................................... 18
4.3.1.1. Data .............................................................................................................................................................. 20
4.3.2. Live Capture Functionality ................................................................................................................ 20
4.3.2.1. Data .............................................................................................................................................................. 20
4.3.2.2. Action ........................................................................................................................................................... 21
4.3.2.3. Sequence Diagram ........................................................................................................................................ 21
4.3.3. Detailed Analysis of TRDP PD Frames ............................................................................................. 21
4.3.3.1. Data .............................................................................................................................................................. 21
This document is subject to the terms of the Mozilla Public License, v. 2.0. If a copy of the MPL was not distributed with this document, You can obtain one at http://mozilla.org/MPL/2.0/.
© 2013, Bombardier Inc. or its subsidiaries and others. All rights reserved.
PAGE 4/27
TCN-TRDP3-D-BOM-024-02
TRDP-SPY Architecture and Design
TRAIN REAL TIME DATA PROTOCOL
4.3.3.2. Action .......................................................................................................................................................... 23
4.3.3.3. Sequence Diagram ....................................................................................................................................... 24
4.3.4. Detailed Analysis of TRDP MD Frames ............................................................................................ 24
4.3.4.1. Data .............................................................................................................................................................. 24
4.3.4.2. Action .......................................................................................................................................................... 26
4.3.4.3. Sequence Diagram ....................................................................................................................................... 26
4.3.5. Analysing Application Data ............................................................................................................... 26
4.3.5.1. Action .......................................................................................................................................................... 26
4.3.5.2. Sequence Diagram ....................................................................................................................................... 27
This document is subject to the terms of the Mozilla Public License, v. 2.0. If a copy of the MPL was not distributed with this document, You can obtain one at http://mozilla.org/MPL/2.0/.
© 2013, Bombardier Inc. or its subsidiaries and others. All rights reserved.
PAGE 5/27
TCN-TRDP3-D-BOM-024-02
TRDP-SPY Architecture and Design
TRAIN REAL TIME DATA PROTOCOL
Table of Figures
Figure 1 Relation between datasets and a ComId....................................................................... 9
Figure 2 Example view of Wireshark ....................................................................................... 10
Figure 3 Files within trdp_spy folder ....................................................................................... 12
Figure 4: Files within TRDP_spy after build procedure .......................................................... 13
Figure 5 Files within trdp_spy folder ....................................................................................... 14
Figure 6 Files within trdp-spy after build procedure ................................................................ 15
Figure 7 Interface Diagram....................................................................................................... 16
Figure 8 Display Filter .............................................................................................................. 18
Figure 9 Filter Expression ........................................................................................................ 19
Figure 10 Live Functionality Sequence Diagram ..................................................................... 21
Figure 11 Expansaion of TRDP frame in middle pane ............................................................ 23
Figure 12 Detail Analysis of TRDP Frame - Sequence Diagram ............................................ 24
Figure 13 Application Data decoding in middle pane .............................................................. 27
Figure 14 Application Data Decoding - Sequence Diagram .................................................... 27
This document is subject to the terms of the Mozilla Public License, v. 2.0. If a copy of the MPL was not distributed with this document, You can obtain one at http://mozilla.org/MPL/2.0/.
© 2013, Bombardier Inc. or its subsidiaries and others. All rights reserved.
PAGE 6/27
TCN-TRDP3-D-BOM-024-02
TRDP-SPY Architecture and Design
TRAIN REAL TIME DATA PROTOCOL
1. Introduction
1.1. Purpose
As part of the IP-Train project, two new protocols namely TRDP-PD (Process Data) and
TRDP-MD (Message Data) are intended to be supported by the Wireshark tool. The support
is envisaged to be made available in the form of a plug-in.
The existing GUI of the Wireshark V1.8.3 shall not be modified. The plug-in TRDP-SPY
shall be available as a DLL for Windows platform and shared library for TRDP-spy for Linux
platform.
1.2. Intended Audience
The TRDP-SPY will be used primarily by TRDP Engineers.
1.3. References/Related Documents
Reference
Number
Title
IEC51375-3-2
61375-1/FDIS
user-guide-a4.pdf
http://www.wireshark.org
http://www.wireshark.org/docs/wsdg_
html_chunked/ChSetupWin32.html
TCN-TRDP2-D-BOM-011-21
TRDP Protocol (Annex A)
Train Communication Network
Wireshark User Manual
Web link for Wireshark
Setup Wireshark on Windows
TRDP User's Manual
[Wire]
[TCN]
[WS-UM]
[WS-Web]
[WS-Setup]
[TRDP-UM]
This document is subject to the terms of the Mozilla Public License, v. 2.0. If a copy of the MPL was not distributed with this document, You can obtain one at http://mozilla.org/MPL/2.0/.
© 2013, Bombardier Inc. or its subsidiaries and others. All rights reserved.
PAGE 7/27
TCN-TRDP3-D-BOM-024-02
TRDP-SPY Architecture and Design
TRAIN REAL TIME DATA PROTOCOL
1.4. Abbreviations and Definitions
Abbreviation
Definition
API
BT
DLL
FCS
GUI
IEC
IP
TRDP - MD
TRDP - PD
TRDP
MD
PD
SOE
QoS
T2W
TCMS
TCN
TCP/IP
WP
XML
Application Program Interface
Bombardier Transportation
Dynamic Link Library
Frame Check Sequence
Graphic User Interface
International Electrotechnical Commission
Internet Protocol
TRDP – Message Data
TRDP – Process Data
Train Real Time Data Protocol
Message Data
Process Data
Standard Operating Environment
Quality of Service
Train to Wayside
Train Control and Management System
Train Communication Network
Transmission Control Protocol/ Internet Protocol
Wire Protocol ( on IP Train Network)
eXtended Markup Language
This document is subject to the terms of the Mozilla Public License, v. 2.0. If a copy of the MPL was not distributed with this document, You can obtain one at http://mozilla.org/MPL/2.0/.
© 2013, Bombardier Inc. or its subsidiaries and others. All rights reserved.
PAGE 8/27
TCN-TRDP3-D-BOM-024-02
TRDP-SPY Architecture and Design
TRAIN REAL TIME DATA PROTOCOL
2. Overview of the Requirements
2.1.1. Description
Wireshark is a popular network protocol analyser used by network professionals around the
world. Wireshark is an open source and provides flexibility for plug-in development.
A TRDP Analysis Tool is needed, which shall be made available as a plug-in to the popular
Wireshark network protocol analyser.
The TRDP-SPY plug-in shall fulfil the following requirements:
• shall be available for Wireshark v1.8.3
• shall be as far as possible also support later versions of Wireshark
• shall be available for both Windows XP and Linux
• shall decode all TRDP PD and TRDP MD frames in the live capture window
• shall support all functionalities of Live Capture window for real time analysis (capture
mode) and for recorded mode (messages saved on hard disk)
• shall allow declaring filters on any field of TRDP PD and TRDP MD frames
• shall provide statistical functionalities
• shall be able to decode and interpret the application data, using the configuration file
“TRDP_config.xml”
This document is subject to the terms of the Mozilla Public License, v. 2.0. If a copy of the MPL was not distributed with this document, You can obtain one at http://mozilla.org/MPL/2.0/.
© 2013, Bombardier Inc. or its subsidiaries and others. All rights reserved.