[Feature]: Provide a hook API when stack overflow occur with stack protection enabled

[MarcChen46]

Feature Overview

[Background]
Currently we have EFI_CPU_ARCH_PROTOCOL.RegisterInterruptHandler() for DXE_DRIVER and EFI_SMM_CPU_SERVICE_PROTOCOL.RegisterExceptionHandler() for DXE_SMM_DRIVER to register EXCEPT_IA32_STACK_FAULT type that can perform some customized actions when stack overflow occurred with stack protection enabled, but it has a dependency that the customized code can only get performed after these protocols get installed, it is the gap we want to resolve.

[Feature request]
When stack overflow occurred in any protected modules types(ex: DXE_DRIVER, DXE_CORE, SMM_CORE, DXE_SMM_DRIVER...), it should provide a hook API or mechanism that allow platform to add customized code (ex: report the error to somewhere as telemetry), the customized should not have dependency on protocols.

Solution Overview

Below is just a proposal for reference, it is ok to have any other kind of methods to achieve it.
[Proposal]
Implement a MU version of BaseStackCheckLib instance and implement below code in BaseStackCheckMsft.c, use MSFT VS compiler to compile this C code that has an customized hook API inside __report_gsfailure.

NORETURN VOID __cdecl
__report_gsfailure (
  void
  )
{
  DEBUG ((DEBUG_ERROR, "(__report_gsfailure) STACK PROTECTION : Violation detected\n"));

  CustomizedHook ();  // API provided by another new added library class
  CpuDeadLoop ();
}

Alternatives Considered

No response

Urgency

Low

Are you going to implement the feature request?

Someone else needs to implement the feature

Do you need maintainer feedback?

Maintainer feedback requested

Anything else?

No response

[github-actions]

This issue has been automatically marked as stale because it has not had activity in 45 days. It will be closed if no further activity occurs within 7 days. Thank you for your contributions.

[github-actions]

This issue has been automatically been closed because it did not have any activity in 45 days and no follow up within 7 days after being marked stale. Thank you for your contributions.

[MarcChen46]

@TaylorBeebe, sorry, I did not notice the issue would be closed automatically, may I know if there is any plan for this feature request? can we re-open this issue?

[TaylorBeebe]

@TaylorBeebe, sorry, I did not notice the issue would be closed automatically, may I know if there is any plan for this feature request? can we re-open this issue?

This feature request is in progress -- reopened the issue

[github-actions]

This issue has been automatically marked as stale because it has not had activity in 45 days. It will be closed if no further activity occurs within 7 days. Thank you for your contributions.

[TaylorBeebe]

@MarcChen46
This feature will be completed soon. I posted a draft PR which will be cleaned up over the coming days. I'll ping this issue when the PR is out of draft status. #610

[TaylorBeebe]

PR is out of draft status.

[TaylorBeebe]

Feature completed