A Discrete-Event Network Simulator
API
tcp-tx-buffer.h
Go to the documentation of this file.
1/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
2/*
3 * Copyright (c) 2010-2015 Adrian Sai-wah Tam
4 * Copyright (c) 2016 Natale Patriciello <natale.patriciello@gmail.com>
5 *
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License version 2 as
8 * published by the Free Software Foundation;
9 *
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
14 *
15 * You should have received a copy of the GNU General Public License
16 * along with this program; if not, write to the Free Software
17 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
18 *
19 * Original author: Adrian Sai-wah Tam <adrian.sw.tam@gmail.com>
20 */
21
22#ifndef TCP_TX_BUFFER_H
23#define TCP_TX_BUFFER_H
24
25#include "ns3/object.h"
26#include "ns3/traced-value.h"
27#include "ns3/sequence-number.h"
28#include "ns3/tcp-option-sack.h"
29#include "ns3/tcp-tx-item.h"
30
31namespace ns3 {
32class Packet;
33
122class TcpTxBuffer : public Object
123{
124public:
129 static TypeId GetTypeId (void);
134 TcpTxBuffer (uint32_t n = 0);
135 virtual ~TcpTxBuffer (void);
136
137 // Accessors
138
143 SequenceNumber32 HeadSequence (void) const;
144
149 SequenceNumber32 TailSequence (void) const;
150
155 uint32_t Size (void) const;
156
161 uint32_t MaxBufferSize (void) const;
162
167 void SetMaxBufferSize (uint32_t n);
168
173 bool IsSackEnabled (void) const;
174
180 void SetSackEnabled (bool enabled);
181
186 uint32_t Available (void) const;
187
192 void SetDupAckThresh (uint32_t dupAckThresh);
193
199
209 uint32_t GetRetransmitsCount (void) const;
210
217 uint32_t GetLost (void) const;
218
223 uint32_t GetSacked (void) const;
224
231 bool Add (Ptr<Packet> p);
232
239 uint32_t SizeFromSequence (const SequenceNumber32& seq) const;
240
261 TcpTxItem* CopyFromSequence (uint32_t numBytes, const SequenceNumber32& seq);
262
270 void SetHeadSequence (const SequenceNumber32& seq);
271
278 bool IsRetransmittedDataAcked (const SequenceNumber32& ack) const;
279
288 void DiscardUpTo (const SequenceNumber32& seq,
289 const Callback<void, TcpTxItem *> &beforeDelCb = m_nullCb);
290
299 const Callback<void, TcpTxItem *> &sackedCb = m_nullCb);
300
310 bool IsLost (const SequenceNumber32 &seq) const;
311
320 bool NextSeg (SequenceNumber32 *seq, SequenceNumber32 *seqHigh, bool isRecovery) const;
321
338 uint32_t BytesInFlight () const;
339
350 void SetSentListLost (bool resetSack = false);
351
358 bool IsHeadRetransmitted () const;
359
364
369 void ResetSentList ();
370
375 void ResetLastSegmentSent ();
376
380 void MarkHeadAsLost ();
381
394 void AddRenoSack ();
395
402 void ResetRenoSack ();
403
408 void SetRWndCallback (Callback<uint32_t> rWndCallback);
409
410private:
411 friend std::ostream & operator<< (std::ostream & os, TcpTxBuffer const & tcpTxBuf);
412
413 typedef std::list<TcpTxItem*> PacketList;
414
434 void UpdateLostCount ();
435
444 void RemoveFromCounts (TcpTxItem *item, uint32_t size);
445
452 bool IsLostRFC (const SequenceNumber32 &seq, const PacketList::const_iterator &segment) const;
453
458 uint32_t BytesInFlightRFC () const;
459
474 TcpTxItem* GetNewSegment (uint32_t numBytes);
475
491
563 uint32_t numBytes, const SequenceNumber32 &requestedSeq,
564 bool *listEdited = nullptr) const;
565
576 void MergeItems (TcpTxItem *t1, TcpTxItem *t2) const;
577
588 void SplitItems (TcpTxItem *t1, TcpTxItem *t2, uint32_t size) const;
589
594 void ConsistencyCheck () const;
595
600 std::pair <TcpTxBuffer::PacketList::const_iterator, SequenceNumber32>
601 FindHighestSacked () const;
602
609
611 std::pair <PacketList::const_iterator, SequenceNumber32> m_highestSack;
612
616
619 bool m_renoSack {false};
620 bool m_sackEnabled {true};
621
623};
624
631std::ostream & operator<< (std::ostream & os, TcpTxBuffer const & tcpTxBuf);
632
639std::ostream & operator<< (std::ostream & os, TcpTxItem const & item);
640
641} // namespace ns3
642
643#endif /* TCP_TX_BUFFER_H */
Callback template class.
Definition: callback.h:422
A base class which provides memory management and object aggregation.
Definition: object.h:88
std::list< SackBlock > SackList
SACK list definition.
Tcp sender buffer.
uint32_t m_retrans
Number of retransmitted bytes.
void ResetRenoSack()
Reset the SACKs.
uint32_t GetSacked(void) const
Get the number of segments that have been explicitly sacked by the receiver.
void ConsistencyCheck() const
Check if the values of sacked, lost, retrans, are in sync with the sent list.
static TypeId GetTypeId(void)
Get the type ID.
bool m_sackEnabled
Indicates if SACK is enabled on this connection.
uint32_t m_lostOut
Number of lost bytes.
bool IsLostRFC(const SequenceNumber32 &seq, const PacketList::const_iterator &segment) const
Decide if a segment is lost based on RFC 6675 algorithm.
std::pair< TcpTxBuffer::PacketList::const_iterator, SequenceNumber32 > FindHighestSacked() const
Find the highest SACK byte.
std::pair< PacketList::const_iterator, SequenceNumber32 > m_highestSack
Highest SACK byte.
bool IsHeadRetransmitted() const
Check if the head is retransmitted.
bool Add(Ptr< Packet > p)
Append a data packet to the end of the buffer.
void SetSegmentSize(uint32_t segmentSize)
Set the segment size.
uint32_t Available(void) const
Returns the available capacity of this buffer.
bool IsRetransmittedDataAcked(const SequenceNumber32 &ack) const
Checks whether the ack corresponds to retransmitted data.
TcpTxItem * GetPacketFromList(PacketList &list, const SequenceNumber32 &startingSeq, uint32_t numBytes, const SequenceNumber32 &requestedSeq, bool *listEdited=nullptr) const
Get a block (which is returned as Packet) from a list.
uint32_t SizeFromSequence(const SequenceNumber32 &seq) const
Returns the number of bytes from the buffer in the range [seq, tailSequence)
TracedValue< SequenceNumber32 > m_firstByteSeq
Sequence number of the first byte in data (SND.UNA)
std::list< TcpTxItem * > PacketList
container for data stored in the buffer
TcpTxItem * GetTransmittedSegment(uint32_t numBytes, const SequenceNumber32 &seq)
Get a block of data previously transmitted.
uint32_t m_maxBuffer
Max number of data bytes in buffer (SND.WND)
bool m_renoSack
Indicates if AddRenoSack was called.
friend std::ostream & operator<<(std::ostream &os, TcpTxBuffer const &tcpTxBuf)
Output operator.
uint32_t m_dupAckThresh
Duplicate Ack threshold from TcpSocketBase.
void SetSackEnabled(bool enabled)
tell tx-buffer whether SACK is used on this TCP socket
static Callback< void, TcpTxItem * > m_nullCb
Null callback for an item.
virtual ~TcpTxBuffer(void)
uint32_t m_sackedOut
Number of sacked bytes.
void ResetLastSegmentSent()
Take the last segment sent and put it back into the un-sent list (at the beginning)
bool IsLost(const SequenceNumber32 &seq) const
Check if a segment is lost.
bool NextSeg(SequenceNumber32 *seq, SequenceNumber32 *seqHigh, bool isRecovery) const
Get the next sequence number to transmit, according to RFC 6675.
uint32_t MaxBufferSize(void) const
Get the maximum buffer size.
uint32_t GetLost(void) const
Get the number of segments that we believe are lost in the network.
void SetDupAckThresh(uint32_t dupAckThresh)
Set the DupAckThresh.
TcpTxItem * CopyFromSequence(uint32_t numBytes, const SequenceNumber32 &seq)
Copy data from the range [seq, seq+numBytes) into a packet.
TcpTxItem * GetNewSegment(uint32_t numBytes)
Get a block of data not transmitted yet and move it into SentList.
uint32_t m_segmentSize
Segment size from TcpSocketBase.
uint32_t Update(const TcpOptionSack::SackList &list, const Callback< void, TcpTxItem * > &sackedCb=m_nullCb)
Update the scoreboard.
void AddRenoSack()
Emulate SACKs for SACKless connection: account for a new dupack.
void MarkHeadAsLost()
Mark the head of the sent list as lost.
void UpdateLostCount()
Update the lost count.
SequenceNumber32 TailSequence(void) const
Get the sequence number of the buffer tail (plus one)
Callback< uint32_t > m_rWndCallback
Callback to obtain RCV.WND value.
void SetRWndCallback(Callback< uint32_t > rWndCallback)
Set callback to obtain receiver window value.
uint32_t BytesInFlight() const
Return total bytes in flight.
uint32_t Size(void) const
Returns total number of bytes in this buffer.
SequenceNumber32 HeadSequence(void) const
Get the sequence number of the buffer head.
void SetSentListLost(bool resetSack=false)
Set the entire sent list as lost (typically after an RTO)
void SplitItems(TcpTxItem *t1, TcpTxItem *t2, uint32_t size) const
Split one TcpTxItem.
void DiscardUpTo(const SequenceNumber32 &seq, const Callback< void, TcpTxItem * > &beforeDelCb=m_nullCb)
Discard data up to but not including this sequence number.
uint32_t BytesInFlightRFC() const
Calculate the number of bytes in flight per RFC 6675.
PacketList m_appList
Buffer for application data.
void MergeItems(TcpTxItem *t1, TcpTxItem *t2) const
Merge two TcpTxItem.
uint32_t m_size
Size of all data in this buffer.
void ResetSentList()
Reset the sent list.
void DeleteRetransmittedFlagFromHead()
DeleteRetransmittedFlagFromHead.
void SetMaxBufferSize(uint32_t n)
Set the maximum buffer size.
bool IsSackEnabled(void) const
check whether SACK is used on the corresponding TCP socket
PacketList m_sentList
Buffer for sent (but not acked) data.
uint32_t m_sentSize
Size of sent (and not discarded) segments.
void RemoveFromCounts(TcpTxItem *item, uint32_t size)
Remove the size specified from the lostOut, retrans, sacked count.
void SetHeadSequence(const SequenceNumber32 &seq)
Set the head sequence of the buffer.
uint32_t GetRetransmitsCount(void) const
Return the number of segments in the sent list that have been transmitted more than once,...
TcpTxBuffer(uint32_t n=0)
Constructor.
Item that encloses the application packet and some flags for it.
Definition: tcp-tx-item.h:33
a unique identifier for an interface.
Definition: type-id.h:59
uint32_t segmentSize
Every class exported by the ns3 library is enclosed in the ns3 namespace.
std::ostream & operator<<(std::ostream &os, const Angles &a)
Definition: angles.cc:139
#define list