INET Framework for OMNeT++/OMNEST
inet::EthernetFragmentFcsInserter Class Reference

#include <EthernetFragmentFcsInserter.h>

Inheritance diagram for inet::EthernetFragmentFcsInserter:
inet::FcsInserterBase inet::queueing::PacketFlowBase inet::queueing::PacketProcessorBase inet::queueing::IPacketFlow inet::queueing::IPacketCollection inet::queueing::IPacketProcessor inet::StringFormat::IDirectiveResolver inet::queueing::IPacketSink inet::queueing::IPacketSource inet::queueing::IPassivePacketSink inet::queueing::IActivePacketSink inet::queueing::IPassivePacketSource inet::queueing::IActivePacketSource

Protected Member Functions

virtual uint32_t computeComputedFcs (const Packet *packet) const override
 
virtual uint32_t computeFcs (const Packet *packet, FcsMode fcsMode) const override
 
virtual void processPacket (Packet *packet) override
 
virtual void handlePacketProcessed (Packet *packet) override
 
- Protected Member Functions inherited from inet::FcsInserterBase
virtual void initialize (int stage) override
 
virtual uint32_t computeDisabledFcs (const Packet *packet) const
 
virtual uint32_t computeDeclaredCorrectFcs (const Packet *packet) const
 
virtual uint32_t computeDeclaredIncorrectFcs (const Packet *packet) const
 
- Protected Member Functions inherited from inet::queueing::PacketFlowBase
virtual void handleMessage (cMessage *message) override
 
virtual bool isStreamingPacket () const
 
virtual void startPacketStreaming (Packet *packet)
 
virtual void endPacketStreaming (Packet *packet)
 
virtual void checkPacketStreaming (Packet *packet)
 
- Protected Member Functions inherited from inet::queueing::PacketProcessorBase
virtual int numInitStages () const override
 
virtual void refreshDisplay () const override
 
virtual void checkPacketOperationSupport (cGate *gate) const
 
virtual void checkPacketOperationSupport (cGate *startGate, cGate *endGate) const
 
virtual void animate (Packet *packet, cGate *gate, const SendOptions &sendOptions, Action action) const
 
virtual void animatePacket (Packet *packet, cGate *gate, Action action) const
 
virtual void animatePacketStart (Packet *packet, cGate *gate, bps datarate, long transmissionId, Action action) const
 
virtual void animatePacketStart (Packet *packet, cGate *gate, bps datarate, const SendOptions &sendOptions, Action action) const
 
virtual void animatePacketEnd (Packet *packet, cGate *gate, long transmissionId, Action action) const
 
virtual void animatePacketEnd (Packet *packet, cGate *gate, const SendOptions &sendOptions, Action action) const
 
virtual void animatePacketProgress (Packet *packet, cGate *gate, bps datarate, b position, b extraProcessableLength, long transmissionId, Action action) const
 
virtual void animatePacketProgress (Packet *packet, cGate *gate, bps datarate, b position, b extraProcessableLength, const SendOptions &sendOptions, Action action) const
 
virtual void pushOrSendPacket (Packet *packet, cGate *gate, IPassivePacketSink *consumer)
 
virtual void pushOrSendPacketStart (Packet *packet, cGate *gate, IPassivePacketSink *consumer, bps datarate, int transmissionId)
 
virtual void pushOrSendPacketEnd (Packet *packet, cGate *gate, IPassivePacketSink *consumer, int transmissionId)
 
virtual void pushOrSendPacketProgress (Packet *packet, cGate *gate, IPassivePacketSink *consumer, bps datarate, b position, b extraProcessableLength, int transmissionId)
 
virtual void animatePush (Packet *packet, cGate *gate, const SendOptions &sendOptions) const
 
virtual void animatePushPacket (Packet *packet, cGate *gate) const
 
virtual void animatePushPacketStart (Packet *packet, cGate *gate, bps datarate, long transmissionId) const
 
virtual void animatePushPacketStart (Packet *packet, cGate *gate, bps datarate, const SendOptions &sendOptions) const
 
virtual void animatePushPacketEnd (Packet *packet, cGate *gate, long transmissionId) const
 
virtual void animatePushPacketEnd (Packet *packet, cGate *gate, const SendOptions &sendOptions) const
 
virtual void animatePushPacketProgress (Packet *packet, cGate *gate, bps datarate, b position, b extraProcessableLength, long transmissionId) const
 
virtual void animatePushPacketProgress (Packet *packet, cGate *gate, bps datarate, b position, b extraProcessableLength, const SendOptions &sendOptions) const
 
virtual void animatePull (Packet *packet, cGate *gate, const SendOptions &sendOptions) const
 
virtual void animatePullPacket (Packet *packet, cGate *gate) const
 
virtual void animatePullPacketStart (Packet *packet, cGate *gate, bps datarate, long transmissionId) const
 
virtual void animatePullPacketStart (Packet *packet, cGate *gate, bps datarate, const SendOptions &sendOptions) const
 
virtual void animatePullPacketEnd (Packet *packet, cGate *gate, long transmissionId) const
 
virtual void animatePullPacketEnd (Packet *packet, cGate *gate, const SendOptions &sendOptions) const
 
virtual void animatePullPacketProgress (Packet *packet, cGate *gate, bps datarate, b position, b extraProcessableLength, long transmissionId) const
 
virtual void animatePullPacketProgress (Packet *packet, cGate *gate, bps datarate, b position, b extraProcessableLength, const SendOptions &sendOptions) const
 
virtual void dropPacket (Packet *packet, PacketDropReason reason, int limit=-1)
 
virtual void updateDisplayString () const
 

Protected Attributes

uint32_t lastFragmentCompleteFcs = 0
 
uint32_t currentFragmentCompleteFcs = 0
 
- Protected Attributes inherited from inet::FcsInserterBase
FcsMode fcsMode = FCS_MODE_UNDEFINED
 
- Protected Attributes inherited from inet::queueing::PacketFlowBase
cGate * inputGate = nullptr
 
ModuleRef< IActivePacketSourceproducer
 
ModuleRef< IPassivePacketSourceprovider
 
ModuleRef< IPacketCollectioncollection
 
cGate * outputGate = nullptr
 
ModuleRef< IPassivePacketSinkconsumer
 
ModuleRef< IActivePacketSinkcollector
 
int inProgressStreamId = -1
 
- Protected Attributes inherited from inet::queueing::PacketProcessorBase
const char * displayStringTextFormat = nullptr
 
int numProcessedPackets = -1
 
b processedTotalLength = b(-1)
 

Additional Inherited Members

- Public Member Functions inherited from inet::queueing::PacketFlowBase
virtual IPassivePacketSinkgetConsumer (cGate *gate) override
 Returns the passive packet sink where packets are pushed or nullptr if the connected module doesn't implement the interface. More...
 
virtual IPassivePacketSourcegetProvider (cGate *gate) override
 Returns the passive packet source from where packets are pulled or nullptr if the connected module doesn't implement the interface. More...
 
virtual bool supportsPacketPushing (cGate *gate) const override
 Returns true if the processor supports pushing packets at the given gate. More...
 
virtual bool supportsPacketPulling (cGate *gate) const override
 Returns true if the processor supports pulling packets at the given gate. More...
 
virtual bool supportsPacketStreaming (cGate *gate) const override
 Returns true if the processor supports streaming packets at the given gate. More...
 
virtual bool canPushSomePacket (cGate *gate) const override
 Returns false if the packet sink is full at the given gate and no more packets can be pushed into it without raising an error. More...
 
virtual bool canPushPacket (Packet *packet, cGate *gate) const override
 Returns true if the given packet can be pushed at the given gate into the packet sink without raising an error. More...
 
virtual void pushPacket (Packet *packet, cGate *gate) override
 Pushes the packet into the packet sink at the given gate. More...
 
virtual void pushPacketStart (Packet *packet, cGate *gate, bps datarate) override
 Starts pushing the packet into the packet sink at the given gate. More...
 
virtual void pushPacketEnd (Packet *packet, cGate *gate) override
 Ends pushing the packet into the packet sink at the given gate. More...
 
virtual void pushPacketProgress (Packet *packet, cGate *gate, bps datarate, b position, b extraProcessableLength=b(0)) override
 Progresses pushing the packet into the packet sink at the given gate. More...
 
virtual void handleCanPushPacketChanged (cGate *gate) override
 Notifies about a change in the possibility of pushing some packet into the passive packet sink at the given gate. More...
 
virtual void handlePushPacketProcessed (Packet *packet, cGate *gate, bool successful) override
 Notifies about the completion of the packet processing for a packet that was pushed earlier independently whether the packet is passed or streamed. More...
 
virtual bool canPullSomePacket (cGate *gate) const override
 Returns false if the packet source is empty at the given gate and no more packets can be pulled from it without raising an error. More...
 
virtual PacketcanPullPacket (cGate *gate) const override
 Returns the packet that can be pulled at the given gate. More...
 
virtual PacketpullPacket (cGate *gate) override
 Pulls the packet from the packet source at the given gate. More...
 
virtual PacketpullPacketStart (cGate *gate, bps datarate) override
 Starts pulling the packet from the packet source at the given gate. More...
 
virtual PacketpullPacketEnd (cGate *gate) override
 Ends pulling the packet from the packet source at the given gate. More...
 
virtual PacketpullPacketProgress (cGate *gate, bps datarate, b position, b extraProcessableLength) override
 Progresses pulling the packet from the packet source at the given gate. More...
 
virtual void handleCanPullPacketChanged (cGate *gate) override
 Notifies about a change in the possibility of pulling some packet from the passive packet source at the given gate. More...
 
virtual void handlePullPacketProcessed (Packet *packet, cGate *gate, bool successful) override
 Notifies about the completion of the packet processing for a packet that was pulled earlier independently whether the packet is passed or streamed. More...
 
virtual int getMaxNumPackets () const override
 Returns maximum allowed number of packets in the collection. More...
 
virtual int getNumPackets () const override
 Returns the number of available packets in the collection in the range [0, inf). More...
 
virtual b getMaxTotalLength () const override
 Returns maximum allowed total length of all packets in the collection. More...
 
virtual b getTotalLength () const override
 Returns the total length of all packets in the collection in the range [0, inf). More...
 
virtual PacketgetPacket (int index) const override
 Returns the packet at the given index. More...
 
virtual bool isEmpty () const override
 Returns true if there are no packets available in the collection. More...
 
virtual void removePacket (Packet *packet) override
 Removes a packet from the collection. More...
 
virtual void removeAllPackets () override
 Removes all packets from the collection. More...
 
- Public Member Functions inherited from inet::queueing::PacketProcessorBase
virtual bool supportsPacketSending (cGate *gate) const override
 Returns true if the processor supports sending packets at the given gate. More...
 
virtual bool supportsPacketPassing (cGate *gate) const override
 Returns true if the processor supports passing packets as a whole at the given gate. More...
 
virtual const char * resolveDirective (char directive) const override
 
- Public Member Functions inherited from inet::queueing::IPacketProcessor
virtual ~IPacketProcessor ()
 
- Public Member Functions inherited from inet::queueing::IPassivePacketSink
virtual ~IPassivePacketSink ()
 
- Public Member Functions inherited from inet::queueing::IActivePacketSink
virtual ~IActivePacketSink ()
 
- Public Member Functions inherited from inet::queueing::IPassivePacketSource
virtual ~IPassivePacketSource ()
 
- Public Member Functions inherited from inet::queueing::IActivePacketSource
virtual ~IActivePacketSource ()
 
- Protected Types inherited from inet::queueing::PacketProcessorBase
enum  Action { PUSH, PULL }
 

Member Function Documentation

◆ computeComputedFcs()

uint32_t inet::EthernetFragmentFcsInserter::computeComputedFcs ( const Packet packet) const
overrideprotectedvirtual

Reimplemented from inet::FcsInserterBase.

20 {
21  auto data = packet->peekDataAsBytes();
22  auto bytes = data->getBytes();
23  auto fragmentTag = packet->getTag<FragmentTag>();
24  currentFragmentCompleteFcs = ethernetCRC(bytes.data(), packet->getByteLength(), fragmentTag->getFirstFragment() ? 0 : lastFragmentCompleteFcs);
25  if (fragmentTag->getLastFragment())
27  else
28  return ethernetCRC(bytes.data(), packet->getByteLength()) ^ 0xFFFF0000;
29 }

Referenced by computeFcs().

◆ computeFcs()

uint32_t inet::EthernetFragmentFcsInserter::computeFcs ( const Packet packet,
FcsMode  fcsMode 
) const
overrideprotectedvirtual

Reimplemented from inet::FcsInserterBase.

32 {
33  switch (fcsMode) {
35  return computeDeclaredCorrectFcs(packet);
37  return computeDeclaredIncorrectFcs(packet);
38  case FCS_COMPUTED:
39  return computeComputedFcs(packet);
40  default:
41  throw cRuntimeError("Unknown FCS mode: %d", (int)fcsMode);
42  }
43 }

Referenced by processPacket().

◆ handlePacketProcessed()

void inet::EthernetFragmentFcsInserter::handlePacketProcessed ( Packet packet)
overrideprotectedvirtual

◆ processPacket()

void inet::EthernetFragmentFcsInserter::processPacket ( Packet packet)
overrideprotectedvirtual

Implements inet::queueing::PacketFlowBase.

46 {
47  const auto& header = makeShared<EthernetFragmentFcs>();
48  auto fragmentTag = packet->getTag<FragmentTag>();
49  auto fcs = computeFcs(packet, fcsMode);
50  header->setFcs(fcs);
51  header->setFcsMode(fcsMode);
52  header->setMCrc(!fragmentTag->getLastFragment());
53  packet->insertAtBack(header);
54  auto& packetProtocolTag = packet->findTagForUpdate<PacketProtocolTag>();
55  if (packetProtocolTag != nullptr)
56  packetProtocolTag->setBackOffset(packetProtocolTag->getBackOffset() - header->getChunkLength());
57 }

Member Data Documentation

◆ currentFragmentCompleteFcs

uint32_t inet::EthernetFragmentFcsInserter::currentFragmentCompleteFcs = 0
mutableprotected

◆ lastFragmentCompleteFcs

uint32_t inet::EthernetFragmentFcsInserter::lastFragmentCompleteFcs = 0
protected

The documentation for this class was generated from the following files:
inet::FcsInserterBase::fcsMode
FcsMode fcsMode
Definition: FcsInserterBase.h:21
inet::FcsInserterBase::computeDeclaredIncorrectFcs
virtual uint32_t computeDeclaredIncorrectFcs(const Packet *packet) const
Definition: FcsInserterBase.cc:31
inet::EthernetFragmentFcsInserter::computeFcs
virtual uint32_t computeFcs(const Packet *packet, FcsMode fcsMode) const override
Definition: EthernetFragmentFcsInserter.cc:31
inet::FCS_COMPUTED
@ FCS_COMPUTED
Definition: FcsMode_m.h:59
inet::FCS_DECLARED_CORRECT
@ FCS_DECLARED_CORRECT
Definition: FcsMode_m.h:57
PacketProtocolTag
removed DscpReq Ipv4ControlInfo Ipv6ControlInfo up L3AddressInd DispatchProtocolReq L4PortInd Ipv4ControlInfo Ipv6ControlInfo down PacketProtocolTag
Definition: IUdp-gates.txt:25
inet::queueing::PacketProcessorBase::handlePacketProcessed
virtual void handlePacketProcessed(Packet *packet)
Definition: PacketProcessorBase.cc:34
inet::ethernetCRC
uint32_t ethernetCRC(const unsigned char *buf, unsigned int bufsize, uint32_t crc)
Definition: EthernetCRC.cc:58
inet::EthernetFragmentFcsInserter::lastFragmentCompleteFcs
uint32_t lastFragmentCompleteFcs
Definition: EthernetFragmentFcsInserter.h:20
inet::FcsInserterBase::computeDeclaredCorrectFcs
virtual uint32_t computeDeclaredCorrectFcs(const Packet *packet) const
Definition: FcsInserterBase.cc:26
inet::EthernetFragmentFcsInserter::currentFragmentCompleteFcs
uint32_t currentFragmentCompleteFcs
Definition: EthernetFragmentFcsInserter.h:21
inet::FCS_DECLARED_INCORRECT
@ FCS_DECLARED_INCORRECT
Definition: FcsMode_m.h:58
inet::EthernetFragmentFcsInserter::computeComputedFcs
virtual uint32_t computeComputedFcs(const Packet *packet) const override
Definition: EthernetFragmentFcsInserter.cc:19