xref: /freebsd/contrib/libpcap/pcap/socket.h (revision a64729f5077d77e13b9497cb33ecb3c82e606ee8)
1 /* -*- Mode: c; tab-width: 8; indent-tabs-mode: 1; c-basic-offset: 8; -*- */
2 /*
3  * Copyright (c) 1993, 1994, 1995, 1996, 1997
4  *	The Regents of the University of California.  All rights reserved.
5  *
6  * Redistribution and use in source and binary forms, with or without
7  * modification, are permitted provided that the following conditions
8  * are met:
9  * 1. Redistributions of source code must retain the above copyright
10  *    notice, this list of conditions and the following disclaimer.
11  * 2. Redistributions in binary form must reproduce the above copyright
12  *    notice, this list of conditions and the following disclaimer in the
13  *    documentation and/or other materials provided with the distribution.
14  * 3. All advertising materials mentioning features or use of this software
15  *    must display the following acknowledgement:
16  *	This product includes software developed by the Computer Systems
17  *	Engineering Group at Lawrence Berkeley Laboratory.
18  * 4. Neither the name of the University nor of the Laboratory may be used
19  *    to endorse or promote products derived from this software without
20  *    specific prior written permission.
21  *
22  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
23  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
24  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
25  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
26  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
27  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
28  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
29  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
30  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
31  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
32  * SUCH DAMAGE.
33  */
34 
35 #ifndef lib_pcap_socket_h
36 #define lib_pcap_socket_h
37 
38 /*
39  * Some minor differences between sockets on various platforms.
40  * We include whatever sockets are needed for Internet-protocol
41  * socket access on UN*X and Windows.
42  */
43 #ifdef _WIN32
44   /* Need windef.h for defines used in winsock2.h under MingW32 */
45   #ifdef __MINGW32__
46     #include <windef.h>
47   #endif
48   #include <winsock2.h>
49   #include <ws2tcpip.h>
50 
51   /*!
52    * \brief In Winsock, a socket handle is of type SOCKET; in UN*X, it's
53    * a file descriptor, and therefore a signed integer.
54    * We define PCAP_SOCKET to be a signed integer on UN*X and a
55    * SOCKET on Windows, so that it can be used on both platforms.
56    *
57    * We used to use SOCKET rather than PCAP_SOCKET, but that collided
58    * with other software, such as barnyard2, which had their own
59    * definitions of SOCKET, so we changed it to PCAP_SOCKET.
60    *
61    * On Windows, this shouldn't break any APIs, as any code using
62    * the two active-mode APIs that return a socket handle would
63    * probably be assigning their return values to a SOCKET, and
64    * as, on Windows, we're defining PCAP_SOCKET as SOCKET, there
65    * would be no type clash.
66    */
67   #ifndef PCAP_SOCKET
68     #define PCAP_SOCKET SOCKET
69   #endif
70 
71   /*
72    * Winsock doesn't have this POSIX type; it's used for the
73    * tv_usec value of struct timeval.
74    */
75   typedef long suseconds_t;
76 #else /* _WIN32 */
77   #include <sys/types.h>
78   #include <sys/socket.h>
79   #include <netdb.h>		/* for struct addrinfo/getaddrinfo() */
80   #include <netinet/in.h>	/* for sockaddr_in, in BSD at least */
81   #include <arpa/inet.h>
82 
83   /*!
84    * \brief In Winsock, a socket handle is of type SOCKET; in UN*Xes,
85    * it's a file descriptor, and therefore a signed integer.
86    * We define PCAP_SOCKET to be a signed integer on UN*X and a
87    * SOCKET on Windows, so that it can be used on both platforms.
88    *
89    * We used to use SOCKET rather than PCAP_SOCKET, but that collided
90    * with other software, such as barnyard2, which had their own
91    * definitions of SOCKET, so we changed it to PCAP_SOCKET.
92    *
93    * On UN*Xes, this might break code that uses one of the two
94    * active-mode APIs that return a socket handle if those programs
95    * were written to assign the return values of those APIs to a
96    * SOCKET, as we're no longer defining SOCKET.  However, as
97    * those APIs are only provided if libpcap is built with remote
98    * capture support - which is not the default - and as they're
99    * somewhat painful to use, there's probably little if any code
100    * that needs to compile for UN*X and that uses them.  If there
101    * *is* any such code, it could do
102    *
103    *    #ifndef PCAP_SOCKET
104    *        #ifdef _WIN32
105    *            #define PCAP_SOCKET SOCKET
106    *        #else
107    *            #defube PCAP_SOCKET int
108    *        #endif
109    *    #endif
110    *
111    * and use PCAP_SOCKET.
112    */
113   #ifndef PCAP_SOCKET
114     #define PCAP_SOCKET int
115   #endif
116 
117   /*!
118    * \brief In Winsock, the error return if socket() fails is INVALID_SOCKET;
119    * in UN*X, it's -1.
120    * We define INVALID_SOCKET to be -1 on UN*X, so that it can be used on
121    * both platforms.
122    */
123   #ifndef INVALID_SOCKET
124     #define INVALID_SOCKET -1
125   #endif
126 #endif /* _WIN32 */
127 
128 #endif /* lib_pcap_socket_h */
129