llvmUtil.h

/*
 * Copyright 2004-2015 Cray Inc.
 * Other additional copyright holders may be indicated within.
 * 
 * The entirety of this work is licensed under the Apache License,
 * Version 2.0 (the "License"); you may not use this file except
 * in compliance with the License.
 * 
 * You may obtain a copy of the License at
 * 
 *     http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

#ifndef _LLVMUTIL_H_
#define _LLVMUTIL_H_

#ifdef HAVE_LLVM

#include <utility>

#include "llvm/Config/llvm-config.h"

#if   LLVM_VERSION_MAJOR>3 || (LLVM_VERSION_MAJOR==3 && LLVM_VERSION_MINOR>=7 )
#define HAVE_LLVM_VER 37
#elif LLVM_VERSION_MAJOR>3 || (LLVM_VERSION_MAJOR==3 && LLVM_VERSION_MINOR>=6 )
#define HAVE_LLVM_VER 36
#elif LLVM_VERSION_MAJOR>3 || (LLVM_VERSION_MAJOR==3 && LLVM_VERSION_MINOR>=5 )
#define HAVE_LLVM_VER 35
#elif LLVM_VERSION_MAJOR>3 || (LLVM_VERSION_MAJOR==3 && LLVM_VERSION_MINOR>=4 )
#define HAVE_LLVM_VER 34
#elif LLVM_VERSION_MAJOR>3 || (LLVM_VERSION_MAJOR==3 && LLVM_VERSION_MINOR>=3 )
#define HAVE_LLVM_VER 33
#elif LLVM_VERSION_MAJOR>3 || (LLVM_VERSION_MAJOR==3 && LLVM_VERSION_MINOR>=2 )
#define HAVE_LLVM_VER 32
#elif LLVM_VERSION_MAJOR>3 || (LLVM_VERSION_MAJOR==3 && LLVM_VERSION_MINOR>=1 )
#define HAVE_LLVM_VER 31
#endif

// So we can declare our small set insert fixup
#include "llvm/ADT/SmallSet.h"

#if HAVE_LLVM_VER >= 33

#include "llvm/IR/Module.h"
#include "llvm/IR/Value.h"
#include "llvm/IR/Intrinsics.h"
#include "llvm/IR/IntrinsicInst.h"
#include "llvm/IR/Attributes.h"
#include "llvm/IR/IRBuilder.h"
#include "llvm/IR/DataLayout.h"
#define LLVM_TARGET_DATA llvm::DataLayout
#define LLVM_ATTRIBUTE llvm::Attribute
static inline bool llvm_fn_param_has_attr(llvm::Function* f, unsigned idx, llvm::Attribute::AttrKind v)
{
  return f->getAttributes().hasAttribute(idx, v);
}

#elif HAVE_LLVM_VER >= 32

#include "llvm/Module.h"
#include "llvm/Value.h"
#include "llvm/IRBuilder.h"
#include "llvm/DataLayout.h"
#include "llvm/Intrinsics.h"
#include "llvm/IntrinsicInst.h"
#include "llvm/Attributes.h"
#define LLVM_TARGET_DATA llvm::DataLayout
#define LLVM_ATTRIBUTE llvm::Attributes
static inline bool llvm_fn_param_has_attr(llvm::Function* f, unsigned idx, llvm::Attributes::AttrVal v)
{
  //return f->getAttributes().getParamAttributes(idx).hasAttribute(v);
  return f->getParamAttributes(idx).hasAttribute(v);
}

#elif HAVE_LLVM_VER >= 31

#include "llvm/Module.h"
#include "llvm/Value.h"
#include "llvm/Support/IRBuilder.h"
#include "llvm/Target/TargetData.h"
#include "llvm/Intrinsics.h"
#include "llvm/IntrinsicInst.h"
#include "llvm/Attributes.h"
#define LLVM_TARGET_DATA llvm::TargetData
#define LLVM_ATTRIBUTE llvm::Attribute
static inline bool llvm_fn_param_has_attr(llvm::Function* f, unsigned idx, llvm::AttrConst v)
{
  return f->paramHasAttr(idx, v);
}

#endif

// PassManager also changed names..
#if HAVE_LLVM_VER >= 37
#include "llvm/IR/LegacyPassManager.h"
#define LEGACY_FUNCTION_PASS_MANAGER llvm::legacy::FunctionPassManager
#define LEGACY_PASS_MANAGER llvm::legacy::PassManagerBase
#else
#include "llvm/PassManager.h"
#define LEGACY_FUNCTION_PASS_MANAGER llvm::FunctionPassManager
#define LEGACY_PASS_MANAGER llvm::PassManagerBase
#endif

struct PromotedPair {
  llvm::Value* a;
  llvm::Value* b;
  bool isSigned;
  PromotedPair(llvm::Value* a, llvm::Value* b, bool isSigned)
    : a(a), b(b), isSigned(isSigned)
  {
  }
};

llvm::Constant* codegenSizeofLLVM(llvm::Type* type);
llvm::AllocaInst* makeAlloca(llvm::Type* type, const char* name, llvm::Instruction* insertBefore, unsigned n=1, unsigned align=0);

llvm::Value* createTempVarLLVM(llvm::IRBuilder<>* builder, llvm::Type* type, const char* name);
llvm::Value *convertValueToType(llvm::IRBuilder<> *builder, LLVM_TARGET_DATA * targetData, llvm::Value *value, llvm::Type *newType, bool isSigned = false, bool force = false);
PromotedPair convertValuesToLarger(llvm::IRBuilder<> *builder, llvm::Value *value1, llvm::Value *value2, bool isSigned1 = false, bool isSigned2 = false);

int64_t getTypeSizeInBytes(LLVM_TARGET_DATA * layout, llvm::Type* ty);
bool isTypeSizeSmallerThan(LLVM_TARGET_DATA * layout, llvm::Type* ty, uint64_t max_size_bytes);
uint64_t getTypeFieldNext(LLVM_TARGET_DATA * layout, llvm::Type* ty, uint64_t offset);


// And create a type for a metadata operand 
#if HAVE_LLVM_VER >= 36
#define LLVM_METADATA_OPERAND_TYPE llvm::Metadata
static inline llvm::ConstantAsMetadata* llvm_constant_as_metadata(llvm::Constant* C)
{
  return llvm::ConstantAsMetadata::get(C);
}
template<typename T, unsigned N>
static inline
bool llvm_small_set_insert(llvm::SmallSet<T,N> & smallset, const T &V) {
  return smallset.insert(V).second;
}
#else
#define LLVM_METADATA_OPERAND_TYPE llvm::Value
static inline llvm::Constant* llvm_constant_as_metadata(llvm::Constant* C)
{
  return C;
}
template<typename T, unsigned N>
static inline
bool llvm_small_set_insert(llvm::SmallSet<T,N> & smallset, const T &V) {
  return smallset.insert(V);
}

#endif

// LLVMs after 3.5 require C++11 support
#if HAVE_LLVM_VER >= 35
#define HAVE_LLVM_CXX11 1
#endif

#ifdef HAVE_LLVM_CXX11
#define LLVM_CXX_OVERRIDE override
#else
#define LLVM_CXX_OVERRIDE
#endif

#endif //HAVE_LLVM

#endif //LLVMUTIL_H