1f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot//===-- llvm/MC/SectionKind.h - Classification of sections ------*- C++ -*-===// 2f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot// 3f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot// The LLVM Compiler Infrastructure 4f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot// 5f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot// This file is distributed under the University of Illinois Open Source 6f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot// License. See LICENSE.TXT for details. 7f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot// 8f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot//===----------------------------------------------------------------------===// 9f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot 10f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot#ifndef LLVM_MC_SECTIONKIND_H 11f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot#define LLVM_MC_SECTIONKIND_H 12f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot 13f3014761c955345d6e05491608e73228d014afbandroid-build-team Robotnamespace llvm { 14f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot 15f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot/// SectionKind - This is a simple POD value that classifies the properties of 16f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot/// a section. A section is classified into the deepest possible 17f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot/// classification, and then the target maps them onto their sections based on 18f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot/// what capabilities they have. 19f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot/// 20f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot/// The comments below describe these as if they were an inheritance hierarchy 21f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot/// in order to explain the predicates below. 22f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot/// 23f3014761c955345d6e05491608e73228d014afbandroid-build-team Robotclass SectionKind { 24f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot enum Kind { 25f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot /// Metadata - Debug info sections or other metadata. 26f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot Metadata, 27f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot 28f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot /// Text - Text section, used for functions and other executable code. 29f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot Text, 30f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot 31f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot /// ExecuteOnly, Text section that is not readable. 32f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot ExecuteOnly, 33f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot 34f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot /// ReadOnly - Data that is never written to at program runtime by the 35f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot /// program or the dynamic linker. Things in the top-level readonly 36f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot /// SectionKind are not mergeable. 37f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot ReadOnly, 38f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot 39f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot /// MergableCString - Any null-terminated string which allows merging. 40f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot /// These values are known to end in a nul value of the specified size, 41f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot /// not otherwise contain a nul value, and be mergable. This allows the 42f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot /// linker to unique the strings if it so desires. 43f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot 44f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot /// Mergeable1ByteCString - 1 byte mergable, null terminated, string. 45f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot Mergeable1ByteCString, 46f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot 47f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot /// Mergeable2ByteCString - 2 byte mergable, null terminated, string. 48f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot Mergeable2ByteCString, 49f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot 50f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot /// Mergeable4ByteCString - 4 byte mergable, null terminated, string. 51f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot Mergeable4ByteCString, 52f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot 53f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot /// MergeableConst - These are sections for merging fixed-length 54f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot /// constants together. For example, this can be used to unique 55f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot /// constant pool entries etc. 56f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot 57f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot /// MergeableConst4 - This is a section used by 4-byte constants, 58f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot /// for example, floats. 59f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot MergeableConst4, 60f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot 61f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot /// MergeableConst8 - This is a section used by 8-byte constants, 62f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot /// for example, doubles. 63f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot MergeableConst8, 64f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot 65f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot /// MergeableConst16 - This is a section used by 16-byte constants, 66f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot /// for example, vectors. 67f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot MergeableConst16, 68f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot 69f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot /// MergeableConst32 - This is a section used by 32-byte constants, 70f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot /// for example, vectors. 71f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot MergeableConst32, 72f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot 73f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot /// Writeable - This is the base of all segments that need to be written 74f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot /// to during program runtime. 75f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot 76f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot /// ThreadLocal - This is the base of all TLS segments. All TLS 77f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot /// objects must be writeable, otherwise there is no reason for them to 78f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot /// be thread local! 79f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot 80f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot /// ThreadBSS - Zero-initialized TLS data objects. 81f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot ThreadBSS, 82f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot 83f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot /// ThreadData - Initialized TLS data objects. 84f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot ThreadData, 85f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot 86f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot /// GlobalWriteableData - Writeable data that is global (not thread 87f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot /// local). 88f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot 89f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot /// BSS - Zero initialized writeable data. 90f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot BSS, 91f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot 92f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot /// BSSLocal - This is BSS (zero initialized and writable) data 93f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot /// which has local linkage. 94f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot BSSLocal, 95f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot 96f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot /// BSSExtern - This is BSS data with normal external linkage. 97f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot BSSExtern, 98f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot 99f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot /// Common - Data with common linkage. These represent tentative 100f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot /// definitions, which always have a zero initializer and are never 101f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot /// marked 'constant'. 102f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot Common, 103f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot 104f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot /// This is writeable data that has a non-zero initializer. 105f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot Data, 106f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot 107f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot /// ReadOnlyWithRel - These are global variables that are never 108f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot /// written to by the program, but that have relocations, so they 109f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot /// must be stuck in a writeable section so that the dynamic linker 110f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot /// can write to them. If it chooses to, the dynamic linker can 111f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot /// mark the pages these globals end up on as read-only after it is 112f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot /// done with its relocation phase. 113f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot ReadOnlyWithRel 114f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot } K : 8; 115f3014761c955345d6e05491608e73228d014afbandroid-build-team Robotpublic: 116f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot 117f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot bool isMetadata() const { return K == Metadata; } 118f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot 119f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot bool isText() const { return K == Text || K == ExecuteOnly; } 120f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot 121f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot bool isExecuteOnly() const { return K == ExecuteOnly; } 122f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot 123f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot bool isReadOnly() const { 124f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot return K == ReadOnly || isMergeableCString() || 125f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot isMergeableConst(); 126f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot } 127f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot 128f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot bool isMergeableCString() const { 129f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot return K == Mergeable1ByteCString || K == Mergeable2ByteCString || 130f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot K == Mergeable4ByteCString; 131f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot } 132f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot bool isMergeable1ByteCString() const { return K == Mergeable1ByteCString; } 133f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot bool isMergeable2ByteCString() const { return K == Mergeable2ByteCString; } 134f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot bool isMergeable4ByteCString() const { return K == Mergeable4ByteCString; } 135f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot 136f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot bool isMergeableConst() const { 137f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot return K == MergeableConst4 || K == MergeableConst8 || 138f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot K == MergeableConst16 || K == MergeableConst32; 139f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot } 140f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot bool isMergeableConst4() const { return K == MergeableConst4; } 141f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot bool isMergeableConst8() const { return K == MergeableConst8; } 142f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot bool isMergeableConst16() const { return K == MergeableConst16; } 143f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot bool isMergeableConst32() const { return K == MergeableConst32; } 144f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot 145f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot bool isWriteable() const { 146f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot return isThreadLocal() || isGlobalWriteableData(); 147f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot } 148f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot 149f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot bool isThreadLocal() const { 150f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot return K == ThreadData || K == ThreadBSS; 151f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot } 152f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot 153f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot bool isThreadBSS() const { return K == ThreadBSS; } 154f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot bool isThreadData() const { return K == ThreadData; } 155f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot 156f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot bool isGlobalWriteableData() const { 157f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot return isBSS() || isCommon() || isData() || isReadOnlyWithRel(); 158f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot } 159f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot 160f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot bool isBSS() const { return K == BSS || K == BSSLocal || K == BSSExtern; } 161f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot bool isBSSLocal() const { return K == BSSLocal; } 162f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot bool isBSSExtern() const { return K == BSSExtern; } 163f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot 164f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot bool isCommon() const { return K == Common; } 165f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot 166f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot bool isData() const { return K == Data; } 167f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot 168f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot bool isReadOnlyWithRel() const { 169f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot return K == ReadOnlyWithRel; 170f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot } 171f3014761c955345d6e05491608e73228d014afbandroid-build-team Robotprivate: 172f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot static SectionKind get(Kind K) { 173f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot SectionKind Res; 174f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot Res.K = K; 175f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot return Res; 176f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot } 177f3014761c955345d6e05491608e73228d014afbandroid-build-team Robotpublic: 178f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot 179f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot static SectionKind getMetadata() { return get(Metadata); } 180f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot static SectionKind getText() { return get(Text); } 181f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot static SectionKind getExecuteOnly() { return get(ExecuteOnly); } 182f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot static SectionKind getReadOnly() { return get(ReadOnly); } 183f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot static SectionKind getMergeable1ByteCString() { 184f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot return get(Mergeable1ByteCString); 185f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot } 186f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot static SectionKind getMergeable2ByteCString() { 187f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot return get(Mergeable2ByteCString); 188f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot } 189f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot static SectionKind getMergeable4ByteCString() { 190f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot return get(Mergeable4ByteCString); 191f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot } 192f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot static SectionKind getMergeableConst4() { return get(MergeableConst4); } 193f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot static SectionKind getMergeableConst8() { return get(MergeableConst8); } 194f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot static SectionKind getMergeableConst16() { return get(MergeableConst16); } 195f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot static SectionKind getMergeableConst32() { return get(MergeableConst32); } 196f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot static SectionKind getThreadBSS() { return get(ThreadBSS); } 197f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot static SectionKind getThreadData() { return get(ThreadData); } 198f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot static SectionKind getBSS() { return get(BSS); } 199f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot static SectionKind getBSSLocal() { return get(BSSLocal); } 200f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot static SectionKind getBSSExtern() { return get(BSSExtern); } 201f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot static SectionKind getCommon() { return get(Common); } 202f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot static SectionKind getData() { return get(Data); } 203f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot static SectionKind getReadOnlyWithRel() { return get(ReadOnlyWithRel); } 204f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot}; 205f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot 206f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot} // end namespace llvm 207f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot 208f3014761c955345d6e05491608e73228d014afbandroid-build-team Robot#endif 209