From nobody Mon Mar 13 08:02:29 2023 X-Original-To: dev-commits-src-all@mlmmj.nyi.freebsd.org Received: from mx1.freebsd.org (mx1.freebsd.org [IPv6:2610:1c1:1:606c::19:1]) by mlmmj.nyi.freebsd.org (Postfix) with ESMTP id 4PZpzT6pVNz3xMVJ; Mon, 13 Mar 2023 08:02:29 +0000 (UTC) (envelope-from git@FreeBSD.org) Received: from mxrelay.nyi.freebsd.org (mxrelay.nyi.freebsd.org [IPv6:2610:1c1:1:606c::19:3]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (4096 bits) server-digest SHA256 client-signature RSA-PSS (4096 bits) client-digest SHA256) (Client CN "mxrelay.nyi.freebsd.org", Issuer "R3" (verified OK)) by mx1.freebsd.org (Postfix) with ESMTPS id 4PZpzT6Kn4z4NrR; Mon, 13 Mar 2023 08:02:29 +0000 (UTC) (envelope-from git@FreeBSD.org) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=freebsd.org; s=dkim; t=1678694549; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding; bh=LOxujEgT89PHwkea7l4HOi86q3HobonsTF5sDUQHDzg=; b=Kp02U9Zxhsle5eYxfP3l42WpZAtnayOJSjcYk1kE21dSjcliY0B4uXJVIQnlZRP04gMK4A 24xSjPADHzub2vB4T44olBZVrVd1R2tG8BHenSOJcWOqUBxIdF28eUIX9MUxRHcANaohGW aSc1+34nvF21eVv68zUVQLBIOZD6VS4ApP+/RwQhxbavpqel9ZaAh0FCwrtjW0PVKWso3I FZ3/p15bk9QNYCu1oeSG8SlAvDDfylaMFnHn8+E7kM5j/UyBrLv7Tw6/Pt6vpJueYkLdK8 aPaToQZfUNZvIW3KwHqlPBF3JcqkAxMZ7+nUiw5+i0qOTkVvOuWk9eM+8k+OWQ== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=freebsd.org; s=dkim; t=1678694549; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding; bh=LOxujEgT89PHwkea7l4HOi86q3HobonsTF5sDUQHDzg=; b=LiV8FuZMfrNMZUhdxtrAzJ7LkqHcPEKA5sFFn/O9cqiWy0Xs19OkJzCy7y0qjQVsR+BdIE kn9z0vdg0qWQX/wYF6Q32bR36pGE68UZfkFtGVcSvpPMZy56PRpgyUz+46Ll9nvC6F5ff5 6orrIBInOqGqUmMXrzTMk6sQgos/Qsq6xz+HxEiUpspo8wBKDImRSZ0ypG+cQvy+MdUTL5 Jk8uXSdjNR0TTIfyPwlgSeavTcDojLV24WelIhNhzXTb0FC7G7TnSDjbLMA/+bMyUjBefT LJh7pBVublSdYWIRx0YLI9UWdVCZowtvo46olX+uWgoCdmskBJGHM1avQds1uQ== ARC-Authentication-Results: i=1; mx1.freebsd.org; none ARC-Seal: i=1; s=dkim; d=freebsd.org; t=1678694549; a=rsa-sha256; cv=none; b=ycF4D3yHEKnzbso/ccqUi6yYFYXfcmZqGRbibXhMfBIWkWXzH7//7vqFiOfnHvDZuWY7Wt X7mJdOtt5luqVDZZMJBGOYHlenVkmJBqW648fYHcvZNiWUfa/5yNlgOV2oymrVIXYFoG7d lhp75wA3ewBHu1MbsXcmn4ckOrb3GM2J5q4c8UahuGe7XYqVCi9SzJmsab4S1pFm44yt0o 9aqXFghN7CgQHOUQQyGEOB4YX+jktjipNEKEAm0LSdh0js4lkqjFaS7cCv+birexRINn/x QdDZdABQ7qQvsZmQfYhxhvWuvRoo1udtH9DQGW9Zk4qUOND6ewOwD/ATYroKNA== Received: from gitrepo.freebsd.org (gitrepo.freebsd.org [IPv6:2610:1c1:1:6068::e6a:5]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (4096 bits) server-digest SHA256) (Client did not present a certificate) by mxrelay.nyi.freebsd.org (Postfix) with ESMTPS id 4PZpzT5RKCzlHF; Mon, 13 Mar 2023 08:02:29 +0000 (UTC) (envelope-from git@FreeBSD.org) Received: from gitrepo.freebsd.org ([127.0.1.44]) by gitrepo.freebsd.org (8.16.1/8.16.1) with ESMTP id 32D82Trh068560; Mon, 13 Mar 2023 08:02:29 GMT (envelope-from git@gitrepo.freebsd.org) Received: (from git@localhost) by gitrepo.freebsd.org (8.16.1/8.16.1/Submit) id 32D82TA1068559; Mon, 13 Mar 2023 08:02:29 GMT (envelope-from git) Date: Mon, 13 Mar 2023 08:02:29 GMT Message-Id: <202303130802.32D82TA1068559@gitrepo.freebsd.org> To: src-committers@FreeBSD.org, dev-commits-src-all@FreeBSD.org, dev-commits-src-branches@FreeBSD.org From: Gordon Bergling Subject: git: afca4c000b72 - stable/13 - route.8: Add information about ROUTE_MPATH and FIB_ALGO List-Id: Commit messages for all branches of the src repository List-Archive: https://lists.freebsd.org/archives/dev-commits-src-all List-Help: List-Post: List-Subscribe: List-Unsubscribe: Sender: owner-dev-commits-src-all@freebsd.org X-BeenThere: dev-commits-src-all@freebsd.org MIME-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: 8bit X-Git-Committer: gbe X-Git-Repository: src X-Git-Refname: refs/heads/stable/13 X-Git-Reftype: branch X-Git-Commit: afca4c000b72cc22b4dd988f67a954cbfe0c84d5 Auto-Submitted: auto-generated X-ThisMailContainsUnwantedMimeParts: N The branch stable/13 has been updated by gbe: URL: https://cgit.FreeBSD.org/src/commit/?id=afca4c000b72cc22b4dd988f67a954cbfe0c84d5 commit afca4c000b72cc22b4dd988f67a954cbfe0c84d5 Author: Gordon Bergling AuthorDate: 2023-02-26 13:15:34 +0000 Commit: Gordon Bergling CommitDate: 2023-03-13 08:01:49 +0000 route.8: Add information about ROUTE_MPATH and FIB_ALGO Since the kernel options ROUTE_MPATH and FIB_ALGO are enabled per default for a while, it's good to have some user facing documetation about the general functionality of multipath routing and fib lookup algorithms. Reviewed by: pauamma, Jose Luis Duran Differential Revision: https://reviews.freebsd.org/D38783 (cherry picked from commit b06338167d64507e79e003500002e22fbe583832) --- sbin/route/route.8 | 57 +++++++++++++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 56 insertions(+), 1 deletion(-) diff --git a/sbin/route/route.8 b/sbin/route/route.8 index 161189e7a9d8..c893ae5ab4b3 100644 --- a/sbin/route/route.8 +++ b/sbin/route/route.8 @@ -28,7 +28,7 @@ .\" @(#)route.8 8.3 (Berkeley) 3/19/94 .\" $FreeBSD$ .\" -.Dd December 15, 2021 +.Dd February 26, 2023 .Dt ROUTE 8 .Os .Sh NAME @@ -405,6 +405,60 @@ and .Dv RTM_CHANGE . As such, only the super-user may modify the routing tables. +.Pp +.Fx provides support for scalable multipath routing. +It is activated by default, but can be turned off by setting the +.Va net.route.multipath +.Xr sysctl 8 +MIB to 0. +.Pp +There are multiple route lookup algorithms available. +They can be configured by setting +.Va net.route.algo.inet.algo +for IPv4 and +.Va net.route.algo.inet6.algo +for IPv6 +.Xr sysctl 8 +MIBs. +.Pp +A list of available algorithms can be obtained by accessing the +following +.Xr sysctl 8 +MIBs +.Va net.route.algo.inet.algo_list +for IPv4 and +.Va net.route.algo.inet6.algo_list +for IPv6. +.Pp +The following algorithms are available: +.Bl -tag -width radix_lockless +.It radix +Base system radix backend. +.It bsearch +Lockless binary search in a special IP array, tailored for a small FIB +with <16 routes. +This algorithm is only available for IPv4. +.It radix_lockless +Lockless immutable radix, re-created on every rtable change, +tailored for a small FIB with <1000 routes. +.It dpdk_lpm +DPDK DIR24-8-based lookups, lockless datastructure, optimized +for a large FIB. +In order to use the dpdk_lpm algorithm one or both of the +following kernel modules must be loaded via +.Xr loader.conf 5 : +.Bl -tag -width dpdk_lpm6.ko -compact +.It dpdk_lpm4.ko +DPDK implementation for IPv4. +.It dpdk_lpm6.ko +DPDK implementation for IPv6. +.El +.El +.Pp +The algorithms are selected automatically based on the size of the routing +table of the system. +They can be changed, but not every algorithm performs best for every +FIB size. .Sh EXIT STATUS .Ex -std .Sh EXAMPLES @@ -484,6 +538,7 @@ The next-hop gateway should be reachable through a different route. .Xr netstat 1 , .Xr netintro 4 , .Xr route 4 , +.Xr loader.conf 5 , .Xr arp 8 , .Xr routed 8 .Sh HISTORY