blob: 73d7b971286ea059d73a2417ab99e42d79bc43ca [file] [log] [blame]
// Copyright (c) 2017, the Dart project authors. Please see the AUTHORS file
// for details. All rights reserved. Use of this source code is governed by a
// BSD-style license that can be found in the LICENSE file.
library js_backend.backend.impact_transformer;
import '../closure.dart';
import '../common.dart';
import '../common_elements.dart';
import '../common/backend_api.dart' show ImpactTransformer;
import '../common/codegen.dart' show CodegenImpact;
import '../common/resolution.dart' show ResolutionImpact;
import '../common_elements.dart' show ElementEnvironment;
import '../constants/expressions.dart';
import '../elements/entities.dart';
import '../elements/types.dart';
import '../native/enqueue.dart';
import '../native/native.dart' as native;
import '../options.dart';
import '../universe/feature.dart';
import '../universe/use.dart'
show StaticUse, StaticUseKind, TypeUse, TypeUseKind;
import '../universe/world_impact.dart' show TransformedWorldImpact, WorldImpact;
import '../util/util.dart';
import 'backend_impact.dart';
import 'backend_usage.dart';
import 'checked_mode_helpers.dart';
import 'custom_elements_analysis.dart';
import 'interceptor_data.dart';
import 'mirrors_data.dart';
import 'namer.dart';
import 'native_data.dart';
import 'runtime_types.dart';
class JavaScriptImpactTransformer extends ImpactTransformer {
final CompilerOptions _options;
final ElementEnvironment _elementEnvironment;
final CommonElements _commonElements;
final BackendImpacts _impacts;
final NativeBasicData _nativeBasicData;
final NativeResolutionEnqueuer _nativeResolutionEnqueuer;
final BackendUsageBuilder _backendUsageBuider;
final MirrorsDataBuilder _mirrorsDataBuilder;
final CustomElementsResolutionAnalysis _customElementsResolutionAnalysis;
final RuntimeTypesNeedBuilder _rtiNeedBuilder;
JavaScriptImpactTransformer(
this._options,
this._elementEnvironment,
this._commonElements,
this._impacts,
this._nativeBasicData,
this._nativeResolutionEnqueuer,
this._backendUsageBuider,
this._mirrorsDataBuilder,
this._customElementsResolutionAnalysis,
this._rtiNeedBuilder);
@override
WorldImpact transformResolutionImpact(ResolutionImpact worldImpact) {
TransformedWorldImpact transformed =
new TransformedWorldImpact(worldImpact);
void registerImpact(BackendImpact impact) {
impact.registerImpact(transformed, _elementEnvironment);
_backendUsageBuider.processBackendImpact(impact);
}
for (Feature feature in worldImpact.features) {
switch (feature) {
case Feature.ABSTRACT_CLASS_INSTANTIATION:
registerImpact(_impacts.abstractClassInstantiation);
break;
case Feature.ASSERT:
registerImpact(_impacts.assertWithoutMessage);
break;
case Feature.ASSERT_WITH_MESSAGE:
registerImpact(_impacts.assertWithMessage);
break;
case Feature.ASYNC:
registerImpact(_impacts.asyncBody);
break;
case Feature.ASYNC_FOR_IN:
registerImpact(_impacts.asyncForIn);
break;
case Feature.ASYNC_STAR:
registerImpact(_impacts.asyncStarBody);
break;
case Feature.CATCH_STATEMENT:
registerImpact(_impacts.catchStatement);
break;
case Feature.COMPILE_TIME_ERROR:
if (_options.generateCodeWithCompileTimeErrors) {
// TODO(johnniwinther): This should have its own uncatchable error.
registerImpact(_impacts.throwRuntimeError);
}
break;
case Feature.FALL_THROUGH_ERROR:
registerImpact(_impacts.fallThroughError);
break;
case Feature.FIELD_WITHOUT_INITIALIZER:
case Feature.LOCAL_WITHOUT_INITIALIZER:
transformed.registerTypeUse(
new TypeUse.instantiation(_commonElements.nullType));
registerImpact(_impacts.nullLiteral);
break;
case Feature.LAZY_FIELD:
registerImpact(_impacts.lazyField);
break;
case Feature.STACK_TRACE_IN_CATCH:
registerImpact(_impacts.stackTraceInCatch);
break;
case Feature.STRING_INTERPOLATION:
registerImpact(_impacts.stringInterpolation);
break;
case Feature.STRING_JUXTAPOSITION:
registerImpact(_impacts.stringJuxtaposition);
break;
case Feature.SUPER_NO_SUCH_METHOD:
registerImpact(_impacts.superNoSuchMethod);
break;
case Feature.SYMBOL_CONSTRUCTOR:
registerImpact(_impacts.symbolConstructor);
break;
case Feature.SYNC_FOR_IN:
registerImpact(_impacts.syncForIn);
break;
case Feature.SYNC_STAR:
registerImpact(_impacts.syncStarBody);
break;
case Feature.THROW_EXPRESSION:
registerImpact(_impacts.throwExpression);
break;
case Feature.THROW_NO_SUCH_METHOD:
registerImpact(_impacts.throwNoSuchMethod);
break;
case Feature.THROW_RUNTIME_ERROR:
registerImpact(_impacts.throwRuntimeError);
break;
case Feature.THROW_UNSUPPORTED_ERROR:
registerImpact(_impacts.throwUnsupportedError);
break;
case Feature.TYPE_VARIABLE_BOUNDS_CHECK:
registerImpact(_impacts.typeVariableBoundCheck);
break;
}
}
bool hasAsCast = false;
bool hasTypeLiteral = false;
for (TypeUse typeUse in worldImpact.typeUses) {
DartType type = typeUse.type;
switch (typeUse.kind) {
case TypeUseKind.INSTANTIATION:
case TypeUseKind.MIRROR_INSTANTIATION:
case TypeUseKind.NATIVE_INSTANTIATION:
registerRequiredType(type);
break;
case TypeUseKind.IS_CHECK:
onIsCheck(type, transformed);
break;
case TypeUseKind.AS_CAST:
onIsCheck(type, transformed);
hasAsCast = true;
break;
case TypeUseKind.CHECKED_MODE_CHECK:
if (_options.enableTypeAssertions) {
onIsCheck(type, transformed);
}
break;
case TypeUseKind.CATCH_TYPE:
onIsCheck(type, transformed);
break;
case TypeUseKind.TYPE_LITERAL:
_customElementsResolutionAnalysis.registerTypeLiteral(type);
if (type.isTypeVariable) {
TypeVariableType typeVariable = type;
if (typeVariable.element.typeDeclaration is ClassEntity) {
// GENERIC_METHODS: The `is!` test above filters away method type
// variables, because they have the value `dynamic` with the
// incomplete support for generic methods offered with
// '--generic-method-syntax'. This must be revised in order to
// support generic methods fully.
ClassEntity cls = typeVariable.element.typeDeclaration;
_rtiNeedBuilder.registerClassUsingTypeVariableExpression(cls);
registerImpact(_impacts.typeVariableExpression);
}
}
hasTypeLiteral = true;
break;
}
}
if (hasAsCast) {
registerImpact(_impacts.asCheck);
}
if (hasTypeLiteral) {
transformed
.registerTypeUse(new TypeUse.instantiation(_commonElements.typeType));
registerImpact(_impacts.typeLiteral);
}
for (MapLiteralUse mapLiteralUse in worldImpact.mapLiterals) {
// TODO(johnniwinther): Use the [isEmpty] property when factory
// constructors are registered directly.
if (mapLiteralUse.isConstant) {
registerImpact(_impacts.constantMapLiteral);
} else {
transformed
.registerTypeUse(new TypeUse.instantiation(mapLiteralUse.type));
}
registerRequiredType(mapLiteralUse.type);
}
for (ListLiteralUse listLiteralUse in worldImpact.listLiterals) {
// TODO(johnniwinther): Use the [isConstant] and [isEmpty] property when
// factory constructors are registered directly.
transformed
.registerTypeUse(new TypeUse.instantiation(listLiteralUse.type));
registerRequiredType(listLiteralUse.type);
}
if (worldImpact.constSymbolNames.isNotEmpty) {
registerImpact(_impacts.constSymbol);
for (String constSymbolName in worldImpact.constSymbolNames) {
_mirrorsDataBuilder.registerConstSymbol(constSymbolName);
}
}
for (StaticUse staticUse in worldImpact.staticUses) {
switch (staticUse.kind) {
case StaticUseKind.CLOSURE:
registerImpact(_impacts.closure);
Local closure = staticUse.element;
FunctionType type = _elementEnvironment.getLocalFunctionType(closure);
if (type.containsTypeVariables) {
registerImpact(_impacts.computeSignature);
}
break;
case StaticUseKind.CONST_CONSTRUCTOR_INVOKE:
case StaticUseKind.CONSTRUCTOR_INVOKE:
registerRequiredType(staticUse.type);
break;
default:
}
}
for (ConstantExpression constant in worldImpact.constantLiterals) {
switch (constant.kind) {
case ConstantExpressionKind.NULL:
registerImpact(_impacts.nullLiteral);
break;
case ConstantExpressionKind.BOOL:
registerImpact(_impacts.boolLiteral);
break;
case ConstantExpressionKind.INT:
registerImpact(_impacts.intLiteral);
break;
case ConstantExpressionKind.DOUBLE:
registerImpact(_impacts.doubleLiteral);
break;
case ConstantExpressionKind.STRING:
registerImpact(_impacts.stringLiteral);
break;
default:
assert(
false,
failedAt(NO_LOCATION_SPANNABLE,
"Unexpected constant literal: ${constant.kind}."));
}
}
for (native.NativeBehavior behavior in worldImpact.nativeData) {
_nativeResolutionEnqueuer.registerNativeBehavior(
transformed, behavior, worldImpact);
}
return transformed;
}
/// Register [type] as required for the runtime type information system.
void registerRequiredType(DartType type) {
if (!type.isInterfaceType) return;
InterfaceType interfaceType = type;
// If [argument] has type variables or is a type variable, this method
// registers a RTI dependency between the class where the type variable is
// defined (that is the enclosing class of the current element being
// resolved) and the class of [type]. If the class of [type] requires RTI,
// then the class of the type variable does too.
ClassEntity contextClass = DartTypes.getClassContext(interfaceType);
if (contextClass != null) {
_rtiNeedBuilder.registerRtiDependency(
interfaceType.element, contextClass);
}
}
// TODO(johnniwinther): Maybe split this into [onAssertType] and [onTestType].
void onIsCheck(DartType type, TransformedWorldImpact transformed) {
void registerImpact(BackendImpact impact) {
impact.registerImpact(transformed, _elementEnvironment);
_backendUsageBuider.processBackendImpact(impact);
}
registerRequiredType(type);
type = _elementEnvironment.getUnaliasedType(type);
registerImpact(_impacts.typeCheck);
bool inCheckedMode = _options.enableTypeAssertions;
if (inCheckedMode) {
registerImpact(_impacts.checkedModeTypeCheck);
}
if (type.isMalformed) {
registerImpact(_impacts.malformedTypeCheck);
}
if (!type.treatAsRaw || type.containsTypeVariables || type.isFunctionType) {
registerImpact(_impacts.genericTypeCheck);
if (inCheckedMode) {
registerImpact(_impacts.genericCheckedModeTypeCheck);
}
if (type.isTypeVariable) {
registerImpact(_impacts.typeVariableTypeCheck);
if (inCheckedMode) {
registerImpact(_impacts.typeVariableCheckedModeTypeCheck);
}
}
}
if (type is FunctionType) {
registerImpact(_impacts.functionTypeCheck);
}
if (type is InterfaceType && _nativeBasicData.isNativeClass(type.element)) {
registerImpact(_impacts.nativeTypeCheck);
}
}
}
class CodegenImpactTransformer {
final CompilerOptions _options;
final ElementEnvironment _elementEnvironment;
final CommonElements _commonElements;
final BackendImpacts _impacts;
final CheckedModeHelpers _checkedModeHelpers;
final NativeData _nativeData;
final BackendUsage _backendUsage;
final RuntimeTypesNeed _rtiNeed;
final NativeCodegenEnqueuer _nativeCodegenEnqueuer;
final Namer _namer;
final OneShotInterceptorData _oneShotInterceptorData;
final RuntimeTypesChecksBuilder _rtiChecksBuilder;
CodegenImpactTransformer(
this._options,
this._elementEnvironment,
this._commonElements,
this._impacts,
this._checkedModeHelpers,
this._nativeData,
this._backendUsage,
this._rtiNeed,
this._nativeCodegenEnqueuer,
this._namer,
this._oneShotInterceptorData,
this._rtiChecksBuilder);
void onIsCheckForCodegen(DartType type, TransformedWorldImpact transformed) {
if (type.isDynamic) return;
if (type.isVoid) return;
type = type.unaliased;
_impacts.typeCheck.registerImpact(transformed, _elementEnvironment);
bool inCheckedMode = _options.enableTypeAssertions;
// [registerIsCheck] is also called for checked mode checks, so we
// need to register checked mode helpers.
if (inCheckedMode) {
// All helpers are added to resolution queue in enqueueHelpers. These
// calls to [enqueue] with the resolution enqueuer serve as assertions
// that the helper was in fact added.
// TODO(13155): Find a way to enqueue helpers lazily.
CheckedModeHelper helper =
_checkedModeHelpers.getCheckedModeHelper(type, typeCast: false);
if (helper != null) {
StaticUse staticUse = helper.getStaticUse(_commonElements);
transformed.registerStaticUse(staticUse);
}
// We also need the native variant of the check (for DOM types).
helper =
_checkedModeHelpers.getNativeCheckedModeHelper(type, typeCast: false);
if (helper != null) {
StaticUse staticUse = helper.getStaticUse(_commonElements);
transformed.registerStaticUse(staticUse);
}
}
if (!type.treatAsRaw || type.containsTypeVariables) {
_impacts.genericIsCheck.registerImpact(transformed, _elementEnvironment);
}
if (type is InterfaceType && _nativeData.isNativeClass(type.element)) {
// We will neeed to add the "$is" and "$as" properties on the
// JavaScript object prototype, so we make sure
// [:defineProperty:] is compiled.
_impacts.nativeTypeCheck.registerImpact(transformed, _elementEnvironment);
}
}
WorldImpact transformCodegenImpact(CodegenImpact impact) {
TransformedWorldImpact transformed = new TransformedWorldImpact(impact);
for (TypeUse typeUse in impact.typeUses) {
DartType type = typeUse.type;
if (typeUse.kind == TypeUseKind.IS_CHECK) {
onIsCheckForCodegen(type, transformed);
}
}
for (Pair<DartType, DartType> check
in impact.typeVariableBoundsSubtypeChecks) {
_rtiChecksBuilder.registerTypeVariableBoundsSubtypeCheck(
check.a, check.b);
}
for (StaticUse staticUse in impact.staticUses) {
if (staticUse.kind == StaticUseKind.CALL_METHOD) {
FunctionEntity callMethod = staticUse.element;
if (_rtiNeed.methodNeedsRti(callMethod)) {
_impacts.computeSignature
.registerImpact(transformed, _elementEnvironment);
} else if (callMethod is SynthesizedCallMethodElementX) {
if (_rtiNeed.localFunctionNeedsRti(callMethod.expression)) {
_impacts.computeSignature
.registerImpact(transformed, _elementEnvironment);
}
}
}
}
for (Set<ClassEntity> classes in impact.specializedGetInterceptors) {
_oneShotInterceptorData.registerSpecializedGetInterceptor(
classes, _namer);
}
if (impact.usesInterceptor) {
if (_nativeCodegenEnqueuer.hasInstantiatedNativeClasses) {
_impacts.interceptorUse
.registerImpact(transformed, _elementEnvironment);
// TODO(johnniwinther): Avoid these workarounds.
_backendUsage.needToInitializeIsolateAffinityTag = true;
_backendUsage.needToInitializeDispatchProperty = true;
}
}
for (AsyncMarker asyncMarker in impact.asyncMarkers) {
switch (asyncMarker) {
case AsyncMarker.ASYNC:
_impacts.asyncBody.registerImpact(transformed, _elementEnvironment);
break;
case AsyncMarker.SYNC_STAR:
_impacts.syncStarBody
.registerImpact(transformed, _elementEnvironment);
break;
case AsyncMarker.ASYNC_STAR:
_impacts.asyncStarBody
.registerImpact(transformed, _elementEnvironment);
break;
}
}
// TODO(johnniwinther): Remove eager registration.
return transformed;
}
}