Socket/Protocols/Raw/MACAddress.hh

   1 // $Id$
   2 //
   3 // Copyright (C) 2007
   4 // Fraunhofer Institute for Open Communication Systems (FOKUS)
   5 // Competence Center NETwork research (NET), St. Augustin, GERMANY
   6 //     Stefan Bund <g0dil@berlios.de>
   7 //
   8 // This program is free software; you can redistribute it and/or modify
   9 // it under the terms of the GNU General Public License as published by
  10 // the Free Software Foundation; either version 2 of the License, or
  11 // (at your option) any later version.
  12 //
  13 // This program is distributed in the hope that it will be useful,
  14 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  15 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16 // GNU General Public License for more details.
  17 //
  18 // You should have received a copy of the GNU General Public License
  19 // along with this program; if not, write to the
  20 // Free Software Foundation, Inc.,
  21 // 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
  22
  23 /** \file
  24     \brief MACAddress public header */
  25
  26 #ifndef HH_SENF_Socket_Protocols_Raw_MACAddress_
  27 #define HH_SENF_Socket_Protocols_Raw_MACAddress_ 1
  28
  29 // Custom includes
  30 #include <iostream>
  31 #include <boost/cstdint.hpp>
  32 #include <boost/array.hpp>
  33 #include <boost/utility.hpp>
  34 #include <boost/type_traits.hpp>
  35 #include "../../../Utils/safe_bool.hh"
  36 #include "../../../Utils/Tags.hh"
  37 #include "../AddressExceptions.hh"
  38
  39 //#include "MACAddress.mpp"
  40 ///////////////////////////////hh.p////////////////////////////////////////
  41
  42 namespace senf {
  43
  44     /** \brief Ethernet MAC address
  45
  46         The Ethernet MAC is modelled as a fixed-size container/sequence of 6 bytes.
  47
  48         The following statements all create the same MAC address <code>00:1A:2B:3C:4D:5F</code>
  49         \code
  50         // Used to construct constant MAC addresses
  51         MACAddress(0x001A2B3C4D5Flu)
  52
  53         // Construct a MAC address from it's string representation:
  54         MACAddress::from_string("00:1a:2b:3c:4d:5f")   // case is ignored
  55         MACAddress::from_string("00-1A-2B-3C-4D-5F")   // '-' as separator is allowed too
  56
  57         // Construct a MAC address from raw data.  'from_data' takes an arbitrary iterator (e.g. a
  58         // pointer) as argument. Here we use a fixed array but normally you will need this to build
  59         // a MAC address in a packet parser
  60         char rawBytes[] = { 0x00, 0x1A, 0x2B, 0x3C, 0x4D, 0x5F };
  61         MACAddress::from_data(rawBytes)
  62
  63         // Construct a MAC from the EUID64 as used by INet6 interfaces.  The eui64 will come from an
  64         // INet6 address:
  65         MACAddress::from_eui64(0x001A2BFFFE3C4D5Ful)
  66         MACAddress::from_eui64(
  67             INet6Address(0x2001u,0xDB8u,0x1u,0x0u,0x001Au,0x2BFFu,0xFE3Cu,0x3D5Fu).id())
  68         \endcode
  69
  70         Since MACAddress is based on \c boost::array, you can access the raw data bytes of the
  71         address using \c begin(), \c end() or \c operator[]:
  72         \code
  73         MACAddress mac = ...;
  74         Packet::iterator i = ...;
  75
  76         std::copy(mac.begin(), mac.end(), i); // Copies 6 bytes
  77         \endcode
  78
  79         \implementation We awkwardly need to use static named constructors (<tt>from_</tt> members)
  80             instead of ordinarily overloaded constructors for one simple reason: <tt>char *</tt>
  81             doubles as string literal and as arbitrary data iterator. The iterator constructor can
  82             therefore not be distinguished from initialization with a string literal. Therefore we
  83             need to disambiguate using the named constructors.
  84
  85         \ingroup addr_group
  86      */
  87     struct MACAddress
  88         : public boost::array<boost::uint8_t,6>,
  89           public comparable_safe_bool<MACAddress>
  90     {
  91         static MACAddress const Broadcast; ///< The broadcast address
  92         static MACAddress const None;   ///< The empty (0) address
  93
  94         MACAddress();                   ///< Construct zero-initialized address
  95         MACAddress(senf::NoInit_t);     ///< Construct uninitialized (!) address
  96         explicit MACAddress(boost::uint64_t v); ///< Construct MACAddress constants
  97
  98         static MACAddress from_string(std::string const & s);
  99                                         ///< Construct address from string representation
 100                                         /**< The string representation must exactly match the form
 101                                              <tt>dd:dd:dd:dd:dd:dd</tt> where <tt>d</tt> is any
 102                                              hexadecimal digit. In place of ':', '-' is also
 103                                              accepted as a delimiter.
 104                                              \throws AddressSyntaxException */
 105
 106         template <class InputIterator>
 107         static MACAddress from_data(InputIterator i);
 108                                         ///< Construct address from raw data
 109                                         /**< Copies the data from \a i into the MAC address.
 110                                              \pre The input range at \a i must have a size of at
 111                                                  least 6 elements. */
 112
 113         static MACAddress from_eui64(boost::uint64_t v);
 114                                         ///< Construct address from EUI-64
 115                                         /**< This constructor takes an EUI-64 value and converts it
 116                                              to a MAC address. This conversion is only possible, if
 117                                              the EUI-64 is MAC compatible: the 4th/5th byte (in
 118                                              transmission order) must be 0xFFFE.
 119                                              \throws AddressSyntaxException if \a v is not a MAC
 120                                                  compatible EUI-64. */
 121
 122         bool local() const;             ///< \c true, if address is locally administered
 123         bool multicast() const;             ///< \c true, if address is a group/multicast address
 124         bool broadcast() const;         ///< \c true, if address is the broadcast address
 125         bool boolean_test() const;      ///< \c true, if address is not the zero address
 126
 127         boost::uint32_t oui() const;    ///< Return first 3 bytes of the address
 128         boost::uint32_t nic() const;    ///< Return last 3 bytes of the address
 129
 130         boost::uint64_t eui64() const;  ///< Build EUI-64 from the MAC address
 131
 132         std::string toString() const; ///< Return string representation of MAC address like 12:34:56:78:90:ab
 133
 134     };
 135
 136     /** \brief Write MAC address
 137         \related MACAddress
 138      */
 139     std::ostream & operator<<(std::ostream & os, MACAddress const & mac);
 140
 141 }
 142
 143 ///////////////////////////////hh.e////////////////////////////////////////
 144 #include "MACAddress.cci"
 145 #include "MACAddress.ct"
 146 //#include "MACAddress.cti"
 147 #endif
 148
 149 \f
 150 // Local Variables:
 151 // mode: c++
 152 // fill-column: 100
 153 // comment-column: 40
 154 // c-file-style: "senf"
 155 // indent-tabs-mode: nil
 156 // ispell-local-dictionary: "american"
 157 // compile-command: "scons -u test"
 158 // End: