LLVM 19.0.0git
Annotation2Metadata.cpp
Go to the documentation of this file.
1//===-- Annotation2Metadata.cpp - Add !annotation metadata. ---------------===//
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// Add !annotation metadata for entries in @llvm.global.anotations, generated
10// using __attribute__((annotate("_name"))) on functions in Clang.
11//
12//===----------------------------------------------------------------------===//
13
16#include "llvm/IR/Constants.h"
17#include "llvm/IR/Function.h"
19#include "llvm/IR/Module.h"
20#include "llvm/Transforms/IPO.h"
21
22using namespace llvm;
23
24#define DEBUG_TYPE "annotation2metadata"
25
27 // Only add !annotation metadata if the corresponding remarks pass is also
28 // enabled.
30 "annotation-remarks"))
31 return false;
32
33 auto *Annotations = M.getGlobalVariable("llvm.global.annotations");
34 auto *C = dyn_cast_or_null<Constant>(Annotations);
35 if (!C || C->getNumOperands() != 1)
36 return false;
37
38 C = cast<Constant>(C->getOperand(0));
39
40 // Iterate over all entries in C and attach !annotation metadata to suitable
41 // entries.
42 for (auto &Op : C->operands()) {
43 // Look at the operands to check if we can use the entry to generate
44 // !annotation metadata.
45 auto *OpC = dyn_cast<ConstantStruct>(&Op);
46 if (!OpC || OpC->getNumOperands() != 4)
47 continue;
48 auto *StrC = dyn_cast<GlobalValue>(OpC->getOperand(1)->stripPointerCasts());
49 if (!StrC)
50 continue;
51 auto *StrData = dyn_cast<ConstantDataSequential>(StrC->getOperand(0));
52 if (!StrData)
53 continue;
54 auto *Fn = dyn_cast<Function>(OpC->getOperand(0)->stripPointerCasts());
55 if (!Fn)
56 continue;
57
58 // Add annotation to all instructions in the function.
59 for (auto &I : instructions(Fn))
60 I.addAnnotationMetadata(StrData->getAsCString());
61 }
62 return true;
63}
64
69}
static bool convertAnnotation2Metadata(Module &M)
This file contains the declarations for the subclasses of Constant, which represent the different fla...
Select target instructions out of generic instructions
#define I(x, y, z)
Definition: MD5.cpp:58
Module.h This file contains the declarations for the Module class.
A container for analyses that lazily runs them and caches their results.
Definition: PassManager.h:348
Annotations lets you mark points and ranges inside source code, for tests:
Definition: Annotations.h:53
This class represents an Operation in the Expression.
A Module instance is used to store all the information related to an LLVM module.
Definition: Module.h:65
bool allowExtraAnalysis(StringRef PassName) const
Whether we allow for extra compile-time budget to perform more analysis to produce fewer false positi...
A set of analyses that are preserved following a run of a transformation pass.
Definition: Analysis.h:109
static PreservedAnalyses none()
Convenience factory function for the empty preserved set.
Definition: Analysis.h:112
static PreservedAnalyses all()
Construct a special preserved set that preserves all passes.
Definition: Analysis.h:115
@ C
The default llvm calling convention, compatible with C.
Definition: CallingConv.h:34
This is an optimization pass for GlobalISel generic memory operations.
Definition: AddressRanges.h:18
PreservedAnalyses run(Module &M, ModuleAnalysisManager &AM)