Install virtual IPs via interface name, and use an interface lookup where required
[strongswan.git] / src / libhydra / kernel / kernel_net.h
index 772ccac..a6b7686 100644 (file)
 #define KERNEL_NET_H_
 
 typedef struct kernel_net_t kernel_net_t;
+typedef enum kernel_address_type_t kernel_address_type_t;
 
-#include <utils/enumerator.h>
-#include <utils/host.h>
+#include <collections/enumerator.h>
+#include <networking/host.h>
 #include <plugins/plugin.h>
 
 /**
+ * Type of addresses (e.g. when enumerating them)
+ */
+enum kernel_address_type_t {
+       /** normal addresses (on regular, up, non-ignored) interfaces */
+       ADDR_TYPE_REGULAR = 0,
+       /** addresses on down interfaces */
+       ADDR_TYPE_DOWN =  (1 << 0),
+       /** addresses on ignored interfaces */
+       ADDR_TYPE_IGNORED = (1 << 1),
+       /** addresses on loopback interfaces */
+       ADDR_TYPE_LOOPBACK = (1 << 2),
+       /** virtual IP addresses */
+       ADDR_TYPE_VIRTUAL = (1 << 3),
+       /** to enumerate all available addresses */
+       ADDR_TYPE_ALL = (1 << 4) - 1,
+};
+
+/**
  * Interface to the network subsystem of the kernel.
  *
  * The kernel network interface handles the communication with the kernel
@@ -65,12 +84,14 @@ struct kernel_net_t {
        host_t* (*get_nexthop)(kernel_net_t *this, host_t *dest, host_t *src);
 
        /**
-        * Get the interface name of a local address.
+        * Get the interface name of a local address. Interfaces that are down or
+        * ignored by config are not considered.
         *
         * @param host                  address to get interface name from
-        * @return                              allocated interface name, or NULL if not found
+        * @param name                  allocated interface name (optional)
+        * @return                              TRUE if interface found and usable
         */
-       char* (*get_interface) (kernel_net_t *this, host_t *host);
+       bool (*get_interface) (kernel_net_t *this, host_t *host, char **name);
 
        /**
         * Creates an enumerator over all local addresses.
@@ -79,14 +100,11 @@ struct kernel_net_t {
         * enumerator gets destroyed.
         * The hosts are read-only, do not modify of free.
         *
-        * @param include_down_ifaces   TRUE to enumerate addresses from down interfaces
-        * @param include_virtual_ips   TRUE to enumerate virtual IP addresses
-        * @param include_loopback              TRUE to enumerate addresses on loopback interfaces
-        * @return                                              enumerator over host_t's
+        * @param which                 a combination of address types to enumerate
+        * @return                              enumerator over host_t's
         */
        enumerator_t *(*create_address_enumerator) (kernel_net_t *this,
-                                                       bool include_down_ifaces, bool include_virtual_ips,
-                                                       bool include_loopback);
+                                                                                               kernel_address_type_t which);
 
        /**
         * Add a virtual IP to an interface.
@@ -94,14 +112,14 @@ struct kernel_net_t {
         * Virtual IPs are attached to an interface. If an IP is added multiple
         * times, the IP is refcounted and not removed until del_ip() was called
         * as many times as add_ip().
-        * The virtual IP is attached to the interface where the iface_ip is found.
         *
         * @param virtual_ip    virtual ip address to assign
-        * @param iface_ip              IP of an interface to attach virtual IP
+        * @param prefix                prefix length to install with IP address, -1 for auto
+        * @param iface                 interface to install virtual IP on
         * @return                              SUCCESS if operation completed
         */
-       status_t (*add_ip) (kernel_net_t *this, host_t *virtual_ip,
-                                               host_t *iface_ip);
+       status_t (*add_ip) (kernel_net_t *this, host_t *virtual_ip, int prefix,
+                                               char *iface);
 
        /**
         * Remove a virtual IP from an interface.
@@ -109,9 +127,10 @@ struct kernel_net_t {
         * The kernel interface uses refcounting, see add_ip().
         *
         * @param virtual_ip    virtual ip address to assign
+        * @param prefix                prefix length of the IP to uninstall, -1 for auto
         * @return                              SUCCESS if operation completed
         */
-       status_t (*del_ip) (kernel_net_t *this, host_t *virtual_ip);
+       status_t (*del_ip) (kernel_net_t *this, host_t *virtual_ip, int prefix);
 
        /**
         * Add a route.