VirtualBox

source: vbox/trunk/include/iprt/net.h@ 18910

Last change on this file since 18910 was 17848, checked in by vboxsync, 16 years ago

comment

  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 20.4 KB
Line 
1/** @file
2 * IPRT - Network Protocols.
3 */
4
5/*
6 * Copyright (C) 2008 Sun Microsystems, Inc.
7 *
8 * This file is part of VirtualBox Open Source Edition (OSE), as
9 * available from http://www.virtualbox.org. This file is free software;
10 * you can redistribute it and/or modify it under the terms of the GNU
11 * General Public License (GPL) as published by the Free Software
12 * Foundation, in version 2 as it comes in the "COPYING" file of the
13 * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
14 * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
15 *
16 * The contents of this file may alternatively be used under the terms
17 * of the Common Development and Distribution License Version 1.0
18 * (CDDL) only, as it comes in the "COPYING.CDDL" file of the
19 * VirtualBox OSE distribution, in which case the provisions of the
20 * CDDL are applicable instead of those of the GPL.
21 *
22 * You may elect to license modified versions of this file under the
23 * terms and conditions of either the GPL or the CDDL or both.
24 *
25 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa
26 * Clara, CA 95054 USA or visit http://www.sun.com if you need
27 * additional information or have any questions.
28 */
29
30#ifndef ___iprt_net_h
31#define ___iprt_net_h
32
33#include <iprt/cdefs.h>
34#include <iprt/types.h>
35#include <iprt/assert.h>
36
37
38__BEGIN_DECLS
39
40/** @defgroup grp_rt_net RTNet - Network Protocols
41 * @ingroup grp_rt
42 * @{
43 */
44
45/**
46 * IPv4 address.
47 */
48typedef RTUINT32U RTNETADDRIPV4;
49AssertCompileSize(RTNETADDRIPV4, 4);
50/** Pointer to a IPv4 address. */
51typedef RTNETADDRIPV4 *PRTNETADDRIPV4;
52/** Pointer to a const IPv4 address. */
53typedef RTNETADDRIPV4 const *PCRTNETADDRIPV4;
54
55/**
56 * IPv6 address.
57 */
58typedef RTUINT128U RTNETADDRIPV6;
59AssertCompileSize(RTNETADDRIPV6, 16);
60/** Pointer to a IPv4 address. */
61typedef RTNETADDRIPV6 *PRTNETADDRIPV6;
62/** Pointer to a const IPv4 address. */
63typedef RTNETADDRIPV6 const *PCRTNETADDRIPV6;
64
65/**
66 * IPX address.
67 */
68#pragma pack(1)
69typedef struct RTNETADDRIPX
70{
71 /** The network ID. */
72 uint32_t Network;
73 /** The node ID. (Defaults to the MAC address apparently.) */
74 RTMAC Node;
75} RTNETADDRIPX;
76#pragma pack()
77AssertCompileSize(RTNETADDRIPX, 4+6);
78/** Pointer to an IPX address. */
79typedef RTNETADDRIPX *PRTNETADDRIPX;
80/** Pointer to a const IPX address. */
81typedef RTNETADDRIPX const *PCRTNETADDRIPX;
82
83/**
84 * Address union.
85 */
86typedef union RTNETADDRU
87{
88 /** 64-bit view. */
89 uint64_t au64[2];
90 /** 32-bit view. */
91 uint32_t au32[4];
92 /** 16-bit view. */
93 uint16_t au16[8];
94 /** 8-bit view. */
95 uint8_t au8[16];
96 /** IPv4 view. */
97 RTNETADDRIPV4 IPv4;
98 /** IPv6 view. */
99 RTNETADDRIPV6 IPv6;
100 /** IPX view. */
101 RTNETADDRIPX Ipx;
102 /** MAC address view. */
103 RTMAC Mac;
104} RTNETADDRU;
105AssertCompileSize(RTNETADDRU, 16);
106/** Pointer to an address union. */
107typedef RTNETADDRU *PRTNETADDRU;
108/** Pointer to a const address union. */
109typedef RTNETADDRU const *PCRTNETADDRU;
110
111
112/**
113 * Ethernet header.
114 */
115#pragma pack(1)
116typedef struct RTNETETHERHDR
117{
118 RTMAC DstMac;
119 RTMAC SrcMac;
120 /** Ethernet frame type or frame size, depending on the kind of ethernet.
121 * This is big endian on the wire. */
122 uint16_t EtherType;
123} RTNETETHERHDR;
124#pragma pack()
125AssertCompileSize(RTNETETHERHDR, 14);
126/** Pointer to an ethernet header. */
127typedef RTNETETHERHDR *PRTNETETHERHDR;
128/** Pointer to a const ethernet header. */
129typedef RTNETETHERHDR const *PCRTNETETHERHDR;
130
131/** @name EtherType (RTNETETHERHDR::EtherType)
132 * @{ */
133#define RTNET_ETHERTYPE_IPV4 UINT16_C(0x0800)
134#define RTNET_ETHERTYPE_ARP UINT16_C(0x0806)
135#define RTNET_ETHERTYPE_IPV6 UINT16_C(0x86dd)
136#define RTNET_ETHERTYPE_VLAN UINT16_C(0x8100)
137#define RTNET_ETHERTYPE_IPX_1 UINT16_C(0x8037)
138#define RTNET_ETHERTYPE_IPX_2 UINT16_C(0x8137)
139#define RTNET_ETHERTYPE_IPX_3 UINT16_C(0x8138)
140/** @} */
141
142
143/**
144 * IPv4 header.
145 * All is bigendian on the wire.
146 */
147#pragma pack(1)
148typedef struct RTNETIPV4
149{
150#ifdef RT_BIG_ENDIAN
151 unsigned int ip_v : 4;
152 unsigned int ip_hl : 4;
153 unsigned int ip_tos : 8;
154 unsigned int ip_len : 16;
155#else
156 /** 00:0 - Header length given as a 32-bit word count. */
157 unsigned int ip_hl : 4;
158 /** 00:4 - Header version. */
159 unsigned int ip_v : 4;
160 /** 01 - Type of service. */
161 unsigned int ip_tos : 8;
162 /** 02 - Total length (header + data). */
163 unsigned int ip_len : 16;
164#endif
165 /** 04 - Packet idenficiation. */
166 uint16_t ip_id;
167 /** 06 - Offset if fragmented. */
168 uint16_t ip_off;
169 /** 08 - Time to live. */
170 uint8_t ip_ttl;
171 /** 09 - Protocol. */
172 uint8_t ip_p;
173 /** 0a - Header check sum. */
174 uint16_t ip_sum;
175 /** 0c - Source address. */
176 RTNETADDRIPV4 ip_src;
177 /** 10 - Destination address. */
178 RTNETADDRIPV4 ip_dst;
179 /** 14 - Options (optional). */
180 uint32_t ip_options[1];
181} RTNETIPV4;
182#pragma pack()
183AssertCompileSize(RTNETIPV4, 6 * 4);
184/** Pointer to a IPv4 header. */
185typedef RTNETIPV4 *PRTNETIPV4;
186/** Pointer to a const IPv4 header. */
187typedef RTNETIPV4 const *PCRTNETIPV4;
188
189/** The minimum IPv4 header length (in bytes).
190 * Up to and including RTNETIPV4::ip_dst. */
191#define RTNETIPV4_MIN_LEN (20)
192
193
194/** @name IPv4 Protocol Numbers
195 * @{ */
196/** IPv4: ICMP */
197#define RTNETIPV4_PROT_ICMP (1)
198/** IPv4: TCP */
199#define RTNETIPV4_PROT_TCP (6)
200/** IPv4: UDP */
201#define RTNETIPV4_PROT_UDP (17)
202/** @} */
203
204/** @name Common IPv4 Port Assignments
205 * @{
206 */
207/** Boostrap Protocol / DHCP) Server. */
208#define RTNETIPV4_PORT_BOOTPS (67)
209/** Boostrap Protocol / DHCP) Client. */
210#define RTNETIPV4_PORT_BOOTPC (68)
211/** @} */
212
213RTDECL(uint16_t) RTNetIPv4HdrChecksum(PCRTNETIPV4 pIpHdr);
214RTDECL(bool) RTNetIPv4IsHdrValid(PCRTNETIPV4 pIpHdr, size_t cbHdrMax, size_t cbPktMax);
215RTDECL(uint32_t) RTNetIPv4PseudoChecksum(PCRTNETIPV4 pIpHdr);
216RTDECL(uint32_t) RTNetIPv4PseudoChecksumBits(RTNETADDRIPV4 SrcAddr, RTNETADDRIPV4 DstAddr, uint8_t bProtocol, uint16_t cbPkt);
217RTDECL(uint32_t) RTNetIPv4AddDataChecksum(void const *pvData, size_t cbData, uint32_t u32Sum, bool *pfOdd);
218RTDECL(uint16_t) RTNetIPv4FinalizeChecksum(uint32_t u32Sum);
219
220
221/**
222 * UDP header.
223 */
224#pragma pack(1)
225typedef struct RTNETUDP
226{
227 /** The source port. */
228 uint16_t uh_sport;
229 /** The destination port. */
230 uint16_t uh_dport;
231 /** The length of the UDP header and associated data. */
232 uint16_t uh_ulen;
233 /** The checksum of the pseudo header, the UDP header and the data. */
234 uint16_t uh_sum;
235} RTNETUDP;
236#pragma pack()
237AssertCompileSize(RTNETUDP, 8);
238/** Pointer to an UDP header. */
239typedef RTNETUDP *PRTNETUDP;
240/** Pointer to a const UDP header. */
241typedef RTNETUDP const *PCRTNETUDP;
242
243/** The minimum UDP packet length (in bytes). (RTNETUDP::uh_ulen) */
244#define RTNETUDP_MIN_LEN (8)
245
246RTDECL(uint32_t) RTNetIPv4AddUDPChecksum(PCRTNETUDP pUdpHdr, uint32_t u32Sum);
247RTDECL(uint16_t) RTNetIPv4UDPChecksum(PCRTNETIPV4 pIpHdr, PCRTNETUDP pUdpHdr, void const *pvData);
248RTDECL(bool) RTNetIPv4IsUDPSizeValid(PCRTNETIPV4 pIpHdr, PCRTNETUDP pUdpHdr, size_t cbPktMax);
249RTDECL(bool) RTNetIPv4IsUDPValid(PCRTNETIPV4 pIpHdr, PCRTNETUDP pUdpHdr, void const *pvData, size_t cbPktMax);
250
251/**
252 * IPv4 BOOTP / DHCP packet.
253 */
254#pragma pack(1)
255typedef struct RTNETBOOTP
256{
257 /** 00 - The packet opcode (RTNETBOOTP_OP_*). */
258 uint8_t bp_op;
259 /** 01 - Hardware address type. Same as RTNETARPHDR::ar_htype. */
260 uint8_t bp_htype;
261 /** 02 - Hardware address length. */
262 uint8_t bp_hlen;
263 /** 03 - Gateway hops. */
264 uint8_t bp_hops;
265 /** 04 - Transaction ID. */
266 uint32_t bp_xid;
267 /** 08 - Seconds since boot started. */
268 uint16_t bp_secs;
269 /** 0a - Unused (BOOTP) / Flags (DHCP) (RTNET_DHCP_FLAGS_*). */
270 uint16_t bp_flags;
271 /** 0c - Client IPv4 address. */
272 RTNETADDRIPV4 bp_ciaddr;
273 /** 10 - Your IPv4 address. */
274 RTNETADDRIPV4 bp_yiaddr;
275 /** 14 - Server IPv4 address. */
276 RTNETADDRIPV4 bp_siaddr;
277 /** 18 - Gateway IPv4 address. */
278 RTNETADDRIPV4 bp_giaddr;
279 /** 1c - Client hardware address. */
280 union
281 {
282 uint8_t au8[16];
283 RTMAC Mac;
284 } bp_chaddr;
285 /** 2c - Server name. */
286 uint8_t bp_sname[64];
287 /** 6c - File name / more DHCP options. */
288 uint8_t bp_file[128];
289 /** ec - Vendor specific area (BOOTP) / Options (DHCP).
290 * @remark This is really 312 bytes in the DHCP version. */
291 union
292 {
293 uint8_t au8[128];
294 struct DHCP
295 {
296 /** ec - The DHCP cookie (RTNET_DHCP_COOKIE). */
297 uint32_t dhcp_cookie;
298 /** f0 - The DHCP options. */
299 uint8_t dhcp_opts[124];
300 } Dhcp;
301 } bp_vend;
302
303} RTNETBOOTP;
304#pragma pack()
305AssertCompileSize(RTNETBOOTP, 0xec + 128);
306/** Pointer to a BOOTP / DHCP packet. */
307typedef RTNETBOOTP *PRTNETBOOTP;
308/** Pointer to a const BOOTP / DHCP packet. */
309typedef RTNETBOOTP const *PCRTNETBOOTP;
310
311/** Minimum BOOTP packet length. For quick validation, no standard thing really. */
312#define RTNETBOOTP_MIN_LEN 0xec
313/** Minimum DHCP packet length. For quick validation, no standard thing really. */
314#define RTNETBOOTP_DHCP_MIN_LEN 0xf1
315
316/** The normal size of the a DHCP packet (i.e. a RTNETBOOTP).
317 * Same as RTNET_DHCP_OPT_SIZE, just expressed differently. */
318#define RTNET_DHCP_NORMAL_SIZE (0xec + 4 + RTNET_DHCP_OPT_SIZE)
319/** The normal size of RTNETBOOTP::bp_vend::Dhcp::dhcp_opts. */
320#define RTNET_DHCP_OPT_SIZE (312 - 4)
321
322/** @name BOOTP packet opcode values
323 * @{ */
324#define RTNETBOOTP_OP_REQUEST 1
325#define RTNETBOOTP_OP_REPLY 2
326/** @} */
327
328/** @name DHCP flags (RTNETBOOTP::bp_flags)
329 * @{ */
330#define RTNET_DHCP_FLAGS_NO_BROADCAST UINT16_C(0x8000) /** @todo check test!!! */
331/** @} */
332
333/** The DHCP cookie (network endian). */
334#define RTNET_DHCP_COOKIE UINT32_C(0x63825363)
335
336/**
337 * An IPv4 DHCP option header.
338 */
339typedef struct RTNETDHCPOPT
340{
341 /** 00 - The DHCP option. */
342 uint8_t dhcp_opt;
343 /** 01 - The data length (excluding this header). */
344 uint8_t dhcp_len;
345 /* 02 - The option data follows here, optional and of variable length. */
346} RTNETDHCPOPT;
347AssertCompileSize(RTNETDHCPOPT, 2);
348/** Pointer to a DHCP option header. */
349typedef RTNETDHCPOPT *PRTNETDHCPOPT;
350/** Pointer to a const DHCP option header. */
351typedef RTNETDHCPOPT const *PCRTNETDHCPOPT;
352
353/** @name DHCP options
354 * @{ */
355/** 1 byte padding, this has no dhcp_len field. */
356#define RTNET_DHCP_OPT_PAD 0
357
358/** The subnet mask. */
359#define RTNET_DHCP_OPT_SUBNET_MASK 1
360/** The time offset. */
361#define RTNET_DHCP_OPT_TIME_OFFSET 2
362/** The routers for the subnet. */
363#define RTNET_DHCP_OPT_ROUTERS 3
364/** Domain Name Server. */
365#define RTNET_DHCP_OPT_DNS 6
366/** Host name. */
367#define RTNET_DHCP_OPT_HOST_NAME 12
368/** Domain name. */
369#define RTNET_DHCP_OPT_DOMAIN_NAME 15
370
371/** The requested address. */
372#define RTNET_DHCP_OPT_REQ_ADDR 50
373/** The lease time in seconds. */
374#define RTNET_DHCP_OPT_LEASE_TIME 51
375/** Option overload.
376 * Indicates that the bp_file and/or bp_sname holds contains DHCP options. */
377#define RTNET_DHCP_OPT_OPTION_OVERLOAD 52
378/** Have a 8-bit message type value as data, see RTNET_DHCP_MT_*. */
379#define RTNET_DHCP_OPT_MSG_TYPE 53
380/** Server ID. */
381#define RTNET_DHCP_OPT_SERVER_ID 54
382/** Parameter request list. */
383#define RTNET_DHCP_OPT_PARAM_REQ_LIST 55
384/** The maximum DHCP message size a client is willing to accept. */
385#define RTNET_DHCP_OPT_MAX_DHCP_MSG_SIZE 57
386/** Client ID. */
387#define RTNET_DHCP_OPT_CLIENT_ID 61
388/** TFTP server name. */
389#define RTNET_DHCP_OPT_TFTP_SERVER_NAME 66
390/** Bootfile name. */
391#define RTNET_DHCP_OPT_BOOTFILE_NAME 67
392
393/** Marks the end of the DHCP options, this has no dhcp_len field. */
394#define RTNET_DHCP_OPT_END 255
395/** @} */
396
397/** @name DHCP Message Types (option 53)
398 * @{ */
399#define RTNET_DHCP_MT_DISCOVER 1
400#define RTNET_DHCP_MT_OFFER 2
401#define RTNET_DHCP_MT_REQUEST 3
402#define RTNET_DHCP_MT_DECLINE 4
403#define RTNET_DHCP_MT_ACK 5
404#define RTNET_DHCP_MT_NAC 6
405#define RTNET_DHCP_MT_RELEASE 7
406#define RTNET_DHCP_MT_INFORM 8
407/** @} */
408
409/** @name DHCP Flags
410 * @{ */
411#define RTNET_DHCP_FLAG_BROADCAST 0x8000
412/** @} */
413
414RTDECL(bool) RTNetIPv4IsDHCPValid(PCRTNETUDP pUdpHdr, PCRTNETBOOTP pDhcp, size_t cbDhcp, uint8_t *pMsgType);
415
416
417/**
418 * IPv4 DHCP packet.
419 * @obsolete Use RTNETBOOTP.
420 */
421#pragma pack(1)
422typedef struct RTNETDHCP
423{
424 /** 00 - The packet opcode. */
425 uint8_t Op;
426 /** Hardware address type. */
427 uint8_t HType;
428 /** Hardware address length. */
429 uint8_t HLen;
430 uint8_t Hops;
431 uint32_t XID;
432 uint16_t Secs;
433 uint16_t Flags;
434 /** Client IPv4 address. */
435 RTNETADDRIPV4 CIAddr;
436 /** Your IPv4 address. */
437 RTNETADDRIPV4 YIAddr;
438 /** Server IPv4 address. */
439 RTNETADDRIPV4 SIAddr;
440 /** Gateway IPv4 address. */
441 RTNETADDRIPV4 GIAddr;
442 /** Client hardware address. */
443 uint8_t CHAddr[16];
444 /** Server name. */
445 uint8_t SName[64];
446 uint8_t File[128];
447 uint8_t abMagic[4];
448 uint8_t DhcpOpt;
449 uint8_t DhcpLen; /* 1 */
450 uint8_t DhcpReq;
451 uint8_t abOptions[57];
452} RTNETDHCP;
453#pragma pack()
454/** @todo AssertCompileSize(RTNETDHCP, ); */
455/** Pointer to a DHCP packet. */
456typedef RTNETDHCP *PRTNETDHCP;
457/** Pointer to a const DHCP packet. */
458typedef RTNETDHCP const *PCRTNETDHCP;
459
460
461/**
462 * TCP packet.
463 */
464#pragma pack(1)
465typedef struct RTNETTCP
466{
467 /** 00 - The source port. */
468 uint16_t th_sport;
469 /** 02 - The destination port. */
470 uint16_t th_dport;
471 /** 04 - The sequence number. */
472 uint32_t th_seq;
473 /** 08 - The acknowledgement number. */
474 uint32_t th_ack;
475#ifdef RT_BIG_ENDIAN
476 unsigned int th_win : 16;
477 unsigned int th_flags : 8;
478 unsigned int th_off : 4;
479 unsigned int th_x2 : 4;
480#else
481 /** 0c:0 - Reserved. */
482 unsigned int th_x2 : 4;
483 /** 0c:4 - The data offset given as a dword count from the start of this header. */
484 unsigned int th_off : 4;
485 /** 0d - flags. */
486 unsigned int th_flags : 8;
487 /** 0e - The window. */
488 unsigned int th_win : 16;
489#endif
490 /** 10 - The checksum of the pseudo header, the TCP header and the data. */
491 uint16_t th_sum;
492 /** 12 - The urgent pointer. */
493 uint16_t th_urp;
494 /* (options follows here and then the data (aka text).) */
495} RTNETTCP;
496#pragma pack()
497AssertCompileSize(RTNETTCP, 20);
498/** Pointer to a TCP packet. */
499typedef RTNETTCP *PRTNETTCP;
500/** Pointer to a const TCP packet. */
501typedef RTNETTCP const *PCRTNETTCP;
502
503/** The minimum TCP header length (in bytes). (RTNETTCP::th_off * 4) */
504#define RTNETTCP_MIN_LEN (20)
505
506RTDECL(uint32_t) RTNetIPv4AddTCPChecksum(PCRTNETTCP pTcpHdr, uint32_t u32Sum);
507RTDECL(uint16_t) RTNetIPv4TCPChecksum(PCRTNETIPV4 pIpHdr, PCRTNETTCP pTcpHdr, void const *pvData);
508RTDECL(bool) RTNetIPv4IsTCPSizeValid(PCRTNETIPV4 pIpHdr, PCRTNETTCP pTcpHdr, size_t cbHdrMax, size_t cbPktMax);
509RTDECL(bool) RTNetIPv4IsTCPValid(PCRTNETIPV4 pIpHdr, PCRTNETTCP pTcpHdr, size_t cbHdrMax, void const *pvData, size_t cbPktMax);
510
511
512/**
513 * IPv4 ICMP packet header.
514 */
515#pragma pack(1)
516typedef struct RTNETICMPV4HDR
517{
518 /** 00 - The ICMP message type. */
519 uint8_t icmp_type;
520 /** 01 - Type specific code that further qualifies the message. */
521 uint8_t icmp_code;
522 /** 02 - Checksum of the ICMP message. */
523 uint16_t icmp_cksum;
524} RTNETICMPV4HDR;
525#pragma pack()
526AssertCompileSize(RTNETICMPV4HDR, 4);
527/** Pointer to an ICMP packet header. */
528typedef RTNETICMPV4HDR *PRTNETICMPV4HDR;
529/** Pointer to a const ICMP packet header. */
530typedef RTNETICMPV4HDR const *PCRTNETICMPV4HDR;
531
532/** @name ICMP (v4) message types.
533 * @{ */
534#define RTNETICMPV4_TYPE_ECHO_REPLY 0
535#define RTNETICMPV4_TYPE_ECHO_REQUEST 8
536#define RTNETICMPV4_TYPE_TRACEROUTE 30
537/** @} */
538
539/**
540 * IPv4 ICMP ECHO Reply & Request packet.
541 */
542#pragma pack(1)
543typedef struct RTNETICMPV4ECHO
544{
545 /** 00 - The ICMP header. */
546 RTNETICMPV4HDR Hdr;
547 /** 04 - The identifier to help the requestor match up the reply.
548 * Can be 0. Typically fixed value. */
549 uint16_t icmp_id;
550 /** 06 - The sequence number to help the requestor match up the reply.
551 * Can be 0. Typically incrementing between requests. */
552 uint16_t icmp_seq;
553 /** 08 - Variable length data that is to be returned unmodified in the reply. */
554 uint8_t icmp_data[1];
555} RTNETICMPV4ECHO;
556#pragma pack()
557AssertCompileSize(RTNETICMPV4ECHO, 9);
558/** Pointer to an ICMP ECHO packet. */
559typedef RTNETICMPV4ECHO *PRTNETICMPV4ECHO;
560/** Pointer to a const ICMP ECHO packet. */
561typedef RTNETICMPV4ECHO const *PCRTNETICMPV4ECHO;
562
563/**
564 * IPv4 ICMP TRACEROUTE packet.
565 * This is an reply to an IP packet with the traceroute option set.
566 */
567#pragma pack(1)
568typedef struct RTNETICMPV4TRACEROUTE
569{
570 /** 00 - The ICMP header. */
571 RTNETICMPV4HDR Hdr;
572 /** 04 - Identifier copied from the traceroute option's ID number. */
573 uint16_t icmp_id;
574 /** 06 - Unused. (Possibly an icmp_seq?) */
575 uint16_t icmp_void;
576 /** 08 - Outbound hop count. From the IP packet causing this message. */
577 uint16_t icmp_ohc;
578 /** 0a - Return hop count. From the IP packet causing this message. */
579 uint16_t icmp_rhc;
580 /** 0c - Output link speed, 0 if not known. */
581 uint32_t icmp_speed;
582 /** 10 - Output link MTU, 0 if not known. */
583 uint32_t icmp_mtu;
584} RTNETICMPV4TRACEROUTE;
585#pragma pack()
586AssertCompileSize(RTNETICMPV4TRACEROUTE, 20);
587/** Pointer to an ICMP TRACEROUTE packet. */
588typedef RTNETICMPV4TRACEROUTE *PRTNETICMPV4TRACEROUTE;
589/** Pointer to a const ICMP TRACEROUTE packet. */
590typedef RTNETICMPV4TRACEROUTE const *PCRTNETICMPV4TRACEROUTE;
591
592/** @todo add more ICMPv4 as needed. */
593
594/**
595 * IPv4 ICMP union packet.
596 */
597typedef union RTNETICMPV4
598{
599 RTNETICMPV4HDR Hdr;
600 RTNETICMPV4ECHO Echo;
601 RTNETICMPV4TRACEROUTE Traceroute;
602} RTNETICMPV4;
603/** Pointer to an ICMP union packet. */
604typedef RTNETICMPV4 *PRTNETICMPV4;
605/** Pointer to a const ICMP union packet. */
606typedef RTNETICMPV4 const *PCRTNETICMPV4;
607
608
609/** @todo add ICMPv6 when needed. */
610
611
612/**
613 * Ethernet ARP header.
614 */
615#pragma pack(1)
616typedef struct RTNETARPHDR
617{
618 /** The hardware type. */
619 uint16_t ar_htype;
620 /** The protocol type (ethertype). */
621 uint16_t ar_ptype;
622 /** The hardware address length. */
623 uint8_t ar_hlen;
624 /** The protocol address length. */
625 uint8_t ar_plen;
626 /** The operation. */
627 uint16_t ar_oper;
628} RTNETARPHDR;
629#pragma pack()
630AssertCompileSize(RTNETARPHDR, 8);
631/** Pointer to an ethernet ARP header. */
632typedef RTNETARPHDR *PRTNETARPHDR;
633/** Pointer to a const ethernet ARP header. */
634typedef RTNETARPHDR const *PCRTNETARPHDR;
635
636/** ARP hardware type - ethernet. */
637#define RTNET_ARP_ETHER UINT16_C(1)
638
639/** @name ARP operations
640 * @{ */
641#define RTNET_ARPOP_REQUEST UINT16_C(1) /**< Request hardware address given a protocol address (ARP). */
642#define RTNET_ARPOP_REPLY UINT16_C(2)
643#define RTNET_ARPOP_REVREQUEST UINT16_C(3) /**< Request protocol address given a hardware address (RARP). */
644#define RTNET_ARPOP_REVREPLY UINT16_C(4)
645#define RTNET_ARPOP_INVREQUEST UINT16_C(8) /**< Inverse ARP. */
646#define RTNET_ARPOP_INVREPLY UINT16_C(9)
647/** Check if an ARP operation is a request or not. */
648#define RTNET_ARPOP_IS_REQUEST(Op) ((Op) & 1)
649/** Check if an ARP operation is a reply or not. */
650#define RTNET_ARPOP_IS_REPLY(Op) (!RTNET_ARPOP_IS_REQUEST(Op))
651/** @} */
652
653
654/**
655 * Ethernet IPv4 + 6-byte MAC ARP request packet.
656 */
657#pragma pack(1)
658typedef struct RTNETARPIPV4
659{
660 /** ARP header. */
661 RTNETARPHDR Hdr;
662 /** The sender hardware address. */
663 RTMAC ar_sha;
664 /** The sender protocol address. */
665 RTNETADDRIPV4 ar_spa;
666 /** The target hardware address. */
667 RTMAC ar_tha;
668 /** The arget protocol address. */
669 RTNETADDRIPV4 ar_tpa;
670} RTNETARPIPV4;
671#pragma pack()
672AssertCompileSize(RTNETARPIPV4, 8+6+4+6+4);
673/** Pointer to an ethernet IPv4+MAC ARP request packet. */
674typedef RTNETARPIPV4 *PRTNETARPIPV4;
675/** Pointer to a const ethernet IPv4+MAC ARP request packet. */
676typedef RTNETARPIPV4 const *PCRTNETARPIPV4;
677
678
679/** @todo RTNETNDP (IPv6)*/
680
681
682/** @} */
683
684__END_DECLS
685
686#endif
687
Note: See TracBrowser for help on using the repository browser.

© 2024 Oracle Support Privacy / Do Not Sell My Info Terms of Use Trademark Policy Automated Access Etiquette