VRF implementation for dataplane #242

stal76 · 2024-09-08T11:58:46Z

Previously, it was possible to add routing rules for different VRFs, but it was not possible to set VRFs for packets and only 'default' was used for them.
In the current change, the ability to set VRF for the entire logical port has been added. Later it will be possible to set VRF by acl rules.
To solve the LPM problem, an algorithm like to 'a path-compressed trie' is used.

ol-imorozko · 2024-10-02T12:03:39Z

common/define.h

@@ -103,6 +103,7 @@ extern LogPriority logPriority;
 #define YANET_RIB_PRIORITY_DEFAULT ((uint32_t)10000)
 #define YANET_RIB_PRIORITY_ROUTE_TUNNEL_FALLBACK ((uint32_t)11000)
 #define YANET_RIB_PRIORITY_ROUTE_REPEAT ((uint32_t)12000)
+#define YANET_RIB_VRF_DEFAULT "default"


constexpr auto YANET_RIB_VRF_DEFAULT = "default";

ol-imorozko · 2024-10-02T12:05:58Z

common/define.h

 #define YANET_RIB_PRIORITY_ROUTE_REPEAT ((uint32_t)12000)
+#define YANET_RIB_VRF_DEFAULT "default"


I think we should replace that in 97th line in librib/libyabird.cpp too:

std::get<1>(request) = {peer_address, {"default", ///< @todo: vrf YANET_RIB_PRIORITY_DEFAULT}};

ol-imorozko · 2024-10-02T12:10:46Z

controlplane/route.h

+	bool is_ignored_table(const std::string& table_name) const
+	{


const method returning value should be marked [[nodiscard]]

controlplane/route.h

cli/show.h

common/blocks_allocator.h

common/unittest/bits.cpp

common/unittest/blocks_allocator.cpp

dataplane/vrf.h

dataplane/vrf.cpp

dataplane/unittest/meson.build

dataplane/unittest/random_prefixes.h

dataplane/unittest/random_prefixes.cpp

dataplane/unittest/vrf_lpm_linear.cpp

dataplane/unittest/vrf_lpm_common.h

dataplane/unittest/vrf_lpm_map.h

dataplane/updater.h

dataplane/vrf.cpp

ol-imorozko · 2025-01-29T14:01:12Z

common/controlplaneconfig.h

+	config_t() :
+	        vrf(YANET_RIB_VRF_DEFAULT),
+	        tunnel_enabled(false)
+	{
+	}


I think this is redundant, since that class' fields are already defined with default values:

std::string vrf{"default"}; bool tunnel_enabled{};

We need to change that "default" to YANET_RIB_VRF_DEFAULT though, and that's it

ol-imorozko · 2025-01-29T14:04:18Z

common/define.h

@@ -118,6 +118,8 @@ extern LogPriority logPriority;
 #define YANET_RIB_PRIORITY_DEFAULT ((uint32_t)10000)
 #define YANET_RIB_PRIORITY_ROUTE_TUNNEL_FALLBACK ((uint32_t)11000)
 #define YANET_RIB_PRIORITY_ROUTE_REPEAT ((uint32_t)12000)
+#define YANET_RIB_VRF_DEFAULT "default"
+#define YANET_RIB_VRF_MAX_NUMBER 64


Suggested change

#define YANET_RIB_VRF_MAX_NUMBER 64

inline constexpr auto YANET_RIB_VRF_MAX_NUMBER = 64;

or replace auto with int, whichever you prefer

ol-imorozko · 2025-01-29T14:20:32Z

controlplane/controlplane.cpp

+tVrfId VrfIdStorage::GetOrCreateOrException(const std::string& vrfName, const std::string& message)
+{
+	std::optional<tVrfId> vrfId = GetOrCreate(vrfName);
+	if (!vrfId.has_value())
+	{
+		throw error_result_t(eResult::invalidVrfId, message + vrfName);
+	}
+	return *vrfId;
+}


We pass only string literals as message to this function. Since we're taking const ref to a string, we will first require to construct that string from a string literal, and then we will construct another string by concatenating both when throwing an exception.

The better approach is to take message as a string_view, which is specifically designed as non-owning reference to a string.

Next, when calling this function, we expect user to add additional symbols ((": ") to message to make the error message pretty:

logicalPort.vrfId = controlplane_ptr->getVrfIdsStorage().GetOrCreateOrException(logicalPort.vrf, "Can't get id logicalPort.vrf: ");

The cleaner approach is to use std::ostringstream to construct the error message (which is far more efficient that concatenation with operator+).
So I suggest:

Suggested change

tVrfId VrfIdStorage::GetOrCreateOrException(const std::string& vrfName, const std::string& message)

{

std::optional<tVrfId> vrfId = GetOrCreate(vrfName);

if (!vrfId.has_value())

{

throw error_result_t(eResult::invalidVrfId, message + vrfName);

}

return *vrfId;

}

tVrfId VrfIdStorage::GetOrCreateOrException(const std::string& vrfName, std::string_view message)

{

std::optional<tVrfId> vrfId = GetOrCreate(vrfName);

if (!vrfId.has_value())

{

std::ostringstream oss;

oss << message <<": " << vrfName;

throw error_result_t(eResult::invalidVrfId, oss.str());

}

return *vrfId;

}

ol-imorozko · 2025-01-29T16:11:38Z

controlplane/controlplane.cpp

+	if (vrf_ids.size() + 1 >= YANET_RIB_VRF_MAX_NUMBER)
+	{
+		vrf_ids[vrfName] = std::nullopt;


Do we need to store std::nullopt in a map if we exceed the number of different id's?
I think we can just don't put it there.
This way we can use plain tVrfId instead of std::optional<tVrfId> in the map. If the ID can’t be assigned, we simply don’t put an entry in the map at all

ol-imorozko · 2025-01-29T16:17:00Z

controlplane/controlplane.cpp

+std::optional<tVrfId> VrfIdStorage::Get(const std::string& vrfName)
+{
+	if (vrfName.empty() || vrfName == YANET_RIB_VRF_DEFAULT)
+	{
+		return 0;
+	}
+
+	std::shared_lock lock(mutex);
+
+	auto iter = vrf_ids.find(vrfName);
+	if (iter != vrf_ids.end())
+	{
+		return iter->second;
+	}
+
+	return std::nullopt;
+}


IMHO Get method should be marked const. It makes sense that in order to get something, we don't actually change the state of the class.
Now, we do capture a mutex here, so we need to mark it mutable (mutable mutexes is a good idea):

private: mutable std::shared_mutex mutex;

ol-imorozko · 2025-01-29T18:02:04Z

dataplane/updater.h

+			updaters_[vrf] = std::make_unique<UpdaterType>(name.c_str(), memory_manager_, socket_id_);
+			if (updaters_[vrf] == nullptr)
+			{
+				return eResult::errorAllocatingMemory;
+			}


This won't work. std::make_unique never returns nullptr - either it succeeds, or it throws std::bad_alloc.

If we want to return an appropriate eResult, we need to use one of the new operator overloads that takes std::nothrow object:

auto new_updater = std::unique_ptr<UpdaterType>( new(std::nothrow) UpdaterType(uniqueName.c_str(), memory_manager_, socket_id_) );

Or you can define helper function in the util namespace:

template<typename T, typename... Args> std::unique_ptr<T> make_unique_nothrow(Args&&... args) { return std::unique_ptr<T>(new(std::nothrow) T(std::forward<Args>(args)...)); }

ol-imorozko · 2025-01-29T18:09:56Z

dataplane/updater.h

+		for (size_t index = 0; index < YANET_RIB_VRF_MAX_NUMBER; index++)
+		{
+			if (updaters_[index])
+			{
+				updaters_[index]->limits(limits);
+			}
+		}


Suggested change

for (size_t index = 0; index < YANET_RIB_VRF_MAX_NUMBER; index++)

{

if (updaters_[index])

{

updaters_[index]->limits(limits);

}

}

for (const auto& updater : updaters_)

{

if (updater)

{

updater->limits(limits);

}

}

ol-imorozko · 2025-01-29T18:10:20Z

dataplane/updater.h

+		for (size_t index = 0; index < YANET_RIB_VRF_MAX_NUMBER; index++)
+		{
+			if (updaters_[index])
+			{
+				updaters_[index]->report(report);
+			}
+		}


Suggested change

for (size_t index = 0; index < YANET_RIB_VRF_MAX_NUMBER; index++)

{

if (updaters_[index])

{

updaters_[index]->report(report);

}

}

for (const auto& updater : updaters_)

{

if (updater)

{

updater->report(report);

}

}

ol-imorozko · 2025-01-29T18:10:38Z

dataplane/updater.h

+		for (size_t index = 0; index < YANET_RIB_VRF_MAX_NUMBER; index++)
+		{
+			if (updaters_[index])
+			{
+				updaters_[index]->clear();
+				updaters_[index] = nullptr;
+			}
+		}


Suggested change

for (size_t index = 0; index < YANET_RIB_VRF_MAX_NUMBER; index++)

{

if (updaters_[index])

{

updaters_[index]->clear();

updaters_[index] = nullptr;

}

}

for (const auto& updater : updaters_)

{

if (updater)

{

updater->clear();

updater.reset();

}

}

ol-imorozko · 2025-01-29T18:13:43Z

dataplane/vrf.h

+	}
+
+private:
+	std::array<InnerLpmType*, YANET_RIB_VRF_MAX_NUMBER> lpms_;


std::array<InnerLpmType*, YANET_RIB_VRF_MAX_NUMBER> is a common type, as I can see. I suggest to add an alias for it.
We will be able to utilize it GetLpms method of updater_vrf_lpm class too

ol-imorozko · 2025-01-31T18:57:06Z

dataplane/vrf.h

+	void Lookup(const Address* ipAddresses, const tVrfId* vrfIds, uint32_t* valueIds, const unsigned int& count) const
+	{
+		for (unsigned int index = 0; index < count; index++)
+		{
+			valueIds[index] = lpmValueIdInvalid;
+			tVrfId vrf = vrfIds[index];
+			if ((vrf < YANET_RIB_VRF_MAX_NUMBER) && (lpms_[vrf] != nullptr))
+			{
+				lpms_[vrf]->lookup(ipAddresses + index, valueIds + index, 1);
+			}
+		}
+	}


The correct approach would be to use iterators to std::array instead of pointer arithmetics, but we're so elbow deep in c-style arrays and pointer arithmetics in worker.h and in underlying lpm that such change would seem unnecessary.
Let's hope that in YANET2 we will be able to make things right (:

(that's not an issue, ignore it)

ol-imorozko · 2025-01-31T18:59:01Z

dataplane/worker.h

@@ -51,6 +51,11 @@ class tStack
 		mbufsCount = 0;
 	}

+	inline void copy_from(tStack& other)


Suggested change

inline void copy_from(tStack& other)

void copy_from(tStack& other)

inline is redundant.

A function defined entirely inside a class/struct/union definition, whether it's a member function or a non-member friend function, is implicitly an inline function

link

…is define

- Fixed filling in lpm stats. - Checking that the route table is ignored has been moved.

- VRF storage has been added in some structures, and vrf is also passed in calls to some functions. - In controlplane.conf one can set the vrf in logicalPort. In the metadata of the network packet the vrfId is filled in according to the value from logicalPort. - A VrfIdStorage object has been added to the cControlPlane class, which issues an id named vrf.

In controlplane.conf, one can set the vrf for lan and wan in the nat64statefull and nat46clat sections, these values will be set in the packet metadata.

ol-imorozko · 2025-02-18T14:24:25Z

I see that you've pushed Fix based on review comments commit.
Could you, please, also mark related conversations as "resolved"? Thanks :)

ol-imorozko · 2025-02-19T11:30:35Z

I see that you've fixed the most important one among my review requests -- about std::make_unique never returning nullptr - either it succeeds, or it throws std::bad_alloc.
You can fix other things, most notably, https://github.com/yanet-platform/yanet/pull/242/files#r1934297957 about passing 8-bit and 32-bit value instead of two 64-bit pointers, but I'm going to approve it now anyway

stal76 requested a review from GeorgyKirichenko as a code owner September 8, 2024 11:58

stal76 force-pushed the vrf branch from 867f368 to 4c7ea67 Compare September 8, 2024 12:25

stal76 force-pushed the vrf branch 2 times, most recently from 6b2cf70 to 591f52f Compare September 20, 2024 10:49

ol-imorozko requested changes Oct 2, 2024

View reviewed changes

ol-imorozko requested changes Oct 4, 2024

View reviewed changes

stal76 force-pushed the vrf branch 2 times, most recently from 79639b4 to c0399dd Compare December 22, 2024 16:47

ol-imorozko requested changes Jan 29, 2025

View reviewed changes

ol-imorozko requested changes Jan 31, 2025

View reviewed changes

stal76 force-pushed the vrf branch from 8bd9ee1 to d4674fe Compare February 17, 2025 13:35

stal76 added 9 commits February 17, 2025 19:18

Fix error in autotest 076_rfc_5549_route_tunnel_ipip

6101e5b

Added define, replaced the use of the string "default" in RIB with th…

0f0df21

…is define

Corrections before making changes to the VRF

3f4f7ce

- Fixed filling in lpm stats. - Checking that the route table is ignored has been moved.

Added the ability to set VRF for nat64statefull and nat46clat

23ae246

In controlplane.conf, one can set the vrf for lan and wan in the nat64statefull and nat46clat sections, these values will be set in the packet metadata.

Added forwarding of route information from controlplane to dataplane

1505a06

Added vrf implementation in worker

d9da607

Added autotests for vrf

e098ea6

Fix based on review comments

a2e78ef

stal76 force-pushed the vrf branch from d4674fe to a2e78ef Compare February 17, 2025 16:34

ol-imorozko approved these changes Feb 19, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

VRF implementation for dataplane #242

VRF implementation for dataplane #242

stal76 commented Sep 8, 2024

ol-imorozko Oct 2, 2024

ol-imorozko Oct 2, 2024

ol-imorozko Oct 2, 2024

ol-imorozko Jan 29, 2025

ol-imorozko Jan 29, 2025

ol-imorozko Jan 29, 2025

ol-imorozko Jan 29, 2025

ol-imorozko Jan 29, 2025

ol-imorozko Jan 29, 2025

ol-imorozko Jan 29, 2025

ol-imorozko Jan 29, 2025

ol-imorozko Jan 29, 2025

ol-imorozko Jan 29, 2025

ol-imorozko Jan 31, 2025

ol-imorozko Jan 31, 2025

ol-imorozko commented Feb 18, 2025 •

edited

Loading

ol-imorozko commented Feb 19, 2025 •

edited

Loading

		#define YANET_RIB_PRIORITY_ROUTE_REPEAT ((uint32_t)12000)
		#define YANET_RIB_VRF_DEFAULT "default"

	#define YANET_RIB_VRF_MAX_NUMBER 64
	inline constexpr auto YANET_RIB_VRF_MAX_NUMBER = 64;

	inline void copy_from(tStack& other)
	void copy_from(tStack& other)

VRF implementation for dataplane #242

Are you sure you want to change the base?

VRF implementation for dataplane #242

Conversation

stal76 commented Sep 8, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ol-imorozko commented Feb 18, 2025 • edited Loading

ol-imorozko commented Feb 19, 2025 • edited Loading

ol-imorozko commented Feb 18, 2025 •

edited

Loading

ol-imorozko commented Feb 19, 2025 •

edited

Loading