NrNicEnb¶

compound module NrNicEnb

The NrNicEnb module serves as a network interface that provides 5G connectivity within a gNodeB. It implements the data and signaling plane of the NR (New Radio) stack, which encompasses the PDCP, RLC, MAC, and PHY layers. The parameters and submodules facilitate the customization of the gNodeB’s behavior, including its support for CoMP (Coordinated MultiPoint) or dual connectivity. D2D support is added by the NrNicEnbD2D subtype.

The PDCP and RLC entities are missing from the submodules on purpose: the RRC layer’s BearerManagement creates them per bearer at run time.

Usage diagram¶

Inheritance diagram¶

Known subclasses¶

Name	Type	Description
NrNicEnbD2D	compound module	Device-to-Device (D2D) capable NR gNodeB network interface. It extends NrNicEnb by swapping in the D2D-capable NR MAC leaf and the D2D-capable eNB PHY, and by enabling the D2D mode controller and mode selection. It is the NR counterpart of LteNicEnbD2D.

Extends¶

Name	Type	Description
LteNicEnb	compound module	The LteNicEnb module is a network interface that provides LTE connectivity within an eNodeB. It implements the data and signaling planes of the LTE stack, which includes the PDCP, RLC, MAC, and PHY layers. The parameters and submodules allow customization of the eNodeB’s behavior, including whether it supports D2D communication, CoMP (Coordinated MultiPoint), or dual connectivity.

Parameters¶

Name	Type	Default value	Description
displayStringTextFormat	string	“%a (%i)\n%m”	Determines the text that is written on top of the submodule, supports displaying pars, watches, and module-specific information
recordPcap	bool	false
numPcapRecorders	int	recordPcap ? 1 : 0
isWireless	bool	true
interfaceTableModule	string
routingTableModule	string
hasRniSupport	bool	false
nodeType	string
processingDelayIn	double	0s	Additional processing delay for incoming ip packets
processingDelayOut	double	0s	Additional processing delay for outgoing ip packets
channelModelType	string	“Tr38901ChannelModel”
dualConnectivityEnabled	bool	false
numCarriers	int	1
address	string	“auto”
compEnabled	bool	false
hasSdap	bool	false	Whether the stack has an SDAP layer: true on 5GC (Upf) networks, false on EPC/EN-DC ones; the network sets it per its core

Properties¶

Name	Value	Description
class	NonlayoutingNetworkInterface
display	i=block/ifcard;bgb=800,810;bgl=3
lifecycleSupport
networkInterface

Gates¶

Name	Direction	Description
upperLayerIn	input
upperLayerOut	output
radioIn	input	To receive messages sent using sendDirect()
nrRadioIn	input	For NR support
x2 [ ]	inout	Optional X2 manager

Signals¶

Name	Type	Unit	Description
packetDropped	inet::Packet ↗

Statistics¶

Name	Title	Source	Record	Unit	Interpolation Mode	Description
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 ↗.displayStringTextFormat	string	“rec: %n pks”	Determines the text that is written on top of the submodule, supports displaying pars, watches, and module-specific information
pcapRecorder ↗.verbose	bool	true	Whether to log packets on the module output
pcapRecorder ↗.recordEmptyPackets	bool	true	Specifies if zero length packets are recorded or not
pcapRecorder ↗.enableConvertingPackets	bool	true	Specifies if converting packets to link type is allowed or not
pcapRecorder ↗.pcapFile	string	“”	The PCAP file to be written, suggested value: pcapFile = “${resultdir}/${configname}-#${runnumber}” + fullpath() + “.pcap”
pcapRecorder ↗.fileFormat	string	“pcapng”
pcapRecorder ↗.snaplen	int	65535	Maximum number of bytes to record per packet
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).
pcapRecorder ↗.dumpBadFrames	bool	true	Enable dump of frames with hasBitError
pcapRecorder ↗.sendingSignalNames	string	“transmissionEnded”	Space-separated list of outbound packet signals to subscribe to
pcapRecorder ↗.receivingSignalNames	string	“receptionEnded”	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
pcapRecorder ↗.alwaysFlush	bool	false	Flush the pcapFile after each write to ensure that all packets are captured in case of a crash
handoverPacketHolder.binderModule	string	“binder”
ip2nic.binderModule	string	“binder”
ip2nic.connectionControlModule	string	“^.rrc.connectionControl”	The node’s control-plane entry point, asked for a bearer on a lookup miss
ip2nic.isNr	bool	false	True for the NR leg (set by NrNicUe/NrNicEnb, or in the ini for a DC master eNB)
ip2nic.hasSdap	bool	false	When true, SDAP handles DRB/RLC assignment; Ip2Nic skips traffic classification
ip2nic.sessionType	string	“”	UE only: the type of the UE’s session (see LteUe), which the payload the NIC delivers up is of; set by the NIC
ip2nic.establishBearersOnDemand	bool	true	When false, a packet that finds no established bearer raises an error instead of establishing one (static bearers are established up front; see the staticDrbs parameter of BearerConfigurator)
rrc.registration.interfaceTableModule	string
rrc.registration.interfaceName	string	“cellular”
rrc.registration.routingTableModule	string
rrc.registration.binderModule	string	“binder”
rrc.registration.connectionControlModule	string	“^.connectionControl”	The node’s control-plane entry point (see Rrc), told about a multicast group join
rrc.registration.sessionType	string	“”	UE only: the type of the UE’s session (see LteUe): a UE created during the run gets an IPv4 default route through the NIC only on an IP session, and the NIC of an Ethernet session is an Ethernet port; set by the NIC
rrc.bearerManagement.binderModule	string	“binder”	To reach a peer’s BearerManagement on RLF
rrc.bearerManagement.connectionControlModule	string	“^.connectionControl”	The node’s control-plane entry point (see Rrc), which a torn-down bearer’s DRB identity goes back through
rrc.bearerManagement.t311	double	0s	RRC re-establishment cell-selection timer (0 => release-to-IDLE)
rrc.bearerManagement.t301	double	0.1s	RRC re-establishment (request -> complete) timer
rrc.bearerManagement.headerCompressedSize	int	-1B	Removed, an error if set: header compression is configured per bearer (the rohc field of BearerConfigurator’s bearer definitions)
rrc.bearerManagement.pdcpEntityModuleType	string	“simu5g.stack.pdcp.LtePdcpEntity”	PDCP entity types: the full PDCP entity is a compound (PdcpEntityBase, TX+RX sides plus the leg split/join stage of a multi-leg bearer); the instantiable types are its subclasses (LtePdcpEntity, NrPdcpEntity). At a DC secondary a bearer’s PDCP lives at the master, so the secondary installs an PdcpRelayEntity (tunnels PDUs to/from the master) in its place.
rrc.bearerManagement.pdcpRelayEntityModuleType	string	“simu5g.stack.pdcp.PdcpRelayEntity”
rrc.bearerManagement.dualConnectivityEnabled	bool	false	Set by the NIC; two-leg (split-capable) bearers
rrc.bearerManagement.rlcTmEntityModuleType	string	“simu5g.stack.rlc.RlcTmEntity”	RLC entity types (compound modules): lteRlc* = LTE-FI bearers (TS 36.322), nrRlc* = NR bearers (SI/SO wire format, TS 38.322)
rrc.bearerManagement.lteRlcUmEntityModuleType	string	“simu5g.stack.rlc.LteRlcUmEntity”
rrc.bearerManagement.lteRlcAmEntityModuleType	string	“simu5g.stack.rlc.LteRlcAmEntity”
rrc.bearerManagement.nrRlcUmEntityModuleType	string	“simu5g.stack.rlc.NrRlcUmEntity”
rrc.bearerManagement.nrRlcAmEntityModuleType	string	“simu5g.stack.rlc.NrRlcAmEntity”
rrc.bearerManagement.registrationModule	string	“^.registration”	Module references for accessing other stack layers
rrc.bearerManagement.drbTableModule	string	“^.drbTable”
rrc.bearerManagement.ip2nicModule	string	“^.^.ip2nic”
rrc.bearerManagement.handoverPacketHolderModule	string	“^.^.handoverPacketHolder”	Attachment-ledger push target (UE only)
rrc.bearerManagement.pdcpMuxModule	string	“^.^.pdcpMux”
rrc.bearerManagement.pdcpDcMuxModule	string	“^.^.pdcpDcMux”
rrc.bearerManagement.d2dModeControllerModule	string	“^.d2dModeController”
rrc.bearerManagement.rlcMuxModule	string	“^.^.rlcMux”
rrc.bearerManagement.nrRlcMuxModule	string	“^.^.nrRlcMux”
rrc.bearerManagement.macModule	string	“^.^.mac”
rrc.bearerManagement.nrMacModule	string	“^.^.nrMac”
rrc.bearerManagement.sdapModule	string	“^.^.sdap”	Configuration push target; unresolvable (no SDAP on the NIC) = no pushes
rrc.bearerManagement.qosFlowClassifierModule	string	“^.^.qosFlowClassifier”	Uplink QFI rule push target; unresolvable (not a UE stack with SDAP) = no pushes
rrc.connectionControl.binderModule	string	“binder”
rrc.connectionControl.bearerConfiguratorModule	string	“bearerConfigurator”
rrc.connectionControl.coreControlModule	string	“coreControl”
rrc.connectionControl.bearerManagementModule	string	“^.bearerManagement”
rrc.connectionControl.macModule	string	“^.^.mac”
rrc.connectionControl.handoverPacketHolderModule	string	“^.^.handoverPacketHolder”
rrc.connectionControl.gtpUserModule	string	“^.^.^.relay.gtpUser”
rrc.connectionControl.gtpUserX2Module	string	“^.^.^.gtpUserX2”
rrc.connectionControl.macNodeId	int		The base station’s node id; the NIC sets it from the node’s
rrc.connectionControl.gateway	string	“”	The node’s core network gateway, as its gateway parameter names it; ignored at a node not connected to a core network (a secondary node)
rrc.nrConnectionControl.dynamicCellAssociation	bool	false
rrc.nrConnectionControl.enableHandover	bool	false	Allows handovers in the UE
rrc.nrConnectionControl.isNr	bool		Whether this instance is associated with the NR or the LTE stack
rrc.nrConnectionControl.macNodeId	int		MacNodeId of the stack leg this controller belongs to (set by the NIC)
rrc.nrConnectionControl.sessionType	string		The type of the session the UE requests at connection setup (see LteUe), set by the NIC
rrc.nrConnectionControl.handoverLatency	double	50ms	Handover duration
rrc.nrConnectionControl.handoverDetachmentTime	double	handoverLatency > 0s ? handoverLatency/2 : 25ms
rrc.nrConnectionControl.handoverAttachmentTime	double	handoverLatency > 0s ? handoverLatency-handoverDetachmentTime : handoverDetachmentTime
rrc.nrConnectionControl.minRssiDefault	bool	true	Whether minRssi is taken from PhyPisaData instead of the minRssi parameter
rrc.nrConnectionControl.minRssi	double	-99.0dB	Configurable minimum threshold RSSI for attaching to an eNB (meaningful only if minRssiDefault==false)
rrc.nrConnectionControl.hysteresisFactor	double	10
rrc.nrConnectionControl.binderModule	string	“binder”
rrc.nrConnectionControl.macModule	string	“^.^.mac”
rrc.nrConnectionControl.bearerManagementModule	string	“^.bearerManagement”
rrc.nrConnectionControl.handoverPacketHolderModule	string	“^.^.handoverPacketHolder”
rrc.nrConnectionControl.feedbackGeneratorModule	string	“^.^.dlFbGen”	TODO or “^.^.nrDlFbGen”
rrc.nrConnectionControl.otherConnectionControlModule	string	“”
rrc.nrConnectionControl.hasCollector	bool	false	True when node has a collector module (ueCollector/nrUeCollector) for this PHY module
rlcMux.bearerManagementModule	string	“^.rrc.bearerManagement”
phy.isNr	bool	false	True for the NR leg (set by NrNicUe/NrNicEnb on their PHY submodule)
phy.macNodeId	int		MacNodeId of the stack leg this PHY belongs to (set by the NIC)
phy.ueTxPower	double	26dBm
phy.eNodeBTxPower	double	46dBm
phy.microTxPower	double	30dBm
phy.txDirection	string	“OMNI”
phy.txAngle	double	0deg
phy.binderModule	string	“binder”
phy.channelModelModule	string	“^.channelModel[0]”	Set to “^.nrChannelModel[0]” on an NR leg, see NrNicUe
phy.enableHandover	bool	false	Marks this eNB as a handover target: its beacons are used by UEs for handover feasibility assessment. Requires enableBeacons=true (the default when handover is on); the module errors out at initialization if beacons are disabled while handover is enabled.
phy.enableBeacons	bool	enableHandover	Enables broadcasting periodic beacons (at cellInfo.beaconInterval). Beacons are the measurement signal UEs use both for handover feasibility assessment and for radio link monitoring (RLF detection), decoupled from enableHandover so radio link monitoring can run without handover. Defaults to enableHandover (beacons flow exactly when handover is enabled). cellInfo.beaconInterval must be positive: a zero/negative interval is an error – switch beacons off with enableBeacons=false.
phy.targetBler	double	0.001
packetFlowObserver.macModule	string	“^.mac”
packetFlowObserver.pdcpModule	string	“^”
packetFlowObserver.rlcModule	string	“^”
packetFlowObserver.isNrObserver	bool	false
packetFlowObserver.pfmType	string	“PacketFlowObserverEnb”
pdcpDcMux.bearerManagementModule	string	“^.rrc.bearerManagement”
x2Manager.interfaceTableModule	string
x2Manager.binderModule	string	“binder”
compManager.compNodeType	string	“COMP_CLIENT”
compManager.coordinatorId	int		ID of the coordinator node
compManager.clientList	object	[]	Space-separated list of client node identifiers
compManager.coordinationPeriod	double	0.001s	The time interval between two coordination events
compManager.binderModule	string	“binder”
handoverX2Forwarder.losslessHandover	bool	false
bgTrafficGenerator.bgUE.mobility ↗.displayStringTextFormat	string	“p: {position}\nv: {velocity}”	Determines the text that is written on top of the submodule, supports displaying pars, watches, and module-specific information
bgTrafficGenerator.bgUE.mobility ↗.subjectModule	string	“^”	The module path that determines the subject module, the motion of which this mobility model describes. The default value is the parent module
bgTrafficGenerator.bgUE.mobility ↗.coordinateSystemModule	string	“”	The module path of the geographic coordinate system module; optional, empty disables geographic conversion (and the {geo_position} directive)
bgTrafficGenerator.bgUE.mobility ↗.updateDisplayString	bool	true	Enables continuous update of the subject module’s position by modifying its display string
bgTrafficGenerator.bgUE.mobility ↗.constraintAreaMinX	double	-inf m	The minimum x position of the constraint area. It is unconstrained by default (negative infinity)
bgTrafficGenerator.bgUE.mobility ↗.constraintAreaMinY	double	-inf m	The minimum y position of the constraint area. It is unconstrained by default (negative infinity)
bgTrafficGenerator.bgUE.mobility ↗.constraintAreaMinZ	double	-inf m	The minimum z position of the constraint area. It is unconstrained by default (negative infinity)
bgTrafficGenerator.bgUE.mobility ↗.constraintAreaMaxX	double	inf m	The maximum x position of the constraint area. It is unconstrained by default (positive infinity)
bgTrafficGenerator.bgUE.mobility ↗.constraintAreaMaxY	double	inf m	The maximum y position of the constraint area. It is unconstrained by default (positive infinity)
bgTrafficGenerator.bgUE.mobility ↗.constraintAreaMaxZ	double	inf m	The maximum z position of the constraint area. It is unconstrained by default (positive infinity)
bgTrafficGenerator.bgUE.mobility ↗.initialX	double	uniform(this.constraintAreaMinX, this.constraintAreaMaxX)
bgTrafficGenerator.bgUE.mobility ↗.initialY	double	uniform(this.constraintAreaMinY, this.constraintAreaMaxY)
bgTrafficGenerator.bgUE.mobility ↗.initialZ	double	nanToZero(uniform(this.constraintAreaMinZ, this.constraintAreaMaxZ))
bgTrafficGenerator.bgUE.mobility ↗.initialLatitude	double	nan deg
bgTrafficGenerator.bgUE.mobility ↗.initialLongitude	double	nan deg
bgTrafficGenerator.bgUE.mobility ↗.initialAltitude	double	0m
bgTrafficGenerator.bgUE.mobility ↗.initialHeading	double	0deg
bgTrafficGenerator.bgUE.mobility ↗.initialElevation	double	0deg
bgTrafficGenerator.bgUE.mobility ↗.initialBank	double	0deg
bgTrafficGenerator.bgUE.mobility ↗.initFromDisplayString	bool	true	Enables one-time initialization from the subject module’s display string
bgTrafficGenerator.bgUE.mobility ↗.updateFromDisplayString	bool	true	Enables continuous update from the subject module’s display string for dragging and rotating it
bgTrafficGenerator.bgUE.generator.computeAvgInterference	bool
bgTrafficGenerator.bgUE.generator.enablePeriodicCqiUpdate	bool
bgTrafficGenerator.bgUE.generator.useProbabilisticCqi	bool
bgTrafficGenerator.bgUE.generator.backgroundTrafficManagerModule	string	“^.^.manager”
bgTrafficGenerator.bgUE.generator.startTimeDl	double	-1s
bgTrafficGenerator.bgUE.generator.startTimeUl	double	-1s
bgTrafficGenerator.bgUE.generator.headerLen	int	33B
bgTrafficGenerator.bgUE.generator.txPower	double	26dBm
bgTrafficGenerator.bgUE.generator.fbPeriod	int	6tti
bgTrafficGenerator.bgUE.generator.periodDl	double	uniform(10ms,50ms)
bgTrafficGenerator.bgUE.generator.periodUl	double	uniform(10ms,50ms)
bgTrafficGenerator.bgUE.generator.packetSizeDl	int	intuniform(20B,100B)
bgTrafficGenerator.bgUE.generator.packetSizeUl	int	intuniform(20B,100B)
bgTrafficGenerator.bgUE.generator.rtxRateDl	double	0.1
bgTrafficGenerator.bgUE.generator.rtxDelayDl	double	0.006s
bgTrafficGenerator.bgUE.generator.rtxRateUl	double	0.1
bgTrafficGenerator.bgUE.generator.rtxDelayUl	double	0.006s
bgTrafficGenerator.bgUE.generator.cqiMeanDl	double	15	These values are only considered when periodicCqi == false && computeAvgInterference == false
bgTrafficGenerator.bgUE.generator.cqiMeanUl	double	15
bgTrafficGenerator.bgUE.generator.cqiStddevDl	double	0
bgTrafficGenerator.bgUE.generator.cqiStddevUl	double	0
bgTrafficGenerator.manager.binderModule	string	“binder”
bgTrafficGenerator.manager.numBgUes	int
bgTrafficGenerator.manager.macModule	string	“^.^.mac”
bgTrafficGenerator.manager.phyModule	string	“^.^.phy”
bgTrafficGenerator.manager.enablePeriodicCqiUpdate	bool
bgTrafficGenerator.manager.computeAvgInterference	bool
sdap.nodeRole	string		Node role: “UE” or “gNB” - determines reflective QoS behavior
sdap.connectionControlModule	string	“^.rrc.connectionControl”	The node’s control-plane entry point, the bearer-selection authority on a lookup miss
sdap.establishBearersOnDemand	bool	true	When false, a packet that finds no established bearer raises an error instead of establishing one (static bearers are established up front; see the staticDrbs parameter of BearerConfigurator)
sdap.reflectiveQosTableModule	string	“”	UE only: path to ReflectiveQosTable module (empty = disabled)
sdap.useReflectiveQos	bool	false	UE only
sdap.reflectiveQosOverridesQfi	bool	false	UE only: when a packet has both a classified QFI (QfiReq tag) and a reflective QoS match, true = the reflective QFI wins, false = the classified one; a packet with only one of the two always uses it

Source code¶

//
// The NrNicEnb module serves as a network interface that provides 5G connectivity
// within a gNodeB. It implements the data and signaling plane of the NR (New Radio) stack,
// which encompasses the PDCP, RLC, MAC, and PHY layers. The parameters and submodules
// facilitate the customization of the gNodeB's behavior, including its support for
// CoMP (Coordinated MultiPoint) or dual connectivity. D2D support is added by the
// ~NrNicEnbD2D subtype.
//
// The PDCP and RLC entities are missing from the submodules on purpose: the RRC
// layer's ~BearerManagement creates them per bearer at run time.
//
module NrNicEnb extends LteNicEnb
{
    parameters:
        bool hasSdap = default(false);  // Whether the stack has an SDAP layer: true on 5GC (Upf) networks, false on EPC/EN-DC ones; the network sets it per its core
        ip2nic.hasSdap = default(this.hasSdap);
        sdap.nodeRole = default("gNB");
        ip2nic.isNr = default(true);
        phy.isNr = default(true);
        rrc.bearerManagement.pdcpEntityModuleType = default("simu5g.stack.pdcp.NrPdcpEntity");
        mac.typename = default("NrMacGnb");
        channelModelType = default("Tr38901ChannelModel");
        packetFlowObserver.typename = default("NrPacketFlowObserverGnb");

    submodules:
        sdap: <default("NrSdap")> like INrSdap if hasSdap {
            @display("p=310,270");
        }

    connections:
        ip2nic.stackOut --> { @reconnect; } --> sdap.upperLayerIn if hasSdap;
        sdap.pdcpOut --> pdcpMux.upperLayerIn if hasSdap;
        pdcpMux.upperLayerOut --> { @reconnect; } --> sdap.pdcpIn if hasSdap;
        sdap.upperLayerOut --> ip2nic.stackIn if hasSdap;
}

File: src/simu5g/stack/NrNicEnb.ned