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/>.
28 #include "qemu-common.h"
39 #define TAP_CONTROL_CODE(request,method) \
40 CTL_CODE (FILE_DEVICE_UNKNOWN, request, method, FILE_ANY_ACCESS)
42 #define TAP_IOCTL_GET_MAC TAP_CONTROL_CODE (1, METHOD_BUFFERED)
43 #define TAP_IOCTL_GET_VERSION TAP_CONTROL_CODE (2, METHOD_BUFFERED)
44 #define TAP_IOCTL_GET_MTU TAP_CONTROL_CODE (3, METHOD_BUFFERED)
45 #define TAP_IOCTL_GET_INFO TAP_CONTROL_CODE (4, METHOD_BUFFERED)
46 #define TAP_IOCTL_CONFIG_POINT_TO_POINT TAP_CONTROL_CODE (5, METHOD_BUFFERED)
47 #define TAP_IOCTL_SET_MEDIA_STATUS TAP_CONTROL_CODE (6, METHOD_BUFFERED)
48 #define TAP_IOCTL_CONFIG_DHCP_MASQ TAP_CONTROL_CODE (7, METHOD_BUFFERED)
49 #define TAP_IOCTL_GET_LOG_LINE TAP_CONTROL_CODE (8, METHOD_BUFFERED)
50 #define TAP_IOCTL_CONFIG_DHCP_SET_OPT TAP_CONTROL_CODE (9, METHOD_BUFFERED)
56 #define ADAPTER_KEY "SYSTEM\\CurrentControlSet\\Control\\Class\\{4D36E972-E325-11CE-BFC1-08002BE10318}"
58 #define NETWORK_CONNECTIONS_KEY "SYSTEM\\CurrentControlSet\\Control\\Network\\{4D36E972-E325-11CE-BFC1-08002BE10318}"
60 //======================
61 // Filesystem prefixes
62 //======================
64 #define USERMODEDEVICEDIR "\\\\.\\Global\\"
65 #define TAPSUFFIX ".tap"
68 //======================
69 // Compile time configuration
70 //======================
72 //#define DEBUG_TAP_WIN32
74 #define TUN_ASYNCHRONOUS_WRITES 1
76 #define TUN_BUFFER_SIZE 1560
77 #define TUN_MAX_BUFFER_COUNT 32
80 * The data member "buffer" must be the first element in the tun_buffer
81 * structure. See the function, tap_win32_free_buffer.
83 typedef struct tun_buffer_s {
84 unsigned char buffer [TUN_BUFFER_SIZE];
85 unsigned long read_size;
86 struct tun_buffer_s* next;
89 typedef struct tap_win32_overlapped {
93 HANDLE output_queue_semaphore;
94 HANDLE free_list_semaphore;
96 CRITICAL_SECTION output_queue_cs;
97 CRITICAL_SECTION free_list_cs;
98 OVERLAPPED read_overlapped;
99 OVERLAPPED write_overlapped;
100 tun_buffer_t buffers[TUN_MAX_BUFFER_COUNT];
101 tun_buffer_t* free_list;
102 tun_buffer_t* output_queue_front;
103 tun_buffer_t* output_queue_back;
104 } tap_win32_overlapped_t;
106 static tap_win32_overlapped_t tap_overlapped;
108 static tun_buffer_t* get_buffer_from_free_list(tap_win32_overlapped_t* const overlapped)
110 tun_buffer_t* buffer = NULL;
111 WaitForSingleObject(overlapped->free_list_semaphore, INFINITE);
112 EnterCriticalSection(&overlapped->free_list_cs);
113 buffer = overlapped->free_list;
114 // assert(buffer != NULL);
115 overlapped->free_list = buffer->next;
116 LeaveCriticalSection(&overlapped->free_list_cs);
121 static void put_buffer_on_free_list(tap_win32_overlapped_t* const overlapped, tun_buffer_t* const buffer)
123 EnterCriticalSection(&overlapped->free_list_cs);
124 buffer->next = overlapped->free_list;
125 overlapped->free_list = buffer;
126 LeaveCriticalSection(&overlapped->free_list_cs);
127 ReleaseSemaphore(overlapped->free_list_semaphore, 1, NULL);
130 static tun_buffer_t* get_buffer_from_output_queue(tap_win32_overlapped_t* const overlapped, const int block)
132 tun_buffer_t* buffer = NULL;
133 DWORD result, timeout = block ? INFINITE : 0L;
136 result = WaitForSingleObject(overlapped->output_queue_semaphore, timeout);
140 // The semaphore object was signaled.
142 EnterCriticalSection(&overlapped->output_queue_cs);
144 buffer = overlapped->output_queue_front;
145 overlapped->output_queue_front = buffer->next;
147 if(overlapped->output_queue_front == NULL) {
148 overlapped->output_queue_back = NULL;
151 LeaveCriticalSection(&overlapped->output_queue_cs);
154 // Semaphore was nonsignaled, so a time-out occurred.
156 // Cannot open another window.
163 static tun_buffer_t* get_buffer_from_output_queue_immediate (tap_win32_overlapped_t* const overlapped)
165 return get_buffer_from_output_queue(overlapped, 0);
168 static void put_buffer_on_output_queue(tap_win32_overlapped_t* const overlapped, tun_buffer_t* const buffer)
170 EnterCriticalSection(&overlapped->output_queue_cs);
172 if(overlapped->output_queue_front == NULL && overlapped->output_queue_back == NULL) {
173 overlapped->output_queue_front = overlapped->output_queue_back = buffer;
176 overlapped->output_queue_back->next = buffer;
177 overlapped->output_queue_back = buffer;
180 LeaveCriticalSection(&overlapped->output_queue_cs);
182 ReleaseSemaphore(overlapped->output_queue_semaphore, 1, NULL);
186 static int is_tap_win32_dev(const char *guid)
193 status = RegOpenKeyEx(
200 if (status != ERROR_SUCCESS) {
206 char unit_string[256];
208 char component_id_string[] = "ComponentId";
209 char component_id[256];
210 char net_cfg_instance_id_string[] = "NetCfgInstanceId";
211 char net_cfg_instance_id[256];
214 len = sizeof (enum_name);
215 status = RegEnumKeyEx(
225 if (status == ERROR_NO_MORE_ITEMS)
227 else if (status != ERROR_SUCCESS) {
231 snprintf (unit_string, sizeof(unit_string), "%s\\%s",
232 ADAPTER_KEY, enum_name);
234 status = RegOpenKeyEx(
241 if (status != ERROR_SUCCESS) {
244 len = sizeof (component_id);
245 status = RegQueryValueEx(
250 (LPBYTE)component_id,
253 if (!(status != ERROR_SUCCESS || data_type != REG_SZ)) {
254 len = sizeof (net_cfg_instance_id);
255 status = RegQueryValueEx(
257 net_cfg_instance_id_string,
260 (LPBYTE)net_cfg_instance_id,
263 if (status == ERROR_SUCCESS && data_type == REG_SZ) {
264 if (/* !strcmp (component_id, TAP_COMPONENT_ID) &&*/
265 !strcmp (net_cfg_instance_id, guid)) {
266 RegCloseKey (unit_key);
267 RegCloseKey (netcard_key);
272 RegCloseKey (unit_key);
277 RegCloseKey (netcard_key);
281 static int get_device_guid(
285 int actual_name_size)
288 HKEY control_net_key;
293 status = RegOpenKeyEx(
295 NETWORK_CONNECTIONS_KEY,
300 if (status != ERROR_SUCCESS) {
307 char connection_string[256];
311 const char name_string[] = "Name";
313 len = sizeof (enum_name);
314 status = RegEnumKeyEx(
324 if (status == ERROR_NO_MORE_ITEMS)
326 else if (status != ERROR_SUCCESS) {
330 snprintf(connection_string,
331 sizeof(connection_string),
332 "%s\\%s\\Connection",
333 NETWORK_CONNECTIONS_KEY, enum_name);
335 status = RegOpenKeyEx(
342 if (status == ERROR_SUCCESS) {
343 len = sizeof (name_data);
344 status = RegQueryValueEx(
352 if (status != ERROR_SUCCESS || name_type != REG_SZ) {
356 if (is_tap_win32_dev(enum_name)) {
357 snprintf(name, name_size, "%s", enum_name);
359 if (strcmp(actual_name, "") != 0) {
360 if (strcmp(name_data, actual_name) != 0) {
361 RegCloseKey (connection_key);
367 snprintf(actual_name, actual_name_size, "%s", name_data);
374 RegCloseKey (connection_key);
379 RegCloseKey (control_net_key);
387 static int tap_win32_set_status(HANDLE handle, int status)
389 unsigned long len = 0;
391 return DeviceIoControl(handle, TAP_IOCTL_SET_MEDIA_STATUS,
392 &status, sizeof (status),
393 &status, sizeof (status), &len, NULL);
396 static void tap_win32_overlapped_init(tap_win32_overlapped_t* const overlapped, const HANDLE handle)
398 overlapped->handle = handle;
400 overlapped->read_event = CreateEvent(NULL, FALSE, FALSE, NULL);
401 overlapped->write_event = CreateEvent(NULL, FALSE, FALSE, NULL);
403 overlapped->read_overlapped.Offset = 0;
404 overlapped->read_overlapped.OffsetHigh = 0;
405 overlapped->read_overlapped.hEvent = overlapped->read_event;
407 overlapped->write_overlapped.Offset = 0;
408 overlapped->write_overlapped.OffsetHigh = 0;
409 overlapped->write_overlapped.hEvent = overlapped->write_event;
411 InitializeCriticalSection(&overlapped->output_queue_cs);
412 InitializeCriticalSection(&overlapped->free_list_cs);
414 overlapped->output_queue_semaphore = CreateSemaphore(
415 NULL, // default security attributes
417 TUN_MAX_BUFFER_COUNT, // maximum count
418 NULL); // unnamed semaphore
420 if(!overlapped->output_queue_semaphore) {
421 fprintf(stderr, "error creating output queue semaphore!\n");
424 overlapped->free_list_semaphore = CreateSemaphore(
425 NULL, // default security attributes
426 TUN_MAX_BUFFER_COUNT, // initial count
427 TUN_MAX_BUFFER_COUNT, // maximum count
428 NULL); // unnamed semaphore
430 if(!overlapped->free_list_semaphore) {
431 fprintf(stderr, "error creating free list semaphore!\n");
434 overlapped->free_list = overlapped->output_queue_front = overlapped->output_queue_back = NULL;
438 for(index = 0; index < TUN_MAX_BUFFER_COUNT; index++) {
439 tun_buffer_t* element = &overlapped->buffers[index];
440 element->next = overlapped->free_list;
441 overlapped->free_list = element;
444 /* To count buffers, initially no-signal. */
445 overlapped->tap_semaphore = CreateSemaphore(NULL, 0, TUN_MAX_BUFFER_COUNT, NULL);
446 if(!overlapped->tap_semaphore)
447 fprintf(stderr, "error creating tap_semaphore.\n");
450 static int tap_win32_write(tap_win32_overlapped_t *overlapped,
451 const void *buffer, unsigned long size)
453 unsigned long write_size;
457 result = GetOverlappedResult( overlapped->handle, &overlapped->write_overlapped,
460 if (!result && GetLastError() == ERROR_IO_INCOMPLETE)
461 WaitForSingleObject(overlapped->write_event, INFINITE);
463 result = WriteFile(overlapped->handle, buffer, size,
464 &write_size, &overlapped->write_overlapped);
467 switch (error = GetLastError())
469 case ERROR_IO_PENDING:
470 #ifndef TUN_ASYNCHRONOUS_WRITES
471 WaitForSingleObject(overlapped->write_event, INFINITE);
482 static DWORD WINAPI tap_win32_thread_entry(LPVOID param)
484 tap_win32_overlapped_t *overlapped = (tap_win32_overlapped_t*)param;
485 unsigned long read_size;
488 tun_buffer_t* buffer = get_buffer_from_free_list(overlapped);
492 result = ReadFile(overlapped->handle,
494 sizeof(buffer->buffer),
496 &overlapped->read_overlapped);
498 dwError = GetLastError();
499 if (dwError == ERROR_IO_PENDING) {
500 WaitForSingleObject(overlapped->read_event, INFINITE);
501 result = GetOverlappedResult( overlapped->handle, &overlapped->read_overlapped,
504 #ifdef DEBUG_TAP_WIN32
506 dwError = GetLastError();
507 FormatMessage( FORMAT_MESSAGE_ALLOCATE_BUFFER | FORMAT_MESSAGE_FROM_SYSTEM,
508 NULL, dwError, MAKELANGID(LANG_NEUTRAL, SUBLANG_DEFAULT),
509 (LPTSTR) & lpBuffer, 0, NULL );
510 fprintf(stderr, "Tap-Win32: Error GetOverlappedResult %d - %s\n", dwError, lpBuffer);
511 LocalFree( lpBuffer );
515 #ifdef DEBUG_TAP_WIN32
517 FormatMessage( FORMAT_MESSAGE_ALLOCATE_BUFFER | FORMAT_MESSAGE_FROM_SYSTEM,
518 NULL, dwError, MAKELANGID(LANG_NEUTRAL, SUBLANG_DEFAULT),
519 (LPTSTR) & lpBuffer, 0, NULL );
520 fprintf(stderr, "Tap-Win32: Error ReadFile %d - %s\n", dwError, lpBuffer);
521 LocalFree( lpBuffer );
527 buffer->read_size = read_size;
528 put_buffer_on_output_queue(overlapped, buffer);
529 ReleaseSemaphore(overlapped->tap_semaphore, 1, NULL);
530 buffer = get_buffer_from_free_list(overlapped);
537 static int tap_win32_read(tap_win32_overlapped_t *overlapped,
538 uint8_t **pbuf, int max_size)
542 tun_buffer_t* buffer = get_buffer_from_output_queue_immediate(overlapped);
545 *pbuf = buffer->buffer;
546 size = (int)buffer->read_size;
547 if(size > max_size) {
555 static void tap_win32_free_buffer(tap_win32_overlapped_t *overlapped,
558 tun_buffer_t* buffer = (tun_buffer_t*)pbuf;
559 put_buffer_on_free_list(overlapped, buffer);
562 static int tap_win32_open(tap_win32_overlapped_t **phandle,
563 const char *prefered_name)
565 char device_path[256];
566 char device_guid[0x100];
570 char name_buffer[0x100] = {0, };
580 if (prefered_name != NULL)
581 snprintf(name_buffer, sizeof(name_buffer), "%s", prefered_name);
583 rc = get_device_guid(device_guid, sizeof(device_guid), name_buffer, sizeof(name_buffer));
587 snprintf (device_path, sizeof(device_path), "%s%s%s",
592 handle = CreateFile (
594 GENERIC_READ | GENERIC_WRITE,
598 FILE_ATTRIBUTE_SYSTEM | FILE_FLAG_OVERLAPPED,
601 if (handle == INVALID_HANDLE_VALUE) {
605 bret = DeviceIoControl(handle, TAP_IOCTL_GET_VERSION,
606 &version, sizeof (version),
607 &version, sizeof (version), &version_len, NULL);
614 if (!tap_win32_set_status(handle, TRUE)) {
618 tap_win32_overlapped_init(&tap_overlapped, handle);
620 *phandle = &tap_overlapped;
622 hThread = CreateThread(NULL, 0, tap_win32_thread_entry,
623 (LPVOID)&tap_overlapped, 0, &idThread);
627 /********************************************/
629 typedef struct TAPState {
631 tap_win32_overlapped_t *handle;
634 static void tap_cleanup(VLANClientState *vc)
636 TAPState *s = vc->opaque;
638 qemu_del_wait_object(s->handle->tap_semaphore, NULL, NULL);
640 /* FIXME: need to kill thread and close file handle:
646 static ssize_t tap_receive(VLANClientState *vc, const uint8_t *buf, size_t size)
648 TAPState *s = vc->opaque;
650 return tap_win32_write(s->handle, buf, size);
653 static void tap_win32_send(void *opaque)
655 TAPState *s = opaque;
660 size = tap_win32_read(s->handle, &buf, max_size);
662 qemu_send_packet(s->vc, buf, size);
663 tap_win32_free_buffer(s->handle, buf);
667 int tap_win32_init(VLANState *vlan, const char *model,
668 const char *name, const char *ifname)
672 s = qemu_mallocz(sizeof(TAPState));
675 if (tap_win32_open(&s->handle, ifname) < 0) {
676 printf("tap: Could not open '%s'\n", ifname);
680 s->vc = qemu_new_vlan_client(vlan, model, name, NULL, tap_receive,
681 NULL, tap_cleanup, s);
683 snprintf(s->vc->info_str, sizeof(s->vc->info_str),
684 "tap: ifname=%s", ifname);
686 qemu_add_wait_object(s->handle->tap_semaphore, tap_win32_send, s);