fix a compiler warning (... copied from RFC2553 :-)
[obnox/wireshark/wip.git] / capture_wpcap_packet.c
1 /* capture_wpcap_packet.c
2  * WinPcap-specific interfaces for low-level information (packet.dll).  
3  * We load WinPcap at run
4  * time, so that we only need one Ethereal binary and one Tethereal binary
5  * for Windows, regardless of whether WinPcap is installed or not.
6  *
7  * $Id$
8  *
9  * Ethereal - Network traffic analyzer
10  * By Gerald Combs <gerald@ethereal.com>
11  * Copyright 2001 Gerald Combs
12  *
13  * This program is free software; you can redistribute it and/or
14  * modify it under the terms of the GNU General Public License
15  * as published by the Free Software Foundation; either version 2
16  * of the License, or (at your option) any later version.
17  *
18  * This program is distributed in the hope that it will be useful,
19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
21  * GNU General Public License for more details.
22  *
23  * You should have received a copy of the GNU General Public License
24  * along with this program; if not, write to the Free Software
25  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
26  */
27
28 #ifdef HAVE_CONFIG_H
29 # include "config.h"
30 #endif
31
32 #if defined HAVE_LIBPCAP && defined _WIN32
33
34 #include <glib.h>
35 #include <gmodule.h>
36
37 #include <wtap.h>
38 #include <pcap.h>
39
40 /* XXX - yes, I know, I should move cppmagic.h to a generic location. */
41 #include "tools/lemon/cppmagic.h"
42
43 #include <epan/value_string.h>
44
45
46
47 #ifndef HAVE_SOCKADDR_STORAGE
48 /* packet32.h requires sockaddr_storage (usually defined in Platform SDK)
49  * copied from RFC2553 (and slightly modified because of datatypes) ...
50  * XXX - defined more than once, move this to a header file */
51 typedef unsigned short eth_sa_family_t;
52
53 /*
54  * Desired design of maximum size and alignment
55  */
56 #define ETH_SS_MAXSIZE    128  /* Implementation specific max size */
57 #define ETH_SS_ALIGNSIZE  (sizeof (gint64 /*int64_t*/))
58                          /* Implementation specific desired alignment */
59 /*
60  * Definitions used for sockaddr_storage structure paddings design.
61  */
62 #define ETH_SS_PAD1SIZE   (ETH_SS_ALIGNSIZE - sizeof (eth_sa_family_t))
63 #define ETH_SS_PAD2SIZE   (ETH_SS_MAXSIZE - (sizeof (eth_sa_family_t) + \
64                               ETH_SS_PAD1SIZE + ETH_SS_ALIGNSIZE))
65
66 struct sockaddr_storage {
67     eth_sa_family_t  __ss_family;     /* address family */
68     /* Following fields are implementation specific */
69     char      __ss_pad1[ETH_SS_PAD1SIZE];
70               /* 6 byte pad, this is to make implementation */
71               /* specific pad up to alignment field that */
72               /* follows explicit in the data structure */
73     gint64 /*int64_t*/   __ss_align;     /* field to force desired structure */
74                /* storage alignment */
75     char      __ss_pad2[ETH_SS_PAD2SIZE];
76               /* 112 byte pad to achieve desired size, */
77               /* _SS_MAXSIZE value minus size of ss_family */
78               /* __ss_pad1, __ss_align fields is 112 */
79 };
80 /* ... copied from RFC2553 */
81 #endif
82
83
84 #include <Packet32.h>
85 #include <windows.h>
86 #include <windowsx.h>
87 #include <Ntddndis.h>
88
89 #include "capture_wpcap_packet.h"
90
91 gboolean has_wpacket = FALSE;
92
93
94 /* This module will use the PacketRequest function in packet.dll (coming with WinPcap) to "directly" access 
95  * the Win32 NDIS network driver(s) and ask for various values (status, statistics, ...).
96  *
97  * Unfortunately, the definitions required for this are not available through the usual windows header files, 
98  * but require the Windows "Device Driver Kit" which is not available for free :-( 
99  *
100  * Fortunately, the definitions needed to access the various NDIS values are available from various OSS projects:
101  * - WinPcap in Ntddndis.h
102  * - Ndiswrapper in driver/ndis.h and driver/iw_ndis.h
103  * - cygwin (MingW?) in usr/include/w32api/ddk/ndis.h and ntddndis.h
104  * - FreeBSD (netperf)
105  */
106
107 /* The MSDN description of the NDIS driver API is available at:
108 /* MSDN Home >  MSDN Library >  Win32 and COM Development >  Driver Development Kit >  Network Devices and Protocols >  Reference */
109 /* "NDIS Objects" */
110 /* http://msdn.microsoft.com/library/default.asp?url=/library/en-us/network/hh/network/21oidovw_d55042e5-0b8a-4439-8ef2-be7331e98464.xml.asp */
111
112 /* Some more interesting links:
113  * http://sourceforge.net/projects/ndiswrapper/
114  * http://www.osronline.com/lists_archive/windbg/thread521.html
115  * http://cvs.sourceforge.net/viewcvs.py/mingw/w32api/include/ddk/ndis.h?view=markup
116  * http://cvs.sourceforge.net/viewcvs.py/mingw/w32api/include/ddk/ntddndis.h?view=markup
117  */
118
119
120
121 /******************************************************************************************************************************/
122 /* stuff to load WinPcap's packet.dll and the functions required from it */
123
124 static PCHAR     (*p_PacketGetVersion) (void);
125 static LPADAPTER (*p_PacketOpenAdapter) (char *adaptername);
126 static void      (*p_PacketCloseAdapter) (LPADAPTER);
127 static int       (*p_PacketRequest) (LPADAPTER, int, void *);
128
129 typedef struct {
130         const char      *name;
131         gpointer        *ptr;
132         gboolean        optional;
133 } symbol_table_t;
134
135 #define SYM(x, y)       { STRINGIFY(x) , (gpointer) &CONCAT(p_,x), y }
136
137 void
138 wpcap_packet_load(void)
139 {
140
141         /* These are the symbols I need or want from packet.dll */
142         static const symbol_table_t     symbols[] = {
143                 SYM(PacketGetVersion, FALSE),
144                 SYM(PacketOpenAdapter, FALSE),
145                 SYM(PacketCloseAdapter, FALSE),
146                 SYM(PacketRequest, FALSE),
147                 { NULL, NULL, FALSE }
148         };
149
150         GModule         *wh; /* wpcap handle */
151         const symbol_table_t    *sym;
152
153         wh = g_module_open("packet", 0);
154
155         if (!wh) {
156                 return;
157         }
158
159         sym = symbols;
160         while (sym->name) {
161                 if (!g_module_symbol(wh, sym->name, sym->ptr)) {
162                         if (sym->optional) {
163                                 /*
164                                  * We don't care if it's missing; we just
165                                  * don't use it.
166                                  */
167                                 *sym->ptr = NULL;
168                         } else {
169                                 /*
170                                  * We require this symbol.
171                                  */
172                                 return;
173                         }
174                 }
175                 sym++;
176         }
177
178         has_wpacket = TRUE;
179 }
180
181
182
183 /******************************************************************************************************************************/
184 /* functions to access the NDIS driver values */
185
186
187 /* get dll version */
188 char *
189 wpcap_packet_get_version(void)
190 {
191     if(!has_wpacket) {
192         return NULL;
193     }
194     return p_PacketGetVersion();
195 }
196
197
198 /* open the interface */
199 void *
200 wpcap_packet_open(char *if_name)
201 {
202     LPADAPTER   adapter;
203
204         g_assert(has_wpacket);
205     adapter = p_PacketOpenAdapter(if_name);
206
207     return adapter;
208 }
209
210
211 /* close the interface */
212 void
213 wpcap_packet_close(void *adapter)
214 {
215
216         g_assert(has_wpacket);
217     p_PacketCloseAdapter(adapter);
218 }
219
220
221 /* do a packet request call */
222 int 
223 wpcap_packet_request(void *adapter, ULONG Oid, int set, char *value, unsigned int *length)
224 {
225     BOOLEAN    Status;
226     ULONG      IoCtlBufferLength=(sizeof(PACKET_OID_DATA) + (*length) - 1);
227     PPACKET_OID_DATA  OidData;
228
229
230         g_assert(has_wpacket);
231
232     if(p_PacketRequest == NULL) {
233         g_warning("packet_request not available\n");
234         return 0;
235     }
236
237     OidData=GlobalAllocPtr(GMEM_MOVEABLE | GMEM_ZEROINIT,IoCtlBufferLength);
238     if (OidData == NULL) {
239         g_warning("packet_link_status failed\n");
240         return 0;
241     }
242
243     OidData->Oid = Oid;
244     OidData->Length = *length;
245
246     Status = p_PacketRequest(adapter, set, OidData);
247
248     if(Status) {
249         g_assert(OidData->Length <= *length);
250         memcpy(value, OidData->Data, OidData->Length);
251         *length = OidData->Length;
252     }
253
254     GlobalFreePtr (OidData);
255
256     if(Status) {
257         return 1;
258     } else {
259         return 0;
260     }
261 }
262
263
264 /* get an UINT value using the packet request call */
265 int
266 wpcap_packet_request_uint(void *adapter, ULONG Oid, UINT *value)
267 {
268     BOOLEAN     Status;
269     int         length = sizeof(UINT);
270
271
272     Status = wpcap_packet_request(adapter, Oid, FALSE /* !set */, (char *) value, &length);
273     if(Status) {
274         g_assert(length == sizeof(UINT));
275         return 1;
276     } else {
277         return 0;
278     }
279 }
280
281
282 /* get an ULONG value using the NDIS packet request call */
283 int
284 wpcap_packet_request_ulong(void *adapter, ULONG Oid, ULONG *value)
285 {
286     BOOLEAN     Status;
287     int         length = sizeof(ULONG);
288
289
290     Status = wpcap_packet_request(adapter, Oid, FALSE /* !set */, (char *) value, &length);
291     if(Status) {
292         g_assert(length == sizeof(ULONG));
293         return 1;
294     } else {
295         return 0;
296     }
297 }
298
299
300 #else /* HAVE_LIBPCAP && _WIN32 */
301
302 void
303 wpcap_packet_load(void)
304 {
305         return;
306 }
307
308 #endif /* HAVE_LIBPCAP */