13 #ifndef LLVM_BINARYFORMAT_XCOFF_H
14 #define LLVM_BINARYFORMAT_XCOFF_H
21 template <
unsigned>
class SmallString;
22 template <
typename T>
class Expected;
140 SSUBTYP_DWLINE = 0x2'0000,
142 SSUBTYP_DWPBTYP = 0x4'0000,
144 SSUBTYP_DWABREV = 0x6'0000,
146 SSUBTYP_DWRNGES = 0x8'0000,
148 SSUBTYP_DWFRAME = 0xA'0000,
152 // STORAGE CLASSES, n_sclass field of syment.
153 // The values come from `storclass.h` and `dbxstclass.h`.
154 enum StorageClass : uint8_t {
155 // Storage classes used for symbolic debugging symbols.
156 C_FILE = 103, // File name
157 C_BINCL = 108, // Beginning of include file
158 C_EINCL = 109, // Ending of include file
159 C_GSYM = 128, // Global variable
160 C_STSYM = 133, // Statically allocated symbol
161 C_BCOMM = 135, // Beginning of common block
162 C_ECOMM = 137, // End of common block
163 C_ENTRY = 141, // Alternate entry
164 C_BSTAT = 143, // Beginning of static block
165 C_ESTAT = 144, // End of static block
166 C_GTLS = 145, // Global thread-local variable
167 C_STTLS = 146, // Static thread-local variable
169 // Storage classes used for DWARF symbols.
170 C_DWARF = 112, // DWARF section symbol
172 // Storage classes used for absolute symbols.
173 C_LSYM = 129, // Automatic variable allocated on stack
174 C_PSYM = 130, // Argument to subroutine allocated on stack
175 C_RSYM = 131, // Register variable
176 C_RPSYM = 132, // Argument to function or procedure stored in register
177 C_ECOML = 136, // Local member of common block
178 C_FUN = 142, // Function or procedure
180 // Storage classes used for undefined external symbols or
181 // symbols of general sections.
182 C_EXT = 2, // External symbol
183 C_WEAKEXT = 111, // Weak external symbol
185 // Storage classes used for symbols of general sections.
187 C_STAT = 3, // Static
188 C_BLOCK = 100, // ".bb" or ".eb"
189 C_FCN = 101, // ".bf" or ".ef"
190 C_HIDEXT = 107, // Un-named external symbol
191 C_INFO = 110, // Comment string in .info section
192 C_DECL = 140, // Declaration of object (type)
194 // Storage classes - Obsolete/Undocumented.
195 C_AUTO = 1, // Automatic variable
196 C_REG = 4, // Register variable
197 C_EXTDEF = 5, // External definition
198 C_LABEL = 6, // Label
199 C_ULABEL = 7, // Undefined label
200 C_MOS = 8, // Member of structure
201 C_ARG = 9, // Function argument
202 C_STRTAG = 10, // Structure tag
203 C_MOU = 11, // Member of union
204 C_UNTAG = 12, // Union tag
205 C_TPDEF = 13, // Type definition
206 C_USTATIC = 14, // Undefined static
207 C_ENTAG = 15, // Enumeration tag
208 C_MOE = 16, // Member of enumeration
209 C_REGPARM = 17, // Register parameter
210 C_FIELD = 18, // Bit field
211 C_EOS = 102, // End of structure
213 C_ALIAS = 105, // Duplicate tag
214 C_HIDDEN = 106, // Special storage class for external
215 C_EFCN = 255, // Physical end of function
217 // Storage classes - reserved
218 C_TCSYM = 134 // Reserved
221 // Flags for defining the symbol type. Values to be encoded into the lower 3
222 // bits of the (unsigned, 8-bit) x_smtyp field of csect auxiliary symbol table
223 // entries. Defined in the system header `syms.h`.
224 enum SymbolType : uint8_t {
225 XTY_ER = 0, ///< External reference.
226 XTY_SD = 1, ///< Csect definition for initialized storage.
227 XTY_LD = 2, ///< Label definition.
229 XTY_CM = 3 ///< Common csect definition. For uninitialized storage.
235 enum VisibilityType : uint16_t {
236 SYM_V_UNSPECIFIED = 0x0000,
237 SYM_V_INTERNAL = 0x1000,
238 SYM_V_HIDDEN = 0x2000,
239 SYM_V_PROTECTED = 0x3000,
240 SYM_V_EXPORTED = 0x4000
243 constexpr uint16_t VISIBILITY_MASK = 0x7000;
245 // Relocation types, defined in `/usr/include/reloc.h`.
246 enum RelocationType : uint8_t {
247 R_POS = 0x00, ///< Positive relocation. Provides the address of the referenced
249 R_RL = 0x0c, ///< Positive indirect load relocation. Modifiable instruction.
250 R_RLA = 0x0d, ///< Positive load address relocation. Modifiable instruction.
252 R_NEG = 0x01, ///< Negative relocation. Provides the negative of the address
254 R_REL = 0x02, ///< Relative to self relocation. Provides a displacement value
258 R_TOC = 0x03, ///< Relative to the TOC relocation. Provides a displacement
261 R_TRL = 0x12, ///< TOC relative indirect load relocation. Similar to R_TOC,
265 0x13, ///< Relative to the TOC or to the thread-local storage base
271 R_GL = 0x05, ///< Global linkage-external TOC address relocation. Provides the
274 R_TCL = 0x06, ///< Local object TOC address relocation. Provides the address
277 R_REF = 0x0f, ///< A non-relocating relocation. Used to prevent the binder
282 R_BA = 0x08, ///< Branch absolute relocation. Provides the address of the
284 R_BR = 0x0a, ///< Branch relative to self relocation. Provides the
288 R_RBA = 0x18, ///< Branch absolute relocation. Similar to R_BA but
290 R_RBR = 0x1a, ///< Branch relative to self relocation. Similar to the R_BR
293 R_TLS = 0x20, ///< General-dynamic reference to TLS symbol.
294 R_TLS_IE = 0x21, ///< Initial-exec reference to TLS symbol.
295 R_TLS_LD = 0x22, ///< Local-dynamic reference to TLS symbol.
296 R_TLS_LE = 0x23, ///< Local-exec reference to TLS symbol.
297 R_TLSM = 0x24, ///< Module reference to TLS. Provides a handle for the module
299 R_TLSML = 0x25, ///< Module reference to the local TLS storage.
301 R_TOCU = 0x30, ///< Relative to TOC upper. Specifies the high-order 16 bits of
303 R_TOCL = 0x31 ///< Relative to TOC lower. Specifies the low-order 16 bits of a
307 enum CFileStringType : uint8_t {
308 XFT_FN = 0, ///< Specifies the source-file name.
309 XFT_CT = 1, ///< Specifies the compiler time stamp.
310 XFT_CV = 2, ///< Specifies the compiler version number.
311 XFT_CD = 128 ///< Specifies compiler-defined information.
314 enum CFileLangId : uint8_t {
315 TB_C = 0, ///< C language.
316 TB_CPLUSPLUS = 9 ///< C++ language.
319 enum CFileCpuId : uint8_t {
320 TCPU_PPC64 = 2, ///< PowerPC common architecture 64-bit mode.
321 TCPU_COM = 3, ///< POWER and PowerPC architecture common.
322 TCPU_970 = 19 ///< PPC970 - PowerPC 64-bit architecture.
325 enum SymbolAuxType : uint8_t {
326 AUX_EXCEPT = 255, ///< Identifies an exception auxiliary entry.
327 AUX_FCN = 254, ///< Identifies a function auxiliary entry.
328 AUX_SYM = 253, ///< Identifies a symbol auxiliary entry.
329 AUX_FILE = 252, ///< Identifies a file auxiliary entry.
330 AUX_CSECT = 251, ///< Identifies a csect auxiliary entry.
331 AUX_SECT = 250 ///< Identifies a SECT auxiliary entry.
332 }; // 64-bit XCOFF file only.
334 StringRef getMappingClassString(XCOFF::StorageMappingClass SMC);
335 StringRef getRelocationTypeString(XCOFF::RelocationType Type);
336 Expected<SmallString<32>> parseParmsType(uint32_t Value, unsigned FixedParmsNum,
337 unsigned FloatingParmsNum);
338 Expected<SmallString<32>> parseParmsTypeWithVecInfo(uint32_t Value,
339 unsigned FixedParmsNum,
340 unsigned FloatingParmsNum,
341 unsigned VectorParmsNum);
342 Expected<SmallString<32>> parseVectorParmsType(uint32_t Value,
345 struct TracebackTable {
346 enum LanguageID : uint8_t {
365 static constexpr uint32_t VersionMask = 0xFF00'0000;
366 static constexpr uint8_t VersionShift = 24;
369 static constexpr
uint32_t LanguageIdMask = 0x00FF
'0000;
370 static constexpr uint8_t LanguageIdShift = 16;
373 static constexpr uint32_t IsGlobaLinkageMask = 0x0000'8000;
374 static constexpr
uint32_t IsOutOfLineEpilogOrPrologueMask = 0x0000
'4000;
375 static constexpr uint32_t HasTraceBackTableOffsetMask = 0x0000'2000;
376 static constexpr
uint32_t IsInternalProcedureMask = 0x0000
'1000;
377 static constexpr uint32_t HasControlledStorageMask = 0x0000'0800;
378 static constexpr
uint32_t IsTOClessMask = 0x0000
'0400;
379 static constexpr uint32_t IsFloatingPointPresentMask = 0x0000'0200;
380 static constexpr
uint32_t IsFloatingPointOperationLogOrAbortEnabledMask =
384 static constexpr uint32_t IsInterruptHandlerMask = 0x0000'0080;
385 static constexpr
uint32_t IsFunctionNamePresentMask = 0x0000
'0040;
386 static constexpr uint32_t IsAllocaUsedMask = 0x0000'0020;
387 static constexpr
uint32_t OnConditionDirectiveMask = 0x0000
'001C;
388 static constexpr uint32_t IsCRSavedMask = 0x0000'0002;
389 static constexpr
uint32_t IsLRSavedMask = 0x0000
'0001;
390 static constexpr uint8_t OnConditionDirectiveShift = 2;
393 static constexpr uint32_t IsBackChainStoredMask = 0x8000'0000;
394 static constexpr
uint32_t IsFixupMask = 0x4000
'0000;
395 static constexpr uint32_t FPRSavedMask = 0x3F00'0000;
399 static constexpr
uint32_t HasExtensionTableMask = 0x0080
'0000;
400 static constexpr uint32_t HasVectorInfoMask = 0x0040'0000;
401 static constexpr
uint32_t GPRSavedMask = 0x003F
'0000;
402 static constexpr uint32_t GPRSavedShift = 16;
405 static constexpr uint32_t NumberOfFixedParmsMask = 0x0000'FF00;
406 static constexpr uint8_t NumberOfFixedParmsShift = 8;
409 static constexpr
uint32_t NumberOfFloatingPointParmsMask = 0x0000
'00FE;
410 static constexpr uint32_t HasParmsOnStackMask = 0x0000'0001;
411 static constexpr uint8_t NumberOfFloatingPointParmsShift = 1;
415 static constexpr
uint32_t ParmTypeIsFloatingBit = 0x8000
'0000;
416 static constexpr uint32_t ParmTypeFloatingIsDoubleBit = 0x4000'0000;
418 static constexpr
uint32_t ParmTypeIsFixedBits = 0x0000
'0000;
419 static constexpr uint32_t ParmTypeIsVectorBits = 0x4000'0000;
420 static constexpr
uint32_t ParmTypeIsFloatingBits = 0x8000
'0000;
421 static constexpr uint32_t ParmTypeIsDoubleBits = 0xC000'0000;
422 static constexpr
uint32_t ParmTypeMask = 0xC000
'0000;
425 static constexpr uint16_t NumberOfVRSavedMask = 0xFC00;
426 static constexpr uint16_t IsVRSavedOnStackMask = 0x0200;
427 static constexpr uint16_t HasVarArgsMask = 0x0100;
428 static constexpr uint8_t NumberOfVRSavedShift = 10;
430 static constexpr uint16_t NumberOfVectorParmsMask = 0x00FE;
431 static constexpr uint16_t HasVMXInstructionMask = 0x0001;
432 static constexpr uint8_t NumberOfVectorParmsShift = 1;
434 static constexpr uint32_t ParmTypeIsVectorCharBit = 0x0000'0000;
435 static constexpr
uint32_t ParmTypeIsVectorShortBit = 0x4000
'0000;
436 static constexpr uint32_t ParmTypeIsVectorIntBit = 0x8000'0000;
437 static constexpr
uint32_t ParmTypeIsVectorFloatBit = 0xC000
'0000;
439 static constexpr uint8_t WidthOfParamType = 2;
442 // Extended Traceback table flags.
443 enum ExtendedTBTableFlag : uint8_t {
444 TB_OS1 = 0x80, ///< Reserved for OS use.
445 TB_RESERVED = 0x40, ///< Reserved for compiler.
446 TB_SSP_CANARY = 0x20, ///< stack smasher canary present on stack.
447 TB_OS2 = 0x10, ///< Reserved for OS use.
448 TB_EH_INFO = 0x08, ///< Exception handling info present.
449 TB_LONGTBTABLE2 = 0x01 ///< Additional tbtable extension exists.
452 StringRef getNameForTracebackTableLanguageId(TracebackTable::LanguageID LangId);
453 SmallString<32> getExtendedTBTableFlagString(uint8_t Flag);
455 struct CsectProperties {
456 CsectProperties(StorageMappingClass SMC, SymbolType ST)
457 : MappingClass(SMC), Type(ST) {}
458 StorageMappingClass MappingClass;
462 } // end namespace XCOFF
463 } // end namespace llvm