Common.h

Go to the documentation of this file.

//===- Common.h - Common declarations for the ArcRuntime ------------------===//
//
// Part of the LLVM 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
//
//===----------------------------------------------------------------------===//
//
// Declares common structs for the ArcRuntime.
//
// This file belongs to both the public and internal API of the ArcRuntime.
// Changes to the internal API must be reflected in the lowering passes of the
// MLIR model.
//
//===----------------------------------------------------------------------===//
 
#ifndef CIRCT_DIALECT_ARC_RUNTIME_COMMON_H
#define CIRCT_DIALECT_ARC_RUNTIME_COMMON_H
 
#include <stdint.h>
#include <string.h>
#if !defined(__cplusplus)
#include <stdalign.h>
#endif
 
/// Version of the combined public and internal API.
#define ARC_RUNTIME_API_VERSION UINT64_C(1)
 
/// Magic number used to assert the presence of an `ArcState` struct.
#define ARC_RUNTIME_MAGIC UINT32_C(0xAC1BB1CA)
 
#pragma pack(push, 1)
 
// Note: The ArcState struct uses a flexible array member to contain the
// variable-length hardware model state. This adheres to the C99 standard.
// It is not standard C++ but widely supported by C++ compilers, even though
// they might emit a warning.
#if defined(__cplusplus) && defined(__clang__)
#pragma clang diagnostic push
#pragma clang diagnostic ignored "-Wc99-extensions"
#endif
 
/// Combined runtime and model state for a hardware model instance.
struct alignas(16) ArcState {
  /// Runtime implementation specific data. Usually points to a custom struct.
  void *impl;
  /// Pointer to the active trace buffer's storage.
  /// May be null iff the model has no trace instrumentation. Otherwise must
  /// point to buffer of at least `traceBufferCapacity` size.
  uint64_t *traceBuffer;
  /// Number of valid elements in the active trace buffer.
  uint32_t traceBufferSize;
  /// Runtime magic number. Must be set to `ARC_RUNTIME_MAGIC`.
  uint32_t magic;
  /// Padding for alignment and reserved for future use.
  uint64_t reserved;
  // The model's state.
  uint8_t modelState[];
};
 
#if defined(__cplusplus) && defined(__clang__)
#pragma clang diagnostic pop
#endif
 
// Forward declaration
struct ArcModelTraceInfo;
 
/// Static information for a compiled hardware model, generated by the
/// MLIR lowering.
struct ArcRuntimeModelInfo {
  /// Runtime API version used when compiling the model.
  uint64_t apiVersion;
  /// Number of bytes required for the model's state.
  uint64_t numStateBytes;
  /// Name of the compiled model.
  const char *modelName;
  /// Signal tracing information. NULL iff the model is not trace instrumented.
  struct ArcModelTraceInfo *traceInfo;
};
 
#pragma pack(pop)
 
#endif // CIRCT_DIALECT_ARC_RUNTIME_COMMON_H