Only use winsock2.h in Wine.
[wine] / dlls / icmp / icmp_main.c
1 /*
2  * ICMP
3  *
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.
8  */
9
10 /* Future work:
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 
17  *   handle's structure?
18  * - This API should probably be thread safe. Is it really?
19  * - Using the winsock functions has not been tested.
20  */
21
22 #include "config.h"
23
24 #include <sys/types.h>
25 #ifdef HAVE_SYS_SOCKET_H
26 # include <sys/socket.h>
27 #endif
28 #ifdef HAVE_NETDB_H
29 # include <netdb.h>
30 #endif
31 #ifdef HAVE_NETINET_IN_SYSTM_H
32 # include <netinet/in_systm.h>
33 #endif
34 #ifdef HAVE_NETINET_IN_H
35 # include <netinet/in.h>
36 #endif
37
38 #include <sys/time.h>
39 #include <string.h>
40 #include <errno.h>
41 #include <unistd.h>
42 #ifdef HAVE_ARPA_INET_H
43 # include <arpa/inet.h>
44 #endif
45
46 #include "windef.h"
47 #include "winbase.h"
48 #ifdef ICMP_WIN
49 #include "winsock2.h"
50 #endif
51
52 #include "winerror.h"
53 #include "wine/ipexport.h"
54 #include "wine/icmpapi.h"
55 #include "debugtools.h"
56
57 /* Set up endiannes macros for the ip and ip_icmp BSD headers */
58 #ifndef BIG_ENDIAN
59 #define BIG_ENDIAN       4321
60 #endif
61 #ifndef LITTLE_ENDIAN
62 #define LITTLE_ENDIAN    1234
63 #endif
64 #ifndef BYTE_ORDER
65 #ifdef WORDS_BIGENDIAN
66 #define BYTE_ORDER       BIG_ENDIAN
67 #else
68 #define BYTE_ORDER       LITTLE_ENDIAN
69 #endif
70 #endif /* BYTE_ORDER */
71
72 #define u_int16_t  WORD
73 #define u_int32_t  DWORD
74
75 /* These are BSD headers. We use these here because they are needed on 
76  * libc5 Linux systems. On other platforms they are usually simply more 
77  * complete than the native stuff, and cause less portability problems 
78  * so we use them anyway.
79  */
80 #include "ip.h"
81 #include "ip_icmp.h"
82
83
84 DEFAULT_DEBUG_CHANNEL(icmp);
85
86 /* Define the following macro to use the winsock functions */
87 /*#define ICMP_WIN*/
88
89 #ifdef ICMP_WIN
90 /* FIXME: should we include winsock.h ???*/
91 SOCKET WINAPI WINSOCK_socket(INT af, INT type, INT protocol);
92 INT WINAPI WINSOCK_sendto(SOCKET s, char *buf, INT len, INT flags, struct sockaddr *to, INT tolen);
93 INT WINAPI WINSOCK_recvfrom(SOCKET s, char *buf,INT len, INT flags, struct sockaddr *from, INT *fromlen32);
94 INT WINAPI WINSOCK_shutdown(SOCKET s, INT how);
95 #endif
96
97
98 #ifdef ICMP_WIN
99 #define ISOCK_SOCKET                SOCKET
100 #define ISOCK_ISVALID(a)            ((a)!=INVALID_SOCKET)
101 #define ISOCK_getsockopt(a,b,c,d,e) WINSOCK_getsockopt(a,b,c,d,e)
102 #define ISOCK_recvfrom(a,b,c,d,e,f) WINSOCK_recvfrom(a,b,c,d,e,f)
103 #define ISOCK_select(a,b,c,d,e)     WINSOCK_select(a,b,c,d,e)
104 #define ISOCK_sendto(a,b,c,d,e,f)   WINSOCK_sendto(a,b,c,d,e,f)
105 #define ISOCK_setsockopt(a,b,c,d,e) WINSOCK_setsockopt(a,b,c,d,e)
106 #define ISOCK_shutdown(a,b)         WINSOCK_shutdown(a,b)
107 #define ISOCK_socket(a,b,c)         WINSOCK_socket(a,b,c)
108 #else
109 #define ISOCK_SOCKET                int
110 #define ISOCK_ISVALID(a)            ((a)>=0)
111 #define ISOCK_getsockopt(a,b,c,d,e) getsockopt(a,b,c,d,e)
112 #define ISOCK_recvfrom(a,b,c,d,e,f) recvfrom(a,b,c,d,e,f)
113 #define ISOCK_select(a,b,c,d,e)     select(a,b,c,d,e)
114 #define ISOCK_setsockopt(a,b,c,d,e) setsockopt(a,b,c,d,e)
115 #define ISOCK_sendto(a,b,c,d,e,f)   sendto(a,b,c,d,e,f)
116 #define ISOCK_shutdown(a,b)         shutdown(a,b)
117 #define ISOCK_socket(a,b,c)         socket(a,b,c)
118 #endif
119
120 typedef struct {
121     ISOCK_SOCKET sid;
122     IP_OPTION_INFORMATION default_opts;
123 } icmp_t;
124
125 #define IP_OPTS_UNKNOWN     0
126 #define IP_OPTS_DEFAULT     1
127 #define IP_OPTS_CUSTOM      2
128
129 /* The sequence number is unique process wide, so that all threads 
130  * have a distinct sequence number.
131  */
132 static LONG icmp_sequence=0;
133
134 static int in_cksum(u_short *addr, int len)
135 {
136     int nleft=len;
137     u_short *w = addr;
138     int sum = 0;
139     u_short answer = 0;
140
141     while (nleft > 1) {
142         sum += *w++;
143         nleft -= 2;
144     }
145
146     if (nleft == 1) {
147         *(u_char *)(&answer) = *(u_char *)w;
148         sum += answer;
149     }
150
151     sum = (sum >> 16) + (sum & 0xffff);
152     sum  += (sum >> 16);
153     answer = ~sum;
154     return(answer);
155 }
156
157
158
159 /*
160  * Exported Routines.
161  */
162
163 /***********************************************************************
164  *              IcmpCreateFile (ICMP.@)
165  */
166 HANDLE WINAPI IcmpCreateFile(VOID)
167 {
168     icmp_t* icp;
169
170     ISOCK_SOCKET sid=ISOCK_socket(AF_INET,SOCK_RAW,IPPROTO_ICMP);
171     if (!ISOCK_ISVALID(sid)) {
172         MESSAGE("WARNING: Trying to use ICMP will fail unless running as root\n");
173         SetLastError(ERROR_ACCESS_DENIED);
174         return INVALID_HANDLE_VALUE;
175     }
176
177     icp=HeapAlloc(GetProcessHeap(), 0, sizeof(*icp));
178     if (icp==NULL) {
179         SetLastError(IP_NO_RESOURCES);
180         return INVALID_HANDLE_VALUE;
181     }
182     icp->sid=sid;
183     icp->default_opts.OptionsSize=IP_OPTS_UNKNOWN;
184     return (HANDLE)icp;
185 }
186
187
188 /***********************************************************************
189  *              IcmpCloseHandle (ICMP.@)
190  */
191 BOOL WINAPI IcmpCloseHandle(HANDLE  IcmpHandle)
192 {
193     icmp_t* icp=(icmp_t*)IcmpHandle;
194     if (IcmpHandle==INVALID_HANDLE_VALUE) {
195         /* FIXME: in fact win98 seems to ignore the handle value !!! */
196         SetLastError(ERROR_INVALID_HANDLE);
197         return FALSE;
198     }
199
200     ISOCK_shutdown(icp->sid,2);
201     HeapFree(GetProcessHeap (), 0, icp);
202     return TRUE;
203 }
204
205
206 /***********************************************************************
207  *              IcmpSendEcho (ICMP.@)
208  */
209 DWORD WINAPI IcmpSendEcho(
210     HANDLE                   IcmpHandle,
211     IPAddr                   DestinationAddress,
212     LPVOID                   RequestData,
213     WORD                     RequestSize,
214     PIP_OPTION_INFORMATION   RequestOptions,
215     LPVOID                   ReplyBuffer,
216     DWORD                    ReplySize,
217     DWORD                    Timeout
218     )
219 {
220     icmp_t* icp=(icmp_t*)IcmpHandle;
221     unsigned char* reqbuf;
222     int reqsize;
223
224     struct icmp_echo_reply* ier;
225     struct ip* ip_header;
226     struct icmp* icmp_header;
227     char* endbuf;
228     int ip_header_len;
229     int maxlen;
230     fd_set fdr;
231     struct timeval timeout,send_time,recv_time;
232     struct sockaddr_in addr;
233     int addrlen;
234     unsigned short id,seq,cksum;
235     int res;
236
237     if (IcmpHandle==INVALID_HANDLE_VALUE) {
238         /* FIXME: in fact win98 seems to ignore the handle value !!! */
239         SetLastError(ERROR_INVALID_HANDLE);
240         return 0;
241     }
242
243     if (ReplySize<sizeof(ICMP_ECHO_REPLY)+ICMP_MINLEN) {
244         SetLastError(IP_BUF_TOO_SMALL);
245         return 0;
246     }
247     /* check the request size against SO_MAX_MSG_SIZE using getsockopt */
248
249     /* Prepare the request */
250     id=getpid() & 0xFFFF;
251     seq=InterlockedIncrement(&icmp_sequence) & 0xFFFF;
252
253     reqsize=ICMP_MINLEN+RequestSize;
254     reqbuf=HeapAlloc(GetProcessHeap(), 0, reqsize);
255     if (reqbuf==NULL) {
256         SetLastError(ERROR_OUTOFMEMORY);
257         return 0;
258     }
259
260     icmp_header=(struct icmp*)reqbuf;
261     icmp_header->icmp_type=ICMP_ECHO;
262     icmp_header->icmp_code=0;
263     icmp_header->icmp_cksum=0;
264     icmp_header->icmp_id=id;
265     icmp_header->icmp_seq=seq;
266     memcpy(reqbuf+ICMP_MINLEN, RequestData, RequestSize);
267     icmp_header->icmp_cksum=cksum=in_cksum((u_short*)reqbuf,reqsize);
268
269     addr.sin_family=AF_INET;
270     addr.sin_addr.s_addr=DestinationAddress;
271     addr.sin_port=0;
272
273     if (RequestOptions!=NULL) {
274         int val;
275         if (icp->default_opts.OptionsSize==IP_OPTS_UNKNOWN) {
276             int len;
277             /* Before we mess with the options, get the default values */
278             len=sizeof(val);
279             ISOCK_getsockopt(icp->sid,IPPROTO_IP,IP_TTL,(char *)&val,&len);
280             icp->default_opts.Ttl=val;
281
282             len=sizeof(val);
283             ISOCK_getsockopt(icp->sid,IPPROTO_IP,IP_TOS,(char *)&val,&len);
284             icp->default_opts.Tos=val;
285             /* FIXME: missing: handling of IP 'flags', and all the other options */
286         }
287
288         val=RequestOptions->Ttl;
289         ISOCK_setsockopt(icp->sid,IPPROTO_IP,IP_TTL,(char *)&val,sizeof(val));
290         val=RequestOptions->Tos;
291         ISOCK_setsockopt(icp->sid,IPPROTO_IP,IP_TOS,(char *)&val,sizeof(val));
292         /* FIXME:  missing: handling of IP 'flags', and all the other options */
293
294         icp->default_opts.OptionsSize=IP_OPTS_CUSTOM;
295     } else if (icp->default_opts.OptionsSize==IP_OPTS_CUSTOM) {
296         int val;
297
298         /* Restore the default options */
299         val=icp->default_opts.Ttl;
300         ISOCK_setsockopt(icp->sid,IPPROTO_IP,IP_TTL,(char *)&val,sizeof(val));
301         val=icp->default_opts.Tos;
302         ISOCK_setsockopt(icp->sid,IPPROTO_IP,IP_TOS,(char *)&val,sizeof(val));
303         /* FIXME: missing: handling of IP 'flags', and all the other options */
304
305         icp->default_opts.OptionsSize=IP_OPTS_DEFAULT;
306     }
307
308     /* Get ready for receiving the reply
309      * Do it before we send the request to minimize the risk of introducing delays
310      */
311     FD_ZERO(&fdr);
312     FD_SET(icp->sid,&fdr);
313     timeout.tv_sec=Timeout/1000;
314     timeout.tv_usec=(Timeout % 1000)*1000;
315     addrlen=sizeof(addr);
316     ier=ReplyBuffer;
317     ip_header=(struct ip *) ((char *) ReplyBuffer+sizeof(ICMP_ECHO_REPLY));
318     endbuf=(char *) ReplyBuffer+ReplySize;
319     maxlen=ReplySize-sizeof(ICMP_ECHO_REPLY);
320
321     /* Send the packet */
322     TRACE("Sending %d bytes (RequestSize=%d) to %s\n", reqsize, RequestSize, inet_ntoa(addr.sin_addr));
323 #if 0
324     if (TRACE_ON(icmp)){
325         unsigned char* buf=(unsigned char*)reqbuf;
326         int i;
327         printf("Output buffer:\n");
328         for (i=0;i<reqsize;i++)
329             printf("%2x,", buf[i]);
330         printf("\n");
331     }
332 #endif
333
334     gettimeofday(&send_time,NULL);
335     res=ISOCK_sendto(icp->sid, reqbuf, reqsize, 0, (struct sockaddr*)&addr, sizeof(addr));
336     HeapFree(GetProcessHeap (), 0, reqbuf);
337     if (res<0) {
338         if (errno==EMSGSIZE)
339             SetLastError(IP_PACKET_TOO_BIG);
340         else {
341             switch (errno) {
342             case ENETUNREACH:
343                 SetLastError(IP_DEST_NET_UNREACHABLE);
344                 break;
345             case EHOSTUNREACH:
346                 SetLastError(IP_DEST_NET_UNREACHABLE);
347                 break;
348             default:
349                 TRACE("unknown error: errno=%d\n",errno);
350                 SetLastError(ERROR_UNKNOWN);
351             }
352         }
353         return 0;
354     }
355
356     /* Get the reply */
357     ip_header_len=0; /* because gcc was complaining */
358     while ((res=ISOCK_select(icp->sid+1,&fdr,NULL,NULL,&timeout))>0) {
359         gettimeofday(&recv_time,NULL);
360         res=ISOCK_recvfrom(icp->sid, (char*)ip_header, maxlen, 0, (struct sockaddr*)&addr,&addrlen);
361         TRACE("received %d bytes from %s\n",res, inet_ntoa(addr.sin_addr));
362         ier->Status=IP_REQ_TIMED_OUT;
363
364         /* Check whether we should ignore this packet */
365         if ((ip_header->ip_p==IPPROTO_ICMP) && (res>=sizeof(struct ip)+ICMP_MINLEN)) {
366             ip_header_len=ip_header->ip_hl << 2;
367             icmp_header=(struct icmp*)(((char*)ip_header)+ip_header_len);
368             TRACE("received an ICMP packet of type,code=%d,%d\n",icmp_header->icmp_type,icmp_header->icmp_code);
369             if (icmp_header->icmp_type==ICMP_ECHOREPLY) {
370                 if ((icmp_header->icmp_id==id) && (icmp_header->icmp_seq==seq))
371                     ier->Status=IP_SUCCESS;
372             } else {
373                 switch (icmp_header->icmp_type) {
374                 case ICMP_UNREACH:
375                     switch (icmp_header->icmp_code) {
376                     case ICMP_UNREACH_HOST:
377 #ifdef ICMP_UNREACH_HOST_UNKNOWN
378                     case ICMP_UNREACH_HOST_UNKNOWN:
379 #endif
380 #ifdef ICMP_UNREACH_ISOLATED
381                     case ICMP_UNREACH_ISOLATED:
382 #endif
383 #ifdef ICMP_UNREACH_HOST_PROHIB
384                     case ICMP_UNREACH_HOST_PROHIB:
385 #endif
386 #ifdef ICMP_UNREACH_TOSHOST
387                     case ICMP_UNREACH_TOSHOST:
388 #endif
389                         ier->Status=IP_DEST_HOST_UNREACHABLE;
390                         break;
391                     case ICMP_UNREACH_PORT:
392                         ier->Status=IP_DEST_PORT_UNREACHABLE;
393                         break;
394                     case ICMP_UNREACH_PROTOCOL:
395                         ier->Status=IP_DEST_PROT_UNREACHABLE;
396                         break;
397                     case ICMP_UNREACH_SRCFAIL:
398                         ier->Status=IP_BAD_ROUTE;
399                         break;
400                     default:
401                         ier->Status=IP_DEST_NET_UNREACHABLE;
402                     }
403                     break;
404                 case ICMP_TIMXCEED:
405                     if (icmp_header->icmp_code==ICMP_TIMXCEED_REASS)
406                         ier->Status=IP_TTL_EXPIRED_REASSEM;
407                     else
408                         ier->Status=IP_TTL_EXPIRED_TRANSIT;
409                     break;
410                 case ICMP_PARAMPROB:
411                     ier->Status=IP_PARAM_PROBLEM;
412                     break;
413                 case ICMP_SOURCEQUENCH:
414                     ier->Status=IP_SOURCE_QUENCH;
415                     break;
416                 }
417                 if (ier->Status!=IP_REQ_TIMED_OUT) {
418                     struct ip* rep_ip_header;
419                     struct icmp* rep_icmp_header;
420                     /* The ICMP header size of all the packets we accept is the same */
421                     rep_ip_header=(struct ip*)(((char*)icmp_header)+ICMP_MINLEN);
422                     rep_icmp_header=(struct icmp*)(((char*)rep_ip_header)+(rep_ip_header->ip_hl << 2));
423
424                     /* Make sure that this is really a reply to our packet */
425                     if (ip_header_len+ICMP_MINLEN+(rep_ip_header->ip_hl << 2)+ICMP_MINLEN>ip_header->ip_len) {
426                         ier->Status=IP_REQ_TIMED_OUT;
427                     } else if ((rep_icmp_header->icmp_type!=ICMP_ECHO) ||
428                         (rep_icmp_header->icmp_code!=0) ||
429                         (rep_icmp_header->icmp_id!=id) ||
430                         (rep_icmp_header->icmp_seq!=seq) ||
431                         (rep_icmp_header->icmp_cksum!=cksum)) {
432                         /* This was not a reply to one of our packets after all */
433                         TRACE("skipping type,code=%d,%d id,seq=%d,%d cksum=%d\n",
434                             rep_icmp_header->icmp_type,rep_icmp_header->icmp_code,
435                             rep_icmp_header->icmp_id,rep_icmp_header->icmp_seq,
436                             rep_icmp_header->icmp_cksum);
437                         TRACE("expected type,code=8,0 id,seq=%d,%d cksum=%d\n",
438                             id,seq,
439                             cksum);
440                         ier->Status=IP_REQ_TIMED_OUT;
441                     }
442                 }
443             }                
444         }
445
446         if (ier->Status==IP_REQ_TIMED_OUT) {
447             /* This packet was not for us.
448              * Decrease the timeout so that we don't enter an endless loop even
449              * if we get flooded with ICMP packets that are not for us.
450              */
451             timeout.tv_sec=Timeout/1000-(recv_time.tv_sec-send_time.tv_sec);
452             timeout.tv_usec=(Timeout % 1000)*1000+send_time.tv_usec-(recv_time.tv_usec-send_time.tv_usec);
453             if (timeout.tv_usec<0) {
454                 timeout.tv_usec+=1000000;
455                 timeout.tv_sec--;
456             }
457             continue;
458         } else {
459             /* This is a reply to our packet */
460             memcpy(&ier->Address,&ip_header->ip_src,sizeof(IPAddr));
461             /* Status is already set */
462             ier->RoundTripTime=(recv_time.tv_sec-send_time.tv_sec)*1000+(recv_time.tv_usec-send_time.tv_usec)/1000;
463             ier->DataSize=res-ip_header_len-ICMP_MINLEN;
464             ier->Reserved=0;
465             ier->Data=endbuf-ier->DataSize;
466             memmove(ier->Data,((char*)ip_header)+ip_header_len+ICMP_MINLEN,ier->DataSize);
467             ier->Options.Ttl=ip_header->ip_ttl;
468             ier->Options.Tos=ip_header->ip_tos;
469             ier->Options.Flags=ip_header->ip_off >> 13;
470             ier->Options.OptionsSize=ip_header_len-sizeof(struct ip);
471             if (ier->Options.OptionsSize!=0) {
472                 ier->Options.OptionsData=(unsigned char *) ier->Data-ier->Options.OptionsSize;
473                 /* FIXME: We are supposed to rearrange the option's 'source route' data */
474                 memmove(ier->Options.OptionsData,((char*)ip_header)+ip_header_len,ier->Options.OptionsSize);
475                 endbuf=ier->Options.OptionsData;
476             } else {
477                 ier->Options.OptionsData=NULL;
478                 endbuf=ier->Data;
479             }
480
481             /* Prepare for the next packet */
482             ier++;
483             ip_header=(struct ip*)(((char*)ip_header)+sizeof(ICMP_ECHO_REPLY));
484             maxlen=endbuf-(char*)ip_header;
485
486             /* Check out whether there is more but don't wait this time */
487             timeout.tv_sec=0;
488             timeout.tv_usec=0;
489         }
490         FD_ZERO(&fdr);
491         FD_SET(icp->sid,&fdr);
492     }
493     res=ier-(ICMP_ECHO_REPLY*)ReplyBuffer;
494     if (res==0)
495         SetLastError(IP_REQ_TIMED_OUT);
496     TRACE("received %d replies\n",res);
497     return res;
498 }
499
500 /*
501  * Copyright (c) 1989 The Regents of the University of California.
502  * All rights reserved.
503  *
504  * This code is derived from software contributed to Berkeley by
505  * Mike Muuss.
506  *
507  * Redistribution and use in source and binary forms, with or without
508  * modification, are permitted provided that the following conditions
509  * are met:
510  * 1. Redistributions of source code must retain the above copyright
511  *    notice, this list of conditions and the following disclaimer.
512  * 2. Redistributions in binary form must reproduce the above copyright
513  *    notice, this list of conditions and the following disclaimer in the
514  *    documentation and/or other materials provided with the distribution.
515  * 3. All advertising materials mentioning features or use of this software
516  *    must display the following acknowledgement:
517  *      This product includes software developed by the University of
518  *      California, Berkeley and its contributors.
519  * 4. Neither the name of the University nor the names of its contributors
520  *    may be used to endorse or promote products derived from this software
521  *    without specific prior written permission.
522  *
523  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
524  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
525  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
526  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
527  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
528  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
529  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
530  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
531  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
532  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
533  * SUCH DAMAGE.
534  *
535  */