Add vl3 load balancer

go.mod

@@ -4,6 +4,7 @@ go 1.20
 
 require (
 	github.com/cilium/ebpf v0.10.0
+	github.com/edwarnicke/genericsync v0.0.0-20220910010113-61a344f9bc29
 	github.com/edwarnicke/serialize v1.0.7
 	github.com/golang/protobuf v1.5.3
 	github.com/google/uuid v1.3.0
@@ -32,7 +33,6 @@ require (
 	github.com/cenkalti/backoff/v4 v4.2.1 // indirect
 	github.com/davecgh/go-spew v1.1.1 // indirect
 	github.com/edwarnicke/exechelper v1.0.2 // indirect
-	github.com/edwarnicke/genericsync v0.0.0-20220910010113-61a344f9bc29 // indirect
 	github.com/edwarnicke/grpcfd v1.1.2 // indirect
 	github.com/fsnotify/fsnotify v1.5.4 // indirect
 	github.com/ftrvxmtrx/fd v0.0.0-20150925145434-c6d800382fff // indirect

pkg/tools/vl3lb/common.go

@@ -0,0 +1,202 @@
+// Copyright (c) 2023 Cisco and/or its affiliates.
+//
+// SPDX-License-Identifier: Apache-2.0
+//
+// 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 vl3lb
+
+import (
+	"context"
+	"fmt"
+	"net"
+	"time"
+
+	"github.com/edwarnicke/genericsync"
+	"go.fd.io/govpp/api"
+
+	"github.com/networkservicemesh/govpp/binapi/cnat"
+	"github.com/networkservicemesh/govpp/binapi/interface_types"
+	"github.com/networkservicemesh/govpp/binapi/ip_types"
+
+	"github.com/networkservicemesh/sdk-vpp/pkg/tools/types"
+
+	"github.com/networkservicemesh/sdk/pkg/tools/log"
+)
+
+// Endpoint contains the main fields for the VPP plugin
+type Endpoint struct {
+	IP   net.IP
+	Port uint16
+}
+
+// Equals returns true if Endpoints are equal
+func (e *Endpoint) Equals(endpoint *Endpoint) bool {
+	return e.IP.Equal(endpoint.IP) && e.Port == endpoint.Port
+}
+
+// Handler works with load balancer servers. It is based on CNAT VPP-plugin
+type Handler struct {
+	vppConn    api.Connection
+	lbEndpoint cnat.CnatEndpoint
+	proto      ip_types.IPProto
+	isRealIP   uint8
+	lbType     cnat.CnatLbType
+
+	// [vl3-NSE] --> [connID]*Endpoint
+	// We store it this way because the plugin does not add, but only updates existing entries. Therefore, to add/delete one entry, we must also pass the old ones.
+	servers genericsync.Map[string, *genericsync.Map[string, *Endpoint]]
+}
+
+// NewHandler creates a Handler.
+// endpoint contains Load Balancer parameters. The clients can reach the LB with endpoint.Addr:endpoint:Port
+func NewHandler(vppConn api.Connection, endpoint *Endpoint, proto ip_types.IPProto) *Handler {
+	return &Handler{
+		vppConn: vppConn,
+		lbEndpoint: cnat.CnatEndpoint{
+			Addr:      types.ToVppAddress(endpoint.IP),
+			SwIfIndex: interface_types.InterfaceIndex(^uint32(0)),
+			Port:      endpoint.Port,
+		},
+		proto:    proto,
+		isRealIP: 1,
+		lbType:   cnat.CNAT_LB_TYPE_MAGLEV,
+	}
+}
+
+func cnatTranslationString(c *cnat.CnatTranslation) string {
+	str := fmt.Sprintf("%s:%d", c.Vip.Addr.String(), c.Vip.Port)
+	for _, p := range c.Paths {
+		str = fmt.Sprintf("%s to %s -> %s:%d, ", str, p.SrcEp.Addr, p.DstEp.Addr, p.DstEp.Port)
+	}
+	return str
+}
+
+// AddServers adds the real servers to the VPP plugin
+func (c *Handler) AddServers(ctx context.Context, vl3NSEName string, add map[string]*Endpoint) (err error) {
+	updateRequired := false
+	realServers, _ := c.servers.LoadOrStore(vl3NSEName, new(genericsync.Map[string, *Endpoint]))
+	for k, v := range add {
+		if endpoint, ok := realServers.Load(k); !ok || !endpoint.Equals(v) {
+			realServers.Store(k, v)
+			updateRequired = true
+		}
+	}
+
+	if updateRequired {
+		err = c.updateVPPCnat(ctx)
+	}
+
+	return err
+}
+
+// DeleteServers deletes the real servers from the VPP plugin
+func (c *Handler) DeleteServers(ctx context.Context, vl3NSEName string, del []string) (err error) {
+	realServers, ok := c.servers.Load(vl3NSEName)
+	if !ok {
+		return nil
+	}
+
+	updateRequired := false
+	for _, id := range del {
+		realServers.Delete(id)
+		updateRequired = true
+	}
+
+	if updateRequired {
+		var length int
+		realServers.Range(func(key string, value *Endpoint) bool {
+			length++
+			return true
+		})
+
+		if length == 0 {
+			log.FromContext(ctx).WithField("vl3Loadbalancer", "DeleteServers").Infof("Delete VL3NSE: %s ", vl3NSEName)
+			c.servers.Delete(vl3NSEName)
+		}
+
+		err = c.updateVPPCnat(ctx)
+	}
+
+	return err
+}
+
+// GetServerIDsByVL3Name returns the list of the servers belonging to the vl3-NSE
+func (c *Handler) GetServerIDsByVL3Name(vl3NSEName string) []string {
+	var list []string
+	realServers, loaded := c.servers.Load(vl3NSEName)
+	if loaded {
+		realServers.Range(func(key string, value *Endpoint) bool {
+			list = append(list, key)
+			return true
+		})
+	}
+	return list
+}
+
+func (c *Handler) updateVPPCnat(ctx context.Context) error {
+	var paths []cnat.CnatEndpointTuple
+	c.servers.Range(func(key string, realServers *genericsync.Map[string, *Endpoint]) bool {
+		realServers.Range(func(key string, s *Endpoint) bool {
+			paths = append(paths, cnat.CnatEndpointTuple{
+				DstEp: cnat.CnatEndpoint{
+					Addr:      types.ToVppAddress(s.IP),
+					SwIfIndex: interface_types.InterfaceIndex(^uint32(0)),
+					Port:      s.Port,
+				},
+				SrcEp: cnat.CnatEndpoint{
+					Addr:      c.lbEndpoint.Addr,
+					SwIfIndex: interface_types.InterfaceIndex(^uint32(0)),
+				},
+			})
+			return true
+		})
+		return true
+	})
+
+	if len(paths) == 0 {
+		now := time.Now()
+		cnatTranslationDel := cnat.CnatTranslationDel{ID: 0}
+		_, err := cnat.NewServiceClient(c.vppConn).CnatTranslationDel(ctx, &cnatTranslationDel)
+		if err != nil {
+			return err
+		}
+
+		log.FromContext(ctx).
+			WithField("translationID", cnatTranslationDel.ID).
+			WithField("duration", time.Since(now)).
+			WithField("vppapi", "CnatTranslationDel").Debug("completed")
+		return nil
+	}
+
+	now := time.Now()
+	cnatTranslation := cnat.CnatTranslation{
+		Vip:      c.lbEndpoint,
+		ID:       0,
+		IPProto:  c.proto,
+		IsRealIP: c.isRealIP,
+		LbType:   c.lbType,
+		NPaths:   uint32(len(paths)),
+		Paths:    paths,
+	}
+	_, err := cnat.NewServiceClient(c.vppConn).CnatTranslationUpdate(ctx, &cnat.CnatTranslationUpdate{Translation: cnatTranslation})
+	if err != nil {
+		return err
+	}
+
+	log.FromContext(ctx).
+		WithField("translation", cnatTranslationString(&cnatTranslation)).
+		WithField("duration", time.Since(now)).
+		WithField("vppapi", "CnatTranslationUpdate").Debug("completed")
+	return nil
+}

pkg/tools/vl3lb/doc.go

@@ -0,0 +1,18 @@
+// Copyright (c) 2023 Cisco and/or its affiliates.
+//
+// SPDX-License-Identifier: Apache-2.0
+//
+// 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 vl3lb provides utilities for load balancing
+package vl3lb