ILSpy/ICSharpCode.Decompiler/IL/ILTypeExtensions.cs

#nullable enable
// Copyright (c) 2014 Daniel Grunwald
// 
// Permission is hereby granted, free of charge, to any person obtaining a copy of this
// software and associated documentation files (the "Software"), to deal in the Software
// without restriction, including without limitation the rights to use, copy, modify, merge,
// publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons
// to whom the Software is furnished to do so, subject to the following conditions:
// 
// The above copyright notice and this permission notice shall be included in all copies or
// substantial portions of the Software.
// 
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
// INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
// PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
// FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
// OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
// DEALINGS IN THE SOFTWARE.

using System.Diagnostics;
using System.Linq;

using ICSharpCode.Decompiler.TypeSystem;

namespace ICSharpCode.Decompiler.IL
{
	static class ILTypeExtensions
	{
		public static StackType GetStackType(this PrimitiveType primitiveType)
		{
			switch (primitiveType)
			{
				case PrimitiveType.I1:
				case PrimitiveType.U1:
				case PrimitiveType.I2:
				case PrimitiveType.U2:
				case PrimitiveType.I4:
				case PrimitiveType.U4:
					return StackType.I4;
				case PrimitiveType.I8:
				case PrimitiveType.U8:
					return StackType.I8;
				case PrimitiveType.I:
				case PrimitiveType.U:
					return StackType.I;
				case PrimitiveType.R4:
					return StackType.F4;
				case PrimitiveType.R8:
				case PrimitiveType.R:
					return StackType.F8;
				case PrimitiveType.Ref: // ByRef
					return StackType.Ref;
				case PrimitiveType.Unknown:
					return StackType.Unknown;
				default:
					return StackType.O;
			}
		}

		public static Sign GetSign(this PrimitiveType primitiveType)
		{
			switch (primitiveType)
			{
				case PrimitiveType.I1:
				case PrimitiveType.I2:
				case PrimitiveType.I4:
				case PrimitiveType.I8:
				case PrimitiveType.R4:
				case PrimitiveType.R8:
				case PrimitiveType.R:
				case PrimitiveType.I:
					return Sign.Signed;
				case PrimitiveType.U1:
				case PrimitiveType.U2:
				case PrimitiveType.U4:
				case PrimitiveType.U8:
				case PrimitiveType.U:
					return Sign.Unsigned;
				default:
					return Sign.None;
			}
		}

		public static bool HasOppositeSign(this PrimitiveType primitiveType)
		{
			switch (primitiveType)
			{
				case PrimitiveType.I1:
				case PrimitiveType.I2:
				case PrimitiveType.I4:
				case PrimitiveType.I8:
				case PrimitiveType.U1:
				case PrimitiveType.U2:
				case PrimitiveType.U4:
				case PrimitiveType.U8:
				case PrimitiveType.I:
				case PrimitiveType.U:
					return true;
				default:
					return false;
			}
		}

		/// <summary>
		/// Gets the size in bytes of the primitive type.
		/// 
		/// Returns 0 for non-primitive types.
		/// Returns <c>NativeIntSize</c> for native int/references.
		/// </summary>
		public static int GetSize(this PrimitiveType type)
		{
			switch (type)
			{
				case PrimitiveType.I1:
				case PrimitiveType.U1:
					return 1;
				case PrimitiveType.I2:
				case PrimitiveType.U2:
					return 2;
				case PrimitiveType.I4:
				case PrimitiveType.U4:
				case PrimitiveType.R4:
					return 4;
				case PrimitiveType.I8:
				case PrimitiveType.R8:
				case PrimitiveType.U8:
				case PrimitiveType.R:
					return 8;
				case PrimitiveType.I:
				case PrimitiveType.U:
				case PrimitiveType.Ref:
					return TypeUtils.NativeIntSize;
				default:
					return 0;
			}
		}

		/// <summary>
		/// Gets whether the type is a small integer type.
		/// Small integer types are:
		/// * bool, sbyte, byte, char, short, ushort
		/// * any enums that have a small integer type as underlying type
		/// </summary>
		public static bool IsSmallIntegerType(this PrimitiveType type)
		{
			return GetSize(type) < 4;
		}

		public static bool IsIntegerType(this PrimitiveType primitiveType)
		{
			return primitiveType.GetStackType().IsIntegerType();
		}

		public static bool IsFloatType(this PrimitiveType type)
		{
			switch (type)
			{
				case PrimitiveType.R4:
				case PrimitiveType.R8:
				case PrimitiveType.R:
					return true;
				default:
					return false;
			}
		}

		/// <summary>
		/// Infers the C# type an instruction expects of the child in <paramref name="childIndex"/>,
		/// i.e. the counterpart to <see cref="InferType"/>: that one asks what a value is, this one
		/// asks what the position it flows into says it should be.
		///
		/// Returns SpecialType.UnknownType where the position names nothing.
		/// </summary>
		/// <remarks>
		/// Where a value's own type is only its stack type - `I4` being `int`, `bool`, `char` and
		/// every enum at once - the consumer often still knows, because a parameter, a return type
		/// or a field carries its type in metadata.
		/// </remarks>
		public static IType InferExpectedType(this ILInstruction inst, int childIndex, ICompilation? compilation)
		{
			switch (inst)
			{
				case CallInstruction call:
					if (childIndex == 0 && call.IsInstanceCall)
						return call.ConstrainedTo ?? call.Method.DeclaringType;
					return call.GetParameter(childIndex)?.Type ?? SpecialType.UnknownType;
				case Leave leave when childIndex == 0:
					// the value of a leave is a return value only where it leaves the function body
					var function = leave.Ancestors.OfType<ILFunction>().FirstOrDefault();
					if (function == null || leave.TargetContainer != function.Body)
						return SpecialType.UnknownType;
					return function.Method?.ReturnType ?? SpecialType.UnknownType;
				case StObj stobj when childIndex == 1:
					return stobj.Type;
				case StLoc stloc when childIndex == 0:
					return stloc.Variable.Type;
				case IfInstruction ifInst when childIndex == 0:
					return compilation?.FindType(KnownTypeCode.Boolean) ?? SpecialType.UnknownType;
				case NewArr newArr:
					return compilation?.FindType(KnownTypeCode.Int32) ?? SpecialType.UnknownType;
				default:
					return SpecialType.UnknownType;
			}
		}

		/// <summary>
		/// Infers the C# type for an IL instruction.
		/// 
		/// Returns SpecialType.UnknownType for unsupported instructions.
		/// </summary>
		/// <remarks>
		/// For instructions with StackType.O that produce a value type, or
		/// instructions with StackType.Ref, we should aim to return the actual type
		/// instead of SpecialType.UnknownType.
		/// 
		/// If not returning UnknownType, must return a type that can store
		/// the result of the instruction without loss of information.
		/// </remarks>
		public static IType InferType(this ILInstruction inst, ICompilation compilation)
		{
			Debug.Assert(compilation != null);
			switch (inst)
			{
				case NewObj newObj:
					return newObj.Method.DeclaringType ?? SpecialType.UnknownType;
				case NewArr newArr:
					return new ArrayType(compilation, newArr.Type, newArr.Indices.Count);
				case Call call:
					return call.Method.ReturnType;
				case CallVirt callVirt:
					return callVirt.Method.ReturnType;
				case CallIndirect calli:
					return calli.FunctionPointerType.ReturnType;
				case UserDefinedLogicOperator logicOp:
					return logicOp.Method.ReturnType;
				case LdObj ldobj:
					return ldobj.Type;
				case StObj stobj:
					return stobj.Type;
				case LdLoc ldloc:
					return ldloc.Variable.Type;
				case StLoc stloc:
					return stloc.Variable.Type;
				case LdLoca ldloca:
					return new ByReferenceType(ldloca.Variable.Type);
				case LdFlda ldflda:
					return new ByReferenceType(ldflda.Field.Type);
				case LdsFlda ldsflda:
					return new ByReferenceType(ldsflda.Field.Type);
				case LdElema ldelema:
					if (ldelema.Array.InferType(compilation) is ArrayType arrayType)
					{
						if (TypeUtils.IsCompatibleTypeForMemoryAccess(arrayType.ElementType, ldelema.Type))
						{
							return new ByReferenceType(arrayType.ElementType);
						}
					}
					return new ByReferenceType(ldelema.Type);
				case Comp comp:
					switch (comp.LiftingKind)
					{
						case ComparisonLiftingKind.None:
						case ComparisonLiftingKind.CSharp:
							return compilation.FindType(KnownTypeCode.Boolean);
						case ComparisonLiftingKind.ThreeValuedLogic:
							return NullableType.Create(compilation, compilation.FindType(KnownTypeCode.Boolean));
						default:
							return SpecialType.UnknownType;
					}
				case BinaryNumericInstruction bni:
					if (bni.IsLifted)
						return SpecialType.UnknownType;
					switch (bni.Operator)
					{
						case BinaryNumericOperator.BitAnd:
						case BinaryNumericOperator.BitOr:
						case BinaryNumericOperator.BitXor:
							var left = bni.Left.InferType(compilation);
							var right = bni.Right.InferType(compilation);
							if (left.Equals(right) && (left.IsCSharpPrimitiveIntegerType() || left.IsCSharpNativeIntegerType() || left.IsKnownType(KnownTypeCode.Boolean)))
								return left;
							else
								return SpecialType.UnknownType;
						default:
							return SpecialType.UnknownType;
					}
				case LdLen ldLen:
					if (compilation == null)
						return SpecialType.UnknownType;
					// Mirrors ExpressionBuilder.VisitLdLen, which picks Array.Length or
					// Array.LongLength based on the result type alone.
					return compilation.FindType(ldLen.ResultType == StackType.I4 ? KnownTypeCode.Int32 : KnownTypeCode.Int64);
				case DefaultValue defaultValue:
					return defaultValue.Type;
				case ILFunction func when func.DelegateType != null:
					return func.DelegateType;
				case IfInstruction ifInst:
					// For structs and byrefs, we don't want to return Unknown as a fallback to
					// to FindType(StackType) wouldn't work. Valid IL should have the same
					// type on both branches so we just return the first that works.
					var thenType = ifInst.TrueInst.InferType(compilation);
					if (thenType.CannotBeReconstructedFromStackType())
					{
						return thenType;
					}
					var elseType = ifInst.FalseInst.InferType(compilation);
					if (elseType.CannotBeReconstructedFromStackType())
					{
						return elseType;
					}
					if (thenType.Equals(elseType))
					{
						return thenType;
					}
					return SpecialType.UnknownType;
				case SwitchInstruction switchInst:
					foreach (var section in switchInst.Sections)
					{
						var bodyType = section.Body.InferType(compilation);
						if (bodyType.CannotBeReconstructedFromStackType())
						{
							return bodyType;
						}
					}
					return SpecialType.UnknownType;
				default:
					return SpecialType.UnknownType;
			}
		}
	}
}