/usr/include/ns3.27/ns3/dsr-maintain-buff.h is in libns3-dev 3.27+dfsg-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 | /* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
/*
* Copyright (c) 2011 Yufei Cheng
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License version 2 as
* published by the Free Software Foundation;
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*
* Author: Yufei Cheng <yfcheng@ittc.ku.edu>
*
* James P.G. Sterbenz <jpgs@ittc.ku.edu>, director
* ResiliNets Research Group http://wiki.ittc.ku.edu/resilinets
* Information and Telecommunication Technology Center (ITTC)
* and Department of Electrical Engineering and Computer Science
* The University of Kansas Lawrence, KS USA.
*
* Work supported in part by NSF FIND (Future Internet Design) Program
* under grant CNS-0626918 (Postmodern Internet Architecture),
* NSF grant CNS-1050226 (Multilayer Network Resilience Analysis and Experimentation on GENI),
* US Department of Defense (DoD), and ITTC at The University of Kansas.
*/
#ifndef DSR_MAINTAIN_BUFF_H
#define DSR_MAINTAIN_BUFF_H
#include <vector>
#include "ns3/ipv4-routing-protocol.h"
#include "ns3/simulator.h"
#include "ns3/ipv4-header.h"
#include "dsr-option-header.h"
namespace ns3 {
namespace dsr {
/**
* The maintenance buffer is responsible for maintaining packet next hop delivery
* The data packet is saved in maintenance buffer whenever the data packet is sent out of send buffer
*/
struct LinkKey
{
Ipv4Address m_source; ///< source address
Ipv4Address m_destination; ///< destination address
Ipv4Address m_ourAdd; ///< local address
Ipv4Address m_nextHop; ///< next hop address
/**
* Compare maintain Buffer entries
* \param o object to compare
* \return true if equal
*/
bool operator < (const LinkKey & o) const
{
if (m_source < o.m_source)
{
return true;
}
if (o.m_source < m_source)
{
return false;
}
if (m_destination < o.m_destination)
{
return true;
}
if (o.m_destination < m_destination)
{
return false;
}
if (m_ourAdd < o.m_ourAdd)
{
return true;
}
if (o.m_ourAdd < m_ourAdd)
{
return false;
}
if (m_nextHop < o.m_nextHop)
{
return true;
}
if (o.m_nextHop < m_nextHop)
{
return false;
}
return false;
}
};
/// NetworkKey structure
struct NetworkKey
{
uint16_t m_ackId; ///< acknowledge ID
Ipv4Address m_ourAdd; ///< local address
Ipv4Address m_nextHop; ///< next hop
Ipv4Address m_source; ///< source address
Ipv4Address m_destination; ///< destination address
/**
* Compare maintain Buffer entries
* \param o object to compare
* \return true if equal
*/
bool operator < (const NetworkKey & o) const
{
if (m_ackId < o.m_ackId)
{
return true;
}
if (o.m_ackId < m_ackId)
{
return false;
}
if (m_source < o.m_source)
{
return true;
}
if (o.m_source < m_source)
{
return false;
}
if (m_destination < o.m_destination)
{
return true;
}
if (o.m_destination < m_destination)
{
return false;
}
if (m_ourAdd < o.m_ourAdd)
{
return true;
}
if (o.m_ourAdd < m_ourAdd)
{
return false;
}
if (m_nextHop < o.m_nextHop)
{
return true;
}
if (o.m_nextHop < m_nextHop)
{
return false;
}
return false;
}
};
/// PassiveKey structure
struct PassiveKey
{
uint16_t m_ackId; ///< acknowledge ID
Ipv4Address m_source; ///< source address
Ipv4Address m_destination; ///< destination address
uint8_t m_segsLeft; ///< segments left
/**
* Compare maintain Buffer entries
* \param o is the object to compare
* \return true if equal
*/
bool operator < (const PassiveKey & o) const
{
if (m_ackId < o.m_ackId)
{
return true;
}
if (o.m_ackId < m_ackId)
{
return false;
}
if (m_source < o.m_source)
{
return true;
}
if (o.m_source < m_source)
{
return false;
}
if (m_destination < o.m_destination)
{
return true;
}
if (o.m_destination < m_destination)
{
return false;
}
if (m_segsLeft < o.m_segsLeft)
{
return true;
}
if (o.m_segsLeft < m_segsLeft)
{
return false;
}
return false;
}
};
/**
* \ingroup dsr
* \brief DSR Maintain Buffer Entry
*/
class DsrMaintainBuffEntry
{
public:
/**
* Construct a DsrMaintainBuffEntry with the given parameters
*
* \param pa packet
* \param us our IPv4 address
* \param n next hop IPv4 address
* \param s IPv4 address of the source
* \param dst IPv4 address of the destination
* \param ackId ACK ID
* \param segs number of segments left
* \param exp expiration time
*/
DsrMaintainBuffEntry (Ptr<const Packet> pa = 0, Ipv4Address us = Ipv4Address (),
Ipv4Address n = Ipv4Address (), Ipv4Address s = Ipv4Address (), Ipv4Address dst = Ipv4Address (),
uint16_t ackId = 0, uint8_t segs = 0, Time exp = Simulator::Now ())
: m_packet (pa),
m_ourAdd (us),
m_nextHop (n),
m_src (s),
m_dst (dst),
m_ackId (ackId),
m_segsLeft (segs),
m_expire (exp + Simulator::Now ())
{
}
// Fields
/**
* Get packet
* \returns the current packet
*/
Ptr<const Packet> GetPacket () const
{
return m_packet;
}
/**
* Set packet
* \param p the current packet
*/
void SetPacket (Ptr<const Packet> p)
{
m_packet = p;
}
/**
* Get local address of entry
* \returns the local IP address
*/
Ipv4Address GetOurAdd () const
{
return m_ourAdd;
}
/**
* Set local address of entry
* \param us the local IP address
*/
void SetOurAdd (Ipv4Address us)
{
m_ourAdd = us;
}
/**
* Get next hop of entry
* \returns the IP address for the next hop
*/
Ipv4Address GetNextHop () const
{
return m_nextHop;
}
/**
* Set next hop of entry
* \param n the next hop IP address
*/
void SetNextHop (Ipv4Address n)
{
m_nextHop = n;
}
/**
* Get destination address
* \returns the destination IP address
*/
Ipv4Address GetDst () const
{
return m_dst;
}
/**
* Set destination address
* \param n the destination IP address
*/
void SetDst (Ipv4Address n)
{
m_dst = n;
}
/**
* Get source address
* \returns the source IP address
*/
Ipv4Address GetSrc () const
{
return m_src;
}
/**
* Set source address
* \param s the source IP address
*/
void SetSrc (Ipv4Address s)
{
m_src = s;
}
/**
* Get acknowledge ID
* \returns the acknowledge ID
*/
uint16_t GetAckId () const
{
return m_ackId;
}
/**
* Set acknowledge ID
* \param ackId the acknowledge ID
*/
void SetAckId (uint16_t ackId)
{
m_ackId = ackId;
}
/**
* Get segments left
* \returns the number of segments left
*/
uint8_t GetSegsLeft () const
{
return m_segsLeft;
}
/**
* Set segments left
* \param segs the number of segments left
*/
void SetSegsLeft (uint8_t segs)
{
m_segsLeft = segs;
}
/**
* Set expiration time
* \param exp the expire time
*/
void SetExpireTime (Time exp)
{
m_expire = exp + Simulator::Now ();
}
/**
* Get expiration time
* \returns the expiration time
*/
Time GetExpireTime () const
{
return m_expire - Simulator::Now ();
}
private:
/// Data packet
Ptr<const Packet> m_packet;
/// Our own ip address
Ipv4Address m_ourAdd;
/// Next hop Ip address
Ipv4Address m_nextHop;
/// The source address
Ipv4Address m_src;
/// The destination address
Ipv4Address m_dst;
/// The data ack id
uint16_t m_ackId;
/// The segments left field
uint8_t m_segsLeft;
/// Expire time for queue entry
Time m_expire;
};
/**
* \ingroup dsr
* \brief DSR maintain buffer
*/
/************************************************************************************************************************/
class DsrMaintainBuffer
{
public:
/**
* Default constructor
*/
DsrMaintainBuffer ()
{
}
/// Push entry in queue, if there is no entry with the same packet and destination address in queue.
/// \param entry Maintain Buffer Entry
/// \return true on success adding the Entry.
bool Enqueue (DsrMaintainBuffEntry & entry);
/// Return first found (the earliest) entry for given destination
/// \param [in] dst Entry destination
/// \param [out] entry The Entry found (if any).
/// \return true on success
bool Dequeue (Ipv4Address dst, DsrMaintainBuffEntry & entry);
/// Remove all packets with next hop IP address dst
/// \param nextHop Next hop in the route.
void DropPacketWithNextHop (Ipv4Address nextHop);
/// Finds whether a packet with next hop dst exists in the queue
/// \param nextHop Next hop in the route.
/// \return true if there is a packet directed to the next hop.
bool Find (Ipv4Address nextHop);
/// Number of entries
/// \return The number of entries.
uint32_t GetSize ();
// Fields
/**
* Get maximum queue length
* \returns the maximum queue length
*/
uint32_t GetMaxQueueLen () const
{
return m_maxLen;
}
/**
* Set maximum queue length
* \param len the maximum queue length
*/
void SetMaxQueueLen (uint32_t len)
{
m_maxLen = len;
}
/**
* Get maintain buffer timeout
* \returns the maintain buffer timeout
*/
Time GetMaintainBufferTimeout () const
{
return m_maintainBufferTimeout;
}
/**
* Set maintain buffer timeout
* \param t the maintain buffer timeoout
*/
void SetMaintainBufferTimeout (Time t)
{
m_maintainBufferTimeout = t;
}
/// Verify if all the elements in the maintenance buffer entry is the same
/// \note For real this function checks if at most one entry is equal. If it is,
/// that entry is removed. Further entries are NOT checked. This could be a bug.
/// \param entry The Entry to check
/// \return true if an Entry was found and removed.
bool AllEqual (DsrMaintainBuffEntry & entry);
/// Verify if the maintain buffer entry is the same in every field for link ack
/// \param entry The Entry to check
/// \return true if an Entry was found and removed.
bool LinkEqual (DsrMaintainBuffEntry & entry);
/// Verify if the maintain buffer entry is the same in every field for network ack
/// \param entry The Entry to check
/// \return true if an Entry was found and removed.
bool NetworkEqual (DsrMaintainBuffEntry & entry);
/// Verify if the maintain buffer entry is the same in every field for promiscuous ack
/// \param entry The Entry to check
/// \return true if an Entry was found and removed.
bool PromiscEqual (DsrMaintainBuffEntry & entry);
private:
/// The vector of maintain buffer entries
std::vector<DsrMaintainBuffEntry> m_maintainBuffer;
/// The vector of network keys
std::vector<NetworkKey> m_allNetworkKey;
/// Remove all expired entries
void Purge ();
/// The maximum number of packets that we allow a routing protocol to buffer.
uint32_t m_maxLen;
/// The maximum period of time that a routing protocol is allowed to buffer a packet for, seconds.
Time m_maintainBufferTimeout;
/// Verify if the maintain buffer is equal or not
/// \param en The Entry to check
/// \param nextHop The next hop to check
/// \return true if an Entry next hop is equal to the function second parameter
static bool IsEqual (DsrMaintainBuffEntry en, const Ipv4Address nextHop)
{
return (en.GetNextHop () == nextHop);
}
};
/*******************************************************************************************************************************/
} // namespace dsr
} // namespace ns3
#endif /* DSR_MAINTAIN_BUFF_H */
|