Upf

compound module

Implements the 5G Core User Plane Function (UPF).

The UPF is responsible for packet routing and forwarding, packet inspection, and (de)tunneling according to GTP. The core network can contain multiple UPFs. Intermediate UPFs, which are not connected to an external Data Network, act like IP routers in the current version. Allows the connection of mobile terminals to external data networks or other 5G network elements through GTP tunneling.

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.

Used in compound modules

Name	Type	Description
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.

Used in

Name	Type	Description
ExtClientServer_bgCells	network	ExtClientServerExample with background cells instead of external ones: one gNodeB served by a Upf core, a router in front of the Upf, one NrUe, and numBgCells BackgroundCell cells. The router has no simulated peer: the host it talks to, and the applications on the NrUe, are configured in the ini file.
ExtClientServerExample	network	One gNodeB served by a Upf core, a router in front of the Upf, and one NrUe. numExtCells ExtCell cells can be added as interferers. The router has no simulated peer: the host it talks to, and the applications on the NrUe, are configured in the ini file.
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.
ExtServerExample	network	One gNodeB served by a Upf core, a router in front of the Upf, and two NrUe terminals. numExtCells ExtCell cells can be added as interferers. The router has no simulated peer: the host it talks to, and the applications on the UEs, are 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.
MultiCell_Standalone	network	Two gNodeB cells served by a 5G core: the anchor Upf faces the data network (a router and a server), an intermediate Upf feeds both gNodeBs, and an X2 link joins them. numUe NrUe terminals attach, and numBgCells BackgroundCell cells can be added as interferers.
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.
SingleCell_Standalone	network	One gNodeB served by a 5G core: the anchor Upf faces the data network (a router and a server), and an intermediate Upf sits between it and the gNodeB. numUe NrUe terminals attach to the gNodeB, and numBgCells BackgroundCell cells can be added around it as interferers.
SingleCell_Standalone_D2D	network	SingleCell_Standalone with its UEs split into three vectors, so that a configuration can address cellular terminals (ueCell), D2D transmitters (ueD2DTx) and D2D receivers (ueD2DRx) separately. The rest of the topology is the same: one gNodeB behind an intermediate and an anchor Upf, with a router and a server on the data network, plus numBgCells BackgroundCell interferers.
SingleCell_withSecondaryEnb	network	The mirror image of SingleCell_withSecondaryGnb: here the gNodeB is the master node and the eNodeB is its secondary, so the UE is anchored on its NR stack and its LTE stack carries the secondary cell group. All data-plane traffic enters at 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)

Extends

Name	Type	Description
ApplicationLayerNodeBase	compound module	(no description)

Parameters

Name	Type	Default value	Description
hasStatus	bool	false
osgModel	string	""	3D model for OSG visualization, no 3D model by default
osgModelColor	string	""	tint color, no colorization by default
canvasImage	string	""	image for canvas visualization, no image by default
canvasImageColor	string	""	tint color, no colorization by default
recordPcap	bool	false
numPcapRecorders	int	recordPcap ? 1 : 0
numLoInterfaces	int	1
numWlanInterfaces	int	0
numEthInterfaces	int	0	minimum number of ethernet interfaces
numPppInterfaces	int	0	minimum number of PPP interfaces
numTunInterfaces	int	0
numVirtInterfaces	int	0
fcsMode	string	"declared"
hasIpv4	bool	true
hasIpv6	bool	false
hasGn	bool	false
forwarding	bool	true
multicastForwarding	bool	false
hasUdp	bool	firstAvailableOrEmpty("Udp") != ""
hasTcp	bool	firstAvailableOrEmpty("Tcp", "TcpLwip", "TcpNsc") != ""
hasSctp	bool	false
numApps	int	0
nodeType	string	"UPF"	Do NOT change!
gateway	string	""

Properties

Name	Value	Description
networkNode
labels	node
class	NodeBase
display	i=abstract/switch

Gates

Name	Direction	Size	Description
radioIn [ ]	input	numWlanInterfaces
pppg [ ]	inout	numPppInterfaces
ethg [ ]	inout	numEthInterfaces
dnPppg	inout		This gate is used for the UPF connected to the external data network it must be left unconnected for intermediate UPFs

Unassigned submodule parameters

Name	Type	Default value	Description
status.initialStatus	string	"UP"	TODO @signal, @statistic
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.moduleNamePatterns	string	"wlan[] eth[] ppp[*]"	space-separated list of sibling module names to listen on
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"
interfaceTable.displayAddresses	bool	false	whether to display IP addresses on links
cb.displayStringTextFormat	string	"processed %p pk (%l)"	determines the text that is written on top of the submodule
cb.forwardServiceRegistration	bool	true
cb.forwardProtocolRegistration	bool	true
bl.displayStringTextFormat	string	"processed %p pk (%l)"	determines the text that is written on top of the submodule
bl.forwardServiceRegistration	bool	true
bl.forwardProtocolRegistration	bool	true
li.displayStringTextFormat	string	"processed %p pk (%l)"	determines the text that is written on top of the submodule
li.forwardServiceRegistration	bool	true
li.forwardProtocolRegistration	bool	true
eth.bitrate	double
nl.displayStringTextFormat	string	"processed %p pk (%l)"	determines the text that is written on top of the submodule
nl.forwardServiceRegistration	bool	true
nl.forwardProtocolRegistration	bool	true
tn.displayStringTextFormat	string	"processed %p pk (%l)"	determines the text that is written on top of the submodule
tn.forwardServiceRegistration	bool	true
tn.forwardProtocolRegistration	bool	true
at.displayStringTextFormat	string	"processed %p pk (%l)"	determines the text that is written on top of the submodule
at.forwardServiceRegistration	bool	true
at.forwardProtocolRegistration	bool	true
dnPpp.pcapRecorder.verbose	bool	true	whether to log packets on the module output
dnPpp.pcapRecorder.pcapFile	string	""	the PCAP file to be written
dnPpp.pcapRecorder.fileFormat	string	"pcapng"
dnPpp.pcapRecorder.snaplen	int	65535	maximum number of bytes to record per packet
dnPpp.pcapRecorder.dumpBadFrames	bool	true	enable dump of frames with hasBitError
dnPpp.pcapRecorder.sendingSignalNames	string	"packetSentToLower"	space-separated list of outbound packet signals to subscribe to
dnPpp.pcapRecorder.receivingSignalNames	string	"packetReceivedFromLower"	space-separated list of inbound packet signals to subscribe to
dnPpp.pcapRecorder.dumpProtocols	string	"ethernetmac ppp ieee80211mac"	space-separated list of protocol names as defined in the Protocol class
dnPpp.pcapRecorder.packetFilter	object	"*"	which packets are considered, matches all packets by default
dnPpp.pcapRecorder.helpers	string	""	usable PcapRecorder::IHelper helpers for accept packettype and store/convert packet as specified linktype currently available: "inet::AckingMacToEthernetPcapRecorderHelper"
dnPpp.pcapRecorder.alwaysFlush	bool	false	flush the pcapFile after each write to ensure that all packets are captured in case of a crash
dnPpp.pcapRecorder.displayStringTextFormat	string	"rec: %n pks"
dnPpp.ppp.interfaceTableModule	string		The path to the InterfaceTable module
dnPpp.ppp.displayStringTextFormat	string	"rate: %b\nsent: %s, rcvd: %r\nqueue: %q, drop: %d"
dnPpp.ppp.sendRawBytes	bool	false	when true packets are serialized into a sequence of bytes before sending out
dnPpp.ppp.mtu	int	4470B
dnPpp.ppp.stopOperationExtraTime	double	-1s	extra time after lifecycle stop operation finished
dnPpp.ppp.stopOperationTimeout	double	2s	timeout value for lifecycle stop operation
trafficFlowFilter.binderModule	string	"binder"
trafficFlowFilter.bearerConfiguratorModule	string	"bearerConfigurator"	Where a core-network instance registers for QFI-rule delivery
trafficFlowFilter.fastForwarding	bool	true
gtp_user.binderModule	string	"binder"
gtp_user.interfaceTableModule	string		Path to the InterfaceTable module
gtp_user.ipOutInterface	string	""	Optional: manual specification of outgoing interface for received IP
gtp_user.localPort	int	31
gtp_user.tunnelPeerPort	int	31

Source code

//
// Implements the 5G Core User Plane Function (UPF).
//
// The UPF is responsible for packet routing and forwarding, packet inspection, and (de)tunneling according to GTP.
// The core network can contain multiple UPFs. Intermediate UPFs, which are not connected to an external Data Network,
// act like IP routers in the current version.
// Allows the connection of mobile terminals to external data networks or other 5G network elements through GTP tunneling.
//
module Upf extends ApplicationLayerNodeBase
{
    parameters:
        @display("i=abstract/switch");
        @figure[submodules];

        string nodeType = default("UPF");   // Do NOT change!
        string gateway = default("");
        forwarding = default(true);
        multicastForwarding = default(false);

    gates:
        // This gate is used for the UPF connected to the external data network
        // it must be left unconnected for intermediate UPFs
        inout dnPppg @loose @labels(PppFrame-conn);

    submodules:
        dnPpp: PppInterface {
            parameters:
                @display("p=1100,975");
        }
        trafficFlowFilter: TrafficFlowFilter {
            parameters:
                @display("p=1200,75");
                ownerType = parent.nodeType;
        }
        gtp_user: GtpUser {
            parameters:
                @display("p=1000,75");
                gateway = parent.gateway;
        }

    connections:

        gtp_user.socketOut --> at.in++;
        gtp_user.socketIn <-- at.out++;

        dnPpp.upperLayerOut --> trafficFlowFilter.internetFilterGateIn;
        dnPpp.upperLayerIn <-- gtp_user.pppGate;

        trafficFlowFilter.gtpUserGateOut --> gtp_user.trafficFlowFilterGate;

        dnPpp.phys <--> dnPppg;
}

File: src/simu5g/nodes/Upf.ned