JSON.h

Go to the documentation of this file.

//===-- JSON.h - llzk-witgen JSON conversion helpers ------------*- 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 "ValueModel.h"
#include "WitnessSelection.h"
 
#include <llvm/Support/Error.h>
#include <llvm/Support/JSON.h>
 
namespace llzk::witgen {

enum class SerializationMode : std::uint8_t {
  PublicOutputsOnly,
  AllSignals,
};

struct JSONMismatch {
  std::string path;
  std::string message;
};

llvm::Expected<WitnessVal> parseJSONValue(
    const llvm::json::Value *json, mlir::Type type, const llzk::Field &field,
    mlir::Operation *origin
);

llvm::Expected<llvm::json::Value> serializeJSONValue(
    const WitnessVal &value, mlir::Type type, mlir::SymbolTableCollection &tables,
    mlir::Operation *origin, SerializationMode mode = SerializationMode::PublicOutputsOnly
);

llvm::Expected<llvm::json::Object> buildInputsJSONObject(
    llvm::ArrayRef<InputBinding> bindings, llvm::ArrayRef<WitnessVal> values,
    mlir::SymbolTableCollection &tables, mlir::Operation *origin
);

llvm::Expected<WitnessVal> extractValueAtPath(
    const WitnessVal &root, mlir::Type rootType, llvm::ArrayRef<std::string> path,
    mlir::SymbolTableCollection &tables, mlir::Operation *origin
);

void diffJSON(
    const llvm::json::Value &expected, const llvm::json::Value &actual,
    llvm::SmallVectorImpl<JSONMismatch> &out, llvm::StringRef path = "$"
);

void printJSONMismatches(llvm::raw_ostream &os, llvm::ArrayRef<JSONMismatch> mismatches);
 
} // namespace llzk::witgen