4 // Fraunhofer Institute for Open Communication Systems (FOKUS)
5 // Competence Center NETwork research (NET), St. Augustin, GERMANY
6 // Thorsten Horstmann <tho@berlios.de>
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.
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.
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.
24 \brief EthernetPacket public header */
26 #ifndef HH_SENF_Packets_DefaultBundle_EthernetPacket_
27 #define HH_SENF_Packets_DefaultBundle_EthernetPacket_ 1
31 #include "../../Socket/Protocols/Raw/MACAddress.hh"
32 #include "../../Packets/Packets.hh"
34 //#include "EthernetPacket.mpp"
35 ///////////////////////////////hh.p////////////////////////////////////////
39 /** \brief Parse an Ethernet MAC address
41 The ethernet MAC is returned by value as a 6-byte sequence
46 struct MACAddressParser : public PacketParserBase
48 MACAddressParser(data_iterator i, state_type s) : PacketParserBase(i,s,fixed_bytes) {}
50 ///////////////////////////////////////////////////////////////////////////
52 typedef MACAddress value_type;
53 static const size_type fixed_bytes = 6u;
55 value_type value() const { return MACAddress::from_data(i()); }
56 void value(value_type const & v) { std::copy(v.begin(), v.end(), i()); }
57 operator value_type () { return value(); }
58 byte & operator[](size_type index) { return *boost::next(i(),index); }
60 MACAddressParser const & operator= (value_type const & other) { value(other); return *this; }
63 /** \brief Parse an Ethernet packet
65 Parser implementing an ethernet header.
67 \see EthernetPacketType
69 struct EthernetPacketParser : public PacketParserBase
71 # include SENF_FIXED_PARSER()
73 SENF_PARSER_FIELD( destination, MACAddressParser );
74 SENF_PARSER_FIELD( source, MACAddressParser );
75 SENF_PARSER_FIELD( type_length, UInt16Parser );
77 SENF_PARSER_FINALIZE(EthernetPacketParser);
80 /** \brief EtherType registry
82 This registry registers packet types with their EtherType number.
84 \see <a href="http://www.iana.org/assignments/ethernet-numbers">Ethernet numbers</a> \n
88 typedef boost::uint16_t key_t;
91 /** \brief Ethernet packet
93 \par Packet type (typedef):
97 \ref EthernetPacketParser
98 \image html EthernetPacket.png
100 \par Associated registries:
103 \par Finalize action:
104 Set \a type from type of next packet if found in \ref EtherTypes
106 \ingroup protocolbundle_default
108 struct EthernetPacketType
109 : public PacketTypeBase,
110 public PacketTypeMixin<EthernetPacketType, EtherTypes>
113 typedef PacketTypeMixin<EthernetPacketType, EtherTypes> mixin;
115 typedef ConcretePacket<EthernetPacketType> packet;
116 typedef EthernetPacketParser parser;
118 using mixin::nextPacketRange;
119 using mixin::initSize;
122 static factory_t nextPacketType(packet p);
123 /// Dump given EthernetPacket in readable form to given output stream
124 static void dump(packet p, std::ostream & os);
125 static void finalize(packet p);
128 /** \brief Ethernet packet typedef */
129 typedef ConcretePacket<EthernetPacketType> EthernetPacket;
131 /** \brief Parse an ethernet VLAN tag
133 Parser interpreting the ethernet VLAN tag. Fields are
135 \see EthVLanPacketType
137 struct EthVLanPacketParser : public PacketParserBase
139 # include SENF_FIXED_PARSER()
141 SENF_PARSER_BITFIELD( priority, 3, unsigned );
142 SENF_PARSER_BITFIELD( cfi, 1, bool );
143 SENF_PARSER_BITFIELD( vlanId, 12, unsigned );
145 SENF_PARSER_FIELD( type, UInt16Parser );
147 SENF_PARSER_FINALIZE(EthVLanPacketParser);
150 /** \brief Ethernet VLAN tag
152 \par Packet type (typedef):
156 \ref EthVLanPacketParser
157 \image html EthVLanPacket.png
159 \par Associated registries:
162 \par Finalize action:
163 Set \a type from type of next packet if found in \ref EtherTypes
165 \ingroup protocolbundle_default
167 struct EthVLanPacketType
168 : public PacketTypeBase,
169 public PacketTypeMixin<EthVLanPacketType, EtherTypes>
172 typedef PacketTypeMixin<EthVLanPacketType, EtherTypes> mixin;
174 typedef ConcretePacket<EthVLanPacketType> packet;
175 typedef EthVLanPacketParser parser;
177 using mixin::nextPacketRange;
178 using mixin::nextPacketType;
179 using mixin::initSize;
182 /** \todo Add LLC/SNAP support -> only use the registry
183 for type() values >=1536, otherwise expect an LLC header */
184 static key_t nextPacketKey(packet p)
185 { return p->type(); }
187 /// Dump given EthVLanPacket in readable form to given output stream
188 static void dump(packet p, std::ostream & os);
189 static void finalize(packet p);
192 /** \brief Ethernet VLAN tag typedef */
193 typedef ConcretePacket<EthVLanPacketType> EthVLanPacket;
197 ///////////////////////////////hh.e////////////////////////////////////////
198 //#include "EthernetPacket.cci"
199 //#include "EthernetPacket.ct"
200 //#include "EthernetPacket.cti"
207 // c-file-style: "senf"
208 // indent-tabs-mode: nil
209 // ispell-local-dictionary: "american"
210 // compile-command: "scons -u test"
211 // comment-column: 40