nm-default-route-manager.c 34.3 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23
/* -*- Mode: C; tab-width: 4; indent-tabs-mode: t; c-basic-offset: 4 -*- */
/* NetworkManager -- Network link manager
 *
 * 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
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * 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.,
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 *
 * Copyright (C) 2014 Red Hat, Inc.
 */


#include "config.h"

24 25
#include "nm-default-route-manager.h"

26 27 28 29
#include "string.h"

#include "nm-logging.h"
#include "nm-device.h"
30
#include "nm-vpn-connection.h"
31
#include "nm-platform.h"
32
#include "nm-manager.h"
33 34
#include "nm-ip4-config.h"
#include "nm-ip6-config.h"
35
#include "nm-activation-request.h"
36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76

typedef struct {
	GPtrArray *entries_ip4;
	GPtrArray *entries_ip6;
} NMDefaultRouteManagerPrivate;

#define NM_DEFAULT_ROUTE_MANAGER_GET_PRIVATE(o) (G_TYPE_INSTANCE_GET_PRIVATE ((o), NM_TYPE_DEFAULT_ROUTE_MANAGER, NMDefaultRouteManagerPrivate))

G_DEFINE_TYPE (NMDefaultRouteManager, nm_default_route_manager, G_TYPE_OBJECT)

static NMDefaultRouteManager *_instance;

#define _LOG(level, addr_family, ...) \
    G_STMT_START { \
        int __addr_family = (addr_family); \
        guint64 __domain = __addr_family == AF_INET ? LOGD_IP4 : LOGD_IP6; \
        \
        if (nm_logging_enabled ((level), (__domain))) { \
            char __ch = __addr_family == AF_INET ? '4' : '6'; \
            char __prefix[30] = "default-route"; \
            \
            if ((self) != _instance) \
                g_snprintf (__prefix, sizeof (__prefix), "default-route%c[%p]", __ch, (self)); \
            else \
                __prefix[STRLEN ("default-route")] = __ch; \
            nm_log ((level), (__domain), \
                    "%s: " _NM_UTILS_MACRO_FIRST(__VA_ARGS__), \
                    __prefix _NM_UTILS_MACRO_REST(__VA_ARGS__)); \
        } \
    } G_STMT_END

#define _LOGD(addr_family, ...)      _LOG (LOGL_DEBUG, addr_family, __VA_ARGS__)
#define _LOGI(addr_family, ...)      _LOG (LOGL_INFO , addr_family, __VA_ARGS__)
#define _LOGW(addr_family, ...)      _LOG (LOGL_WARN , addr_family, __VA_ARGS__)
#define _LOGE(addr_family, ...)      _LOG (LOGL_ERR  , addr_family, __VA_ARGS__)

#define LOG_ENTRY_FMT  "entry[%u/%s:%p:%s]"
#define LOG_ENTRY_ARGS(entry_idx, entry) \
		entry_idx, \
		NM_IS_DEVICE (entry->source.pointer) ? "dev" : "vpn", \
		entry->source.pointer, \
77
		NM_IS_DEVICE (entry->source.pointer) ? nm_device_get_iface (entry->source.device) : nm_vpn_connection_get_connection_id (entry->source.vpn)
78 79 80 81 82 83 84 85

/***********************************************************************************/

typedef struct {
	union {
		void *pointer;
		GObject *object;
		NMDevice *device;
86
		NMVpnConnection *vpn;
87
	} source;
88
	NMPlatformIPXRoute route;
89
	gboolean synced; /* if true, we synced the entry to platform. We don't sync assumed devices */
90 91 92 93 94 95

	/* it makes sense to order sources based on their priority, without
	 * actually adding a default route. This is useful to decide which
	 * DNS server to prefer. never_default entries are not synced to platform. */
	gboolean never_default;

96 97 98 99 100 101 102
	guint32 effective_metric;
} Entry;

typedef struct {
	int addr_family;
	GPtrArray *(*get_entries) (NMDefaultRouteManagerPrivate *priv);
	const char *(*platform_route_to_string) (const NMPlatformIPRoute *route);
103
	GArray *(*platform_route_get_all) (int ifindex, NMPlatformGetRouteMode mode);
104 105 106 107 108 109 110 111
	gboolean (*platform_route_delete_default) (int ifindex, guint32 metric);
	guint32 (*route_metric_normalize) (guint32 metric);
} VTableIP;

static const VTableIP vtable_ip4, vtable_ip6;

#define VTABLE_IS_IP4 (vtable->addr_family == AF_INET)

112 113 114 115 116 117 118 119 120
static NMPlatformIPRoute *
_vt_route_index (const VTableIP *vtable, GArray *routes, guint index)
{
	if (VTABLE_IS_IP4)
		return (NMPlatformIPRoute *) &g_array_index (routes, NMPlatformIP4Route, index);
	else
		return (NMPlatformIPRoute *) &g_array_index (routes, NMPlatformIP6Route, index);
}

121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155
static void
_entry_free (Entry *entry)
{
	if (entry) {
		g_object_unref (entry->source.object);
		g_slice_free (Entry, entry);
	}
}

static Entry *
_entry_find_by_source (GPtrArray *entries, gpointer source, guint *out_idx)
{
	guint i;

	for (i = 0; i < entries->len; i++) {
		Entry *e = g_ptr_array_index (entries, i);

		if (e->source.pointer == source) {
			if (out_idx)
				*out_idx = i;
			return e;
		}
	}

	if (out_idx)
		*out_idx = G_MAXUINT;
	return NULL;
}

static void
_platform_route_sync_add (const VTableIP *vtable, NMDefaultRouteManager *self, guint32 metric)
{
	NMDefaultRouteManagerPrivate *priv = NM_DEFAULT_ROUTE_MANAGER_GET_PRIVATE (self);
	GPtrArray *entries = vtable->get_entries (priv);
	guint i;
156
	Entry *entry_unsynced = NULL;
157 158 159 160 161 162 163 164 165
	Entry *entry = NULL;
	gboolean success;

	/* Find the entries for the given metric.
	 * The effective metric for synced entries is choosen in a way that it
	 * is unique (except for G_MAXUINT32, where a clash is not solvable). */
	for (i = 0; i < entries->len; i++) {
		Entry *e = g_ptr_array_index (entries, i);

166 167 168
		if (e->never_default)
			continue;

169 170 171 172 173
		if (e->effective_metric != metric)
			continue;

		if (e->synced) {
			g_assert (!entry || metric == G_MAXUINT32);
174 175
			if (!entry)
				entry = e;
176
		} else
177
			entry_unsynced = e;
178 179
	}

180 181 182 183 184 185
	/* We don't expect to have an unsynced *and* a synced entry for the same metric.
	 * Unless, (a) their metric is G_MAXUINT32, in which case we could not find an unused effective metric,
	 * or (b) if we have an unsynced and a synced entry for the same ifindex.
	 * The latter case happens for example when activating an openvpn connection (synced) and
	 * assuming the corresponding tun0 interface (unsynced). */
	g_assert (!entry || !entry_unsynced || (entry->route.rx.ifindex == entry_unsynced->route.rx.ifindex) || metric == G_MAXUINT32);
186 187 188 189 190 191

	/* we only add the route, if we have an (to be synced) entry for it. */
	if (!entry)
		return;

	if (VTABLE_IS_IP4) {
192 193
		success = nm_platform_ip4_route_add (entry->route.rx.ifindex,
		                                     entry->route.rx.source,
194 195
		                                     0,
		                                     0,
196
		                                     entry->route.r4.gateway,
197
		                                     entry->effective_metric,
198
		                                     entry->route.rx.mss);
199
	} else {
200 201
		success = nm_platform_ip6_route_add (entry->route.rx.ifindex,
		                                     entry->route.rx.source,
202 203
		                                     in6addr_any,
		                                     0,
204
		                                     entry->route.r6.gateway,
205
		                                     entry->effective_metric,
206 207 208 209 210
		                                     entry->route.rx.mss);
	}
	if (!success) {
		_LOGW (vtable->addr_family, "failed to add default route %s with effective metric %u",
		       vtable->platform_route_to_string (&entry->route.rx), (guint) entry->effective_metric);
211 212 213 214 215 216 217 218 219
	}
}

static void
_platform_route_sync_flush (const VTableIP *vtable, NMDefaultRouteManager *self)
{
	NMDefaultRouteManagerPrivate *priv = NM_DEFAULT_ROUTE_MANAGER_GET_PRIVATE (self);
	GPtrArray *entries = vtable->get_entries (priv);
	GArray *routes;
220
	guint i, j;
221 222

	/* prune all other default routes from this device. */
223
	routes = vtable->platform_route_get_all (0, NM_PLATFORM_GET_ROUTE_MODE_ONLY_DEFAULT);
224 225 226 227 228 229

	for (i = 0; i < routes->len; i++) {
		const NMPlatformIPRoute *route;
		gboolean has_ifindex_synced = FALSE;
		Entry *entry = NULL;

230
		route = _vt_route_index (vtable, routes, i);
231 232 233

		/* look at all entires and see if the route for this ifindex pair is
		 * a known entry. */
234 235
		for (j = 0; j < entries->len; j++) {
			Entry *e = g_ptr_array_index (entries, j);
236

237 238 239
			if (e->never_default)
				continue;

240
			if (   e->route.rx.ifindex == route->ifindex
241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268
			    && e->synced) {
				has_ifindex_synced = TRUE;
				if (e->effective_metric == route->metric)
					entry = e;
			}
		}

		/* we only delete the route if we don't have a matching entry,
		 * and there is at least one entry that references this ifindex
		 * (indicating that the ifindex is managed by us -- not assumed).
		 *
		 * Otherwise, don't delete the route because it's configured
		 * externally (and will be assumed -- or already is assumed).
		 */
		if (has_ifindex_synced && !entry)
			vtable->platform_route_delete_default (route->ifindex, route->metric);
	}
	g_array_free (routes, TRUE);
}

static int
_sort_entries_cmp (gconstpointer a, gconstpointer b, gpointer user_data)
{
	guint32 m_a, m_b;
	const Entry *e_a = *((const Entry **) a);
	const Entry *e_b = *((const Entry **) b);

	/* when comparing routes, we consider the (original) metric. */
269 270
	m_a = e_a->route.rx.metric;
	m_b = e_b->route.rx.metric;
271 272 273 274 275 276 277

	/* we normalize route.metric already in _ipx_update_default_route().
	 * so we can just compare the metrics numerically */

	if (m_a != m_b)
		return (m_a < m_b) ? -1 : 1;

278 279 280 281
	/* If the metrics are equal, we prefer the one that is !never_default */
	if (!!e_a->never_default != !!e_b->never_default)
		return e_a->never_default ? 1 : -1;

282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302
	/* If the metrics are equal, we prefer the one that is assumed (!synced).
	 * Entries that we sync, can be modified so that only the best
	 * entry has a (deterministically) lowest metric.
	 * With assumed devices we cannot increase/change the metric.
	 * For example: two devices, both metric 0. One is assumed the other is
	 * synced.
	 * If we would choose the synced entry as best, we cannot
	 * increase the metric of the assumed one and we would have non-determinism.
	 * If we instead prefer the assumed device, we can increase the metric
	 * of the synced device and the assumed device is (deterministically)
	 * prefered.
	 * If both devices are assumed, we also have non-determinism, but also
	 * we don't reorder either.
	 */
	if (!!e_a->synced != !!e_b->synced)
		return e_a->synced ? 1 : -1;

	/* otherwise, do not reorder */
	return 0;
}

303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343
static GHashTable *
_get_assumed_interface_metrics (const VTableIP *vtable, NMDefaultRouteManager *self, GArray *routes)
{
	NMDefaultRouteManagerPrivate *priv = NM_DEFAULT_ROUTE_MANAGER_GET_PRIVATE (self);
	GPtrArray *entries;
	guint i, j;
	GHashTable *result;

	/* create a list of all metrics that are currently assigned on an interface
	 * that is *not* already covered by one of our synced entries.
	 * IOW, returns the metrics that are in use by assumed interfaces
	 * that we want to preserve. */

	entries = vtable->get_entries (priv);

	result = g_hash_table_new (NULL, NULL);

	for (i = 0; i < routes->len; i++) {
		gboolean ifindex_has_synced_entry = FALSE;
		const NMPlatformIPRoute *route;

		route = _vt_route_index (vtable, routes, i);

		for (j = 0; j < entries->len; j++) {
			Entry *e = g_ptr_array_index (entries, j);

			if (   !e->never_default
			    && e->synced
			    && e->route.rx.ifindex == route->ifindex) {
				ifindex_has_synced_entry = TRUE;
				break;
			}
		}

		if (!ifindex_has_synced_entry)
			g_hash_table_add (result, GUINT_TO_POINTER (vtable->route_metric_normalize (route->metric)));
	}

	return result;
}

344
static void
345
_resync_all (const VTableIP *vtable, NMDefaultRouteManager *self, const Entry *changed_entry, const Entry *old_entry)
346 347 348
{
	NMDefaultRouteManagerPrivate *priv = NM_DEFAULT_ROUTE_MANAGER_GET_PRIVATE (self);
	Entry *entry;
349
	guint i, j;
350 351 352 353 354 355
	gint64 last_metric = -1;
	guint32 expected_metric;
	GPtrArray *entries;
	GHashTableIter iter;
	gpointer ptr;
	GHashTable *changed_metrics = g_hash_table_new (NULL, NULL);
356 357
	GHashTable *assumed_metrics;
	GArray *routes;
358 359 360

	entries = vtable->get_entries (priv);

361 362 363 364
	routes = vtable->platform_route_get_all (0, NM_PLATFORM_GET_ROUTE_MODE_ONLY_DEFAULT);

	assumed_metrics = _get_assumed_interface_metrics (vtable, self, routes);

365 366 367 368 369 370 371 372 373 374 375
	if (old_entry && old_entry->synced) {
		/* The old version obviously changed. */
		g_hash_table_add (changed_metrics, GUINT_TO_POINTER (old_entry->effective_metric));
	}

	/* first iterate over all entries and adjust the effective metrics. */
	for (i = 0; i < entries->len; i++) {
		entry = g_ptr_array_index (entries, i);

		g_assert (entry != old_entry);

376 377 378
		if (entry->never_default)
			continue;

379
		if (!entry->synced) {
380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397
			gboolean has_synced_entry = FALSE;

			/* A non synced entry is completely ignored, if we have
			 * a synced entry for the same if index.
			 * Otherwise the metric of the entry is still remembered as
			 * last_metric to avoid reusing it. */
			for (j = 0; j < entries->len; j++) {
				const Entry *e = g_ptr_array_index (entries, j);

				if (   !e->never_default
				    && e->synced
					&& e->route.rx.ifindex == entry->route.rx.ifindex) {
					has_synced_entry = TRUE;
					break;
				}
			}
			if (!has_synced_entry)
				last_metric = MAX (last_metric, (gint64) entry->effective_metric);
398 399 400
			continue;
		}

401
		expected_metric = entry->route.rx.metric;
402 403 404
		if ((gint64) expected_metric <= last_metric)
			expected_metric = last_metric == G_MAXUINT32 ? G_MAXUINT32 : last_metric + 1;

405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426
		while (   expected_metric < G_MAXUINT32
		       && g_hash_table_contains (assumed_metrics, GUINT_TO_POINTER (expected_metric))) {
			gboolean has_metric_for_ifindex = FALSE;

			/* Check if there are assumed devices that have default routes with this metric.
			 * If there are any, we have to pick another effective_metric. */

			/* However, if there is a matching route (ifindex+metric) for our current entry, we are done. */
			for (j = 0; j < routes->len; j++) {
				const NMPlatformIPRoute *r = _vt_route_index (vtable, routes, i);

				if (   r->metric == expected_metric
				    && r->ifindex == entry->route.rx.ifindex) {
					has_metric_for_ifindex = TRUE;
					break;
				}
			}
			if (has_metric_for_ifindex)
				break;
			expected_metric++;
		}

427 428 429 430
		if (changed_entry == entry) {
			/* for the changed entry, the previous metric was either old_entry->effective_metric,
			 * or none. Hence, we only have to remember what is going to change. */
			g_hash_table_add (changed_metrics, GUINT_TO_POINTER (expected_metric));
431 432 433 434 435 436 437 438
			if (old_entry) {
				_LOGD (vtable->addr_family, LOG_ENTRY_FMT": update %s (%u -> %u)", LOG_ENTRY_ARGS (i, entry),
				       vtable->platform_route_to_string (&entry->route.rx), (guint) old_entry->effective_metric,
				       (guint) expected_metric);
			} else {
				_LOGD (vtable->addr_family, LOG_ENTRY_FMT": add %s (%u)", LOG_ENTRY_ARGS (i, entry),
				       vtable->platform_route_to_string (&entry->route.rx), (guint) expected_metric);
			}
439 440 441
		} else if (entry->effective_metric != expected_metric) {
			g_hash_table_add (changed_metrics, GUINT_TO_POINTER (entry->effective_metric));
			g_hash_table_add (changed_metrics, GUINT_TO_POINTER (expected_metric));
442 443 444
			_LOGD (vtable->addr_family, LOG_ENTRY_FMT": resync metric %s (%u -> %u)", LOG_ENTRY_ARGS (i, entry),
			       vtable->platform_route_to_string (&entry->route.rx), (guint) entry->effective_metric,
			       (guint) expected_metric);
445 446 447 448 449 450
		}

		entry->effective_metric = expected_metric;
		last_metric = expected_metric;
	}

451 452
	g_array_free (routes, TRUE);

453 454 455 456
	g_hash_table_iter_init (&iter, changed_metrics);
	while (g_hash_table_iter_next (&iter, &ptr, NULL))
		_platform_route_sync_add (vtable, self, GPOINTER_TO_UINT (ptr));
	_platform_route_sync_flush (vtable, self);
457 458

	g_hash_table_unref (changed_metrics);
459
	g_hash_table_unref (assumed_metrics);
460 461 462
}

static void
463
_entry_at_idx_update (const VTableIP *vtable, NMDefaultRouteManager *self, guint entry_idx, const Entry *old_entry)
464 465 466 467 468 469 470 471 472 473 474
{
	NMDefaultRouteManagerPrivate *priv = NM_DEFAULT_ROUTE_MANAGER_GET_PRIVATE (self);
	Entry *entry;
	GPtrArray *entries;

	entries = vtable->get_entries (priv);
	g_assert (entry_idx < entries->len);

	entry = g_ptr_array_index (entries, entry_idx);

	g_assert (   !old_entry
475
	          || (entry->source.pointer == old_entry->source.pointer && entry->route.rx.ifindex == old_entry->route.rx.ifindex));
476 477

	if (!entry->synced) {
478
		entry->effective_metric = entry->route.rx.metric;
479 480 481
		_LOGD (vtable->addr_family, LOG_ENTRY_FMT": %s %s%s",
		       LOG_ENTRY_ARGS (entry_idx, entry),
		       old_entry ? "update" : "add",
482
		       vtable->platform_route_to_string (&entry->route.rx),
483
		       entry->never_default ? " (never-default)" : (entry->synced ? "" : " (not synced)"));
484 485 486 487
	}

	g_ptr_array_sort_with_data (entries, _sort_entries_cmp, NULL);

488
	_resync_all (vtable, self, entry, old_entry);
489 490 491
}

static void
492
_entry_at_idx_remove (const VTableIP *vtable, NMDefaultRouteManager *self, guint entry_idx)
493 494 495 496 497 498 499 500 501 502 503
{
	NMDefaultRouteManagerPrivate *priv = NM_DEFAULT_ROUTE_MANAGER_GET_PRIVATE (self);
	Entry *entry;
	GPtrArray *entries;

	entries = vtable->get_entries (priv);

	g_assert (entry_idx < entries->len);

	entry = g_ptr_array_index (entries, entry_idx);

504 505 506
	_LOGD (vtable->addr_family, LOG_ENTRY_FMT": remove %s (%u%s)", LOG_ENTRY_ARGS (entry_idx, entry),
	       vtable->platform_route_to_string (&entry->route.rx), (guint) entry->effective_metric,
	       entry->synced ? "" : ", not synced");
507 508 509 510 511

	/* Remove the entry from the list (but don't free it yet) */
	g_ptr_array_index (entries, entry_idx) = NULL;
	g_ptr_array_remove_index (entries, entry_idx);

512
	_resync_all (vtable, self, NULL, entry);
513 514 515 516 517 518 519 520 521 522 523 524 525

	_entry_free (entry);
}

/***********************************************************************************/

static void
_ipx_update_default_route (const VTableIP *vtable, NMDefaultRouteManager *self, gpointer source)
{
	NMDefaultRouteManagerPrivate *priv;
	Entry *entry;
	guint entry_idx;
	const NMPlatformIPRoute *default_route = NULL;
526
	NMPlatformIPXRoute rt;
527 528 529
	int ip_ifindex;
	GPtrArray *entries;
	NMDevice *device = NULL;
530 531
	NMVpnConnection *vpn = NULL;
	gboolean never_default = FALSE;
532 533 534 535 536
	gboolean synced;

	g_return_if_fail (NM_IS_DEFAULT_ROUTE_MANAGER (self));
	if (NM_IS_DEVICE (source))
		device = source;
537 538
	else if (NM_IS_VPN_CONNECTION (source))
		vpn = source;
539 540 541
	else
		g_return_if_reached ();

542 543 544 545 546 547 548 549 550 551 552 553
	if (device)
		ip_ifindex = nm_device_get_ip_ifindex (device);
	else {
		ip_ifindex = nm_vpn_connection_get_ip_ifindex (vpn);

		if (ip_ifindex <= 0) {
			NMDevice *parent = nm_active_connection_get_device (NM_ACTIVE_CONNECTION (vpn));

			if (parent)
				ip_ifindex = nm_device_get_ip_ifindex (parent);
		}
	}
554 555 556 557 558 559 560

	priv = NM_DEFAULT_ROUTE_MANAGER_GET_PRIVATE (self);

	entries = vtable->get_entries (priv);
	entry = _entry_find_by_source (entries, source, &entry_idx);

	if (   entry
561
	    && entry->route.rx.ifindex != ip_ifindex) {
562 563 564
		/* Strange... the ifindex changed... Remove the device and start again. */
		_LOGD (vtable->addr_family, "ifindex of "LOG_ENTRY_FMT" changed: %d -> %d",
		       LOG_ENTRY_ARGS (entry_idx, entry),
565
		       entry->route.rx.ifindex, ip_ifindex);
566 567

		g_object_freeze_notify (G_OBJECT (self));
568
		_entry_at_idx_remove (vtable, self, entry_idx);
569 570 571 572 573 574 575 576
		g_assert (!_entry_find_by_source (entries, source, NULL));
		_ipx_update_default_route (vtable, self, source);
		g_object_thaw_notify (G_OBJECT (self));
		return;
	}

	/* get the @default_route from the device. */
	if (ip_ifindex > 0) {
577 578 579 580 581 582 583 584 585 586 587
		if (device) {
			if (VTABLE_IS_IP4)
				default_route = (const NMPlatformIPRoute *) nm_device_get_ip4_default_route (device);
			else
				default_route = (const NMPlatformIPRoute *) nm_device_get_ip6_default_route (device);
		} else {
			NMConnection *connection = nm_active_connection_get_connection ((NMActiveConnection *) vpn);

			if (   connection
			    && nm_vpn_connection_get_vpn_state (vpn) == NM_VPN_CONNECTION_STATE_ACTIVATED) {

588
				memset (&rt, 0, sizeof (rt));
589 590 591 592 593 594
				if (VTABLE_IS_IP4) {
					NMIP4Config *vpn_config;

					vpn_config = nm_vpn_connection_get_ip4_config (vpn);
					if (vpn_config) {
						never_default = nm_ip4_config_get_never_default (vpn_config);
595 596 597 598 599 600
						rt.r4.ifindex = ip_ifindex;
						rt.r4.source = NM_IP_CONFIG_SOURCE_VPN;
						rt.r4.gateway = nm_vpn_connection_get_ip4_internal_gateway (vpn);
						rt.r4.metric = nm_vpn_connection_get_ip4_route_metric (vpn);
						rt.r4.mss = nm_ip4_config_get_mss (vpn_config);
						default_route = &rt.rx;
601 602 603 604 605 606 607 608 609
					}
				} else {
					NMIP6Config *vpn_config;

					vpn_config = nm_vpn_connection_get_ip6_config (vpn);
					if (vpn_config) {
						const struct in6_addr *int_gw = nm_vpn_connection_get_ip6_internal_gateway (vpn);

						never_default = nm_ip6_config_get_never_default (vpn_config);
610 611 612 613 614 615
						rt.r6.ifindex = ip_ifindex;
						rt.r6.source = NM_IP_CONFIG_SOURCE_VPN;
						rt.r6.gateway = int_gw ? *int_gw : in6addr_any;
						rt.r6.metric = nm_vpn_connection_get_ip6_route_metric (vpn);
						rt.r6.mss = nm_ip6_config_get_mss (vpn_config);
						default_route = &rt.rx;
616 617 618 619
					}
				}
			}
		}
620 621 622
	}
	g_assert (!default_route || default_route->plen == 0);

623 624 625
	/* if the source is never_default or the device uses an assumed connection,
	 * we don't sync the route. */
	synced = !never_default && (!device || !nm_device_uses_assumed_connection (device));
626 627 628 629 630 631 632 633 634

	if (!entry && !default_route)
		/* nothing to do */;
	else if (!entry) {
		/* add */
		entry = g_slice_new0 (Entry);
		entry->source.object = g_object_ref (source);

		if (VTABLE_IS_IP4)
635
			entry->route.r4 = *((const NMPlatformIP4Route *) default_route);
636
		else
637
			entry->route.r6 = *((const NMPlatformIP6Route *) default_route);
638 639

		/* only use normalized metrics */
640 641
		entry->route.rx.metric = vtable->route_metric_normalize (entry->route.rx.metric);
		entry->route.rx.ifindex = ip_ifindex;
642
		entry->never_default = never_default;
643
		entry->effective_metric = entry->route.rx.metric;
644 645 646
		entry->synced = synced;

		g_ptr_array_add (entries, entry);
647
		_entry_at_idx_update (vtable, self, entries->len - 1, NULL);
648 649 650 651 652 653
	} else if (default_route) {
		/* update */
		Entry old_entry, new_entry;

		new_entry = *entry;
		if (VTABLE_IS_IP4)
654
			new_entry.route.r4 = *((const NMPlatformIP4Route *) default_route);
655
		else
656
			new_entry.route.r6 = *((const NMPlatformIP6Route *) default_route);
657
		/* only use normalized metrics */
658 659
		new_entry.route.rx.metric = vtable->route_metric_normalize (new_entry.route.rx.metric);
		new_entry.route.rx.ifindex = ip_ifindex;
660
		new_entry.never_default = never_default;
661 662 663 664 665 666 667
		new_entry.synced = synced;

		if (memcmp (entry, &new_entry, sizeof (new_entry)) == 0)
			return;

		old_entry = *entry;
		*entry = new_entry;
668
		_entry_at_idx_update (vtable, self, entry_idx, &old_entry);
669 670
	} else {
		/* delete */
671
		_entry_at_idx_remove (vtable, self, entry_idx);
672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735
	}
}

void
nm_default_route_manager_ip4_update_default_route (NMDefaultRouteManager *self, gpointer source)
{
	_ipx_update_default_route (&vtable_ip4, self, source);
}

void
nm_default_route_manager_ip6_update_default_route (NMDefaultRouteManager *self, gpointer source)
{
	_ipx_update_default_route (&vtable_ip6, self, source);
}

/***********************************************************************************/

static gboolean
_ipx_connection_has_default_route (const VTableIP *vtable, NMDefaultRouteManager *self, NMConnection *connection)
{
	const char *method;
	NMSettingIPConfig *s_ip;

	g_return_val_if_fail (NM_IS_DEFAULT_ROUTE_MANAGER (self), FALSE);
	g_return_val_if_fail (NM_IS_CONNECTION (connection), FALSE);

	if (VTABLE_IS_IP4)
		s_ip = nm_connection_get_setting_ip4_config (connection);
	else
		s_ip = nm_connection_get_setting_ip6_config (connection);
	if (!s_ip || nm_setting_ip_config_get_never_default (s_ip))
		return FALSE;

	if (VTABLE_IS_IP4) {
		method = nm_utils_get_ip_config_method (connection, NM_TYPE_SETTING_IP4_CONFIG);
		if (   !method
		    || !strcmp (method, NM_SETTING_IP4_CONFIG_METHOD_DISABLED)
		    || !strcmp (method, NM_SETTING_IP4_CONFIG_METHOD_LINK_LOCAL))
			return FALSE;
	} else {
		method = nm_utils_get_ip_config_method (connection, NM_TYPE_SETTING_IP6_CONFIG);
		if (   !method
		    || !strcmp (method, NM_SETTING_IP6_CONFIG_METHOD_IGNORE)
		    || !strcmp (method, NM_SETTING_IP6_CONFIG_METHOD_LINK_LOCAL))
			return FALSE;
	}

	return TRUE;
}

gboolean
nm_default_route_manager_ip4_connection_has_default_route (NMDefaultRouteManager *self, NMConnection *connection)
{
	return _ipx_connection_has_default_route (&vtable_ip4, self, connection);
}

gboolean
nm_default_route_manager_ip6_connection_has_default_route (NMDefaultRouteManager *self, NMConnection *connection)
{
	return _ipx_connection_has_default_route (&vtable_ip6, self, connection);
}

/***********************************************************************************/

736
static NMDevice *
737
_ipx_get_best_device (const VTableIP *vtable, NMDefaultRouteManager *self, const GSList *devices)
738 739 740 741 742 743 744
{
	NMDefaultRouteManagerPrivate *priv;
	GPtrArray *entries;
	guint i;

	g_return_val_if_fail (NM_IS_DEFAULT_ROUTE_MANAGER (self), NULL);

745 746 747
	if (!devices)
		return NULL;

748 749 750 751 752 753 754 755 756 757
	priv = NM_DEFAULT_ROUTE_MANAGER_GET_PRIVATE (self);
	entries = vtable->get_entries (priv);

	for (i = 0; i < entries->len; i++) {
		Entry *entry = g_ptr_array_index (entries, i);

		if (!NM_IS_DEVICE (entry->source.pointer))
			continue;

		g_assert (!entry->never_default);
758 759 760

		if (g_slist_find ((GSList *) devices, entry->source.device))
			return entry->source.pointer;
761 762 763 764 765
	}
	return NULL;
}

/** _ipx_get_best_activating_device:
766 767 768 769 770 771 772 773 774 775
 * @vtable: the virtual table
 * @self: #NMDefaultRouteManager
 * @devices: list of devices to be searched. Only devices from this list will be considered
 * @fully_activated: if #TRUE, only search for devices that are fully activated. Otherwise,
 *   search if there is a best device going to be activated. In the latter case, this will
 *   return NULL if the best device is already activated.
 * @preferred_device: if not-NULL, this device is preferred if there are more devices with
 *   the same priority.
 **/
static NMDevice *
776
_ipx_get_best_activating_device (const VTableIP *vtable, NMDefaultRouteManager *self, const GSList *devices, NMDevice *preferred_device)
777
{
778
	NMDefaultRouteManagerPrivate *priv;
779 780 781
	const GSList *iter;
	NMDevice *best_device = NULL;
	guint32 best_prio = G_MAXUINT32;
782
	NMDevice *best_activated_device;
783 784 785

	g_return_val_if_fail (NM_IS_DEFAULT_ROUTE_MANAGER (self), NULL);

786 787
	priv = NM_DEFAULT_ROUTE_MANAGER_GET_PRIVATE (self);

788
	best_activated_device = _ipx_get_best_device (vtable, self, devices);
789

790 791 792
	for (iter = devices; iter; iter = g_slist_next (iter)) {
		NMDevice *device = NM_DEVICE (iter->data);
		guint32 prio;
793
		Entry *entry;
794

795
		entry = _entry_find_by_source (vtable->get_entries (priv), device, NULL);
796

797 798 799 800 801 802 803 804
		if (entry) {
			/* of all the device that have an entry, we already know that best_activated_device
			 * is the best. entry cannot be better. */
			if (entry->source.device != best_activated_device)
				continue;
			prio = entry->effective_metric;
		} else {
			NMDeviceState state = nm_device_get_state (device);
805

806 807 808
			if (   state <= NM_DEVICE_STATE_DISCONNECTED
			    || state >= NM_DEVICE_STATE_DEACTIVATING)
				continue;
809

810 811
			if (!_ipx_connection_has_default_route (vtable, self, nm_device_get_connection (device)))
				continue;
812

813
			prio = nm_device_get_ip4_route_metric (device);
814
		}
815 816
		prio = vtable->route_metric_normalize (prio);

817 818 819 820 821
		if (   !best_device
		    || prio < best_prio
			|| (prio == best_prio && preferred_device == device)) {
			best_device = device;
			best_prio = prio;
822 823 824
		}
	}

825 826 827 828 829 830
	/* There's only a best activating device if the best device
	 * among all activating and already-activated devices is a
	 * still-activating one.
	 */
	if (best_device && nm_device_get_state (best_device) >= NM_DEVICE_STATE_SECONDARIES)
		return NULL;
831 832 833 834 835 836
	return best_device;
}

NMDevice *
nm_default_route_manager_ip4_get_best_device (NMDefaultRouteManager *self, const GSList *devices, gboolean fully_activated, NMDevice *preferred_device)
{
837
	if (fully_activated)
838
		return _ipx_get_best_device (&vtable_ip4, self, devices);
839 840
	else
		return _ipx_get_best_activating_device (&vtable_ip4, self, devices, preferred_device);
841 842 843 844 845
}

NMDevice *
nm_default_route_manager_ip6_get_best_device (NMDefaultRouteManager *self, const GSList *devices, gboolean fully_activated, NMDevice *preferred_device)
{
846
	if (fully_activated)
847
		return _ipx_get_best_device (&vtable_ip6, self, devices);
848 849
	else
		return _ipx_get_best_activating_device (&vtable_ip6, self, devices, preferred_device);
850 851 852 853
}

/***********************************************************************************/

854 855 856 857 858 859 860 861 862 863
static gpointer
_ipx_get_best_config (const VTableIP *vtable,
                      NMDefaultRouteManager *self,
                      gboolean ignore_never_default,
                      const char **out_ip_iface,
                      NMActiveConnection **out_ac,
                      NMDevice **out_device,
                      NMVpnConnection **out_vpn)
{
	NMDefaultRouteManagerPrivate *priv;
864 865
	GPtrArray *entries;
	guint i;
866 867 868 869
	gpointer config_result = NULL;

	g_return_val_if_fail (NM_IS_DEFAULT_ROUTE_MANAGER (self), NULL);

870 871 872 873 874 875 876 877 878
	if (out_ip_iface)
		*out_ip_iface = NULL;
	if (out_ac)
		*out_ac = NULL;
	if (out_device)
		*out_device = NULL;
	if (out_vpn)
		*out_vpn = NULL;

879 880
	priv = NM_DEFAULT_ROUTE_MANAGER_GET_PRIVATE (self);

881
	g_return_val_if_fail (NM_IS_DEFAULT_ROUTE_MANAGER (self), NULL);
882

883 884
	priv = NM_DEFAULT_ROUTE_MANAGER_GET_PRIVATE (self);
	entries = vtable->get_entries (priv);
885

886 887
	for (i = 0; i < entries->len; i++) {
		Entry *entry = g_ptr_array_index (entries, i);
888

889 890
		if (!NM_IS_DEVICE (entry->source.pointer)) {
			NMVpnConnection *vpn = NM_VPN_CONNECTION (entry->source.vpn);
891

892
			if (entry->never_default && !ignore_never_default)
893 894
				continue;

895 896 897 898 899
			if (VTABLE_IS_IP4)
				config_result = nm_vpn_connection_get_ip4_config (vpn);
			else
				config_result = nm_vpn_connection_get_ip6_config (vpn);
			g_assert (config_result);
900

901 902 903 904 905 906
			if (out_vpn)
				*out_vpn = vpn;
			if (out_ac)
				*out_ac = NM_ACTIVE_CONNECTION (vpn);
			if (out_ip_iface)
				*out_ip_iface = nm_vpn_connection_get_ip_iface (vpn);
907
		} else {
908 909
			NMDevice *device = entry->source.device;
			NMActRequest *req;
910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925

			if (VTABLE_IS_IP4)
				config_result = nm_device_get_ip4_config (device);
			else
				config_result = nm_device_get_ip6_config (device);
			g_assert (config_result);
			req = nm_device_get_act_request (device);
			g_assert (req);

			if (out_device)
				*out_device = device;
			if (out_ac)
				*out_ac = NM_ACTIVE_CONNECTION (req);
			if (out_ip_iface)
				*out_ip_iface = nm_device_get_ip_iface (device);
		}
926
		break;
927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967
	}

	return config_result;
}

NMIP4Config *
nm_default_route_manager_ip4_get_best_config (NMDefaultRouteManager *self,
                                              gboolean ignore_never_default,
                                              const char **out_ip_iface,
                                              NMActiveConnection **out_ac,
                                              NMDevice **out_device,
                                              NMVpnConnection **out_vpn)
{
	return _ipx_get_best_config (&vtable_ip4,
	                             self,
	                             ignore_never_default,
	                             out_ip_iface,
	                             out_ac,
	                             out_device,
	                             out_vpn);
}

NMIP6Config *
nm_default_route_manager_ip6_get_best_config (NMDefaultRouteManager *self,
                                              gboolean ignore_never_default,
                                              const char **out_ip_iface,
                                              NMActiveConnection **out_ac,
                                              NMDevice **out_device,
                                              NMVpnConnection **out_vpn)
{
	return _ipx_get_best_config (&vtable_ip6,
	                             self,
	                             ignore_never_default,
	                             out_ip_iface,
	                             out_ac,
	                             out_device,
	                             out_vpn);
}

/***********************************************************************************/

968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001
static GPtrArray *
_v4_get_entries (NMDefaultRouteManagerPrivate *priv)
{
	return priv->entries_ip4;
}

static GPtrArray *
_v6_get_entries (NMDefaultRouteManagerPrivate *priv)
{
	return priv->entries_ip6;
}

static gboolean
_v4_platform_route_delete_default (int ifindex, guint32 metric)
{
	return nm_platform_ip4_route_delete (ifindex, 0, 0, metric);
}

static gboolean
_v6_platform_route_delete_default (int ifindex, guint32 metric)
{
	return nm_platform_ip6_route_delete (ifindex, in6addr_any, 0, metric);
}

static guint32
_v4_route_metric_normalize (guint32 metric)
{
	return metric;
}

static const VTableIP vtable_ip4 = {
	.addr_family                    = AF_INET,
	.get_entries                    = _v4_get_entries,
	.platform_route_to_string       = (const char *(*)(const NMPlatformIPRoute *)) nm_platform_ip4_route_to_string,
1002
	.platform_route_get_all         = nm_platform_ip4_route_get_all,
1003 1004 1005 1006 1007 1008 1009 1010
	.platform_route_delete_default  = _v4_platform_route_delete_default,
	.route_metric_normalize         = _v4_route_metric_normalize,
};

static const VTableIP vtable_ip6 = {
	.addr_family                    = AF_INET6,
	.get_entries                    = _v6_get_entries,
	.platform_route_to_string       = (const char *(*)(const NMPlatformIPRoute *)) nm_platform_ip6_route_to_string,
1011
	.platform_route_get_all         = nm_platform_ip6_route_get_all,
1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067
	.platform_route_delete_default  = _v6_platform_route_delete_default,
	.route_metric_normalize         = nm_utils_ip6_route_metric_normalize,
};

/***********************************************************************************/

NMDefaultRouteManager *
nm_default_route_manager_get ()
{
	if (G_UNLIKELY (!_instance)) {
		_instance = NM_DEFAULT_ROUTE_MANAGER (g_object_new (NM_TYPE_DEFAULT_ROUTE_MANAGER, NULL));
		g_object_add_weak_pointer (G_OBJECT (_instance), (gpointer *) &_instance);
	}
	return _instance;
}

/***********************************************************************************/

static void
nm_default_route_manager_init (NMDefaultRouteManager *self)
{
	NMDefaultRouteManagerPrivate *priv = NM_DEFAULT_ROUTE_MANAGER_GET_PRIVATE (self);

	priv->entries_ip4 = g_ptr_array_new_full (0, (GDestroyNotify) _entry_free);
	priv->entries_ip6 = g_ptr_array_new_full (0, (GDestroyNotify) _entry_free);
}

static void
dispose (GObject *object)
{
	NMDefaultRouteManager *self = NM_DEFAULT_ROUTE_MANAGER (object);
	NMDefaultRouteManagerPrivate *priv = NM_DEFAULT_ROUTE_MANAGER_GET_PRIVATE (self);

	if (priv->entries_ip4) {
		g_ptr_array_free (priv->entries_ip4, TRUE);
		priv->entries_ip4 = NULL;
	}
	if (priv->entries_ip6) {
		g_ptr_array_free (priv->entries_ip6, TRUE);
		priv->entries_ip6 = NULL;
	}

	G_OBJECT_CLASS (nm_default_route_manager_parent_class)->dispose (object);
}

static void
nm_default_route_manager_class_init (NMDefaultRouteManagerClass *klass)
{
	GObjectClass *object_class = G_OBJECT_CLASS (klass);

	g_type_class_add_private (klass, sizeof (NMDefaultRouteManagerPrivate));

	/* virtual methods */
	object_class->dispose = dispose;
}