Initial Commit for UEFI Extension

Initial commit moving the UEFI extension from microsoft/mu_feature_debugger to microsoft/uefi_debug_tools.

Migrated from: https://github.com/microsoft/mu_feature_debugger/tree/bc84e6b62c5d798db5b433d0dc598ff7c5ace2d0

Co-authored-by: Oliver Smith-Denny <osde@microsoft.com>

Author: cfernald

UefiDbgExt/dbgexts.cpp

@@ -0,0 +1,366 @@
+/*++
+
+    Copyright (c) Microsoft Corporation.
+
+    SPDX-License-Identifier: BSD-2-Clause-Patent
+
+Module Name:
+
+    dbgexts.cpp
+
+Abstract:
+
+    This file contains the generic routines and initialization code
+    for the debugger extensions dll.
+
+--*/
+
+#include "dbgexts.h"
+#include <strsafe.h>
+
+PDEBUG_CLIENT4    g_ExtClient;
+PDEBUG_CONTROL    g_ExtControl;
+PDEBUG_SYMBOLS2   g_ExtSymbols;
+PDEBUG_REGISTERS  g_ExtRegisters;
+
+WINDBG_EXTENSION_APIS  ExtensionApis;
+
+ULONG  TargetMachine;
+BOOL   Connected;
+
+// Queries for all debugger interfaces.
+extern "C" HRESULT
+ExtQuery (
+  PDEBUG_CLIENT4  Client
+  )
+{
+  HRESULT  Status;
+
+  if ((Status = Client->QueryInterface (
+                          __uuidof (IDebugControl),
+                          (void **)&g_ExtControl
+                          )) != S_OK)
+  {
+    goto Fail;
+  }
+
+  if ((Status = Client->QueryInterface (
+                          __uuidof (IDebugSymbols2),
+                          (void **)&g_ExtSymbols
+                          )) != S_OK)
+  {
+    goto Fail;
+  }
+
+  g_ExtClient = Client;
+
+  return S_OK;
+
+Fail:
+  ExtRelease ();
+  return Status;
+}
+
+// Cleans up all debugger interfaces.
+void
+ExtRelease (
+  void
+  )
+{
+  g_ExtClient = NULL;
+  EXT_RELEASE (g_ExtControl);
+  EXT_RELEASE (g_ExtSymbols);
+}
+
+// Normal output.
+void __cdecl
+ExtOut (
+  PCSTR  Format,
+  ...
+  )
+{
+  va_list  Args;
+
+  va_start (Args, Format);
+  g_ExtControl->OutputVaList (DEBUG_OUTPUT_NORMAL, Format, Args);
+  va_end (Args);
+}
+
+// Error output.
+void __cdecl
+ExtErr (
+  PCSTR  Format,
+  ...
+  )
+{
+  va_list  Args;
+
+  va_start (Args, Format);
+  g_ExtControl->OutputVaList (DEBUG_OUTPUT_ERROR, Format, Args);
+  va_end (Args);
+}
+
+// Warning output.
+void __cdecl
+ExtWarn (
+  PCSTR  Format,
+  ...
+  )
+{
+  va_list  Args;
+
+  va_start (Args, Format);
+  g_ExtControl->OutputVaList (DEBUG_OUTPUT_WARNING, Format, Args);
+  va_end (Args);
+}
+
+extern "C"
+HRESULT
+CALLBACK
+DebugExtensionInitialize (
+  PULONG  Version,
+  PULONG  Flags
+  )
+{
+  IDebugClient    *DebugClient;
+  PDEBUG_CONTROL  DebugControl;
+  HRESULT         Hr;
+
+  *Version = DEBUG_EXTENSION_VERSION (1, 0);
+  *Flags   = 0;
+  Hr       = S_OK;
+
+  if ((Hr = DebugCreate (
+              __uuidof (IDebugClient),
+              (void **)&DebugClient
+              )) != S_OK)
+  {
+    return Hr;
+  }
+
+  if ((Hr = DebugClient->QueryInterface (
+                           __uuidof (IDebugControl),
+                           (void **)&DebugControl
+                           )) == S_OK)
+  {
+    //
+    // Get the windbg-style extension APIS
+    //
+    ExtensionApis.nSize = sizeof (ExtensionApis);
+    Hr                  = DebugControl->GetWindbgExtensionApis64 (&ExtensionApis);
+
+    DebugControl->Release ();
+  }
+
+  DebugClient->Release ();
+  return Hr;
+}
+
+extern "C"
+void
+CALLBACK
+DebugExtensionNotify (
+  ULONG    Notify,
+  ULONG64  Argument
+  )
+{
+  UNREFERENCED_PARAMETER (Argument);
+
+  //
+  // The first time we actually connect to a target
+  //
+
+  if ((Notify == DEBUG_NOTIFY_SESSION_ACCESSIBLE) && (!Connected)) {
+    IDebugClient    *DebugClient;
+    HRESULT         Hr;
+    PDEBUG_CONTROL  DebugControl;
+
+    if ((Hr = DebugCreate (
+                __uuidof (IDebugClient),
+                (void **)&DebugClient
+                )) == S_OK)
+    {
+      //
+      // Get the architecture type.
+      //
+
+      if ((Hr = DebugClient->QueryInterface (
+                               __uuidof (IDebugControl),
+                               (void **)&DebugControl
+                               )) == S_OK)
+      {
+        if ((Hr = DebugControl->GetActualProcessorType (
+                                  &TargetMachine
+                                  )) == S_OK)
+        {
+          Connected = TRUE;
+        }
+
+        NotifyOnTargetAccessible (DebugControl);
+
+        DebugControl->Release ();
+      }
+
+      DebugClient->Release ();
+    }
+  }
+
+  if (Notify == DEBUG_NOTIFY_SESSION_INACTIVE) {
+    Connected     = FALSE;
+    TargetMachine = 0;
+  }
+
+  return;
+}
+
+extern "C"
+void
+CALLBACK
+DebugExtensionUninitialize (
+  void
+  )
+{
+  return;
+}
+
+extern "C"
+HRESULT
+CALLBACK
+KnownStructOutput (
+  _In_ ULONG Flag,
+  _In_ ULONG64 Address,
+  _In_ PSTR StructName,
+  _Out_writes_opt_ (*BufferSize) PSTR Buffer,
+  _Inout_opt_ _When_ (Flag == DEBUG_KNOWN_STRUCT_GET_NAMES, _Notnull_) _When_ (Flag == DEBUG_KNOWN_STRUCT_GET_SINGLE_LINE_OUTPUT, _Notnull_) PULONG BufferSize
+  )
+{
+  const char  *KnownStructs[] = { "_LARGE_INTEGER", "_SYSTEMTIME", NULL };
+  HRESULT     Hr              = S_OK;
+
+  if ((Flag == DEBUG_KNOWN_STRUCT_GET_NAMES) && (Buffer != NULL) && (BufferSize != NULL)) {
+    //
+    // Return names of known structs in multi string
+    //
+    ULONG  SizeRemaining = *BufferSize, SizeNeeded = 0, Length;
+    PCHAR  CopyAt = Buffer;
+
+    for (ULONG i = 0; KnownStructs[i] != NULL; i++) {
+      if ((SizeRemaining > (Length = (ULONG)strlen (KnownStructs[i]) + 1)) &&
+          (Hr == S_OK))
+      {
+        Hr = StringCbCopy (CopyAt, SizeRemaining, KnownStructs[i]);
+
+        SizeRemaining -= Length;
+        CopyAt        += Length;
+      } else {
+        Hr = S_FALSE;
+      }
+
+      SizeNeeded += Length;
+    }
+
+    if ((SizeRemaining > 0) && (Hr == S_OK)) {
+      // Terminate multistring and return size copied
+      *CopyAt = 0;
+    } else {
+      Hr = S_FALSE;
+    }
+
+    // return size copied
+    *BufferSize = SizeNeeded+1;
+  } else if ((Flag == DEBUG_KNOWN_STRUCT_GET_SINGLE_LINE_OUTPUT) && (Buffer != NULL) && (BufferSize != NULL)) {
+    if (!strcmp (StructName, KnownStructs[0])) {
+      ULONG64  Data;
+      ULONG    ret;
+
+      if (ReadMemory (Address, &Data, sizeof (Data), &ret)) {
+        Hr = StringCbPrintf (Buffer, *BufferSize, " { %lx`%lx }", (ULONG)(Data >> 32), (ULONG)Data);
+      } else {
+        Hr = E_INVALIDARG;
+      }
+    } else if (!strcmp (StructName, KnownStructs[1])) {
+      SYSTEMTIME  Data;
+      ULONG       ret;
+
+      if (ReadMemory (Address, &Data, sizeof (Data), &ret)) {
+        Hr = StringCbPrintf (
+               Buffer,
+               *BufferSize,
+               " { %02lu:%02lu:%02lu %02lu/%02lu/%04lu }",
+               Data.wHour,
+               Data.wMinute,
+               Data.wSecond,
+               Data.wMonth,
+               Data.wDay,
+               Data.wYear
+               );
+      } else {
+        Hr = E_INVALIDARG;
+      }
+    } else {
+      Hr = E_INVALIDARG;
+    }
+  } else if (Flag == DEBUG_KNOWN_STRUCT_SUPPRESS_TYPE_NAME) {
+    if (!strcmp (StructName, KnownStructs[0])) {
+      // Do not print type name for KnownStructs[0]
+      Hr = S_OK;
+    } else {
+      // Print the type name
+      Hr = S_FALSE;
+    }
+
+    if (Buffer) {
+      Buffer[0] = 0;
+    }
+  } else {
+    Hr = E_INVALIDARG;
+  }
+
+  return Hr;
+}
+
+extern "C"
+HRESULT
+_EFN_Analyze (
+  _In_ PDEBUG_CLIENT4             Client,
+  _In_ FA_EXTENSION_PLUGIN_PHASE  CallPhase,
+  _In_ PDEBUG_FAILURE_ANALYSIS2   pAnalysis
+  )
+{
+  INIT_API ();
+
+  // Analysis tags
+  #define FA_TAG_SAMPLE_PLUGIN_DEBUG_TEXT  0xA0000000
+
+  ExtOut ("DbgExts Analysis Phase: %lx\n", CallPhase);
+  switch (CallPhase) {
+    case FA_PLUGIN_STACK_ANALYSIS:
+      pAnalysis->SetString (
+                   (FA_TAG)FA_TAG_SAMPLE_PLUGIN_DEBUG_TEXT,
+                   "Sample custom analyzer was run for this analysis.\n"
+                   );
+      break;
+    case FA_PLUGIN_POST_BUCKETING:
+      PFA_ENTRY  Entry;
+
+      //
+      // Set default bucket if folowup module in dbgeng
+      //
+      if (((Entry = pAnalysis->Get (DEBUG_FLR_MODULE_NAME)) != NULL) &&
+          !strcmp (FA_ENTRY_DATA (PSTR, Entry), "dbgeng"))
+      {
+        pAnalysis->SetString (DEBUG_FLR_DEFAULT_BUCKET_ID, "AV_IN_DEBUGGER");
+      }
+
+      break;
+    default:
+      // do nothing
+      EXIT_API ();
+      return S_OK;
+  }
+
+  UNREFERENCED_PARAMETER (pAnalysis);
+
+  EXIT_API ();
+  return S_OK;
+}