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>
31 #include <netinet/in_systm.h>
32 #ifdef HAVE_NETINET_IN_H
33 # include <netinet/in.h>
40 #ifdef HAVE_ARPA_INET_H
41 # include <arpa/inet.h>
51 #include "wine/ipexport.h"
52 #include "wine/icmpapi.h"
53 #include "debugtools.h"
55 /* Set up endiannes macros for the ip and ip_icmp BSD headers */
57 #define BIG_ENDIAN 4321
60 #define LITTLE_ENDIAN 1234
63 #ifdef WORDS_BIGENDIAN
64 #define BYTE_ORDER BIG_ENDIAN
66 #define BYTE_ORDER LITTLE_ENDIAN
68 #endif /* BYTE_ORDER */
70 #define u_int16_t WORD
71 #define u_int32_t DWORD
73 /* These are BSD headers. We use these here because they are needed on
74 * libc5 Linux systems. On other platforms they are usually simply more
75 * complete than the native stuff, and cause less portability problems
76 * so we use them anyway.
82 DEFAULT_DEBUG_CHANNEL(icmp);
84 /* Define the following macro to use the winsock functions */
88 /* FIXME: should we include winsock.h ???*/
89 SOCKET WINAPI WINSOCK_socket(INT af, INT type, INT protocol);
90 INT WINAPI WINSOCK_sendto(SOCKET s, char *buf, INT len, INT flags, struct sockaddr *to, INT tolen);
91 INT WINAPI WINSOCK_recvfrom(SOCKET s, char *buf,INT len, INT flags, struct sockaddr *from, INT *fromlen32);
92 INT WINAPI WINSOCK_shutdown(SOCKET s, INT how);
97 #define ISOCK_SOCKET SOCKET
98 #define ISOCK_ISVALID(a) ((a)!=INVALID_SOCKET)
99 #define ISOCK_getsockopt(a,b,c,d,e) WINSOCK_getsockopt(a,b,c,d,e)
100 #define ISOCK_recvfrom(a,b,c,d,e,f) WINSOCK_recvfrom(a,b,c,d,e,f)
101 #define ISOCK_select(a,b,c,d,e) WINSOCK_select(a,b,c,d,e)
102 #define ISOCK_sendto(a,b,c,d,e,f) WINSOCK_sendto(a,b,c,d,e,f)
103 #define ISOCK_setsockopt(a,b,c,d,e) WINSOCK_setsockopt(a,b,c,d,e)
104 #define ISOCK_shutdown(a,b) WINSOCK_shutdown(a,b)
105 #define ISOCK_socket(a,b,c) WINSOCK_socket(a,b,c)
107 #define ISOCK_SOCKET int
108 #define ISOCK_ISVALID(a) ((a)>=0)
109 #define ISOCK_getsockopt(a,b,c,d,e) getsockopt(a,b,c,d,e)
110 #define ISOCK_recvfrom(a,b,c,d,e,f) recvfrom(a,b,c,d,e,f)
111 #define ISOCK_select(a,b,c,d,e) select(a,b,c,d,e)
112 #define ISOCK_setsockopt(a,b,c,d,e) setsockopt(a,b,c,d,e)
113 #define ISOCK_sendto(a,b,c,d,e,f) sendto(a,b,c,d,e,f)
114 #define ISOCK_shutdown(a,b) shutdown(a,b)
115 #define ISOCK_socket(a,b,c) socket(a,b,c)
120 IP_OPTION_INFORMATION default_opts;
123 #define IP_OPTS_UNKNOWN 0
124 #define IP_OPTS_DEFAULT 1
125 #define IP_OPTS_CUSTOM 2
127 /* The sequence number is unique process wide, so that all threads
128 * have a distinct sequence number.
130 static LONG icmp_sequence=0;
132 static int in_cksum(u_short *addr, int len)
145 *(u_char *)(&answer) = *(u_char *)w;
149 sum = (sum >> 16) + (sum & 0xffff);
161 /***********************************************************************
164 HANDLE WINAPI IcmpCreateFile(VOID)
168 ISOCK_SOCKET sid=ISOCK_socket(AF_INET,SOCK_RAW,IPPROTO_ICMP);
169 if (!ISOCK_ISVALID(sid)) {
170 MESSAGE("WARNING: Trying to use ICMP will fail unless running as root\n");
171 SetLastError(ERROR_ACCESS_DENIED);
172 return INVALID_HANDLE_VALUE;
175 icp=HeapAlloc(GetProcessHeap(), 0, sizeof(*icp));
177 SetLastError(IP_NO_RESOURCES);
178 return INVALID_HANDLE_VALUE;
181 icp->default_opts.OptionsSize=IP_OPTS_UNKNOWN;
186 /***********************************************************************
189 BOOL WINAPI IcmpCloseHandle(HANDLE IcmpHandle)
191 icmp_t* icp=(icmp_t*)IcmpHandle;
192 if (IcmpHandle==INVALID_HANDLE_VALUE) {
193 /* FIXME: in fact win98 seems to ignore the handle value !!! */
194 SetLastError(ERROR_INVALID_HANDLE);
198 ISOCK_shutdown(icp->sid,2);
199 HeapFree(GetProcessHeap (), 0, icp);
204 /***********************************************************************
207 DWORD WINAPI IcmpSendEcho(
209 IPAddr DestinationAddress,
212 PIP_OPTION_INFORMATION RequestOptions,
218 icmp_t* icp=(icmp_t*)IcmpHandle;
219 unsigned char* reqbuf;
222 struct icmp_echo_reply* ier;
223 struct ip* ip_header;
224 struct icmp* icmp_header;
229 struct timeval timeout,send_time,recv_time;
230 struct sockaddr_in addr;
232 unsigned short id,seq,cksum;
235 if (IcmpHandle==INVALID_HANDLE_VALUE) {
236 /* FIXME: in fact win98 seems to ignore the handle value !!! */
237 SetLastError(ERROR_INVALID_HANDLE);
241 if (ReplySize<sizeof(ICMP_ECHO_REPLY)+ICMP_MINLEN) {
242 SetLastError(IP_BUF_TOO_SMALL);
245 /* check the request size against SO_MAX_MSG_SIZE using getsockopt */
247 /* Prepare the request */
248 id=getpid() & 0xFFFF;
249 seq=InterlockedIncrement(&icmp_sequence) & 0xFFFF;
251 reqsize=ICMP_MINLEN+RequestSize;
252 reqbuf=HeapAlloc(GetProcessHeap(), 0, reqsize);
254 SetLastError(ERROR_OUTOFMEMORY);
258 icmp_header=(struct icmp*)reqbuf;
259 icmp_header->icmp_type=ICMP_ECHO;
260 icmp_header->icmp_code=0;
261 icmp_header->icmp_cksum=0;
262 icmp_header->icmp_id=id;
263 icmp_header->icmp_seq=seq;
264 memcpy(reqbuf+ICMP_MINLEN, RequestData, RequestSize);
265 icmp_header->icmp_cksum=cksum=in_cksum((u_short*)reqbuf,reqsize);
267 addr.sin_family=AF_INET;
268 addr.sin_addr.s_addr=DestinationAddress;
271 if (RequestOptions!=NULL) {
273 if (icp->default_opts.OptionsSize==IP_OPTS_UNKNOWN) {
275 /* Before we mess with the options, get the default values */
277 ISOCK_getsockopt(icp->sid,IPPROTO_IP,IP_TTL,(char *)&val,&len);
278 icp->default_opts.Ttl=val;
281 ISOCK_getsockopt(icp->sid,IPPROTO_IP,IP_TOS,(char *)&val,&len);
282 icp->default_opts.Tos=val;
283 /* FIXME: missing: handling of IP 'flags', and all the other options */
286 val=RequestOptions->Ttl;
287 ISOCK_setsockopt(icp->sid,IPPROTO_IP,IP_TTL,(char *)&val,sizeof(val));
288 val=RequestOptions->Tos;
289 ISOCK_setsockopt(icp->sid,IPPROTO_IP,IP_TOS,(char *)&val,sizeof(val));
290 /* FIXME: missing: handling of IP 'flags', and all the other options */
292 icp->default_opts.OptionsSize=IP_OPTS_CUSTOM;
293 } else if (icp->default_opts.OptionsSize==IP_OPTS_CUSTOM) {
296 /* Restore the default options */
297 val=icp->default_opts.Ttl;
298 ISOCK_setsockopt(icp->sid,IPPROTO_IP,IP_TTL,(char *)&val,sizeof(val));
299 val=icp->default_opts.Tos;
300 ISOCK_setsockopt(icp->sid,IPPROTO_IP,IP_TOS,(char *)&val,sizeof(val));
301 /* FIXME: missing: handling of IP 'flags', and all the other options */
303 icp->default_opts.OptionsSize=IP_OPTS_DEFAULT;
306 /* Get ready for receiving the reply
307 * Do it before we send the request to minimize the risk of introducing delays
310 FD_SET(icp->sid,&fdr);
311 timeout.tv_sec=Timeout/1000;
312 timeout.tv_usec=(Timeout % 1000)*1000;
313 addrlen=sizeof(addr);
315 ip_header=(struct ip *) ((char *) ReplyBuffer+sizeof(ICMP_ECHO_REPLY));
316 endbuf=(char *) ReplyBuffer+ReplySize;
317 maxlen=ReplySize-sizeof(ICMP_ECHO_REPLY);
319 /* Send the packet */
320 TRACE("Sending %d bytes (RequestSize=%d) to %s\n", reqsize, RequestSize, inet_ntoa(addr.sin_addr));
323 unsigned char* buf=(unsigned char*)reqbuf;
325 printf("Output buffer:\n");
326 for (i=0;i<reqsize;i++)
327 printf("%2x,", buf[i]);
332 gettimeofday(&send_time,NULL);
333 res=ISOCK_sendto(icp->sid, reqbuf, reqsize, 0, (struct sockaddr*)&addr, sizeof(addr));
334 HeapFree(GetProcessHeap (), 0, reqbuf);
337 SetLastError(IP_PACKET_TOO_BIG);
341 SetLastError(IP_DEST_NET_UNREACHABLE);
344 SetLastError(IP_DEST_NET_UNREACHABLE);
347 TRACE("unknown error: errno=%d\n",errno);
348 SetLastError(ERROR_UNKNOWN);
355 ip_header_len=0; /* because gcc was complaining */
356 while ((res=ISOCK_select(icp->sid+1,&fdr,NULL,NULL,&timeout))>0) {
357 gettimeofday(&recv_time,NULL);
358 res=ISOCK_recvfrom(icp->sid, (char*)ip_header, maxlen, 0, (struct sockaddr*)&addr,&addrlen);
359 TRACE("received %d bytes from %s\n",res, inet_ntoa(addr.sin_addr));
360 ier->Status=IP_REQ_TIMED_OUT;
362 /* Check whether we should ignore this packet */
363 if ((ip_header->ip_p==IPPROTO_ICMP) && (res>=sizeof(struct ip)+ICMP_MINLEN)) {
364 ip_header_len=ip_header->ip_hl << 2;
365 icmp_header=(struct icmp*)(((char*)ip_header)+ip_header_len);
366 TRACE("received an ICMP packet of type,code=%d,%d\n",icmp_header->icmp_type,icmp_header->icmp_code);
367 if (icmp_header->icmp_type==ICMP_ECHOREPLY) {
368 if ((icmp_header->icmp_id==id) && (icmp_header->icmp_seq==seq))
369 ier->Status=IP_SUCCESS;
371 switch (icmp_header->icmp_type) {
373 switch (icmp_header->icmp_code) {
374 case ICMP_UNREACH_HOST:
375 #ifdef ICMP_UNREACH_HOST_UNKNOWN
376 case ICMP_UNREACH_HOST_UNKNOWN:
378 #ifdef ICMP_UNREACH_ISOLATED
379 case ICMP_UNREACH_ISOLATED:
381 #ifdef ICMP_UNREACH_HOST_PROHIB
382 case ICMP_UNREACH_HOST_PROHIB:
384 #ifdef ICMP_UNREACH_TOSHOST
385 case ICMP_UNREACH_TOSHOST:
387 ier->Status=IP_DEST_HOST_UNREACHABLE;
389 case ICMP_UNREACH_PORT:
390 ier->Status=IP_DEST_PORT_UNREACHABLE;
392 case ICMP_UNREACH_PROTOCOL:
393 ier->Status=IP_DEST_PROT_UNREACHABLE;
395 case ICMP_UNREACH_SRCFAIL:
396 ier->Status=IP_BAD_ROUTE;
399 ier->Status=IP_DEST_NET_UNREACHABLE;
403 if (icmp_header->icmp_code==ICMP_TIMXCEED_REASS)
404 ier->Status=IP_TTL_EXPIRED_REASSEM;
406 ier->Status=IP_TTL_EXPIRED_TRANSIT;
409 ier->Status=IP_PARAM_PROBLEM;
411 case ICMP_SOURCEQUENCH:
412 ier->Status=IP_SOURCE_QUENCH;
415 if (ier->Status!=IP_REQ_TIMED_OUT) {
416 struct ip* rep_ip_header;
417 struct icmp* rep_icmp_header;
418 /* The ICMP header size of all the packets we accept is the same */
419 rep_ip_header=(struct ip*)(((char*)icmp_header)+ICMP_MINLEN);
420 rep_icmp_header=(struct icmp*)(((char*)rep_ip_header)+(rep_ip_header->ip_hl << 2));
422 /* Make sure that this is really a reply to our packet */
423 if (ip_header_len+ICMP_MINLEN+(rep_ip_header->ip_hl << 2)+ICMP_MINLEN>ip_header->ip_len) {
424 ier->Status=IP_REQ_TIMED_OUT;
425 } else if ((rep_icmp_header->icmp_type!=ICMP_ECHO) ||
426 (rep_icmp_header->icmp_code!=0) ||
427 (rep_icmp_header->icmp_id!=id) ||
428 (rep_icmp_header->icmp_seq!=seq) ||
429 (rep_icmp_header->icmp_cksum!=cksum)) {
430 /* This was not a reply to one of our packets after all */
431 TRACE("skipping type,code=%d,%d id,seq=%d,%d cksum=%d\n",
432 rep_icmp_header->icmp_type,rep_icmp_header->icmp_code,
433 rep_icmp_header->icmp_id,rep_icmp_header->icmp_seq,
434 rep_icmp_header->icmp_cksum);
435 TRACE("expected type,code=8,0 id,seq=%d,%d cksum=%d\n",
438 ier->Status=IP_REQ_TIMED_OUT;
444 if (ier->Status==IP_REQ_TIMED_OUT) {
445 /* This packet was not for us.
446 * Decrease the timeout so that we don't enter an endless loop even
447 * if we get flooded with ICMP packets that are not for us.
449 timeout.tv_sec=Timeout/1000-(recv_time.tv_sec-send_time.tv_sec);
450 timeout.tv_usec=(Timeout % 1000)*1000+send_time.tv_usec-(recv_time.tv_usec-send_time.tv_usec);
451 if (timeout.tv_usec<0) {
452 timeout.tv_usec+=1000000;
457 /* This is a reply to our packet */
458 memcpy(&ier->Address,&ip_header->ip_src,sizeof(IPAddr));
459 /* Status is already set */
460 ier->RoundTripTime=(recv_time.tv_sec-send_time.tv_sec)*1000+(recv_time.tv_usec-send_time.tv_usec)/1000;
461 ier->DataSize=res-ip_header_len-ICMP_MINLEN;
463 ier->Data=endbuf-ier->DataSize;
464 memmove(ier->Data,((char*)ip_header)+ip_header_len+ICMP_MINLEN,ier->DataSize);
465 ier->Options.Ttl=ip_header->ip_ttl;
466 ier->Options.Tos=ip_header->ip_tos;
467 ier->Options.Flags=ip_header->ip_off >> 13;
468 ier->Options.OptionsSize=ip_header_len-sizeof(struct ip);
469 if (ier->Options.OptionsSize!=0) {
470 ier->Options.OptionsData=(unsigned char *) ier->Data-ier->Options.OptionsSize;
471 /* FIXME: We are supposed to rearrange the option's 'source route' data */
472 memmove(ier->Options.OptionsData,((char*)ip_header)+ip_header_len,ier->Options.OptionsSize);
473 endbuf=ier->Options.OptionsData;
475 ier->Options.OptionsData=NULL;
479 /* Prepare for the next packet */
481 ip_header=(struct ip*)(((char*)ip_header)+sizeof(ICMP_ECHO_REPLY));
482 maxlen=endbuf-(char*)ip_header;
484 /* Check out whether there is more but don't wait this time */
489 FD_SET(icp->sid,&fdr);
491 res=ier-(ICMP_ECHO_REPLY*)ReplyBuffer;
493 SetLastError(IP_REQ_TIMED_OUT);
494 TRACE("received %d replies\n",res);
499 * Copyright (c) 1989 The Regents of the University of California.
500 * All rights reserved.
502 * This code is derived from software contributed to Berkeley by
505 * Redistribution and use in source and binary forms, with or without
506 * modification, are permitted provided that the following conditions
508 * 1. Redistributions of source code must retain the above copyright
509 * notice, this list of conditions and the following disclaimer.
510 * 2. Redistributions in binary form must reproduce the above copyright
511 * notice, this list of conditions and the following disclaimer in the
512 * documentation and/or other materials provided with the distribution.
513 * 3. All advertising materials mentioning features or use of this software
514 * must display the following acknowledgement:
515 * This product includes software developed by the University of
516 * California, Berkeley and its contributors.
517 * 4. Neither the name of the University nor the names of its contributors
518 * may be used to endorse or promote products derived from this software
519 * without specific prior written permission.
521 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
522 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
523 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
524 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
525 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
526 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
527 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
528 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
529 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
530 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF