ExtUpperEthernetInterface

Package: inet.emulation.linklayer.ethernet

ExtUpperEthernetInterface

compound module

This module provides an Ethernet network interface suitable for emulation. The upper part of the network interface is realized in the real world using a real TAP device of the host computer which is running the simulation.

pcapRecorder[numPcapRecorders] : PcapRecorder

Records PCAP traces of frames sent/received by other modules within the same host.

Source:
pcapRecorder[numPcapRecorders]: PcapRecorder {
    parameters:
        moduleNamePatterns = ".^";
        @display("p=100,100;is=s");
} clock : like IClock

IClock: This module interface is implemented by clock models.

Source:
clock: <default("")> like IClock if typename != "" {
    parameters:
        @display("p=100,200;is=s");
} tap : ExtEthernetTapDevice

This module provides a bidirectional connection to a real TAP device of the host computer which is...

Source:
tap: ExtEthernetTapDevice {
    parameters:
        @display("p=350,100");
} queue : like IPacketQueue

EthernetQueue: Queue module that gives the PAUSE frames a higher priority.

IPacketQueue: This module interface is implemented by packet queue modules.

Source:
queue: <default("EthernetQueue")> like IPacketQueue {
    parameters:
        packetCapacity = default(10000);
        @display("p=250,200");
} mac : like IEtherMac

IEtherMac: Interface for Ethernet MAC implementations.

Source:
mac: <default(csmacdSupport ? "EthernetCsmaMac" : "EthernetMac")> like IEtherMac {
    parameters:
        @display("p=350,300");
}

Usage diagram

The following diagram shows usage relationships between types. Unresolved types are missing from the diagram.

Inheritance diagram

The following diagram shows inheritance relationships for this type. Unresolved types are missing from the diagram.

Extends

Name Type Description
ExtInterface compound module

This module provides a base module for external network interfaces.

Parameters

Name Type Default value Description
displayStringTextFormat string "%a (%i)\n%m"
recordPcap bool false
numPcapRecorders int recordPcap ? 1 : 0
isWireless bool false
interfaceTableModule string
device string
namespace string ""
copyConfiguration string ""
address string "auto"
broadcast bool true
multicast bool true
pointToPoint bool false
mtu int 4470B
csmacdSupport bool false

by default CSMA/CD is turned off, so only point-to-point duplex links are supported.

bitrate double nan bps

Properties

Name Value Description
networkInterface
lifecycleSupport
class ExtInterface
display bgb=450,400

Gates

Name Direction Size Description
upperLayerIn input
upperLayerOut output
cutthroughIn input
cutthroughOut output
phys inout

Signals

Name Type Unit
packetDropped inet::Packet

Statistics

Name Title Source Record Unit Interpolation Mode
packetDropInterfaceDown packet drops: interface down packetDropReasonIsInterfaceDown(packetDropped) count, sum(packetBytes), vector(packetBytes) none
packetDropNoCarrier packet drops: no carrier packetDropReasonIsNoCarrier(packetDropped) count, sum(packetBytes), vector(packetBytes) none

Unassigned submodule parameters

Name Type Default value Description
pcapRecorder.verbose bool true

whether to log packets on the module output

pcapRecorder.pcapFile string ""

the PCAP file to be written

pcapRecorder.fileFormat string "pcapng"
pcapRecorder.snaplen int 65535

maximum number of bytes to record per packet

pcapRecorder.dumpBadFrames bool true

enable dump of frames with hasBitError

pcapRecorder.sendingSignalNames string "packetSentToLower"

space-separated list of outbound packet signals to subscribe to

pcapRecorder.receivingSignalNames string "packetReceivedFromLower"

space-separated list of inbound packet signals to subscribe to

pcapRecorder.dumpProtocols string "ethernetmac ppp ieee80211mac"

space-separated list of protocol names as defined in the Protocol class

pcapRecorder.packetFilter object "*"

which packets are considered, matches all packets by default

pcapRecorder.helpers string ""

usable PcapRecorder::IHelper helpers for accept packettype and store/convert packet as specified linktype currently available: "inet::AckingMacToEthernetPcapRecorderHelper"

pcapRecorder.alwaysFlush bool false

flush the pcapFile after each write to ensure that all packets are captured in case of a crash

pcapRecorder.displayStringTextFormat string "rec: %n pks"
tap.device string

name of existing real tap interface

tap.namespace string ""
tap.packetNameFormat string "Ext-%p-%t-%n"
mac.promiscuous bool

if true, all packets are received, otherwise only the ones with matching destination MAC address

mac.duplexMode bool

selects full-duplex (true) or half-duplex (false) operation

mac.mtu int

Source code

//
// This module provides an Ethernet network interface suitable for emulation.
// The upper part of the network interface is realized in the real world using
// a real TAP device of the host computer which is running the simulation.
//
module ExtUpperEthernetInterface extends ExtInterface like IEthernetInterface
{
    parameters:
        bool csmacdSupport = default(false);  // by default CSMA/CD is turned off, so only point-to-point duplex links are supported.
        double bitrate @unit(bps) = default(nan bps);
        @display("bgb=450,400");
    gates:
        input cutthroughIn @loose;
        output cutthroughOut @loose;
        inout phys @labels(EthernetSignal);
    submodules:
        tap: ExtEthernetTapDevice {
            parameters:
                @display("p=350,100");
        }
        queue: <default("EthernetQueue")> like IPacketQueue {
            parameters:
                packetCapacity = default(10000);
                @display("p=250,200");
        }
        mac: <default(csmacdSupport ? "EthernetCsmaMac" : "EthernetMac")> like IEtherMac {
            parameters:
                @display("p=350,300");
        }
    connections allowunconnected:
        tap.lowerLayerOut --> queue.in;
        queue.out --> mac.upperLayerIn;
        tap.lowerLayerIn <-- mac.upperLayerOut;
        mac.phys <--> { @display("m=s"); } <--> phys;
}

File: src/inet/emulation/linklayer/ethernet/ExtUpperEthernetInterface.ned