Fix compatibility with TAP-Win32 9.0.0.21 and later.
[tinc] / src / mingw / device.c
index 4a962fe..49b833a 100644 (file)
@@ -1,7 +1,7 @@
 /*
-    device.c -- Interaction with CIPE driver in a MinGW environment
-    Copyright (C) 2002-2003 Ivo Timmermans <ivo@o2w.nl>,
-                  2002-2003 Guus Sliepen <guus@sliepen.eu.org>
+    device.c -- Interaction with Windows tap driver in a MinGW environment
+    Copyright (C) 2002-2005 Ivo Timmermans,
+                  2002-2014 Guus Sliepen <guus@tinc-vpn.org>
 
     This program is free software; you can redistribute it and/or modify
     it under the terms of the GNU General Public License as published by
     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
     GNU General Public License for more details.
 
-    You should have received a copy of the GNU General Public License
-    along with this program; if not, write to the Free Software
-    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
-
-    $Id: device.c,v 1.1.2.3 2003/07/28 21:54:03 guus Exp $
+    You should have received a copy of the GNU General Public License along
+    with this program; if not, write to the Free Software Foundation, Inc.,
+    51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 */
 
-#include "system.h"
+#include "../system.h"
 
 #include <windows.h>
 #include <winioctl.h>
 
-#include "conf.h"
-#include "logger.h"
-#include "net.h"
-#include "route.h"
-#include "utils.h"
-#include "xalloc.h"
-
-#define NETCARD_REG_KEY_2000 "SYSTEM\\CurrentControlSet\\Control\\Class\\{4D36E972-E325-11CE-BFC1-08002BE10318}"
-#define NETCARD_REG_KEY      "SOFTWARE\\Microsoft\\Windows NT\\CurrentVersion\\NetworkCards"
-#define REG_SERVICE_KEY      "SYSTEM\\CurrentControlSet\\Services"
-#define REG_CONTROL_NET      "SYSTEM\\CurrentControlSet\\Control\\Network\\{4D36E972-E325-11CE-BFC1-08002BE10318}"
-
-#define USERMODEDEVICEDIR "\\\\.\\"
-#define SYSDEVICEDIR  "\\Device\\"
-#define USERDEVICEDIR "\\??\\"
-#define TAPSUFFIX     ".tap"
-
-#define TAP_CONTROL_CODE(request,method) CTL_CODE(FILE_DEVICE_PHYSICAL_NETCARD | 8000, request, method, FILE_ANY_ACCESS)
+#include "../conf.h"
+#include "../device.h"
+#include "../logger.h"
+#include "../net.h"
+#include "../route.h"
+#include "../utils.h"
+#include "../xalloc.h"
 
-#define TAP_IOCTL_GET_LASTMAC    TAP_CONTROL_CODE(0, METHOD_BUFFERED)
-#define TAP_IOCTL_GET_MAC        TAP_CONTROL_CODE(1, METHOD_BUFFERED)
-#define TAP_IOCTL_SET_STATISTICS TAP_CONTROL_CODE(2, METHOD_BUFFERED)
+#include "common.h"
 
-/* FIXME: This only works for Windows 2000 */
-#define OSTYPE 5
-
-HANDLE device_fd = INVALID_HANDLE_VALUE;
+int device_fd = -1;
+static HANDLE device_handle = INVALID_HANDLE_VALUE;
 char *device = NULL;
 char *iface = NULL;
-char *device_info = NULL;
+static char *device_info = NULL;
+
+static uint64_t device_total_in = 0;
+static uint64_t device_total_out = 0;
+
+extern char *myport;
+OVERLAPPED r_overlapped;
+OVERLAPPED w_overlapped;
+
+static DWORD WINAPI tapreader(void *bla) {
+       int status;
+       DWORD len;
+       vpn_packet_t packet;
+       int errors = 0;
+
+       logger(LOG_DEBUG, "Tap reader running");
+
+       /* Read from tap device and send to parent */
+
+       r_overlapped.hEvent = CreateEvent(NULL, TRUE, FALSE, NULL);
+
+       for(;;) {
+               ResetEvent(r_overlapped.hEvent);
+
+               status = ReadFile(device_handle, packet.data, MTU, &len, &r_overlapped);
+
+               if(!status) {
+                       if(GetLastError() == ERROR_IO_PENDING) {
+                               WaitForSingleObject(r_overlapped.hEvent, INFINITE);
+                               if(!GetOverlappedResult(device_handle, &r_overlapped, &len, FALSE))
+                                       continue;
+                       } else {
+                               logger(LOG_ERR, "Error while reading from %s %s: %s", device_info,
+                                          device, strerror(errno));
+                               errors++;
+                               if(errors >= 10) {
+                                       EnterCriticalSection(&mutex);
+                                       running = false;
+                                       LeaveCriticalSection(&mutex);
+                               }
+                               usleep(1000000);
+                               continue;
+                       }
+               }
 
-int device_total_in = 0;
-int device_total_out = 0;
+               errors = 0;
+               packet.len = len;
+               packet.priority = 0;
 
-bool setup_device(void)
-{
+               EnterCriticalSection(&mutex);
+               route(myself, &packet);
+               LeaveCriticalSection(&mutex);
+       }
+
+       return 0;
+}
+
+static bool setup_device(void) {
        HKEY key, key2;
        int i;
 
@@ -68,20 +102,21 @@ bool setup_device(void)
        char adapterid[1024];
        char adaptername[1024];
        char tapname[1024];
-       char gelukt = 0;
-       long len;
+       DWORD len;
+       unsigned long status;
 
        bool found = false;
 
-       cp();
+       int err;
+       HANDLE thread;
 
        get_config_string(lookup_config(config_tree, "Device"), &device);
        get_config_string(lookup_config(config_tree, "Interface"), &iface);
 
        /* Open registry and look for network adapters */
 
-       if(RegOpenKeyEx(HKEY_LOCAL_MACHINE, REG_CONTROL_NET, 0, KEY_READ, &key)) {
-               logger(LOG_ERR, _("Unable to read registry"));
+       if(RegOpenKeyEx(HKEY_LOCAL_MACHINE, NETWORK_CONNECTIONS_KEY, 0, KEY_READ, &key)) {
+               logger(LOG_ERR, "Unable to read registry: %s", winerror(GetLastError()));
                return false;
        }
 
@@ -90,6 +125,21 @@ bool setup_device(void)
                if(RegEnumKeyEx(key, i, adapterid, &len, 0, 0, 0, NULL))
                        break;
 
+               /* Find out more about this adapter */
+
+               snprintf(regpath, sizeof(regpath), "%s\\%s\\Connection", NETWORK_CONNECTIONS_KEY, adapterid);
+
+                if(RegOpenKeyEx(HKEY_LOCAL_MACHINE, regpath, 0, KEY_READ, &key2))
+                       continue;
+
+               len = sizeof(adaptername);
+               err = RegQueryValueEx(key2, "Name", 0, 0, (LPBYTE)adaptername, &len);
+
+               RegCloseKey(key2);
+
+               if(err)
+                       continue;
+
                if(device) {
                        if(!strcmp(device, adapterid)) {
                                found = true;
@@ -98,18 +148,6 @@ bool setup_device(void)
                                continue;
                }
 
-               /* Find out more about this adapter */
-
-               snprintf(regpath, sizeof(regpath), "%s\\%s\\Connection", REG_CONTROL_NET, adapterid);
-
-                if(RegOpenKeyEx(HKEY_LOCAL_MACHINE, regpath, 0, KEY_READ, &key2)) {
-                       logger(LOG_ERR, _("Unable to read registry"));
-                       return false;
-               }
-
-               len = sizeof(adaptername);
-               RegQueryValueEx(key2, "Name", 0, 0, adaptername, &len);
-
                if(iface) {
                        if(!strcmp(iface, adaptername)) {
                                found = true;
@@ -119,37 +157,42 @@ bool setup_device(void)
                }
 
                snprintf(tapname, sizeof(tapname), USERMODEDEVICEDIR "%s" TAPSUFFIX, adapterid);
-               device_fd = CreateFile(tapname, GENERIC_WRITE | GENERIC_READ, 0, 0, OPEN_EXISTING, FILE_ATTRIBUTE_SYSTEM, 0);
-               if(device_fd != INVALID_HANDLE_VALUE) {
+               device_handle = CreateFile(tapname, GENERIC_WRITE | GENERIC_READ, 0, 0, OPEN_EXISTING, FILE_ATTRIBUTE_SYSTEM | FILE_FLAG_OVERLAPPED, 0);
+               if(device_handle != INVALID_HANDLE_VALUE) {
                        found = true;
                        break;
                }
        }
 
+       RegCloseKey(key);
+
        if(!found) {
-               logger(LOG_ERR, _("No Windows tap device found!"));
+               logger(LOG_ERR, "No Windows tap device found!");
                return false;
        }
 
-       device = adapterid;
-       iface = adaptername;
+       if(!device)
+               device = xstrdup(adapterid);
+
+       if(!iface)
+               iface = xstrdup(adaptername);
 
        /* Try to open the corresponding tap device */
 
-       if(device_fd == INVALID_HANDLE_VALUE) {
+       if(device_handle == INVALID_HANDLE_VALUE) {
                snprintf(tapname, sizeof(tapname), USERMODEDEVICEDIR "%s" TAPSUFFIX, device);
-               device_fd = CreateFile(tapname, GENERIC_WRITE | GENERIC_READ, 0, 0, OPEN_EXISTING, FILE_ATTRIBUTE_SYSTEM, 0);
+               device_handle = CreateFile(tapname, GENERIC_WRITE | GENERIC_READ, 0, 0, OPEN_EXISTING, FILE_ATTRIBUTE_SYSTEM | FILE_FLAG_OVERLAPPED, 0);
        }
        
-       if(device_fd == INVALID_HANDLE_VALUE) {
-               logger(LOG_ERR, _("%s (%s) is no a usable Windows tap device!"), device, iface);
+       if(device_handle == INVALID_HANDLE_VALUE) {
+               logger(LOG_ERR, "%s (%s) is not a usable Windows tap device: %s", device, iface, winerror(GetLastError()));
                return false;
        }
 
        /* Get MAC address from tap device */
 
-       if(DeviceIoControl(device_fd, TAP_IOCTL_GET_MAC, mymac.x, sizeof(mymac.x), mymac.x, sizeof(mymac.x), &len, 0)) {
-               logger(LOG_ERR, _("Could not get MAC address from Windows tap device!"));
+       if(!DeviceIoControl(device_handle, TAP_IOCTL_GET_MAC, mymac.x, sizeof(mymac.x), mymac.x, sizeof(mymac.x), &len, 0)) {
+               logger(LOG_ERR, "Could not get MAC address from Windows tap device %s (%s): %s", device, iface, winerror(GetLastError()));
                return false;
        }
 
@@ -157,57 +200,87 @@ bool setup_device(void)
                overwrite_mac = 1;
        }
 
-       if(!get_config_string(lookup_config(config_tree, "Interface"), &iface))
-               iface = device;
+       /* Create overlapped events for tap I/O */
 
-       device_info = _("Windows tap device");
+       r_overlapped.hEvent = CreateEvent(NULL, TRUE, FALSE, NULL);
+       w_overlapped.hEvent = CreateEvent(NULL, TRUE, TRUE, NULL);
 
-       logger(LOG_INFO, _("%s (%s) is a %s"), device, iface, device_info);
+       /* Start the tap reader */
 
-       return true;
-}
+       thread = CreateThread(NULL, 0, tapreader, NULL, 0, NULL);
 
-void close_device(void)
-{
-       cp();
+       if(!thread) {
+               logger(LOG_ERR, "System call `%s' failed: %s", "CreateThread", winerror(GetLastError()));
+               return false;
+       }
 
-       CloseHandle(device_fd);
-}
+       /* Set media status for newer TAP-Win32 devices */
 
-bool read_packet(vpn_packet_t *packet)
-{
-       int lenin;
+       status = true;
+       DeviceIoControl(device_handle, TAP_IOCTL_SET_MEDIA_STATUS, &status, sizeof(status), &status, sizeof(status), &len, NULL);
 
-       cp();
+       device_info = "Windows tap device";
 
-       if(!ReadFile(device_fd, packet->data, MTU, &lenin, NULL)) {
-               logger(LOG_ERR, _("Error while reading from %s %s: %s"), device_info,
-                          device, strerror(errno));
-               return false;
-       }
-       
-       packet->len = lenin;
+       logger(LOG_INFO, "%s (%s) is a %s", device, iface, device_info);
 
-       device_total_in += packet->len;
+       return true;
+}
 
-       ifdebug(TRAFFIC) logger(LOG_DEBUG, _("Read packet of %d bytes from %s"), packet->len,
-                          device_info);
+static void close_device(void) {
+       CloseHandle(device_handle);
 
-       return true;
+       free(device);
+       free(iface);
 }
 
-bool write_packet(vpn_packet_t *packet)
-{
-       int lenout;
+static bool read_packet(vpn_packet_t *packet) {
+       return false;
+}
 
-       cp();
+static bool write_packet(vpn_packet_t *packet) {
+       DWORD lenout;
+       static vpn_packet_t queue;
 
-       ifdebug(TRAFFIC) logger(LOG_DEBUG, _("Writing packet of %d bytes to %s"),
+       ifdebug(TRAFFIC) logger(LOG_DEBUG, "Writing packet of %d bytes to %s",
                           packet->len, device_info);
 
-       if(!WriteFile(device_fd, packet->data, packet->len, &lenout, NULL)) {
-               logger(LOG_ERR, "Error while writing to %s %s", device_info, device);
-               return false;
+       /* Check if there is something in progress */
+
+       if(queue.len) {
+               DWORD size;
+               BOOL success = GetOverlappedResult(device_handle, &w_overlapped, &size, FALSE);
+               if(success) {
+                       ResetEvent(&w_overlapped);
+                       queue.len = 0;
+               } else {
+                       int err = GetLastError();
+                       if(err != ERROR_IO_INCOMPLETE) {
+                               ifdebug(TRAFFIC) logger(LOG_DEBUG, "Error completing previously queued write: %s", winerror(err));
+                               ResetEvent(&w_overlapped);
+                               queue.len = 0;
+                       } else {
+                               ifdebug(TRAFFIC) logger(LOG_DEBUG, "Previous overlapped write still in progress");
+                               // drop this packet
+                               return true;
+                       }
+               }
+       }
+
+       /* Otherwise, try to write. */
+
+       memcpy(queue.data, packet->data, packet->len);
+
+       if(!WriteFile(device_handle, queue.data, packet->len, &lenout, &w_overlapped)) {
+               int err = GetLastError();
+               if(err != ERROR_IO_PENDING) {
+                       logger(LOG_ERR, "Error while writing to %s %s: %s", device_info, device, winerror(err));
+                       return false;
+               }
+               // Write is being done asynchronously.
+               queue.len = packet->len;
+       } else {
+               // Write was completed immediately.
+               ResetEvent(&w_overlapped);
        }
 
        device_total_out += packet->len;
@@ -215,11 +288,16 @@ bool write_packet(vpn_packet_t *packet)
        return true;
 }
 
-void dump_device_stats(void)
-{
-       cp();
-
-       logger(LOG_DEBUG, _("Statistics for %s %s:"), device_info, device);
-       logger(LOG_DEBUG, _(" total bytes in:  %10d"), device_total_in);
-       logger(LOG_DEBUG, _(" total bytes out: %10d"), device_total_out);
+static void dump_device_stats(void) {
+       logger(LOG_DEBUG, "Statistics for %s %s:", device_info, device);
+       logger(LOG_DEBUG, " total bytes in:  %10"PRIu64, device_total_in);
+       logger(LOG_DEBUG, " total bytes out: %10"PRIu64, device_total_out);
 }
+
+const devops_t os_devops = {
+       .setup = setup_device,
+       .close = close_device,
+       .read = read_packet,
+       .write = write_packet,
+       .dump_stats = dump_device_stats,
+};