From nobody Sun Feb 26 13:16:02 2023 X-Original-To: dev-commits-src-main@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 4PPkfB70W5z3tZd0; Sun, 26 Feb 2023 13:16:02 +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 4PPkfB6K2Rz3MrP; Sun, 26 Feb 2023 13:16:02 +0000 (UTC) (envelope-from git@FreeBSD.org) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=freebsd.org; s=dkim; t=1677417362; 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=XNFdXbxU3vX5HCTLzPZuS2uXL27vriNKFjEB23QSJNY=; b=dDSBN/A1uP1QizOSESErTO6RdfPQ/JxvO4eAUbLg5L8BomDUqbMh7aJKUeIYJJ+uuda4od w2Rfb/BEa7vG9C2U/0nSc0IChMVw1CYhyWVBFD5BTpylKeftrlIYk65tNbRzDEG2SDpyb0 4EXwRvTzwptnJQuiLBqnBOohUhGTWly/tpiGBiFHqoK/UU9BkyfK3p509EGChPFXEfcNQN SxK9Bfvmd980ilT+Yz4OWruTn6aXEGS/kT5Spiw2fJB0pXsyb47YTKL2ITmIKo9j1LqCS5 V6RSvadEEi5HjLDF1AjJNwcHibF2I46rD9IdyIe4/qEx1/ElVTrKrIbVXa7mZg== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=freebsd.org; s=dkim; t=1677417362; 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=XNFdXbxU3vX5HCTLzPZuS2uXL27vriNKFjEB23QSJNY=; b=YBBfCAAzpoMRYGB3TDpk70+EkiB/nInb6PSW5DPgc8CJKNCW/4WKKFZM8gQhwt60mcVNsC bxR1bkByrhvqF27QRireMMpH38kayrFhPbtiH6jgdZZwpYKRPqEhpBNJn8F4+I3RgMRVup emqa4uPhc2+epVMAVif4q/7XlSmMA/wLO7KlTncY/YHuoyA0oO8Nk0X36ZDNtn7rQxw9QA j29zC7FBegk2vwGklHJIWYw3if6e7CY2WxtoY8Dw/6iIEAZ7cY3mDzNKx3I6Xd5tCD4tV+ 9rNBLv5t3BIcedXG7UIqqCXtixACpEkyvFTEWxnXzPR9M5GzIwOKbMSh8QWv1g== ARC-Authentication-Results: i=1; mx1.freebsd.org; none ARC-Seal: i=1; s=dkim; d=freebsd.org; t=1677417362; a=rsa-sha256; cv=none; b=renddYW29vVRbhiKwwnV9SdfxvAh9K+ZQp2pSz3eDHYF6hTn+jWBsMYMXob3ydwptpOcA3 VgIEVGD3tmysot7tLDOVKDUQlqaphHbUS+s/CNR/+SpXCYhdOAAOPzag+X7hN8+lnBf/y3 LZ0CxwTBnID7InmmI6kyL8SeLYYXaq8JDGZc6IBsg4T9NFcbHy0p/wdqeKq6MQ4Pe7N5Mn J1MRorMmcp3LhXTjB98LgI5/S6tFFa3hOAGOdlHQJQNiHhnjUSvT8Cz7+KImNyLFLqd0wO SNIEIbS0WNIwPeHpNp+sJUbllcqghqpTVmaTBJviXdicjgb7ZbCRr2eXA+EW2w== 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 4PPkfB5F0wzmnq; Sun, 26 Feb 2023 13:16:02 +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 31QDG2Dj077523; Sun, 26 Feb 2023 13:16:02 GMT (envelope-from git@gitrepo.freebsd.org) Received: (from git@localhost) by gitrepo.freebsd.org (8.16.1/8.16.1/Submit) id 31QDG2s0077522; Sun, 26 Feb 2023 13:16:02 GMT (envelope-from git) Date: Sun, 26 Feb 2023 13:16:02 GMT Message-Id: <202302261316.31QDG2s0077522@gitrepo.freebsd.org> To: src-committers@FreeBSD.org, dev-commits-src-all@FreeBSD.org, dev-commits-src-main@FreeBSD.org From: Gordon Bergling Subject: git: b06338167d64 - main - route.8: Add information about ROUTE_MPATH and FIB_ALGO List-Id: Commit messages for the main branch of the src repository List-Archive: https://lists.freebsd.org/archives/dev-commits-src-main List-Help: List-Post: List-Subscribe: List-Unsubscribe: Sender: owner-dev-commits-src-main@freebsd.org X-BeenThere: dev-commits-src-main@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/main X-Git-Reftype: branch X-Git-Commit: b06338167d64507e79e003500002e22fbe583832 Auto-Submitted: auto-generated X-ThisMailContainsUnwantedMimeParts: N The branch main has been updated by gbe: URL: https://cgit.FreeBSD.org/src/commit/?id=b06338167d64507e79e003500002e22fbe583832 commit b06338167d64507e79e003500002e22fbe583832 Author: Gordon Bergling AuthorDate: 2023-02-26 13:15:34 +0000 Commit: Gordon Bergling CommitDate: 2023-02-26 13:15:34 +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 MFC after: 5 days Differential Revision: https://reviews.freebsd.org/D38783 --- 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