ebpfPsaTableImplementation.h

/*
Copyright 2022-present Orange
Copyright 2022-present Open Networking Foundation
 
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.
*/
 
#ifndef BACKENDS_EBPF_PSA_EXTERNS_EBPFPSATABLEIMPLEMENTATION_H_
#define BACKENDS_EBPF_PSA_EXTERNS_EBPFPSATABLEIMPLEMENTATION_H_
 
#include "backends/ebpf/ebpfTable.h"
#include "backends/ebpf/psa/ebpfPsaTable.h"
#include "backends/ebpf/psa/externs/ebpfPsaHashAlgorithm.h"
 
namespace EBPF {
 
// Base class for ActionProfile and ActionSelector
class EBPFTableImplementationPSA : public EBPFTablePSA {
 public:
    EBPFTableImplementationPSA(const EBPFProgram *program, CodeGenInspector *codeGen,
                               const IR::Declaration_Instance *decl);
 
    void emitTypes(CodeBuilder *builder) override;
    void emitInitializer(CodeBuilder *builder) override;
    virtual void emitReferenceEntry(CodeBuilder *builder);
 
    virtual void registerTable(const EBPFTablePSA *instance);
 
    virtual void applyImplementation(CodeBuilder *builder, cstring tableValueName,
                                     cstring actionRunVariable) = 0;
 
 protected:
    const IR::Declaration_Instance *declaration;
    cstring referenceName;
 
    void verifyTableActionList(const EBPFTablePSA *instance);
    void verifyTableNoDefaultAction(const EBPFTablePSA *instance);
    void verifyTableNoDirectObjects(const EBPFTablePSA *instance);
    void verifyTableNoEntries(const EBPFTablePSA *instance);
 
    unsigned getUintFromExpression(const IR::Expression *expr, unsigned defaultValue);
 
    DECLARE_TYPEINFO(EBPFTableImplementationPSA, EBPFTablePSA);
};
 
class EBPFActionProfilePSA : public EBPFTableImplementationPSA {
 public:
    EBPFActionProfilePSA(const EBPFProgram *program, CodeGenInspector *codeGen,
                         const IR::Declaration_Instance *decl);
 
    void emitInstance(CodeBuilder *builder) override;
    void applyImplementation(CodeBuilder *builder, cstring tableValueName,
                             cstring actionRunVariable) override;
 
    DECLARE_TYPEINFO(EBPFActionProfilePSA, EBPFTableImplementationPSA);
};
 
class EBPFActionSelectorPSA : public EBPFTableImplementationPSA {
 public:
    EBPFActionSelectorPSA(const EBPFProgram *program, CodeGenInspector *codeGen,
                          const IR::Declaration_Instance *decl);
 
    void emitInitializer(CodeBuilder *builder) override;
    void emitInstance(CodeBuilder *builder) override;
    void emitReferenceEntry(CodeBuilder *builder) override;
 
    void applyImplementation(CodeBuilder *builder, cstring tableValueName,
                             cstring actionRunVariable) override;
 
    void registerTable(const EBPFTablePSA *instance) override;
 
    void emitCacheTypes(CodeBuilder *builder) override;
    void emitCacheVariables(CodeBuilder *builder);
    void emitCacheLookup(CodeBuilder *builder, cstring key, cstring value) override;
    void emitCacheUpdate(CodeBuilder *builder, cstring key, cstring value) override;
 
 protected:
    typedef std::vector<const IR::KeyElement *> SelectorsListType;
 
    const IR::Property *emptyGroupAction;
    EBPFHashAlgorithmPSA *hashEngine;
    SelectorsListType selectors;
    cstring actionsMapName;
    cstring groupsMapName;
    cstring emptyGroupActionMapName;
    size_t groupsMapSize;
    cstring outputHashMask;
    cstring isGroupEntryName;
    cstring groupStateVarName;
    cstring cacheKeyVar;
    cstring cacheDoUpdateVar;
 
    EBPFHashAlgorithmPSA::ArgumentsList unpackSelectors();
    SelectorsListType getSelectorsFromTable(const EBPFTablePSA *instance);
 
    void verifyTableSelectorKeySet(const EBPFTablePSA *instance);
    void verifyTableEmptyGroupAction(const EBPFTablePSA *instance);
 
    DECLARE_TYPEINFO(EBPFActionSelectorPSA, EBPFTableImplementationPSA);
};
 
}  // namespace EBPF
 
#endif  // BACKENDS_EBPF_PSA_EXTERNS_EBPFPSATABLEIMPLEMENTATION_H_