//
// SPDX-License-Identifier: LGPL-3.0-or-later
//

package inet.tutorials.stp;

import inet.common.packet.recorder.PcapRecorder;
import inet.common.scenario.ScenarioManager;
import inet.linklayer.configurator.common.L2NetworkConfigurator;
import inet.linklayer.ieee8021d.tester.StpTester;
import inet.node.ethernet.Eth1G;
import inet.node.ethernet.EthernetHost;
import inet.node.ethernet.EthernetSwitch;
import inet.visualizer.canvas.integrated.IntegratedMultiCanvasVisualizer;


//
// Three Ethernet switches connected in a ring with two hosts.
// Used in Step 1 to demonstrate broadcast loops without STP.
//
network LoopNetwork
{
    submodules:
        visualizer: IntegratedMultiCanvasVisualizer {
            @display("p=100,351;is=s");
        }
        pcapRecorder: PcapRecorder {
            @display("p=100,415;is=s");
        }
        switch1: EthernetSwitch {
            @display("p=300,200");
        }
        switch2: EthernetSwitch {
            @display("p=500,200");
        }
        switch3: EthernetSwitch {
            @display("p=400,350");
        }
        host1: EthernetHost {
            @display("p=100,200");
        }
        host2: EthernetHost {
            @display("p=600,350");
        }
    connections:
        switch1.ethg++ <--> Eth1G <--> switch2.ethg++;
        switch2.ethg++ <--> Eth1G <--> switch3.ethg++;
        switch3.ethg++ <--> Eth1G <--> switch1.ethg++;
        host1.ethg <--> Eth1G <--> switch1.ethg++;
        host2.ethg <--> Eth1G <--> switch3.ethg++;
}

//
// Seven Ethernet switches with redundant links, forming a looped topology.
// Used in Steps 2-5 to demonstrate STP and RSTP tree building.
//
network SwitchNetwork
{
    @figure[simtime](type="simTimeText"; pos=550,400; prefix="SimTime: "; font=,10);
    submodules:
        stpTester: StpTester {
            @display("p=100,100,col,60;g=left;is=s");
        }
        scenarioManager: ScenarioManager {
            @display("p=100,100,col,60;g=left;is=s");
        }
        l2NetworkConfigurator: L2NetworkConfigurator {
            @display("p=100,100,col,60;g=left;is=s");
        }
        visualizer: IntegratedMultiCanvasVisualizer {
            @display("p=100,100,col,60;g=left;is=s");
        }
        pcapRecorder: PcapRecorder {
            @display("p=100,100,col,60;g=left;is=s");
        }
        switch1: EthernetSwitch {
            @display("p=400,100");
        }
        switch2: EthernetSwitch {
            @display("p=475,300");
        }
        switch3: EthernetSwitch {
            @display("p=550,100");
        }
        switch4: EthernetSwitch {
            @display("p=400,200");
        }
        switch5: EthernetSwitch {
            @display("p=625,300");
        }
        switch6: EthernetSwitch {
            @display("p=325,300");
        }
        switch7: EthernetSwitch {
            @display("p=550,200");
        }
        host1: EthernetHost {
            @display("p=200,300");
        }
        host2: EthernetHost {
            @display("p=750,300");
        }
    connections:
        switch1.ethg++ <--> Eth1G <--> switch4.ethg++;
        switch1.ethg++ <--> Eth1G <--> switch3.ethg++;
        switch2.ethg++ <--> Eth1G <--> switch4.ethg++;
        switch2.ethg++ <--> Eth1G <--> switch6.ethg++;
        switch2.ethg++ <--> Eth1G <--> switch7.ethg++;
        switch3.ethg++ <--> Eth1G <--> switch7.ethg++;
        switch4.ethg++ <--> Eth1G <--> switch6.ethg++;
        switch4.ethg++ <--> Eth1G <--> switch7.ethg++;
        switch5.ethg++ <--> Eth1G <--> switch7.ethg++;
        host1.ethg <--> Eth1G <--> switch6.ethg++;
        host2.ethg <--> Eth1G <--> switch5.ethg++;
}

//
// STP variant of SwitchNetwork with STP-specific legend.
//
network StpSwitchNetwork extends SwitchNetwork
{
    @figure[legend](type=text; pos=200,10; text="Port labels: Role/State\nRoles: R=Root D=Designated -=NotAssigned X=Disabled\nStates: F=Forwarding L=Learning B=Blocking N=Listening");
}

//
// RSTP variant of SwitchNetwork with RSTP-specific legend.
//
network RstpSwitchNetwork extends SwitchNetwork
{
    @figure[legend](type=text; pos=200,10; text="Port labels: Role/State\nRoles: R=Root D=Designated A=Alternate B=Backup -=NotAssigned X=Disabled\nStates: F=Forwarding L=Learning D=Discarding");
}

//
// Extends SwitchNetwork with four additional switches and four additional hosts,
// creating a larger meshed topology. Used in Steps 5-8.
//
network LargeNet extends SwitchNetwork
{
    @figure[simtime](type="simTimeText"; pos=550,520; prefix="SimTime: "; font=,10);
    submodules:
        switch8: EthernetSwitch {
            @display("p=475,370");
        }
        switch9: EthernetSwitch {
            @display("p=475,470");
        }
        switch10: EthernetSwitch {
            @display("p=625,470");
        }
        switch11: EthernetSwitch {
            @display("p=625,370");
        }
        host3: EthernetHost {
            @display("p=700,100");
        }
        host4: EthernetHost {
            @display("p=775,470");
        }
        host5: EthernetHost {
            @display("p=325,470");
        }
        host6: EthernetHost {
            @display("p=325,370");
        }
    connections:
        switch11.ethg++ <--> Eth1G <--> switch9.ethg++;
        switch11.ethg++ <--> Eth1G <--> switch10.ethg++;
        switch11.ethg++ <--> Eth1G <--> switch5.ethg++;
        switch9.ethg++ <--> Eth1G <--> switch10.ethg++;
        switch8.ethg++ <--> Eth1G <--> switch9.ethg++;
        switch8.ethg++ <--> Eth1G <--> switch11.ethg++;
        switch8.ethg++ <--> Eth1G <--> switch5.ethg++;
        switch8.ethg++ <--> Eth1G <--> switch2.ethg++;
        switch3.ethg++ <--> Eth1G <--> host3.ethg;
        host4.ethg <--> Eth1G <--> switch10.ethg++;
        host5.ethg <--> Eth1G <--> switch9.ethg++;
        host6.ethg <--> Eth1G <--> switch8.ethg++;
}

//
// STP variant of LargeNet with STP-specific legend.
//
network StpLargeNet extends LargeNet
{
    @figure[legend](type=text; pos=200,10; text="Port labels: Role/State\nRoles: R=Root D=Designated -=NotAssigned X=Disabled\nStates: F=Forwarding L=Learning B=Blocking N=Listening");
}

//
// RSTP variant of LargeNet with RSTP-specific legend.
//
network RstpLargeNet extends LargeNet
{
    @figure[legend](type=text; pos=200,10; text="Port labels: Role/State\nRoles: R=Root D=Designated A=Alternate B=Backup -=NotAssigned X=Disabled\nStates: F=Forwarding L=Learning D=Discarding");
}

//
// Dumbbell-shaped network: two internally meshed clusters of four switches each,
// connected only through two bridge switches in the middle. Used in Step 9.
//
network BottleneckNetwork
{
    submodules:
        stpTester: StpTester {
            @display("p=50,50;is=s");
        }
        scenarioManager: ScenarioManager {
            @display("p=50,120;is=s");
        }
        l2NetworkConfigurator: L2NetworkConfigurator {
            @display("p=50,190;is=s");
        }
        visualizer: IntegratedMultiCanvasVisualizer {
            @display("p=50,260;is=s");
        }
        pcapRecorder: PcapRecorder {
            @display("p=50,330;is=s");
        }

        // Left cluster
        switchL1: EthernetSwitch {
            @display("p=250,100");
        }
        switchL2: EthernetSwitch {
            @display("p=250,300");
        }
        switchL3: EthernetSwitch {
            @display("p=400,150");
        }
        switchL4: EthernetSwitch {
            @display("p=400,300");
        }

        // Bridge switches
        switch11: EthernetSwitch {
            @display("p=550,150");
        }
        switch12: EthernetSwitch {
            @display("p=550,300");
        }

        // Right cluster
        switchR1: EthernetSwitch {
            @display("p=850,100");
        }
        switchR2: EthernetSwitch {
            @display("p=850,300");
        }
        switchR3: EthernetSwitch {
            @display("p=700,150");
        }
        switchR4: EthernetSwitch {
            @display("p=700,300");
        }

        // Hosts
        host1: EthernetHost {
            @display("p=100,100");
        }
        host2: EthernetHost {
            @display("p=100,300");
        }
        host3: EthernetHost {
            @display("p=1000,100");
        }
        host4: EthernetHost {
            @display("p=1000,300");
        }

    connections:
        // Left cluster mesh
        switchL1.ethg++ <--> Eth1G <--> switchL2.ethg++;
        switchL1.ethg++ <--> Eth1G <--> switchL3.ethg++;
        switchL2.ethg++ <--> Eth1G <--> switchL3.ethg++;
        switchL2.ethg++ <--> Eth1G <--> switchL4.ethg++;
        switchL3.ethg++ <--> Eth1G <--> switchL4.ethg++;

        // Right cluster mesh
        switchR1.ethg++ <--> Eth1G <--> switchR2.ethg++;
        switchR1.ethg++ <--> Eth1G <--> switchR3.ethg++;
        switchR2.ethg++ <--> Eth1G <--> switchR3.ethg++;
        switchR2.ethg++ <--> Eth1G <--> switchR4.ethg++;
        switchR3.ethg++ <--> Eth1G <--> switchR4.ethg++;

        // Bridge links (bottleneck)
        switchL3.ethg++ <--> Eth1G <--> switch11.ethg++;
        switch11.ethg++ <--> Eth1G <--> switchR3.ethg++;
        switchL4.ethg++ <--> Eth1G <--> switch12.ethg++;
        switch12.ethg++ <--> Eth1G <--> switchR4.ethg++;

        // Host connections
        host1.ethg <--> Eth1G <--> switchL1.ethg++;
        host2.ethg <--> Eth1G <--> switchL2.ethg++;
        host3.ethg <--> Eth1G <--> switchR1.ethg++;
        host4.ethg <--> Eth1G <--> switchR2.ethg++;
}