ziti/controller/model/circuit_manager.go

/*
	Copyright NetFoundry Inc.

	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

	https://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 model

import (
	"sync/atomic"
	"time"

	"github.com/openziti/identity"
	"github.com/openziti/ziti/v2/controller/storage/boltz"
	"github.com/openziti/ziti/v2/controller/storage/objectz"
	"github.com/openziti/ziti/v2/common/datastructures"
	"github.com/openziti/ziti/v2/common/logcontext"
	"github.com/openziti/ziti/v2/controller/models"
	"github.com/openziti/ziti/v2/controller/xt"
	"github.com/orcaman/concurrent-map/v2"
)

type Circuit struct {
	Id         string
	ClientId   string
	ServiceId  string
	Terminator xt.CostedTerminator
	Path       *Path
	Tags       map[string]string
	Rerouting  atomic.Bool
	PeerData   xt.PeerData
	CreatedAt  time.Time
	UpdatedAt  time.Time
}

func (self *Circuit) GetId() string {
	return self.Id
}

func (self *Circuit) SetId(string) {
	// id cannot be updated
}

func (self *Circuit) GetCreatedAt() time.Time {
	return self.CreatedAt
}

func (self *Circuit) GetUpdatedAt() time.Time {
	return self.UpdatedAt
}

func (self *Circuit) GetTags() map[string]interface{} {
	result := map[string]interface{}{}
	for k, v := range self.Tags {
		result[k] = v
	}
	return result
}

func (self *Circuit) IsSystemEntity() bool {
	return false
}

func (self *Circuit) HasRouter(routerId string) bool {
	if self == nil || self.Path == nil {
		return false
	}
	for _, node := range self.Path.Nodes {
		if node.Id == routerId {
			return true
		}
	}
	return false
}

func (self *Circuit) IsEndpointRouter(routerId string) bool {
	if self == nil || self.Path == nil || len(self.Path.Nodes) == 0 {
		return false
	}
	return self.Path.Nodes[0].Id == routerId || self.Path.Nodes[len(self.Path.Nodes)-1].Id == routerId
}

type CircuitManager struct {
	models.BaseObjectStoreManager[*Circuit]
	circuits cmap.ConcurrentMap[string, *Circuit]
}

func NewCircuitManager() *CircuitManager {
	result := &CircuitManager{
		circuits:               cmap.New[*Circuit](),
		BaseObjectStoreManager: models.BaseObjectStoreManager[*Circuit]{},
	}
	result.InitStore(objectz.NewObjectStore[*Circuit](func() objectz.ObjectIterator[*Circuit] {
		return datastructures.IterateCMap(result.circuits)
	}))

	result.GetStore().AddStringSymbol("id", func(entity *Circuit) *string {
		return &entity.Id
	})
	result.GetStore().AddStringSymbol("clientId", func(entity *Circuit) *string {
		return &entity.ClientId
	})
	result.GetStore().AddStringSymbol("service", func(entity *Circuit) *string {
		return &entity.ServiceId
	})
	result.GetStore().AddStringSymbol("terminator", func(entity *Circuit) *string {
		val := entity.Terminator.GetId()
		return &val
	})
	result.GetStore().AddDatetimeSymbol("createdAt", func(entity *Circuit) *time.Time {
		return &entity.CreatedAt
	})
	result.GetStore().AddDatetimeSymbol("updatedAt", func(entity *Circuit) *time.Time {
		return &entity.CreatedAt
	})
	return result
}

func (self *CircuitManager) Add(circuit *Circuit) {
	self.circuits.Set(circuit.Id, circuit)
}

// Reserve atomically claims a circuit ID in the map with a stub circuit. Returns false
// if the ID is already in use. The caller must call Add to finalize or Remove to release.
func (self *CircuitManager) Reserve(circuit *Circuit) bool {
	return self.circuits.SetIfAbsent(circuit.Id, circuit)
}

func (self *CircuitManager) Get(id string) (*Circuit, bool) {
	if circuit, found := self.circuits.Get(id); found {
		return circuit, true
	}
	return nil, false
}

func (self *CircuitManager) BaseLoad(id string) (*Circuit, error) {
	entity, found := self.Get(id)
	if !found {
		return nil, boltz.NewNotFoundError("circuit", "id", id)
	}
	return entity, nil
}

func (self *CircuitManager) All() []*Circuit {
	var circuits []*Circuit
	self.circuits.IterCb(func(_ string, circuit *Circuit) {
		circuits = append(circuits, circuit)
	})
	return circuits
}

func (self *CircuitManager) Remove(circuit *Circuit) {
	self.circuits.Remove(circuit.Id)
}

type CreateCircuitParams interface {
	GetServiceId() string
	GetSourceRouter() *Router
	GetClientId() *identity.TokenId
	GetCircuitTags(terminator xt.CostedTerminator) map[string]string
	GetLogContext() logcontext.Context
	GetDeadline() time.Time
	// GetCircuitId returns a pre-assigned circuit ID, or empty string to have one generated.
	GetCircuitId() string
}