Add warnings for bad combinations of Device and Interface.
[tinc] / src / cygwin / device.c
index c8f288c..b04a747 100644 (file)
@@ -1,7 +1,7 @@
 /*
     device.c -- Interaction with Windows tap driver in a Cygwin environment
-    Copyright (C) 2002-2003 Ivo Timmermans <ivo@o2w.nl>,
-                  2002-2003 Guus Sliepen <guus@sliepen.eu.org>
+    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.16 2003/08/08 19:49:47 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 <w32api/windows.h>
 #include <w32api/winioctl.h>
 
-#include "conf.h"
-#include "logger.h"
-#include "net.h"
-#include "route.h"
-#include "utils.h"
-#include "xalloc.h"
-
-#define REG_CONTROL_NET "SYSTEM\\CurrentControlSet\\Control\\Network\\{4D36E972-E325-11CE-BFC1-08002BE10318}"
-
-#define USERMODEDEVICEDIR "\\\\.\\"
-#define USERDEVICEDIR "\\??\\"
-#define TAPSUFFIX ".tap"
+#include "../conf.h"
+#include "../device.h"
+#include "../logger.h"
+#include "../names.h"
+#include "../net.h"
+#include "../route.h"
+#include "../utils.h"
+#include "../xalloc.h"
 
-#define TAP_CONTROL_CODE(request,method) CTL_CODE(FILE_DEVICE_PHYSICAL_NETCARD | 8000, request, method, FILE_ANY_ACCESS)
-
-#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 "../mingw/common.h"
 
 int device_fd = -1;
 static HANDLE device_handle = INVALID_HANDLE_VALUE;
 char *device = NULL;
 char *iface = NULL;
-char *device_info = NULL;
-
-int device_total_in = 0;
-int device_total_out = 0;
+static char *device_info = NULL;
 
-pid_t reader_pid;
-int sp[2];
+static pid_t reader_pid;
+static int sp[2];
 
-bool setup_device(void)
-{
+static bool setup_device(void) {
        HKEY key, key2;
-       int i;
+       int i, err;
 
        char regpath[1024];
        char adapterid[1024];
@@ -70,31 +56,32 @@ bool setup_device(void)
 
        bool found = false;
 
-       cp();
-
        get_config_string(lookup_config(config_tree, "Device"), &device);
        get_config_string(lookup_config(config_tree, "Interface"), &iface);
 
+       if(device && interface)
+               logger(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: %s"), winerror(GetLastError()));
+       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++) {
-               len = sizeof(adapterid);
+               len = sizeof adapterid;
                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))
+               if(RegOpenKeyEx(HKEY_LOCAL_MACHINE, regpath, 0, KEY_READ, &key2))
                        continue;
 
-               len = sizeof(adaptername);
+               len = sizeof adaptername;
                err = RegQueryValueEx(key2, "Name", 0, 0, adaptername, &len);
 
                RegCloseKey(key2);
@@ -118,7 +105,7 @@ bool setup_device(void)
                                continue;
                }
 
-               snprintf(tapname, sizeof(tapname), USERMODEDEVICEDIR "%s" TAPSUFFIX, adapterid);
+               snprintf(tapname, sizeof tapname, USERMODEDEVICEDIR "%s" TAPSUFFIX, adapterid);
                device_handle = CreateFile(tapname, GENERIC_WRITE | GENERIC_READ, 0, 0, OPEN_EXISTING, FILE_ATTRIBUTE_SYSTEM, 0);
                if(device_handle != INVALID_HANDLE_VALUE) {
                        CloseHandle(device_handle);
@@ -130,7 +117,7 @@ bool setup_device(void)
        RegCloseKey(key);
 
        if(!found) {
-               logger(LOG_ERR, _("No Windows tap device found!"));
+               logger(DEBUG_ALWAYS, LOG_ERR, "No Windows tap device found!");
                return false;
        }
 
@@ -140,23 +127,23 @@ bool setup_device(void)
        if(!iface)
                iface = xstrdup(adaptername);
 
-       snprintf(tapname, sizeof(tapname), USERMODEDEVICEDIR "%s" TAPSUFFIX, device);
-       
+       snprintf(tapname, sizeof tapname, USERMODEDEVICEDIR "%s" TAPSUFFIX, device);
+
        /* Now we are going to open this device twice: once for reading and once for writing.
           We do this because apparently it isn't possible to check for activity in the select() loop.
           Furthermore I don't really know how to do it the "Windows" way. */
 
        if(socketpair(AF_UNIX, SOCK_DGRAM, PF_UNIX, sp)) {
-               logger(LOG_DEBUG, _("System call `%s' failed: %s"), "socketpair", strerror(errno));
+               logger(DEBUG_ALWAYS, LOG_DEBUG, "System call `%s' failed: %s", "socketpair", strerror(errno));
                return false;
        }
 
        /* The parent opens the tap device for writing. */
-       
+
        device_handle = CreateFile(tapname, GENERIC_WRITE,  FILE_SHARE_READ,  0,  OPEN_EXISTING, FILE_ATTRIBUTE_SYSTEM , 0);
-       
+
        if(device_handle == INVALID_HANDLE_VALUE) {
-               logger(LOG_ERR, _("Could not open Windows tap device %s (%s) for writing: %s"), device, iface, winerror(GetLastError()));
+               logger(DEBUG_ALWAYS, LOG_ERR, "Could not open Windows tap device %s (%s) for writing: %s", device, iface, winerror(GetLastError()));
                return false;
        }
 
@@ -164,8 +151,8 @@ bool setup_device(void)
 
        /* Get MAC address from 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()));
+       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;
        }
 
@@ -178,29 +165,29 @@ bool setup_device(void)
        reader_pid = fork();
 
        if(reader_pid == -1) {
-               logger(LOG_DEBUG, _("System call `%s' failed: %s"), "fork", strerror(errno));
+               logger(DEBUG_ALWAYS, LOG_DEBUG, "System call `%s' failed: %s", "fork", strerror(errno));
                return false;
        }
 
        if(!reader_pid) {
                /* The child opens the tap device for reading, blocking.
                   It passes everything it reads to the socket. */
-       
+
                char buf[MTU];
-               long lenin;
+               long inlen;
 
                CloseHandle(device_handle);
 
                device_handle = CreateFile(tapname, GENERIC_READ, FILE_SHARE_WRITE, 0,  OPEN_EXISTING, FILE_ATTRIBUTE_SYSTEM, 0);
 
                if(device_handle == INVALID_HANDLE_VALUE) {
-                       logger(LOG_ERR, _("Could not open Windows tap device %s (%s) for reading: %s"), device, iface, winerror(GetLastError()));
+                       logger(DEBUG_ALWAYS, LOG_ERR, "Could not open Windows tap device %s (%s) for reading: %s", device, iface, winerror(GetLastError()));
                        buf[0] = 0;
                        write(sp[1], buf, 1);
                        exit(1);
                }
 
-               logger(LOG_DEBUG, _("Tap reader forked and running."));
+               logger(DEBUG_ALWAYS, LOG_DEBUG, "Tap reader forked and running.");
 
                /* Notify success */
 
@@ -210,81 +197,70 @@ bool setup_device(void)
                /* Pass packets */
 
                for(;;) {
-                       ReadFile(device_handle, buf, MTU, &lenin, NULL);
-                       write(sp[1], buf, lenin);
+                       ReadFile(device_handle, buf, MTU, &inlen, NULL);
+                       write(sp[1], buf, inlen);
                }
        }
 
        read(device_fd, &gelukt, 1);
        if(gelukt != 1) {
-               logger(LOG_DEBUG, _("Tap reader failed!"));
+               logger(DEBUG_ALWAYS, LOG_DEBUG, "Tap reader failed!");
                return false;
        }
 
-       device_info = _("Windows tap device");
+       device_info = "Windows tap device";
 
-       logger(LOG_INFO, _("%s (%s) is a %s"), device, iface, device_info);
+       logger(DEBUG_ALWAYS, LOG_INFO, "%s (%s) is a %s", device, iface, device_info);
 
        return true;
 }
 
-void close_device(void)
-{
-       cp();
-
+static void close_device(void) {
        close(sp[0]);
        close(sp[1]);
-       CloseHandle(device_handle);
+       CloseHandle(device_handle); device_handle = INVALID_HANDLE_VALUE;
 
        kill(reader_pid, SIGKILL);
-}
 
-bool read_packet(vpn_packet_t *packet)
-{
-       int lenin;
+       free(device); device = NULL;
+       free(iface); iface = NULL;
+       device_info = NULL;
+}
 
-       cp();
+static bool read_packet(vpn_packet_t *packet) {
+       int inlen;
 
-       if((lenin = read(sp[0], packet->data, MTU)) <= 0) {
-               logger(LOG_ERR, _("Error while reading from %s %s: %s"), device_info,
+       if((inlen = read(sp[0], DATA(packet), MTU)) <= 0) {
+               logger(DEBUG_ALWAYS, LOG_ERR, "Error while reading from %s %s: %s", device_info,
                           device, strerror(errno));
                return false;
        }
-       
-       packet->len = lenin;
 
-       device_total_in += packet->len;
+       packet->len = inlen;
 
-       ifdebug(TRAFFIC) logger(LOG_DEBUG, _("Read packet of %d bytes from %s"), packet->len,
+       logger(DEBUG_TRAFFIC, LOG_DEBUG, "Read packet of %d bytes from %s", packet->len,
                           device_info);
 
        return true;
 }
 
-bool write_packet(vpn_packet_t *packet)
-{
-       long lenout;
+static bool write_packet(vpn_packet_t *packet) {
+       long outlen;
 
-       cp();
-
-       ifdebug(TRAFFIC) logger(LOG_DEBUG, _("Writing packet of %d bytes to %s"),
+       logger(DEBUG_TRAFFIC, LOG_DEBUG, "Writing packet of %d bytes to %s",
                           packet->len, device_info);
 
-       if(!WriteFile (device_handle, packet->data, packet->len, &lenout, NULL)) {
-               logger(LOG_ERR, _("Error while writing to %s %s: %s"), device_info, device, winerror(GetLastError()));
+       if(!WriteFile (device_handle, DATA(packet), packet->len, &outlen, NULL)) {
+               logger(DEBUG_ALWAYS, LOG_ERR, "Error while writing to %s %s: %s", device_info, device, winerror(GetLastError()));
                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,
+};