From 8406ec6272392a3f7f7672d85fdde333b6c70378 Mon Sep 17 00:00:00 2001
From: jduncanator <1518948+jduncanator@users.noreply.github.com>
Date: Fri, 11 Jan 2019 11:11:46 +1100
Subject: Refactor Ryujinx.Common and HLE Stub Logging (#537)

* Refactor Ryujinx.Common and HLE Stub Logging

* Resolve review comments

* Rename missed loop variable

* Optimize PrintStub logging function

* Pass the call-sites Thread ID through to the logger

* Remove superfluous lock from ConsoleLog

* Process logged data objects in the logger target

Pass the data object all the way to the output logger targets, to allow them to "serialize" this in whatever appropriate format they're logging in.

* Use existing StringBuilder to build the properties string

* Add a ServiceNotImplemented Exception

Useful for printing debug information about unimplemented service calls

* Resolve Style Nits

* Resolve Merge Issues

* Fix typo and align declarations
---
 .../Exceptions/ServiceNotImplementedException.cs   | 163 +++++++++++++++++++++
 1 file changed, 163 insertions(+)
 create mode 100644 Ryujinx.HLE/Exceptions/ServiceNotImplementedException.cs

(limited to 'Ryujinx.HLE/Exceptions/ServiceNotImplementedException.cs')

diff --git a/Ryujinx.HLE/Exceptions/ServiceNotImplementedException.cs b/Ryujinx.HLE/Exceptions/ServiceNotImplementedException.cs
new file mode 100644
index 00000000..18f41910
--- /dev/null
+++ b/Ryujinx.HLE/Exceptions/ServiceNotImplementedException.cs
@@ -0,0 +1,163 @@
+using Ryujinx.Common;
+using Ryujinx.HLE.HOS;
+using Ryujinx.HLE.HOS.Ipc;
+using Ryujinx.HLE.HOS.Kernel.Ipc;
+using Ryujinx.HLE.HOS.Services;
+using System;
+using System.Collections.Generic;
+using System.Diagnostics;
+using System.Linq;
+using System.Reflection;
+using System.Runtime.Serialization;
+using System.Text;
+
+namespace Ryujinx.HLE.Exceptions
+{
+    [Serializable]
+    internal class ServiceNotImplementedException : Exception
+    {
+        public KSession   Session { get; }
+        public IpcMessage Request { get; }
+        public ServiceCtx Context { get; }
+
+        public ServiceNotImplementedException(ServiceCtx context)
+            : this(context, "The service call is not implemented.")
+        { }
+
+        public ServiceNotImplementedException(ServiceCtx context, string message)
+            : base(message)
+        {
+            Context = context;
+            Session = context.Session;
+            Request = context.Request;
+        }
+
+        public ServiceNotImplementedException(ServiceCtx context, string message, Exception inner)
+            : base(message, inner)
+        {
+            Context = context;
+            Session = context.Session;
+            Request = context.Request;
+        }
+
+        protected ServiceNotImplementedException(SerializationInfo info, StreamingContext context) 
+            : base(info, context)
+        { }
+
+        public override string Message
+        {
+            get
+            {
+                return base.Message +
+                        Environment.NewLine +
+                        Environment.NewLine +
+                        BuildMessage();
+            }
+        }
+
+        private string BuildMessage()
+        {
+            StringBuilder sb = new StringBuilder();
+
+            // Print the IPC command details (service name, command ID, and handler)
+            (Type callingType, MethodBase callingMethod) = WalkStackTrace(new StackTrace(this));
+
+            if (callingType != null && callingMethod != null)
+            {
+                var ipcService  = Context.Session.Service;
+                var ipcCommands = ipcService.Commands;
+
+                // Find the handler for the method called
+                var ipcHandler   = ipcCommands.FirstOrDefault(x => x.Value.Method == callingMethod);
+                var ipcCommandId = ipcHandler.Key;
+                var ipcMethod    = ipcHandler.Value;
+
+                if (ipcMethod != null)
+                {
+                    sb.AppendLine($"Service Command: {Session.ServiceName} {ipcService.GetType().Name}: {ipcCommandId} ({ipcMethod.Method.Name})");
+                    sb.AppendLine();
+                }
+            }
+
+            // Print buffer information
+            sb.AppendLine("Buffer Information");
+
+            if (Request.PtrBuff.Count > 0)
+            {
+                sb.AppendLine("\tPtrBuff:");
+
+                foreach (var buff in Request.PtrBuff)
+                {
+                    sb.AppendLine($"\t[{buff.Index}] Position: 0x{buff.Position:x16} Size: 0x{buff.Size:x16}");
+                }
+            }
+
+            if (Request.SendBuff.Count > 0)
+            {
+                sb.AppendLine("\tSendBuff:");
+
+                foreach (var buff in Request.SendBuff)
+                {
+                    sb.AppendLine($"\tPosition: 0x{buff.Position:x16} Size: 0x{buff.Size:x16} Flags: {buff.Flags}");
+                }
+            }
+
+            if (Request.ReceiveBuff.Count > 0)
+            {
+                sb.AppendLine("\tReceiveBuff:");
+
+                foreach (var buff in Request.ReceiveBuff)
+                {
+                    sb.AppendLine($"\tPosition: 0x{buff.Position:x16} Size: 0x{buff.Size:x16} Flags: {buff.Flags}");
+                }
+            }
+
+            if (Request.ExchangeBuff.Count > 0)
+            {
+                sb.AppendLine("\tExchangeBuff:");
+
+                foreach (var buff in Request.ExchangeBuff)
+                {
+                    sb.AppendLine($"\tPosition: 0x{buff.Position:x16} Size: 0x{buff.Size:x16} Flags: {buff.Flags}");
+                }
+            }
+
+            if (Request.RecvListBuff.Count > 0)
+            {
+                sb.AppendLine("\tRecvListBuff:");
+
+                foreach (var buff in Request.RecvListBuff)
+                {
+                    sb.AppendLine($"\tPosition: 0x{buff.Position:x16} Size: 0x{buff.Size:x16}");
+                }
+            }
+
+            sb.AppendLine();
+
+            sb.AppendLine("Raw Request Data:");
+            sb.Append(HexUtils.HexTable(Request.RawData));
+
+            return sb.ToString();
+        }
+
+        private (Type, MethodBase) WalkStackTrace(StackTrace trace)
+        {
+            int i = 0;
+
+            StackFrame frame;
+            // Find the IIpcService method that threw this exception
+            while ((frame = trace.GetFrame(i++)) != null)
+            {
+                var method   = frame.GetMethod();
+                var declType = method.DeclaringType;
+
+                if (typeof(IIpcService).IsAssignableFrom(declType))
+                {
+                    return (declType, method);
+                }
+            }
+
+            return (null, null);
+        }
+    }
+}
-- 
cgit v1.2.3