ValueModel.h

Go to the documentation of this file.

//===-- ValueModel.h - llzk-witgen runtime values ---------------*- C++ -*-===//
//
// Part of the LLZK Project, under the Apache License v2.0.
// See LICENSE.txt for license information.
// Copyright 2026 Project LLZK
// SPDX-License-Identifier: Apache-2.0
//
//===----------------------------------------------------------------------===//
 
#pragma once
 
#include "llzk/Dialect/Array/IR/Types.h"
#include "llzk/Dialect/POD/IR/Types.h"
#include "llzk/Dialect/Struct/IR/Ops.h"
#include "llzk/Dialect/Struct/IR/Types.h"
#include "llzk/Util/Field.h"
 
#include <llvm/ADT/DenseMap.h>
#include <llvm/ADT/DynamicAPInt.h>
#include <llvm/ADT/StringRef.h>
#include <llvm/Support/Error.h>
 
#include <cstdint>
#include <memory>
#include <optional>
#include <random>
#include <variant>
#include <vector>
 
namespace mlir {
class Operation;
class SymbolTableCollection;
} // namespace mlir
 
namespace llzk::witgen {
 
struct ArrayValue;
struct PodValue;
struct StructValue;

using ArrayValueRef = std::shared_ptr<ArrayValue>;

using PodValueRef = std::shared_ptr<PodValue>;

using StructValueRef = std::shared_ptr<StructValue>;

using WitnessVal = std::variant<
    std::monostate, bool, int64_t, llvm::DynamicAPInt, ArrayValueRef, PodValueRef, StructValueRef>;

enum class UninitializedBehavior : std::uint8_t {
  Zero,
  Random,
  Fail,
};

struct ArrayValue {
  array::ArrayType type;
  std::vector<WitnessVal> elements;
};

struct PodValue {
  pod::PodType type;
  llvm::DenseMap<llvm::StringRef, WitnessVal> records;
};

struct StructValue {
  component::StructType type;
  llvm::DenseMap<llvm::StringRef, WitnessVal> members;
};

llvm::Expected<bool> asBool(const WitnessVal &value);

llvm::Expected<int64_t> asIndex(const WitnessVal &value);

llvm::Expected<llvm::DynamicAPInt> asFelt(const WitnessVal &value);

llvm::Expected<ArrayValueRef> asArray(const WitnessVal &value);

llvm::Expected<PodValueRef> asPod(const WitnessVal &value);

llvm::Expected<StructValueRef> asStruct(const WitnessVal &value);

llvm::Expected<WitnessVal> defaultValue(
    mlir::Type type, mlir::SymbolTableCollection &tables, mlir::Operation *origin,
    const llzk::Field &field, UninitializedBehavior behavior, std::mt19937_64 *rng = nullptr
);
 
} // namespace llzk::witgen