1 // $id: EthernetPacket.hh 299 2007-07-10 21:23:49Z g0dil $
4 // Fraunhofer Institut fuer offene Kommunikationssysteme (FOKUS)
5 // Kompetenzzentrum fuer Satelitenkommunikation (SatCom)
6 // Stefan Bund <stefan.bund@fokus.fraunhofer.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_EthernetPacket_
27 #define HH_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 Parse_MAC : public PacketParserBase
48 Parse_MAC(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 Parse_MAC 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 Parse_Ethernet : public PacketParserBase
71 # include SENF_FIXED_PARSER()
73 SENF_PARSER_FIELD( destination, Parse_MAC );
74 SENF_PARSER_FIELD( source, Parse_MAC );
75 SENF_PARSER_FIELD( type_length, Parse_UInt16 );
77 SENF_PARSER_FINALIZE(Parse_Ethernet);
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
89 typedef boost::uint16_t key_t;
92 /** \brief Ethernet packet
94 \par Packet type (typedef):
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;
114 typedef ConcretePacket<EthernetPacketType> packet;
115 typedef Parse_Ethernet parser;
117 using mixin::nextPacketRange;
118 // using mixin::nextPacketType;
119 using mixin::initSize;
122 static factory_t nextPacketType(packet p);
123 static void dump(packet p, std::ostream & os);
124 static void finalize(packet p);
127 /** \brief Ethernet packet typedef */
128 typedef ConcretePacket<EthernetPacketType> EthernetPacket;
130 /** \brief Parse an ethernet VLAN tag
132 Parser interpreting the ethernet VLAN tag. Fields are
134 \see EthVLanPacketType
136 struct Parse_EthVLan : public PacketParserBase
138 # include SENF_FIXED_PARSER()
140 SENF_PARSER_BITFIELD( priority, 3, unsigned );
141 SENF_PARSER_BITFIELD( cfi, 1, bool );
142 SENF_PARSER_BITFIELD( vlanId, 12, unsigned );
144 SENF_PARSER_FIELD( type, Parse_UInt16 );
146 SENF_PARSER_FINALIZE(Parse_EthVLan);
149 /** \brief Ethernet VLAN tag
151 \par Packet type (typedef):
157 \par Associated registries:
160 \par Finalize action:
161 Set \a type from type of next packet if found in \ref EtherTypes
163 \ingroup protocolbundle_default
165 struct EthVLanPacketType
166 : public PacketTypeBase,
167 public PacketTypeMixin<EthVLanPacketType, EtherTypes>
170 typedef PacketTypeMixin<EthVLanPacketType, EtherTypes> mixin;
171 typedef ConcretePacket<EthVLanPacketType> packet;
172 typedef Parse_EthVLan parser;
174 using mixin::nextPacketRange;
175 using mixin::nextPacketType;
176 using mixin::initSize;
179 /** \todo Add LLC/SNAP support -> only use the registry
180 for type() values >=1536, otherwise expect an LLC header */
181 static registry_key_t nextPacketKey(packet p)
182 { return p->type(); }
184 static void dump(packet p, std::ostream & os);
185 static void finalize(packet p);
188 /** \brief Ethernet VLAN tag typedef */
189 typedef ConcretePacket<EthVLanPacketType> EthVLanPacket;
192 /** \brief Parse an ethernet LLC/SNAP header
196 \see EthVLanPacketType
198 struct Parse_EthLlcSnapPacket : public PacketParserBase
200 # include SENF_FIXED_PARSER()
202 SENF_PARSER_FIELD( dsap, Parse_UInt8 );
203 SENF_PARSER_FIELD( ssap, Parse_UInt8 );
204 SENF_PARSER_FIELD( ctrl, Parse_UInt8 );
206 SENF_PARSER_FIELD( protocolId, Parse_UInt24 );
207 SENF_PARSER_FIELD( type, Parse_UInt16 );
209 SENF_PARSER_FINALIZE(Parse_EthLlcSnapPacket);
215 protocolId() = 0x000000;
219 /** \brief Ethernet LLC/SNAP header
223 \par Packet type (typedef):
224 \ref EthLlcSnapPacketType
227 \ref Parse_EthLlcSnapPacket
229 \par Associated registries:
232 \par Finalize action:
235 \ingroup protocolbundle_default
237 struct EthLlcSnapPacketType
238 : public PacketTypeBase,
239 public PacketTypeMixin<EthLlcSnapPacketType, EtherTypes>
242 typedef PacketTypeMixin<EthLlcSnapPacketType, EtherTypes> mixin;
243 typedef ConcretePacket<EthLlcSnapPacketType> packet;
244 typedef Parse_EthLlcSnapPacket parser;
246 using mixin::nextPacketRange;
247 using mixin::nextPacketType;
248 using mixin::initSize;
251 static registry_key_t nextPacketKey(packet p)
252 { return p->type(); }
254 static void dump(packet p, std::ostream & os);
255 static void finalize(packet p);
258 /** \brief Ethernet VLAN tag typedef */
259 typedef ConcretePacket<EthLlcSnapPacketType> EthLlcSnapPacket;
263 ///////////////////////////////hh.e////////////////////////////////////////
265 #ifndef SENF_PACKETS_DECL_ONLY
266 //#include "EthernetPacket.cci"
267 //#include "EthernetPacket.ct"
268 //#include "EthernetPacket.cti"
275 // c-file-style: "senf"
276 // indent-tabs-mode: nil
277 // ispell-local-dictionary: "american"
278 // compile-command: "scons -u test"
279 // comment-column: 40