/usr/include/ns3.17/ns3/olsr-header.h is in libns3-dev 3.17+dfsg-1build1.
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 | /* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
/*
* Copyright (c) 2007 INESC Porto
*
* 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: Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
*/
#ifndef OLSR_HEADER_H
#define OLSR_HEADER_H
#include <stdint.h>
#include <vector>
#include "ns3/header.h"
#include "ns3/ipv4-address.h"
#include "ns3/nstime.h"
namespace ns3 {
namespace olsr {
double EmfToSeconds (uint8_t emf);
uint8_t SecondsToEmf (double seconds);
// 3.3. Packet Format
//
// The basic layout of any packet in OLSR is as follows (omitting IP and
// UDP headers):
//
// 0 1 2 3
// 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
// +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
// | Packet Length | Packet Sequence Number |
// +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
// | Message Type | Vtime | Message Size |
// +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
// | Originator Address |
// +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
// | Time To Live | Hop Count | Message Sequence Number |
// +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
// | |
// : MESSAGE :
// | |
// +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
// | Message Type | Vtime | Message Size |
// +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
// | Originator Address |
// +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
// | Time To Live | Hop Count | Message Sequence Number |
// +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
// | |
// : MESSAGE :
// | |
// +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
// : :
// (etc.)
class PacketHeader : public Header
{
public:
PacketHeader ();
virtual ~PacketHeader ();
void SetPacketLength (uint16_t length)
{
m_packetLength = length;
}
uint16_t GetPacketLength () const
{
return m_packetLength;
}
void SetPacketSequenceNumber (uint16_t seqnum)
{
m_packetSequenceNumber = seqnum;
}
uint16_t GetPacketSequenceNumber () const
{
return m_packetSequenceNumber;
}
private:
uint16_t m_packetLength;
uint16_t m_packetSequenceNumber;
public:
static TypeId GetTypeId (void);
virtual TypeId GetInstanceTypeId (void) const;
virtual void Print (std::ostream &os) const;
virtual uint32_t GetSerializedSize (void) const;
virtual void Serialize (Buffer::Iterator start) const;
virtual uint32_t Deserialize (Buffer::Iterator start);
};
// 0 1 2 3
// 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
// +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
// | Message Type | Vtime | Message Size |
// +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
// | Originator Address |
// +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
// | Time To Live | Hop Count | Message Sequence Number |
// +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
class MessageHeader : public Header
{
public:
enum MessageType {
HELLO_MESSAGE = 1,
TC_MESSAGE = 2,
MID_MESSAGE = 3,
HNA_MESSAGE = 4,
};
MessageHeader ();
virtual ~MessageHeader ();
void SetMessageType (MessageType messageType)
{
m_messageType = messageType;
}
MessageType GetMessageType () const
{
return m_messageType;
}
void SetVTime (Time time)
{
m_vTime = SecondsToEmf (time.GetSeconds ());
}
Time GetVTime () const
{
return Seconds (EmfToSeconds (m_vTime));
}
void SetOriginatorAddress (Ipv4Address originatorAddress)
{
m_originatorAddress = originatorAddress;
}
Ipv4Address GetOriginatorAddress () const
{
return m_originatorAddress;
}
void SetTimeToLive (uint8_t timeToLive)
{
m_timeToLive = timeToLive;
}
uint8_t GetTimeToLive () const
{
return m_timeToLive;
}
void SetHopCount (uint8_t hopCount)
{
m_hopCount = hopCount;
}
uint8_t GetHopCount () const
{
return m_hopCount;
}
void SetMessageSequenceNumber (uint16_t messageSequenceNumber)
{
m_messageSequenceNumber = messageSequenceNumber;
}
uint16_t GetMessageSequenceNumber () const
{
return m_messageSequenceNumber;
}
// void SetMessageSize (uint16_t messageSize)
// {
// m_messageSize = messageSize;
// }
// uint16_t GetMessageSize () const
// {
// return m_messageSize;
// }
private:
MessageType m_messageType;
uint8_t m_vTime;
Ipv4Address m_originatorAddress;
uint8_t m_timeToLive;
uint8_t m_hopCount;
uint16_t m_messageSequenceNumber;
uint16_t m_messageSize;
public:
static TypeId GetTypeId (void);
virtual TypeId GetInstanceTypeId (void) const;
virtual void Print (std::ostream &os) const;
virtual uint32_t GetSerializedSize (void) const;
virtual void Serialize (Buffer::Iterator start) const;
virtual uint32_t Deserialize (Buffer::Iterator start);
// 5.1. MID Message Format
//
// The proposed format of a MID message is as follows:
//
// 0 1 2 3
// 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
// +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
// | OLSR Interface Address |
// +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
// | OLSR Interface Address |
// +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
// | ... |
// +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
struct Mid
{
std::vector<Ipv4Address> interfaceAddresses;
void Print (std::ostream &os) const;
uint32_t GetSerializedSize (void) const;
void Serialize (Buffer::Iterator start) const;
uint32_t Deserialize (Buffer::Iterator start, uint32_t messageSize);
};
// 6.1. HELLO Message Format
//
// 0 1 2 3
// 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
//
// +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
// | Reserved | Htime | Willingness |
// +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
// | Link Code | Reserved | Link Message Size |
// +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
// | Neighbor Interface Address |
// +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
// | Neighbor Interface Address |
// +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
// : . . . :
// : :
// +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
// | Link Code | Reserved | Link Message Size |
// +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
// | Neighbor Interface Address |
// +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
// | Neighbor Interface Address |
// +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
// : :
// : :
// (etc.)
struct Hello
{
struct LinkMessage {
uint8_t linkCode;
std::vector<Ipv4Address> neighborInterfaceAddresses;
};
uint8_t hTime;
void SetHTime (Time time)
{
this->hTime = SecondsToEmf (time.GetSeconds ());
}
Time GetHTime () const
{
return Seconds (EmfToSeconds (this->hTime));
}
uint8_t willingness;
std::vector<LinkMessage> linkMessages;
void Print (std::ostream &os) const;
uint32_t GetSerializedSize (void) const;
void Serialize (Buffer::Iterator start) const;
uint32_t Deserialize (Buffer::Iterator start, uint32_t messageSize);
};
// 9.1. TC Message Format
//
// The proposed format of a TC message is as follows:
//
// 0 1 2 3
// 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
// +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
// | ANSN | Reserved |
// +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
// | Advertised Neighbor Main Address |
// +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
// | Advertised Neighbor Main Address |
// +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
// | ... |
// +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
struct Tc
{
std::vector<Ipv4Address> neighborAddresses;
uint16_t ansn;
void Print (std::ostream &os) const;
uint32_t GetSerializedSize (void) const;
void Serialize (Buffer::Iterator start) const;
uint32_t Deserialize (Buffer::Iterator start, uint32_t messageSize);
};
// 12.1. HNA Message Format
//
// The proposed format of an HNA-message is:
//
// 0 1 2 3
// 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
// +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
// | Network Address |
// +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
// | Netmask |
// +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
// | Network Address |
// +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
// | Netmask |
// +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
// | ... |
// +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
// Note: HNA stands for Host Network Association
struct Hna
{
struct Association
{
Ipv4Address address;
Ipv4Mask mask;
};
std::vector<Association> associations;
void Print (std::ostream &os) const;
uint32_t GetSerializedSize (void) const;
void Serialize (Buffer::Iterator start) const;
uint32_t Deserialize (Buffer::Iterator start, uint32_t messageSize);
};
private:
struct
{
Mid mid;
Hello hello;
Tc tc;
Hna hna;
} m_message; // union not allowed
public:
Mid& GetMid ()
{
if (m_messageType == 0)
{
m_messageType = MID_MESSAGE;
}
else
{
NS_ASSERT (m_messageType == MID_MESSAGE);
}
return m_message.mid;
}
Hello& GetHello ()
{
if (m_messageType == 0)
{
m_messageType = HELLO_MESSAGE;
}
else
{
NS_ASSERT (m_messageType == HELLO_MESSAGE);
}
return m_message.hello;
}
Tc& GetTc ()
{
if (m_messageType == 0)
{
m_messageType = TC_MESSAGE;
}
else
{
NS_ASSERT (m_messageType == TC_MESSAGE);
}
return m_message.tc;
}
Hna& GetHna ()
{
if (m_messageType == 0)
{
m_messageType = HNA_MESSAGE;
}
else
{
NS_ASSERT (m_messageType == HNA_MESSAGE);
}
return m_message.hna;
}
const Mid& GetMid () const
{
NS_ASSERT (m_messageType == MID_MESSAGE);
return m_message.mid;
}
const Hello& GetHello () const
{
NS_ASSERT (m_messageType == HELLO_MESSAGE);
return m_message.hello;
}
const Tc& GetTc () const
{
NS_ASSERT (m_messageType == TC_MESSAGE);
return m_message.tc;
}
const Hna& GetHna () const
{
NS_ASSERT (m_messageType == HNA_MESSAGE);
return m_message.hna;
}
};
static inline std::ostream& operator<< (std::ostream& os, const PacketHeader & packet)
{
packet.Print (os);
return os;
}
static inline std::ostream& operator<< (std::ostream& os, const MessageHeader & message)
{
message.Print (os);
return os;
}
typedef std::vector<MessageHeader> MessageList;
static inline std::ostream& operator<< (std::ostream& os, const MessageList & messages)
{
os << "[";
for (std::vector<MessageHeader>::const_iterator messageIter = messages.begin ();
messageIter != messages.end (); messageIter++)
{
messageIter->Print (os);
if (messageIter+1 != messages.end ())
os << ", ";
}
os << "]";
return os;
}
}
} // namespace olsr, ns3
#endif /* OLSR_HEADER_H */
|