UefiCpuPkg: Merge StuffRsb.inc files into one in UefiCpuPkg/Include

REF:https://bugzilla.tianocore.org/show_bug.cgi?id=1091

Previously, when compiling NASM source files, BaseTools did not support
including files outside of the NASM source file directory. As a result, we
duplicated multiple copies of "StuffRsb.inc" files in UefiCpuPkg. Those
INC files contain the common logic to stuff the Return Stack Buffer and
are identical.

After the fix of BZ 1085:
https://bugzilla.tianocore.org/show_bug.cgi?id=1085
The above support was introduced.

Thus, this commit will merge all the StuffRsb.inc files in UefiCpuPkg into
one file. The merged file will be named 'StuffRsbNasm.inc' and be placed
under folder UefiCpuPkg/Include/.

Cc: Ruiyu Ni <ruiyu.ni@intel.com>
Contributed-under: TianoCore Contribution Agreement 1.1
Signed-off-by: Hao Wu <hao.a.wu@intel.com>
Reviewed-by: Eric Dong <eric.dong@intel.com>
Reviewed-by: Laszlo Ersek <lersek@redhat.com>

3 files changed, 2 insertions, 57 deletions

diff --git a/UefiCpuPkg/PiSmmCpuDxeSmm/X64/SmiEntry.nasm b/UefiCpuPkg/PiSmmCpuDxeSmm/X64/SmiEntry.nasm
index 414b5ab5fa..807b309b27 100644
--- a/UefiCpuPkg/PiSmmCpuDxeSmm/X64/SmiEntry.nasm
+++ b/UefiCpuPkg/PiSmmCpuDxeSmm/X64/SmiEntry.nasm
@@ -18,7 +18,7 @@
 ;

 ;-------------------------------------------------------------------------------

 

-%include "StuffRsb.inc"

+%include "StuffRsbNasm.inc"

 

 ;

 ; Variables referrenced by C code

diff --git a/UefiCpuPkg/PiSmmCpuDxeSmm/X64/SmmInit.nasm b/UefiCpuPkg/PiSmmCpuDxeSmm/X64/SmmInit.nasm
index 24357d5870..5ba45cd8e0 100644
--- a/UefiCpuPkg/PiSmmCpuDxeSmm/X64/SmmInit.nasm
+++ b/UefiCpuPkg/PiSmmCpuDxeSmm/X64/SmmInit.nasm
@@ -18,7 +18,7 @@
 ;

 ;-------------------------------------------------------------------------------

 

-%include "StuffRsb.inc"

+%include "StuffRsbNasm.inc"

 

 extern ASM_PFX(SmmInitHandler)

 extern ASM_PFX(mRebasedFlag)

diff --git a/UefiCpuPkg/PiSmmCpuDxeSmm/X64/StuffRsb.inc b/UefiCpuPkg/PiSmmCpuDxeSmm/X64/StuffRsb.inc
deleted file mode 100644
index 14267c3fde..0000000000
--- a/UefiCpuPkg/PiSmmCpuDxeSmm/X64/StuffRsb.inc
+++ /dev/null
@@ -1,55 +0,0 @@
-;------------------------------------------------------------------------------

-;

-; Copyright (c) 2018, Intel Corporation. All rights reserved.<BR>

-; This program and the accompanying materials

-; are licensed and made available under the terms and conditions of the BSD License

-; which accompanies this distribution.  The full text of the license may be found at

-; http://opensource.org/licenses/bsd-license.php.

-;

-; THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,

-; WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.

-;

-; Abstract:

-;

-;   This file provides macro definitions for stuffing the Return Stack Buffer (RSB).

-;

-;------------------------------------------------------------------------------

-

-%define RSB_STUFF_ENTRIES 0x20

-

-;

-; parameters:

-; @param 1: register to use as counter (e.g. IA32:eax, X64:rax)

-; @param 2: stack pointer to restore   (IA32:esp, X64:rsp)

-; @param 3: the size of a stack frame  (IA32:4, X64:8)

-;

-%macro StuffRsb 3

-      mov     %1, RSB_STUFF_ENTRIES / 2

-  %%Unroll1:

-      call    %%Unroll2

-  %%SpecTrap1:

-      pause

-      lfence

-      jmp     %%SpecTrap1

-  %%Unroll2:

-      call    %%StuffLoop

-  %%SpecTrap2:

-      pause

-      lfence

-      jmp     %%SpecTrap2

-  %%StuffLoop:

-      dec     %1

-      jnz     %%Unroll1

-      add     %2, RSB_STUFF_ENTRIES * %3 ; Restore the stack pointer

-%endmacro

-

-;

-; RSB stuffing macros for IA32 and X64

-;

-%macro StuffRsb32 0

-      StuffRsb     eax, esp, 4

-%endmacro

-

-%macro StuffRsb64 0

-      StuffRsb     rax, rsp, 8

-%endmacro