4 * Francois Gouget, 1999, based on the work of
5 * RW Hall, 1999, based on public domain code PING.C by Mike Muus (1983)
6 * and later works (c) 1989 Regents of Univ. of California - see copyright
7 * notice at end of source-code.
11 * - Systems like FreeBSD don't seem to support the IP_TTL option and maybe others.
12 * But using IP_HDRINCL and building the IP header by hand might work.
13 * - Not all IP options are supported.
14 * - Are ICMP handles real handles, i.e. inheritable and all? There might be some
15 * more work to do here, including server side stuff with synchronization.
16 * - Is it correct to use malloc for the internal buffer, for allocating the
18 * - This API should probably be thread safe. Is it really?
19 * - Using the winsock functions has not been tested.
24 #include <sys/types.h>
25 #ifdef HAVE_SYS_SOCKET_H
26 # include <sys/socket.h>
29 #include <netinet/in_systm.h>
30 #ifdef HAVE_NETINET_IN_H
31 # include <netinet/in.h>
39 #ifdef HAVE_ARPA_INET_H
40 # include <arpa/inet.h>
50 #include "wine/ipexport.h"
51 #include "wine/icmpapi.h"
52 #include "debugtools.h"
54 /* Set up endiannes macros for the ip and ip_icmp BSD headers */
56 #define BIG_ENDIAN 4321
59 #define LITTLE_ENDIAN 1234
62 #ifdef WORDS_BIGENDIAN
63 #define BYTE_ORDER BIG_ENDIAN
65 #define BYTE_ORDER LITTLE_ENDIAN
67 #endif /* BYTE_ORDER */
69 #define u_int16_t WORD
70 #define u_int32_t DWORD
72 /* These are BSD headers. We use these here because they are needed on
73 * libc5 Linux systems. On other platforms they are usually simply more
74 * complete than the native stuff, and cause less portability problems
75 * so we use them anyway.
81 DEFAULT_DEBUG_CHANNEL(icmp
)
83 /* Define the following macro to use the winsock functions */
87 /* FIXME: should we include winsock.h ???*/
88 SOCKET WINAPI
WINSOCK_socket(INT af
, INT type
, INT protocol
);
89 INT WINAPI
WINSOCK_sendto(SOCKET s
, char *buf
, INT len
, INT flags
, struct sockaddr
*to
, INT tolen
);
90 INT WINAPI
WINSOCK_recvfrom(SOCKET s
, char *buf
,INT len
, INT flags
, struct sockaddr
*from
, INT
*fromlen32
);
91 INT WINAPI
WINSOCK_shutdown(SOCKET s
, INT how
);
96 #define ISOCK_SOCKET SOCKET
97 #define ISOCK_ISVALID(a) ((a)!=INVALID_SOCKET)
98 #define ISOCK_getsockopt(a,b,c,d,e) WINSOCK_getsockopt(a,b,c,d,e)
99 #define ISOCK_recvfrom(a,b,c,d,e,f) WINSOCK_recvfrom(a,b,c,d,e,f)
100 #define ISOCK_select(a,b,c,d,e) WINSOCK_select(a,b,c,d,e)
101 #define ISOCK_sendto(a,b,c,d,e,f) WINSOCK_sendto(a,b,c,d,e,f)
102 #define ISOCK_setsockopt(a,b,c,d,e) WINSOCK_setsockopt(a,b,c,d,e)
103 #define ISOCK_shutdown(a,b) WINSOCK_shutdown(a,b)
104 #define ISOCK_socket(a,b,c) WINSOCK_socket(a,b,c)
106 #define ISOCK_SOCKET int
107 #define ISOCK_ISVALID(a) ((a)>=0)
108 #define ISOCK_getsockopt(a,b,c,d,e) getsockopt(a,b,c,d,e)
109 #define ISOCK_recvfrom(a,b,c,d,e,f) recvfrom(a,b,c,d,e,f)
110 #define ISOCK_select(a,b,c,d,e) select(a,b,c,d,e)
111 #define ISOCK_setsockopt(a,b,c,d,e) setsockopt(a,b,c,d,e)
112 #define ISOCK_sendto(a,b,c,d,e,f) sendto(a,b,c,d,e,f)
113 #define ISOCK_shutdown(a,b) shutdown(a,b)
114 #define ISOCK_socket(a,b,c) socket(a,b,c)
119 IP_OPTION_INFORMATION default_opts
;
122 #define IP_OPTS_UNKNOWN 0
123 #define IP_OPTS_DEFAULT 1
124 #define IP_OPTS_CUSTOM 2
126 /* The sequence number is unique process wide, so that all threads
127 * have a distinct sequence number.
129 static LONG icmp_sequence
=0;
131 static int in_cksum(u_short
*addr
, int len
)
144 *(u_char
*)(&answer
) = *(u_char
*)w
;
148 sum
= (sum
>> 16) + (sum
& 0xffff);
160 HANDLE WINAPI
IcmpCreateFile(VOID
)
164 ISOCK_SOCKET sid
=ISOCK_socket(AF_INET
,SOCK_RAW
,IPPROTO_ICMP
);
165 if (!ISOCK_ISVALID(sid
)) {
166 MESSAGE("WARNING: Trying to use ICMP will fail unless running as root\n");
167 SetLastError(ERROR_ACCESS_DENIED
);
168 return INVALID_HANDLE_VALUE
;
171 icp
=malloc(sizeof(*icp
));
173 SetLastError(IP_NO_RESOURCES
);
174 return INVALID_HANDLE_VALUE
;
177 icp
->default_opts
.OptionsSize
=IP_OPTS_UNKNOWN
;
182 BOOL WINAPI
IcmpCloseHandle(HANDLE IcmpHandle
)
184 icmp_t
* icp
=(icmp_t
*)IcmpHandle
;
185 if (IcmpHandle
==INVALID_HANDLE_VALUE
) {
186 /* FIXME: in fact win98 seems to ignore the handle value !!! */
187 SetLastError(ERROR_INVALID_HANDLE
);
191 ISOCK_shutdown(icp
->sid
,2);
197 DWORD WINAPI
IcmpSendEcho(
199 IPAddr DestinationAddress
,
202 PIP_OPTION_INFORMATION RequestOptions
,
208 icmp_t
* icp
=(icmp_t
*)IcmpHandle
;
209 unsigned char* reqbuf
;
212 struct icmp_echo_reply
* ier
;
213 struct ip
* ip_header
;
214 struct icmp
* icmp_header
;
219 struct timeval timeout
,send_time
,recv_time
;
220 struct sockaddr_in addr
;
222 unsigned short id
,seq
,cksum
;
225 if (IcmpHandle
==INVALID_HANDLE_VALUE
) {
226 /* FIXME: in fact win98 seems to ignore the handle value !!! */
227 SetLastError(ERROR_INVALID_HANDLE
);
231 if (ReplySize
<sizeof(ICMP_ECHO_REPLY
)+ICMP_MINLEN
) {
232 SetLastError(IP_BUF_TOO_SMALL
);
235 /* check the request size against SO_MAX_MSG_SIZE using getsockopt */
237 /* Prepare the request */
238 id
=getpid() & 0xFFFF;
239 seq
=InterlockedIncrement(&icmp_sequence
) & 0xFFFF;
241 reqsize
=ICMP_MINLEN
+RequestSize
;
242 reqbuf
=malloc(reqsize
);
244 SetLastError(ERROR_OUTOFMEMORY
);
248 icmp_header
=(struct icmp
*)reqbuf
;
249 icmp_header
->icmp_type
=ICMP_ECHO
;
250 icmp_header
->icmp_code
=0;
251 icmp_header
->icmp_cksum
=0;
252 icmp_header
->icmp_id
=id
;
253 icmp_header
->icmp_seq
=seq
;
254 memcpy(reqbuf
+ICMP_MINLEN
, RequestData
, RequestSize
);
255 icmp_header
->icmp_cksum
=cksum
=in_cksum((u_short
*)reqbuf
,reqsize
);
257 addr
.sin_family
=AF_INET
;
258 addr
.sin_addr
.s_addr
=DestinationAddress
;
261 if (RequestOptions
!=NULL
) {
263 if (icp
->default_opts
.OptionsSize
==IP_OPTS_UNKNOWN
) {
265 /* Before we mess with the options, get the default values */
267 ISOCK_getsockopt(icp
->sid
,IPPROTO_IP
,IP_TTL
,(char *)&val
,&len
);
268 icp
->default_opts
.Ttl
=val
;
271 ISOCK_getsockopt(icp
->sid
,IPPROTO_IP
,IP_TOS
,(char *)&val
,&len
);
272 icp
->default_opts
.Tos
=val
;
273 /* FIXME: missing: handling of IP 'flags', and all the other options */
276 val
=RequestOptions
->Ttl
;
277 ISOCK_setsockopt(icp
->sid
,IPPROTO_IP
,IP_TTL
,(char *)&val
,sizeof(val
));
278 val
=RequestOptions
->Tos
;
279 ISOCK_setsockopt(icp
->sid
,IPPROTO_IP
,IP_TOS
,(char *)&val
,sizeof(val
));
280 /* FIXME: missing: handling of IP 'flags', and all the other options */
282 icp
->default_opts
.OptionsSize
=IP_OPTS_CUSTOM
;
283 } else if (icp
->default_opts
.OptionsSize
==IP_OPTS_CUSTOM
) {
286 /* Restore the default options */
287 val
=icp
->default_opts
.Ttl
;
288 ISOCK_setsockopt(icp
->sid
,IPPROTO_IP
,IP_TTL
,(char *)&val
,sizeof(val
));
289 val
=icp
->default_opts
.Tos
;
290 ISOCK_setsockopt(icp
->sid
,IPPROTO_IP
,IP_TOS
,(char *)&val
,sizeof(val
));
291 /* FIXME: missing: handling of IP 'flags', and all the other options */
293 icp
->default_opts
.OptionsSize
=IP_OPTS_DEFAULT
;
296 /* Get ready for receiving the reply
297 * Do it before we send the request to minimize the risk of introducing delays
300 FD_SET(icp
->sid
,&fdr
);
301 timeout
.tv_sec
=Timeout
/1000;
302 timeout
.tv_usec
=(Timeout
% 1000)*1000;
303 addrlen
=sizeof(addr
);
305 ip_header
=ReplyBuffer
+sizeof(ICMP_ECHO_REPLY
);
306 endbuf
=ReplyBuffer
+ReplySize
;
307 maxlen
=ReplySize
-sizeof(ICMP_ECHO_REPLY
);
309 /* Send the packet */
310 TRACE("Sending %d bytes (RequestSize=%d) to %s\n", reqsize
, RequestSize
, inet_ntoa(addr
.sin_addr
));
313 unsigned char* buf
=(unsigned char*)reqbuf
;
315 printf("Output buffer:\n");
316 for (i
=0;i
<reqsize
;i
++)
317 printf("%2x,", buf
[i
]);
322 gettimeofday(&send_time
,NULL
);
323 res
=ISOCK_sendto(icp
->sid
, reqbuf
, reqsize
, 0, (struct sockaddr
*)&addr
, sizeof(addr
));
327 SetLastError(IP_PACKET_TOO_BIG
);
331 SetLastError(IP_DEST_NET_UNREACHABLE
);
334 SetLastError(IP_DEST_NET_UNREACHABLE
);
337 TRACE("unknown error: errno=%d\n",errno
);
338 SetLastError(ERROR_UNKNOWN
);
345 ip_header_len
=0; /* because gcc was complaining */
346 while ((res
=ISOCK_select(icp
->sid
+1,&fdr
,NULL
,NULL
,&timeout
))>0) {
347 gettimeofday(&recv_time
,NULL
);
348 res
=ISOCK_recvfrom(icp
->sid
, (char*)ip_header
, maxlen
, 0, (struct sockaddr
*)&addr
,&addrlen
);
349 TRACE("received %d bytes from %s\n",res
, inet_ntoa(addr
.sin_addr
));
350 ier
->Status
=IP_REQ_TIMED_OUT
;
352 /* Check whether we should ignore this packet */
353 if ((ip_header
->ip_p
==IPPROTO_ICMP
) && (res
>=sizeof(struct ip
)+ICMP_MINLEN
)) {
354 ip_header_len
=ip_header
->ip_hl
<< 2;
355 icmp_header
=(struct icmp
*)(((char*)ip_header
)+ip_header_len
);
356 TRACE("received an ICMP packet of type,code=%d,%d\n",icmp_header
->icmp_type
,icmp_header
->icmp_code
);
357 if (icmp_header
->icmp_type
==ICMP_ECHOREPLY
) {
358 if ((icmp_header
->icmp_id
==id
) && (icmp_header
->icmp_seq
==seq
))
359 ier
->Status
=IP_SUCCESS
;
361 switch (icmp_header
->icmp_type
) {
363 switch (icmp_header
->icmp_code
) {
364 case ICMP_UNREACH_HOST
:
365 #ifdef ICMP_UNREACH_HOST_UNKNOWN
366 case ICMP_UNREACH_HOST_UNKNOWN
:
368 #ifdef ICMP_UNREACH_ISOLATED
369 case ICMP_UNREACH_ISOLATED
:
371 #ifdef ICMP_UNREACH_HOST_PROHIB
372 case ICMP_UNREACH_HOST_PROHIB
:
374 #ifdef ICMP_UNREACH_TOSHOST
375 case ICMP_UNREACH_TOSHOST
:
377 ier
->Status
=IP_DEST_HOST_UNREACHABLE
;
379 case ICMP_UNREACH_PORT
:
380 ier
->Status
=IP_DEST_PORT_UNREACHABLE
;
382 case ICMP_UNREACH_PROTOCOL
:
383 ier
->Status
=IP_DEST_PROT_UNREACHABLE
;
385 case ICMP_UNREACH_SRCFAIL
:
386 ier
->Status
=IP_BAD_ROUTE
;
389 ier
->Status
=IP_DEST_NET_UNREACHABLE
;
393 if (icmp_header
->icmp_code
==ICMP_TIMXCEED_REASS
)
394 ier
->Status
=IP_TTL_EXPIRED_REASSEM
;
396 ier
->Status
=IP_TTL_EXPIRED_TRANSIT
;
399 ier
->Status
=IP_PARAM_PROBLEM
;
401 case ICMP_SOURCEQUENCH
:
402 ier
->Status
=IP_SOURCE_QUENCH
;
405 if (ier
->Status
!=IP_REQ_TIMED_OUT
) {
406 struct ip
* rep_ip_header
;
407 struct icmp
* rep_icmp_header
;
408 /* The ICMP header size of all the packets we accept is the same */
409 rep_ip_header
=(struct ip
*)(((char*)icmp_header
)+ICMP_MINLEN
);
410 rep_icmp_header
=(struct icmp
*)(((char*)rep_ip_header
)+(rep_ip_header
->ip_hl
<< 2));
412 /* Make sure that this is really a reply to our packet */
413 if (ip_header_len
+ICMP_MINLEN
+(rep_ip_header
->ip_hl
<< 2)+ICMP_MINLEN
>ip_header
->ip_len
) {
414 ier
->Status
=IP_REQ_TIMED_OUT
;
415 } else if ((rep_icmp_header
->icmp_type
!=ICMP_ECHO
) ||
416 (rep_icmp_header
->icmp_code
!=0) ||
417 (rep_icmp_header
->icmp_id
!=id
) ||
418 (rep_icmp_header
->icmp_seq
!=seq
) ||
419 (rep_icmp_header
->icmp_cksum
!=cksum
)) {
420 /* This was not a reply to one of our packets after all */
421 TRACE("skipping type,code=%d,%d id,seq=%d,%d cksum=%d\n",
422 rep_icmp_header
->icmp_type
,rep_icmp_header
->icmp_code
,
423 rep_icmp_header
->icmp_id
,rep_icmp_header
->icmp_seq
,
424 rep_icmp_header
->icmp_cksum
);
425 TRACE("expected type,code=8,0 id,seq=%d,%d cksum=%d\n",
428 ier
->Status
=IP_REQ_TIMED_OUT
;
434 if (ier
->Status
==IP_REQ_TIMED_OUT
) {
435 /* This packet was not for us.
436 * Decrease the timeout so that we don't enter an endless loop even
437 * if we get flooded with ICMP packets that are not for us.
439 timeout
.tv_sec
=Timeout
/1000-(recv_time
.tv_sec
-send_time
.tv_sec
);
440 timeout
.tv_usec
=(Timeout
% 1000)*1000+send_time
.tv_usec
-(recv_time
.tv_usec
-send_time
.tv_usec
);
441 if (timeout
.tv_usec
<0) {
442 timeout
.tv_usec
+=1000000;
447 /* This is a reply to our packet */
448 memcpy(&ier
->Address
,&ip_header
->ip_src
,sizeof(IPAddr
));
449 /* Status is already set */
450 ier
->RoundTripTime
=(recv_time
.tv_sec
-send_time
.tv_sec
)*1000+(recv_time
.tv_usec
-send_time
.tv_usec
)/1000;
451 ier
->DataSize
=res
-ip_header_len
-ICMP_MINLEN
;
453 ier
->Data
=endbuf
-ier
->DataSize
;
454 memmove(ier
->Data
,((char*)ip_header
)+ip_header_len
+ICMP_MINLEN
,ier
->DataSize
);
455 ier
->Options
.Ttl
=ip_header
->ip_ttl
;
456 ier
->Options
.Tos
=ip_header
->ip_tos
;
457 ier
->Options
.Flags
=ip_header
->ip_off
>> 13;
458 ier
->Options
.OptionsSize
=ip_header_len
-sizeof(struct ip
);
459 if (ier
->Options
.OptionsSize
!=0) {
460 ier
->Options
.OptionsData
=ier
->Data
-ier
->Options
.OptionsSize
;
461 /* FIXME: We are supposed to rearrange the option's 'source route' data */
462 memmove(ier
->Options
.OptionsData
,((char*)ip_header
)+ip_header_len
,ier
->Options
.OptionsSize
);
463 endbuf
=ier
->Options
.OptionsData
;
465 ier
->Options
.OptionsData
=NULL
;
469 /* Prepare for the next packet */
471 ip_header
=(struct ip
*)(((char*)ip_header
)+sizeof(ICMP_ECHO_REPLY
));
472 maxlen
=endbuf
-(char*)ip_header
;
474 /* Check out whether there is more but don't wait this time */
479 FD_SET(icp
->sid
,&fdr
);
481 res
=ier
-(ICMP_ECHO_REPLY
*)ReplyBuffer
;
483 SetLastError(IP_REQ_TIMED_OUT
);
484 TRACE("received %d replies\n",res
);
489 * Copyright (c) 1989 The Regents of the University of California.
490 * All rights reserved.
492 * This code is derived from software contributed to Berkeley by
495 * Redistribution and use in source and binary forms, with or without
496 * modification, are permitted provided that the following conditions
498 * 1. Redistributions of source code must retain the above copyright
499 * notice, this list of conditions and the following disclaimer.
500 * 2. Redistributions in binary form must reproduce the above copyright
501 * notice, this list of conditions and the following disclaimer in the
502 * documentation and/or other materials provided with the distribution.
503 * 3. All advertising materials mentioning features or use of this software
504 * must display the following acknowledgement:
505 * This product includes software developed by the University of
506 * California, Berkeley and its contributors.
507 * 4. Neither the name of the University nor the names of its contributors
508 * may be used to endorse or promote products derived from this software
509 * without specific prior written permission.
511 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
512 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
513 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
514 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
515 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
516 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
517 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
518 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
519 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
520 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF