Merge pull request #63 from andrewsykim/ofproto-trace-support

add initial support for ovs-appctl ofproto/trace

Author: andrewsykim

.travis.yml

@@ -1,6 +1,6 @@
 language: go
 go:
-  - 1.x
+  - 1.11
 os:
   - linux
 sudo: required
@@ -9,13 +9,11 @@ before_install:
   - sudo apt install openvswitch-switch
   - sudo ovs-vsctl add-br ovsbr0
   - go get github.com/golang/lint/golint
-  - go get honnef.co/go/tools/cmd/staticcheck
   - go get -d ./...
 script:
   - ./scripts/licensecheck.sh
   - go build -tags=gofuzz ./...
   - go vet ./...
-  - staticcheck ./...
   - ./scripts/gofmt.sh
   - ./scripts/golint.sh
   - go test -race ./...

ovs/action.go

@@ -26,10 +26,22 @@ var (
 	// errCTNoArguments is returned when no arguments are passed to ActionCT.
 	errCTNoArguments = errors.New("no arguments for connection tracking")
 
+	// errInvalidIPv6Label is returned when an input IPv6 label is out of
+	// range. It should only use the first 20 bits of the 32 bit field.
+	errInvalidIPv6Label = errors.New("IPv6 label must only use 20 bits")
+
+	// errInvalidARPOP is returned when an input ARP OP is out of
+	// range. It should be in the range 1-4.
+	errInvalidARPOP = errors.New("ARP OP must in the range 1-4")
+
 	// errInvalidVLANVID is returned when an input VLAN VID is out of range
 	// for a valid VLAN VID.
 	errInvalidVLANVID = errors.New("VLAN VID must be between 0 and 4095")
 
+	// errInvalidVLANVIDPCP is returned when an input VLAN PCP is out of range
+	// for a valid VLAN PCP.
+	errInvalidVLANPCP = errors.New("VLAN PCP must be between 0 and 7")
+
 	// errOutputNegativePort is returned when Output is called with a
 	// negative integer port.
 	errOutputNegativePort = errors.New("output port number must not be negative")
@@ -557,8 +569,26 @@ func (a *setTunnelAction) MarshalText() ([]byte, error) {
 	return bprintf("set_tunnel:%#x", a.tunnelID), nil
 }
 
+// validARPOP indicates if an ARP OP is out of range. It should be in the range
+// 1-4.
+func validARPOP(op uint16) bool {
+	return 1 <= op && op <= 4
+}
+
+// validIPv6Label indicates if an IPv6 label is out of range. It should only
+// use the first 20 bits of the 32 bit field.
+func validIPv6Label(label uint32) bool {
+	return (label & 0xfff00000) == 0x00000000
+}
+
 // validVLANVID indicates if a VLAN VID falls within the valid range
 // for a VLAN VID.
 func validVLANVID(vid int) bool {
 	return vid >= 0x000 && vid <= 0xfff
 }
+
+// validVLANVPCP indicates if a VLAN VID falls within the valid range
+// for a VLAN VID.
+func validVLANPCP(pcp int) bool {
+	return pcp >= 0 && pcp <= 7
+}

ovs/app.go

@@ -0,0 +1,58 @@
+// Copyright 2017 DigitalOcean.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//   http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+package ovs
+
+import (
+	"strings"
+)
+
+// AppService runs commands that are available from ovs-appctl
+type AppService struct {
+	c *Client
+}
+
+// ProtoTrace runs ovs-appctl ofproto/trace on the given bridge and match flow
+// and returns a *ProtoTrace. Also returns err if there is any error parsing the
+// output from ovs-appctl ofproto/trace.
+func (a *AppService) ProtoTrace(bridge string, matches []Match) (*ProtoTrace, error) {
+	matchFlows := []string{}
+	for _, match := range matches {
+		matchFlow, err := match.MarshalText()
+		if err != nil {
+			return nil, err
+		}
+
+		matchFlows = append(matchFlows, string(matchFlow))
+	}
+
+	matchArg := strings.Join(matchFlows, ",")
+	out, err := a.exec("ofproto/trace", bridge, matchArg)
+	if err != nil {
+		return nil, err
+	}
+
+	pt := &ProtoTrace{}
+	err = pt.UnmarshalText(out)
+	if err != nil {
+		return nil, err
+	}
+
+	return pt, nil
+}
+
+// exec executes 'ovs-appctl' + args passed in
+func (a *AppService) exec(args ...string) ([]byte, error) {
+	return a.c.exec("ovs-appctl", args...)
+}

ovs/client.go

@@ -30,6 +30,9 @@ type Client struct {
 	// OpenFlow wraps functionality of the 'ovs-ofctl' binary.
 	OpenFlow *OpenFlowService
 
+	// App wraps functionality of the 'ovs-appctl' binary
+	App *AppService
+
 	// VSwitch wraps functionality of the 'ovs-vsctl' binary.
 	VSwitch *VSwitchService
 
@@ -232,6 +235,11 @@ func New(options ...OptionFunc) *Client {
 	}
 	c.OpenFlow = ofs
 
+	app := &AppService{
+		c: c,
+	}
+	c.App = app
+
 	return c
 }