1//===- CodeGen/Analysis.h - CodeGen LLVM IR Analysis Utilities --*- C++ -*-===//
2//
3//                     The LLVM Compiler Infrastructure
4//
5// This file is distributed under the University of Illinois Open Source
6// License. See LICENSE.TXT for details.
7//
8//===----------------------------------------------------------------------===//
9//
10// This file declares several CodeGen-specific LLVM IR analysis utilities.
11//
12//===----------------------------------------------------------------------===//
13
14#ifndef LLVM_CODEGEN_ANALYSIS_H
15#define LLVM_CODEGEN_ANALYSIS_H
16
17#include "llvm/ADT/ArrayRef.h"
18#include "llvm/ADT/SmallVector.h"
19#include "llvm/CodeGen/ISDOpcodes.h"
20#include "llvm/IR/CallSite.h"
21#include "llvm/IR/InlineAsm.h"
22#include "llvm/IR/Instructions.h"
23
24namespace llvm {
25class GlobalVariable;
26class TargetLoweringBase;
27class SDNode;
28class SDValue;
29class SelectionDAG;
30class TargetLowering;
31struct EVT;
32
33/// ComputeLinearIndex - Given an LLVM IR aggregate type and a sequence
34/// of insertvalue or extractvalue indices that identify a member, return
35/// the linearized index of the start of the member.
36///
37unsigned ComputeLinearIndex(Type *Ty,
38                            const unsigned *Indices,
39                            const unsigned *IndicesEnd,
40                            unsigned CurIndex = 0);
41
42inline unsigned ComputeLinearIndex(Type *Ty,
43                                   ArrayRef<unsigned> Indices,
44                                   unsigned CurIndex = 0) {
45  return ComputeLinearIndex(Ty, Indices.begin(), Indices.end(), CurIndex);
46}
47
48/// ComputeValueVTs - Given an LLVM IR type, compute a sequence of
49/// EVTs that represent all the individual underlying
50/// non-aggregate types that comprise it.
51///
52/// If Offsets is non-null, it points to a vector to be filled in
53/// with the in-memory offsets of each of the individual values.
54///
55void ComputeValueVTs(const TargetLowering &TLI, Type *Ty,
56                     SmallVectorImpl<EVT> &ValueVTs,
57                     SmallVectorImpl<uint64_t> *Offsets = nullptr,
58                     uint64_t StartingOffset = 0);
59
60/// ExtractTypeInfo - Returns the type info, possibly bitcast, encoded in V.
61GlobalVariable *ExtractTypeInfo(Value *V);
62
63/// hasInlineAsmMemConstraint - Return true if the inline asm instruction being
64/// processed uses a memory 'm' constraint.
65bool hasInlineAsmMemConstraint(InlineAsm::ConstraintInfoVector &CInfos,
66                               const TargetLowering &TLI);
67
68/// getFCmpCondCode - Return the ISD condition code corresponding to
69/// the given LLVM IR floating-point condition code.  This includes
70/// consideration of global floating-point math flags.
71///
72ISD::CondCode getFCmpCondCode(FCmpInst::Predicate Pred);
73
74/// getFCmpCodeWithoutNaN - Given an ISD condition code comparing floats,
75/// return the equivalent code if we're allowed to assume that NaNs won't occur.
76ISD::CondCode getFCmpCodeWithoutNaN(ISD::CondCode CC);
77
78/// getICmpCondCode - Return the ISD condition code corresponding to
79/// the given LLVM IR integer condition code.
80///
81ISD::CondCode getICmpCondCode(ICmpInst::Predicate Pred);
82
83/// Test if the given instruction is in a position to be optimized
84/// with a tail-call. This roughly means that it's in a block with
85/// a return and there's nothing that needs to be scheduled
86/// between it and the return.
87///
88/// This function only tests target-independent requirements.
89bool isInTailCallPosition(ImmutableCallSite CS, const SelectionDAG &DAG);
90
91/// Test if given that the input instruction is in the tail call position if the
92/// return type or any attributes of the function will inhibit tail call
93/// optimization.
94bool returnTypeIsEligibleForTailCall(const Function *F,
95                                     const Instruction *I,
96                                     const ReturnInst *Ret,
97                                     const TargetLoweringBase &TLI);
98
99} // End llvm namespace
100
101#endif
102