Time-Aware Shaping - Showcase

[adamgeorge309]

Discuss the "Time-Aware Shaping" showcase here. Ideas and recommendations are welcome.

[ar8384]

Hello everyone,

I have trouble to understand the logic behind the offset parameter of PeriodicGate.
As far as I understand, the real value of the offset is offset - duration while offset > 0 and offset > duration. In which case, a configuration where offset = 8ms and duration = [2ms, 2ms] would be equivalent to offset = 0ms and duration = [2ms, 2ms]. Am I right?

Thank you in advance

(I also saw what seems to be a misprint to me in this line: *.client.app[*].source.packetLength = 1000B - 54B # 42B = 8B (UDP) + 20B (IP) + 14B (ETH MAC) + 4B (ETH FCS) + 8B (ETH PHY): shouldn't it be ... # 54B = ... ?)

[adamgeorge309]

Yes, you are right on both; offset = 8ms and durations = [2ms, 2ms] is equivalent to offset = 0ms, because the offset is an integer multiple of the duration. So you just shift the closing and opening times with two complete gate cycles.

So basically the durations parameter specifies when the gate is open and closed within a duration of a gate cycle. This pattern then repeats in each gate cycle. The offset parameter can shift this within the gate cycle. So it is possible to describe the same pattern with just using the durations parameter.

The offset shifts the pattern by selecting a point in the pattern, and the pattern starts at that point in the beginning of the gate cycle.

Also, thanks for the typo, it is 54B

[Kueshen]

Hi,
I am following the example posted here https://inet.omnetpp.org/docs/showcases/tsn/trafficshaping/timeawareshaper/doc/index.html. However, I cannot find the NED file used to generate the network. Any chance you can upload this file?

Regards

[adamgeorge309]

It is using TsnLinearNetwork (in the ini file: network = inet.networks.tsn.TsnLinearNetwork). It is located in inet/src/networks/tsn/TsnLinearNetwork.ned.

[Kueshen]

Thanks for the info! Do you have any example of 802.1AS and 802.1Qbv working together? I have issues when enabling both. See example attached. Any clue? Thanks!

Ned file:
//
// This program is free software: you can redistribute it and/or modify
// it under the terms of the GNU Lesser General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public License
// along with this program. If not, see http://www.gnu.org/licenses/.
//

package simple_qbv;

@license(LGPL);

//package inet.examples.ieee8021as;
import inet.networks.base.TsnNetworkBase;
import inet.linklayer.ieee8021as.GptpMaster;
//import inet.linklayer.ieee8021as.GptpBridge;
//import inet.linklayer.ieee8021as.GptpMaster;
//import inet.linklayer.ieee8021as.GptpSlave;
//import inet.networklayer.configurator.contract.IL3NetworkConfigurator;
//import inet.networklayer.configurator.contract.INetworkConfigurator;
//import inet.networklayer.configurator.ipv4.Ipv4NetworkConfigurator;
//import inet.node.ethernet.Eth100M;
import inet.node.ethernet.EthernetLink;
import inet.node.tsn.TsnClock;
//import inet.node.inet.StandardHost;
import inet.node.tsn.TsnDevice;
import inet.node.tsn.TsnSwitch;
import inet.common.scenario.ScenarioManager;
//import inet.visualizer.common.GateScheduleVisualizer;

network SimpleReferenceQbv extends TsnNetworkBase
{
@display("bgb=1127.74,565");
types:
channel Ethernet100 extends ned.DatarateChannel
{
datarate = 100Mbps;
delay = 25ns; // Length of connection is 5 meters
}
submodules:
client: TsnDevice {
@display("p=900,200");
}
server: TsnDevice {
@display("p=400,200");
}
switch4: TsnSwitch {
@display("p=800,200");
}
switch3: TsnSwitch {
@display("p=700,200");
}
switch2: TsnSwitch {
@display("p=600,200");
}
switch1: TsnSwitch {
@display("p=500,200");
}
grand_leader: TsnClock {
@display("p=500,75");
}
connections:
client.ethg++ <--> Ethernet100 <--> switch4.ethg++;
switch4.ethg++ <--> Ethernet100 <--> switch3.ethg++;
switch3.ethg++ <--> Ethernet100 <--> switch2.ethg++;
switch2.ethg++ <--> Ethernet100 <--> switch1.ethg++;
switch1.ethg++ <--> Ethernet100 <--> server.ethg++;
grand_leader.ethg++ <--> Ethernet100 <--> switch1.ethg++;
}

omnetpp.ini

[General]
network = simple_qbv.SimpleReferenceQbv
sim-time-limit = 1s
description = "Traffic shaping using time-aware shapers + 802.1AS"

*.visualizer.typename = "IntegratedMultiCanvasVisualizer"
*.visualizer.infoVisualizer.displayInfos = true
#**.displayGateSchedules = true

Set all reference clocks to master clock so the time difference can be visualized

**.referenceClock = "grand_leader.clock"

enable time synchronization in all network nodes

..hasTimeSynchronization = true

data link visualizer displays gPTP time synchronization packets

*.visualizer.dataLinkVisualizer[0].displayLinks = true
*.visualizer.dataLinkVisualizer[0].activityLevel = "protocol"
*.visualizer.dataLinkVisualizer[0].packetFilter = "GptpSync"
*.visualizer.dataLinkVisualizer[0].lineColor = "blue2"

*.visualizer.numInfoVisualizers = 3
.visualizer.infoVisualizer[0].modules = ".grand_leader.clock"
.grand_leader.clock.displayStringTextFormat = "time: %T"
.visualizer.infoVisualizer[1].modules = ".switch.clock"
.visualizer.infoVisualizer[1].placementHint = "topLeft"
.visualizer.infoVisualizer[2].modules = ".tsnDevice.clock"
*.visualizer.infoVisualizer[2].placementHint = "bottom"
.switch.clock.displayStringTextFormat = "diff: %d"
*.server.clock.displayStringTextFormat = "diff: %d"
*.client.clock.displayStringTextFormat = "diff: %d"

.gateFilter = ".eth[1].**"
**.gateScheduleVisualizer.height = 16
**.gateScheduleVisualizer.placementHint = "top"

all oscillators have a random constant drift

**.oscillator.typename = "ConstantDriftOscillator"
**.oscillator.driftRate = uniform(-100ppm, 100ppm)

all Ethernet interfaces have 100 Mbps speed

..eth[*].bitrate = 100Mbps

client applications

*.client.numApps = 2
.client.app[].typename = "UdpSourceApp"
*.client.app[0].display-name = "best effort"
*.client.app[1].display-name = "video"
.client.app[].io.destAddress = "server"
*.client.app[0].io.destPort = 1000
*.client.app[1].io.destPort = 1001
.client.app[].source.packetLength = 1000B - 54B # 42B = 8B (UDP) + 20B (IP) + 14B (ETH MAC) + 4B (ETH FCS) + 8B (ETH PHY)
*.client.app[0].source.productionInterval = exponential(200us) # ~40Mbps
*.client.app[1].source.productionInterval = exponential(400us) # ~20Mbps

server applications

*.server.numApps = 2
.server.app[].typename = "UdpSinkApp"
*.server.app[0].io.localPort = 1000
*.server.app[1].io.localPort = 1001

enable outgoing streams

*.client.hasOutgoingStreams = true

client stream identification

*.client.bridging.streamIdentifier.identifier.mapping = [{stream: "best effort", packetFilter: expr(udp.destPort == 1000)},
{stream: "video", packetFilter: expr(udp.destPort == 1001)}]

client stream encoding

*.client.bridging.streamCoder.encoder.mapping = [{stream: "best effort", pcp: 0},
{stream: "video", pcp: 4}]

enable egress traffic shaping

*.switch4.hasEgressTrafficShaping = true
*.switch3.hasEgressTrafficShaping = true
*.switch2.hasEgressTrafficShaping = true
*.switch1.hasEgressTrafficShaping = true

time-aware traffic shaping

.switch4.eth[].macLayer.queue.numTrafficClasses = 2
.switch4.eth[].macLayer.queue.[0].display-name = "best effort"
.switch4.eth[].macLayer.queue.[1].display-name = "video"
.switch4.eth[].macLayer.queue.transmissionGate[0].offset = 0ms
.switch4.eth[].macLayer.queue.transmissionGate[0].durations = [4ms, 6ms] # period is 10 # length of periods
.switch4.eth[].macLayer.queue.transmissionGate[1].offset = 6ms
.switch4.eth[].macLayer.queue.transmissionGate[1].durations = [2ms, 8ms]

.switch3.eth[].macLayer.queue.numTrafficClasses = 2
.switch3.eth[].macLayer.queue.[0].display-name = "best effort"
.switch3.eth[].macLayer.queue.[1].display-name = "video"
.switch3.eth[].macLayer.queue.transmissionGate[0].offset = 0.1ms
.switch3.eth[].macLayer.queue.transmissionGate[0].durations = [4ms, 6ms] # period is 10 # length of periods
.switch3.eth[].macLayer.queue.transmissionGate[1].offset = 6.1ms
.switch3.eth[].macLayer.queue.transmissionGate[1].durations = [2ms, 8ms]

.switch2.eth[].macLayer.queue.numTrafficClasses = 2
.switch2.eth[].macLayer.queue.[0].display-name = "best effort"
.switch2.eth[].macLayer.queue.[1].display-name = "video"
.switch2.eth[].macLayer.queue.transmissionGate[0].offset = 0.2ms
.switch2.eth[].macLayer.queue.transmissionGate[0].durations = [4ms, 6ms] # period is 10 # length of periods
.switch2.eth[].macLayer.queue.transmissionGate[1].offset = 6.2ms
.switch2.eth[].macLayer.queue.transmissionGate[1].durations = [2ms, 8ms]

.switch1.eth[].macLayer.queue.numTrafficClasses = 2
.switch1.eth[].macLayer.queue.[0].display-name = "best effort"
.switch1.eth[].macLayer.queue.[1].display-name = "video"
.switch1.eth[].macLayer.queue.transmissionGate[0].offset = 0.3ms
.switch1.eth[].macLayer.queue.transmissionGate[0].durations = [4ms, 6ms] # period is 10 # length of periods
.switch1.eth[].macLayer.queue.transmissionGate[1].offset = 6.3ms
.switch1.eth[].macLayer.queue.transmissionGate[1].durations = [2ms, 8ms]

time sync set up

*.grand_leader.gptp.masterPorts = ["eth0"]

*.server.gptp.slavePort= "eth0"
*.client.gptp.slavePort= "eth0"

*.switch1.gptp.slavePort= "eth0"
*.switch1.gptp.masterPorts = ["eth1"]
*.switch2.gptp.slavePort= "eth0"
*.switch2.gptp.masterPorts = ["eth1"]
*.switch3.gptp.slavePort= "eth0"
*.switch3.gptp.masterPorts = ["eth1"]
*.switch4.gptp.slavePort = "eth0"
*.switch4.gptp.masterPorts = ["eth1"]

[levy]

Did you see this example?

https://inet.omnetpp.org/docs/showcases/tsn/combiningfeatures/gptpandtas/doc/index.html

[wehyy]

Hello everyone,
May I ask a question about the OMNeT++ sequence charts? I would like to know how to modify the message color in the OMNeT++ ELOG file, similar to the example in this showcase.
this is in the showcase:

and this is in my trying:

[levy]

You can do this on the Sequence Chart in the IDE only. There's a color gradient icon on the toolbar that activates the color coding dialog. You can assign colors to message filter expressions in that dialog. I hope this helps.

[levy]

Could you please make a new issue for this? As I see, it isn't directly related to this showcase.

[ar8384]

Yes, you're right. I'll do it.

[tuantitu22]

Hello,
When I try to add numTrafficClasses to 8, and allocate 8 apps to 8 pcps. Then stream of pcp 1 is transmitted when transmissionGate 0 is open, and stream of pcp 0 is transmitted when transmissionGate 1 is open. The others are fine. Is it correct? Why there is a reverse for gate 0 and 1?
Thanks!

[levy]

That is correct. See PcpTrafficClassClassifier.ned file, there's an excerpt from the IEEE Standard for Local and Metropolitan Area Networks, Bridges and Bridged Networks, Table 8-5—Recommended priority to traffic class mappings.

[tuantitu22]

Get it. Thank you very much!

[Abh4git]

Hi,

Can any of you help me with the buffer size of a TSN Switch by default? My links are Eth100M. I couldn't find this detail anywhere
Thank you!

Thanks
Regards
Abhilash

[levy]

The PacketQueue module doesn't have default limits but you can configure them using packetCapacity and dataCapacity parameters.

[Abh4git]

Thank you!

[Abh4git]

In Time Aware shaping showcase we could work with the TSNScheduleConfigurator and Scheduler. Is there a similar schedule for EDF (Earliest Deadline First) ? Is EagerScheduler EDF based? or is it just greedily scheduling. If not there can you please suggest me a path to have an EDF Scheduler? Thanks a lot for the help!

[levy]

The EagerGateScheduleConfigurator is just a greedy scheduler, it can easily fail to find a solution. I don't really know what an EDF scheduler is, but you can always implement your own GateScheduleConfigurator module.

[Abh4git]

Thank you very much! So that means the Earliest Deadline First scheduler needs to be created. Thank you for providing clarity.

[madhusrivatsav]

Can you give me some reference on how to implement our own Gateschedule configurator ?

[Abh4git]

Yes Better to have your own Base as well

1. Create your own implementation of TestGateScheduleConfiguratorBase : public NetworkConfiguratorBase
2. Now we can create our scheduler MyTestGateScheduleConfigurator : public TestGateScheduleConfiguratorBase
3. We can use these in our configuration files.
   Note: The code for existing schedulers are in inet/src

[madhusrivatsav]

Thank you for your reply. I ll check it out

[madhusrivatsav]

Is there any example that uses the gate control list to control the gates in a TSN network ?

[Abh4git]

Yes, Its TSN Gatescheduling, right there in the showcase folder with inet. https://inet.omnetpp.org/docs/showcases/tsn/gatescheduling/tsnsched/doc/index.html

[madhusrivatsav]

Thank you for your reply.
I want to create my own gate schedule to control the gates, and not use TSNschedGateScheduleConfigurator. Is there any example that shows that ?

[Frt0214]

Hi mate! I had a similar problem. Do you have any ideas about the example of configuring gating entries yourself?

[Abh4git]

Hi, The code is the best example. There are EagerGateschedulerconfigurator as well. You can see how they have implemented and go ahead with your own. RegardsAbhilash  On Tuesday, January 30, 2024 at 04:03:14 PM GMT+5:30, Madhuvanthi Srivatsav R ***@***.***> wrote: Thank you for your reply. I want to create my own gate schedule to control the gates, and not use TSNschedGateScheduleConfigurator. Is there any example that shows that ? — Reply to this email directly, view it on GitHub, or unsubscribe. You are receiving this because you commented.Message ID: ***@***.***>

[madhusrivatsav]

Hi .. I am not able to run TSNSched simulation on windows. I have installed TSNSched and Z3 solver. Can you please help ?

[Abh4git]

Hi Please explain with exact environment and what problems you are facing including the steps and error details. Then only someone can help.  On Tuesday, January 30, 2024 at 09:18:41 PM GMT+5:30, Madhuvanthi Srivatsav R ***@***.***> wrote: Hi .. I am not able to run TSNSched simulation on windows. I have installed TSNSched and Z3 solver. Can you please help ? — Reply to this email directly, view it on GitHub, or unsubscribe. You are receiving this because you commented.Message ID: ***@***.***>

[madhusrivatsav]

Hi
Thanks for your reply. The issue got resolved.

[madhusrivatsav]

Is it possible to set PCP values using an expression?
I am trying to set it like this.
*.client.bridging.streamCoder.encoder.mapping = [{stream: "R1", pcp: expr(int(simTime()*1000))}]

[Frt0214]

Hello everyone!

I have trouble to config my own gcl. Due to the propagation delay of links and the transmission delay of switching nodes, packets do not arrive gated immediately. After I set the hasGcl parameter to true, how do I configure some parameters so that the gate entry starts running GCL after the propagation delay of the link and the transfer delay of the switch node? This is like starting the Gcl run when Operbasetime>=Currenttime is specified in IEEE802.1Qbv. Here is my gating configuration, I want to start running Gcl entries after 8936ns.

*.switch1.eth[3].macLayer.queue.numTrafficClasses = 3
*.switch1.eth[3].macLayer.queue.hasGcl=true
*.switch1.eth[3].macLayer.queue.gateControlList.numGates=3
*.switch1.eth[3].macLayer.queue.gateControlList.offset = 8936us
*.switch1.eth[3].macLayer.queue.gateControlList.gateStates=["001","110","000"]
*.switch1.eth[3].macLayer.queue.gateControlList.durations = [8us,984us,8us]
*.switch1.eth[3].macLayer.queue.gateControlList.mapping="012"
*.switch1.eth[3].macLayer.queue.[0].display-name = "interface"
*.switch1.eth[3].macLayer.queue.[1].display-name = "be"
*.switch1.eth[3].macLayer.queue.[2].display-name = "tt"

Best Regards
Jack

[Prabharoop]

Hi,
I am working on TSN. Just a basic example like in the showcase of 2 TSN end devices and 1 switch in between. I would like to see the number of packets received at the switch and leaving the switch on a real-time basis. I noticed that qt gui shows some of this information. Can this information be collected outside and displayed as real-time data while simulations are running? Can you please help us with any pointers or examples in this direction?
@levy @avarga

[adamgeorge309]

The StatisticVisualizer module can display statistics in real-time in Qtenv. More info here: https://inet.omnetpp.org/docs/showcases/visualizer/canvas/statistic/doc/index.html

[Prabharoop]

Hi,

Thank you for your answer. But as mentioned, I need to collect these signals/ statistics in real-time, possibly from another module (For example, a cSimpleModule?) so that we can use it for further processing in real-time, rather than monitoring from Qtenv.