source: mainline/uspace/lib/net/include/icmp_header.h@ a26b9e3

lfn serial ticket/834-toolchain-update topic/msim-upgrade topic/simplify-dev-export
Last change on this file since a26b9e3 was a26b9e3, checked in by Jakub Jermar <jakub@…>, 15 years ago

Cleanup libnet ICMP interfaces.

  • Property mode set to 100644
File size: 3.5 KB
Line 
1/*
2 * Copyright (c) 2009 Lukas Mejdrech
3 * All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
7 * are met:
8 *
9 * - Redistributions of source code must retain the above copyright
10 * notice, this list of conditions and the following disclaimer.
11 * - Redistributions in binary form must reproduce the above copyright
12 * notice, this list of conditions and the following disclaimer in the
13 * documentation and/or other materials provided with the distribution.
14 * - The name of the author may not be used to endorse or promote products
15 * derived from this software without specific prior written permission.
16 *
17 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
18 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
19 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
20 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
21 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
22 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
23 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
24 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
26 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27 */
28
29/** @addtogroup libnet
30 * @{
31 */
32
33/** @file
34 * ICMP header definition.
35 * Based on the RFC 792.
36 */
37
38#ifndef LIBNET_ICMP_HEADER_H_
39#define LIBNET_ICMP_HEADER_H_
40
41#include <sys/types.h>
42
43#include <net/in.h>
44#include <net/icmp_codes.h>
45
46/** ICMP header size in bytes. */
47#define ICMP_HEADER_SIZE sizeof(icmp_header_t)
48
49/** Type definition of the echo specific data.
50 * @see icmp_echo
51 */
52typedef struct icmp_echo icmp_echo_t;
53
54/** Type definition of the echo specific data pointer.
55 * @see icmp_echo
56 */
57typedef icmp_echo_t *icmp_echo_ref;
58
59/** Echo specific data. */
60struct icmp_echo {
61 /** Message idintifier. */
62 icmp_param_t identifier;
63 /** Message sequence number. */
64 icmp_param_t sequence_number;
65} __attribute__ ((packed));
66
67/** Type definition of the internet control message header.
68 * @see icmp_header
69 */
70typedef struct icmp_header icmp_header_t;
71
72/** Type definition of the internet control message header pointer.
73 * @see icmp_header
74 */
75typedef icmp_header_t *icmp_header_ref;
76
77/** Internet control message header. */
78struct icmp_header {
79 /** The type of the message. */
80 uint8_t type;
81
82 /**
83 * The error code for the datagram reported by the ICMP message.
84 * The interpretation is dependent on the message type.
85 */
86 uint8_t code;
87
88 /**
89 * The checksum is the 16-bit ones's complement of the one's complement
90 * sum of the ICMP message starting with the ICMP Type. For computing
91 * the checksum, the checksum field should be zero. If the checksum does
92 * not match the contents, the datagram is discarded.
93 */
94 uint16_t checksum;
95
96 /** Message specific data. */
97 union {
98 /** Echo specific data. */
99 icmp_echo_t echo;
100 /** Proposed gateway value. */
101 in_addr_t gateway;
102
103 /** Fragmentation needed specific data. */
104 struct {
105 /** Reserved field. Must be zero. */
106 icmp_param_t reserved;
107 /** Proposed MTU. */
108 icmp_param_t mtu;
109 } frag;
110
111 /** Parameter problem specific data. */
112 struct {
113 /** Problem pointer. */
114 icmp_param_t pointer;
115 /** Reserved field. Must be zero. */
116 icmp_param_t reserved;
117 } param;
118 } un;
119} __attribute__ ((packed));
120
121#endif
122
123/** @}
124 */
Note: See TracBrowser for help on using the repository browser.