* [edk2-devel] [PATCH] BaseTools/AutoGen: declare ProcessLibraryConstructorList() for SEC modules
2024-02-24 20:59 [edk2-devel] [v2] BaseTools/AutoGen: declare ProcessLibraryConstructorList() for SEC modules Laszlo Ersek
@ 2024-02-24 21:05 ` Laszlo Ersek
2024-02-25 3:32 ` [edk2-devel] 回复: " gaoliming via groups.io
2024-02-24 21:23 ` [edk2-devel] [edk2-BuildSpecification PATCH 0/3] AutoGen.h: " Laszlo Ersek
` (3 subsequent siblings)
4 siblings, 1 reply; 20+ messages in thread
From: Laszlo Ersek @ 2024-02-24 21:05 UTC (permalink / raw)
To: edk2-devel-groups-io
Cc: Bob Feng, Liming Gao, Michael D Kinney, Rebecca Cran, Yuwei Chen
Most module types have standardized entry point function prototypes. They
are declared in headers like
- MdePkg/Include/Library/PeiCoreEntryPoint.h
- MdePkg/Include/Library/PeimEntryPoint.h
- MdePkg/Include/Library/DxeCoreEntryPoint.h
- MdePkg/Include/Library/UefiDriverEntryPoint.h
- MdePkg/Include/Library/UefiApplicationEntryPoint.h
These header files also declare matching ProcessLibraryConstructorList()
prototypes.
The SEC module type does not have a standardized entry point prototype
(aka parameter list), therefore no header file like the above ones exists
for SEC. Consequently, no header file *declares*
ProcessLibraryConstructorList() for SEC modules, even though AutoGen
always *defines* ProcessLibraryConstructorList() with the same, empty,
parameter list (i.e., just (VOID)).
The lack of a central declaration is a problem because in SEC code,
ProcessLibraryConstructorList() needs to be called manually, and those
calls need a prototype. Most SEC modules in edk2 get around this by
declaring ProcessLibraryConstructorList() manually, while some others use
an incorrect (PEIM) prototype.
Liming suggested in
<https://bugzilla.tianocore.org/show_bug.cgi?id=991#c2> that AutoGen
provide the declaration as well; implement that in this patch.
Mike suggested that the feature be gated with INF_VERSION, for
compatibility reasons. (INF_VERSION >= 1.30) reflects that the latest
(draft) version of the INF specification, as of this writing, is commit
a31e3c842bee / version 1.29.
For example, if we modify "OvmfPkg/Sec/SecMain.inf" as follows:
> diff --git a/OvmfPkg/Sec/SecMain.inf b/OvmfPkg/Sec/SecMain.inf
> index 3c47a664a95d..dca932a474ee 100644
> --- a/OvmfPkg/Sec/SecMain.inf
> +++ b/OvmfPkg/Sec/SecMain.inf
> @@ -8,7 +8,7 @@
> ##
>
> [Defines]
> - INF_VERSION = 0x00010005
> + INF_VERSION = 1.30
> BASE_NAME = SecMain
> FILE_GUID = df1ccef6-f301-4a63-9661-fc6030dcc880
> MODULE_TYPE = SEC
then the patch produces the following difference in
"Build/OvmfX64/NOOPT_GCC5/X64/OvmfPkg/Sec/SecMain/DEBUG/AutoGen.h":
> --- AutoGen.h.orig 2024-02-06 23:10:23.469535345 +0100
> +++ AutoGen.h 2024-02-07 00:00:57.361294055 +0100
> @@ -220,6 +220,13 @@
>
> // Definition of PCDs used in libraries is in AutoGen.c
>
> +// ProcessLibraryConstructorList() declared here because SEC has no standard entry point.
> +VOID
> +EFIAPI
> +ProcessLibraryConstructorList (
> + VOID
> + );
> +
>
> #ifdef __cplusplus
> }
which presently (as of edk2 commit edc6681206c1) triggers the following
build error:
> In file included from OvmfPkg/Sec/SecMain.c:14:
> MdePkg/Include/Library/PeimEntryPoint.h:74:1: error: conflicting types for
> ‘ProcessLibraryConstructorList’; have ‘void(void *, const
> EFI_PEI_SERVICES **)’ {aka ‘void(void *, const struct _EFI_PEI_SERVICES
> **)’}
> 74 | ProcessLibraryConstructorList (
> | ^~~~~~~~~~~~~~~~~~~~~~~~~~~~~
> In file included from <command-line>:
> Build/OvmfX64/NOOPT_GCC5/X64/OvmfPkg/Sec/SecMain/DEBUG/AutoGen.h:226:1: note:
> previous declaration of ‘ProcessLibraryConstructorList’ with type
> ‘void(void)’
> 226 | ProcessLibraryConstructorList (
> | ^~~~~~~~~~~~~~~~~~~~~~~~~~~~~
That's a genuine bug in OvmfPkg that needs to be fixed, but we keep
compatibility with existent SEC modules until/unless they upgrade
INF_VERSION to 1.30+.
Cc: Bob Feng <bob.c.feng@intel.com>
Cc: Liming Gao <gaoliming@byosoft.com.cn>
Cc: Michael D Kinney <michael.d.kinney@intel.com>
Cc: Rebecca Cran <rebecca@bsdio.com>
Cc: Yuwei Chen <yuwei.chen@intel.com>
Ref: https://bugzilla.tianocore.org/show_bug.cgi?id=991
Suggested-by: Liming Gao <gaoliming@byosoft.com.cn>
Suggested-by: Michael D Kinney <michael.d.kinney@intel.com>
Signed-off-by: Laszlo Ersek <lersek@redhat.com>
---
Notes:
v2:
- CI run: <https://github.com/tianocore/edk2/pull/5404>
- port to edk2-basetools:
<https://github.com/tianocore/edk2-basetools/pull/120>
- depend on INF_VERSION >= 1.30 [Mike]
- extend commit message with INF_VERSION dependency
- extend commit message with example build error due to preexistent
broken ProcessLibraryConstructorList() declaration in OvmfPkg, now
caught by the auto-generated prototype
BaseTools/Source/Python/AutoGen/GenC.py | 8 ++++++++
1 file changed, 8 insertions(+)
diff --git a/BaseTools/Source/Python/AutoGen/GenC.py b/BaseTools/Source/Python/AutoGen/GenC.py
index a2053d548521..5ad10cee2898 100755
--- a/BaseTools/Source/Python/AutoGen/GenC.py
+++ b/BaseTools/Source/Python/AutoGen/GenC.py
@@ -1371,6 +1371,14 @@ def CreateLibraryConstructorCode(Info, AutoGenC, AutoGenH):
else:
if Info.ModuleType in [SUP_MODULE_BASE, SUP_MODULE_SEC, SUP_MODULE_USER_DEFINED, SUP_MODULE_HOST_APPLICATION]:
AutoGenC.Append(gLibraryString[SUP_MODULE_BASE].Replace(Dict))
+ if Info.ModuleType == SUP_MODULE_SEC and Info.AutoGenVersion >= 0x0001001E:
+ AutoGenH.Append(("\n"
+ "// ProcessLibraryConstructorList() declared here because SEC has no standard entry point.\n"
+ "VOID\n"
+ "EFIAPI\n"
+ "ProcessLibraryConstructorList (\n"
+ " VOID\n"
+ " );\n"))
elif Info.ModuleType in SUP_MODULE_SET_PEI:
AutoGenC.Append(gLibraryString['PEI'].Replace(Dict))
elif Info.ModuleType in [SUP_MODULE_DXE_CORE, SUP_MODULE_DXE_DRIVER, SUP_MODULE_DXE_SMM_DRIVER, SUP_MODULE_DXE_RUNTIME_DRIVER,
base-commit: edc6681206c1a8791981a2f911d2fb8b3d2f5768
-=-=-=-=-=-=-=-=-=-=-=-
Groups.io Links: You receive all messages sent to this group.
View/Reply Online (#115910): https://edk2.groups.io/g/devel/message/115910
Mute This Topic: https://groups.io/mt/104553716/7686176
Group Owner: devel+owner@edk2.groups.io
Unsubscribe: https://edk2.groups.io/g/devel/unsub [rebecca@openfw.io]
-=-=-=-=-=-=-=-=-=-=-=-
^ permalink raw reply related [flat|nested] 20+ messages in thread* [edk2-devel] 回复: [PATCH] BaseTools/AutoGen: declare ProcessLibraryConstructorList() for SEC modules
2024-02-24 21:05 ` [edk2-devel] [PATCH] " Laszlo Ersek
@ 2024-02-25 3:32 ` gaoliming via groups.io
2024-02-29 10:17 ` Laszlo Ersek
0 siblings, 1 reply; 20+ messages in thread
From: gaoliming via groups.io @ 2024-02-25 3:32 UTC (permalink / raw)
To: 'Laszlo Ersek', 'edk2-devel-groups-io'
Cc: 'Bob Feng', 'Michael D Kinney',
'Rebecca Cran', 'Yuwei Chen'
Laszlo:
Thanks for your work to make sure this issue be fixed. I agree this change. Reviewed-by: Liming Gao <gaoliming@byosoft.com.cn>
Thanks
Liming
> -----邮件原件-----
> 发件人: Laszlo Ersek <lersek@redhat.com>
> 发送时间: 2024年2月25日 5:05
> 收件人: edk2-devel-groups-io <devel@edk2.groups.io>
> 抄送: Bob Feng <bob.c.feng@intel.com>; Liming Gao
> <gaoliming@byosoft.com.cn>; Michael D Kinney
> <michael.d.kinney@intel.com>; Rebecca Cran <rebecca@bsdio.com>; Yuwei
> Chen <yuwei.chen@intel.com>
> 主题: [PATCH] BaseTools/AutoGen: declare ProcessLibraryConstructorList()
> for SEC modules
>
> Most module types have standardized entry point function prototypes. They
> are declared in headers like
>
> - MdePkg/Include/Library/PeiCoreEntryPoint.h
> - MdePkg/Include/Library/PeimEntryPoint.h
> - MdePkg/Include/Library/DxeCoreEntryPoint.h
> - MdePkg/Include/Library/UefiDriverEntryPoint.h
> - MdePkg/Include/Library/UefiApplicationEntryPoint.h
>
> These header files also declare matching ProcessLibraryConstructorList()
> prototypes.
>
> The SEC module type does not have a standardized entry point prototype
> (aka parameter list), therefore no header file like the above ones exists
> for SEC. Consequently, no header file *declares*
> ProcessLibraryConstructorList() for SEC modules, even though AutoGen
> always *defines* ProcessLibraryConstructorList() with the same, empty,
> parameter list (i.e., just (VOID)).
>
> The lack of a central declaration is a problem because in SEC code,
> ProcessLibraryConstructorList() needs to be called manually, and those
> calls need a prototype. Most SEC modules in edk2 get around this by
> declaring ProcessLibraryConstructorList() manually, while some others use
> an incorrect (PEIM) prototype.
>
> Liming suggested in
> <https://bugzilla.tianocore.org/show_bug.cgi?id=991#c2> that AutoGen
> provide the declaration as well; implement that in this patch.
>
> Mike suggested that the feature be gated with INF_VERSION, for
> compatibility reasons. (INF_VERSION >= 1.30) reflects that the latest
> (draft) version of the INF specification, as of this writing, is commit
> a31e3c842bee / version 1.29.
>
> For example, if we modify "OvmfPkg/Sec/SecMain.inf" as follows:
>
> > diff --git a/OvmfPkg/Sec/SecMain.inf b/OvmfPkg/Sec/SecMain.inf
> > index 3c47a664a95d..dca932a474ee 100644
> > --- a/OvmfPkg/Sec/SecMain.inf
> > +++ b/OvmfPkg/Sec/SecMain.inf
> > @@ -8,7 +8,7 @@
> > ##
> >
> > [Defines]
> > - INF_VERSION = 0x00010005
> > + INF_VERSION = 1.30
> > BASE_NAME = SecMain
> > FILE_GUID =
> df1ccef6-f301-4a63-9661-fc6030dcc880
> > MODULE_TYPE = SEC
>
> then the patch produces the following difference in
> "Build/OvmfX64/NOOPT_GCC5/X64/OvmfPkg/Sec/SecMain/DEBUG/AutoGe
> n.h":
>
> > --- AutoGen.h.orig 2024-02-06 23:10:23.469535345 +0100
> > +++ AutoGen.h 2024-02-07 00:00:57.361294055 +0100
> > @@ -220,6 +220,13 @@
> >
> > // Definition of PCDs used in libraries is in AutoGen.c
> >
> > +// ProcessLibraryConstructorList() declared here because SEC has no
> standard entry point.
> > +VOID
> > +EFIAPI
> > +ProcessLibraryConstructorList (
> > + VOID
> > + );
> > +
> >
> > #ifdef __cplusplus
> > }
>
> which presently (as of edk2 commit edc6681206c1) triggers the following
> build error:
>
> > In file included from OvmfPkg/Sec/SecMain.c:14:
> > MdePkg/Include/Library/PeimEntryPoint.h:74:1: error: conflicting types for
> > ‘ProcessLibraryConstructorList’; have ‘void(void *, const
> > EFI_PEI_SERVICES **)’ {aka ‘void(void *, const struct _EFI_PEI_SERVICES
> > **)’}
> > 74 | ProcessLibraryConstructorList (
> > | ^~~~~~~~~~~~~~~~~~~~~~~~~~~~~
> > In file included from <command-line>:
> >
> Build/OvmfX64/NOOPT_GCC5/X64/OvmfPkg/Sec/SecMain/DEBUG/AutoGen.
> h:226:1: note:
> > previous declaration of ‘ProcessLibraryConstructorList’ with type
> > ‘void(void)’
> > 226 | ProcessLibraryConstructorList (
> > | ^~~~~~~~~~~~~~~~~~~~~~~~~~~~~
>
> That's a genuine bug in OvmfPkg that needs to be fixed, but we keep
> compatibility with existent SEC modules until/unless they upgrade
> INF_VERSION to 1.30+.
>
> Cc: Bob Feng <bob.c.feng@intel.com>
> Cc: Liming Gao <gaoliming@byosoft.com.cn>
> Cc: Michael D Kinney <michael.d.kinney@intel.com>
> Cc: Rebecca Cran <rebecca@bsdio.com>
> Cc: Yuwei Chen <yuwei.chen@intel.com>
> Ref: https://bugzilla.tianocore.org/show_bug.cgi?id=991
> Suggested-by: Liming Gao <gaoliming@byosoft.com.cn>
> Suggested-by: Michael D Kinney <michael.d.kinney@intel.com>
> Signed-off-by: Laszlo Ersek <lersek@redhat.com>
> ---
>
> Notes:
> v2:
>
> - CI run: <https://github.com/tianocore/edk2/pull/5404>
>
> - port to edk2-basetools:
> <https://github.com/tianocore/edk2-basetools/pull/120>
>
> - depend on INF_VERSION >= 1.30 [Mike]
>
> - extend commit message with INF_VERSION dependency
>
> - extend commit message with example build error due to preexistent
> broken ProcessLibraryConstructorList() declaration in OvmfPkg, now
> caught by the auto-generated prototype
>
> BaseTools/Source/Python/AutoGen/GenC.py | 8 ++++++++
> 1 file changed, 8 insertions(+)
>
> diff --git a/BaseTools/Source/Python/AutoGen/GenC.py
> b/BaseTools/Source/Python/AutoGen/GenC.py
> index a2053d548521..5ad10cee2898 100755
> --- a/BaseTools/Source/Python/AutoGen/GenC.py
> +++ b/BaseTools/Source/Python/AutoGen/GenC.py
> @@ -1371,6 +1371,14 @@ def CreateLibraryConstructorCode(Info,
> AutoGenC, AutoGenH):
> else:
> if Info.ModuleType in [SUP_MODULE_BASE, SUP_MODULE_SEC,
> SUP_MODULE_USER_DEFINED, SUP_MODULE_HOST_APPLICATION]:
>
> AutoGenC.Append(gLibraryString[SUP_MODULE_BASE].Replace(Dict))
> + if Info.ModuleType == SUP_MODULE_SEC and
> Info.AutoGenVersion >= 0x0001001E:
> + AutoGenH.Append(("\n"
> + "// ProcessLibraryConstructorList()
> declared here because SEC has no standard entry point.\n"
> + "VOID\n"
> + "EFIAPI\n"
> + "ProcessLibraryConstructorList (\n"
> + " VOID\n"
> + " );\n"))
> elif Info.ModuleType in SUP_MODULE_SET_PEI:
> AutoGenC.Append(gLibraryString['PEI'].Replace(Dict))
> elif Info.ModuleType in [SUP_MODULE_DXE_CORE,
> SUP_MODULE_DXE_DRIVER, SUP_MODULE_DXE_SMM_DRIVER,
> SUP_MODULE_DXE_RUNTIME_DRIVER,
>
> base-commit: edc6681206c1a8791981a2f911d2fb8b3d2f5768
-=-=-=-=-=-=-=-=-=-=-=-
Groups.io Links: You receive all messages sent to this group.
View/Reply Online (#115920): https://edk2.groups.io/g/devel/message/115920
Mute This Topic: https://groups.io/mt/104558376/7686176
Group Owner: devel+owner@edk2.groups.io
Unsubscribe: https://edk2.groups.io/g/devel/unsub [rebecca@openfw.io]
-=-=-=-=-=-=-=-=-=-=-=-
^ permalink raw reply [flat|nested] 20+ messages in thread
* [edk2-devel] [edk2-BuildSpecification PATCH 0/3] AutoGen.h: declare ProcessLibraryConstructorList() for SEC modules
2024-02-24 20:59 [edk2-devel] [v2] BaseTools/AutoGen: declare ProcessLibraryConstructorList() for SEC modules Laszlo Ersek
2024-02-24 21:05 ` [edk2-devel] [PATCH] " Laszlo Ersek
@ 2024-02-24 21:23 ` Laszlo Ersek
2024-02-24 21:23 ` [edk2-devel] [edk2-BuildSpecification PATCH 1/3] README.md: fix revision history whitespace Laszlo Ersek
` (4 more replies)
2024-02-24 21:28 ` [edk2-devel] [edk2-InfSpecification PATCH 0/2] README: INF_VERSION >= 1.30: declare ProcessLibraryCon...() " Laszlo Ersek
` (2 subsequent siblings)
4 siblings, 5 replies; 20+ messages in thread
From: Laszlo Ersek @ 2024-02-24 21:23 UTC (permalink / raw)
To: edk2-devel-groups-io
Cc: Bob Feng, Liming Gao, Michael D Kinney, Rebecca Cran, Yuwei Chen
The first two patches are cleanups, the new feature is documented in the
third patch.
I managed to render these updates to public HTML, following
(a) Mike's note from October 2020:
https://edk2.groups.io/g/devel/message/66426
msgid <MN2PR11MB44619CB0EB0407554B94CFF4D21F0@MN2PR11MB4461.namprd11.prod.outlook.com>
(b) the github access token / project secrets steps at
https://github.com/ZanderZhao/gitbook-action?tab=readme-ov-file#step2--generate-token-and-add-to-secrets
Therefore:
https://lersek.github.io/edk2-BuildSpecification/ProcessLibraryConstructorList-SEC-991/
https://github.com/lersek/edk2-BuildSpecification/actions/workflows/gitbook-action.yml
Cc: Bob Feng <bob.c.feng@intel.com>
Cc: Liming Gao <gaoliming@byosoft.com.cn>
Cc: Michael D Kinney <michael.d.kinney@intel.com>
Cc: Rebecca Cran <rebecca@bsdio.com>
Cc: Yuwei Chen <yuwei.chen@intel.com>
Thanks
Laszlo
Laszlo Ersek (3):
README.md: fix revision history whitespace
AutoGen.c: list the SEC module type for <CONSTRUCTOR>/<DESTRUCTOR>
(VOID)
AutoGen.h: declare ProcessLibraryConstructorList() for SEC modules
8_pre-build_autogen_stage/83_auto-generated_code.md | 42 +++++++++++++++-----
README.md | 5 ++-
2 files changed, 36 insertions(+), 11 deletions(-)
base-commit: db69f5661caec977fac9730e21e5a1132f6ff80b
-=-=-=-=-=-=-=-=-=-=-=-
Groups.io Links: You receive all messages sent to this group.
View/Reply Online (#115911): https://edk2.groups.io/g/devel/message/115911
Mute This Topic: https://groups.io/mt/104554003/7686176
Group Owner: devel+owner@edk2.groups.io
Unsubscribe: https://edk2.groups.io/g/devel/unsub [rebecca@openfw.io]
-=-=-=-=-=-=-=-=-=-=-=-
^ permalink raw reply [flat|nested] 20+ messages in thread* [edk2-devel] [edk2-BuildSpecification PATCH 1/3] README.md: fix revision history whitespace
2024-02-24 21:23 ` [edk2-devel] [edk2-BuildSpecification PATCH 0/3] AutoGen.h: " Laszlo Ersek
@ 2024-02-24 21:23 ` Laszlo Ersek
2024-02-24 21:23 ` [edk2-devel] [edk2-BuildSpecification PATCH 2/3] AutoGen.c: list the SEC module type for <CONSTRUCTOR>/<DESTRUCTOR> (VOID) Laszlo Ersek
` (3 subsequent siblings)
4 siblings, 0 replies; 20+ messages in thread
From: Laszlo Ersek @ 2024-02-24 21:23 UTC (permalink / raw)
To: edk2-devel-groups-io
Cc: Bob Feng, Liming Gao, Michael D Kinney, Rebecca Cran, Yuwei Chen
Fix the right-hand-side whitespace in the revision history table.
Cc: Bob Feng <bob.c.feng@intel.com>
Cc: Liming Gao <gaoliming@byosoft.com.cn>
Cc: Michael D Kinney <michael.d.kinney@intel.com>
Cc: Rebecca Cran <rebecca@bsdio.com>
Cc: Yuwei Chen <yuwei.chen@intel.com>
Ref: https://bugzilla.tianocore.org/show_bug.cgi?id=991
Signed-off-by: Laszlo Ersek <lersek@redhat.com>
---
README.md | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
diff --git a/README.md b/README.md
index bedc3e7ce6e4..6d41f3a94fc2 100644
--- a/README.md
+++ b/README.md
@@ -229,5 +229,5 @@ Copyright (c) 2008-2017, Intel Corporation. All rights reserved.
| | Add !error statement section | |
| | [#1110](https://bugzilla.tianocore.org/show_bug.cgi?id=1110) Extend exclamation statement's keyword to case-insensitive | |
| | [#598](https://bugzilla.tianocore.org/show_bug.cgi?id=598) update supported operators in 8.2.4.6 Expressions | |
-| 1.29 | [#1453](https://bugzilla.tianocore.org/show_bug.cgi?id=1453) Update Build spec to remove EDK related contents | Mar 2019 |
-| 1.30 | [#1952](https://bugzilla.tianocore.org/show_bug.cgi?id=1952) Update Build spec to support HOST_APPLICATION MODULE_TYPE | July 2019 |
+| 1.29 | [#1453](https://bugzilla.tianocore.org/show_bug.cgi?id=1453) Update Build spec to remove EDK related contents | Mar 2019 |
+| 1.30 | [#1952](https://bugzilla.tianocore.org/show_bug.cgi?id=1952) Update Build spec to support HOST_APPLICATION MODULE_TYPE | July 2019 |
-=-=-=-=-=-=-=-=-=-=-=-
Groups.io Links: You receive all messages sent to this group.
View/Reply Online (#115912): https://edk2.groups.io/g/devel/message/115912
Mute This Topic: https://groups.io/mt/104554004/7686176
Group Owner: devel+owner@edk2.groups.io
Unsubscribe: https://edk2.groups.io/g/devel/unsub [rebecca@openfw.io]
-=-=-=-=-=-=-=-=-=-=-=-
^ permalink raw reply related [flat|nested] 20+ messages in thread* [edk2-devel] [edk2-BuildSpecification PATCH 2/3] AutoGen.c: list the SEC module type for <CONSTRUCTOR>/<DESTRUCTOR> (VOID)
2024-02-24 21:23 ` [edk2-devel] [edk2-BuildSpecification PATCH 0/3] AutoGen.h: " Laszlo Ersek
2024-02-24 21:23 ` [edk2-devel] [edk2-BuildSpecification PATCH 1/3] README.md: fix revision history whitespace Laszlo Ersek
@ 2024-02-24 21:23 ` Laszlo Ersek
2024-02-24 21:23 ` [edk2-devel] [edk2-BuildSpecification PATCH 3/3] AutoGen.h: declare ProcessLibraryConstructorList() for SEC modules Laszlo Ersek
` (2 subsequent siblings)
4 siblings, 0 replies; 20+ messages in thread
From: Laszlo Ersek @ 2024-02-24 21:23 UTC (permalink / raw)
To: edk2-devel-groups-io
Cc: Bob Feng, Liming Gao, Michael D Kinney, Rebecca Cran, Yuwei Chen
Minimally as of edk2 commit edc6681206c1, the
- CreateLibraryConstructorCode()
- CreateLibraryDestructorCode()
methods in "BaseTools/Source/Python/AutoGen/GenC.py" generate declarations
and calls of the form
- <CONSTRUCTOR> (VOID)
- <DESTRUCTOR> (VOID)
(respectively), for pre-requisite libraries that have type BASE or SEC:
1340 if Lib.ModuleType in [SUP_MODULE_BASE, SUP_MODULE_SEC]:
1341 ConstructorPrototypeString.Append(gLibraryStructorPrototype[SUP_MODULE_BASE].Replace(Dict))
1342 ConstructorCallingString.Append(gLibraryStructorCall[SUP_MODULE_BASE].Replace(Dict))
1403 if Lib.ModuleType in [SUP_MODULE_BASE, SUP_MODULE_SEC]:
1404 DestructorPrototypeString.Append(gLibraryStructorPrototype[SUP_MODULE_BASE].Replace(Dict))
1405 DestructorCallingString.Append(gLibraryStructorCall[SUP_MODULE_BASE].Replace(Dict))
The build spec only lists BASE thus far; cover SEC now.
This patch is best viewed with "git show -W".
Cc: Bob Feng <bob.c.feng@intel.com>
Cc: Liming Gao <gaoliming@byosoft.com.cn>
Cc: Michael D Kinney <michael.d.kinney@intel.com>
Cc: Rebecca Cran <rebecca@bsdio.com>
Cc: Yuwei Chen <yuwei.chen@intel.com>
Ref: https://bugzilla.tianocore.org/show_bug.cgi?id=991
Signed-off-by: Laszlo Ersek <lersek@redhat.com>
---
8_pre-build_autogen_stage/83_auto-generated_code.md | 16 ++++++++--------
1 file changed, 8 insertions(+), 8 deletions(-)
diff --git a/8_pre-build_autogen_stage/83_auto-generated_code.md b/8_pre-build_autogen_stage/83_auto-generated_code.md
index b9a40ef44435..3e1da3809000 100644
--- a/8_pre-build_autogen_stage/83_auto-generated_code.md
+++ b/8_pre-build_autogen_stage/83_auto-generated_code.md
@@ -756,7 +756,7 @@ library instances that are being linked to.
```c
If (CONSTRUCTOR defined in INF) {
- If (MODULE_TYPE == "BASE") {
+ If ((MODULE_TYPE == "BASE") || (MODULE_TYPE == "SEC")) {
include_statement (AutoGen.c, "
EFI_STATUS
EFIAPI
@@ -798,7 +798,7 @@ If (CONSTRUCTOR defined in INF) {
} // End CONSTRUCTOR defined in INF
-If (MODULE_TYPE == "BASE") {
+If ((MODULE_TYPE == "BASE") || (MODULE_TYPE == "SEC")) {
include_statement (AutoGen.c, "
VOID
EFIAPI
@@ -841,11 +841,11 @@ include_statement (AutoGen.c, "
");
If (CONSTRUCTOR defined in INF) {
- If (MODULE_TYPE == "BASE") {
+ If ((MODULE_TYPE == "BASE") || (MODULE_TYPE == "SEC")) {
include_statement (AutoGen.c, "
EFI_STATUS Status;
- Status = <CONSTRUCTOR>();
+ Status = <CONSTRUCTOR> ();
ASSERT_EFI_ERROR (Status);
");
@@ -889,7 +889,7 @@ of the library instances that are being linked to.
```c
If (DESTRUCTOR defined in INF) {
- If (MODULE_TYPE == "BASE") {
+ If ((MODULE_TYPE == "BASE") || (MODULE_TYPE == "SEC")) {
include_statement (AutoGen.c, "
EFI_STATUS
EFIAPI
@@ -925,7 +925,7 @@ If (DESTRUCTOR defined in INF) {
}
} // End DESTRUCTOR defined in INF
-If (MODULE_TYPE == "BASE") {
+If ((MODULE_TYPE == "BASE") || (MODULE_TYPE == "SEC")) {
include_statement (AutoGen.c, "
VOID
EFIAPI
@@ -971,11 +971,11 @@ include_statement (AutoGen.c, "
");
If (DESTRUCTOR defined in INF) {
- If (MODULE_TYPE == "BASE") {
+ If ((MODULE_TYPE == "BASE") || (MODULE_TYPE == "SEC")) {
include_statement (AutoGen.c, "
EFI_STATUS Status;
- Status = <DESTRUCTOR>();
+ Status = <DESTRUCTOR> ();
ASSERT_EFI_ERROR (Status);
");
-=-=-=-=-=-=-=-=-=-=-=-
Groups.io Links: You receive all messages sent to this group.
View/Reply Online (#115914): https://edk2.groups.io/g/devel/message/115914
Mute This Topic: https://groups.io/mt/104554008/7686176
Group Owner: devel+owner@edk2.groups.io
Unsubscribe: https://edk2.groups.io/g/devel/unsub [rebecca@openfw.io]
-=-=-=-=-=-=-=-=-=-=-=-
^ permalink raw reply related [flat|nested] 20+ messages in thread* [edk2-devel] [edk2-BuildSpecification PATCH 3/3] AutoGen.h: declare ProcessLibraryConstructorList() for SEC modules
2024-02-24 21:23 ` [edk2-devel] [edk2-BuildSpecification PATCH 0/3] AutoGen.h: " Laszlo Ersek
2024-02-24 21:23 ` [edk2-devel] [edk2-BuildSpecification PATCH 1/3] README.md: fix revision history whitespace Laszlo Ersek
2024-02-24 21:23 ` [edk2-devel] [edk2-BuildSpecification PATCH 2/3] AutoGen.c: list the SEC module type for <CONSTRUCTOR>/<DESTRUCTOR> (VOID) Laszlo Ersek
@ 2024-02-24 21:23 ` Laszlo Ersek
2024-02-24 21:49 ` [edk2-devel] [edk2-BuildSpecification PATCH 0/3] " Laszlo Ersek
2024-03-01 12:53 ` 回复: " gaoliming via groups.io
4 siblings, 0 replies; 20+ messages in thread
From: Laszlo Ersek @ 2024-02-24 21:23 UTC (permalink / raw)
To: edk2-devel-groups-io
Cc: Bob Feng, Liming Gao, Michael D Kinney, Rebecca Cran, Yuwei Chen
Most module types have standardized entry point function prototypes. They
are declared in headers like
- MdePkg/Include/Library/PeiCoreEntryPoint.h
- MdePkg/Include/Library/PeimEntryPoint.h
- MdePkg/Include/Library/DxeCoreEntryPoint.h
- MdePkg/Include/Library/UefiDriverEntryPoint.h
- MdePkg/Include/Library/UefiApplicationEntryPoint.h
These header files also declare matching ProcessLibraryConstructorList()
prototypes.
The SEC module type does not have a standardized entry point prototype
(aka parameter list), therefore no header file like the above ones exists
for SEC. Consequently, no header file *declares*
ProcessLibraryConstructorList() for SEC modules, even though AutoGen
always *defines* ProcessLibraryConstructorList() with the same, empty,
parameter list (i.e., just (VOID)).
The lack of a central declaration is a problem because in SEC code,
ProcessLibraryConstructorList() needs to be called manually, and those
calls need a prototype. Most SEC modules in edk2 get around this by
declaring ProcessLibraryConstructorList() manually, while some others use
an incorrect (PEIM) prototype.
Liming suggested in
<https://bugzilla.tianocore.org/show_bug.cgi?id=991#c2> that AutoGen
provide the declaration as well. Accompanying the upcoming BaseTools
patch, document the feature in the Build spec.
"INF_VERSION >= 1.30" reflects that the latest (draft) version of the INF
specification, as of this writing, is commit a31e3c842bee / version 1.29.
Cc: Bob Feng <bob.c.feng@intel.com>
Cc: Liming Gao <gaoliming@byosoft.com.cn>
Cc: Michael D Kinney <michael.d.kinney@intel.com>
Cc: Rebecca Cran <rebecca@bsdio.com>
Cc: Yuwei Chen <yuwei.chen@intel.com>
Ref: https://bugzilla.tianocore.org/show_bug.cgi?id=991
Suggested-by: Liming Gao <gaoliming@byosoft.com.cn>
Suggested-by: Michael D Kinney <michael.d.kinney@intel.com>
Signed-off-by: Laszlo Ersek <lersek@redhat.com>
---
8_pre-build_autogen_stage/83_auto-generated_code.md | 26 +++++++++++++++++++-
README.md | 1 +
2 files changed, 26 insertions(+), 1 deletion(-)
diff --git a/8_pre-build_autogen_stage/83_auto-generated_code.md b/8_pre-build_autogen_stage/83_auto-generated_code.md
index 3e1da3809000..8b20a6ace9f8 100644
--- a/8_pre-build_autogen_stage/83_auto-generated_code.md
+++ b/8_pre-build_autogen_stage/83_auto-generated_code.md
@@ -649,7 +649,31 @@ include_statement(AutoGen.h, "
");
```
-#### 8.3.6.5 AutoGen Epilogue
+#### 8.3.6.5 `ProcessLibraryConstructorList` function declaration
+
+Entry point functions of non-library SEC modules do not have standardized
+parameter lists, therefore edk2 does not offer an
+`MdePkg/Include/Library/*EntryPoint.h` header file for such modules.
+Consequently, `ProcessLibraryConstructorList` is not declared for them either,
+despite the fact that they must call `ProcessLibraryConstructorList` explicitly.
+Historically, each such module has declared `ProcessLibraryConstructorList`
+internally for itself, compensating for the lack of a central declaration.
+
+The `ProcessLibraryConstructorList` function is declared in `AutoGen.h` for
+non-library SEC modules, if `INF_VERSION` in the module's INF file is greater
+than or equal to `1.30`.
+
+```c
+include_statement (AutoGen.h, "
+ VOID
+ EFIAPI
+ ProcessLibraryConstructorList (
+ VOID
+ );
+");
+```
+
+#### 8.3.6.6 AutoGen Epilogue
```c
#ifdef __cplusplus
diff --git a/README.md b/README.md
index 6d41f3a94fc2..7c7c2a60bd2d 100644
--- a/README.md
+++ b/README.md
@@ -231,3 +231,4 @@ Copyright (c) 2008-2017, Intel Corporation. All rights reserved.
| | [#598](https://bugzilla.tianocore.org/show_bug.cgi?id=598) update supported operators in 8.2.4.6 Expressions | |
| 1.29 | [#1453](https://bugzilla.tianocore.org/show_bug.cgi?id=1453) Update Build spec to remove EDK related contents | Mar 2019 |
| 1.30 | [#1952](https://bugzilla.tianocore.org/show_bug.cgi?id=1952) Update Build spec to support HOST_APPLICATION MODULE_TYPE | July 2019 |
+| 1.31 | [#991](https://bugzilla.tianocore.org/show_bug.cgi?id=991) generate ProcessLibraryConstructorList() declaration in AutoGen.h for SEC modules | February 2024 |
-=-=-=-=-=-=-=-=-=-=-=-
Groups.io Links: You receive all messages sent to this group.
View/Reply Online (#115913): https://edk2.groups.io/g/devel/message/115913
Mute This Topic: https://groups.io/mt/104554007/7686176
Group Owner: devel+owner@edk2.groups.io
Unsubscribe: https://edk2.groups.io/g/devel/unsub [rebecca@openfw.io]
-=-=-=-=-=-=-=-=-=-=-=-
^ permalink raw reply related [flat|nested] 20+ messages in thread
* Re: [edk2-devel] [edk2-BuildSpecification PATCH 0/3] AutoGen.h: declare ProcessLibraryConstructorList() for SEC modules
2024-02-24 21:23 ` [edk2-devel] [edk2-BuildSpecification PATCH 0/3] AutoGen.h: " Laszlo Ersek
` (2 preceding siblings ...)
2024-02-24 21:23 ` [edk2-devel] [edk2-BuildSpecification PATCH 3/3] AutoGen.h: declare ProcessLibraryConstructorList() for SEC modules Laszlo Ersek
@ 2024-02-24 21:49 ` Laszlo Ersek
2024-03-01 12:53 ` 回复: " gaoliming via groups.io
4 siblings, 0 replies; 20+ messages in thread
From: Laszlo Ersek @ 2024-02-24 21:49 UTC (permalink / raw)
To: edk2-devel-groups-io
Cc: Bob Feng, Liming Gao, Michael D Kinney, Rebecca Cran, Yuwei Chen
On 2/24/24 22:23, Laszlo Ersek wrote:
> The first two patches are cleanups, the new feature is documented in the
> third patch.
>
> I managed to render these updates to public HTML, following
>
> (a) Mike's note from October 2020:
>
> https://edk2.groups.io/g/devel/message/66426
> msgid <MN2PR11MB44619CB0EB0407554B94CFF4D21F0@MN2PR11MB4461.namprd11.prod.outlook.com>
>
> (b) the github access token / project secrets steps at
>
> https://github.com/ZanderZhao/gitbook-action?tab=readme-ov-file#step2--generate-token-and-add-to-secrets
>
> Therefore:
>
> https://lersek.github.io/edk2-BuildSpecification/ProcessLibraryConstructorList-SEC-991/
> https://github.com/lersek/edk2-BuildSpecification/actions/workflows/gitbook-action.yml
Branch on github, if someone wants to fetch it:
https://github.com/lersek/edk2-BuildSpecification/tree/ProcessLibraryConstructorList-SEC-991
Laszlo
>
> Cc: Bob Feng <bob.c.feng@intel.com>
> Cc: Liming Gao <gaoliming@byosoft.com.cn>
> Cc: Michael D Kinney <michael.d.kinney@intel.com>
> Cc: Rebecca Cran <rebecca@bsdio.com>
> Cc: Yuwei Chen <yuwei.chen@intel.com>
>
> Thanks
> Laszlo
>
> Laszlo Ersek (3):
> README.md: fix revision history whitespace
> AutoGen.c: list the SEC module type for <CONSTRUCTOR>/<DESTRUCTOR>
> (VOID)
> AutoGen.h: declare ProcessLibraryConstructorList() for SEC modules
>
> 8_pre-build_autogen_stage/83_auto-generated_code.md | 42 +++++++++++++++-----
> README.md | 5 ++-
> 2 files changed, 36 insertions(+), 11 deletions(-)
>
>
> base-commit: db69f5661caec977fac9730e21e5a1132f6ff80b
>
>
>
>
>
-=-=-=-=-=-=-=-=-=-=-=-
Groups.io Links: You receive all messages sent to this group.
View/Reply Online (#115918): https://edk2.groups.io/g/devel/message/115918
Mute This Topic: https://groups.io/mt/104554003/7686176
Group Owner: devel+owner@edk2.groups.io
Unsubscribe: https://edk2.groups.io/g/devel/unsub [rebecca@openfw.io]
-=-=-=-=-=-=-=-=-=-=-=-
^ permalink raw reply [flat|nested] 20+ messages in thread* 回复: [edk2-devel] [edk2-BuildSpecification PATCH 0/3] AutoGen.h: declare ProcessLibraryConstructorList() for SEC modules
2024-02-24 21:23 ` [edk2-devel] [edk2-BuildSpecification PATCH 0/3] AutoGen.h: " Laszlo Ersek
` (3 preceding siblings ...)
2024-02-24 21:49 ` [edk2-devel] [edk2-BuildSpecification PATCH 0/3] " Laszlo Ersek
@ 2024-03-01 12:53 ` gaoliming via groups.io
2024-03-01 13:40 ` Laszlo Ersek
4 siblings, 1 reply; 20+ messages in thread
From: gaoliming via groups.io @ 2024-03-01 12:53 UTC (permalink / raw)
To: devel, lersek
Cc: 'Bob Feng', 'Michael D Kinney',
'Rebecca Cran', 'Yuwei Chen'
Looks good. Reviewed-by: Liming Gao <gaoliming@byosoft.com.cn>
> -----邮件原件-----
> 发件人: devel@edk2.groups.io <devel@edk2.groups.io> 代表 Laszlo Ersek
> 发送时间: 2024年2月25日 5:24
> 收件人: edk2-devel-groups-io <devel@edk2.groups.io>
> 抄送: Bob Feng <bob.c.feng@intel.com>; Liming Gao
> <gaoliming@byosoft.com.cn>; Michael D Kinney
> <michael.d.kinney@intel.com>; Rebecca Cran <rebecca@bsdio.com>; Yuwei
> Chen <yuwei.chen@intel.com>
> 主题: [edk2-devel] [edk2-BuildSpecification PATCH 0/3] AutoGen.h: declare
> ProcessLibraryConstructorList() for SEC modules
>
> The first two patches are cleanups, the new feature is documented in the
> third patch.
>
> I managed to render these updates to public HTML, following
>
> (a) Mike's note from October 2020:
>
> https://edk2.groups.io/g/devel/message/66426
> msgid
> <MN2PR11MB44619CB0EB0407554B94CFF4D21F0@MN2PR11MB4461.nam
> prd11.prod.outlook.com>
>
> (b) the github access token / project secrets steps at
>
>
> https://github.com/ZanderZhao/gitbook-action?tab=readme-ov-file#step2--g
> enerate-token-and-add-to-secrets
>
> Therefore:
>
>
>
https://lersek.github.io/edk2-BuildSpecification/ProcessLibraryConstructorLi
s
> t-SEC-991/
>
>
https://github.com/lersek/edk2-BuildSpecification/actions/workflows/gitbook
> -action.yml
>
> Cc: Bob Feng <bob.c.feng@intel.com>
> Cc: Liming Gao <gaoliming@byosoft.com.cn>
> Cc: Michael D Kinney <michael.d.kinney@intel.com>
> Cc: Rebecca Cran <rebecca@bsdio.com>
> Cc: Yuwei Chen <yuwei.chen@intel.com>
>
> Thanks
> Laszlo
>
> Laszlo Ersek (3):
> README.md: fix revision history whitespace
> AutoGen.c: list the SEC module type for <CONSTRUCTOR>/<DESTRUCTOR>
> (VOID)
> AutoGen.h: declare ProcessLibraryConstructorList() for SEC modules
>
> 8_pre-build_autogen_stage/83_auto-generated_code.md | 42
> +++++++++++++++-----
> README.md | 5 ++-
> 2 files changed, 36 insertions(+), 11 deletions(-)
>
>
> base-commit: db69f5661caec977fac9730e21e5a1132f6ff80b
>
>
>
>
-=-=-=-=-=-=-=-=-=-=-=-
Groups.io Links: You receive all messages sent to this group.
View/Reply Online (#116247): https://edk2.groups.io/g/devel/message/116247
Mute This Topic: https://groups.io/mt/104662733/7686176
Group Owner: devel+owner@edk2.groups.io
Unsubscribe: https://edk2.groups.io/g/devel/unsub [rebecca@openfw.io]
-=-=-=-=-=-=-=-=-=-=-=-
^ permalink raw reply [flat|nested] 20+ messages in thread* Re: 回复: [edk2-devel] [edk2-BuildSpecification PATCH 0/3] AutoGen.h: declare ProcessLibraryConstructorList() for SEC modules
2024-03-01 12:53 ` 回复: " gaoliming via groups.io
@ 2024-03-01 13:40 ` Laszlo Ersek
0 siblings, 0 replies; 20+ messages in thread
From: Laszlo Ersek @ 2024-03-01 13:40 UTC (permalink / raw)
To: devel, gaoliming
Cc: 'Bob Feng', 'Michael D Kinney',
'Rebecca Cran', 'Yuwei Chen'
On 3/1/24 13:53, gaoliming via groups.io wrote:
> Looks good. Reviewed-by: Liming Gao <gaoliming@byosoft.com.cn>
Thank you, merged as commit range db69f5661cae..7a7165a7d199.
Laszlo
>
>> -----邮件原件-----
>> 发件人: devel@edk2.groups.io <devel@edk2.groups.io> 代表 Laszlo Ersek
>> 发送时间: 2024年2月25日 5:24
>> 收件人: edk2-devel-groups-io <devel@edk2.groups.io>
>> 抄送: Bob Feng <bob.c.feng@intel.com>; Liming Gao
>> <gaoliming@byosoft.com.cn>; Michael D Kinney
>> <michael.d.kinney@intel.com>; Rebecca Cran <rebecca@bsdio.com>; Yuwei
>> Chen <yuwei.chen@intel.com>
>> 主题: [edk2-devel] [edk2-BuildSpecification PATCH 0/3] AutoGen.h: declare
>> ProcessLibraryConstructorList() for SEC modules
>>
>> The first two patches are cleanups, the new feature is documented in the
>> third patch.
>>
>> I managed to render these updates to public HTML, following
>>
>> (a) Mike's note from October 2020:
>>
>> https://edk2.groups.io/g/devel/message/66426
>> msgid
>> <MN2PR11MB44619CB0EB0407554B94CFF4D21F0@MN2PR11MB4461.nam
>> prd11.prod.outlook.com>
>>
>> (b) the github access token / project secrets steps at
>>
>>
>> https://github.com/ZanderZhao/gitbook-action?tab=readme-ov-file#step2--g
>> enerate-token-and-add-to-secrets
>>
>> Therefore:
>>
>>
>>
> https://lersek.github.io/edk2-BuildSpecification/ProcessLibraryConstructorLi
> s
>> t-SEC-991/
>>
>>
> https://github.com/lersek/edk2-BuildSpecification/actions/workflows/gitbook
>> -action.yml
>>
>> Cc: Bob Feng <bob.c.feng@intel.com>
>> Cc: Liming Gao <gaoliming@byosoft.com.cn>
>> Cc: Michael D Kinney <michael.d.kinney@intel.com>
>> Cc: Rebecca Cran <rebecca@bsdio.com>
>> Cc: Yuwei Chen <yuwei.chen@intel.com>
>>
>> Thanks
>> Laszlo
>>
>> Laszlo Ersek (3):
>> README.md: fix revision history whitespace
>> AutoGen.c: list the SEC module type for <CONSTRUCTOR>/<DESTRUCTOR>
>> (VOID)
>> AutoGen.h: declare ProcessLibraryConstructorList() for SEC modules
>>
>> 8_pre-build_autogen_stage/83_auto-generated_code.md | 42
>> +++++++++++++++-----
>> README.md | 5 ++-
>> 2 files changed, 36 insertions(+), 11 deletions(-)
>>
>>
>> base-commit: db69f5661caec977fac9730e21e5a1132f6ff80b
>>
>>
>>
>>
>
>
>
>
>
>
>
>
-=-=-=-=-=-=-=-=-=-=-=-
Groups.io Links: You receive all messages sent to this group.
View/Reply Online (#116252): https://edk2.groups.io/g/devel/message/116252
Mute This Topic: https://groups.io/mt/104662733/7686176
Group Owner: devel+owner@edk2.groups.io
Unsubscribe: https://edk2.groups.io/g/devel/unsub [rebecca@openfw.io]
-=-=-=-=-=-=-=-=-=-=-=-
^ permalink raw reply [flat|nested] 20+ messages in thread
* [edk2-devel] [edk2-InfSpecification PATCH 0/2] README: INF_VERSION >= 1.30: declare ProcessLibraryCon...() for SEC modules
2024-02-24 20:59 [edk2-devel] [v2] BaseTools/AutoGen: declare ProcessLibraryConstructorList() for SEC modules Laszlo Ersek
2024-02-24 21:05 ` [edk2-devel] [PATCH] " Laszlo Ersek
2024-02-24 21:23 ` [edk2-devel] [edk2-BuildSpecification PATCH 0/3] AutoGen.h: " Laszlo Ersek
@ 2024-02-24 21:28 ` Laszlo Ersek
2024-02-24 21:28 ` [edk2-devel] [edk2-InfSpecification PATCH 1/2] README.md: fix revision history whitespace Laszlo Ersek
` (3 more replies)
2024-02-27 23:41 ` [edk2-devel] [v2] BaseTools/AutoGen: declare ProcessLibraryConstructorList() " Rebecca Cran
2024-03-01 11:30 ` Laszlo Ersek
4 siblings, 4 replies; 20+ messages in thread
From: Laszlo Ersek @ 2024-02-24 21:28 UTC (permalink / raw)
To: edk2-devel-groups-io
Cc: Bob Feng, Liming Gao, Michael D Kinney, Rebecca Cran, Yuwei Chen
The first patch is a minor cleanup, the new feature is documented in the
second patch.
Rendered version:
https://lersek.github.io/edk2-InfSpecification/ProcessLibraryConstructorList-SEC-991/
https://github.com/lersek/edk2-InfSpecification/actions/workflows/gitbook-action.yml
Cc: Bob Feng <bob.c.feng@intel.com>
Cc: Liming Gao <gaoliming@byosoft.com.cn>
Cc: Michael D Kinney <michael.d.kinney@intel.com>
Cc: Rebecca Cran <rebecca@bsdio.com>
Cc: Yuwei Chen <yuwei.chen@intel.com>
Thanks
Laszlo
Laszlo Ersek (2):
README.md: fix revision history whitespace
README: INF_VERSION >= 1.30: declare ProcessLibraryCon...() for SEC
modules
README.md | 5 +++--
1 file changed, 3 insertions(+), 2 deletions(-)
base-commit: a31e3c842beed72661b6ccf9dbb34df8d0c1afa6
-=-=-=-=-=-=-=-=-=-=-=-
Groups.io Links: You receive all messages sent to this group.
View/Reply Online (#115915): https://edk2.groups.io/g/devel/message/115915
Mute This Topic: https://groups.io/mt/104554095/7686176
Group Owner: devel+owner@edk2.groups.io
Unsubscribe: https://edk2.groups.io/g/devel/unsub [rebecca@openfw.io]
-=-=-=-=-=-=-=-=-=-=-=-
^ permalink raw reply [flat|nested] 20+ messages in thread* [edk2-devel] [edk2-InfSpecification PATCH 1/2] README.md: fix revision history whitespace
2024-02-24 21:28 ` [edk2-devel] [edk2-InfSpecification PATCH 0/2] README: INF_VERSION >= 1.30: declare ProcessLibraryCon...() " Laszlo Ersek
@ 2024-02-24 21:28 ` Laszlo Ersek
2024-02-24 21:28 ` [edk2-devel] [edk2-InfSpecification PATCH 2/2] README: INF_VERSION >= 1.30: declare ProcessLibraryCon...() for SEC modules Laszlo Ersek
` (2 subsequent siblings)
3 siblings, 0 replies; 20+ messages in thread
From: Laszlo Ersek @ 2024-02-24 21:28 UTC (permalink / raw)
To: edk2-devel-groups-io
Cc: Bob Feng, Liming Gao, Michael D Kinney, Rebecca Cran, Yuwei Chen
Fix the right-hand-side whitespace in the revision history table.
Cc: Bob Feng <bob.c.feng@intel.com>
Cc: Liming Gao <gaoliming@byosoft.com.cn>
Cc: Michael D Kinney <michael.d.kinney@intel.com>
Cc: Rebecca Cran <rebecca@bsdio.com>
Cc: Yuwei Chen <yuwei.chen@intel.com>
Ref: https://bugzilla.tianocore.org/show_bug.cgi?id=991
Signed-off-by: Laszlo Ersek <lersek@redhat.com>
---
README.md | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
diff --git a/README.md b/README.md
index 60fba19fd67f..ea7bf9b9dc43 100644
--- a/README.md
+++ b/README.md
@@ -201,5 +201,5 @@ Copyright (c) 2007-2017, Intel Corporation. All rights reserved.
| | Add clarification that !error statement is not permitted in INF file | |
| | INF Spec: FixedAtBuild (VOID*) PCD use in the [DEPEX] section | |
| | [#1162](https://bugzilla.tianocore.org/show_bug.cgi?id=1162) Correct the item in Table 1 to align with 3.4 section | |
-| 1.28 | [#1453](https://bugzilla.tianocore.org/show_bug.cgi?id=1453) Update INF spec to remove EDK related contents | Mar 2019 |
-| 1.29 | [#1952](https://bugzilla.tianocore.org/show_bug.cgi?id=1952) Add new MODULE_TYPE HOST_APPLICATION | July 2019 |
+| 1.28 | [#1453](https://bugzilla.tianocore.org/show_bug.cgi?id=1453) Update INF spec to remove EDK related contents | Mar 2019 |
+| 1.29 | [#1952](https://bugzilla.tianocore.org/show_bug.cgi?id=1952) Add new MODULE_TYPE HOST_APPLICATION | July 2019 |
-=-=-=-=-=-=-=-=-=-=-=-
Groups.io Links: You receive all messages sent to this group.
View/Reply Online (#115917): https://edk2.groups.io/g/devel/message/115917
Mute This Topic: https://groups.io/mt/104554098/7686176
Group Owner: devel+owner@edk2.groups.io
Unsubscribe: https://edk2.groups.io/g/devel/unsub [rebecca@openfw.io]
-=-=-=-=-=-=-=-=-=-=-=-
^ permalink raw reply related [flat|nested] 20+ messages in thread* [edk2-devel] [edk2-InfSpecification PATCH 2/2] README: INF_VERSION >= 1.30: declare ProcessLibraryCon...() for SEC modules
2024-02-24 21:28 ` [edk2-devel] [edk2-InfSpecification PATCH 0/2] README: INF_VERSION >= 1.30: declare ProcessLibraryCon...() " Laszlo Ersek
2024-02-24 21:28 ` [edk2-devel] [edk2-InfSpecification PATCH 1/2] README.md: fix revision history whitespace Laszlo Ersek
@ 2024-02-24 21:28 ` Laszlo Ersek
2024-02-24 21:51 ` [edk2-devel] [edk2-InfSpecification PATCH 0/2] " Laszlo Ersek
2024-03-01 12:52 ` 回复: " gaoliming via groups.io
3 siblings, 0 replies; 20+ messages in thread
From: Laszlo Ersek @ 2024-02-24 21:28 UTC (permalink / raw)
To: edk2-devel-groups-io
Cc: Bob Feng, Liming Gao, Michael D Kinney, Rebecca Cran, Yuwei Chen
Simply bump INF_VERSION (spec release version) as a fence for the feature
AutoGen.h: declare ProcessLibraryConstructorList() for SEC modules
described comprehensively in the Build spec.
(The INF spec does not seem to have an explicit compatibility table tied
to INF_VERSION, except this revision history in "README.md". Furthermore,
sections "2.1 Processing Overview" and "2.4 [Defines] Section" explicitly
defer to the Build spec regarding the autogenerated files.)
Cc: Bob Feng <bob.c.feng@intel.com>
Cc: Liming Gao <gaoliming@byosoft.com.cn>
Cc: Michael D Kinney <michael.d.kinney@intel.com>
Cc: Rebecca Cran <rebecca@bsdio.com>
Cc: Yuwei Chen <yuwei.chen@intel.com>
Ref: https://bugzilla.tianocore.org/show_bug.cgi?id=991
Suggested-by: Liming Gao <gaoliming@byosoft.com.cn>
Suggested-by: Michael D Kinney <michael.d.kinney@intel.com>
Signed-off-by: Laszlo Ersek <lersek@redhat.com>
---
README.md | 1 +
1 file changed, 1 insertion(+)
diff --git a/README.md b/README.md
index ea7bf9b9dc43..d077ab1ceaad 100644
--- a/README.md
+++ b/README.md
@@ -203,3 +203,4 @@ Copyright (c) 2007-2017, Intel Corporation. All rights reserved.
| | [#1162](https://bugzilla.tianocore.org/show_bug.cgi?id=1162) Correct the item in Table 1 to align with 3.4 section | |
| 1.28 | [#1453](https://bugzilla.tianocore.org/show_bug.cgi?id=1453) Update INF spec to remove EDK related contents | Mar 2019 |
| 1.29 | [#1952](https://bugzilla.tianocore.org/show_bug.cgi?id=1952) Add new MODULE_TYPE HOST_APPLICATION | July 2019 |
+| 1.30 | [#991](https://bugzilla.tianocore.org/show_bug.cgi?id=991) generate ProcessLibraryConstructorList() declaration in AutoGen.h for SEC modules | February 2024 |
-=-=-=-=-=-=-=-=-=-=-=-
Groups.io Links: You receive all messages sent to this group.
View/Reply Online (#115916): https://edk2.groups.io/g/devel/message/115916
Mute This Topic: https://groups.io/mt/104554097/7686176
Group Owner: devel+owner@edk2.groups.io
Unsubscribe: https://edk2.groups.io/g/devel/unsub [rebecca@openfw.io]
-=-=-=-=-=-=-=-=-=-=-=-
^ permalink raw reply related [flat|nested] 20+ messages in thread
* Re: [edk2-devel] [edk2-InfSpecification PATCH 0/2] README: INF_VERSION >= 1.30: declare ProcessLibraryCon...() for SEC modules
2024-02-24 21:28 ` [edk2-devel] [edk2-InfSpecification PATCH 0/2] README: INF_VERSION >= 1.30: declare ProcessLibraryCon...() " Laszlo Ersek
2024-02-24 21:28 ` [edk2-devel] [edk2-InfSpecification PATCH 1/2] README.md: fix revision history whitespace Laszlo Ersek
2024-02-24 21:28 ` [edk2-devel] [edk2-InfSpecification PATCH 2/2] README: INF_VERSION >= 1.30: declare ProcessLibraryCon...() for SEC modules Laszlo Ersek
@ 2024-02-24 21:51 ` Laszlo Ersek
2024-03-01 12:52 ` 回复: " gaoliming via groups.io
3 siblings, 0 replies; 20+ messages in thread
From: Laszlo Ersek @ 2024-02-24 21:51 UTC (permalink / raw)
To: edk2-devel-groups-io
Cc: Bob Feng, Liming Gao, Michael D Kinney, Rebecca Cran, Yuwei Chen
On 2/24/24 22:28, Laszlo Ersek wrote:
> The first patch is a minor cleanup, the new feature is documented in the
> second patch.
>
> Rendered version:
>
> https://lersek.github.io/edk2-InfSpecification/ProcessLibraryConstructorList-SEC-991/
> https://github.com/lersek/edk2-InfSpecification/actions/workflows/gitbook-action.yml
Branch on github, if someone wants to fetch it:
https://github.com/lersek/edk2-InfSpecification/tree/ProcessLibraryConstructorList-SEC-991
Laszlo
>
> Cc: Bob Feng <bob.c.feng@intel.com>
> Cc: Liming Gao <gaoliming@byosoft.com.cn>
> Cc: Michael D Kinney <michael.d.kinney@intel.com>
> Cc: Rebecca Cran <rebecca@bsdio.com>
> Cc: Yuwei Chen <yuwei.chen@intel.com>
>
> Thanks
> Laszlo
>
> Laszlo Ersek (2):
> README.md: fix revision history whitespace
> README: INF_VERSION >= 1.30: declare ProcessLibraryCon...() for SEC
> modules
>
> README.md | 5 +++--
> 1 file changed, 3 insertions(+), 2 deletions(-)
>
>
> base-commit: a31e3c842beed72661b6ccf9dbb34df8d0c1afa6
>
>
>
>
>
-=-=-=-=-=-=-=-=-=-=-=-
Groups.io Links: You receive all messages sent to this group.
View/Reply Online (#115919): https://edk2.groups.io/g/devel/message/115919
Mute This Topic: https://groups.io/mt/104554095/7686176
Group Owner: devel+owner@edk2.groups.io
Unsubscribe: https://edk2.groups.io/g/devel/unsub [rebecca@openfw.io]
-=-=-=-=-=-=-=-=-=-=-=-
^ permalink raw reply [flat|nested] 20+ messages in thread
* 回复: [edk2-devel] [edk2-InfSpecification PATCH 0/2] README: INF_VERSION >= 1.30: declare ProcessLibraryCon...() for SEC modules
2024-02-24 21:28 ` [edk2-devel] [edk2-InfSpecification PATCH 0/2] README: INF_VERSION >= 1.30: declare ProcessLibraryCon...() " Laszlo Ersek
` (2 preceding siblings ...)
2024-02-24 21:51 ` [edk2-devel] [edk2-InfSpecification PATCH 0/2] " Laszlo Ersek
@ 2024-03-01 12:52 ` gaoliming via groups.io
2024-03-01 13:46 ` Laszlo Ersek
3 siblings, 1 reply; 20+ messages in thread
From: gaoliming via groups.io @ 2024-03-01 12:52 UTC (permalink / raw)
To: devel, lersek
Cc: 'Bob Feng', 'Michael D Kinney',
'Rebecca Cran', 'Yuwei Chen'
Looks good. Reviewed-by: Liming Gao <gaoliming@byosoft.com.cn>
> -----邮件原件-----
> 发件人: devel@edk2.groups.io <devel@edk2.groups.io> 代表 Laszlo Ersek
> 发送时间: 2024年2月25日 5:29
> 收件人: edk2-devel-groups-io <devel@edk2.groups.io>
> 抄送: Bob Feng <bob.c.feng@intel.com>; Liming Gao
> <gaoliming@byosoft.com.cn>; Michael D Kinney
> <michael.d.kinney@intel.com>; Rebecca Cran <rebecca@bsdio.com>; Yuwei
> Chen <yuwei.chen@intel.com>
> 主题: [edk2-devel] [edk2-InfSpecification PATCH 0/2] README:
> INF_VERSION >= 1.30: declare ProcessLibraryCon...() for SEC modules
>
> The first patch is a minor cleanup, the new feature is documented in the
> second patch.
>
> Rendered version:
>
>
>
https://lersek.github.io/edk2-InfSpecification/ProcessLibraryConstructorList
-S
> EC-991/
>
>
https://github.com/lersek/edk2-InfSpecification/actions/workflows/gitbook-a
> ction.yml
>
> Cc: Bob Feng <bob.c.feng@intel.com>
> Cc: Liming Gao <gaoliming@byosoft.com.cn>
> Cc: Michael D Kinney <michael.d.kinney@intel.com>
> Cc: Rebecca Cran <rebecca@bsdio.com>
> Cc: Yuwei Chen <yuwei.chen@intel.com>
>
> Thanks
> Laszlo
>
> Laszlo Ersek (2):
> README.md: fix revision history whitespace
> README: INF_VERSION >= 1.30: declare ProcessLibraryCon...() for SEC
> modules
>
> README.md | 5 +++--
> 1 file changed, 3 insertions(+), 2 deletions(-)
>
>
> base-commit: a31e3c842beed72661b6ccf9dbb34df8d0c1afa6
>
>
>
>
-=-=-=-=-=-=-=-=-=-=-=-
Groups.io Links: You receive all messages sent to this group.
View/Reply Online (#116246): https://edk2.groups.io/g/devel/message/116246
Mute This Topic: https://groups.io/mt/104662704/7686176
Group Owner: devel+owner@edk2.groups.io
Unsubscribe: https://edk2.groups.io/g/devel/unsub [rebecca@openfw.io]
-=-=-=-=-=-=-=-=-=-=-=-
^ permalink raw reply [flat|nested] 20+ messages in thread* Re: 回复: [edk2-devel] [edk2-InfSpecification PATCH 0/2] README: INF_VERSION >= 1.30: declare ProcessLibraryCon...() for SEC modules
2024-03-01 12:52 ` 回复: " gaoliming via groups.io
@ 2024-03-01 13:46 ` Laszlo Ersek
0 siblings, 0 replies; 20+ messages in thread
From: Laszlo Ersek @ 2024-03-01 13:46 UTC (permalink / raw)
To: devel, gaoliming
Cc: 'Bob Feng', 'Michael D Kinney',
'Rebecca Cran', 'Yuwei Chen'
On 3/1/24 13:52, gaoliming via groups.io wrote:
> Looks good. Reviewed-by: Liming Gao <gaoliming@byosoft.com.cn>
Thank you, merged as commit range a31e3c842bee..1ea6546578fe.
Laszlo
>
>> -----邮件原件-----
>> 发件人: devel@edk2.groups.io <devel@edk2.groups.io> 代表 Laszlo Ersek
>> 发送时间: 2024年2月25日 5:29
>> 收件人: edk2-devel-groups-io <devel@edk2.groups.io>
>> 抄送: Bob Feng <bob.c.feng@intel.com>; Liming Gao
>> <gaoliming@byosoft.com.cn>; Michael D Kinney
>> <michael.d.kinney@intel.com>; Rebecca Cran <rebecca@bsdio.com>; Yuwei
>> Chen <yuwei.chen@intel.com>
>> 主题: [edk2-devel] [edk2-InfSpecification PATCH 0/2] README:
>> INF_VERSION >= 1.30: declare ProcessLibraryCon...() for SEC modules
>>
>> The first patch is a minor cleanup, the new feature is documented in the
>> second patch.
>>
>> Rendered version:
>>
>>
>>
> https://lersek.github.io/edk2-InfSpecification/ProcessLibraryConstructorList
> -S
>> EC-991/
>>
>>
> https://github.com/lersek/edk2-InfSpecification/actions/workflows/gitbook-a
>> ction.yml
>>
>> Cc: Bob Feng <bob.c.feng@intel.com>
>> Cc: Liming Gao <gaoliming@byosoft.com.cn>
>> Cc: Michael D Kinney <michael.d.kinney@intel.com>
>> Cc: Rebecca Cran <rebecca@bsdio.com>
>> Cc: Yuwei Chen <yuwei.chen@intel.com>
>>
>> Thanks
>> Laszlo
>>
>> Laszlo Ersek (2):
>> README.md: fix revision history whitespace
>> README: INF_VERSION >= 1.30: declare ProcessLibraryCon...() for SEC
>> modules
>>
>> README.md | 5 +++--
>> 1 file changed, 3 insertions(+), 2 deletions(-)
>>
>>
>> base-commit: a31e3c842beed72661b6ccf9dbb34df8d0c1afa6
>>
>>
>>
>>
>
>
>
>
>
>
>
>
-=-=-=-=-=-=-=-=-=-=-=-
Groups.io Links: You receive all messages sent to this group.
View/Reply Online (#116253): https://edk2.groups.io/g/devel/message/116253
Mute This Topic: https://groups.io/mt/104662704/7686176
Group Owner: devel+owner@edk2.groups.io
Unsubscribe: https://edk2.groups.io/g/devel/unsub [rebecca@openfw.io]
-=-=-=-=-=-=-=-=-=-=-=-
^ permalink raw reply [flat|nested] 20+ messages in thread
* Re: [edk2-devel] [v2] BaseTools/AutoGen: declare ProcessLibraryConstructorList() for SEC modules
2024-02-24 20:59 [edk2-devel] [v2] BaseTools/AutoGen: declare ProcessLibraryConstructorList() for SEC modules Laszlo Ersek
` (2 preceding siblings ...)
2024-02-24 21:28 ` [edk2-devel] [edk2-InfSpecification PATCH 0/2] README: INF_VERSION >= 1.30: declare ProcessLibraryCon...() " Laszlo Ersek
@ 2024-02-27 23:41 ` Rebecca Cran
2024-03-02 18:14 ` Laszlo Ersek
2024-03-01 11:30 ` Laszlo Ersek
4 siblings, 1 reply; 20+ messages in thread
From: Rebecca Cran @ 2024-02-27 23:41 UTC (permalink / raw)
To: Laszlo Ersek, edk2-devel-groups-io
Cc: Bob Feng, Liming Gao, Michael D Kinney, Yuwei Chen
edk2-basetools v0.1.50 has just been published so we're back up and running.
I'll work my way through the backlog of BaseTools changes in the next
few days.
--
Rebecca Cran
On 2/24/24 13:59, Laszlo Ersek wrote:
> v1 posting:
>
> https://edk2.groups.io/g/devel/message/115193
> msgid <36593e23-d3e8-b71a-808d-ef94260b5fd0@redhat.com>
>
> Bugzilla:
>
> https://bugzilla.tianocore.org/show_bug.cgi?id=991
>
> In version 2, the feature is structured differently. Following Mike's
> advice, for compatibility, the ProcessLibraryConstructorList()
> declaration in AutoGen.h is now gated on the SEC module having
> INF_VERSION >= 1.30.
>
> Accordingly,
>
> - I now update the Build specification and the Inf specification (see
> patch sets posted in response to this email),
>
> - edk2 only receives a single patch (for AutoGen), for the time being,
>
> - the same edk2 patch is being ported to edk2-basetools:
> https://github.com/tianocore/edk2-basetools/pull/120.
>
> Next steps: once all of the above is merged, *and* an edk2-basetools
> release has been tagged and published, I'll rework the C code patches
> for edk2 and edk2-platforms, from the v1 patch sets, as follows:
>
> - all those SEC modules will have to see their INF_VERSIONs bumped to
> 1.30, for triggering the new code generation,
>
> - pip-requirements.txt/edk2-basetools will need to reference the new
> edk2-basetools release, for exposing the feature in the first place.
>
> Laszlo
>
-=-=-=-=-=-=-=-=-=-=-=-
Groups.io Links: You receive all messages sent to this group.
View/Reply Online (#116063): https://edk2.groups.io/g/devel/message/116063
Mute This Topic: https://groups.io/mt/104553597/7686176
Group Owner: devel+owner@edk2.groups.io
Unsubscribe: https://edk2.groups.io/g/devel/unsub [rebecca@openfw.io]
-=-=-=-=-=-=-=-=-=-=-=-
^ permalink raw reply [flat|nested] 20+ messages in thread* Re: [edk2-devel] [v2] BaseTools/AutoGen: declare ProcessLibraryConstructorList() for SEC modules
2024-02-24 20:59 [edk2-devel] [v2] BaseTools/AutoGen: declare ProcessLibraryConstructorList() for SEC modules Laszlo Ersek
` (3 preceding siblings ...)
2024-02-27 23:41 ` [edk2-devel] [v2] BaseTools/AutoGen: declare ProcessLibraryConstructorList() " Rebecca Cran
@ 2024-03-01 11:30 ` Laszlo Ersek
4 siblings, 0 replies; 20+ messages in thread
From: Laszlo Ersek @ 2024-03-01 11:30 UTC (permalink / raw)
To: Kinney, Michael D
Cc: Bob Feng, Liming Gao, Rebecca Cran, Yuwei Chen,
edk2-devel-groups-io
Hi Mike,
can you please comment on the Build and Inf spec changes proposed in
this thread?
Thanks,
Laszlo
On 2/24/24 21:59, Laszlo Ersek wrote:
> v1 posting:
>
> https://edk2.groups.io/g/devel/message/115193
> msgid <36593e23-d3e8-b71a-808d-ef94260b5fd0@redhat.com>
>
> Bugzilla:
>
> https://bugzilla.tianocore.org/show_bug.cgi?id=991
>
> In version 2, the feature is structured differently. Following Mike's
> advice, for compatibility, the ProcessLibraryConstructorList()
> declaration in AutoGen.h is now gated on the SEC module having
> INF_VERSION >= 1.30.
>
> Accordingly,
>
> - I now update the Build specification and the Inf specification (see
> patch sets posted in response to this email),
>
> - edk2 only receives a single patch (for AutoGen), for the time being,
>
> - the same edk2 patch is being ported to edk2-basetools:
> https://github.com/tianocore/edk2-basetools/pull/120.
>
> Next steps: once all of the above is merged, *and* an edk2-basetools
> release has been tagged and published, I'll rework the C code patches
> for edk2 and edk2-platforms, from the v1 patch sets, as follows:
>
> - all those SEC modules will have to see their INF_VERSIONs bumped to
> 1.30, for triggering the new code generation,
>
> - pip-requirements.txt/edk2-basetools will need to reference the new
> edk2-basetools release, for exposing the feature in the first place.
>
> Laszlo
>
>
>
>
>
>
-=-=-=-=-=-=-=-=-=-=-=-
Groups.io Links: You receive all messages sent to this group.
View/Reply Online (#116234): https://edk2.groups.io/g/devel/message/116234
Mute This Topic: https://groups.io/mt/104553597/7686176
Group Owner: devel+owner@edk2.groups.io
Unsubscribe: https://edk2.groups.io/g/devel/unsub [rebecca@openfw.io]
-=-=-=-=-=-=-=-=-=-=-=-
^ permalink raw reply [flat|nested] 20+ messages in thread