Improve performance of Activator.CreateInstance #32520
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,142 @@ | ||
| // Licensed to the .NET Foundation under one or more agreements. | ||
| // The .NET Foundation licenses this file to you under the MIT license. | ||
|
|
||
| using System.Diagnostics; | ||
| using System.Diagnostics.CodeAnalysis; | ||
| using System.Runtime.CompilerServices; | ||
|
|
||
| namespace System | ||
| { | ||
| internal sealed partial class RuntimeType | ||
| { | ||
| /// <summary> | ||
| /// A cache which allows optimizing <see cref="Activator.CreateInstance"/>, | ||
| /// <see cref="RuntimeType.CreateInstanceDefaultCtor"/>, and related APIs. | ||
| /// </summary> | ||
| private sealed unsafe class ActivatorCache | ||
| { | ||
| // The managed calli to the newobj allocator, plus its first argument (MethodTable*). | ||
| // In the case of the COM allocator, first arg is ComClassFactory*, not MethodTable*. | ||
| private readonly delegate*<void*, object?> _pfnAllocator; | ||
| private readonly void* _allocatorFirstArg; | ||
|
|
||
| // The managed calli to the parameterless ctor, taking "this" (as object) as its first argument. | ||
| private readonly delegate*<object?, void> _pfnCtor; | ||
| private readonly bool _ctorIsPublic; | ||
|
|
||
| #if DEBUG | ||
| private readonly RuntimeType _originalRuntimeType; | ||
| #endif | ||
|
|
||
| internal ActivatorCache(RuntimeType rt) | ||
| { | ||
| Debug.Assert(rt != null); | ||
|
|
||
| #if DEBUG | ||
| _originalRuntimeType = rt; | ||
| #endif | ||
|
|
||
| // The check below is redundant since these same checks are performed at the | ||
| // unmanaged layer, but this call will throw slightly different exceptions | ||
| // than the unmanaged layer, and callers might be dependent on this. | ||
|
|
||
| rt.CreateInstanceCheckThis(); | ||
|
|
||
| try | ||
| { | ||
| RuntimeTypeHandle.GetActivationInfo(rt, | ||
| out _pfnAllocator!, out _allocatorFirstArg, | ||
| out _pfnCtor!, out _ctorIsPublic); | ||
| } | ||
| catch (Exception ex) | ||
| { | ||
| // Exception messages coming from the runtime won't include | ||
| // the type name. Let's include it here to improve the | ||
| // debugging experience for our callers. | ||
|
|
||
| string friendlyMessage = SR.Format(SR.Activator_CannotCreateInstance, rt, ex.Message); | ||
| switch (ex) | ||
| { | ||
| case ArgumentException: throw new ArgumentException(friendlyMessage); | ||
| case PlatformNotSupportedException: throw new PlatformNotSupportedException(friendlyMessage); | ||
| case NotSupportedException: throw new NotSupportedException(friendlyMessage); | ||
| case MethodAccessException: throw new MethodAccessException(friendlyMessage); | ||
| case MissingMethodException: throw new MissingMethodException(friendlyMessage); | ||
| case MemberAccessException: throw new MemberAccessException(friendlyMessage); | ||
| } | ||
|
|
||
| throw; // can't make a friendlier message, rethrow original exception | ||
| } | ||
|
|
||
| // Activator.CreateInstance returns null given typeof(Nullable<T>). | ||
|
|
||
| if (_pfnAllocator == null) | ||
| { | ||
| Debug.Assert(Nullable.GetUnderlyingType(rt) != null, | ||
| "Null allocator should only be returned for Nullable<T>."); | ||
|
|
||
| static object? ReturnNull(void* _) => null; | ||
| _pfnAllocator = &ReturnNull; | ||
| } | ||
|
|
||
| // If no ctor is provided, we have Nullable<T>, a ctorless value type T, | ||
| // or a ctorless __ComObject. In any case, we should replace the | ||
| // ctor call with our no-op stub. The unmanaged GetActivationInfo layer | ||
| // would have thrown an exception if 'rt' were a normal reference type | ||
| // without a ctor. | ||
|
|
||
| if (_pfnCtor == null) | ||
| { | ||
| static void CtorNoopStub(object? uninitializedObject) { } | ||
| _pfnCtor = &CtorNoopStub; // we use null singleton pattern if no ctor call is necessary | ||
|
|
||
| Debug.Assert(_ctorIsPublic); // implicit parameterless ctor is always considered public | ||
| } | ||
|
|
||
| // We don't need to worry about invoking cctors here. The runtime will figure it | ||
| // out for us when the instance ctor is called. For value types, because we're | ||
| // creating a boxed default(T), the static cctor is called when *any* instance | ||
| // method is invoked. | ||
| } | ||
|
|
||
| internal bool CtorIsPublic => _ctorIsPublic; | ||
|
|
||
| [MethodImpl(MethodImplOptions.AggressiveInlining)] | ||
| internal object? CreateUninitializedObject(RuntimeType rt) | ||
| { | ||
| // We don't use RuntimeType, but we force the caller to pass it so | ||
| // that we can keep it alive on their behalf. Once the object is | ||
| // constructed, we no longer need the reference to the type instance, | ||
| // as the object itself will keep the type alive. | ||
|
|
||
| #if DEBUG | ||
| if (_originalRuntimeType != rt) | ||
| { | ||
| Debug.Fail("Caller passed the wrong RuntimeType to this routine." | ||
| + Environment.NewLineConst + "Expected: " + (_originalRuntimeType ?? (object)"<null>") | ||
| + Environment.NewLineConst + "Actual: " + (rt ?? (object)"<null>")); | ||
| } | ||
| #endif | ||
|
|
||
| object? retVal = _pfnAllocator(_allocatorFirstArg); | ||
| GC.KeepAlive(rt); | ||
| return retVal; | ||
| } | ||
|
|
||
| [MethodImpl(MethodImplOptions.AggressiveInlining)] | ||
| internal void CallConstructor(object? uninitializedObject) | ||
| { | ||
| #if DEBUG | ||
| if (uninitializedObject != null && !uninitializedObject.GetType().IsEquivalentTo(_originalRuntimeType)) | ||
| { | ||
| Debug.Fail("Caller passed an unexpected 'this' parameter to ctor - possible type safety violation." | ||
| + Environment.NewLineConst + "Expected type: " + (_originalRuntimeType ?? (object)"<null>") | ||
| + Environment.NewLineConst + "Actual type: " + uninitializedObject.GetType()); | ||
| } | ||
| #endif | ||
|
|
||
| _pfnCtor(uninitializedObject); | ||
| } | ||
| } | ||
| } | ||
| } | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Is this better than, say:
? I realize the above is probably a bit more IL, but it also means you won't catch and rethrow if the exception didn't match one of the special-cased types. I don't know how common that will be.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Not ignoring this, but leaving this thread marked unresolved for now because I think we can address it as part of #36194.