xref: /freebsd/contrib/llvm-project/llvm/include/llvm/MC/MCSectionCOFF.h (revision 0fca6ea1d4eea4c934cfff25ac9ee8ad6fe95583)
1 //===- MCSectionCOFF.h - COFF Machine Code Sections -------------*- 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 // This file declares the MCSectionCOFF class.
10 //
11 //===----------------------------------------------------------------------===//
12 
13 #ifndef LLVM_MC_MCSECTIONCOFF_H
14 #define LLVM_MC_MCSECTIONCOFF_H
15 
16 #include "llvm/ADT/StringRef.h"
17 #include "llvm/BinaryFormat/COFF.h"
18 #include "llvm/MC/MCSection.h"
19 #include "llvm/MC/SectionKind.h"
20 #include <cassert>
21 
22 namespace llvm {
23 
24 class MCSymbol;
25 
26 /// This represents a section on Windows
27 class MCSectionCOFF final : public MCSection {
28   // FIXME: The following fields should not be mutable, but are for now so the
29   // asm parser can honor the .linkonce directive.
30 
31   /// This is the Characteristics field of a section, drawn from the enums
32   /// below.
33   mutable unsigned Characteristics;
34 
35   /// The unique IDs used with the .pdata and .xdata sections created internally
36   /// by the assembler. This ID is used to ensure that for every .text section,
37   /// there is exactly one .pdata and one .xdata section, which is required by
38   /// the Microsoft incremental linker. This data is mutable because this ID is
39   /// not notionally part of the section.
40   mutable unsigned WinCFISectionID = ~0U;
41 
42   /// The COMDAT symbol of this section. Only valid if this is a COMDAT section.
43   /// Two COMDAT sections are merged if they have the same COMDAT symbol.
44   MCSymbol *COMDATSymbol;
45 
46   /// This is the Selection field for the section symbol, if it is a COMDAT
47   /// section (Characteristics & IMAGE_SCN_LNK_COMDAT) != 0
48   mutable int Selection;
49 
50 private:
51   friend class MCContext;
52   // The storage of Name is owned by MCContext's COFFUniquingMap.
MCSectionCOFF(StringRef Name,unsigned Characteristics,MCSymbol * COMDATSymbol,int Selection,MCSymbol * Begin)53   MCSectionCOFF(StringRef Name, unsigned Characteristics,
54                 MCSymbol *COMDATSymbol, int Selection, MCSymbol *Begin)
55       : MCSection(SV_COFF, Name, Characteristics & COFF::IMAGE_SCN_CNT_CODE,
56                   Characteristics & COFF::IMAGE_SCN_CNT_UNINITIALIZED_DATA,
57                   Begin),
58         Characteristics(Characteristics), COMDATSymbol(COMDATSymbol),
59         Selection(Selection) {
60     assert((Characteristics & 0x00F00000) == 0 &&
61            "alignment must not be set upon section creation");
62   }
63 
64 public:
65   /// Decides whether a '.section' directive should be printed before the
66   /// section name
67   bool shouldOmitSectionDirective(StringRef Name, const MCAsmInfo &MAI) const;
68 
getCharacteristics()69   unsigned getCharacteristics() const { return Characteristics; }
getCOMDATSymbol()70   MCSymbol *getCOMDATSymbol() const { return COMDATSymbol; }
getSelection()71   int getSelection() const { return Selection; }
72 
73   void setSelection(int Selection) const;
74 
75   void printSwitchToSection(const MCAsmInfo &MAI, const Triple &T,
76                             raw_ostream &OS,
77                             uint32_t Subsection) const override;
78   bool useCodeAlign() const override;
79   StringRef getVirtualSectionKind() const override;
80 
getOrAssignWinCFISectionID(unsigned * NextID)81   unsigned getOrAssignWinCFISectionID(unsigned *NextID) const {
82     if (WinCFISectionID == ~0U)
83       WinCFISectionID = (*NextID)++;
84     return WinCFISectionID;
85   }
86 
isImplicitlyDiscardable(StringRef Name)87   static bool isImplicitlyDiscardable(StringRef Name) {
88     return Name.starts_with(".debug");
89   }
90 
classof(const MCSection * S)91   static bool classof(const MCSection *S) { return S->getVariant() == SV_COFF; }
92 };
93 
94 } // end namespace llvm
95 
96 #endif // LLVM_MC_MCSECTIONCOFF_H
97