From eaf1f7cc131ebee449e35bc1bd521d18130c48a4 Mon Sep 17 00:00:00 2001
From: Adam Harrison <harrisonadamw@gmail.com>
Date: Wed, 7 Oct 2015 17:43:31 +0100
Subject: [PATCH] Include overlay diagnostics in report JSON

---
 router/fastdp.go         | 72 ++++++++++++++++++++++++++++++++++++++++
 router/overlay.go        |  7 ++++
 router/overlay_switch.go |  8 +++++
 router/sleeve.go         |  4 +++
 router/status.go         |  4 ++-
 5 files changed, 94 insertions(+), 1 deletion(-)

diff --git a/router/fastdp.go b/router/fastdp.go
index e292c9f6..e3043370 100644
--- a/router/fastdp.go
+++ b/router/fastdp.go
@@ -2,6 +2,7 @@ package router
 
 import (
 	"encoding/binary"
+	"encoding/json"
 	"fmt"
 	"net"
 	"sync"
@@ -321,6 +322,77 @@ func (fastDatapathOverlay) AddFeaturesTo(features map[string]string) {
 	// OverlaySwitch.
 }
 
+type FlowStatus odp.FlowInfo
+
+func (flowStatus *FlowStatus) MarshalJSON() ([]byte, error) {
+	type jsonFlowStatus struct {
+		FlowKeys []string
+		Actions  []string
+		Packets  uint64
+		Bytes    uint64
+		Used     uint64
+	}
+
+	flowKeys := make([]string, 0, len(flowStatus.FlowKeys))
+	for _, flowKey := range flowStatus.FlowKeys {
+		if !flowKey.Ignored() {
+			flowKeys = append(flowKeys, fmt.Sprint(flowKey))
+		}
+	}
+
+	actions := make([]string, 0, len(flowStatus.Actions))
+	for _, action := range flowStatus.Actions {
+		actions = append(actions, fmt.Sprint(action))
+	}
+
+	return json.Marshal(&jsonFlowStatus{flowKeys, actions,
+		flowStatus.Packets, flowStatus.Bytes, flowStatus.Used})
+}
+
+type VportStatus odp.Vport
+
+func (vport *VportStatus) MarshalJSON() ([]byte, error) {
+	type jsonVportStatus struct {
+		ID       odp.VportID
+		Name     string
+		TypeName string
+	}
+
+	return json.Marshal(&jsonVportStatus{vport.ID, vport.Spec.Name(),
+		vport.Spec.TypeName()})
+}
+
+func (fastdp fastDatapathOverlay) Diagnostics() interface{} {
+	lock := fastdp.startLock()
+	defer lock.unlock()
+
+	vports, err := fastdp.dp.EnumerateVports()
+	if err != nil {
+		log.Warn(err)
+	}
+	vportStatuses := make([]VportStatus, 0, len(vports))
+	for _, vport := range vports {
+		vportStatuses = append(vportStatuses, VportStatus(vport))
+	}
+
+	flows, err := fastdp.dp.EnumerateFlows()
+	if err != nil {
+		log.Warn(err)
+	}
+	flowStatuses := make([]FlowStatus, 0, len(flows))
+	for _, flow := range flows {
+		flowStatuses = append(flowStatuses, FlowStatus(flow))
+	}
+
+	return struct {
+		Vports []VportStatus
+		Flows  []FlowStatus
+	}{
+		vportStatuses,
+		flowStatuses,
+	}
+}
+
 func (fastdp fastDatapathOverlay) StartConsumingPackets(localPeer *Peer,
 	peers *Peers, consumer OverlayConsumer) error {
 	fastdp.lock.Lock()
diff --git a/router/overlay.go b/router/overlay.go
index 85e23e42..168cb9f3 100644
--- a/router/overlay.go
+++ b/router/overlay.go
@@ -21,6 +21,9 @@ type Overlay interface {
 
 	// Enhance a features map with overlay-related features
 	AddFeaturesTo(map[string]string)
+
+	// Obtain diagnostic information specific to the overlay
+	Diagnostics() interface{}
 }
 
 type ForwarderParams struct {
@@ -136,3 +139,7 @@ func (NullOverlay) ControlMessage(byte, []byte) {
 func (NullOverlay) DisplayName() string {
 	return "null"
 }
+
+func (NullOverlay) Diagnostics() interface{} {
+	return nil
+}
diff --git a/router/overlay_switch.go b/router/overlay_switch.go
index 1022c5e3..2602d24b 100644
--- a/router/overlay_switch.go
+++ b/router/overlay_switch.go
@@ -35,6 +35,14 @@ func (osw *OverlaySwitch) AddFeaturesTo(features map[string]string) {
 	features["Overlays"] = strings.Join(osw.overlayNames, " ")
 }
 
+func (osw *OverlaySwitch) Diagnostics() interface{} {
+	diagnostics := make(map[string]interface{})
+	for name, overlay := range osw.overlays {
+		diagnostics[name] = overlay.Diagnostics()
+	}
+	return diagnostics
+}
+
 func (osw *OverlaySwitch) InvalidateRoutes() {
 	for _, overlay := range osw.overlays {
 		overlay.InvalidateRoutes()
diff --git a/router/sleeve.go b/router/sleeve.go
index e24956aa..374b34ef 100644
--- a/router/sleeve.go
+++ b/router/sleeve.go
@@ -133,6 +133,10 @@ func (*SleeveOverlay) AddFeaturesTo(map[string]string) {
 	// No features to be provided, to facilitate compatibility
 }
 
+func (*SleeveOverlay) Diagnostics() interface{} {
+	return nil
+}
+
 func (sleeve *SleeveOverlay) lookupForwarder(peer PeerName) *sleeveForwarder {
 	sleeve.lock.Lock()
 	defer sleeve.lock.Unlock()
diff --git a/router/status.go b/router/status.go
index f2e97c99..53d45cdc 100644
--- a/router/status.go
+++ b/router/status.go
@@ -22,6 +22,7 @@ type Status struct {
 	BroadcastRoutes    []BroadcastRouteStatus
 	Connections        []LocalConnectionStatus
 	Targets            []string
+	OverlayDiagnostics interface{}
 }
 
 type MACStatus struct {
@@ -80,7 +81,8 @@ func NewStatus(router *Router) *Status {
 		NewUnicastRouteStatusSlice(router.Routes),
 		NewBroadcastRouteStatusSlice(router.Routes),
 		NewLocalConnectionStatusSlice(router.ConnectionMaker),
-		NewTargetSlice(router.ConnectionMaker)}
+		NewTargetSlice(router.ConnectionMaker),
+		router.Overlay.Diagnostics()}
 }
 
 func NewMACStatusSlice(cache *MacCache) []MACStatus {