00001 00002 /* 00003 * nixvec.h 00004 * Copyright (C) 2000 by the University of Southern California 00005 * $Id: nixvec.h,v 1.3 2005/08/25 18:58:10 johnh Exp $ 00006 * 00007 * This program is free software; you can redistribute it and/or 00008 * modify it under the terms of the GNU General Public License, 00009 * version 2, as published by the Free Software Foundation. 00010 * 00011 * This program is distributed in the hope that it will be useful, 00012 * but WITHOUT ANY WARRANTY; without even the implied warranty of 00013 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 00014 * GNU General Public License for more details. 00015 * 00016 * You should have received a copy of the GNU General Public License along 00017 * with this program; if not, write to the Free Software Foundation, Inc., 00018 * 59 Temple Place, Suite 330, Boston, MA 02111-1307, USA. 00019 * 00020 * 00021 * The copyright of this module includes the following 00022 * linking-with-specific-other-licenses addition: 00023 * 00024 * In addition, as a special exception, the copyright holders of 00025 * this module give you permission to combine (via static or 00026 * dynamic linking) this module with free software programs or 00027 * libraries that are released under the GNU LGPL and with code 00028 * included in the standard release of ns-2 under the Apache 2.0 00029 * license or under otherwise-compatible licenses with advertising 00030 * requirements (or modified versions of such code, with unchanged 00031 * license). You may copy and distribute such a system following the 00032 * terms of the GNU GPL for this module and the licenses of the 00033 * other code concerned, provided that you include the source code of 00034 * that other code when and as the GNU GPL requires distribution of 00035 * source code. 00036 * 00037 * Note that people who make modified versions of this module 00038 * are not obligated to grant this special exception for their 00039 * modified versions; it is their choice whether to do so. The GNU 00040 * General Public License gives permission to release a modified 00041 * version without this exception; this exception also makes it 00042 * possible to release a modified version which carries forward this 00043 * exception. 00044 * 00045 */ 00046 00047 /* 00048 * Support for NixVector routing 00049 * contributed to ns from 00050 * George F. Riley, Georgia Tech, Spring 2000 00051 */ 00052 00053 #ifndef __NIXVEC_H__ 00054 #define __NIXVEC_H__ 00055 00056 #include <utility> // for pair 00057 #ifdef WIN32 00058 #include <pair.h> // for MSVC 6.0 that doens't have a proper <utility> 00059 #endif /* WIN32 */ 00060 00061 // Define a type for the neighbor index 00062 typedef unsigned long Nix_t; 00063 typedef unsigned long Nixl_t; // Length of a NV 00064 const Nix_t NIX_NONE = 0xffffffff; // If not a neighbor 00065 const Nixl_t NIX_BPW = 32; // Bits per long word 00066 typedef pair<Nix_t, Nixl_t> NixPair_t; // Index, bits needed 00067 typedef pair<Nix_t*, Nixl_t> NixpPair_t;// NV Pointer, length 00068 00069 00070 // The variable length neighbor index routing vector 00071 class NixVec { 00072 public : 00073 NixVec () : m_pNV(0), m_used(0), m_alth(0) { }; 00074 NixVec(NixVec*); // Construct from existing 00075 ~NixVec(); // Destructor 00076 void Add(NixPair_t); // Add bits to the nix vector 00077 Nix_t Extract(Nixl_t); // Extract the specified number of bits 00078 Nix_t Extract(Nixl_t, Nixl_t*); // Extract using external "used" 00079 NixpPair_t Get(void); // Get the entire nv 00080 void Reset(); // Reset used to 0 00081 Nixl_t Lth(); // Get length in bits of allocated 00082 void DBDump(); // Debug..print it out 00083 Nixl_t ALth() { return m_alth;} // Debug...how many bits actually used 00084 static Nixl_t GetBitl(Nix_t); // Find out how many bits needed 00085 private : 00086 Nix_t* m_pNV; // Points to variable lth nixvector (or actual if l == 32) 00087 // Nixl_t m_lth; // Length of this nixvector (computed from m_alth) 00088 Nixl_t m_used; // Used portion of this nixvector 00089 Nixl_t m_alth; // Actual length (largest used) 00090 }; 00091 00092 #endif