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   /// Parse RISCV ISA info from arch string.
46   static llvm::Expected<std::unique_ptr<RISCVISAInfo>>
47   parseArchString(StringRef Arch, bool EnableExperimentalExtension,
48                   bool ExperimentalExtensionVersionCheck = true);
49 
50   /// Parse RISCV ISA info from feature vector.
51   static llvm::Expected<std::unique_ptr<RISCVISAInfo>>
52   parseFeatures(unsigned XLen, const std::vector<std::string> &Features);
53 
54   /// Convert RISCV ISA info to a feature vector.
55   void toFeatures(std::vector<StringRef> &Features,
56                   std::function<StringRef(const Twine &)> StrAlloc) const;
57 
58   const OrderedExtensionMap &getExtensions() const { return Exts; };
59 
60   unsigned getXLen() const { return XLen; };
61   unsigned getFLen() const { return FLen; };
62   unsigned getMinVLen() const { return MinVLen; }
63   unsigned getMaxELen() const { return MaxELen; }
64   unsigned getMaxELenFp() const { return MaxELenFp; }
65 
66   bool hasExtension(StringRef Ext) const;
67   std::string toString() const;
68   std::vector<std::string> toFeatureVector() const;
69   StringRef computeDefaultABI() const;
70 
71   static bool isSupportedExtensionFeature(StringRef Ext);
72   static bool isSupportedExtension(StringRef Ext);
73   static bool isSupportedExtension(StringRef Ext, unsigned MajorVersion,
74                                    unsigned MinorVersion);
75 
76 private:
77   RISCVISAInfo(unsigned XLen)
78       : XLen(XLen), FLen(0), MinVLen(0), MaxELen(0), MaxELenFp(0) {}
79 
80   unsigned XLen;
81   unsigned FLen;
82   unsigned MinVLen;
83   unsigned MaxELen, MaxELenFp;
84 
85   OrderedExtensionMap Exts;
86 
87   void addExtension(StringRef ExtName, unsigned MajorVersion,
88                     unsigned MinorVersion);
89 
90   Error checkDependency();
91 
92   void updateImplication();
93   void updateCombination();
94   void updateFLen();
95   void updateMinVLen();
96   void updateMaxELen();
97 
98   static llvm::Expected<std::unique_ptr<RISCVISAInfo>>
99   postProcessAndChecking(std::unique_ptr<RISCVISAInfo> &&ISAInfo);
100 };
101 
102 } // namespace llvm
103 
104 #endif
105