LambdaRewriter.cs 77.4 KB
Newer Older
1
// Copyright (c) Microsoft.  All Rights Reserved.  Licensed under the Apache License, Version 2.0.  See License.txt in the project root for license information.
P
Pilchie 已提交
2 3 4 5

#if DEBUG
//#define CHECK_LOCALS // define CHECK_LOCALS to help debug some rewriting problems that would otherwise cause code-gen failures

6
#endif
A
Andy Gocke 已提交
7

P
Pilchie 已提交
8 9 10 11
using System;
using System.Collections.Generic;
using System.Collections.Immutable;
using System.Diagnostics;
12
using Microsoft.CodeAnalysis.CodeGen;
P
Pilchie 已提交
13
using Microsoft.CodeAnalysis.CSharp.Symbols;
14
using Microsoft.CodeAnalysis.CSharp.Syntax;
T
Tomas Matousek 已提交
15
using Microsoft.CodeAnalysis.PooledObjects;
P
Pilchie 已提交
16 17 18 19 20 21 22 23 24
using Roslyn.Utilities;

namespace Microsoft.CodeAnalysis.CSharp
{
    /// <summary>
    /// The rewriter for removing lambda expressions from method bodies and introducing closure classes
    /// as containers for captured variables along the lines of the example in section 6.5.3 of the
    /// C# language specification.
    /// 
T
TomasMatousek 已提交
25
    /// The entry point is the public method <see cref="Rewrite"/>.  It operates as follows:
P
Pilchie 已提交
26 27 28
    /// 
    /// First, an analysis of the whole method body is performed that determines which variables are
    /// captured, what their scopes are, and what the nesting relationship is between scopes that
29
    /// have captured variables.  The result of this analysis is left in <see cref="_analysis"/>.
P
Pilchie 已提交
30 31
    /// 
    /// Then we make a frame, or compiler-generated class, represented by an instance of
32
    /// <see cref="SynthesizedClosureEnvironment"/> for each scope with captured variables.  The generated frames are kept
33
    /// in <see cref="_frames"/>.  Each frame is given a single field for each captured
34
    /// variable in the corresponding scope.  These are maintained in <see cref="MethodToClassRewriter.proxies"/>.
P
Pilchie 已提交
35
    /// 
36
    /// Next, we walk and rewrite the input bound tree, keeping track of the following:
37 38 39
    /// (1) The current set of active frame pointers, in <see cref="_framePointers"/>
    /// (2) The current method being processed (this changes within a lambda's body), in <see cref="_currentMethod"/>
    /// (3) The "this" symbol for the current method in <see cref="_currentFrameThis"/>, and
P
Pilchie 已提交
40
    /// (4) The symbol that is used to access the innermost frame pointer (it could be a local variable or "this" parameter)
41 42 43 44 45 46 47
    ///
    /// Lastly, we visit the top-level method and each of the lowered methods
    /// to rewrite references (e.g., calls and delegate conversions) to local
    /// functions. We visit references to local functions separately from
    /// lambdas because we may see the reference before we lower the target
    /// local function. Lambdas, on the other hand, are always convertible as
    /// they are being lowered.
P
Pilchie 已提交
48 49 50 51 52 53 54
    /// 
    /// There are a few key transformations done in the rewriting.
    /// (1) Lambda expressions are turned into delegate creation expressions, and the body of the lambda is
    ///     moved into a new, compiler-generated method of a selected frame class.
    /// (2) On entry to a scope with captured variables, we create a frame object and store it in a local variable.
    /// (3) References to captured variables are transformed into references to fields of a frame class.
    /// 
55 56
    /// In addition, the rewriting deposits into <see cref="TypeCompilationState.SynthesizedMethods"/>
    /// a (<see cref="MethodSymbol"/>, <see cref="BoundStatement"/>) pair for each generated method.
P
Pilchie 已提交
57
    /// 
T
TomasMatousek 已提交
58
    /// <see cref="Rewrite"/> produces its output in two forms.  First, it returns a new bound statement
P
Pilchie 已提交
59
    /// for the caller to use for the body of the original method.  Second, it returns a collection of
T
TomasMatousek 已提交
60
    /// (<see cref="MethodSymbol"/>, <see cref="BoundStatement"/>) pairs for additional methods that the lambda rewriter produced.
P
Pilchie 已提交
61 62 63 64 65
    /// These additional methods contain the bodies of the lambdas moved into ordinary methods of their
    /// respective frame classes, and the caller is responsible for processing them just as it does with
    /// the returned bound node.  For example, the caller will typically perform iterator method and
    /// asynchronous method transformations, and emit IL instructions into an assembly.
    /// </summary>
66
    internal sealed partial class LambdaRewriter : MethodToClassRewriter
P
Pilchie 已提交
67
    {
68 69
        private readonly Analysis _analysis;
        private readonly MethodSymbol _topLevelMethod;
70
        private readonly MethodSymbol _substitutedSourceMethod;
71
        private readonly int _topLevelMethodOrdinal;
P
Pilchie 已提交
72

73 74
        // lambda frame for static lambdas. 
        // initialized lazily and could be null if there are no static lambdas
75
        private SynthesizedClosureEnvironment _lazyStaticLambdaFrame;
76

77
        // A mapping from every lambda parameter to its corresponding method's parameter.
78
        private readonly Dictionary<ParameterSymbol, ParameterSymbol> _parameterMap = new Dictionary<ParameterSymbol, ParameterSymbol>();
79

P
Pilchie 已提交
80
        // for each block with lifted (captured) variables, the corresponding frame type
81
        private readonly Dictionary<BoundNode, Analysis.ClosureEnvironment> _frames = new Dictionary<BoundNode, Analysis.ClosureEnvironment>();
P
Pilchie 已提交
82 83 84

        // the current set of frame pointers in scope.  Each is either a local variable (where introduced),
        // or the "this" parameter when at the top level.  Keys in this map are never constructed types.
85
        private readonly Dictionary<NamedTypeSymbol, Symbol> _framePointers = new Dictionary<NamedTypeSymbol, Symbol>();
P
Pilchie 已提交
86

87 88 89 90
        // The set of original locals that should be assigned to proxies
        // if lifted. This is useful for the expression evaluator where
        // the original locals are left as is.
        private readonly HashSet<LocalSymbol> _assignLocals;
91

P
Pilchie 已提交
92
        // The current method or lambda being processed.
93
        private MethodSymbol _currentMethod;
P
Pilchie 已提交
94 95

        // The "this" symbol for the current method.
96
        private ParameterSymbol _currentFrameThis;
P
Pilchie 已提交
97

98
        private readonly ArrayBuilder<LambdaDebugInfo> _lambdaDebugInfoBuilder;
99

100
        // ID dispenser for field names of frame references
101
        private int _synthesizedFieldNameIdDispenser;
102

P
Pilchie 已提交
103
        // The symbol (field or local) holding the innermost frame
104
        private Symbol _innermostFramePointer;
P
Pilchie 已提交
105 106

        // The mapping of type parameters for the current lambda body
107
        private TypeMap _currentLambdaBodyTypeMap;
P
Pilchie 已提交
108 109

        // The current set of type parameters (mapped from the enclosing method's type parameters)
110
        private ImmutableArray<TypeParameterSymbol> _currentTypeParameters;
P
Pilchie 已提交
111 112 113

        // Initialization for the proxy of the upper frame if it needs to be deferred.
        // Such situation happens when lifting this in a ctor.
114
        private BoundExpression _thisProxyInitDeferred;
P
Pilchie 已提交
115 116

        // Set to true once we've seen the base (or self) constructor invocation in a constructor
117
        private bool _seenBaseCall;
P
Pilchie 已提交
118 119

        // Set to true while translating code inside of an expression lambda.
120
        private bool _inExpressionLambda;
P
Pilchie 已提交
121 122 123 124

        // When a lambda captures only 'this' of the enclosing method, we cache it in a local
        // variable.  This is the set of such local variables that must be added to the enclosing
        // method's top-level block.
125
        private ArrayBuilder<LocalSymbol> _addedLocals;
P
Pilchie 已提交
126 127 128

        // Similarly, this is the set of statements that must be added to the enclosing method's
        // top-level block initializing those variables to null.
129
        private ArrayBuilder<BoundStatement> _addedStatements;
P
Pilchie 已提交
130

131 132 133 134 135 136
        /// <summary>
        /// Temporary bag for methods synthesized by the rewriting. Added to
        /// <see cref="TypeCompilationState.SynthesizedMethods"/> at the end of rewriting.
        /// </summary>
        private ArrayBuilder<TypeCompilationState.MethodWithBody> _synthesizedMethods;

A
Andy Gocke 已提交
137 138 139 140 141 142 143 144 145
        /// <summary>
        /// TODO(https://github.com/dotnet/roslyn/projects/26): Delete this.
        /// This should only be used by <see cref="NeedsProxy(Symbol)"/> which
        /// hasn't had logic to move the proxy analysis into <see cref="Analysis"/>,
        /// where the <see cref="Analysis.ScopeTree"/> could be walked to build
        /// the proxy list.
        /// </summary>
        private readonly ImmutableHashSet<Symbol> _allCapturedVariables;

P
Pilchie 已提交
146 147 148
        private LambdaRewriter(
            Analysis analysis,
            NamedTypeSymbol thisType,
T
TomasMatousek 已提交
149
            ParameterSymbol thisParameterOpt,
P
Pilchie 已提交
150
            MethodSymbol method,
151
            int methodOrdinal,
152
            MethodSymbol substitutedSourceMethod,
153
            ArrayBuilder<LambdaDebugInfo> lambdaDebugInfoBuilder,
154
            VariableSlotAllocator slotAllocatorOpt,
P
Pilchie 已提交
155 156
            TypeCompilationState compilationState,
            DiagnosticBag diagnostics,
157
            HashSet<LocalSymbol> assignLocals)
158
            : base(slotAllocatorOpt, compilationState, diagnostics)
P
Pilchie 已提交
159
        {
T
TomasMatousek 已提交
160 161 162 163 164 165
            Debug.Assert(analysis != null);
            Debug.Assert(thisType != null);
            Debug.Assert(method != null);
            Debug.Assert(compilationState != null);
            Debug.Assert(diagnostics != null);

166
            _topLevelMethod = method;
167
            _substitutedSourceMethod = substitutedSourceMethod;
168 169 170 171 172 173 174
            _topLevelMethodOrdinal = methodOrdinal;
            _lambdaDebugInfoBuilder = lambdaDebugInfoBuilder;
            _currentMethod = method;
            _analysis = analysis;
            _assignLocals = assignLocals;
            _currentTypeParameters = method.TypeParameters;
            _currentLambdaBodyTypeMap = TypeMap.Empty;
175
            _innermostFramePointer = _currentFrameThis = thisParameterOpt;
176 177 178
            _framePointers[thisType] = thisParameterOpt;
            _seenBaseCall = method.MethodKind != MethodKind.Constructor; // only used for ctors
            _synthesizedFieldNameIdDispenser = 1;
A
Andy Gocke 已提交
179 180 181 182 183 184 185

            var allCapturedVars = ImmutableHashSet.CreateBuilder<Symbol>();
            Analysis.VisitClosures(analysis.ScopeTree, (scope, closure) =>
            {
                allCapturedVars.UnionWith(closure.CapturedVariables);
            });
            _allCapturedVariables = allCapturedVars.ToImmutable();
P
Pilchie 已提交
186 187
        }

188 189
        protected override bool NeedsProxy(Symbol localOrParameter)
        {
E
Evan Hauck 已提交
190 191
            Debug.Assert(localOrParameter is LocalSymbol || localOrParameter is ParameterSymbol ||
                (localOrParameter as MethodSymbol)?.MethodKind == MethodKind.LocalFunction);
A
Andy Gocke 已提交
192
            return _allCapturedVariables.Contains(localOrParameter);
193 194
        }

P
Pilchie 已提交
195 196 197 198 199 200
        /// <summary>
        /// Rewrite the given node to eliminate lambda expressions.  Also returned are the method symbols and their
        /// bound bodies for the extracted lambda bodies. These would typically be emitted by the caller such as
        /// MethodBodyCompiler.  See this class' documentation
        /// for a more thorough explanation of the algorithm and its use by clients.
        /// </summary>
201
        /// <param name="loweredBody">The bound node to be rewritten</param>
P
Pilchie 已提交
202 203 204
        /// <param name="thisType">The type of the top-most frame</param>
        /// <param name="thisParameter">The "this" parameter in the top-most frame, or null if static method</param>
        /// <param name="method">The containing method of the node to be rewritten</param>
205
        /// <param name="methodOrdinal">Index of the method symbol in its containing type member list.</param>
206
        /// <param name="substitutedSourceMethod">If this is non-null, then <paramref name="method"/> will be treated as this for uses of parent symbols. For use in EE.</param>
207 208
        /// <param name="lambdaDebugInfoBuilder">Information on lambdas defined in <paramref name="method"/> needed for debugging.</param>
        /// <param name="closureDebugInfoBuilder">Information on closures defined in <paramref name="method"/> needed for debugging.</param>
209
        /// <param name="slotAllocatorOpt">Slot allocator.</param>
P
Pilchie 已提交
210 211
        /// <param name="compilationState">The caller's buffer into which we produce additional methods to be emitted by the caller</param>
        /// <param name="diagnostics">Diagnostic bag for diagnostics</param>
212
        /// <param name="assignLocals">The set of original locals that should be assigned to proxies if lifted</param>
P
Pilchie 已提交
213
        public static BoundStatement Rewrite(
214
            BoundStatement loweredBody,
P
Pilchie 已提交
215 216 217
            NamedTypeSymbol thisType,
            ParameterSymbol thisParameter,
            MethodSymbol method,
218
            int methodOrdinal,
219
            MethodSymbol substitutedSourceMethod,
220 221
            ArrayBuilder<LambdaDebugInfo> lambdaDebugInfoBuilder,
            ArrayBuilder<ClosureDebugInfo> closureDebugInfoBuilder,
222
            VariableSlotAllocator slotAllocatorOpt,
P
Pilchie 已提交
223 224
            TypeCompilationState compilationState,
            DiagnosticBag diagnostics,
225
            HashSet<LocalSymbol> assignLocals)
P
Pilchie 已提交
226 227 228
        {
            Debug.Assert((object)thisType != null);
            Debug.Assert(((object)thisParameter == null) || (thisParameter.Type == thisType));
229 230
            Debug.Assert(compilationState.ModuleBuilderOpt != null);

A
Andy Gocke 已提交
231 232 233 234 235 236 237 238 239
            var analysis = Analysis.Analyze(
                loweredBody,
                method,
                methodOrdinal,
                substitutedSourceMethod,
                slotAllocatorOpt,
                compilationState,
                closureDebugInfoBuilder,
                diagnostics);
P
Pilchie 已提交
240

241
            CheckLocalsDefined(loweredBody);
242 243 244 245 246
            var rewriter = new LambdaRewriter(
                analysis,
                thisType,
                thisParameter,
                method,
247
                methodOrdinal,
248
                substitutedSourceMethod,
249
                lambdaDebugInfoBuilder,
250
                slotAllocatorOpt,
251 252
                compilationState,
                diagnostics,
253
                assignLocals);
254

255
            rewriter.SynthesizeClosureEnvironments(closureDebugInfoBuilder);
256
            rewriter.SynthesizeLoweredFunctionMethods();
257 258 259 260

            var body = rewriter.AddStatementsIfNeeded(
                (BoundStatement)rewriter.Visit(loweredBody));

261 262 263 264 265 266 267 268 269 270 271 272 273 274
            // Add the completed methods to the compilation state
            if (rewriter._synthesizedMethods != null)
            {
                if (compilationState.SynthesizedMethods == null)
                {
                    compilationState.SynthesizedMethods = rewriter._synthesizedMethods;
                }
                else
                {
                    compilationState.SynthesizedMethods.AddRange(rewriter._synthesizedMethods);
                    rewriter._synthesizedMethods.Free();
                }
            }

P
Pilchie 已提交
275
            CheckLocalsDefined(body);
276

277 278
            analysis.Free();

P
Pilchie 已提交
279 280 281
            return body;
        }

282
        private BoundStatement AddStatementsIfNeeded(BoundStatement body)
P
Pilchie 已提交
283
        {
284
            if (_addedLocals != null)
P
Pilchie 已提交
285
            {
286
                _addedStatements.Add(body);
287
                body = new BoundBlock(body.Syntax, _addedLocals.ToImmutableAndFree(), _addedStatements.ToImmutableAndFree()) { WasCompilerGenerated = true };
288 289
                _addedLocals = null;
                _addedStatements = null;
P
Pilchie 已提交
290 291 292
            }
            else
            {
293
                Debug.Assert(_addedStatements == null);
P
Pilchie 已提交
294 295 296 297 298 299 300
            }

            return body;
        }

        protected override TypeMap TypeMap
        {
301
            get { return _currentLambdaBodyTypeMap; }
P
Pilchie 已提交
302 303 304 305
        }

        protected override MethodSymbol CurrentMethod
        {
306
            get { return _currentMethod; }
P
Pilchie 已提交
307 308 309 310
        }

        protected override NamedTypeSymbol ContainingType
        {
311
            get { return _topLevelMethod.ContainingType; }
P
Pilchie 已提交
312 313 314 315 316 317 318 319 320
        }

        /// <summary>
        /// Check that the top-level node is well-defined, in the sense that all
        /// locals that are used are defined in some enclosing scope.
        /// </summary>
        static partial void CheckLocalsDefined(BoundNode node);

        /// <summary>
321
        /// Adds <see cref="SynthesizedClosureEnvironment"/> synthesized types to the compilation state
A
Andy Gocke 已提交
322
        /// and creates hoisted fields for all locals captured by the environments.
P
Pilchie 已提交
323
        /// </summary>
324
        private void SynthesizeClosureEnvironments(ArrayBuilder<ClosureDebugInfo> closureDebugInfo)
P
Pilchie 已提交
325
        {
A
Andy Gocke 已提交
326
            Analysis.VisitScopeTree(_analysis.ScopeTree, scope =>
P
Pilchie 已提交
327
            {
A
Andy Gocke 已提交
328
                if (scope.DeclaredEnvironments.Count > 0)
P
Pilchie 已提交
329
                {
A
Andy Gocke 已提交
330 331 332 333
                    Debug.Assert(!_frames.ContainsKey(scope.BoundNode));
                    // At the moment, all variables declared in the same
                    // scope always get assigned to the same environment
                    Debug.Assert(scope.DeclaredEnvironments.Count == 1);
P
Pilchie 已提交
334

A
Andy Gocke 已提交
335
                    var env = scope.DeclaredEnvironments[0];
336
                    var frame = MakeFrame(scope, env);
337
                    env.SynthesizedEnvironment = frame;
338

339 340
                    CompilationState.ModuleBuilderOpt.AddSynthesizedDefinition(ContainingType, frame);
                    if (frame.Constructor != null)
341
                    {
A
Andy Gocke 已提交
342
                        AddSynthesizedMethod(
343
                            frame.Constructor,
A
Andy Gocke 已提交
344
                            FlowAnalysisPass.AppendImplicitReturn(
345 346
                                MethodCompiler.BindMethodBody(frame.Constructor, CompilationState, null),
                                frame.Constructor));
347 348
                    }

A
Andy Gocke 已提交
349
                    _frames.Add(scope.BoundNode, env);
350
                }
A
Andy Gocke 已提交
351
            });
352

353
            SynthesizedClosureEnvironment MakeFrame(Analysis.Scope scope, Analysis.ClosureEnvironment env)
354 355 356 357 358 359 360 361 362 363 364 365 366 367 368
            {
                var scopeBoundNode = scope.BoundNode;

                var syntax = scopeBoundNode.Syntax;
                Debug.Assert(syntax != null);

                DebugId methodId = _analysis.GetTopLevelMethodId();
                DebugId closureId = _analysis.GetClosureId(syntax, closureDebugInfo);

                var containingMethod = scope.ContainingClosureOpt?.OriginalMethodSymbol ?? _topLevelMethod;
                if ((object)_substitutedSourceMethod != null && containingMethod == _topLevelMethod)
                {
                    containingMethod = _substitutedSourceMethod;
                }

369
                var synthesizedEnv = new SynthesizedClosureEnvironment(
370 371
                    _topLevelMethod,
                    containingMethod,
372
                    env.IsStruct,
373 374 375
                    syntax,
                    methodId,
                    closureId);
376 377 378 379 380 381 382 383 384 385 386 387

                foreach (var captured in env.CapturedVariables)
                {
                    Debug.Assert(!proxies.ContainsKey(captured));

                    var hoistedField = LambdaCapturedVariable.Create(synthesizedEnv, captured, ref _synthesizedFieldNameIdDispenser);
                    proxies.Add(captured, new CapturedToFrameSymbolReplacement(hoistedField, isReusable: false));
                    synthesizedEnv.AddHoistedField(hoistedField);
                    CompilationState.ModuleBuilderOpt.AddSynthesizedDefinition(synthesizedEnv, hoistedField);
                }

                return synthesizedEnv;
388
            }
389 390
        }

391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406
        /// <summary>
        /// Synthesize the final signature for all closures.
        /// </summary>
        private void SynthesizeLoweredFunctionMethods()
        {
            Analysis.VisitClosures(_analysis.ScopeTree, (scope, closure) =>
            {
                var originalMethod = closure.OriginalMethodSymbol;
                var syntax = originalMethod.DeclaringSyntaxReferences[0].GetSyntax();

                int closureOrdinal;
                ClosureKind closureKind;
                NamedTypeSymbol translatedLambdaContainer;
                SynthesizedClosureEnvironment containerAsFrame;
                DebugId topLevelMethodId;
                DebugId lambdaId;
A
Andy Gocke 已提交
407

408 409 410 411 412 413 414 415 416 417 418 419 420 421 422
                if (closure.ContainingEnvironmentOpt != null)
                {
                    containerAsFrame = closure.ContainingEnvironmentOpt?.SynthesizedEnvironment;

                    closureKind = ClosureKind.General;
                    translatedLambdaContainer = containerAsFrame;
                    closureOrdinal = containerAsFrame.ClosureOrdinal;
                }
                else if (closure.CapturesThis)
                {
                    containerAsFrame = null;
                    translatedLambdaContainer = _topLevelMethod.ContainingType;
                    closureKind = ClosureKind.ThisOnly;
                    closureOrdinal = LambdaDebugInfo.ThisOnlyClosureOrdinal;
                }
A
Andy Gocke 已提交
423 424
                else if (closure.CapturedEnvironments.Count == 0 &&
                         _analysis.MethodsConvertedToDelegates.Contains(originalMethod))
425
                {
A
Andy Gocke 已提交
426 427 428
                    translatedLambdaContainer = containerAsFrame = GetStaticFrame(Diagnostics, syntax);
                    closureKind = ClosureKind.Singleton;
                    closureOrdinal = LambdaDebugInfo.StaticClosureOrdinal;
429 430 431 432 433
                }
                else
                {
                    // Lower directly onto the containing type
                    translatedLambdaContainer = _topLevelMethod.ContainingType;
A
Andy Gocke 已提交
434 435
                    containerAsFrame = null;
                    closureKind = ClosureKind.Static;
436 437 438 439 440 441 442 443 444
                    closureOrdinal = LambdaDebugInfo.StaticClosureOrdinal;
                }

                // Move the body of the lambda to a freshly generated synthetic method on its frame.
                topLevelMethodId = _analysis.GetTopLevelMethodId();
                lambdaId = GetLambdaId(syntax, closureKind, closureOrdinal);

                var synthesizedMethod = new SynthesizedClosureMethod(
                    translatedLambdaContainer,
A
Andy Gocke 已提交
445
                    GetStructClosures(closure),
446 447 448 449 450 451 452 453
                    closureKind,
                    _topLevelMethod,
                    topLevelMethodId,
                    originalMethod,
                    closure.BlockSyntax,
                    lambdaId);
                closure.SynthesizedLoweredMethod = synthesizedMethod;
            });
A
Andy Gocke 已提交
454 455 456 457 458 459 460 461 462 463 464 465 466 467 468

            ImmutableArray<SynthesizedClosureEnvironment> GetStructClosures(Analysis.Closure closure)
            {
                var closuresBuilder = ArrayBuilder<SynthesizedClosureEnvironment>.GetInstance();

                foreach (var env in closure.CapturedEnvironments)
                {
                    if (env.IsStruct)
                    {
                        closuresBuilder.Add(env.SynthesizedEnvironment);
                    }
                }

                return closuresBuilder.ToImmutableAndFree();
            }
469 470 471 472 473 474 475 476 477 478 479 480
        }

        /// <summary>
        /// Get the static container for closures or create one if one doesn't already exist.
        /// </summary>
        /// <param name="syntax">
        /// associate the frame with the first lambda that caused it to exist. 
        /// we need to associate this with some syntax.
        /// unfortunately either containing method or containing class could be synthetic
        /// therefore could have no syntax.
        /// </param>
        private SynthesizedClosureEnvironment GetStaticFrame(DiagnosticBag diagnostics, SyntaxNode syntax)
481
        {
482
            if (_lazyStaticLambdaFrame == null)
483
            {
484
                var isNonGeneric = !_topLevelMethod.IsGenericMethod;
485 486
                if (isNonGeneric)
                {
487
                    _lazyStaticLambdaFrame = CompilationState.StaticLambdaFrame;
488 489
                }

490
                if (_lazyStaticLambdaFrame == null)
491
                {
492
                    DebugId methodId;
493 494
                    if (isNonGeneric)
                    {
495
                        methodId = new DebugId(DebugId.UndefinedOrdinal, CompilationState.ModuleBuilderOpt.CurrentGenerationOrdinal);
496 497 498
                    }
                    else
                    {
A
Andy Gocke 已提交
499
                        methodId = _analysis.GetTopLevelMethodId();
500
                    }
501

E
Evan Hauck 已提交
502
                    DebugId closureId = default(DebugId);
E
Evan Hauck 已提交
503
                    // using _topLevelMethod as containing member because the static frame does not have generic parameters, except for the top level method's
504
                    var containingMethod = isNonGeneric ? null : (_substitutedSourceMethod ?? _topLevelMethod);
505
                    _lazyStaticLambdaFrame = new SynthesizedClosureEnvironment(
A
Andy Gocke 已提交
506 507 508 509 510 511
                        _topLevelMethod,
                        containingMethod,
                        isStruct: false,
                        scopeSyntaxOpt: null,
                        methodId: methodId,
                        closureId: closureId);
512

513
                    // non-generic static lambdas can share the frame
514
                    if (isNonGeneric)
515
                    {
516
                        CompilationState.StaticLambdaFrame = _lazyStaticLambdaFrame;
517 518
                    }

519
                    var frame = _lazyStaticLambdaFrame;
520

521
                    // add frame type and cache field
522 523
                    CompilationState.ModuleBuilderOpt.AddSynthesizedDefinition(this.ContainingType, frame);

524
                    // add its ctor (note Constructor can be null if TypeKind.Struct is passed in to LambdaFrame.ctor, but Class is passed in above)
525
                    AddSynthesizedMethod(
526
                        frame.Constructor,
527 528 529
                        FlowAnalysisPass.AppendImplicitReturn(
                            MethodCompiler.BindMethodBody(frame.Constructor, CompilationState, null),
                            frame.Constructor));
530 531 532 533 534 535 536 537

                    // add cctor
                    // Frame.inst = new Frame()
                    var F = new SyntheticBoundNodeFactory(frame.StaticConstructor, syntax, CompilationState, diagnostics);
                    var body = F.Block(
                            F.Assignment(
                                F.Field(null, frame.SingletonCache),
                                F.New(frame.Constructor)),
538
                            new BoundReturnStatement(syntax, RefKind.None, null));
539

540
                    AddSynthesizedMethod(frame.StaticConstructor, body);
541 542 543
                }
            }

544
            return _lazyStaticLambdaFrame;
545 546
        }

P
Pilchie 已提交
547 548 549 550 551 552
        /// <summary>
        /// Produce a bound expression representing a pointer to a frame of a particular frame type.
        /// </summary>
        /// <param name="syntax">The syntax to attach to the bound nodes produced</param>
        /// <param name="frameType">The type of frame to be returned</param>
        /// <returns>A bound node that computes the pointer to the required frame</returns>
553
        private BoundExpression FrameOfType(SyntaxNode syntax, NamedTypeSymbol frameType)
P
Pilchie 已提交
554 555 556 557 558 559 560 561 562 563 564 565 566 567
        {
            BoundExpression result = FramePointer(syntax, frameType.OriginalDefinition);
            Debug.Assert(result.Type == frameType);
            return result;
        }

        /// <summary>
        /// Produce a bound expression representing a pointer to a frame of a particular frame class.
        /// Note that for generic frames, the frameClass parameter is the generic definition, but
        /// the resulting expression will be constructed with the current type parameters.
        /// </summary>
        /// <param name="syntax">The syntax to attach to the bound nodes produced</param>
        /// <param name="frameClass">The class type of frame to be returned</param>
        /// <returns>A bound node that computes the pointer to the required frame</returns>
568
        protected override BoundExpression FramePointer(SyntaxNode syntax, NamedTypeSymbol frameClass)
P
Pilchie 已提交
569 570 571 572
        {
            Debug.Assert(frameClass.IsDefinition);

            // If in an instance method of the right type, we can just return the "this" pointer.
573
            if ((object)_currentFrameThis != null && _currentFrameThis.Type == frameClass)
P
Pilchie 已提交
574 575 576 577
            {
                return new BoundThisReference(syntax, frameClass);
            }

578
            // If the current method has by-ref struct closure parameters, and one of them is correct, use it.
579
            var lambda = _currentMethod as SynthesizedClosureMethod;
580 581 582 583 584 585 586 587 588 589 590 591 592
            if (lambda != null)
            {
                var start = lambda.ParameterCount - lambda.ExtraSynthesizedParameterCount;
                for (var i = start; i < lambda.ParameterCount; i++)
                {
                    var potentialParameter = lambda.Parameters[i];
                    if (potentialParameter.Type.OriginalDefinition == frameClass)
                    {
                        return new BoundParameter(syntax, potentialParameter);
                    }
                }
            }

P
Pilchie 已提交
593
            // Otherwise we need to return the value from a frame pointer local variable...
594
            Symbol framePointer = _framePointers[frameClass];
P
Pilchie 已提交
595 596 597 598 599 600 601 602 603
            CapturedSymbolReplacement proxyField;
            if (proxies.TryGetValue(framePointer, out proxyField))
            {
                // However, frame pointer local variables themselves can be "captured".  In that case
                // the inner frames contain pointers to the enclosing frames.  That is, nested
                // frame pointers are organized in a linked list.
                return proxyField.Replacement(syntax, frameType => FramePointer(syntax, frameType));
            }

604
            var localFrame = (LocalSymbol)framePointer;
P
Pilchie 已提交
605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621
            return new BoundLocal(syntax, localFrame, null, localFrame.Type);
        }

        private static void InsertAndFreePrologue(ArrayBuilder<BoundStatement> result, ArrayBuilder<BoundExpression> prologue)
        {
            foreach (var expr in prologue)
            {
                result.Add(new BoundExpressionStatement(expr.Syntax, expr));
            }

            prologue.Free();
        }

        /// <summary>
        /// Introduce a frame around the translation of the given node.
        /// </summary>
        /// <param name="node">The node whose translation should be translated to contain a frame</param>
622
        /// <param name="env">The environment for the translated node</param>
P
Pilchie 已提交
623 624
        /// <param name="F">A function that computes the translation of the node.  It receives lists of added statements and added symbols</param>
        /// <returns>The translated statement, as returned from F</returns>
625
        private BoundNode IntroduceFrame(BoundNode node, Analysis.ClosureEnvironment env, Func<ArrayBuilder<BoundExpression>, ArrayBuilder<LocalSymbol>, BoundNode> F)
P
Pilchie 已提交
626
        {
627
            var frame = env.SynthesizedEnvironment;
N
Neal Gafter 已提交
628
            var frameTypeParameters = ImmutableArray.Create(StaticCast<TypeSymbol>.From(_currentTypeParameters).SelectAsArray(TypeMap.TypeSymbolAsTypeWithModifiers), 0, frame.Arity);
E
Evan Hauck 已提交
629
            NamedTypeSymbol frameType = frame.ConstructIfGeneric(frameTypeParameters);
630 631

            Debug.Assert(frame.ScopeSyntaxOpt != null);
632
            LocalSymbol framePointer = new SynthesizedLocal(_topLevelMethod, frameType, SynthesizedLocalKind.LambdaDisplayClass, frame.ScopeSyntaxOpt);
P
Pilchie 已提交
633

634
            SyntaxNode syntax = node.Syntax;
P
Pilchie 已提交
635 636 637 638 639

            // assign new frame to the frame variable

            var prologue = ArrayBuilder<BoundExpression>.GetInstance();

A
Andy Gocke 已提交
640
            if ((object)frame.Constructor != null)
641
            {
642 643
                MethodSymbol constructor = frame.Constructor.AsMember(frameType);
                Debug.Assert(frameType == constructor.ContainingType);
P
Pilchie 已提交
644

V
vsadov 已提交
645 646
                prologue.Add(new BoundAssignmentOperator(syntax,
                    new BoundLocal(syntax, framePointer, null, frameType),
G
Gen Lu 已提交
647
                    new BoundObjectCreationExpression(syntax: syntax, constructor: constructor, binderOpt: null),
V
vsadov 已提交
648 649
                    frameType));
            }
P
Pilchie 已提交
650 651

            CapturedSymbolReplacement oldInnermostFrameProxy = null;
652
            if ((object)_innermostFramePointer != null)
P
Pilchie 已提交
653
            {
654
                proxies.TryGetValue(_innermostFramePointer, out oldInnermostFrameProxy);
655
                if (env.CapturesParent)
P
Pilchie 已提交
656
                {
657
                    var capturedFrame = LambdaCapturedVariable.Create(frame, _innermostFramePointer, ref _synthesizedFieldNameIdDispenser);
P
Pilchie 已提交
658 659 660 661
                    FieldSymbol frameParent = capturedFrame.AsMember(frameType);
                    BoundExpression left = new BoundFieldAccess(syntax, new BoundLocal(syntax, framePointer, null, frameType), frameParent, null);
                    BoundExpression right = FrameOfType(syntax, frameParent.Type as NamedTypeSymbol);
                    BoundExpression assignment = new BoundAssignmentOperator(syntax, left, right, left.Type);
A
Andy Gocke 已提交
662
                    prologue.Add(assignment);
P
Pilchie 已提交
663 664 665

                    if (CompilationState.Emitting)
                    {
E
Evan Hauck 已提交
666
                        Debug.Assert(capturedFrame.Type.IsReferenceType); // Make sure we're not accidentally capturing a struct by value
667
                        frame.AddHoistedField(capturedFrame);
T
TomasMatousek 已提交
668
                        CompilationState.ModuleBuilderOpt.AddSynthesizedDefinition(frame, capturedFrame);
P
Pilchie 已提交
669 670
                    }

671
                    proxies[_innermostFramePointer] = new CapturedToFrameSymbolReplacement(capturedFrame, isReusable: false);
P
Pilchie 已提交
672 673 674 675
                }
            }

            // Capture any parameters of this block.  This would typically occur
676
            // at the top level of a method or lambda with captured parameters.
677
            foreach (var variable in env.CapturedVariables)
678
            {
679
                InitVariableProxy(syntax, variable, framePointer, prologue);
P
Pilchie 已提交
680 681
            }

682
            Symbol oldInnermostFramePointer = _innermostFramePointer;
A
Andy Gocke 已提交
683 684 685 686
            if (!framePointer.Type.IsValueType)
            {
                _innermostFramePointer = framePointer;
            }
P
Pilchie 已提交
687 688
            var addedLocals = ArrayBuilder<LocalSymbol>.GetInstance();
            addedLocals.Add(framePointer);
689
            _framePointers.Add(frame, framePointer);
P
Pilchie 已提交
690 691 692

            var result = F(prologue, addedLocals);

693
            _innermostFramePointer = oldInnermostFramePointer;
P
Pilchie 已提交
694

695
            if ((object)_innermostFramePointer != null)
P
Pilchie 已提交
696 697 698
            {
                if (oldInnermostFrameProxy != null)
                {
699
                    proxies[_innermostFramePointer] = oldInnermostFrameProxy;
P
Pilchie 已提交
700 701 702
                }
                else
                {
703
                    proxies.Remove(_innermostFramePointer);
P
Pilchie 已提交
704 705 706 707 708 709
                }
            }

            return result;
        }

710
        private void InitVariableProxy(SyntaxNode syntax, Symbol symbol, LocalSymbol framePointer, ArrayBuilder<BoundExpression> prologue)
P
Pilchie 已提交
711 712
        {
            CapturedSymbolReplacement proxy;
713
            if (proxies.TryGetValue(symbol, out proxy))
P
Pilchie 已提交
714
            {
715 716
                BoundExpression value;
                switch (symbol.Kind)
717
                {
718 719 720
                    case SymbolKind.Parameter:
                        var parameter = (ParameterSymbol)symbol;
                        ParameterSymbol parameterToUse;
721
                        if (!_parameterMap.TryGetValue(parameter, out parameterToUse))
722 723
                        {
                            parameterToUse = parameter;
724
                        }
725 726

                        value = new BoundParameter(syntax, parameterToUse);
727
                        break;
728

729
                    case SymbolKind.Local:
730 731
                        var local = (LocalSymbol)symbol;
                        if (_assignLocals == null || !_assignLocals.Contains(local))
732 733 734
                        {
                            return;
                        }
735

736 737 738 739 740 741 742
                        LocalSymbol localToUse;
                        if (!localMap.TryGetValue(local, out localToUse))
                        {
                            localToUse = local;
                        }

                        value = new BoundLocal(syntax, localToUse, null, localToUse.Type);
743
                        break;
E
Evan Hauck 已提交
744

745 746 747
                    default:
                        throw ExceptionUtilities.UnexpectedValue(symbol.Kind);
                }
P
Pilchie 已提交
748

E
Evan Hauck 已提交
749 750
                var left = proxy.Replacement(syntax, frameType1 => new BoundLocal(syntax, framePointer, null, framePointer.Type));
                var assignToProxy = new BoundAssignmentOperator(syntax, left, value, value.Type);
A
Andy Gocke 已提交
751 752 753 754 755 756 757 758 759 760 761 762 763 764
                if (_currentMethod.MethodKind == MethodKind.Constructor &&
                    symbol == _currentMethod.ThisParameter &&
                    !_seenBaseCall)
                {
                    // Containing method is a constructor 
                    // Initialization statement for the "this" proxy must be inserted
                    // after the constructor initializer statement block
                    Debug.Assert(_thisProxyInitDeferred == null);
                    _thisProxyInitDeferred = assignToProxy;
                }
                else
                {
                    prologue.Add(assignToProxy);
                }
P
Pilchie 已提交
765 766 767 768 769
            }
        }

        #region Visit Methods

770 771 772
        protected override BoundNode VisitUnhoistedParameter(BoundParameter node)
        {
            ParameterSymbol replacementParameter;
773
            if (_parameterMap.TryGetValue(node.ParameterSymbol, out replacementParameter))
774 775 776 777 778 779 780
            {
                return new BoundParameter(node.Syntax, replacementParameter, replacementParameter.Type, node.HasErrors);
            }

            return base.VisitUnhoistedParameter(node);
        }

P
Pilchie 已提交
781 782 783 784 785 786 787 788 789 790 791 792
        public override BoundNode VisitThisReference(BoundThisReference node)
        {
            // "topLevelMethod.ThisParameter == null" can occur in a delegate creation expression because the method group
            // in the argument can have a "this" receiver even when "this"
            // is not captured because a static method is selected.  But we do preserve
            // the method group and its receiver in the bound tree.
            // No need to capture "this" in such case.

            // TODO: Why don't we drop "this" while lowering if method is static? 
            //       Actually, considering that method group expression does not evaluate to a particular value 
            //       why do we have it in the lowered tree at all?

793
            return (_currentMethod == _topLevelMethod || _topLevelMethod.ThisParameter == null ?
794 795
                node :
                FramePointer(node.Syntax, (NamedTypeSymbol)node.Type));
P
Pilchie 已提交
796 797 798 799
        }

        public override BoundNode VisitBaseReference(BoundBaseReference node)
        {
800
            return (!_currentMethod.IsStatic && _currentMethod.ContainingType == _topLevelMethod.ContainingType)
P
Pilchie 已提交
801
                ? node
802
                : FramePointer(node.Syntax, _topLevelMethod.ContainingType); // technically, not the correct static type
P
Pilchie 已提交
803
        }
804

805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904
        /// <summary>
        /// Rewrites a reference to an unlowered local function to the newly
        /// lowered local function.
        /// </summary>
        private void RemapLocalFunction(
            SyntaxNode syntax,
            MethodSymbol localFunc,
            out BoundExpression receiver,
            out MethodSymbol method,
            ref ImmutableArray<BoundExpression> parameters)
        {
            Debug.Assert(localFunc.MethodKind == MethodKind.LocalFunction);

            var closure = Analysis.GetClosureInTree(_analysis.ScopeTree, localFunc.OriginalDefinition);
            var loweredSymbol = closure.SynthesizedLoweredMethod;

            // If the local function captured variables then they will be stored
            // in frames and the frames need to be passed as extra parameters.
            var frameCount = loweredSymbol.ExtraSynthesizedParameterCount;
            if (frameCount != 0)
            {
                Debug.Assert(!parameters.IsDefault);

                // Build a new list of parameters to pass to the local function
                // call that includes any necessary capture frames
                var parametersBuilder = ArrayBuilder<BoundExpression>.GetInstance();
                parametersBuilder.AddRange(parameters);

                var start = loweredSymbol.ParameterCount - frameCount;
                for (int i = start; i < loweredSymbol.ParameterCount; i++)
                {
                    // will always be a LambdaFrame, it's always a capture frame
                    var frameType = (NamedTypeSymbol)loweredSymbol.Parameters[i].Type.OriginalDefinition;

                    Debug.Assert(frameType is SynthesizedClosureEnvironment);

                    if (frameType.Arity > 0)
                    {
                        var typeParameters = ((SynthesizedClosureEnvironment)frameType).ConstructedFromTypeParameters;
                        Debug.Assert(typeParameters.Length == frameType.Arity);
                        var subst = this.TypeMap.SubstituteTypeParameters(typeParameters);
                        frameType = frameType.Construct(subst);
                    }

                    var frame = FrameOfType(syntax, frameType);
                    parametersBuilder.Add(frame);
                }
                parameters = parametersBuilder.ToImmutableAndFree();
            }

            method = loweredSymbol;
            NamedTypeSymbol constructedFrame;

            RemapLambdaOrLocalFunction(syntax,
                                       localFunc,
                                       SubstituteTypeArguments(localFunc.TypeArguments),
                                       loweredSymbol.ClosureKind,
                                       ref method,
                                       out receiver,
                                       out constructedFrame);
        }

        /// <summary>
        /// Substitutes references from old type arguments to new type arguments
        /// in the lowered methods.
        /// </summary>
        /// <example>
        /// Consider the following method:
        ///     void M() {
        ///         void L&lt;T&gt;(T t) => Console.Write(t);
        ///         L("A");
        ///     }
        ///     
        /// In this example, L&lt;T&gt; is a local function that will be
        /// lowered into its own method and the type parameter T will be
        /// alpha renamed to something else (let's call it T'). In this case,
        /// all references to the original type parameter T in L must be
        /// rewritten to the renamed parameter, T'.
        /// </example>
        private ImmutableArray<TypeSymbol> SubstituteTypeArguments(ImmutableArray<TypeSymbol> typeArguments)
        {
            Debug.Assert(!typeArguments.IsDefault);

            if (typeArguments.IsEmpty)
            {
                return typeArguments;
            }

            // We must perform this process repeatedly as local
            // functions may nest inside one another and capture type
            // parameters from the enclosing local functions. Each
            // iteration of nesting will cause alpha-renaming of the captured
            // parameters, meaning that we must replace until there are no
            // more alpha-rename mappings.
            //
            // The method symbol references are different from all other
            // substituted types in this context because the method symbol in
            // local function references is not rewritten until all local
            // functions have already been lowered. Everything else is rewritten
            // by the visitors as the definition is lowered. This means that
C
Charles Stoner 已提交
905
            // only one substitution happens per lowering, but we need to do
906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927
            // N substitutions all at once, where N is the number of lowerings.

            var builder = ArrayBuilder<TypeSymbol>.GetInstance();
            foreach (var typeArg in typeArguments)
            {
                TypeSymbol oldTypeArg;
                TypeSymbol newTypeArg = typeArg;
                do
                {
                    oldTypeArg = newTypeArg;
                    newTypeArg = this.TypeMap.SubstituteType(typeArg).Type;
                }
                while (oldTypeArg != newTypeArg);

                Debug.Assert((object)oldTypeArg == newTypeArg);

                builder.Add(newTypeArg);
            }

            return builder.ToImmutableAndFree();
        }

E
Evan Hauck 已提交
928
        private void RemapLambdaOrLocalFunction(
929
            SyntaxNode syntax,
E
Evan Hauck 已提交
930 931 932 933 934 935
            MethodSymbol originalMethod,
            ImmutableArray<TypeSymbol> typeArgumentsOpt,
            ClosureKind closureKind,
            ref MethodSymbol synthesizedMethod,
            out BoundExpression receiver,
            out NamedTypeSymbol constructedFrame)
E
Evan Hauck 已提交
936
        {
E
Evan Hauck 已提交
937
            var translatedLambdaContainer = synthesizedMethod.ContainingType;
938
            var containerAsFrame = translatedLambdaContainer as SynthesizedClosureEnvironment;
939

940
            // All of _currentTypeParameters might not be preserved here due to recursively calling upwards in the chain of local functions/lambdas
E
Evan Hauck 已提交
941
            Debug.Assert((typeArgumentsOpt.IsDefault && !originalMethod.IsGenericMethod) || (typeArgumentsOpt.Length == originalMethod.Arity));
942
            var totalTypeArgumentCount = (containerAsFrame?.Arity ?? 0) + synthesizedMethod.Arity;
E
Evan Hauck 已提交
943 944
            var realTypeArguments = ImmutableArray.Create(StaticCast<TypeSymbol>.From(_currentTypeParameters), 0, totalTypeArgumentCount - originalMethod.Arity);
            if (!typeArgumentsOpt.IsDefault)
945
            {
E
Evan Hauck 已提交
946
                realTypeArguments = realTypeArguments.Concat(typeArgumentsOpt);
947 948
            }

E
Evan Hauck 已提交
949 950 951 952 953 954 955 956 957 958
            if (containerAsFrame != null && containerAsFrame.Arity != 0)
            {
                var containerTypeArguments = ImmutableArray.Create(realTypeArguments, 0, containerAsFrame.Arity);
                realTypeArguments = ImmutableArray.Create(realTypeArguments, containerAsFrame.Arity, realTypeArguments.Length - containerAsFrame.Arity);
                constructedFrame = containerAsFrame.Construct(containerTypeArguments);
            }
            else
            {
                constructedFrame = translatedLambdaContainer;
            }
E
Evan Hauck 已提交
959 960 961

            // for instance lambdas, receiver is the frame
            // for static lambdas, get the singleton receiver
962
            if (closureKind == ClosureKind.Singleton)
E
Evan Hauck 已提交
963 964 965 966
            {
                var field = containerAsFrame.SingletonCache.AsMember(constructedFrame);
                receiver = new BoundFieldAccess(syntax, null, field, constantValueOpt: null);
            }
967 968 969 970 971 972 973 974
            else if (closureKind == ClosureKind.Static)
            {
                receiver = null;
            }
            else // ThisOnly and General
            {
                receiver = FrameOfType(syntax, constructedFrame);
            }
975

E
Evan Hauck 已提交
976 977 978 979 980 981
            synthesizedMethod = synthesizedMethod.AsMember(constructedFrame);
            if (synthesizedMethod.IsGenericMethod)
            {
                synthesizedMethod = synthesizedMethod.Construct(StaticCast<TypeSymbol>.From(realTypeArguments));
            }
            else
E
Evan Hauck 已提交
982
            {
E
Evan Hauck 已提交
983
                Debug.Assert(realTypeArguments.Length == 0);
E
Evan Hauck 已提交
984
            }
985
        }
P
Pilchie 已提交
986 987 988

        public override BoundNode VisitCall(BoundCall node)
        {
E
Evan Hauck 已提交
989 990
            if (node.Method.MethodKind == MethodKind.LocalFunction)
            {
991 992 993 994 995
                var args = VisitList(node.Arguments);
                var type = VisitType(node.Type);

                RemapLocalFunction(
                    node.Syntax,
996
                    node.Method,
997 998 999 1000 1001 1002 1003 1004
                    out var receiver,
                    out var method,
                    ref args);

                return node.Update(
                    receiver,
                    method,
                    args,
1005 1006 1007 1008 1009 1010 1011
                    node.ArgumentNamesOpt,
                    node.ArgumentRefKindsOpt,
                    node.IsDelegateCall,
                    node.Expanded,
                    node.InvokedAsExtensionMethod,
                    node.ArgsToParamsOpt,
                    node.ResultKind,
1012
                    node.BinderOpt,
1013
                    type);
E
Evan Hauck 已提交
1014
            }
1015

E
Evan Hauck 已提交
1016
            var visited = base.VisitCall(node);
P
Pilchie 已提交
1017 1018 1019 1020 1021 1022 1023 1024
            if (visited.Kind != BoundKind.Call)
            {
                return visited;
            }

            var rewritten = (BoundCall)visited;

            // Check if we need to init the 'this' proxy in a ctor call
1025
            if (!_seenBaseCall)
P
Pilchie 已提交
1026
            {
A
Andy Gocke 已提交
1027
                if (_currentMethod == _topLevelMethod && node.IsConstructorInitializer())
P
Pilchie 已提交
1028
                {
A
Andy Gocke 已提交
1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040
                    _seenBaseCall = true;
                    if (_thisProxyInitDeferred != null)
                    {
                        // Insert the this proxy assignment after the ctor call.
                        // Create bound sequence: { ctor call, thisProxyInitDeferred }
                        return new BoundSequence(
                            syntax: node.Syntax,
                            locals: ImmutableArray<LocalSymbol>.Empty,
                            sideEffects: ImmutableArray.Create<BoundExpression>(rewritten),
                            value: _thisProxyInitDeferred,
                            type: rewritten.Type);
                    }
P
Pilchie 已提交
1041 1042 1043 1044 1045 1046 1047 1048
                }
            }

            return rewritten;
        }

        private BoundSequence RewriteSequence(BoundSequence node, ArrayBuilder<BoundExpression> prologue, ArrayBuilder<LocalSymbol> newLocals)
        {
1049
            RewriteLocals(node.Locals, newLocals);
P
Pilchie 已提交
1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065

            foreach (var expr in node.SideEffects)
            {
                var replacement = (BoundExpression)this.Visit(expr);
                if (replacement != null) prologue.Add(replacement);
            }

            var newValue = (BoundExpression)this.Visit(node.Value);
            var newType = this.VisitType(node.Type);

            return node.Update(newLocals.ToImmutableAndFree(), prologue.ToImmutableAndFree(), newValue, newType);
        }

        public override BoundNode VisitBlock(BoundBlock node)
        {
            // Test if this frame has captured variables and requires the introduction of a closure class.
1066
            if (_frames.TryGetValue(node, out var frame))
P
Pilchie 已提交
1067 1068 1069 1070 1071 1072 1073 1074 1075 1076
            {
                return IntroduceFrame(node, frame, (ArrayBuilder<BoundExpression> prologue, ArrayBuilder<LocalSymbol> newLocals) =>
                    RewriteBlock(node, prologue, newLocals));
            }
            else
            {
                return RewriteBlock(node, ArrayBuilder<BoundExpression>.GetInstance(), ArrayBuilder<LocalSymbol>.GetInstance());
            }
        }

1077
        private BoundBlock RewriteBlock(BoundBlock node, ArrayBuilder<BoundExpression> prologue, ArrayBuilder<LocalSymbol> newLocals)
P
Pilchie 已提交
1078
        {
1079
            RewriteLocals(node.Locals, newLocals);
P
Pilchie 已提交
1080 1081 1082

            var newStatements = ArrayBuilder<BoundStatement>.GetInstance();

1083 1084 1085 1086 1087 1088 1089
            if (prologue.Count > 0)
            {
                newStatements.Add(new BoundSequencePoint(null, null) { WasCompilerGenerated = true });
            }

            InsertAndFreePrologue(newStatements, prologue);

P
Pilchie 已提交
1090 1091 1092 1093 1094 1095 1096 1097 1098 1099
            foreach (var statement in node.Statements)
            {
                var replacement = (BoundStatement)this.Visit(statement);
                if (replacement != null)
                {
                    newStatements.Add(replacement);
                }
            }

            // TODO: we may not need to update if there was nothing to rewrite.
E
Evan Hauck 已提交
1100
            return node.Update(newLocals.ToImmutableAndFree(), node.LocalFunctions, newStatements.ToImmutableAndFree());
P
Pilchie 已提交
1101 1102
        }

1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118
        public override BoundNode VisitScope(BoundScope node)
        {
            Debug.Assert(!node.Locals.IsEmpty);
            var newLocals = ArrayBuilder<LocalSymbol>.GetInstance();
            RewriteLocals(node.Locals, newLocals);

            var statements = VisitList(node.Statements);
            if (newLocals.Count == 0)
            {
                newLocals.Free();
                return new BoundStatementList(node.Syntax, statements);
            }

            return node.Update(newLocals.ToImmutableAndFree(), statements);
        }

P
Pilchie 已提交
1119 1120 1121
        public override BoundNode VisitCatchBlock(BoundCatchBlock node)
        {
            // Test if this frame has captured variables and requires the introduction of a closure class.
1122
            if (_frames.TryGetValue(node, out var frame))
P
Pilchie 已提交
1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136
            {
                return IntroduceFrame(node, frame, (ArrayBuilder<BoundExpression> prologue, ArrayBuilder<LocalSymbol> newLocals) =>
                {
                    return RewriteCatch(node, prologue, newLocals);
                });
            }
            else
            {
                return RewriteCatch(node, ArrayBuilder<BoundExpression>.GetInstance(), ArrayBuilder<LocalSymbol>.GetInstance());
            }
        }

        private BoundNode RewriteCatch(BoundCatchBlock node, ArrayBuilder<BoundExpression> prologue, ArrayBuilder<LocalSymbol> newLocals)
        {
1137 1138
            RewriteLocals(node.Locals, newLocals);
            var rewrittenCatchLocals = newLocals.ToImmutableAndFree();
P
Pilchie 已提交
1139 1140 1141

            // If exception variable got lifted, IntroduceFrame will give us frame init prologue.
            // It needs to run before the exception variable is accessed.
1142
            // To ensure that, we will make exception variable a sequence that performs prologue as its side-effects.
P
Pilchie 已提交
1143
            BoundExpression rewrittenExceptionSource = null;
1144
            var rewrittenFilter = (BoundExpression)this.Visit(node.ExceptionFilterOpt);
P
Pilchie 已提交
1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157
            if (node.ExceptionSourceOpt != null)
            {
                rewrittenExceptionSource = (BoundExpression)Visit(node.ExceptionSourceOpt);
                if (prologue.Count > 0)
                {
                    rewrittenExceptionSource = new BoundSequence(
                        rewrittenExceptionSource.Syntax,
                        ImmutableArray.Create<LocalSymbol>(),
                        prologue.ToImmutable(),
                        rewrittenExceptionSource,
                        rewrittenExceptionSource.Type);
                }
            }
1158 1159 1160 1161 1162 1163 1164 1165 1166 1167
            else if (prologue.Count > 0)
            {
                Debug.Assert(rewrittenFilter != null);
                rewrittenFilter = new BoundSequence(
                    rewrittenFilter.Syntax,
                    ImmutableArray.Create<LocalSymbol>(),
                    prologue.ToImmutable(),
                    rewrittenFilter,
                    rewrittenFilter.Type);
            }
P
Pilchie 已提交
1168

1169
            // done with this.
P
Pilchie 已提交
1170 1171 1172 1173 1174 1175 1176 1177
            prologue.Free();

            // rewrite filter and body
            // NOTE: this will proxy all accesses to exception local if that got lifted.
            var exceptionTypeOpt = this.VisitType(node.ExceptionTypeOpt);
            var rewrittenBlock = (BoundBlock)this.Visit(node.Body);

            return node.Update(
1178
                rewrittenCatchLocals,
P
Pilchie 已提交
1179 1180 1181
                rewrittenExceptionSource,
                exceptionTypeOpt,
                rewrittenFilter,
1182 1183
                rewrittenBlock,
                node.IsSynthesizedAsyncCatchAll);
P
Pilchie 已提交
1184 1185 1186 1187 1188
        }

        public override BoundNode VisitSequence(BoundSequence node)
        {
            // Test if this frame has captured variables and requires the introduction of a closure class.
1189
            if (_frames.TryGetValue(node, out var frame))
P
Pilchie 已提交
1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205
            {
                return IntroduceFrame(node, frame, (ArrayBuilder<BoundExpression> prologue, ArrayBuilder<LocalSymbol> newLocals) =>
                {
                    return RewriteSequence(node, prologue, newLocals);
                });
            }
            else
            {
                return RewriteSequence(node, ArrayBuilder<BoundExpression>.GetInstance(), ArrayBuilder<LocalSymbol>.GetInstance());
            }
        }

        public override BoundNode VisitStatementList(BoundStatementList node)
        {
            // Test if this frame has captured variables and requires the introduction of a closure class.
            // That can occur for a BoundStatementList if it is the body of a method with captured parameters.
1206
            if (_frames.TryGetValue(node, out var frame))
P
Pilchie 已提交
1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217
            {
                return IntroduceFrame(node, frame, (ArrayBuilder<BoundExpression> prologue, ArrayBuilder<LocalSymbol> newLocals) =>
                {
                    var newStatements = ArrayBuilder<BoundStatement>.GetInstance();
                    InsertAndFreePrologue(newStatements, prologue);

                    foreach (var s in node.Statements)
                    {
                        newStatements.Add((BoundStatement)this.Visit(s));
                    }

1218
                    return new BoundBlock(node.Syntax, newLocals.ToImmutableAndFree(), newStatements.ToImmutableAndFree(), node.HasErrors);
P
Pilchie 已提交
1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229
                });
            }
            else
            {
                return base.VisitStatementList(node);
            }
        }

        public override BoundNode VisitSwitchStatement(BoundSwitchStatement node)
        {
            // Test if this frame has captured variables and requires the introduction of a closure class.
1230
            if (_frames.TryGetValue(node, out var frame))
P
Pilchie 已提交
1231 1232 1233 1234 1235 1236 1237
            {
                return IntroduceFrame(node, frame, (ArrayBuilder<BoundExpression> prologue, ArrayBuilder<LocalSymbol> newLocals) =>
                {
                    var newStatements = ArrayBuilder<BoundStatement>.GetInstance();
                    InsertAndFreePrologue(newStatements, prologue);
                    newStatements.Add((BoundStatement)base.VisitSwitchStatement(node));

1238
                    return new BoundBlock(node.Syntax, newLocals.ToImmutableAndFree(), newStatements.ToImmutableAndFree(), node.HasErrors);
P
Pilchie 已提交
1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254
                });
            }
            else
            {
                return base.VisitSwitchStatement(node);
            }
        }

        public override BoundNode VisitDelegateCreationExpression(BoundDelegateCreationExpression node)
        {
            // A delegate creation expression of the form "new Action( ()=>{} )" is treated exactly like
            // (Action)(()=>{})
            if (node.Argument.Kind == BoundKind.Lambda)
            {
                return RewriteLambdaConversion((BoundLambda)node.Argument);
            }
1255 1256

            if (node.MethodOpt?.MethodKind == MethodKind.LocalFunction)
P
Pilchie 已提交
1257
            {
1258 1259 1260
                var arguments = default(ImmutableArray<BoundExpression>);
                RemapLocalFunction(
                    node.Syntax,
1261
                    node.MethodOpt,
1262 1263 1264
                    out var receiver,
                    out var method,
                    ref arguments);
1265

1266 1267 1268 1269 1270 1271
                return new BoundDelegateCreationExpression(
                    node.Syntax,
                    receiver,
                    method,
                    node.IsExtensionMethod,
                    VisitType(node.Type));
P
Pilchie 已提交
1272
            }
1273
            return base.VisitDelegateCreationExpression(node);
P
Pilchie 已提交
1274 1275 1276 1277
        }

        public override BoundNode VisitConversion(BoundConversion conversion)
        {
1278
            Debug.Assert(conversion.ConversionKind != ConversionKind.MethodGroup);
P
Pilchie 已提交
1279 1280 1281
            if (conversion.ConversionKind == ConversionKind.AnonymousFunction)
            {
                var result = (BoundExpression)RewriteLambdaConversion((BoundLambda)conversion.Operand);
1282 1283 1284 1285

                if (_inExpressionLambda && conversion.ExplicitCastInCode)
                {
                    result = new BoundConversion(
1286 1287
                        syntax: conversion.Syntax,
                        operand: result,
V
VSadov 已提交
1288
                        conversion: conversion.Conversion,
1289 1290 1291 1292
                        isBaseConversion: false,
                        @checked: false,
                        explicitCastInCode: true,
                        constantValueOpt: conversion.ConstantValueOpt,
1293 1294 1295 1296
                        type: conversion.Type);
                }

                return result;
P
Pilchie 已提交
1297
            }
1298 1299

            return base.VisitConversion(conversion);
P
Pilchie 已提交
1300 1301
        }

1302 1303
        public override BoundNode VisitLocalFunctionStatement(BoundLocalFunctionStatement node)
        {
E
Evan Hauck 已提交
1304
            ClosureKind closureKind;
1305
            NamedTypeSymbol translatedLambdaContainer;
1306
            SynthesizedClosureEnvironment containerAsFrame;
E
Evan Hauck 已提交
1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317
            BoundNode lambdaScope;
            DebugId topLevelMethodId;
            DebugId lambdaId;
            RewriteLambdaOrLocalFunction(
                node,
                out closureKind,
                out translatedLambdaContainer,
                out containerAsFrame,
                out lambdaScope,
                out topLevelMethodId,
                out lambdaId);
1318 1319 1320 1321

            return new BoundNoOpStatement(node.Syntax, NoOpStatementFlavor.Default);
        }

1322
        private DebugId GetLambdaId(SyntaxNode syntax, ClosureKind closureKind, int closureOrdinal)
1323 1324 1325 1326 1327
        {
            Debug.Assert(syntax != null);

            SyntaxNode lambdaOrLambdaBodySyntax;
            var anonymousFunction = syntax as AnonymousFunctionExpressionSyntax;
1328
            var localFunction = syntax as LocalFunctionStatementSyntax;
1329 1330
            bool isLambdaBody;

1331 1332 1333
            if (anonymousFunction != null)
            {
                lambdaOrLambdaBodySyntax = anonymousFunction.Body;
1334
                isLambdaBody = true;
1335
            }
1336 1337
            else if (localFunction != null)
            {
1338
                lambdaOrLambdaBodySyntax = (SyntaxNode)localFunction.Body ?? localFunction.ExpressionBody?.Expression;
1339 1340
                isLambdaBody = true;
            }
1341
            else if (LambdaUtilities.IsQueryPairLambda(syntax))
1342 1343 1344
            {
                // "pair" query lambdas
                lambdaOrLambdaBodySyntax = syntax;
1345
                isLambdaBody = false;
1346
                Debug.Assert(closureKind == ClosureKind.Singleton);
1347 1348 1349 1350 1351
            }
            else
            {
                // query lambdas
                lambdaOrLambdaBodySyntax = syntax;
1352
                isLambdaBody = true;
1353 1354
            }

1355
            Debug.Assert(!isLambdaBody || LambdaUtilities.IsLambdaBody(lambdaOrLambdaBodySyntax));
1356

1357
            // determine lambda ordinal and calculate syntax offset
1358

1359 1360 1361
            DebugId lambdaId;
            DebugId previousLambdaId;
            if (slotAllocatorOpt != null && slotAllocatorOpt.TryGetPreviousLambda(lambdaOrLambdaBodySyntax, isLambdaBody, out previousLambdaId))
1362
            {
1363
                lambdaId = previousLambdaId;
1364 1365 1366
            }
            else
            {
1367
                lambdaId = new DebugId(_lambdaDebugInfoBuilder.Count, CompilationState.ModuleBuilderOpt.CurrentGenerationOrdinal);
1368
            }
1369 1370

            int syntaxOffset = _topLevelMethod.CalculateLocalSyntaxOffset(lambdaOrLambdaBodySyntax.SpanStart, lambdaOrLambdaBodySyntax.SyntaxTree);
T
Tomas Matousek 已提交
1371
            _lambdaDebugInfoBuilder.Add(new LambdaDebugInfo(syntaxOffset, lambdaId, closureOrdinal));
1372
            return lambdaId;
1373 1374
        }

1375
        private SynthesizedClosureMethod RewriteLambdaOrLocalFunction(
E
Evan Hauck 已提交
1376 1377 1378
            IBoundLambdaOrFunction node,
            out ClosureKind closureKind,
            out NamedTypeSymbol translatedLambdaContainer,
1379
            out SynthesizedClosureEnvironment containerAsFrame,
E
Evan Hauck 已提交
1380 1381 1382
            out BoundNode lambdaScope,
            out DebugId topLevelMethodId,
            out DebugId lambdaId)
P
Pilchie 已提交
1383
        {
A
Andy Gocke 已提交
1384
            Analysis.Closure closure = Analysis.GetClosureInTree(_analysis.ScopeTree, node.Symbol);
1385 1386
            var synthesizedMethod = closure.SynthesizedLoweredMethod;
            Debug.Assert(synthesizedMethod != null);
A
Andy Gocke 已提交
1387

1388 1389 1390 1391 1392
            closureKind = synthesizedMethod.ClosureKind;
            translatedLambdaContainer = synthesizedMethod.ContainingType;
            containerAsFrame = translatedLambdaContainer as SynthesizedClosureEnvironment;
            topLevelMethodId = _analysis.GetTopLevelMethodId();
            lambdaId = synthesizedMethod.LambdaId;
1393

A
Andy Gocke 已提交
1394
            if (closure.ContainingEnvironmentOpt != null)
P
Pilchie 已提交
1395
            {
1396 1397 1398
                // Find the scope of the containing environment
                BoundNode tmpScope = null;
                Analysis.VisitScopeTree(_analysis.ScopeTree, scope =>
1399
                {
1400
                    if (scope.DeclaredEnvironments.Contains(closure.ContainingEnvironmentOpt))
A
Andy Gocke 已提交
1401
                    {
1402 1403 1404 1405 1406
                        tmpScope = scope.BoundNode;
                    }
                });
                Debug.Assert(tmpScope != null);
                lambdaScope = tmpScope;
P
Pilchie 已提交
1407 1408 1409
            }
            else
            {
1410
                lambdaScope = null;
P
Pilchie 已提交
1411
            }
1412
            
1413
            CompilationState.ModuleBuilderOpt.AddSynthesizedDefinition(translatedLambdaContainer, synthesizedMethod);
P
Pilchie 已提交
1414

1415
            foreach (var parameter in node.Symbol.Parameters)
P
Pilchie 已提交
1416
            {
1417
                _parameterMap.Add(parameter, synthesizedMethod.Parameters[parameter.Ordinal]);
P
Pilchie 已提交
1418 1419 1420
            }

            // rewrite the lambda body as the generated method's body
1421 1422 1423 1424 1425 1426 1427 1428 1429
            var oldMethod = _currentMethod;
            var oldFrameThis = _currentFrameThis;
            var oldTypeParameters = _currentTypeParameters;
            var oldInnermostFramePointer = _innermostFramePointer;
            var oldTypeMap = _currentLambdaBodyTypeMap;
            var oldAddedStatements = _addedStatements;
            var oldAddedLocals = _addedLocals;
            _addedStatements = null;
            _addedLocals = null;
P
Pilchie 已提交
1430 1431 1432

            // switch to the generated method

1433
            _currentMethod = synthesizedMethod;
1434
            if (closureKind == ClosureKind.Static || closureKind == ClosureKind.Singleton)
P
Pilchie 已提交
1435 1436
            {
                // no link from a static lambda to its container
1437
                _innermostFramePointer = _currentFrameThis = null;
P
Pilchie 已提交
1438 1439 1440
            }
            else
            {
1441 1442
                _currentFrameThis = synthesizedMethod.ThisParameter;
                _framePointers.TryGetValue(translatedLambdaContainer, out _innermostFramePointer);
P
Pilchie 已提交
1443 1444
            }

E
Evan Hauck 已提交
1445
            _currentTypeParameters = containerAsFrame?.TypeParameters.Concat(synthesizedMethod.TypeParameters) ?? synthesizedMethod.TypeParameters;
E
Evan Hauck 已提交
1446
            _currentLambdaBodyTypeMap = synthesizedMethod.TypeMap;
P
Pilchie 已提交
1447 1448 1449

            var body = AddStatementsIfNeeded((BoundStatement)VisitBlock(node.Body));
            CheckLocalsDefined(body);
1450
            AddSynthesizedMethod(synthesizedMethod, body);
P
Pilchie 已提交
1451 1452 1453

            // return to the old method

1454 1455 1456 1457 1458 1459 1460
            _currentMethod = oldMethod;
            _currentFrameThis = oldFrameThis;
            _currentTypeParameters = oldTypeParameters;
            _innermostFramePointer = oldInnermostFramePointer;
            _currentLambdaBodyTypeMap = oldTypeMap;
            _addedLocals = oldAddedLocals;
            _addedStatements = oldAddedStatements;
P
Pilchie 已提交
1461

E
Evan Hauck 已提交
1462
            return synthesizedMethod;
1463
        }
E
Evan Hauck 已提交
1464

1465 1466 1467
        private void AddSynthesizedMethod(MethodSymbol method, BoundStatement body)
        {
            if (_synthesizedMethods == null)
1468
            {
1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480
                _synthesizedMethods = ArrayBuilder<TypeCompilationState.MethodWithBody>.GetInstance();
            }

            _synthesizedMethods.Add(
                new TypeCompilationState.MethodWithBody(
                    method,
                    body,
                    CompilationState.CurrentImportChain));
        }

        private BoundNode RewriteLambdaConversion(BoundLambda node)
        {
E
Evan Hauck 已提交
1481 1482 1483 1484 1485 1486 1487 1488
            var wasInExpressionLambda = _inExpressionLambda;
            _inExpressionLambda = _inExpressionLambda || node.Type.IsExpressionTree();

            if (_inExpressionLambda)
            {
                var newType = VisitType(node.Type);
                var newBody = (BoundBlock)Visit(node.Body);
                node = node.Update(node.Symbol, newBody, node.Diagnostics, node.Binder, newType);
1489
                var result0 = wasInExpressionLambda ? node : ExpressionLambdaRewriter.RewriteLambda(node, CompilationState, TypeMap, RecursionDepth, Diagnostics);
E
Evan Hauck 已提交
1490 1491 1492 1493 1494 1495
                _inExpressionLambda = wasInExpressionLambda;
                return result0;
            }

            ClosureKind closureKind;
            NamedTypeSymbol translatedLambdaContainer;
1496
            SynthesizedClosureEnvironment containerAsFrame;
E
Evan Hauck 已提交
1497 1498 1499
            BoundNode lambdaScope;
            DebugId topLevelMethodId;
            DebugId lambdaId;
1500
            SynthesizedClosureMethod synthesizedMethod = RewriteLambdaOrLocalFunction(
E
Evan Hauck 已提交
1501 1502 1503 1504 1505 1506 1507 1508
                node,
                out closureKind,
                out translatedLambdaContainer,
                out containerAsFrame,
                out lambdaScope,
                out topLevelMethodId,
                out lambdaId);

E
Evan Hauck 已提交
1509
            MethodSymbol referencedMethod = synthesizedMethod;
1510
            BoundExpression receiver;
E
Evan Hauck 已提交
1511 1512
            NamedTypeSymbol constructedFrame;
            RemapLambdaOrLocalFunction(node.Syntax, node.Symbol, default(ImmutableArray<TypeSymbol>), closureKind, ref referencedMethod, out receiver, out constructedFrame);
1513

E
Evan Hauck 已提交
1514
            // Rewrite the lambda expression (and the enclosing anonymous method conversion) as a delegate creation expression
1515

P
Pilchie 已提交
1516
            TypeSymbol type = this.VisitType(node.Type);
1517

1518 1519
            // static lambdas are emitted as instance methods on a singleton receiver
            // delegates invoke dispatch is optimized for instance delegates so 
1520
            // it is preferable to emit lambdas as instance methods even when lambdas 
1521
            // do not capture anything
P
Pilchie 已提交
1522 1523 1524 1525
            BoundExpression result = new BoundDelegateCreationExpression(
                node.Syntax,
                receiver,
                referencedMethod,
1526
                isExtensionMethod: false,
P
Pilchie 已提交
1527 1528 1529 1530 1531
                type: type);

            // if the block containing the lambda is not the innermost block,
            // or the lambda is static, then the lambda object should be cached in its frame.
            // NOTE: we are not caching static lambdas in static ctors - cannot reuse such cache.
1532
            var shouldCacheForStaticMethod = closureKind == ClosureKind.Singleton &&
1533
                _currentMethod.MethodKind != MethodKind.StaticConstructor &&
P
Pilchie 已提交
1534 1535 1536 1537 1538
                !referencedMethod.IsGenericMethod;

            // NOTE: We require "lambdaScope != null". 
            //       We do not want to introduce a field into an actual user's class (not a synthetic frame).
            var shouldCacheInLoop = lambdaScope != null &&
1539
                lambdaScope != Analysis.GetScopeParent(_analysis.ScopeTree, node.Body).BoundNode &&
P
Pilchie 已提交
1540 1541 1542 1543
                InLoopOrLambda(node.Syntax, lambdaScope.Syntax);

            if (shouldCacheForStaticMethod || shouldCacheInLoop)
            {
1544
                // replace the expression "new Delegate(frame.M)" with "frame.cache ?? (frame.cache = new Delegate(frame.M));
1545
                var F = new SyntheticBoundNodeFactory(_currentMethod, node.Syntax, CompilationState, Diagnostics);
P
Pilchie 已提交
1546 1547
                try
                {
T
TomasMatousek 已提交
1548
                    BoundExpression cache;
1549
                    if (shouldCacheForStaticMethod || shouldCacheInLoop && (object)containerAsFrame != null)
P
Pilchie 已提交
1550
                    {
1551 1552 1553
                        // Since the cache variable will be in a container with possibly alpha-rewritten generic parameters, we need to
                        // substitute the original type according to the type map for that container. That substituted type may be
                        // different from the local variable `type`, which has the node's type substituted for the current container.
1554
                        var cacheVariableType = containerAsFrame.TypeMap.SubstituteType(node.Type).Type;
1555

1556
                        var cacheVariableName = GeneratedNames.MakeLambdaCacheFieldName(
1557 1558
                            // If we are generating the field into a display class created exclusively for the lambda the lambdaOrdinal itself is unique already, 
                            // no need to include the top-level method ordinal in the field name.
1559 1560
                            (closureKind == ClosureKind.General) ? -1 : topLevelMethodId.Ordinal,
                            topLevelMethodId.Generation,
1561 1562
                            lambdaId.Ordinal,
                            lambdaId.Generation);
1563

1564
                        var cacheField = new SynthesizedLambdaCacheFieldSymbol(translatedLambdaContainer, cacheVariableType, cacheVariableName, _topLevelMethod, isReadOnly: false, isStatic: closureKind == ClosureKind.Singleton);
T
TomasMatousek 已提交
1565
                        CompilationState.ModuleBuilderOpt.AddSynthesizedDefinition(translatedLambdaContainer, cacheField);
T
TomasMatousek 已提交
1566
                        cache = F.Field(receiver, cacheField.AsMember(constructedFrame)); //NOTE: the field was added to the unconstructed frame type.
P
Pilchie 已提交
1567 1568 1569 1570
                    }
                    else
                    {
                        // the lambda captures at most the "this" of the enclosing method.  We cache its delegate in a local variable.
1571
                        var cacheLocal = F.SynthesizedLocal(type, kind: SynthesizedLocalKind.CachedAnonymousMethodDelegate);
1572 1573 1574
                        if (_addedLocals == null) _addedLocals = ArrayBuilder<LocalSymbol>.GetInstance();
                        _addedLocals.Add(cacheLocal);
                        if (_addedStatements == null) _addedStatements = ArrayBuilder<BoundStatement>.GetInstance();
T
TomasMatousek 已提交
1575
                        cache = F.Local(cacheLocal);
1576
                        _addedStatements.Add(F.Assignment(cache, F.Null(type)));
P
Pilchie 已提交
1577 1578
                    }

T
TomasMatousek 已提交
1579
                    result = F.Coalesce(cache, F.AssignmentExpression(cache, result));
P
Pilchie 已提交
1580 1581 1582 1583
                }
                catch (SyntheticBoundNodeFactory.MissingPredefinedMember ex)
                {
                    Diagnostics.Add(ex.Diagnostic);
1584
                    return new BoundBadExpression(F.Syntax, LookupResultKind.Empty, ImmutableArray<Symbol>.Empty, ImmutableArray.Create<BoundExpression>(node), node.Type);
P
Pilchie 已提交
1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622
                }
            }

            return result;
        }

        // This helper checks syntactically whether there is a loop or lambda expression
        // between given lambda syntax and the syntax that corresponds to its closure.
        // we use this heuristic as a hint that the lambda delegate may be created 
        // multiple times with same closure.
        // In such cases it makes sense to cache the delegate.
        //
        // Examples:
        //            int x = 123;
        //            for (int i = 1; i< 10; i++)
        //            {
        //                if (i< 2)
        //                {
        //                    arr[i].Execute(arg => arg + x);  // delegate should be cached
        //                }
        //            }

        //            for (int i = 1; i< 10; i++)
        //            {
        //                var val = i;
        //                if (i< 2)
        //                {
        //                    int y = i + i;
        //                    System.Console.WriteLine(y);
        //                    arr[i].Execute(arg => arg + val);  // delegate should NOT be cached (closure created inside the loop)
        //                }
        //            }
        //
        private static bool InLoopOrLambda(SyntaxNode lambdaSyntax, SyntaxNode scopeSyntax)
        {
            var curSyntax = lambdaSyntax.Parent;
            while (curSyntax != null && curSyntax != scopeSyntax)
            {
1623
                switch (curSyntax.Kind())
P
Pilchie 已提交
1624 1625 1626
                {
                    case SyntaxKind.ForStatement:
                    case SyntaxKind.ForEachStatement:
1627
                    case SyntaxKind.ForEachVariableStatement:
P
Pilchie 已提交
1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646
                    case SyntaxKind.WhileStatement:
                    case SyntaxKind.DoStatement:
                    case SyntaxKind.SimpleLambdaExpression:
                    case SyntaxKind.ParenthesizedLambdaExpression:
                        return true;
                }

                curSyntax = curSyntax.Parent;
            }

            return false;
        }

        public override BoundNode VisitLambda(BoundLambda node)
        {
            // these nodes have been handled in the context of the enclosing anonymous method conversion.
            throw ExceptionUtilities.Unreachable;
        }

E
Evan Hauck 已提交
1647
        #endregion
P
Pilchie 已提交
1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737

#if CHECK_LOCALS
        /// <summary>
        /// Ensure that local variables are always in scope where used in bound trees
        /// </summary>
        /// <param name="node"></param>
        static partial void CheckLocalsDefined(BoundNode node)
        {
            LocalsDefinedScanner.INSTANCE.Visit(node);
        }

        class LocalsDefinedScanner : BoundTreeWalker
        {
            internal static LocalsDefinedScanner INSTANCE = new LocalsDefinedScanner();

            HashSet<Symbol> localsDefined = new HashSet<Symbol>();

            public override BoundNode VisitLocal(BoundLocal node)
            {
                Debug.Assert(node.LocalSymbol.IsConst || localsDefined.Contains(node.LocalSymbol));
                return base.VisitLocal(node);
            }

            public override BoundNode VisitSequence(BoundSequence node)
            {
                try
                {
                    if (!node.Locals.IsNullOrEmpty)
                        foreach (var l in node.Locals)
                            localsDefined.Add(l);
                    return base.VisitSequence(node);
                }
                finally
                {
                    if (!node.Locals.IsNullOrEmpty)
                        foreach (var l in node.Locals)
                            localsDefined.Remove(l);
                }
            }

            public override BoundNode VisitCatchBlock(BoundCatchBlock node)
            {
                try
                {
                    if ((object)node.LocalOpt != null) localsDefined.Add(node.LocalOpt);
                    return base.VisitCatchBlock(node);
                }
                finally
                {
                    if ((object)node.LocalOpt != null) localsDefined.Remove(node.LocalOpt);
                }
            }

            public override BoundNode VisitSwitchStatement(BoundSwitchStatement node)
            {
                try
                {
                    if (!node.LocalsOpt.IsNullOrEmpty)
                        foreach (var l in node.LocalsOpt)
                            localsDefined.Add(l);
                    return base.VisitSwitchStatement(node);
                }
                finally
                {
                    if (!node.LocalsOpt.IsNullOrEmpty)
                        foreach (var l in node.LocalsOpt)
                            localsDefined.Remove(l);
                }
            }

            public override BoundNode VisitBlock(BoundBlock node)
            {
                try
                {
                    if (!node.LocalsOpt.IsNullOrEmpty)
                        foreach (var l in node.LocalsOpt)
                            localsDefined.Add(l);
                    return base.VisitBlock(node);
                }
                finally
                {
                    if (!node.LocalsOpt.IsNullOrEmpty)
                        foreach (var l in node.LocalsOpt)
                            localsDefined.Remove(l);
                }
            }
        }
#endif
    }
}