1 //===-- RISCVISAInfo.h - RISCV ISA Information ------------------*- 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 LLVM_SUPPORT_RISCVISAINFO_H
10 #define LLVM_SUPPORT_RISCVISAINFO_H
11 
12 #include "llvm/ADT/StringRef.h"
13 #include "llvm/Support/Error.h"
14 
15 #include <map>
16 #include <string>
17 #include <vector>
18 
19 namespace llvm {
20 struct RISCVExtensionInfo {
21   std::string ExtName;
22   unsigned MajorVersion;
23   unsigned MinorVersion;
24 };
25 
26 class RISCVISAInfo {
27 public:
28   RISCVISAInfo(const RISCVISAInfo &) = delete;
29   RISCVISAInfo &operator=(const RISCVISAInfo &) = delete;
30 
31   static bool compareExtension(const std::string &LHS, const std::string &RHS);
32 
33   /// Helper class for OrderedExtensionMap.
34   struct ExtensionComparator {
35     bool operator()(const std::string &LHS, const std::string &RHS) const {
36       return compareExtension(LHS, RHS);
37     }
38   };
39 
40   /// OrderedExtensionMap is std::map, it's specialized to keep entries
41   /// in canonical order of extension.
42   typedef std::map<std::string, RISCVExtensionInfo, ExtensionComparator>
43       OrderedExtensionMap;
44 
45   RISCVISAInfo(unsigned XLen, OrderedExtensionMap &Exts)
46       : XLen(XLen), FLen(0), MinVLen(0), MaxELen(0), MaxELenFp(0), Exts(Exts) {}
47 
48   /// Parse RISCV ISA info from arch string.
49   static llvm::Expected<std::unique_ptr<RISCVISAInfo>>
50   parseArchString(StringRef Arch, bool EnableExperimentalExtension,
51                   bool ExperimentalExtensionVersionCheck = true,
52                   bool IgnoreUnknown = false);
53 
54   /// Parse RISCV ISA info from feature vector.
55   static llvm::Expected<std::unique_ptr<RISCVISAInfo>>
56   parseFeatures(unsigned XLen, const std::vector<std::string> &Features);
57 
58   /// Convert RISCV ISA info to a feature vector.
59   void toFeatures(std::vector<StringRef> &Features,
60                   llvm::function_ref<StringRef(const Twine &)> StrAlloc,
61                   bool AddAllExtensions) const;
62 
63   const OrderedExtensionMap &getExtensions() const { return Exts; };
64 
65   unsigned getXLen() const { return XLen; };
66   unsigned getFLen() const { return FLen; };
67   unsigned getMinVLen() const { return MinVLen; }
68   unsigned getMaxVLen() const { return 65536; }
69   unsigned getMaxELen() const { return MaxELen; }
70   unsigned getMaxELenFp() const { return MaxELenFp; }
71 
72   bool hasExtension(StringRef Ext) const;
73   std::string toString() const;
74   std::vector<std::string> toFeatureVector() const;
75   StringRef computeDefaultABI() const;
76 
77   static bool isSupportedExtensionFeature(StringRef Ext);
78   static bool isSupportedExtension(StringRef Ext);
79   static bool isSupportedExtension(StringRef Ext, unsigned MajorVersion,
80                                    unsigned MinorVersion);
81   static llvm::Expected<std::unique_ptr<RISCVISAInfo>>
82   postProcessAndChecking(std::unique_ptr<RISCVISAInfo> &&ISAInfo);
83 
84 private:
85   RISCVISAInfo(unsigned XLen)
86       : XLen(XLen), FLen(0), MinVLen(0), MaxELen(0), MaxELenFp(0) {}
87 
88   unsigned XLen;
89   unsigned FLen;
90   unsigned MinVLen;
91   unsigned MaxELen, MaxELenFp;
92 
93   OrderedExtensionMap Exts;
94 
95   void addExtension(StringRef ExtName, unsigned MajorVersion,
96                     unsigned MinorVersion);
97 
98   Error checkDependency();
99 
100   void updateImplication();
101   void updateCombination();
102   void updateFLen();
103   void updateMinVLen();
104   void updateMaxELen();
105 };
106 
107 } // namespace llvm
108 
109 #endif
110