A Discrete-Event Network Simulator
API
aodv-rqueue.cc
Go to the documentation of this file.
1 /* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
2 /*
3  * Copyright (c) 2009 IITP RAS
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  * Based on
19  * NS-2 AODV model developed by the CMU/MONARCH group and optimized and
20  * tuned by Samir Das and Mahesh Marina, University of Cincinnati;
21  *
22  * AODV-UU implementation by Erik Nordström of Uppsala University
23  * http://core.it.uu.se/core/index.php/AODV-UU
24  *
25  * Authors: Elena Buchatskaia <borovkovaes@iitp.ru>
26  * Pavel Boyko <boyko@iitp.ru>
27  */
28 #include "aodv-rqueue.h"
29 #include <algorithm>
30 #include <functional>
31 #include "ns3/ipv4-route.h"
32 #include "ns3/socket.h"
33 #include "ns3/log.h"
34 
35 namespace ns3 {
36 
37 NS_LOG_COMPONENT_DEFINE ("AodvRequestQueue");
38 
39 namespace aodv {
40 uint32_t
42 {
43  Purge ();
44  return m_queue.size ();
45 }
46 
47 bool
49 {
50  Purge ();
51  for (std::vector<QueueEntry>::const_iterator i = m_queue.begin (); i
52  != m_queue.end (); ++i)
53  {
54  if ((i->GetPacket ()->GetUid () == entry.GetPacket ()->GetUid ())
55  && (i->GetIpv4Header ().GetDestination ()
56  == entry.GetIpv4Header ().GetDestination ()))
57  {
58  return false;
59  }
60  }
62  if (m_queue.size () == m_maxLen)
63  {
64  Drop (m_queue.front (), "Drop the most aged packet"); // Drop the most aged packet
65  m_queue.erase (m_queue.begin ());
66  }
67  m_queue.push_back (entry);
68  return true;
69 }
70 
71 void
73 {
74  NS_LOG_FUNCTION (this << dst);
75  Purge ();
76  for (std::vector<QueueEntry>::iterator i = m_queue.begin (); i
77  != m_queue.end (); ++i)
78  {
79  if (IsEqual (*i, dst))
80  {
81  Drop (*i, "DropPacketWithDst ");
82  }
83  }
84  m_queue.erase (std::remove_if (m_queue.begin (), m_queue.end (),
85  std::bind2nd (std::ptr_fun (RequestQueue::IsEqual), dst)), m_queue.end ());
86 }
87 
88 bool
90 {
91  Purge ();
92  for (std::vector<QueueEntry>::iterator i = m_queue.begin (); i != m_queue.end (); ++i)
93  {
94  if (i->GetIpv4Header ().GetDestination () == dst)
95  {
96  entry = *i;
97  m_queue.erase (i);
98  return true;
99  }
100  }
101  return false;
102 }
103 
104 bool
106 {
107  for (std::vector<QueueEntry>::const_iterator i = m_queue.begin (); i
108  != m_queue.end (); ++i)
109  {
110  if (i->GetIpv4Header ().GetDestination () == dst)
111  {
112  return true;
113  }
114  }
115  return false;
116 }
117 
121 struct IsExpired
122 {
123  bool
130  operator() (QueueEntry const & e) const
131  {
132  return (e.GetExpireTime () < Seconds (0));
133  }
134 };
135 
136 void
138 {
139  IsExpired pred;
140  for (std::vector<QueueEntry>::iterator i = m_queue.begin (); i
141  != m_queue.end (); ++i)
142  {
143  if (pred (*i))
144  {
145  Drop (*i, "Drop outdated packet ");
146  }
147  }
148  m_queue.erase (std::remove_if (m_queue.begin (), m_queue.end (), pred),
149  m_queue.end ());
150 }
151 
152 void
153 RequestQueue::Drop (QueueEntry en, std::string reason)
154 {
155  NS_LOG_LOGIC (reason << en.GetPacket ()->GetUid () << " " << en.GetIpv4Header ().GetDestination ());
156  en.GetErrorCallback () (en.GetPacket (), en.GetIpv4Header (),
158  return;
159 }
160 
161 } // namespace aodv
162 } // namespace ns3
#define NS_LOG_FUNCTION(parameters)
If log level LOG_FUNCTION is enabled, this macro will output all input parameters separated by "...
Ipv4Header GetIpv4Header() const
Get IPv4 header.
Definition: aodv-rqueue.h:125
void Drop(QueueEntry en, std::string reason)
Notify that packet is dropped from queue by timeout.
Definition: aodv-rqueue.cc:153
uint64_t GetUid(void) const
Returns the packet's Uid.
Definition: packet.cc:367
Ipv4Address GetDestination(void) const
Definition: ipv4-header.cc:304
#define NS_LOG_COMPONENT_DEFINE(name)
Define a Log component with a specific name.
Definition: log.h:201
void SetExpireTime(Time exp)
Set expire time.
Definition: aodv-rqueue.h:141
bool Enqueue(QueueEntry &entry)
Push entry in queue, if there is no entry with the same packet and destination address in queue...
Definition: aodv-rqueue.cc:48
std::vector< QueueEntry > m_queue
The queue.
Definition: aodv-rqueue.h:228
Ptr< const Packet > GetPacket() const
Get packet from entry.
Definition: aodv-rqueue.h:109
void DropPacketWithDst(Ipv4Address dst)
Remove all packets with destination IP address dst.
Definition: aodv-rqueue.cc:72
#define NS_LOG_LOGIC(msg)
Use NS_LOG to output a message of level LOG_LOGIC.
Definition: log.h:285
IsExpired structure.
Definition: aodv-rqueue.cc:121
AODV Queue Entry.
Definition: aodv-rqueue.h:43
Every class exported by the ns3 library is enclosed in the ns3 namespace.
ErrorCallback GetErrorCallback() const
Get error callback.
Definition: aodv-rqueue.h:93
uint32_t GetSize()
Number of entries.
Definition: aodv-rqueue.cc:41
Time m_queueTimeout
The maximum period of time that a routing protocol is allowed to buffer a packet for, seconds.
Definition: aodv-rqueue.h:236
Time GetExpireTime() const
Get expire time.
Definition: aodv-rqueue.h:149
Ipv4 addresses are stored in host order in this class.
Definition: ipv4-address.h:40
void Purge()
Remove all expired entries.
Definition: aodv-rqueue.cc:137
static bool IsEqual(QueueEntry en, const Ipv4Address dst)
Determine if queue matches a destination address.
Definition: aodv-rqueue.h:243
Time Seconds(double value)
Construct a Time in the indicated unit.
Definition: nstime.h:993
uint32_t m_maxLen
The maximum number of packets that we allow a routing protocol to buffer.
Definition: aodv-rqueue.h:234
bool operator()(QueueEntry const &e) const
Check if the entry is expired.
Definition: aodv-rqueue.cc:130
bool Find(Ipv4Address dst)
Finds whether a packet with destination dst exists in the queue.
Definition: aodv-rqueue.cc:105
bool Dequeue(Ipv4Address dst, QueueEntry &entry)
Return first found (the earliest) entry for given destination.
Definition: aodv-rqueue.cc:89