LLVM 20.0.0git
MILexer.h
Go to the documentation of this file.
1//===- MILexer.h - Lexer for machine instructions ---------------*- 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// This file declares the function that lexes the machine instruction source
10// string.
11//
12//===----------------------------------------------------------------------===//
13
14#ifndef LLVM_LIB_CODEGEN_MIRPARSER_MILEXER_H
15#define LLVM_LIB_CODEGEN_MIRPARSER_MILEXER_H
16
17#include "llvm/ADT/APSInt.h"
18#include "llvm/ADT/StringRef.h"
19#include <string>
20
21namespace llvm {
22
23class Twine;
24
25/// A token produced by the machine instruction lexer.
26struct MIToken {
27 enum TokenKind {
28 // Markers
32
33 // Tokens with no info.
49
50 // Keywords
144
145 // Metadata types.
147
148 // Named metadata keywords
155
156 // Identifier tokens
168
169 // Other tokens
181 QuotedIRValue, // `<constant value>`
184 };
185
186private:
187 TokenKind Kind = Error;
188 StringRef Range;
189 StringRef StringValue;
190 std::string StringValueStorage;
191 APSInt IntVal;
192
193public:
194 MIToken() = default;
195
196 MIToken &reset(TokenKind Kind, StringRef Range);
197
199 MIToken &setOwnedStringValue(std::string StrVal);
201
202 TokenKind kind() const { return Kind; }
203
204 bool isError() const { return Kind == Error; }
205
206 bool isNewlineOrEOF() const { return Kind == Newline || Kind == Eof; }
207
208 bool isErrorOrEOF() const { return Kind == Error || Kind == Eof; }
209
210 bool isRegister() const {
211 return Kind == NamedRegister || Kind == underscore ||
212 Kind == NamedVirtualRegister || Kind == VirtualRegister;
213 }
214
215 bool isRegisterFlag() const {
216 return Kind == kw_implicit || Kind == kw_implicit_define ||
217 Kind == kw_def || Kind == kw_dead || Kind == kw_killed ||
218 Kind == kw_undef || Kind == kw_internal ||
219 Kind == kw_early_clobber || Kind == kw_debug_use ||
220 Kind == kw_renamable;
221 }
222
223 bool isMemoryOperandFlag() const {
224 return Kind == kw_volatile || Kind == kw_non_temporal ||
225 Kind == kw_dereferenceable || Kind == kw_invariant ||
226 Kind == StringConstant;
227 }
228
229 bool is(TokenKind K) const { return Kind == K; }
230
231 bool isNot(TokenKind K) const { return Kind != K; }
232
233 StringRef::iterator location() const { return Range.begin(); }
234
235 StringRef range() const { return Range; }
236
237 /// Return the token's string value.
238 StringRef stringValue() const { return StringValue; }
239
240 const APSInt &integerValue() const { return IntVal; }
241
242 bool hasIntegerValue() const {
243 return Kind == IntegerLiteral || Kind == MachineBasicBlock ||
244 Kind == MachineBasicBlockLabel || Kind == StackObject ||
245 Kind == FixedStackObject || Kind == GlobalValue ||
246 Kind == VirtualRegister || Kind == ConstantPoolItem ||
247 Kind == JumpTableIndex || Kind == IRBlock || Kind == IRValue;
248 }
249};
250
251/// Consume a single machine instruction token in the given source and return
252/// the remaining source string.
254 StringRef Source, MIToken &Token,
255 function_ref<void(StringRef::iterator, const Twine &)> ErrorCallback);
256
257} // end namespace llvm
258
259#endif // LLVM_LIB_CODEGEN_MIRPARSER_MILEXER_H
This file implements the APSInt class, which is a simple class that represents an arbitrary sized int...
ConstantRange Range(APInt(BitWidth, Low), APInt(BitWidth, High))
An arbitrary precision integer that knows its signedness.
Definition: APSInt.h:23
Lightweight error class with error context and mandatory checking.
Definition: Error.h:160
StringRef - Represent a constant reference to a string, i.e.
Definition: StringRef.h:50
Twine - A lightweight data structure for efficiently representing the concatenation of temporary valu...
Definition: Twine.h:81
An efficient, type-erasing, non-owning reference to a callable.
This is an optimization pass for GlobalISel generic memory operations.
Definition: AddressRanges.h:18
StringRef lexMIToken(StringRef Source, MIToken &Token, function_ref< void(StringRef::iterator, const Twine &)> ErrorCallback)
Consume a single machine instruction token in the given source and return the remaining source string...
A token produced by the machine instruction lexer.
Definition: MILexer.h:26
bool isRegisterFlag() const
Definition: MILexer.h:215
MIToken & setStringValue(StringRef StrVal)
Definition: MILexer.cpp:68
TokenKind kind() const
Definition: MILexer.h:202
bool isNewlineOrEOF() const
Definition: MILexer.h:206
bool hasIntegerValue() const
Definition: MILexer.h:242
bool isNot(TokenKind K) const
Definition: MILexer.h:231
bool is(TokenKind K) const
Definition: MILexer.h:229
MIToken()=default
bool isMemoryOperandFlag() const
Definition: MILexer.h:223
StringRef stringValue() const
Return the token's string value.
Definition: MILexer.h:238
@ kw_target_flags
Definition: MILexer.h:109
@ kw_landing_pad
Definition: MILexer.h:123
@ kw_blockaddress
Definition: MILexer.h:99
@ kw_pre_instr_symbol
Definition: MILexer.h:131
@ md_alias_scope
Definition: MILexer.h:150
@ NamedGlobalValue
Definition: MILexer.h:164
@ kw_call_frame_size
Definition: MILexer.h:142
@ SubRegisterIndex
Definition: MILexer.h:182
@ kw_frame_setup
Definition: MILexer.h:63
@ kw_cfi_aarch64_negate_ra_sign_state
Definition: MILexer.h:98
@ ConstantPoolItem
Definition: MILexer.h:175
@ kw_cfi_llvm_def_aspace_cfa
Definition: MILexer.h:91
@ MachineBasicBlock
Definition: MILexer.h:161
@ kw_dbg_instr_ref
Definition: MILexer.h:82
@ NamedVirtualRegister
Definition: MILexer.h:159
@ kw_early_clobber
Definition: MILexer.h:59
@ kw_cfi_offset
Definition: MILexer.h:84
@ kw_unpredictable
Definition: MILexer.h:77
@ FloatingPointLiteral
Definition: MILexer.h:171
@ kw_debug_use
Definition: MILexer.h:60
@ kw_cfi_window_save
Definition: MILexer.h:97
@ kw_constant_pool
Definition: MILexer.h:119
@ kw_frame_destroy
Definition: MILexer.h:64
@ kw_cfi_undefined
Definition: MILexer.h:96
@ StringConstant
Definition: MILexer.h:183
@ MachineBasicBlockLabel
Definition: MILexer.h:160
@ kw_cfi_restore
Definition: MILexer.h:94
@ kw_non_temporal
Definition: MILexer.h:111
@ kw_cfi_register
Definition: MILexer.h:92
@ kw_inlineasm_br_indirect_target
Definition: MILexer.h:124
@ kw_cfi_rel_offset
Definition: MILexer.h:85
@ kw_ehfunclet_entry
Definition: MILexer.h:125
@ kw_cfi_def_cfa_register
Definition: MILexer.h:86
@ FixedStackObject
Definition: MILexer.h:163
@ kw_cfi_same_value
Definition: MILexer.h:83
@ kw_target_index
Definition: MILexer.h:101
@ kw_cfi_adjust_cfa_offset
Definition: MILexer.h:88
@ kw_dereferenceable
Definition: MILexer.h:55
@ kw_implicit_define
Definition: MILexer.h:52
@ kw_cfi_def_cfa
Definition: MILexer.h:90
@ kw_cfi_escape
Definition: MILexer.h:89
@ VirtualRegister
Definition: MILexer.h:174
@ kw_cfi_def_cfa_offset
Definition: MILexer.h:87
@ kw_machine_block_address_taken
Definition: MILexer.h:141
@ kw_renamable
Definition: MILexer.h:61
@ ExternalSymbol
Definition: MILexer.h:166
@ kw_unknown_size
Definition: MILexer.h:138
@ IntegerLiteral
Definition: MILexer.h:170
@ kw_cfi_remember_state
Definition: MILexer.h:93
@ kw_debug_instr_number
Definition: MILexer.h:81
@ kw_post_instr_symbol
Definition: MILexer.h:132
@ kw_cfi_restore_state
Definition: MILexer.h:95
@ kw_nofpexcept
Definition: MILexer.h:76
@ kw_ir_block_address_taken
Definition: MILexer.h:140
@ kw_unknown_address
Definition: MILexer.h:139
@ JumpTableIndex
Definition: MILexer.h:176
@ kw_shufflemask
Definition: MILexer.h:130
@ kw_debug_location
Definition: MILexer.h:80
@ kw_noconvergent
Definition: MILexer.h:143
@ kw_heap_alloc_marker
Definition: MILexer.h:133
StringRef range() const
Definition: MILexer.h:235
bool isRegister() const
Definition: MILexer.h:210
MIToken & setIntegerValue(APSInt IntVal)
Definition: MILexer.cpp:79
bool isErrorOrEOF() const
Definition: MILexer.h:208
MIToken & reset(TokenKind Kind, StringRef Range)
Definition: MILexer.cpp:62
bool isError() const
Definition: MILexer.h:204
MIToken & setOwnedStringValue(std::string StrVal)
Definition: MILexer.cpp:73
StringRef::iterator location() const
Definition: MILexer.h:233
const APSInt & integerValue() const
Definition: MILexer.h:240