trace_event_types.h

/*
 * SPDX-FileCopyrightText: 2023 The P4 Language Consortium
 *
 * SPDX-License-Identifier: Apache-2.0
 */
 
#ifndef BACKENDS_P4TOOLS_COMMON_LIB_TRACE_EVENT_TYPES_H_
#define BACKENDS_P4TOOLS_COMMON_LIB_TRACE_EVENT_TYPES_H_
 
#include <iosfwd>
#include <utility>
#include <vector>
 
#include "backends/p4tools/common/lib/model.h"
#include "backends/p4tools/common/lib/symbolic_env.h"
#include "backends/p4tools/common/lib/trace_event.h"
#include "ir/ir.h"
#include "ir/visitor.h"
#include "lib/cstring.h"

namespace P4::P4Tools::TraceEvents {
 
/* =============================================================================================
 *   Generic
 * ============================================================================================= */

class Generic : public TraceEvent {
 protected:
    // A label that specifies the type of this generic trace event.
    cstring label;
 
    void print(std::ostream &os) const override;
 
 public:
    explicit Generic(cstring label);
    ~Generic() override = default;
    Generic(const Generic &) = default;
    Generic(Generic &&) = default;
    Generic &operator=(const Generic &) = default;
    Generic &operator=(Generic &&) = default;
 
    DECLARE_TYPEINFO(Generic, TraceEvent);
};
 
/* =============================================================================================
 *   GenericDescription
 * ============================================================================================= */

class GenericDescription : public Generic {
 protected:
    cstring description;
 
    void print(std::ostream &os) const override;
 
 public:
    explicit GenericDescription(cstring label, cstring description);
 
    DECLARE_TYPEINFO(GenericDescription, Generic);
};
 
/* =============================================================================================
 *   Expression
 * ============================================================================================= */

class Expression : public Generic {
 private:
    const IR::Expression *value;
 
 public:
    [[nodiscard]] const Expression *subst(const SymbolicEnv &env) const override;
    const Expression *apply(Transform &visitor) const override;
    [[nodiscard]] const Expression *evaluate(const Model &model, bool doComplete) const override;
 
    explicit Expression(const IR::Expression *value, cstring label);
    ~Expression() override = default;
    Expression(const Expression &) = default;
    Expression(Expression &&) = default;
    Expression &operator=(const Expression &) = default;
    Expression &operator=(Expression &&) = default;
 
 protected:
    void print(std::ostream &os) const override;
 
    DECLARE_TYPEINFO(Expression, Generic);
};
 
/* =============================================================================================
 *   MethodCallExpression
 * ============================================================================================= */

class MethodCall : public TraceEvent {
 private:
    const IR::MethodCallExpression *call;
 
 public:
    explicit MethodCall(const IR::MethodCallExpression *call);
    ~MethodCall() override = default;
    MethodCall(const MethodCall &) = default;
    MethodCall(MethodCall &&) = default;
    MethodCall &operator=(const MethodCall &) = default;
    MethodCall &operator=(MethodCall &&) = default;
 
 protected:
    void print(std::ostream &os) const override;
 
    DECLARE_TYPEINFO(MethodCall, TraceEvent);
};
 
/* =============================================================================================
 *   IfStatementCondition
 * ============================================================================================= */

class IfStatementCondition : public TraceEvent {
 private:
    const IR::Expression *preEvalCond = nullptr;
    const IR::Expression *postEvalCond;
 
    void setPreEvalCond(const IR::Expression *cond);
 
 public:
    [[nodiscard]] const IfStatementCondition *subst(const SymbolicEnv &env) const override;
    const IfStatementCondition *apply(Transform &visitor) const override;
    [[nodiscard]] const IfStatementCondition *evaluate(const Model &model,
                                                       bool doComplete) const override;
 
    explicit IfStatementCondition(const IR::Expression *cond);
 
 protected:
    void print(std::ostream &os) const override;
 
    DECLARE_TYPEINFO(IfStatementCondition, TraceEvent);
};
 
/* =============================================================================================
 *   AssignmentStatement
 * ============================================================================================= */

class AssignmentStatement : public TraceEvent {
 private:
    const IR::AssignmentStatement &stmt;
 
 public:
    [[nodiscard]] const AssignmentStatement *subst(const SymbolicEnv &env) const override;
    const AssignmentStatement *apply(Transform &visitor) const override;
    [[nodiscard]] const AssignmentStatement *evaluate(const Model &model,
                                                      bool doComplete) const override;
 
    explicit AssignmentStatement(const IR::AssignmentStatement &stmt);
 
 protected:
    void print(std::ostream &os) const override;
 
    DECLARE_TYPEINFO(AssignmentStatement, TraceEvent);
};
 
/* =============================================================================================
 *   ExtractSuccess
 * ============================================================================================= */

class ExtractSuccess : public TraceEvent {
 private:
    const IR::Expression *extractedHeader;

    int offset;

    const IR::Expression *condition;

    std::vector<std::pair<IR::StateVariable, const IR::Expression *>> fields;
 
 public:
    [[nodiscard]] const ExtractSuccess *subst(const SymbolicEnv &env) const override;
    const ExtractSuccess *apply(Transform &visitor) const override;
    [[nodiscard]] const ExtractSuccess *evaluate(const Model &model,
                                                 bool doComplete) const override;

    [[nodiscard]] const IR::Expression *getExtractedHeader() const;

    [[nodiscard]] int getOffset() const;

    [[nodiscard]] const std::vector<std::pair<IR::StateVariable, const IR::Expression *>> &
    getFields() const;
 
    ExtractSuccess(const IR::Expression *extractedHeader, int offset,
                   const IR::Expression *condition,
                   std::vector<std::pair<IR::StateVariable, const IR::Expression *>> fields);
    ExtractSuccess(const ExtractSuccess &) = default;
    ExtractSuccess(ExtractSuccess &&) = default;
    ExtractSuccess &operator=(const ExtractSuccess &) = default;
    ExtractSuccess &operator=(ExtractSuccess &&) = default;
    ~ExtractSuccess() override = default;
 
 protected:
    void print(std::ostream &os) const override;
 
    DECLARE_TYPEINFO(ExtractSuccess, TraceEvent);
};
 
/* =============================================================================================
 *   ExtractFailure
 * ============================================================================================= */

class ExtractFailure : public TraceEvent {
 private:
    const IR::Expression *extractedHeader;

    int offset;

    const IR::Expression *condition;
 
 public:
    ExtractFailure(const IR::Expression *extractedHeader, int offset,
                   const IR::Expression *condition);
 
    ExtractFailure(const ExtractFailure &) = default;
    ExtractFailure(ExtractFailure &&) = default;
    ExtractFailure &operator=(const ExtractFailure &) = default;
    ExtractFailure &operator=(ExtractFailure &&) = default;
    ~ExtractFailure() override = default;
 
 protected:
    void print(std::ostream &os) const override;
 
    DECLARE_TYPEINFO(ExtractFailure, TraceEvent);
};
 
/* =============================================================================================
 *   Emit
 * ============================================================================================= */

class Emit : public TraceEvent {
 private:
    const IR::HeaderExpression *emitHeader;
 
 public:
    [[nodiscard]] const Emit *subst(const SymbolicEnv &env) const override;
    const Emit *apply(Transform &visitor) const override;
    [[nodiscard]] const Emit *evaluate(const Model &model, bool doComplete) const override;
 
    explicit Emit(const IR::HeaderExpression *emitHeader);
    ~Emit() override = default;
    Emit(const Emit &) = default;
    Emit(Emit &&) = default;
    Emit &operator=(const Emit &) = default;
    Emit &operator=(Emit &&) = default;
 
 protected:
    void print(std::ostream &os) const override;
 
    DECLARE_TYPEINFO(Emit, TraceEvent);
};
 
/* =============================================================================================
 *   Packet
 * ============================================================================================= */

class Packet : public TraceEvent {
 public:
    enum class Direction {
        In,

        Out,
    };
 
    const Packet *apply(Transform &visitor) const override;
 
    [[nodiscard]] const Packet *evaluate(const Model &model, bool doComplete) const override;
 
    [[nodiscard]] const Packet *subst(const SymbolicEnv &env) const override;
 
    Packet(const Direction &direction, const IR::Expression *packetValue);
    ~Packet() override = default;
    Packet(const Packet &) = default;
    Packet(Packet &&) = default;
    Packet &operator=(const Packet &) = default;
    Packet &operator=(Packet &&) = default;
 
 private:
    Direction direction;
    const IR::Expression *packetValue;
 
 protected:
    void print(std::ostream &os) const override;
 
    DECLARE_TYPEINFO(Packet, TraceEvent);
};
 
std::ostream &operator<<(std::ostream &os, const Packet::Direction &direction);
 
/* =============================================================================================
 *   ParserStart
 * ============================================================================================= */

class ParserStart : public TraceEvent {
 private:
    const IR::P4Parser *parser;
 
 public:
    explicit ParserStart(const IR::P4Parser *parser);
    ~ParserStart() override = default;
    ParserStart(const ParserStart &) = default;
    ParserStart(ParserStart &&) = default;
    ParserStart &operator=(const ParserStart &) = default;
    ParserStart &operator=(ParserStart &&) = default;
 
 protected:
    void print(std::ostream &os) const override;
 
    DECLARE_TYPEINFO(ParserStart, TraceEvent);
};
 
/* =============================================================================================
 *   ParserState
 * ============================================================================================= */

class ParserState : public TraceEvent {
 private:
    const IR::ParserState *state;
 
 public:
    explicit ParserState(const IR::ParserState *state);
    ~ParserState() override = default;
    ParserState(const ParserState &) = default;
    ParserState(ParserState &&) = default;
    ParserState &operator=(const ParserState &) = default;
    ParserState &operator=(ParserState &&) = default;

    const IR::ParserState *getParserState() const;
 
 protected:
    void print(std::ostream &os) const override;
 
    DECLARE_TYPEINFO(ParserState, TraceEvent);
};
 
}  // namespace P4::P4Tools::TraceEvents
 
#endif /* BACKENDS_P4TOOLS_COMMON_LIB_TRACE_EVENT_TYPES_H_ */