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
|
/*========================== begin_copyright_notice ============================
Copyright (C) 2017-2021 Intel Corporation
SPDX-License-Identifier: MIT
============================= end_copyright_notice ===========================*/
#pragma once
#include "Compiler/MetaDataUtilsWrapper.h"
#include "common/LLVMWarningsPush.hpp"
#include <llvm/Pass.h>
#include <llvm/IR/InstVisitor.h>
#include "common/LLVMWarningsPop.hpp"
namespace IGC {
/// @brief OpenCLPrintf Pass checks if there are printf calls inside a kernel
/// and adds two implicit arguments for printf output buffer and
/// maximum size of the buffer.
class OpenCLPrintfAnalysis : public llvm::ModulePass, public llvm::InstVisitor<OpenCLPrintfAnalysis> {
public:
// Pass identification, replacement for typeid
static char ID;
/// @brief Constructor
OpenCLPrintfAnalysis();
/// @brief Destructor
~OpenCLPrintfAnalysis() {}
/// @brief Provides name of pass
virtual llvm::StringRef getPassName() const override { return "OpenCLPrintfAnalysis"; }
void getAnalysisUsage(llvm::AnalysisUsage &AU) const override { AU.addRequired<MetaDataUtilsWrapper>(); }
/// @brief Main entry point.
/// @param M The destination module.
virtual bool runOnModule(llvm::Module &M) override;
void visitCallInst(llvm::CallInst &callInst);
static const llvm::StringRef OPENCL_PRINTF_FUNCTION_NAME;
static const llvm::StringRef ONEAPI_PRINTF_FUNCTION_NAME;
static const llvm::StringRef BUILTIN_PRINTF_FUNCTION_NAME;
static bool isOpenCLPrintf(const llvm::Function *F);
static bool isOneAPIPrintf(const llvm::Function *F);
static bool isBuiltinPrintf(const llvm::Function *F);
// Return true if every top level user of a string literal is a printf
// call. Note that the function is expected to work only before printf
// expansion.
static bool isPrintfOnlyStringConstant(const llvm::GlobalVariable *GV);
private:
/// @brief Adds an implicit argument for address of printf output buffer
/// created by the Runtime and an implicit argument for maximum
/// size of the buffer.
void addPrintfBufferArgs(llvm::Function &F);
std::unordered_set<llvm::Function *> m_hasPrintfs;
/// @brief MetaData utils used to generate LLVM metadata
IGCMD::MetaDataUtils *m_pMDUtils = nullptr;
};
} // namespace IGC
|
