#region Copyright notice and license
// Protocol Buffers - Google's data interchange format
// Copyright 2008 Google Inc. All rights reserved.
//
// Use of this source code is governed by a BSD-style
// license that can be found in the LICENSE file or at
// https://developers.google.com/open-source/licenses/bsd
#endregion
using System;
using System.Diagnostics.CodeAnalysis;
using System.Reflection;
using System.Runtime.CompilerServices;
using Google.Protobuf.Compatibility;
namespace Google.Protobuf.Reflection {
///
/// The methods in this class are somewhat evil, and should not be tampered with lightly.
/// Basically they allow the creation of relatively weakly typed delegates from MethodInfos
/// which are more strongly typed. They do this by creating an appropriate strongly typed
/// delegate from the MethodInfo, and then calling that within an anonymous method.
/// Mind-bending stuff (at least to your humble narrator) but the resulting delegates are
/// very fast compared with calling Invoke later on.
///
internal static class ReflectionUtil {
static ReflectionUtil() {
ForceInitialize(); // Handles all reference types
ForceInitialize();
ForceInitialize();
ForceInitialize();
ForceInitialize();
ForceInitialize();
ForceInitialize();
ForceInitialize();
ForceInitialize < int ? > ();
ForceInitialize < long ? > ();
ForceInitialize < uint ? > ();
ForceInitialize < ulong ? > ();
ForceInitialize < float ? > ();
ForceInitialize < double ? > ();
ForceInitialize < bool ? > ();
ForceInitialize();
SampleEnumMethod();
}
internal static void ForceInitialize() => new ReflectionHelper();
///
/// Empty Type[] used when calling GetProperty to force property instead of indexer fetching.
///
internal static readonly Type[] EmptyTypes = new Type[0];
///
/// Creates a delegate which will cast the argument to the type that declares the method,
/// call the method on it, then convert the result to object.
///
/// The method to create a delegate for, which must be declared in an
/// IMessage implementation.
internal static Func CreateFuncIMessageObject(MethodInfo method) =>
GetReflectionHelper(method.DeclaringType, method.ReturnType)
.CreateFuncIMessageObject(method);
///
/// Creates a delegate which will cast the argument to the type that declares the method,
/// call the method on it, then convert the result to the specified type. The method is expected
/// to actually return an enum (because of where we're calling it - for oneof cases). Sometimes
/// that means we need some extra work to perform conversions.
///
/// The method to create a delegate for, which must be declared in an
/// IMessage implementation.
internal static Func CreateFuncIMessageInt32(MethodInfo method) =>
GetReflectionHelper(method.DeclaringType, method.ReturnType)
.CreateFuncIMessageInt32(method);
///
/// Creates a delegate which will execute the given method after casting the first argument to
/// the type that declares the method, and the second argument to the first parameter type of
/// the method.
///
/// The method to create a delegate for, which must be declared in an
/// IMessage implementation.
internal static Action CreateActionIMessageObject(MethodInfo method) =>
GetReflectionHelper(method.DeclaringType, method.GetParameters()[0].ParameterType)
.CreateActionIMessageObject(method);
///
/// Creates a delegate which will execute the given method after casting the first argument to
/// type that declares the method.
///
/// The method to create a delegate for, which must be declared in an
/// IMessage implementation.
internal static Action CreateActionIMessage(MethodInfo method) =>
GetReflectionHelper(method.DeclaringType, typeof(object)).CreateActionIMessage(method);
internal static Func CreateFuncIMessageBool(MethodInfo method) =>
GetReflectionHelper(method.DeclaringType, method.ReturnType).CreateFuncIMessageBool(method);
[UnconditionalSuppressMessage(
"Trimming", "IL2026",
Justification =
"Type parameter members are preserved with DynamicallyAccessedMembers on GeneratedClrTypeInfo.ctor clrType parameter.")]
[UnconditionalSuppressMessage(
"AotAnalysis", "IL3050:RequiresDynamicCode",
Justification =
"Type definition is explicitly specified and type argument is always a message type.")]
internal static Func CreateIsInitializedCaller([
DynamicallyAccessedMembers(GeneratedClrTypeInfo.MessageAccessibility)
] Type msg) => ((IExtensionSetReflector)Activator
.CreateInstance(typeof(ExtensionSetReflector<>).MakeGenericType(msg)))
.CreateIsInitializedCaller();
///
/// Creates a delegate which will execute the given method after casting the first argument to
/// the type that declares the method, and the second argument to the first parameter type of
/// the method.
///
[UnconditionalSuppressMessage(
"Trimming", "IL2026",
Justification =
"Type parameter members are preserved with DynamicallyAccessedMembers on GeneratedClrTypeInfo.ctor clrType parameter.")]
[UnconditionalSuppressMessage("AOT", "IL3050",
Justification = "Dynamic code won't call Type.MakeGenericType.")]
internal static IExtensionReflectionHelper CreateExtensionHelper(Extension extension) {
#if NET5_0_OR_GREATER
if (!RuntimeFeature.IsDynamicCodeSupported) {
// Using extensions with reflection is not supported with AOT.
// This helper is created when descriptors are populated. Delay throwing error until an app
// uses IFieldAccessor with an extension field.
return new AotExtensionReflectionHelper();
}
#endif
var t1 = extension.TargetType;
var t3 = extension.GetType().GenericTypeArguments[1];
return (IExtensionReflectionHelper)Activator.CreateInstance(
typeof(ExtensionReflectionHelper<, >).MakeGenericType(t1, t3), extension);
}
///
/// Creates a reflection helper for the given type arguments. Currently these are created on
/// demand rather than cached; this will be "busy" when initially loading a message's
/// descriptor, but after that they can be garbage collected. We could cache them by type if
/// that proves to be important, but creating an object is pretty cheap.
///
[UnconditionalSuppressMessage(
"Trimming", "IL2026",
Justification =
"Type parameter members are preserved with DynamicallyAccessedMembers on GeneratedClrTypeInfo.ctor clrType parameter.")]
[UnconditionalSuppressMessage("AOT", "IL3050",
Justification = "Dynamic code won't call Type.MakeGenericType.")]
private static IReflectionHelper GetReflectionHelper(Type t1, Type t2) {
#if NET5_0_OR_GREATER
if (!RuntimeFeature.IsDynamicCodeSupported) {
return new AotReflectionHelper();
}
#endif
return (IReflectionHelper)Activator.CreateInstance(
typeof(ReflectionHelper<, >).MakeGenericType(t1, t2));
}
// Non-generic interface allowing us to use an instance of ReflectionHelper without
// statically knowing the types involved.
private interface IReflectionHelper {
Func CreateFuncIMessageInt32(MethodInfo method);
Action CreateActionIMessage(MethodInfo method);
Func CreateFuncIMessageObject(MethodInfo method);
Action CreateActionIMessageObject(MethodInfo method);
Func CreateFuncIMessageBool(MethodInfo method);
}
internal interface IExtensionReflectionHelper {
object GetExtension(IMessage message);
void SetExtension(IMessage message, object value);
bool HasExtension(IMessage message);
void ClearExtension(IMessage message);
}
private interface IExtensionSetReflector {
Func CreateIsInitializedCaller();
}
private sealed class ReflectionHelper : IReflectionHelper {
public Func CreateFuncIMessageInt32(MethodInfo method) {
// On pleasant runtimes, we can create a Func from a method returning
// an enum based on an int. That's the fast path.
if (CanConvertEnumFuncToInt32Func) {
var del = (Func)method.CreateDelegate(typeof(Func));
return message => del((T1)message);
} else {
// On some runtimes (e.g. old Mono) the return type has to be exactly correct,
// so we go via boxing. Reflection is already fairly inefficient, and this is
// only used for one-of case checking, fortunately.
var del = (Func)method.CreateDelegate(typeof(Func));
return message => (int)(object)del((T1)message);
}
}
public Action CreateActionIMessage(MethodInfo method) {
var del = (Action)method.CreateDelegate(typeof(Action));
return message => del((T1)message);
}
public Func CreateFuncIMessageObject(MethodInfo method) {
var del = (Func)method.CreateDelegate(typeof(Func));
return message => del((T1)message);
}
public Action CreateActionIMessageObject(MethodInfo method) {
var del = (Action)method.CreateDelegate(typeof(Action));
return (message, arg) => del((T1)message, (T2)arg);
}
public Func CreateFuncIMessageBool(MethodInfo method) {
var del = (Func)method.CreateDelegate(typeof(Func));
return message => del((T1)message);
}
}
private sealed class ExtensionReflectionHelper : IExtensionReflectionHelper
where T1 : IExtendableMessage {
private readonly Extension extension;
public ExtensionReflectionHelper(Extension extension) {
this.extension = extension;
}
public object GetExtension(IMessage message) {
if (message is not T1 extensionMessage) {
throw new InvalidCastException(
"Cannot access extension on message that isn't IExtensionMessage");
}
if (extension is Extension ext13) {
return extensionMessage.GetExtension(ext13);
} else if (extension is RepeatedExtension repeatedExt13) {
return extensionMessage.GetOrInitializeExtension(repeatedExt13);
} else {
throw new InvalidCastException(
"The provided extension is not a valid extension identifier type");
}
}
public bool HasExtension(IMessage message) {
if (message is not T1 extensionMessage) {
throw new InvalidCastException(
"Cannot access extension on message that isn't IExtensionMessage");
}
if (extension is Extension ext13) {
return extensionMessage.HasExtension(ext13);
} else if (extension is RepeatedExtension) {
throw new InvalidOperationException(
"HasValue is not implemented for repeated extensions");
} else {
throw new InvalidCastException(
"The provided extension is not a valid extension identifier type");
}
}
public void SetExtension(IMessage message, object value) {
if (message is not T1 extensionMessage) {
throw new InvalidCastException(
"Cannot access extension on message that isn't IExtensionMessage");
}
if (extension is Extension ext13) {
extensionMessage.SetExtension(ext13, (T3)value);
} else if (extension is RepeatedExtension) {
throw new InvalidOperationException(
"SetValue is not implemented for repeated extensions");
} else {
throw new InvalidCastException(
"The provided extension is not a valid extension identifier type");
}
}
public void ClearExtension(IMessage message) {
if (message is not T1 extensionMessage) {
throw new InvalidCastException(
"Cannot access extension on message that isn't IExtensionMessage");
}
if (extension is Extension ext13) {
extensionMessage.ClearExtension(ext13);
} else if (extension is RepeatedExtension repeatedExt13) {
extensionMessage.GetExtension(repeatedExt13).Clear();
} else {
throw new InvalidCastException(
"The provided extension is not a valid extension identifier type");
}
}
}
#if NET5_0_OR_GREATER
///
/// This helper is compatible with .NET Native AOT.
/// MakeGenericType doesn't work when a type argument is a value type in AOT.
/// MethodInfo.Invoke is used instead of compiled expressions because it's faster in AOT.
///
private sealed class AotReflectionHelper : IReflectionHelper {
private static readonly object[] EmptyObjectArray = new object[0];
public Action CreateActionIMessage(MethodInfo method) => message =>
method.Invoke(message, EmptyObjectArray);
public Action CreateActionIMessageObject(MethodInfo method) =>
(message, arg) => method.Invoke(message, new object[] { arg });
public Func CreateFuncIMessageBool(MethodInfo method) => message =>
(bool)method.Invoke(message, EmptyObjectArray);
public Func CreateFuncIMessageInt32(MethodInfo method) => message =>
(int)method.Invoke(message, EmptyObjectArray);
public Func CreateFuncIMessageObject(MethodInfo method) => message =>
method.Invoke(message, EmptyObjectArray);
}
///
/// Reflection with extensions isn't supported because IExtendableMessage members are used to
/// get values. Can't use reflection to invoke those methods because they have a generic
/// argument. MakeGenericMethod can't be used because it will break whenever the extension type
/// is a value type. This could be made to work if there were non-generic methods available for
/// getting and setting extension values.
///
private sealed class AotExtensionReflectionHelper : IExtensionReflectionHelper {
private const string Message = "Extensions reflection is not supported with AOT.";
public object GetExtension(IMessage message) => throw new NotSupportedException(Message);
public bool HasExtension(IMessage message) => throw new NotSupportedException(Message);
public void SetExtension(IMessage message,
object value) => throw new NotSupportedException(Message);
public void ClearExtension(IMessage message) => throw new NotSupportedException(Message);
}
#endif
private sealed class ExtensionSetReflector<[DynamicallyAccessedMembers(
DynamicallyAccessedMemberTypes.PublicProperties |
DynamicallyAccessedMemberTypes.NonPublicProperties)] T1> : IExtensionSetReflector
where T1 : IExtendableMessage {
public Func CreateIsInitializedCaller() {
var prop = typeof(T1).GetTypeInfo().GetDeclaredProperty("_Extensions");
var getFunc = (Func>)prop.GetMethod.CreateDelegate(
typeof(Func>));
var initializedFunc = (Func, bool>)typeof(ExtensionSet)
.GetTypeInfo()
.GetDeclaredMethod("IsInitialized")
.CreateDelegate(typeof(Func, bool>));
return (m) => {
var set = getFunc((T1)m);
return set == null || initializedFunc(set);
};
}
}
// Runtime compatibility checking code - see ReflectionHelper.CreateFuncIMessageInt32
// for details about why we're doing this.
// Deliberately not inside the generic type. We only want to check this once.
private static bool CanConvertEnumFuncToInt32Func { get; } =
CheckCanConvertEnumFuncToInt32Func();
private static bool CheckCanConvertEnumFuncToInt32Func() {
try {
// Try to do the conversion using reflection, so we can see whether it's supported.
MethodInfo method = typeof(ReflectionUtil).GetMethod(nameof(SampleEnumMethod));
// If this passes, we're in a reasonable runtime.
method.CreateDelegate(typeof(Func));
return true;
} catch (ArgumentException) {
return false;
}
}
public enum SampleEnum { X }
// Public to make the reflection simpler.
public static SampleEnum SampleEnumMethod() => SampleEnum.X;
}
}