Fix documentation build under maverick (doxygen 1.7.1)
[senf.git] / senf / Packets / DefaultBundle / UDPPacket.cc
1 // $Id$
2 //
3 // Copyright (C) 2006
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 UDPPacket non-inline non-template implementation */
25
26 #include "UDPPacket.hh"
27 //#include "UDPPacket.ih"
28
29 // Custom includes
30 #include <iomanip>
31 #include <boost/io/ios_state.hpp>
32 #include <senf/Packets/Packets.hh>
33 #include <senf/Utils/IpChecksum.hh>
34 #include "IPv4Packet.hh"
35 #include "IPv6Packet.hh"
36
37 #define prefix_
38 //-/////////////////////////////////////////////////////////////////////////////////////////////////
39
40 namespace {
41     SENF_PACKET_REGISTRY_REGISTER( senf::IpTypes, 17, senf::UDPPacket);
42 }
43
44 //-/////////////////////////////////////////////////////////////////////////////////////////////////
45 // senf::UDPPacketParser
46
47 prefix_ boost::uint16_t senf::UDPPacketParser::calcChecksum()
48     const
49 {
50     IpChecksum summer;
51     // first on to the awkward part: the IP pseudo header
52     IPv4Packet ipv4 (packet().rfind<IPv4Packet>(nothrow));
53     if (ipv4) {
54         // Pseudo header defined in RFC768
55         summer.feed( ipv4->source().i(),
56                      ipv4->source().i() + IPv4Packet::Parser::source_t::fixed_bytes );
57         ///\fixme What about a hop-by-hop routing option? Which destination is used in IPv4 ?
58         summer.feed( ipv4->destination().i(),
59                      ipv4->destination().i() + IPv4PacketParser::destination_t::fixed_bytes );
60         summer.feed( 0u );
61         ///\fixme May there be another header between the IPv4 header and UDP? if so, we
62         /// need to hack the correct protocol number here ...
63         summer.feed( 17u );
64         summer.feed( i() + length_offset, i() + length_offset + 2 );
65     }
66     else {
67         // Pseudo header defined in RFC2460
68         IPv6Packet ipv6 (packet().rfind<IPv6Packet>(nothrow));
69         if (ipv6) {
70             summer.feed( ipv6->source().i(),
71                          ipv6->source().i() + IPv6Packet::Parser::source_t::fixed_bytes );
72             ///\todo Implement routing header support
73             // The destination used here must be the *final* destination ...
74             summer.feed( ipv6->destination().i(),
75                          ipv6->destination().i() + IPv6PacketParser::destination_t::fixed_bytes );
76             // This is a simplification. The value is really 32bit to support UDP Jumbograms
77             // (RFC2147). However, skipping an even number of 0 bytes does not change the checksum
78             summer.feed( i() + length_offset, i() + length_offset + 2 );
79             // RFC2460 specifies, that this must always be 17, not the value used in the ipv6
80             // header
81             summer.feed( 0u );
82             summer.feed( 17u );
83         }
84     }
85
86     // since header are 16 / even 32bit aligned we don't have to care for padding. since IpChecksum
87     // cares for padding at the final summing we don't have to care is the payload is 16nbit-aligned, too.
88     summer.feed( i(), i()+checksum_offset );
89     summer.feed( i()+checksum_offset+2, data().end() );
90
91     boost::uint16_t rv (summer.sum());
92     return rv ? rv : 0xffffu;
93 }
94
95 //-/////////////////////////////////////////////////////////////////////////////////////////////////
96 // senf::UDPPacketType
97
98 prefix_ void senf::UDPPacketType::dump(packet p, std::ostream & os)
99 {
100     boost::io::ios_all_saver ias(os);
101     os << "UDP:\n"
102        << senf::fieldName("source port")               << p->source() << "\n"
103        << senf::fieldName("dest port")                 << p->destination() << "\n"
104        << senf::fieldName("length")                    << p->length() << "\n"
105        << senf::fieldName("checksum")
106        << "0x" << std::hex << std::setw(4) << std::setfill('0') << p->checksum() << "\n";
107 }
108
109 prefix_ void senf::UDPPacketType::finalize(packet p)
110 {
111     p->length() << p.size();
112     p->checksum() << p->calcChecksum();
113 }
114
115 //-/////////////////////////////////////////////////////////////////////////////////////////////////
116 #undef prefix_
117
118 \f
119 // Local Variables:
120 // mode: c++
121 // fill-column: 100
122 // c-file-style: "senf"
123 // indent-tabs-mode: nil
124 // ispell-local-dictionary: "american"
125 // compile-command: "scons -u test"
126 // comment-column: 40
127 // End: