LLVM  6.0.0svn
Comdat.h
Go to the documentation of this file.
1 //===- llvm/IR/Comdat.h - Comdat definitions --------------------*- C++ -*-===//
2 //
3 // The LLVM Compiler Infrastructure
4 //
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
7 //
8 //===----------------------------------------------------------------------===//
9 //
10 /// @file
11 /// This file contains the declaration of the Comdat class, which represents a
12 /// single COMDAT in LLVM.
13 //
14 //===----------------------------------------------------------------------===//
15 
16 #ifndef LLVM_IR_COMDAT_H
17 #define LLVM_IR_COMDAT_H
18 
19 namespace llvm {
20 
21 class raw_ostream;
22 class StringRef;
23 template <typename ValueTy> class StringMapEntry;
24 
25 // This is a Name X SelectionKind pair. The reason for having this be an
26 // independent object instead of just adding the name and the SelectionKind
27 // to a GlobalObject is that it is invalid to have two Comdats with the same
28 // name but different SelectionKind. This structure makes that unrepresentable.
29 class Comdat {
30 public:
32  Any, ///< The linker may choose any COMDAT.
33  ExactMatch, ///< The data referenced by the COMDAT must be the same.
34  Largest, ///< The linker will choose the largest COMDAT.
35  NoDuplicates, ///< No other Module may specify this COMDAT.
36  SameSize, ///< The data referenced by the COMDAT must be the same size.
37  };
38 
39  Comdat(const Comdat &) = delete;
40  Comdat(Comdat &&C);
41 
42  SelectionKind getSelectionKind() const { return SK; }
43  void setSelectionKind(SelectionKind Val) { SK = Val; }
44  StringRef getName() const;
45  void print(raw_ostream &OS, bool IsForDebug = false) const;
46  void dump() const;
47 
48 private:
49  friend class Module;
50 
51  Comdat();
52 
53  // Points to the map in Module.
54  StringMapEntry<Comdat> *Name = nullptr;
55  SelectionKind SK = Any;
56 };
57 
58 inline raw_ostream &operator<<(raw_ostream &OS, const Comdat &C) {
59  C.print(OS);
60  return OS;
61 }
62 
63 } // end namespace llvm
64 
65 #endif // LLVM_IR_COMDAT_H
uint64_t CallInst * C
Compute iterated dominance frontiers using a linear time algorithm.
Definition: AllocatorList.h:24
StringMapEntry - This is used to represent one value that is inserted into a StringMap.
Definition: StringMap.h:126
A Module instance is used to store all the information related to an LLVM module. ...
Definition: Module.h:63
The data referenced by the COMDAT must be the same size.
Definition: Comdat.h:36
The linker may choose any COMDAT.
Definition: Comdat.h:32
void dump() const
Definition: AsmWriter.cpp:3656
No other Module may specify this COMDAT.
Definition: Comdat.h:35
StringRef getName() const
Definition: Comdat.cpp:24
void print(raw_ostream &OS, bool IsForDebug=false) const
Definition: AsmWriter.cpp:3443
The data referenced by the COMDAT must be the same.
Definition: Comdat.h:33
void setSelectionKind(SelectionKind Val)
Definition: Comdat.h:43
The linker will choose the largest COMDAT.
Definition: Comdat.h:34
raw_ostream & operator<<(raw_ostream &OS, const APInt &I)
Definition: APInt.h:2018
This class implements an extremely fast bulk output stream that can only output to a stream...
Definition: raw_ostream.h:44
StringRef - Represent a constant reference to a string, i.e.
Definition: StringRef.h:49
SelectionKind getSelectionKind() const
Definition: Comdat.h:42