backends/tc/options.h

/*
 * Copyright (C) 2023 Intel Corporation
 * SPDX-FileCopyrightText: 2023 Intel Corporation
 *
 * SPDX-License-Identifier: Apache-2.0
 */
 
#ifndef BACKENDS_TC_OPTIONS_H_
#define BACKENDS_TC_OPTIONS_H_
 
#include <cstdlib>
#include <limits>
 
#include "backends/ebpf/ebpfOptions.h"
#include "frontends/common/options.h"
#include "lib/error.h"
 
namespace P4::TC {
 
class TCOptions : public CompilerOptions {
 public:
    // file to output to
    std::filesystem::path outputFolder;
    bool DebugOn = false;
    // tracing eBPF code execution
    bool emitTraceMessages = false;
    // XDP2TC mode for PSA-eBPF
    enum XDP2TC xdp2tcMode = XDP2TC_META;
    unsigned timerProfiles = 4;
 
    TCOptions() {
        registerOption(
            "-o", "output Directory",
            [this](const char *arg) {
                outputFolder = arg;
                return true;
            },
            "Write pipeline template, introspection json and C output to given directory");
        registerOption(
            "-g", nullptr,
            [this](const char *) {
                DebugOn = true;
                return true;
            },
            "Generates debug information");
        registerOption(
            "--trace", nullptr,
            [this](const char *) {
                emitTraceMessages = true;
                return true;
            },
            "Generate tracing messages of packet processing");
        registerOption(
            "--xdp2tc", "MODE",
            [this](const char *arg) {
                if (!strcmp(arg, "meta")) {
                    xdp2tcMode = XDP2TC_META;
                } else if (!strcmp(arg, "head")) {
                    xdp2tcMode = XDP2TC_HEAD;
                } else if (!strcmp(arg, "cpumap")) {
                    xdp2tcMode = XDP2TC_CPUMAP;
                } else {
                    ::P4::error(ErrorType::ERR_INVALID,
                                "Unknown --xdp2tc mode '%1%'; expected one of: meta, head, "
                                "cpumap",
                                arg);
                    return false;
                }
                return true;
            },
            "Select the mode used to pass metadata from XDP to TC "
            "(possible values: meta, head, cpumap).");
        registerOption(
            "--num-timer-profiles", "profiles",
            [this](const char *arg) {
                char *end = nullptr;
                long value = strtol(arg, &end, 0);
                if (*end != 0 || value <= 0 ||
                    static_cast<unsigned long>(value) >
                        static_cast<unsigned long>(std::numeric_limits<unsigned>::max())) {
                    ::P4::error(ErrorType::ERR_INVALID,
                                "--num-timer-profiles expects a positive integer, got '%1%'", arg);
                    return false;
                }
                timerProfiles = static_cast<unsigned>(value);
                return true;
            },
            "Defines the number of timer profiles. Default is 4.");
    }
};
 
using TCContext = P4CContextWithOptions<TCOptions>;
 
}  // namespace P4::TC
 
#endif /* BACKENDS_TC_OPTIONS_H_ */