2 * TAP-Win32 -- A kernel driver to provide virtual tap device functionality
3 * on Windows. Originally derived from the CIPE-Win32
4 * project by Damion K. Wilson, with extensive modifications by
7 * All source code which derives from the CIPE-Win32 project is
8 * Copyright (C) Damion K. Wilson, 2003, and is released under the
9 * GPL version 2 (see below).
11 * All other source code is Copyright (C) James Yonan, 2003-2004,
12 * and is released under the GPL version 2 (see below).
14 * This program is free software; you can redistribute it and/or modify
15 * it under the terms of the GNU General Public License as published by
16 * the Free Software Foundation; either version 2 of the License, or
17 * (at your option) any later version.
19 * This program is distributed in the hope that it will be useful,
20 * but WITHOUT ANY WARRANTY; without even the implied warranty of
21 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
22 * GNU General Public License for more details.
24 * You should have received a copy of the GNU General Public License
25 * along with this program (see the file COPYING included with this
26 * distribution); if not, see <http://www.gnu.org/licenses/>.
31 #include "qemu-common.h"
42 #define TAP_CONTROL_CODE(request,method) \
43 CTL_CODE (FILE_DEVICE_UNKNOWN, request, method, FILE_ANY_ACCESS)
45 #define TAP_IOCTL_GET_MAC TAP_CONTROL_CODE (1, METHOD_BUFFERED)
46 #define TAP_IOCTL_GET_VERSION TAP_CONTROL_CODE (2, METHOD_BUFFERED)
47 #define TAP_IOCTL_GET_MTU TAP_CONTROL_CODE (3, METHOD_BUFFERED)
48 #define TAP_IOCTL_GET_INFO TAP_CONTROL_CODE (4, METHOD_BUFFERED)
49 #define TAP_IOCTL_CONFIG_POINT_TO_POINT TAP_CONTROL_CODE (5, METHOD_BUFFERED)
50 #define TAP_IOCTL_SET_MEDIA_STATUS TAP_CONTROL_CODE (6, METHOD_BUFFERED)
51 #define TAP_IOCTL_CONFIG_DHCP_MASQ TAP_CONTROL_CODE (7, METHOD_BUFFERED)
52 #define TAP_IOCTL_GET_LOG_LINE TAP_CONTROL_CODE (8, METHOD_BUFFERED)
53 #define TAP_IOCTL_CONFIG_DHCP_SET_OPT TAP_CONTROL_CODE (9, METHOD_BUFFERED)
59 #define ADAPTER_KEY "SYSTEM\\CurrentControlSet\\Control\\Class\\{4D36E972-E325-11CE-BFC1-08002BE10318}"
61 #define NETWORK_CONNECTIONS_KEY "SYSTEM\\CurrentControlSet\\Control\\Network\\{4D36E972-E325-11CE-BFC1-08002BE10318}"
63 //======================
64 // Filesystem prefixes
65 //======================
67 #define USERMODEDEVICEDIR "\\\\.\\Global\\"
68 #define TAPSUFFIX ".tap"
71 //======================
72 // Compile time configuration
73 //======================
75 //#define DEBUG_TAP_WIN32
77 #define TUN_ASYNCHRONOUS_WRITES 1
79 #define TUN_BUFFER_SIZE 1560
80 #define TUN_MAX_BUFFER_COUNT 32
83 * The data member "buffer" must be the first element in the tun_buffer
84 * structure. See the function, tap_win32_free_buffer.
86 typedef struct tun_buffer_s
{
87 unsigned char buffer
[TUN_BUFFER_SIZE
];
88 unsigned long read_size
;
89 struct tun_buffer_s
* next
;
92 typedef struct tap_win32_overlapped
{
96 HANDLE output_queue_semaphore
;
97 HANDLE free_list_semaphore
;
99 CRITICAL_SECTION output_queue_cs
;
100 CRITICAL_SECTION free_list_cs
;
101 OVERLAPPED read_overlapped
;
102 OVERLAPPED write_overlapped
;
103 tun_buffer_t buffers
[TUN_MAX_BUFFER_COUNT
];
104 tun_buffer_t
* free_list
;
105 tun_buffer_t
* output_queue_front
;
106 tun_buffer_t
* output_queue_back
;
107 } tap_win32_overlapped_t
;
109 static tap_win32_overlapped_t tap_overlapped
;
111 static tun_buffer_t
* get_buffer_from_free_list(tap_win32_overlapped_t
* const overlapped
)
113 tun_buffer_t
* buffer
= NULL
;
114 WaitForSingleObject(overlapped
->free_list_semaphore
, INFINITE
);
115 EnterCriticalSection(&overlapped
->free_list_cs
);
116 buffer
= overlapped
->free_list
;
117 // assert(buffer != NULL);
118 overlapped
->free_list
= buffer
->next
;
119 LeaveCriticalSection(&overlapped
->free_list_cs
);
124 static void put_buffer_on_free_list(tap_win32_overlapped_t
* const overlapped
, tun_buffer_t
* const buffer
)
126 EnterCriticalSection(&overlapped
->free_list_cs
);
127 buffer
->next
= overlapped
->free_list
;
128 overlapped
->free_list
= buffer
;
129 LeaveCriticalSection(&overlapped
->free_list_cs
);
130 ReleaseSemaphore(overlapped
->free_list_semaphore
, 1, NULL
);
133 static tun_buffer_t
* get_buffer_from_output_queue(tap_win32_overlapped_t
* const overlapped
, const int block
)
135 tun_buffer_t
* buffer
= NULL
;
136 DWORD result
, timeout
= block
? INFINITE
: 0L;
139 result
= WaitForSingleObject(overlapped
->output_queue_semaphore
, timeout
);
143 // The semaphore object was signaled.
145 EnterCriticalSection(&overlapped
->output_queue_cs
);
147 buffer
= overlapped
->output_queue_front
;
148 overlapped
->output_queue_front
= buffer
->next
;
150 if(overlapped
->output_queue_front
== NULL
) {
151 overlapped
->output_queue_back
= NULL
;
154 LeaveCriticalSection(&overlapped
->output_queue_cs
);
157 // Semaphore was nonsignaled, so a time-out occurred.
159 // Cannot open another window.
166 static tun_buffer_t
* get_buffer_from_output_queue_immediate (tap_win32_overlapped_t
* const overlapped
)
168 return get_buffer_from_output_queue(overlapped
, 0);
171 static void put_buffer_on_output_queue(tap_win32_overlapped_t
* const overlapped
, tun_buffer_t
* const buffer
)
173 EnterCriticalSection(&overlapped
->output_queue_cs
);
175 if(overlapped
->output_queue_front
== NULL
&& overlapped
->output_queue_back
== NULL
) {
176 overlapped
->output_queue_front
= overlapped
->output_queue_back
= buffer
;
179 overlapped
->output_queue_back
->next
= buffer
;
180 overlapped
->output_queue_back
= buffer
;
183 LeaveCriticalSection(&overlapped
->output_queue_cs
);
185 ReleaseSemaphore(overlapped
->output_queue_semaphore
, 1, NULL
);
189 static int is_tap_win32_dev(const char *guid
)
196 status
= RegOpenKeyEx(
203 if (status
!= ERROR_SUCCESS
) {
209 char unit_string
[256];
211 char component_id_string
[] = "ComponentId";
212 char component_id
[256];
213 char net_cfg_instance_id_string
[] = "NetCfgInstanceId";
214 char net_cfg_instance_id
[256];
217 len
= sizeof (enum_name
);
218 status
= RegEnumKeyEx(
228 if (status
== ERROR_NO_MORE_ITEMS
)
230 else if (status
!= ERROR_SUCCESS
) {
234 snprintf (unit_string
, sizeof(unit_string
), "%s\\%s",
235 ADAPTER_KEY
, enum_name
);
237 status
= RegOpenKeyEx(
244 if (status
!= ERROR_SUCCESS
) {
247 len
= sizeof (component_id
);
248 status
= RegQueryValueEx(
253 (LPBYTE
)component_id
,
256 if (!(status
!= ERROR_SUCCESS
|| data_type
!= REG_SZ
)) {
257 len
= sizeof (net_cfg_instance_id
);
258 status
= RegQueryValueEx(
260 net_cfg_instance_id_string
,
263 (LPBYTE
)net_cfg_instance_id
,
266 if (status
== ERROR_SUCCESS
&& data_type
== REG_SZ
) {
267 if (/* !strcmp (component_id, TAP_COMPONENT_ID) &&*/
268 !strcmp (net_cfg_instance_id
, guid
)) {
269 RegCloseKey (unit_key
);
270 RegCloseKey (netcard_key
);
275 RegCloseKey (unit_key
);
280 RegCloseKey (netcard_key
);
284 static int get_device_guid(
288 int actual_name_size
)
291 HKEY control_net_key
;
296 status
= RegOpenKeyEx(
298 NETWORK_CONNECTIONS_KEY
,
303 if (status
!= ERROR_SUCCESS
) {
310 char connection_string
[256];
314 const char name_string
[] = "Name";
316 len
= sizeof (enum_name
);
317 status
= RegEnumKeyEx(
327 if (status
== ERROR_NO_MORE_ITEMS
)
329 else if (status
!= ERROR_SUCCESS
) {
333 snprintf(connection_string
,
334 sizeof(connection_string
),
335 "%s\\%s\\Connection",
336 NETWORK_CONNECTIONS_KEY
, enum_name
);
338 status
= RegOpenKeyEx(
345 if (status
== ERROR_SUCCESS
) {
346 len
= sizeof (name_data
);
347 status
= RegQueryValueEx(
355 if (status
!= ERROR_SUCCESS
|| name_type
!= REG_SZ
) {
359 if (is_tap_win32_dev(enum_name
)) {
360 snprintf(name
, name_size
, "%s", enum_name
);
362 if (strcmp(actual_name
, "") != 0) {
363 if (strcmp(name_data
, actual_name
) != 0) {
364 RegCloseKey (connection_key
);
370 snprintf(actual_name
, actual_name_size
, "%s", name_data
);
377 RegCloseKey (connection_key
);
382 RegCloseKey (control_net_key
);
390 static int tap_win32_set_status(HANDLE handle
, int status
)
392 unsigned long len
= 0;
394 return DeviceIoControl(handle
, TAP_IOCTL_SET_MEDIA_STATUS
,
395 &status
, sizeof (status
),
396 &status
, sizeof (status
), &len
, NULL
);
399 static void tap_win32_overlapped_init(tap_win32_overlapped_t
* const overlapped
, const HANDLE handle
)
401 overlapped
->handle
= handle
;
403 overlapped
->read_event
= CreateEvent(NULL
, FALSE
, FALSE
, NULL
);
404 overlapped
->write_event
= CreateEvent(NULL
, FALSE
, FALSE
, NULL
);
406 overlapped
->read_overlapped
.Offset
= 0;
407 overlapped
->read_overlapped
.OffsetHigh
= 0;
408 overlapped
->read_overlapped
.hEvent
= overlapped
->read_event
;
410 overlapped
->write_overlapped
.Offset
= 0;
411 overlapped
->write_overlapped
.OffsetHigh
= 0;
412 overlapped
->write_overlapped
.hEvent
= overlapped
->write_event
;
414 InitializeCriticalSection(&overlapped
->output_queue_cs
);
415 InitializeCriticalSection(&overlapped
->free_list_cs
);
417 overlapped
->output_queue_semaphore
= CreateSemaphore(
418 NULL
, // default security attributes
420 TUN_MAX_BUFFER_COUNT
, // maximum count
421 NULL
); // unnamed semaphore
423 if(!overlapped
->output_queue_semaphore
) {
424 fprintf(stderr
, "error creating output queue semaphore!\n");
427 overlapped
->free_list_semaphore
= CreateSemaphore(
428 NULL
, // default security attributes
429 TUN_MAX_BUFFER_COUNT
, // initial count
430 TUN_MAX_BUFFER_COUNT
, // maximum count
431 NULL
); // unnamed semaphore
433 if(!overlapped
->free_list_semaphore
) {
434 fprintf(stderr
, "error creating free list semaphore!\n");
437 overlapped
->free_list
= overlapped
->output_queue_front
= overlapped
->output_queue_back
= NULL
;
441 for(index
= 0; index
< TUN_MAX_BUFFER_COUNT
; index
++) {
442 tun_buffer_t
* element
= &overlapped
->buffers
[index
];
443 element
->next
= overlapped
->free_list
;
444 overlapped
->free_list
= element
;
447 /* To count buffers, initially no-signal. */
448 overlapped
->tap_semaphore
= CreateSemaphore(NULL
, 0, TUN_MAX_BUFFER_COUNT
, NULL
);
449 if(!overlapped
->tap_semaphore
)
450 fprintf(stderr
, "error creating tap_semaphore.\n");
453 static int tap_win32_write(tap_win32_overlapped_t
*overlapped
,
454 const void *buffer
, unsigned long size
)
456 unsigned long write_size
;
460 result
= GetOverlappedResult( overlapped
->handle
, &overlapped
->write_overlapped
,
463 if (!result
&& GetLastError() == ERROR_IO_INCOMPLETE
)
464 WaitForSingleObject(overlapped
->write_event
, INFINITE
);
466 result
= WriteFile(overlapped
->handle
, buffer
, size
,
467 &write_size
, &overlapped
->write_overlapped
);
470 switch (error
= GetLastError())
472 case ERROR_IO_PENDING
:
473 #ifndef TUN_ASYNCHRONOUS_WRITES
474 WaitForSingleObject(overlapped
->write_event
, INFINITE
);
485 static DWORD WINAPI
tap_win32_thread_entry(LPVOID param
)
487 tap_win32_overlapped_t
*overlapped
= (tap_win32_overlapped_t
*)param
;
488 unsigned long read_size
;
491 tun_buffer_t
* buffer
= get_buffer_from_free_list(overlapped
);
495 result
= ReadFile(overlapped
->handle
,
497 sizeof(buffer
->buffer
),
499 &overlapped
->read_overlapped
);
501 dwError
= GetLastError();
502 if (dwError
== ERROR_IO_PENDING
) {
503 WaitForSingleObject(overlapped
->read_event
, INFINITE
);
504 result
= GetOverlappedResult( overlapped
->handle
, &overlapped
->read_overlapped
,
507 #ifdef DEBUG_TAP_WIN32
509 dwError
= GetLastError();
510 FormatMessage( FORMAT_MESSAGE_ALLOCATE_BUFFER
| FORMAT_MESSAGE_FROM_SYSTEM
,
511 NULL
, dwError
, MAKELANGID(LANG_NEUTRAL
, SUBLANG_DEFAULT
),
512 (LPTSTR
) & lpBuffer
, 0, NULL
);
513 fprintf(stderr
, "Tap-Win32: Error GetOverlappedResult %d - %s\n", dwError
, lpBuffer
);
514 LocalFree( lpBuffer
);
518 #ifdef DEBUG_TAP_WIN32
520 FormatMessage( FORMAT_MESSAGE_ALLOCATE_BUFFER
| FORMAT_MESSAGE_FROM_SYSTEM
,
521 NULL
, dwError
, MAKELANGID(LANG_NEUTRAL
, SUBLANG_DEFAULT
),
522 (LPTSTR
) & lpBuffer
, 0, NULL
);
523 fprintf(stderr
, "Tap-Win32: Error ReadFile %d - %s\n", dwError
, lpBuffer
);
524 LocalFree( lpBuffer
);
530 buffer
->read_size
= read_size
;
531 put_buffer_on_output_queue(overlapped
, buffer
);
532 ReleaseSemaphore(overlapped
->tap_semaphore
, 1, NULL
);
533 buffer
= get_buffer_from_free_list(overlapped
);
540 static int tap_win32_read(tap_win32_overlapped_t
*overlapped
,
541 uint8_t **pbuf
, int max_size
)
545 tun_buffer_t
* buffer
= get_buffer_from_output_queue_immediate(overlapped
);
548 *pbuf
= buffer
->buffer
;
549 size
= (int)buffer
->read_size
;
550 if(size
> max_size
) {
558 static void tap_win32_free_buffer(tap_win32_overlapped_t
*overlapped
,
561 tun_buffer_t
* buffer
= (tun_buffer_t
*)pbuf
;
562 put_buffer_on_free_list(overlapped
, buffer
);
565 static int tap_win32_open(tap_win32_overlapped_t
**phandle
,
566 const char *prefered_name
)
568 char device_path
[256];
569 char device_guid
[0x100];
573 char name_buffer
[0x100] = {0, };
583 if (prefered_name
!= NULL
)
584 snprintf(name_buffer
, sizeof(name_buffer
), "%s", prefered_name
);
586 rc
= get_device_guid(device_guid
, sizeof(device_guid
), name_buffer
, sizeof(name_buffer
));
590 snprintf (device_path
, sizeof(device_path
), "%s%s%s",
595 handle
= CreateFile (
597 GENERIC_READ
| GENERIC_WRITE
,
601 FILE_ATTRIBUTE_SYSTEM
| FILE_FLAG_OVERLAPPED
,
604 if (handle
== INVALID_HANDLE_VALUE
) {
608 bret
= DeviceIoControl(handle
, TAP_IOCTL_GET_VERSION
,
609 &version
, sizeof (version
),
610 &version
, sizeof (version
), &version_len
, NULL
);
617 if (!tap_win32_set_status(handle
, TRUE
)) {
621 tap_win32_overlapped_init(&tap_overlapped
, handle
);
623 *phandle
= &tap_overlapped
;
625 hThread
= CreateThread(NULL
, 0, tap_win32_thread_entry
,
626 (LPVOID
)&tap_overlapped
, 0, &idThread
);
630 /********************************************/
632 typedef struct TAPState
{
634 tap_win32_overlapped_t
*handle
;
637 static void tap_cleanup(VLANClientState
*nc
)
639 TAPState
*s
= DO_UPCAST(TAPState
, nc
, nc
);
641 qemu_del_wait_object(s
->handle
->tap_semaphore
, NULL
, NULL
);
643 /* FIXME: need to kill thread and close file handle:
648 static ssize_t
tap_receive(VLANClientState
*nc
, const uint8_t *buf
, size_t size
)
650 TAPState
*s
= DO_UPCAST(TAPState
, nc
, nc
);
652 return tap_win32_write(s
->handle
, buf
, size
);
655 static void tap_win32_send(void *opaque
)
657 TAPState
*s
= opaque
;
662 size
= tap_win32_read(s
->handle
, &buf
, max_size
);
664 qemu_send_packet(&s
->nc
, buf
, size
);
665 tap_win32_free_buffer(s
->handle
, buf
);
669 static NetClientInfo net_tap_win32_info
= {
670 .type
= NET_CLIENT_TYPE_TAP
,
671 .size
= sizeof(TAPState
),
672 .receive
= tap_receive
,
673 .cleanup
= tap_cleanup
,
676 static int tap_win32_init(VLANState
*vlan
, const char *model
,
677 const char *name
, const char *ifname
)
681 tap_win32_overlapped_t
*handle
;
683 if (tap_win32_open(&handle
, ifname
) < 0) {
684 printf("tap: Could not open '%s'\n", ifname
);
688 nc
= qemu_new_net_client(&net_tap_win32_info
, vlan
, NULL
, model
, name
);
690 s
= DO_UPCAST(TAPState
, nc
, nc
);
692 snprintf(s
->nc
.info_str
, sizeof(s
->nc
.info_str
),
693 "tap: ifname=%s", ifname
);
697 qemu_add_wait_object(s
->handle
->tap_semaphore
, tap_win32_send
, s
);
702 int net_init_tap(QemuOpts
*opts
, Monitor
*mon
, const char *name
, VLANState
*vlan
)
706 ifname
= qemu_opt_get(opts
, "ifname");
709 error_report("tap: no interface name");
713 if (tap_win32_init(vlan
, "tap", name
, ifname
) == -1) {
720 int tap_has_ufo(VLANClientState
*vc
)
725 int tap_has_vnet_hdr(VLANClientState
*vc
)
730 void tap_using_vnet_hdr(VLANClientState
*vc
, int using_vnet_hdr
)
734 void tap_set_offload(VLANClientState
*vc
, int csum
, int tso4
,
735 int tso6
, int ecn
, int ufo
)