/*
- 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"
+#include "../conf.h"
+#include "../device.h"
+#include "../logger.h"
+#include "../names.h"
+#include "../net.h"
+#include "../route.h"
+#include "../utils.h"
+#include "../xalloc.h"
+
+#include "common.h"
+
+int device_fd = -1;
+static HANDLE device_handle = INVALID_HANDLE_VALUE;
+static io_t device_read_io;
+static OVERLAPPED device_read_overlapped;
+static OVERLAPPED device_write_overlapped;
+static vpn_packet_t device_read_packet;
+static vpn_packet_t device_write_packet;
+char *device = NULL;
+char *iface = NULL;
+static const char *device_info = "Windows tap device";
-#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}"
+extern char *myport;
-#define USERMODEDEVICEDIR "\\\\.\\"
-#define SYSDEVICEDIR "\\Device\\"
-#define USERDEVICEDIR "\\??\\"
-#define TAPSUFFIX ".tap"
+static void device_issue_read() {
+ int status;
-#define TAP_CONTROL_CODE(request,method) CTL_CODE(FILE_DEVICE_PHYSICAL_NETCARD | 8000, request, method, FILE_ANY_ACCESS)
+ for(;;) {
+ ResetEvent(device_read_overlapped.hEvent);
-#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)
+ DWORD len;
+ status = ReadFile(device_handle, (void *)device_read_packet.data, MTU, &len, &device_read_overlapped);
-/* FIXME: This only works for Windows 2000 */
-#define OSTYPE 5
+ if(!status) {
+ if(GetLastError() != ERROR_IO_PENDING)
+ logger(DEBUG_ALWAYS, LOG_ERR, "Error while reading from %s %s: %s", device_info,
+ device, strerror(errno));
-HANDLE device_fd = INVALID_HANDLE_VALUE;
-char *device = NULL;
-char *iface = NULL;
-char *device_info = NULL;
+ break;
+ }
+
+ device_read_packet.len = len;
+ device_read_packet.priority = 0;
+ route(myself, &device_read_packet);
+ }
+}
+
+static void device_handle_read(void *data, int flags) {
+ DWORD len;
-int device_total_in = 0;
-int device_total_out = 0;
+ if(!GetOverlappedResult(device_handle, &device_read_overlapped, &len, FALSE)) {
+ logger(DEBUG_ALWAYS, LOG_ERR, "Error getting read result from %s %s: %s", device_info,
+ device, strerror(errno));
-bool setup_device(void)
-{
+ if(GetLastError() != ERROR_IO_INCOMPLETE) {
+ /* Must reset event or it will keep firing. */
+ ResetEvent(device_read_overlapped.hEvent);
+ }
+
+ return;
+ }
+
+ device_read_packet.len = len;
+ device_read_packet.priority = 0;
+ route(myself, &device_read_packet);
+ device_issue_read();
+}
+
+static bool setup_device(void) {
HKEY key, key2;
int i;
char adapterid[1024];
char adaptername[1024];
char tapname[1024];
- char gelukt = 0;
- long len;
+ DWORD len;
bool found = false;
- cp();
+ int err;
get_config_string(lookup_config(config_tree, "Device"), &device);
get_config_string(lookup_config(config_tree, "Interface"), &iface);
+ if(device && iface) {
+ logger(DEBUG_ALWAYS, LOG_WARNING, "Warning: both Device and Interface specified, results may not be as expected");
+ }
+
/* 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(DEBUG_ALWAYS, LOG_ERR, "Unable to read registry: %s", winerror(GetLastError()));
return false;
}
- for (i = 0; ; i++) {
+ for(i = 0; ; i++) {
len = sizeof(adapterid);
- if(RegEnumKeyEx(key, i, adapterid, &len, 0, 0, 0, NULL))
- break;
- if(device) {
- if(!strcmp(device, adapterid)) {
- found = true;
- break;
- } else
- continue;
+ if(RegEnumKeyEx(key, i, adapterid, &len, 0, 0, 0, NULL)) {
+ break;
}
/* Find out more about this adapter */
- snprintf(regpath, sizeof(regpath), "%s\\%s\\Connection", REG_CONTROL_NET, adapterid);
+ snprintf(regpath, sizeof(regpath), "%s\\%s\\Connection", NETWORK_CONNECTIONS_KEY, adapterid);
- if(RegOpenKeyEx(HKEY_LOCAL_MACHINE, regpath, 0, KEY_READ, &key2)) {
- logger(LOG_ERR, _("Unable to read registry"));
- return false;
+ if(RegOpenKeyEx(HKEY_LOCAL_MACHINE, regpath, 0, KEY_READ, &key2)) {
+ continue;
}
len = sizeof(adaptername);
- RegQueryValueEx(key2, "Name", 0, 0, adaptername, &len);
+ err = RegQueryValueEx(key2, "Name", 0, 0, (LPBYTE)adaptername, &len);
+
+ RegCloseKey(key2);
+
+ if(err) {
+ continue;
+ }
+
+ if(device) {
+ if(!strcmp(device, adapterid)) {
+ found = true;
+ break;
+ } else {
+ continue;
+ }
+ }
if(iface) {
if(!strcmp(iface, adaptername)) {
found = true;
break;
- } else
+ } else {
continue;
+ }
}
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(DEBUG_ALWAYS, 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(DEBUG_ALWAYS, LOG_ERR, "%s (%s) is not a usable Windows tap device: %s", device, iface, winerror(GetLastError()));
return false;
}
+ /* Get version information from tap device */
+
+ {
+ ULONG info[3] = {0};
+ DWORD len;
+
+ if(!DeviceIoControl(device_handle, TAP_IOCTL_GET_VERSION, &info, sizeof(info), &info, sizeof(info), &len, NULL)) {
+ logger(DEBUG_ALWAYS, LOG_WARNING, "Could not get version information from Windows tap device %s (%s): %s", device, iface, winerror(GetLastError()));
+ } else {
+ logger(DEBUG_ALWAYS, LOG_INFO, "TAP-Windows driver version: %lu.%lu%s", info[0], info[1], info[2] ? " (DEBUG)" : "");
+
+ /* Warn if using >=9.21. This is because starting from 9.21, TAP-Win32 seems to use a different, less efficient write path. */
+ if(info[0] == 9 && info[1] >= 21)
+ logger(DEBUG_ALWAYS, LOG_WARNING,
+ "You are using the newer (>= 9.0.0.21, NDIS6) series of TAP-Win32 drivers. "
+ "Using these drivers with tinc is not recommanded as it can result in poor performance. "
+ "You might want to revert back to 9.0.0.9 instead.");
+ }
+ }
+
/* 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(DEBUG_ALWAYS, LOG_ERR, "Could not get MAC address from Windows tap device %s (%s): %s", device, iface, winerror(GetLastError()));
return false;
}
overwrite_mac = 1;
}
- if(!get_config_string(lookup_config(config_tree, "Interface"), &iface))
- iface = device;
+ device_info = "Windows tap device";
- device_info = _("Windows tap device");
+ logger(DEBUG_ALWAYS, LOG_INFO, "%s (%s) is a %s", device, iface, device_info);
- logger(LOG_INFO, _("%s (%s) is a %s"), device, iface, device_info);
+ device_read_overlapped.hEvent = CreateEvent(NULL, TRUE, FALSE, NULL);
+ device_write_overlapped.hEvent = CreateEvent(NULL, TRUE, FALSE, NULL);
return true;
}
-void close_device(void)
-{
- cp();
+static void enable_device(void) {
+ logger(DEBUG_ALWAYS, LOG_INFO, "Enabling %s", device_info);
- CloseHandle(device_fd);
+ ULONG status = 1;
+ DWORD len;
+ DeviceIoControl(device_handle, TAP_IOCTL_SET_MEDIA_STATUS, &status, sizeof(status), &status, sizeof(status), &len, NULL);
+
+ /* We don't use the write event directly, but GetOverlappedResult() does, internally. */
+
+ io_add_event(&device_read_io, device_handle_read, NULL, device_read_overlapped.hEvent);
+ device_issue_read();
}
-bool read_packet(vpn_packet_t *packet)
-{
- int lenin;
+static void disable_device(void) {
+ logger(DEBUG_ALWAYS, LOG_INFO, "Disabling %s", device_info);
- cp();
+ io_del(&device_read_io);
- 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;
+ ULONG status = 0;
+ DWORD len;
+ DeviceIoControl(device_handle, TAP_IOCTL_SET_MEDIA_STATUS, &status, sizeof(status), &status, sizeof(status), &len, NULL);
+
+ /* Note that we don't try to cancel ongoing I/O here - we just stop listening.
+ This is because some TAP-Win32 drivers don't seem to handle cancellation very well,
+ especially when combined with other events such as the computer going to sleep - cases
+ were observed where the GetOverlappedResult() would just block indefinitely and never
+ return in that case. */
+}
+
+static void close_device(void) {
+ CancelIo(device_handle);
+
+ /* According to MSDN, CancelIo() does not necessarily wait for the operation to complete.
+ To prevent race conditions, make sure the operation is complete
+ before we close the event it's referencing. */
+
+ DWORD len;
+
+ if(!GetOverlappedResult(device_handle, &device_read_overlapped, &len, TRUE) && GetLastError() != ERROR_OPERATION_ABORTED) {
+ logger(DEBUG_ALWAYS, LOG_ERR, "Could not wait for %s %s read to cancel: %s", device_info, device, winerror(GetLastError()));
}
-
- packet->len = lenin;
- device_total_in += packet->len;
+ if(device_write_packet.len > 0 && !GetOverlappedResult(device_handle, &device_write_overlapped, &len, TRUE) && GetLastError() != ERROR_OPERATION_ABORTED) {
+ logger(DEBUG_ALWAYS, LOG_ERR, "Could not wait for %s %s write to cancel: %s", device_info, device, winerror(GetLastError()));
+ }
- ifdebug(TRAFFIC) logger(LOG_DEBUG, _("Read packet of %d bytes from %s"), packet->len,
- device_info);
+ device_write_packet.len = 0;
- return true;
+ CloseHandle(device_read_overlapped.hEvent);
+ CloseHandle(device_write_overlapped.hEvent);
+
+ CloseHandle(device_handle);
+ device_handle = INVALID_HANDLE_VALUE;
+
+ free(device);
+ device = NULL;
+ free(iface);
+ iface = NULL;
+ device_info = NULL;
}
-bool write_packet(vpn_packet_t *packet)
-{
- int lenout;
+static bool read_packet(vpn_packet_t *packet) {
+ return false;
+}
+
+static bool write_packet(vpn_packet_t *packet) {
+ DWORD outlen;
+
+ logger(DEBUG_TRAFFIC, LOG_DEBUG, "Writing packet of %d bytes to %s",
+ packet->len, device_info);
+
+ if(device_write_packet.len > 0) {
+ /* Make sure the previous write operation is finished before we start the next one;
+ otherwise we end up with multiple write ops referencing the same OVERLAPPED structure,
+ which according to MSDN is a no-no. */
+
+ if(!GetOverlappedResult(device_handle, &device_write_overlapped, &outlen, FALSE)) {
+ if(GetLastError() != ERROR_IO_INCOMPLETE) {
+ logger(DEBUG_ALWAYS, LOG_ERR, "Error completing previously queued write to %s %s: %s", device_info, device, winerror(GetLastError()));
+ } else {
+ logger(DEBUG_TRAFFIC, LOG_ERR, "Previous overlapped write to %s %s still in progress", device_info, device);
+ // drop this packet
+ return true;
+ }
+ }
+ }
- cp();
+ /* Copy the packet, since the write operation might still be ongoing after we return. */
- ifdebug(TRAFFIC) logger(LOG_DEBUG, _("Writing packet of %d bytes to %s"),
- packet->len, device_info);
+ memcpy(&device_write_packet, packet, sizeof(*packet));
- if(!WriteFile(device_fd, packet->data, packet->len, &lenout, NULL)) {
- logger(LOG_ERR, "Error while writing to %s %s", device_info, device);
+ ResetEvent(device_write_overlapped.hEvent);
+
+ if(WriteFile(device_handle, DATA(&device_write_packet), device_write_packet.len, &outlen, &device_write_overlapped)) {
+ // Write was completed immediately.
+ device_write_packet.len = 0;
+ } else if(GetLastError() != ERROR_IO_PENDING) {
+ logger(DEBUG_ALWAYS, LOG_ERR, "Error while writing to %s %s: %s", device_info, device, winerror(GetLastError()));
+ device_write_packet.len = 0;
return false;
}
- device_total_out += packet->len;
-
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);
-}
+const devops_t os_devops = {
+ .setup = setup_device,
+ .close = close_device,
+ .read = read_packet,
+ .write = write_packet,
+ .enable = enable_device,
+ .disable = disable_device,
+};