Update GoVPP and use pure Go client adapters by default (#1401)

* Update GoVPP and use pure Go client adapters by default

Signed-off-by: Ondrej Fabry <[email protected]>

* Update GoVPP with fix for duplicate objects

Signed-off-by: Ondrej Fabry <[email protected]>

Author: ondrej-fabry

Gopkg.lock

@@ -0,0 +1,48 @@
+//  Copyright (c) 2019 Cisco and/or its affiliates.
+//
+//  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.
+
+// +build !mockvpp,!vppapiclient
+
+package govppmux
+
+import (
+	"git.fd.io/govpp.git/adapter"
+	"git.fd.io/govpp.git/adapter/socketclient"
+	"git.fd.io/govpp.git/adapter/statsclient"
+	"github.com/ligato/cn-infra/logging"
+)
+
+// NewVppAdapter returns VPP binary API adapter, implemented as pure Go client.
+func NewVppAdapter(addr string, useShm bool) adapter.VppAPI {
+	if useShm {
+		logging.Warnf(`Using shared memory for VPP binary API is not currently supported in pure Go client!
+
+	To use socket client for VPP binary API:
+	  - unset GOVPPMUX_NOSOCK environment variable
+	  - remove these settings from govpp.conf config: shm-prefix, connect-via-shm
+
+	If you still want to use shared memory for VPP binary API (not recommended):
+	  - compile your agent with this build tag: vppapiclient
+`)
+		panic("No implementation for shared memory in pure Go client!")
+	}
+	// addr is used as socket path
+	return socketclient.NewVppClient(addr)
+
+}
+
+// NewStatsAdapter returns VPP stats API adapter, implemented as pure Go client.
+func NewStatsAdapter(socketName string) adapter.StatsAPI {
+	return statsclient.NewStatsClient(socketName)
+}

plugins/govppmux/adapter_puregoclient.go

@@ -21,12 +21,12 @@ import (
 	govppmock "git.fd.io/govpp.git/adapter/mock"
 )
 
-// NewVppAdapter returns mock adapter, used for building without vppapiclient library.
+// NewVppAdapter returns mock adapter for VPP binary API.
 func NewVppAdapter(shmPrefix string, useShm bool) adapter.VppAPI {
 	return govppmock.NewVppAdapter()
 }
 
-// NewStatsAdapter returns stats vpp api adapter, used for reading statistics with vppapiclient library.
+// NewStatsAdapter returns mock adapter for VPP stats API.
 func NewStatsAdapter(socketName string) adapter.StatsAPI {
 	return govppmock.NewStatsAdapter()
 }

plugins/govppmux/adapter_stubs.go

@@ -12,7 +12,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-// +build !mockvpp
+// +build !mockvpp,vppapiclient
 
 package govppmux
 
@@ -22,18 +22,17 @@ import (
 	"git.fd.io/govpp.git/adapter/vppapiclient"
 )
 
-// NewVppAdapter returns real vpp api adapter, used for building with vppapiclient library.
+// NewVppAdapter returns VPP binary API adapter, implemented as wrapper for vppapiclient library.
 func NewVppAdapter(addr string, useShm bool) adapter.VppAPI {
 	if useShm {
 		// addr is used as shm prefix
 		return vppapiclient.NewVppClient(addr)
 	}
 	// addr is used as socket path
 	return socketclient.NewVppClient(addr)
-
 }
 
-// NewStatsAdapter returns stats vpp api adapter, used for reading statistics with vppapiclient library.
+// NewStatsAdapter returns VPP stats API adapter, implemented as wrapper for vppapiclient library.
 func NewStatsAdapter(socketName string) adapter.StatsAPI {
 	return vppapiclient.NewStatClient(socketName)
 }

plugins/govppmux/adapter_vppapiclient.go

@@ -1,16 +1,16 @@
-// Copyright (c) 2018 Cisco and/or its affiliates.
+//  Copyright (c) 2019 Cisco and/or its affiliates.
 //
-// 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:
+//  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
+//      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.
+//  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 govppmux
 
@@ -26,6 +26,42 @@ import (
 	"github.com/ligato/cn-infra/logging/measure"
 )
 
+// NewAPIChannel returns a new API channel for communication with VPP via govpp core.
+// It uses default buffer sizes for the request and reply Go channels.
+//
+// Example of binary API call from some plugin using GOVPP:
+//      ch, _ := govpp_mux.NewAPIChannel()
+//      ch.SendRequest(req).ReceiveReply
+func (p *Plugin) NewAPIChannel() (govppapi.Channel, error) {
+	ch, err := p.vppConn.NewAPIChannel()
+	if err != nil {
+		return nil, err
+	}
+	retryCfg := retryConfig{
+		p.config.RetryRequestCount,
+		p.config.RetryRequestTimeout,
+	}
+	return newGovppChan(ch, retryCfg, p.tracer), nil
+}
+
+// NewAPIChannelBuffered returns a new API channel for communication with VPP via govpp core.
+// It allows to specify custom buffer sizes for the request and reply Go channels.
+//
+// Example of binary API call from some plugin using GOVPP:
+//      ch, _ := govpp_mux.NewAPIChannelBuffered(100, 100)
+//      ch.SendRequest(req).ReceiveReply
+func (p *Plugin) NewAPIChannelBuffered(reqChanBufSize, replyChanBufSize int) (govppapi.Channel, error) {
+	ch, err := p.vppConn.NewAPIChannelBuffered(reqChanBufSize, replyChanBufSize)
+	if err != nil {
+		return nil, err
+	}
+	retryCfg := retryConfig{
+		p.config.RetryRequestCount,
+		p.config.RetryRequestTimeout,
+	}
+	return newGovppChan(ch, retryCfg, p.tracer), nil
+}
+
 // goVppChan implements govpp channel interface. Instance is returned by NewAPIChannel() or NewAPIChannelBuffered(),
 // and contains *govpp.channel dynamic type (vppChan field). Implemented methods allow custom handling of low-level
 // govpp.

plugins/govppmux/govpp_channel.go renamed to plugins/govppmux/binapi_client.go

@@ -0,0 +1,68 @@
+//  Copyright (c) 2019 Cisco and/or its affiliates.
+//
+//  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 govppmux
+
+import "time"
+
+// Config groups the configurable parameter of GoVpp.
+type Config struct {
+	TraceEnabled             bool          `json:"trace-enabled"`
+	ReconnectResync          bool          `json:"resync-after-reconnect"`
+	HealthCheckProbeInterval time.Duration `json:"health-check-probe-interval"`
+	HealthCheckReplyTimeout  time.Duration `json:"health-check-reply-timeout"`
+	HealthCheckThreshold     int           `json:"health-check-threshold"`
+	ReplyTimeout             time.Duration `json:"reply-timeout"`
+	// Connect to VPP for configuration requests via the shared memory instead of through the socket.
+	ConnectViaShm bool `json:"connect-via-shm"`
+	// The prefix prepended to the name used for shared memory (SHM) segments. If not set,
+	// shared memory segments are created directly in the SHM directory /dev/shm.
+	ShmPrefix        string `json:"shm-prefix"`
+	BinAPISocketPath string `json:"binapi-socket-path"`
+	StatsSocketPath  string `json:"stats-socket-path"`
+	// How many times can be request resent in case vpp is suddenly disconnected.
+	RetryRequestCount int `json:"retry-request-count"`
+	// Time between request resend attempts. Default is 500ms.
+	RetryRequestTimeout time.Duration `json:"retry-request-timeout"`
+	// How many times can be connection request resent in case the vpp is not reachable.
+	RetryConnectCount int `json:"retry-connect-count"`
+	// Time between connection request resend attempts. Default is 1s.
+	RetryConnectTimeout time.Duration `json:"retry-connect-timeout"`
+}
+
+func defaultConfig() *Config {
+	return &Config{
+		HealthCheckProbeInterval: time.Second,
+		HealthCheckReplyTimeout:  250 * time.Millisecond,
+		HealthCheckThreshold:     1,
+		ReplyTimeout:             time.Second,
+		RetryRequestTimeout:      500 * time.Millisecond,
+		RetryConnectTimeout:      time.Second,
+	}
+}
+
+func (p *Plugin) loadConfig() (*Config, error) {
+	cfg := defaultConfig()
+
+	found, err := p.Cfg.LoadValue(cfg)
+	if err != nil {
+		return nil, err
+	} else if found {
+		p.Log.Debugf("config loaded from file %q", p.Cfg.GetConfigName())
+	} else {
+		p.Log.Debugf("config file %q not found, using default config", p.Cfg.GetConfigName())
+	}
+
+	return cfg, nil
+}