* [Patch 1/2] MdePkg/Include/IndustryStandard: Address C++ keyword collisions
2023-05-29 17:06 [Patch 0/2] Address C++ keyword collisions Michael D Kinney
@ 2023-05-29 17:06 ` Michael D Kinney
2023-05-30 4:14 ` [edk2-devel] " Yao, Jiewen
2023-05-29 17:06 ` [Patch 2/2] SecurityPkg/Library/TpmCommandLib: Change xor to Xor Michael D Kinney
` (2 subsequent siblings)
3 siblings, 1 reply; 7+ messages in thread
From: Michael D Kinney @ 2023-05-29 17:06 UTC (permalink / raw)
To: devel
Cc: Liming Gao, Zhiguang Liu, Oliver Smith-Denny, Pedro Falcato,
Aaron Pop
Update Tpm12.h and Tpm20.h and not use c++ reserved keywords
operator and xor in C structures to support use of these
include files when building with a C++ compiler.
* Change operator -> Operator
* Change xor -> Xor
NOTE: This is a non-backwards compatible change to Tpm12.h
and Tmp20.h. And consumers of these include files that access
the "operator" or "xor" fields must be updated.
Cc: Liming Gao <gaoliming@byosoft.com.cn>
Cc: Zhiguang Liu <zhiguang.liu@intel.com>
Cc: Oliver Smith-Denny <osde@linux.microsoft.com>
Cc: Pedro Falcato <pedro.falcato@gmail.com>
Cc: Aaron Pop <aaronpop@microsoft.com>
Signed-off-by: Michael D Kinney <michael.d.kinney@intel.com>
---
MdePkg/Include/IndustryStandard/Tpm12.h | 4 ++--
MdePkg/Include/IndustryStandard/Tpm20.h | 4 ++--
2 files changed, 4 insertions(+), 4 deletions(-)
diff --git a/MdePkg/Include/IndustryStandard/Tpm12.h b/MdePkg/Include/IndustryStandard/Tpm12.h
index 155dcc9f5f99..147c0863fffd 100644
--- a/MdePkg/Include/IndustryStandard/Tpm12.h
+++ b/MdePkg/Include/IndustryStandard/Tpm12.h
@@ -744,8 +744,8 @@ typedef struct tdTPM_PERMANENT_FLAGS {
BOOLEAN TPMpost;
BOOLEAN TPMpostLock;
BOOLEAN FIPS;
- BOOLEAN operator;
- BOOLEAN enableRevokeEK;
+ BOOLEAN Operator;
+ BOOLEAN enableRevokeEK;
BOOLEAN nvLocked;
BOOLEAN readSRKPub;
BOOLEAN tpmEstablished;
diff --git a/MdePkg/Include/IndustryStandard/Tpm20.h b/MdePkg/Include/IndustryStandard/Tpm20.h
index 4440f3769f26..c827af13efd0 100644
--- a/MdePkg/Include/IndustryStandard/Tpm20.h
+++ b/MdePkg/Include/IndustryStandard/Tpm20.h
@@ -1247,7 +1247,7 @@ typedef union {
TPMI_AES_KEY_BITS aes;
TPMI_SM4_KEY_BITS SM4;
TPM_KEY_BITS sym;
- TPMI_ALG_HASH xor;
+ TPMI_ALG_HASH Xor;
} TPMU_SYM_KEY_BITS;
// Table 123 - TPMU_SYM_MODE Union
@@ -1320,7 +1320,7 @@ typedef struct {
// Table 136 - TPMU_SCHEME_KEYEDHASH Union
typedef union {
TPMS_SCHEME_HMAC hmac;
- TPMS_SCHEME_XOR xor;
+ TPMS_SCHEME_XOR Xor;
} TPMU_SCHEME_KEYEDHASH;
// Table 137 - TPMT_KEYEDHASH_SCHEME Structure
--
2.40.1.windows.1
^ permalink raw reply related [flat|nested] 7+ messages in thread* Re: [edk2-devel] [Patch 1/2] MdePkg/Include/IndustryStandard: Address C++ keyword collisions
2023-05-29 17:06 ` [Patch 1/2] MdePkg/Include/IndustryStandard: " Michael D Kinney
@ 2023-05-30 4:14 ` Yao, Jiewen
0 siblings, 0 replies; 7+ messages in thread
From: Yao, Jiewen @ 2023-05-30 4:14 UTC (permalink / raw)
To: devel@edk2.groups.io, Kinney, Michael D
Cc: Gao, Liming, Liu, Zhiguang, Oliver Smith-Denny, Pedro Falcato,
Pop, Aaron
Reviewed-by: Jiewen Yao <Jiewen.yao@intel.com>
> -----Original Message-----
> From: devel@edk2.groups.io <devel@edk2.groups.io> On Behalf Of Michael D
> Kinney
> Sent: Tuesday, May 30, 2023 1:07 AM
> To: devel@edk2.groups.io
> Cc: Gao, Liming <gaoliming@byosoft.com.cn>; Liu, Zhiguang
> <zhiguang.liu@intel.com>; Oliver Smith-Denny <osde@linux.microsoft.com>;
> Pedro Falcato <pedro.falcato@gmail.com>; Pop, Aaron
> <aaronpop@microsoft.com>
> Subject: [edk2-devel] [Patch 1/2] MdePkg/Include/IndustryStandard: Address
> C++ keyword collisions
>
> Update Tpm12.h and Tpm20.h and not use c++ reserved keywords
> operator and xor in C structures to support use of these
> include files when building with a C++ compiler.
>
> * Change operator -> Operator
> * Change xor -> Xor
>
> NOTE: This is a non-backwards compatible change to Tpm12.h
> and Tmp20.h. And consumers of these include files that access
> the "operator" or "xor" fields must be updated.
>
> Cc: Liming Gao <gaoliming@byosoft.com.cn>
> Cc: Zhiguang Liu <zhiguang.liu@intel.com>
> Cc: Oliver Smith-Denny <osde@linux.microsoft.com>
> Cc: Pedro Falcato <pedro.falcato@gmail.com>
> Cc: Aaron Pop <aaronpop@microsoft.com>
> Signed-off-by: Michael D Kinney <michael.d.kinney@intel.com>
> ---
> MdePkg/Include/IndustryStandard/Tpm12.h | 4 ++--
> MdePkg/Include/IndustryStandard/Tpm20.h | 4 ++--
> 2 files changed, 4 insertions(+), 4 deletions(-)
>
> diff --git a/MdePkg/Include/IndustryStandard/Tpm12.h
> b/MdePkg/Include/IndustryStandard/Tpm12.h
> index 155dcc9f5f99..147c0863fffd 100644
> --- a/MdePkg/Include/IndustryStandard/Tpm12.h
> +++ b/MdePkg/Include/IndustryStandard/Tpm12.h
> @@ -744,8 +744,8 @@ typedef struct tdTPM_PERMANENT_FLAGS {
> BOOLEAN TPMpost;
> BOOLEAN TPMpostLock;
> BOOLEAN FIPS;
> - BOOLEAN operator;
> - BOOLEAN enableRevokeEK;
> + BOOLEAN Operator;
> + BOOLEAN enableRevokeEK;
> BOOLEAN nvLocked;
> BOOLEAN readSRKPub;
> BOOLEAN tpmEstablished;
> diff --git a/MdePkg/Include/IndustryStandard/Tpm20.h
> b/MdePkg/Include/IndustryStandard/Tpm20.h
> index 4440f3769f26..c827af13efd0 100644
> --- a/MdePkg/Include/IndustryStandard/Tpm20.h
> +++ b/MdePkg/Include/IndustryStandard/Tpm20.h
> @@ -1247,7 +1247,7 @@ typedef union {
> TPMI_AES_KEY_BITS aes;
> TPMI_SM4_KEY_BITS SM4;
> TPM_KEY_BITS sym;
> - TPMI_ALG_HASH xor;
> + TPMI_ALG_HASH Xor;
> } TPMU_SYM_KEY_BITS;
>
> // Table 123 - TPMU_SYM_MODE Union
> @@ -1320,7 +1320,7 @@ typedef struct {
> // Table 136 - TPMU_SCHEME_KEYEDHASH Union
> typedef union {
> TPMS_SCHEME_HMAC hmac;
> - TPMS_SCHEME_XOR xor;
> + TPMS_SCHEME_XOR Xor;
> } TPMU_SCHEME_KEYEDHASH;
>
> // Table 137 - TPMT_KEYEDHASH_SCHEME Structure
> --
> 2.40.1.windows.1
>
>
>
>
>
^ permalink raw reply [flat|nested] 7+ messages in thread
* [Patch 2/2] SecurityPkg/Library/TpmCommandLib: Change xor to Xor
2023-05-29 17:06 [Patch 0/2] Address C++ keyword collisions Michael D Kinney
2023-05-29 17:06 ` [Patch 1/2] MdePkg/Include/IndustryStandard: " Michael D Kinney
@ 2023-05-29 17:06 ` Michael D Kinney
2023-05-30 12:10 ` [Patch 0/2] Address C++ keyword collisions Pedro Falcato
2023-05-30 16:26 ` [edk2-devel] " Oliver Smith-Denny
3 siblings, 0 replies; 7+ messages in thread
From: Michael D Kinney @ 2023-05-29 17:06 UTC (permalink / raw)
To: devel; +Cc: Jiewen Yao, Jian J Wang, Oliver Smith-Denny, Pedro Falcato,
Aaron Pop
Change xor to Xor to avoid C++ reserved work name collisions
when building with C++ compilers.
NOTE: This is a non-backwards compatible change to Tpm12.h
and Tmp20.h. And consumers of these include files that access
the "operator" or "xor" fields must be updated.
Cc: Jiewen Yao <jiewen.yao@intel.com>
Cc: Jian J Wang <jian.j.wang@intel.com>
Cc: Oliver Smith-Denny <osde@linux.microsoft.com>
Cc: Pedro Falcato <pedro.falcato@gmail.com>
Cc: Aaron Pop <aaronpop@microsoft.com>
Signed-off-by: Michael D Kinney <michael.d.kinney@intel.com>
---
SecurityPkg/Library/Tpm2CommandLib/Tpm2Capability.c | 6 +++---
SecurityPkg/Library/Tpm2CommandLib/Tpm2Object.c | 6 +++---
SecurityPkg/Library/Tpm2CommandLib/Tpm2Session.c | 2 +-
3 files changed, 7 insertions(+), 7 deletions(-)
diff --git a/SecurityPkg/Library/Tpm2CommandLib/Tpm2Capability.c b/SecurityPkg/Library/Tpm2CommandLib/Tpm2Capability.c
index f0e6019a47be..f8c781a445a1 100644
--- a/SecurityPkg/Library/Tpm2CommandLib/Tpm2Capability.c
+++ b/SecurityPkg/Library/Tpm2CommandLib/Tpm2Capability.c
@@ -734,9 +734,9 @@ Tpm2TestParms (
Buffer += sizeof (UINT16);
break;
case TPM_ALG_XOR:
- WriteUnaligned16 ((UINT16 *)Buffer, SwapBytes16 (Parameters->parameters.keyedHashDetail.scheme.details.xor.hashAlg));
+ WriteUnaligned16 ((UINT16 *)Buffer, SwapBytes16 (Parameters->parameters.keyedHashDetail.scheme.details.Xor.hashAlg));
Buffer += sizeof (UINT16);
- WriteUnaligned16 ((UINT16 *)Buffer, SwapBytes16 (Parameters->parameters.keyedHashDetail.scheme.details.xor.kdf));
+ WriteUnaligned16 ((UINT16 *)Buffer, SwapBytes16 (Parameters->parameters.keyedHashDetail.scheme.details.Xor.kdf));
Buffer += sizeof (UINT16);
break;
default:
@@ -761,7 +761,7 @@ Tpm2TestParms (
Buffer += sizeof (UINT16);
break;
case TPM_ALG_XOR:
- WriteUnaligned16 ((UINT16 *)Buffer, SwapBytes16 (Parameters->parameters.symDetail.keyBits.xor));
+ WriteUnaligned16 ((UINT16 *)Buffer, SwapBytes16 (Parameters->parameters.symDetail.keyBits.Xor));
Buffer += sizeof (UINT16);
break;
case TPM_ALG_NULL:
diff --git a/SecurityPkg/Library/Tpm2CommandLib/Tpm2Object.c b/SecurityPkg/Library/Tpm2CommandLib/Tpm2Object.c
index 335957d6cedc..578a61b20339 100644
--- a/SecurityPkg/Library/Tpm2CommandLib/Tpm2Object.c
+++ b/SecurityPkg/Library/Tpm2CommandLib/Tpm2Object.c
@@ -169,9 +169,9 @@ Tpm2ReadPublic (
Buffer += sizeof (UINT16);
break;
case TPM_ALG_XOR:
- OutPublic->publicArea.parameters.keyedHashDetail.scheme.details.xor.hashAlg = SwapBytes16 (ReadUnaligned16 ((UINT16 *)Buffer));
+ OutPublic->publicArea.parameters.keyedHashDetail.scheme.details.Xor.hashAlg = SwapBytes16 (ReadUnaligned16 ((UINT16 *)Buffer));
Buffer += sizeof (UINT16);
- OutPublic->publicArea.parameters.keyedHashDetail.scheme.details.xor.kdf = SwapBytes16 (ReadUnaligned16 ((UINT16 *)Buffer));
+ OutPublic->publicArea.parameters.keyedHashDetail.scheme.details.Xor.kdf = SwapBytes16 (ReadUnaligned16 ((UINT16 *)Buffer));
Buffer += sizeof (UINT16);
break;
default:
@@ -195,7 +195,7 @@ Tpm2ReadPublic (
Buffer += sizeof (UINT16);
break;
case TPM_ALG_XOR:
- OutPublic->publicArea.parameters.symDetail.keyBits.xor = SwapBytes16 (ReadUnaligned16 ((UINT16 *)Buffer));
+ OutPublic->publicArea.parameters.symDetail.keyBits.Xor = SwapBytes16 (ReadUnaligned16 ((UINT16 *)Buffer));
Buffer += sizeof (UINT16);
break;
case TPM_ALG_NULL:
diff --git a/SecurityPkg/Library/Tpm2CommandLib/Tpm2Session.c b/SecurityPkg/Library/Tpm2CommandLib/Tpm2Session.c
index 7f247da301fe..e17318b6e6fb 100644
--- a/SecurityPkg/Library/Tpm2CommandLib/Tpm2Session.c
+++ b/SecurityPkg/Library/Tpm2CommandLib/Tpm2Session.c
@@ -119,7 +119,7 @@ Tpm2StartAuthSession (
Buffer += sizeof (UINT16);
break;
case TPM_ALG_XOR:
- WriteUnaligned16 ((UINT16 *)Buffer, SwapBytes16 (Symmetric->keyBits.xor));
+ WriteUnaligned16 ((UINT16 *)Buffer, SwapBytes16 (Symmetric->keyBits.Xor));
Buffer += sizeof (UINT16);
break;
default:
--
2.40.1.windows.1
^ permalink raw reply related [flat|nested] 7+ messages in thread* Re: [Patch 0/2] Address C++ keyword collisions
2023-05-29 17:06 [Patch 0/2] Address C++ keyword collisions Michael D Kinney
2023-05-29 17:06 ` [Patch 1/2] MdePkg/Include/IndustryStandard: " Michael D Kinney
2023-05-29 17:06 ` [Patch 2/2] SecurityPkg/Library/TpmCommandLib: Change xor to Xor Michael D Kinney
@ 2023-05-30 12:10 ` Pedro Falcato
2023-05-30 18:57 ` Michael D Kinney
2023-05-30 16:26 ` [edk2-devel] " Oliver Smith-Denny
3 siblings, 1 reply; 7+ messages in thread
From: Pedro Falcato @ 2023-05-30 12:10 UTC (permalink / raw)
To: Michael D Kinney
Cc: devel, Liming Gao, Zhiguang Liu, Oliver Smith-Denny, Aaron Pop
On Mon, May 29, 2023 at 6:06 PM Michael D Kinney
<michael.d.kinney@intel.com> wrote:
>
> Update Tpm12.h and Tpm20.h and not use c++ reserved keywords
> operator and xor in C structures to support use of these
> include files when building with a C++ compiler.
>
> Update SecurityPkg Tpm2CommandLib to use updated field names.
>
> * Change operator -> Operator
> * Change xor -> Xor
>
> NOTE: This is a non-backwards compatible change to Tpm12.h
> and Tmp20.h. And consumers of these include files that access
> the "operator" or "xor" fields must be updated.
>
> Cc: Liming Gao <gaoliming@byosoft.com.cn>
> Cc: Zhiguang Liu <zhiguang.liu@intel.com>
> Cc: Oliver Smith-Denny <osde@linux.microsoft.com>
> Cc: Pedro Falcato <pedro.falcato@gmail.com>
> Cc: Aaron Pop <aaronpop@microsoft.com>
> Signed-off-by: Michael D Kinney <michael.d.kinney@intel.com>
>
> Michael D Kinney (2):
> MdePkg/Include/IndustryStandard: Address C++ keyword collisions
> SecurityPkg/Library/TpmCommandLib: Change xor to Xor
>
> MdePkg/Include/IndustryStandard/Tpm12.h | 4 ++--
> MdePkg/Include/IndustryStandard/Tpm20.h | 4 ++--
> SecurityPkg/Library/Tpm2CommandLib/Tpm2Capability.c | 6 +++---
> SecurityPkg/Library/Tpm2CommandLib/Tpm2Object.c | 6 +++---
> SecurityPkg/Library/Tpm2CommandLib/Tpm2Session.c | 2 +-
> 5 files changed, 11 insertions(+), 11 deletions(-)
>
> --
> 2.40.1.windows.1
>
For the series:
Reviewed-by: Pedro Falcato <pedro.falcato@gmail.com>
Make sure you squash these two commits into one, as to not break bisectability.
--
Pedro
^ permalink raw reply [flat|nested] 7+ messages in thread
* Re: [Patch 0/2] Address C++ keyword collisions
2023-05-30 12:10 ` [Patch 0/2] Address C++ keyword collisions Pedro Falcato
@ 2023-05-30 18:57 ` Michael D Kinney
0 siblings, 0 replies; 7+ messages in thread
From: Michael D Kinney @ 2023-05-30 18:57 UTC (permalink / raw)
To: Pedro Falcato
Cc: devel@edk2.groups.io, Gao, Liming, Liu, Zhiguang,
Oliver Smith-Denny, Pop, Aaron, Kinney, Michael D
Hi Pedro,
Great point on bisect. It is also important to provide patches
that allow downstream usage of these fields to be able to
use a subset of the patches that support both field names
so they can update and test their code before using the full
patch series that removes the old field name.
I have sent V2 of this series that temporarily uses an
anonymous union to support old and new field names.
Mike
> -----Original Message-----
> From: Pedro Falcato <pedro.falcato@gmail.com>
> Sent: Tuesday, May 30, 2023 5:10 AM
> To: Kinney, Michael D <michael.d.kinney@intel.com>
> Cc: devel@edk2.groups.io; Gao, Liming <gaoliming@byosoft.com.cn>; Liu,
> Zhiguang <zhiguang.liu@intel.com>; Oliver Smith-Denny
> <osde@linux.microsoft.com>; Pop, Aaron <aaronpop@microsoft.com>
> Subject: Re: [Patch 0/2] Address C++ keyword collisions
>
> On Mon, May 29, 2023 at 6:06 PM Michael D Kinney
> <michael.d.kinney@intel.com> wrote:
> >
> > Update Tpm12.h and Tpm20.h and not use c++ reserved keywords
> > operator and xor in C structures to support use of these
> > include files when building with a C++ compiler.
> >
> > Update SecurityPkg Tpm2CommandLib to use updated field names.
> >
> > * Change operator -> Operator
> > * Change xor -> Xor
> >
> > NOTE: This is a non-backwards compatible change to Tpm12.h
> > and Tmp20.h. And consumers of these include files that access
> > the "operator" or "xor" fields must be updated.
> >
> > Cc: Liming Gao <gaoliming@byosoft.com.cn>
> > Cc: Zhiguang Liu <zhiguang.liu@intel.com>
> > Cc: Oliver Smith-Denny <osde@linux.microsoft.com>
> > Cc: Pedro Falcato <pedro.falcato@gmail.com>
> > Cc: Aaron Pop <aaronpop@microsoft.com>
> > Signed-off-by: Michael D Kinney <michael.d.kinney@intel.com>
> >
> > Michael D Kinney (2):
> > MdePkg/Include/IndustryStandard: Address C++ keyword collisions
> > SecurityPkg/Library/TpmCommandLib: Change xor to Xor
> >
> > MdePkg/Include/IndustryStandard/Tpm12.h | 4 ++--
> > MdePkg/Include/IndustryStandard/Tpm20.h | 4 ++--
> > SecurityPkg/Library/Tpm2CommandLib/Tpm2Capability.c | 6 +++---
> > SecurityPkg/Library/Tpm2CommandLib/Tpm2Object.c | 6 +++---
> > SecurityPkg/Library/Tpm2CommandLib/Tpm2Session.c | 2 +-
> > 5 files changed, 11 insertions(+), 11 deletions(-)
> >
> > --
> > 2.40.1.windows.1
> >
>
> For the series:
>
> Reviewed-by: Pedro Falcato <pedro.falcato@gmail.com>
>
> Make sure you squash these two commits into one, as to not break
> bisectability.
>
> --
> Pedro
^ permalink raw reply [flat|nested] 7+ messages in thread
* Re: [edk2-devel] [Patch 0/2] Address C++ keyword collisions
2023-05-29 17:06 [Patch 0/2] Address C++ keyword collisions Michael D Kinney
` (2 preceding siblings ...)
2023-05-30 12:10 ` [Patch 0/2] Address C++ keyword collisions Pedro Falcato
@ 2023-05-30 16:26 ` Oliver Smith-Denny
3 siblings, 0 replies; 7+ messages in thread
From: Oliver Smith-Denny @ 2023-05-30 16:26 UTC (permalink / raw)
To: devel, michael.d.kinney
Cc: Liming Gao, Zhiguang Liu, Pedro Falcato, Aaron Pop
For the patchset:
Reviewed-by: Oliver Smith-Denny <osde@linux.microsoft.com>
Thanks!
On 5/29/2023 10:06 AM, Michael D Kinney wrote:
> Update Tpm12.h and Tpm20.h and not use c++ reserved keywords
> operator and xor in C structures to support use of these
> include files when building with a C++ compiler.
>
> Update SecurityPkg Tpm2CommandLib to use updated field names.
>
> * Change operator -> Operator
> * Change xor -> Xor
>
> NOTE: This is a non-backwards compatible change to Tpm12.h
> and Tmp20.h. And consumers of these include files that access
> the "operator" or "xor" fields must be updated.
>
> Cc: Liming Gao <gaoliming@byosoft.com.cn>
> Cc: Zhiguang Liu <zhiguang.liu@intel.com>
> Cc: Oliver Smith-Denny <osde@linux.microsoft.com>
> Cc: Pedro Falcato <pedro.falcato@gmail.com>
> Cc: Aaron Pop <aaronpop@microsoft.com>
> Signed-off-by: Michael D Kinney <michael.d.kinney@intel.com>
>
> Michael D Kinney (2):
> MdePkg/Include/IndustryStandard: Address C++ keyword collisions
> SecurityPkg/Library/TpmCommandLib: Change xor to Xor
>
> MdePkg/Include/IndustryStandard/Tpm12.h | 4 ++--
> MdePkg/Include/IndustryStandard/Tpm20.h | 4 ++--
> SecurityPkg/Library/Tpm2CommandLib/Tpm2Capability.c | 6 +++---
> SecurityPkg/Library/Tpm2CommandLib/Tpm2Object.c | 6 +++---
> SecurityPkg/Library/Tpm2CommandLib/Tpm2Session.c | 2 +-
> 5 files changed, 11 insertions(+), 11 deletions(-)
>
^ permalink raw reply [flat|nested] 7+ messages in thread