|
| 1 | +//===--- Value.h - Definition of interpreter value --------------*- C++ -*-===// |
| 2 | +// |
| 3 | +// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions. |
| 4 | +// See https://llvm.org/LICENSE.txt for license information. |
| 5 | +// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception |
| 6 | +// |
| 7 | +//===----------------------------------------------------------------------===// |
| 8 | +// |
| 9 | +// Value is a lightweight struct that is used for carrying execution results in |
| 10 | +// clang-repl. It's a special runtime that acts like a messager between compiled |
| 11 | +// code and interpreted code. This makes it possible to exchange interesting |
| 12 | +// information between the compiled & interpreted world. |
| 13 | +// |
| 14 | +// A typical usage is like the below: |
| 15 | +// |
| 16 | +// Value V; |
| 17 | +// Interp.ParseAndExecute("int x = 42;"); |
| 18 | +// Interp.ParseAndExecute("x", &V); |
| 19 | +// V.getType(); // <-- Yields a clang::QualType. |
| 20 | +// V.getInt(); // <-- Yields 42. |
| 21 | +// |
| 22 | +// The current design is still highly experimental and nobody should rely on the |
| 23 | +// API being stable because we're hopefully going to make significant changes to |
| 24 | +// it in the relatively near future. For example, Value also intends to be used |
| 25 | +// as an exchange token for JIT support enabling remote execution on the embed |
| 26 | +// devices where the JIT infrastructure cannot fit. To support that we will need |
| 27 | +// to split the memory storage in a different place and perhaps add a resource |
| 28 | +// header is similar to intrinsics headers which have stricter performance |
| 29 | +// constraints. |
| 30 | +// |
| 31 | +//===----------------------------------------------------------------------===// |
| 32 | + |
| 33 | +#ifndef LLVM_CLANG_INTERPRETER_VALUE_H |
| 34 | +#define LLVM_CLANG_INTERPRETER_VALUE_H |
| 35 | + |
| 36 | +#include "llvm/Support/Compiler.h" |
| 37 | +#include <cstdint> |
| 38 | + |
| 39 | +// NOTE: Since the REPL itself could also include this runtime, extreme caution |
| 40 | +// should be taken when MAKING CHANGES to this file, especially when INCLUDE NEW |
| 41 | +// HEADERS, like <string>, <memory> and etc. (That pulls a large number of |
| 42 | +// tokens and will impact the runtime performance of the REPL) |
| 43 | + |
| 44 | +namespace llvm { |
| 45 | +class raw_ostream; |
| 46 | + |
| 47 | +} // namespace llvm |
| 48 | + |
| 49 | +namespace clang { |
| 50 | + |
| 51 | +class ASTContext; |
| 52 | +class Interpreter; |
| 53 | +class QualType; |
| 54 | + |
| 55 | +#if __has_attribute(visibility) && \ |
| 56 | + (!(defined(_WIN32) || defined(__CYGWIN__)) || \ |
| 57 | + (defined(__MINGW32__) && defined(__clang__))) |
| 58 | +#if defined(LLVM_BUILD_LLVM_DYLIB) || defined(LLVM_BUILD_SHARED_LIBS) |
| 59 | +#define REPL_EXTERNAL_VISIBILITY __attribute__((visibility("default"))) |
| 60 | +#else |
| 61 | +#define REPL_EXTERNAL_VISIBILITY |
| 62 | +#endif |
| 63 | +#else |
| 64 | +#if defined(_WIN32) |
| 65 | +#define REPL_EXTERNAL_VISIBILITY __declspec(dllexport) |
| 66 | +#endif |
| 67 | +#endif |
| 68 | + |
| 69 | +#define REPL_BUILTIN_TYPES \ |
| 70 | + X(bool, Bool) \ |
| 71 | + X(char, Char_S) \ |
| 72 | + X(signed char, SChar) \ |
| 73 | + X(unsigned char, UChar) \ |
| 74 | + X(short, Short) \ |
| 75 | + X(unsigned short, UShort) \ |
| 76 | + X(int, Int) \ |
| 77 | + X(unsigned int, UInt) \ |
| 78 | + X(long, Long) \ |
| 79 | + X(unsigned long, ULong) \ |
| 80 | + X(long long, LongLong) \ |
| 81 | + X(unsigned long long, ULongLong) \ |
| 82 | + X(float, Float) \ |
| 83 | + X(double, Double) \ |
| 84 | + X(long double, LongDouble) |
| 85 | + |
| 86 | +class REPL_EXTERNAL_VISIBILITY Value { |
| 87 | + union Storage { |
| 88 | +#define X(type, name) type m_##name; |
| 89 | + REPL_BUILTIN_TYPES |
| 90 | +#undef X |
| 91 | + void *m_Ptr; |
| 92 | + }; |
| 93 | + |
| 94 | +public: |
| 95 | + enum Kind { |
| 96 | +#define X(type, name) K_##name, |
| 97 | + REPL_BUILTIN_TYPES |
| 98 | +#undef X |
| 99 | + |
| 100 | + K_Void, |
| 101 | + K_PtrOrObj, |
| 102 | + K_Unspecified |
| 103 | + }; |
| 104 | + |
| 105 | + Value() = default; |
| 106 | + Value(Interpreter *In, void *Ty); |
| 107 | + Value(const Value &RHS); |
| 108 | + Value(Value &&RHS) noexcept; |
| 109 | + Value &operator=(const Value &RHS); |
| 110 | + Value &operator=(Value &&RHS) noexcept; |
| 111 | + ~Value(); |
| 112 | + |
| 113 | + void printType(llvm::raw_ostream &Out) const; |
| 114 | + void printData(llvm::raw_ostream &Out) const; |
| 115 | + void print(llvm::raw_ostream &Out) const; |
| 116 | + void dump() const; |
| 117 | + void clear(); |
| 118 | + |
| 119 | + ASTContext &getASTContext(); |
| 120 | + const ASTContext &getASTContext() const; |
| 121 | + Interpreter &getInterpreter(); |
| 122 | + const Interpreter &getInterpreter() const; |
| 123 | + QualType getType() const; |
| 124 | + |
| 125 | + bool isValid() const { return ValueKind != K_Unspecified; } |
| 126 | + bool isVoid() const { return ValueKind == K_Void; } |
| 127 | + bool hasValue() const { return isValid() && !isVoid(); } |
| 128 | + bool isManuallyAlloc() const { return IsManuallyAlloc; } |
| 129 | + Kind getKind() const { return ValueKind; } |
| 130 | + void setKind(Kind K) { ValueKind = K; } |
| 131 | + void setOpaqueType(void *Ty) { OpaqueType = Ty; } |
| 132 | + |
| 133 | + void *getPtr() const; |
| 134 | + void setPtr(void *Ptr) { Data.m_Ptr = Ptr; } |
| 135 | + |
| 136 | +#define X(type, name) \ |
| 137 | + void set##name(type Val) { Data.m_##name = Val; } \ |
| 138 | + type get##name() const { return Data.m_##name; } |
| 139 | + REPL_BUILTIN_TYPES |
| 140 | +#undef X |
| 141 | + |
| 142 | + /// \brief Get the value with cast. |
| 143 | + // |
| 144 | + /// Get the value cast to T. This is similar to reinterpret_cast<T>(value), |
| 145 | + /// casting the value of builtins (except void), enums and pointers. |
| 146 | + /// Values referencing an object are treated as pointers to the object. |
| 147 | + template <typename T> T convertTo() const { |
| 148 | + return convertFwd<T>::cast(*this); |
| 149 | + } |
| 150 | + |
| 151 | +protected: |
| 152 | + bool isPointerOrObjectType() const { return ValueKind == K_PtrOrObj; } |
| 153 | + |
| 154 | + /// \brief Get to the value with type checking casting the underlying |
| 155 | + /// stored value to T. |
| 156 | + template <typename T> T as() const { |
| 157 | + switch (ValueKind) { |
| 158 | + default: |
| 159 | + return T(); |
| 160 | +#define X(type, name) \ |
| 161 | + case Value::K_##name: \ |
| 162 | + return (T)Data.m_##name; |
| 163 | + REPL_BUILTIN_TYPES |
| 164 | +#undef X |
| 165 | + } |
| 166 | + } |
| 167 | + |
| 168 | + // Allow convertTo to be partially specialized. |
| 169 | + template <typename T> struct convertFwd { |
| 170 | + static T cast(const Value &V) { |
| 171 | + if (V.isPointerOrObjectType()) |
| 172 | + return (T)(uintptr_t)V.as<void *>(); |
| 173 | + if (!V.isValid() || V.isVoid()) { |
| 174 | + return T(); |
| 175 | + } |
| 176 | + return V.as<T>(); |
| 177 | + } |
| 178 | + }; |
| 179 | + |
| 180 | + template <typename T> struct convertFwd<T *> { |
| 181 | + static T *cast(const Value &V) { |
| 182 | + if (V.isPointerOrObjectType()) |
| 183 | + return (T *)(uintptr_t)V.as<void *>(); |
| 184 | + return nullptr; |
| 185 | + } |
| 186 | + }; |
| 187 | + |
| 188 | + Interpreter *Interp = nullptr; |
| 189 | + void *OpaqueType = nullptr; |
| 190 | + Storage Data; |
| 191 | + Kind ValueKind = K_Unspecified; |
| 192 | + bool IsManuallyAlloc = false; |
| 193 | +}; |
| 194 | + |
| 195 | +template <> inline void *Value::as() const { |
| 196 | + if (isPointerOrObjectType()) |
| 197 | + return Data.m_Ptr; |
| 198 | + return (void *)as<uintptr_t>(); |
| 199 | +} |
| 200 | + |
| 201 | +} // namespace clang |
| 202 | +#endif |
0 commit comments