ERSPAN support updates

tomflynn · tomflynn · commit 414d38a9de53 · 2020-05-05T15:45:25.000Z
Signed-off-by: Tom Flynn &lt;tom.flynn@gmail.com&gt;
Change-Id: Ie7629a6eb681d55864ad85074355f7dbd937c8a5
diff --git a/agent-ovs/lib/include/opflexagent/SpanSessionState.h b/agent-ovs/lib/include/opflexagent/SpanSessionState.h
@@ -112,7 +112,7 @@ class SessionState {
 
         /**
          * constructor that takes a URI that points to a Session object
-         * @param uri_ URI to a Session object
+         * @param uri_ URI of a Session object
          * @param name_ name of Session object
          */
         SessionState(const URI& uri_, const string& name_) :
@@ -196,6 +196,75 @@ class SessionState {
         // mapping DstSummary to dst IP
         address destination;
 };
+
+class ErspanParams {
+public:
+    /**
+     * Default constructor
+     */
+    ErspanParams() : ver(0) {}
+
+    /**
+     * Copy constructor
+     */
+    ErspanParams(const ErspanParams& copy) : ver(copy.ver), remoteIp(copy.remoteIp), portName(copy.portName) {}
+
+    /**
+     * Get the ERSPAN version
+     *
+     * @return 1 for Type II, 2 for Type III
+     */
+    unsigned int getVersion() const {
+        return ver;
+    }
+
+    /**
+     * Set the ERSPAN version
+     *
+     * @param version ERSPAN version
+     */
+    void setVersion(int version) {
+        ver = version;
+    }
+
+    /**
+     * Get the ERSPAN session dest IP
+     * @return dest IP
+     */
+    const string& getRemoteIp() const {
+        return remoteIp;
+    }
+
+    /**
+     * Set the ERSPAN session dest IP
+     * @param remoteIp_ ERSPAN session dest IP
+     */
+    void setRemoteIp(const string& remoteIp_) {
+        remoteIp = remoteIp_;
+    }
+
+    /**
+     * Get the ERSPAN port name
+     * @return ERSPAN port name
+     */
+    const string& getPortName() const {
+        return portName;
+    }
+
+    /**
+     * Set the ERSPAN port name
+     * @param portName_ ERSPAN port name
+     */
+    void setPortName(const string& portName_) {
+        portName = portName_;
+    }
+
+private:
+
+    unsigned int ver;
+    string remoteIp;
+    string portName;
+};
 }
 
 #endif // SPANSESSIONSTATE_H
diff --git a/agent-ovs/ovs/JsonRpc.cpp b/agent-ovs/ovs/JsonRpc.cpp
@@ -307,7 +307,7 @@ bool JsonRpc::getOvsdbMirrorConfig(mirror& mir) {
     return true;
 }
 
-bool JsonRpc::getCurrentErspanParams(const string& portName, erspan_ifc& params) {
+bool JsonRpc::getCurrentErspanParams(const string& portName, ErspanParams& params) {
     // for ERSPAN port get IP address
     JsonRpcTransactMessage msg1(OvsdbOperation::SELECT, OvsdbTable::INTERFACE);
     tuple<string, string, string> cond1("name", "==", portName);
@@ -395,7 +395,7 @@ bool JsonRpc::getPortList(const uint64_t reqId, const Document& payload, unorder
     }
 }
 
-bool JsonRpc::getErspanOptions(const uint64_t reqId, const Document& payload, erspan_ifc& pIfc) {
+bool JsonRpc::getErspanOptions(const uint64_t reqId, const Document& payload, ErspanParams& params) {
     if (!payload.IsArray()) {
         LOG(DEBUG) << "payload is not an array";
         return false;
@@ -407,45 +407,16 @@ bool JsonRpc::getErspanOptions(const uint64_t reqId, const Document& payload, er
         LOG(DEBUG) << "expected array";
         return false;
     }
-    map<string, string> options;
     for (Value::ConstValueIterator itr1 = arr.Begin(); itr1 != arr.End(); itr1++) {
-        LOG(DEBUG) << (*itr1)[0].GetString() << ":"
-                   << (*itr1)[1].GetString();
         string val((*itr1)[1].GetString());
         string index((*itr1)[0].GetString());
-        options.emplace(index, val);
-    }
-    auto ver = options.find("erspan_ver");
-    if (ver != options.end()) {
-        if (ver->second == "1") {
-            erspan_ifc_v1 params = erspan_ifc_v1();
-            if (options.find("erspan_idx") != options.end()) {
-                params.erspan_idx = stoi(options["erspan_idx"]);
-            }
-            pIfc = params;
-        } else if (ver->second == "2") {
-            erspan_ifc_v2 params = erspan_ifc_v2();
-            if (options.find("erspan_hwid") != options.end()) {
-                params.erspan_hw_id = stoi(options["erspan_hwid"]);
-            }
-            if (options.find("erspan_dir") != options.end()) {
-                params.erspan_dir = stoi(options["erspan_dir"]);
-            }
-            pIfc = params;
-        } else {
-            return false;
-        }
-        if (options.find("key") != options.end()) {
-            pIfc.key = stoi(options["key"]);
+        if (index == "erspan_ver") {
+            params.setVersion(stoi(val));
+        } else if (index == "remote_ip") {
+            params.setRemoteIp(val);
         }
-        pIfc.erspan_ver = stoi(ver->second);
-        if (options.find("remote_ip") != options.end()) {
-            pIfc.remote_ip = options["remote_ip"];
-        }
-        return true;
-    } else {
-        return false;
     }
+    return (params.getVersion() != 0);
 }
 
 void JsonRpc::getPortUuid(const string& name, string& uuid) {
@@ -578,10 +549,10 @@ bool JsonRpc::createMirror(const string& brUuid, const string& name, const set<s
     return handleCreateMirrorResp(pResp->reqId, pResp->payload);
 }
 
-bool JsonRpc::addErspanPort(const string& bridge, erspan_ifc& port) {
+bool JsonRpc::addErspanPort(const string& bridge, ErspanParams& params) {
     JsonRpcTransactMessage msg1(OvsdbOperation::INSERT, OvsdbTable::PORT);
     vector<TupleData> tuples;
-    tuples.emplace_back("", port.name);
+    tuples.emplace_back("", params.getPortName());
     TupleDataSet tdSet(tuples);
     msg1.rowData.emplace("name", tdSet);
 
@@ -603,7 +574,7 @@ bool JsonRpc::addErspanPort(const string& bridge, erspan_ifc& port) {
     // row entries
     // name
     tuples.clear();
-    tuples.emplace_back("", port.name);
+    tuples.emplace_back("", params.getPortName());
     tdSet = TupleDataSet(tuples);
     msg2.rowData.emplace("name", tdSet);
 
@@ -616,18 +587,8 @@ bool JsonRpc::addErspanPort(const string& bridge, erspan_ifc& port) {
 
     // options depend upon version
     tuples.clear();
-    tuples.emplace_back("erspan_ver", std::to_string(port.erspan_ver));
-    tuples.emplace_back("key", std::to_string(port.key));
-    tuples.emplace_back("remote_ip", port.remote_ip);
-    if (port.erspan_ver == 1) {
-        tuples.emplace_back("erspan_idx",
-                            std::to_string(static_cast<erspan_ifc_v1&>(port).erspan_idx));
-    } else if (port.erspan_ver == 2) {
-        tuples.emplace_back("erspan_hwid",
-                            std::to_string(static_cast<erspan_ifc_v2&>(port).erspan_hw_id));
-        tuples.emplace_back("erspan_dir",
-                            std::to_string(static_cast<erspan_ifc_v2&>(port).erspan_dir));
-    }
+    tuples.emplace_back("erspan_ver", std::to_string(params.getVersion()));
+    tuples.emplace_back("remote_ip", params.getRemoteIp());
     tdSet = TupleDataSet(tuples, "map");
     msg2.rowData.emplace("options", tdSet);
 
diff --git a/agent-ovs/ovs/SpanRenderer.cpp b/agent-ovs/ovs/SpanRenderer.cpp
@@ -183,15 +183,15 @@ namespace opflexagent {
         }
 
         // get ERSPAN interface params if configured
-        JsonRpc::erspan_ifc params;
+        ErspanParams params;
         if (!jRpc->getCurrentErspanParams(ERSPAN_PORT_PREFIX + seSt.get()->getName(), params)) {
             LOG(DEBUG) << "Unable to get ERSPAN parameters";
             return;
         }
         // check for change in config, push it if there is a change.
-        if (params.remote_ip != seSt.get()->getDestination().to_string() ||
-            params.erspan_ver != seSt.get()->getVersion()) {
-            LOG(INFO) << "Mirror config has changed";
+        if (params.getRemoteIp() != seSt.get()->getDestination().to_string() ||
+            params.getVersion() != seSt.get()->getVersion()) {
+            LOG(INFO) << "Mirror config has changed for " << seSt.get()->getName();
             updateMirrorConfig(seSt.get());
             return;
         }
@@ -232,30 +232,11 @@ namespace opflexagent {
 
     bool SpanRenderer::addErspanPort(const string& portName, const string &ipAddr, const uint8_t version) {
         LOG(DEBUG) << "adding erspan port " << portName << " IP " << ipAddr << " and version " << std::to_string(version);
-        JsonRpc::erspan_ifc ep;
-        if (version == 1) {
-            JsonRpc::erspan_ifc_v1 params = JsonRpc::erspan_ifc_v1();
-            // current OVS implementation supports only one ERSPAN port.
-            // use 1 as ersan_idx
-            params.erspan_idx = 1;
-            ep = params;
-        } else if (version == 2) {
-            JsonRpc::erspan_ifc_v2 params = JsonRpc::erspan_ifc_v2();
-            // current OVS implementation supports one ERSPAN port and mirror
-            // choose 1 for hw_id.
-            // dir can be set to 0 as it does not have an affect on the mirror traffic.
-            params.erspan_hw_id = 1;
-            params.erspan_dir = 0;
-            ep = params;
-        } else {
-            return false;
-        }
-        ep.name = portName;
-        ep.remote_ip = ipAddr;
-        // current OVS implementation supports only one ERPSAN port and mirror.
-        // choose 1 as the key.
-        ep.key = 1;
-        if (!jRpc->addErspanPort(switchName, ep)) {
+        ErspanParams params;
+        params.setVersion(version);
+        params.setPortName(portName);
+        params.setRemoteIp(ipAddr);
+        if (!jRpc->addErspanPort(switchName, params)) {
             LOG(DEBUG) << "add erspan port failed";
             return false;
         }
diff --git a/agent-ovs/ovs/include/JsonRpc.h b/agent-ovs/ovs/include/JsonRpc.h
@@ -25,6 +25,7 @@
 #include <thread>
 #include <rapidjson/document.h>
 #include "OvsdbConnection.h"
+#include <opflexagent/SpanSessionState.h>
 #include <opflexagent/logging.h>
 
 #include <boost/optional.hpp>
@@ -54,73 +55,7 @@ void getValue(const Document& val, const list<string>& idx, Value& result);
  */
 class JsonRpc : public Transaction {
 public:
-    /**
-     * base struct for ERSPAN interface parameters
-     */
-    typedef struct erspan_ifc_ {
-        /**
-         * ERSPAN version
-         */
-        int erspan_ver;
-        /**
-         * name of ERSPAN port
-         */
-        string name;
-        /**
-         * ERSPAN key
-         * maps to ERSPAN session ID/Span ID
-         */
-        int key;
-        /**
-         * destination IP address
-         */
-        string remote_ip;
-    } erspan_ifc;
 
-    /**
-     * ERSPAN type II struct
-     */
-    typedef struct erspan_ifc_v1_ : erspan_ifc {
-        /**
-         * constructor
-         * ERSPAN version 1 maps to ERSPAN type 2
-         */
-        erspan_ifc_v1_() {
-            erspan_ver = 1;
-            erspan_idx = 0;
-        }
-        /**
-         * ERSPAN index
-         * This field is a 20-bit index/port number associated with the ERSPAN traffic's
-         * source port and direction (ingress/egress). This field is platform dependent.
-         */
-        int erspan_idx;
-    } erspan_ifc_v1;
-
-    /**
-     * ERSPAN type III struct
-     */
-    typedef struct erspan_ifc_v2_ : erspan_ifc {
-        /**
-         * constructor
-         * ERSPAN version 2 maps to ERSPAN type 3.
-         */
-        erspan_ifc_v2_() {
-            erspan_ver = 2;
-            erspan_hw_id = 0;
-            erspan_dir = 0;
-        }
-        /**
-         * ERSPAN hardware ID
-         * A 6-bit unique identifier of an ERSPAN v2 engine within a system.
-         */
-        int erspan_hw_id;
-        /**
-         * ERSPAN direction
-         * the mirrored traffic's direction: 0 for ingress traffic, 1 for egress traffic.
-         */
-        int erspan_dir;
-    } erspan_ifc_v2;
 
     /**
      * struct for managing mirror data
@@ -250,10 +185,10 @@ class JsonRpc : public Transaction {
     /**
      * add an erspan port to the bridge
      * @param[in] bridgeName name of bridge to add the port to
-     * @param[in] port erspan_ifc struct
+     * @param[in] params ERSPAN params
      * @return true if success, false otherwise
      */
-    bool addErspanPort(const string& bridgeName, erspan_ifc& port);
+    bool addErspanPort(const string& bridgeName, ErspanParams& params);
 
     /**
      * createNetFlow
@@ -347,7 +282,7 @@ class JsonRpc : public Transaction {
      * @param[out] params erspan interface struct
      * @return true if success, false otherwise
      */
-    bool getCurrentErspanParams(const string& portName, erspan_ifc& params);
+    bool getCurrentErspanParams(const string& portName, ErspanParams& params);
 
     /**
      * check if connection has been established
@@ -384,10 +319,10 @@ class JsonRpc : public Transaction {
      * get ERSPAN interface options from Value struct
      * @param[in] reqId request ID
      * @param[in] payload response Value struct
-     * @param[out] pIfc empty shared pointer to ERSPAN
+     * @param[out] pararms ERSPAN session params
      * interface struct
      */
-    static bool getErspanOptions(const uint64_t reqId, const Document& payload, erspan_ifc& pIfc);
+    static bool getErspanOptions(const uint64_t reqId, const Document& payload, ErspanParams& params);
 
     template <typename T>
     inline bool sendRequestAndAwaitResponse(const list<T> &tl) {
diff --git a/agent-ovs/ovs/test/SpanRenderer_test.cpp b/agent-ovs/ovs/test/SpanRenderer_test.cpp
