SPIRVBinaryUtils.h

Go to the documentation of this file.

//===- SPIRVBinaryUtils.cpp - SPIR-V Binary Module Utils --------*- C++ -*-===//
//
// Part of the MLIR Project, under the Apache License v2.0 with LLVM Exceptions.
// See https://llvm.org/LICENSE.txt for license information.
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
//
//===----------------------------------------------------------------------===//
//
// This file declares common utilities for SPIR-V binary module.
//
//===----------------------------------------------------------------------===//

#ifndef MLIR_DIALECT_SPIRV_SPIRV_BINARY_UTILS_H_
#define MLIR_DIALECT_SPIRV_SPIRV_BINARY_UTILS_H_

#include "mlir/Dialect/SPIRV/SPIRVOps.h"
#include "mlir/Support/LogicalResult.h"

#include <cstdint>

namespace mlir {
namespace spirv {

constexpr unsigned kHeaderWordCount = 5;

constexpr uint32_t kMagicNumber = 0x07230203;

constexpr uint32_t kGeneratorNumber = 22;

#define GET_SPIRV_SERIALIZATION_UTILS
#include "mlir/Dialect/SPIRV/SPIRVSerialization.inc"

void appendModuleHeader(SmallVectorImpl<uint32_t> &header, uint32_t idBound);

uint32_t getPrefixedOpcode(uint32_t wordCount, spirv::Opcode opcode);

LogicalResult encodeStringLiteralInto(SmallVectorImpl<uint32_t> &binary,
                                      StringRef literal);
} // end namespace spirv
} // end namespace mlir

#endif // MLIR_DIALECT_SPIRV_SPIRV_BINARY_UTILS_H_