godotengine
/
godot
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
godot/modules/gdscript/gdscript_byte_codegen.h

501 lines
20 KiB
C++
Raw Normal View History

Add GDScript code generation interface Implement the abstraction by targeting the current VM.
2020-07-28 18:17:49 +00:00
/*************************************************************************/
/* gdscript_byte_codegen.h */
/*************************************************************************/
/* This file is part of: */
/* GODOT ENGINE */
/* https://godotengine.org */
/*************************************************************************/
Update copyright statements to 2021 Happy new year to the wonderful Godot community! 2020 has been a tough year for most of us personally, but a good year for Godot development nonetheless with a huge amount of work done towards Godot 4.0 and great improvements backported to the long-lived 3.2 branch. We've had close to 400 contributors to engine code this year, authoring near 7,000 commit! (And that's only for the `master` branch and for the engine code, there's a lot more when counting docs, demos and other first-party repos.) Here's to a great year 2021 for all Godot users 🎆
2021-01-01 19:13:46 +00:00
/* Copyright (c) 2007-2021 Juan Linietsky, Ariel Manzur. */
/* Copyright (c) 2014-2021 Godot Engine contributors (cf. AUTHORS.md). */
Add GDScript code generation interface Implement the abstraction by targeting the current VM.
2020-07-28 18:17:49 +00:00
/* */
/* Permission is hereby granted, free of charge, to any person obtaining */
/* a copy of this software and associated documentation files (the */
/* "Software"), to deal in the Software without restriction, including */
/* without limitation the rights to use, copy, modify, merge, publish, */
/* distribute, sublicense, and/or sell copies of the Software, and to */
/* permit persons to whom the Software is furnished to do so, subject to */
/* the following conditions: */
/* */
/* The above copyright notice and this permission notice shall be */
/* included in all copies or substantial portions of the Software. */
/* */
/* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, */
/* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF */
/* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.*/
/* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY */
/* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, */
/* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE */
/* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */
/*************************************************************************/
#ifndef GDSCRIPT_BYTE_CODEGEN
#define GDSCRIPT_BYTE_CODEGEN
#include "gdscript_codegen.h"
GDScript: Gather instructions arguments beforehand Almost all instructions need variant arguments. With this change they are loaded in an array before each instruction call. This makes the addressing code be localized to less places, improving compilation overhead and binary size by a small margin. This should not affect performance.
2020-11-13 13:31:14 +00:00
#include "gdscript_function.h"
GDScript: Refactor builtin functions They are now called "utility functions" to avoid confusion with methods of builtin types, and be consistent with the naming in Variant. Core utility functions are now available in GDScript. The ones missing in core are added specifically to GDScript as helpers for convenience. Some functions were remove when there are better ways to do, reducing redundancy and cleaning up the global scope.
2020-11-26 14:56:32 +00:00
#include "gdscript_utility_functions.h"
GDScript: Gather instructions arguments beforehand Almost all instructions need variant arguments. With this change they are loaded in an array before each instruction call. This makes the addressing code be localized to less places, improving compilation overhead and binary size by a small margin. This should not affect performance.
2020-11-13 13:31:14 +00:00
Add GDScript code generation interface Implement the abstraction by targeting the current VM.
2020-07-28 18:17:49 +00:00
class GDScriptByteCodeGenerator : public GDScriptCodeGenerator {
GDScript: Pool temporary values by type on the stack So the stack slots perform less type changes, which is useful for future optimizations.
2021-04-14 17:35:51 +00:00
struct StackSlot {
Variant::Type type = Variant::NIL;
Vector<int> bytecode_indices;
StackSlot() = default;
StackSlot(Variant::Type p_type) :
type(p_type) {}
};
const static int RESERVED_STACK = 3; // For self, class, and nil.
Add GDScript code generation interface Implement the abstraction by targeting the current VM.
2020-07-28 18:17:49 +00:00
bool ended = false;
GDScriptFunction *function = nullptr;
bool debug_stack = false;
Vector<int> opcodes;
List<Map<StringName, int>> stack_id_stack;
Map<StringName, int> stack_identifiers;
GDScript: Fix mishandling of stack pointers - Replace the for loop temporaries by locals. They cause conflicts with the stack when being popped, while locals are properly handled in the scope. - Change the interface for the codegen so the for loop list doesn't live through the whole block if it's a temporary. - Keep track of the actual amount of local variables in the stack. Using the size of the map is misleading in cases where multiple locals have the same name (which is allowed when there's no shadowing). - Added a few debug checks for temporaries, to avoid them being wrongly manipulated in the future. They should not live more than a line of code. - Rearrange some of compiler code to make sure the temporaries don't live across blocks.
2020-11-22 15:24:40 +00:00
List<int> stack_identifiers_counts;
Add GDScript code generation interface Implement the abstraction by targeting the current VM.
2020-07-28 18:17:49 +00:00
Map<StringName, int> local_constants;
GDScript: Pool temporary values by type on the stack So the stack slots perform less type changes, which is useful for future optimizations.
2021-04-14 17:35:51 +00:00
Vector<StackSlot> locals;
Vector<StackSlot> temporaries;
List<int> used_temporaries;
Map<Variant::Type, List<int>> temporaries_pool;
Add GDScript code generation interface Implement the abstraction by targeting the current VM.
2020-07-28 18:17:49 +00:00
List<GDScriptFunction::StackDebug> stack_debug;
List<Map<StringName, int>> block_identifier_stack;
Map<StringName, int> block_identifiers;
GDScript: Pool temporary values by type on the stack So the stack slots perform less type changes, which is useful for future optimizations.
2021-04-14 17:35:51 +00:00
int max_locals = 0;
GDScript: Add faster operator for known types It now uses the direct operator function pointer, which increases performance in evaluation.
2020-11-13 19:47:45 +00:00
int current_line = 0;
int instr_args_max = 0;
GDScript: Add faster call instructions for native methods
2020-11-17 13:44:52 +00:00
int ptrcall_max = 0;
Add GDScript code generation interface Implement the abstraction by targeting the current VM.
2020-07-28 18:17:49 +00:00
GDScript: Fix mishandling of stack pointers - Replace the for loop temporaries by locals. They cause conflicts with the stack when being popped, while locals are properly handled in the scope. - Change the interface for the codegen so the for loop list doesn't live through the whole block if it's a temporary. - Keep track of the actual amount of local variables in the stack. Using the size of the map is misleading in cases where multiple locals have the same name (which is allowed when there's no shadowing). - Added a few debug checks for temporaries, to avoid them being wrongly manipulated in the future. They should not live more than a line of code. - Rearrange some of compiler code to make sure the temporaries don't live across blocks.
2020-11-22 15:24:40 +00:00
#ifdef DEBUG_ENABLED
List<int> temp_stack;
#endif
Add GDScript code generation interface Implement the abstraction by targeting the current VM.
2020-07-28 18:17:49 +00:00
HashMap<Variant, int, VariantHasher, VariantComparator> constant_map;
Map<StringName, int> name_map;
#ifdef TOOLS_ENABLED
Vector<StringName> named_globals;
#endif
GDScript: Add faster operator for known types It now uses the direct operator function pointer, which increases performance in evaluation.
2020-11-13 19:47:45 +00:00
Map<Variant::ValidatedOperatorEvaluator, int> operator_func_map;
GDScript: Add speficic set/get instructions When the base type is known at compile-time, we can get a direct function pointer that is faster than the regular set/get paths.
2020-11-16 15:59:53 +00:00
Map<Variant::ValidatedSetter, int> setters_map;
Map<Variant::ValidatedGetter, int> getters_map;
Map<Variant::ValidatedKeyedSetter, int> keyed_setters_map;
Map<Variant::ValidatedKeyedGetter, int> keyed_getters_map;
Map<Variant::ValidatedIndexedSetter, int> indexed_setters_map;
Map<Variant::ValidatedIndexedGetter, int> indexed_getters_map;
GDScript: Add faster call instructions for builtin methods Methods from builtin types can be called by using the function pointer when the argument and base types are known at compile time.
2020-11-18 13:32:28 +00:00
Map<Variant::ValidatedBuiltInMethod, int> builtin_method_map;
GDScript: Add faster instruction for validated constructor Only for built-in types.
2020-11-18 14:37:08 +00:00
Map<Variant::ValidatedConstructor, int> constructors_map;
GDScript: Refactor builtin functions They are now called "utility functions" to avoid confusion with methods of builtin types, and be consistent with the naming in Variant. Core utility functions are now available in GDScript. The ones missing in core are added specifically to GDScript as helpers for convenience. Some functions were remove when there are better ways to do, reducing redundancy and cleaning up the global scope.
2020-11-26 14:56:32 +00:00
Map<Variant::ValidatedUtilityFunction, int> utilities_map;
Map<GDScriptUtilityFunctions::FunctionPtr, int> gds_utilities_map;
GDScript: Add faster call instructions for native methods
2020-11-17 13:44:52 +00:00
Map<MethodBind *, int> method_bind_map;
GDScript: Implement lambdas compilation and runtime
2021-03-28 14:03:13 +00:00
Map<GDScriptFunction *, int> lambdas_map;
Add GDScript code generation interface Implement the abstraction by targeting the current VM.
2020-07-28 18:17:49 +00:00
GDScript: Fix mishandling of stack pointers - Replace the for loop temporaries by locals. They cause conflicts with the stack when being popped, while locals are properly handled in the scope. - Change the interface for the codegen so the for loop list doesn't live through the whole block if it's a temporary. - Keep track of the actual amount of local variables in the stack. Using the size of the map is misleading in cases where multiple locals have the same name (which is allowed when there's no shadowing). - Added a few debug checks for temporaries, to avoid them being wrongly manipulated in the future. They should not live more than a line of code. - Rearrange some of compiler code to make sure the temporaries don't live across blocks.
2020-11-22 15:24:40 +00:00
// Lists since these can be nested.
List<int> if_jmp_addrs;
Add GDScript code generation interface Implement the abstraction by targeting the current VM.
2020-07-28 18:17:49 +00:00
List<int> for_jmp_addrs;
GDScript: Fix mishandling of stack pointers - Replace the for loop temporaries by locals. They cause conflicts with the stack when being popped, while locals are properly handled in the scope. - Change the interface for the codegen so the for loop list doesn't live through the whole block if it's a temporary. - Keep track of the actual amount of local variables in the stack. Using the size of the map is misleading in cases where multiple locals have the same name (which is allowed when there's no shadowing). - Added a few debug checks for temporaries, to avoid them being wrongly manipulated in the future. They should not live more than a line of code. - Rearrange some of compiler code to make sure the temporaries don't live across blocks.
2020-11-22 15:24:40 +00:00
List<Address> for_iterator_variables;
List<Address> for_counter_variables;
List<Address> for_container_variables;
Add GDScript code generation interface Implement the abstraction by targeting the current VM.
2020-07-28 18:17:49 +00:00
List<int> while_jmp_addrs;
List<int> continue_addrs;
// Used to patch jumps with `and` and `or` operators with short-circuit.
List<int> logic_op_jump_pos1;
List<int> logic_op_jump_pos2;
List<Address> ternary_result;
List<int> ternary_jump_fail_pos;
List<int> ternary_jump_skip_pos;
List<List<int>> current_breaks_to_patch;
List<List<int>> match_continues_to_patch;
void add_stack_identifier(const StringName &p_id, int p_stackpos) {
GDScript: Pool temporary values by type on the stack So the stack slots perform less type changes, which is useful for future optimizations.
2021-04-14 17:35:51 +00:00
if (locals.size() > max_locals) {
max_locals = locals.size();
}
Add GDScript code generation interface Implement the abstraction by targeting the current VM.
2020-07-28 18:17:49 +00:00
stack_identifiers[p_id] = p_stackpos;
if (debug_stack) {
block_identifiers[p_id] = p_stackpos;
GDScriptFunction::StackDebug sd;
sd.added = true;
sd.line = current_line;
sd.identifier = p_id;
sd.pos = p_stackpos;
stack_debug.push_back(sd);
}
}
void push_stack_identifiers() {
GDScript: Pool temporary values by type on the stack So the stack slots perform less type changes, which is useful for future optimizations.
2021-04-14 17:35:51 +00:00
stack_identifiers_counts.push_back(locals.size());
Add GDScript code generation interface Implement the abstraction by targeting the current VM.
2020-07-28 18:17:49 +00:00
stack_id_stack.push_back(stack_identifiers);
if (debug_stack) {
GDScript: Fix mishandling of stack pointers - Replace the for loop temporaries by locals. They cause conflicts with the stack when being popped, while locals are properly handled in the scope. - Change the interface for the codegen so the for loop list doesn't live through the whole block if it's a temporary. - Keep track of the actual amount of local variables in the stack. Using the size of the map is misleading in cases where multiple locals have the same name (which is allowed when there's no shadowing). - Added a few debug checks for temporaries, to avoid them being wrongly manipulated in the future. They should not live more than a line of code. - Rearrange some of compiler code to make sure the temporaries don't live across blocks.
2020-11-22 15:24:40 +00:00
Map<StringName, int> block_ids(block_identifiers);
block_identifier_stack.push_back(block_ids);
Add GDScript code generation interface Implement the abstraction by targeting the current VM.
2020-07-28 18:17:49 +00:00
block_identifiers.clear();
}
}
void pop_stack_identifiers() {
GDScript: Pool temporary values by type on the stack So the stack slots perform less type changes, which is useful for future optimizations.
2021-04-14 17:35:51 +00:00
int current_locals = stack_identifiers_counts.back()->get();
GDScript: Fix mishandling of stack pointers - Replace the for loop temporaries by locals. They cause conflicts with the stack when being popped, while locals are properly handled in the scope. - Change the interface for the codegen so the for loop list doesn't live through the whole block if it's a temporary. - Keep track of the actual amount of local variables in the stack. Using the size of the map is misleading in cases where multiple locals have the same name (which is allowed when there's no shadowing). - Added a few debug checks for temporaries, to avoid them being wrongly manipulated in the future. They should not live more than a line of code. - Rearrange some of compiler code to make sure the temporaries don't live across blocks.
2020-11-22 15:24:40 +00:00
stack_identifiers_counts.pop_back();
Add GDScript code generation interface Implement the abstraction by targeting the current VM.
2020-07-28 18:17:49 +00:00
stack_identifiers = stack_id_stack.back()->get();
stack_id_stack.pop_back();
GDScript: Fix mishandling of stack pointers - Replace the for loop temporaries by locals. They cause conflicts with the stack when being popped, while locals are properly handled in the scope. - Change the interface for the codegen so the for loop list doesn't live through the whole block if it's a temporary. - Keep track of the actual amount of local variables in the stack. Using the size of the map is misleading in cases where multiple locals have the same name (which is allowed when there's no shadowing). - Added a few debug checks for temporaries, to avoid them being wrongly manipulated in the future. They should not live more than a line of code. - Rearrange some of compiler code to make sure the temporaries don't live across blocks.
2020-11-22 15:24:40 +00:00
#ifdef DEBUG_ENABLED
GDScript: Pool temporary values by type on the stack So the stack slots perform less type changes, which is useful for future optimizations.
2021-04-14 17:35:51 +00:00
if (!used_temporaries.is_empty()) {
ERR_PRINT("Leaving block with non-zero temporary variables: " + itos(used_temporaries.size()));
GDScript: Fix mishandling of stack pointers - Replace the for loop temporaries by locals. They cause conflicts with the stack when being popped, while locals are properly handled in the scope. - Change the interface for the codegen so the for loop list doesn't live through the whole block if it's a temporary. - Keep track of the actual amount of local variables in the stack. Using the size of the map is misleading in cases where multiple locals have the same name (which is allowed when there's no shadowing). - Added a few debug checks for temporaries, to avoid them being wrongly manipulated in the future. They should not live more than a line of code. - Rearrange some of compiler code to make sure the temporaries don't live across blocks.
2020-11-22 15:24:40 +00:00
}
#endif
GDScript: Pool temporary values by type on the stack So the stack slots perform less type changes, which is useful for future optimizations.
2021-04-14 17:35:51 +00:00
locals.resize(current_locals);
Add GDScript code generation interface Implement the abstraction by targeting the current VM.
2020-07-28 18:17:49 +00:00
if (debug_stack) {
for (Map<StringName, int>::Element *E = block_identifiers.front(); E; E = E->next()) {
GDScriptFunction::StackDebug sd;
sd.added = false;
sd.identifier = E->key();
sd.line = current_line;
sd.pos = E->get();
stack_debug.push_back(sd);
}
block_identifiers = block_identifier_stack.back()->get();
block_identifier_stack.pop_back();
}
}
int get_name_map_pos(const StringName &p_identifier) {
int ret;
if (!name_map.has(p_identifier)) {
ret = name_map.size();
name_map[p_identifier] = ret;
} else {
ret = name_map[p_identifier];
}
return ret;
}
int get_constant_pos(const Variant &p_constant) {
Style: Apply clang-tidy's `readability-braces-around-statements`
2021-04-05 12:09:59 +00:00
if (constant_map.has(p_constant)) {
Add GDScript code generation interface Implement the abstraction by targeting the current VM.
2020-07-28 18:17:49 +00:00
return constant_map[p_constant];
Style: Apply clang-tidy's `readability-braces-around-statements`
2021-04-05 12:09:59 +00:00
}
Add GDScript code generation interface Implement the abstraction by targeting the current VM.
2020-07-28 18:17:49 +00:00
int pos = constant_map.size();
constant_map[p_constant] = pos;
return pos;
}
GDScript: Add faster operator for known types It now uses the direct operator function pointer, which increases performance in evaluation.
2020-11-13 19:47:45 +00:00
int get_operation_pos(const Variant::ValidatedOperatorEvaluator p_operation) {
Style: Apply clang-tidy's `readability-braces-around-statements`
2021-04-05 12:09:59 +00:00
if (operator_func_map.has(p_operation)) {
GDScript: Add faster operator for known types It now uses the direct operator function pointer, which increases performance in evaluation.
2020-11-13 19:47:45 +00:00
return operator_func_map[p_operation];
Style: Apply clang-tidy's `readability-braces-around-statements`
2021-04-05 12:09:59 +00:00
}
GDScript: Add faster operator for known types It now uses the direct operator function pointer, which increases performance in evaluation.
2020-11-13 19:47:45 +00:00
int pos = operator_func_map.size();
operator_func_map[p_operation] = pos;
return pos;
}
GDScript: Add speficic set/get instructions When the base type is known at compile-time, we can get a direct function pointer that is faster than the regular set/get paths.
2020-11-16 15:59:53 +00:00
int get_setter_pos(const Variant::ValidatedSetter p_setter) {
Style: Apply clang-tidy's `readability-braces-around-statements`
2021-04-05 12:09:59 +00:00
if (setters_map.has(p_setter)) {
GDScript: Add speficic set/get instructions When the base type is known at compile-time, we can get a direct function pointer that is faster than the regular set/get paths.
2020-11-16 15:59:53 +00:00
return setters_map[p_setter];
Style: Apply clang-tidy's `readability-braces-around-statements`
2021-04-05 12:09:59 +00:00
}
GDScript: Add speficic set/get instructions When the base type is known at compile-time, we can get a direct function pointer that is faster than the regular set/get paths.
2020-11-16 15:59:53 +00:00
int pos = setters_map.size();
setters_map[p_setter] = pos;
return pos;
}
int get_getter_pos(const Variant::ValidatedGetter p_getter) {
Style: Apply clang-tidy's `readability-braces-around-statements`
2021-04-05 12:09:59 +00:00
if (getters_map.has(p_getter)) {
GDScript: Add speficic set/get instructions When the base type is known at compile-time, we can get a direct function pointer that is faster than the regular set/get paths.
2020-11-16 15:59:53 +00:00
return getters_map[p_getter];
Style: Apply clang-tidy's `readability-braces-around-statements`
2021-04-05 12:09:59 +00:00
}
GDScript: Add speficic set/get instructions When the base type is known at compile-time, we can get a direct function pointer that is faster than the regular set/get paths.
2020-11-16 15:59:53 +00:00
int pos = getters_map.size();
getters_map[p_getter] = pos;
return pos;
}
int get_keyed_setter_pos(const Variant::ValidatedKeyedSetter p_keyed_setter) {
Style: Apply clang-tidy's `readability-braces-around-statements`
2021-04-05 12:09:59 +00:00
if (keyed_setters_map.has(p_keyed_setter)) {
GDScript: Add speficic set/get instructions When the base type is known at compile-time, we can get a direct function pointer that is faster than the regular set/get paths.
2020-11-16 15:59:53 +00:00
return keyed_setters_map[p_keyed_setter];
Style: Apply clang-tidy's `readability-braces-around-statements`
2021-04-05 12:09:59 +00:00
}
GDScript: Add speficic set/get instructions When the base type is known at compile-time, we can get a direct function pointer that is faster than the regular set/get paths.
2020-11-16 15:59:53 +00:00
int pos = keyed_setters_map.size();
keyed_setters_map[p_keyed_setter] = pos;
return pos;
}
int get_keyed_getter_pos(const Variant::ValidatedKeyedGetter p_keyed_getter) {
Style: Apply clang-tidy's `readability-braces-around-statements`
2021-04-05 12:09:59 +00:00
if (keyed_getters_map.has(p_keyed_getter)) {
GDScript: Add speficic set/get instructions When the base type is known at compile-time, we can get a direct function pointer that is faster than the regular set/get paths.
2020-11-16 15:59:53 +00:00
return keyed_getters_map[p_keyed_getter];
Style: Apply clang-tidy's `readability-braces-around-statements`
2021-04-05 12:09:59 +00:00
}
GDScript: Add speficic set/get instructions When the base type is known at compile-time, we can get a direct function pointer that is faster than the regular set/get paths.
2020-11-16 15:59:53 +00:00
int pos = keyed_getters_map.size();
keyed_getters_map[p_keyed_getter] = pos;
return pos;
}
int get_indexed_setter_pos(const Variant::ValidatedIndexedSetter p_indexed_setter) {
Style: Apply clang-tidy's `readability-braces-around-statements`
2021-04-05 12:09:59 +00:00
if (indexed_setters_map.has(p_indexed_setter)) {
GDScript: Add speficic set/get instructions When the base type is known at compile-time, we can get a direct function pointer that is faster than the regular set/get paths.
2020-11-16 15:59:53 +00:00
return indexed_setters_map[p_indexed_setter];
Style: Apply clang-tidy's `readability-braces-around-statements`
2021-04-05 12:09:59 +00:00
}
GDScript: Add speficic set/get instructions When the base type is known at compile-time, we can get a direct function pointer that is faster than the regular set/get paths.
2020-11-16 15:59:53 +00:00
int pos = indexed_setters_map.size();
indexed_setters_map[p_indexed_setter] = pos;
return pos;
}
int get_indexed_getter_pos(const Variant::ValidatedIndexedGetter p_indexed_getter) {
Style: Apply clang-tidy's `readability-braces-around-statements`
2021-04-05 12:09:59 +00:00
if (indexed_getters_map.has(p_indexed_getter)) {
GDScript: Add speficic set/get instructions When the base type is known at compile-time, we can get a direct function pointer that is faster than the regular set/get paths.
2020-11-16 15:59:53 +00:00
return indexed_getters_map[p_indexed_getter];
Style: Apply clang-tidy's `readability-braces-around-statements`
2021-04-05 12:09:59 +00:00
}
GDScript: Add speficic set/get instructions When the base type is known at compile-time, we can get a direct function pointer that is faster than the regular set/get paths.
2020-11-16 15:59:53 +00:00
int pos = indexed_getters_map.size();
indexed_getters_map[p_indexed_getter] = pos;
return pos;
}
GDScript: Add faster call instructions for builtin methods Methods from builtin types can be called by using the function pointer when the argument and base types are known at compile time.
2020-11-18 13:32:28 +00:00
int get_builtin_method_pos(const Variant::ValidatedBuiltInMethod p_method) {
if (builtin_method_map.has(p_method)) {
return builtin_method_map[p_method];
}
int pos = builtin_method_map.size();
builtin_method_map[p_method] = pos;
return pos;
}
GDScript: Add faster instruction for validated constructor Only for built-in types.
2020-11-18 14:37:08 +00:00
int get_constructor_pos(const Variant::ValidatedConstructor p_constructor) {
if (constructors_map.has(p_constructor)) {
return constructors_map[p_constructor];
}
int pos = constructors_map.size();
constructors_map[p_constructor] = pos;
return pos;
}
GDScript: Refactor builtin functions They are now called "utility functions" to avoid confusion with methods of builtin types, and be consistent with the naming in Variant. Core utility functions are now available in GDScript. The ones missing in core are added specifically to GDScript as helpers for convenience. Some functions were remove when there are better ways to do, reducing redundancy and cleaning up the global scope.
2020-11-26 14:56:32 +00:00
int get_utility_pos(const Variant::ValidatedUtilityFunction p_utility) {
if (utilities_map.has(p_utility)) {
return utilities_map[p_utility];
}
int pos = utilities_map.size();
utilities_map[p_utility] = pos;
return pos;
}
int get_gds_utility_pos(const GDScriptUtilityFunctions::FunctionPtr p_gds_utility) {
if (gds_utilities_map.has(p_gds_utility)) {
return gds_utilities_map[p_gds_utility];
}
int pos = gds_utilities_map.size();
gds_utilities_map[p_gds_utility] = pos;
return pos;
}
GDScript: Add faster call instructions for native methods
2020-11-17 13:44:52 +00:00
int get_method_bind_pos(MethodBind *p_method) {
if (method_bind_map.has(p_method)) {
return method_bind_map[p_method];
}
int pos = method_bind_map.size();
method_bind_map[p_method] = pos;
return pos;
}
GDScript: Implement lambdas compilation and runtime
2021-03-28 14:03:13 +00:00
int get_lambda_function_pos(GDScriptFunction *p_lambda_function) {
if (lambdas_map.has(p_lambda_function)) {
return lambdas_map[p_lambda_function];
}
int pos = lambdas_map.size();
lambdas_map[p_lambda_function] = pos;
return pos;
}
GDScript: Add faster call instructions for native methods
2020-11-17 13:44:52 +00:00
void alloc_ptrcall(int p_params) {
Style: Apply clang-tidy's `readability-braces-around-statements`
2021-04-05 12:09:59 +00:00
if (p_params >= ptrcall_max) {
GDScript: Add faster call instructions for native methods
2020-11-17 13:44:52 +00:00
ptrcall_max = p_params;
Style: Apply clang-tidy's `readability-braces-around-statements`
2021-04-05 12:09:59 +00:00
}
GDScript: Add faster call instructions for native methods
2020-11-17 13:44:52 +00:00
}
Add GDScript code generation interface Implement the abstraction by targeting the current VM.
2020-07-28 18:17:49 +00:00
int address_of(const Address &p_address) {
switch (p_address.mode) {
case Address::SELF:
Reduce number of addressing modes in GDScript VM There's now only 3 addressing modes: stack, constant, and member. Self, class, and nil are now present respectively in the first 3 stack slots. Global and class constants are moved to local constants when compiling. Named globals is only present on editor to use on tool singletons, so its use now emits a new instruction to copy the global to the stack. This allow us to further optimize the VM later by embedding the addressing modes in the instructions themselves, which is better done with less permutations.
2021-04-08 14:55:24 +00:00
return GDScriptFunction::ADDR_SELF;
Add GDScript code generation interface Implement the abstraction by targeting the current VM.
2020-07-28 18:17:49 +00:00
case Address::CLASS:
Reduce number of addressing modes in GDScript VM There's now only 3 addressing modes: stack, constant, and member. Self, class, and nil are now present respectively in the first 3 stack slots. Global and class constants are moved to local constants when compiling. Named globals is only present on editor to use on tool singletons, so its use now emits a new instruction to copy the global to the stack. This allow us to further optimize the VM later by embedding the addressing modes in the instructions themselves, which is better done with less permutations.
2021-04-08 14:55:24 +00:00
return GDScriptFunction::ADDR_CLASS;
Add GDScript code generation interface Implement the abstraction by targeting the current VM.
2020-07-28 18:17:49 +00:00
case Address::MEMBER:
return p_address.address | (GDScriptFunction::ADDR_TYPE_MEMBER << GDScriptFunction::ADDR_BITS);
case Address::CONSTANT:
Reduce number of addressing modes in GDScript VM There's now only 3 addressing modes: stack, constant, and member. Self, class, and nil are now present respectively in the first 3 stack slots. Global and class constants are moved to local constants when compiling. Named globals is only present on editor to use on tool singletons, so its use now emits a new instruction to copy the global to the stack. This allow us to further optimize the VM later by embedding the addressing modes in the instructions themselves, which is better done with less permutations.
2021-04-08 14:55:24 +00:00
return p_address.address | (GDScriptFunction::ADDR_TYPE_CONSTANT << GDScriptFunction::ADDR_BITS);
Add GDScript code generation interface Implement the abstraction by targeting the current VM.
2020-07-28 18:17:49 +00:00
case Address::LOCAL_VARIABLE:
case Address::FUNCTION_PARAMETER:
return p_address.address | (GDScriptFunction::ADDR_TYPE_STACK << GDScriptFunction::ADDR_BITS);
GDScript: Pool temporary values by type on the stack So the stack slots perform less type changes, which is useful for future optimizations.
2021-04-14 17:35:51 +00:00
case Address::TEMPORARY:
temporaries.write[p_address.address].bytecode_indices.push_back(opcodes.size());
return -1;
Add GDScript code generation interface Implement the abstraction by targeting the current VM.
2020-07-28 18:17:49 +00:00
case Address::NIL:
Reduce number of addressing modes in GDScript VM There's now only 3 addressing modes: stack, constant, and member. Self, class, and nil are now present respectively in the first 3 stack slots. Global and class constants are moved to local constants when compiling. Named globals is only present on editor to use on tool singletons, so its use now emits a new instruction to copy the global to the stack. This allow us to further optimize the VM later by embedding the addressing modes in the instructions themselves, which is better done with less permutations.
2021-04-08 14:55:24 +00:00
return GDScriptFunction::ADDR_NIL;
Add GDScript code generation interface Implement the abstraction by targeting the current VM.
2020-07-28 18:17:49 +00:00
}
return -1; // Unreachable.
}
GDScript: Gather instructions arguments beforehand Almost all instructions need variant arguments. With this change they are loaded in an array before each instruction call. This makes the addressing code be localized to less places, improving compilation overhead and binary size by a small margin. This should not affect performance.
2020-11-13 13:31:14 +00:00
void append(GDScriptFunction::Opcode p_code, int p_argument_count) {
opcodes.push_back((p_code & GDScriptFunction::INSTR_MASK) | (p_argument_count << GDScriptFunction::INSTR_BITS));
instr_args_max = MAX(instr_args_max, p_argument_count);
}
void append(int p_code) {
opcodes.push_back(p_code);
Add GDScript code generation interface Implement the abstraction by targeting the current VM.
2020-07-28 18:17:49 +00:00
}
void append(const Address &p_address) {
opcodes.push_back(address_of(p_address));
}
void append(const StringName &p_name) {
opcodes.push_back(get_name_map_pos(p_name));
}
GDScript: Add faster operator for known types It now uses the direct operator function pointer, which increases performance in evaluation.
2020-11-13 19:47:45 +00:00
void append(const Variant::ValidatedOperatorEvaluator p_operation) {
opcodes.push_back(get_operation_pos(p_operation));
}
GDScript: Add speficic set/get instructions When the base type is known at compile-time, we can get a direct function pointer that is faster than the regular set/get paths.
2020-11-16 15:59:53 +00:00
void append(const Variant::ValidatedSetter p_setter) {
opcodes.push_back(get_setter_pos(p_setter));
}
void append(const Variant::ValidatedGetter p_getter) {
opcodes.push_back(get_getter_pos(p_getter));
}
void append(const Variant::ValidatedKeyedSetter p_keyed_setter) {
opcodes.push_back(get_keyed_setter_pos(p_keyed_setter));
}
void append(const Variant::ValidatedKeyedGetter p_keyed_getter) {
opcodes.push_back(get_keyed_getter_pos(p_keyed_getter));
}
void append(const Variant::ValidatedIndexedSetter p_indexed_setter) {
opcodes.push_back(get_indexed_setter_pos(p_indexed_setter));
}
void append(const Variant::ValidatedIndexedGetter p_indexed_getter) {
opcodes.push_back(get_indexed_getter_pos(p_indexed_getter));
}
GDScript: Add faster call instructions for builtin methods Methods from builtin types can be called by using the function pointer when the argument and base types are known at compile time.
2020-11-18 13:32:28 +00:00
void append(const Variant::ValidatedBuiltInMethod p_method) {
opcodes.push_back(get_builtin_method_pos(p_method));
}
GDScript: Add faster instruction for validated constructor Only for built-in types.
2020-11-18 14:37:08 +00:00
void append(const Variant::ValidatedConstructor p_constructor) {
opcodes.push_back(get_constructor_pos(p_constructor));
}
GDScript: Refactor builtin functions They are now called "utility functions" to avoid confusion with methods of builtin types, and be consistent with the naming in Variant. Core utility functions are now available in GDScript. The ones missing in core are added specifically to GDScript as helpers for convenience. Some functions were remove when there are better ways to do, reducing redundancy and cleaning up the global scope.
2020-11-26 14:56:32 +00:00
void append(const Variant::ValidatedUtilityFunction p_utility) {
opcodes.push_back(get_utility_pos(p_utility));
}
void append(const GDScriptUtilityFunctions::FunctionPtr p_gds_utility) {
opcodes.push_back(get_gds_utility_pos(p_gds_utility));
}
GDScript: Add faster call instructions for native methods
2020-11-17 13:44:52 +00:00
void append(MethodBind *p_method) {
opcodes.push_back(get_method_bind_pos(p_method));
}
GDScript: Implement lambdas compilation and runtime
2021-03-28 14:03:13 +00:00
void append(GDScriptFunction *p_lambda_function) {
opcodes.push_back(get_lambda_function_pos(p_lambda_function));
}
Add GDScript code generation interface Implement the abstraction by targeting the current VM.
2020-07-28 18:17:49 +00:00
void patch_jump(int p_address) {
opcodes.write[p_address] = opcodes.size();
}
public:
virtual uint32_t add_parameter(const StringName &p_name, bool p_is_optional, const GDScriptDataType &p_type) override;
virtual uint32_t add_local(const StringName &p_name, const GDScriptDataType &p_type) override;
virtual uint32_t add_local_constant(const StringName &p_name, const Variant &p_constant) override;
virtual uint32_t add_or_get_constant(const Variant &p_constant) override;
virtual uint32_t add_or_get_name(const StringName &p_name) override;
GDScript: Pool temporary values by type on the stack So the stack slots perform less type changes, which is useful for future optimizations.
2021-04-14 17:35:51 +00:00
virtual uint32_t add_temporary(const GDScriptDataType &p_type) override;
Add GDScript code generation interface Implement the abstraction by targeting the current VM.
2020-07-28 18:17:49 +00:00
virtual void pop_temporary() override;
virtual void start_parameters() override;
virtual void end_parameters() override;
virtual void start_block() override;
virtual void end_block() override;
virtual void write_start(GDScript *p_script, const StringName &p_function_name, bool p_static, MultiplayerAPI::RPCMode p_rpc_mode, const GDScriptDataType &p_return_type) override;
virtual GDScriptFunction *write_end() override;
#ifdef DEBUG_ENABLED
virtual void set_signature(const String &p_signature) override;
#endif
virtual void set_initial_line(int p_line) override;
GDScript: Adjust type of temporaries when needed
2021-04-16 15:04:08 +00:00
virtual void write_type_adjust(const Address &p_target, Variant::Type p_new_type) override;
GDScript: Improve handling of operators - Use the new functions in Variant to determine the validity and resulting type of operators. - Split the operator function in codegen between binary and unary, since the unary ones have now a special requirement of having the second argument to be the NIL type when requesting info.
2020-11-26 17:41:55 +00:00
virtual void write_unary_operator(const Address &p_target, Variant::Operator p_operator, const Address &p_left_operand) override;
virtual void write_binary_operator(const Address &p_target, Variant::Operator p_operator, const Address &p_left_operand, const Address &p_right_operand) override;
Add GDScript code generation interface Implement the abstraction by targeting the current VM.
2020-07-28 18:17:49 +00:00
virtual void write_type_test(const Address &p_target, const Address &p_source, const Address &p_type) override;
virtual void write_type_test_builtin(const Address &p_target, const Address &p_source, Variant::Type p_type) override;
virtual void write_and_left_operand(const Address &p_left_operand) override;
virtual void write_and_right_operand(const Address &p_right_operand) override;
virtual void write_end_and(const Address &p_target) override;
virtual void write_or_left_operand(const Address &p_left_operand) override;
virtual void write_or_right_operand(const Address &p_right_operand) override;
virtual void write_end_or(const Address &p_target) override;
virtual void write_start_ternary(const Address &p_target) override;
virtual void write_ternary_condition(const Address &p_condition) override;
virtual void write_ternary_true_expr(const Address &p_expr) override;
virtual void write_ternary_false_expr(const Address &p_expr) override;
virtual void write_end_ternary() override;
virtual void write_set(const Address &p_target, const Address &p_index, const Address &p_source) override;
virtual void write_get(const Address &p_target, const Address &p_index, const Address &p_source) override;
virtual void write_set_named(const Address &p_target, const StringName &p_name, const Address &p_source) override;
virtual void write_get_named(const Address &p_target, const StringName &p_name, const Address &p_source) override;
virtual void write_set_member(const Address &p_value, const StringName &p_name) override;
virtual void write_get_member(const Address &p_target, const StringName &p_name) override;
virtual void write_assign(const Address &p_target, const Address &p_source) override;
virtual void write_assign_true(const Address &p_target) override;
virtual void write_assign_false(const Address &p_target) override;
GDScript default argument override bug fix Fix: #41766
2020-09-04 21:46:23 +00:00
virtual void write_assign_default_parameter(const Address &p_dst, const Address &p_src) override;
Reduce number of addressing modes in GDScript VM There's now only 3 addressing modes: stack, constant, and member. Self, class, and nil are now present respectively in the first 3 stack slots. Global and class constants are moved to local constants when compiling. Named globals is only present on editor to use on tool singletons, so its use now emits a new instruction to copy the global to the stack. This allow us to further optimize the VM later by embedding the addressing modes in the instructions themselves, which is better done with less permutations.
2021-04-08 14:55:24 +00:00
virtual void write_store_named_global(const Address &p_dst, const StringName &p_global) override;
Add GDScript code generation interface Implement the abstraction by targeting the current VM.
2020-07-28 18:17:49 +00:00
virtual void write_cast(const Address &p_target, const Address &p_source, const GDScriptDataType &p_type) override;
virtual void write_call(const Address &p_target, const Address &p_base, const StringName &p_function_name, const Vector<Address> &p_arguments) override;
virtual void write_super_call(const Address &p_target, const StringName &p_function_name, const Vector<Address> &p_arguments) override;
virtual void write_call_async(const Address &p_target, const Address &p_base, const StringName &p_function_name, const Vector<Address> &p_arguments) override;
GDScript: Refactor builtin functions They are now called "utility functions" to avoid confusion with methods of builtin types, and be consistent with the naming in Variant. Core utility functions are now available in GDScript. The ones missing in core are added specifically to GDScript as helpers for convenience. Some functions were remove when there are better ways to do, reducing redundancy and cleaning up the global scope.
2020-11-26 14:56:32 +00:00
virtual void write_call_utility(const Address &p_target, const StringName &p_function, const Vector<Address> &p_arguments) override;
virtual void write_call_gdscript_utility(const Address &p_target, GDScriptUtilityFunctions::FunctionPtr p_function, const Vector<Address> &p_arguments) override;
GDScript: Add faster call instructions for builtin methods Methods from builtin types can be called by using the function pointer when the argument and base types are known at compile time.
2020-11-18 13:32:28 +00:00
virtual void write_call_builtin_type(const Address &p_target, const Address &p_base, Variant::Type p_type, const StringName &p_method, const Vector<Address> &p_arguments) override;
GDScript: Add support for builtin static method calls
2021-05-16 14:48:53 +00:00
virtual void write_call_builtin_type_static(const Address &p_target, Variant::Type p_type, const StringName &p_method, const Vector<Address> &p_arguments) override;
GDScript: Add faster call instructions for native methods
2020-11-17 13:44:52 +00:00
virtual void write_call_method_bind(const Address &p_target, const Address &p_base, MethodBind *p_method, const Vector<Address> &p_arguments) override;
virtual void write_call_ptrcall(const Address &p_target, const Address &p_base, MethodBind *p_method, const Vector<Address> &p_arguments) override;
Add GDScript code generation interface Implement the abstraction by targeting the current VM.
2020-07-28 18:17:49 +00:00
virtual void write_call_self(const Address &p_target, const StringName &p_function_name, const Vector<Address> &p_arguments) override;
Fix error when calling coroutine with await in _ready The code paths for calling async functions seemed to be missing in some cases, causing a debug break and false positive error.
2020-12-04 23:42:45 +00:00
virtual void write_call_self_async(const Address &p_target, const StringName &p_function_name, const Vector<Address> &p_arguments) override;
Add GDScript code generation interface Implement the abstraction by targeting the current VM.
2020-07-28 18:17:49 +00:00
virtual void write_call_script_function(const Address &p_target, const Address &p_base, const StringName &p_function_name, const Vector<Address> &p_arguments) override;
GDScript: Implement lambdas compilation and runtime
2021-03-28 14:03:13 +00:00
virtual void write_lambda(const Address &p_target, GDScriptFunction *p_function, const Vector<Address> &p_captures) override;
Add GDScript code generation interface Implement the abstraction by targeting the current VM.
2020-07-28 18:17:49 +00:00
virtual void write_construct(const Address &p_target, Variant::Type p_type, const Vector<Address> &p_arguments) override;
virtual void write_construct_array(const Address &p_target, const Vector<Address> &p_arguments) override;
Add typed arrays to GDScript - Use `Array[type]` for type-hints. e.g.: `var array: Array[int] = [1, 2, 3]` - Array literals are typed if their storage is typed (variable asssignment of as argument in function all). Otherwise they are untyped.
2021-03-09 15:32:35 +00:00
virtual void write_construct_typed_array(const Address &p_target, const GDScriptDataType &p_element_type, const Vector<Address> &p_arguments) override;
Add GDScript code generation interface Implement the abstraction by targeting the current VM.
2020-07-28 18:17:49 +00:00
virtual void write_construct_dictionary(const Address &p_target, const Vector<Address> &p_arguments) override;
virtual void write_await(const Address &p_target, const Address &p_operand) override;
virtual void write_if(const Address &p_condition) override;
virtual void write_else() override;
virtual void write_endif() override;
GDScript: Fix mishandling of stack pointers - Replace the for loop temporaries by locals. They cause conflicts with the stack when being popped, while locals are properly handled in the scope. - Change the interface for the codegen so the for loop list doesn't live through the whole block if it's a temporary. - Keep track of the actual amount of local variables in the stack. Using the size of the map is misleading in cases where multiple locals have the same name (which is allowed when there's no shadowing). - Added a few debug checks for temporaries, to avoid them being wrongly manipulated in the future. They should not live more than a line of code. - Rearrange some of compiler code to make sure the temporaries don't live across blocks.
2020-11-22 15:24:40 +00:00
virtual void start_for(const GDScriptDataType &p_iterator_type, const GDScriptDataType &p_list_type) override;
virtual void write_for_assignment(const Address &p_variable, const Address &p_list) override;
virtual void write_for() override;
Add GDScript code generation interface Implement the abstraction by targeting the current VM.
2020-07-28 18:17:49 +00:00
virtual void write_endfor() override;
virtual void start_while_condition() override;
virtual void write_while(const Address &p_condition) override;
virtual void write_endwhile() override;
virtual void start_match() override;
virtual void start_match_branch() override;
virtual void end_match() override;
virtual void write_break() override;
virtual void write_continue() override;
virtual void write_continue_match() override;
virtual void write_breakpoint() override;
virtual void write_newline(int p_line) override;
virtual void write_return(const Address &p_return_value) override;
virtual void write_assert(const Address &p_test, const Address &p_message) override;
virtual ~GDScriptByteCodeGenerator();
};
#endif // GDSCRIPT_BYTE_CODEGEN