A Discrete-Event Network Simulator
API
packet.h
Go to the documentation of this file.
1 /* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
2 /*
3  * Copyright (c) 2005,2006 INRIA
4  *
5  * This program is free software; you can redistribute it and/or modify
6  * it under the terms of the GNU General Public License version 2 as
7  * published by the Free Software Foundation;
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software
16  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17  *
18  * Author: Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
19  */
20 #ifndef PACKET_H
21 #define PACKET_H
22 
23 #include <stdint.h>
24 #include "buffer.h"
25 #include "header.h"
26 #include "trailer.h"
27 #include "packet-metadata.h"
28 #include "tag.h"
29 #include "byte-tag-list.h"
30 #include "packet-tag-list.h"
31 #include "nix-vector.h"
32 #include "ns3/mac48-address.h"
33 #include "ns3/callback.h"
34 #include "ns3/assert.h"
35 #include "ns3/ptr.h"
36 #include "ns3/deprecated.h"
37 
38 namespace ns3 {
39 
40 // Forward declaration
41 class Address;
42 
55 {
56 public:
61  class Item
62  {
63 public:
67  TypeId GetTypeId (void) const;
73  uint32_t GetStart (void) const;
79  uint32_t GetEnd (void) const;
88  void GetTag (Tag &tag) const;
89 private:
91  friend class ByteTagIterator;
99  Item (TypeId tid, uint32_t start, uint32_t end, TagBuffer buffer);
100 
102  uint32_t m_start;
103  uint32_t m_end;
105  };
109  bool HasNext (void) const;
113  Item Next (void);
114 private:
116  friend class Packet;
123 };
124 
132 {
133 public:
137  class Item
138  {
139 public:
143  TypeId GetTypeId (void) const;
152  void GetTag (Tag &tag) const;
153 private:
155  friend class PacketTagIterator;
160  Item (const struct PacketTagList::TagData *data);
162  };
166  bool HasNext (void) const;
170  Item Next (void);
171 private:
173  friend class Packet;
178  PacketTagIterator (const struct PacketTagList::TagData *head);
180 };
181 
231 class Packet : public SimpleRefCount<Packet>
232 {
233 public:
234 
239  Packet ();
244  Packet (const Packet &o);
250  Packet &operator = (const Packet &o);
262  Packet (uint32_t size);
275  Packet (uint8_t const*buffer, uint32_t size, bool magic);
286  Packet (uint8_t const*buffer, uint32_t size);
297  Ptr<Packet> CreateFragment (uint32_t start, uint32_t length) const;
304  inline uint32_t GetSize (void) const;
315  void AddHeader (const Header & header);
325  uint32_t RemoveHeader (Header &header);
337  uint32_t RemoveHeader (Header &header, uint32_t size);
346  uint32_t PeekHeader (Header &header) const;
358  uint32_t PeekHeader (Header &header, uint32_t size) const;
369  void AddTrailer (const Trailer &trailer);
378  uint32_t RemoveTrailer (Trailer &trailer);
387  uint32_t PeekTrailer (Trailer &trailer);
388 
397  void AddAtEnd (Ptr<const Packet> packet);
403  void AddPaddingAtEnd (uint32_t size);
412  void RemoveAtEnd (uint32_t size);
421  void RemoveAtStart (uint32_t size);
422 
433  uint32_t CopyData (uint8_t *buffer, uint32_t size) const;
434 
443  void CopyData (std::ostream *os, uint32_t size) const;
444 
454  Ptr<Packet> Copy (void) const;
455 
475  uint64_t GetUid (void) const;
476 
487  void Print (std::ostream &os) const;
488 
496  std::string ToString (void) const;
497 
511 
521  static void EnablePrinting (void);
532  static void EnableChecking (void);
533 
545  uint32_t GetSerializedSize (void) const;
546 
555  uint32_t Serialize (uint8_t* buffer, uint32_t maxSize) const;
556 
573  void AddByteTag (const Tag &tag) const;
574 
594  void AddByteTag (const Tag &tag, uint32_t start, uint32_t end) const;
600  ByteTagIterator GetByteTagIterator (void) const;
610  bool FindFirstMatchingByteTag (Tag &tag) const;
611 
615  void RemoveAllByteTags (void);
616 
623  void PrintByteTags (std::ostream &os) const;
624 
634  void AddPacketTag (const Tag &tag) const;
643  bool RemovePacketTag (Tag &tag);
654  bool ReplacePacketTag (Tag & tag);
662  bool PeekPacketTag (Tag &tag) const;
666  void RemoveAllPacketTags (void);
667 
676  void PrintPacketTags (std::ostream &os) const;
677 
686 
699  void SetNixVector (Ptr<NixVector> nixVector);
707  Ptr<NixVector> GetNixVector (void) const;
708 
714  typedef void (* TracedCallback) (Ptr<const Packet> packet);
715 
722  typedef void (* AddressTracedCallback)
724 
732  typedef void (* TwoAddressTracedCallback)
733  (const Ptr<const Packet> packet, const Address &srcAddress, const Address &destAddress);
734 
741  typedef void (* Mac48AddressTracedCallback)
743 
750  typedef void (* SizeTracedCallback)
751  (uint32_t oldSize, uint32_t newSize);
752 
759  typedef void (* SinrTracedCallback)
760  (Ptr<const Packet> packet, double sinr);
761 
762 
763 private:
771  Packet (const Buffer &buffer, const ByteTagList &byteTagList,
772  const PacketTagList &packetTagList, const PacketMetadata &metadata);
773 
780  uint32_t Deserialize (uint8_t const*buffer, uint32_t size);
781 
786 
787  /* Please see comments above about nix-vector */
789 
790  static uint32_t m_globalUid;
791 };
792 
800 std::ostream& operator<< (std::ostream& os, const Packet &packet);
801 
843 } // namespace ns3
844 
845 /****************************************************
846  * Implementation of inline methods for performance
847  ****************************************************/
848 
849 namespace ns3 {
850 
851 uint32_t
852 Packet::GetSize (void) const
853 {
854  return m_buffer.GetSize ();
855 }
856 
857 } // namespace ns3
858 
859 #endif /* PACKET_H */
Protocol header serialization and deserialization.
Definition: header.h:42
bool FindFirstMatchingByteTag(Tag &tag) const
Finds the first tag matching the parameter Tag type.
Definition: packet.cc:846
PacketMetadata m_metadata
the packet&#39;s metadata
Definition: packet.h:785
uint32_t RemoveHeader(Header &header)
Deserialize and remove the header from the internal buffer.
Definition: packet.cc:280
TypeId GetTypeId(void) const
Definition: packet.cc:34
void(* Mac48AddressTracedCallback)(Ptr< const Packet > packet, Mac48Address mac)
TracedCallback signature for packet and Mac48Address.
Definition: packet.h:742
uint64_t GetUid(void) const
Returns the packet&#39;s Uid.
Definition: packet.cc:390
void Print(std::ostream &os) const
Print the packet contents.
Definition: packet.cc:434
uint32_t Deserialize(uint8_t const *buffer, uint32_t size)
Deserializes a packet.
Definition: packet.cc:737
uint32_t GetSize(void) const
Returns the the size in bytes of the packet (including the zero-filled initial payload).
Definition: packet.h:852
bool HasNext(void) const
Definition: packet.cc:65
void(* TwoAddressTracedCallback)(const Ptr< const Packet > packet, const Address &srcAddress, const Address &destAddress)
TracedCallback signature for packet and source/destination addresses.
Definition: packet.h:733
uint32_t GetSerializedSize(void) const
Returns number of bytes required for packet serialization.
Definition: packet.cc:585
TypeId GetTypeId(void) const
Definition: packet.cc:107
const struct PacketTagList::TagData * m_data
the tag data
Definition: packet.h:161
automatically resized byte buffer
Definition: buffer.h:92
def start()
Definition: core.py:1855
Forward calls to a chain of Callback.
List of the packet tags stored in a packet.
keep track of the byte tags stored in a packet.
Definition: byte-tag-list.h:63
Ptr< Packet > CreateFragment(uint32_t start, uint32_t length) const
Create a new packet which contains a fragment of the original packet.
Definition: packet.cc:227
static uint32_t m_globalUid
Global counter of packets Uid.
Definition: packet.h:790
void(* SizeTracedCallback)(uint32_t oldSize, uint32_t newSize)
TracedCallback signature for changes in packet size.
Definition: packet.h:751
uint32_t GetStart(void) const
The index is an offset from the start of the packet.
Definition: packet.cc:39
Buffer m_buffer
the packet buffer (it&#39;s actual contents)
Definition: packet.h:782
Item(TypeId tid, uint32_t start, uint32_t end, TagBuffer buffer)
Constructor.
Definition: packet.cc:57
Packet & operator=(const Packet &o)
Basic assignment.
Definition: packet.cc:156
void PrintPacketTags(std::ostream &os) const
Print the list of packet tags.
Definition: packet.cc:898
network packets
Definition: packet.h:231
Item Next(void)
Definition: packet.cc:94
a polymophic address class
Definition: address.h:90
ByteTagList::Iterator m_current
actual position over the set of byte tags in a packet
Definition: packet.h:122
Packet()
Create an empty packet with a new uid (as returned by getUid).
Definition: packet.cc:129
uint32_t PeekTrailer(Trailer &trailer)
Deserialize but does not remove a trailer from the internal buffer.
Definition: packet.cc:327
void AddAtEnd(Ptr< const Packet > packet)
Concatenate the input packet at the end of the current packet.
Definition: packet.cc:335
Tree node for sharing serialized tags.
void RemoveAllPacketTags(void)
Remove all packet tags.
Definition: packet.cc:891
Identifies a byte tag and a set of bytes within a packet to which the tag applies.
Definition: packet.h:61
void RemoveAtStart(uint32_t size)
Remove size bytes from the start of the current packet.
Definition: packet.cc:362
TagBuffer m_buffer
the buffer associated with this tag.
Definition: packet.h:104
static void EnablePrinting(void)
Enable printing packets metadata.
Definition: packet.cc:572
bool HasNext(void) const
Definition: packet.cc:89
void(* AddressTracedCallback)(Ptr< const Packet > packet, const Address &address)
TracedCallback signature for packet and Address.
Definition: packet.h:723
TypeId m_tid
the ns3::TypeId associated to this tag.
Definition: packet.h:101
void SetNixVector(Ptr< NixVector > nixVector)
Set the packet nix-vector.
Definition: packet.cc:244
ByteTagList m_byteTagList
the ByteTag list
Definition: packet.h:783
Defines a linked list of Packet tags, including copy-on-write semantics.
uint8_t data[writeSize]
Iterator class for metadata items.
bool ReplacePacketTag(Tag &tag)
Replace the value of a packet tag.
Definition: packet.cc:877
mac
Definition: third.py:99
static void EnableChecking(void)
Enable packets metadata checking.
Definition: packet.cc:579
std::string ToString(void) const
Return a string representation of the packet.
Definition: packet.cc:426
void AddPaddingAtEnd(uint32_t size)
Add a zero-filled padding to the packet.
Definition: packet.cc:347
uint32_t PeekHeader(Header &header) const
Deserialize but does not remove the header from the internal buffer.
Definition: packet.cc:290
Item Next(void)
Definition: packet.cc:70
void(* SinrTracedCallback)(Ptr< const Packet > packet, double sinr)
TracedCallback signature for packet and SINR.
Definition: packet.h:760
Iterator over the set of packet tags in a packet.
Definition: packet.h:131
const struct PacketTagList::TagData * m_current
actual position over the set of tags in a packet
Definition: packet.h:179
std::ostream & operator<<(std::ostream &os, const Angles &a)
print a struct Angles to output
Definition: angles.cc:42
uint32_t m_end
the index of the last byte tagged by this tag.
Definition: packet.h:103
Protocol trailer serialization and deserialization.
Definition: trailer.h:40
tag a set of bytes in a packet
Definition: tag.h:36
PacketTagIterator GetPacketTagIterator(void) const
Returns an object which can be used to iterate over the list of packet tags.
Definition: packet.cc:921
Every class exported by the ns3 library is enclosed in the ns3 namespace.
address
Definition: first.py:37
PacketTagIterator(const struct PacketTagList::TagData *head)
Constructor.
Definition: packet.cc:84
void AddTrailer(const Trailer &trailer)
Add trailer to this packet.
Definition: packet.cc:307
Ptr< Packet > Copy(void) const
performs a COW copy of the packet.
Definition: packet.cc:121
void RemoveAtEnd(uint32_t size)
Remove size bytes from the end of the current packet.
Definition: packet.cc:355
Iterator over the set of byte tags in a packet.
Definition: packet.h:54
uint32_t RemoveTrailer(Trailer &trailer)
Remove a deserialized trailer from the internal buffer.
Definition: packet.cc:318
an EUI-48 address
Definition: mac48-address.h:43
PacketTagList m_packetTagList
the packet&#39;s Tag list
Definition: packet.h:784
void PrintByteTags(std::ostream &os) const
Iterate over the byte tags present in this packet, and invoke the Print method of each tag stored in ...
Definition: packet.cc:396
Identifies a packet tag within a packet.
Definition: packet.h:137
PacketMetadata::ItemIterator BeginItem(void) const
Returns an iterator which points to the first &#39;item&#39; stored in this buffer.
Definition: packet.cc:566
Item(const struct PacketTagList::TagData *data)
Constructor.
Definition: packet.cc:102
uint32_t GetEnd(void) const
The index is an offset from the start of the packet.
Definition: packet.cc:44
An iterator for iterating through a byte tag list.
Definition: byte-tag-list.h:72
read and write tag data
Definition: tag-buffer.h:51
void GetTag(Tag &tag) const
Read the requested tag and store it in the user-provided tag instance.
Definition: packet.cc:112
void AddPacketTag(const Tag &tag) const
Add a packet tag.
Definition: packet.cc:863
uint32_t CopyData(uint8_t *buffer, uint32_t size) const
Copy the packet contents to a byte buffer.
Definition: packet.cc:378
bool RemovePacketTag(Tag &tag)
Remove a packet tag.
Definition: packet.cc:870
void RemoveAllByteTags(void)
Remove all byte tags stored in this packet.
Definition: packet.cc:371
Ptr< NixVector > GetNixVector(void) const
Get the packet nix-vector.
Definition: packet.cc:250
Ptr< NixVector > m_nixVector
the packet&#39;s Nix vector
Definition: packet.h:788
uint32_t GetSize(void) const
Definition: buffer.h:1063
uint32_t m_start
the index of the first byte tagged by this tag.
Definition: packet.h:102
ByteTagIterator(ByteTagList::Iterator i)
Copy Constructor.
Definition: packet.cc:78
bool PeekPacketTag(Tag &tag) const
Search a matching tag and call Tag::Deserialize if it is found.
Definition: packet.cc:885
void GetTag(Tag &tag) const
Read the requested tag and store it in the user-provided tag instance.
Definition: packet.cc:49
A template-based reference counting class.
a unique identifier for an interface.
Definition: type-id.h:58
void AddByteTag(const Tag &tag) const
Tag each byte included in this packet with a new byte tag.
Definition: packet.cc:819
void AddHeader(const Header &header)
Add header to this packet.
Definition: packet.cc:256
ByteTagIterator GetByteTagIterator(void) const
Returns an iterator over the set of byte tags included in this packet.
Definition: packet.cc:840
uint32_t Serialize(uint8_t *buffer, uint32_t maxSize) const
Serialize a packet, tags, and metadata into a byte buffer.
Definition: packet.cc:628
Handle packet metadata about packet headers and trailers.