xref: /llvm-project/llvm/lib/Target/WebAssembly/WebAssemblyUtilities.h (revision c921ac724ff06997bab25715786c98d4926b0c0e)
1984dc4b9SReid Kleckner //===-- WebAssemblyUtilities - WebAssembly Utility Functions ---*- C++ -*-====//
2984dc4b9SReid Kleckner //
3984dc4b9SReid Kleckner // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4984dc4b9SReid Kleckner // See https://llvm.org/LICENSE.txt for license information.
5984dc4b9SReid Kleckner // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6984dc4b9SReid Kleckner //
7984dc4b9SReid Kleckner //===----------------------------------------------------------------------===//
8984dc4b9SReid Kleckner ///
9984dc4b9SReid Kleckner /// \file
10984dc4b9SReid Kleckner /// This file contains the declaration of the WebAssembly-specific
11984dc4b9SReid Kleckner /// utility functions.
12984dc4b9SReid Kleckner ///
13984dc4b9SReid Kleckner //===----------------------------------------------------------------------===//
14984dc4b9SReid Kleckner 
15984dc4b9SReid Kleckner #ifndef LLVM_LIB_TARGET_WEBASSEMBLY_UTILS_WEBASSEMBLYUTILITIES_H
16984dc4b9SReid Kleckner #define LLVM_LIB_TARGET_WEBASSEMBLY_UTILS_WEBASSEMBLYUTILITIES_H
17984dc4b9SReid Kleckner 
18984dc4b9SReid Kleckner #include "llvm/Support/CommandLine.h"
19984dc4b9SReid Kleckner 
20984dc4b9SReid Kleckner namespace llvm {
21984dc4b9SReid Kleckner 
22984dc4b9SReid Kleckner class MachineBasicBlock;
23984dc4b9SReid Kleckner class MachineInstr;
24984dc4b9SReid Kleckner class MachineOperand;
25984dc4b9SReid Kleckner class MCContext;
26984dc4b9SReid Kleckner class MCSymbolWasm;
27984dc4b9SReid Kleckner class TargetRegisterClass;
28984dc4b9SReid Kleckner class WebAssemblyFunctionInfo;
29984dc4b9SReid Kleckner class WebAssemblySubtarget;
30984dc4b9SReid Kleckner 
31984dc4b9SReid Kleckner namespace WebAssembly {
32984dc4b9SReid Kleckner 
33984dc4b9SReid Kleckner bool isChild(const MachineInstr &MI, const WebAssemblyFunctionInfo &MFI);
34984dc4b9SReid Kleckner bool mayThrow(const MachineInstr &MI);
35984dc4b9SReid Kleckner 
36984dc4b9SReid Kleckner // Exception-related function names
37984dc4b9SReid Kleckner extern const char *const ClangCallTerminateFn;
38984dc4b9SReid Kleckner extern const char *const CxaBeginCatchFn;
39984dc4b9SReid Kleckner extern const char *const CxaRethrowFn;
40984dc4b9SReid Kleckner extern const char *const StdTerminateFn;
41984dc4b9SReid Kleckner extern const char *const PersonalityWrapperFn;
42984dc4b9SReid Kleckner 
43984dc4b9SReid Kleckner /// Returns the operand number of a callee, assuming the argument is a call
44984dc4b9SReid Kleckner /// instruction.
45984dc4b9SReid Kleckner const MachineOperand &getCalleeOp(const MachineInstr &MI);
46984dc4b9SReid Kleckner 
47984dc4b9SReid Kleckner /// Returns the __indirect_function_table, for use in call_indirect and in
48984dc4b9SReid Kleckner /// function bitcasts.
49984dc4b9SReid Kleckner MCSymbolWasm *
50984dc4b9SReid Kleckner getOrCreateFunctionTableSymbol(MCContext &Ctx,
51984dc4b9SReid Kleckner                                const WebAssemblySubtarget *Subtarget);
52984dc4b9SReid Kleckner 
53984dc4b9SReid Kleckner /// Returns the __funcref_call_table, for use in funcref calls when lowered to
54984dc4b9SReid Kleckner /// table.set + call_indirect.
55984dc4b9SReid Kleckner MCSymbolWasm *
56984dc4b9SReid Kleckner getOrCreateFuncrefCallTableSymbol(MCContext &Ctx,
57984dc4b9SReid Kleckner                                   const WebAssemblySubtarget *Subtarget);
58984dc4b9SReid Kleckner 
59984dc4b9SReid Kleckner /// Find a catch instruction from an EH pad. Returns null if no catch
60984dc4b9SReid Kleckner /// instruction found or the catch is in an invalid location.
61984dc4b9SReid Kleckner MachineInstr *findCatch(MachineBasicBlock *EHPad);
62984dc4b9SReid Kleckner 
63984dc4b9SReid Kleckner /// Returns the appropriate copy opcode for the given register class.
64984dc4b9SReid Kleckner unsigned getCopyOpcodeForRegClass(const TargetRegisterClass *RC);
65984dc4b9SReid Kleckner 
66*c921ac72SHeejin Ahn /// Returns true if multivalue returns of a function can be lowered directly,
67*c921ac72SHeejin Ahn /// i.e., not indirectly via a pointer parameter that points to the value in
68*c921ac72SHeejin Ahn /// memory.
69*c921ac72SHeejin Ahn bool canLowerMultivalueReturn(const WebAssemblySubtarget *Subtarget);
70*c921ac72SHeejin Ahn 
71*c921ac72SHeejin Ahn /// Returns true if the function's return value(s) can be lowered directly,
72*c921ac72SHeejin Ahn /// i.e., not indirectly via a pointer parameter that points to the value in
73*c921ac72SHeejin Ahn /// memory.
74*c921ac72SHeejin Ahn bool canLowerReturn(size_t ResultSize, const WebAssemblySubtarget *Subtarget);
75*c921ac72SHeejin Ahn 
76984dc4b9SReid Kleckner } // end namespace WebAssembly
77984dc4b9SReid Kleckner 
78984dc4b9SReid Kleckner } // end namespace llvm
79984dc4b9SReid Kleckner 
80984dc4b9SReid Kleckner #endif
81