Welcome to mirror list, hosted at ThFree Co, Russian Federation.

ISymbolNode.cs « DependencyAnalysis « Compiler « src « ILCompiler.Compiler « src - github.com/mono/corert.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
blob: feca8b45e2fe62925247fc84840e1b9c0385395a (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
// Licensed to the .NET Foundation under one or more agreements.
// The .NET Foundation licenses this file to you under the MIT license.
// See the LICENSE file in the project root for more information.

using System;
using ILCompiler.DependencyAnalysisFramework;
using Internal.Text;

namespace ILCompiler.DependencyAnalysis
{
    /// <summary>
    /// Represents a reference to a symbol. The reference can potentially be offset by a value.
    /// </summary>
    public interface ISymbolNode : IDependencyNode<NodeFactory>
    {
        /// <summary>
        /// Appends the mangled name of the symbol to the string builder provided.
        /// </summary>
        void AppendMangledName(NameMangler nameMangler, Utf8StringBuilder sb);

        /// <summary>
        /// Gets the offset (delta) from the symbol this <see cref="ISymbolNode"/> references.
        /// </summary>
        int Offset { get; }

        /// <summary>
        /// Set the return value of this property to true to indicate that this symbol
        /// is an indirection cell to data that is needed, not the actual data itself.
        /// Most commonly affects the code generation which accesses symbols such
        /// Types which may require an indirection to access or not.
        /// </summary>
        bool RepresentsIndirectionCell { get; }
    }

    /// <summary>
    /// Represents a symbol backed by a different symbol for object emission purposes.
    /// </summary>
    public interface ISymbolNodeWithLinkage : ISymbolNode
    {
        /// <summary>
        /// Return a node that is used for linkage
        /// </summary>
        ISymbolNode NodeForLinkage(NodeFactory factory);
    }

    public interface ISortableSymbolNode : ISymbolNode, ISortableNode
    {
    }


    /// <summary>
    /// Represents a definition of a symbol within an <see cref="ObjectNode"/>. The symbol will be defined
    /// at the specified offset from the beginning of the <see cref="ObjectNode"/> that reports this as one of
    /// the symbols it defines.
    /// </summary>
    public interface ISymbolDefinitionNode : ISymbolNode
    {
        /// <summary>
        /// Gets the offset (delta) from the beginning of the <see cref="ObjectNode"/> where this symbol should
        /// be defined. Note this is different from <see cref="ISymbolNode.Offset"/>, which is the offset to be
        /// used when referencing the symbol.
        /// </summary>
        /// <remarks>
        /// Most node types will want to implement both <see cref="ISymbolNode.Offset"/> and <see cref="Offset"/>
        /// to return 0. The name was chosen to make this convenient. If an object node implements this interface,
        /// it will pretty much always want to either implement both as returning 0, or *one of them* to return
        /// a non-zero value.
        /// Some examples: an EEType node defines the symbol of the EEType in the middle of the object node,
        /// since EETypes are prefixed by a GCDesc structure (that is not considered the beginning of the EEType).
        /// This means that <see cref="Offset"/> will return a non-zero value. When referencing the EEType by its
        /// symbol, the GCDesc was already accounted for when the symbol was defined, so we want the
        /// <see cref="ISymbolNode.Offset"/> to be zero.
        /// </remarks>
        new int Offset { get; }
    }

    public static class ISymbolNodeExtensions
    {
        [ThreadStatic]
        static Utf8StringBuilder s_cachedUtf8StringBuilder;

        public static string GetMangledName(this ISymbolNode symbolNode, NameMangler nameMangler)
        {
            Utf8StringBuilder sb = s_cachedUtf8StringBuilder;
            if (sb == null)
                sb = new Utf8StringBuilder();

            symbolNode.AppendMangledName(nameMangler, sb);
            string ret = sb.ToString();

            sb.Clear();
            s_cachedUtf8StringBuilder = sb;

            return ret;
        }
    }
}