MECHost

Package: simu5g.nodes.mec

MECHost

compound module

This 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 This module represents the Virtualisation Infrastructure in a MEC host. Source: virtualisationInfrastructure: VirtualisationInfrastructure { parameters: @display("p=500,400"); gateway = parent.gateway; } mecPlatform : MECPlatform This module represents the MEC Platform entity within a ~MECHost, as specified in the ETSI MEC... Source: mecPlatform: MECPlatform { parameters: @display("p=573,158"); } mecPlatformManager : MecPlatformManager Source: mecPlatformManager: MecPlatformManager { parameters: @display("p=865,116;is=m"); } vim : VirtualisationInfrastructureManager This module is responsible for managing the computing resources currently allocated to MEC... Source: vim: VirtualisationInfrastructureManager { parameters: @display("p=865,224;is=m"); } upf_mec : Upf Implements a 5G Core User Plane Function (UPF) module. Source: upf_mec: Upf { parameters: @display("p=150,400"); nodeType = "UPF_MEC"; gateway = parent.gateway; } bgApp[numBGMecApp] : BackgroundApp This module can be used to simulate a background application running on the MEC host without... Source: bgApp[numBGMecApp]: BackgroundApp { @display("p=865,326,row,140"); } independentMecApp[numIndependentMecApp] : like IApp IApp: 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 (no description)
ExtUeAppExample network (no description)
ExtUeAppMecAppExample 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 Million Instruction per Seconds (MIPS)
numBGMecApp 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
pppIf [ ] inout

to external networks (internet)

Unassigned submodule parameters

Name Type Default value Description
virtualisationInfrastructure.interfaceTable.displayAddresses bool false

whether to display IP addresses on links
virtualisationInfrastructure.pppIf.pcapRecorder.verbose bool true

whether to log packets on the module output
virtualisationInfrastructure.pppIf.pcapRecorder.pcapFile string ""

the PCAP file to be written
virtualisationInfrastructure.pppIf.pcapRecorder.fileFormat string "pcapng"
virtualisationInfrastructure.pppIf.pcapRecorder.snaplen int 65535

maximum number of bytes to record per packet
virtualisationInfrastructure.pppIf.pcapRecorder.dumpBadFrames bool true

enable dump of frames with hasBitError
virtualisationInfrastructure.pppIf.pcapRecorder.sendingSignalNames string "packetSentToLower"

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

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.pcapRecorder.displayStringTextFormat string "rec: %n pks"
virtualisationInfrastructure.pppIf.ppp.interfaceTableModule string

The path to the InterfaceTable module
virtualisationInfrastructure.pppIf.ppp.displayStringTextFormat string "rate: %b\nsent: %s, rcvd: %r\nqueue: %q, drop: %d"
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.interfaceTableModule string

The path to the InterfaceTable module
virtualisationInfrastructure.udp.icmpModule string "^.ipv4.icmp"
virtualisationInfrastructure.udp.icmpv6Module string "^.ipv6.icmpv6"
virtualisationInfrastructure.udp.crcMode string "declared"
virtualisationInfrastructure.udp.defaultMulticastLoop bool true
virtualisationInfrastructure.tcp.crcMode 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 to the power of 2. -1 indicates that manual window scaling is turned off.
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 (RFC 793) (header option)
virtualisationInfrastructure.tcp.msl int 120s

Maximum Segment Lifetime
virtualisationInfrastructure.tcp.tcpAlgorithmClass string "TcpReno"

TODO: use the following @enum or similar, but it must allow new values for user defined algorithms (omnetpp-6.1 checks @enum strictly): @enum("TcpVegas", "TcpWestwood", "TcpNewReno", "TcpReno", "TcpTahoe", "TcpNoCongestionControl")
virtualisationInfrastructure.tcp.useDataNotification bool false

turn the notifications for arrived data on or off
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.at.displayStringTextFormat string "processed %p pk (%l)"

determines the text that is written on top of the submodule
virtualisationInfrastructure.at.forwardServiceRegistration bool true
virtualisationInfrastructure.at.forwardProtocolRegistration bool true
virtualisationInfrastructure.tn.displayStringTextFormat string "processed %p pk (%l)"

determines the text that is written on top of the submodule
virtualisationInfrastructure.tn.forwardServiceRegistration bool true
virtualisationInfrastructure.tn.forwardProtocolRegistration bool true
virtualisationInfrastructure.nl.displayStringTextFormat string "processed %p pk (%l)"

determines the text that is written on top of the submodule
virtualisationInfrastructure.nl.forwardServiceRegistration bool true
virtualisationInfrastructure.nl.forwardProtocolRegistration bool true
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.nodes.mec.MECPlatform.MECServices.MECServiceBase.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.initialStatus string "UP"

TODO @signal, @statistic
upf_mec.pcapRecorder.verbose bool true

whether to log packets on the module output
upf_mec.pcapRecorder.pcapFile string ""

the PCAP file to be written
upf_mec.pcapRecorder.fileFormat string "pcapng"
upf_mec.pcapRecorder.snaplen int 65535

maximum number of bytes to record per packet
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 "packetSentToLower"

space-separated list of outbound packet signals to subscribe to
upf_mec.pcapRecorder.receivingSignalNames string "packetReceivedFromLower"

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.pcapRecorder.displayStringTextFormat string "rec: %n pks"
upf_mec.interfaceTable.displayAddresses bool false

whether to display IP addresses on links
upf_mec.cb.displayStringTextFormat string "processed %p pk (%l)"

determines the text that is written on top of the submodule
upf_mec.cb.forwardServiceRegistration bool true
upf_mec.cb.forwardProtocolRegistration bool true
upf_mec.bl.displayStringTextFormat string "processed %p pk (%l)"

determines the text that is written on top of the submodule
upf_mec.bl.forwardServiceRegistration bool true
upf_mec.bl.forwardProtocolRegistration bool true
upf_mec.li.displayStringTextFormat string "processed %p pk (%l)"

determines the text that is written on top of the submodule
upf_mec.li.forwardServiceRegistration bool true
upf_mec.li.forwardProtocolRegistration bool true
upf_mec.eth.bitrate double
upf_mec.nl.displayStringTextFormat string "processed %p pk (%l)"

determines the text that is written on top of the submodule
upf_mec.nl.forwardServiceRegistration bool true
upf_mec.nl.forwardProtocolRegistration bool true
upf_mec.pppIf.pcapRecorder.verbose bool true

whether to log packets on the module output
upf_mec.pppIf.pcapRecorder.pcapFile string ""

the PCAP file to be written
upf_mec.pppIf.pcapRecorder.fileFormat string "pcapng"
upf_mec.pppIf.pcapRecorder.snaplen int 65535

maximum number of bytes to record per packet
upf_mec.pppIf.pcapRecorder.dumpBadFrames bool true

enable dump of frames with hasBitError
upf_mec.pppIf.pcapRecorder.sendingSignalNames string "packetSentToLower"

space-separated list of outbound packet signals to subscribe to
upf_mec.pppIf.pcapRecorder.receivingSignalNames string "packetReceivedFromLower"

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

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

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

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

flush the pcapFile after each write to ensure that all packets are captured in case of a crash
upf_mec.pppIf.pcapRecorder.displayStringTextFormat string "rec: %n pks"
upf_mec.pppIf.ppp.interfaceTableModule string

The path to the InterfaceTable module
upf_mec.pppIf.ppp.displayStringTextFormat string "rate: %b\nsent: %s, rcvd: %r\nqueue: %q, drop: %d"
upf_mec.pppIf.ppp.sendRawBytes bool false

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

extra time after lifecycle stop operation finished
upf_mec.pppIf.ppp.stopOperationTimeout double 2s

timeout value for lifecycle stop operation
upf_mec.udp.interfaceTableModule string

The path to the InterfaceTable module
upf_mec.udp.icmpModule string "^.ipv4.icmp"
upf_mec.udp.icmpv6Module string "^.ipv6.icmpv6"
upf_mec.udp.crcMode string "declared"
upf_mec.udp.defaultMulticastLoop bool true
upf_mec.trafficFlowFilter.binderModule string "binder"
upf_mec.trafficFlowFilter.fastForwarding bool true
upf_mec.gtp_user.binderModule string "binder"
upf_mec.gtp_user.interfaceTableModule string

path to the InterfaceTable module
upf_mec.gtp_user.ipOutInterface string ""

optional: manual specification of outgoing interface for received IP
upf_mec.gtp_user.localPort int 31
upf_mec.gtp_user.tunnelPeerPort int 31
upf_mec.tn.displayStringTextFormat string "processed %p pk (%l)"

determines the text that is written on top of the submodule
upf_mec.tn.forwardServiceRegistration bool true
upf_mec.tn.forwardProtocolRegistration bool true
upf_mec.at.displayStringTextFormat string "processed %p pk (%l)"

determines the text that is written on top of the submodule
upf_mec.at.forwardServiceRegistration bool true
upf_mec.at.forwardProtocolRegistration bool true

Source code

//
// This 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.
//
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 Million Instruction per Seconds (MIPS)

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

        //# List of Base Stations associated to 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[numBGMecApp]: 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.filterGate;

        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/nodes/mec/MECHost.ned

This documentation is released under the Creative Commons license