enhance SaiRouteManager to keep track of routes with invalid metadata

Summary: This is follow-up of S466640. Enhance SaiRouteManager to keep track of a list of routes with invalid metadata, i.e. routes have class id 2 but nexthop is not pointing to cpu port

Reviewed By: jasmeetbagga

Differential Revision: D67951124

fbshipit-source-id: 96fa44e0e30e63fe32f880f4fd74006f9070951b

Author: daiwei1983

fboss/agent/Utils.cpp

@@ -1155,4 +1155,12 @@ int numFabricLevels(const std::map<int64_t, cfg::DsfNode>& dsfNodes) {
       });
   return maxFabricLevel;
 }
+
+const std::vector<cfg::AclLookupClass>& getToCpuClassIds() {
+  static const std::vector<cfg::AclLookupClass> toCpuClassIds = {
+      cfg::AclLookupClass::DST_CLASS_L3_LOCAL_1,
+      cfg::AclLookupClass::DST_CLASS_L3_LOCAL_2,
+  };
+  return toCpuClassIds;
+}
 } // namespace facebook::fboss

fboss/agent/Utils.h

@@ -457,4 +457,6 @@ CpuCosQueueId hwQueueIdToCpuCosQueueId(
     const HwAsic* asic,
     HwSwitchFb303Stats* hwswitchStats);
 int numFabricLevels(const std::map<int64_t, cfg::DsfNode>& dsfNodes);
+
+const std::vector<cfg::AclLookupClass>& getToCpuClassIds();
 } // namespace facebook::fboss

fboss/agent/hw/sai/switch/SaiRouteManager.cpp

@@ -9,6 +9,7 @@
  */
 
 #include "fboss/agent/hw/sai/switch/SaiRouteManager.h"
+#include "fboss/agent/Utils.h"
 
 #include "fboss/agent/hw/sai/store/SaiStore.h"
 #include "fboss/agent/hw/sai/switch/SaiCounterManager.h"
@@ -426,6 +427,9 @@ void SaiRouteManager::addOrUpdateRoute(
   routeHandle->route = route;
   routeHandle->nexthopHandle_ = nextHopHandle;
   routeHandle->counterHandle_ = counterHandle;
+  if (!newRoute->isConnected()) {
+    checkMetadata(entry);
+  }
 }
 
 template <typename AddrT>
@@ -596,6 +600,34 @@ SaiRouteManager::refOrCreateManagedRouteNextHop(
   return managedRouteNextHop;
 }
 
+void SaiRouteManager::checkMetadata(SaiRouteTraits::RouteEntry entry) {
+  auto route = getRouteObject(entry);
+  if (!route) {
+    return;
+  }
+  auto attributes = route->attributes();
+  auto metadata =
+      std::get<std::optional<SaiRouteTraits::Attributes::Metadata>>(attributes);
+  auto nexthop = std::get<std::optional<SaiRouteTraits::Attributes::NextHopId>>(
+      attributes);
+  const auto& toCpuClassIds = getToCpuClassIds();
+  if (metadata.has_value() && metadata.value().value() &&
+      std::find(
+          toCpuClassIds.begin(),
+          toCpuClassIds.end(),
+          static_cast<cfg::AclLookupClass>(metadata.value().value())) !=
+          toCpuClassIds.end() &&
+      nexthop.has_value() &&
+      nexthop.value() !=
+          static_cast<sai_object_id_t>(
+              managerTable_->switchManager().getCpuPort())) {
+    // invalid
+    XLOG(FATAL) << "found invalid route entry with class id value "
+                << std::to_string(metadata.value().value())
+                << " but cpu is not nexthop: " << entry.toString();
+  }
+}
+
 template <typename NextHopTraitsT>
 ManagedRouteNextHop<NextHopTraitsT>::ManagedRouteNextHop(
     PortSaiId cpuPort,

fboss/agent/hw/sai/switch/SaiRouteManager.h

@@ -136,6 +136,8 @@ class SaiRouteManager {
   std::shared_ptr<SaiObject<SaiRouteTraits>> getRouteObject(
       SaiRouteTraits::AdapterHostKey routeKey);
 
+  void checkMetadata(SaiRouteTraits::RouteEntry entry);
+
  private:
   SaiRouteHandle* getRouteHandleImpl(
       const SaiRouteTraits::RouteEntry& entry) const;