adding SAI 0.9.3 support to fboss

BUILD.md

@@ -15,6 +15,7 @@ If you want to build them manually, the dependencies are as follows:
 * iproute2-3.19.0: download from
   [here](https://www.kernel.org/pub/linux/utils/net/iproute2/iproute2-3.19.0.tar.xz)
 * Broadcom's [OpenNSL](https://github.com/Broadcom-Switch/OpenNSL)
+* [OCP-SAI](https://github.com/opencomputeproject/SAI.git), download only.
 
 Once the prerequisites are available, take the following steps. 
 
@@ -26,7 +27,11 @@ git clone https://github.com/facebook/fboss.git
 
 If you installed dependencies manually, CMAKE_INCLUDE_PATH and
 CMAKE_LIBRARY_PATH must be modified to include the paths to the dependencies.
-If you use `getdeps.sh`, then this should work out of the box.
+If you use `getdeps.sh`, then this should work out of the box. 
+
+If you build with SAI there are two additional steps: (1) copy and rename the 
+SAI adapter library as external/SAI/lib/libSaiAdapter.so (2) copy and rename
+./fboss/github/CMakeLists_SAI.txt as ./CMakeLists_SAI.txt.
 
 Build as follows:
 
@@ -36,5 +41,4 @@ cd fboss/build
 cmake ..
 make
 ```
-
-The produced executables are `sim_agent` and `wedge_agent` in the build directory.
+The produced executables are `sim_agent` and `wedge_agent` (or `sai_agent`) in the build directory.

fboss/agent/hw/sai/SaiError.cpp

@@ -0,0 +1,18 @@
+/*
+ * Copyright (c) 2004-present, Facebook, Inc.
+ * Copyright (c) 2016, Cavium, Inc.
+ * All rights reserved.
+ * 
+ * This source code is licensed under the BSD-style license found in the
+ * LICENSE file in the root directory of this source tree. An additional grant
+ * of patent rights can be found in the PATENTS file in the same directory.
+ * 
+ */
+#include "SaiError.h"
+
+#include <stdlib.h>
+#include <sstream>
+
+namespace facebook { namespace fboss {
+
+}} // facebook::fboss

fboss/agent/hw/sai/SaiError.h

@@ -0,0 +1,37 @@
+/*
+ * Copyright (c) 2004-present, Facebook, Inc.
+ * Copyright (c) 2016, Cavium, Inc.
+ * All rights reserved.
+ * 
+ * This source code is licensed under the BSD-style license found in the
+ * LICENSE file in the root directory of this source tree. An additional grant
+ * of patent rights can be found in the PATENTS file in the same directory.
+ * 
+ */
+#pragma once
+
+#include "fboss/agent/FbossError.h"
+
+namespace facebook { namespace fboss {
+
+class SaiError : public FbossError {
+public:
+  template<typename... Args>
+  explicit SaiError(Args&&... args)
+  : FbossError("SAI-agent: ", std::forward<Args>(args)...){
+  }
+
+  ~SaiError() throw() {}
+};
+
+class SaiFatal : public FbossError {
+public:
+  template<typename... Args>
+  explicit SaiFatal(Args&&... args)
+  : FbossError("SAI-agent: ", std::forward<Args>(args)...){
+  }
+
+  ~SaiFatal() throw() {}
+};
+
+}} // facebook::fboss

fboss/agent/hw/sai/SaiHost.cpp

@@ -0,0 +1,143 @@
+/*
+ * Copyright (c) 2004-present, Facebook, Inc.
+ * Copyright (c) 2016, Cavium, Inc.
+ * All rights reserved.
+ * 
+ * This source code is licensed under the BSD-style license found in the
+ * LICENSE file in the root directory of this source tree. An additional grant
+ * of patent rights can be found in the PATENTS file in the same directory.
+ * 
+ */
+#include "SaiHost.h"
+#include "SaiVrfTable.h"
+#include "SaiVrf.h"
+#include "SaiIntfTable.h"
+#include "SaiIntf.h"
+#include "SaiSwitch.h"
+#include "SaiError.h"
+
+using folly::IPAddress;
+using folly::MacAddress;
+
+namespace facebook { namespace fboss {
+
+SaiHost::SaiHost(const SaiSwitch *hw, InterfaceID intf,
+                 const IPAddress &ip, const folly::MacAddress &mac)
+  : hw_(hw)
+  , intf_(intf)
+  , ip_(ip)
+  , mac_(mac) {
+
+  VLOG(4) << "Entering " << __FUNCTION__;
+
+  saiNeighborApi_ = hw_->getSaiNeighborApi();
+}
+
+SaiHost::~SaiHost() {
+  VLOG(4) << "Entering " << __FUNCTION__;
+
+  if (!added_) {
+    return;
+  }
+
+  saiNeighborApi_->remove_neighbor_entry(&neighborEntry_);
+  VLOG(3) << "Deleted L3 host object for " << ip_;
+}
+
+void SaiHost::program(sai_packet_action_t action, const folly::MacAddress &mac) {
+  VLOG(4) << "Entering " << __FUNCTION__;
+
+  if (!added_) {
+
+    if (ip_.empty() || ip_.isZero()) {
+      throw SaiError("Wrong IP address ", ip_, " specified");
+    }
+
+    // fill neighborEntry_
+    neighborEntry_.rif_id = hw_->getIntfTable()->getIntf(intf_)->getIfId();
+
+    if (ip_.isV4()) {
+      // IPv4
+      neighborEntry_.ip_address.addr_family = SAI_IP_ADDR_FAMILY_IPV4;
+
+      memcpy(&neighborEntry_.ip_address.addr.ip4, ip_.bytes(),
+             sizeof(neighborEntry_.ip_address.addr.ip4));
+    } else {
+      // IPv6
+      neighborEntry_.ip_address.addr_family = SAI_IP_ADDR_FAMILY_IPV6;
+
+      memcpy(neighborEntry_.ip_address.addr.ip6, ip_.bytes(),
+             sizeof(neighborEntry_.ip_address.addr.ip6));
+    }
+
+    // fill neighbor attributes
+    std::vector<sai_attribute_t> attrList;
+    sai_attribute_t attr {0};
+
+    // MAC
+    attr.id = SAI_NEIGHBOR_ATTR_DST_MAC_ADDRESS;
+    memcpy(attr.value.mac, mac_.bytes(), sizeof(attr.value.mac));
+    attrList.push_back(attr);
+
+    // packet action
+    attr.id = SAI_NEIGHBOR_ATTR_PACKET_ACTION;
+    attr.value.u32 = action;
+    attrList.push_back(attr);
+
+    // create neighbor
+    sai_status_t saiRetVal = saiNeighborApi_->create_neighbor_entry(&neighborEntry_,
+                                                                     attrList.size(),
+                                                                     attrList.data());
+    if (saiRetVal != SAI_STATUS_SUCCESS) {
+       throw SaiError("Could not create SAI neighbor with IP addr: ", ip_,
+                       " MAC: ", mac_, " router interface ID: ", intf_,
+                       " Error: ", saiRetVal);
+    }
+
+    added_ = true;
+    action_ = action;
+
+    return;
+  }
+
+  if (mac != mac_) {
+    // fill neighbor MAC attribute
+    sai_attribute_t macAttr {0};
+    macAttr.id = SAI_NEIGHBOR_ATTR_DST_MAC_ADDRESS;
+    memcpy(macAttr.value.mac, mac.bytes(), sizeof(macAttr.value.mac));
+
+    // set action attribute
+    sai_status_t saiRetVal = saiNeighborApi_->set_neighbor_attribute(&neighborEntry_,
+                                                                      &macAttr);
+    if (saiRetVal != SAI_STATUS_SUCCESS) {
+      throw SaiError("Could not set MAC: ", mac,
+                     "to SAI neighbor with IP addr: ", ip_,
+                     " router interface ID: ", intf_,
+                     " Error: ", saiRetVal);
+    }
+
+    mac_ = mac;
+  }
+
+  if (action != action_) {
+
+    // fill neighbor packet action attribute
+    sai_attribute_t actionAttr {0};
+    actionAttr.id = SAI_NEIGHBOR_ATTR_PACKET_ACTION;
+    actionAttr.value.u32 = action;
+
+    // set action attribute
+    sai_status_t saiRetVal = saiNeighborApi_->set_neighbor_attribute(&neighborEntry_,
+                                                                      &actionAttr);
+    if (saiRetVal != SAI_STATUS_SUCCESS) {
+      throw SaiError("Could not set packet action attribute: ", action,
+                     " to SAI neighbor with IP addr: ", ip_,
+                     " MAC: ", mac_, " router interface ID: ", intf_,
+                     " Error: ", saiRetVal);
+    }
+
+    action_ = action;
+  }
+}
+
+}} // facebook::fboss

fboss/agent/hw/sai/SaiHost.h

@@ -0,0 +1,83 @@
+/*
+ * Copyright (c) 2004-present, Facebook, Inc.
+ * Copyright (c) 2016, Cavium, Inc.
+ * All rights reserved.
+ * 
+ * This source code is licensed under the BSD-style license found in the
+ * LICENSE file in the root directory of this source tree. An additional grant
+ * of patent rights can be found in the PATENTS file in the same directory.
+ * 
+ */
+#pragma once
+
+#include <folly/IPAddress.h>
+#include <folly/MacAddress.h>
+
+#include "fboss/agent/types.h"
+
+extern "C" {
+#include "saitypes.h"
+#include "saineighbor.h"
+#include "saiswitch.h"
+}
+
+namespace facebook { namespace fboss {
+
+class SaiSwitch;
+
+class SaiHost {
+public:
+  /**
+   * Constructs the SaiHost object.
+   *
+   * This method doesn't make any calls to the SAI to program host there.
+   * program() will be called soon after construction, and any
+   * actual initialization logic will be performed there.
+   */
+  SaiHost(const SaiSwitch *hw,
+          InterfaceID intf,
+          const folly::IPAddress &ip,
+          const folly::MacAddress &mac);
+  /**
+   * Destructs the SaiHost object.
+   *
+   * This method removes the host from the HW as well.
+   */
+  virtual ~SaiHost();
+
+  /**
+   * Gets Sai Host action. 
+   *  
+   * @return Host action of sai_packet_action_t type.
+   */
+  sai_packet_action_t getSaiAction() const {
+      return action_;
+  }
+
+  /**
+   * Programs host in HW and stores sai_neighbor_entry_t instance
+   * which holds SAI host data needed. 
+   *  
+   * If one of SAI HW calls fails it throws an exception; 
+   *  
+   * @return none
+   */
+  void program(sai_packet_action_t action, const folly::MacAddress &mac);
+
+private:
+  // no copy or assignment
+  SaiHost(SaiHost const &) = delete;
+  SaiHost &operator=(SaiHost const &) = delete;
+
+  const SaiSwitch *hw_;
+  const InterfaceID intf_;
+  const folly::IPAddress ip_;
+  folly::MacAddress mac_;
+  sai_packet_action_t action_ {SAI_PACKET_ACTION_DROP};
+  bool added_ {false}; // if added to the HW host table or not
+
+  sai_neighbor_entry_t neighborEntry_;
+  sai_neighbor_api_t *saiNeighborApi_ { nullptr };
+};
+
+}} // facebook::fboss