/usr/include/ns3.26/ns3/lte-asn1-header.h is in libns3-dev 3.26+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 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 | /* -*- Mode: C++; c-file-style: "gnu"; indent-tabs-mode:nil; -*- */
/*
* Copyright (c) 2012 Centre Tecnologic de Telecomunicacions de Catalunya (CTTC)
*
* 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: Lluis Parcerisa <lparcerisa@cttc.cat>
*/
#ifndef ASN1_HEADER_H
#define ASN1_HEADER_H
#include "ns3/header.h"
#include <bitset>
#include <string>
namespace ns3 {
/**
* This class has the purpose to encode Information Elements according
* to ASN.1 syntax, as defined in ITU-T X-691.
* IMPORTANT: The encoding is done following the UNALIGNED variant.
*/
class Asn1Header : public Header
{
public:
Asn1Header ();
virtual ~Asn1Header ();
/**
* \brief Get the type ID.
* \return the object TypeId
*/
static TypeId GetTypeId (void);
virtual TypeId GetInstanceTypeId (void) const;
uint32_t GetSerializedSize (void) const;
void Serialize (Buffer::Iterator bIterator) const;
// Inherited from ns3::Header base class
// Pure virtual methods, to be implemented in child classes
virtual uint32_t Deserialize (Buffer::Iterator bIterator) = 0;
virtual void Print (std::ostream &os) const = 0;
/**
* This function serializes class attributes to m_serializationResult
* local Buffer. As ASN1 encoding produces a bitstream that does not have
* a fixed length, this function is needed to store the result, so
* its length can be retrieved with Header::GetSerializedSize() function.
* This method is pure virtual in this class (needs to be implemented
* in child classes) as the meaningful information elements are in
* the subclasses.
*/
virtual void PreSerialize (void) const = 0;
protected:
mutable uint8_t m_serializationPendingBits; //!< pending bits
mutable uint8_t m_numSerializationPendingBits; //!< number of pending bits
mutable bool m_isDataSerialized; //!< true if data is serialized
mutable Buffer m_serializationResult; //!< serialization result
/**
* Function to write in m_serializationResult, after resizing its size
* \param octet bits to write
*/
void WriteOctet (uint8_t octet) const;
// Serialization functions
/**
* Serialize a bool
* \param value value to serialize
*/
void SerializeBoolean (bool value) const;
/**
* Serialize an Integer
* \param n value to serialize
* \param nmin min value to serialize
* \param nmax max value to serialize
*/
void SerializeInteger (int n, int nmin, int nmax) const;
// void SerializeOctetstring (std::string s) const;
/**
* Serialize a Sequence
* \param numElems element number to serialize
* \param nMax max value to serialize
* \param nMin min value to serialize
*/
void SerializeSequenceOf (int numElems, int nMax, int nMin) const;
/**
* Serialize a Choice (set of options)
* \param numOptions number of options
* \param selectedOption selected option
* \param isExtensionMarkerPresent true if extension mark is present
*/
void SerializeChoice (int numOptions, int selectedOption,
bool isExtensionMarkerPresent) const;
/**
* Serialize an Enum
* \param numElems number of elements in the enum
* \param selectedElem selected element
*/
void SerializeEnum (int numElems, int selectedElem) const;
/**
* Serialize nothing (null op)
*/
void SerializeNull () const;
/**
* Finalizes an in progress serialization.
*/
void FinalizeSerialization () const;
/**
* Serialize a bitset
* \param data data to serialize
*/
template <int N>
void SerializeBitset (std::bitset<N> data) const;
/**
* Serialize a sequence
* \param optionalOrDefaultMask Mask to serialize
* \param isExtensionMarkerPresent true if Extension Marker is present
*/
template <int N>
void SerializeSequence (std::bitset<N> optionalOrDefaultMask,
bool isExtensionMarkerPresent) const;
/**
* Serialize a sequence
* \param optionalOrDefaultMask Mask to serialize
* \param isExtensionMarkerPresent true if Extension Marker is present
*/
void SerializeSequence (std::bitset<0> optionalOrDefaultMask,
bool isExtensionMarkerPresent) const;
/**
* Serialize a sequence
* \param optionalOrDefaultMask Mask to serialize
* \param isExtensionMarkerPresent true if Extension Marker is present
*/
void SerializeSequence (std::bitset<1> optionalOrDefaultMask,
bool isExtensionMarkerPresent) const;
/**
* Serialize a sequence
* \param optionalOrDefaultMask Mask to serialize
* \param isExtensionMarkerPresent true if Extension Marker is present
*/
void SerializeSequence (std::bitset<2> optionalOrDefaultMask,
bool isExtensionMarkerPresent) const;
/**
* Serialize a sequence
* \param optionalOrDefaultMask Mask to serialize
* \param isExtensionMarkerPresent true if Extension Marker is present
*/
void SerializeSequence (std::bitset<3> optionalOrDefaultMask,
bool isExtensionMarkerPresent) const;
/**
* Serialize a sequence
* \param optionalOrDefaultMask Mask to serialize
* \param isExtensionMarkerPresent true if Extension Marker is present
*/
void SerializeSequence (std::bitset<4> optionalOrDefaultMask,
bool isExtensionMarkerPresent) const;
/**
* Serialize a sequence
* \param optionalOrDefaultMask Mask to serialize
* \param isExtensionMarkerPresent true if Extension Marker is present
*/
void SerializeSequence (std::bitset<5> optionalOrDefaultMask,
bool isExtensionMarkerPresent) const;
/**
* Serialize a sequence
* \param optionalOrDefaultMask Mask to serialize
* \param isExtensionMarkerPresent true if Extension Marker is present
*/
void SerializeSequence (std::bitset<6> optionalOrDefaultMask,
bool isExtensionMarkerPresent) const;
/**
* Serialize a sequence
* \param optionalOrDefaultMask Mask to serialize
* \param isExtensionMarkerPresent true if Extension Marker is present
*/
void SerializeSequence (std::bitset<9> optionalOrDefaultMask,
bool isExtensionMarkerPresent) const;
/**
* Serialize a sequence
* \param optionalOrDefaultMask Mask to serialize
* \param isExtensionMarkerPresent true if Extension Marker is present
*/
void SerializeSequence (std::bitset<10> optionalOrDefaultMask,
bool isExtensionMarkerPresent) const;
/**
* Serialize a sequence
* \param optionalOrDefaultMask Mask to serialize
* \param isExtensionMarkerPresent true if Extension Marker is present
*/
void SerializeSequence (std::bitset<11> optionalOrDefaultMask,
bool isExtensionMarkerPresent) const;
/**
* Serialize a bitstring
* \param bitstring bitstring to serialize
*/
template <int N>
void SerializeBitstring (std::bitset<N> bitstring) const;
/**
* Serialize a bitstring
* \param bitstring bitstring to serialize
*/
void SerializeBitstring (std::bitset<1> bitstring) const;
/**
* Serialize a bitstring
* \param bitstring bitstring to serialize
*/
void SerializeBitstring (std::bitset<2> bitstring) const;
/**
* Serialize a bitstring
* \param bitstring bitstring to serialize
*/
void SerializeBitstring (std::bitset<8> bitstring) const;
/**
* Serialize a bitstring
* \param bitstring bitstring to serialize
*/
void SerializeBitstring (std::bitset<10> bitstring) const;
/**
* Serialize a bitstring
* \param bitstring bitstring to serialize
*/
void SerializeBitstring (std::bitset<16> bitstring) const;
/**
* Serialize a bitstring
* \param bitstring bitstring to serialize
*/
void SerializeBitstring (std::bitset<27> bitstring) const;
/**
* Serialize a bitstring
* \param bitstring bitstring to serialize
*/
void SerializeBitstring (std::bitset<28> bitstring) const;
/**
* Serialize a bitstring
* \param bitstring bitstring to serialize
*/
void SerializeBitstring (std::bitset<32> bitstring) const;
// Deserialization functions
/**
* Deserialize a bitset
* \param data buffer to store the result
* \param bIterator buffer iterator
* \returns the modified buffer iterator
*/
template <int N>
Buffer::Iterator DeserializeBitset (std::bitset<N> *data,
Buffer::Iterator bIterator);
/**
* Deserialize a bitset
* \param data buffer to store the result
* \param bIterator buffer iterator
* \returns the modified buffer iterator
*/
Buffer::Iterator DeserializeBitset (std::bitset<8> *data,
Buffer::Iterator bIterator);
/**
* Deserialize a boolean
* \param value buffer to store the result
* \param bIterator buffer iterator
* \returns the modified buffer iterator
*/
Buffer::Iterator DeserializeBoolean (bool *value,
Buffer::Iterator bIterator);
/**
* Deserialize an integer
* \param n buffer to store the result
* \param nmin min value to serialize
* \param nmax max value to serialize
* \param bIterator buffer iterator
* \returns the modified buffer iterator
*/
Buffer::Iterator DeserializeInteger (int *n, int nmin, int nmax,
Buffer::Iterator bIterator);
/**
* Deserialize a Choice (set of options)
* \param numOptions number of options
* \param isExtensionMarkerPresent true if extension mark is present
* \param selectedOption buffer to store the result
* \param bIterator buffer iterator
* \returns the modified buffer iterator
*/
Buffer::Iterator DeserializeChoice (int numOptions,
bool isExtensionMarkerPresent,
int *selectedOption,
Buffer::Iterator bIterator);
/**
* Deserialize an Enum
* \param numElems number of elements in the enum
* \param selectedElem buffer to store the result
* \param bIterator buffer iterator
* \returns the modified buffer iterator
*/
Buffer::Iterator DeserializeEnum (int numElems, int *selectedElem,
Buffer::Iterator bIterator);
/**
* Deserialize a sequence
* \param optionalOrDefaultMask buffer to store the result
* \param isExtensionMarkerPresent true if Extension Marker is present
* \param bIterator buffer iterator
* \returns the modified buffer iterator
*/
template <int N>
/**
* Deserialize a sequence
* \param optionalOrDefaultMask buffer to store the result
* \param isExtensionMarkerPresent true if Extension Marker is present
* \param bIterator buffer iterator
* \returns the modified buffer iterator
*/
Buffer::Iterator DeserializeSequence (std::bitset<N> *optionalOrDefaultMask,
bool isExtensionMarkerPresent,
Buffer::Iterator bIterator);
/**
* Deserialize a sequence
* \param optionalOrDefaultMask buffer to store the result
* \param isExtensionMarkerPresent true if Extension Marker is present
* \param bIterator buffer iterator
* \returns the modified buffer iterator
*/
Buffer::Iterator DeserializeSequence (std::bitset<0> *optionalOrDefaultMask,
bool isExtensionMarkerPresent,
Buffer::Iterator bIterator);
/**
* Deserialize a sequence
* \param optionalOrDefaultMask buffer to store the result
* \param isExtensionMarkerPresent true if Extension Marker is present
* \param bIterator buffer iterator
* \returns the modified buffer iterator
*/
Buffer::Iterator DeserializeSequence (std::bitset<1> *optionalOrDefaultMask,
bool isExtensionMarkerPresent,
Buffer::Iterator bIterator);
/**
* Deserialize a sequence
* \param optionalOrDefaultMask buffer to store the result
* \param isExtensionMarkerPresent true if Extension Marker is present
* \param bIterator buffer iterator
* \returns the modified buffer iterator
*/
Buffer::Iterator DeserializeSequence (std::bitset<2> *optionalOrDefaultMask,
bool isExtensionMarkerPresent,
Buffer::Iterator bIterator);
/**
* Deserialize a sequence
* \param optionalOrDefaultMask buffer to store the result
* \param isExtensionMarkerPresent true if Extension Marker is present
* \param bIterator buffer iterator
* \returns the modified buffer iterator
*/
Buffer::Iterator DeserializeSequence (std::bitset<3> *optionalOrDefaultMask,
bool isExtensionMarkerPresent,
Buffer::Iterator bIterator);
/**
* Deserialize a sequence
* \param optionalOrDefaultMask buffer to store the result
* \param isExtensionMarkerPresent true if Extension Marker is present
* \param bIterator buffer iterator
* \returns the modified buffer iterator
*/
Buffer::Iterator DeserializeSequence (std::bitset<4> *optionalOrDefaultMask,
bool isExtensionMarkerPresent,
Buffer::Iterator bIterator);
/**
* Deserialize a sequence
* \param optionalOrDefaultMask buffer to store the result
* \param isExtensionMarkerPresent true if Extension Marker is present
* \param bIterator buffer iterator
* \returns the modified buffer iterator
*/
Buffer::Iterator DeserializeSequence (std::bitset<5> *optionalOrDefaultMask,
bool isExtensionMarkerPresent,
Buffer::Iterator bIterator);
/**
* Deserialize a sequence
* \param optionalOrDefaultMask buffer to store the result
* \param isExtensionMarkerPresent true if Extension Marker is present
* \param bIterator buffer iterator
* \returns the modified buffer iterator
*/
Buffer::Iterator DeserializeSequence (std::bitset<6> *optionalOrDefaultMask,
bool isExtensionMarkerPresent,
Buffer::Iterator bIterator);
/**
* Deserialize a sequence
* \param optionalOrDefaultMask buffer to store the result
* \param isExtensionMarkerPresent true if Extension Marker is present
* \param bIterator buffer iterator
* \returns the modified buffer iterator
*/
Buffer::Iterator DeserializeSequence (std::bitset<9> *optionalOrDefaultMask,
bool isExtensionMarkerPresent,
Buffer::Iterator bIterator);
/**
* Deserialize a sequence
* \param optionalOrDefaultMask buffer to store the result
* \param isExtensionMarkerPresent true if Extension Marker is present
* \param bIterator buffer iterator
* \returns the modified buffer iterator
*/
Buffer::Iterator DeserializeSequence (std::bitset<10> *optionalOrDefaultMask,
bool isExtensionMarkerPresent,
Buffer::Iterator bIterator);
/**
* Deserialize a sequence
* \param optionalOrDefaultMask buffer to store the result
* \param isExtensionMarkerPresent true if Extension Marker is present
* \param bIterator buffer iterator
* \returns the modified buffer iterator
*/
Buffer::Iterator DeserializeSequence (std::bitset<11> *optionalOrDefaultMask,
bool isExtensionMarkerPresent,
Buffer::Iterator bIterator);
/**
* Deserialize a bitstring
* \param bitstring buffer to store the result
* \param bIterator buffer iterator
* \returns the modified buffer iterator
*/
template <int N>
Buffer::Iterator DeserializeBitstring (std::bitset<N> *bitstring,
Buffer::Iterator bIterator);
/**
* Deserialize a bitstring
* \param bitstring buffer to store the result
* \param bIterator buffer iterator
* \returns the modified buffer iterator
*/
Buffer::Iterator DeserializeBitstring (std::bitset<1> *bitstring,
Buffer::Iterator bIterator);
/**
* Deserialize a bitstring
* \param bitstring buffer to store the result
* \param bIterator buffer iterator
* \returns the modified buffer iterator
*/
Buffer::Iterator DeserializeBitstring (std::bitset<2> *bitstring,
Buffer::Iterator bIterator);
/**
* Deserialize a bitstring
* \param bitstring buffer to store the result
* \param bIterator buffer iterator
* \returns the modified buffer iterator
*/
Buffer::Iterator DeserializeBitstring (std::bitset<8> *bitstring,
Buffer::Iterator bIterator);
/**
* Deserialize a bitstring
* \param bitstring buffer to store the result
* \param bIterator buffer iterator
* \returns the modified buffer iterator
*/
Buffer::Iterator DeserializeBitstring (std::bitset<10> *bitstring,
Buffer::Iterator bIterator);
/**
* Deserialize a bitstring
* \param bitstring buffer to store the result
* \param bIterator buffer iterator
* \returns the modified buffer iterator
*/
Buffer::Iterator DeserializeBitstring (std::bitset<16> *bitstring,
Buffer::Iterator bIterator);
/**
* Deserialize a bitstring
* \param bitstring buffer to store the result
* \param bIterator buffer iterator
* \returns the modified buffer iterator
*/
Buffer::Iterator DeserializeBitstring (std::bitset<27> *bitstring,
Buffer::Iterator bIterator);
/**
* Deserialize a bitstring
* \param bitstring buffer to store the result
* \param bIterator buffer iterator
* \returns the modified buffer iterator
*/
Buffer::Iterator DeserializeBitstring (std::bitset<28> *bitstring,
Buffer::Iterator bIterator);
/**
* Deserialize a bitstring
* \param bitstring buffer to store the result
* \param bIterator buffer iterator
* \returns the modified buffer iterator
*/
Buffer::Iterator DeserializeBitstring (std::bitset<32> *bitstring,
Buffer::Iterator bIterator);
/**
* Deserialize nothing (null op)
* \param bIterator buffer iterator
* \returns the modified buffer iterator
*/
Buffer::Iterator DeserializeNull (Buffer::Iterator bIterator);
/**
* Deserialize a Sequence
* \param numElems buffer to store the result
* \param nMax max value to serialize
* \param nMin min value to serialize
* \param bIterator buffer iterator
* \returns the modified buffer iterator
*/
Buffer::Iterator DeserializeSequenceOf (int *numElems, int nMax, int nMin,
Buffer::Iterator bIterator);
};
} // namespace ns3
#endif // ASN1_HEADER_H
|