LLVM 19.0.0git
Comdat.h
Go to the documentation of this file.
1//===- llvm/IR/Comdat.h - Comdat definitions --------------------*- 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/// @file
10/// This file contains the declaration of the Comdat class, which represents a
11/// single COMDAT in LLVM.
12//
13//===----------------------------------------------------------------------===//
14
15#ifndef LLVM_IR_COMDAT_H
16#define LLVM_IR_COMDAT_H
17
18#include "llvm-c/Types.h"
21
22namespace llvm {
23
24class GlobalObject;
25class raw_ostream;
26class StringRef;
27template <typename ValueTy> class StringMapEntry;
28
29// This is a Name X SelectionKind pair. The reason for having this be an
30// independent object instead of just adding the name and the SelectionKind
31// to a GlobalObject is that it is invalid to have two Comdats with the same
32// name but different SelectionKind. This structure makes that unrepresentable.
33class Comdat {
34public:
36 Any, ///< The linker may choose any COMDAT.
37 ExactMatch, ///< The data referenced by the COMDAT must be the same.
38 Largest, ///< The linker will choose the largest COMDAT.
39 NoDeduplicate, ///< No deduplication is performed.
40 SameSize, ///< The data referenced by the COMDAT must be the same size.
41 };
42
43 Comdat(const Comdat &) = delete;
44 Comdat(Comdat &&C);
45
46 SelectionKind getSelectionKind() const { return SK; }
47 void setSelectionKind(SelectionKind Val) { SK = Val; }
48 StringRef getName() const;
49 void print(raw_ostream &OS, bool IsForDebug = false) const;
50 void dump() const;
51 const SmallPtrSetImpl<GlobalObject *> &getUsers() const { return Users; }
52
53private:
54 friend class Module;
55 friend class GlobalObject;
56
57 Comdat();
58 void addUser(GlobalObject *GO);
59 void removeUser(GlobalObject *GO);
60
61 // Points to the map in Module.
63 SelectionKind SK = Any;
64 // Globals using this comdat.
66};
67
68// Create wrappers for C Binding types (see CBindingWrapping.h).
70
72 C.print(OS);
73 return OS;
74}
75
76} // end namespace llvm
77
78#endif // LLVM_IR_COMDAT_H
aarch64 promote const
always inline
#define DEFINE_SIMPLE_CONVERSION_FUNCTIONS(ty, ref)
std::string Name
iv Induction Variable Users
Definition: IVUsers.cpp:48
raw_pwrite_stream & OS
This file defines the SmallPtrSet class.
Comdat(const Comdat &)=delete
void print(raw_ostream &OS, bool IsForDebug=false) const
Definition: AsmWriter.cpp:4808
StringRef getName() const
Definition: Comdat.cpp:28
void dump() const
Definition: AsmWriter.cpp:5173
const SmallPtrSetImpl< GlobalObject * > & getUsers() const
Definition: Comdat.h:51
@ Largest
The linker will choose the largest COMDAT.
Definition: Comdat.h:38
@ SameSize
The data referenced by the COMDAT must be the same size.
Definition: Comdat.h:40
@ Any
The linker may choose any COMDAT.
Definition: Comdat.h:36
@ NoDeduplicate
No deduplication is performed.
Definition: Comdat.h:39
@ ExactMatch
The data referenced by the COMDAT must be the same.
Definition: Comdat.h:37
void setSelectionKind(SelectionKind Val)
Definition: Comdat.h:47
SelectionKind getSelectionKind() const
Definition: Comdat.h:46
A Module instance is used to store all the information related to an LLVM module.
Definition: Module.h:65
A templated base class for SmallPtrSet which provides the typesafe interface that is common across al...
Definition: SmallPtrSet.h:321
SmallPtrSet - This class implements a set which is optimized for holding SmallSize or less elements.
Definition: SmallPtrSet.h:427
StringMapEntry - This is used to represent one value that is inserted into a StringMap.
StringRef - Represent a constant reference to a string, i.e.
Definition: StringRef.h:50
This class implements an extremely fast bulk output stream that can only output to a stream.
Definition: raw_ostream.h:52
struct LLVMComdat * LLVMComdatRef
Definition: Types.h:155
@ 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