/build/llvm-toolchain-snapshot-9~svn362543/include/llvm/Support/Error.h

Bug Summary

File:	include/llvm/Support/Error.h
Warning:	line 200, column 5 Potential leak of memory pointed to by 'Payload._M_t._M_head_impl'

Annotated Source Code

Press '?' to see keyboard shortcuts

Show analyzer invocation

clang -cc1 -triple x86_64-pc-linux-gnu -analyze -disable-free -disable-llvm-verifier -discard-value-names -main-file-name CallEvent.cpp -analyzer-store=region -analyzer-opt-analyze-nested-blocks -analyzer-checker=core -analyzer-checker=apiModeling -analyzer-checker=unix -analyzer-checker=deadcode -analyzer-checker=cplusplus -analyzer-checker=security.insecureAPI.UncheckedReturn -analyzer-checker=security.insecureAPI.getpw -analyzer-checker=security.insecureAPI.gets -analyzer-checker=security.insecureAPI.mktemp -analyzer-checker=security.insecureAPI.mkstemp -analyzer-checker=security.insecureAPI.vfork -analyzer-checker=nullability.NullPassedToNonnull -analyzer-checker=nullability.NullReturnedFromNonnull -analyzer-output plist -w -analyzer-config-compatibility-mode=true -mrelocation-model pic -pic-level 2 -mthread-model posix -relaxed-aliasing -fmath-errno -masm-verbose -mconstructor-aliases -munwind-tables -fuse-init-array -target-cpu x86-64 -dwarf-column-info -debugger-tuning=gdb -momit-leaf-frame-pointer -ffunction-sections -fdata-sections -resource-dir /usr/lib/llvm-9/lib/clang/9.0.0 -D CLANG_VENDOR="Debian " -D _DEBUG -D _GNU_SOURCE -D __STDC_CONSTANT_MACROS -D __STDC_FORMAT_MACROS -D __STDC_LIMIT_MACROS -I /build/llvm-toolchain-snapshot-9~svn362543/build-llvm/tools/clang/lib/StaticAnalyzer/Core -I /build/llvm-toolchain-snapshot-9~svn362543/tools/clang/lib/StaticAnalyzer/Core -I /build/llvm-toolchain-snapshot-9~svn362543/tools/clang/include -I /build/llvm-toolchain-snapshot-9~svn362543/build-llvm/tools/clang/include -I /build/llvm-toolchain-snapshot-9~svn362543/build-llvm/include -I /build/llvm-toolchain-snapshot-9~svn362543/include -U NDEBUG -internal-isystem /usr/lib/gcc/x86_64-linux-gnu/6.3.0/../../../../include/c++/6.3.0 -internal-isystem /usr/lib/gcc/x86_64-linux-gnu/6.3.0/../../../../include/x86_64-linux-gnu/c++/6.3.0 -internal-isystem /usr/lib/gcc/x86_64-linux-gnu/6.3.0/../../../../include/x86_64-linux-gnu/c++/6.3.0 -internal-isystem /usr/lib/gcc/x86_64-linux-gnu/6.3.0/../../../../include/c++/6.3.0/backward -internal-isystem /usr/include/clang/9.0.0/include/ -internal-isystem /usr/local/include -internal-isystem /usr/lib/llvm-9/lib/clang/9.0.0/include -internal-externc-isystem /usr/include/x86_64-linux-gnu -internal-externc-isystem /include -internal-externc-isystem /usr/include -O2 -Wno-unused-parameter -Wwrite-strings -Wno-missing-field-initializers -Wno-long-long -Wno-maybe-uninitialized -Wno-comment -std=c++11 -fdeprecated-macro -fdebug-compilation-dir /build/llvm-toolchain-snapshot-9~svn362543/build-llvm/tools/clang/lib/StaticAnalyzer/Core -fdebug-prefix-map=/build/llvm-toolchain-snapshot-9~svn362543=. -ferror-limit 19 -fmessage-length 0 -fvisibility-inlines-hidden -stack-protector 2 -fobjc-runtime=gcc -fno-common -fdiagnostics-show-option -vectorize-loops -vectorize-slp -analyzer-output=html -analyzer-config stable-report-filename=true -o /tmp/scan-build-2019-06-05-060531-1271-1 -x c++ /build/llvm-toolchain-snapshot-9~svn362543/tools/clang/lib/StaticAnalyzer/Core/CallEvent.cpp -faddrsig

/build/llvm-toolchain-snapshot-9~svn362543/tools/clang/lib/StaticAnalyzer/Core/CallEvent.cpp

→

1//===- CallEvent.cpp - Wrapper for all function and method calls ----------===//
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/// \file This file defines CallEvent and its subclasses, which represent path-
10/// sensitive instances of different kinds of function and method calls
11/// (C, C++, and Objective-C).
12//
13//===----------------------------------------------------------------------===//

15#include "clang/StaticAnalyzer/Core/PathSensitive/CallEvent.h"
16#include "clang/AST/ASTContext.h"
17#include "clang/AST/Decl.h"
18#include "clang/AST/DeclBase.h"
19#include "clang/AST/DeclCXX.h"
20#include "clang/AST/DeclObjC.h"
21#include "clang/AST/Expr.h"
22#include "clang/AST/ExprCXX.h"
23#include "clang/AST/ExprObjC.h"
24#include "clang/AST/ParentMap.h"
25#include "clang/AST/Stmt.h"
26#include "clang/AST/Type.h"
27#include "clang/Analysis/AnalysisDeclContext.h"
28#include "clang/Analysis/CFG.h"
29#include "clang/Analysis/CFGStmtMap.h"
30#include "clang/Analysis/ProgramPoint.h"
31#include "clang/CrossTU/CrossTranslationUnit.h"
32#include "clang/Basic/IdentifierTable.h"
33#include "clang/Basic/LLVM.h"
34#include "clang/Basic/SourceLocation.h"
35#include "clang/Basic/SourceManager.h"
36#include "clang/Basic/Specifiers.h"
37#include "clang/StaticAnalyzer/Core/BugReporter/PathDiagnostic.h"
38#include "clang/StaticAnalyzer/Core/PathSensitive/CheckerContext.h"
39#include "clang/StaticAnalyzer/Core/PathSensitive/DynamicTypeInfo.h"
40#include "clang/StaticAnalyzer/Core/PathSensitive/DynamicTypeMap.h"
41#include "clang/StaticAnalyzer/Core/PathSensitive/MemRegion.h"
42#include "clang/StaticAnalyzer/Core/PathSensitive/ProgramState.h"
43#include "clang/StaticAnalyzer/Core/PathSensitive/ProgramState_Fwd.h"
44#include "clang/StaticAnalyzer/Core/PathSensitive/SVals.h"
45#include "clang/StaticAnalyzer/Core/PathSensitive/SValBuilder.h"
46#include "clang/StaticAnalyzer/Core/PathSensitive/Store.h"
47#include "llvm/ADT/ArrayRef.h"
48#include "llvm/ADT/DenseMap.h"
49#include "llvm/ADT/None.h"
50#include "llvm/ADT/Optional.h"
51#include "llvm/ADT/PointerIntPair.h"
52#include "llvm/ADT/SmallSet.h"
53#include "llvm/ADT/SmallVector.h"
54#include "llvm/ADT/StringExtras.h"
55#include "llvm/ADT/StringRef.h"
56#include "llvm/Support/Casting.h"
57#include "llvm/Support/Compiler.h"
58#include "llvm/Support/Debug.h"
59#include "llvm/Support/ErrorHandling.h"
60#include "llvm/Support/raw_ostream.h"
61#include <cassert>
62#include <utility>

64#define DEBUG_TYPE"static-analyzer-call-event" "static-analyzer-call-event"

66using namespace clang;
67using namespace ento;

69QualType CallEvent::getResultType() const {
ASTContext &Ctx = getState()->getStateManager().getContext();
const Expr *E = getOriginExpr();
if (!E)
  return Ctx.VoidTy;
assert(E)((E) ? static_cast<void> (0) : __assert_fail ("E", "/build/llvm-toolchain-snapshot-9~svn362543/tools/clang/lib/StaticAnalyzer/Core/CallEvent.cpp"
, 74, __PRETTY_FUNCTION__));

QualType ResultTy = E->getType();

// A function that returns a reference to 'int' will have a result type
// of simply 'int'. Check the origin expr's value kind to recover the
// proper type.
switch (E->getValueKind()) {
case VK_LValue:
  ResultTy = Ctx.getLValueReferenceType(ResultTy);
  break;
case VK_XValue:
  ResultTy = Ctx.getRValueReferenceType(ResultTy);
  break;
case VK_RValue:
  // No adjustment is necessary.
  break;
}

return ResultTy;
94}

96static bool isCallback(QualType T) {
// If a parameter is a block or a callback, assume it can modify pointer.
if (T->isBlockPointerType() ||
    T->isFunctionPointerType() ||
    T->isObjCSelType())
  return true;

// Check if a callback is passed inside a struct (for both, struct passed by
// reference and by value). Dig just one level into the struct for now.

if (T->isAnyPointerType() || T->isReferenceType())
  T = T->getPointeeType();

if (const RecordType *RT = T->getAsStructureType()) {
  const RecordDecl *RD = RT->getDecl();
  for (const auto *I : RD->fields()) {
    QualType FieldT = I->getType();
    if (FieldT->isBlockPointerType() || FieldT->isFunctionPointerType())
      return true;
  }
}
return false;
118}

120static bool isVoidPointerToNonConst(QualType T) {
if (const auto *PT = T->getAs<PointerType>()) {
  QualType PointeeTy = PT->getPointeeType();
  if (PointeeTy.isConstQualified())
    return false;
  return PointeeTy->isVoidType();
} else
  return false;
128}

130bool CallEvent::hasNonNullArgumentsWithType(bool (*Condition)(QualType)) const {
unsigned NumOfArgs = getNumArgs();

// If calling using a function pointer, assume the function does not
// satisfy the callback.
// TODO: We could check the types of the arguments here.
if (!getDecl())
  return false;

unsigned Idx = 0;
for (CallEvent::param_type_iterator I = param_type_begin(),
                                    E = param_type_end();
     I != E && Idx < NumOfArgs; ++I, ++Idx) {
  // If the parameter is 0, it's harmless.
  if (getArgSVal(Idx).isZeroConstant())
    continue;

  if (Condition(*I))
    return true;
}
return false;
151}

153bool CallEvent::hasNonZeroCallbackArg() const {
return hasNonNullArgumentsWithType(isCallback);
155}

157bool CallEvent::hasVoidPointerToNonConstArg() const {
return hasNonNullArgumentsWithType(isVoidPointerToNonConst);
159}

161bool CallEvent::isGlobalCFunction(StringRef FunctionName) const {
const auto *FD = dyn_cast_or_null<FunctionDecl>(getDecl());
if (!FD)
  return false;

return CheckerContext::isCLibraryFunction(FD, FunctionName);
167}

169AnalysisDeclContext *CallEvent::getCalleeAnalysisDeclContext() const {
const Decl *D = getDecl();
if (!D)
  return nullptr;

// TODO: For now we skip functions without definitions, even if we have
// our own getDecl(), because it's hard to find out which re-declaration
// is going to be used, and usually clients don't really care about this
// situation because there's a loss of precision anyway because we cannot
// inline the call.
RuntimeDefinition RD = getRuntimeDefinition();
if (!RD.getDecl())
  return nullptr;

AnalysisDeclContext *ADC =
    LCtx->getAnalysisDeclContext()->getManager()->getContext(D);

// TODO: For now we skip virtual functions, because this also rises
// the problem of which decl to use, but now it's across different classes.
if (RD.mayHaveOtherDefinitions() || RD.getDecl() != ADC->getDecl())
  return nullptr;

return ADC;
192}

194const StackFrameContext *CallEvent::getCalleeStackFrame() const {
AnalysisDeclContext *ADC = getCalleeAnalysisDeclContext();
if (!ADC)
  return nullptr;

const Expr *E = getOriginExpr();
if (!E)
  return nullptr;

// Recover CFG block via reverse lookup.
// TODO: If we were to keep CFG element information as part of the CallEvent
// instead of doing this reverse lookup, we would be able to build the stack
// frame for non-expression-based calls, and also we wouldn't need the reverse
// lookup.
CFGStmtMap *Map = LCtx->getAnalysisDeclContext()->getCFGStmtMap();
const CFGBlock *B = Map->getBlock(E);
assert(B)((B) ? static_cast<void> (0) : __assert_fail ("B", "/build/llvm-toolchain-snapshot-9~svn362543/tools/clang/lib/StaticAnalyzer/Core/CallEvent.cpp"
, 210, __PRETTY_FUNCTION__));

// Also recover CFG index by scanning the CFG block.
unsigned Idx = 0, Sz = B->size();
for (; Idx < Sz; ++Idx)
  if (auto StmtElem = (*B)[Idx].getAs<CFGStmt>())
    if (StmtElem->getStmt() == E)
      break;
assert(Idx < Sz)((Idx < Sz) ? static_cast<void> (0) : __assert_fail (
"Idx < Sz", "/build/llvm-toolchain-snapshot-9~svn362543/tools/clang/lib/StaticAnalyzer/Core/CallEvent.cpp"
, 218, __PRETTY_FUNCTION__));

return ADC->getManager()->getStackFrame(ADC, LCtx, E, B, Idx);
221}

223const VarRegion *CallEvent::getParameterLocation(unsigned Index) const {
const StackFrameContext *SFC = getCalleeStackFrame();
// We cannot construct a VarRegion without a stack frame.
if (!SFC)
  return nullptr;

// Retrieve parameters of the definition, which are different from
// CallEvent's parameters() because getDecl() isn't necessarily
// the definition. SFC contains the definition that would be used
// during analysis.
const Decl *D = SFC->getDecl();

// TODO: Refactor into a virtual method of CallEvent, like parameters().
const ParmVarDecl *PVD = nullptr;
if (const auto *FD = dyn_cast<FunctionDecl>(D))
  PVD = FD->parameters()[Index];
else if (const auto *BD = dyn_cast<BlockDecl>(D))
  PVD = BD->parameters()[Index];
else if (const auto *MD = dyn_cast<ObjCMethodDecl>(D))
  PVD = MD->parameters()[Index];
else if (const auto *CD = dyn_cast<CXXConstructorDecl>(D))
  PVD = CD->parameters()[Index];
assert(PVD && "Unexpected Decl kind!")((PVD && "Unexpected Decl kind!") ? static_cast<void
> (0) : __assert_fail ("PVD && \"Unexpected Decl kind!\""
, "/build/llvm-toolchain-snapshot-9~svn362543/tools/clang/lib/StaticAnalyzer/Core/CallEvent.cpp"
, 245, __PRETTY_FUNCTION__));

const VarRegion *VR =
    State->getStateManager().getRegionManager().getVarRegion(PVD, SFC);

// This sanity check would fail if our parameter declaration doesn't
// correspond to the stack frame's function declaration.
assert(VR->getStackFrame() == SFC)((VR->getStackFrame() == SFC) ? static_cast<void> (0
) : __assert_fail ("VR->getStackFrame() == SFC", "/build/llvm-toolchain-snapshot-9~svn362543/tools/clang/lib/StaticAnalyzer/Core/CallEvent.cpp"
, 252, __PRETTY_FUNCTION__));

return VR;
255}

257/// Returns true if a type is a pointer-to-const or reference-to-const
258/// with no further indirection.
259static bool isPointerToConst(QualType Ty) {
QualType PointeeTy = Ty->getPointeeType();
if (PointeeTy == QualType())
  return false;
if (!PointeeTy.isConstQualified())
  return false;
if (PointeeTy->isAnyPointerType())
  return false;
return true;
268}

270// Try to retrieve the function declaration and find the function parameter
271// types which are pointers/references to a non-pointer const.
272// We will not invalidate the corresponding argument regions.
273static void findPtrToConstParams(llvm::SmallSet<unsigned, 4> &PreserveArgs,
                               const CallEvent &Call) {
unsigned Idx = 0;
for (CallEvent::param_type_iterator I = Call.param_type_begin(),
                                    E = Call.param_type_end();
     I != E; ++I, ++Idx) {
  if (isPointerToConst(*I))
    PreserveArgs.insert(Idx);
}
282}

284ProgramStateRef CallEvent::invalidateRegions(unsigned BlockCount,
                                           ProgramStateRef Orig) const {
ProgramStateRef Result = (Orig ? Orig : getState());

// Don't invalidate anything if the callee is marked pure/const.
if (const Decl *callee = getDecl())
  if (callee->hasAttr<PureAttr>() || callee->hasAttr<ConstAttr>())
    return Result;

SmallVector<SVal, 8> ValuesToInvalidate;
RegionAndSymbolInvalidationTraits ETraits;

getExtraInvalidatedValues(ValuesToInvalidate, &ETraits);

// Indexes of arguments whose values will be preserved by the call.
llvm::SmallSet<unsigned, 4> PreserveArgs;
if (!argumentsMayEscape())
  findPtrToConstParams(PreserveArgs, *this);

for (unsigned Idx = 0, Count = getNumArgs(); Idx != Count; ++Idx) {
  // Mark this region for invalidation.  We batch invalidate regions
  // below for efficiency.
  if (PreserveArgs.count(Idx))
    if (const MemRegion *MR = getArgSVal(Idx).getAsRegion())
      ETraits.setTrait(MR->getBaseRegion(),
                      RegionAndSymbolInvalidationTraits::TK_PreserveContents);
      // TODO: Factor this out + handle the lower level const pointers.

  ValuesToInvalidate.push_back(getArgSVal(Idx));

  // If a function accepts an object by argument (which would of course be a
  // temporary that isn't lifetime-extended), invalidate the object itself,
  // not only other objects reachable from it. This is necessary because the
  // destructor has access to the temporary object after the call.
  // TODO: Support placement arguments once we start
  // constructing them directly.
  // TODO: This is unnecessary when there's no destructor, but that's
  // currently hard to figure out.
  if (getKind() != CE_CXXAllocator)
    if (isArgumentConstructedDirectly(Idx))
      if (auto AdjIdx = getAdjustedParameterIndex(Idx))
        if (const VarRegion *VR = getParameterLocation(*AdjIdx))
          ValuesToInvalidate.push_back(loc::MemRegionVal(VR));
}

// Invalidate designated regions using the batch invalidation API.
// NOTE: Even if RegionsToInvalidate is empty, we may still invalidate
//  global variables.
return Result->invalidateRegions(ValuesToInvalidate, getOriginExpr(),
                                 BlockCount, getLocationContext(),
                                 /*CausedByPointerEscape*/ true,
                                 /*Symbols=*/nullptr, this, &ETraits);
336}

338ProgramPoint CallEvent::getProgramPoint(bool IsPreVisit,
                                      const ProgramPointTag *Tag) const {
if (const Expr *E = getOriginExpr()) {
  if (IsPreVisit)
    return PreStmt(E, getLocationContext(), Tag);
  return PostStmt(E, getLocationContext(), Tag);
}

const Decl *D = getDecl();
assert(D && "Cannot get a program point without a statement or decl")((D && "Cannot get a program point without a statement or decl"
) ? static_cast<void> (0) : __assert_fail ("D && \"Cannot get a program point without a statement or decl\""
, "/build/llvm-toolchain-snapshot-9~svn362543/tools/clang/lib/StaticAnalyzer/Core/CallEvent.cpp"
, 347, __PRETTY_FUNCTION__));

SourceLocation Loc = getSourceRange().getBegin();
if (IsPreVisit)
  return PreImplicitCall(D, Loc, getLocationContext(), Tag);
return PostImplicitCall(D, Loc, getLocationContext(), Tag);
353}

355bool CallEvent::isCalled(const CallDescription &CD) const {
// FIXME: Add ObjC Message support.
if (getKind() == CE_ObjCMessage)
  return false;
if (!CD.IsLookupDone) {
  CD.IsLookupDone = true;
  CD.II = &getState()->getStateManager().getContext().Idents.get(
      CD.getFunctionName());
}
const IdentifierInfo *II = getCalleeIdentifier();
if (!II || II != CD.II)
  return false;

const Decl *D = getDecl();
// If CallDescription provides prefix names, use them to improve matching
// accuracy.
if (CD.QualifiedName.size() > 1 && D) {
  const DeclContext *Ctx = D->getDeclContext();
  // See if we'll be able to match them all.
  size_t NumUnmatched = CD.QualifiedName.size() - 1;
  for (; Ctx && isa<NamedDecl>(Ctx); Ctx = Ctx->getParent()) {
    if (NumUnmatched == 0)
      break;

    if (const auto *ND = dyn_cast<NamespaceDecl>(Ctx)) {
      if (ND->getName() == CD.QualifiedName[NumUnmatched - 1])
        --NumUnmatched;
      continue;
    }

    if (const auto *RD = dyn_cast<RecordDecl>(Ctx)) {
      if (RD->getName() == CD.QualifiedName[NumUnmatched - 1])
        --NumUnmatched;
      continue;
    }
  }

  if (NumUnmatched > 0)
    return false;
}

return (CD.RequiredArgs == CallDescription::NoArgRequirement ||
        CD.RequiredArgs == getNumArgs());
398}

400SVal CallEvent::getArgSVal(unsigned Index) const {
const Expr *ArgE = getArgExpr(Index);
if (!ArgE)
  return UnknownVal();
return getSVal(ArgE);
405}

407SourceRange CallEvent::getArgSourceRange(unsigned Index) const {
const Expr *ArgE = getArgExpr(Index);
if (!ArgE)
  return {};
return ArgE->getSourceRange();
412}

414SVal CallEvent::getReturnValue() const {
const Expr *E = getOriginExpr();
if (!E)
  return UndefinedVal();
return getSVal(E);
419}

421LLVM_DUMP_METHOD__attribute__((noinline)) __attribute__((__used__)) void CallEvent::dump() const { dump(llvm::errs()); }

423void CallEvent::dump(raw_ostream &Out) const {
ASTContext &Ctx = getState()->getStateManager().getContext();
if (const Expr *E = getOriginExpr()) {
  E->printPretty(Out, nullptr, Ctx.getPrintingPolicy());
  Out << "\n";
  return;
}

if (const Decl *D = getDecl()) {
  Out << "Call to ";
  D->print(Out, Ctx.getPrintingPolicy());
  return;
}

// FIXME: a string representation of the kind would be nice.
Out << "Unknown call (type " << getKind() << ")";
439}

441bool CallEvent::isCallStmt(const Stmt *S) {
return isa<CallExpr>(S) || isa<ObjCMessageExpr>(S)
                        || isa<CXXConstructExpr>(S)
                        || isa<CXXNewExpr>(S);
445}

447QualType CallEvent::getDeclaredResultType(const Decl *D) {
assert(D)((D) ? static_cast<void> (0) : __assert_fail ("D", "/build/llvm-toolchain-snapshot-9~svn362543/tools/clang/lib/StaticAnalyzer/Core/CallEvent.cpp"
, 448, __PRETTY_FUNCTION__));
if (const auto *FD = dyn_cast<FunctionDecl>(D))
  return FD->getReturnType();
if (const auto *MD = dyn_cast<ObjCMethodDecl>(D))
  return MD->getReturnType();
if (const auto *BD = dyn_cast<BlockDecl>(D)) {
  // Blocks are difficult because the return type may not be stored in the
  // BlockDecl itself. The AST should probably be enhanced, but for now we
  // just do what we can.
  // If the block is declared without an explicit argument list, the
  // signature-as-written just includes the return type, not the entire
  // function type.
  // FIXME: All blocks should have signatures-as-written, even if the return
  // type is inferred. (That's signified with a dependent result type.)
  if (const TypeSourceInfo *TSI = BD->getSignatureAsWritten()) {
    QualType Ty = TSI->getType();
    if (const FunctionType *FT = Ty->getAs<FunctionType>())
      Ty = FT->getReturnType();
    if (!Ty->isDependentType())
      return Ty;
  }

  return {};
}

llvm_unreachable("unknown callable kind")::llvm::llvm_unreachable_internal("unknown callable kind", "/build/llvm-toolchain-snapshot-9~svn362543/tools/clang/lib/StaticAnalyzer/Core/CallEvent.cpp"
, 473);
474}

476bool CallEvent::isVariadic(const Decl *D) {
assert(D)((D) ? static_cast<void> (0) : __assert_fail ("D", "/build/llvm-toolchain-snapshot-9~svn362543/tools/clang/lib/StaticAnalyzer/Core/CallEvent.cpp"
, 477, __PRETTY_FUNCTION__));

if (const auto *FD = dyn_cast<FunctionDecl>(D))
  return FD->isVariadic();
if (const auto *MD = dyn_cast<ObjCMethodDecl>(D))
  return MD->isVariadic();
if (const auto *BD = dyn_cast<BlockDecl>(D))
  return BD->isVariadic();

llvm_unreachable("unknown callable kind")::llvm::llvm_unreachable_internal("unknown callable kind", "/build/llvm-toolchain-snapshot-9~svn362543/tools/clang/lib/StaticAnalyzer/Core/CallEvent.cpp"
, 486);
487}

489static void addParameterValuesToBindings(const StackFrameContext *CalleeCtx,
                                       CallEvent::BindingsTy &Bindings,
                                       SValBuilder &SVB,
                                       const CallEvent &Call,
                                       ArrayRef<ParmVarDecl*> parameters) {
MemRegionManager &MRMgr = SVB.getRegionManager();

// If the function has fewer parameters than the call has arguments, we simply
// do not bind any values to them.
unsigned NumArgs = Call.getNumArgs();
unsigned Idx = 0;
ArrayRef<ParmVarDecl*>::iterator I = parameters.begin(), E = parameters.end();
for (; I != E && Idx < NumArgs; ++I, ++Idx) {
  const ParmVarDecl *ParamDecl = *I;
  assert(ParamDecl && "Formal parameter has no decl?")((ParamDecl && "Formal parameter has no decl?") ? static_cast
<void> (0) : __assert_fail ("ParamDecl && \"Formal parameter has no decl?\""
, "/build/llvm-toolchain-snapshot-9~svn362543/tools/clang/lib/StaticAnalyzer/Core/CallEvent.cpp"
, 503, __PRETTY_FUNCTION__));

  // TODO: Support allocator calls.
  if (Call.getKind() != CE_CXXAllocator)
    if (Call.isArgumentConstructedDirectly(Idx))
      continue;

  // TODO: Allocators should receive the correct size and possibly alignment,
  // determined in compile-time but not represented as arg-expressions,
  // which makes getArgSVal() fail and return UnknownVal.
  SVal ArgVal = Call.getArgSVal(Idx);
  if (!ArgVal.isUnknown()) {
    Loc ParamLoc = SVB.makeLoc(MRMgr.getVarRegion(ParamDecl, CalleeCtx));
    Bindings.push_back(std::make_pair(ParamLoc, ArgVal));
  }
}

// FIXME: Variadic arguments are not handled at all right now.
521}

523ArrayRef<ParmVarDecl*> AnyFunctionCall::parameters() const {
const FunctionDecl *D = getDecl();
if (!D)
  return None;
return D->parameters();
528}

530RuntimeDefinition AnyFunctionCall::getRuntimeDefinition() const {
const FunctionDecl *FD = getDecl();
if (!FD)
8
←
Assuming 'FD' is non-null→
9
←
Taking false branch→
  return {};

// Note that the AnalysisDeclContext will have the FunctionDecl with
// the definition (if one exists).
AnalysisDeclContext *AD =
  getLocationContext()->getAnalysisDeclContext()->
  getManager()->getContext(FD);
bool IsAutosynthesized;
Stmt* Body = AD->getBody(IsAutosynthesized);
LLVM_DEBUG({do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("static-analyzer-call-event")) { { if (IsAutosynthesized) llvm
::dbgs() << "Using autosynthesized body for " << FD
->getName() << "\n"; }; } } while (false)
10
←
Assuming 'DebugFlag' is 0→
11
←
Loop condition is false.  Exiting loop→
  if (IsAutosynthesized)do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("static-analyzer-call-event")) { { if (IsAutosynthesized) llvm
::dbgs() << "Using autosynthesized body for " << FD
->getName() << "\n"; }; } } while (false)
    llvm::dbgs() << "Using autosynthesized body for " << FD->getName()do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("static-analyzer-call-event")) { { if (IsAutosynthesized) llvm
::dbgs() << "Using autosynthesized body for " << FD
->getName() << "\n"; }; } } while (false)
                 << "\n";do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("static-analyzer-call-event")) { { if (IsAutosynthesized) llvm
::dbgs() << "Using autosynthesized body for " << FD
->getName() << "\n"; }; } } while (false)
})do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("static-analyzer-call-event")) { { if (IsAutosynthesized) llvm
::dbgs() << "Using autosynthesized body for " << FD
->getName() << "\n"; }; } } while (false);
if (Body) {
12
←
Assuming 'Body' is null→
13
←
Taking false branch→
  const Decl* Decl = AD->getDecl();
  return RuntimeDefinition(Decl);
}

SubEngine &Engine = getState()->getStateManager().getOwningEngine();
AnalyzerOptions &Opts = Engine.getAnalysisManager().options;

// Try to get CTU definition only if CTUDir is provided.
if (!Opts.IsNaiveCTUEnabled)
14
←
Assuming the condition is false→
15
←
Taking false branch→
  return {};

cross_tu::CrossTranslationUnitContext &CTUCtx =
    *Engine.getCrossTranslationUnitContext();
llvm::Expected<const FunctionDecl *> CTUDeclOrError =
    CTUCtx.getCrossTUDefinition(FD, Opts.CTUDir, Opts.CTUIndexName,
                                Opts.DisplayCTUProgress);

if (!CTUDeclOrError) {
16
←
Taking true branch→
  handleAllErrors(CTUDeclOrError.takeError(),
17
←
Calling 'handleAllErrors<(lambda at /build/llvm-toolchain-snapshot-9~svn362543/tools/clang/lib/StaticAnalyzer/Core/CallEvent.cpp:567:21)>'→
                  [&](const cross_tu::IndexError &IE) {
                    CTUCtx.emitCrossTUDiagnostics(IE);
                  });
  return {};
}

return RuntimeDefinition(*CTUDeclOrError);
574}

576void AnyFunctionCall::getInitialStackFrameContents(
                                      const StackFrameContext *CalleeCtx,
                                      BindingsTy &Bindings) const {
const auto *D = cast<FunctionDecl>(CalleeCtx->getDecl());
SValBuilder &SVB = getState()->getStateManager().getSValBuilder();
addParameterValuesToBindings(CalleeCtx, Bindings, SVB, *this,
                             D->parameters());
583}

585bool AnyFunctionCall::argumentsMayEscape() const {
if (CallEvent::argumentsMayEscape() || hasVoidPointerToNonConstArg())
  return true;

const FunctionDecl *D = getDecl();
if (!D)
  return true;

const IdentifierInfo *II = D->getIdentifier();
if (!II)
  return false;

// This set of "escaping" APIs is

// - 'int pthread_setspecific(ptheread_key k, const void *)' stores a
//   value into thread local storage. The value can later be retrieved with
//   'void *ptheread_getspecific(pthread_key)'. So even thought the
//   parameter is 'const void *', the region escapes through the call.
if (II->isStr("pthread_setspecific"))
  return true;

// - xpc_connection_set_context stores a value which can be retrieved later
//   with xpc_connection_get_context.
if (II->isStr("xpc_connection_set_context"))
  return true;

// - funopen - sets a buffer for future IO calls.
if (II->isStr("funopen"))
  return true;

// - __cxa_demangle - can reallocate memory and can return the pointer to
// the input buffer.
if (II->isStr("__cxa_demangle"))
  return true;

StringRef FName = II->getName();

// - CoreFoundation functions that end with "NoCopy" can free a passed-in
//   buffer even if it is const.
if (FName.endswith("NoCopy"))
  return true;

// - NSXXInsertXX, for example NSMapInsertIfAbsent, since they can
//   be deallocated by NSMapRemove.
if (FName.startswith("NS") && (FName.find("Insert") != StringRef::npos))
  return true;

// - Many CF containers allow objects to escape through custom
//   allocators/deallocators upon container construction. (PR12101)
if (FName.startswith("CF") || FName.startswith("CG")) {
  return StrInStrNoCase(FName, "InsertValue")  != StringRef::npos ||
         StrInStrNoCase(FName, "AddValue")     != StringRef::npos ||
         StrInStrNoCase(FName, "SetValue")     != StringRef::npos ||
         StrInStrNoCase(FName, "WithData")     != StringRef::npos ||
         StrInStrNoCase(FName, "AppendValue")  != StringRef::npos ||
         StrInStrNoCase(FName, "SetAttribute") != StringRef::npos;
}

return false;
644}

646const FunctionDecl *SimpleFunctionCall::getDecl() const {
const FunctionDecl *D = getOriginExpr()->getDirectCallee();
if (D)
  return D;

return getSVal(getOriginExpr()->getCallee()).getAsFunctionDecl();
652}

654const FunctionDecl *CXXInstanceCall::getDecl() const {
const auto *CE = cast_or_null<CallExpr>(getOriginExpr());
if (!CE)
  return AnyFunctionCall::getDecl();

const FunctionDecl *D = CE->getDirectCallee();
if (D)
  return D;

return getSVal(CE->getCallee()).getAsFunctionDecl();
664}

666void CXXInstanceCall::getExtraInvalidatedValues(
  ValueList &Values, RegionAndSymbolInvalidationTraits *ETraits) const {
SVal ThisVal = getCXXThisVal();
Values.push_back(ThisVal);

// Don't invalidate if the method is const and there are no mutable fields.
if (const auto *D = cast_or_null<CXXMethodDecl>(getDecl())) {
  if (!D->isConst())
    return;
  // Get the record decl for the class of 'This'. D->getParent() may return a
  // base class decl, rather than the class of the instance which needs to be
  // checked for mutable fields.
  // TODO: We might as well look at the dynamic type of the object.
  const Expr *Ex = getCXXThisExpr()->ignoreParenBaseCasts();
  QualType T = Ex->getType();
  if (T->isPointerType()) // Arrow or implicit-this syntax?
    T = T->getPointeeType();
  const CXXRecordDecl *ParentRecord = T->getAsCXXRecordDecl();
  assert(ParentRecord)((ParentRecord) ? static_cast<void> (0) : __assert_fail
 ("ParentRecord", "/build/llvm-toolchain-snapshot-9~svn362543/tools/clang/lib/StaticAnalyzer/Core/CallEvent.cpp"
, 684, __PRETTY_FUNCTION__));
  if (ParentRecord->hasMutableFields())
    return;
  // Preserve CXXThis.
  const MemRegion *ThisRegion = ThisVal.getAsRegion();
  if (!ThisRegion)
    return;

  ETraits->setTrait(ThisRegion->getBaseRegion(),
                    RegionAndSymbolInvalidationTraits::TK_PreserveContents);
}
695}

697SVal CXXInstanceCall::getCXXThisVal() const {
const Expr *Base = getCXXThisExpr();
// FIXME: This doesn't handle an overloaded ->* operator.
if (!Base)
  return UnknownVal();

SVal ThisVal = getSVal(Base);
assert(ThisVal.isUnknownOrUndef() || ThisVal.getAs<Loc>())((ThisVal.isUnknownOrUndef() || ThisVal.getAs<Loc>()) ?
 static_cast<void> (0) : __assert_fail ("ThisVal.isUnknownOrUndef() || ThisVal.getAs<Loc>()"
, "/build/llvm-toolchain-snapshot-9~svn362543/tools/clang/lib/StaticAnalyzer/Core/CallEvent.cpp"
, 704, __PRETTY_FUNCTION__));
return ThisVal;
706}

708RuntimeDefinition CXXInstanceCall::getRuntimeDefinition() const {
// Do we have a decl at all?
const Decl *D = getDecl();
if (!D)
4
←
Assuming 'D' is non-null→
5
←
Taking false branch→
  return {};

// If the method is non-virtual, we know we can inline it.
const auto *MD = cast<CXXMethodDecl>(D);
if (!MD->isVirtual())
6
←
Taking true branch→
  return AnyFunctionCall::getRuntimeDefinition();
7
←
Calling 'AnyFunctionCall::getRuntimeDefinition'→

// Do we know the implicit 'this' object being called?
const MemRegion *R = getCXXThisVal().getAsRegion();
if (!R)
  return {};

// Do we know anything about the type of 'this'?
DynamicTypeInfo DynType = getDynamicTypeInfo(getState(), R);
if (!DynType.isValid())
  return {};

// Is the type a C++ class? (This is mostly a defensive check.)
QualType RegionType = DynType.getType()->getPointeeType();
assert(!RegionType.isNull() && "DynamicTypeInfo should always be a pointer.")((!RegionType.isNull() && "DynamicTypeInfo should always be a pointer."
) ? static_cast<void> (0) : __assert_fail ("!RegionType.isNull() && \"DynamicTypeInfo should always be a pointer.\""
, "/build/llvm-toolchain-snapshot-9~svn362543/tools/clang/lib/StaticAnalyzer/Core/CallEvent.cpp"
, 731, __PRETTY_FUNCTION__));

const CXXRecordDecl *RD = RegionType->getAsCXXRecordDecl();
if (!RD || !RD->hasDefinition())
  return {};

// Find the decl for this method in that class.
const CXXMethodDecl *Result = MD->getCorrespondingMethodInClass(RD, true);
if (!Result) {
  // We might not even get the original statically-resolved method due to
  // some particularly nasty casting (e.g. casts to sister classes).
  // However, we should at least be able to search up and down our own class
  // hierarchy, and some real bugs have been caught by checking this.
  assert(!RD->isDerivedFrom(MD->getParent()) && "Couldn't find known method")((!RD->isDerivedFrom(MD->getParent()) && "Couldn't find known method"
) ? static_cast<void> (0) : __assert_fail ("!RD->isDerivedFrom(MD->getParent()) && \"Couldn't find known method\""
, "/build/llvm-toolchain-snapshot-9~svn362543/tools/clang/lib/StaticAnalyzer/Core/CallEvent.cpp"
, 744, __PRETTY_FUNCTION__));

  // FIXME: This is checking that our DynamicTypeInfo is at least as good as
  // the static type. However, because we currently don't update
  // DynamicTypeInfo when an object is cast, we can't actually be sure the
  // DynamicTypeInfo is up to date. This assert should be re-enabled once
  // this is fixed. <rdar://problem/12287087>
  //assert(!MD->getParent()->isDerivedFrom(RD) && "Bad DynamicTypeInfo");

  return {};
}

// Does the decl that we found have an implementation?
const FunctionDecl *Definition;
if (!Result->hasBody(Definition))
  return {};

// We found a definition. If we're not sure that this devirtualization is
// actually what will happen at runtime, make sure to provide the region so
// that ExprEngine can decide what to do with it.
if (DynType.canBeASubClass())
  return RuntimeDefinition(Definition, R->StripCasts());
return RuntimeDefinition(Definition, /*DispatchRegion=*/nullptr);
767}

769void CXXInstanceCall::getInitialStackFrameContents(
                                          const StackFrameContext *CalleeCtx,
                                          BindingsTy &Bindings) const {
AnyFunctionCall::getInitialStackFrameContents(CalleeCtx, Bindings);

// Handle the binding of 'this' in the new stack frame.
SVal ThisVal = getCXXThisVal();
if (!ThisVal.isUnknown()) {
  ProgramStateManager &StateMgr = getState()->getStateManager();
  SValBuilder &SVB = StateMgr.getSValBuilder();

  const auto *MD = cast<CXXMethodDecl>(CalleeCtx->getDecl());
  Loc ThisLoc = SVB.getCXXThis(MD, CalleeCtx);

  // If we devirtualized to a different member function, we need to make sure
  // we have the proper layering of CXXBaseObjectRegions.
  if (MD->getCanonicalDecl() != getDecl()->getCanonicalDecl()) {
    ASTContext &Ctx = SVB.getContext();
    const CXXRecordDecl *Class = MD->getParent();
    QualType Ty = Ctx.getPointerType(Ctx.getRecordType(Class));

    // FIXME: CallEvent maybe shouldn't be directly accessing StoreManager.
    bool Failed;
    ThisVal = StateMgr.getStoreManager().attemptDownCast(ThisVal, Ty, Failed);
    if (Failed) {
      // We might have suffered some sort of placement new earlier, so
      // we're constructing in a completely unexpected storage.
      // Fall back to a generic pointer cast for this-value.
      const CXXMethodDecl *StaticMD = cast<CXXMethodDecl>(getDecl());
      const CXXRecordDecl *StaticClass = StaticMD->getParent();
      QualType StaticTy = Ctx.getPointerType(Ctx.getRecordType(StaticClass));
      ThisVal = SVB.evalCast(ThisVal, Ty, StaticTy);
    }
  }

  if (!ThisVal.isUnknown())
    Bindings.push_back(std::make_pair(ThisLoc, ThisVal));
}
807}

809const Expr *CXXMemberCall::getCXXThisExpr() const {
return getOriginExpr()->getImplicitObjectArgument();
811}

813RuntimeDefinition CXXMemberCall::getRuntimeDefinition() const {
// C++11 [expr.call]p1: ...If the selected function is non-virtual, or if the
// id-expression in the class member access expression is a qualified-id,
// that function is called. Otherwise, its final overrider in the dynamic type
// of the object expression is called.
if (const auto *ME = dyn_cast<MemberExpr>(getOriginExpr()->getCallee()))
  if (ME->hasQualifier())
    return AnyFunctionCall::getRuntimeDefinition();

return CXXInstanceCall::getRuntimeDefinition();
823}

825const Expr *CXXMemberOperatorCall::getCXXThisExpr() const {
return getOriginExpr()->getArg(0);
827}

829const BlockDataRegion *BlockCall::getBlockRegion() const {
const Expr *Callee = getOriginExpr()->getCallee();
const MemRegion *DataReg = getSVal(Callee).getAsRegion();

return dyn_cast_or_null<BlockDataRegion>(DataReg);
834}

836ArrayRef<ParmVarDecl*> BlockCall::parameters() const {
const BlockDecl *D = getDecl();
if (!D)
  return None;
return D->parameters();
841}

843void BlockCall::getExtraInvalidatedValues(ValueList &Values,
                RegionAndSymbolInvalidationTraits *ETraits) const {
// FIXME: This also needs to invalidate captured globals.
if (const MemRegion *R = getBlockRegion())
  Values.push_back(loc::MemRegionVal(R));
848}

850void BlockCall::getInitialStackFrameContents(const StackFrameContext *CalleeCtx,
                                           BindingsTy &Bindings) const {
SValBuilder &SVB = getState()->getStateManager().getSValBuilder();
ArrayRef<ParmVarDecl*> Params;
if (isConversionFromLambda()) {
  auto *LambdaOperatorDecl = cast<CXXMethodDecl>(CalleeCtx->getDecl());
  Params = LambdaOperatorDecl->parameters();

  // For blocks converted from a C++ lambda, the callee declaration is the
  // operator() method on the lambda so we bind "this" to
  // the lambda captured by the block.
  const VarRegion *CapturedLambdaRegion = getRegionStoringCapturedLambda();
  SVal ThisVal = loc::MemRegionVal(CapturedLambdaRegion);
  Loc ThisLoc = SVB.getCXXThis(LambdaOperatorDecl, CalleeCtx);
  Bindings.push_back(std::make_pair(ThisLoc, ThisVal));
} else {
  Params = cast<BlockDecl>(CalleeCtx->getDecl())->parameters();
}

addParameterValuesToBindings(CalleeCtx, Bindings, SVB, *this,
                             Params);
871}

873SVal CXXConstructorCall::getCXXThisVal() const {
if (Data)
  return loc::MemRegionVal(static_cast<const MemRegion *>(Data));
return UnknownVal();
877}

879void CXXConstructorCall::getExtraInvalidatedValues(ValueList &Values,
                         RegionAndSymbolInvalidationTraits *ETraits) const {
if (Data) {
  loc::MemRegionVal MV(static_cast<const MemRegion *>(Data));
  if (SymbolRef Sym = MV.getAsSymbol(true))
    ETraits->setTrait(Sym,
                      RegionAndSymbolInvalidationTraits::TK_SuppressEscape);
  Values.push_back(MV);
}
888}

890void CXXConstructorCall::getInitialStackFrameContents(
                                           const StackFrameContext *CalleeCtx,
                                           BindingsTy &Bindings) const {
AnyFunctionCall::getInitialStackFrameContents(CalleeCtx, Bindings);

SVal ThisVal = getCXXThisVal();
if (!ThisVal.isUnknown()) {
  SValBuilder &SVB = getState()->getStateManager().getSValBuilder();
  const auto *MD = cast<CXXMethodDecl>(CalleeCtx->getDecl());
  Loc ThisLoc = SVB.getCXXThis(MD, CalleeCtx);
  Bindings.push_back(std::make_pair(ThisLoc, ThisVal));
}
902}

904SVal CXXDestructorCall::getCXXThisVal() const {
if (Data)
  return loc::MemRegionVal(DtorDataTy::getFromOpaqueValue(Data).getPointer());
return UnknownVal();
908}

910RuntimeDefinition CXXDestructorCall::getRuntimeDefinition() const {
// Base destructors are always called non-virtually.
// Skip CXXInstanceCall's devirtualization logic in this case.
if (isBaseDestructor())
1
Assuming the condition is false→
2
←
Taking false branch→
  return AnyFunctionCall::getRuntimeDefinition();

return CXXInstanceCall::getRuntimeDefinition();
3
←
Calling 'CXXInstanceCall::getRuntimeDefinition'→
917}

919ArrayRef<ParmVarDecl*> ObjCMethodCall::parameters() const {
const ObjCMethodDecl *D = getDecl();
if (!D)
  return None;
return D->parameters();
924}

926void ObjCMethodCall::getExtraInvalidatedValues(
  ValueList &Values, RegionAndSymbolInvalidationTraits *ETraits) const {

// If the method call is a setter for property known to be backed by
// an instance variable, don't invalidate the entire receiver, just
// the storage for that instance variable.
if (const ObjCPropertyDecl *PropDecl = getAccessedProperty()) {
  if (const ObjCIvarDecl *PropIvar = PropDecl->getPropertyIvarDecl()) {
    SVal IvarLVal = getState()->getLValue(PropIvar, getReceiverSVal());
    if (const MemRegion *IvarRegion = IvarLVal.getAsRegion()) {
      ETraits->setTrait(
        IvarRegion,
        RegionAndSymbolInvalidationTraits::TK_DoNotInvalidateSuperRegion);
      ETraits->setTrait(
        IvarRegion,
        RegionAndSymbolInvalidationTraits::TK_SuppressEscape);
      Values.push_back(IvarLVal);
    }
    return;
  }
}

Values.push_back(getReceiverSVal());
949}

951SVal ObjCMethodCall::getSelfSVal() const {
const LocationContext *LCtx = getLocationContext();
const ImplicitParamDecl *SelfDecl = LCtx->getSelfDecl();
if (!SelfDecl)
  return SVal();
return getState()->getSVal(getState()->getRegion(SelfDecl, LCtx));
957}

959SVal ObjCMethodCall::getReceiverSVal() const {
// FIXME: Is this the best way to handle class receivers?
if (!isInstanceMessage())
  return UnknownVal();

if (const Expr *RecE = getOriginExpr()->getInstanceReceiver())
  return getSVal(RecE);

// An instance message with no expression means we are sending to super.
// In this case the object reference is the same as 'self'.
assert(getOriginExpr()->getReceiverKind() == ObjCMessageExpr::SuperInstance)((getOriginExpr()->getReceiverKind() == ObjCMessageExpr::SuperInstance
) ? static_cast<void> (0) : __assert_fail ("getOriginExpr()->getReceiverKind() == ObjCMessageExpr::SuperInstance"
, "/build/llvm-toolchain-snapshot-9~svn362543/tools/clang/lib/StaticAnalyzer/Core/CallEvent.cpp"
, 969, __PRETTY_FUNCTION__));
SVal SelfVal = getSelfSVal();
assert(SelfVal.isValid() && "Calling super but not in ObjC method")((SelfVal.isValid() && "Calling super but not in ObjC method"
) ? static_cast<void> (0) : __assert_fail ("SelfVal.isValid() && \"Calling super but not in ObjC method\""
, "/build/llvm-toolchain-snapshot-9~svn362543/tools/clang/lib/StaticAnalyzer/Core/CallEvent.cpp"
, 971, __PRETTY_FUNCTION__));
return SelfVal;
973}

975bool ObjCMethodCall::isReceiverSelfOrSuper() const {
if (getOriginExpr()->getReceiverKind() == ObjCMessageExpr::SuperInstance ||
    getOriginExpr()->getReceiverKind() == ObjCMessageExpr::SuperClass)
    return true;

if (!isInstanceMessage())
  return false;

SVal RecVal = getSVal(getOriginExpr()->getInstanceReceiver());

return (RecVal == getSelfSVal());
986}

988SourceRange ObjCMethodCall::getSourceRange() const {
switch (getMessageKind()) {
case OCM_Message:
  return getOriginExpr()->getSourceRange();
case OCM_PropertyAccess:
case OCM_Subscript:
  return getContainingPseudoObjectExpr()->getSourceRange();
}
llvm_unreachable("unknown message kind")::llvm::llvm_unreachable_internal("unknown message kind", "/build/llvm-toolchain-snapshot-9~svn362543/tools/clang/lib/StaticAnalyzer/Core/CallEvent.cpp"
, 996);
997}

999using ObjCMessageDataTy = llvm::PointerIntPair<const PseudoObjectExpr *, 2>;

1001const PseudoObjectExpr *ObjCMethodCall::getContainingPseudoObjectExpr() const {
assert(Data && "Lazy lookup not yet performed.")((Data && "Lazy lookup not yet performed.") ? static_cast
<void> (0) : __assert_fail ("Data && \"Lazy lookup not yet performed.\""
, "/build/llvm-toolchain-snapshot-9~svn362543/tools/clang/lib/StaticAnalyzer/Core/CallEvent.cpp"
, 1002, __PRETTY_FUNCTION__));
assert(getMessageKind() != OCM_Message && "Explicit message send.")((getMessageKind() != OCM_Message && "Explicit message send."
) ? static_cast<void> (0) : __assert_fail ("getMessageKind() != OCM_Message && \"Explicit message send.\""
, "/build/llvm-toolchain-snapshot-9~svn362543/tools/clang/lib/StaticAnalyzer/Core/CallEvent.cpp"
, 1003, __PRETTY_FUNCTION__));
return ObjCMessageDataTy::getFromOpaqueValue(Data).getPointer();
1005}

1007static const Expr *
1008getSyntacticFromForPseudoObjectExpr(const PseudoObjectExpr *POE) {
const Expr *Syntactic = POE->getSyntacticForm();

// This handles the funny case of assigning to the result of a getter.
// This can happen if the getter returns a non-const reference.
if (const auto *BO = dyn_cast<BinaryOperator>(Syntactic))
  Syntactic = BO->getLHS();

return Syntactic;
1017}

1019ObjCMessageKind ObjCMethodCall::getMessageKind() const {
if (!Data) {
  // Find the parent, ignoring implicit casts.
  ParentMap &PM = getLocationContext()->getParentMap();
  const Stmt *S = PM.getParentIgnoreParenCasts(getOriginExpr());

  // Check if parent is a PseudoObjectExpr.
  if (const auto *POE = dyn_cast_or_null<PseudoObjectExpr>(S)) {
    const Expr *Syntactic = getSyntacticFromForPseudoObjectExpr(POE);

    ObjCMessageKind K;
    switch (Syntactic->getStmtClass()) {
    case Stmt::ObjCPropertyRefExprClass:
      K = OCM_PropertyAccess;
      break;
    case Stmt::ObjCSubscriptRefExprClass:
      K = OCM_Subscript;
      break;
    default:
      // FIXME: Can this ever happen?
      K = OCM_Message;
      break;
    }

    if (K != OCM_Message) {
      const_cast<ObjCMethodCall *>(this)->Data
        = ObjCMessageDataTy(POE, K).getOpaqueValue();
      assert(getMessageKind() == K)((getMessageKind() == K) ? static_cast<void> (0) : __assert_fail
 ("getMessageKind() == K", "/build/llvm-toolchain-snapshot-9~svn362543/tools/clang/lib/StaticAnalyzer/Core/CallEvent.cpp"
, 1046, __PRETTY_FUNCTION__));
      return K;
    }
  }

  const_cast<ObjCMethodCall *>(this)->Data
    = ObjCMessageDataTy(nullptr, 1).getOpaqueValue();
  assert(getMessageKind() == OCM_Message)((getMessageKind() == OCM_Message) ? static_cast<void> (
0) : __assert_fail ("getMessageKind() == OCM_Message", "/build/llvm-toolchain-snapshot-9~svn362543/tools/clang/lib/StaticAnalyzer/Core/CallEvent.cpp"
, 1053, __PRETTY_FUNCTION__));
  return OCM_Message;
}

ObjCMessageDataTy Info = ObjCMessageDataTy::getFromOpaqueValue(Data);
if (!Info.getPointer())
  return OCM_Message;
return static_cast<ObjCMessageKind>(Info.getInt());
1061}

1063const ObjCPropertyDecl *ObjCMethodCall::getAccessedProperty() const {
// Look for properties accessed with property syntax (foo.bar = ...)
if ( getMessageKind() == OCM_PropertyAccess) {
  const PseudoObjectExpr *POE = getContainingPseudoObjectExpr();
  assert(POE && "Property access without PseudoObjectExpr?")((POE && "Property access without PseudoObjectExpr?")
 ? static_cast<void> (0) : __assert_fail ("POE && \"Property access without PseudoObjectExpr?\""
, "/build/llvm-toolchain-snapshot-9~svn362543/tools/clang/lib/StaticAnalyzer/Core/CallEvent.cpp"
, 1067, __PRETTY_FUNCTION__));

  const Expr *Syntactic = getSyntacticFromForPseudoObjectExpr(POE);
  auto *RefExpr = cast<ObjCPropertyRefExpr>(Syntactic);

  if (RefExpr->isExplicitProperty())
    return RefExpr->getExplicitProperty();
}

// Look for properties accessed with method syntax ([foo setBar:...]).
const ObjCMethodDecl *MD = getDecl();
if (!MD || !MD->isPropertyAccessor())
  return nullptr;

// Note: This is potentially quite slow.
return MD->findPropertyDecl();
1083}

1085bool ObjCMethodCall::canBeOverridenInSubclass(ObjCInterfaceDecl *IDecl,
                                           Selector Sel) const {
assert(IDecl)((IDecl) ? static_cast<void> (0) : __assert_fail ("IDecl"
, "/build/llvm-toolchain-snapshot-9~svn362543/tools/clang/lib/StaticAnalyzer/Core/CallEvent.cpp"
, 1087, __PRETTY_FUNCTION__));
AnalysisManager &AMgr =
    getState()->getStateManager().getOwningEngine().getAnalysisManager();
// If the class interface is declared inside the main file, assume it is not
// subcassed.
// TODO: It could actually be subclassed if the subclass is private as well.
// This is probably very rare.
SourceLocation InterfLoc = IDecl->getEndOfDefinitionLoc();
if (InterfLoc.isValid() && AMgr.isInCodeFile(InterfLoc))
  return false;

// Assume that property accessors are not overridden.
if (getMessageKind() == OCM_PropertyAccess)
  return false;

// We assume that if the method is public (declared outside of main file) or
// has a parent which publicly declares the method, the method could be
// overridden in a subclass.

// Find the first declaration in the class hierarchy that declares
// the selector.
ObjCMethodDecl *D = nullptr;
while (true) {
  D = IDecl->lookupMethod(Sel, true);

  // Cannot find a public definition.
  if (!D)
    return false;

  // If outside the main file,
  if (D->getLocation().isValid() && !AMgr.isInCodeFile(D->getLocation()))
    return true;

  if (D->isOverriding()) {
    // Search in the superclass on the next iteration.
    IDecl = D->getClassInterface();
    if (!IDecl)
      return false;

    IDecl = IDecl->getSuperClass();
    if (!IDecl)
      return false;

    continue;
  }

  return false;
};

llvm_unreachable("The while loop should always terminate.")::llvm::llvm_unreachable_internal("The while loop should always terminate."
, "/build/llvm-toolchain-snapshot-9~svn362543/tools/clang/lib/StaticAnalyzer/Core/CallEvent.cpp"
, 1136);
1137}

1139static const ObjCMethodDecl *findDefiningRedecl(const ObjCMethodDecl *MD) {
if (!MD)
  return MD;

// Find the redeclaration that defines the method.
if (!MD->hasBody()) {
  for (auto I : MD->redecls())
    if (I->hasBody())
      MD = cast<ObjCMethodDecl>(I);
}
return MD;
1150}

1152static bool isCallToSelfClass(const ObjCMessageExpr *ME) {
const Expr* InstRec = ME->getInstanceReceiver();
if (!InstRec)
  return false;
const auto *InstRecIg = dyn_cast<DeclRefExpr>(InstRec->IgnoreParenImpCasts());

// Check that receiver is called 'self'.
if (!InstRecIg || !InstRecIg->getFoundDecl() ||
    !InstRecIg->getFoundDecl()->getName().equals("self"))
  return false;

// Check that the method name is 'class'.
if (ME->getSelector().getNumArgs() != 0 ||
    !ME->getSelector().getNameForSlot(0).equals("class"))
  return false;

return true;
1169}

1171RuntimeDefinition ObjCMethodCall::getRuntimeDefinition() const {
const ObjCMessageExpr *E = getOriginExpr();
assert(E)((E) ? static_cast<void> (0) : __assert_fail ("E", "/build/llvm-toolchain-snapshot-9~svn362543/tools/clang/lib/StaticAnalyzer/Core/CallEvent.cpp"
, 1173, __PRETTY_FUNCTION__));
Selector Sel = E->getSelector();

if (E->isInstanceMessage()) {
  // Find the receiver type.
  const ObjCObjectPointerType *ReceiverT = nullptr;
  bool CanBeSubClassed = false;
  QualType SupersType = E->getSuperType();
  const MemRegion *Receiver = nullptr;

  if (!SupersType.isNull()) {
    // The receiver is guaranteed to be 'super' in this case.
    // Super always means the type of immediate predecessor to the method
    // where the call occurs.
    ReceiverT = cast<ObjCObjectPointerType>(SupersType);
  } else {
    Receiver = getReceiverSVal().getAsRegion();
    if (!Receiver)
      return {};

    DynamicTypeInfo DTI = getDynamicTypeInfo(getState(), Receiver);
    if (!DTI.isValid()) {
      assert(isa<AllocaRegion>(Receiver) &&((isa<AllocaRegion>(Receiver) && "Unhandled untyped region class!"
) ? static_cast<void> (0) : __assert_fail ("isa<AllocaRegion>(Receiver) && \"Unhandled untyped region class!\""
, "/build/llvm-toolchain-snapshot-9~svn362543/tools/clang/lib/StaticAnalyzer/Core/CallEvent.cpp"
, 1196, __PRETTY_FUNCTION__))
             "Unhandled untyped region class!")((isa<AllocaRegion>(Receiver) && "Unhandled untyped region class!"
) ? static_cast<void> (0) : __assert_fail ("isa<AllocaRegion>(Receiver) && \"Unhandled untyped region class!\""
, "/build/llvm-toolchain-snapshot-9~svn362543/tools/clang/lib/StaticAnalyzer/Core/CallEvent.cpp"
, 1196, __PRETTY_FUNCTION__));
      return {};
    }

    QualType DynType = DTI.getType();
    CanBeSubClassed = DTI.canBeASubClass();
    ReceiverT = dyn_cast<ObjCObjectPointerType>(DynType.getCanonicalType());

    if (ReceiverT && CanBeSubClassed)
      if (ObjCInterfaceDecl *IDecl = ReceiverT->getInterfaceDecl())
        if (!canBeOverridenInSubclass(IDecl, Sel))
          CanBeSubClassed = false;
  }

  // Handle special cases of '[self classMethod]' and
  // '[[self class] classMethod]', which are treated by the compiler as
  // instance (not class) messages. We will statically dispatch to those.
  if (auto *PT = dyn_cast_or_null<ObjCObjectPointerType>(ReceiverT)) {
    // For [self classMethod], return the compiler visible declaration.
    if (PT->getObjectType()->isObjCClass() &&
        Receiver == getSelfSVal().getAsRegion())
      return RuntimeDefinition(findDefiningRedecl(E->getMethodDecl()));

    // Similarly, handle [[self class] classMethod].
    // TODO: We are currently doing a syntactic match for this pattern with is
    // limiting as the test cases in Analysis/inlining/InlineObjCClassMethod.m
    // shows. A better way would be to associate the meta type with the symbol
    // using the dynamic type info tracking and use it here. We can add a new
    // SVal for ObjC 'Class' values that know what interface declaration they
    // come from. Then 'self' in a class method would be filled in with
    // something meaningful in ObjCMethodCall::getReceiverSVal() and we could
    // do proper dynamic dispatch for class methods just like we do for
    // instance methods now.
    if (E->getInstanceReceiver())
      if (const auto *M = dyn_cast<ObjCMessageExpr>(E->getInstanceReceiver()))
        if (isCallToSelfClass(M))
          return RuntimeDefinition(findDefiningRedecl(E->getMethodDecl()));
  }

  // Lookup the instance method implementation.
  if (ReceiverT)
    if (ObjCInterfaceDecl *IDecl = ReceiverT->getInterfaceDecl()) {
      // Repeatedly calling lookupPrivateMethod() is expensive, especially
      // when in many cases it returns null.  We cache the results so
      // that repeated queries on the same ObjCIntefaceDecl and Selector
      // don't incur the same cost.  On some test cases, we can see the
      // same query being issued thousands of times.
      //
      // NOTE: This cache is essentially a "global" variable, but it
      // only gets lazily created when we get here.  The value of the
      // cache probably comes from it being global across ExprEngines,
      // where the same queries may get issued.  If we are worried about
      // concurrency, or possibly loading/unloading ASTs, etc., we may
      // need to revisit this someday.  In terms of memory, this table
      // stays around until clang quits, which also may be bad if we
      // need to release memory.
      using PrivateMethodKey = std::pair<const ObjCInterfaceDecl *, Selector>;
      using PrivateMethodCache =
          llvm::DenseMap<PrivateMethodKey, Optional<const ObjCMethodDecl *>>;

      static PrivateMethodCache PMC;
      Optional<const ObjCMethodDecl *> &Val = PMC[std::make_pair(IDecl, Sel)];

      // Query lookupPrivateMethod() if the cache does not hit.
      if (!Val.hasValue()) {
        Val = IDecl->lookupPrivateMethod(Sel);

        // If the method is a property accessor, we should try to "inline" it
        // even if we don't actually have an implementation.
        if (!*Val)
          if (const ObjCMethodDecl *CompileTimeMD = E->getMethodDecl())
            if (CompileTimeMD->isPropertyAccessor()) {
              if (!CompileTimeMD->getSelfDecl() &&
                  isa<ObjCCategoryDecl>(CompileTimeMD->getDeclContext())) {
                // If the method is an accessor in a category, and it doesn't
                // have a self declaration, first
                // try to find the method in a class extension. This
                // works around a bug in Sema where multiple accessors
                // are synthesized for properties in class
                // extensions that are redeclared in a category and the
                // the implicit parameters are not filled in for
                // the method on the category.
                // This ensures we find the accessor in the extension, which
                // has the implicit parameters filled in.
                auto *ID = CompileTimeMD->getClassInterface();
                for (auto *CatDecl : ID->visible_extensions()) {
                  Val = CatDecl->getMethod(Sel,
                                           CompileTimeMD->isInstanceMethod());
                  if (*Val)
                    break;
                }
              }
              if (!*Val)
                Val = IDecl->lookupInstanceMethod(Sel);
            }
      }

      const ObjCMethodDecl *MD = Val.getValue();
      if (CanBeSubClassed)
        return RuntimeDefinition(MD, Receiver);
      else
        return RuntimeDefinition(MD, nullptr);
    }
} else {
  // This is a class method.
  // If we have type info for the receiver class, we are calling via
  // class name.
  if (ObjCInterfaceDecl *IDecl = E->getReceiverInterface()) {
    // Find/Return the method implementation.
    return RuntimeDefinition(IDecl->lookupPrivateClassMethod(Sel));
  }
}

return {};
1310}

1312bool ObjCMethodCall::argumentsMayEscape() const {
if (isInSystemHeader() && !isInstanceMessage()) {
  Selector Sel = getSelector();
  if (Sel.getNumArgs() == 1 &&
      Sel.getIdentifierInfoForSlot(0)->isStr("valueWithPointer"))
    return true;
}

return CallEvent::argumentsMayEscape();
1321}

1323void ObjCMethodCall::getInitialStackFrameContents(
                                           const StackFrameContext *CalleeCtx,
                                           BindingsTy &Bindings) const {
const auto *D = cast<ObjCMethodDecl>(CalleeCtx->getDecl());
SValBuilder &SVB = getState()->getStateManager().getSValBuilder();
addParameterValuesToBindings(CalleeCtx, Bindings, SVB, *this,
                             D->parameters());

SVal SelfVal = getReceiverSVal();
if (!SelfVal.isUnknown()) {
  const VarDecl *SelfD = CalleeCtx->getAnalysisDeclContext()->getSelfDecl();
  MemRegionManager &MRMgr = SVB.getRegionManager();
  Loc SelfLoc = SVB.makeLoc(MRMgr.getVarRegion(SelfD, CalleeCtx));
  Bindings.push_back(std::make_pair(SelfLoc, SelfVal));
}
1338}

1340CallEventRef<>
1341CallEventManager::getSimpleCall(const CallExpr *CE, ProgramStateRef State,
                              const LocationContext *LCtx) {
if (const auto *MCE = dyn_cast<CXXMemberCallExpr>(CE))
  return create<CXXMemberCall>(MCE, State, LCtx);

if (const auto *OpCE = dyn_cast<CXXOperatorCallExpr>(CE)) {
  const FunctionDecl *DirectCallee = OpCE->getDirectCallee();
  if (const auto *MD = dyn_cast<CXXMethodDecl>(DirectCallee))
    if (MD->isInstance())
      return create<CXXMemberOperatorCall>(OpCE, State, LCtx);

} else if (CE->getCallee()->getType()->isBlockPointerType()) {
  return create<BlockCall>(CE, State, LCtx);
}

// Otherwise, it's a normal function call, static member function call, or
// something we can't reason about.
return create<SimpleFunctionCall>(CE, State, LCtx);
1359}

1361CallEventRef<>
1362CallEventManager::getCaller(const StackFrameContext *CalleeCtx,
                          ProgramStateRef State) {
const LocationContext *ParentCtx = CalleeCtx->getParent();
const LocationContext *CallerCtx = ParentCtx->getStackFrame();
assert(CallerCtx && "This should not be used for top-level stack frames")((CallerCtx && "This should not be used for top-level stack frames"
) ? static_cast<void> (0) : __assert_fail ("CallerCtx && \"This should not be used for top-level stack frames\""
, "/build/llvm-toolchain-snapshot-9~svn362543/tools/clang/lib/StaticAnalyzer/Core/CallEvent.cpp"
, 1366, __PRETTY_FUNCTION__));

const Stmt *CallSite = CalleeCtx->getCallSite();

if (CallSite) {
  if (CallEventRef<> Out = getCall(CallSite, State, CallerCtx))
    return Out;

  // All other cases are handled by getCall.
  assert(isa<CXXConstructExpr>(CallSite) &&((isa<CXXConstructExpr>(CallSite) && "This is not an inlineable statement"
) ? static_cast<void> (0) : __assert_fail ("isa<CXXConstructExpr>(CallSite) && \"This is not an inlineable statement\""
, "/build/llvm-toolchain-snapshot-9~svn362543/tools/clang/lib/StaticAnalyzer/Core/CallEvent.cpp"
, 1376, __PRETTY_FUNCTION__))
         "This is not an inlineable statement")((isa<CXXConstructExpr>(CallSite) && "This is not an inlineable statement"
) ? static_cast<void> (0) : __assert_fail ("isa<CXXConstructExpr>(CallSite) && \"This is not an inlineable statement\""
, "/build/llvm-toolchain-snapshot-9~svn362543/tools/clang/lib/StaticAnalyzer/Core/CallEvent.cpp"
, 1376, __PRETTY_FUNCTION__));

  SValBuilder &SVB = State->getStateManager().getSValBuilder();
  const auto *Ctor = cast<CXXMethodDecl>(CalleeCtx->getDecl());
  Loc ThisPtr = SVB.getCXXThis(Ctor, CalleeCtx);
  SVal ThisVal = State->getSVal(ThisPtr);

  return getCXXConstructorCall(cast<CXXConstructExpr>(CallSite),
                               ThisVal.getAsRegion(), State, CallerCtx);
}

// Fall back to the CFG. The only thing we haven't handled yet is
// destructors, though this could change in the future.
const CFGBlock *B = CalleeCtx->getCallSiteBlock();
CFGElement E = (*B)[CalleeCtx->getIndex()];
assert((E.getAs<CFGImplicitDtor>() || E.getAs<CFGTemporaryDtor>()) &&(((E.getAs<CFGImplicitDtor>() || E.getAs<CFGTemporaryDtor
>()) && "All other CFG elements should have exprs"
) ? static_cast<void> (0) : __assert_fail ("(E.getAs<CFGImplicitDtor>() || E.getAs<CFGTemporaryDtor>()) && \"All other CFG elements should have exprs\""
, "/build/llvm-toolchain-snapshot-9~svn362543/tools/clang/lib/StaticAnalyzer/Core/CallEvent.cpp"
, 1392, __PRETTY_FUNCTION__))
       "All other CFG elements should have exprs")(((E.getAs<CFGImplicitDtor>() || E.getAs<CFGTemporaryDtor
>()) && "All other CFG elements should have exprs"
) ? static_cast<void> (0) : __assert_fail ("(E.getAs<CFGImplicitDtor>() || E.getAs<CFGTemporaryDtor>()) && \"All other CFG elements should have exprs\""
, "/build/llvm-toolchain-snapshot-9~svn362543/tools/clang/lib/StaticAnalyzer/Core/CallEvent.cpp"
, 1392, __PRETTY_FUNCTION__));

SValBuilder &SVB = State->getStateManager().getSValBuilder();
const auto *Dtor = cast<CXXDestructorDecl>(CalleeCtx->getDecl());
Loc ThisPtr = SVB.getCXXThis(Dtor, CalleeCtx);
SVal ThisVal = State->getSVal(ThisPtr);

const Stmt *Trigger;
if (Optional<CFGAutomaticObjDtor> AutoDtor = E.getAs<CFGAutomaticObjDtor>())
  Trigger = AutoDtor->getTriggerStmt();
else if (Optional<CFGDeleteDtor> DeleteDtor = E.getAs<CFGDeleteDtor>())
  Trigger = DeleteDtor->getDeleteExpr();
else
  Trigger = Dtor->getBody();

return getCXXDestructorCall(Dtor, Trigger, ThisVal.getAsRegion(),
                            E.getAs<CFGBaseDtor>().hasValue(), State,
                            CallerCtx);
1410}

1412CallEventRef<> CallEventManager::getCall(const Stmt *S, ProgramStateRef State,
                                       const LocationContext *LC) {
if (const auto *CE = dyn_cast<CallExpr>(S)) {
  return getSimpleCall(CE, State, LC);
} else if (const auto *NE = dyn_cast<CXXNewExpr>(S)) {
  return getCXXAllocatorCall(NE, State, LC);
} else if (const auto *ME = dyn_cast<ObjCMessageExpr>(S)) {
  return getObjCMethodCall(ME, State, LC);
} else {
  return nullptr;
}
1423}

←

/build/llvm-toolchain-snapshot-9~svn362543/include/llvm/Support/Error.h

1//===- llvm/Support/Error.h - Recoverable error handling --------*- 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// This file defines an API used to report recoverable errors.
10//
11//===----------------------------------------------------------------------===//
12 
13#ifndef LLVM_SUPPORT_ERROR_H
14#define LLVM_SUPPORT_ERROR_H
15 
16#include "llvm-c/Error.h"
17#include "llvm/ADT/STLExtras.h"
18#include "llvm/ADT/SmallVector.h"
19#include "llvm/ADT/StringExtras.h"
20#include "llvm/ADT/Twine.h"
21#include "llvm/Config/abi-breaking.h"
22#include "llvm/Support/AlignOf.h"
23#include "llvm/Support/Compiler.h"
24#include "llvm/Support/Debug.h"
25#include "llvm/Support/ErrorHandling.h"
26#include "llvm/Support/ErrorOr.h"
27#include "llvm/Support/Format.h"
28#include "llvm/Support/raw_ostream.h"
29#include <algorithm>
30#include <cassert>
31#include <cstdint>
32#include <cstdlib>
33#include <functional>
34#include <memory>
35#include <new>
36#include <string>
37#include <system_error>
38#include <type_traits>
39#include <utility>
40#include <vector>
41 
42namespace llvm {
43 
44class ErrorSuccess;
45 
46/// Base class for error info classes. Do not extend this directly: Extend
47/// the ErrorInfo template subclass instead.
48class ErrorInfoBase {
49public:
50  virtual ~ErrorInfoBase() = default;
51 
52  /// Print an error message to an output stream.
53  virtual void log(raw_ostream &OS) const = 0;
54 
55  /// Return the error message as a string.
56  virtual std::string message() const {
57    std::string Msg;
58    raw_string_ostream OS(Msg);
59    log(OS);
60    return OS.str();
61  }
62 
63  /// Convert this error to a std::error_code.
64  ///
65  /// This is a temporary crutch to enable interaction with code still
66  /// using std::error_code. It will be removed in the future.
67  virtual std::error_code convertToErrorCode() const = 0;
68 
69  // Returns the class ID for this type.
70  static const void *classID() { return &ID; }
71 
72  // Returns the class ID for the dynamic type of this ErrorInfoBase instance.
73  virtual const void *dynamicClassID() const = 0;
74 
75  // Check whether this instance is a subclass of the class identified by
76  // ClassID.
77  virtual bool isA(const void *const ClassID) const {
78    return ClassID == classID();
79  }
80 
81  // Check whether this instance is a subclass of ErrorInfoT.
82  template <typename ErrorInfoT> bool isA() const {
83    return isA(ErrorInfoT::classID());
84  }
85 
86private:
87  virtual void anchor();
88 
89  static char ID;
90};
91 
92/// Lightweight error class with error context and mandatory checking.
93///
94/// Instances of this class wrap a ErrorInfoBase pointer. Failure states
95/// are represented by setting the pointer to a ErrorInfoBase subclass
96/// instance containing information describing the failure. Success is
97/// represented by a null pointer value.
98///
99/// Instances of Error also contains a 'Checked' flag, which must be set
100/// before the destructor is called, otherwise the destructor will trigger a
101/// runtime error. This enforces at runtime the requirement that all Error
102/// instances be checked or returned to the caller.
103///
104/// There are two ways to set the checked flag, depending on what state the
105/// Error instance is in. For Error instances indicating success, it
106/// is sufficient to invoke the boolean conversion operator. E.g.:
107///
108///   @code{.cpp}
109///   Error foo(<...>);
110///
111///   if (auto E = foo(<...>))
112///     return E; // <- Return E if it is in the error state.
113///   // We have verified that E was in the success state. It can now be safely
114///   // destroyed.
115///   @endcode
116///
117/// A success value *can not* be dropped. For example, just calling 'foo(<...>)'
118/// without testing the return value will raise a runtime error, even if foo
119/// returns success.
120///
121/// For Error instances representing failure, you must use either the
122/// handleErrors or handleAllErrors function with a typed handler. E.g.:
123///
124///   @code{.cpp}
125///   class MyErrorInfo : public ErrorInfo<MyErrorInfo> {
126///     // Custom error info.
127///   };
128///
129///   Error foo(<...>) { return make_error<MyErrorInfo>(...); }
130///
131///   auto E = foo(<...>); // <- foo returns failure with MyErrorInfo.
132///   auto NewE =
133///     handleErrors(E,
134///       [](const MyErrorInfo &M) {
135///         // Deal with the error.
136///       },
137///       [](std::unique_ptr<OtherError> M) -> Error {
138///         if (canHandle(*M)) {
139///           // handle error.
140///           return Error::success();
141///         }
142///         // Couldn't handle this error instance. Pass it up the stack.
143///         return Error(std::move(M));
144///       );
145///   // Note - we must check or return NewE in case any of the handlers
146///   // returned a new error.
147///   @endcode
148///
149/// The handleAllErrors function is identical to handleErrors, except
150/// that it has a void return type, and requires all errors to be handled and
151/// no new errors be returned. It prevents errors (assuming they can all be
152/// handled) from having to be bubbled all the way to the top-level.
153///
154/// *All* Error instances must be checked before destruction, even if
155/// they're moved-assigned or constructed from Success values that have already
156/// been checked. This enforces checking through all levels of the call stack.
157class LLVM_NODISCARD[[clang::warn_unused_result]] Error {
158  // Both ErrorList and FileError need to be able to yank ErrorInfoBase
159  // pointers out of this class to add to the error list.
160  friend class ErrorList;
161  friend class FileError;
162 
163  // handleErrors needs to be able to set the Checked flag.
164  template <typename... HandlerTs>
165  friend Error handleErrors(Error E, HandlerTs &&... Handlers);
166 
167  // Expected<T> needs to be able to steal the payload when constructed from an
168  // error.
169  template <typename T> friend class Expected;
170 
171  // wrap needs to be able to steal the payload.
172  friend LLVMErrorRef wrap(Error);
173 
174protected:
175  /// Create a success value. Prefer using 'Error::success()' for readability
176  Error() {
177    setPtr(nullptr);
178    setChecked(false);
179  }
180 
181public:
182  /// Create a success value.
183  static ErrorSuccess success();
184 
185  // Errors are not copy-constructable.
186  Error(const Error &Other) = delete;
187 
188  /// Move-construct an error value. The newly constructed error is considered
189  /// unchecked, even if the source error had been checked. The original error
190  /// becomes a checked Success value, regardless of its original state.
191  Error(Error &&Other) {
192    setChecked(true);
193    *this = std::move(Other);
194  }
195 
196  /// Create an error value. Prefer using the 'make_error' function, but
197  /// this constructor can be useful when "re-throwing" errors from handlers.
198  Error(std::unique_ptr<ErrorInfoBase> Payload) {
199    setPtr(Payload.release());
200    setChecked(false);
34
←
Potential leak of memory pointed to by 'Payload._M_t._M_head_impl'
201  }
202 
203  // Errors are not copy-assignable.
204  Error &operator=(const Error &Other) = delete;
205 
206  /// Move-assign an error value. The current error must represent success, you
207  /// you cannot overwrite an unhandled error. The current error is then
208  /// considered unchecked. The source error becomes a checked success value,
209  /// regardless of its original state.
210  Error &operator=(Error &&Other) {
211    // Don't allow overwriting of unchecked values.
212    assertIsChecked();
213    setPtr(Other.getPtr());
214 
215    // This Error is unchecked, even if the source error was checked.
216    setChecked(false);
217 
218    // Null out Other's payload and set its checked bit.
219    Other.setPtr(nullptr);
220    Other.setChecked(true);
221 
222    return *this;
223  }
224 
225  /// Destroy a Error. Fails with a call to abort() if the error is
226  /// unchecked.
227  ~Error() {
228    assertIsChecked();
229    delete getPtr();
230  }
231 
232  /// Bool conversion. Returns true if this Error is in a failure state,
233  /// and false if it is in an accept state. If the error is in a Success state
234  /// it will be considered checked.
235  explicit operator bool() {
236    setChecked(getPtr() == nullptr);
237    return getPtr() != nullptr;
238  }
239 
240  /// Check whether one error is a subclass of another.
241  template <typename ErrT> bool isA() const {
242    return getPtr() && getPtr()->isA(ErrT::classID());
243  }
244 
245  /// Returns the dynamic class id of this error, or null if this is a success
246  /// value.
247  const void* dynamicClassID() const {
248    if (!getPtr())
249      return nullptr;
250    return getPtr()->dynamicClassID();
251  }
252 
253private:
254#if LLVM_ENABLE_ABI_BREAKING_CHECKS1
255  // assertIsChecked() happens very frequently, but under normal circumstances
256  // is supposed to be a no-op.  So we want it to be inlined, but having a bunch
257  // of debug prints can cause the function to be too large for inlining.  So
258  // it's important that we define this function out of line so that it can't be
259  // inlined.
260  LLVM_ATTRIBUTE_NORETURN__attribute__((noreturn))
261  void fatalUncheckedError() const;
262#endif
263 
264  void assertIsChecked() {
265#if LLVM_ENABLE_ABI_BREAKING_CHECKS1
266    if (LLVM_UNLIKELY(!getChecked() || getPtr())__builtin_expect((bool)(!getChecked() || getPtr()), false))
267      fatalUncheckedError();
268#endif
269  }
270 
271  ErrorInfoBase *getPtr() const {
272    return reinterpret_cast<ErrorInfoBase*>(
273             reinterpret_cast<uintptr_t>(Payload) &
274             ~static_cast<uintptr_t>(0x1));
275  }
276 
277  void setPtr(ErrorInfoBase *EI) {
278#if LLVM_ENABLE_ABI_BREAKING_CHECKS1
279    Payload = reinterpret_cast<ErrorInfoBase*>(
280                (reinterpret_cast<uintptr_t>(EI) &
281                 ~static_cast<uintptr_t>(0x1)) |
282                (reinterpret_cast<uintptr_t>(Payload) & 0x1));
283#else
284    Payload = EI;
285#endif
286  }
287 
288  bool getChecked() const {
289#if LLVM_ENABLE_ABI_BREAKING_CHECKS1
290    return (reinterpret_cast<uintptr_t>(Payload) & 0x1) == 0;
291#else
292    return true;
293#endif
294  }
295 
296  void setChecked(bool V) {
297    Payload = reinterpret_cast<ErrorInfoBase*>(
298                (reinterpret_cast<uintptr_t>(Payload) &
299                  ~static_cast<uintptr_t>(0x1)) |
300                  (V ? 0 : 1));
301  }
302 
303  std::unique_ptr<ErrorInfoBase> takePayload() {
304    std::unique_ptr<ErrorInfoBase> Tmp(getPtr());
305    setPtr(nullptr);
306    setChecked(true);
307    return Tmp;
308  }
309 
310  friend raw_ostream &operator<<(raw_ostream &OS, const Error &E) {
311    if (auto P = E.getPtr())
312      P->log(OS);
313    else
314      OS << "success";
315    return OS;
316  }
317 
318  ErrorInfoBase *Payload = nullptr;
319};
320 
321/// Subclass of Error for the sole purpose of identifying the success path in
322/// the type system. This allows to catch invalid conversion to Expected<T> at
323/// compile time.
324class ErrorSuccess final : public Error {};
325 
326inline ErrorSuccess Error::success() { return ErrorSuccess(); }
327 
328/// Make a Error instance representing failure using the given error info
329/// type.
330template <typename ErrT, typename... ArgTs> Error make_error(ArgTs &&... Args) {
331  return Error(llvm::make_unique<ErrT>(std::forward<ArgTs>(Args)...));
332}
333 
334/// Base class for user error types. Users should declare their error types
335/// like:
336///
337/// class MyError : public ErrorInfo<MyError> {
338///   ....
339/// };
340///
341/// This class provides an implementation of the ErrorInfoBase::kind
342/// method, which is used by the Error RTTI system.
343template <typename ThisErrT, typename ParentErrT = ErrorInfoBase>
344class ErrorInfo : public ParentErrT {
345public:
346  using ParentErrT::ParentErrT; // inherit constructors
347 
348  static const void *classID() { return &ThisErrT::ID; }
349 
350  const void *dynamicClassID() const override { return &ThisErrT::ID; }
351 
352  bool isA(const void *const ClassID) const override {
353    return ClassID == classID() || ParentErrT::isA(ClassID);
354  }
355};
356 
357/// Special ErrorInfo subclass representing a list of ErrorInfos.
358/// Instances of this class are constructed by joinError.
359class ErrorList final : public ErrorInfo<ErrorList> {
360  // handleErrors needs to be able to iterate the payload list of an
361  // ErrorList.
362  template <typename... HandlerTs>
363  friend Error handleErrors(Error E, HandlerTs &&... Handlers);
364 
365  // joinErrors is implemented in terms of join.
366  friend Error joinErrors(Error, Error);
367 
368public:
369  void log(raw_ostream &OS) const override {
370    OS << "Multiple errors:\n";
371    for (auto &ErrPayload : Payloads) {
372      ErrPayload->log(OS);
373      OS << "\n";
374    }
375  }
376 
377  std::error_code convertToErrorCode() const override;
378 
379  // Used by ErrorInfo::classID.
380  static char ID;
381 
382private:
383  ErrorList(std::unique_ptr<ErrorInfoBase> Payload1,
384            std::unique_ptr<ErrorInfoBase> Payload2) {
385    assert(!Payload1->isA<ErrorList>() && !Payload2->isA<ErrorList>() &&((!Payload1->isA<ErrorList>() && !Payload2->
isA<ErrorList>() && "ErrorList constructor payloads should be singleton errors"
) ? static_cast<void> (0) : __assert_fail ("!Payload1->isA<ErrorList>() && !Payload2->isA<ErrorList>() && \"ErrorList constructor payloads should be singleton errors\""
, "/build/llvm-toolchain-snapshot-9~svn362543/include/llvm/Support/Error.h"
, 386, __PRETTY_FUNCTION__))
386           "ErrorList constructor payloads should be singleton errors")((!Payload1->isA<ErrorList>() && !Payload2->
isA<ErrorList>() && "ErrorList constructor payloads should be singleton errors"
) ? static_cast<void> (0) : __assert_fail ("!Payload1->isA<ErrorList>() && !Payload2->isA<ErrorList>() && \"ErrorList constructor payloads should be singleton errors\""
, "/build/llvm-toolchain-snapshot-9~svn362543/include/llvm/Support/Error.h"
, 386, __PRETTY_FUNCTION__));
387    Payloads.push_back(std::move(Payload1));
388    Payloads.push_back(std::move(Payload2));
389  }
390 
391  static Error join(Error E1, Error E2) {
392    if (!E1)
24
←
Assuming the condition is false→
25
←
Taking false branch→
393      return E2;
394    if (!E2)
26
←
Assuming the condition is false→
27
←
Taking false branch→
395      return E1;
396    if (E1.isA<ErrorList>()) {
28
←
Assuming the condition is false→
29
←
Taking false branch→
397      auto &E1List = static_cast<ErrorList &>(*E1.getPtr());
398      if (E2.isA<ErrorList>()) {
399        auto E2Payload = E2.takePayload();
400        auto &E2List = static_cast<ErrorList &>(*E2Payload);
401        for (auto &Payload : E2List.Payloads)
402          E1List.Payloads.push_back(std::move(Payload));
403      } else
404        E1List.Payloads.push_back(E2.takePayload());
405 
406      return E1;
407    }
408    if (E2.isA<ErrorList>()) {
30
←
Assuming the condition is false→
31
←
Taking false branch→
409      auto &E2List = static_cast<ErrorList &>(*E2.getPtr());
410      E2List.Payloads.insert(E2List.Payloads.begin(), E1.takePayload());
411      return E2;
412    }
413    return Error(std::unique_ptr<ErrorList>(
33
←
Calling constructor for 'Error'→
414        new ErrorList(E1.takePayload(), E2.takePayload())));
32
←
Memory is allocated→
415  }
416 
417  std::vector<std::unique_ptr<ErrorInfoBase>> Payloads;
418};
419 
420/// Concatenate errors. The resulting Error is unchecked, and contains the
421/// ErrorInfo(s), if any, contained in E1, followed by the
422/// ErrorInfo(s), if any, contained in E2.
423inline Error joinErrors(Error E1, Error E2) {
424  return ErrorList::join(std::move(E1), std::move(E2));
425}
426 
427/// Tagged union holding either a T or a Error.
428///
429/// This class parallels ErrorOr, but replaces error_code with Error. Since
430/// Error cannot be copied, this class replaces getError() with
431/// takeError(). It also adds an bool errorIsA<ErrT>() method for testing the
432/// error class type.
433template <class T> class LLVM_NODISCARD[[clang::warn_unused_result]] Expected {
434  template <class T1> friend class ExpectedAsOutParameter;
435  template <class OtherT> friend class Expected;
436 
437  static const bool isRef = std::is_reference<T>::value;
438 
439  using wrap = std::reference_wrapper<typename std::remove_reference<T>::type>;
440 
441  using error_type = std::unique_ptr<ErrorInfoBase>;
442 
443public:
444  using storage_type = typename std::conditional<isRef, wrap, T>::type;
445  using value_type = T;
446 
447private:
448  using reference = typename std::remove_reference<T>::type &;
449  using const_reference = const typename std::remove_reference<T>::type &;
450  using pointer = typename std::remove_reference<T>::type *;
451  using const_pointer = const typename std::remove_reference<T>::type *;
452 
453public:
454  /// Create an Expected<T> error value from the given Error.
455  Expected(Error Err)
456      : HasError(true)
457#if LLVM_ENABLE_ABI_BREAKING_CHECKS1
458        // Expected is unchecked upon construction in Debug builds.
459        , Unchecked(true)
460#endif
461  {
462    assert(Err && "Cannot create Expected<T> from Error success value.")((Err && "Cannot create Expected<T> from Error success value."
) ? static_cast<void> (0) : __assert_fail ("Err && \"Cannot create Expected<T> from Error success value.\""
, "/build/llvm-toolchain-snapshot-9~svn362543/include/llvm/Support/Error.h"
, 462, __PRETTY_FUNCTION__));
463    new (getErrorStorage()) error_type(Err.takePayload());
464  }
465 
466  /// Forbid to convert from Error::success() implicitly, this avoids having
467  /// Expected<T> foo() { return Error::success(); } which compiles otherwise
468  /// but triggers the assertion above.
469  Expected(ErrorSuccess) = delete;
470 
471  /// Create an Expected<T> success value from the given OtherT value, which
472  /// must be convertible to T.
473  template <typename OtherT>
474  Expected(OtherT &&Val,
475           typename std::enable_if<std::is_convertible<OtherT, T>::value>::type
476               * = nullptr)
477      : HasError(false)
478#if LLVM_ENABLE_ABI_BREAKING_CHECKS1
479        // Expected is unchecked upon construction in Debug builds.
480        , Unchecked(true)
481#endif
482  {
483    new (getStorage()) storage_type(std::forward<OtherT>(Val));
484  }
485 
486  /// Move construct an Expected<T> value.
487  Expected(Expected &&Other) { moveConstruct(std::move(Other)); }
488 
489  /// Move construct an Expected<T> value from an Expected<OtherT>, where OtherT
490  /// must be convertible to T.
491  template <class OtherT>
492  Expected(Expected<OtherT> &&Other,
493           typename std::enable_if<std::is_convertible<OtherT, T>::value>::type
494               * = nullptr) {
495    moveConstruct(std::move(Other));
496  }
497 
498  /// Move construct an Expected<T> value from an Expected<OtherT>, where OtherT
499  /// isn't convertible to T.
500  template <class OtherT>
501  explicit Expected(
502      Expected<OtherT> &&Other,
503      typename std::enable_if<!std::is_convertible<OtherT, T>::value>::type * =
504          nullptr) {
505    moveConstruct(std::move(Other));
506  }
507 
508  /// Move-assign from another Expected<T>.
509  Expected &operator=(Expected &&Other) {
510    moveAssign(std::move(Other));
511    return *this;
512  }
513 
514  /// Destroy an Expected<T>.
515  ~Expected() {
516    assertIsChecked();
517    if (!HasError)
518      getStorage()->~storage_type();
519    else
520      getErrorStorage()->~error_type();
521  }
522 
523  /// Return false if there is an error.
524  explicit operator bool() {
525#if LLVM_ENABLE_ABI_BREAKING_CHECKS1
526    Unchecked = HasError;
527#endif
528    return !HasError;
529  }
530 
531  /// Returns a reference to the stored T value.
532  reference get() {
533    assertIsChecked();
534    return *getStorage();
535  }
536 
537  /// Returns a const reference to the stored T value.
538  const_reference get() const {
539    assertIsChecked();
540    return const_cast<Expected<T> *>(this)->get();
541  }
542 
543  /// Check that this Expected<T> is an error of type ErrT.
544  template <typename ErrT> bool errorIsA() const {
545    return HasError && (*getErrorStorage())->template isA<ErrT>();
546  }
547 
548  /// Take ownership of the stored error.
549  /// After calling this the Expected<T> is in an indeterminate state that can
550  /// only be safely destructed. No further calls (beside the destructor) should
551  /// be made on the Expected<T> vaule.
552  Error takeError() {
553#if LLVM_ENABLE_ABI_BREAKING_CHECKS1
554    Unchecked = false;
555#endif
556    return HasError ? Error(std::move(*getErrorStorage())) : Error::success();
557  }
558 
559  /// Returns a pointer to the stored T value.
560  pointer operator->() {
561    assertIsChecked();
562    return toPointer(getStorage());
563  }
564 
565  /// Returns a const pointer to the stored T value.
566  const_pointer operator->() const {
567    assertIsChecked();
568    return toPointer(getStorage());
569  }
570 
571  /// Returns a reference to the stored T value.
572  reference operator*() {
573    assertIsChecked();
574    return *getStorage();
575  }
576 
577  /// Returns a const reference to the stored T value.
578  const_reference operator*() const {
579    assertIsChecked();
580    return *getStorage();
581  }
582 
583private:
584  template <class T1>
585  static bool compareThisIfSameType(const T1 &a, const T1 &b) {
586    return &a == &b;
587  }
588 
589  template <class T1, class T2>
590  static bool compareThisIfSameType(const T1 &a, const T2 &b) {
591    return false;
592  }
593 
594  template <class OtherT> void moveConstruct(Expected<OtherT> &&Other) {
595    HasError = Other.HasError;
596#if LLVM_ENABLE_ABI_BREAKING_CHECKS1
597    Unchecked = true;
598    Other.Unchecked = false;
599#endif
600 
601    if (!HasError)
602      new (getStorage()) storage_type(std::move(*Other.getStorage()));
603    else
604      new (getErrorStorage()) error_type(std::move(*Other.getErrorStorage()));
605  }
606 
607  template <class OtherT> void moveAssign(Expected<OtherT> &&Other) {
608    assertIsChecked();
609 
610    if (compareThisIfSameType(*this, Other))
611      return;
612 
613    this->~Expected();
614    new (this) Expected(std::move(Other));
615  }
616 
617  pointer toPointer(pointer Val) { return Val; }
618 
619  const_pointer toPointer(const_pointer Val) const { return Val; }
620 
621  pointer toPointer(wrap *Val) { return &Val->get(); }
622 
623  const_pointer toPointer(const wrap *Val) const { return &Val->get(); }
624 
625  storage_type *getStorage() {
626    assert(!HasError && "Cannot get value when an error exists!")((!HasError && "Cannot get value when an error exists!"
) ? static_cast<void> (0) : __assert_fail ("!HasError && \"Cannot get value when an error exists!\""
, "/build/llvm-toolchain-snapshot-9~svn362543/include/llvm/Support/Error.h"
, 626, __PRETTY_FUNCTION__));
627    return reinterpret_cast<storage_type *>(TStorage.buffer);
628  }
629 
630  const storage_type *getStorage() const {
631    assert(!HasError && "Cannot get value when an error exists!")((!HasError && "Cannot get value when an error exists!"
) ? static_cast<void> (0) : __assert_fail ("!HasError && \"Cannot get value when an error exists!\""
, "/build/llvm-toolchain-snapshot-9~svn362543/include/llvm/Support/Error.h"
, 631, __PRETTY_FUNCTION__));
632    return reinterpret_cast<const storage_type *>(TStorage.buffer);
633  }
634 
635  error_type *getErrorStorage() {
636    assert(HasError && "Cannot get error when a value exists!")((HasError && "Cannot get error when a value exists!"
) ? static_cast<void> (0) : __assert_fail ("HasError && \"Cannot get error when a value exists!\""
, "/build/llvm-toolchain-snapshot-9~svn362543/include/llvm/Support/Error.h"
, 636, __PRETTY_FUNCTION__));
637    return reinterpret_cast<error_type *>(ErrorStorage.buffer);
638  }
639 
640  const error_type *getErrorStorage() const {
641    assert(HasError && "Cannot get error when a value exists!")((HasError && "Cannot get error when a value exists!"
) ? static_cast<void> (0) : __assert_fail ("HasError && \"Cannot get error when a value exists!\""
, "/build/llvm-toolchain-snapshot-9~svn362543/include/llvm/Support/Error.h"
, 641, __PRETTY_FUNCTION__));
642    return reinterpret_cast<const error_type *>(ErrorStorage.buffer);
643  }
644 
645  // Used by ExpectedAsOutParameter to reset the checked flag.
646  void setUnchecked() {
647#if LLVM_ENABLE_ABI_BREAKING_CHECKS1
648    Unchecked = true;
649#endif
650  }
651 
652#if LLVM_ENABLE_ABI_BREAKING_CHECKS1
653  LLVM_ATTRIBUTE_NORETURN__attribute__((noreturn))
654  LLVM_ATTRIBUTE_NOINLINE__attribute__((noinline))
655  void fatalUncheckedExpected() const {
656    dbgs() << "Expected<T> must be checked before access or destruction.\n";
657    if (HasError) {
658      dbgs() << "Unchecked Expected<T> contained error:\n";
659      (*getErrorStorage())->log(dbgs());
660    } else
661      dbgs() << "Expected<T> value was in success state. (Note: Expected<T> "
662                "values in success mode must still be checked prior to being "
663                "destroyed).\n";
664    abort();
665  }
666#endif
667 
668  void assertIsChecked() {
669#if LLVM_ENABLE_ABI_BREAKING_CHECKS1
670    if (LLVM_UNLIKELY(Unchecked)__builtin_expect((bool)(Unchecked), false))
671      fatalUncheckedExpected();
672#endif
673  }
674 
675  union {
676    AlignedCharArrayUnion<storage_type> TStorage;
677    AlignedCharArrayUnion<error_type> ErrorStorage;
678  };
679  bool HasError : 1;
680#if LLVM_ENABLE_ABI_BREAKING_CHECKS1
681  bool Unchecked : 1;
682#endif
683};
684 
685/// Report a serious error, calling any installed error handler. See
686/// ErrorHandling.h.
687LLVM_ATTRIBUTE_NORETURN__attribute__((noreturn)) void report_fatal_error(Error Err,
688                                                bool gen_crash_diag = true);
689 
690/// Report a fatal error if Err is a failure value.
691///
692/// This function can be used to wrap calls to fallible functions ONLY when it
693/// is known that the Error will always be a success value. E.g.
694///
695///   @code{.cpp}
696///   // foo only attempts the fallible operation if DoFallibleOperation is
697///   // true. If DoFallibleOperation is false then foo always returns
698///   // Error::success().
699///   Error foo(bool DoFallibleOperation);
700///
701///   cantFail(foo(false));
702///   @endcode
703inline void cantFail(Error Err, const char *Msg = nullptr) {
704  if (Err) {
705    if (!Msg)
706      Msg = "Failure value returned from cantFail wrapped call";
707    llvm_unreachable(Msg)::llvm::llvm_unreachable_internal(Msg, "/build/llvm-toolchain-snapshot-9~svn362543/include/llvm/Support/Error.h"
, 707);
708  }
709}
710 
711/// Report a fatal error if ValOrErr is a failure value, otherwise unwraps and
712/// returns the contained value.
713///
714/// This function can be used to wrap calls to fallible functions ONLY when it
715/// is known that the Error will always be a success value. E.g.
716///
717///   @code{.cpp}
718///   // foo only attempts the fallible operation if DoFallibleOperation is
719///   // true. If DoFallibleOperation is false then foo always returns an int.
720///   Expected<int> foo(bool DoFallibleOperation);
721///
722///   int X = cantFail(foo(false));
723///   @endcode
724template <typename T>
725T cantFail(Expected<T> ValOrErr, const char *Msg = nullptr) {
726  if (ValOrErr)
727    return std::move(*ValOrErr);
728  else {
729    if (!Msg)
730      Msg = "Failure value returned from cantFail wrapped call";
731    llvm_unreachable(Msg)::llvm::llvm_unreachable_internal(Msg, "/build/llvm-toolchain-snapshot-9~svn362543/include/llvm/Support/Error.h"
, 731);
732  }
733}
734 
735/// Report a fatal error if ValOrErr is a failure value, otherwise unwraps and
736/// returns the contained reference.
737///
738/// This function can be used to wrap calls to fallible functions ONLY when it
739/// is known that the Error will always be a success value. E.g.
740///
741///   @code{.cpp}
742///   // foo only attempts the fallible operation if DoFallibleOperation is
743///   // true. If DoFallibleOperation is false then foo always returns a Bar&.
744///   Expected<Bar&> foo(bool DoFallibleOperation);
745///
746///   Bar &X = cantFail(foo(false));
747///   @endcode
748template <typename T>
749T& cantFail(Expected<T&> ValOrErr, const char *Msg = nullptr) {
750  if (ValOrErr)
751    return *ValOrErr;
752  else {
753    if (!Msg)
754      Msg = "Failure value returned from cantFail wrapped call";
755    llvm_unreachable(Msg)::llvm::llvm_unreachable_internal(Msg, "/build/llvm-toolchain-snapshot-9~svn362543/include/llvm/Support/Error.h"
, 755);
756  }
757}
758 
759/// Helper for testing applicability of, and applying, handlers for
760/// ErrorInfo types.
761template <typename HandlerT>
762class ErrorHandlerTraits
763    : public ErrorHandlerTraits<decltype(
764          &std::remove_reference<HandlerT>::type::operator())> {};
765 
766// Specialization functions of the form 'Error (const ErrT&)'.
767template <typename ErrT> class ErrorHandlerTraits<Error (&)(ErrT &)> {
768public:
769  static bool appliesTo(const ErrorInfoBase &E) {
770    return E.template isA<ErrT>();
771  }
772 
773  template <typename HandlerT>
774  static Error apply(HandlerT &&H, std::unique_ptr<ErrorInfoBase> E) {
775    assert(appliesTo(*E) && "Applying incorrect handler")((appliesTo(*E) && "Applying incorrect handler") ? static_cast
<void> (0) : __assert_fail ("appliesTo(*E) && \"Applying incorrect handler\""
, "/build/llvm-toolchain-snapshot-9~svn362543/include/llvm/Support/Error.h"
, 775, __PRETTY_FUNCTION__));
776    return H(static_cast<ErrT &>(*E));
777  }
778};
779 
780// Specialization functions of the form 'void (const ErrT&)'.
781template <typename ErrT> class ErrorHandlerTraits<void (&)(ErrT &)> {
782public:
783  static bool appliesTo(const ErrorInfoBase &E) {
784    return E.template isA<ErrT>();
785  }
786 
787  template <typename HandlerT>
788  static Error apply(HandlerT &&H, std::unique_ptr<ErrorInfoBase> E) {
789    assert(appliesTo(*E) && "Applying incorrect handler")((appliesTo(*E) && "Applying incorrect handler") ? static_cast
<void> (0) : __assert_fail ("appliesTo(*E) && \"Applying incorrect handler\""
, "/build/llvm-toolchain-snapshot-9~svn362543/include/llvm/Support/Error.h"
, 789, __PRETTY_FUNCTION__));
790    H(static_cast<ErrT &>(*E));
791    return Error::success();
792  }
793};
794 
795/// Specialization for functions of the form 'Error (std::unique_ptr<ErrT>)'.
796template <typename ErrT>
797class ErrorHandlerTraits<Error (&)(std::unique_ptr<ErrT>)> {
798public:
799  static bool appliesTo(const ErrorInfoBase &E) {
800    return E.template isA<ErrT>();
801  }
802 
803  template <typename HandlerT>
804  static Error apply(HandlerT &&H, std::unique_ptr<ErrorInfoBase> E) {
805    assert(appliesTo(*E) && "Applying incorrect handler")((appliesTo(*E) && "Applying incorrect handler") ? static_cast
<void> (0) : __assert_fail ("appliesTo(*E) && \"Applying incorrect handler\""
, "/build/llvm-toolchain-snapshot-9~svn362543/include/llvm/Support/Error.h"
, 805, __PRETTY_FUNCTION__));
806    std::unique_ptr<ErrT> SubE(static_cast<ErrT *>(E.release()));
807    return H(std::move(SubE));
808  }
809};
810 
811/// Specialization for functions of the form 'void (std::unique_ptr<ErrT>)'.
812template <typename ErrT>
813class ErrorHandlerTraits<void (&)(std::unique_ptr<ErrT>)> {
814public:
815  static bool appliesTo(const ErrorInfoBase &E) {
816    return E.template isA<ErrT>();
817  }
818 
819  template <typename HandlerT>
820  static Error apply(HandlerT &&H, std::unique_ptr<ErrorInfoBase> E) {
821    assert(appliesTo(*E) && "Applying incorrect handler")((appliesTo(*E) && "Applying incorrect handler") ? static_cast
<void> (0) : __assert_fail ("appliesTo(*E) && \"Applying incorrect handler\""
, "/build/llvm-toolchain-snapshot-9~svn362543/include/llvm/Support/Error.h"
, 821, __PRETTY_FUNCTION__));
822    std::unique_ptr<ErrT> SubE(static_cast<ErrT *>(E.release()));
823    H(std::move(SubE));
824    return Error::success();
825  }
826};
827 
828// Specialization for member functions of the form 'RetT (const ErrT&)'.
829template <typename C, typename RetT, typename ErrT>
830class ErrorHandlerTraits<RetT (C::*)(ErrT &)>
831    : public ErrorHandlerTraits<RetT (&)(ErrT &)> {};
832 
833// Specialization for member functions of the form 'RetT (const ErrT&) const'.
834template <typename C, typename RetT, typename ErrT>
835class ErrorHandlerTraits<RetT (C::*)(ErrT &) const>
836    : public ErrorHandlerTraits<RetT (&)(ErrT &)> {};
837 
838// Specialization for member functions of the form 'RetT (const ErrT&)'.
839template <typename C, typename RetT, typename ErrT>
840class ErrorHandlerTraits<RetT (C::*)(const ErrT &)>
841    : public ErrorHandlerTraits<RetT (&)(ErrT &)> {};
842 
843// Specialization for member functions of the form 'RetT (const ErrT&) const'.
844template <typename C, typename RetT, typename ErrT>
845class ErrorHandlerTraits<RetT (C::*)(const ErrT &) const>
846    : public ErrorHandlerTraits<RetT (&)(ErrT &)> {};
847 
848/// Specialization for member functions of the form
849/// 'RetT (std::unique_ptr<ErrT>)'.
850template <typename C, typename RetT, typename ErrT>
851class ErrorHandlerTraits<RetT (C::*)(std::unique_ptr<ErrT>)>
852    : public ErrorHandlerTraits<RetT (&)(std::unique_ptr<ErrT>)> {};
853 
854/// Specialization for member functions of the form
855/// 'RetT (std::unique_ptr<ErrT>) const'.
856template <typename C, typename RetT, typename ErrT>
857class ErrorHandlerTraits<RetT (C::*)(std::unique_ptr<ErrT>) const>
858    : public ErrorHandlerTraits<RetT (&)(std::unique_ptr<ErrT>)> {};
859 
860inline Error handleErrorImpl(std::unique_ptr<ErrorInfoBase> Payload) {
861  return Error(std::move(Payload));
862}
863 
864template <typename HandlerT, typename... HandlerTs>
865Error handleErrorImpl(std::unique_ptr<ErrorInfoBase> Payload,
866                      HandlerT &&Handler, HandlerTs &&... Handlers) {
867  if (ErrorHandlerTraits<HandlerT>::appliesTo(*Payload))
868    return ErrorHandlerTraits<HandlerT>::apply(std::forward<HandlerT>(Handler),
869                                               std::move(Payload));
870  return handleErrorImpl(std::move(Payload),
871                         std::forward<HandlerTs>(Handlers)...);
872}
873 
874/// Pass the ErrorInfo(s) contained in E to their respective handlers. Any
875/// unhandled errors (or Errors returned by handlers) are re-concatenated and
876/// returned.
877/// Because this function returns an error, its result must also be checked
878/// or returned. If you intend to handle all errors use handleAllErrors
879/// (which returns void, and will abort() on unhandled errors) instead.
880template <typename... HandlerTs>
881Error handleErrors(Error E, HandlerTs &&... Hs) {
882  if (!E)
19
←
Assuming the condition is false→
20
←
Taking false branch→
883    return Error::success();
884 
885  std::unique_ptr<ErrorInfoBase> Payload = E.takePayload();
886 
887  if (Payload->isA<ErrorList>()) {
21
←
Assuming the condition is true→
22
←
Taking true branch→
888    ErrorList &List = static_cast<ErrorList &>(*Payload);
889    Error R;
890    for (auto &P : List.Payloads)
891      R = ErrorList::join(
23
←
Calling 'ErrorList::join'→
892          std::move(R),
893          handleErrorImpl(std::move(P), std::forward<HandlerTs>(Hs)...));
894    return R;
895  }
896 
897  return handleErrorImpl(std::move(Payload), std::forward<HandlerTs>(Hs)...);
898}
899 
900/// Behaves the same as handleErrors, except that by contract all errors
901/// *must* be handled by the given handlers (i.e. there must be no remaining
902/// errors after running the handlers, or llvm_unreachable is called).
903template <typename... HandlerTs>
904void handleAllErrors(Error E, HandlerTs &&... Handlers) {
905  cantFail(handleErrors(std::move(E), std::forward<HandlerTs>(Handlers)...));
18
←
Calling 'handleErrors<(lambda at /build/llvm-toolchain-snapshot-9~svn362543/tools/clang/lib/StaticAnalyzer/Core/CallEvent.cpp:567:21)>'→
906}
907 
908/// Check that E is a non-error, then drop it.
909/// If E is an error, llvm_unreachable will be called.
910inline void handleAllErrors(Error E) {
911  cantFail(std::move(E));
912}
913 
914/// Handle any errors (if present) in an Expected<T>, then try a recovery path.
915///
916/// If the incoming value is a success value it is returned unmodified. If it
917/// is a failure value then it the contained error is passed to handleErrors.
918/// If handleErrors is able to handle the error then the RecoveryPath functor
919/// is called to supply the final result. If handleErrors is not able to
920/// handle all errors then the unhandled errors are returned.
921///
922/// This utility enables the follow pattern:
923///
924///   @code{.cpp}
925///   enum FooStrategy { Aggressive, Conservative };
926///   Expected<Foo> foo(FooStrategy S);
927///
928///   auto ResultOrErr =
929///     handleExpected(
930///       foo(Aggressive),
931///       []() { return foo(Conservative); },
932///       [](AggressiveStrategyError&) {
933///         // Implicitly conusme this - we'll recover by using a conservative
934///         // strategy.
935///       });
936///
937///   @endcode
938template <typename T, typename RecoveryFtor, typename... HandlerTs>
939Expected<T> handleExpected(Expected<T> ValOrErr, RecoveryFtor &&RecoveryPath,
940                           HandlerTs &&... Handlers) {
941  if (ValOrErr)
942    return ValOrErr;
943 
944  if (auto Err = handleErrors(ValOrErr.takeError(),
945                              std::forward<HandlerTs>(Handlers)...))
946    return std::move(Err);
947 
948  return RecoveryPath();
949}
950 
951/// Log all errors (if any) in E to OS. If there are any errors, ErrorBanner
952/// will be printed before the first one is logged. A newline will be printed
953/// after each error.
954///
955/// This function is compatible with the helpers from Support/WithColor.h. You
956/// can pass any of them as the OS. Please consider using them instead of
957/// including 'error: ' in the ErrorBanner.
958///
959/// This is useful in the base level of your program to allow clean termination
960/// (allowing clean deallocation of resources, etc.), while reporting error
961/// information to the user.
962void logAllUnhandledErrors(Error E, raw_ostream &OS, Twine ErrorBanner = {});
963 
964/// Write all error messages (if any) in E to a string. The newline character
965/// is used to separate error messages.
966inline std::string toString(Error E) {
967  SmallVector<std::string, 2> Errors;
968  handleAllErrors(std::move(E), [&Errors](const ErrorInfoBase &EI) {
969    Errors.push_back(EI.message());
970  });
971  return join(Errors.begin(), Errors.end(), "\n");
972}
973 
974/// Consume a Error without doing anything. This method should be used
975/// only where an error can be considered a reasonable and expected return
976/// value.
977///
978/// Uses of this method are potentially indicative of design problems: If it's
979/// legitimate to do nothing while processing an "error", the error-producer
980/// might be more clearly refactored to return an Optional<T>.
981inline void consumeError(Error Err) {
982  handleAllErrors(std::move(Err), [](const ErrorInfoBase &) {});
983}
984 
985/// Helper for converting an Error to a bool.
986///
987/// This method returns true if Err is in an error state, or false if it is
988/// in a success state.  Puts Err in a checked state in both cases (unlike
989/// Error::operator bool(), which only does this for success states).
990inline bool errorToBool(Error Err) {
991  bool IsError = static_cast<bool>(Err);
992  if (IsError)
993    consumeError(std::move(Err));
994  return IsError;
995}
996 
997/// Helper for Errors used as out-parameters.
998///
999/// This helper is for use with the Error-as-out-parameter idiom, where an error
1000/// is passed to a function or method by reference, rather than being returned.
1001/// In such cases it is helpful to set the checked bit on entry to the function
1002/// so that the error can be written to (unchecked Errors abort on assignment)
1003/// and clear the checked bit on exit so that clients cannot accidentally forget
1004/// to check the result. This helper performs these actions automatically using
1005/// RAII:
1006///
1007///   @code{.cpp}
1008///   Result foo(Error &Err) {
1009///     ErrorAsOutParameter ErrAsOutParam(&Err); // 'Checked' flag set
1010///     // <body of foo>
1011///     // <- 'Checked' flag auto-cleared when ErrAsOutParam is destructed.
1012///   }
1013///   @endcode
1014///
1015/// ErrorAsOutParameter takes an Error* rather than Error& so that it can be
1016/// used with optional Errors (Error pointers that are allowed to be null). If
1017/// ErrorAsOutParameter took an Error reference, an instance would have to be
1018/// created inside every condition that verified that Error was non-null. By
1019/// taking an Error pointer we can just create one instance at the top of the
1020/// function.
1021class ErrorAsOutParameter {
1022public:
1023  ErrorAsOutParameter(Error *Err) : Err(Err) {
1024    // Raise the checked bit if Err is success.
1025    if (Err)
1026      (void)!!*Err;
1027  }
1028 
1029  ~ErrorAsOutParameter() {
1030    // Clear the checked bit.
1031    if (Err && !*Err)
1032      *Err = Error::success();
1033  }
1034 
1035private:
1036  Error *Err;
1037};
1038 
1039/// Helper for Expected<T>s used as out-parameters.
1040///
1041/// See ErrorAsOutParameter.
1042template <typename T>
1043class ExpectedAsOutParameter {
1044public:
1045  ExpectedAsOutParameter(Expected<T> *ValOrErr)
1046    : ValOrErr(ValOrErr) {
1047    if (ValOrErr)
1048      (void)!!*ValOrErr;
1049  }
1050 
1051  ~ExpectedAsOutParameter() {
1052    if (ValOrErr)
1053      ValOrErr->setUnchecked();
1054  }
1055 
1056private:
1057  Expected<T> *ValOrErr;
1058};
1059 
1060/// This class wraps a std::error_code in a Error.
1061///
1062/// This is useful if you're writing an interface that returns a Error
1063/// (or Expected) and you want to call code that still returns
1064/// std::error_codes.
1065class ECError : public ErrorInfo<ECError> {
1066  friend Error errorCodeToError(std::error_code);
1067 
1068  virtual void anchor() override;
1069 
1070public:
1071  void setErrorCode(std::error_code EC) { this->EC = EC; }
1072  std::error_code convertToErrorCode() const override { return EC; }
1073  void log(raw_ostream &OS) const override { OS << EC.message(); }
1074 
1075  // Used by ErrorInfo::classID.
1076  static char ID;
1077 
1078protected:
1079  ECError() = default;
1080  ECError(std::error_code EC) : EC(EC) {}
1081 
1082  std::error_code EC;
1083};
1084 
1085/// The value returned by this function can be returned from convertToErrorCode
1086/// for Error values where no sensible translation to std::error_code exists.
1087/// It should only be used in this situation, and should never be used where a
1088/// sensible conversion to std::error_code is available, as attempts to convert
1089/// to/from this error will result in a fatal error. (i.e. it is a programmatic
1090///error to try to convert such a value).
1091std::error_code inconvertibleErrorCode();
1092 
1093/// Helper for converting an std::error_code to a Error.
1094Error errorCodeToError(std::error_code EC);
1095 
1096/// Helper for converting an ECError to a std::error_code.
1097///
1098/// This method requires that Err be Error() or an ECError, otherwise it
1099/// will trigger a call to abort().
1100std::error_code errorToErrorCode(Error Err);
1101 
1102/// Convert an ErrorOr<T> to an Expected<T>.
1103template <typename T> Expected<T> errorOrToExpected(ErrorOr<T> &&EO) {
1104  if (auto EC = EO.getError())
1105    return errorCodeToError(EC);
1106  return std::move(*EO);
1107}
1108 
1109/// Convert an Expected<T> to an ErrorOr<T>.
1110template <typename T> ErrorOr<T> expectedToErrorOr(Expected<T> &&E) {
1111  if (auto Err = E.takeError())
1112    return errorToErrorCode(std::move(Err));
1113  return std::move(*E);
1114}
1115 
1116/// This class wraps a string in an Error.
1117///
1118/// StringError is useful in cases where the client is not expected to be able
1119/// to consume the specific error message programmatically (for example, if the
1120/// error message is to be presented to the user).
1121///
1122/// StringError can also be used when additional information is to be printed
1123/// along with a error_code message. Depending on the constructor called, this
1124/// class can either display:
1125///    1. the error_code message (ECError behavior)
1126///    2. a string
1127///    3. the error_code message and a string
1128///
1129/// These behaviors are useful when subtyping is required; for example, when a
1130/// specific library needs an explicit error type. In the example below,
1131/// PDBError is derived from StringError:
1132///
1133///   @code{.cpp}
1134///   Expected<int> foo() {
1135///      return llvm::make_error<PDBError>(pdb_error_code::dia_failed_loading,
1136///                                        "Additional information");
1137///   }
1138///   @endcode
1139///
1140class StringError : public ErrorInfo<StringError> {
1141public:
1142  static char ID;
1143 
1144  // Prints EC + S and converts to EC
1145  StringError(std::error_code EC, const Twine &S = Twine());
1146 
1147  // Prints S and converts to EC
1148  StringError(const Twine &S, std::error_code EC);
1149 
1150  void log(raw_ostream &OS) const override;
1151  std::error_code convertToErrorCode() const override;
1152 
1153  const std::string &getMessage() const { return Msg; }
1154 
1155private:
1156  std::string Msg;
1157  std::error_code EC;
1158  const bool PrintMsgOnly = false;
1159};
1160 
1161/// Create formatted StringError object.
1162template <typename... Ts>
1163Error createStringError(std::error_code EC, char const *Fmt,
1164                        const Ts &... Vals) {
1165  std::string Buffer;
1166  raw_string_ostream Stream(Buffer);
1167  Stream << format(Fmt, Vals...);
1168  return make_error<StringError>(Stream.str(), EC);
1169}
1170 
1171Error createStringError(std::error_code EC, char const *Msg);
1172 
1173/// This class wraps a filename and another Error.
1174///
1175/// In some cases, an error needs to live along a 'source' name, in order to
1176/// show more detailed information to the user.
1177class FileError final : public ErrorInfo<FileError> {
1178 
1179  friend Error createFileError(const Twine &, Error);
1180  friend Error createFileError(const Twine &, size_t, Error);
1181 
1182public:
1183  void log(raw_ostream &OS) const override {
1184    assert(Err && !FileName.empty() && "Trying to log after takeError().")((Err && !FileName.empty() && "Trying to log after takeError()."
) ? static_cast<void> (0) : __assert_fail ("Err && !FileName.empty() && \"Trying to log after takeError().\""
, "/build/llvm-toolchain-snapshot-9~svn362543/include/llvm/Support/Error.h"
, 1184, __PRETTY_FUNCTION__));
1185    OS << "'" << FileName << "': ";
1186    if (Line.hasValue())
1187      OS << "line " << Line.getValue() << ": ";
1188    Err->log(OS);
1189  }
1190 
1191  Error takeError() { return Error(std::move(Err)); }
1192 
1193  std::error_code convertToErrorCode() const override;
1194 
1195  // Used by ErrorInfo::classID.
1196  static char ID;
1197 
1198private:
1199  FileError(const Twine &F, Optional<size_t> LineNum,
1200            std::unique_ptr<ErrorInfoBase> E) {
1201    assert(E && "Cannot create FileError from Error success value.")((E && "Cannot create FileError from Error success value."
) ? static_cast<void> (0) : __assert_fail ("E && \"Cannot create FileError from Error success value.\""
, "/build/llvm-toolchain-snapshot-9~svn362543/include/llvm/Support/Error.h"
, 1201, __PRETTY_FUNCTION__));
1202    assert(!F.isTriviallyEmpty() &&((!F.isTriviallyEmpty() && "The file name provided to FileError must not be empty."
) ? static_cast<void> (0) : __assert_fail ("!F.isTriviallyEmpty() && \"The file name provided to FileError must not be empty.\""
, "/build/llvm-toolchain-snapshot-9~svn362543/include/llvm/Support/Error.h"
, 1203, __PRETTY_FUNCTION__))
1203           "The file name provided to FileError must not be empty.")((!F.isTriviallyEmpty() && "The file name provided to FileError must not be empty."
) ? static_cast<void> (0) : __assert_fail ("!F.isTriviallyEmpty() && \"The file name provided to FileError must not be empty.\""
, "/build/llvm-toolchain-snapshot-9~svn362543/include/llvm/Support/Error.h"
, 1203, __PRETTY_FUNCTION__));
1204    FileName = F.str();
1205    Err = std::move(E);
1206    Line = std::move(LineNum);
1207  }
1208 
1209  static Error build(const Twine &F, Optional<size_t> Line, Error E) {
1210    return Error(
1211        std::unique_ptr<FileError>(new FileError(F, Line, E.takePayload())));
1212  }
1213 
1214  std::string FileName;
1215  Optional<size_t> Line;
1216  std::unique_ptr<ErrorInfoBase> Err;
1217};
1218 
1219/// Concatenate a source file path and/or name with an Error. The resulting
1220/// Error is unchecked.
1221inline Error createFileError(const Twine &F, Error E) {
1222  return FileError::build(F, Optional<size_t>(), std::move(E));
1223}
1224 
1225/// Concatenate a source file path and/or name with line number and an Error.
1226/// The resulting Error is unchecked.
1227inline Error createFileError(const Twine &F, size_t Line, Error E) {
1228  return FileError::build(F, Optional<size_t>(Line), std::move(E));
1229}
1230 
1231/// Concatenate a source file path and/or name with a std::error_code 
1232/// to form an Error object.
1233inline Error createFileError(const Twine &F, std::error_code EC) {
1234  return createFileError(F, errorCodeToError(EC));
1235}
1236 
1237/// Concatenate a source file path and/or name with line number and
1238/// std::error_code to form an Error object.
1239inline Error createFileError(const Twine &F, size_t Line, std::error_code EC) {
1240  return createFileError(F, Line, errorCodeToError(EC));
1241}
1242 
1243Error createFileError(const Twine &F, ErrorSuccess) = delete;
1244 
1245/// Helper for check-and-exit error handling.
1246///
1247/// For tool use only. NOT FOR USE IN LIBRARY CODE.
1248///
1249class ExitOnError {
1250public:
1251  /// Create an error on exit helper.
1252  ExitOnError(std::string Banner = "", int DefaultErrorExitCode = 1)
1253      : Banner(std::move(Banner)),
1254        GetExitCode([=](const Error &) { return DefaultErrorExitCode; }) {}
1255 
1256  /// Set the banner string for any errors caught by operator().
1257  void setBanner(std::string Banner) { this->Banner = std::move(Banner); }
1258 
1259  /// Set the exit-code mapper function.
1260  void setExitCodeMapper(std::function<int(const Error &)> GetExitCode) {
1261    this->GetExitCode = std::move(GetExitCode);
1262  }
1263 
1264  /// Check Err. If it's in a failure state log the error(s) and exit.
1265  void operator()(Error Err) const { checkError(std::move(Err)); }
1266 
1267  /// Check E. If it's in a success state then return the contained value. If
1268  /// it's in a failure state log the error(s) and exit.
1269  template <typename T> T operator()(Expected<T> &&E) const {
1270    checkError(E.takeError());
1271    return std::move(*E);
1272  }
1273 
1274  /// Check E. If it's in a success state then return the contained reference. If
1275  /// it's in a failure state log the error(s) and exit.
1276  template <typename T> T& operator()(Expected<T&> &&E) const {
1277    checkError(E.takeError());
1278    return *E;
1279  }
1280 
1281private:
1282  void checkError(Error Err) const {
1283    if (Err) {
1284      int ExitCode = GetExitCode(Err);
1285      logAllUnhandledErrors(std::move(Err), errs(), Banner);
1286      exit(ExitCode);
1287    }
1288  }
1289 
1290  std::string Banner;
1291  std::function<int(const Error &)> GetExitCode;
1292};
1293 
1294/// Conversion from Error to LLVMErrorRef for C error bindings.
1295inline LLVMErrorRef wrap(Error Err) {
1296  return reinterpret_cast<LLVMErrorRef>(Err.takePayload().release());
1297}
1298 
1299/// Conversion from LLVMErrorRef to Error for C error bindings.
1300inline Error unwrap(LLVMErrorRef ErrRef) {
1301  return Error(std::unique_ptr<ErrorInfoBase>(
1302      reinterpret_cast<ErrorInfoBase *>(ErrRef)));
1303}
1304 
1305} // end namespace llvm
1306 
1307#endif // LLVM_SUPPORT_ERROR_H