[Optimization] Parsing Smart Contract Script Analysis

src/Neo.CLI/CLI/MainService.Tools.cs

@@ -14,7 +14,6 @@
 using Neo.Extensions;
 using Neo.IO;
 using Neo.SmartContract;
-using Neo.VM;
 using Neo.Wallets;
 using System;
 using System.Collections.Generic;
@@ -57,7 +56,8 @@ private void OnParseCommand(string value)
 
                 if (result != null)
                 {
-                    Console.WriteLine($"{pair.Key,-30}\t{result}");
+                    ConsoleHelper.Info("", "-----", pair.Key, "-----");
+                    ConsoleHelper.Info("", result, Environment.NewLine);
                     any = true;
                 }
             }
@@ -418,62 +418,27 @@ private static string Base64Fixed(string str)
         [ParseFunction("Base64 Smart Contract Script Analysis")]
         private string? ScriptsToOpCode(string base64)
         {
-            Script script;
             try
             {
-                var scriptData = Convert.FromBase64String(base64);
-                script = new Script(scriptData.ToArray(), true);
-            }
-            catch (Exception)
-            {
-                return null;
-            }
-            return ScriptsToOpCode(script);
-        }
+                var bytes = Convert.FromBase64String(base64);
+                var sb = new StringBuilder();
+                var line = 0;
 
-        private string ScriptsToOpCode(Script script)
-        {
-            //Initialize all InteropService
-            var dic = new Dictionary<uint, string>();
-            ApplicationEngine.Services.ToList().ForEach(p => dic.Add(p.Value.Hash, p.Value.Name));
-
-            //Analyzing Scripts
-            var ip = 0;
-            Instruction instruction;
-            var result = new List<string>();
-            while (ip < script.Length && (instruction = script.GetInstruction(ip)) != null)
-            {
-                ip += instruction.Size;
-
-                var op = instruction.OpCode;
-
-                if (op.ToString().StartsWith("PUSHINT"))
-                {
-                    var operand = instruction.Operand.ToArray();
-                    result.Add($"{op} {new BigInteger(operand)}");
-                }
-                else if (op == OpCode.SYSCALL)
+                foreach (var instruct in new VMInstruction(bytes))
                 {
-                    var operand = instruction.Operand.ToArray();
-                    result.Add($"{op} {dic[BitConverter.ToUInt32(operand)]}");
-                }
-                else
-                {
-                    if (!instruction.Operand.IsEmpty && instruction.Operand.Length > 0)
-                    {
-                        var operand = instruction.Operand.ToArray();
-                        var ascii = Encoding.Default.GetString(operand);
-                        ascii = ascii.Any(p => p < '0' || p > 'z') ? operand.ToHexString() : ascii;
-
-                        result.Add($"{op} {(operand.Length == 20 ? new UInt160(operand).ToString() : ascii)}");
-                    }
+                    if (instruct.OperandSize == 0)
+                        sb.AppendFormat("L{0:D04}:{1:X04} {2}{3}", line, instruct.Position, instruct.OpCode, Environment.NewLine);
                     else
-                    {
-                        result.Add($"{op}");
-                    }
+                        sb.AppendFormat("L{0:D04}:{1:X04} {2,-10}{3}{4}", line, instruct.Position, instruct.OpCode, instruct.DecodeOperand(), Environment.NewLine);
+                    line++;
                 }
+
+                return sb.ToString();
+            }
+            catch
+            {
+                return null;
             }
-            return Environment.NewLine + string.Join("\r\n", result.ToArray());
         }
 
         /// <summary>

src/Neo.CLI/Tools/VMInstruction.cs

@@ -0,0 +1,178 @@
+// Copyright (C) 2015-2024 The Neo Project.
+//
+// VMInstruction.cs file belongs to the neo project and is free
+// software distributed under the MIT software license, see the
+// accompanying file LICENSE in the main directory of the
+// repository or http://www.opensource.org/licenses/mit-license.php
+// for more details.
+//
+// Redistribution and use in source and binary forms with or without
+// modifications are permitted.
+
+using Neo.SmartContract;
+using Neo.VM;
+using System;
+using System.Buffers.Binary;
+using System.Collections;
+using System.Collections.Generic;
+using System.Diagnostics;
+using System.IO;
+using System.Linq;
+using System.Numerics;
+using System.Reflection;
+using System.Runtime.CompilerServices;
+using System.Text;
+
+namespace Neo.CLI
+{
+    [DebuggerDisplay("OpCode={OpCode}, OperandSize={OperandSize}")]
+    internal sealed class VMInstruction : IEnumerable<VMInstruction>
+    {
+        private const int OpCodeSize = 1;
+
+        public int Position { get; private init; }
+        public OpCode OpCode { get; private init; }
+        public ReadOnlyMemory<byte> Operand { get; private init; }
+        public int OperandSize { get; private init; }
+        public int OperandPrefixSize { get; private init; }
+
+        private static readonly int[] s_operandSizeTable = new int[256];
+        private static readonly int[] s_operandSizePrefixTable = new int[256];
+
+        private readonly ReadOnlyMemory<byte> _script;
+
+        public VMInstruction(ReadOnlyMemory<byte> script, int start = 0)
+        {
+            if (script.IsEmpty)
+                throw new Exception("Bad Script.");
+
+            var opcode = (OpCode)script.Span[start];
+
+            if (Enum.IsDefined(opcode) == false)
+                throw new InvalidDataException($"Invalid opcode at Position: {start}.");
+
+            OperandPrefixSize = s_operandSizePrefixTable[(int)opcode];
+            OperandSize = OperandPrefixSize switch
+            {
+                0 => s_operandSizeTable[(int)opcode],
+                1 => script.Span[start + 1],
+                2 => BinaryPrimitives.ReadUInt16LittleEndian(script.Span[(start + 1)..]),
+                4 => unchecked((int)BinaryPrimitives.ReadUInt32LittleEndian(script.Span[(start + 1)..])),
+                _ => throw new InvalidDataException($"Invalid opcode prefix at Position: {start}."),
+            };
+
+            OperandSize += OperandPrefixSize;
+
+            if (start + OperandSize + OpCodeSize > script.Length)
+                throw new IndexOutOfRangeException("Operand size exceeds end of script.");
+
+            Operand = script.Slice(start + OpCodeSize, OperandSize);
+
+            _script = script;
+            OpCode = opcode;
+            Position = start;
+        }
+
+        static VMInstruction()
+        {
+            foreach (var field in typeof(OpCode).GetFields(BindingFlags.Public | BindingFlags.Static))
+            {
+                var attr = field.GetCustomAttribute<OperandSizeAttribute>();
+                if (attr == null) continue;
+
+                var index = (uint)(OpCode)field.GetValue(null)!;
+                s_operandSizeTable[index] = attr.Size;
+                s_operandSizePrefixTable[index] = attr.SizePrefix;
+            }
+        }
+
+        public IEnumerator<VMInstruction> GetEnumerator()
+        {
+            var nip = Position + OperandSize + OpCodeSize;
+            yield return this;
+
+            VMInstruction? instruct;
+            for (var ip = nip; ip < _script.Length; ip += instruct.OperandSize + OpCodeSize)
+                yield return instruct = new VMInstruction(_script, ip);
+        }
+
+        IEnumerator IEnumerable.GetEnumerator() =>
+            GetEnumerator();
+
+        public override string ToString()
+        {
+            var sb = new StringBuilder();
+            sb.AppendFormat("{1:X04} {2,-10}{3}{4}", Position, OpCode, DecodeOperand());
+            return sb.ToString();
+        }
+
+        public T AsToken<T>(uint index = 0)
+            where T : unmanaged
+        {
+            var size = Unsafe.SizeOf<T>();
+
+            if (size > OperandSize)
+                throw new ArgumentOutOfRangeException(nameof(T), $"SizeOf {typeof(T).FullName} is too big for operand. OpCode: {OpCode}.");
+            if (size + index > OperandSize)
+                throw new ArgumentOutOfRangeException(nameof(index), $"SizeOf {typeof(T).FullName} + {index} is too big for operand. OpCode: {OpCode}.");
+
+            var bytes = Operand[..OperandSize].ToArray();
+            return Unsafe.As<byte, T>(ref bytes[index]);
+        }
+
+        public string DecodeOperand()
+        {
+            var operand = Operand[OperandPrefixSize..].ToArray();
+            var asStr = Encoding.UTF8.GetString(operand);
+            var readable = asStr.All(char.IsAsciiLetterOrDigit);
+
+            return OpCode switch
+            {
+                OpCode.JMP or
+                OpCode.JMPIF or
+                OpCode.JMPIFNOT or
+                OpCode.JMPEQ or
+                OpCode.JMPNE or
+                OpCode.JMPGT or
+                OpCode.JMPLT or
+                OpCode.CALL or
+                OpCode.ENDTRY => $"[{checked(Position + AsToken<byte>()):X08}]",
+                OpCode.JMP_L or
+                OpCode.JMPIF_L or
+                OpCode.PUSHA or
+                OpCode.JMPIFNOT_L or
+                OpCode.JMPEQ_L or
+                OpCode.JMPNE_L or
+                OpCode.JMPGT_L or
+                OpCode.JMPLT_L or
+                OpCode.CALL_L or
+                OpCode.ENDTRY_L => $"[{checked(Position + AsToken<int>()):X08}]",
+                OpCode.TRY => $"[{AsToken<byte>():X02}, {AsToken<byte>(1):X02}]",
+                OpCode.INITSLOT => $"{AsToken<byte>()}, {AsToken<byte>(1)}",
+                OpCode.TRY_L => $"[{checked(Position + AsToken<int>()):X08}, {checked(Position + AsToken<int>()):X08}]",
+                OpCode.CALLT => $"[{checked(Position + AsToken<ushort>()):X08}]",
+                OpCode.NEWARRAY_T or
+                OpCode.ISTYPE or
+                OpCode.CONVERT => $"{AsToken<byte>():X02}",
+                OpCode.STLOC or
+                OpCode.LDLOC or
+                OpCode.LDSFLD or
+                OpCode.STSFLD or
+                OpCode.LDARG or
+                OpCode.STARG or
+                OpCode.INITSSLOT => $"{AsToken<byte>()}",
+                OpCode.PUSHINT8 => $"{AsToken<sbyte>()}",
+                OpCode.PUSHINT16 => $"{AsToken<short>()}",
+                OpCode.PUSHINT32 => $"{AsToken<int>()}",
+                OpCode.PUSHINT64 => $"{AsToken<long>()}",
+                OpCode.PUSHINT128 or
+                OpCode.PUSHINT256 => $"{new BigInteger(operand)}",
+                OpCode.SYSCALL => $"[{ApplicationEngine.Services[Unsafe.As<byte, uint>(ref operand[0])].Name}]",
+                OpCode.PUSHDATA1 or
+                OpCode.PUSHDATA2 or
+                OpCode.PUSHDATA4 => readable ? $"{Convert.ToHexString(operand)} // {asStr}" : Convert.ToHexString(operand),
+                _ => readable ? $"\"{asStr}\"" : $"{Convert.ToHexString(operand)}",
+            };
+        }
+    }
+}