compiler.hpp

Go to the documentation of this file.

//==-------- compiler.hpp - Interface between compiler and runtime ---------==//
//
// 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
//
//===----------------------------------------------------------------------===//
 
#pragma once
 
#include <cstddef>
#include <cstdint>
 
#define __SYCL_DEVICE_BINARY_TARGET_UNKNOWN "<unknown>"
#define __SYCL_DEVICE_BINARY_TARGET_SPIRV32 "spir"
#define __SYCL_DEVICE_BINARY_TARGET_SPIRV64 "spir64"
#define __SYCL_DEVICE_BINARY_TARGET_SPIRV64_X86_64 "spir64_x86_64"
#define __SYCL_DEVICE_BINARY_TARGET_SPIRV64_GEN "spir64_gen"
#define __SYCL_DEVICE_BINARY_TARGET_SPIRV64_FPGA "spir64_fpga"
#define __SYCL_DEVICE_BINARY_TARGET_NVPTX64 "nvptx64"
#define __SYCL_DEVICE_BINARY_TARGET_AMDGCN "amdgcn"
#define __SYCL_DEVICE_BINARY_TARGET_NATIVE_CPU "native_cpu"
 
#define __SYCL_PROPERTY_SET_SPEC_CONST_MAP "SYCL/specialization constants"
#define __SYCL_PROPERTY_SET_SPEC_CONST_DEFAULT_VALUES_MAP                      \
  "SYCL/specialization constants default values"
#define __SYCL_PROPERTY_SET_DEVICELIB_REQ_MASK "SYCL/devicelib req mask"
#define __SYCL_PROPERTY_SET_KERNEL_PARAM_OPT_INFO "SYCL/kernel param opt"
#define __SYCL_PROPERTY_SET_PROGRAM_METADATA "SYCL/program metadata"
#define __SYCL_PROPERTY_SET_SYCL_MISC_PROP "SYCL/misc properties"
#define __SYCL_PROPERTY_SET_SYCL_ASSERT_USED "SYCL/assert used"
#define __SYCL_PROPERTY_SET_SYCL_EXPORTED_SYMBOLS "SYCL/exported symbols"
#define __SYCL_PROPERTY_SET_SYCL_IMPORTED_SYMBOLS "SYCL/imported symbols"
#define __SYCL_PROPERTY_SET_SYCL_DEVICE_GLOBALS "SYCL/device globals"
#define __SYCL_PROPERTY_SET_SYCL_DEVICE_REQUIREMENTS "SYCL/device requirements"
#define __SYCL_PROPERTY_SET_SYCL_HOST_PIPES "SYCL/host pipes"
#define __SYCL_PROPERTY_SET_SYCL_VIRTUAL_FUNCTIONS "SYCL/virtual functions"
 
#define __SYCL_PROGRAM_METADATA_TAG_REQD_WORK_GROUP_SIZE "@reqd_work_group_size"
#define __SYCL_PROGRAM_METADATA_GLOBAL_ID_MAPPING "@global_id_mapping"
 
#define __SYCL_PROGRAM_METADATA_TAG_NEED_FINALIZATION "Requires finalization"
 
// Entry type, matches OpenMP for compatibility
struct _sycl_offload_entry_struct {
  void *addr;
  char *name;
  size_t size;
  int32_t flags;
  int32_t reserved;
};
using sycl_offload_entry = _sycl_offload_entry_struct *;
 
// A type of a binary image property.
enum sycl_property_type {
  SYCL_PROPERTY_TYPE_UNKNOWN,
  SYCL_PROPERTY_TYPE_UINT32,     // 32-bit integer
  SYCL_PROPERTY_TYPE_BYTE_ARRAY, // byte array
  SYCL_PROPERTY_TYPE_STRING      // null-terminated string
};
 
// Device binary image property.
// If the type size of the property value is fixed and is no greater than
// 64 bits, then ValAddr is 0 and the value is stored in the ValSize field.
// Example - PI_PROPERTY_TYPE_UINT32, which is 32-bit
struct _sycl_device_binary_property_struct {
  char *Name;       // null-terminated property name
  void *ValAddr;    // address of property value
  uint32_t Type;    // _pi_property_type
  uint64_t ValSize; // size of property value in bytes
};
using sycl_device_binary_property = _sycl_device_binary_property_struct *;
 
// Named array of properties.
struct _sycl_device_binary_property_set_struct {
  char *Name;                                  // the name
  sycl_device_binary_property PropertiesBegin; // array start
  sycl_device_binary_property PropertiesEnd;   // array end
};
using sycl_device_binary_property_set =
    _sycl_device_binary_property_set_struct *;
 
enum sycl_device_binary_type : uint8_t {
  SYCL_DEVICE_BINARY_TYPE_NONE = 0,   // undetermined
  SYCL_DEVICE_BINARY_TYPE_NATIVE = 1, // specific to a device
  SYCL_DEVICE_BINARY_TYPE_SPIRV = 2,
  SYCL_DEVICE_BINARY_TYPE_LLVMIR_BITCODE = 3
};
 
// Device binary descriptor version supported by this library.
static const uint16_t SYCL_DEVICE_BINARY_VERSION = 1;
 
// The kind of offload model the binary employs; must be 4 for SYCL
static const uint8_t SYCL_DEVICE_BINARY_OFFLOAD_KIND_SYCL = 4;
 
struct sycl_device_binary_struct {
  uint16_t Version;
  uint8_t Kind;
  uint8_t Format;
  const char *DeviceTargetSpec;
  const char *CompileOptions;
  const char *LinkOptions;
  const char *ManifestStart;
  const char *ManifestEnd;
  const unsigned char *BinaryStart;
  const unsigned char *BinaryEnd;
  sycl_offload_entry EntriesBegin;
  sycl_offload_entry EntriesEnd;
  // Array of preperty sets; e.g. specialization constants symbol-int ID map is
  // propagated to runtime with this mechanism.
  sycl_device_binary_property_set PropertySetsBegin;
  sycl_device_binary_property_set PropertySetsEnd;
  // TODO Other fields like entries, link options can be propagated using
  // the property set infrastructure. This will improve binary compatibility and
  // add flexibility.
};
using sycl_device_binary = sycl_device_binary_struct *;
 
// Offload binaries descriptor version supported by this library.
static const uint16_t SYCL_DEVICE_BINARIES_VERSION = 1;
 
struct sycl_device_binaries_struct {
  uint16_t Version;
  uint16_t NumDeviceBinaries;
  sycl_device_binary DeviceBinaries;
  sycl_offload_entry *HostEntriesBegin;
  sycl_offload_entry *HostEntriesEnd;
};
using sycl_device_binaries = sycl_device_binaries_struct *;