2 * Copyright (C) 2008-2012 Tobias Brunner
3 * Copyright (C) 2007 Martin Willi
4 * Hochschule fuer Technik Rapperswil
6 * This program is free software; you can redistribute it and/or modify it
7 * under the terms of the GNU General Public License as published by the
8 * Free Software Foundation; either version 2 of the License, or (at your
9 * option) any later version. See <http://www.fsf.org/copyleft/gpl.txt>.
11 * This program is distributed in the hope that it will be useful, but
12 * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
13 * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
18 * @defgroup kernel_net kernel_net
25 typedef struct kernel_net_t kernel_net_t
;
26 typedef enum kernel_address_type_t kernel_address_type_t
;
28 #include <collections/enumerator.h>
29 #include <networking/host.h>
30 #include <plugins/plugin.h>
31 #include <kernel/kernel_interface.h>
34 * Type of addresses (e.g. when enumerating them)
36 enum kernel_address_type_t
{
37 /** normal addresses (on regular, up, non-ignored) interfaces */
38 ADDR_TYPE_REGULAR
= (1 << 0),
39 /** addresses on down interfaces */
40 ADDR_TYPE_DOWN
= (1 << 1),
41 /** addresses on ignored interfaces */
42 ADDR_TYPE_IGNORED
= (1 << 2),
43 /** addresses on loopback interfaces */
44 ADDR_TYPE_LOOPBACK
= (1 << 3),
45 /** virtual IP addresses */
46 ADDR_TYPE_VIRTUAL
= (1 << 4),
47 /** to enumerate all available addresses */
48 ADDR_TYPE_ALL
= (1 << 5) - 1,
52 * Interface to the network subsystem of the kernel.
54 * The kernel network interface handles the communication with the kernel
55 * for interface and IP address management.
60 * Get the feature set supported by this kernel backend.
62 * @return ORed feature-set of backend
64 kernel_feature_t (*get_features
)(kernel_net_t
*this);
67 * Get our outgoing source address for a destination.
69 * Does a route lookup to get the source address used to reach dest.
70 * The returned host is allocated and must be destroyed.
71 * An optional src address can be used to check if a route is available
72 * for the given source to dest.
74 * @param dest target destination address
75 * @param src source address to check, or NULL
76 * @return outgoing source address, NULL if unreachable
78 host_t
* (*get_source_addr
)(kernel_net_t
*this, host_t
*dest
, host_t
*src
);
81 * Get the next hop for a destination.
83 * Does a route lookup to get the next hop used to reach dest.
84 * The returned host is allocated and must be destroyed.
85 * An optional src address can be used to check if a route is available
86 * for the given source to dest.
88 * @param dest target destination address
89 * @param prefix prefix length if dest is a subnet, -1 for auto
90 * @param src source address to check, or NULL
91 * @return next hop address, NULL if unreachable
93 host_t
* (*get_nexthop
)(kernel_net_t
*this, host_t
*dest
, int prefix
,
97 * Get the interface name of a local address. Interfaces that are down or
98 * ignored by config are not considered.
100 * @param host address to get interface name from
101 * @param name allocated interface name (optional)
102 * @return TRUE if interface found and usable
104 bool (*get_interface
) (kernel_net_t
*this, host_t
*host
, char **name
);
107 * Creates an enumerator over all local addresses.
109 * This function blocks an internal cached address list until the
110 * enumerator gets destroyed.
111 * The hosts are read-only, do not modify of free.
113 * @param which a combination of address types to enumerate
114 * @return enumerator over host_t's
116 enumerator_t
*(*create_address_enumerator
) (kernel_net_t
*this,
117 kernel_address_type_t which
);
120 * Add a virtual IP to an interface.
122 * Virtual IPs are attached to an interface. If an IP is added multiple
123 * times, the IP is refcounted and not removed until del_ip() was called
124 * as many times as add_ip().
126 * @param virtual_ip virtual ip address to assign
127 * @param prefix prefix length to install with IP address, -1 for auto
128 * @param iface interface to install virtual IP on
129 * @return SUCCESS if operation completed
131 status_t (*add_ip
) (kernel_net_t
*this, host_t
*virtual_ip
, int prefix
,
135 * Remove a virtual IP from an interface.
137 * The kernel interface uses refcounting, see add_ip().
139 * @param virtual_ip virtual ip address to remove
140 * @param prefix prefix length of the IP to uninstall, -1 for auto
141 * @param wait TRUE to wait until IP is gone
142 * @return SUCCESS if operation completed
144 status_t (*del_ip
) (kernel_net_t
*this, host_t
*virtual_ip
, int prefix
,
150 * @param dst_net destination net
151 * @param prefixlen destination net prefix length
152 * @param gateway gateway for this route
153 * @param src_ip source ip of the route
154 * @param if_name name of the interface the route is bound to
155 * @return SUCCESS if operation completed
156 * ALREADY_DONE if the route already exists
158 status_t (*add_route
) (kernel_net_t
*this, chunk_t dst_net
,
159 u_int8_t prefixlen
, host_t
*gateway
, host_t
*src_ip
,
165 * @param dst_net destination net
166 * @param prefixlen destination net prefix length
167 * @param gateway gateway for this route
168 * @param src_ip source ip of the route
169 * @param if_name name of the interface the route is bound to
170 * @return SUCCESS if operation completed
172 status_t (*del_route
) (kernel_net_t
*this, chunk_t dst_net
,
173 u_int8_t prefixlen
, host_t
*gateway
, host_t
*src_ip
,
177 * Destroy the implementation.
179 void (*destroy
) (kernel_net_t
*this);
183 * Helper function to (un-)register net kernel interfaces from plugin features.
185 * This function is a plugin_feature_callback_t and can be used with the
186 * PLUGIN_CALLBACK macro to register an net kernel interface constructor.
188 * @param plugin plugin registering the kernel interface
189 * @param feature associated plugin feature
190 * @param reg TRUE to register, FALSE to unregister
191 * @param data data passed to callback, an kernel_net_constructor_t
193 bool kernel_net_register(plugin_t
*plugin
, plugin_feature_t
*feature
,
194 bool reg
, void *data
);
196 #endif /** KERNEL_NET_H_ @}*/