LLZKLayout.h

Go to the documentation of this file.

//===-- LLZKLayout.h -------------------------------------------*- 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 <mlir/IR/BuiltinAttributes.h>
#include <mlir/IR/BuiltinOps.h>
#include <mlir/Support/LogicalResult.h>
 
#include <llvm/ADT/DenseMap.h>
#include <llvm/ADT/SmallVector.h>
 
#include <cstdint>
#include <optional>
 
namespace llvm {
class raw_ostream;
} // namespace llvm
 
namespace llzk {

inline constexpr char LAYOUT_MAIN_ROOT[] = "main";
inline constexpr char LAYOUT_ARGUMENT_ROOT[] = "arg";

struct LLZKLayout {
  llvm::SmallVector<mlir::ArrayAttr> signalPaths;
  llvm::DenseMap<mlir::ArrayAttr, uint64_t> signalIds;
  llvm::SmallVector<mlir::StringAttr> argumentNames;

  std::optional<uint64_t> getSignalId(mlir::ArrayAttr path) const;
};

mlir::FailureOr<LLZKLayout> buildLLZKLayout(mlir::ModuleOp module);

void printLLZKLayout(const LLZKLayout &layout, llvm::raw_ostream &output);
 
} // namespace llzk