Qt
Internal/Contributor docs for the Qt SDK. Note: These are NOT official API docs; those are found at https://doc.qt.io/
Loading...
Searching...
No Matches
qqmljstypepropagator_p.h
Go to the documentation of this file.
1// Copyright (C) 2021 The Qt Company Ltd.
2// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GPL-3.0-only WITH Qt-GPL-exception-1.0
3// Qt-Security score:significant
4
5#ifndef QQMLJSTYPEPROPAGATOR_P_H
6#define QQMLJSTYPEPROPAGATOR_P_H
7
8//
9// W A R N I N G
10// -------------
11//
12// This file is not part of the Qt API. It exists purely as an
13// implementation detail. This header file may change from version to
14// version without notice, or even be removed.
15//
16// We mean it.
17
18#include <private/qqmljsast_p.h>
19#include <private/qqmljsscope_p.h>
20#include <private/qqmljscompilepass_p.h>
21#include <private/qqmljscontextproperties_p.h>
22#include <private/qqmljsusercontextproperties_p.h>
23
24QT_BEGIN_NAMESPACE
25
26namespace QQmlSA {
27class PassManager;
28};
29
35
36struct Q_QMLCOMPILER_EXPORT QQmlJSTypePropagator : public QQmlJSCompilePass
37{
38 QQmlJSTypePropagator(const QV4::Compiler::JSUnitGenerator *unitGenerator,
39 const QQmlJSTypeResolver *typeResolver, QQmlJSLogger *logger,
40 const BasicBlocks &basicBlocks = {},
41 const InstructionAnnotations &annotations = {},
42 QQmlSA::PassManager *passManager = nullptr,
43 const ContextPropertyInfo &contextPropertyInfo = {});
44
45 BlocksAndAnnotations run(const Function *m_function);
46
47 void generate_Ret() override;
48 void generate_Debug() override;
49 void generate_LoadConst(int index) override;
50 void generate_LoadZero() override;
51 void generate_LoadTrue() override;
52 void generate_LoadFalse() override;
53 void generate_LoadNull() override;
54 void generate_LoadUndefined() override;
55 void generate_LoadInt(int value) override;
56 void generate_MoveConst(int constIndex, int destTemp) override;
57 void generate_LoadReg(int reg) override;
58 void generate_StoreReg(int reg) override;
59 void generate_MoveReg(int srcReg, int destReg) override;
60 void generate_LoadImport(int index) override;
61 void generate_LoadLocal(int index) override;
62 void generate_StoreLocal(int index) override;
63 void generate_LoadScopedLocal(int scope, int index) override;
64 void generate_StoreScopedLocal(int scope, int index) override;
65 void generate_LoadRuntimeString(int stringId) override;
66 void generate_MoveRegExp(int regExpId, int destReg) override;
67 void generate_LoadClosure(int value) override;
68 void generate_LoadName(int nameIndex) override;
69 void generate_LoadGlobalLookup(int index) override;
70 void generate_LoadQmlContextPropertyLookup(int index) override;
71 void generate_StoreNameCommon(int nameIndex);
72 void generate_StoreNameSloppy(int nameIndex) override;
73 void generate_StoreNameStrict(int name) override;
74 void generate_LoadElement(int base) override;
75 void generate_StoreElement(int base, int index) override;
76 void generate_LoadProperty(int nameIndex) override;
77 void generate_LoadOptionalProperty(int name, int offset) override;
78 void generate_GetLookup(int index) override;
79 void generate_GetOptionalLookup(int index, int offset) override;
80 void generate_StoreProperty(int name, int base) override;
81 void generate_SetLookup(int index, int base) override;
82 void generate_LoadSuperProperty(int property) override;
83 void generate_StoreSuperProperty(int property) override;
84 void generate_Yield() override;
85 void generate_YieldStar() override;
86 void generate_Resume(int) override;
87
88 void generate_CallValue(int name, int argc, int argv) override;
89 void generate_CallWithReceiver(int name, int thisObject, int argc, int argv) override;
90 void generate_CallProperty(int name, int base, int argc, int argv) override;
91 void generate_CallPropertyLookup(int lookupIndex, int base, int argc, int argv) override;
92 void generate_CallName(int name, int argc, int argv) override;
93 void generate_CallPossiblyDirectEval(int argc, int argv) override;
94 void generate_CallGlobalLookup(int index, int argc, int argv) override;
95 void generate_CallQmlContextPropertyLookup(int index, int argc, int argv) override;
96 void generate_CallWithSpread(int func, int thisObject, int argc, int argv) override;
97 void generate_TailCall(int func, int thisObject, int argc, int argv) override;
98 void generate_Construct(int func, int argc, int argv) override;
99 void generate_ConstructWithSpread(int func, int argc, int argv) override;
100 void generate_SetUnwindHandler(int offset) override;
101 void generate_UnwindDispatch() override;
102 void generate_UnwindToLabel(int level, int offset) override;
103 void generate_DeadTemporalZoneCheck(int name) override;
104 void generate_ThrowException() override;
105 void generate_GetException() override;
106 void generate_SetException() override;
107 void generate_CreateCallContext() override;
108 void generate_PushCatchContext(int index, int name) override;
109 void generate_PushWithContext() override;
110 void generate_PushBlockContext(int index) override;
111 void generate_CloneBlockContext() override;
112 void generate_PushScriptContext(int index) override;
113 void generate_PopScriptContext() override;
114 void generate_PopContext() override;
115 void generate_GetIterator(int iterator) override;
116 void generate_IteratorNext(int value, int offset) override;
117 void generate_IteratorNextForYieldStar(int iterator, int object, int offset) override;
118 void generate_IteratorClose() override;
119 void generate_DestructureRestElement() override;
120 void generate_DeleteProperty(int base, int index) override;
121 void generate_DeleteName(int name) override;
122 void generate_TypeofName(int name) override;
123 void generate_TypeofValue() override;
124 void generate_DeclareVar(int varName, int isDeletable) override;
125 void generate_DefineArray(int argc, int args) override;
126 void generate_DefineObjectLiteral(int internalClassId, int argc, int args) override;
127 void generate_CreateClass(int classIndex, int heritage, int computedNames) override;
128 void generate_CreateMappedArgumentsObject() override;
129 void generate_CreateUnmappedArgumentsObject() override;
130 void generate_CreateRestParameter(int argIndex) override;
131 void generate_ConvertThisToObject() override;
132 void generate_LoadSuperConstructor() override;
133 void generate_ToObject() override;
134 void generate_Jump(int offset) override;
135 void generate_JumpTrue(int offset) override;
136 void generate_JumpFalse(int offset) override;
137 void generate_JumpNoException(int offset) override;
138 void generate_JumpNotUndefined(int offset) override;
139 void generate_CheckException() override;
140 void generate_CmpEqNull() override;
141 void generate_CmpNeNull() override;
142 void generate_CmpEqInt(int lhsConst) override;
143 void generate_CmpNeInt(int lhs) override;
144 void generate_CmpEq(int lhs) override;
145 void generate_CmpNe(int lhs) override;
146 void generate_CmpGt(int lhs) override;
147 void generate_CmpGe(int lhs) override;
148 void generate_CmpLt(int lhs) override;
149 void generate_CmpLe(int lhs) override;
150 void generate_CmpStrictEqual(int lhs) override;
151 void generate_CmpStrictNotEqual(int lhs) override;
152 void generate_CmpIn(int lhs) override;
153 void generate_CmpInstanceOf(int lhs) override;
154 void generate_As(int lhs) override;
155 void generate_UNot() override;
156 void generate_UPlus() override;
157 void generate_UMinus() override;
158 void generate_UCompl() override;
159 void generate_Increment() override;
160 void generate_Decrement() override;
161 void generate_Add(int lhs) override;
162 void generate_BitAnd(int lhs) override;
163 void generate_BitOr(int lhs) override;
164 void generate_BitXor(int lhs) override;
165 void generate_UShr(int lhs) override;
166 void generate_Shr(int lhs) override;
167 void generate_Shl(int lhs) override;
168 void generate_BitAndConst(int rhsConst) override;
169 void generate_BitOrConst(int rhsConst) override;
170 void generate_BitXorConst(int rhsConst) override;
171 void generate_UShrConst(int rhsConst) override;
172 void generate_ShrConst(int rhs) override;
173 void generate_ShlConst(int rhs) override;
174 void generate_Exp(int lhs) override;
175 void generate_Mul(int lhs) override;
176 void generate_Div(int lhs) override;
177 void generate_Mod(int lhs) override;
178 void generate_Sub(int lhs) override;
179 void generate_InitializeBlockDeadTemporalZone(int firstReg, int count) override;
180 void generate_ThrowOnNullOrUndefined() override;
181 void generate_GetTemplateObject(int index) override;
182
183 bool checkForEnumProblems(QQmlJSRegisterContent base, const QString &propertyName);
184
185 Verdict startInstruction(QV4::Moth::Instr::Type instr) override;
186 void endInstruction(QV4::Moth::Instr::Type instr) override;
187
188private:
189 struct ExpectedRegisterState
190 {
191 int originatingOffset = 0;
192 VirtualRegisters registers;
193 };
194
195 struct PassState : QQmlJSCompilePass::State
196 {
197 InstructionAnnotations annotations;
198 QSet<int> jumpTargets;
199 bool skipInstructionsUntilNextJumpTarget = false;
200 bool needsMorePasses = false;
201 bool instructionHasError = false;
202 };
203
204 void handleUnqualifiedAccess(const QString &name, bool isMethod) const;
205 void handleUnqualifiedAccessAndContextProperties(const QString &name, bool isMethod) const;
206 void checkDeprecated(QQmlJSScope::ConstPtr scope, const QString &name, bool isMethod) const;
207 bool isCallingProperty(QQmlJSScope::ConstPtr scope, const QString &name) const;
208
209 enum PropertyResolution {
210 PropertyMissing,
211 PropertyTypeUnresolved,
212 PropertyFullyResolved
213 };
214
215 PropertyResolution propertyResolution(QQmlJSScope::ConstPtr scope, const QString &type) const;
216
217 void checkConversion(QQmlJSRegisterContent from, QQmlJSRegisterContent to);
218 void generateUnaryArithmeticOperation(QQmlJSTypeResolver::UnaryOperator op);
219
220 QQmlJSRegisterContent propagateBinaryOperation(QSOperator::Op op, int lhs);
221 void generateBinaryArithmeticOperation(QSOperator::Op op, int lhs);
222 void generateBinaryConstArithmeticOperation(QSOperator::Op op);
223
224 void propagateCall(
225 const QList<QQmlJSMetaMethod> &methods, int argc, int argv,
226 QQmlJSRegisterContent scope);
227 void propagateTranslationMethod_SAcheck(const QString &methodName);
228 bool propagateTranslationMethod(const QList<QQmlJSMetaMethod> &methods, int argc, int argv);
229 void propagateStringArgCall(QQmlJSRegisterContent base, int argv);
230 bool propagateArrayMethod(const QString &name, int argc, int argv, QQmlJSRegisterContent valueType);
231 void propagatePropertyLookup(
232 const QString &name, int lookupIndex = QQmlJSRegisterContent::InvalidLookupIndex);
233 void propagateScopeLookupCall(const QString &functionName, int argc, int argv);
234 void saveRegisterStateForJump(int offset);
235 bool canConvertFromTo(QQmlJSRegisterContent from, QQmlJSRegisterContent to);
236 bool canConvertFromTo(QQmlJSRegisterContent from, const QQmlJSScope::ConstPtr &to);
237
238 QString registerName(int registerIndex) const;
239
240 QQmlJSRegisterContent checkedInputRegister(int reg);
241 QQmlJSMetaMethod bestMatchForCall(const QList<QQmlJSMetaMethod> &methods, int argc, int argv,
242 QStringList *errors);
243
244 void setAccumulator(QQmlJSRegisterContent content);
245 void setRegister(int index, QQmlJSRegisterContent content);
246 void mergeRegister(int index, const VirtualRegister &a, const VirtualRegister &b);
247
248 void addReadRegister(int index);
249 void addReadRegister(int index, QQmlJSRegisterContent convertTo);
250 void addReadRegister(int index, const QQmlJSScope::ConstPtr &convertTo);
251
252 void addReadAccumulator()
253 {
254 addReadRegister(Accumulator);
255 }
256
257 void addReadAccumulator(QQmlJSRegisterContent convertTo)
258 {
259 addReadRegister(Accumulator, convertTo);
260 }
261
262 void addReadAccumulator(const QQmlJSScope::ConstPtr &convertTo)
263 {
264 addReadRegister(Accumulator, convertTo);
265 }
266
267 bool populatesAccumulator(QV4::Moth::Instr::Type instr) const;
268 bool isNoop(QV4::Moth::Instr::Type instr) const;
269
270 void recordEqualsNullType();
271 void recordEqualsIntType();
272 void recordEqualsType(int lhs);
273 void recordCompareType(int lhs);
274
275 // helper functions to deal with special cases in generate_ methods
276 void generate_CallProperty_SCMath(const QString &name, int base, int arcg, int argv);
277 void generate_CallProperty_SCconsole(const QString &name, int base, int argc, int argv);
278 void generate_Construct_SCDate(const QQmlJSMetaMethod &ctor, int argc, int argv);
279 void generate_Construct_SCArray(const QQmlJSMetaMethod &ctor, int argc, int argv);
280
281 // helper functions to perform QQmlSA checks
282 void generate_ret_SAcheck();
283 void generate_LoadQmlContextPropertyLookup_SAcheck(const QString &name);
284 void generate_StoreNameCommon_SAcheck(QQmlJSRegisterContent in, const QString &name);
285 void propagatePropertyLookup_SAcheck(const QString &propertyName);
286 void generate_StoreProperty_SAcheck(const QString &propertyName, QQmlJSRegisterContent callBase);
287 void generate_callProperty_SAcheck(const QString &propertyName,
288 const QQmlJSScope::ConstPtr &callBase);
289 void propagateCall_SAcheck(const QQmlJSMetaMethod &method,
290 const QQmlJSScope::ConstPtr &baseType);
291 void generate_GetOptionalLookup_SAcheck();
292
293 bool handleImportNamespaceLookup(const QString &propertyName);
294 void handleLookupError(const QString &propertyName);
295
296 void addError(const QString &message)
297 {
298 QQmlJSCompilePass::addError(message);
299 m_state.instructionHasError = true;
300 }
301
302 void setVarAccumulatorAndError()
303 {
304 setAccumulator(m_typeResolver->syntheticType(m_typeResolver->varType()));
305 m_state.instructionHasError = true;
306 }
307 void warnAboutTypeCoercion(int lhs);
308
309 QQmlJSRegisterContent m_returnType;
310 QQmlSA::PassManager *m_passManager = nullptr;
311
312 // Not part of the state, as the back jumps are the reason for running multiple passes
313 QMultiHash<int, ExpectedRegisterState> m_jumpOriginRegisterStateByTargetInstructionOffset;
314
315 InstructionAnnotations m_prevStateAnnotations;
316 PassState m_state;
317 ContextPropertyInfo m_contextPropertyInfo;
318};
319
320QT_END_NAMESPACE
321
322#endif // QQMLJSTYPEPROPAGATOR_P_H
QQmlSA
\inmodule QtQmlCompiler
Definition qqmljsscope_p.h:700
isStringOrNumberOrBoolean
static bool isStringOrNumberOrBoolean(const QQmlJSScope::ConstPtr &scope, const QQmlJSTypeResolver *resolver)
Definition qqmljstypepropagator.cpp:2654
INSTR_PROLOGUE_NOT_IMPLEMENTED
#define INSTR_PROLOGUE_NOT_IMPLEMENTED()
Definition qqmljstypepropagator.cpp:75
deepCompare
static bool deepCompare(const QQmlJSRegisterContent &a, const QQmlJSRegisterContent &b)
Definition qqmljstypepropagator.cpp:3297
shouldMentionRequiredProperties
static bool shouldMentionRequiredProperties(const QQmlJSScope::ConstPtr &qmlScope)
Definition qqmljstypepropagator.cpp:563
INSTR_PROLOGUE_NOT_IMPLEMENTED_IGNORE
#define INSTR_PROLOGUE_NOT_IMPLEMENTED_IGNORE()
Definition qqmljstypepropagator.cpp:84
INSTR_PROLOGUE_NOT_IMPLEMENTED_POPULATES_ACC
#define INSTR_PROLOGUE_NOT_IMPLEMENTED_POPULATES_ACC()
Definition qqmljstypepropagator.cpp:79
isLoggingMethod
static bool isLoggingMethod(const QString &consoleMethod)
Definition qqmljstypepropagator.cpp:1235
isVoidOrUndefined
static bool isVoidOrUndefined(const QQmlJSScope::ConstPtr &scope, const QQmlJSTypeResolver *resolver)
Definition qqmljstypepropagator.cpp:2661
mightContainStringOrNumberOrBoolean
static bool mightContainStringOrNumberOrBoolean(const QQmlJSScope::ConstPtr &scope, const QQmlJSTypeResolver *resolver)
Definition qqmljstypepropagator.cpp:2647
requiresStrictEquality
static bool requiresStrictEquality(const QQmlJSScope::ConstPtr &lhs, const QQmlJSScope::ConstPtr &rhs, const QQmlJSTypeResolver *resolver)
Definition qqmljstypepropagator.cpp:2667
ContextPropertyInfo::heuristicContextProperties
QQmlJS::HeuristicContextProperties heuristicContextProperties
Definition qqmljstypepropagator_p.h:32
ContextPropertyInfo::userContextProperties
QQmlJS::UserContextProperties userContextProperties
Definition qqmljstypepropagator_p.h:33