Skip to content

Commit 38446eb

Browse files
KyllianAubryGitHub Enterprise
KyllianAubry
authored and
GitHub Enterprise
committed
SKA-533: modify executable names (#75)
1 parent 2082e24 commit 38446eb

File tree

12 files changed

+49
-49
lines changed

12 files changed

+49
-49
lines changed

‎CMakeLists.txt

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -160,8 +160,8 @@ install(
160160
)
161161

162162
install(
163-
TARGETS
164-
SilKitDemoEthernetIcmpEchoDevice
163+
TARGETS
164+
sil-kit-demo-ethernet-icmp-echo-device
165165
RUNTIME DESTINATION ${CMAKE_INSTALL_BINDIR} COMPONENT Runtime
166166
PERMISSIONS
167167
OWNER_READ OWNER_WRITE OWNER_EXECUTE
@@ -170,13 +170,13 @@ install(
170170
EXCLUDE_FROM_ALL
171171
)
172172

173-
# only SilKitAdapterTap should be installed to /usr/local/bin by calling --target install (therefore it is not excluded)
173+
# only sil-kit-adapter-tap should be installed to /usr/local/bin by calling --target install (therefore it is not excluded)
174174
install(
175-
TARGETS
176-
SilKitAdapterTap
175+
TARGETS
176+
sil-kit-adapter-tap
177177
RUNTIME DESTINATION ${CMAKE_INSTALL_BINDIR} COMPONENT Runtime
178178
LIBRARY DESTINATION ${CMAKE_INSTALL_LIBDIR} COMPONENT Runtime
179-
ARCHIVE DESTINATION ${CMAKE_INSTALL_LIBDIR}/SilKitAdapterTap COMPONENT Development
179+
ARCHIVE DESTINATION ${CMAKE_INSTALL_LIBDIR}/sil-kit-adapter-tap COMPONENT Development
180180
PERMISSIONS
181181
OWNER_READ OWNER_WRITE OWNER_EXECUTE
182182
GROUP_READ GROUP_EXECUTE

‎README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -49,17 +49,17 @@ Download a preview or release of the Adapters directly from [Vector SIL Kit Adap
4949

5050
If not already existent on your system you should also download a SIL Kit Release directly from [Vector SIL Kit Releases](https://github.com/vectorgrp/sil-kit/releases). You will need this for being able to start a sil-kit-registry.
5151

52-
## Install the SilKitAdapterTap (optional)
52+
## Install the sil-kit-adapter-tap (optional)
5353
Be aware that SIL Kit itself also needs to be installed to run the adapter.
5454

55-
Run the following command to install the SilKitAdapterTap (can be done for self build and pre build package after cmake configure):
55+
Run the following command to install the sil-kit-adapter-tap (can be done for self build and pre build package after cmake configure):
5656

5757

5858
### Linux installation
5959

6060
sudo cmake --build build --target install
6161

62-
**Note:** After installing the adapter on Linux, the following command ``SilKitAdapterTap`` can be called from everywhere without defining a path. The default installation path will be ``/usr/local/bin``.
62+
**Note:** After installing the adapter on Linux, the following command ``sil-kit-adapter-tap`` can be called from everywhere without defining a path. The default installation path will be ``/usr/local/bin``.
6363

6464
### Windows installation
6565

@@ -70,20 +70,20 @@ Run the following command to install the SilKitAdapterTap (can be done for self
7070
**Note 2:** The default installation path will be ``C:\Program Files\Vector SIL Kit Adapters TAP <TAP_ADAPTER_VERSION>``, with <TAP_ADAPTER_VERSION> as the version of the TAP adapter you install.
7171
Depending on your system this default path can be ``Program Files (x86)``.
7272

73-
## Run the SilKitAdapterTap
73+
## Run the sil-kit-adapter-tap
7474
This application allows the user to attach a TAP device of a Linux or Windows system to the Vector SIL Kit.
7575

7676
Before you start the adapter there always needs to be a sil-kit-registry running already. Start it e.g. like this:
7777

7878
/path/to/SilKit-x.y.z-$platform/SilKit/bin/sil-kit-registry --listen-uri 'silkit://0.0.0.0:8501'
7979

80-
It is also necessary that the TAP device exists before the ``SilKitAdapterTap`` is started.
80+
It is also necessary that the TAP device exists before the ``sil-kit-adapter-tap`` is started.
8181

82-
**Hint:** If your TAP device has been created by a third party application (you want the SIL Kit to connect to) it is possible that this TAP device resource is 'flagged' as busy/blocked. In this case you just can create another TAP device for usage with the ``SilKitAdapterTap`` by yourself and bridge (``brctl`` on Linux, ``netsh bridge`` on Windows) it with the TAP device of your third party application.
82+
**Hint:** If your TAP device has been created by a third party application (you want the SIL Kit to connect to) it is possible that this TAP device resource is 'flagged' as busy/blocked. In this case you just can create another TAP device for usage with the ``sil-kit-adapter-tap`` by yourself and bridge (``brctl`` on Linux, ``netsh bridge`` on Windows) it with the TAP device of your third party application.
8383

8484
The application *optionally* takes the following command line arguments (default between curly braces):
8585

86-
SilKitAdapterTap [--name <participant's name{EthernetTapDevice}>]
86+
sil-kit-adapter-tap [--name <participant's name{EthernetTapDevice}>]
8787
[--configuration <path to .silkit.yaml or .json configuration file>]
8888
[--registry-uri silkit://<host{localhost}>:<port{8501}>]
8989
[--log <Trace|Debug|Warn|{Info}|Error|Critical|Off>]

‎adaptive/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -223,7 +223,7 @@ The user manual of the start application suggests to create a network adapter wi
223223
a) If no special SIL Kit configuration was added in the global CANoe options, this is just the name of the used network, e.g. ``Ethernet1``.
224224

225225
```bash
226-
./bin/SilKitAdapterTap --network 'Ethernet1'
226+
./bin/sil-kit-adapter-tap --network 'Ethernet1'
227227
```
228228

229229
b) If the Vector SIL Kit was configured with an additional configuration.yaml, make sure to use the network name from that file.
@@ -235,7 +235,7 @@ The user manual of the start application suggests to create a network adapter wi
235235
```
236236

237237
```bash
238-
./bin/SilKitAdapterTap --network 'silkit_network'
238+
./bin/sil-kit-adapter-tap --network 'silkit_network'
239239
```
240240

241241
3. Move the TAP device "silkit_tap" to the network namespace "tap_demo_ns"

‎tap/adapter/CMakeLists.txt

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,24 @@
1-
add_executable(SilKitAdapterTap
1+
add_executable(sil-kit-adapter-tap
22
"SilKitAdapterTap.cpp"
33
"TapConnection.cpp"
44
"Parsing.cpp"
55
"SignalHandler.cpp"
66
)
7-
target_link_libraries(SilKitAdapterTap
7+
target_link_libraries(sil-kit-adapter-tap
88
PRIVATE
99
Utility
1010
asio
1111
SilKit::SilKit
1212
)
13-
set_target_properties(SilKitAdapterTap
13+
set_target_properties(sil-kit-adapter-tap
1414
PROPERTIES
1515
#ensure SilKit shared libraries can be loaded
1616
INSTALL_RPATH "$ORIGIN/../lib:$ORIGIN"
1717
BUILD_RPATH "$ORIGIN"
1818
RUNTIME_OUTPUT_DIRECTORY $<$<BOOL:ALWAYS>:${SILKIT_ADAPTERS_TAP_OUTPUT_DIRECTORY}>
1919
)
2020
add_custom_command(
21-
TARGET SilKitAdapterTap
21+
TARGET sil-kit-adapter-tap
2222
POST_BUILD
2323
COMMAND ${CMAKE_COMMAND}
2424
ARGS -E copy $<TARGET_FILE:SilKit::SilKit> ${SILKIT_ADAPTERS_TAP_LIBRARY_DIRECTORY}/libSilKit.so

‎tap/adapter/Parsing.cpp

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ bool adapters::thereAreUnknownArguments(int argc, char** argv)
4343
void adapters::print_help(bool userRequested)
4444
{
4545
std::cout << "Usage (defaults in curly braces if you omit the switch):" << std::endl
46-
<< "SilKitAdapterTap ["<<participantNameArg<<" <participant's name{EthernetTapDevice}>]\n"
46+
<< "sil-kit-adapter-tap ["<<participantNameArg<<" <participant's name{EthernetTapDevice}>]\n"
4747
" ["<<configurationArg<<" <path to .silkit.yaml or .json configuration file>]\n"
4848
" ["<<regUriArg<<" silkit://<host{localhost}>:<port{8501}>]\n"
4949
" ["<<logLevelArg<<" <Trace|Debug|Warn|{Info}|Error|Critical|Off>]\n"
@@ -53,7 +53,7 @@ void adapters::print_help(bool userRequested)
5353
"SIL Kit-specific CLI arguments will be overwritten by the config file passed by " << configurationArg << ".\n";
5454
std::cout << "\n"
5555
"Example:\n"
56-
"SilKitAdapterTap "<<participantNameArg<<" EthernetTapBridge "
56+
"sil-kit-adapter-tap "<<participantNameArg<<" EthernetTapBridge "
5757
<< networkArg<<" tap_bridge\n";
5858
if (!userRequested)
5959
std::cout << "\n"

‎tap/demos/CANoe4SW_SE/run_all.ps1

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,12 +17,12 @@ $execRegistry = {
1717

1818
$execAdapter = {
1919
param ($ScriptDir)
20-
& $ScriptDir\..\..\..\bin\SilKitAdapterTap.exe --log Debug | Out-File -FilePath $ScriptDir\SilKitAdapterTap.out
20+
& $ScriptDir\..\..\..\bin\sil-kit-adapter-tap.exe --log Debug | Out-File -FilePath $ScriptDir\sil-kit-adapter-tap.out
2121
}
2222

2323
$execDemo = {
2424
param ($ScriptDir)
25-
& $ScriptDir\..\..\..\bin\SilKitDemoEthernetIcmpEchoDevice.exe --log Debug | Out-File -FilePath $ScriptDir\SilKitDemoEthernetIcmpEchoDevice.out
25+
& $ScriptDir\..\..\..\bin\sil-kit-demo-ethernet-icmp-echo-device.exe --log Debug | Out-File -FilePath $ScriptDir\sil-kit-demo-ethernet-icmp-echo-device.out
2626
}
2727

2828
$execPing = {

‎tap/demos/CANoe4SW_SE/run_all.sh

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ timeout 30s grep -q 'Registered signal handler' <(tail -f /$scriptDir/sil-kit-re
2424

2525
$scriptDir/../DemoLinux/start_adapter_and_ping_demo.sh &> $scriptDir/start_adapter_and_ping_demo.out &
2626

27-
$scriptDir/../../../bin/SilKitDemoEthernetIcmpEchoDevice &> $scriptDir/SilKitDemoEthernetIcmpEchoDevice.out &
27+
$scriptDir/../../../bin/sil-kit-demo-ethernet-icmp-echo-device &> $scriptDir/sil-kit-demo-ethernet-icmp-echo-device.out &
2828

2929
$scriptDir/run.sh
3030

‎tap/demos/DemoLinux/README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# Ethernet Demo and Adapter Setup
2-
This demo consists of a TAP device "silkit_tap" which is connected to the SIL Kit via ``SilKitAdapterTap`` as a SIL Kit participant. In a second step this TAP device is moved to a Linux network name space and gets a IP configured which is in the same range as the one of the ``SilKitDemoEthernetIcmpEchoDevice``. The Linux ping application is used within this created network name space to ping ``SilKitDemoEthernetIcmpEchoDevice`` through the TAP device via SIL Kit. The application ``SilKitDemoEthernetIcmpEchoDevice``, which is a SIL Kit participant as well, will reply to an ARP request and respond to ICMPv4 echo requests.
2+
This demo consists of a TAP device "silkit_tap" which is connected to the SIL Kit via ``sil-kit-adapter-tap`` as a SIL Kit participant. In a second step this TAP device is moved to a Linux network name space and gets a IP configured which is in the same range as the one of the ``sil-kit-demo-ethernet-icmp-echo-device``. The Linux ping application is used within this created network name space to ping ``sil-kit-demo-ethernet-icmp-echo-device`` through the TAP device via SIL Kit. The application ``sil-kit-demo-ethernet-icmp-echo-device``, which is a SIL Kit participant as well, will reply to an ARP request and respond to ICMPv4 echo requests.
33

44
The following sketch shows the general setup:
55

@@ -19,7 +19,7 @@ The following sketch shows the general setup:
1919
+----------------------------------------+ +-----------------------------------+
2020

2121

22-
## SilKitDemoEthernetIcmpEchoDevice
22+
## sil-kit-demo-ethernet-icmp-echo-device
2323
This demo application implements a very simple SIL Kit participant with a single simulated ethernet controller.
2424
The application will reply to an ARP request and respond to ICMPv4 Echo Requests directed to it's hardcoded MAC address
2525
(``52:54:56:53:4B:55``) and IPv4 address (``192.168.7.35``).
@@ -29,20 +29,20 @@ The application will reply to an ARP request and respond to ICMPv4 Echo Requests
2929

3030
## Running the Demo Applications
3131

32-
Now is a good point to start the ``sil-kit-registry``, the ``SilKitDemoEthernetIcmpEchoDevice`` and the demo helper script ``start_adapter_and_ping_demo`` - which creates the TAP device, connects it to the adapter and afterwards adds it to the network namespace and starts pinging the echos device from there - in separate terminals:
32+
Now is a good point to start the ``sil-kit-registry``, the ``sil-kit-demo-ethernet-icmp-echo-device`` and the demo helper script ``start_adapter_and_ping_demo`` - which creates the TAP device, connects it to the adapter and afterwards adds it to the network namespace and starts pinging the echos device from there - in separate terminals:
3333

3434
/path/to/SilKit-x.y.z-$platform/SilKit/bin/sil-kit-registry --listen-uri 'silkit://0.0.0.0:8501'
3535
36-
./bin/SilKitDemoEthernetIcmpEchoDevice --log Debug
36+
./bin/sil-kit-demo-ethernet-icmp-echo-device --log Debug
3737

3838
sudo ./tap/demos/DemoLinux/start_adapter_and_ping_demo.sh
3939

40-
The applications will produce output when they send and receive Ethernet frames from the TAP device or the Vector SIL Kit. The console output of ``SilKitAdapterTap`` is redirected to ``./bin/SilKitAdapterTap.out``.
40+
The applications will produce output when they send and receive Ethernet frames from the TAP device or the Vector SIL Kit. The console output of ``sil-kit-adapter-tap`` is redirected to ``./bin/sil-kit-adapter-tap.out``.
4141

4242
## ICMP Ping and Pong
4343
The ping requests should all receive responses.
4444

45-
You should see output similar to the following from the ``SilKitDemoEthernetIcmpEchoDevice`` application:
45+
You should see output similar to the following from the ``sil-kit-demo-ethernet-icmp-echo-device`` application:
4646

4747
[date time] [EthernetDevice] [debug] SIL Kit >> Demo: Ethernet frame (98 bytes)
4848
[date time] [EthernetDevice] [debug] EthernetHeader(destination=EthernetAddress(52:54:56:53:4b:55),source=EthernetAddress(9a:97:c4:83:d8:d0),etherType=EtherType::Ip4)

‎tap/demos/DemoLinux/start_adapter_and_ping_demo.sh

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -20,12 +20,12 @@ fi
2020
echo "Creating tap device silkit_tap"
2121
ip tuntap add dev silkit_tap mode tap
2222

23-
echo "Starting SilKitAdapterTap..."
24-
$SCRIPT_DIR/../../../bin/SilKitAdapterTap --configuration $SCRIPT_DIR/../SilKitConfig_Adapter.silkit.yaml &> /$SCRIPT_DIR/../CANoe4SW_SE/SilKitAdapterTap.out &
23+
echo "Starting sil-kit-adapter-tap..."
24+
$SCRIPT_DIR/../../../bin/sil-kit-adapter-tap --configuration $SCRIPT_DIR/../SilKitConfig_Adapter.silkit.yaml &> /$SCRIPT_DIR/../CANoe4SW_SE/sil-kit-adapter-tap.out &
2525
sleep 1 # wait 1 second for the creation/existense of the .out file
2626

27-
timeout 30s grep -q 'Press CTRL + C to stop the process...' <(tail -f /$SCRIPT_DIR/../CANoe4SW_SE/SilKitAdapterTap.out) || (echo "[error] Timeout reached while waiting for SilKitAdapterTap to start"; exit 1;)
28-
echo "SilKitAdapterTap has been started"
27+
timeout 30s grep -q 'Press CTRL + C to stop the process...' <(tail -f /$SCRIPT_DIR/../CANoe4SW_SE/sil-kit-adapter-tap.out) || (echo "[error] Timeout reached while waiting for sil-kit-adapter-tap to start"; exit 1;)
28+
echo "sil-kit-adapter-tap has been started"
2929

3030
# Hint: It is important to establish the connection to the the adapter before moving the tap device to its separate namespace
3131
echo "Moving tap device 'silkit_tap' to network namespace 'tap_demo_ns'"

‎tap/demos/DemoWindows/README.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
# Ethernet Demo and Adapter Setup
2-
This demo consists of a TAP device "silkit_tap" which is connected to the SIL Kit via ``SilKitAdapterTap`` as a SIL Kit participant. This TAP device gets
3-
a IP configured which is in the same range as the one of the ``SilKitDemoEthernetIcmpEchoDevice``.
4-
The Windows ping application is used to ping ``SilKitDemoEthernetIcmpEchoDevice`` through the TAP device via SIL Kit.
5-
The application ``SilKitDemoEthernetIcmpEchoDevice``, which is a SIL Kit participant as well, will reply to an ARP request and respond to ICMPv4 echo requests.
2+
This demo consists of a TAP device "silkit_tap" which is connected to the SIL Kit via ``sil-kit-adapter-tap`` as a SIL Kit participant. This TAP device gets
3+
a IP configured which is in the same range as the one of the ``sil-kit-demo-ethernet-icmp-echo-device``.
4+
The Windows ping application is used to ping ``sil-kit-demo-ethernet-icmp-echo-device`` through the TAP device via SIL Kit.
5+
The application ``sil-kit-demo-ethernet-icmp-echo-device``, which is a SIL Kit participant as well, will reply to an ARP request and respond to ICMPv4 echo requests.
66

77
The following sketch shows the general setup:
88

@@ -22,7 +22,7 @@ The following sketch shows the general setup:
2222
+----------------------------------------+ +-----------------------------------+
2323

2424

25-
## SilKitDemoEthernetIcmpEchoDevice
25+
## sil-kit-demo-ethernet-icmp-echo-device
2626
This demo application implements a very simple SIL Kit participant with a single simulated ethernet controller.
2727
The application will reply to an ARP request and respond to ICMPv4 Echo Requests directed to it's hardcoded MAC address
2828
(``52:54:56:53:4B:55``) and IPv4 address (``192.168.7.35``).
@@ -46,23 +46,23 @@ netsh interface ip set address silkit_tap static 192.168.7.2 255.255.255.0
4646

4747
## Running the Demo Applications
4848

49-
Now is a good point to start the ``sil-kit-registry``, the ``SilKitDemoEthernetIcmpEchoDevice`` in separate terminals:
49+
Now is a good point to start the ``sil-kit-registry``, the ``sil-kit-demo-ethernet-icmp-echo-device`` in separate terminals:
5050

5151
/path/to/SilKit-x.y.z-$platform/SilKit/bin/sil-kit-registry.exe --listen-uri 'silkit://0.0.0.0:8501'
5252

53-
./bin/SilKitAdapterTap.exe --log Debug
53+
./bin/sil-kit-adapter-tap.exe --log Debug
5454

55-
./bin/SilKitDemoEthernetIcmpEchoDevice.exe --log Debug
55+
./bin/sil-kit-demo-ethernet-icmp-echo-device.exe --log Debug
5656

5757
The applications will produce output when they send and receive Ethernet frames from the TAP device or the Vector SIL Kit.
5858

5959
## ICMP Ping and Pong
60-
To ping the ``SilKitDemoEthernetIcmpEchoDevice`` and make sure the route over the Windows TAP is taken, specify the source as follow:
60+
To ping the ``sil-kit-demo-ethernet-icmp-echo-device`` and make sure the route over the Windows TAP is taken, specify the source as follow:
6161
```
6262
ping 192.168.7.35 -S 192.168.7.2 -t
6363
```
6464

65-
You should see output similar to the following from the ``SilKitDemoEthernetIcmpEchoDevice`` application:
65+
You should see output similar to the following from the ``sil-kit-demo-ethernet-icmp-echo-device`` application:
6666

6767
[date time] [EthernetDevice] [debug] SIL Kit >> Demo: Ethernet frame (98 bytes)
6868
[date time] [EthernetDevice] [debug] EthernetHeader(destination=EthernetAddress(52:54:56:53:4b:55),source=EthernetAddress(9a:97:c4:83:d8:d0),etherType=EtherType::Ip4)

‎tap/demos/IcmpEchoDevice/CMakeLists.txt

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,16 @@
1-
add_executable(SilKitDemoEthernetIcmpEchoDevice
1+
add_executable(sil-kit-demo-ethernet-icmp-echo-device
22
"SilKitDemoEthernetIcmpEchoDevice.cpp"
33
Device.hpp
44
Device.cpp
55
${CMAKE_SOURCE_DIR}/tap/adapter/Parsing.cpp
66
${CMAKE_SOURCE_DIR}/tap/adapter/SignalHandler.cpp
77
)
8-
target_link_libraries(SilKitDemoEthernetIcmpEchoDevice
8+
target_link_libraries(sil-kit-demo-ethernet-icmp-echo-device
99
PRIVATE
1010
Utility
1111
SilKit::SilKit
1212
)
13-
set_target_properties(SilKitDemoEthernetIcmpEchoDevice
13+
set_target_properties(sil-kit-demo-ethernet-icmp-echo-device
1414
PROPERTIES
1515
#ensure SilKit shared libraries can be loaded
1616
INSTALL_RPATH "$ORIGIN/../lib:$ORIGIN"

‎tap/demos/IcmpEchoDevice/SilKitDemoEthernetIcmpEchoDevice.cpp

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -41,13 +41,13 @@ void promptForExit()
4141
void print_demo_help(bool userRequested)
4242
{
4343
std::cout << "Usage (defaults in curly braces if you omit the switch):" << std::endl;
44-
std::cout << "SilKitDemoEthernetIcmpEchoDevice [" << participantNameArg << " <participant's name{EthernetDevice}>]\n"
44+
std::cout << "sil-kit-demo-ethernet-icmp-echo-device [" << participantNameArg << " <participant's name{EthernetDevice}>]\n"
4545
" [" << regUriArg << " silkit://<host{localhost}>:<port{8501}>]\n"
4646
" [" << networkArg << " <SIL Kit Ethernet network name{tap_demo}>]\n"
4747
" [" << logLevelArg << " <Trace|Debug|Warn|{Info}|Error|Critical|Off>]\n";
4848
std::cout << "\n"
4949
"Example:\n"
50-
"SilKitDemoEthernetIcmpEchoDevice " << participantNameArg << " EchoDevice " << networkArg << " tap_network " << logLevelArg << " Off\n ";
50+
"sil-kit-demo-ethernet-icmp-echo-device " << participantNameArg << " EchoDevice " << networkArg << " tap_network " << logLevelArg << " Off\n ";
5151

5252
if (!userRequested)
5353
std::cout << "\n"

0 commit comments

Comments
 (0)