File: UndefinedReferencesPass.cpp

package info (click to toggle)
intel-graphics-compiler2 2.16.0-2
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 106,644 kB
  • sloc: cpp: 805,640; lisp: 287,672; ansic: 16,414; python: 3,952; yacc: 2,588; lex: 1,666; pascal: 313; sh: 186; makefile: 35
file content (103 lines) | stat: -rw-r--r-- 3,995 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
/*========================== begin_copyright_notice ============================

Copyright (C) 2017-2021 Intel Corporation

SPDX-License-Identifier: MIT

============================= end_copyright_notice ===========================*/

#include "Compiler/Optimizer/OpenCLPasses/UndefinedReferences/UndefinedReferencesPass.hpp"
#include "Compiler/IGCPassSupport.h"
#include "Compiler/CodeGenPublic.h"

#include "common/LLVMWarningsPush.hpp"
#include <llvm/IR/Module.h>
#include <llvm/IR/Function.h>
#include "common/LLVMWarningsPop.hpp"
#include "GenISAIntrinsics/GenIntrinsics.h"

#include "Compiler/Optimizer/OpenCLPasses/BufferBoundsChecking/BufferBoundsCheckingPatcher.hpp"

using namespace llvm;
using namespace IGC;

// Register pass to igc-opt
#define PASS_FLAG "undefined-references"
#define PASS_DESCRIPTION "Emit linker warnings to user"
#define PASS_CFG_ONLY false
#define PASS_ANALYSIS true
IGC_INITIALIZE_PASS_BEGIN(UndefinedReferencesPass, PASS_FLAG, PASS_DESCRIPTION, PASS_CFG_ONLY, PASS_ANALYSIS)
IGC_INITIALIZE_PASS_END(UndefinedReferencesPass, PASS_FLAG, PASS_DESCRIPTION, PASS_CFG_ONLY, PASS_ANALYSIS)

char UndefinedReferencesPass::ID = 0;

UndefinedReferencesPass::UndefinedReferencesPass() : ModulePass(ID) {
  initializeUndefinedReferencesPassPass(*PassRegistry::getPassRegistry());
}

static void ReportUndefinedReference(CodeGenContext *CGC, StringRef name, Value *ctx) {
  std::string message;
  message += "undefined reference to `" + name.str() + "'";
  CGC->EmitError(message.c_str(), ctx);
}

///////////////////////////////////////////////////////////////////////////////
//
// ExistUndefinedReferencesInModule()
//
// LLVM's linker only does the job of tying together references across modules;
// for LLVM since a declaration in LLVM IR is perfectly valid, it does not make
// sense to check for any remaining undefined references.  Call this function
// after linking to determine this.  A true return value indicates there are
// undefined references, the errors will be reported to CodeGenContext as they
// are detected.
//
static bool ExistUndefinedReferencesInModule(Module &module, CodeGenContext *CGC) {
  bool foundUndef = false;

  Module::global_iterator GVarIter = module.global_begin();
  for (; GVarIter != module.global_end();) {
    GlobalVariable *pGVar = &(*GVarIter);

    // Increment the iterator before attempting to remove a global variable
    GVarIter++;

    if ((pGVar->hasAtLeastLocalUnnamedAddr() == false || pGVar->hasNUsesOrMore(1)) &&
        (pGVar->hasExternalLinkage() || pGVar->hasCommonLinkage())) {
      continue;
    }

    if (pGVar->isDeclaration() && pGVar->hasNUsesOrMore(1)) {
      ReportUndefinedReference(CGC, pGVar->getName(), pGVar);
      foundUndef = true;
    }

    if (!pGVar->isDeclaration() && pGVar->use_empty()) {
      // Remove the declaration
      pGVar->eraseFromParent();
    }
  }

  for (auto &F : module) {
    if (F.isDeclaration() && !F.isIntrinsic() && !GenISAIntrinsic::isIntrinsic(&F) && F.hasNUsesOrMore(1)) {
      StringRef funcName = F.getName();
      if (!funcName.startswith("__builtin_IB") && funcName != "printf" && !funcName.startswith("__builtin_bf16") &&
          !funcName.startswith("__igcbuiltin_") && !funcName.startswith("__translate_sampler_initializer") &&
          !funcName.startswith("_Z20__spirv_SampledImage") && !funcName.startswith("_Z21__spirv_VmeImageINTEL") &&
          funcName != BufferBoundsCheckingPatcher::BUFFER_SIZE_PLACEHOLDER_FUNCTION_NAME &&
          !F.hasFnAttribute("referenced-indirectly")) {
        ReportUndefinedReference(CGC, funcName, &F);
        foundUndef = true;
      }
    }
  }
  return foundUndef;
}

bool UndefinedReferencesPass::runOnModule(Module &M) {
  // At this point all references should have been linked to definitions, any
  // undefined references should generate errors.
  CodeGenContext *CGC = getAnalysis<CodeGenContextWrapper>().getCodeGenContext();
  ExistUndefinedReferencesInModule(M, CGC);
  return false;
}