File: OptimizeWorkItemGVars.cc

package info (click to toggle)
pocl 6.0-6
  • links: PTS, VCS
  • area: main
  • in suites: trixie
  • size: 25,304 kB
  • sloc: lisp: 149,513; ansic: 103,778; cpp: 54,947; python: 1,513; sh: 949; ruby: 255; pascal: 226; tcl: 180; makefile: 173; java: 72; xml: 49
file content (143 lines) | stat: -rw-r--r-- 4,666 bytes parent folder | download | duplicates (2)
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
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
// OptimizeWorkItemGVars is an LLVM pass to optimize loads from "magic" extern
// global variables that are WI function related (_local_id_x etc).
//
// Copyright (c) 2024 Michal Babej / Intel Finland Oy
//
// This is unfortunately not optional; in some cases, if this pass is not run,
// LLVM optimizes switch cases with three loads (@_local_id_x, @_local_id_y...)
// into a Phi followed by a single load:
//   %p = phi [ @_local_id_x, %sw.branch.0 ], [ @_local_id_y, %sw.branch.1 ]...
//   load i64, ptr %p
//
// the Phi is then replaced by the phis2allocas pass with an alloca + stores &
// loads. Since the workgroup pass can only deal with loads from the special WI
// variables, this ends up leaving unresolved symbols in the final binary.
//
//
// TODO: we should replace the magic global variables (work-item ID
// placeholders) with function calls or intrinsics.
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
// THE SOFTWARE.

#include "CompilerWarnings.h"
IGNORE_COMPILER_WARNING("-Wmaybe-uninitialized")
#include <llvm/ADT/Twine.h>
POP_COMPILER_DIAGS
IGNORE_COMPILER_WARNING("-Wunused-parameter")
#include <llvm/IR/Constants.h>
#include <llvm/IR/IRBuilder.h>
#include <llvm/IR/Instructions.h>

#include "LLVMUtils.h"
#include "OptimizeWorkItemGVars.h"
#include "VariableUniformityAnalysis.h"
#include "WorkitemHandlerChooser.h"
POP_COMPILER_DIAGS

#include <iostream>
#include <map>
#include <set>

#define PASS_NAME "optimize-wi-gvars"
#define PASS_CLASS pocl::OptimizeWorkItemGVars
#define PASS_DESC "Optimize work-item global variable loads"

//#define DEBUG_OPTIMIZE_WI_GVARS

namespace pocl {

using namespace llvm;

static bool optimizeWorkItemGVars(Function &F) {

  bool Changed = false;

  Module *M = F.getParent();
  for (auto GVarName : WorkgroupVariablesVector) {
    GlobalVariable *GVar = M->getGlobalVariable(GVarName);
    if (!GVar)
      continue;
    if (!isGVarUsedByFunction(GVar, &F))
      continue;

#ifdef DEBUG_OPTIMIZE_WI_GVARS
    std::cerr << "; ######### Optimizing GVAR: " << GVarName << "\n";
#endif
    std::vector<LoadInst *> GVUsers;
    for (auto U : GVar->users()) {
      LoadInst *LI = dyn_cast<LoadInst>(U);
      if (LI == nullptr) {
#ifdef DEBUG_OPTIMIZE_WI_GVARS
        std::cerr << "; ######### ERROR: User is not LOAD\n";
        LI->dump();
#endif
        continue;
      }
      if (LI->getFunction() == &F) {
        GVUsers.push_back(LI);
      }
    }

    if (GVUsers.size() > 1) {
      Changed = true;
      IRBuilder<> Builder(&*(F.getEntryBlock().getFirstInsertionPt()));
      LoadInst *ReplLoad = Builder.CreateLoad(GVar->getValueType(), GVar,
                                              Twine(GVarName, "_load"));
      for (auto U : GVUsers) {
        U->replaceAllUsesWith(ReplLoad);
        U->eraseFromParent();
      }
    }
  }

  return Changed;
}

#if LLVM_MAJOR < MIN_LLVM_NEW_PASSMANAGER
char OptimizeWorkItemGVars::ID = 0;

bool OptimizeWorkItemGVars::runOnFunction(Function &F) {
  return optimizeWorkItemGVars(F);
}

void OptimizeWorkItemGVars::getAnalysisUsage(AnalysisUsage &AU) const {
  AU.addPreserved<WorkitemHandlerChooser>();
}

REGISTER_OLD_FPASS(PASS_NAME, PASS_CLASS, PASS_DESC);

#else

llvm::PreservedAnalyses
OptimizeWorkItemGVars::run(llvm::Function &F,
                           llvm::FunctionAnalysisManager &AM) {
  PreservedAnalyses PAChanged = PreservedAnalyses::none();
  PAChanged.preserve<WorkitemHandlerChooser>();

  if (!isKernelToProcess(F))
    return PreservedAnalyses::all();

  return optimizeWorkItemGVars(F) ? PAChanged : PreservedAnalyses::all();
}

REGISTER_NEW_FPASS(PASS_NAME, PASS_CLASS, PASS_DESC);

#endif

} // namespace pocl