LLVM 17.0.0git
Go to the documentation of this file.
1//===-- Annotation2Metadata.cpp - Add !annotation metadata. ---------------===//
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
9// Add !annotation metadata for entries in @llvm.global.anotations, generated
10// using __attribute__((annotate("_name"))) on functions in Clang.
16#include "llvm/IR/Constants.h"
17#include "llvm/IR/Function.h"
19#include "llvm/IR/Module.h"
21#include "llvm/Pass.h"
22#include "llvm/Transforms/IPO.h"
24using namespace llvm;
26#define DEBUG_TYPE "annotation2metadata"
29 // Only add !annotation metadata if the corresponding remarks pass is also
30 // enabled.
32 "annotation-remarks"))
33 return false;
35 auto *Annotations = M.getGlobalVariable("llvm.global.annotations");
36 auto *C = dyn_cast_or_null<Constant>(Annotations);
37 if (!C || C->getNumOperands() != 1)
38 return false;
40 C = cast<Constant>(C->getOperand(0));
42 // Iterate over all entries in C and attach !annotation metadata to suitable
43 // entries.
44 for (auto &Op : C->operands()) {
45 // Look at the operands to check if we can use the entry to generate
46 // !annotation metadata.
47 auto *OpC = dyn_cast<ConstantStruct>(&Op);
48 if (!OpC || OpC->getNumOperands() != 4)
49 continue;
50 auto *StrC = dyn_cast<GlobalValue>(OpC->getOperand(1)->stripPointerCasts());
51 if (!StrC)
52 continue;
53 auto *StrData = dyn_cast<ConstantDataSequential>(StrC->getOperand(0));
54 if (!StrData)
55 continue;
56 auto *Fn = dyn_cast<Function>(OpC->getOperand(0)->stripPointerCasts());
57 if (!Fn)
58 continue;
60 // Add annotation to all instructions in the function.
61 for (auto &I : instructions(Fn))
62 I.addAnnotationMetadata(StrData->getAsCString());
63 }
64 return true;
static bool convertAnnotation2Metadata(Module &M)
This file contains the declarations for the subclasses of Constant, which represent the different fla...
#define I(x, y, z)
Definition: MD5.cpp:58
Module.h This file contains the declarations for the Module class.
print must be executed print the must be executed context for all instructions
A container for analyses that lazily runs them and caches their results.
Definition: PassManager.h:620
Annotations lets you mark points and ranges inside source code, for tests:
Definition: Annotations.h:53
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: PassManager.h:152
static PreservedAnalyses none()
Convenience factory function for the empty preserved set.
Definition: PassManager.h:155
static PreservedAnalyses all()
Construct a special preserved set that preserves all passes.
Definition: PassManager.h:158
@ 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)