xref: /freebsd/contrib/llvm-project/llvm/lib/Target/NVPTX/NVPTXUtilities.h (revision 972a253a57b6f144b0e4a3e2080a2a0076ec55a0)
1 //===-- NVPTXUtilities - Utilities -----------------------------*- 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 contains the declaration of the NVVM specific utility functions.
10 //
11 //===----------------------------------------------------------------------===//
12 
13 #ifndef LLVM_LIB_TARGET_NVPTX_NVPTXUTILITIES_H
14 #define LLVM_LIB_TARGET_NVPTX_NVPTXUTILITIES_H
15 
16 #include "llvm/IR/Function.h"
17 #include "llvm/IR/GlobalVariable.h"
18 #include "llvm/IR/IntrinsicInst.h"
19 #include "llvm/IR/Value.h"
20 #include <cstdarg>
21 #include <set>
22 #include <string>
23 #include <vector>
24 
25 namespace llvm {
26 
27 void clearAnnotationCache(const Module *);
28 
29 bool findOneNVVMAnnotation(const GlobalValue *, const std::string &,
30                            unsigned &);
31 bool findAllNVVMAnnotation(const GlobalValue *, const std::string &,
32                            std::vector<unsigned> &);
33 
34 bool isTexture(const Value &);
35 bool isSurface(const Value &);
36 bool isSampler(const Value &);
37 bool isImage(const Value &);
38 bool isImageReadOnly(const Value &);
39 bool isImageWriteOnly(const Value &);
40 bool isImageReadWrite(const Value &);
41 bool isManaged(const Value &);
42 
43 std::string getTextureName(const Value &);
44 std::string getSurfaceName(const Value &);
45 std::string getSamplerName(const Value &);
46 
47 bool getMaxNTIDx(const Function &, unsigned &);
48 bool getMaxNTIDy(const Function &, unsigned &);
49 bool getMaxNTIDz(const Function &, unsigned &);
50 
51 bool getReqNTIDx(const Function &, unsigned &);
52 bool getReqNTIDy(const Function &, unsigned &);
53 bool getReqNTIDz(const Function &, unsigned &);
54 
55 bool getMinCTASm(const Function &, unsigned &);
56 bool getMaxNReg(const Function &, unsigned &);
57 bool isKernelFunction(const Function &);
58 
59 bool getAlign(const Function &, unsigned index, unsigned &);
60 bool getAlign(const CallInst &, unsigned index, unsigned &);
61 
62 // PTX ABI requires all scalar argument/return values to have
63 // bit-size as a power of two of at least 32 bits.
64 inline unsigned promoteScalarArgumentSize(unsigned size) {
65   if (size <= 32)
66     return 32;
67   else if (size <= 64)
68     return 64;
69   else
70     return size;
71 }
72 }
73 
74 #endif
75