MecHost

Package: simu5g.nodes

MecHost

compound module

Represents a model of a Multi-access Edge Computing (MEC) host belonging to a MEC system, as specified by the ETSI GS MEC 003 specifications. It runs MEC applications within its VirtualisationInfrastructure and can provide a number of MEC services via the MEC platform. MEC applications can be created either dynamically by the MEC orchestrator or statically at the initialization of the simulation. The MEC host possesses a configurable number of computing resources (such as CPU speed, RAM, and storage) and keeps track of the utilization of these resources by the MEC applications via the VirtualisationInfrastructureManager. Moreover, this module includes a User Plane Function (UPF) that allows it to be connected with the 5G core network.

virtualisationInfrastructure : VirtualisationInfrastructure Represents the Virtualisation Infrastructure in a MEC host. Source: virtualisationInfrastructure: VirtualisationInfrastructure { parameters: @display("p=500,400"); gateway = parent.gateway; } mecPlatform : MecPlatform Represents the MEC Platform entity within a ~MecHost, as specified in the ETSI MEC architecture... Source: mecPlatform: MecPlatform { parameters: @display("p=573,158"); } mecPlatformManager : MecPlatformManager Implements the MEC platform manager (MECPM) entity within the ~MecHost. Source: mecPlatformManager: MecPlatformManager { parameters: @display("p=865,116;is=m"); } vim : VirtualisationInfrastructureManager Manages the computing resources currently allocated to MEC applications hosted by a MEC host. Source: vim: VirtualisationInfrastructureManager { parameters: @display("p=865,224;is=m"); } upf_mec : Upf Implements the 5G Core User Plane Function (UPF). Source: upf_mec: Upf { parameters: @display("p=150,400"); nodeType = "UPF_MEC"; gateway = parent.gateway; } bgApp[numBgMecApps] : BackgroundApp Can be used to simulate a background application running on the MEC host without simulating all... Source: bgApp[numBgMecApps]: BackgroundApp { @display("p=865,326,row,140"); } independentMecApp[numIndependentMecApp] : like IApp IApp [from inet] ↗: Generic application interface. Source: independentMecApp[numIndependentMecApp]: <> like IApp { @display("p=371,156,row,140"); }

Usage diagram

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

Used in

Name Type Description
ExtMecAppExample network

One gNodeB and one MecHost hung off the same intermediate Upf, behind an anchor Upf that carries the Ualcmp and, behind it, the MecOrchestrator, plus one NrUe. Nothing here is external: which node talks to a real host, and over which interface, is configured in the ini file.
ExtUeAppExample network

One gNodeB and one MecHost hung off the same intermediate Upf, behind an anchor Upf that carries the Ualcmp and, behind it, the MecOrchestrator, plus one NrUe. Nothing here is external: which node talks to a real host, and over which interface, is configured in the ini file.
ExtUeAppMecAppExample network

One gNodeB and one MecHost hung off the same intermediate Upf, behind an anchor Upf that carries the Ualcmp and, behind it, the MecOrchestrator, plus one NrUe. Nothing here is external: which node talks to a real host, and over which interface, is configured in the ini file.
MultiMecHost network

Two gNodeB cells, each on an intermediate Upf of its own with a MecHost hung off it, so every cell has its own MEC host. Both intermediate Upf nodes meet at the anchor Upf, which carries the Ualcmp and, behind it, the MecOrchestrator. An X2 link joins the two gNodeBs. numUe NrUe terminals attach, and numBgCells BackgroundCell cells can be added as interferers.
MultiMecHost_delay network

MultiMecHost with the two intermediate Upf nodes linked directly to each other, and with no X2 link between the gNodeBs. The length of that link -- and so its propagation delay -- follows the routersDelay parameter, which makes the distance between the two MEC hosts configurable.
MultiOperator network

Two operator networks side by side. Each has three gNodeB cells chained by X2, an intermediate Upf that feeds them and carries the operator's MecHost, an anchor Upf, and a Ualcmp with its MecOrchestrator. The two anchor Upf nodes meet at a shared router, the only node the operators have in common. numUe_A and numUe_B NrUe terminals attach to operator A and B respectively, and numBgCells BackgroundCell cells can be added as interferers.
RnisTest network

The topology of SingleMecHost -- one gNodeB and one MecHost on a shared intermediate Upf, with a Ualcmp and a MecOrchestrator behind the anchor Upf -- without its playground size parameters. numUes NrUe terminals attach to the gNodeB.
SingleMecHost network

One gNodeB and one MecHost hung off the same intermediate Upf, behind an anchor Upf that carries the Ualcmp and, behind it, the MecOrchestrator. numUes NrUe terminals attach to the gNodeB.
UrbanNetwork network (no description)

Parameters

Name Type Default value Description
nodeType string "MecHost"
gateway string "upf"
maxMecApps int 0
maxRam double 32GB
maxDisk double 100TB
maxCpuSpeed double 300000

CPU's clock speed in millions of instructions per second (MIPS)
numBgMecApps int 0
numIndependentMecApp int 0
bsList object []

This is a string of comma-separated values

Properties

Name Value Description
display i=device/server2;bgb=1000,500

Gates

Name Direction Size Description
ppp [ ] inout

To local radio networks
pppIf [ ] inout

To external networks (internet)

Unassigned submodule parameters

Name Type Default value Description
virtualisationInfrastructure.interfaceTable.displayStringTextFormat string "{numInterfaces} interfaces"

Determines the text that is written on top of the submodule, supports displaying pars, watches, and module-specific information
virtualisationInfrastructure.interfaceTable.displayAddresses bool false

Whether to display IP addresses on links
virtualisationInfrastructure.pppIf.pcapRecorder.displayStringTextFormat string "rec: %n pks"

Determines the text that is written on top of the submodule, supports displaying pars, watches, and module-specific information
virtualisationInfrastructure.pppIf.pcapRecorder.verbose bool true

Whether to log packets on the module output
virtualisationInfrastructure.pppIf.pcapRecorder.recordEmptyPackets bool true

Specifies if zero length packets are recorded or not
virtualisationInfrastructure.pppIf.pcapRecorder.enableConvertingPackets bool true

Specifies if converting packets to link type is allowed or not
virtualisationInfrastructure.pppIf.pcapRecorder.pcapFile string ""

The PCAP file to be written, suggested value: pcapFile = "${resultdir}/${configname}-#${runnumber}" + fullpath() + ".pcap"
virtualisationInfrastructure.pppIf.pcapRecorder.fileFormat string "pcapng"
virtualisationInfrastructure.pppIf.pcapRecorder.snaplen int 65535

Maximum number of bytes to record per packet
virtualisationInfrastructure.pppIf.pcapRecorder.timePrecision int 6

Time precision in recorded file. pcap supports only 6 (usec) or 9 (nanosec), pcapng supports more values (see 'if_tsresol' option in pcapng file format).
virtualisationInfrastructure.pppIf.pcapRecorder.dumpBadFrames bool true

Enable dump of frames with hasBitError
virtualisationInfrastructure.pppIf.pcapRecorder.sendingSignalNames string "transmissionEnded"

Space-separated list of outbound packet signals to subscribe to
virtualisationInfrastructure.pppIf.pcapRecorder.receivingSignalNames string "receptionEnded"

Space-separated list of inbound packet signals to subscribe to
virtualisationInfrastructure.pppIf.pcapRecorder.dumpProtocols string "ethernetmac ppp ieee80211mac"

Space-separated list of protocol names as defined in the Protocol class
virtualisationInfrastructure.pppIf.pcapRecorder.packetFilter object "*"

Which packets are considered, matches all packets by default
virtualisationInfrastructure.pppIf.pcapRecorder.helpers string ""

Usable PcapRecorder::IHelper helpers for accept packettype and store/convert packet as specified linktype currently available: "inet::AckingMacToEthernetPcapRecorderHelper"
virtualisationInfrastructure.pppIf.pcapRecorder.alwaysFlush bool false

Flush the pcapFile after each write to ensure that all packets are captured in case of a crash
virtualisationInfrastructure.pppIf.ppp.displayStringTextFormat string "rate: %b\nsent: %s, rcvd: %r\nqueue: %q, drop: %d"

Determines the text that is written on top of the submodule, supports displaying pars, watches, and module-specific information
virtualisationInfrastructure.pppIf.ppp.interfaceTableModule string

The path to the InterfaceTable module
virtualisationInfrastructure.pppIf.ppp.sendRawBytes bool false

When true packets are serialized into a sequence of bytes before sending out
virtualisationInfrastructure.pppIf.ppp.mtu int 4470B
virtualisationInfrastructure.pppIf.ppp.stopOperationExtraTime double -1s

Extra time after lifecycle stop operation finished
virtualisationInfrastructure.pppIf.ppp.stopOperationTimeout double 2s

Timeout value for lifecycle stop operation
virtualisationInfrastructure.extEth.bitrate double
virtualisationInfrastructure.udp.displayStringTextFormat string "passed up: {numPassedUp} pks\nsent: {numSent} pks{udpDroppedText}"

Determines the text that is written on top of the submodule, supports displaying pars, watches, and module-specific information
virtualisationInfrastructure.udp.interfaceTableModule string

The path to the InterfaceTable module
virtualisationInfrastructure.udp.checksumMode string "declared"
virtualisationInfrastructure.udp.defaultMulticastLoop bool true
virtualisationInfrastructure.tcp.displayStringTextFormat string ""

Determines the text that is written on top of the submodule, supports displaying pars, watches, and module-specific information
virtualisationInfrastructure.tcp.checksumMode string "declared"
virtualisationInfrastructure.tcp.advertisedWindow int 14 * this.mss

In bytes, corresponds with the maximal receiver buffer capacity (Note: normally, NIC queues should be at least this size)
virtualisationInfrastructure.tcp.delayedAcksEnabled bool false

Delayed ACK algorithm (RFC 1122) enabled/disabled
virtualisationInfrastructure.tcp.nagleEnabled bool true

Nagle's algorithm (RFC 896) enabled/disabled
virtualisationInfrastructure.tcp.limitedTransmitEnabled bool false

Limited Transmit algorithm (RFC 3042) enabled/disabled (can be used for TcpReno/TcpTahoe/TcpNewReno/TcpNoCongestionControl)
virtualisationInfrastructure.tcp.increasedIWEnabled bool false

Increased Initial Window (RFC 3390) enabled/disabled
virtualisationInfrastructure.tcp.sackSupport bool false

Selective Acknowledgment (RFC 2018, 2883, 3517) support (header option) (SACK will be enabled for a connection if both endpoints support it)
virtualisationInfrastructure.tcp.windowScalingSupport bool false

Window Scale (RFC 1323) support (header option) (WS will be enabled for a connection if both endpoints support it)
virtualisationInfrastructure.tcp.windowScalingFactor int -1

Window Scaling Factor given as a shift count. Valid values are 0..14, and -1 for automatic selection (it chooses the smallest shift count that makes advertisedWindow representable in 16 bits)
virtualisationInfrastructure.tcp.timestampSupport bool false

Timestamps (RFC 1323) support (header option) (TS will be enabled for a connection if both endpoints support it)
virtualisationInfrastructure.tcp.mss int 536

Maximum Segment Size (header option). Default 536 per RFC 1122.
virtualisationInfrastructure.tcp.msl int 120s

Maximum Segment Lifetime
virtualisationInfrastructure.tcp.tcpAlgorithmClass string "TcpReno"
virtualisationInfrastructure.tcp.dupthresh int 3

Used for TcpTahoe, TcpReno, and SACK (RFC 3517) DO NOT change unless you really know what you are doing
virtualisationInfrastructure.tcp.initialSsthresh int 0xFFFFFFFF

Initial value for Slow Start threshold used in TahoeRenoFamily. The initial value of ssthresh SHOULD be set arbitrarily high (e.g., to the size of the largest possible advertised window) Without user interaction there is no limit...
virtualisationInfrastructure.tcp.stopOperationExtraTime double 0s

Extra time after lifecycle stop operation finished
virtualisationInfrastructure.tcp.stopOperationTimeout double 2s

Timeout value for lifecycle stop operation
virtualisationInfrastructure.tcp.ecnWillingness bool false

True if willing to use ECN
virtualisationInfrastructure.tcp.dctcpGamma double 0.0625

A fixed estimation gain for calculating dctcp_alpha (RFC 8257 4.2)
virtualisationInfrastructure.tcp.pmtudEnabled bool false

Path MTU Discovery (RFC 1191, RFC 1981) enabled/disabled
virtualisationInfrastructure.tcp.pmtudTimeout double 600s

Time after which the original MSS is restored to probe for increased path MTU (RFC 1191, Section 6.3)
virtualisationInfrastructure.at.displayStringTextFormat string "processed {numProcessedPackets} pk ({processedTotalLength})"

Determines the text that is written on top of the submodule, supports displaying pars, watches, and module-specific information
virtualisationInfrastructure.at.interfaceTableModule string

Module path to the InterfaceTable module
virtualisationInfrastructure.at.forwardServiceRegistration bool true
virtualisationInfrastructure.at.forwardProtocolRegistration bool true
virtualisationInfrastructure.at.interfaceMapping object {}

Maps network interface names to connected submodule names (e.g. {"eth0": "bridging"}), overrides automatically learned dispatching; * overrides all learned network interfaces, ? overrides default
virtualisationInfrastructure.at.serviceMapping object {}

Maps protocols to connected submodule names (e.g. {"ethernetmac": "bridging"}), overrides automatically learned dispatching; * overrides all learned services, ? overrides default
virtualisationInfrastructure.at.protocolMapping object {}

Maps protocols to connected submodule names (e.g. {"ipv4": "bridging"}), overrides automatically learned dispatching; * overrides all learned protocols, ? overrides default
virtualisationInfrastructure.tn.displayStringTextFormat string "processed {numProcessedPackets} pk ({processedTotalLength})"

Determines the text that is written on top of the submodule, supports displaying pars, watches, and module-specific information
virtualisationInfrastructure.tn.interfaceTableModule string

Module path to the InterfaceTable module
virtualisationInfrastructure.tn.forwardServiceRegistration bool true
virtualisationInfrastructure.tn.forwardProtocolRegistration bool true
virtualisationInfrastructure.tn.interfaceMapping object {}

Maps network interface names to connected submodule names (e.g. {"eth0": "bridging"}), overrides automatically learned dispatching; * overrides all learned network interfaces, ? overrides default
virtualisationInfrastructure.tn.serviceMapping object {}

Maps protocols to connected submodule names (e.g. {"ethernetmac": "bridging"}), overrides automatically learned dispatching; * overrides all learned services, ? overrides default
virtualisationInfrastructure.tn.protocolMapping object {}

Maps protocols to connected submodule names (e.g. {"ipv4": "bridging"}), overrides automatically learned dispatching; * overrides all learned protocols, ? overrides default
virtualisationInfrastructure.nl.displayStringTextFormat string "processed {numProcessedPackets} pk ({processedTotalLength})"

Determines the text that is written on top of the submodule, supports displaying pars, watches, and module-specific information
virtualisationInfrastructure.nl.interfaceTableModule string

Module path to the InterfaceTable module
virtualisationInfrastructure.nl.forwardServiceRegistration bool true
virtualisationInfrastructure.nl.forwardProtocolRegistration bool true
virtualisationInfrastructure.nl.interfaceMapping object {}

Maps network interface names to connected submodule names (e.g. {"eth0": "bridging"}), overrides automatically learned dispatching; * overrides all learned network interfaces, ? overrides default
virtualisationInfrastructure.nl.serviceMapping object {}

Maps protocols to connected submodule names (e.g. {"ethernetmac": "bridging"}), overrides automatically learned dispatching; * overrides all learned services, ? overrides default
virtualisationInfrastructure.nl.protocolMapping object {}

Maps protocols to connected submodule names (e.g. {"ipv4": "bridging"}), overrides automatically learned dispatching; * overrides all learned protocols, ? overrides default
mecPlatform.serviceRegistry.serviceName string "ServiceRegistry"
mecPlatform.serviceRegistry.requestQueueSize int 0
mecPlatform.serviceRegistry.subscriptionQueueSize int 0
mecPlatform.serviceRegistry.localAddress string ""

Local address; may be left empty ("")
mecPlatform.serviceRegistry.localPort int 1000

localPort number to listen on
mecPlatform.serviceRegistry.requestServiceTime double 15us
mecPlatform.serviceRegistry.subscriptionServiceTime double 20us
mecPlatform.serviceRegistry.serverThreadClass string "simu5g.mec.platform.services.base.SocketManager"
mecPlatform.serviceRegistry.tos int -1

If not -1, set the Type of Service (IPv4) / Traffic Class (IPv6) field of sent packets to this value
mecPlatform.serviceRegistry.binderModule string "binder"
mecPlatformManager.mecOrchestrator string
mecPlatformManager.serviceRegistryModule string "^.mecPlatform.serviceRegistry"
mecPlatformManager.vimModule string "^.vim"
vim.binderModule string "binder"
vim.mp1Port int 10021
vim.scheduling string "segregation"
upf_mec.status.displayStringTextFormat string "{stateStr}"

Determines the text that is written on top of the submodule, supports displaying pars, watches, and module-specific information
upf_mec.status.initialStatus string "UP"

TODO @signal, @statistic
upf_mec.environment.displayStringTextFormat string ""

Determines the text that is written on top of the submodule, supports displaying pars, watches, and module-specific information
upf_mec.environment.initStage int 0

Initialization stage for the setup command
upf_mec.environment.globalNamespace bool false

Create new network namespaces under /var/run/netns/ (Linux only)
upf_mec.environment.namespace string ""

Name of the host OS network namespace (optional) (Linux only)
upf_mec.environment.setupCommand string ""

A host OS system command
upf_mec.environment.teardownCommand string ""

A host OS system command
upf_mec.pcapRecorder.displayStringTextFormat string "rec: %n pks"

Determines the text that is written on top of the submodule, supports displaying pars, watches, and module-specific information
upf_mec.pcapRecorder.verbose bool true

Whether to log packets on the module output
upf_mec.pcapRecorder.recordEmptyPackets bool true

Specifies if zero length packets are recorded or not
upf_mec.pcapRecorder.enableConvertingPackets bool true

Specifies if converting packets to link type is allowed or not
upf_mec.pcapRecorder.pcapFile string ""

The PCAP file to be written, suggested value: pcapFile = "${resultdir}/${configname}-#${runnumber}" + fullpath() + ".pcap"
upf_mec.pcapRecorder.fileFormat string "pcapng"
upf_mec.pcapRecorder.snaplen int 65535

Maximum number of bytes to record per packet
upf_mec.pcapRecorder.timePrecision int 6

Time precision in recorded file. pcap supports only 6 (usec) or 9 (nanosec), pcapng supports more values (see 'if_tsresol' option in pcapng file format).
upf_mec.pcapRecorder.dumpBadFrames bool true

Enable dump of frames with hasBitError
upf_mec.pcapRecorder.moduleNamePatterns string "wlan[*] eth[*] ppp[*]"

Space-separated list of sibling module names to listen on
upf_mec.pcapRecorder.sendingSignalNames string "transmissionEnded"

Space-separated list of outbound packet signals to subscribe to
upf_mec.pcapRecorder.receivingSignalNames string "receptionEnded"

Space-separated list of inbound packet signals to subscribe to
upf_mec.pcapRecorder.dumpProtocols string "ethernetmac ppp ieee80211mac"

Space-separated list of protocol names as defined in the Protocol class
upf_mec.pcapRecorder.packetFilter object "*"

Which packets are considered, matches all packets by default
upf_mec.pcapRecorder.helpers string ""

Usable PcapRecorder::IHelper helpers for accept packettype and store/convert packet as specified linktype currently available: "inet::AckingMacToEthernetPcapRecorderHelper"
upf_mec.pcapRecorder.alwaysFlush bool false

Flush the pcapFile after each write to ensure that all packets are captured in case of a crash
upf_mec.interfaceTable.displayStringTextFormat string "{numInterfaces} interfaces"

Determines the text that is written on top of the submodule, supports displaying pars, watches, and module-specific information
upf_mec.interfaceTable.displayAddresses bool false

Whether to display IP addresses on links
upf_mec.cb.displayStringTextFormat string "processed {numProcessedPackets} pk ({processedTotalLength})"

Determines the text that is written on top of the submodule, supports displaying pars, watches, and module-specific information
upf_mec.cb.interfaceTableModule string

Module path to the InterfaceTable module
upf_mec.cb.forwardServiceRegistration bool true
upf_mec.cb.forwardProtocolRegistration bool true
upf_mec.cb.interfaceMapping object {}

Maps network interface names to connected submodule names (e.g. {"eth0": "bridging"}), overrides automatically learned dispatching; * overrides all learned network interfaces, ? overrides default
upf_mec.cb.serviceMapping object {}

Maps protocols to connected submodule names (e.g. {"ethernetmac": "bridging"}), overrides automatically learned dispatching; * overrides all learned services, ? overrides default
upf_mec.cb.protocolMapping object {}

Maps protocols to connected submodule names (e.g. {"ipv4": "bridging"}), overrides automatically learned dispatching; * overrides all learned protocols, ? overrides default
upf_mec.bl.displayStringTextFormat string "processed {numProcessedPackets} pk ({processedTotalLength})"

Determines the text that is written on top of the submodule, supports displaying pars, watches, and module-specific information
upf_mec.bl.interfaceTableModule string

Module path to the InterfaceTable module
upf_mec.bl.forwardServiceRegistration bool true
upf_mec.bl.forwardProtocolRegistration bool true
upf_mec.bl.interfaceMapping object {}

Maps network interface names to connected submodule names (e.g. {"eth0": "bridging"}), overrides automatically learned dispatching; * overrides all learned network interfaces, ? overrides default
upf_mec.bl.serviceMapping object {}

Maps protocols to connected submodule names (e.g. {"ethernetmac": "bridging"}), overrides automatically learned dispatching; * overrides all learned services, ? overrides default
upf_mec.bl.protocolMapping object {}

Maps protocols to connected submodule names (e.g. {"ipv4": "bridging"}), overrides automatically learned dispatching; * overrides all learned protocols, ? overrides default
upf_mec.li.displayStringTextFormat string "processed {numProcessedPackets} pk ({processedTotalLength})"

Determines the text that is written on top of the submodule, supports displaying pars, watches, and module-specific information
upf_mec.li.interfaceTableModule string

Module path to the InterfaceTable module
upf_mec.li.forwardServiceRegistration bool true
upf_mec.li.forwardProtocolRegistration bool true
upf_mec.li.interfaceMapping object {}

Maps network interface names to connected submodule names (e.g. {"eth0": "bridging"}), overrides automatically learned dispatching; * overrides all learned network interfaces, ? overrides default
upf_mec.li.serviceMapping object {}

Maps protocols to connected submodule names (e.g. {"ethernetmac": "bridging"}), overrides automatically learned dispatching; * overrides all learned services, ? overrides default
upf_mec.li.protocolMapping object {}

Maps protocols to connected submodule names (e.g. {"ipv4": "bridging"}), overrides automatically learned dispatching; * overrides all learned protocols, ? overrides default
upf_mec.eth.bitrate double
upf_mec.nl.displayStringTextFormat string "processed {numProcessedPackets} pk ({processedTotalLength})"

Determines the text that is written on top of the submodule, supports displaying pars, watches, and module-specific information
upf_mec.nl.interfaceTableModule string

Module path to the InterfaceTable module
upf_mec.nl.forwardServiceRegistration bool true
upf_mec.nl.forwardProtocolRegistration bool true
upf_mec.nl.interfaceMapping object {}

Maps network interface names to connected submodule names (e.g. {"eth0": "bridging"}), overrides automatically learned dispatching; * overrides all learned network interfaces, ? overrides default
upf_mec.nl.serviceMapping object {}

Maps protocols to connected submodule names (e.g. {"ethernetmac": "bridging"}), overrides automatically learned dispatching; * overrides all learned services, ? overrides default
upf_mec.nl.protocolMapping object {}

Maps protocols to connected submodule names (e.g. {"ipv4": "bridging"}), overrides automatically learned dispatching; * overrides all learned protocols, ? overrides default
upf_mec.tn.displayStringTextFormat string "processed {numProcessedPackets} pk ({processedTotalLength})"

Determines the text that is written on top of the submodule, supports displaying pars, watches, and module-specific information
upf_mec.tn.interfaceTableModule string

Module path to the InterfaceTable module
upf_mec.tn.forwardServiceRegistration bool true
upf_mec.tn.forwardProtocolRegistration bool true
upf_mec.tn.interfaceMapping object {}

Maps network interface names to connected submodule names (e.g. {"eth0": "bridging"}), overrides automatically learned dispatching; * overrides all learned network interfaces, ? overrides default
upf_mec.tn.serviceMapping object {}

Maps protocols to connected submodule names (e.g. {"ethernetmac": "bridging"}), overrides automatically learned dispatching; * overrides all learned services, ? overrides default
upf_mec.tn.protocolMapping object {}

Maps protocols to connected submodule names (e.g. {"ipv4": "bridging"}), overrides automatically learned dispatching; * overrides all learned protocols, ? overrides default
upf_mec.at.displayStringTextFormat string "processed {numProcessedPackets} pk ({processedTotalLength})"

Determines the text that is written on top of the submodule, supports displaying pars, watches, and module-specific information
upf_mec.at.interfaceTableModule string

Module path to the InterfaceTable module
upf_mec.at.forwardServiceRegistration bool true
upf_mec.at.forwardProtocolRegistration bool true
upf_mec.at.interfaceMapping object {}

Maps network interface names to connected submodule names (e.g. {"eth0": "bridging"}), overrides automatically learned dispatching; * overrides all learned network interfaces, ? overrides default
upf_mec.at.serviceMapping object {}

Maps protocols to connected submodule names (e.g. {"ethernetmac": "bridging"}), overrides automatically learned dispatching; * overrides all learned services, ? overrides default
upf_mec.at.protocolMapping object {}

Maps protocols to connected submodule names (e.g. {"ipv4": "bridging"}), overrides automatically learned dispatching; * overrides all learned protocols, ? overrides default
upf_mec.dnPpp.pcapRecorder.displayStringTextFormat string "rec: %n pks"

Determines the text that is written on top of the submodule, supports displaying pars, watches, and module-specific information
upf_mec.dnPpp.pcapRecorder.verbose bool true

Whether to log packets on the module output
upf_mec.dnPpp.pcapRecorder.recordEmptyPackets bool true

Specifies if zero length packets are recorded or not
upf_mec.dnPpp.pcapRecorder.enableConvertingPackets bool true

Specifies if converting packets to link type is allowed or not
upf_mec.dnPpp.pcapRecorder.pcapFile string ""

The PCAP file to be written, suggested value: pcapFile = "${resultdir}/${configname}-#${runnumber}" + fullpath() + ".pcap"
upf_mec.dnPpp.pcapRecorder.fileFormat string "pcapng"
upf_mec.dnPpp.pcapRecorder.snaplen int 65535

Maximum number of bytes to record per packet
upf_mec.dnPpp.pcapRecorder.timePrecision int 6

Time precision in recorded file. pcap supports only 6 (usec) or 9 (nanosec), pcapng supports more values (see 'if_tsresol' option in pcapng file format).
upf_mec.dnPpp.pcapRecorder.dumpBadFrames bool true

Enable dump of frames with hasBitError
upf_mec.dnPpp.pcapRecorder.sendingSignalNames string "transmissionEnded"

Space-separated list of outbound packet signals to subscribe to
upf_mec.dnPpp.pcapRecorder.receivingSignalNames string "receptionEnded"

Space-separated list of inbound packet signals to subscribe to
upf_mec.dnPpp.pcapRecorder.dumpProtocols string "ethernetmac ppp ieee80211mac"

Space-separated list of protocol names as defined in the Protocol class
upf_mec.dnPpp.pcapRecorder.packetFilter object "*"

Which packets are considered, matches all packets by default
upf_mec.dnPpp.pcapRecorder.helpers string ""

Usable PcapRecorder::IHelper helpers for accept packettype and store/convert packet as specified linktype currently available: "inet::AckingMacToEthernetPcapRecorderHelper"
upf_mec.dnPpp.pcapRecorder.alwaysFlush bool false

Flush the pcapFile after each write to ensure that all packets are captured in case of a crash
upf_mec.dnPpp.ppp.displayStringTextFormat string "rate: %b\nsent: %s, rcvd: %r\nqueue: %q, drop: %d"

Determines the text that is written on top of the submodule, supports displaying pars, watches, and module-specific information
upf_mec.dnPpp.ppp.interfaceTableModule string

The path to the InterfaceTable module
upf_mec.dnPpp.ppp.sendRawBytes bool false

When true packets are serialized into a sequence of bytes before sending out
upf_mec.dnPpp.ppp.mtu int 4470B
upf_mec.dnPpp.ppp.stopOperationExtraTime double -1s

Extra time after lifecycle stop operation finished
upf_mec.dnPpp.ppp.stopOperationTimeout double 2s

Timeout value for lifecycle stop operation
upf_mec.relay.trafficFlowFilter.binderModule string "binder"
upf_mec.relay.trafficFlowFilter.fastForwarding bool true
upf_mec.relay.gtpUser.binderModule string "binder"
upf_mec.relay.gtpUser.localPort int 31
upf_mec.relay.gtpUser.tunnelPeerPort int 31
upf_mec.rd.displayStringTextFormat string "processed {numProcessedPackets} pk ({processedTotalLength})"

Determines the text that is written on top of the submodule, supports displaying pars, watches, and module-specific information
upf_mec.rd.interfaceTableModule string

Module path to the InterfaceTable module
upf_mec.rd.interfaceMapping object {}

Maps network interface names to connected submodule names (e.g. {"eth0": "bridging"}), overrides automatically learned dispatching; * overrides all learned network interfaces, ? overrides default
upf_mec.nodeControl.binderModule string "binder"
upf_mec.nodeControl.gtpUserModule string "^.relay.gtpUser"
upf_mec.nodeControl.trafficFlowFilterModule string "^.relay.trafficFlowFilter"
upf_mec.nodeControl.ethernetBridgeModule string "^.ethBridge.sessionMux"

The node's Ethernet session bridge (see EthernetSessionBridge), if it has one
upf_mec.nodeControl.unstructuredPrefix string ""

The prefix the N6 addresses of Unstructured sessions are allocated from, e.g. "2001:db8:5::/64" or "10.5.0.0/16"; empty = the node anchors no Unstructured session (see the main comment)
upf_mec.nodeControl.unstructuredServer string ""

The application server the Unstructured sessions' uplink goes to: a module path relative to the network, resolved in the family of unstructuredPrefix
upf_mec.nodeControl.unstructuredServerPort int -1

The UDP port of unstructuredServer the uplink goes to; must be set for Unstructured sessions
upf_mec.nodeControl.unstructuredPort int -1

The UDP port the node receives the Unstructured sessions' downlink on, and sends their uplink from; must be set for Unstructured sessions
upf_mec.ndResponder.binderModule string "binder"
upf_mec.ndResponder.linkLocalAddress string "fe80::1"

The router's address on every session's link
upf_mec.ndResponder.routerLifetime double 9000s

Router Lifetime in the Router Advertisements (max 9000s, RFC 4861)
upf_mec.ndResponder.curHopLimit int 64

Cur Hop Limit in the Router Advertisements (0 = unspecified)
upf_mec.ndResponder.checksumMode string "declared"
upf_mec.ethBridge.macTable.agingTime double
upf_mec.ethBridge.macTable.forwardingTableFile string
upf_mec.ethBridge.interfaceTable.displayStringTextFormat string "{numInterfaces} interfaces"

Determines the text that is written on top of the submodule, supports displaying pars, watches, and module-specific information
upf_mec.ethBridge.interfaceTable.displayAddresses bool false

Whether to display IP addresses on links
upf_mec.ethBridge.sessionMux.interfaceTableModule string

The bridge's interface table, which the session ports are registered in
upf_mec.ethBridge.sessionMux.macTableModule string

The bridge's MAC table, flushed of a released session's port
upf_mec.ethBridge.sessionMux.portModuleType string "simu5g.corenetwork.ethernetSessionBridge.EthernetSessionPort"

The module type of the session ports
upf_mec.ethBridge.sessionMux.portDisplayString string "p=500,420,row,100;g=sessionPorts"

Display string of the session ports (their place in the bridge's layout)
upf_mec.ethBridge.cb.displayStringTextFormat string "processed {numProcessedPackets} pk ({processedTotalLength})"

Determines the text that is written on top of the submodule, supports displaying pars, watches, and module-specific information
upf_mec.ethBridge.cb.interfaceTableModule string

Module path to the InterfaceTable module
upf_mec.ethBridge.cb.forwardServiceRegistration bool true
upf_mec.ethBridge.cb.forwardProtocolRegistration bool true
upf_mec.ethBridge.cb.interfaceMapping object {}

Maps network interface names to connected submodule names (e.g. {"eth0": "bridging"}), overrides automatically learned dispatching; * overrides all learned network interfaces, ? overrides default
upf_mec.ethBridge.cb.serviceMapping object {}

Maps protocols to connected submodule names (e.g. {"ethernetmac": "bridging"}), overrides automatically learned dispatching; * overrides all learned services, ? overrides default
upf_mec.ethBridge.cb.protocolMapping object {}

Maps protocols to connected submodule names (e.g. {"ipv4": "bridging"}), overrides automatically learned dispatching; * overrides all learned protocols, ? overrides default
upf_mec.ethBridge.bl.displayStringTextFormat string "processed {numProcessedPackets} pk ({processedTotalLength})"

Determines the text that is written on top of the submodule, supports displaying pars, watches, and module-specific information
upf_mec.ethBridge.bl.interfaceTableModule string

Module path to the InterfaceTable module
upf_mec.ethBridge.bl.forwardServiceRegistration bool true
upf_mec.ethBridge.bl.forwardProtocolRegistration bool true
upf_mec.ethBridge.bl.interfaceMapping object {}

Maps network interface names to connected submodule names (e.g. {"eth0": "bridging"}), overrides automatically learned dispatching; * overrides all learned network interfaces, ? overrides default
upf_mec.ethBridge.bl.serviceMapping object {}

Maps protocols to connected submodule names (e.g. {"ethernetmac": "bridging"}), overrides automatically learned dispatching; * overrides all learned services, ? overrides default
upf_mec.ethBridge.bl.protocolMapping object {}

Maps protocols to connected submodule names (e.g. {"ipv4": "bridging"}), overrides automatically learned dispatching; * overrides all learned protocols, ? overrides default
upf_mec.ethBridge.li.displayStringTextFormat string "processed {numProcessedPackets} pk ({processedTotalLength})"

Determines the text that is written on top of the submodule, supports displaying pars, watches, and module-specific information
upf_mec.ethBridge.li.interfaceTableModule string

Module path to the InterfaceTable module
upf_mec.ethBridge.li.forwardServiceRegistration bool true
upf_mec.ethBridge.li.forwardProtocolRegistration bool true
upf_mec.ethBridge.li.interfaceMapping object {}

Maps network interface names to connected submodule names (e.g. {"eth0": "bridging"}), overrides automatically learned dispatching; * overrides all learned network interfaces, ? overrides default
upf_mec.ethBridge.li.serviceMapping object {}

Maps protocols to connected submodule names (e.g. {"ethernetmac": "bridging"}), overrides automatically learned dispatching; * overrides all learned services, ? overrides default
upf_mec.ethBridge.li.protocolMapping object {}

Maps protocols to connected submodule names (e.g. {"ipv4": "bridging"}), overrides automatically learned dispatching; * overrides all learned protocols, ? overrides default
upf_mec.dnEth.bitrate double

Source code

//
// Represents a model of a Multi-access Edge Computing (MEC) host
// belonging to a MEC system, as specified by the ETSI GS MEC 003 specifications. It runs
// MEC applications within its ~VirtualisationInfrastructure and can provide a number of
// MEC services via the MEC platform. MEC applications can be created either dynamically by
// the MEC orchestrator or statically at the initialization of the simulation. The MEC host
// possesses a configurable number of computing resources (such as CPU speed, RAM, and storage)
// and keeps track of the utilization of these resources by the MEC applications via the
// ~VirtualisationInfrastructureManager. Moreover, this module includes a User Plane
// Function (UPF) that allows it to be connected with the 5G core network.
//
module MecHost
{
    parameters:
        @display("i=device/server2;bgb=1000,500");

        //# Node specs
        string nodeType = "MecHost";						// DO NOT CHANGE
        string gateway = default("upf");

        //# ME Host Resources
        int maxMecApps = default(0);
        double maxRam @unit("B") = default(32GB);
        double maxDisk @unit("B") = default(100TB);
        double maxCpuSpeed = default(300000);         // CPU's clock speed in millions of instructions per second (MIPS)

        int numBgMecApps = default(0);
        int numIndependentMecApp = default(0);

        //# List of base stations associated with the MEC host
        // This is a string of comma-separated values
        object bsList = default([]);

    gates:
        // To local radio networks
        inout ppp[];

        // To external networks (internet)
        inout pppIf[];

    submodules:

        virtualisationInfrastructure: VirtualisationInfrastructure {
            parameters:
                @display("p=500,400");
                gateway = parent.gateway;
        }

        mecPlatform: MecPlatform {
            parameters:
                @display("p=573,158");
        }

        mecPlatformManager: MecPlatformManager {
            parameters:
                @display("p=865,116;is=m");
        }

        vim: VirtualisationInfrastructureManager {
            parameters:
                @display("p=865,224;is=m");
        }

        // UPF module used to connect the MEC host to the 5G Core Network (either a BS or a UPF)
        upf_mec: Upf {
            parameters:
                @display("p=150,400");
                nodeType = "UPF_MEC";
                gateway = parent.gateway;
        }

        bgApp[numBgMecApps]: BackgroundApp {
            @display("p=865,326,row,140");
        }

        independentMecApp[numIndependentMecApp]: <> like IApp {
            @display("p=371,156,row,140");
        }

    connections allowunconnected:

        for i=0..sizeof(ppp)-1 {
            ppp++ <--> upf_mec.pppg++;
        }

        for i=0..sizeof(pppIf)-1 {
            //#
            //# external connection to external networks
            //#
            virtualisationInfrastructure.ppp++ <--> pppIf++;
        }

        //#
        //# internal connection between GtpEndpoint and VirtualisationInfrastrcuture
        //#
        virtualisationInfrastructure.ppp++ <--> Eth10G <--> upf_mec.dnPppg;

        for i=0..numIndependentMecApp-1 {
            independentMecApp[i].socketIn <-- virtualisationInfrastructure.independentMecAppOut[i];
            independentMecApp[i].socketOut --> virtualisationInfrastructure.independentMecAppIn[i];
        }

        for i=0..mecPlatform.numMecServices {
            virtualisationInfrastructure.mecPlatform++ <--> mecPlatform.virtInfr++;
        }
}
File: src/simu5g/nodes/MecHost.ned

This documentation is released under the Creative Commons license