LLDB mainline
ArchSpec.h
Go to the documentation of this file.
1//===-- ArchSpec.h ----------------------------------------------*- 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#ifndef LLDB_UTILITY_ARCHSPEC_H
10#define LLDB_UTILITY_ARCHSPEC_H
11
14#include "lldb/lldb-forward.h"
16#include "llvm/ADT/StringRef.h"
17#include "llvm/TargetParser/SubtargetFeature.h"
18#include "llvm/TargetParser/Triple.h"
19#include <cstddef>
20#include <cstdint>
21#include <string>
22
23namespace lldb_private {
24
25/// \class ArchSpec ArchSpec.h "lldb/Utility/ArchSpec.h" An architecture
26/// specification class.
27///
28/// A class designed to be created from a cpu type and subtype, a
29/// string representation, or an llvm::Triple. Keeping all of the conversions
30/// of strings to architecture enumeration values confined to this class
31/// allows new architecture support to be added easily.
32class ArchSpec {
33public:
49
50 // Masks for the ases word of an ABI flags structure.
51 enum MIPSASE {
52 eMIPSAse_dsp = 0x00000001, // DSP ASE
53 eMIPSAse_dspr2 = 0x00000002, // DSP R2 ASE
54 eMIPSAse_eva = 0x00000004, // Enhanced VA Scheme
55 eMIPSAse_mcu = 0x00000008, // MCU (MicroController) ASE
56 eMIPSAse_mdmx = 0x00000010, // MDMX ASE
57 eMIPSAse_mips3d = 0x00000020, // MIPS-3D ASE
58 eMIPSAse_mt = 0x00000040, // MT ASE
59 eMIPSAse_smartmips = 0x00000080, // SmartMIPS ASE
60 eMIPSAse_virt = 0x00000100, // VZ ASE
61 eMIPSAse_msa = 0x00000200, // MSA ASE
62 eMIPSAse_mips16 = 0x00000400, // MIPS16 ASE
63 eMIPSAse_micromips = 0x00000800, // MICROMIPS ASE
64 eMIPSAse_xpa = 0x00001000, // XPA ASE
65 eMIPSAse_mask = 0x00001fff,
66 eMIPSABI_O32 = 0x00002000,
67 eMIPSABI_N32 = 0x00004000,
68 eMIPSABI_N64 = 0x00008000,
69 eMIPSABI_O64 = 0x00020000,
70 eMIPSABI_EABI32 = 0x00040000,
71 eMIPSABI_EABI64 = 0x00080000,
72 eMIPSABI_mask = 0x000ff000
73 };
74
75 // MIPS Floating point ABI Values
77 eMIPS_ABI_FP_ANY = 0x00000000,
78 eMIPS_ABI_FP_DOUBLE = 0x00100000, // hard float / -mdouble-float
79 eMIPS_ABI_FP_SINGLE = 0x00200000, // hard float / -msingle-float
80 eMIPS_ABI_FP_SOFT = 0x00300000, // soft float
81 eMIPS_ABI_FP_OLD_64 = 0x00400000, // -mips32r2 -mfp64
82 eMIPS_ABI_FP_XX = 0x00500000, // -mfpxx
83 eMIPS_ABI_FP_64 = 0x00600000, // -mips32r2 -mfp64
84 eMIPS_ABI_FP_64A = 0x00700000, // -mips32r2 -mfp64 -mno-odd-spreg
85 eMIPS_ABI_FP_mask = 0x00700000
86 };
87
88 // ARM specific e_flags
89 enum ARMeflags {
90 eARM_abi_soft_float = 0x00000200,
92 };
93
95 eRISCV_rvc = 0x00000001, /// RVC, +c
96 eRISCV_float_abi_soft = 0x00000000, /// soft float
97 eRISCV_float_abi_single = 0x00000002, /// single precision floating point, +f
98 eRISCV_float_abi_double = 0x00000004, /// double precision floating point, +d
99 eRISCV_float_abi_quad = 0x00000006, /// quad precision floating point, +q
101 eRISCV_rve = 0x00000008, /// RVE, +e
102 eRISCV_tso = 0x00000010, /// RVTSO (total store ordering)
103 };
104
110
112 eLoongArch_abi_soft_float = 0x00000000, /// soft float
114 0x00000001, /// single precision floating point, +f
116 0x00000002, /// double precision floating point, +d
118 };
119
125
126 enum Core {
147
167
188
190
204
208
210
212
214
219
221 eCore_x86_64_x86_64h, // Haswell enabled x86_64
223
227
230
233
236
237 eCore_arc, // little endian ARC
238
240
242
322
324
326 // The following constants are used for wildcard matching only
334
337
340
343
346
349
352
355
358
361
364
367
370
373
374 };
375
376 /// Default constructor.
377 ///
378 /// Default constructor that initializes the object with invalid cpu type
379 /// and subtype values.
381
382 /// Constructor over triple.
383 ///
384 /// Constructs an ArchSpec with properties consistent with the given Triple.
385 explicit ArchSpec(const llvm::Triple &triple);
386 explicit ArchSpec(const char *triple_cstr);
387 explicit ArchSpec(llvm::StringRef triple_str);
388 /// Constructor over architecture name.
389 ///
390 /// Constructs an ArchSpec with properties consistent with the given object
391 /// type and architecture name.
392 explicit ArchSpec(ArchitectureType arch_type, uint32_t cpu_type,
393 uint32_t cpu_subtype);
394
395 /// Destructor.
397
398 /// Returns true if the OS, vendor and environment fields of the triple are
399 /// unset. The triple is expected to be normalized
400 /// (llvm::Triple::normalize).
401 static bool ContainsOnlyArch(const llvm::Triple &normalized_triple);
402
403 static void ListSupportedArchNames(StringList &list);
404 static void AutoComplete(CompletionRequest &request);
405
406 /// Returns a static string representing the current architecture.
407 ///
408 /// \return A static string corresponding to the current
409 /// architecture.
410 const char *GetArchitectureName() const;
411
412 /// if MIPS architecture return true.
413 ///
414 /// \return a boolean value.
415 bool IsMIPS() const;
416
417 /// If NVPTX architecture return true.
418 ///
419 /// \return a boolean value.
420 bool IsNVPTX() const;
421
422 /// Returns a string representing current architecture as a target CPU for
423 /// tools like compiler, disassembler etc.
424 ///
425 /// \return A string representing target CPU for the current
426 /// architecture.
427 std::string GetClangTargetCPU() const;
428
429 /// Return a string representing target application ABI.
430 ///
431 /// \return A string representing target application ABI.
432 std::string GetTargetABI() const;
433
434 /// Clears the object state.
435 ///
436 /// Clears the object state back to a default invalid state.
437 void Clear();
438
439 /// Returns the size in bytes of an address of the current architecture.
440 ///
441 /// \return The byte size of an address of the current architecture.
442 uint32_t GetAddressByteSize() const;
443
444 /// Returns a machine family for the current architecture.
445 ///
446 /// \return An LLVM arch type.
447 llvm::Triple::ArchType GetMachine() const;
448
449 /// Tests if this ArchSpec is valid.
450 ///
451 /// \return True if the current architecture is valid, false
452 /// otherwise.
453 bool IsValid() const {
455 }
456 explicit operator bool() const { return IsValid(); }
457
459 return !m_triple.getVendorName().empty();
460 }
461
462 bool TripleOSWasSpecified() const { return !m_triple.getOSName().empty(); }
463
465 return m_triple.hasEnvironment();
466 }
467
468 /// Merges fields from another ArchSpec into this ArchSpec.
469 ///
470 /// This will use the supplied ArchSpec to fill in any fields of the triple
471 /// in this ArchSpec which were unspecified. This can be used to refine a
472 /// generic ArchSpec with a more specific one. For example, if this
473 /// ArchSpec's triple is something like i386-unknown-unknown-unknown, and we
474 /// have a triple which is x64-pc-windows-msvc, then merging that triple
475 /// into this one will result in the triple i386-pc-windows-msvc.
476 ///
477 void MergeFrom(const ArchSpec &other);
478
479 /// Change the architecture object type, CPU type and OS type.
480 ///
481 /// \param[in] arch_type The object type of this ArchSpec.
482 ///
483 /// \param[in] cpu The required CPU type.
484 ///
485 /// \param[in] os The optional OS type
486 /// The default value of 0 was chosen to from the ELF spec value
487 /// ELFOSABI_NONE. ELF is the only one using this parameter. If another
488 /// format uses this parameter and 0 does not work, use a value over
489 /// 255 because in the ELF header this is value is only a byte.
490 ///
491 /// \return True if the object, and CPU were successfully set.
492 ///
493 /// As a side effect, the vendor value is usually set to unknown. The
494 /// exceptions are
495 /// aarch64-apple-ios
496 /// arm-apple-ios
497 /// thumb-apple-ios
498 /// x86-apple-
499 /// x86_64-apple-
500 ///
501 /// As a side effect, the os value is usually set to unknown The exceptions
502 /// are
503 /// *-*-aix
504 /// aarch64-apple-ios
505 /// arm-apple-ios
506 /// thumb-apple-ios
507 /// powerpc-apple-darwin
508 /// *-*-freebsd
509 /// *-*-linux
510 /// *-*-netbsd
511 /// *-*-openbsd
512 /// *-*-solaris
513 bool SetArchitecture(ArchitectureType arch_type, uint32_t cpu, uint32_t sub,
514 uint32_t os = 0);
515
516 /// Returns the byte order for the architecture specification.
517 ///
518 /// \return The endian enumeration for the current endianness of
519 /// the architecture specification
521
522 /// Sets this ArchSpec's byte order.
523 ///
524 /// In the common case there is no need to call this method as the byte
525 /// order can almost always be determined by the architecture. However, many
526 /// CPU's are bi-endian (ARM, Alpha, PowerPC, etc) and the default/assumed
527 /// byte order may be incorrect.
528 void SetByteOrder(lldb::ByteOrder byte_order) { m_byte_order = byte_order; }
529
530 uint32_t GetMinimumOpcodeByteSize() const;
531
532 uint32_t GetMaximumOpcodeByteSize() const;
533
534 Core GetCore() const { return m_core; }
535
536 uint32_t GetMachOCPUType() const;
537
538 uint32_t GetMachOCPUSubType() const;
539
540 uint32_t GetElfCPUSubType() const;
541
542 /// Architecture triple accessor.
543 ///
544 /// \return A triple describing this ArchSpec.
545 llvm::Triple &GetTriple() { return m_triple; }
546
547 /// Architecture triple accessor.
548 ///
549 /// \return A triple describing this ArchSpec.
550 const llvm::Triple &GetTriple() const { return m_triple; }
551
552 void DumpTriple(llvm::raw_ostream &s) const;
553
554 /// Architecture triple setter.
555 ///
556 /// Configures this ArchSpec according to the given triple. If the triple
557 /// has unknown components in all of the vendor, OS, and the optional
558 /// environment field (i.e. "i386-unknown-unknown") then default values are
559 /// taken from the host. Architecture and environment components are used
560 /// to further resolve the CPU type and subtype, endian characteristics,
561 /// etc.
562 ///
563 /// \return A triple describing this ArchSpec.
564 bool SetTriple(const llvm::Triple &triple);
565
566 bool SetTriple(llvm::StringRef triple_str);
567
568 /// Returns the default endianness of the architecture.
569 ///
570 /// \return The endian enumeration for the default endianness of
571 /// the architecture.
573
574 /// Returns true if 'char' is a signed type by default in the architecture
575 /// false otherwise
576 ///
577 /// \return True if 'char' is a signed type by default on the
578 /// architecture and false otherwise.
579 bool CharIsSignedByDefault() const;
580
582
583 /// Compare this ArchSpec to another ArchSpec. \a match specifies the kind of
584 /// matching that is to be done. CompatibleMatch requires only a compatible
585 /// cpu type (e.g., armv7s is compatible with armv7). ExactMatch requires an
586 /// exact match (armv7s is not an exact match with armv7).
587 ///
588 /// \return true if the two ArchSpecs match.
589 bool IsMatch(const ArchSpec &rhs, MatchType match) const;
590
591 /// Shorthand for IsMatch(rhs, ExactMatch).
592 bool IsExactMatch(const ArchSpec &rhs) const {
593 return IsMatch(rhs, ExactMatch);
594 }
595
596 /// Shorthand for IsMatch(rhs, CompatibleMatch).
597 bool IsCompatibleMatch(const ArchSpec &rhs) const {
598 return IsMatch(rhs, CompatibleMatch);
599 }
600
601 bool IsFullySpecifiedTriple() const;
602
603 /// Detect whether this architecture uses thumb code exclusively
604 ///
605 /// Some embedded ARM chips (e.g. the ARM Cortex M0-7 line) can only execute
606 /// the Thumb instructions, never Arm. We should normally pick up
607 /// arm/thumbness from their the processor status bits (cpsr/xpsr) or hints
608 /// on each function - but when doing bare-boards low level debugging
609 /// (especially common with these embedded processors), we may not have
610 /// those things easily accessible.
611 ///
612 /// \return true if this is an arm ArchSpec which can only execute Thumb
613 /// instructions
614 bool IsAlwaysThumbInstructions() const;
615
616 uint32_t GetFlags() const { return m_flags; }
617
618 void SetFlags(uint32_t flags) { m_flags = flags; }
619
620 void SetFlags(const std::string &elf_abi);
621
622 const llvm::SubtargetFeatures &GetSubtargetFeatures() const {
624 }
625
626 void SetSubtargetFeatures(llvm::SubtargetFeatures &&subtarget_features) {
627 m_subtarget_features = std::move(subtarget_features);
628 }
629
630protected:
631 void UpdateCore();
632
633 llvm::Triple m_triple;
636
637 // Additional arch flags which we cannot get from triple and core For MIPS
638 // these are application specific extensions like micromips, mips16 etc.
639 uint32_t m_flags = 0;
640
641 llvm::SubtargetFeatures m_subtarget_features;
642
643 // Called when m_def or m_entry are changed. Fills in all remaining members
644 // with default values.
645 void CoreUpdated(bool update_triple);
646};
647
648/// \fn bool operator< (const ArchSpec& lhs, const ArchSpec& rhs) Less than
649/// operator.
650///
651/// Tests two ArchSpec objects to see if \a lhs is less than \a rhs.
652///
653/// \param[in] lhs The Left Hand Side ArchSpec object to compare. \param[in]
654/// rhs The Left Hand Side ArchSpec object to compare.
655///
656/// \return true if \a lhs is less than \a rhs
657bool operator<(const ArchSpec &lhs, const ArchSpec &rhs);
658bool operator==(const ArchSpec &lhs, const ArchSpec &rhs);
659bool operator!=(const ArchSpec &lhs, const ArchSpec &rhs);
660
661bool ParseMachCPUDashSubtypeTriple(llvm::StringRef triple_str, ArchSpec &arch);
662
663} // namespace lldb_private
664
665#endif // LLDB_UTILITY_ARCHSPEC_H
An architecture specification class.
Definition ArchSpec.h:32
static void ListSupportedArchNames(StringList &list)
Definition ArchSpec.cpp:387
bool IsFullySpecifiedTriple() const
llvm::SubtargetFeatures m_subtarget_features
Definition ArchSpec.h:641
void SetByteOrder(lldb::ByteOrder byte_order)
Sets this ArchSpec's byte order.
Definition ArchSpec.h:528
bool IsNVPTX() const
If NVPTX architecture return true.
Definition ArchSpec.cpp:751
static void AutoComplete(CompletionRequest &request)
Definition ArchSpec.cpp:392
uint32_t GetAddressByteSize() const
Returns the size in bytes of an address of the current architecture.
Definition ArchSpec.cpp:891
bool IsValid() const
Tests if this ArchSpec is valid.
Definition ArchSpec.h:453
void Clear()
Clears the object state.
Definition ArchSpec.cpp:732
llvm::Triple & GetTriple()
Architecture triple accessor.
Definition ArchSpec.h:545
void SetFlags(uint32_t flags)
Definition ArchSpec.h:618
bool IsAlwaysThumbInstructions() const
Detect whether this architecture uses thumb code exclusively.
bool TripleEnvironmentWasSpecified() const
Definition ArchSpec.h:464
bool IsMatch(const ArchSpec &rhs, MatchType match) const
Compare this ArchSpec to another ArchSpec.
bool SetTriple(const llvm::Triple &triple)
Architecture triple setter.
Definition ArchSpec.cpp:949
llvm::Triple m_triple
Definition ArchSpec.h:633
lldb::ByteOrder GetDefaultEndian() const
Returns the default endianness of the architecture.
Definition ArchSpec.cpp:905
lldb::ByteOrder m_byte_order
Definition ArchSpec.h:635
uint32_t GetElfCPUSubType() const
Definition ArchSpec.cpp:879
~ArchSpec()
Destructor.
bool SetArchitecture(ArchitectureType arch_type, uint32_t cpu, uint32_t sub, uint32_t os=0)
Change the architecture object type, CPU type and OS type.
void MergeFrom(const ArchSpec &other)
Merges fields from another ArchSpec into this ArchSpec.
void DumpTriple(llvm::raw_ostream &s) const
uint32_t GetMachOCPUSubType() const
Definition ArchSpec.cpp:875
void CoreUpdated(bool update_triple)
@ eLoongArch_abi_single_float
soft float
Definition ArchSpec.h:113
@ eLoongArch_abi_mask
double precision floating point, +d
Definition ArchSpec.h:117
@ eLoongArch_abi_double_float
single precision floating point, +f
Definition ArchSpec.h:115
bool IsMIPS() const
if MIPS architecture return true.
Definition ArchSpec.cpp:749
bool IsCompatibleMatch(const ArchSpec &rhs) const
Shorthand for IsMatch(rhs, CompatibleMatch).
Definition ArchSpec.h:597
bool CharIsSignedByDefault() const
Returns true if 'char' is a signed type by default in the architecture false otherwise.
Definition ArchSpec.cpp:912
bool IsExactMatch(const ArchSpec &rhs) const
Shorthand for IsMatch(rhs, ExactMatch).
Definition ArchSpec.h:592
const llvm::SubtargetFeatures & GetSubtargetFeatures() const
Definition ArchSpec.h:622
ArchSpec()
Default constructor.
uint32_t GetMachOCPUType() const
Definition ArchSpec.cpp:871
std::string GetTargetABI() const
Return a string representing target application ABI.
Definition ArchSpec.cpp:753
uint32_t GetMinimumOpcodeByteSize() const
uint32_t GetFlags() const
Definition ArchSpec.h:616
lldb::ByteOrder GetByteOrder() const
Returns the byte order for the architecture specification.
Definition ArchSpec.cpp:940
llvm::Triple::ArchType GetMachine() const
Returns a machine family for the current architecture.
Definition ArchSpec.cpp:883
@ eRISCV_float_abi_double
single precision floating point, +f
Definition ArchSpec.h:98
@ eRISCV_float_abi_soft
RVC, +c.
Definition ArchSpec.h:96
@ eRISCV_float_abi_quad
double precision floating point, +d
Definition ArchSpec.h:99
@ eRISCV_float_abi_mask
quad precision floating point, +q
Definition ArchSpec.h:100
@ eRISCV_float_abi_single
soft float
Definition ArchSpec.h:97
std::string GetClangTargetCPU() const
Returns a string representing current architecture as a target CPU for tools like compiler,...
Definition ArchSpec.cpp:789
uint32_t GetMaximumOpcodeByteSize() const
bool TripleVendorWasSpecified() const
Definition ArchSpec.h:458
Core GetCore() const
Definition ArchSpec.h:534
bool TripleOSWasSpecified() const
Definition ArchSpec.h:462
static bool ContainsOnlyArch(const llvm::Triple &normalized_triple)
Returns true if the OS, vendor and environment fields of the triple are unset.
const llvm::Triple & GetTriple() const
Architecture triple accessor.
Definition ArchSpec.h:550
const char * GetArchitectureName() const
Returns a static string representing the current architecture.
Definition ArchSpec.cpp:742
void SetSubtargetFeatures(llvm::SubtargetFeatures &&subtarget_features)
Definition ArchSpec.h:626
"lldb/Utility/ArgCompletionRequest.h"
A class that represents a running process on the host machine.
bool ParseMachCPUDashSubtypeTriple(llvm::StringRef triple_str, ArchSpec &arch)
Definition ArchSpec.cpp:955
bool operator!=(const Address &lhs, const Address &rhs)
Definition Address.cpp:1011
bool operator==(const Address &lhs, const Address &rhs)
Definition Address.cpp:1005
bool operator<(const Address &lhs, const Address &rhs)
Definition Address.cpp:974
ByteOrder
Byte ordering definitions.