//===--- Source.h - Source location provider for the VM  --------*- C++ -*-===//

//

// 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

//

//===----------------------------------------------------------------------===//

//

// Defines a program which organises and links multiple bytecode functions.

//

//===----------------------------------------------------------------------===//

#ifndef LLVM_CLANG_AST_INTERP_SOURCE_H

#define LLVM_CLANG_AST_INTERP_SOURCE_H

#include "clang/AST/Decl.h"

#include "clang/AST/Stmt.h"

#include "llvm/Support/Endian.h"

namespace clang {

namespace interp {

class Function;

/// Pointer into the code segment.

class CodePtr {

public:

  CodePtr() : Ptr(nullptr) {}

  CodePtr &operator+=(int32_t Offset) {

    Ptr += Offset;

    return *this;

  }

  int32_t operator-(const CodePtr &RHS) const {

    assert(Ptr != nullptr && RHS.Ptr != nullptr && "Invalid code pointer");

    return Ptr - RHS.Ptr;

  }

  CodePtr operator-(size_t RHS) const {

    assert(Ptr != nullptr && "Invalid code pointer");

    return CodePtr(Ptr - RHS);

  }

  bool operator!=(const CodePtr &RHS) const { return Ptr != RHS.Ptr; }

  /// Reads data and advances the pointer.

  template <typename T> std::enable_if_t<!std::is_pointer<T>::value, T> read() {

    using namespace llvm::support;

    T Value = endian::read<T, endianness::native, 1>(Ptr);

    Ptr += sizeof(T);

    return Value;

  }

std::__1::enable_if<!(std::is_pointer<clang::interp::Opcode>::value), clang::interp::Opcode>::type clang::interp::CodePtr::read<clang::interp::Opcode>()

Line

Count

Source

47

1

  template <typename T> std::enable_if_t<!std::is_pointer<T>::value, T> read() {

48

1

    using namespace llvm::support;

49

1

    T Value = endian::read<T, endianness::native, 1>(Ptr);

50

1

    Ptr += sizeof(T);

51

1

    return Value;

52

1

  }

Unexecuted instantiation: std::__1::enable_if<!(std::is_pointer<bool>::value), bool>::type clang::interp::CodePtr::read<bool>()

Unexecuted instantiation: std::__1::enable_if<!(std::is_pointer<short>::value), short>::type clang::interp::CodePtr::read<short>()

Unexecuted instantiation: std::__1::enable_if<!(std::is_pointer<int>::value), int>::type clang::interp::CodePtr::read<int>()

Unexecuted instantiation: std::__1::enable_if<!(std::is_pointer<long long>::value), long long>::type clang::interp::CodePtr::read<long long>()

Unexecuted instantiation: std::__1::enable_if<!(std::is_pointer<signed char>::value), signed char>::type clang::interp::CodePtr::read<signed char>()

Unexecuted instantiation: std::__1::enable_if<!(std::is_pointer<unsigned short>::value), unsigned short>::type clang::interp::CodePtr::read<unsigned short>()

std::__1::enable_if<!(std::is_pointer<unsigned int>::value), unsigned int>::type clang::interp::CodePtr::read<unsigned int>()

Line

Count

Source

47

1

  template <typename T> std::enable_if_t<!std::is_pointer<T>::value, T> read() {

48

1

    using namespace llvm::support;

49

1

    T Value = endian::read<T, endianness::native, 1>(Ptr);

50

1

    Ptr += sizeof(T);

51

1

    return Value;

52

1

  }

Unexecuted instantiation: std::__1::enable_if<!(std::is_pointer<unsigned long long>::value), unsigned long long>::type clang::interp::CodePtr::read<unsigned long long>()

Unexecuted instantiation: std::__1::enable_if<!(std::is_pointer<unsigned char>::value), unsigned char>::type clang::interp::CodePtr::read<unsigned char>()

private:

  /// Constructor used by Function to generate pointers.

  CodePtr(const char *Ptr) : Ptr(Ptr) {}

private:

  friend class Function;

  /// Pointer into the code owned by a function.

  const char *Ptr;

};

/// Describes the statement/declaration an opcode was generated from.

class SourceInfo {

public:

  SourceInfo() {}

  SourceInfo(const Stmt *E) : Source(E) {}

  SourceInfo(const Decl *D) : Source(D) {}

  SourceLocation getLoc() const;

  const Stmt *asStmt() const { return Source.dyn_cast<const Stmt *>(); }

  const Decl *asDecl() const { return Source.dyn_cast<const Decl *>(); }

  const Expr *asExpr() const;

  operator bool() const { return !Source.isNull(); }

private:

  llvm::PointerUnion<const Decl *, const Stmt *> Source;

};

using SourceMap = std::vector<std::pair<unsigned, SourceInfo>>;

/// Interface for classes which map locations to sources.

class SourceMapper {

public:

  virtual ~SourceMapper() {}

  /// Returns source information for a given PC in a function.

  virtual SourceInfo getSource(Function *F, CodePtr PC) const = 0;

  /// Returns the expression if an opcode belongs to one, null otherwise.

  const Expr *getExpr(Function *F, CodePtr PC) const;

  /// Returns the location from which an opcode originates.

  SourceLocation getLocation(Function *F, CodePtr PC) const;

};

} // namespace interp

} // namespace clang

#endif