summaryrefslogtreecommitdiff
path: root/src/vm/typekey.h
blob: 0d58254d83e84dea9c1d531959b138a8a1d7298d (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
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
// 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.
//
// typekey.h
//

// ---------------------------------------------------------------------------
//
// Support for type lookups based on components of the type (as opposed to string)
// Used in
// * Table of constructed types (Module::m_pAvailableParamTypes)
// * Types currently being loaded (ClassLoader::m_pUnresolvedClassHash)
//
// Type handles are in one-to-one correspondence with TypeKeys
// In particular, note that tokens in the key are resolved TypeDefs
//
// ---------------------------------------------------------------------------


#ifndef _H_TYPEKEY
#define _H_TYPEKEY

class TypeKey
{
    // ELEMENT_TYPE_CLASS for ordinary classes and generic instantiations (including value types)
    // ELEMENT_TYPE_ARRAY and ELEMENT_TYPE_SZARRAY for array types
    // ELEMENT_TYPE_PTR and ELEMENT_TYPE_BYREF for pointer types
    // ELEMENT_TYPE_FNPTR for function pointer types
    // ELEMENT_TYPE_VALUETYPE for native value types (used in IL stubs)
    CorElementType m_kind;

    union 
    {
        // m_kind = CLASS 
        struct 
        {
            Module *       m_pModule;
            mdToken        m_typeDef;
            DWORD          m_numGenericArgs; // 0 for non-generic types
            FixupPointer<TypeHandle> * m_pGenericArgs;   // NULL for non-generic types 
            // Note that for DAC builds, m_pGenericArgs is a host allocated buffer (eg. by in SigPointer::GetTypeHandleThrowing), 
            // not a copy of an object marshalled by DAC.
        } asClass;

        // m_kind = ARRAY, SZARRAY, PTR or BYREF
        struct 
        {
            TADDR m_paramType;   // The element type (actually a TypeHandle, but we don't want its constructor
                                 // run on a C++ union)
            DWORD m_rank;        // Non-zero for ARRAY, 1 for SZARRAY, 0 for PTR or BYREF
            BOOL m_isTemplateMethodTable; // TRUE if this key indexes the template method table for an array, rather than a type-desc
        } asParamType;

        // m_kind = FNPTR
        struct 
        {
            BYTE m_callConv;
            DWORD m_numArgs;
            TypeHandle* m_pRetAndArgTypes;
        } asFnPtr;
    } u; 

public:

    // Constructor for BYREF/PTR/ARRAY/SZARRAY types
    TypeKey(CorElementType etype, TypeHandle paramType, BOOL isTemplateMethodTable = FALSE, DWORD rank = 0)
    {
        WRAPPER_NO_CONTRACT;
        SUPPORTS_DAC;
        PRECONDITION(rank > 0 && etype == ELEMENT_TYPE_ARRAY || 
                     rank == 1 && etype == ELEMENT_TYPE_SZARRAY ||
                     rank == 0 && (etype == ELEMENT_TYPE_PTR || etype == ELEMENT_TYPE_BYREF || etype == ELEMENT_TYPE_VALUETYPE));
        PRECONDITION(CheckPointer(paramType));
        m_kind = etype;
        u.asParamType.m_paramType = paramType.AsTAddr();
        u.asParamType.m_rank = rank;
        u.asParamType.m_isTemplateMethodTable = isTemplateMethodTable;
    }

    // Constructor for instantiated types
    TypeKey(Module *pModule, mdTypeDef token, Instantiation inst = Instantiation())
    {
        WRAPPER_NO_CONTRACT;
        PRECONDITION(CheckPointer(pModule));
        PRECONDITION(TypeFromToken(token) == mdtTypeDef);
        PRECONDITION(!IsNilToken(token));
        m_kind = ELEMENT_TYPE_CLASS;
        u.asClass.m_pModule = pModule;
        u.asClass.m_typeDef = token;
        u.asClass.m_numGenericArgs = inst.GetNumArgs();
        u.asClass.m_pGenericArgs = inst.GetRawArgs();
    }
    
    // Constructor for function pointer type
    TypeKey(BYTE callConv, DWORD numArgs, TypeHandle* retAndArgTypes)
    {
        WRAPPER_NO_CONTRACT;
        PRECONDITION(CheckPointer(retAndArgTypes));
        m_kind = ELEMENT_TYPE_FNPTR;
        u.asFnPtr.m_callConv = callConv;
        u.asFnPtr.m_numArgs = numArgs;
        u.asFnPtr.m_pRetAndArgTypes = retAndArgTypes;
    }

    CorElementType GetKind() const
    {
        LIMITED_METHOD_CONTRACT;
        SUPPORTS_DAC;
        return m_kind;
    }

    // Accessors on array/pointer types
    DWORD GetRank() const
    {
        LIMITED_METHOD_CONTRACT;
        SUPPORTS_DAC;
        PRECONDITION(CorTypeInfo::IsArray_NoThrow(m_kind));
        return u.asParamType.m_rank;
    }

    BOOL IsTemplateMethodTable() const
    {
        LIMITED_METHOD_CONTRACT;
        SUPPORTS_DAC;
        return u.asParamType.m_isTemplateMethodTable;
    }

    TypeHandle GetElementType() const
    {
        WRAPPER_NO_CONTRACT;
        SUPPORTS_DAC;
        PRECONDITION(CorTypeInfo::IsModifier_NoThrow(m_kind) || m_kind == ELEMENT_TYPE_VALUETYPE);
        return TypeHandle::FromTAddr(u.asParamType.m_paramType);
    }

    BOOL IsConstructed() const
    {
        LIMITED_METHOD_CONTRACT;
        SUPPORTS_DAC;
        return !(m_kind == ELEMENT_TYPE_CLASS && u.asClass.m_numGenericArgs == 0);
    }

    // Accessors on instantiated types
    PTR_Module GetModule() const
    {
        CONTRACTL
        {
            NOTHROW;
            GC_NOTRIGGER;
            SO_TOLERANT;
            MODE_ANY;
            SUPPORTS_DAC;
        }
        CONTRACTL_END;
        if (m_kind == ELEMENT_TYPE_CLASS)
            return PTR_Module(u.asClass.m_pModule);
        else if (CorTypeInfo::IsModifier_NoThrow(m_kind) || m_kind == ELEMENT_TYPE_VALUETYPE)
            return GetElementType().GetModule();
        else
            return NULL;
    }

    mdTypeDef GetTypeToken() const
    {
        LIMITED_METHOD_CONTRACT;
        SUPPORTS_DAC;
        PRECONDITION(m_kind == ELEMENT_TYPE_CLASS);
        return u.asClass.m_typeDef;
    }

    // Get the type parameters for this CLASS type.
    // This is an array (host-allocated in DAC builds) of length GetNumGenericArgs().
    Instantiation GetInstantiation() const
    {
        LIMITED_METHOD_CONTRACT;
        SUPPORTS_DAC;
        PRECONDITION(m_kind == ELEMENT_TYPE_CLASS);
        return Instantiation(u.asClass.m_pGenericArgs, u.asClass.m_numGenericArgs);
    }

    DWORD GetNumGenericArgs() const
    {
        LIMITED_METHOD_CONTRACT;
        SUPPORTS_DAC;
        PRECONDITION(m_kind == ELEMENT_TYPE_CLASS);
        return u.asClass.m_numGenericArgs;
    }

    BOOL HasInstantiation() const
    {
        LIMITED_METHOD_CONTRACT;
        return m_kind == ELEMENT_TYPE_CLASS && u.asClass.m_numGenericArgs != 0;
    }

    // Accessors on function pointer types
    DWORD GetNumArgs() const
    {
        LIMITED_METHOD_CONTRACT;
        SUPPORTS_DAC;
        PRECONDITION(m_kind == ELEMENT_TYPE_FNPTR);
        return u.asFnPtr.m_numArgs;
    }
        
    BYTE GetCallConv() const
    {
        LIMITED_METHOD_CONTRACT;
        SUPPORTS_DAC;
        PRECONDITION(m_kind == ELEMENT_TYPE_FNPTR);
        return u.asFnPtr.m_callConv;
    }
        
    TypeHandle* GetRetAndArgTypes() const
    {
        LIMITED_METHOD_CONTRACT;
        SUPPORTS_DAC;
        PRECONDITION(m_kind == ELEMENT_TYPE_FNPTR);
        return u.asFnPtr.m_pRetAndArgTypes;
    }       

    BOOL Equals(TypeKey *pKey) const
    {
        WRAPPER_NO_CONTRACT;
        return TypeKey::Equals(this, pKey);
    }

    // Comparison and hashing
    static BOOL Equals(const TypeKey *pKey1, const TypeKey *pKey2) 
    {
        WRAPPER_NO_CONTRACT;
        if (pKey1->m_kind != pKey2->m_kind)
        {
            return FALSE;
        }
        if (pKey1->m_kind == ELEMENT_TYPE_CLASS)
        {
            if (pKey1->u.asClass.m_typeDef != pKey2->u.asClass.m_typeDef ||
                pKey1->u.asClass.m_pModule != pKey2->u.asClass.m_pModule ||
                pKey1->u.asClass.m_numGenericArgs != pKey2->u.asClass.m_numGenericArgs)
            {
                return FALSE;
            }
            for (DWORD i = 0; i < pKey1->u.asClass.m_numGenericArgs; i++)
            {
                if (pKey1->u.asClass.m_pGenericArgs[i].GetValue() != pKey2->u.asClass.m_pGenericArgs[i].GetValue())
                    return FALSE;
            }
            return TRUE;
        }
        else if (CorTypeInfo::IsModifier_NoThrow(pKey1->m_kind) || pKey1->m_kind == ELEMENT_TYPE_VALUETYPE)
        {
            return pKey1->u.asParamType.m_paramType == pKey2->u.asParamType.m_paramType
                && pKey1->u.asParamType.m_rank == pKey2->u.asParamType.m_rank
                && pKey1->u.asParamType.m_isTemplateMethodTable == pKey2->u.asParamType.m_isTemplateMethodTable;
        }
        else
        {
            _ASSERTE(pKey1->m_kind == ELEMENT_TYPE_FNPTR);
            if (pKey1->u.asFnPtr.m_callConv != pKey2->u.asFnPtr.m_callConv ||
                pKey1->u.asFnPtr.m_numArgs != pKey2->u.asFnPtr.m_numArgs)
                return FALSE;
            
            // Includes return type
            for (DWORD i = 0; i <= pKey1->u.asFnPtr.m_numArgs; i++)
            {
                if (pKey1->u.asFnPtr.m_pRetAndArgTypes[i] != pKey2->u.asFnPtr.m_pRetAndArgTypes[i])
                    return FALSE;
            }
            return TRUE;
        }
    }

    DWORD ComputeHash() const
    {
        LIMITED_METHOD_CONTRACT;
        DWORD_PTR hashLarge;

        if (m_kind == ELEMENT_TYPE_CLASS)
        {
            hashLarge = ((DWORD_PTR)u.asClass.m_pModule ^ (DWORD_PTR)u.asClass.m_numGenericArgs ^ (DWORD_PTR)u.asClass.m_typeDef);
        }
        else if (CorTypeInfo::IsModifier_NoThrow(m_kind) || m_kind == ELEMENT_TYPE_VALUETYPE)
        {
            hashLarge = (u.asParamType.m_paramType ^ (DWORD_PTR) u.asParamType.m_rank);
        }
        else hashLarge = 0;

#if POINTER_BITS == 32
        return hashLarge;
#else
        DWORD hash = *(DWORD *)&hashLarge;
        for (unsigned i = 1; i < POINTER_BITS / 32; i++)
        {
            hash ^= ((DWORD *)&hashLarge)[i];
        }
        return hash;
#endif
    }

    // Is this type part of an assembly loaded for introspection?
    BOOL IsIntrospectionOnly();


};


#endif /* _H_TYPEKEY */