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
169
190
192
206
210
212
214
216
221
223 eCore_x86_64_x86_64h, // Haswell enabled x86_64
225
229
232
235
238
239 eCore_arc, // little endian ARC
240
242
244
324
326
328 // The following constants are used for wildcard matching only
336
339
342
345
348
351
354
357
360
363
366
369
372
375
376 };
377
378 /// Default constructor.
379 ///
380 /// Default constructor that initializes the object with invalid cpu type
381 /// and subtype values.
383
384 /// Constructor over triple.
385 ///
386 /// Constructs an ArchSpec with properties consistent with the given Triple.
387 explicit ArchSpec(const llvm::Triple &triple);
388 explicit ArchSpec(const char *triple_cstr);
389 explicit ArchSpec(llvm::StringRef triple_str);
390 /// Constructor over architecture name.
391 ///
392 /// Constructs an ArchSpec with properties consistent with the given object
393 /// type and architecture name.
394 explicit ArchSpec(ArchitectureType arch_type, uint32_t cpu_type,
395 uint32_t cpu_subtype);
396
397 /// Destructor.
399
400 /// Returns true if the OS, vendor and environment fields of the triple are
401 /// unset. The triple is expected to be normalized
402 /// (llvm::Triple::normalize).
403 static bool ContainsOnlyArch(const llvm::Triple &normalized_triple);
404
405 static void ListSupportedArchNames(StringList &list);
406 static void AutoComplete(CompletionRequest &request);
407
408 /// Returns a static string representing the current architecture.
409 ///
410 /// \return A static string corresponding to the current
411 /// architecture.
412 const char *GetArchitectureName() const;
413
414 /// if MIPS architecture return true.
415 ///
416 /// \return a boolean value.
417 bool IsMIPS() const;
418
419 /// If NVPTX architecture return true.
420 ///
421 /// \return a boolean value.
422 bool IsNVPTX() const;
423
424 /// Returns a string representing current architecture as a target CPU for
425 /// tools like compiler, disassembler etc.
426 ///
427 /// \return A string representing target CPU for the current
428 /// architecture.
429 std::string GetClangTargetCPU() const;
430
431 /// Return a string representing target application ABI.
432 ///
433 /// \return A string representing target application ABI.
434 std::string GetTargetABI() const;
435
436 /// Clears the object state.
437 ///
438 /// Clears the object state back to a default invalid state.
439 void Clear();
440
441 /// Returns the size in bytes of an address of the current architecture.
442 ///
443 /// \return The byte size of an address of the current architecture.
444 uint32_t GetAddressByteSize() const;
445
446 /// Returns a machine family for the current architecture.
447 ///
448 /// \return An LLVM arch type.
449 llvm::Triple::ArchType GetMachine() const;
450
451 /// Tests if this ArchSpec is valid.
452 ///
453 /// \return True if the current architecture is valid, false
454 /// otherwise.
455 bool IsValid() const {
457 }
458 explicit operator bool() const { return IsValid(); }
459
461 return !m_triple.getVendorName().empty();
462 }
463
464 bool TripleOSWasSpecified() const { return !m_triple.getOSName().empty(); }
465
467 return m_triple.hasEnvironment();
468 }
469
470 /// Merges fields from another ArchSpec into this ArchSpec.
471 ///
472 /// This will use the supplied ArchSpec to fill in any fields of the triple
473 /// in this ArchSpec which were unspecified. This can be used to refine a
474 /// generic ArchSpec with a more specific one. For example, if this
475 /// ArchSpec's triple is something like i386-unknown-unknown-unknown, and we
476 /// have a triple which is x64-pc-windows-msvc, then merging that triple
477 /// into this one will result in the triple i386-pc-windows-msvc.
478 ///
479 void MergeFrom(const ArchSpec &other);
480
481 /// Change the architecture object type, CPU type and OS type.
482 ///
483 /// \param[in] arch_type The object type of this ArchSpec.
484 ///
485 /// \param[in] cpu The required CPU type.
486 ///
487 /// \param[in] os The optional OS type
488 /// The default value of 0 was chosen to from the ELF spec value
489 /// ELFOSABI_NONE. ELF is the only one using this parameter. If another
490 /// format uses this parameter and 0 does not work, use a value over
491 /// 255 because in the ELF header this is value is only a byte.
492 ///
493 /// \return True if the object, and CPU were successfully set.
494 ///
495 /// As a side effect, the vendor value is usually set to unknown. The
496 /// exceptions are
497 /// aarch64-apple-ios
498 /// arm-apple-ios
499 /// thumb-apple-ios
500 /// x86-apple-
501 /// x86_64-apple-
502 ///
503 /// As a side effect, the os value is usually set to unknown The exceptions
504 /// are
505 /// *-*-aix
506 /// aarch64-apple-ios
507 /// arm-apple-ios
508 /// thumb-apple-ios
509 /// powerpc-apple-darwin
510 /// *-*-freebsd
511 /// *-*-linux
512 /// *-*-netbsd
513 /// *-*-openbsd
514 /// *-*-solaris
515 bool SetArchitecture(ArchitectureType arch_type, uint32_t cpu, uint32_t sub,
516 uint32_t os = 0);
517
518 /// Returns the byte order for the architecture specification.
519 ///
520 /// \return The endian enumeration for the current endianness of
521 /// the architecture specification
523
524 /// Sets this ArchSpec's byte order.
525 ///
526 /// In the common case there is no need to call this method as the byte
527 /// order can almost always be determined by the architecture. However, many
528 /// CPU's are bi-endian (ARM, Alpha, PowerPC, etc) and the default/assumed
529 /// byte order may be incorrect.
530 void SetByteOrder(lldb::ByteOrder byte_order) { m_byte_order = byte_order; }
531
532 uint32_t GetMinimumOpcodeByteSize() const;
533
534 uint32_t GetMaximumOpcodeByteSize() const;
535
536 Core GetCore() const { return m_core; }
537
538 uint32_t GetMachOCPUType() const;
539
540 uint32_t GetMachOCPUSubType() const;
541
542 uint32_t GetElfCPUSubType() const;
543
544 /// Architecture triple accessor.
545 ///
546 /// \return A triple describing this ArchSpec.
547 llvm::Triple &GetTriple() { return m_triple; }
548
549 /// Architecture triple accessor.
550 ///
551 /// \return A triple describing this ArchSpec.
552 const llvm::Triple &GetTriple() const { return m_triple; }
553
554 void DumpTriple(llvm::raw_ostream &s) const;
555
556 /// Architecture triple setter.
557 ///
558 /// Configures this ArchSpec according to the given triple. If the triple
559 /// has unknown components in all of the vendor, OS, and the optional
560 /// environment field (i.e. "i386-unknown-unknown") then default values are
561 /// taken from the host. Architecture and environment components are used
562 /// to further resolve the CPU type and subtype, endian characteristics,
563 /// etc.
564 ///
565 /// \return A triple describing this ArchSpec.
566 bool SetTriple(const llvm::Triple &triple);
567
568 bool SetTriple(llvm::StringRef triple_str);
569
570 /// Returns the default endianness of the architecture.
571 ///
572 /// \return The endian enumeration for the default endianness of
573 /// the architecture.
575
576 /// Returns true if 'char' is a signed type by default in the architecture
577 /// false otherwise
578 ///
579 /// \return True if 'char' is a signed type by default on the
580 /// architecture and false otherwise.
581 bool CharIsSignedByDefault() const;
582
584
585 /// Compare this ArchSpec to another ArchSpec. \a match specifies the kind of
586 /// matching that is to be done. CompatibleMatch requires only a compatible
587 /// cpu type (e.g., armv7s is compatible with armv7). ExactMatch requires an
588 /// exact match (armv7s is not an exact match with armv7).
589 ///
590 /// \return true if the two ArchSpecs match.
591 bool IsMatch(const ArchSpec &rhs, MatchType match) const;
592
593 /// Shorthand for IsMatch(rhs, ExactMatch).
594 bool IsExactMatch(const ArchSpec &rhs) const {
595 return IsMatch(rhs, ExactMatch);
596 }
597
598 /// Shorthand for IsMatch(rhs, CompatibleMatch).
599 bool IsCompatibleMatch(const ArchSpec &rhs) const {
600 return IsMatch(rhs, CompatibleMatch);
601 }
602
603 bool IsFullySpecifiedTriple() const;
604
605 /// Detect whether this architecture uses thumb code exclusively
606 ///
607 /// Some embedded ARM chips (e.g. the ARM Cortex M0-7 line) can only execute
608 /// the Thumb instructions, never Arm. We should normally pick up
609 /// arm/thumbness from their the processor status bits (cpsr/xpsr) or hints
610 /// on each function - but when doing bare-boards low level debugging
611 /// (especially common with these embedded processors), we may not have
612 /// those things easily accessible.
613 ///
614 /// \return true if this is an arm ArchSpec which can only execute Thumb
615 /// instructions
616 bool IsAlwaysThumbInstructions() const;
617
618 uint32_t GetFlags() const { return m_flags; }
619
620 void SetFlags(uint32_t flags) { m_flags = flags; }
621
622 void SetFlags(const std::string &elf_abi);
623
624 const llvm::SubtargetFeatures &GetSubtargetFeatures() const {
626 }
627
628 void SetSubtargetFeatures(llvm::SubtargetFeatures &&subtarget_features) {
629 m_subtarget_features = std::move(subtarget_features);
630 }
631
632protected:
633 void UpdateCore();
634
635 llvm::Triple m_triple;
638
639 // Additional arch flags which we cannot get from triple and core For MIPS
640 // these are application specific extensions like micromips, mips16 etc.
641 uint32_t m_flags = 0;
642
643 llvm::SubtargetFeatures m_subtarget_features;
644
645 // Called when m_def or m_entry are changed. Fills in all remaining members
646 // with default values.
647 void CoreUpdated(bool update_triple);
648};
649
650/// \fn bool operator< (const ArchSpec& lhs, const ArchSpec& rhs) Less than
651/// operator.
652///
653/// Tests two ArchSpec objects to see if \a lhs is less than \a rhs.
654///
655/// \param[in] lhs The Left Hand Side ArchSpec object to compare. \param[in]
656/// rhs The Left Hand Side ArchSpec object to compare.
657///
658/// \return true if \a lhs is less than \a rhs
659bool operator<(const ArchSpec &lhs, const ArchSpec &rhs);
660bool operator==(const ArchSpec &lhs, const ArchSpec &rhs);
661bool operator!=(const ArchSpec &lhs, const ArchSpec &rhs);
662
663bool ParseMachCPUDashSubtypeTriple(llvm::StringRef triple_str, ArchSpec &arch);
664
665} // namespace lldb_private
666
667#endif // LLDB_UTILITY_ARCHSPEC_H
An architecture specification class.
Definition ArchSpec.h:32
static void ListSupportedArchNames(StringList &list)
Definition ArchSpec.cpp:389
bool IsFullySpecifiedTriple() const
llvm::SubtargetFeatures m_subtarget_features
Definition ArchSpec.h:643
void SetByteOrder(lldb::ByteOrder byte_order)
Sets this ArchSpec's byte order.
Definition ArchSpec.h:530
bool IsNVPTX() const
If NVPTX architecture return true.
Definition ArchSpec.cpp:754
static void AutoComplete(CompletionRequest &request)
Definition ArchSpec.cpp:394
uint32_t GetAddressByteSize() const
Returns the size in bytes of an address of the current architecture.
Definition ArchSpec.cpp:894
bool IsValid() const
Tests if this ArchSpec is valid.
Definition ArchSpec.h:455
void Clear()
Clears the object state.
Definition ArchSpec.cpp:735
llvm::Triple & GetTriple()
Architecture triple accessor.
Definition ArchSpec.h:547
void SetFlags(uint32_t flags)
Definition ArchSpec.h:620
bool IsAlwaysThumbInstructions() const
Detect whether this architecture uses thumb code exclusively.
bool TripleEnvironmentWasSpecified() const
Definition ArchSpec.h:466
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:952
llvm::Triple m_triple
Definition ArchSpec.h:635
lldb::ByteOrder GetDefaultEndian() const
Returns the default endianness of the architecture.
Definition ArchSpec.cpp:908
lldb::ByteOrder m_byte_order
Definition ArchSpec.h:637
uint32_t GetElfCPUSubType() const
Definition ArchSpec.cpp:882
~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:878
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:752
bool IsCompatibleMatch(const ArchSpec &rhs) const
Shorthand for IsMatch(rhs, CompatibleMatch).
Definition ArchSpec.h:599
bool CharIsSignedByDefault() const
Returns true if 'char' is a signed type by default in the architecture false otherwise.
Definition ArchSpec.cpp:915
bool IsExactMatch(const ArchSpec &rhs) const
Shorthand for IsMatch(rhs, ExactMatch).
Definition ArchSpec.h:594
const llvm::SubtargetFeatures & GetSubtargetFeatures() const
Definition ArchSpec.h:624
ArchSpec()
Default constructor.
uint32_t GetMachOCPUType() const
Definition ArchSpec.cpp:874
std::string GetTargetABI() const
Return a string representing target application ABI.
Definition ArchSpec.cpp:756
uint32_t GetMinimumOpcodeByteSize() const
uint32_t GetFlags() const
Definition ArchSpec.h:618
lldb::ByteOrder GetByteOrder() const
Returns the byte order for the architecture specification.
Definition ArchSpec.cpp:943
llvm::Triple::ArchType GetMachine() const
Returns a machine family for the current architecture.
Definition ArchSpec.cpp:886
@ 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:792
uint32_t GetMaximumOpcodeByteSize() const
bool TripleVendorWasSpecified() const
Definition ArchSpec.h:460
Core GetCore() const
Definition ArchSpec.h:536
bool TripleOSWasSpecified() const
Definition ArchSpec.h:464
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:552
const char * GetArchitectureName() const
Returns a static string representing the current architecture.
Definition ArchSpec.cpp:745
void SetSubtargetFeatures(llvm::SubtargetFeatures &&subtarget_features)
Definition ArchSpec.h:628
"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:958
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.