/****************************************************************************** * The MIT License (MIT) * * Copyright (c) 2015-2017 Baldur Karlsson * Copyright (c) 2014 Crytek * * 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; using System.Collections.Generic; using System.Linq; using System.Text; using System.IO; using System.Threading; using System.Xml; using System.Xml.Serialization; using renderdoc; using System.Windows.Forms; namespace renderdocui.Code { [Serializable] public class RemoteHost { public string Hostname = ""; public string RunCommand = ""; [XmlIgnore] public bool ServerRunning = false; [XmlIgnore] public bool Connected = false; [XmlIgnore] public bool Busy = false; [XmlIgnore] public bool VersionMismatch = false; public void CheckStatus() { // special case - this is the local context if (Hostname == "localhost") { ServerRunning = false; VersionMismatch = Busy = false; return; } try { RemoteServer server = StaticExports.CreateRemoteServer(Hostname, 0); ServerRunning = true; VersionMismatch = Busy = false; server.ShutdownConnection(); // since we can only have one active client at once on a remote server, we need // to avoid DDOS'ing by doing multiple CheckStatus() one after the other so fast // that the active client can't be properly shut down. Sleeping here for a short // time gives that breathing room. // Not the most elegant solution, but it is simple Thread.Sleep(15); } catch (ReplayCreateException ex) { if (ex.Status == ReplayCreateStatus.NetworkRemoteBusy) { ServerRunning = true; Busy = true; } else if (ex.Status == ReplayCreateStatus.NetworkVersionMismatch) { ServerRunning = true; Busy = true; VersionMismatch = true; } else { ServerRunning = false; Busy = false; } } } public void Launch() { try { System.Diagnostics.ProcessStartInfo startInfo = new System.Diagnostics.ProcessStartInfo("cmd.exe"); startInfo.CreateNoWindow = true; startInfo.UseShellExecute = false; startInfo.WindowStyle = System.Diagnostics.ProcessWindowStyle.Hidden; startInfo.Arguments = "/C " + RunCommand; System.Diagnostics.Process cmd = System.Diagnostics.Process.Start(startInfo); // wait up to 2s for the command to exit cmd.WaitForExit(2000); } catch (Exception) { MessageBox.Show(String.Format("Error running command to launch remote server:\n{0}", RunCommand), "Error", MessageBoxButtons.OK, MessageBoxIcon.Error); } } } [Serializable] public class ExternalDisassembler { //indicates to the system that this placeholder points to the SPIR-V binary [NonSerialized] public static readonly string SPV_BIN_TAG = "{spv_bin}"; //indicates to the system that this placeholder points to the disassembled SPIR-V [NonSerialized] public static readonly string SPV_DISAS_TAG = "{spv_disas}"; //The TAGs below are for future usage to help identify in the argument list, //the shader entry point and the shader stage (for flexibility) [NonSerialized] public static readonly string SPV_ENTRY_POINT_TAG = "{spv_entry_point}"; [NonSerialized] public static readonly string SPV_SHADER_STAGE_TAG = "{spv_shader_stage}"; public ExternalDisassembler(uint id, string name, string executable, string args) { this.id = id; this.name = name; this.executable = executable; this.args = args; } protected ExternalDisassembler() { } public uint id { get; set; } public string name { get; set; } public string executable { get; set; } public string args { get; set; } public override bool Equals(object obj) { return obj.GetType() == typeof(ExternalDisassembler) && id == ((ExternalDisassembler)obj).id; } public override int GetHashCode() { return GetType().GetHashCode() ^ id.GetHashCode(); } } [Serializable] public class PersistantConfig { public string LastLogPath = ""; public List RecentLogFiles = new List(); public string LastCapturePath = ""; public string LastCaptureExe = ""; public List RecentCaptureSettings = new List(); public string AdbExecutablePath = ""; public uint MaxConnectTimeout = 30; // for historical reasons, this was named CaptureSavePath [XmlElement("CaptureSavePath")] public string TemporaryCaptureDirectory = ""; public string DefaultCaptureSaveDirectory = ""; //The list should contain all the pre-configured, external, SPIR-V disassemblers [XmlIgnore] // not directly serializable private Dictionary ExternalDisassemblers = new Dictionary(); public List> ExternalDisassemblersValues = new List>(); public bool ExternalDisassemblerEnabled = false; public void SetExternalDisassemblers(int id, ExternalDisassembler value) { ExternalDisassemblers[id] = value; } public ExternalDisassembler GetExternalDisassembler(int id) { if (ExternalDisassemblers.ContainsKey(id)) return ExternalDisassemblers[id]; return null; } //the default disassembler is at 0 public ExternalDisassembler GetDefaultExternalDisassembler() { if(!ExternalDisassemblers.ContainsKey(0)) { //Add default external disassembler at key 0 ExternalDisassemblers.Add(0, new ExternalDisassembler(0, "SPIRV-Cross", "", "")); } return ExternalDisassemblers[0]; } public bool TextureViewer_ResetRange = false; public bool TextureViewer_PerTexSettings = true; public bool ShaderViewer_FriendlyNaming = true; public bool AlwaysReplayLocally = false; public List RemoteHosts = new List(); public int LocalProxy = 0; [XmlIgnore] // not directly serializable public Dictionary ConfigSettings = new Dictionary(); public List> ConfigSettingsValues = new List>(); public void SetConfigSetting(string name, string value) { ConfigSettings[name] = value; StaticExports.SetConfigSetting(name, value); } public string GetConfigSetting(string name) { if(ConfigSettings.ContainsKey(name)) return ConfigSettings[name]; return ""; } public enum TimeUnit { Seconds = 0, Milliseconds, Microseconds, Nanoseconds, }; public static String UnitPrefix(TimeUnit t) { if (t == TimeUnit.Seconds) return "s"; else if (t == TimeUnit.Milliseconds) return "ms"; else if (t == TimeUnit.Microseconds) return "µs"; else if (t == TimeUnit.Nanoseconds) return "ns"; return "s"; } public TimeUnit EventBrowser_TimeUnit = TimeUnit.Microseconds; public bool EventBrowser_HideEmpty = false; public bool EventBrowser_HideAPICalls = false; public bool EventBrowser_ApplyColours = true; public bool EventBrowser_ColourEventRow = true; public int Formatter_MinFigures = 2; public int Formatter_MaxFigures = 5; public int Formatter_NegExp = 5; public int Formatter_PosExp = 7; public bool Font_PreferMonospaced = false; [XmlIgnore] // not directly serializable public System.Drawing.Font PreferredFont { get; private set; } public bool CheckUpdate_AllowChecks = true; public bool CheckUpdate_UpdateAvailable = false; public string CheckUpdate_UpdateResponse = ""; public DateTime CheckUpdate_LastUpdate = new DateTime(2012, 06, 27); public DateTime DegradedLog_LastUpdate = new DateTime(2015, 01, 01); public bool Tips_SeenFirst = false; public bool AllowGlobalHook = false; public void SetupFormatting() { Formatter.MinFigures = Formatter_MinFigures; Formatter.MaxFigures = Formatter_MaxFigures; Formatter.ExponentialNegCutoff = Formatter_NegExp; Formatter.ExponentialPosCutoff = Formatter_PosExp; PreferredFont = Font_PreferMonospaced ? new System.Drawing.Font("Consolas", 9.25F, System.Drawing.FontStyle.Regular, System.Drawing.GraphicsUnit.Point, ((byte)(0))) : new System.Drawing.Font("Tahoma", 8.25F); } public void AddRecentFile(List recentList, string file, int maxItems) { if (!recentList.Contains(Path.GetFullPath(file))) { recentList.Add(Path.GetFullPath(file)); if (recentList.Count >= maxItems) recentList.RemoveAt(0); } else { recentList.Remove(Path.GetFullPath(file)); recentList.Add(Path.GetFullPath(file)); } } public PersistantConfig() { RecentLogFiles.Clear(); RecentCaptureSettings.Clear(); } public bool ReadOnly = false; public void Serialize(string file) { if (ReadOnly) return; try { ConfigSettingsValues.Clear(); foreach (var kv in ConfigSettings) ConfigSettingsValues.Add(new SerializableKeyValuePair(kv.Key, kv.Value)); //external disassemblers ExternalDisassemblersValues.Clear(); foreach (var kv in ExternalDisassemblers) ExternalDisassemblersValues.Add(new SerializableKeyValuePair(kv.Key, kv.Value)); XmlSerializer xs = new XmlSerializer(this.GetType()); StreamWriter writer = File.CreateText(file); xs.Serialize(writer, this); writer.Flush(); writer.Close(); } catch (System.IO.IOException ex) { // Can't recover, but let user know that we couldn't save their settings. MessageBox.Show(String.Format("Error saving config file: {1}\n{0}", file, ex.Message)); } } public static PersistantConfig Deserialize(string file) { XmlSerializer xs = new XmlSerializer(typeof(PersistantConfig)); StreamReader reader = File.OpenText(file); PersistantConfig c = (PersistantConfig)xs.Deserialize(reader); reader.Close(); foreach (var kv in c.ConfigSettingsValues) { if (kv.Key != null && kv.Key.Length > 0 && kv.Value != null) { c.SetConfigSetting(kv.Key, kv.Value); } } //external disassemblers foreach (var kv in c.ExternalDisassemblersValues) { if (kv.Key >= 0 && kv.Value != null) { c.SetExternalDisassemblers(kv.Key, kv.Value); } } // localhost should always be available bool foundLocalhost = false; for (int i = 0; i < c.RemoteHosts.Count; i++) { if (c.RemoteHosts[i].Hostname == "localhost") { foundLocalhost = true; break; } } if (!foundLocalhost) { RemoteHost host = new RemoteHost(); host.Hostname = "localhost"; c.RemoteHosts.Add(host); } return c; } public void AddAndroidHosts() { for (int i = RemoteHosts.Count - 1; i >= 0; i--) { if (RemoteHosts[i].Hostname.StartsWith("adb:")) RemoteHosts.RemoveAt(i); } string adbExePath = File.Exists(AdbExecutablePath) ? AdbExecutablePath : ""; // Set the config setting as it will be reused when we start the remoteserver etc. StaticExports.SetConfigSetting("adbExePath", adbExePath); if (adbExePath.Length == 0) return;// adb path must be non-empty in the Options dialog. string[] androidHosts = StaticExports.EnumerateAndroidDevices(); foreach(string hostName in androidHosts) { RemoteHost host = new RemoteHost(); host.Hostname = "adb:" + hostName; RemoteHosts.Add(host); } } } }