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 /***********************************************************************
163 HANDLE WINAPI IcmpCreateFile(VOID)
167 ISOCK_SOCKET sid=ISOCK_socket(AF_INET,SOCK_RAW,IPPROTO_ICMP);
168 if (!ISOCK_ISVALID(sid)) {
169 MESSAGE("WARNING: Trying to use ICMP will fail unless running as root\n");
170 SetLastError(ERROR_ACCESS_DENIED);
171 return INVALID_HANDLE_VALUE;
174 icp=malloc(sizeof(*icp));
176 SetLastError(IP_NO_RESOURCES);
177 return INVALID_HANDLE_VALUE;
180 icp->default_opts.OptionsSize=IP_OPTS_UNKNOWN;
185 /***********************************************************************
188 BOOL WINAPI IcmpCloseHandle(HANDLE IcmpHandle)
190 icmp_t* icp=(icmp_t*)IcmpHandle;
191 if (IcmpHandle==INVALID_HANDLE_VALUE) {
192 /* FIXME: in fact win98 seems to ignore the handle value !!! */
193 SetLastError(ERROR_INVALID_HANDLE);
197 ISOCK_shutdown(icp->sid,2);
203 /***********************************************************************
206 DWORD WINAPI IcmpSendEcho(
208 IPAddr DestinationAddress,
211 PIP_OPTION_INFORMATION RequestOptions,
217 icmp_t* icp=(icmp_t*)IcmpHandle;
218 unsigned char* reqbuf;
221 struct icmp_echo_reply* ier;
222 struct ip* ip_header;
223 struct icmp* icmp_header;
228 struct timeval timeout,send_time,recv_time;
229 struct sockaddr_in addr;
231 unsigned short id,seq,cksum;
234 if (IcmpHandle==INVALID_HANDLE_VALUE) {
235 /* FIXME: in fact win98 seems to ignore the handle value !!! */
236 SetLastError(ERROR_INVALID_HANDLE);
240 if (ReplySize<sizeof(ICMP_ECHO_REPLY)+ICMP_MINLEN) {
241 SetLastError(IP_BUF_TOO_SMALL);
244 /* check the request size against SO_MAX_MSG_SIZE using getsockopt */
246 /* Prepare the request */
247 id=getpid() & 0xFFFF;
248 seq=InterlockedIncrement(&icmp_sequence) & 0xFFFF;
250 reqsize=ICMP_MINLEN+RequestSize;
251 reqbuf=malloc(reqsize);
253 SetLastError(ERROR_OUTOFMEMORY);
257 icmp_header=(struct icmp*)reqbuf;
258 icmp_header->icmp_type=ICMP_ECHO;
259 icmp_header->icmp_code=0;
260 icmp_header->icmp_cksum=0;
261 icmp_header->icmp_id=id;
262 icmp_header->icmp_seq=seq;
263 memcpy(reqbuf+ICMP_MINLEN, RequestData, RequestSize);
264 icmp_header->icmp_cksum=cksum=in_cksum((u_short*)reqbuf,reqsize);
266 addr.sin_family=AF_INET;
267 addr.sin_addr.s_addr=DestinationAddress;
270 if (RequestOptions!=NULL) {
272 if (icp->default_opts.OptionsSize==IP_OPTS_UNKNOWN) {
274 /* Before we mess with the options, get the default values */
276 ISOCK_getsockopt(icp->sid,IPPROTO_IP,IP_TTL,(char *)&val,&len);
277 icp->default_opts.Ttl=val;
280 ISOCK_getsockopt(icp->sid,IPPROTO_IP,IP_TOS,(char *)&val,&len);
281 icp->default_opts.Tos=val;
282 /* FIXME: missing: handling of IP 'flags', and all the other options */
285 val=RequestOptions->Ttl;
286 ISOCK_setsockopt(icp->sid,IPPROTO_IP,IP_TTL,(char *)&val,sizeof(val));
287 val=RequestOptions->Tos;
288 ISOCK_setsockopt(icp->sid,IPPROTO_IP,IP_TOS,(char *)&val,sizeof(val));
289 /* FIXME: missing: handling of IP 'flags', and all the other options */
291 icp->default_opts.OptionsSize=IP_OPTS_CUSTOM;
292 } else if (icp->default_opts.OptionsSize==IP_OPTS_CUSTOM) {
295 /* Restore the default options */
296 val=icp->default_opts.Ttl;
297 ISOCK_setsockopt(icp->sid,IPPROTO_IP,IP_TTL,(char *)&val,sizeof(val));
298 val=icp->default_opts.Tos;
299 ISOCK_setsockopt(icp->sid,IPPROTO_IP,IP_TOS,(char *)&val,sizeof(val));
300 /* FIXME: missing: handling of IP 'flags', and all the other options */
302 icp->default_opts.OptionsSize=IP_OPTS_DEFAULT;
305 /* Get ready for receiving the reply
306 * Do it before we send the request to minimize the risk of introducing delays
309 FD_SET(icp->sid,&fdr);
310 timeout.tv_sec=Timeout/1000;
311 timeout.tv_usec=(Timeout % 1000)*1000;
312 addrlen=sizeof(addr);
314 ip_header=(struct ip *) ((char *) ReplyBuffer+sizeof(ICMP_ECHO_REPLY));
315 endbuf=(char *) ReplyBuffer+ReplySize;
316 maxlen=ReplySize-sizeof(ICMP_ECHO_REPLY);
318 /* Send the packet */
319 TRACE("Sending %d bytes (RequestSize=%d) to %s\n", reqsize, RequestSize, inet_ntoa(addr.sin_addr));
322 unsigned char* buf=(unsigned char*)reqbuf;
324 printf("Output buffer:\n");
325 for (i=0;i<reqsize;i++)
326 printf("%2x,", buf[i]);
331 gettimeofday(&send_time,NULL);
332 res=ISOCK_sendto(icp->sid, reqbuf, reqsize, 0, (struct sockaddr*)&addr, sizeof(addr));
336 SetLastError(IP_PACKET_TOO_BIG);
340 SetLastError(IP_DEST_NET_UNREACHABLE);
343 SetLastError(IP_DEST_NET_UNREACHABLE);
346 TRACE("unknown error: errno=%d\n",errno);
347 SetLastError(ERROR_UNKNOWN);
354 ip_header_len=0; /* because gcc was complaining */
355 while ((res=ISOCK_select(icp->sid+1,&fdr,NULL,NULL,&timeout))>0) {
356 gettimeofday(&recv_time,NULL);
357 res=ISOCK_recvfrom(icp->sid, (char*)ip_header, maxlen, 0, (struct sockaddr*)&addr,&addrlen);
358 TRACE("received %d bytes from %s\n",res, inet_ntoa(addr.sin_addr));
359 ier->Status=IP_REQ_TIMED_OUT;
361 /* Check whether we should ignore this packet */
362 if ((ip_header->ip_p==IPPROTO_ICMP) && (res>=sizeof(struct ip)+ICMP_MINLEN)) {
363 ip_header_len=ip_header->ip_hl << 2;
364 icmp_header=(struct icmp*)(((char*)ip_header)+ip_header_len);
365 TRACE("received an ICMP packet of type,code=%d,%d\n",icmp_header->icmp_type,icmp_header->icmp_code);
366 if (icmp_header->icmp_type==ICMP_ECHOREPLY) {
367 if ((icmp_header->icmp_id==id) && (icmp_header->icmp_seq==seq))
368 ier->Status=IP_SUCCESS;
370 switch (icmp_header->icmp_type) {
372 switch (icmp_header->icmp_code) {
373 case ICMP_UNREACH_HOST:
374 #ifdef ICMP_UNREACH_HOST_UNKNOWN
375 case ICMP_UNREACH_HOST_UNKNOWN:
377 #ifdef ICMP_UNREACH_ISOLATED
378 case ICMP_UNREACH_ISOLATED:
380 #ifdef ICMP_UNREACH_HOST_PROHIB
381 case ICMP_UNREACH_HOST_PROHIB:
383 #ifdef ICMP_UNREACH_TOSHOST
384 case ICMP_UNREACH_TOSHOST:
386 ier->Status=IP_DEST_HOST_UNREACHABLE;
388 case ICMP_UNREACH_PORT:
389 ier->Status=IP_DEST_PORT_UNREACHABLE;
391 case ICMP_UNREACH_PROTOCOL:
392 ier->Status=IP_DEST_PROT_UNREACHABLE;
394 case ICMP_UNREACH_SRCFAIL:
395 ier->Status=IP_BAD_ROUTE;
398 ier->Status=IP_DEST_NET_UNREACHABLE;
402 if (icmp_header->icmp_code==ICMP_TIMXCEED_REASS)
403 ier->Status=IP_TTL_EXPIRED_REASSEM;
405 ier->Status=IP_TTL_EXPIRED_TRANSIT;
408 ier->Status=IP_PARAM_PROBLEM;
410 case ICMP_SOURCEQUENCH:
411 ier->Status=IP_SOURCE_QUENCH;
414 if (ier->Status!=IP_REQ_TIMED_OUT) {
415 struct ip* rep_ip_header;
416 struct icmp* rep_icmp_header;
417 /* The ICMP header size of all the packets we accept is the same */
418 rep_ip_header=(struct ip*)(((char*)icmp_header)+ICMP_MINLEN);
419 rep_icmp_header=(struct icmp*)(((char*)rep_ip_header)+(rep_ip_header->ip_hl << 2));
421 /* Make sure that this is really a reply to our packet */
422 if (ip_header_len+ICMP_MINLEN+(rep_ip_header->ip_hl << 2)+ICMP_MINLEN>ip_header->ip_len) {
423 ier->Status=IP_REQ_TIMED_OUT;
424 } else if ((rep_icmp_header->icmp_type!=ICMP_ECHO) ||
425 (rep_icmp_header->icmp_code!=0) ||
426 (rep_icmp_header->icmp_id!=id) ||
427 (rep_icmp_header->icmp_seq!=seq) ||
428 (rep_icmp_header->icmp_cksum!=cksum)) {
429 /* This was not a reply to one of our packets after all */
430 TRACE("skipping type,code=%d,%d id,seq=%d,%d cksum=%d\n",
431 rep_icmp_header->icmp_type,rep_icmp_header->icmp_code,
432 rep_icmp_header->icmp_id,rep_icmp_header->icmp_seq,
433 rep_icmp_header->icmp_cksum);
434 TRACE("expected type,code=8,0 id,seq=%d,%d cksum=%d\n",
437 ier->Status=IP_REQ_TIMED_OUT;
443 if (ier->Status==IP_REQ_TIMED_OUT) {
444 /* This packet was not for us.
445 * Decrease the timeout so that we don't enter an endless loop even
446 * if we get flooded with ICMP packets that are not for us.
448 timeout.tv_sec=Timeout/1000-(recv_time.tv_sec-send_time.tv_sec);
449 timeout.tv_usec=(Timeout % 1000)*1000+send_time.tv_usec-(recv_time.tv_usec-send_time.tv_usec);
450 if (timeout.tv_usec<0) {
451 timeout.tv_usec+=1000000;
456 /* This is a reply to our packet */
457 memcpy(&ier->Address,&ip_header->ip_src,sizeof(IPAddr));
458 /* Status is already set */
459 ier->RoundTripTime=(recv_time.tv_sec-send_time.tv_sec)*1000+(recv_time.tv_usec-send_time.tv_usec)/1000;
460 ier->DataSize=res-ip_header_len-ICMP_MINLEN;
462 ier->Data=endbuf-ier->DataSize;
463 memmove(ier->Data,((char*)ip_header)+ip_header_len+ICMP_MINLEN,ier->DataSize);
464 ier->Options.Ttl=ip_header->ip_ttl;
465 ier->Options.Tos=ip_header->ip_tos;
466 ier->Options.Flags=ip_header->ip_off >> 13;
467 ier->Options.OptionsSize=ip_header_len-sizeof(struct ip);
468 if (ier->Options.OptionsSize!=0) {
469 ier->Options.OptionsData=(unsigned char *) ier->Data-ier->Options.OptionsSize;
470 /* FIXME: We are supposed to rearrange the option's 'source route' data */
471 memmove(ier->Options.OptionsData,((char*)ip_header)+ip_header_len,ier->Options.OptionsSize);
472 endbuf=ier->Options.OptionsData;
474 ier->Options.OptionsData=NULL;
478 /* Prepare for the next packet */
480 ip_header=(struct ip*)(((char*)ip_header)+sizeof(ICMP_ECHO_REPLY));
481 maxlen=endbuf-(char*)ip_header;
483 /* Check out whether there is more but don't wait this time */
488 FD_SET(icp->sid,&fdr);
490 res=ier-(ICMP_ECHO_REPLY*)ReplyBuffer;
492 SetLastError(IP_REQ_TIMED_OUT);
493 TRACE("received %d replies\n",res);
498 * Copyright (c) 1989 The Regents of the University of California.
499 * All rights reserved.
501 * This code is derived from software contributed to Berkeley by
504 * Redistribution and use in source and binary forms, with or without
505 * modification, are permitted provided that the following conditions
507 * 1. Redistributions of source code must retain the above copyright
508 * notice, this list of conditions and the following disclaimer.
509 * 2. Redistributions in binary form must reproduce the above copyright
510 * notice, this list of conditions and the following disclaimer in the
511 * documentation and/or other materials provided with the distribution.
512 * 3. All advertising materials mentioning features or use of this software
513 * must display the following acknowledgement:
514 * This product includes software developed by the University of
515 * California, Berkeley and its contributors.
516 * 4. Neither the name of the University nor the names of its contributors
517 * may be used to endorse or promote products derived from this software
518 * without specific prior written permission.
520 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
521 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
522 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
523 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
524 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
525 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
526 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
527 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
528 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
529 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF