LLVM 19.0.0git
RecordStreamer.h
Go to the documentation of this file.
1//===- RecordStreamer.h - Record asm defined and used symbols ---*- 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#ifndef LLVM_LIB_OBJECT_RECORDSTREAMER_H
10#define LLVM_LIB_OBJECT_RECORDSTREAMER_H
11
12#include "llvm/ADT/DenseMap.h"
13#include "llvm/ADT/StringMap.h"
15#include "llvm/MC/MCStreamer.h"
16#include "llvm/Support/SMLoc.h"
17#include <vector>
18
19namespace llvm {
20
21class MCSymbol;
22class Module;
23
24class RecordStreamer : public MCStreamer {
25public:
28
29private:
30 const Module &M;
31 StringMap<State> Symbols;
32 // Map of aliases created by .symver directives, saved so we can update
33 // their symbol binding after parsing complete. This maps from each
34 // aliasee to its list of aliases.
36
37 /// Get the state recorded for the given symbol.
38 State getSymbolState(const MCSymbol *Sym);
39
40 void markDefined(const MCSymbol &Symbol);
41 void markGlobal(const MCSymbol &Symbol, MCSymbolAttr Attribute);
42 void markUsed(const MCSymbol &Symbol);
43 void visitUsedSymbol(const MCSymbol &Sym) override;
44
45public:
46 RecordStreamer(MCContext &Context, const Module &M);
47
48 void emitLabel(MCSymbol *Symbol, SMLoc Loc = SMLoc()) override;
49 void emitAssignment(MCSymbol *Symbol, const MCExpr *Value) override;
50 bool emitSymbolAttribute(MCSymbol *Symbol, MCSymbolAttr Attribute) override;
51 void emitZerofill(MCSection *Section, MCSymbol *Symbol, uint64_t Size,
52 Align ByteAlignment, SMLoc Loc = SMLoc()) override;
54 Align ByteAlignment) override;
55
56 // Ignore COFF-specific directives; we do not need any information from them,
57 // but the default implementation of these methods crashes, so we override
58 // them with versions that do nothing.
59 void beginCOFFSymbolDef(const MCSymbol *Symbol) override {}
61 void emitCOFFSymbolType(int Type) override {}
62 void endCOFFSymbolDef() override {}
63
64 /// Record .symver aliases for later processing.
65 void emitELFSymverDirective(const MCSymbol *OriginalSym, StringRef Name,
66 bool KeepOriginalSym) override;
67
68 // Emit ELF .symver aliases and ensure they have the same binding as the
69 // defined symbol they alias with.
71
72 // Symbols iterators
76
77 // SymverAliasMap iterators
78 using const_symver_iterator = decltype(SymverAliasMap)::const_iterator;
80};
81
82} // end namespace llvm
83
84#endif // LLVM_LIB_OBJECT_RECORDSTREAMER_H
This file defines the StringMap class.
This file defines the DenseMap class.
std::string Name
uint64_t Size
Symbol * Sym
Definition: ELF_riscv.cpp:479
Machine Check Debug Module
Context object for machine code objects.
Definition: MCContext.h:83
Base class for the full range of assembler expressions which are needed for parsing.
Definition: MCExpr.h:35
Instances of this class represent a uniqued identifier for a section in the current translation unit.
Definition: MCSection.h:35
Streaming machine code generation interface.
Definition: MCStreamer.h:212
MCSymbol - Instances of this class represent a symbol name in the MC file, and MCSymbols are created ...
Definition: MCSymbol.h:41
A Module instance is used to store all the information related to an LLVM module.
Definition: Module.h:65
decltype(SymverAliasMap)::const_iterator const_symver_iterator
void emitZerofill(MCSection *Section, MCSymbol *Symbol, uint64_t Size, Align ByteAlignment, SMLoc Loc=SMLoc()) override
Emit the zerofill section and an optional symbol.
void endCOFFSymbolDef() override
Marks the end of the symbol definition.
bool emitSymbolAttribute(MCSymbol *Symbol, MCSymbolAttr Attribute) override
Add the given Attribute to Symbol.
void emitCommonSymbol(MCSymbol *Symbol, uint64_t Size, Align ByteAlignment) override
Emit a common symbol.
void emitELFSymverDirective(const MCSymbol *OriginalSym, StringRef Name, bool KeepOriginalSym) override
Record .symver aliases for later processing.
void emitAssignment(MCSymbol *Symbol, const MCExpr *Value) override
Emit an assignment of Value to Symbol.
iterator_range< const_symver_iterator > symverAliases()
void emitCOFFSymbolStorageClass(int StorageClass) override
Emit the storage class of the symbol.
StringMap< State >::const_iterator const_iterator
const_iterator end()
void beginCOFFSymbolDef(const MCSymbol *Symbol) override
Start emitting COFF symbol definition.
void emitLabel(MCSymbol *Symbol, SMLoc Loc=SMLoc()) override
Emit a label for Symbol into the current section.
void emitCOFFSymbolType(int Type) override
Emit the type of the symbol.
const_iterator begin()
Represents a location in source code.
Definition: SMLoc.h:23
StringMap - This is an unconventional map that is specialized for handling keys that are "strings",...
Definition: StringMap.h:128
StringRef - Represent a constant reference to a string, i.e.
Definition: StringRef.h:50
The instances of the Type class are immutable: once they are created, they are never changed.
Definition: Type.h:45
LLVM Value Representation.
Definition: Value.h:74
A range adaptor for a pair of iterators.
StorageClass
Definition: XCOFF.h:170
This is an optimization pass for GlobalISel generic memory operations.
Definition: AddressRanges.h:18
MCSymbolAttr
Definition: MCDirectives.h:18
This struct is a compact representation of a valid (non-zero power of two) alignment.
Definition: Alignment.h:39