LambdaRewriter.cs 66.6 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
P
Pilchie 已提交
7 8 9 10
using System;
using System.Collections.Generic;
using System.Collections.Immutable;
using System.Diagnostics;
11
using Microsoft.CodeAnalysis.CodeGen;
P
Pilchie 已提交
12
using Microsoft.CodeAnalysis.CSharp.Symbols;
13
using Microsoft.CodeAnalysis.CSharp.Syntax;
P
Pilchie 已提交
14 15 16 17 18 19 20 21 22
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 已提交
23
    /// The entry point is the public method <see cref="Rewrite"/>.  It operates as follows:
P
Pilchie 已提交
24 25 26
    /// 
    /// 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
27
    /// have captured variables.  The result of this analysis is left in <see cref="_analysis"/>.
P
Pilchie 已提交
28 29
    /// 
    /// Then we make a frame, or compiler-generated class, represented by an instance of
T
TomasMatousek 已提交
30
    /// <see cref="LambdaFrame"/> for each scope with captured variables.  The generated frames are kept
31
    /// in <see cref="_frames"/>.  Each frame is given a single field for each captured
T
TomasMatousek 已提交
32
    /// variable in the corresponding scope.  These are are maintained in <see cref="MethodToClassRewriter.proxies"/>.
P
Pilchie 已提交
33 34
    /// 
    /// Finally, we walk and rewrite the input bound tree, keeping track of the following:
35 36 37
    /// (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 已提交
38 39 40 41 42 43 44 45
    /// (4) The symbol that is used to access the innermost frame pointer (it could be a local variable or "this" parameter)
    /// 
    /// 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.
    /// 
T
TomasMatousek 已提交
46
    /// In addition, the rewriting deposits into <see cref="TypeCompilationState.SynthesizedMethods"/> a (<see cref="MethodSymbol"/>, <see cref="BoundStatement"/>)
P
Pilchie 已提交
47 48
    /// pair for each generated method.
    /// 
T
TomasMatousek 已提交
49
    /// <see cref="Rewrite"/> produces its output in two forms.  First, it returns a new bound statement
P
Pilchie 已提交
50
    /// for the caller to use for the body of the original method.  Second, it returns a collection of
T
TomasMatousek 已提交
51
    /// (<see cref="MethodSymbol"/>, <see cref="BoundStatement"/>) pairs for additional methods that the lambda rewriter produced.
P
Pilchie 已提交
52 53 54 55 56
    /// 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>
57
    internal sealed partial class LambdaRewriter : MethodToClassRewriter
P
Pilchie 已提交
58
    {
59 60 61
        private readonly Analysis _analysis;
        private readonly MethodSymbol _topLevelMethod;
        private readonly int _topLevelMethodOrdinal;
P
Pilchie 已提交
62

63 64
        // lambda frame for static lambdas. 
        // initialized lazily and could be null if there are no static lambdas
65
        private LambdaFrame _lazyStaticLambdaFrame;
66

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

70
        // A mapping from every local function to its lowered method
E
Evan Hauck 已提交
71 72 73 74 75 76 77 78 79 80 81
        private struct MappedLocalFunction
        {
            public readonly MethodSymbol Symbol;
            public readonly ClosureKind ClosureKind;
            public MappedLocalFunction(MethodSymbol symbol, ClosureKind closureKind)
            {
                Symbol = symbol;
                ClosureKind = closureKind;
            }
        }
        private readonly Dictionary<LocalFunctionSymbol, MappedLocalFunction> _localFunctionMap = new Dictionary<LocalFunctionSymbol, MappedLocalFunction>();
E
Evan Hauck 已提交
82

P
Pilchie 已提交
83
        // for each block with lifted (captured) variables, the corresponding frame type
84
        private readonly Dictionary<BoundNode, LambdaFrame> _frames = new Dictionary<BoundNode, LambdaFrame>();
P
Pilchie 已提交
85 86 87

        // 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.
88
        private readonly Dictionary<NamedTypeSymbol, Symbol> _framePointers = new Dictionary<NamedTypeSymbol, Symbol>();
P
Pilchie 已提交
89

90 91 92
        // True if the rewritten tree should include assignments of the
        // original locals to the lifted proxies. This is only useful for the
        // expression evaluator where the original locals are left as is.
93
        private readonly bool _assignLocals;
94

P
Pilchie 已提交
95
        // The current method or lambda being processed.
96
        private MethodSymbol _currentMethod;
P
Pilchie 已提交
97 98

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

101
        private readonly ArrayBuilder<LambdaDebugInfo> _lambdaDebugInfoBuilder;
102

103
        // ID dispenser for field names of frame references
104
        private int _synthesizedFieldNameIdDispenser;
105

P
Pilchie 已提交
106
        // The symbol (field or local) holding the innermost frame
107
        private Symbol _innermostFramePointer;
P
Pilchie 已提交
108 109

        // The mapping of type parameters for the current lambda body
110
        private TypeMap _currentLambdaBodyTypeMap;
P
Pilchie 已提交
111 112

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

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

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

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

        // 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.
128
        private ArrayBuilder<LocalSymbol> _addedLocals;
P
Pilchie 已提交
129 130 131

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

        private LambdaRewriter(
            Analysis analysis,
            NamedTypeSymbol thisType,
T
TomasMatousek 已提交
137
            ParameterSymbol thisParameterOpt,
P
Pilchie 已提交
138
            MethodSymbol method,
139
            int methodOrdinal,
140
            ArrayBuilder<LambdaDebugInfo> lambdaDebugInfoBuilder,
141
            VariableSlotAllocator slotAllocatorOpt,
P
Pilchie 已提交
142 143
            TypeCompilationState compilationState,
            DiagnosticBag diagnostics,
144
            bool assignLocals)
145
            : base(slotAllocatorOpt, compilationState, diagnostics)
P
Pilchie 已提交
146
        {
T
TomasMatousek 已提交
147 148 149 150 151 152
            Debug.Assert(analysis != null);
            Debug.Assert(thisType != null);
            Debug.Assert(method != null);
            Debug.Assert(compilationState != null);
            Debug.Assert(diagnostics != null);

153 154 155 156 157 158 159 160 161 162 163 164
            _topLevelMethod = method;
            _topLevelMethodOrdinal = methodOrdinal;
            _lambdaDebugInfoBuilder = lambdaDebugInfoBuilder;
            _currentMethod = method;
            _analysis = analysis;
            _assignLocals = assignLocals;
            _currentTypeParameters = method.TypeParameters;
            _currentLambdaBodyTypeMap = TypeMap.Empty;
            _innermostFramePointer = _currentFrameThis = thisParameterOpt;
            _framePointers[thisType] = thisParameterOpt;
            _seenBaseCall = method.MethodKind != MethodKind.Constructor; // only used for ctors
            _synthesizedFieldNameIdDispenser = 1;
P
Pilchie 已提交
165 166
        }

167 168
        protected override bool NeedsProxy(Symbol localOrParameter)
        {
E
Evan Hauck 已提交
169 170
            Debug.Assert(localOrParameter is LocalSymbol || localOrParameter is ParameterSymbol ||
                (localOrParameter as MethodSymbol)?.MethodKind == MethodKind.LocalFunction);
171
            return _analysis.capturedVariables.ContainsKey(localOrParameter);
172 173
        }

P
Pilchie 已提交
174 175 176 177 178 179
        /// <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>
180
        /// <param name="loweredBody">The bound node to be rewritten</param>
P
Pilchie 已提交
181 182 183
        /// <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>
184
        /// <param name="methodOrdinal">Index of the method symbol in its containing type member list.</param>
185 186
        /// <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>
187
        /// <param name="slotAllocatorOpt">Slot allocator.</param>
P
Pilchie 已提交
188 189
        /// <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>
190
        /// <param name="assignLocals">The rewritten tree should include assignments of the original locals to the lifted proxies</param>
P
Pilchie 已提交
191
        public static BoundStatement Rewrite(
192
            BoundStatement loweredBody,
P
Pilchie 已提交
193 194 195
            NamedTypeSymbol thisType,
            ParameterSymbol thisParameter,
            MethodSymbol method,
196
            int methodOrdinal,
197 198
            ArrayBuilder<LambdaDebugInfo> lambdaDebugInfoBuilder,
            ArrayBuilder<ClosureDebugInfo> closureDebugInfoBuilder,
199
            VariableSlotAllocator slotAllocatorOpt,
P
Pilchie 已提交
200 201
            TypeCompilationState compilationState,
            DiagnosticBag diagnostics,
202
            bool assignLocals)
P
Pilchie 已提交
203 204 205
        {
            Debug.Assert((object)thisType != null);
            Debug.Assert(((object)thisParameter == null) || (thisParameter.Type == thisType));
206 207 208 209 210 211 212 213 214 215 216 217
            Debug.Assert(compilationState.ModuleBuilderOpt != null);

            var analysis = Analysis.Analyze(loweredBody, method);
            if (!analysis.SeenLambda)
            {
                // Unreachable anonymous functions are ignored by the analyzer.
                // No closures or lambda methods are generated.
                // E.g. 
                //   int y = 0;
                //   var b = false && from z in new X(y) select f(z + y)
                return loweredBody;
            }
P
Pilchie 已提交
218

219
            CheckLocalsDefined(loweredBody);
220 221 222 223 224
            var rewriter = new LambdaRewriter(
                analysis,
                thisType,
                thisParameter,
                method,
225
                methodOrdinal,
226
                lambdaDebugInfoBuilder,
227
                slotAllocatorOpt,
228 229
                compilationState,
                diagnostics,
230
                assignLocals);
231

P
Pilchie 已提交
232
            analysis.ComputeLambdaScopesAndFrameCaptures();
233 234
            rewriter.MakeFrames(closureDebugInfoBuilder);
            var body = rewriter.AddStatementsIfNeeded((BoundStatement)rewriter.Visit(loweredBody));
P
Pilchie 已提交
235
            CheckLocalsDefined(body);
236

P
Pilchie 已提交
237 238 239
            return body;
        }

240
        private BoundStatement AddStatementsIfNeeded(BoundStatement body)
P
Pilchie 已提交
241
        {
242
            if (_addedLocals != null)
P
Pilchie 已提交
243
            {
244 245 246 247
                _addedStatements.Add(body);
                body = new BoundBlock(body.Syntax, _addedLocals.ToImmutableAndFree(), _addedStatements.ToImmutableAndFree()) { WasCompilerGenerated = true };
                _addedLocals = null;
                _addedStatements = null;
P
Pilchie 已提交
248 249 250
            }
            else
            {
251
                Debug.Assert(_addedStatements == null);
P
Pilchie 已提交
252 253 254 255 256 257 258
            }

            return body;
        }

        protected override TypeMap TypeMap
        {
259
            get { return _currentLambdaBodyTypeMap; }
P
Pilchie 已提交
260 261 262 263
        }

        protected override MethodSymbol CurrentMethod
        {
264
            get { return _currentMethod; }
P
Pilchie 已提交
265 266 267 268
        }

        protected override NamedTypeSymbol ContainingType
        {
269
            get { return _topLevelMethod.ContainingType; }
P
Pilchie 已提交
270 271 272 273 274 275 276 277 278 279 280
        }

        /// <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>
        /// Create the frame types.
        /// </summary>
281
        private void MakeFrames(ArrayBuilder<ClosureDebugInfo> closureDebugInfo)
P
Pilchie 已提交
282 283 284
        {
            NamedTypeSymbol containingType = this.ContainingType;

285
            foreach (var kvp in _analysis.capturedVariables)
P
Pilchie 已提交
286
            {
P
pgavlin 已提交
287 288
                var captured = kvp.Key;

289
                BoundNode scope;
290
                if (!_analysis.variableScope.TryGetValue(captured, out scope))
P
Pilchie 已提交
291 292 293 294
                {
                    continue;
                }

295
                LambdaFrame frame = GetFrameForScope(scope, closureDebugInfo);
P
Pilchie 已提交
296

E
Evan Hauck 已提交
297
                if (captured.Kind != SymbolKind.Method)
P
Pilchie 已提交
298
                {
E
Evan Hauck 已提交
299 300 301 302 303
                    var hoistedField = LambdaCapturedVariable.Create(frame, captured, ref _synthesizedFieldNameIdDispenser);
                    proxies.Add(captured, new CapturedToFrameSymbolReplacement(hoistedField, isReusable: false));
                    CompilationState.ModuleBuilderOpt.AddSynthesizedDefinition(frame, hoistedField);

                    if (hoistedField.Type.IsRestrictedType())
P
Pilchie 已提交
304
                    {
E
Evan Hauck 已提交
305 306 307 308 309
                        foreach (CSharpSyntaxNode syntax in kvp.Value)
                        {
                            // CS4013: Instance of type '{0}' cannot be used inside an anonymous function, query expression, iterator block or async method
                            this.Diagnostics.Add(ErrorCode.ERR_SpecialByRefInLambda, syntax.Location, hoistedField.Type);
                        }
P
Pilchie 已提交
310 311 312 313 314
                    }
                }
            }
        }

315
        private LambdaFrame GetFrameForScope(BoundNode scope, ArrayBuilder<ClosureDebugInfo> closureDebugInfo)
316 317
        {
            LambdaFrame frame;
318
            if (!_frames.TryGetValue(scope, out frame))
319
            {
320 321 322
                var syntax = scope.Syntax;
                Debug.Assert(syntax != null);

323 324
                DebugId methodId = GetTopLevelMethodId();
                DebugId closureId = GetClosureId(syntax, closureDebugInfo);
325

E
Evan Hauck 已提交
326 327
                var containingMethod = _analysis.scopeOwner[scope];
                frame = new LambdaFrame(_topLevelMethod, containingMethod, syntax, methodId, closureId);
328
                _frames.Add(scope, frame);
329

330 331 332 333 334
                CompilationState.ModuleBuilderOpt.AddSynthesizedDefinition(this.ContainingType, frame);
                CompilationState.AddSynthesizedMethod(
                    frame.Constructor,
                    FlowAnalysisPass.AppendImplicitReturn(MethodCompiler.BindMethodBody(frame.Constructor, CompilationState, null),
                    frame.Constructor));
335 336 337 338 339
            }

            return frame;
        }

E
Evan Hauck 已提交
340
        private LambdaFrame GetStaticFrame(DiagnosticBag diagnostics, IBoundLambdaOrFunction lambda)
341
        {
342
            if (_lazyStaticLambdaFrame == null)
343
            {
344
                var isNonGeneric = !_topLevelMethod.IsGenericMethod;
345 346
                if (isNonGeneric)
                {
347
                    _lazyStaticLambdaFrame = CompilationState.staticLambdaFrame;
348 349
                }

350
                if (_lazyStaticLambdaFrame == null)
351
                {
352
                    DebugId methodId;
353 354
                    if (isNonGeneric)
                    {
355
                        methodId = new DebugId(DebugId.UndefinedOrdinal, CompilationState.ModuleBuilderOpt.CurrentGenerationOrdinal);
356 357 358
                    }
                    else
                    {
359
                        methodId = GetTopLevelMethodId();
360
                    }
361

E
Evan Hauck 已提交
362
                    DebugId closureId = default(DebugId);
E
Evan Hauck 已提交
363 364
                    // using _topLevelMethod as containing member because the static frame does not have generic parameters, except for the top level method's
                    _lazyStaticLambdaFrame = new LambdaFrame(_topLevelMethod, _topLevelMethod, scopeSyntaxOpt: null, methodId: methodId, closureId: closureId);
365 366

                    // nongeneric static lambdas can share the frame
367
                    if (isNonGeneric)
368
                    {
369
                        CompilationState.staticLambdaFrame = _lazyStaticLambdaFrame;
370 371
                    }

372
                    var frame = _lazyStaticLambdaFrame;
373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398

                    // add frame type
                    CompilationState.ModuleBuilderOpt.AddSynthesizedDefinition(this.ContainingType, frame);

                    // add its ctor
                    CompilationState.AddSynthesizedMethod(
                        frame.Constructor,
                        FlowAnalysisPass.AppendImplicitReturn(MethodCompiler.BindMethodBody(frame.Constructor, CompilationState, null),
                        frame.Constructor));

                    // associate the frame with the the first lambda that caused it to exist. 
                    // we need to associate this with somme syntax.
                    // unfortunately either containing method or containing class could be synthetic
                    // therefore could have no syntax.
                    CSharpSyntaxNode syntax = lambda.Syntax;

                    // 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)),
                            F.Return());

                    CompilationState.AddSynthesizedMethod(frame.StaticConstructor, body);
399 400 401
                }
            }

402
            return _lazyStaticLambdaFrame;
403 404
        }

P
Pilchie 已提交
405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430
        /// <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>
        private BoundExpression FrameOfType(CSharpSyntaxNode syntax, NamedTypeSymbol frameType)
        {
            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>
        protected override BoundExpression FramePointer(CSharpSyntaxNode syntax, NamedTypeSymbol frameClass)
        {
            Debug.Assert(frameClass.IsDefinition);

            // If in an instance method of the right type, we can just return the "this" pointer.
431
            if ((object)_currentFrameThis != null && _currentFrameThis.Type == frameClass)
P
Pilchie 已提交
432 433 434 435 436
            {
                return new BoundThisReference(syntax, frameClass);
            }

            // Otherwise we need to return the value from a frame pointer local variable...
437
            Symbol framePointer = _framePointers[frameClass];
P
Pilchie 已提交
438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469
            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));
            }

            var localFrame = framePointer as LocalSymbol;
            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>
        /// <param name="frame">The frame for the translated node</param>
        /// <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>
        private T IntroduceFrame<T>(BoundNode node, LambdaFrame frame, Func<ArrayBuilder<BoundExpression>, ArrayBuilder<LocalSymbol>, T> F)
        {
E
Evan Hauck 已提交
470 471
            var frameTypeParameters = ImmutableArray.Create(StaticCast<TypeSymbol>.From(_currentTypeParameters), 0, frame.Arity);
            NamedTypeSymbol frameType = frame.ConstructIfGeneric(frameTypeParameters);
472 473

            Debug.Assert(frame.ScopeSyntaxOpt != null);
474
            LocalSymbol framePointer = new SynthesizedLocal(_topLevelMethod, frameType, SynthesizedLocalKind.LambdaDisplayClass, frame.ScopeSyntaxOpt);
P
Pilchie 已提交
475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493

            CSharpSyntaxNode syntax = node.Syntax;

            // assign new frame to the frame variable

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

            MethodSymbol constructor = frame.Constructor.AsMember(frameType);
            Debug.Assert(frameType == constructor.ContainingType);
            var newFrame = new BoundObjectCreationExpression(
                syntax: syntax,
                constructor: constructor);

            prologue.Add(new BoundAssignmentOperator(syntax,
                new BoundLocal(syntax, framePointer, null, frameType),
                newFrame,
                frameType));

            CapturedSymbolReplacement oldInnermostFrameProxy = null;
494
            if ((object)_innermostFramePointer != null)
P
Pilchie 已提交
495
            {
496 497
                proxies.TryGetValue(_innermostFramePointer, out oldInnermostFrameProxy);
                if (_analysis.needsParentFrame.Contains(node))
P
Pilchie 已提交
498
                {
499
                    var capturedFrame = LambdaCapturedVariable.Create(frame, _innermostFramePointer, ref _synthesizedFieldNameIdDispenser);
P
Pilchie 已提交
500 501 502 503 504
                    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);

505
                    if (_currentMethod.MethodKind == MethodKind.Constructor && capturedFrame.Type == _currentMethod.ContainingType && !_seenBaseCall)
P
Pilchie 已提交
506 507 508 509 510
                    {
                        // Containing method is a constructor 
                        // Initialization statement for the "this" proxy must be inserted
                        // after the constructor initializer statement block
                        // This insertion will be done by the delegate F
511 512
                        Debug.Assert(_thisProxyInitDeferred == null);
                        _thisProxyInitDeferred = assignment;
P
Pilchie 已提交
513 514 515 516 517 518 519 520
                    }
                    else
                    {
                        prologue.Add(assignment);
                    }

                    if (CompilationState.Emitting)
                    {
T
TomasMatousek 已提交
521
                        CompilationState.ModuleBuilderOpt.AddSynthesizedDefinition(frame, capturedFrame);
P
Pilchie 已提交
522 523
                    }

524
                    proxies[_innermostFramePointer] = new CapturedToFrameSymbolReplacement(capturedFrame, isReusable: false);
P
Pilchie 已提交
525 526 527 528
                }
            }

            // Capture any parameters of this block.  This would typically occur
529
            // at the top level of a method or lambda with captured parameters.
P
Pilchie 已提交
530
            // TODO: speed up the following by computing it in analysis.
531
            foreach (var variable in _analysis.capturedVariables.Keys)
P
Pilchie 已提交
532 533
            {
                BoundNode varNode;
534
                if (!_analysis.variableScope.TryGetValue(variable, out varNode) || varNode != node)
P
Pilchie 已提交
535 536 537 538
                {
                    continue;
                }

539
                InitVariableProxy(syntax, variable, framePointer, prologue);
P
Pilchie 已提交
540 541
            }

542 543
            Symbol oldInnermostFramePointer = _innermostFramePointer;
            _innermostFramePointer = framePointer;
P
Pilchie 已提交
544 545
            var addedLocals = ArrayBuilder<LocalSymbol>.GetInstance();
            addedLocals.Add(framePointer);
546
            _framePointers.Add(frame, framePointer);
P
Pilchie 已提交
547 548 549

            var result = F(prologue, addedLocals);

550 551
            _framePointers.Remove(frame);
            _innermostFramePointer = oldInnermostFramePointer;
P
Pilchie 已提交
552

553
            if ((object)_innermostFramePointer != null)
P
Pilchie 已提交
554 555 556
            {
                if (oldInnermostFrameProxy != null)
                {
557
                    proxies[_innermostFramePointer] = oldInnermostFrameProxy;
P
Pilchie 已提交
558 559 560
                }
                else
                {
561
                    proxies.Remove(_innermostFramePointer);
P
Pilchie 已提交
562 563 564 565 566 567
                }
            }

            return result;
        }

568
        private void InitVariableProxy(CSharpSyntaxNode syntax, Symbol symbol, LocalSymbol framePointer, ArrayBuilder<BoundExpression> prologue)
P
Pilchie 已提交
569 570
        {
            CapturedSymbolReplacement proxy;
571
            if (proxies.TryGetValue(symbol, out proxy))
P
Pilchie 已提交
572
            {
573 574
                BoundExpression value;
                switch (symbol.Kind)
575
                {
576 577 578
                    case SymbolKind.Parameter:
                        var parameter = (ParameterSymbol)symbol;
                        ParameterSymbol parameterToUse;
579
                        if (!_parameterMap.TryGetValue(parameter, out parameterToUse))
580 581
                        {
                            parameterToUse = parameter;
582
                        }
583 584

                        value = new BoundParameter(syntax, parameterToUse);
585
                        break;
586

587
                    case SymbolKind.Local:
588
                        if (!_assignLocals)
589 590 591
                        {
                            return;
                        }
592

593 594 595 596 597 598 599 600
                        var local = (LocalSymbol)symbol;
                        LocalSymbol localToUse;
                        if (!localMap.TryGetValue(local, out localToUse))
                        {
                            localToUse = local;
                        }

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

603 604 605
                    default:
                        throw ExceptionUtilities.UnexpectedValue(symbol.Kind);
                }
P
Pilchie 已提交
606

E
Evan Hauck 已提交
607 608 609
                var left = proxy.Replacement(syntax, frameType1 => new BoundLocal(syntax, framePointer, null, framePointer.Type));
                var assignToProxy = new BoundAssignmentOperator(syntax, left, value, value.Type);
                prologue.Add(assignToProxy);
P
Pilchie 已提交
610 611 612 613 614
            }
        }

        #region Visit Methods

615 616 617
        protected override BoundNode VisitUnhoistedParameter(BoundParameter node)
        {
            ParameterSymbol replacementParameter;
618
            if (_parameterMap.TryGetValue(node.ParameterSymbol, out replacementParameter))
619 620 621 622 623 624 625
            {
                return new BoundParameter(node.Syntax, replacementParameter, replacementParameter.Type, node.HasErrors);
            }

            return base.VisitUnhoistedParameter(node);
        }

P
Pilchie 已提交
626 627 628 629 630 631 632 633 634 635 636 637
        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?

638
            return (_currentMethod == _topLevelMethod || _topLevelMethod.ThisParameter == null ?
639 640
                node :
                FramePointer(node.Syntax, (NamedTypeSymbol)node.Type));
P
Pilchie 已提交
641 642 643 644
        }

        public override BoundNode VisitBaseReference(BoundBaseReference node)
        {
645
            return (_currentMethod.ContainingType == _topLevelMethod.ContainingType)
P
Pilchie 已提交
646
                ? node
647
                : FramePointer(node.Syntax, _topLevelMethod.ContainingType); // technically, not the correct static type
P
Pilchie 已提交
648
        }
649

E
Evan Hauck 已提交
650 651 652 653 654 655 656 657
        private void RemapLambdaOrLocalFunction(
            CSharpSyntaxNode syntax,
            MethodSymbol originalMethod,
            ImmutableArray<TypeSymbol> typeArgumentsOpt,
            ClosureKind closureKind,
            ref MethodSymbol synthesizedMethod,
            out BoundExpression receiver,
            out NamedTypeSymbol constructedFrame)
E
Evan Hauck 已提交
658
        {
E
Evan Hauck 已提交
659 660
            var translatedLambdaContainer = synthesizedMethod.ContainingType;
            var containerAsFrame = translatedLambdaContainer as LambdaFrame;
661

E
Evan Hauck 已提交
662 663 664 665 666
            // All of _currentTypeParameters might not be preserved due to recursively calling upwards in the chain of local functions/lambdas
            Debug.Assert((typeArgumentsOpt.IsDefault && !originalMethod.IsGenericMethod) || (typeArgumentsOpt.Length == originalMethod.Arity));
            var totalTypeArgumentCount = translatedLambdaContainer.Arity + synthesizedMethod.Arity;
            var realTypeArguments = ImmutableArray.Create(StaticCast<TypeSymbol>.From(_currentTypeParameters), 0, totalTypeArgumentCount - originalMethod.Arity);
            if (!typeArgumentsOpt.IsDefault)
667
            {
E
Evan Hauck 已提交
668
                realTypeArguments = realTypeArguments.Concat(typeArgumentsOpt);
669 670
            }

E
Evan Hauck 已提交
671 672 673 674 675 676 677 678 679 680
            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 已提交
681 682 683

            // for instance lambdas, receiver is the frame
            // for static lambdas, get the singleton receiver
E
Evan Hauck 已提交
684
            if (closureKind != ClosureKind.Static)
E
Evan Hauck 已提交
685 686 687 688 689 690 691 692
            {
                receiver = FrameOfType(syntax, constructedFrame);
            }
            else
            {
                var field = containerAsFrame.SingletonCache.AsMember(constructedFrame);
                receiver = new BoundFieldAccess(syntax, null, field, constantValueOpt: null);
            }
693

E
Evan Hauck 已提交
694 695 696 697 698 699
            synthesizedMethod = synthesizedMethod.AsMember(constructedFrame);
            if (synthesizedMethod.IsGenericMethod)
            {
                synthesizedMethod = synthesizedMethod.Construct(StaticCast<TypeSymbol>.From(realTypeArguments));
            }
            else
E
Evan Hauck 已提交
700
            {
E
Evan Hauck 已提交
701
                Debug.Assert(realTypeArguments.Length == 0);
E
Evan Hauck 已提交
702
            }
703
        }
P
Pilchie 已提交
704

E
Evan Hauck 已提交
705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725
        private void RemapLocalFunction(
            CSharpSyntaxNode syntax, MethodSymbol symbol,
            out BoundExpression receiver, out MethodSymbol method,
            ImmutableArray<TypeSymbol> typeArguments = default(ImmutableArray<TypeSymbol>))
        {
            Debug.Assert(symbol.MethodKind == MethodKind.LocalFunction);

            var constructed = symbol as ConstructedMethodSymbol;
            if (constructed != null)
            {
                RemapLocalFunction(syntax, constructed.ConstructedFrom, out receiver, out method, this.TypeMap.SubstituteTypes(constructed.TypeArguments));
                return;
            }

            var mappedLocalFunction = _localFunctionMap[(LocalFunctionSymbol)symbol];
            method = mappedLocalFunction.Symbol;

            NamedTypeSymbol constructedFrame;
            RemapLambdaOrLocalFunction(syntax, symbol, typeArguments, mappedLocalFunction.ClosureKind, ref method, out receiver, out constructedFrame);
        }

P
Pilchie 已提交
726 727
        public override BoundNode VisitCall(BoundCall node)
        {
E
Evan Hauck 已提交
728 729 730 731 732 733 734 735
            if (node.Method.MethodKind == MethodKind.LocalFunction)
            {
                BoundExpression receiver;
                MethodSymbol method;
                RemapLocalFunction(node.Syntax, node.Method, out receiver, out method);
                node = node.Update(receiver, method, node.Arguments);
            }
            var visited = base.VisitCall(node);
P
Pilchie 已提交
736 737 738 739 740 741 742 743
            if (visited.Kind != BoundKind.Call)
            {
                return visited;
            }

            var rewritten = (BoundCall)visited;

            // Check if we need to init the 'this' proxy in a ctor call
744
            if (!_seenBaseCall)
P
Pilchie 已提交
745
            {
746 747
                _seenBaseCall = _currentMethod == _topLevelMethod && node.IsConstructorInitializer();
                if (_seenBaseCall && _thisProxyInitDeferred != null)
P
Pilchie 已提交
748 749 750 751 752 753 754
                {
                    // 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),
755
                        value: _thisProxyInitDeferred,
P
Pilchie 已提交
756 757 758 759 760 761 762 763 764
                        type: rewritten.Type);
                }
            }

            return rewritten;
        }

        private BoundSequence RewriteSequence(BoundSequence node, ArrayBuilder<BoundExpression> prologue, ArrayBuilder<LocalSymbol> newLocals)
        {
765
            RewriteLocals(node.Locals, newLocals);
P
Pilchie 已提交
766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782

            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)
        {
            LambdaFrame frame;
            // Test if this frame has captured variables and requires the introduction of a closure class.
783
            if (_frames.TryGetValue(node, out frame))
P
Pilchie 已提交
784 785 786 787 788 789 790 791 792 793
            {
                return IntroduceFrame(node, frame, (ArrayBuilder<BoundExpression> prologue, ArrayBuilder<LocalSymbol> newLocals) =>
                    RewriteBlock(node, prologue, newLocals));
            }
            else
            {
                return RewriteBlock(node, ArrayBuilder<BoundExpression>.GetInstance(), ArrayBuilder<LocalSymbol>.GetInstance());
            }
        }

794
        private BoundBlock RewriteBlock(BoundBlock node, ArrayBuilder<BoundExpression> prologue, ArrayBuilder<LocalSymbol> newLocals)
P
Pilchie 已提交
795
        {
796
            RewriteLocals(node.Locals, newLocals);
P
Pilchie 已提交
797 798 799

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

800 801 802 803 804 805 806
            if (prologue.Count > 0)
            {
                newStatements.Add(new BoundSequencePoint(null, null) { WasCompilerGenerated = true });
            }

            InsertAndFreePrologue(newStatements, prologue);

P
Pilchie 已提交
807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823
            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.
            return node.Update(newLocals.ToImmutableAndFree(), newStatements.ToImmutableAndFree());
        }

        public override BoundNode VisitCatchBlock(BoundCatchBlock node)
        {
            // Test if this frame has captured variables and requires the introduction of a closure class.
            LambdaFrame frame;
824
            if (_frames.TryGetValue(node, out frame))
P
Pilchie 已提交
825 826 827 828 829 830 831 832 833 834 835 836 837 838
            {
                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)
        {
839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860
            LocalSymbol newLocal;
            if ((object)node.LocalOpt != null && TryRewriteLocal(node.LocalOpt, out newLocal))
            {
                newLocals.Add(newLocal);
            }

            LocalSymbol rewrittenCatchLocal;

            if (newLocals.Count > 0)
            {
                // If the original LocalOpt was lifted into a closure,
                // the newLocals will contain a frame reference. In this case, 
                // instead of an actual local, catch will own the frame reference.

                Debug.Assert((object)node.LocalOpt != null && newLocals.Count == 1);
                rewrittenCatchLocal = newLocals[0];
            }
            else
            {
                Debug.Assert((object)node.LocalOpt == null);
                rewrittenCatchLocal = null;
            }
P
Pilchie 已提交
861 862 863 864 865

            // If exception variable got lifted, IntroduceFrame will give us frame init prologue.
            // It needs to run before the exception variable is accessed.
            // To ensure that, we will make exception variable a sequence that performs prologue as its its sideeffecs.
            BoundExpression rewrittenExceptionSource = null;
866
            var rewrittenFilter = (BoundExpression)this.Visit(node.ExceptionFilterOpt);
P
Pilchie 已提交
867 868 869 870 871 872 873 874 875 876 877 878 879
            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);
                }
            }
880 881 882 883 884 885 886 887 888 889
            else if (prologue.Count > 0)
            {
                Debug.Assert(rewrittenFilter != null);
                rewrittenFilter = new BoundSequence(
                    rewrittenFilter.Syntax,
                    ImmutableArray.Create<LocalSymbol>(),
                    prologue.ToImmutable(),
                    rewrittenFilter,
                    rewrittenFilter.Type);
            }
P
Pilchie 已提交
890

891
            // done with this.
892
            newLocals.Free();
P
Pilchie 已提交
893 894 895 896 897 898 899 900
            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(
901
                rewrittenCatchLocal,
P
Pilchie 已提交
902 903 904
                rewrittenExceptionSource,
                exceptionTypeOpt,
                rewrittenFilter,
905 906
                rewrittenBlock,
                node.IsSynthesizedAsyncCatchAll);
P
Pilchie 已提交
907 908 909 910 911 912
        }

        public override BoundNode VisitSequence(BoundSequence node)
        {
            LambdaFrame frame;
            // Test if this frame has captured variables and requires the introduction of a closure class.
913
            if (_frames.TryGetValue(node, out frame))
P
Pilchie 已提交
914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930
            {
                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)
        {
            LambdaFrame frame;
            // 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.
931
            if (_frames.TryGetValue(node, out frame))
P
Pilchie 已提交
932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955
            {
                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));
                    }

                    return new BoundBlock(node.Syntax, newLocals.ToImmutableAndFree(), newStatements.ToImmutableAndFree(), node.HasErrors);
                });
            }
            else
            {
                return base.VisitStatementList(node);
            }
        }

        public override BoundNode VisitSwitchStatement(BoundSwitchStatement node)
        {
            LambdaFrame frame;
            // Test if this frame has captured variables and requires the introduction of a closure class.
956
            if (_frames.TryGetValue(node, out frame))
P
Pilchie 已提交
957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982
            {
                return IntroduceFrame(node, frame, (ArrayBuilder<BoundExpression> prologue, ArrayBuilder<LocalSymbol> newLocals) =>
                {
                    var newStatements = ArrayBuilder<BoundStatement>.GetInstance();
                    InsertAndFreePrologue(newStatements, prologue);
                    newStatements.Add((BoundStatement)base.VisitSwitchStatement(node));

                    return new BoundBlock(node.Syntax, newLocals.ToImmutableAndFree(), newStatements.ToImmutableAndFree(), node.HasErrors);
                });
            }
            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);
            }
            else
            {
E
Evan Hauck 已提交
983 984 985 986 987 988 989 990
                if (node.MethodOpt?.MethodKind == MethodKind.LocalFunction)
                {
                    BoundExpression receiver;
                    MethodSymbol method;
                    RemapLocalFunction(node.Syntax, node.MethodOpt, out receiver, out method);
                    var result = new BoundDelegateCreationExpression(node.Syntax, receiver, method, isExtensionMethod: false, type: node.Type);
                    return result;
                }
P
Pilchie 已提交
991 992 993 994 995 996 997 998 999
                return base.VisitDelegateCreationExpression(node);
            }
        }

        public override BoundNode VisitConversion(BoundConversion conversion)
        {
            if (conversion.ConversionKind == ConversionKind.AnonymousFunction)
            {
                var result = (BoundExpression)RewriteLambdaConversion((BoundLambda)conversion.Operand);
1000
                return _inExpressionLambda && conversion.ExplicitCastInCode
1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013
                    ? new BoundConversion(
                        syntax: conversion.Syntax,
                        operand: result,
                        conversionKind: conversion.ConversionKind,
                        resultKind: conversion.ResultKind,
                        isBaseConversion: false,
                        symbolOpt: null,
                        @checked: false,
                        explicitCastInCode: true,
                        isExtensionMethod: false,
                        isArrayIndex: false,
                        constantValueOpt: conversion.ConstantValueOpt,
                        type: conversion.Type)
P
Pilchie 已提交
1014 1015 1016 1017
                    : result;
            }
            else
            {
E
Evan Hauck 已提交
1018
                if (conversion.ConversionKind == ConversionKind.MethodGroup && conversion.SymbolOpt?.MethodKind == MethodKind.LocalFunction)
E
Evan Hauck 已提交
1019 1020 1021 1022 1023 1024 1025
                {
                    BoundExpression receiver;
                    MethodSymbol method;
                    RemapLocalFunction(conversion.Syntax, conversion.SymbolOpt, out receiver, out method);
                    var result = new BoundDelegateCreationExpression(conversion.Syntax, receiver, method, isExtensionMethod: false, type: conversion.Type);
                    return result;
                }
P
Pilchie 已提交
1026 1027 1028 1029
                return base.VisitConversion(conversion);
            }
        }

1030 1031
        public override BoundNode VisitLocalFunctionStatement(BoundLocalFunctionStatement node)
        {
E
Evan Hauck 已提交
1032
            ClosureKind closureKind;
1033 1034
            NamedTypeSymbol translatedLambdaContainer;
            LambdaFrame containerAsFrame;
E
Evan Hauck 已提交
1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045
            BoundNode lambdaScope;
            DebugId topLevelMethodId;
            DebugId lambdaId;
            RewriteLambdaOrLocalFunction(
                node,
                out closureKind,
                out translatedLambdaContainer,
                out containerAsFrame,
                out lambdaScope,
                out topLevelMethodId,
                out lambdaId);
1046 1047 1048 1049

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

1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070
        private DebugId GetTopLevelMethodId()
        {
            return slotAllocatorOpt?.MethodId ?? new DebugId(_topLevelMethodOrdinal, CompilationState.ModuleBuilderOpt.CurrentGenerationOrdinal);
        }

        private DebugId GetClosureId(SyntaxNode syntax, ArrayBuilder<ClosureDebugInfo> closureDebugInfo)
        {
            Debug.Assert(syntax != null);

            DebugId closureId;
            DebugId previousClosureId;
            if (slotAllocatorOpt != null && slotAllocatorOpt.TryGetPreviousClosure(syntax, out previousClosureId))
            {
                closureId = previousClosureId;
            }
            else
            {
                closureId = new DebugId(closureDebugInfo.Count, CompilationState.ModuleBuilderOpt.CurrentGenerationOrdinal);
            }

            int syntaxOffset = _topLevelMethod.CalculateLocalSyntaxOffset(syntax.SpanStart, syntax.SyntaxTree);
T
Tomas Matousek 已提交
1071
            closureDebugInfo.Add(new ClosureDebugInfo(syntaxOffset, closureId));
1072 1073 1074 1075 1076

            return closureId;
        }

        private DebugId GetLambdaId(SyntaxNode syntax, ClosureKind closureKind, int closureOrdinal)
1077 1078 1079 1080 1081
        {
            Debug.Assert(syntax != null);

            SyntaxNode lambdaOrLambdaBodySyntax;
            var anonymousFunction = syntax as AnonymousFunctionExpressionSyntax;
1082
            var localFunction = syntax as LocalFunctionStatementSyntax;
1083 1084
            bool isLambdaBody;

1085 1086 1087
            if (anonymousFunction != null)
            {
                lambdaOrLambdaBodySyntax = anonymousFunction.Body;
1088
                isLambdaBody = true;
1089
            }
1090 1091 1092 1093 1094
            else if (localFunction != null)
            {
                lambdaOrLambdaBodySyntax = (SyntaxNode)localFunction.Body ?? localFunction.ExpressionBody;
                isLambdaBody = true;
            }
1095
            else if (LambdaUtilities.IsQueryPairLambda(syntax))
1096 1097 1098
            {
                // "pair" query lambdas
                lambdaOrLambdaBodySyntax = syntax;
1099
                isLambdaBody = false;
1100 1101 1102 1103 1104 1105
                Debug.Assert(closureKind == ClosureKind.Static);
            }
            else
            {
                // query lambdas
                lambdaOrLambdaBodySyntax = syntax;
1106
                isLambdaBody = true;
1107 1108
            }

1109
            Debug.Assert(!isLambdaBody || LambdaUtilities.IsLambdaBody(lambdaOrLambdaBodySyntax));
1110

1111
            // determine lambda ordinal and calculate syntax offset
1112

1113 1114 1115
            DebugId lambdaId;
            DebugId previousLambdaId;
            if (slotAllocatorOpt != null && slotAllocatorOpt.TryGetPreviousLambda(lambdaOrLambdaBodySyntax, isLambdaBody, out previousLambdaId))
1116
            {
1117
                lambdaId = previousLambdaId;
1118 1119 1120
            }
            else
            {
1121
                lambdaId = new DebugId(_lambdaDebugInfoBuilder.Count, CompilationState.ModuleBuilderOpt.CurrentGenerationOrdinal);
1122
            }
1123 1124

            int syntaxOffset = _topLevelMethod.CalculateLocalSyntaxOffset(lambdaOrLambdaBodySyntax.SpanStart, lambdaOrLambdaBodySyntax.SyntaxTree);
T
Tomas Matousek 已提交
1125
            _lambdaDebugInfoBuilder.Add(new LambdaDebugInfo(syntaxOffset, lambdaId, closureOrdinal));
1126
            return lambdaId;
1127 1128
        }

E
Evan Hauck 已提交
1129 1130 1131 1132 1133 1134 1135 1136
        private SynthesizedLambdaMethod RewriteLambdaOrLocalFunction(
            IBoundLambdaOrFunction node,
            out ClosureKind closureKind,
            out NamedTypeSymbol translatedLambdaContainer,
            out LambdaFrame containerAsFrame,
            out BoundNode lambdaScope,
            out DebugId topLevelMethodId,
            out DebugId lambdaId)
P
Pilchie 已提交
1137
        {
1138
            int closureOrdinal;
1139
            if (_analysis.lambdaScopes.TryGetValue(node.Symbol, out lambdaScope))
P
Pilchie 已提交
1140
            {
1141
                translatedLambdaContainer = containerAsFrame = _frames[lambdaScope];
1142
                closureKind = ClosureKind.General;
1143
                closureOrdinal = containerAsFrame.ClosureOrdinal;
P
Pilchie 已提交
1144
            }
1145
            else if (_analysis.capturedVariablesByLambda[node.Symbol].Count == 0)
1146
            {
1147
                translatedLambdaContainer = containerAsFrame = GetStaticFrame(Diagnostics, node);
1148
                closureKind = ClosureKind.Static;
1149
                closureOrdinal = LambdaDebugInfo.StaticClosureOrdinal;
1150
            }
P
Pilchie 已提交
1151 1152
            else
            {
1153
                containerAsFrame = null;
1154
                translatedLambdaContainer = _topLevelMethod.ContainingType;
1155
                closureKind = ClosureKind.ThisOnly;
1156
                closureOrdinal = LambdaDebugInfo.ThisOnlyClosureOrdinal;
P
Pilchie 已提交
1157 1158 1159
            }

            // Move the body of the lambda to a freshly generated synthetic method on its frame.
E
Evan Hauck 已提交
1160 1161
            topLevelMethodId = GetTopLevelMethodId();
            lambdaId = GetLambdaId(node.Syntax, closureKind, closureOrdinal);
1162

1163
            var synthesizedMethod = new SynthesizedLambdaMethod(translatedLambdaContainer, closureKind, _topLevelMethod, topLevelMethodId, node, lambdaId);
1164
            CompilationState.ModuleBuilderOpt.AddSynthesizedDefinition(translatedLambdaContainer, synthesizedMethod);
P
Pilchie 已提交
1165

1166
            foreach (var parameter in node.Symbol.Parameters)
P
Pilchie 已提交
1167
            {
1168
                _parameterMap.Add(parameter, synthesizedMethod.Parameters[parameter.Ordinal]);
P
Pilchie 已提交
1169 1170
            }

E
Evan Hauck 已提交
1171 1172
            if (node is BoundLocalFunctionStatement)
            {
E
Evan Hauck 已提交
1173
                _localFunctionMap[((BoundLocalFunctionStatement)node).Symbol] = new MappedLocalFunction(synthesizedMethod, closureKind);
E
Evan Hauck 已提交
1174 1175
            }

P
Pilchie 已提交
1176
            // rewrite the lambda body as the generated method's body
1177 1178 1179 1180 1181 1182 1183 1184 1185
            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 已提交
1186 1187 1188

            // switch to the generated method

1189
            _currentMethod = synthesizedMethod;
1190
            if (closureKind == ClosureKind.Static)
P
Pilchie 已提交
1191 1192
            {
                // no link from a static lambda to its container
1193
                _innermostFramePointer = _currentFrameThis = null;
P
Pilchie 已提交
1194 1195 1196
            }
            else
            {
1197 1198 1199
                _currentFrameThis = synthesizedMethod.ThisParameter;
                _innermostFramePointer = null;
                _framePointers.TryGetValue(translatedLambdaContainer, out _innermostFramePointer);
P
Pilchie 已提交
1200 1201
            }

E
Evan Hauck 已提交
1202 1203
            _currentTypeParameters = translatedLambdaContainer?.TypeParameters.Concat(synthesizedMethod.TypeParameters) ?? synthesizedMethod.TypeParameters;
            _currentLambdaBodyTypeMap = synthesizedMethod.TypeMap;
P
Pilchie 已提交
1204 1205 1206

            var body = AddStatementsIfNeeded((BoundStatement)VisitBlock(node.Body));
            CheckLocalsDefined(body);
T
TomasMatousek 已提交
1207
            CompilationState.AddSynthesizedMethod(synthesizedMethod, body);
P
Pilchie 已提交
1208 1209 1210

            // return to the old method

1211 1212 1213 1214 1215 1216 1217
            _currentMethod = oldMethod;
            _currentFrameThis = oldFrameThis;
            _currentTypeParameters = oldTypeParameters;
            _innermostFramePointer = oldInnermostFramePointer;
            _currentLambdaBodyTypeMap = oldTypeMap;
            _addedLocals = oldAddedLocals;
            _addedStatements = oldAddedStatements;
P
Pilchie 已提交
1218

E
Evan Hauck 已提交
1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251
            return synthesizedMethod;
        }

        private BoundNode RewriteLambdaConversion(BoundLambda node)
        {
            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);
                var result0 = wasInExpressionLambda ? node : ExpressionLambdaRewriter.RewriteLambda(node, CompilationState, TypeMap, Diagnostics);
                _inExpressionLambda = wasInExpressionLambda;
                return result0;
            }

            ClosureKind closureKind;
            NamedTypeSymbol translatedLambdaContainer;
            LambdaFrame containerAsFrame;
            BoundNode lambdaScope;
            DebugId topLevelMethodId;
            DebugId lambdaId;
            SynthesizedLambdaMethod synthesizedMethod = RewriteLambdaOrLocalFunction(
                node,
                out closureKind,
                out translatedLambdaContainer,
                out containerAsFrame,
                out lambdaScope,
                out topLevelMethodId,
                out lambdaId);

E
Evan Hauck 已提交
1252
            MethodSymbol referencedMethod = synthesizedMethod;
1253
            BoundExpression receiver;
E
Evan Hauck 已提交
1254 1255
            NamedTypeSymbol constructedFrame;
            RemapLambdaOrLocalFunction(node.Syntax, node.Symbol, default(ImmutableArray<TypeSymbol>), closureKind, ref referencedMethod, out receiver, out constructedFrame);
1256

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

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

1261 1262 1263 1264
            // static lambdas are emitted as instance methods on a singleton receiver
            // delegates invoke dispatch is optimized for instance delegates so 
            // it is preferrable to emit lambdas as instance methods even when lambdas 
            // do not capture anything
P
Pilchie 已提交
1265 1266 1267 1268
            BoundExpression result = new BoundDelegateCreationExpression(
                node.Syntax,
                receiver,
                referencedMethod,
1269
                isExtensionMethod: false,
P
Pilchie 已提交
1270 1271 1272 1273 1274
                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.
1275
            var shouldCacheForStaticMethod = closureKind == ClosureKind.Static &&
1276
                _currentMethod.MethodKind != MethodKind.StaticConstructor &&
P
Pilchie 已提交
1277 1278 1279 1280 1281
                !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 &&
1282
                lambdaScope != _analysis.scopeParent[node.Body] &&
P
Pilchie 已提交
1283 1284 1285 1286
                InLoopOrLambda(node.Syntax, lambdaScope.Syntax);

            if (shouldCacheForStaticMethod || shouldCacheInLoop)
            {
1287
                // replace the expression "new Delegate(frame.M)" with "frame.cache ?? (frame.cache = new Delegate(frame.M));
1288
                var F = new SyntheticBoundNodeFactory(_currentMethod, node.Syntax, CompilationState, Diagnostics);
P
Pilchie 已提交
1289 1290
                try
                {
T
TomasMatousek 已提交
1291
                    BoundExpression cache;
1292
                    if (shouldCacheForStaticMethod || shouldCacheInLoop && (object)containerAsFrame != null)
P
Pilchie 已提交
1293
                    {
1294 1295 1296
                        // 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.
1297
                        var cacheVariableType = containerAsFrame.TypeMap.SubstituteType(node.Type);
1298

1299
                        var cacheVariableName = GeneratedNames.MakeLambdaCacheFieldName(
1300 1301
                            // 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.
1302 1303
                            (closureKind == ClosureKind.General) ? -1 : topLevelMethodId.Ordinal,
                            topLevelMethodId.Generation,
1304 1305
                            lambdaId.Ordinal,
                            lambdaId.Generation);
1306

1307
                        var cacheField = new SynthesizedLambdaCacheFieldSymbol(translatedLambdaContainer, cacheVariableType, cacheVariableName, _topLevelMethod, isReadOnly: false, isStatic: closureKind == ClosureKind.Static);
T
TomasMatousek 已提交
1308
                        CompilationState.ModuleBuilderOpt.AddSynthesizedDefinition(translatedLambdaContainer, cacheField);
T
TomasMatousek 已提交
1309
                        cache = F.Field(receiver, cacheField.AsMember(constructedFrame)); //NOTE: the field was added to the unconstructed frame type.
P
Pilchie 已提交
1310 1311 1312 1313
                    }
                    else
                    {
                        // the lambda captures at most the "this" of the enclosing method.  We cache its delegate in a local variable.
1314
                        var cacheLocal = F.SynthesizedLocal(type, kind: SynthesizedLocalKind.CachedAnonymousMethodDelegate);
1315 1316 1317
                        if (_addedLocals == null) _addedLocals = ArrayBuilder<LocalSymbol>.GetInstance();
                        _addedLocals.Add(cacheLocal);
                        if (_addedStatements == null) _addedStatements = ArrayBuilder<BoundStatement>.GetInstance();
T
TomasMatousek 已提交
1318
                        cache = F.Local(cacheLocal);
1319
                        _addedStatements.Add(F.Assignment(cache, F.Null(type)));
P
Pilchie 已提交
1320 1321
                    }

T
TomasMatousek 已提交
1322
                    result = F.Coalesce(cache, F.AssignmentExpression(cache, result));
P
Pilchie 已提交
1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365
                }
                catch (SyntheticBoundNodeFactory.MissingPredefinedMember ex)
                {
                    Diagnostics.Add(ex.Diagnostic);
                    return new BoundBadExpression(F.Syntax, LookupResultKind.Empty, ImmutableArray<Symbol>.Empty, ImmutableArray.Create<BoundNode>(node), node.Type);
                }
            }

            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)
            {
1366
                switch (curSyntax.Kind())
P
Pilchie 已提交
1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388
                {
                    case SyntaxKind.ForStatement:
                    case SyntaxKind.ForEachStatement:
                    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 已提交
1389
        #endregion
P
Pilchie 已提交
1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479

#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
    }
}