packet.h
上传用户:sdhqmy
上传日期:2015-12-07
资源大小:63k
文件大小:16k
源码类别:

3G开发

开发平台:

C/C++

  1. /* -*- Mode:C++; c-basic-offset:8; tab-width:8; indent-tabs-mode:t -*- */
  2. /*
  3.  * Copyright (c) 1997 Regents of the University of California.
  4.  * All rights reserved.
  5.  *
  6.  * Redistribution and use in source and binary forms, with or without
  7.  * modification, are permitted provided that the following conditions
  8.  * are met:
  9.  * 1. Redistributions of source code must retain the above copyright
  10.  *    notice, this list of conditions and the following disclaimer.
  11.  * 2. Redistributions in binary form must reproduce the above copyright
  12.  *    notice, this list of conditions and the following disclaimer in the
  13.  *    documentation and/or other materials provided with the distribution.
  14.  * 3. All advertising materials mentioning features or use of this software
  15.  *    must display the following acknowledgement:
  16.  * This product includes software developed by the Computer Systems
  17.  * Engineering Group at Lawrence Berkeley Laboratory.
  18.  * 4. Neither the name of the University nor of the Laboratory may be used
  19.  *    to endorse or promote products derived from this software without
  20.  *    specific prior written permission.
  21.  *
  22.  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  23.  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  24.  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  25.  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  26.  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  27.  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  28.  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  29.  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  30.  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  31.  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  32.  * SUCH DAMAGE.
  33.  *
  34.  * @(#) $Header: /nfs/jade/vint/CVSROOT/ns-2/common/packet.h,v 1.89 2002/05/30 17:44:03 haldar Exp $ (LBL)
  35.  */
  36. #ifndef ns_packet_h
  37. #define ns_packet_h
  38. #include <string.h>
  39. #include <assert.h>
  40. #include "config.h"
  41. #include "scheduler.h"
  42. #include "object.h"
  43. #include "lib/bsd-list.h"
  44. #include "packet-stamp.h"
  45. #include "ns-process.h"
  46. // Used by wireless routing code to attach routing agent
  47. #define RT_PORT 255 /* port that all route msgs are sent to */
  48. #define HDR_CMN(p)      (hdr_cmn::access(p))
  49. #define HDR_ARP(p)      (hdr_arp::access(p))
  50. #define HDR_MAC(p)      (hdr_mac::access(p))
  51. #define HDR_MAC802_11(p) ((hdr_mac802_11 *)hdr_mac::access(p))
  52. #define HDR_MAC_TDMA(p) ((hdr_mac_tdma *)hdr_mac::access(p))
  53. #define HDR_LL(p)       (hdr_ll::access(p))
  54. #define HDR_IP(p)       (hdr_ip::access(p))
  55. #define HDR_RTP(p)      (hdr_rtp::access(p))
  56. #define HDR_TCP(p)      (hdr_tcp::access(p))
  57. #define HDR_SR(p)       (hdr_sr::access(p))
  58. #define HDR_TFRC(p)     (hdr_tfrc::access(p))
  59. #define HDR_TORA(p)     (hdr_tora::access(p))
  60. #define HDR_IMEP(p)     (hdr_imep::access(p))
  61. #define HDR_CDIFF(p)    (hdr_cdiff::access(p))  /* chalermak's diffusion*/
  62. //#define HDR_DIFF(p)     (hdr_diff::access(p))  /* SCADD's diffusion ported into ns */
  63. /* --------------------------------------------------------------------*/
  64. enum packet_t {
  65. PT_TCP,
  66. PT_UDP,
  67. PT_CBR,
  68. PT_AUDIO,
  69. PT_VIDEO,
  70. PT_ACK,
  71. PT_START,
  72. PT_STOP,
  73. PT_PRUNE,
  74. PT_GRAFT,
  75. PT_GRAFTACK,
  76. PT_JOIN,
  77. PT_ASSERT,
  78. PT_MESSAGE,
  79. PT_RTCP,
  80. PT_RTP,
  81. PT_RTPROTO_DV,
  82. PT_CtrMcast_Encap,
  83. PT_CtrMcast_Decap,
  84. PT_SRM,
  85. /* simple signalling messages */
  86. PT_REQUEST,
  87. PT_ACCEPT,
  88. PT_CONFIRM,
  89. PT_TEARDOWN,
  90. PT_LIVE, // packet from live network
  91. PT_REJECT,
  92. PT_TELNET, // not needed: telnet use TCP
  93. PT_FTP,
  94. PT_PARETO,
  95. PT_EXP,
  96. PT_INVAL,
  97. PT_HTTP,
  98. /* new encapsulator */
  99. PT_ENCAPSULATED,
  100. PT_MFTP,
  101. /* CMU/Monarch's extnsions */
  102. PT_ARP,
  103. PT_MAC,
  104. PT_TORA,
  105. PT_DSR,
  106. PT_AODV,
  107. PT_IMEP,
  108. // RAP packets
  109. PT_RAP_DATA,
  110. PT_RAP_ACK,
  111. PT_TFRC,
  112. PT_TFRC_ACK,
  113. PT_PING,
  114. // Diffusion packets - Chalermek
  115. PT_DIFF,
  116. // LinkState routing update packets
  117. PT_RTPROTO_LS,
  118. // MPLS LDP header
  119. PT_LDP,
  120. // GAF packet
  121.         PT_GAF,  
  122. // ReadAudio traffic
  123. PT_REALAUDIO,
  124. // Pushback Messages
  125. PT_PUSHBACK,
  126. #ifdef HAVE_STL
  127. // Pragmatic General Multicast
  128. PT_PGM,
  129. #endif //STL
  130. // insert new packet types here
  131. PT_NTYPE // This MUST be the LAST one
  132. };
  133. class p_info {
  134. public:
  135. p_info() {
  136. name_[PT_TCP]= "tcp";
  137. name_[PT_UDP]= "udp";
  138. name_[PT_CBR]= "cbr";
  139. name_[PT_AUDIO]= "audio";
  140. name_[PT_VIDEO]= "video";
  141. name_[PT_ACK]= "ack";
  142. name_[PT_START]= "start";
  143. name_[PT_STOP]= "stop";
  144. name_[PT_PRUNE]= "prune";
  145. name_[PT_GRAFT]= "graft";
  146. name_[PT_GRAFTACK]= "graftAck";
  147. name_[PT_JOIN]= "join";
  148. name_[PT_ASSERT]= "assert";
  149. name_[PT_MESSAGE]= "message";
  150. name_[PT_RTCP]= "rtcp";
  151. name_[PT_RTP]= "rtp";
  152. name_[PT_RTPROTO_DV]= "rtProtoDV";
  153. name_[PT_CtrMcast_Encap]= "CtrMcast_Encap";
  154. name_[PT_CtrMcast_Decap]= "CtrMcast_Decap";
  155. name_[PT_SRM]= "SRM";
  156. name_[PT_REQUEST]= "sa_req";
  157. name_[PT_ACCEPT]= "sa_accept";
  158. name_[PT_CONFIRM]= "sa_conf";
  159. name_[PT_TEARDOWN]= "sa_teardown";
  160. name_[PT_LIVE]= "live"; 
  161. name_[PT_REJECT]= "sa_reject";
  162. name_[PT_TELNET]= "telnet";
  163. name_[PT_FTP]= "ftp";
  164. name_[PT_PARETO]= "pareto";
  165. name_[PT_EXP]= "exp";
  166. name_[PT_INVAL]= "httpInval";
  167. name_[PT_HTTP]= "http";
  168. name_[PT_ENCAPSULATED]= "encap";
  169. name_[PT_MFTP]= "mftp";
  170. name_[PT_ARP]= "ARP";
  171. name_[PT_MAC]= "MAC";
  172. name_[PT_TORA]= "TORA";
  173. name_[PT_DSR]= "DSR";
  174. name_[PT_AODV]= "AODV";
  175. name_[PT_IMEP]= "IMEP";
  176. name_[PT_RAP_DATA] = "rap_data";
  177. name_[PT_RAP_ACK] = "rap_ack";
  178.   name_[PT_TFRC]= "tcpFriend";
  179. name_[PT_TFRC_ACK]= "tcpFriendCtl";
  180. name_[PT_PING]="ping";
  181.   /* For diffusion : Chalermek */
  182.   name_[PT_DIFF] = "diffusion";
  183. // Link state routing updates
  184. name_[PT_RTPROTO_LS] = "rtProtoLS";
  185. // MPLS LDP packets
  186. name_[PT_LDP] = "LDP";
  187. // for GAF
  188.                 name_[PT_GAF] = "gaf";      
  189. // RealAudio packets
  190. name_[PT_REALAUDIO] = "ra";
  191. //pushback 
  192. name_[PT_PUSHBACK] = "pushback";
  193. #ifdef PGM
  194. // for PGM
  195. name_[PT_PGM] = "PGM";
  196. #endif
  197. name_[PT_NTYPE]= "undefined";
  198. }
  199. const char* name(packet_t p) const { 
  200. if ( p <= PT_NTYPE ) return name_[p];
  201. return 0;
  202. }
  203. static bool data_packet(packet_t type) {
  204. return ( (type) == PT_TCP || 
  205.  (type) == PT_TELNET || 
  206.  (type) == PT_CBR || 
  207.  (type) == PT_AUDIO || 
  208.  (type) == PT_VIDEO || 
  209.  (type) == PT_ACK 
  210.  );
  211. }
  212. private:
  213. static char* name_[PT_NTYPE+1];
  214. };
  215. extern p_info packet_info; /* map PT_* to string name */
  216. //extern char* p_info::name_[];
  217. #define DATA_PACKET(type) ( (type) == PT_TCP || 
  218.                             (type) == PT_TELNET || 
  219.                             (type) == PT_CBR || 
  220.                             (type) == PT_AUDIO || 
  221.                             (type) == PT_VIDEO || 
  222.                             (type) == PT_ACK 
  223.                             )
  224. #define OFFSET(type, field) ((int) &((type *)0)->field)
  225. class PacketData : public AppData {
  226. public:
  227. PacketData(int sz) : AppData(PACKET_DATA) {
  228. datalen_ = sz;
  229. if (datalen_ > 0)
  230. data_ = new unsigned char[datalen_];
  231. else
  232. data_ = NULL;
  233. }
  234. PacketData(PacketData& d) : AppData(d) {
  235. datalen_ = d.datalen_;
  236. if (datalen_ > 0) {
  237. data_ = new unsigned char[datalen_];
  238. memcpy(data_, d.data_, datalen_);
  239. } else
  240. data_ = NULL;
  241. }
  242. virtual ~PacketData() { 
  243. if (data_ != NULL) 
  244. delete []data_; 
  245. }
  246. unsigned char* data() { return data_; }
  247. virtual int size() const { return datalen_; }
  248. virtual AppData* copy() { return new PacketData(*this); }
  249. private:
  250. unsigned char* data_;
  251. int datalen_;
  252. };
  253. //Monarch ext
  254. typedef void (*FailureCallback)(Packet *,void *);
  255. class Packet : public Event {
  256. private:
  257. unsigned char* bits_; // header bits
  258. // unsigned char* data_; // variable size buffer for 'data'
  259. //   unsigned int datalen_; // length of variable size buffer
  260. AppData* data_; // variable size buffer for 'data'
  261. static void init(Packet*);     // initialize pkt hdr 
  262. bool fflag_;
  263. protected:
  264. static Packet* free_; // packet free list
  265. public:
  266. Packet* next_; // for queues and the free list
  267. static int hdrlen_;
  268. Packet() : bits_(0), data_(0), next_(0) { }
  269. inline unsigned char* const bits() { return (bits_); }
  270. inline Packet* copy() const;
  271. static inline Packet* alloc();
  272. static inline Packet* alloc(int);
  273. inline void allocdata(int);
  274. // dirty hack for diffusion data
  275. inline void initdata() { data_  = 0;}
  276. static inline void free(Packet*);
  277. inline unsigned char* access(int off) const {
  278. if (off < 0)
  279. abort();
  280. return (&bits_[off]);
  281. }
  282. // This is used for backward compatibility, i.e., assuming user data
  283. // is PacketData and return its pointer.
  284. inline unsigned char* accessdata() const { 
  285. if (data_ == 0)
  286. return 0;
  287. assert(data_->type() == PACKET_DATA);
  288. return (((PacketData*)data_)->data()); 
  289. }
  290. // This is used to access application-specific data, not limited 
  291. // to PacketData.
  292. inline AppData* userdata() const {
  293. return data_;
  294. }
  295. inline void setdata(AppData* d) { 
  296. if (data_ != NULL)
  297. delete data_;
  298. data_ = d; 
  299. }
  300. inline int datalen() const { return data_ ? data_->size() : 0; }
  301. // Monarch extn
  302. static void dump_header(Packet *p, int offset, int length);
  303. // the pkt stamp carries all info about how/where the pkt
  304.         // was sent needed for a receiver to determine if it correctly
  305.         // receives the pkt
  306.         PacketStamp txinfo_;  
  307. /*
  308.          * According to cmu code:
  309.  * This flag is set by the MAC layer on an incoming packet
  310.          * and is cleared by the link layer.  It is an ugly hack, but
  311.          * there's really no other way because NS always calls
  312.          * the recv() function of an object.
  313.  * 
  314.          */
  315.         u_int8_t        incoming;
  316. //monarch extns end;
  317. };
  318. /* 
  319.  * static constant associations between interface special (negative) 
  320.  * values and their c-string representations that are used from tcl
  321.  */
  322. class iface_literal {
  323. public:
  324. enum iface_constant { 
  325. UNKN_IFACE= -1, /* 
  326.  * iface value for locally originated packets 
  327.  */
  328. ANY_IFACE= -2   /* 
  329.  * hashnode with iif == ANY_IFACE_   
  330.  * matches any pkt iface (imported from TCL);
  331.  * this value should be different from 
  332.  * hdr_cmn::UNKN_IFACE (packet.h)
  333.  */ 
  334. };
  335. iface_literal(const iface_constant i, const char * const n) : 
  336. value_(i), name_(n) {}
  337. inline int value() const { return value_; }
  338. inline const char * const name() const { return name_; }
  339. private:
  340. const iface_constant value_;
  341. /* strings used in TCL to access those special values */
  342. const char * const name_; 
  343. };
  344. static const iface_literal UNKN_IFACE(iface_literal::UNKN_IFACE, "?");
  345. static const iface_literal ANY_IFACE(iface_literal::ANY_IFACE, "*");
  346. /*
  347.  * Note that NS_AF_* doesn't necessarily correspond with
  348.  * the constants used in your system (because many
  349.  * systems don't have NONE or ILINK).
  350.  */
  351. enum ns_af_enum { NS_AF_NONE, NS_AF_ILINK, NS_AF_INET };
  352. struct hdr_cmn {
  353. enum dir_t { DOWN= -1, NONE= 0, UP= 1 };
  354. packet_t ptype_; // packet type (see above)
  355. int size_; // simulated packet size
  356. int uid_; // unique id
  357. int error_; // error flag
  358. int     errbitcnt_;     // # of corrupted bits jahn
  359. int     fecsize_;
  360. double ts_; // timestamp: for q-delay measurement
  361. int iface_; // receiving interface (label)
  362. dir_t direction_; // direction: 0=none, 1=up, -1=down
  363. int ref_count_; // free the pkt until count to 0
  364. // source routing 
  365.         char src_rt_valid;
  366. //Monarch extn begins
  367. nsaddr_t prev_hop_;     // IP addr of forwarding hop
  368. nsaddr_t next_hop_; // next hop for this packet
  369. int      addr_type_;    // type of next_hop_ addr
  370. nsaddr_t last_hop_;     // for tracing on multi-user channels
  371.         // called if pkt can't obtain media or isn't ack'd. not called if
  372.         // droped by a queue
  373.         FailureCallback xmit_failure_; 
  374.         void *xmit_failure_data_;
  375.         /*
  376.          * MONARCH wants to know if the MAC layer is passing this back because
  377.          * it could not get the RTS through or because it did not receive
  378.          * an ACK.
  379.          */
  380.         int     xmit_reason_;
  381. #define XMIT_REASON_RTS 0x01
  382. #define XMIT_REASON_ACK 0x02
  383. //JUNGMIN
  384. #define XMIT_REASON_ATIMACK 0x03
  385. //end of JUNGMIN
  386.         // filled in by GOD on first transmission, used for trace analysis
  387.         int num_forwards_; // how many times this pkt was forwarded
  388.         int opt_num_forwards_;   // optimal #forwards
  389. // Monarch extn ends;
  390. // tx time for this packet in sec
  391. double txtime_;
  392. inline double& txtime() { return(txtime_); }
  393. static int offset_; // offset for this header
  394. inline static int& offset() { return offset_; }
  395. inline static hdr_cmn* access(const Packet* p) {
  396. return (hdr_cmn*) p->access(offset_);
  397. }
  398.         /* per-field member functions */
  399. inline packet_t& ptype() { return (ptype_); }
  400. inline int& size() { return (size_); }
  401. inline int& uid() { return (uid_); }
  402. inline int& error() { return error_; }
  403. inline int& errbitcnt() {return errbitcnt_; }
  404. inline int& fecsize() {return fecsize_; }
  405. inline double& timestamp() { return (ts_); }
  406. inline int& iface() { return (iface_); }
  407. inline dir_t& direction() { return (direction_); }
  408. inline int& ref_count() { return (ref_count_); }
  409. // monarch_begin
  410. inline nsaddr_t& next_hop() { return (next_hop_); }
  411. inline int& addr_type() { return (addr_type_); }
  412. inline int& num_forwards() { return (num_forwards_); }
  413. inline int& opt_num_forwards() { return (opt_num_forwards_); }
  414.         //monarch_end
  415. };
  416. class PacketHeaderClass : public TclClass {
  417. protected:
  418. PacketHeaderClass(const char* classname, int hdrsize);
  419. virtual int method(int argc, const char*const* argv);
  420. void field_offset(const char* fieldname, int offset);
  421. inline void bind_offset(int* off) { offset_ = off; }
  422. inline void offset(int* off) {offset_= off;}
  423. int hdrlen_; // # of bytes for this header
  424. int* offset_; // offset for this header
  425. public:
  426. virtual void bind();
  427. virtual void export_offsets();
  428. TclObject* create(int argc, const char*const* argv);
  429. };
  430. inline void Packet::init(Packet* p)
  431. {
  432. bzero(p->bits_, hdrlen_);
  433. }
  434. inline Packet* Packet::alloc()
  435. {
  436. Packet* p = free_;
  437. if (p != 0) {
  438. assert(p->fflag_ == FALSE);
  439. free_ = p->next_;
  440. assert(p->data_ == 0);
  441. p->uid_ = 0;
  442. p->time_ = 0;
  443. } else {
  444. p = new Packet;
  445. p->bits_ = new unsigned char[hdrlen_];
  446. if (p == 0 || p->bits_ == 0)
  447. abort();
  448. }
  449. init(p); // Initialize bits_[]
  450. (HDR_CMN(p))->next_hop_ = -2; // -1 reserved for IP_BROADCAST
  451. (HDR_CMN(p))->last_hop_ = -2; // -1 reserved for IP_BROADCAST
  452. p->fflag_ = TRUE;
  453. (HDR_CMN(p))->direction() = hdr_cmn::DOWN;
  454. /* setting all direction of pkts to be downward as default; 
  455.    until channel changes it to +1 (upward) */
  456. p->next_ = 0;
  457. return (p);
  458. }
  459. /* 
  460.  * Allocate an n byte data buffer to an existing packet 
  461.  * 
  462.  * To set application-specific AppData, use Packet::setdata()
  463.  */
  464. inline void Packet::allocdata(int n)
  465. {
  466. assert(data_ == 0);
  467. data_ = new PacketData(n);
  468. if (data_ == 0)
  469. abort();
  470. }
  471. /* allocate a packet with an n byte data buffer */
  472. inline Packet* Packet::alloc(int n)
  473. {
  474. Packet* p = alloc();
  475. if (n > 0) 
  476. p->allocdata(n);
  477. return (p);
  478. }
  479. inline void Packet::free(Packet* p)
  480. {
  481. hdr_cmn* ch = hdr_cmn::access(p);
  482. if (p->fflag_) {
  483. if (ch->ref_count() == 0) {
  484. /*
  485.  * A packet's uid may be < 0 (out of a event queue), or
  486.  * == 0 (newed but never gets into the event queue.
  487.  */
  488. assert(p->uid_ <= 0);
  489. // Delete user data because we won't need it any more.
  490. if (p->data_ != 0) {
  491. delete p->data_;
  492. p->data_ = 0;
  493. }
  494. init(p);
  495. p->next_ = free_;
  496. free_ = p;
  497. p->fflag_ = FALSE;
  498. } else {
  499. ch->ref_count() = ch->ref_count() - 1;
  500. }
  501. }
  502. }
  503. inline Packet* Packet::copy() const
  504. {
  505. Packet* p = alloc();
  506. memcpy(p->bits(), bits_, hdrlen_);
  507. if (data_) 
  508. p->data_ = data_->copy();
  509. p->txinfo_.init(&txinfo_);
  510.  
  511. return (p);
  512. }
  513. inline void
  514. Packet::dump_header(Packet *p, int offset, int length)
  515. {
  516.         assert(offset + length <= p->hdrlen_);
  517.         struct hdr_cmn *ch = HDR_CMN(p);
  518.         fprintf(stderr, "nPacket ID: %dn", ch->uid());
  519.         for(int i = 0; i < length ; i+=16) {
  520.                 fprintf(stderr, "%02x %02x %02x %02x %02x %02x %02x %02x %02x %02x %02x %02x %02x %02x %02x %02xn",
  521.                         p->bits_[offset + i],     p->bits_[offset + i + 1],
  522.                         p->bits_[offset + i + 2], p->bits_[offset + i + 3],
  523.                         p->bits_[offset + i + 4], p->bits_[offset + i + 5],
  524.                         p->bits_[offset + i + 6], p->bits_[offset + i + 7],
  525.                         p->bits_[offset + i + 8], p->bits_[offset + i + 9],
  526.                         p->bits_[offset + i + 10], p->bits_[offset + i + 11],
  527.                         p->bits_[offset + i + 12], p->bits_[offset + i + 13],
  528.                         p->bits_[offset + i + 14], p->bits_[offset + i + 15]);
  529.         }
  530. }
  531. #endif