This file is indexed.

/usr/include/ns3.27/ns3/dsr-gratuitous-reply-table.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
/* -*- 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_GRATUITOUS_REPLY_TABLE_H
#define DSR_GRATUITOUS_REPLY_TABLE_H

#include "ns3/simulator.h"
#include "ns3/timer.h"
#include "ns3/ipv4-address.h"
#include "ns3/callback.h"
#include <vector>

namespace ns3 {
namespace dsr {
/**
 * The gratuitous table entries, it maintains the already sent gratuitous route reply entries.
 * When the node "promiscuously" received a packet destined for other nodes, and inferred a shorter
 * route for the data packet, it will construct a route reply and send back to the source
 */
struct GraReplyEntry
{
  Ipv4Address m_replyTo; ///< reply to address
  Ipv4Address m_hearFrom; ///< heard from address
  Time m_gratReplyHoldoff; ///< gratuitous reply holdoff time

  /**
   * Constructor
   *
   * \param t IPv4 address to reply to
   * \param f IPv4 address to hear from
   * \param h gratuitous hold off time
   */
  GraReplyEntry (Ipv4Address t, Ipv4Address f, Time h)
    : m_replyTo (t),
      m_hearFrom (f),
      m_gratReplyHoldoff (h)
  {
  }
};
/**
 * \ingroup dsr
 * \brief maintain the gratuitous reply
 */
class DsrGraReply  : public Object
{
public:
  /**
   * \brief Get the type ID.
   * \return the object TypeId
   */
  static TypeId GetTypeId ();

  DsrGraReply ();
  virtual ~DsrGraReply ();

  /// Set the gratuitous reply table size
  /// \param g The gratuitous reply table size
  void SetGraTableSize (uint32_t g)
  {
    GraReplyTableSize = g;
  }
  /// Get the gratuitous reply table size
  /// \returns The gratuitous reply table size
  uint32_t GetGraTableSize () const
  {
    return GraReplyTableSize;
  }
  /// Add a new gratuitous reply entry
  /// \param graTableEntry The gratuitous reply entry
  /// \return true on success
  bool AddEntry (GraReplyEntry & graTableEntry);
  /// Update the route entry if found
  /// \param replyTo Entry directed to
  /// \param replyFrom Entry heard from
  /// \param gratReplyHoldoff New gratuitous reply holdoff time
  /// \return true on success
  bool FindAndUpdate (Ipv4Address replyTo, Ipv4Address replyFrom, Time gratReplyHoldoff);
  /// Remove all expired entries
  void Purge ();
  /// Remove all entries
  void Clear ()
  {
    m_graReply.clear ();
  }

private:
  /// Vector of entries
  std::vector<GraReplyEntry> m_graReply;
  /// The max # of gratuitous reply entries to hold
  uint32_t GraReplyTableSize;

  /// Check if the entry is expired or not
  struct IsExpired
  {
    /**
     * Check if the entry is expired
     *
     * \param b GraReplyEntry entry
     * \return true if expired, false otherwise
     */
    bool operator() (const struct GraReplyEntry & b) const
    {
      return (b.m_gratReplyHoldoff < Simulator::Now ());
    }
  };
};
}  // namespace dsr
}  // namespace ns3

#endif /* DSR_GRATUITOUS_REPLY_TABLE_H */