A Discrete-Event Network Simulator
API
Loading...
Searching...
No Matches
tcp-tx-buffer.h
Go to the documentation of this file.
1/*
2 * Copyright (c) 2010-2015 Adrian Sai-wah Tam
3 * Copyright (c) 2016 Natale Patriciello <natale.patriciello@gmail.com>
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 * Original author: Adrian Sai-wah Tam <adrian.sw.tam@gmail.com>
19 */
20
21#ifndef TCP_TX_BUFFER_H
22#define TCP_TX_BUFFER_H
23
24#include "tcp-option-sack.h"
25#include "tcp-tx-item.h"
26
27#include "ns3/object.h"
28#include "ns3/sequence-number.h"
29#include "ns3/traced-value.h"
30
31namespace ns3
32{
33class Packet;
34
123class TcpTxBuffer : public Object
124{
125 public:
130 static TypeId GetTypeId();
135 TcpTxBuffer(uint32_t n = 0);
136 ~TcpTxBuffer() override;
137
138 // Accessors
139
145
151
156 uint32_t Size() const;
157
162 uint32_t MaxBufferSize() const;
163
169
174 bool IsSackEnabled() const;
175
181 void SetSackEnabled(bool enabled);
182
187 uint32_t Available() const;
188
193 void SetDupAckThresh(uint32_t dupAckThresh);
194
200
211
218 uint32_t GetLost() const;
219
224 uint32_t GetSacked() const;
225
232 bool Add(Ptr<Packet> p);
233
241
263
271 void SetHeadSequence(const SequenceNumber32& seq);
272
279 bool IsRetransmittedDataAcked(const SequenceNumber32& ack) const;
280
289 void DiscardUpTo(const SequenceNumber32& seq,
290 const Callback<void, TcpTxItem*>& beforeDelCb = m_nullCb);
291
300 const Callback<void, TcpTxItem*>& sackedCb = m_nullCb);
301
311 bool IsLost(const SequenceNumber32& seq) const;
312
321 bool NextSeg(SequenceNumber32* seq, SequenceNumber32* seqHigh, bool isRecovery) const;
322
339 uint32_t BytesInFlight() const;
340
351 void SetSentListLost(bool resetSack = false);
352
359 bool IsHeadRetransmitted() const;
360
365
370 void ResetSentList();
371
377
381 void MarkHeadAsLost();
382
395 void AddRenoSack();
396
403 void ResetRenoSack();
404
409 void SetRWndCallback(Callback<uint32_t> rWndCallback);
410
411 private:
412 friend std::ostream& operator<<(std::ostream& os, const TcpTxBuffer& tcpTxBuf);
413
414 typedef std::list<TcpTxItem*> PacketList;
415
435 void UpdateLostCount();
436
445 void RemoveFromCounts(TcpTxItem* item, uint32_t size);
446
453 bool IsLostRFC(const SequenceNumber32& seq, const PacketList::const_iterator& segment) const;
454
460
476
492
564 const SequenceNumber32& startingSeq,
565 uint32_t numBytes,
566 const SequenceNumber32& requestedSeq,
567 bool* listEdited = nullptr) const;
568
579 void MergeItems(TcpTxItem* t1, TcpTxItem* t2) const;
580
591 void SplitItems(TcpTxItem* t1, TcpTxItem* t2, uint32_t size) const;
592
597 void ConsistencyCheck() const;
598
603 std::pair<TcpTxBuffer::PacketList::const_iterator, SequenceNumber32> FindHighestSacked() const;
604
611
614 std::pair<PacketList::const_iterator, SequenceNumber32> m_highestSack;
615
619
622 bool m_renoSack{false};
623 bool m_sackEnabled{true};
624
626};
627
634std::ostream& operator<<(std::ostream& os, const TcpTxBuffer& tcpTxBuf);
635
642std::ostream& operator<<(std::ostream& os, const TcpTxItem& item);
643
644} // namespace ns3
645
646#endif /* TCP_TX_BUFFER_H */
Callback template class.
Definition: callback.h:438
A base class which provides memory management and object aggregation.
Definition: object.h:89
Smart pointer class similar to boost::intrusive_ptr.
Definition: ptr.h:78
std::list< SackBlock > SackList
SACK list definition.
Tcp sender buffer.
uint32_t m_retrans
Number of retransmitted bytes.
void ResetRenoSack()
Reset the SACKs.
void ConsistencyCheck() const
Check if the values of sacked, lost, retrans, are in sync with the sent list.
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.
SequenceNumber32 HeadSequence() const
Get the sequence number of the buffer head.
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 GetRetransmitsCount() const
Return the number of segments in the sent list that have been transmitted more than once,...
bool IsRetransmittedDataAcked(const SequenceNumber32 &ack) const
Checks whether the ack corresponds to retransmitted data.
static TypeId GetTypeId()
Get the type ID.
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
uint32_t MaxBufferSize() const
Get the maximum buffer size.
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.
uint32_t m_dupAckThresh
Duplicate Ack threshold from TcpSocketBase.
uint32_t Size() const
Returns total number of bytes in this buffer.
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.
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.
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.
bool IsSackEnabled() const
check whether SACK is used on the corresponding TCP socket
TcpTxItem * GetNewSegment(uint32_t numBytes)
Get a block of data not transmitted yet and move it into SentList.
uint32_t Available() const
Returns the available capacity of this buffer.
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.
uint32_t GetLost() const
Get the number of segments that we believe are lost in the network.
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() 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.
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.
~TcpTxBuffer() override
PacketList m_appList
Buffer for application data.
uint32_t GetSacked() const
Get the number of segments that have been explicitly sacked by the receiver.
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.
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.
friend std::ostream & operator<<(std::ostream &os, const TcpTxBuffer &tcpTxBuf)
Output operator.
void SetHeadSequence(const SequenceNumber32 &seq)
Set the head sequence of the buffer.
Item that encloses the application packet and some flags for it.
Definition: tcp-tx-item.h:33
Trace classes with value semantics.
Definition: traced-value.h:116
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:159
#define list