go.ligato.io/vpp-agent/v3@v3.5.0/plugins/vpp/aclplugin/vppcalls/vpp2106/interfaces_vppcalls.go

//  Copyright (c) 2021 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 vpp2106

import (
	"fmt"

	vpp_acl "go.ligato.io/vpp-agent/v3/plugins/vpp/binapi/vpp2106/acl"
	"go.ligato.io/vpp-agent/v3/plugins/vpp/binapi/vpp2106/interface_types"
)

// SetACLToInterfacesAsIngress implements ACL handler.
func (h *ACLVppHandler) SetACLToInterfacesAsIngress(ACLIndex uint32, ifIndices []uint32) error {
	return h.requestSetACLToInterfaces(&aclInterfaceLogicalReq{
		aclIndex:  ACLIndex,
		ifIndices: ifIndices,
		ingress:   true,
	})
}

// RemoveACLFromInterfacesAsIngress implements ACL handler.
func (h *ACLVppHandler) RemoveACLFromInterfacesAsIngress(ACLIndex uint32, ifIndices []uint32) error {
	return h.requestRemoveInterfacesFromACL(&aclInterfaceLogicalReq{
		aclIndex:  ACLIndex,
		ifIndices: ifIndices,
		ingress:   true,
	})
}

// SetACLToInterfacesAsEgress implements ACL handler.
func (h *ACLVppHandler) SetACLToInterfacesAsEgress(ACLIndex uint32, ifIndices []uint32) error {
	return h.requestSetACLToInterfaces(&aclInterfaceLogicalReq{
		aclIndex:  ACLIndex,
		ifIndices: ifIndices,
		ingress:   false,
	})
}

// RemoveACLFromInterfacesAsEgress implements ACL handler.
func (h *ACLVppHandler) RemoveACLFromInterfacesAsEgress(ACLIndex uint32, ifIndices []uint32) error {
	return h.requestRemoveInterfacesFromACL(&aclInterfaceLogicalReq{
		aclIndex:  ACLIndex,
		ifIndices: ifIndices,
		ingress:   false,
	})
}

// AddACLToInterfaceAsIngress implements ACL handler.
func (h *ACLVppHandler) AddACLToInterfaceAsIngress(aclIndex uint32, ifName string) error {
	meta, ok := h.ifIndexes.LookupByName(ifName)
	if !ok {
		return fmt.Errorf("metadata for interface %s not found", ifName)
	}
	ifIdx := meta.SwIfIndex

	req := &vpp_acl.ACLInterfaceAddDel{
		ACLIndex:  aclIndex,
		IsAdd:     true,
		SwIfIndex: interface_types.InterfaceIndex(ifIdx),
		IsInput:   true,
	}
	reply := &vpp_acl.ACLInterfaceAddDelReply{}

	err := h.callsChannel.SendRequest(req).ReceiveReply(reply)
	if err != nil {
		return fmt.Errorf("failed to add interface %d to ACL (L3/L4) %d as ingress: %v", ifIdx, aclIndex, err)
	}

	return nil
}

// AddACLToInterfaceAsEgress implements ACL handler.
func (h *ACLVppHandler) AddACLToInterfaceAsEgress(aclIndex uint32, ifName string) error {
	meta, ok := h.ifIndexes.LookupByName(ifName)
	if !ok {
		return fmt.Errorf("metadata for interface %s not found", ifName)
	}
	ifIdx := meta.SwIfIndex

	req := &vpp_acl.ACLInterfaceAddDel{
		ACLIndex:  aclIndex,
		IsAdd:     true,
		SwIfIndex: interface_types.InterfaceIndex(ifIdx),
		IsInput:   false,
	}
	reply := &vpp_acl.ACLInterfaceAddDelReply{}

	err := h.callsChannel.SendRequest(req).ReceiveReply(reply)
	if err != nil {
		return fmt.Errorf("failed to add interface %d to ACL (L3/L4) %d as egress: %v", ifIdx, aclIndex, err)
	}

	return nil
}

// DeleteACLFromInterfaceAsIngress implements ACL handler.
func (h *ACLVppHandler) DeleteACLFromInterfaceAsIngress(aclIndex uint32, ifName string) error {
	meta, ok := h.ifIndexes.LookupByName(ifName)
	if !ok {
		return fmt.Errorf("metadata for interface %s not found", ifName)
	}
	ifIdx := meta.SwIfIndex

	req := &vpp_acl.ACLInterfaceAddDel{
		ACLIndex:  aclIndex,
		IsAdd:     false,
		SwIfIndex: interface_types.InterfaceIndex(ifIdx),
		IsInput:   true,
	}
	reply := &vpp_acl.ACLInterfaceAddDelReply{}

	if err := h.callsChannel.SendRequest(req).ReceiveReply(reply); err != nil {
		return fmt.Errorf("failed to delete interface %d from ACL (L3/L4) %d as ingress: %v", ifIdx, aclIndex, err)
	}

	return nil
}

// DeleteACLFromInterfaceAsEgress implements ACL handler.
func (h *ACLVppHandler) DeleteACLFromInterfaceAsEgress(aclIndex uint32, ifName string) error {
	meta, ok := h.ifIndexes.LookupByName(ifName)
	if !ok {
		return fmt.Errorf("metadata for interface %s not found", ifName)
	}
	ifIdx := meta.SwIfIndex

	req := &vpp_acl.ACLInterfaceAddDel{
		ACLIndex:  aclIndex,
		IsAdd:     false,
		SwIfIndex: interface_types.InterfaceIndex(ifIdx),
		IsInput:   false,
	}
	reply := &vpp_acl.ACLInterfaceAddDelReply{}

	if err := h.callsChannel.SendRequest(req).ReceiveReply(reply); err != nil {
		return fmt.Errorf("failed to delete interface %d from ACL (L3/L4) %d as egress: %v", ifIdx, aclIndex, err)
	}

	return nil
}

// AddMACIPACLToInterface implements ACL handler.
func (h *ACLVppHandler) AddMACIPACLToInterface(aclIndex uint32, ifName string) error {
	meta, ok := h.ifIndexes.LookupByName(ifName)
	if !ok {
		return fmt.Errorf("metadata for interface %s not found", ifName)
	}
	ifIdx := meta.SwIfIndex

	req := &vpp_acl.MacipACLInterfaceAddDel{
		ACLIndex:  aclIndex,
		IsAdd:     true,
		SwIfIndex: interface_types.InterfaceIndex(ifIdx),
	}
	reply := &vpp_acl.MacipACLInterfaceAddDelReply{}

	err := h.callsChannel.SendRequest(req).ReceiveReply(reply)
	if err != nil {
		return fmt.Errorf("failed to add interface %d to MACIP ACL (L2) %d: %v", ifIdx, aclIndex, err)
	}

	return nil
}

// DeleteMACIPACLFromInterface implements ACL handler.
func (h *ACLVppHandler) DeleteMACIPACLFromInterface(aclIndex uint32, ifName string) error {
	meta, ok := h.ifIndexes.LookupByName(ifName)
	if !ok {
		return fmt.Errorf("metadata for interface %s not found", ifName)
	}
	ifIdx := meta.SwIfIndex

	req := &vpp_acl.MacipACLInterfaceAddDel{
		ACLIndex:  aclIndex,
		IsAdd:     false,
		SwIfIndex: interface_types.InterfaceIndex(ifIdx),
	}
	reply := &vpp_acl.MacipACLInterfaceAddDelReply{}

	err := h.callsChannel.SendRequest(req).ReceiveReply(reply)
	if err != nil {
		return fmt.Errorf("failed to delete interface %d from MACIP ACL (L2) %d: %v", ifIdx, aclIndex, err)
	}

	return nil
}

// SetMACIPACLToInterfaces implements ACL handler.
func (h *ACLVppHandler) SetMACIPACLToInterfaces(aclIndex uint32, ifIndices []uint32) error {
	for _, ifIdx := range ifIndices {
		req := &vpp_acl.MacipACLInterfaceAddDel{
			ACLIndex:  aclIndex,
			IsAdd:     true,
			SwIfIndex: interface_types.InterfaceIndex(ifIdx),
		}
		reply := &vpp_acl.MacipACLInterfaceAddDelReply{}

		err := h.callsChannel.SendRequest(req).ReceiveReply(reply)
		if err != nil {
			return fmt.Errorf("failed to set interface %d to L2 ACL %d: %v", ifIdx, aclIndex, err)
		}
	}

	return nil
}

// RemoveMACIPACLFromInterfaces implements ACL handler.
func (h *ACLVppHandler) RemoveMACIPACLFromInterfaces(removedACLIndex uint32, ifIndices []uint32) error {
	for _, ifIdx := range ifIndices {
		req := &vpp_acl.MacipACLInterfaceAddDel{
			ACLIndex:  removedACLIndex,
			SwIfIndex: interface_types.InterfaceIndex(ifIdx),
			IsAdd:     false,
		}
		reply := &vpp_acl.MacipACLInterfaceAddDelReply{}

		if err := h.callsChannel.SendRequest(req).ReceiveReply(reply); err != nil {
			return fmt.Errorf("failed to remove L2 ACL %d from interface %d: %v", removedACLIndex, ifIdx, err)
		}
	}
	return nil
}

// aclInterfaceLogicalReq groups multiple fields to not enumerate all of them in one function call
type aclInterfaceLogicalReq struct {
	aclIndex  uint32
	ifIndices []uint32
	ingress   bool
}

func (h *ACLVppHandler) requestSetACLToInterfaces(logicalReq *aclInterfaceLogicalReq) error {
	for _, aclIfIdx := range logicalReq.ifIndices {
		// Create acl list with new entry
		var ACLs []uint32

		// All previously assigned ACLs have to be dumped and added to acl list
		aclInterfaceDetails, err := h.DumpInterfaceACLList(aclIfIdx)
		if err != nil {
			return err
		}

		var nInput uint8
		if aclInterfaceDetails != nil {
			nInput = aclInterfaceDetails.NInput
			if logicalReq.ingress {
				// Construct ACL list. ACLs within NInput are defined as ingress, so provided new aclIndex has to be
				// added to the beginning of the list
				// TODO it would be nicer to add new acl index to newNInput index
				ACLs = append(ACLs, logicalReq.aclIndex)
				ACLs = append(ACLs, aclInterfaceDetails.Acls...)
				nInput++ // Rise NInput
			} else {
				// Construct ACL list. ACLs outside of NInput are defined as egress, so provided new aclIndex has to be
				// added to the end of the list
				ACLs = append(ACLs, aclInterfaceDetails.Acls...)
				ACLs = append(ACLs, logicalReq.aclIndex)
				// NInput remains the same
			}
		}

		msg := &vpp_acl.ACLInterfaceSetACLList{
			Acls:      ACLs,
			Count:     uint8(len(ACLs)),
			SwIfIndex: interface_types.InterfaceIndex(aclIfIdx),
			NInput:    nInput,
		}
		reply := &vpp_acl.ACLInterfaceSetACLListReply{}

		err = h.callsChannel.SendRequest(msg).ReceiveReply(reply)
		if err != nil {
			return err
		}
	}

	return nil
}

func (h *ACLVppHandler) requestRemoveInterfacesFromACL(logicalReq *aclInterfaceLogicalReq) error {
	var wasErr error
	for _, aclIfIdx := range logicalReq.ifIndices {
		// Create empty ACL list
		var ACLs []uint32

		// All assigned ACLs have to be dumped
		aclInterfaceDetails, err := h.DumpInterfaceACLList(aclIfIdx)
		if err != nil {
			return err
		}

		// Reconstruct ACL list without removed ACL
		var nInput uint8
		if aclInterfaceDetails != nil {
			nInput = aclInterfaceDetails.NInput
			for idx, aclIndex := range aclInterfaceDetails.Acls {
				if (aclIndex != logicalReq.aclIndex) ||
					(logicalReq.ingress && idx >= int(aclInterfaceDetails.NInput)) ||
					(!logicalReq.ingress && idx < int(aclInterfaceDetails.NInput)) {
					ACLs = append(ACLs, aclIndex)
				} else {
					// Decrease NInput if ingress, otherwise keep it the same
					if logicalReq.ingress {
						nInput--
					}
				}
			}
		}

		msg := &vpp_acl.ACLInterfaceSetACLList{
			Acls:      ACLs,
			Count:     uint8(len(ACLs)),
			SwIfIndex: interface_types.InterfaceIndex(aclIfIdx),
			NInput:    nInput,
		}

		reply := &vpp_acl.ACLInterfaceSetACLListReply{}
		err = h.callsChannel.SendRequest(msg).ReceiveReply(reply)
		if err != nil {
			wasErr = err
		}
	}

	return wasErr
}