* RFC: Add BaseLib/QuickSort in MdePkg @ 2021-09-14 6:15 Ni, Ray 2021-09-16 1:26 ` 回复: [edk2-devel] " gaoliming 0 siblings, 1 reply; 21+ messages in thread From: Ni, Ray @ 2021-09-14 6:15 UTC (permalink / raw) To: Kinney, Michael D, Gao, Liming, Liu, Zhiguang, Wang, Jian J, Gao, Zhichao Cc: devel@edk2.groups.io, Chan, Amy [-- Attachment #1: Type: text/plain, Size: 1622 bytes --] Hi package maintainers of MdePkg, MdeModulePkg and ShellPkg, community, A commit (UefiCpuPkg/CpuCacheInfoLib: Sort CpuCacheInfo array<https://github.com/tianocore/edk2/commit/4de77ae9890d241271f543e9195ab3516f3abec6>) to UefiCpuPkg let UefiCpuPkg depend on MdeModulePkg because the SortLib class and instances are all in MdeModulePkg. UefiCpuPkg depending on MdeModulePkg breaks the rule that "UefiCpuPkg should ONLY depend on MdePkg". To address this issue, there are two approaches: 1. Duplicate the sort logic in UefiCpuPkg to not depend on MdeModulePkg/SortLib 2. Add QuickSort() API to BaseLib in MdePkg. Approach #2 (MdePkg/BaseLib/QuickSort) makes more sense because quick sort is a standard algorithm. We encourage consumers to update their code to use the quick sort in MdePkg and gradually deprecate today's MdeModulePkg/SortLib. If you don't have concerns, I plan to: 1. "Add QuickSort() to BaseLib" and update all existing consumers to use this API instead. VOID EFIAPI QuickSort ( IN OUT VOID *BufferToSort, IN CONST UINTN Count, IN CONST UINTN ElementSize, IN SORT_COMPARE CompareFunction ); 1. "Add new ShellPkg/SortCompareLib" Background: ShellPkg requires to sort devicepath/string so 3 APIs in UefiSortLib (DevicePathCompare, StringNoCaseCompare, StringCompare) are provided for Shell usage. we can move the 3 APIs to the SortCompareLib and update Shell code to use BaseLib/QuickSort directly, with the sort compare function from SortCompareLib. Any concerns? Thanks, Ray [-- Attachment #2: Type: text/html, Size: 10341 bytes --] ^ permalink raw reply [flat|nested] 21+ messages in thread
* 回复: [edk2-devel] RFC: Add BaseLib/QuickSort in MdePkg 2021-09-14 6:15 RFC: Add BaseLib/QuickSort in MdePkg Ni, Ray @ 2021-09-16 1:26 ` gaoliming 2021-09-16 2:13 ` Andrew Fish 0 siblings, 1 reply; 21+ messages in thread From: gaoliming @ 2021-09-16 1:26 UTC (permalink / raw) To: devel, ray.ni, 'Kinney, Michael D', 'Gao, Liming', 'Liu, Zhiguang', 'Wang, Jian J', 'Gao, Zhichao' Cc: 'Chan, Amy' [-- Attachment #1: Type: text/plain, Size: 2490 bytes --] Ray: SortLib has been added since 2015. I would suggest to still keep this library class. To resolve the package dependency, my proposal is to move the library class header file SortLib.h from MdeModulePkg to MdePkg, and still keep the library instance in MdeModulePkg. This proposal has no impact on the existing platform. Thanks Liming 发件人: devel@edk2.groups.io <devel@edk2.groups.io> 代表 Ni, Ray 发送时间: 2021年9月14日 14:15 收件人: Kinney, Michael D <michael.d.kinney@intel.com>; Gao, Liming <liming. gao@intel.com>; Liu, Zhiguang <zhiguang.liu@intel.com>; Wang, Jian J <jian.j.wang@intel.com>; Gao, Zhichao <zhichao.gao@intel.com> 抄送: devel@edk2.groups.io; Chan, Amy <amy.chan@intel.com> 主题: [edk2-devel] RFC: Add BaseLib/QuickSort in MdePkg Hi package maintainers of MdePkg, MdeModulePkg and ShellPkg, community, A commit (UefiCpuPkg/CpuCacheInfoLib: Sort CpuCacheInfo array <https://github.com/tianocore/edk2/commit/4de77ae9890d241271f543e9195ab3516f 3abec6> ) to UefiCpuPkg let UefiCpuPkg depend on MdeModulePkg because the SortLib class and instances are all in MdeModulePkg. UefiCpuPkg depending on MdeModulePkg breaks the rule that “UefiCpuPkg should ONLY depend on MdePkg”. To address this issue, there are two approaches: 1. Duplicate the sort logic in UefiCpuPkg to not depend on MdeModulePkg/SortLib 2. Add QuickSort() API to BaseLib in MdePkg. Approach #2 (MdePkg/BaseLib/QuickSort) makes more sense because quick sort is a standard algorithm. We encourage consumers to update their code to use the quick sort in MdePkg and gradually deprecate today’s MdeModulePkg/SortLib. If you don’t have concerns, I plan to: 1. “Add QuickSort() to BaseLib” and update all existing consumers to use this API instead. VOID EFIAPI QuickSort ( IN OUT VOID *BufferToSort, IN CONST UINTN Count, IN CONST UINTN ElementSize, IN SORT_COMPARE CompareFunction ); 2. “Add new ShellPkg/SortCompareLib” Background: ShellPkg requires to sort devicepath/string so 3 APIs in UefiSortLib (DevicePathCompare, StringNoCaseCompare, StringCompare) are provided for Shell usage. we can move the 3 APIs to the SortCompareLib and update Shell code to use BaseLib/QuickSort directly, with the sort compare function from SortCompareLib. Any concerns? Thanks, Ray [-- Attachment #2: Type: text/html, Size: 13517 bytes --] ^ permalink raw reply [flat|nested] 21+ messages in thread
* Re: [edk2-devel] RFC: Add BaseLib/QuickSort in MdePkg 2021-09-16 1:26 ` 回复: [edk2-devel] " gaoliming @ 2021-09-16 2:13 ` Andrew Fish 2021-09-16 2:23 ` 回复: " gaoliming 0 siblings, 1 reply; 21+ messages in thread From: Andrew Fish @ 2021-09-16 2:13 UTC (permalink / raw) To: edk2-devel-groups-io, Liming Gao Cc: Ni, Ray, Mike Kinney, Gao, Liming, Liu, Zhiguang, Wang, Jian J, Gao, Zhichao, Chan, Amy [-- Attachment #1: Type: text/plain, Size: 3107 bytes --] > On Sep 15, 2021, at 6:26 PM, gaoliming <gaoliming@byosoft.com.cn> wrote: > > Ray: > SortLib has been added since 2015. I would suggest to still keep this library class. To resolve the package dependency, my proposal is to move the library class header file SortLib.h from MdeModulePkg to MdePkg, and still keep the library instance in MdeModulePkg. This proposal has no impact on the existing platform. > If we add QuickSort() API to the BaseLib can we not just port the existing MdeModulePkg/SortLib to use QuickSort() in the implementation? Or is there some other way to add the new thing in a backward compatible way. Thanks, Andrew Fish > Thanks > Liming > 发件人: devel@edk2.groups.io <mailto:devel@edk2.groups.io> <devel@edk2.groups.io <mailto:devel@edk2.groups.io>> 代表 Ni, Ray > 发送时间: 2021年9月14日 14:15 > 收件人: Kinney, Michael D <michael.d.kinney@intel.com <mailto:michael.d.kinney@intel.com>>; Gao, Liming <liming.gao@intel.com <mailto:liming.gao@intel.com>>; Liu, Zhiguang <zhiguang.liu@intel.com <mailto:zhiguang.liu@intel.com>>; Wang, Jian J <jian.j.wang@intel.com <mailto:jian.j.wang@intel.com>>; Gao, Zhichao <zhichao.gao@intel.com <mailto:zhichao.gao@intel.com>> > 抄送: devel@edk2.groups.io <mailto:devel@edk2.groups.io>; Chan, Amy <amy.chan@intel.com <mailto:amy.chan@intel.com>> > 主题: [edk2-devel] RFC: Add BaseLib/QuickSort in MdePkg > > Hi package maintainers of MdePkg, MdeModulePkg and ShellPkg, community, > > A commit (UefiCpuPkg/CpuCacheInfoLib: Sort CpuCacheInfo array <https://github.com/tianocore/edk2/commit/4de77ae9890d241271f543e9195ab3516f3abec6>) to UefiCpuPkg let > UefiCpuPkg depend on MdeModulePkg because the SortLib class and instances are all in MdeModulePkg. > > UefiCpuPkg depending on MdeModulePkg breaks the rule that “UefiCpuPkg should ONLY depend on MdePkg”. > > To address this issue, there are two approaches: > Duplicate the sort logic in UefiCpuPkg to not depend on MdeModulePkg/SortLib > Add QuickSort() API to BaseLib in MdePkg. > > Approach #2 (MdePkg/BaseLib/QuickSort) makes more sense because quick sort is a standard algorithm. > We encourage consumers to update their code to use the quick sort in MdePkg and gradually deprecate today’s MdeModulePkg/SortLib. > > If you don’t have concerns, I plan to: > “Add QuickSort() to BaseLib” and update all existing consumers to use this API instead. > VOID > EFIAPI > QuickSort ( > IN OUT VOID *BufferToSort, > IN CONST UINTN Count, > IN CONST UINTN ElementSize, > IN SORT_COMPARE CompareFunction > ); > > “Add new ShellPkg/SortCompareLib” > Background: ShellPkg requires to sort devicepath/string so 3 APIs in UefiSortLib (DevicePathCompare, StringNoCaseCompare, StringCompare) are provided for Shell usage. we can move the 3 APIs to the SortCompareLib and update Shell code to use BaseLib/QuickSort directly, with the sort compare function from SortCompareLib. > > Any concerns? > > Thanks, > Ray > [-- Attachment #2: Type: text/html, Size: 15573 bytes --] ^ permalink raw reply [flat|nested] 21+ messages in thread
* 回复: [edk2-devel] RFC: Add BaseLib/QuickSort in MdePkg 2021-09-16 2:13 ` Andrew Fish @ 2021-09-16 2:23 ` gaoliming 2021-09-16 2:45 ` Chan, Amy 2021-09-16 2:47 ` Ni, Ray 0 siblings, 2 replies; 21+ messages in thread From: gaoliming @ 2021-09-16 2:23 UTC (permalink / raw) To: 'Andrew Fish', 'edk2-devel-groups-io' Cc: 'Ni, Ray', 'Mike Kinney', 'Gao, Liming', 'Liu, Zhiguang', 'Wang, Jian J', 'Gao, Zhichao', 'Chan, Amy' [-- Attachment #1: Type: text/plain, Size: 3991 bytes --] Andrew: Thanks for your suggestion. I think your idea is better. We add new QuickSort() API to BaseLib, and update SortLib library instance to consume BaseLib QuickSort() API. This way has no change in current SortLib library class. It is the compatible solution. Thanks Liming 发件人: Andrew Fish <afish@apple.com> 发送时间: 2021年9月16日 10:13 收件人: edk2-devel-groups-io <devel@edk2.groups.io>; Liming Gao <gaoliming@byosoft.com.cn> 抄送: Ni, Ray <ray.ni@intel.com>; Mike Kinney <michael.d.kinney@intel.com>; Gao, Liming <liming.gao@intel.com>; Liu, Zhiguang <zhiguang.liu@intel.com>; Wang, Jian J <jian.j.wang@intel.com>; Gao, Zhichao <zhichao.gao@intel.com>; Chan, Amy <amy.chan@intel.com> 主题: Re: [edk2-devel] RFC: Add BaseLib/QuickSort in MdePkg On Sep 15, 2021, at 6:26 PM, gaoliming <gaoliming@byosoft.com.cn <mailto:gaoliming@byosoft.com.cn> > wrote: Ray: SortLib has been added since 2015. I would suggest to still keep this library class. To resolve the package dependency, my proposal is to move the library class header file SortLib.h from MdeModulePkg to MdePkg, and still keep the library instance in MdeModulePkg. This proposal has no impact on the existing platform. If we add QuickSort() API to the BaseLib can we not just port the existing MdeModulePkg/SortLib to use QuickSort() in the implementation? Or is there some other way to add the new thing in a backward compatible way. Thanks, Andrew Fish Thanks Liming 发件人: <mailto:devel@edk2.groups.io> devel@edk2.groups.io < <mailto:devel@edk2.groups.io> devel@edk2.groups.io> 代表 Ni, Ray 发送时间: 2021年9月14日 14:15 收件人: Kinney, Michael D < <mailto:michael.d.kinney@intel.com> michael.d.kinney@intel.com>; Gao, Liming < <mailto:liming.gao@intel.com> liming.gao@intel.com>; Liu, Zhiguang < <mailto:zhiguang.liu@intel.com> zhiguang.liu@intel.com>; Wang, Jian J < <mailto:jian.j.wang@intel.com> jian.j.wang@intel.com>; Gao, Zhichao < <mailto:zhichao.gao@intel.com> zhichao.gao@intel.com> 抄送: <mailto:devel@edk2.groups.io> devel@edk2.groups.io; Chan, Amy < <mailto:amy.chan@intel.com> amy.chan@intel.com> 主题: [edk2-devel] RFC: Add BaseLib/QuickSort in MdePkg Hi package maintainers of MdePkg, MdeModulePkg and ShellPkg, community, A commit ( <https://github.com/tianocore/edk2/commit/4de77ae9890d241271f543e9195ab3516f3abec6> UefiCpuPkg/CpuCacheInfoLib: Sort CpuCacheInfo array) to UefiCpuPkg let UefiCpuPkg depend on MdeModulePkg because the SortLib class and instances are all in MdeModulePkg. UefiCpuPkg depending on MdeModulePkg breaks the rule that “UefiCpuPkg should ONLY depend on MdePkg”. To address this issue, there are two approaches: 1. Duplicate the sort logic in UefiCpuPkg to not depend on MdeModulePkg/SortLib 2. Add QuickSort() API to BaseLib in MdePkg. Approach #2 (MdePkg/BaseLib/QuickSort) makes more sense because quick sort is a standard algorithm. We encourage consumers to update their code to use the quick sort in MdePkg and gradually deprecate today’s MdeModulePkg/SortLib. If you don’t have concerns, I plan to: 1. “Add QuickSort() to BaseLib” and update all existing consumers to use this API instead. VOID EFIAPI QuickSort ( IN OUT VOID *BufferToSort, IN CONST UINTN Count, IN CONST UINTN ElementSize, IN SORT_COMPARE CompareFunction ); 2. “Add new ShellPkg/SortCompareLib” Background: ShellPkg requires to sort devicepath/string so 3 APIs in UefiSortLib (DevicePathCompare, StringNoCaseCompare, StringCompare) are provided for Shell usage. we can move the 3 APIs to the SortCompareLib and update Shell code to use BaseLib/QuickSort directly, with the sort compare function from SortCompareLib. Any concerns? Thanks, Ray [-- Attachment #2: Type: text/html, Size: 19536 bytes --] ^ permalink raw reply [flat|nested] 21+ messages in thread
* Re: [edk2-devel] RFC: Add BaseLib/QuickSort in MdePkg 2021-09-16 2:23 ` 回复: " gaoliming @ 2021-09-16 2:45 ` Chan, Amy 2021-09-16 2:47 ` Ni, Ray 2021-09-16 2:47 ` Ni, Ray 1 sibling, 1 reply; 21+ messages in thread From: Chan, Amy @ 2021-09-16 2:45 UTC (permalink / raw) To: gaoliming, 'Andrew Fish', 'edk2-devel-groups-io' Cc: Ni, Ray, Kinney, Michael D, 'Gao, Liming', Liu, Zhiguang, Wang, Jian J, Gao, Zhichao [-- Attachment #1: Type: text/plain, Size: 4745 bytes --] Just to double confirm, will we have the null instance of QuickSort in MdePkg? Regards, Amy From: gaoliming <gaoliming@byosoft.com.cn> Sent: Thursday, September 16, 2021 10:23 AM To: 'Andrew Fish' <afish@apple.com>; 'edk2-devel-groups-io' <devel@edk2.groups.io> Cc: Ni, Ray <ray.ni@intel.com>; Kinney, Michael D <michael.d.kinney@intel.com>; 'Gao, Liming' <liming.gao@intel.com>; Liu, Zhiguang <zhiguang.liu@intel.com>; Wang, Jian J <jian.j.wang@intel.com>; Gao, Zhichao <zhichao.gao@intel.com>; Chan, Amy <amy.chan@intel.com> Subject: 回复: [edk2-devel] RFC: Add BaseLib/QuickSort in MdePkg Andrew: Thanks for your suggestion. I think your idea is better. We add new QuickSort() API to BaseLib, and update SortLib library instance to consume BaseLib QuickSort() API. This way has no change in current SortLib library class. It is the compatible solution. Thanks Liming 发件人: Andrew Fish <afish@apple.com<mailto:afish@apple.com>> 发送时间: 2021年9月16日 10:13 收件人: edk2-devel-groups-io <devel@edk2.groups.io<mailto:devel@edk2.groups.io>>; Liming Gao <gaoliming@byosoft.com.cn<mailto:gaoliming@byosoft.com.cn>> 抄送: Ni, Ray <ray.ni@intel.com<mailto:ray.ni@intel.com>>; Mike Kinney <michael.d.kinney@intel.com<mailto:michael.d.kinney@intel.com>>; Gao, Liming <liming.gao@intel.com<mailto:liming.gao@intel.com>>; Liu, Zhiguang <zhiguang.liu@intel.com<mailto:zhiguang.liu@intel.com>>; Wang, Jian J <jian.j.wang@intel.com<mailto:jian.j.wang@intel.com>>; Gao, Zhichao <zhichao.gao@intel.com<mailto:zhichao.gao@intel.com>>; Chan, Amy <amy.chan@intel.com<mailto:amy.chan@intel.com>> 主题: Re: [edk2-devel] RFC: Add BaseLib/QuickSort in MdePkg On Sep 15, 2021, at 6:26 PM, gaoliming <gaoliming@byosoft.com.cn<mailto:gaoliming@byosoft.com.cn>> wrote: Ray: SortLib has been added since 2015. I would suggest to still keep this library class. To resolve the package dependency, my proposal is to move the library class header file SortLib.h from MdeModulePkg to MdePkg, and still keep the library instance in MdeModulePkg. This proposal has no impact on the existing platform. If we add QuickSort() API to the BaseLib can we not just port the existing MdeModulePkg/SortLib to use QuickSort() in the implementation? Or is there some other way to add the new thing in a backward compatible way. Thanks, Andrew Fish Thanks Liming 发件人: devel@edk2.groups.io<mailto:devel@edk2.groups.io> <devel@edk2.groups.io<mailto:devel@edk2.groups.io>> 代表 Ni, Ray 发送时间: 2021年9月14日 14:15 收件人: Kinney, Michael D <michael.d.kinney@intel.com<mailto:michael.d.kinney@intel.com>>; Gao, Liming <liming.gao@intel.com<mailto:liming.gao@intel.com>>; Liu, Zhiguang <zhiguang.liu@intel.com<mailto:zhiguang.liu@intel.com>>; Wang, Jian J <jian.j.wang@intel.com<mailto:jian.j.wang@intel.com>>; Gao, Zhichao <zhichao.gao@intel.com<mailto:zhichao.gao@intel.com>> 抄送: devel@edk2.groups.io<mailto:devel@edk2.groups.io>; Chan, Amy <amy.chan@intel.com<mailto:amy.chan@intel.com>> 主题: [edk2-devel] RFC: Add BaseLib/QuickSort in MdePkg Hi package maintainers of MdePkg, MdeModulePkg and ShellPkg, community, A commit (UefiCpuPkg/CpuCacheInfoLib: Sort CpuCacheInfo array<https://github.com/tianocore/edk2/commit/4de77ae9890d241271f543e9195ab3516f3abec6>) to UefiCpuPkg let UefiCpuPkg depend on MdeModulePkg because the SortLib class and instances are all in MdeModulePkg. UefiCpuPkg depending on MdeModulePkg breaks the rule that “UefiCpuPkg should ONLY depend on MdePkg”. To address this issue, there are two approaches: 1. Duplicate the sort logic in UefiCpuPkg to not depend on MdeModulePkg/SortLib 2. Add QuickSort() API to BaseLib in MdePkg. Approach #2 (MdePkg/BaseLib/QuickSort) makes more sense because quick sort is a standard algorithm. We encourage consumers to update their code to use the quick sort in MdePkg and gradually deprecate today’s MdeModulePkg/SortLib. If you don’t have concerns, I plan to: 1. “Add QuickSort() to BaseLib” and update all existing consumers to use this API instead. VOID EFIAPI QuickSort ( IN OUT VOID *BufferToSort, IN CONST UINTN Count, IN CONST UINTN ElementSize, IN SORT_COMPARE CompareFunction ); 1. “Add new ShellPkg/SortCompareLib” Background: ShellPkg requires to sort devicepath/string so 3 APIs in UefiSortLib (DevicePathCompare, StringNoCaseCompare, StringCompare) are provided for Shell usage. we can move the 3 APIs to the SortCompareLib and update Shell code to use BaseLib/QuickSort directly, with the sort compare function from SortCompareLib. Any concerns? Thanks, Ray [-- Attachment #2: Type: text/html, Size: 28052 bytes --] ^ permalink raw reply [flat|nested] 21+ messages in thread
* Re: [edk2-devel] RFC: Add BaseLib/QuickSort in MdePkg 2021-09-16 2:45 ` Chan, Amy @ 2021-09-16 2:47 ` Ni, Ray 2021-09-22 6:03 ` Ni, Ray [not found] ` <16A70FAC1585C7C1.27516@groups.io> 0 siblings, 2 replies; 21+ messages in thread From: Ni, Ray @ 2021-09-16 2:47 UTC (permalink / raw) To: Chan, Amy, gaoliming, 'Andrew Fish', 'edk2-devel-groups-io' Cc: Kinney, Michael D, 'Gao, Liming', Liu, Zhiguang, Wang, Jian J, Gao, Zhichao [-- Attachment #1: Type: text/plain, Size: 5609 bytes --] Amy, No. We only Add QuickSort() function API into BaseLib.h. From: Chan, Amy <amy.chan@intel.com> Sent: Thursday, September 16, 2021 10:46 AM To: gaoliming <gaoliming@byosoft.com.cn>; 'Andrew Fish' <afish@apple.com>; 'edk2-devel-groups-io' <devel@edk2.groups.io> Cc: Ni, Ray <ray.ni@intel.com>; Kinney, Michael D <michael.d.kinney@intel.com>; 'Gao, Liming' <liming.gao@intel.com>; Liu, Zhiguang <zhiguang.liu@intel.com>; Wang, Jian J <jian.j.wang@intel.com>; Gao, Zhichao <zhichao.gao@intel.com> Subject: RE: [edk2-devel] RFC: Add BaseLib/QuickSort in MdePkg Just to double confirm, will we have the null instance of QuickSort in MdePkg? Regards, Amy From: gaoliming <gaoliming@byosoft.com.cn<mailto:gaoliming@byosoft.com.cn>> Sent: Thursday, September 16, 2021 10:23 AM To: 'Andrew Fish' <afish@apple.com<mailto:afish@apple.com>>; 'edk2-devel-groups-io' <devel@edk2.groups.io<mailto:devel@edk2.groups.io>> Cc: Ni, Ray <ray.ni@intel.com<mailto:ray.ni@intel.com>>; Kinney, Michael D <michael.d.kinney@intel.com<mailto:michael.d.kinney@intel.com>>; 'Gao, Liming' <liming.gao@intel.com<mailto:liming.gao@intel.com>>; Liu, Zhiguang <zhiguang.liu@intel.com<mailto:zhiguang.liu@intel.com>>; Wang, Jian J <jian.j.wang@intel.com<mailto:jian.j.wang@intel.com>>; Gao, Zhichao <zhichao.gao@intel.com<mailto:zhichao.gao@intel.com>>; Chan, Amy <amy.chan@intel.com<mailto:amy.chan@intel.com>> Subject: 回复: [edk2-devel] RFC: Add BaseLib/QuickSort in MdePkg Andrew: Thanks for your suggestion. I think your idea is better. We add new QuickSort() API to BaseLib, and update SortLib library instance to consume BaseLib QuickSort() API. This way has no change in current SortLib library class. It is the compatible solution. Thanks Liming 发件人: Andrew Fish <afish@apple.com<mailto:afish@apple.com>> 发送时间: 2021年9月16日 10:13 收件人: edk2-devel-groups-io <devel@edk2.groups.io<mailto:devel@edk2.groups.io>>; Liming Gao <gaoliming@byosoft.com.cn<mailto:gaoliming@byosoft.com.cn>> 抄送: Ni, Ray <ray.ni@intel.com<mailto:ray.ni@intel.com>>; Mike Kinney <michael.d.kinney@intel.com<mailto:michael.d.kinney@intel.com>>; Gao, Liming <liming.gao@intel.com<mailto:liming.gao@intel.com>>; Liu, Zhiguang <zhiguang.liu@intel.com<mailto:zhiguang.liu@intel.com>>; Wang, Jian J <jian.j.wang@intel.com<mailto:jian.j.wang@intel.com>>; Gao, Zhichao <zhichao.gao@intel.com<mailto:zhichao.gao@intel.com>>; Chan, Amy <amy.chan@intel.com<mailto:amy.chan@intel.com>> 主题: Re: [edk2-devel] RFC: Add BaseLib/QuickSort in MdePkg On Sep 15, 2021, at 6:26 PM, gaoliming <gaoliming@byosoft.com.cn<mailto:gaoliming@byosoft.com.cn>> wrote: Ray: SortLib has been added since 2015. I would suggest to still keep this library class. To resolve the package dependency, my proposal is to move the library class header file SortLib.h from MdeModulePkg to MdePkg, and still keep the library instance in MdeModulePkg. This proposal has no impact on the existing platform. If we add QuickSort() API to the BaseLib can we not just port the existing MdeModulePkg/SortLib to use QuickSort() in the implementation? Or is there some other way to add the new thing in a backward compatible way. Thanks, Andrew Fish Thanks Liming 发件人: devel@edk2.groups.io<mailto:devel@edk2.groups.io> <devel@edk2.groups.io<mailto:devel@edk2.groups.io>> 代表 Ni, Ray 发送时间: 2021年9月14日 14:15 收件人: Kinney, Michael D <michael.d.kinney@intel.com<mailto:michael.d.kinney@intel.com>>; Gao, Liming <liming.gao@intel.com<mailto:liming.gao@intel.com>>; Liu, Zhiguang <zhiguang.liu@intel.com<mailto:zhiguang.liu@intel.com>>; Wang, Jian J <jian.j.wang@intel.com<mailto:jian.j.wang@intel.com>>; Gao, Zhichao <zhichao.gao@intel.com<mailto:zhichao.gao@intel.com>> 抄送: devel@edk2.groups.io<mailto:devel@edk2.groups.io>; Chan, Amy <amy.chan@intel.com<mailto:amy.chan@intel.com>> 主题: [edk2-devel] RFC: Add BaseLib/QuickSort in MdePkg Hi package maintainers of MdePkg, MdeModulePkg and ShellPkg, community, A commit (UefiCpuPkg/CpuCacheInfoLib: Sort CpuCacheInfo array<https://github.com/tianocore/edk2/commit/4de77ae9890d241271f543e9195ab3516f3abec6>) to UefiCpuPkg let UefiCpuPkg depend on MdeModulePkg because the SortLib class and instances are all in MdeModulePkg. UefiCpuPkg depending on MdeModulePkg breaks the rule that “UefiCpuPkg should ONLY depend on MdePkg”. To address this issue, there are two approaches: 1. Duplicate the sort logic in UefiCpuPkg to not depend on MdeModulePkg/SortLib 2. Add QuickSort() API to BaseLib in MdePkg. Approach #2 (MdePkg/BaseLib/QuickSort) makes more sense because quick sort is a standard algorithm. We encourage consumers to update their code to use the quick sort in MdePkg and gradually deprecate today’s MdeModulePkg/SortLib. If you don’t have concerns, I plan to: 1. “Add QuickSort() to BaseLib” and update all existing consumers to use this API instead. VOID EFIAPI QuickSort ( IN OUT VOID *BufferToSort, IN CONST UINTN Count, IN CONST UINTN ElementSize, IN SORT_COMPARE CompareFunction ); 1. “Add new ShellPkg/SortCompareLib” Background: ShellPkg requires to sort devicepath/string so 3 APIs in UefiSortLib (DevicePathCompare, StringNoCaseCompare, StringCompare) are provided for Shell usage. we can move the 3 APIs to the SortCompareLib and update Shell code to use BaseLib/QuickSort directly, with the sort compare function from SortCompareLib. Any concerns? Thanks, Ray [-- Attachment #2: Type: text/html, Size: 26805 bytes --] ^ permalink raw reply [flat|nested] 21+ messages in thread
* Re: [edk2-devel] RFC: Add BaseLib/QuickSort in MdePkg 2021-09-16 2:47 ` Ni, Ray @ 2021-09-22 6:03 ` Ni, Ray [not found] ` <16A70FAC1585C7C1.27516@groups.io> 1 sibling, 0 replies; 21+ messages in thread From: Ni, Ray @ 2021-09-22 6:03 UTC (permalink / raw) To: Chan, Amy, gaoliming, 'Andrew Fish', 'edk2-devel-groups-io' Cc: Kinney, Michael D, 'Gao, Liming', Liu, Zhiguang, Wang, Jian J, Gao, Zhichao [-- Attachment #1: Type: text/plain, Size: 6733 bytes --] I don’t see objection so far. So, the final solution is: 1. Add QuickSort() API to BaseLib in MdePkg. 2. Update existing MdeModulePkg/SortLib to use QuickSort() in the implementation (proposed by Andrew Fish and Liming Gao) 3. Update UefiCpuPkg to use QuickSortLib to remove improper dependency on MdeModulePkg Thanks, Ray From: Ni, Ray Sent: Thursday, September 16, 2021 10:48 AM To: Chan, Amy <amy.chan@intel.com>; gaoliming <gaoliming@byosoft.com.cn>; 'Andrew Fish' <afish@apple.com>; 'edk2-devel-groups-io' <devel@edk2.groups.io> Cc: Kinney, Michael D <michael.d.kinney@intel.com>; 'Gao, Liming' <liming.gao@intel.com>; Liu, Zhiguang <Zhiguang.Liu@intel.com>; Wang, Jian J <jian.j.wang@intel.com>; Gao, Zhichao <zhichao.gao@intel.com> Subject: RE: [edk2-devel] RFC: Add BaseLib/QuickSort in MdePkg Amy, No. We only Add QuickSort() function API into BaseLib.h. From: Chan, Amy <amy.chan@intel.com<mailto:amy.chan@intel.com>> Sent: Thursday, September 16, 2021 10:46 AM To: gaoliming <gaoliming@byosoft.com.cn<mailto:gaoliming@byosoft.com.cn>>; 'Andrew Fish' <afish@apple.com<mailto:afish@apple.com>>; 'edk2-devel-groups-io' <devel@edk2.groups.io<mailto:devel@edk2.groups.io>> Cc: Ni, Ray <ray.ni@intel.com<mailto:ray.ni@intel.com>>; Kinney, Michael D <michael.d.kinney@intel.com<mailto:michael.d.kinney@intel.com>>; 'Gao, Liming' <liming.gao@intel.com<mailto:liming.gao@intel.com>>; Liu, Zhiguang <zhiguang.liu@intel.com<mailto:zhiguang.liu@intel.com>>; Wang, Jian J <jian.j.wang@intel.com<mailto:jian.j.wang@intel.com>>; Gao, Zhichao <zhichao.gao@intel.com<mailto:zhichao.gao@intel.com>> Subject: RE: [edk2-devel] RFC: Add BaseLib/QuickSort in MdePkg Just to double confirm, will we have the null instance of QuickSort in MdePkg? Regards, Amy From: gaoliming <gaoliming@byosoft.com.cn<mailto:gaoliming@byosoft.com.cn>> Sent: Thursday, September 16, 2021 10:23 AM To: 'Andrew Fish' <afish@apple.com<mailto:afish@apple.com>>; 'edk2-devel-groups-io' <devel@edk2.groups.io<mailto:devel@edk2.groups.io>> Cc: Ni, Ray <ray.ni@intel.com<mailto:ray.ni@intel.com>>; Kinney, Michael D <michael.d.kinney@intel.com<mailto:michael.d.kinney@intel.com>>; 'Gao, Liming' <liming.gao@intel.com<mailto:liming.gao@intel.com>>; Liu, Zhiguang <zhiguang.liu@intel.com<mailto:zhiguang.liu@intel.com>>; Wang, Jian J <jian.j.wang@intel.com<mailto:jian.j.wang@intel.com>>; Gao, Zhichao <zhichao.gao@intel.com<mailto:zhichao.gao@intel.com>>; Chan, Amy <amy.chan@intel.com<mailto:amy.chan@intel.com>> Subject: 回复: [edk2-devel] RFC: Add BaseLib/QuickSort in MdePkg Andrew: Thanks for your suggestion. I think your idea is better. We add new QuickSort() API to BaseLib, and update SortLib library instance to consume BaseLib QuickSort() API. This way has no change in current SortLib library class. It is the compatible solution. Thanks Liming 发件人: Andrew Fish <afish@apple.com<mailto:afish@apple.com>> 发送时间: 2021年9月16日 10:13 收件人: edk2-devel-groups-io <devel@edk2.groups.io<mailto:devel@edk2.groups.io>>; Liming Gao <gaoliming@byosoft.com.cn<mailto:gaoliming@byosoft.com.cn>> 抄送: Ni, Ray <ray.ni@intel.com<mailto:ray.ni@intel.com>>; Mike Kinney <michael.d.kinney@intel.com<mailto:michael.d.kinney@intel.com>>; Gao, Liming <liming.gao@intel.com<mailto:liming.gao@intel.com>>; Liu, Zhiguang <zhiguang.liu@intel.com<mailto:zhiguang.liu@intel.com>>; Wang, Jian J <jian.j.wang@intel.com<mailto:jian.j.wang@intel.com>>; Gao, Zhichao <zhichao.gao@intel.com<mailto:zhichao.gao@intel.com>>; Chan, Amy <amy.chan@intel.com<mailto:amy.chan@intel.com>> 主题: Re: [edk2-devel] RFC: Add BaseLib/QuickSort in MdePkg On Sep 15, 2021, at 6:26 PM, gaoliming <gaoliming@byosoft.com.cn<mailto:gaoliming@byosoft.com.cn>> wrote: Ray: SortLib has been added since 2015. I would suggest to still keep this library class. To resolve the package dependency, my proposal is to move the library class header file SortLib.h from MdeModulePkg to MdePkg, and still keep the library instance in MdeModulePkg. This proposal has no impact on the existing platform. If we add QuickSort() API to the BaseLib can we not just port the existing MdeModulePkg/SortLib to use QuickSort() in the implementation? Or is there some other way to add the new thing in a backward compatible way. Thanks, Andrew Fish Thanks Liming 发件人: devel@edk2.groups.io<mailto:devel@edk2.groups.io> <devel@edk2.groups.io<mailto:devel@edk2.groups.io>> 代表 Ni, Ray 发送时间: 2021年9月14日 14:15 收件人: Kinney, Michael D <michael.d.kinney@intel.com<mailto:michael.d.kinney@intel.com>>; Gao, Liming <liming.gao@intel.com<mailto:liming.gao@intel.com>>; Liu, Zhiguang <zhiguang.liu@intel.com<mailto:zhiguang.liu@intel.com>>; Wang, Jian J <jian.j.wang@intel.com<mailto:jian.j.wang@intel.com>>; Gao, Zhichao <zhichao.gao@intel.com<mailto:zhichao.gao@intel.com>> 抄送: devel@edk2.groups.io<mailto:devel@edk2.groups.io>; Chan, Amy <amy.chan@intel.com<mailto:amy.chan@intel.com>> 主题: [edk2-devel] RFC: Add BaseLib/QuickSort in MdePkg Hi package maintainers of MdePkg, MdeModulePkg and ShellPkg, community, A commit (UefiCpuPkg/CpuCacheInfoLib: Sort CpuCacheInfo array<https://github.com/tianocore/edk2/commit/4de77ae9890d241271f543e9195ab3516f3abec6>) to UefiCpuPkg let UefiCpuPkg depend on MdeModulePkg because the SortLib class and instances are all in MdeModulePkg. UefiCpuPkg depending on MdeModulePkg breaks the rule that “UefiCpuPkg should ONLY depend on MdePkg”. To address this issue, there are two approaches: 1. Duplicate the sort logic in UefiCpuPkg to not depend on MdeModulePkg/SortLib 2. Add QuickSort() API to BaseLib in MdePkg. Approach #2 (MdePkg/BaseLib/QuickSort) makes more sense because quick sort is a standard algorithm. We encourage consumers to update their code to use the quick sort in MdePkg and gradually deprecate today’s MdeModulePkg/SortLib. If you don’t have concerns, I plan to: 1. “Add QuickSort() to BaseLib” and update all existing consumers to use this API instead. VOID EFIAPI QuickSort ( IN OUT VOID *BufferToSort, IN CONST UINTN Count, IN CONST UINTN ElementSize, IN SORT_COMPARE CompareFunction ); 1. “Add new ShellPkg/SortCompareLib” Background: ShellPkg requires to sort devicepath/string so 3 APIs in UefiSortLib (DevicePathCompare, StringNoCaseCompare, StringCompare) are provided for Shell usage. we can move the 3 APIs to the SortCompareLib and update Shell code to use BaseLib/QuickSort directly, with the sort compare function from SortCompareLib. Any concerns? Thanks, Ray [-- Attachment #2: Type: text/html, Size: 31987 bytes --] ^ permalink raw reply [flat|nested] 21+ messages in thread
[parent not found: <16A70FAC1585C7C1.27516@groups.io>]
* Re: [edk2-devel] RFC: Add BaseLib/QuickSort in MdePkg [not found] ` <16A70FAC1585C7C1.27516@groups.io> @ 2021-09-24 3:53 ` Ni, Ray 2021-09-26 2:00 ` 回复: " gaoliming 0 siblings, 1 reply; 21+ messages in thread From: Ni, Ray @ 2021-09-24 3:53 UTC (permalink / raw) To: devel@edk2.groups.io, Ni, Ray, Chan, Amy, gaoliming, 'Andrew Fish' Cc: Kinney, Michael D, 'Gao, Liming', Liu, Zhiguang, Wang, Jian J, Gao, Zhichao [-- Attachment #1: Type: text/plain, Size: 8554 bytes --] More details on new QuickSort() API: The new API needs to carry additional parameter “BufferOneElement”. This parameter gives QuickSort() the temporary buffer for swapping in sorting. It’s to avoid BaseLib depends on MemoryAllocationLib. … @param [in] BufferOneElement When ElementSize > 256, caller needs to provide a buffer whose size equals to ElementSize. It’s used by QuickSort() for swapping in sorting. When ElementSize <= 256, QuickSort() uses a local stack 256-byte buffer. @retval EFI_INVALID_PARAMETER When (ElementSize > 256) and (BufferOneElement == NULL). … VOID EFIAPI QuickSort ( IN OUT VOID *BufferToSort, IN CONST UINTN ElementCount, IN CONST UINTN ElementSize, IN SORT_COMPARE CompareFunction, IN VOID *BufferOneElement OPTIONAL ); Any comments? From: devel@edk2.groups.io <devel@edk2.groups.io> On Behalf Of Ni, Ray Sent: Wednesday, September 22, 2021 2:04 PM To: Chan, Amy <amy.chan@intel.com>; gaoliming <gaoliming@byosoft.com.cn>; 'Andrew Fish' <afish@apple.com>; 'edk2-devel-groups-io' <devel@edk2.groups.io> Cc: Kinney, Michael D <michael.d.kinney@intel.com>; 'Gao, Liming' <liming.gao@intel.com>; Liu, Zhiguang <zhiguang.liu@intel.com>; Wang, Jian J <jian.j.wang@intel.com>; Gao, Zhichao <zhichao.gao@intel.com> Subject: Re: [edk2-devel] RFC: Add BaseLib/QuickSort in MdePkg I don’t see objection so far. So, the final solution is: 1. Add QuickSort() API to BaseLib in MdePkg. 2. Update existing MdeModulePkg/SortLib to use QuickSort() in the implementation (proposed by Andrew Fish and Liming Gao) 3. Update UefiCpuPkg to use QuickSortLib to remove improper dependency on MdeModulePkg Thanks, Ray From: Ni, Ray Sent: Thursday, September 16, 2021 10:48 AM To: Chan, Amy <amy.chan@intel.com<mailto:amy.chan@intel.com>>; gaoliming <gaoliming@byosoft.com.cn<mailto:gaoliming@byosoft.com.cn>>; 'Andrew Fish' <afish@apple.com<mailto:afish@apple.com>>; 'edk2-devel-groups-io' <devel@edk2.groups.io<mailto:devel@edk2.groups.io>> Cc: Kinney, Michael D <michael.d.kinney@intel.com<mailto:michael.d.kinney@intel.com>>; 'Gao, Liming' <liming.gao@intel.com<mailto:liming.gao@intel.com>>; Liu, Zhiguang <Zhiguang.Liu@intel.com<mailto:Zhiguang.Liu@intel.com>>; Wang, Jian J <jian.j.wang@intel.com<mailto:jian.j.wang@intel.com>>; Gao, Zhichao <zhichao.gao@intel.com<mailto:zhichao.gao@intel.com>> Subject: RE: [edk2-devel] RFC: Add BaseLib/QuickSort in MdePkg Amy, No. We only Add QuickSort() function API into BaseLib.h. From: Chan, Amy <amy.chan@intel.com<mailto:amy.chan@intel.com>> Sent: Thursday, September 16, 2021 10:46 AM To: gaoliming <gaoliming@byosoft.com.cn<mailto:gaoliming@byosoft.com.cn>>; 'Andrew Fish' <afish@apple.com<mailto:afish@apple.com>>; 'edk2-devel-groups-io' <devel@edk2.groups.io<mailto:devel@edk2.groups.io>> Cc: Ni, Ray <ray.ni@intel.com<mailto:ray.ni@intel.com>>; Kinney, Michael D <michael.d.kinney@intel.com<mailto:michael.d.kinney@intel.com>>; 'Gao, Liming' <liming.gao@intel.com<mailto:liming.gao@intel.com>>; Liu, Zhiguang <zhiguang.liu@intel.com<mailto:zhiguang.liu@intel.com>>; Wang, Jian J <jian.j.wang@intel.com<mailto:jian.j.wang@intel.com>>; Gao, Zhichao <zhichao.gao@intel.com<mailto:zhichao.gao@intel.com>> Subject: RE: [edk2-devel] RFC: Add BaseLib/QuickSort in MdePkg Just to double confirm, will we have the null instance of QuickSort in MdePkg? Regards, Amy From: gaoliming <gaoliming@byosoft.com.cn<mailto:gaoliming@byosoft.com.cn>> Sent: Thursday, September 16, 2021 10:23 AM To: 'Andrew Fish' <afish@apple.com<mailto:afish@apple.com>>; 'edk2-devel-groups-io' <devel@edk2.groups.io<mailto:devel@edk2.groups.io>> Cc: Ni, Ray <ray.ni@intel.com<mailto:ray.ni@intel.com>>; Kinney, Michael D <michael.d.kinney@intel.com<mailto:michael.d.kinney@intel.com>>; 'Gao, Liming' <liming.gao@intel.com<mailto:liming.gao@intel.com>>; Liu, Zhiguang <zhiguang.liu@intel.com<mailto:zhiguang.liu@intel.com>>; Wang, Jian J <jian.j.wang@intel.com<mailto:jian.j.wang@intel.com>>; Gao, Zhichao <zhichao.gao@intel.com<mailto:zhichao.gao@intel.com>>; Chan, Amy <amy.chan@intel.com<mailto:amy.chan@intel.com>> Subject: 回复: [edk2-devel] RFC: Add BaseLib/QuickSort in MdePkg Andrew: Thanks for your suggestion. I think your idea is better. We add new QuickSort() API to BaseLib, and update SortLib library instance to consume BaseLib QuickSort() API. This way has no change in current SortLib library class. It is the compatible solution. Thanks Liming 发件人: Andrew Fish <afish@apple.com<mailto:afish@apple.com>> 发送时间: 2021年9月16日 10:13 收件人: edk2-devel-groups-io <devel@edk2.groups.io<mailto:devel@edk2.groups.io>>; Liming Gao <gaoliming@byosoft.com.cn<mailto:gaoliming@byosoft.com.cn>> 抄送: Ni, Ray <ray.ni@intel.com<mailto:ray.ni@intel.com>>; Mike Kinney <michael.d.kinney@intel.com<mailto:michael.d.kinney@intel.com>>; Gao, Liming <liming.gao@intel.com<mailto:liming.gao@intel.com>>; Liu, Zhiguang <zhiguang.liu@intel.com<mailto:zhiguang.liu@intel.com>>; Wang, Jian J <jian.j.wang@intel.com<mailto:jian.j.wang@intel.com>>; Gao, Zhichao <zhichao.gao@intel.com<mailto:zhichao.gao@intel.com>>; Chan, Amy <amy.chan@intel.com<mailto:amy.chan@intel.com>> 主题: Re: [edk2-devel] RFC: Add BaseLib/QuickSort in MdePkg On Sep 15, 2021, at 6:26 PM, gaoliming <gaoliming@byosoft.com.cn<mailto:gaoliming@byosoft.com.cn>> wrote: Ray: SortLib has been added since 2015. I would suggest to still keep this library class. To resolve the package dependency, my proposal is to move the library class header file SortLib.h from MdeModulePkg to MdePkg, and still keep the library instance in MdeModulePkg. This proposal has no impact on the existing platform. If we add QuickSort() API to the BaseLib can we not just port the existing MdeModulePkg/SortLib to use QuickSort() in the implementation? Or is there some other way to add the new thing in a backward compatible way. Thanks, Andrew Fish Thanks Liming 发件人: devel@edk2.groups.io<mailto:devel@edk2.groups.io> <devel@edk2.groups.io<mailto:devel@edk2.groups.io>> 代表 Ni, Ray 发送时间: 2021年9月14日 14:15 收件人: Kinney, Michael D <michael.d.kinney@intel.com<mailto:michael.d.kinney@intel.com>>; Gao, Liming <liming.gao@intel.com<mailto:liming.gao@intel.com>>; Liu, Zhiguang <zhiguang.liu@intel.com<mailto:zhiguang.liu@intel.com>>; Wang, Jian J <jian.j.wang@intel.com<mailto:jian.j.wang@intel.com>>; Gao, Zhichao <zhichao.gao@intel.com<mailto:zhichao.gao@intel.com>> 抄送: devel@edk2.groups.io<mailto:devel@edk2.groups.io>; Chan, Amy <amy.chan@intel.com<mailto:amy.chan@intel.com>> 主题: [edk2-devel] RFC: Add BaseLib/QuickSort in MdePkg Hi package maintainers of MdePkg, MdeModulePkg and ShellPkg, community, A commit (UefiCpuPkg/CpuCacheInfoLib: Sort CpuCacheInfo array<https://github.com/tianocore/edk2/commit/4de77ae9890d241271f543e9195ab3516f3abec6>) to UefiCpuPkg let UefiCpuPkg depend on MdeModulePkg because the SortLib class and instances are all in MdeModulePkg. UefiCpuPkg depending on MdeModulePkg breaks the rule that “UefiCpuPkg should ONLY depend on MdePkg”. To address this issue, there are two approaches: 1. Duplicate the sort logic in UefiCpuPkg to not depend on MdeModulePkg/SortLib 2. Add QuickSort() API to BaseLib in MdePkg. Approach #2 (MdePkg/BaseLib/QuickSort) makes more sense because quick sort is a standard algorithm. We encourage consumers to update their code to use the quick sort in MdePkg and gradually deprecate today’s MdeModulePkg/SortLib. If you don’t have concerns, I plan to: 1. “Add QuickSort() to BaseLib” and update all existing consumers to use this API instead. VOID EFIAPI QuickSort ( IN OUT VOID *BufferToSort, IN CONST UINTN Count, IN CONST UINTN ElementSize, IN SORT_COMPARE CompareFunction ); 1. “Add new ShellPkg/SortCompareLib” Background: ShellPkg requires to sort devicepath/string so 3 APIs in UefiSortLib (DevicePathCompare, StringNoCaseCompare, StringCompare) are provided for Shell usage. we can move the 3 APIs to the SortCompareLib and update Shell code to use BaseLib/QuickSort directly, with the sort compare function from SortCompareLib. Any concerns? Thanks, Ray [-- Attachment #2: Type: text/html, Size: 38291 bytes --] ^ permalink raw reply [flat|nested] 21+ messages in thread
* 回复: [edk2-devel] RFC: Add BaseLib/QuickSort in MdePkg 2021-09-24 3:53 ` Ni, Ray @ 2021-09-26 2:00 ` gaoliming 2021-09-26 2:24 ` Ni, Ray 0 siblings, 1 reply; 21+ messages in thread From: gaoliming @ 2021-09-26 2:00 UTC (permalink / raw) To: 'Ni, Ray', devel, 'Chan, Amy', 'Andrew Fish' Cc: 'Kinney, Michael D', 'Gao, Liming', 'Liu, Zhiguang', 'Wang, Jian J', 'Gao, Zhichao' [-- Attachment #1: Type: text/plain, Size: 9999 bytes --] Ray: I may suggest to always require BufferOneElement. The consumer code may not know ElementSize. To avoid the error, the consumer must allocate buffer for BufferOneElement. If so, BufferOneElement is the required parameter. Thanks Liming 发件人: Ni, Ray <ray.ni@intel.com> 发送时间: 2021年9月24日 11:53 收件人: devel@edk2.groups.io; Ni, Ray <ray.ni@intel.com>; Chan, Amy <amy.chan@intel.com>; gaoliming <gaoliming@byosoft.com.cn>; 'Andrew Fish' <afish@apple.com> 抄送: Kinney, Michael D <michael.d.kinney@intel.com>; 'Gao, Liming' <liming.gao@intel.com>; Liu, Zhiguang <zhiguang.liu@intel.com>; Wang, Jian J <jian.j.wang@intel.com>; Gao, Zhichao <zhichao.gao@intel.com> 主题: RE: [edk2-devel] RFC: Add BaseLib/QuickSort in MdePkg More details on new QuickSort() API: The new API needs to carry additional parameter “BufferOneElement”. This parameter gives QuickSort() the temporary buffer for swapping in sorting. It’s to avoid BaseLib depends on MemoryAllocationLib. … @param [in] BufferOneElement When ElementSize > 256, caller needs to provide a buffer whose size equals to ElementSize. It’s used by QuickSort() for swapping in sorting. When ElementSize <= 256, QuickSort() uses a local stack 256-byte buffer. @retval EFI_INVALID_PARAMETER When (ElementSize > 256) and (BufferOneElement == NULL). … VOID EFIAPI QuickSort ( IN OUT VOID *BufferToSort, IN CONST UINTN ElementCount, IN CONST UINTN ElementSize, IN SORT_COMPARE CompareFunction, IN VOID *BufferOneElement OPTIONAL ); Any comments? From: devel@edk2.groups.io <mailto:devel@edk2.groups.io> <devel@edk2.groups.io <mailto:devel@edk2.groups.io> > On Behalf Of Ni, Ray Sent: Wednesday, September 22, 2021 2:04 PM To: Chan, Amy <amy.chan@intel.com <mailto:amy.chan@intel.com> >; gaoliming <gaoliming@byosoft.com.cn <mailto:gaoliming@byosoft.com.cn> >; 'Andrew Fish' <afish@apple.com <mailto:afish@apple.com> >; 'edk2-devel-groups-io' <devel@edk2.groups.io <mailto:devel@edk2.groups.io> > Cc: Kinney, Michael D <michael.d.kinney@intel.com <mailto:michael.d.kinney@intel.com> >; 'Gao, Liming' <liming.gao@intel.com <mailto:liming.gao@intel.com> >; Liu, Zhiguang <zhiguang.liu@intel.com <mailto:zhiguang.liu@intel.com> >; Wang, Jian J <jian.j.wang@intel.com <mailto:jian.j.wang@intel.com> >; Gao, Zhichao <zhichao.gao@intel.com <mailto:zhichao.gao@intel.com> > Subject: Re: [edk2-devel] RFC: Add BaseLib/QuickSort in MdePkg I don’t see objection so far. So, the final solution is: 1. Add QuickSort() API to BaseLib in MdePkg. 2. Update existing MdeModulePkg/SortLib to use QuickSort() in the implementation (proposed by Andrew Fish and Liming Gao) 3. Update UefiCpuPkg to use QuickSortLib to remove improper dependency on MdeModulePkg Thanks, Ray From: Ni, Ray Sent: Thursday, September 16, 2021 10:48 AM To: Chan, Amy <amy.chan@intel.com <mailto:amy.chan@intel.com> >; gaoliming <gaoliming@byosoft.com.cn <mailto:gaoliming@byosoft.com.cn> >; 'Andrew Fish' <afish@apple.com <mailto:afish@apple.com> >; 'edk2-devel-groups-io' <devel@edk2.groups.io <mailto:devel@edk2.groups.io> > Cc: Kinney, Michael D <michael.d.kinney@intel.com <mailto:michael.d.kinney@intel.com> >; 'Gao, Liming' <liming.gao@intel.com <mailto:liming.gao@intel.com> >; Liu, Zhiguang <Zhiguang.Liu@intel.com <mailto:Zhiguang.Liu@intel.com> >; Wang, Jian J <jian.j.wang@intel.com <mailto:jian.j.wang@intel.com> >; Gao, Zhichao <zhichao.gao@intel.com <mailto:zhichao.gao@intel.com> > Subject: RE: [edk2-devel] RFC: Add BaseLib/QuickSort in MdePkg Amy, No. We only Add QuickSort() function API into BaseLib.h. From: Chan, Amy <amy.chan@intel.com <mailto:amy.chan@intel.com> > Sent: Thursday, September 16, 2021 10:46 AM To: gaoliming <gaoliming@byosoft.com.cn <mailto:gaoliming@byosoft.com.cn> >; 'Andrew Fish' <afish@apple.com <mailto:afish@apple.com> >; 'edk2-devel-groups-io' <devel@edk2.groups.io <mailto:devel@edk2.groups.io> > Cc: Ni, Ray <ray.ni@intel.com <mailto:ray.ni@intel.com> >; Kinney, Michael D <michael.d.kinney@intel.com <mailto:michael.d.kinney@intel.com> >; 'Gao, Liming' <liming.gao@intel.com <mailto:liming.gao@intel.com> >; Liu, Zhiguang <zhiguang.liu@intel.com <mailto:zhiguang.liu@intel.com> >; Wang, Jian J <jian.j.wang@intel.com <mailto:jian.j.wang@intel.com> >; Gao, Zhichao <zhichao.gao@intel.com <mailto:zhichao.gao@intel.com> > Subject: RE: [edk2-devel] RFC: Add BaseLib/QuickSort in MdePkg Just to double confirm, will we have the null instance of QuickSort in MdePkg? Regards, Amy From: gaoliming <gaoliming@byosoft.com.cn <mailto:gaoliming@byosoft.com.cn> > Sent: Thursday, September 16, 2021 10:23 AM To: 'Andrew Fish' <afish@apple.com <mailto:afish@apple.com> >; 'edk2-devel-groups-io' <devel@edk2.groups.io <mailto:devel@edk2.groups.io> > Cc: Ni, Ray <ray.ni@intel.com <mailto:ray.ni@intel.com> >; Kinney, Michael D <michael.d.kinney@intel.com <mailto:michael.d.kinney@intel.com> >; 'Gao, Liming' <liming.gao@intel.com <mailto:liming.gao@intel.com> >; Liu, Zhiguang <zhiguang.liu@intel.com <mailto:zhiguang.liu@intel.com> >; Wang, Jian J <jian.j.wang@intel.com <mailto:jian.j.wang@intel.com> >; Gao, Zhichao <zhichao.gao@intel.com <mailto:zhichao.gao@intel.com> >; Chan, Amy <amy.chan@intel.com <mailto:amy.chan@intel.com> > Subject: 回复: [edk2-devel] RFC: Add BaseLib/QuickSort in MdePkg Andrew: Thanks for your suggestion. I think your idea is better. We add new QuickSort() API to BaseLib, and update SortLib library instance to consume BaseLib QuickSort() API. This way has no change in current SortLib library class. It is the compatible solution. Thanks Liming 发件人: Andrew Fish <afish@apple.com <mailto:afish@apple.com> > 发送时间: 2021年9月16日 10:13 收件人: edk2-devel-groups-io <devel@edk2.groups.io <mailto:devel@edk2.groups.io> >; Liming Gao <gaoliming@byosoft.com.cn <mailto:gaoliming@byosoft.com.cn> > 抄送: Ni, Ray <ray.ni@intel.com <mailto:ray.ni@intel.com> >; Mike Kinney <michael.d.kinney@intel.com <mailto:michael.d.kinney@intel.com> >; Gao, Liming <liming.gao@intel.com <mailto:liming.gao@intel.com> >; Liu, Zhiguang <zhiguang.liu@intel.com <mailto:zhiguang.liu@intel.com> >; Wang, Jian J <jian.j.wang@intel.com <mailto:jian.j.wang@intel.com> >; Gao, Zhichao <zhichao.gao@intel.com <mailto:zhichao.gao@intel.com> >; Chan, Amy <amy.chan@intel.com <mailto:amy.chan@intel.com> > 主题: Re: [edk2-devel] RFC: Add BaseLib/QuickSort in MdePkg On Sep 15, 2021, at 6:26 PM, gaoliming <gaoliming@byosoft.com.cn <mailto:gaoliming@byosoft.com.cn> > wrote: Ray: SortLib has been added since 2015. I would suggest to still keep this library class. To resolve the package dependency, my proposal is to move the library class header file SortLib.h from MdeModulePkg to MdePkg, and still keep the library instance in MdeModulePkg. This proposal has no impact on the existing platform. If we add QuickSort() API to the BaseLib can we not just port the existing MdeModulePkg/SortLib to use QuickSort() in the implementation? Or is there some other way to add the new thing in a backward compatible way. Thanks, Andrew Fish Thanks Liming 发件人: <mailto:devel@edk2.groups.io> devel@edk2.groups.io < <mailto:devel@edk2.groups.io> devel@edk2.groups.io> 代表 Ni, Ray 发送时间: 2021年9月14日 14:15 收件人: Kinney, Michael D < <mailto:michael.d.kinney@intel.com> michael.d.kinney@intel.com>; Gao, Liming < <mailto:liming.gao@intel.com> liming.gao@intel.com>; Liu, Zhiguang < <mailto:zhiguang.liu@intel.com> zhiguang.liu@intel.com>; Wang, Jian J < <mailto:jian.j.wang@intel.com> jian.j.wang@intel.com>; Gao, Zhichao < <mailto:zhichao.gao@intel.com> zhichao.gao@intel.com> 抄送: <mailto:devel@edk2.groups.io> devel@edk2.groups.io; Chan, Amy < <mailto:amy.chan@intel.com> amy.chan@intel.com> 主题: [edk2-devel] RFC: Add BaseLib/QuickSort in MdePkg Hi package maintainers of MdePkg, MdeModulePkg and ShellPkg, community, A commit ( <https://github.com/tianocore/edk2/commit/4de77ae9890d241271f543e9195ab3516f3abec6> UefiCpuPkg/CpuCacheInfoLib: Sort CpuCacheInfo array) to UefiCpuPkg let UefiCpuPkg depend on MdeModulePkg because the SortLib class and instances are all in MdeModulePkg. UefiCpuPkg depending on MdeModulePkg breaks the rule that “UefiCpuPkg should ONLY depend on MdePkg”. To address this issue, there are two approaches: 1. Duplicate the sort logic in UefiCpuPkg to not depend on MdeModulePkg/SortLib 2. Add QuickSort() API to BaseLib in MdePkg. Approach #2 (MdePkg/BaseLib/QuickSort) makes more sense because quick sort is a standard algorithm. We encourage consumers to update their code to use the quick sort in MdePkg and gradually deprecate today’s MdeModulePkg/SortLib. If you don’t have concerns, I plan to: 1. “Add QuickSort() to BaseLib” and update all existing consumers to use this API instead. VOID EFIAPI QuickSort ( IN OUT VOID *BufferToSort, IN CONST UINTN Count, IN CONST UINTN ElementSize, IN SORT_COMPARE CompareFunction ); 2. “Add new ShellPkg/SortCompareLib” Background: ShellPkg requires to sort devicepath/string so 3 APIs in UefiSortLib (DevicePathCompare, StringNoCaseCompare, StringCompare) are provided for Shell usage. we can move the 3 APIs to the SortCompareLib and update Shell code to use BaseLib/QuickSort directly, with the sort compare function from SortCompareLib. Any concerns? Thanks, Ray [-- Attachment #2: Type: text/html, Size: 42038 bytes --] ^ permalink raw reply [flat|nested] 21+ messages in thread
* Re: [edk2-devel] RFC: Add BaseLib/QuickSort in MdePkg 2021-09-26 2:00 ` 回复: " gaoliming @ 2021-09-26 2:24 ` Ni, Ray 2021-09-26 11:20 ` Marvin Häuser 0 siblings, 1 reply; 21+ messages in thread From: Ni, Ray @ 2021-09-26 2:24 UTC (permalink / raw) To: gaoliming, devel@edk2.groups.io, Chan, Amy, 'Andrew Fish' Cc: Kinney, Michael D, 'Gao, Liming', Liu, Zhiguang, Wang, Jian J, Gao, Zhichao [-- Attachment #1: Type: text/plain, Size: 11567 bytes --] Liming, The purpose of the optional BufferOneElement is to ease consumer’s life assuming most of the time the element size should be smaller than 256. Are you saying that it’s a bit hard to calculate the actual value of sizeof (Element) when writing code? I recommend consumer always allocates memory if it’s hard to judge sizeof (Element) < 256. Searching edk2 code, I can find below code using PerformQuickSort(): 1. ShellPkg/UefiShellCommandLib: It’s sorting array of (EFI_DEVICE_PATH_PROTOCOL *). 2. UefiCpuPkg/CpuCacheInfoLib: It’s sorting array of CPU_CACHE_INFO. 3. MinPlatformPkg/AcpiTables: It’s sorting array of EFI_CPU_ID_ORDER_MAP. 4. MdeModulePkg/UefiBootManagerLib: It’s sorting array of EFI_BOOT_MANAGER_LOAD_OPTION. 5. MdeModulePkg/CapsuleApp: It’s sorting array of (EFI_FILE_INFO *) 6. CryptoPkg/CrtWrapper: It’s sorting array of (unknown type). 7. RedfishPkg/RedfishCrtLib: It’s sorting array of (unknown type). For 1~5, it’s easy to know that the size of the element is smaller than 256. The AllocatePool() can be skipped. Thanks, Ray From: gaoliming <gaoliming@byosoft.com.cn> Sent: Sunday, September 26, 2021 10:01 AM To: Ni, Ray <ray.ni@intel.com>; devel@edk2.groups.io; Chan, Amy <amy.chan@intel.com>; 'Andrew Fish' <afish@apple.com> Cc: Kinney, Michael D <michael.d.kinney@intel.com>; 'Gao, Liming' <liming.gao@intel.com>; Liu, Zhiguang <zhiguang.liu@intel.com>; Wang, Jian J <jian.j.wang@intel.com>; Gao, Zhichao <zhichao.gao@intel.com> Subject: 回复: [edk2-devel] RFC: Add BaseLib/QuickSort in MdePkg Ray: I may suggest to always require BufferOneElement. The consumer code may not know ElementSize. To avoid the error, the consumer must allocate buffer for BufferOneElement. If so, BufferOneElement is the required parameter. Thanks Liming 发件人: Ni, Ray <ray.ni@intel.com<mailto:ray.ni@intel.com>> 发送时间: 2021年9月24日 11:53 收件人: devel@edk2.groups.io<mailto:devel@edk2.groups.io>; Ni, Ray <ray.ni@intel.com<mailto:ray.ni@intel.com>>; Chan, Amy <amy.chan@intel.com<mailto:amy.chan@intel.com>>; gaoliming <gaoliming@byosoft.com.cn<mailto:gaoliming@byosoft.com.cn>>; 'Andrew Fish' <afish@apple.com<mailto:afish@apple.com>> 抄送: Kinney, Michael D <michael.d.kinney@intel.com<mailto:michael.d.kinney@intel.com>>; 'Gao, Liming' <liming.gao@intel.com<mailto:liming.gao@intel.com>>; Liu, Zhiguang <zhiguang.liu@intel.com<mailto:zhiguang.liu@intel.com>>; Wang, Jian J <jian.j.wang@intel.com<mailto:jian.j.wang@intel.com>>; Gao, Zhichao <zhichao.gao@intel.com<mailto:zhichao.gao@intel.com>> 主题: RE: [edk2-devel] RFC: Add BaseLib/QuickSort in MdePkg More details on new QuickSort() API: The new API needs to carry additional parameter “BufferOneElement”. This parameter gives QuickSort() the temporary buffer for swapping in sorting. It’s to avoid BaseLib depends on MemoryAllocationLib. … @param [in] BufferOneElement When ElementSize > 256, caller needs to provide a buffer whose size equals to ElementSize. It’s used by QuickSort() for swapping in sorting. When ElementSize <= 256, QuickSort() uses a local stack 256-byte buffer. @retval EFI_INVALID_PARAMETER When (ElementSize > 256) and (BufferOneElement == NULL). … VOID EFIAPI QuickSort ( IN OUT VOID *BufferToSort, IN CONST UINTN ElementCount, IN CONST UINTN ElementSize, IN SORT_COMPARE CompareFunction, IN VOID *BufferOneElement OPTIONAL ); Any comments? From: devel@edk2.groups.io<mailto:devel@edk2.groups.io> <devel@edk2.groups.io<mailto:devel@edk2.groups.io>> On Behalf Of Ni, Ray Sent: Wednesday, September 22, 2021 2:04 PM To: Chan, Amy <amy.chan@intel.com<mailto:amy.chan@intel.com>>; gaoliming <gaoliming@byosoft.com.cn<mailto:gaoliming@byosoft.com.cn>>; 'Andrew Fish' <afish@apple.com<mailto:afish@apple.com>>; 'edk2-devel-groups-io' <devel@edk2.groups.io<mailto:devel@edk2.groups.io>> Cc: Kinney, Michael D <michael.d.kinney@intel.com<mailto:michael.d.kinney@intel.com>>; 'Gao, Liming' <liming.gao@intel.com<mailto:liming.gao@intel.com>>; Liu, Zhiguang <zhiguang.liu@intel.com<mailto:zhiguang.liu@intel.com>>; Wang, Jian J <jian.j.wang@intel.com<mailto:jian.j.wang@intel.com>>; Gao, Zhichao <zhichao.gao@intel.com<mailto:zhichao.gao@intel.com>> Subject: Re: [edk2-devel] RFC: Add BaseLib/QuickSort in MdePkg I don’t see objection so far. So, the final solution is: 1. Add QuickSort() API to BaseLib in MdePkg. 2. Update existing MdeModulePkg/SortLib to use QuickSort() in the implementation (proposed by Andrew Fish and Liming Gao) 3. Update UefiCpuPkg to use QuickSortLib to remove improper dependency on MdeModulePkg Thanks, Ray From: Ni, Ray Sent: Thursday, September 16, 2021 10:48 AM To: Chan, Amy <amy.chan@intel.com<mailto:amy.chan@intel.com>>; gaoliming <gaoliming@byosoft.com.cn<mailto:gaoliming@byosoft.com.cn>>; 'Andrew Fish' <afish@apple.com<mailto:afish@apple.com>>; 'edk2-devel-groups-io' <devel@edk2.groups.io<mailto:devel@edk2.groups.io>> Cc: Kinney, Michael D <michael.d.kinney@intel.com<mailto:michael.d.kinney@intel.com>>; 'Gao, Liming' <liming.gao@intel.com<mailto:liming.gao@intel.com>>; Liu, Zhiguang <Zhiguang.Liu@intel.com<mailto:Zhiguang.Liu@intel.com>>; Wang, Jian J <jian.j.wang@intel.com<mailto:jian.j.wang@intel.com>>; Gao, Zhichao <zhichao.gao@intel.com<mailto:zhichao.gao@intel.com>> Subject: RE: [edk2-devel] RFC: Add BaseLib/QuickSort in MdePkg Amy, No. We only Add QuickSort() function API into BaseLib.h. From: Chan, Amy <amy.chan@intel.com<mailto:amy.chan@intel.com>> Sent: Thursday, September 16, 2021 10:46 AM To: gaoliming <gaoliming@byosoft.com.cn<mailto:gaoliming@byosoft.com.cn>>; 'Andrew Fish' <afish@apple.com<mailto:afish@apple.com>>; 'edk2-devel-groups-io' <devel@edk2.groups.io<mailto:devel@edk2.groups.io>> Cc: Ni, Ray <ray.ni@intel.com<mailto:ray.ni@intel.com>>; Kinney, Michael D <michael.d.kinney@intel.com<mailto:michael.d.kinney@intel.com>>; 'Gao, Liming' <liming.gao@intel.com<mailto:liming.gao@intel.com>>; Liu, Zhiguang <zhiguang.liu@intel.com<mailto:zhiguang.liu@intel.com>>; Wang, Jian J <jian.j.wang@intel.com<mailto:jian.j.wang@intel.com>>; Gao, Zhichao <zhichao.gao@intel.com<mailto:zhichao.gao@intel.com>> Subject: RE: [edk2-devel] RFC: Add BaseLib/QuickSort in MdePkg Just to double confirm, will we have the null instance of QuickSort in MdePkg? Regards, Amy From: gaoliming <gaoliming@byosoft.com.cn<mailto:gaoliming@byosoft.com.cn>> Sent: Thursday, September 16, 2021 10:23 AM To: 'Andrew Fish' <afish@apple.com<mailto:afish@apple.com>>; 'edk2-devel-groups-io' <devel@edk2.groups.io<mailto:devel@edk2.groups.io>> Cc: Ni, Ray <ray.ni@intel.com<mailto:ray.ni@intel.com>>; Kinney, Michael D <michael.d.kinney@intel.com<mailto:michael.d.kinney@intel.com>>; 'Gao, Liming' <liming.gao@intel.com<mailto:liming.gao@intel.com>>; Liu, Zhiguang <zhiguang.liu@intel.com<mailto:zhiguang.liu@intel.com>>; Wang, Jian J <jian.j.wang@intel.com<mailto:jian.j.wang@intel.com>>; Gao, Zhichao <zhichao.gao@intel.com<mailto:zhichao.gao@intel.com>>; Chan, Amy <amy.chan@intel.com<mailto:amy.chan@intel.com>> Subject: 回复: [edk2-devel] RFC: Add BaseLib/QuickSort in MdePkg Andrew: Thanks for your suggestion. I think your idea is better. We add new QuickSort() API to BaseLib, and update SortLib library instance to consume BaseLib QuickSort() API. This way has no change in current SortLib library class. It is the compatible solution. Thanks Liming 发件人: Andrew Fish <afish@apple.com<mailto:afish@apple.com>> 发送时间: 2021年9月16日 10:13 收件人: edk2-devel-groups-io <devel@edk2.groups.io<mailto:devel@edk2.groups.io>>; Liming Gao <gaoliming@byosoft.com.cn<mailto:gaoliming@byosoft.com.cn>> 抄送: Ni, Ray <ray.ni@intel.com<mailto:ray.ni@intel.com>>; Mike Kinney <michael.d.kinney@intel.com<mailto:michael.d.kinney@intel.com>>; Gao, Liming <liming.gao@intel.com<mailto:liming.gao@intel.com>>; Liu, Zhiguang <zhiguang.liu@intel.com<mailto:zhiguang.liu@intel.com>>; Wang, Jian J <jian.j.wang@intel.com<mailto:jian.j.wang@intel.com>>; Gao, Zhichao <zhichao.gao@intel.com<mailto:zhichao.gao@intel.com>>; Chan, Amy <amy.chan@intel.com<mailto:amy.chan@intel.com>> 主题: Re: [edk2-devel] RFC: Add BaseLib/QuickSort in MdePkg On Sep 15, 2021, at 6:26 PM, gaoliming <gaoliming@byosoft.com.cn<mailto:gaoliming@byosoft.com.cn>> wrote: Ray: SortLib has been added since 2015. I would suggest to still keep this library class. To resolve the package dependency, my proposal is to move the library class header file SortLib.h from MdeModulePkg to MdePkg, and still keep the library instance in MdeModulePkg. This proposal has no impact on the existing platform. If we add QuickSort() API to the BaseLib can we not just port the existing MdeModulePkg/SortLib to use QuickSort() in the implementation? Or is there some other way to add the new thing in a backward compatible way. Thanks, Andrew Fish Thanks Liming 发件人: devel@edk2.groups.io<mailto:devel@edk2.groups.io> <devel@edk2.groups.io<mailto:devel@edk2.groups.io>> 代表 Ni, Ray 发送时间: 2021年9月14日 14:15 收件人: Kinney, Michael D <michael.d.kinney@intel.com<mailto:michael.d.kinney@intel.com>>; Gao, Liming <liming.gao@intel.com<mailto:liming.gao@intel.com>>; Liu, Zhiguang <zhiguang.liu@intel.com<mailto:zhiguang.liu@intel.com>>; Wang, Jian J <jian.j.wang@intel.com<mailto:jian.j.wang@intel.com>>; Gao, Zhichao <zhichao.gao@intel.com<mailto:zhichao.gao@intel.com>> 抄送: devel@edk2.groups.io<mailto:devel@edk2.groups.io>; Chan, Amy <amy.chan@intel.com<mailto:amy.chan@intel.com>> 主题: [edk2-devel] RFC: Add BaseLib/QuickSort in MdePkg Hi package maintainers of MdePkg, MdeModulePkg and ShellPkg, community, A commit (UefiCpuPkg/CpuCacheInfoLib: Sort CpuCacheInfo array<https://github.com/tianocore/edk2/commit/4de77ae9890d241271f543e9195ab3516f3abec6>) to UefiCpuPkg let UefiCpuPkg depend on MdeModulePkg because the SortLib class and instances are all in MdeModulePkg. UefiCpuPkg depending on MdeModulePkg breaks the rule that “UefiCpuPkg should ONLY depend on MdePkg”. To address this issue, there are two approaches: 1. Duplicate the sort logic in UefiCpuPkg to not depend on MdeModulePkg/SortLib 2. Add QuickSort() API to BaseLib in MdePkg. Approach #2 (MdePkg/BaseLib/QuickSort) makes more sense because quick sort is a standard algorithm. We encourage consumers to update their code to use the quick sort in MdePkg and gradually deprecate today’s MdeModulePkg/SortLib. If you don’t have concerns, I plan to: 1. “Add QuickSort() to BaseLib” and update all existing consumers to use this API instead. VOID EFIAPI QuickSort ( IN OUT VOID *BufferToSort, IN CONST UINTN Count, IN CONST UINTN ElementSize, IN SORT_COMPARE CompareFunction ); 1. “Add new ShellPkg/SortCompareLib” Background: ShellPkg requires to sort devicepath/string so 3 APIs in UefiSortLib (DevicePathCompare, StringNoCaseCompare, StringCompare) are provided for Shell usage. we can move the 3 APIs to the SortCompareLib and update Shell code to use BaseLib/QuickSort directly, with the sort compare function from SortCompareLib. Any concerns? Thanks, Ray [-- Attachment #2: Type: text/html, Size: 47270 bytes --] ^ permalink raw reply [flat|nested] 21+ messages in thread
* Re: [edk2-devel] RFC: Add BaseLib/QuickSort in MdePkg 2021-09-26 2:24 ` Ni, Ray @ 2021-09-26 11:20 ` Marvin Häuser 2021-09-27 0:45 ` Jeff Fan 0 siblings, 1 reply; 21+ messages in thread From: Marvin Häuser @ 2021-09-26 11:20 UTC (permalink / raw) To: devel, ray.ni, gaoliming, Chan, Amy, 'Andrew Fish' Cc: Kinney, Michael D, 'Gao, Liming', Liu, Zhiguang, Wang, Jian J, Gao, Zhichao Hey Ray, In my opinion that spec is too complicated. For some cases it is obvious, but I think the last anyone wants to see is a (STATIC_)ASSERT before most QuickSort calls to ensure the element size *really* is <= 256 Bytes. In my opinion, there are two roads: 1) Make the parameter required (I think this is what Liming suggested). The caller would always need to provide said buffer, and it can do as it sees fit - on the stack, in a pool, in a page, who knows. 2) Remove the parameter entirely. The library would depend on MemoryAllocationLib again, but also would have an optimisation by choosing stack vs pool based on ElementSize. Usually I would prefer 2), as it is less prone to caller errors, but considering the low-level nature of edk2, I can totally see the point to allow the caller to control whether there are dynamic memory allocations made or not as possible with 1). 2) could technically also be a wrapper for 1) if you want granular control and convenience/safety (why not actually?). Both approaches have the advantage that it is crystal-clear what the caller's job is - to always or to never allocate the buffer. Best regards, Marvin On 26/09/2021 04:24, Ni, Ray wrote: > > Liming, > > The purpose of the optional BufferOneElement is to ease consumer’s > life assuming most of the time the element size should be smaller than > 256. > > Are you saying that it’s a bit hard to calculate the actual value of > sizeof (Element) when writing code? > > I recommend consumer always allocates memory if it’s hard to judge > sizeof (Element) < 256. > > Searching edk2 code, I can find below code using PerformQuickSort(): > > 1. ShellPkg/UefiShellCommandLib: It’s sorting array of > (EFI_DEVICE_PATH_PROTOCOL *). > 2. UefiCpuPkg/CpuCacheInfoLib: It’s sorting array of CPU_CACHE_INFO. > 3. MinPlatformPkg/AcpiTables: It’s sorting array of EFI_CPU_ID_ORDER_MAP. > 4. MdeModulePkg/UefiBootManagerLib: It’s sorting array of > EFI_BOOT_MANAGER_LOAD_OPTION. > 5. MdeModulePkg/CapsuleApp: It’s sorting array of (EFI_FILE_INFO *) > 6. CryptoPkg/CrtWrapper: It’s sorting array of (unknown type). > 7. RedfishPkg/RedfishCrtLib: It’s sorting array of (unknown type). > > For 1~5, it’s easy to know that the size of the element is smaller > than 256. The AllocatePool() can be skipped. > > Thanks, > > Ray > > *From:*gaoliming <gaoliming@byosoft.com.cn> > *Sent:* Sunday, September 26, 2021 10:01 AM > *To:* Ni, Ray <ray.ni@intel.com>; devel@edk2.groups.io; Chan, Amy > <amy.chan@intel.com>; 'Andrew Fish' <afish@apple.com> > *Cc:* Kinney, Michael D <michael.d.kinney@intel.com>; 'Gao, Liming' > <liming.gao@intel.com>; Liu, Zhiguang <zhiguang.liu@intel.com>; Wang, > Jian J <jian.j.wang@intel.com>; Gao, Zhichao <zhichao.gao@intel.com> > *Subject:* 回复: [edk2-devel] RFC: Add BaseLib/QuickSort in MdePkg > > Ray: > > I may suggest to always require BufferOneElement. The consumer code > may not know ElementSize. To avoid the error, the consumer must > allocate buffer for BufferOneElement. If so, BufferOneElement is the > required parameter. > > Thanks > > Liming > > *发件人**:*Ni, Ray <ray.ni@intel.com <mailto:ray.ni@intel.com>> > *发送时间:* 2021年9月24日 11:53 > *收件人:* devel@edk2.groups.io <mailto:devel@edk2.groups.io>; Ni, Ray > <ray.ni@intel.com <mailto:ray.ni@intel.com>>; Chan, Amy > <amy.chan@intel.com <mailto:amy.chan@intel.com>>; gaoliming > <gaoliming@byosoft.com.cn <mailto:gaoliming@byosoft.com.cn>>; 'Andrew > Fish' <afish@apple.com <mailto:afish@apple.com>> > *抄送:* Kinney, Michael D <michael.d.kinney@intel.com > <mailto:michael.d.kinney@intel.com>>; 'Gao, Liming' > <liming.gao@intel.com <mailto:liming.gao@intel.com>>; Liu, Zhiguang > <zhiguang.liu@intel.com <mailto:zhiguang.liu@intel.com>>; Wang, Jian J > <jian.j.wang@intel.com <mailto:jian.j.wang@intel.com>>; Gao, Zhichao > <zhichao.gao@intel.com <mailto:zhichao.gao@intel.com>> > *主题:* RE: [edk2-devel] RFC: Add BaseLib/QuickSort in MdePkg > > More details on new QuickSort() API: > > The new API needs to carry additional parameter “BufferOneElement”. > > This parameter gives QuickSort() the temporary buffer for swapping in > sorting. > > It’s to avoid BaseLib depends on MemoryAllocationLib. > > … > > @param [in] BufferOneElement When ElementSize > 256, caller needs to > provide a buffer whose size > equals to ElementSize. It’s used by > QuickSort() for swapping in sorting. > > When ElementSize <= 256, QuickSort() uses a local stack 256-byte buffer. > > @retval EFI_INVALID_PARAMETER When (ElementSize > 256) and > (BufferOneElement == NULL). > > … > > VOID > > EFIAPI > > QuickSort ( > > IN OUT VOID *BufferToSort, > > IN CONST UINTN ElementCount, > > IN CONST UINTN ElementSize, > > IN SORT_COMPARE CompareFunction, > > IN VOID *BufferOneElement OPTIONAL > > ); > > Any comments? > > *From:*devel@edk2.groups.io <mailto:devel@edk2.groups.io> > <devel@edk2.groups.io <mailto:devel@edk2.groups.io>> *On Behalf Of > *Ni, Ray > *Sent:* Wednesday, September 22, 2021 2:04 PM > *To:* Chan, Amy <amy.chan@intel.com <mailto:amy.chan@intel.com>>; > gaoliming <gaoliming@byosoft.com.cn > <mailto:gaoliming@byosoft.com.cn>>; 'Andrew Fish' <afish@apple.com > <mailto:afish@apple.com>>; 'edk2-devel-groups-io' > <devel@edk2.groups.io <mailto:devel@edk2.groups.io>> > *Cc:* Kinney, Michael D <michael.d.kinney@intel.com > <mailto:michael.d.kinney@intel.com>>; 'Gao, Liming' > <liming.gao@intel.com <mailto:liming.gao@intel.com>>; Liu, Zhiguang > <zhiguang.liu@intel.com <mailto:zhiguang.liu@intel.com>>; Wang, Jian J > <jian.j.wang@intel.com <mailto:jian.j.wang@intel.com>>; Gao, Zhichao > <zhichao.gao@intel.com <mailto:zhichao.gao@intel.com>> > *Subject:* Re: [edk2-devel] RFC: Add BaseLib/QuickSort in MdePkg > > I don’t see objection so far. > > So, the final solution is: > > 1. Add QuickSort() API to BaseLib in MdePkg. > 2. Update existing MdeModulePkg/SortLib to use QuickSort() in the > implementation (proposed by Andrew Fish and Liming Gao) > 3. Update UefiCpuPkg to use QuickSortLib to remove improper > dependency on MdeModulePkg > > Thanks, > > Ray > > *From:*Ni, Ray > *Sent:* Thursday, September 16, 2021 10:48 AM > *To:* Chan, Amy <amy.chan@intel.com <mailto:amy.chan@intel.com>>; > gaoliming <gaoliming@byosoft.com.cn > <mailto:gaoliming@byosoft.com.cn>>; 'Andrew Fish' <afish@apple.com > <mailto:afish@apple.com>>; 'edk2-devel-groups-io' > <devel@edk2.groups.io <mailto:devel@edk2.groups.io>> > *Cc:* Kinney, Michael D <michael.d.kinney@intel.com > <mailto:michael.d.kinney@intel.com>>; 'Gao, Liming' > <liming.gao@intel.com <mailto:liming.gao@intel.com>>; Liu, Zhiguang > <Zhiguang.Liu@intel.com <mailto:Zhiguang.Liu@intel.com>>; Wang, Jian J > <jian.j.wang@intel.com <mailto:jian.j.wang@intel.com>>; Gao, Zhichao > <zhichao.gao@intel.com <mailto:zhichao.gao@intel.com>> > *Subject:* RE: [edk2-devel] RFC: Add BaseLib/QuickSort in MdePkg > > Amy, > > No. We only Add QuickSort() function API into BaseLib.h. > > *From:*Chan, Amy <amy.chan@intel.com <mailto:amy.chan@intel.com>> > *Sent:* Thursday, September 16, 2021 10:46 AM > *To:* gaoliming <gaoliming@byosoft.com.cn > <mailto:gaoliming@byosoft.com.cn>>; 'Andrew Fish' <afish@apple.com > <mailto:afish@apple.com>>; 'edk2-devel-groups-io' > <devel@edk2.groups.io <mailto:devel@edk2.groups.io>> > *Cc:* Ni, Ray <ray.ni@intel.com <mailto:ray.ni@intel.com>>; Kinney, > Michael D <michael.d.kinney@intel.com > <mailto:michael.d.kinney@intel.com>>; 'Gao, Liming' > <liming.gao@intel.com <mailto:liming.gao@intel.com>>; Liu, Zhiguang > <zhiguang.liu@intel.com <mailto:zhiguang.liu@intel.com>>; Wang, Jian J > <jian.j.wang@intel.com <mailto:jian.j.wang@intel.com>>; Gao, Zhichao > <zhichao.gao@intel.com <mailto:zhichao.gao@intel.com>> > *Subject:* RE: [edk2-devel] RFC: Add BaseLib/QuickSort in MdePkg > > Just to double confirm, will we have the null instance of QuickSort in > MdePkg? > > Regards, > > Amy > > *From:*gaoliming <gaoliming@byosoft.com.cn > <mailto:gaoliming@byosoft.com.cn>> > *Sent:* Thursday, September 16, 2021 10:23 AM > *To:* 'Andrew Fish' <afish@apple.com <mailto:afish@apple.com>>; > 'edk2-devel-groups-io' <devel@edk2.groups.io > <mailto:devel@edk2.groups.io>> > *Cc:* Ni, Ray <ray.ni@intel.com <mailto:ray.ni@intel.com>>; Kinney, > Michael D <michael.d.kinney@intel.com > <mailto:michael.d.kinney@intel.com>>; 'Gao, Liming' > <liming.gao@intel.com <mailto:liming.gao@intel.com>>; Liu, Zhiguang > <zhiguang.liu@intel.com <mailto:zhiguang.liu@intel.com>>; Wang, Jian J > <jian.j.wang@intel.com <mailto:jian.j.wang@intel.com>>; Gao, Zhichao > <zhichao.gao@intel.com <mailto:zhichao.gao@intel.com>>; Chan, Amy > <amy.chan@intel.com <mailto:amy.chan@intel.com>> > *Subject:* 回复: [edk2-devel] RFC: Add BaseLib/QuickSort in MdePkg > > Andrew: > > Thanks for your suggestion. I think your idea is better. We add new > QuickSort() API to BaseLib, and update SortLib library instance to > consume BaseLib QuickSort() API. This way has no change in current > SortLib library class. It is the compatible solution. > > Thanks > > Liming > > *发件人**:*Andrew Fish <afish@apple.com <mailto:afish@apple.com>> > *发送时间:* 2021年9月16日 10:13 > *收件人:* edk2-devel-groups-io <devel@edk2.groups.io > <mailto:devel@edk2.groups.io>>; Liming Gao <gaoliming@byosoft.com.cn > <mailto:gaoliming@byosoft.com.cn>> > *抄送:* Ni, Ray <ray.ni@intel.com <mailto:ray.ni@intel.com>>; Mike > Kinney <michael.d.kinney@intel.com > <mailto:michael.d.kinney@intel.com>>; Gao, Liming > <liming.gao@intel.com <mailto:liming.gao@intel.com>>; Liu, Zhiguang > <zhiguang.liu@intel.com <mailto:zhiguang.liu@intel.com>>; Wang, Jian J > <jian.j.wang@intel.com <mailto:jian.j.wang@intel.com>>; Gao, Zhichao > <zhichao.gao@intel.com <mailto:zhichao.gao@intel.com>>; Chan, Amy > <amy.chan@intel.com <mailto:amy.chan@intel.com>> > *主题:* Re: [edk2-devel] RFC: Add BaseLib/QuickSort in MdePkg > > On Sep 15, 2021, at 6:26 PM, gaoliming <gaoliming@byosoft.com.cn > <mailto:gaoliming@byosoft.com.cn>> wrote: > > Ray: > > SortLib has been added since 2015. I would suggest to still keep > this library class. To resolve the package dependency, my proposal > is to move the library class header file SortLib.h from > MdeModulePkg to MdePkg, and still keep the library instance in > MdeModulePkg. This proposal has no impact on the existing platform. > > If we add QuickSort() API to the BaseLib can we not just port the > existing MdeModulePkg/SortLib to use QuickSort() in the > implementation? Or is there some other way to add the new thing in a > backward compatible way. > > Thanks, > > Andrew Fish > > Thanks > > Liming > > *发件人**:*devel@edk2.groups.io > <mailto:devel@edk2.groups.io><devel@edk2.groups.io > <mailto:devel@edk2.groups.io>>*代表***Ni, Ray > *发送时间:*2021年9月14日14:15 > *收件人:*Kinney, Michael D <michael.d.kinney@intel.com > <mailto:michael.d.kinney@intel.com>>; Gao, Liming > <liming.gao@intel.com <mailto:liming.gao@intel.com>>; Liu, > Zhiguang <zhiguang.liu@intel.com <mailto:zhiguang.liu@intel.com>>; > Wang, Jian J <jian.j.wang@intel.com > <mailto:jian.j.wang@intel.com>>; Gao, Zhichao > <zhichao.gao@intel.com <mailto:zhichao.gao@intel.com>> > *抄送:*devel@edk2.groups.io <mailto:devel@edk2.groups.io>; Chan, Amy > <amy.chan@intel.com <mailto:amy.chan@intel.com>> > *主题:*[edk2-devel] RFC: Add BaseLib/QuickSort in MdePkg > > Hi package maintainers of MdePkg, MdeModulePkg and ShellPkg, > community, > > A commit (UefiCpuPkg/CpuCacheInfoLib: Sort CpuCacheInfo array > <https://github.com/tianocore/edk2/commit/4de77ae9890d241271f543e9195ab3516f3abec6>) > to UefiCpuPkg let > UefiCpuPkg depend on MdeModulePkg because the SortLib class and > instances are all in MdeModulePkg. > > UefiCpuPkg depending on MdeModulePkg breaks the rule that > “UefiCpuPkg should ONLY depend on MdePkg”. > > To address this issue, there are two approaches: > > 1. Duplicate the sort logic in UefiCpuPkg to not depend on > MdeModulePkg/SortLib > 2. Add QuickSort() API to BaseLib in MdePkg. > > Approach #2 (MdePkg/BaseLib/QuickSort) makes more sense because > quick sort is a standard algorithm. > > We encourage consumers to update their code to use the quick sort > in MdePkg and gradually deprecate today’s MdeModulePkg/SortLib. > > If you don’t have concerns, I plan to: > > 1. “Add QuickSort() to BaseLib” and update all existing consumers > to use this API instead. > > VOID > > EFIAPI > > QuickSort ( > > IN OUT VOID *BufferToSort, > > IN CONST UINTN Count, > > IN CONST UINTN ElementSize, > > IN SORT_COMPARE CompareFunction > > ); > > 2. “Add new ShellPkg/SortCompareLib” > > Background: ShellPkg requires to sort devicepath/string so 3 APIs > in UefiSortLib (DevicePathCompare, StringNoCaseCompare, > StringCompare) are provided for Shell usage. we can move the 3 > APIs to the SortCompareLib and update Shell code to use > BaseLib/QuickSort directly, with the sort compare function from > SortCompareLib. > > Any concerns? > > Thanks, > > Ray > > ^ permalink raw reply [flat|nested] 21+ messages in thread
* Re: [edk2-devel] RFC: Add BaseLib/QuickSort in MdePkg 2021-09-26 11:20 ` Marvin Häuser @ 2021-09-27 0:45 ` Jeff Fan 2021-09-27 8:14 ` Marvin Häuser 0 siblings, 1 reply; 21+ messages in thread From: Jeff Fan @ 2021-09-27 0:45 UTC (permalink / raw) To: devel@edk2.groups.io, mhaeuser, Ni, Ray, 'gaoliming', Chan, Amy, 'Andrew Fish' Cc: Kinney, Michael D, 'Gao, Liming', Liu, Zhiguang, Wang, Jian J, Gao, Zhichao [-- Attachment #1: Type: text/plain, Size: 14700 bytes --] Making baselib implementation depend on MemoryAllocationLib (indirectly on Pei Service and gBS), it may prevent this base API using at some seneraio. i don't think it's better. Add this parameter and make this parameter is optional, 1, when NULL, use the local 256 bytes stack 2, if 256 bytes stack is not enough, return RETURE_BUFFER_TOO_SAMLL, 3, caller check the return status, to do nothing or to allocate enough buffer for retry This is just like SetVariable()'s implementation. Jeff fanjianfeng@byosoft.com.cn From: Marvin Häuser Date: 2021-09-26 19:20 To: devel; ray.ni; gaoliming; Chan, Amy; 'Andrew Fish' CC: Kinney, Michael D; 'Gao, Liming'; Liu, Zhiguang; Wang, Jian J; Gao, Zhichao Subject: Re: [edk2-devel] RFC: Add BaseLib/QuickSort in MdePkg Hey Ray, In my opinion that spec is too complicated. For some cases it is obvious, but I think the last anyone wants to see is a (STATIC_)ASSERT before most QuickSort calls to ensure the element size *really* is <= 256 Bytes. In my opinion, there are two roads: 1) Make the parameter required (I think this is what Liming suggested). The caller would always need to provide said buffer, and it can do as it sees fit - on the stack, in a pool, in a page, who knows. 2) Remove the parameter entirely. The library would depend on MemoryAllocationLib again, but also would have an optimisation by choosing stack vs pool based on ElementSize. Usually I would prefer 2), as it is less prone to caller errors, but considering the low-level nature of edk2, I can totally see the point to allow the caller to control whether there are dynamic memory allocations made or not as possible with 1). 2) could technically also be a wrapper for 1) if you want granular control and convenience/safety (why not actually?). Both approaches have the advantage that it is crystal-clear what the caller's job is - to always or to never allocate the buffer. Best regards, Marvin On 26/09/2021 04:24, Ni, Ray wrote: > > Liming, > > The purpose of the optional BufferOneElement is to ease consumer’s > life assuming most of the time the element size should be smaller than > 256. > > Are you saying that it’s a bit hard to calculate the actual value of > sizeof (Element) when writing code? > > I recommend consumer always allocates memory if it’s hard to judge > sizeof (Element) < 256. > > Searching edk2 code, I can find below code using PerformQuickSort(): > > 1. ShellPkg/UefiShellCommandLib: It’s sorting array of > (EFI_DEVICE_PATH_PROTOCOL *). > 2. UefiCpuPkg/CpuCacheInfoLib: It’s sorting array of CPU_CACHE_INFO. > 3. MinPlatformPkg/AcpiTables: It’s sorting array of EFI_CPU_ID_ORDER_MAP. > 4. MdeModulePkg/UefiBootManagerLib: It’s sorting array of > EFI_BOOT_MANAGER_LOAD_OPTION. > 5. MdeModulePkg/CapsuleApp: It’s sorting array of (EFI_FILE_INFO *) > 6. CryptoPkg/CrtWrapper: It’s sorting array of (unknown type). > 7. RedfishPkg/RedfishCrtLib: It’s sorting array of (unknown type). > > For 1~5, it’s easy to know that the size of the element is smaller > than 256. The AllocatePool() can be skipped. > > Thanks, > > Ray > > *From:*gaoliming <gaoliming@byosoft.com.cn> > *Sent:* Sunday, September 26, 2021 10:01 AM > *To:* Ni, Ray <ray.ni@intel.com>; devel@edk2.groups.io; Chan, Amy > <amy.chan@intel.com>; 'Andrew Fish' <afish@apple.com> > *Cc:* Kinney, Michael D <michael.d.kinney@intel.com>; 'Gao, Liming' > <liming.gao@intel.com>; Liu, Zhiguang <zhiguang.liu@intel.com>; Wang, > Jian J <jian.j.wang@intel.com>; Gao, Zhichao <zhichao.gao@intel.com> > *Subject:* 回复: [edk2-devel] RFC: Add BaseLib/QuickSort in MdePkg > > Ray: > > I may suggest to always require BufferOneElement. The consumer code > may not know ElementSize. To avoid the error, the consumer must > allocate buffer for BufferOneElement. If so, BufferOneElement is the > required parameter. > > Thanks > > Liming > > *发件人**:*Ni, Ray <ray.ni@intel.com <mailto:ray.ni@intel.com>> > *发送时间:* 2021年9月24日 11:53 > *收件人:* devel@edk2.groups.io <mailto:devel@edk2.groups.io>; Ni, Ray > <ray.ni@intel.com <mailto:ray.ni@intel.com>>; Chan, Amy > <amy.chan@intel.com <mailto:amy.chan@intel.com>>; gaoliming > <gaoliming@byosoft.com.cn <mailto:gaoliming@byosoft.com.cn>>; 'Andrew > Fish' <afish@apple.com <mailto:afish@apple.com>> > *抄送:* Kinney, Michael D <michael.d.kinney@intel.com > <mailto:michael.d.kinney@intel.com>>; 'Gao, Liming' > <liming.gao@intel.com <mailto:liming.gao@intel.com>>; Liu, Zhiguang > <zhiguang.liu@intel.com <mailto:zhiguang.liu@intel.com>>; Wang, Jian J > <jian.j.wang@intel.com <mailto:jian.j.wang@intel.com>>; Gao, Zhichao > <zhichao.gao@intel.com <mailto:zhichao.gao@intel.com>> > *主题:* RE: [edk2-devel] RFC: Add BaseLib/QuickSort in MdePkg > > More details on new QuickSort() API: > > The new API needs to carry additional parameter “BufferOneElement”. > > This parameter gives QuickSort() the temporary buffer for swapping in > sorting. > > It’s to avoid BaseLib depends on MemoryAllocationLib. > > … > > @param [in] BufferOneElement When ElementSize > 256, caller needs to > provide a buffer whose size > equals to ElementSize. It’s used by > QuickSort() for swapping in sorting. > > When ElementSize <= 256, QuickSort() uses a local stack 256-byte buffer. > > @retval EFI_INVALID_PARAMETER When (ElementSize > 256) and > (BufferOneElement == NULL). > > … > > VOID > > EFIAPI > > QuickSort ( > > IN OUT VOID *BufferToSort, > > IN CONST UINTN ElementCount, > > IN CONST UINTN ElementSize, > > IN SORT_COMPARE CompareFunction, > > IN VOID *BufferOneElement OPTIONAL > > ); > > Any comments? > > *From:*devel@edk2.groups.io <mailto:devel@edk2.groups.io> > <devel@edk2.groups.io <mailto:devel@edk2.groups.io>> *On Behalf Of > *Ni, Ray > *Sent:* Wednesday, September 22, 2021 2:04 PM > *To:* Chan, Amy <amy.chan@intel.com <mailto:amy.chan@intel.com>>; > gaoliming <gaoliming@byosoft.com.cn > <mailto:gaoliming@byosoft.com.cn>>; 'Andrew Fish' <afish@apple.com > <mailto:afish@apple.com>>; 'edk2-devel-groups-io' > <devel@edk2.groups.io <mailto:devel@edk2.groups.io>> > *Cc:* Kinney, Michael D <michael.d.kinney@intel.com > <mailto:michael.d.kinney@intel.com>>; 'Gao, Liming' > <liming.gao@intel.com <mailto:liming.gao@intel.com>>; Liu, Zhiguang > <zhiguang.liu@intel.com <mailto:zhiguang.liu@intel.com>>; Wang, Jian J > <jian.j.wang@intel.com <mailto:jian.j.wang@intel.com>>; Gao, Zhichao > <zhichao.gao@intel.com <mailto:zhichao.gao@intel.com>> > *Subject:* Re: [edk2-devel] RFC: Add BaseLib/QuickSort in MdePkg > > I don’t see objection so far. > > So, the final solution is: > > 1. Add QuickSort() API to BaseLib in MdePkg. > 2. Update existing MdeModulePkg/SortLib to use QuickSort() in the > implementation (proposed by Andrew Fish and Liming Gao) > 3. Update UefiCpuPkg to use QuickSortLib to remove improper > dependency on MdeModulePkg > > Thanks, > > Ray > > *From:*Ni, Ray > *Sent:* Thursday, September 16, 2021 10:48 AM > *To:* Chan, Amy <amy.chan@intel.com <mailto:amy.chan@intel.com>>; > gaoliming <gaoliming@byosoft.com.cn > <mailto:gaoliming@byosoft.com.cn>>; 'Andrew Fish' <afish@apple.com > <mailto:afish@apple.com>>; 'edk2-devel-groups-io' > <devel@edk2.groups.io <mailto:devel@edk2.groups.io>> > *Cc:* Kinney, Michael D <michael.d.kinney@intel.com > <mailto:michael.d.kinney@intel.com>>; 'Gao, Liming' > <liming.gao@intel.com <mailto:liming.gao@intel.com>>; Liu, Zhiguang > <Zhiguang.Liu@intel.com <mailto:Zhiguang.Liu@intel.com>>; Wang, Jian J > <jian.j.wang@intel.com <mailto:jian.j.wang@intel.com>>; Gao, Zhichao > <zhichao.gao@intel.com <mailto:zhichao.gao@intel.com>> > *Subject:* RE: [edk2-devel] RFC: Add BaseLib/QuickSort in MdePkg > > Amy, > > No. We only Add QuickSort() function API into BaseLib.h. > > *From:*Chan, Amy <amy.chan@intel.com <mailto:amy.chan@intel.com>> > *Sent:* Thursday, September 16, 2021 10:46 AM > *To:* gaoliming <gaoliming@byosoft.com.cn > <mailto:gaoliming@byosoft.com.cn>>; 'Andrew Fish' <afish@apple.com > <mailto:afish@apple.com>>; 'edk2-devel-groups-io' > <devel@edk2.groups.io <mailto:devel@edk2.groups.io>> > *Cc:* Ni, Ray <ray.ni@intel.com <mailto:ray.ni@intel.com>>; Kinney, > Michael D <michael.d.kinney@intel.com > <mailto:michael.d.kinney@intel.com>>; 'Gao, Liming' > <liming.gao@intel.com <mailto:liming.gao@intel.com>>; Liu, Zhiguang > <zhiguang.liu@intel.com <mailto:zhiguang.liu@intel.com>>; Wang, Jian J > <jian.j.wang@intel.com <mailto:jian.j.wang@intel.com>>; Gao, Zhichao > <zhichao.gao@intel.com <mailto:zhichao.gao@intel.com>> > *Subject:* RE: [edk2-devel] RFC: Add BaseLib/QuickSort in MdePkg > > Just to double confirm, will we have the null instance of QuickSort in > MdePkg? > > Regards, > > Amy > > *From:*gaoliming <gaoliming@byosoft.com.cn > <mailto:gaoliming@byosoft.com.cn>> > *Sent:* Thursday, September 16, 2021 10:23 AM > *To:* 'Andrew Fish' <afish@apple.com <mailto:afish@apple.com>>; > 'edk2-devel-groups-io' <devel@edk2.groups.io > <mailto:devel@edk2.groups.io>> > *Cc:* Ni, Ray <ray.ni@intel.com <mailto:ray.ni@intel.com>>; Kinney, > Michael D <michael.d.kinney@intel.com > <mailto:michael.d.kinney@intel.com>>; 'Gao, Liming' > <liming.gao@intel.com <mailto:liming.gao@intel.com>>; Liu, Zhiguang > <zhiguang.liu@intel.com <mailto:zhiguang.liu@intel.com>>; Wang, Jian J > <jian.j.wang@intel.com <mailto:jian.j.wang@intel.com>>; Gao, Zhichao > <zhichao.gao@intel.com <mailto:zhichao.gao@intel.com>>; Chan, Amy > <amy.chan@intel.com <mailto:amy.chan@intel.com>> > *Subject:* 回复: [edk2-devel] RFC: Add BaseLib/QuickSort in MdePkg > > Andrew: > > Thanks for your suggestion. I think your idea is better. We add new > QuickSort() API to BaseLib, and update SortLib library instance to > consume BaseLib QuickSort() API. This way has no change in current > SortLib library class. It is the compatible solution. > > Thanks > > Liming > > *发件人**:*Andrew Fish <afish@apple.com <mailto:afish@apple.com>> > *发送时间:* 2021年9月16日 10:13 > *收件人:* edk2-devel-groups-io <devel@edk2.groups.io > <mailto:devel@edk2.groups.io>>; Liming Gao <gaoliming@byosoft.com.cn > <mailto:gaoliming@byosoft.com.cn>> > *抄送:* Ni, Ray <ray.ni@intel.com <mailto:ray.ni@intel.com>>; Mike > Kinney <michael.d.kinney@intel.com > <mailto:michael.d.kinney@intel.com>>; Gao, Liming > <liming.gao@intel.com <mailto:liming.gao@intel.com>>; Liu, Zhiguang > <zhiguang.liu@intel.com <mailto:zhiguang.liu@intel.com>>; Wang, Jian J > <jian.j.wang@intel.com <mailto:jian.j.wang@intel.com>>; Gao, Zhichao > <zhichao.gao@intel.com <mailto:zhichao.gao@intel.com>>; Chan, Amy > <amy.chan@intel.com <mailto:amy.chan@intel.com>> > *主题:* Re: [edk2-devel] RFC: Add BaseLib/QuickSort in MdePkg > > On Sep 15, 2021, at 6:26 PM, gaoliming <gaoliming@byosoft.com.cn > <mailto:gaoliming@byosoft.com.cn>> wrote: > > Ray: > > SortLib has been added since 2015. I would suggest to still keep > this library class. To resolve the package dependency, my proposal > is to move the library class header file SortLib.h from > MdeModulePkg to MdePkg, and still keep the library instance in > MdeModulePkg. This proposal has no impact on the existing platform. > > If we add QuickSort() API to the BaseLib can we not just port the > existing MdeModulePkg/SortLib to use QuickSort() in the > implementation? Or is there some other way to add the new thing in a > backward compatible way. > > Thanks, > > Andrew Fish > > Thanks > > Liming > > *发件人**:*devel@edk2.groups.io > <mailto:devel@edk2.groups.io><devel@edk2.groups.io > <mailto:devel@edk2.groups.io>>*代表***Ni, Ray > *发送时间:*2021年9月14日14:15 > *收件人:*Kinney, Michael D <michael.d.kinney@intel.com > <mailto:michael.d.kinney@intel.com>>; Gao, Liming > <liming.gao@intel.com <mailto:liming.gao@intel.com>>; Liu, > Zhiguang <zhiguang.liu@intel.com <mailto:zhiguang.liu@intel.com>>; > Wang, Jian J <jian.j.wang@intel.com > <mailto:jian.j.wang@intel.com>>; Gao, Zhichao > <zhichao.gao@intel.com <mailto:zhichao.gao@intel.com>> > *抄送:*devel@edk2.groups.io <mailto:devel@edk2.groups.io>; Chan, Amy > <amy.chan@intel.com <mailto:amy.chan@intel.com>> > *主题:*[edk2-devel] RFC: Add BaseLib/QuickSort in MdePkg > > Hi package maintainers of MdePkg, MdeModulePkg and ShellPkg, > community, > > A commit (UefiCpuPkg/CpuCacheInfoLib: Sort CpuCacheInfo array > <https://github.com/tianocore/edk2/commit/4de77ae9890d241271f543e9195ab3516f3abec6>) > to UefiCpuPkg let > UefiCpuPkg depend on MdeModulePkg because the SortLib class and > instances are all in MdeModulePkg. > > UefiCpuPkg depending on MdeModulePkg breaks the rule that > “UefiCpuPkg should ONLY depend on MdePkg”. > > To address this issue, there are two approaches: > > 1. Duplicate the sort logic in UefiCpuPkg to not depend on > MdeModulePkg/SortLib > 2. Add QuickSort() API to BaseLib in MdePkg. > > Approach #2 (MdePkg/BaseLib/QuickSort) makes more sense because > quick sort is a standard algorithm. > > We encourage consumers to update their code to use the quick sort > in MdePkg and gradually deprecate today’s MdeModulePkg/SortLib. > > If you don’t have concerns, I plan to: > > 1. “Add QuickSort() to BaseLib” and update all existing consumers > to use this API instead. > > VOID > > EFIAPI > > QuickSort ( > > IN OUT VOID *BufferToSort, > > IN CONST UINTN Count, > > IN CONST UINTN ElementSize, > > IN SORT_COMPARE CompareFunction > > ); > > 2. “Add new ShellPkg/SortCompareLib” > > Background: ShellPkg requires to sort devicepath/string so 3 APIs > in UefiSortLib (DevicePathCompare, StringNoCaseCompare, > StringCompare) are provided for Shell usage. we can move the 3 > APIs to the SortCompareLib and update Shell code to use > BaseLib/QuickSort directly, with the sort compare function from > SortCompareLib. > > Any concerns? > > Thanks, > > Ray > > [-- Attachment #2: Type: text/html, Size: 24865 bytes --] ^ permalink raw reply [flat|nested] 21+ messages in thread
* Re: [edk2-devel] RFC: Add BaseLib/QuickSort in MdePkg 2021-09-27 0:45 ` Jeff Fan @ 2021-09-27 8:14 ` Marvin Häuser 2021-09-27 8:50 ` Jeff Fan [not found] ` <16A8A1ADDB4E97C4.26412@groups.io> 0 siblings, 2 replies; 21+ messages in thread From: Marvin Häuser @ 2021-09-27 8:14 UTC (permalink / raw) To: fanjianfeng@byosoft.com.cn, devel@edk2.groups.io, Ni, Ray, 'gaoliming', Chan, Amy, 'Andrew Fish' Cc: Kinney, Michael D, 'Gao, Liming', Liu, Zhiguang, Wang, Jian J, Gao, Zhichao On 27/09/2021 02:45, fanjianfeng@byosoft.com.cn wrote: > Making baselib implementation depend on MemoryAllocationLib > (indirectly on Pei Service and gBS), it may prevent > this base API using at some seneraio. i don't think it's better. That is why I asked about a split-API scenario, one of which does not depend on dynamic memory allocation (SetVariable-like) and one does (wrapper-like). > Add this parameter and make this parameter is optional, > 1, when NULL, use the local 256 bytes stack > 2, if 256 bytes stack is not enough, return RETURE_BUFFER_TOO_SAMLL, > 3, caller check the return status, to do nothing or to allocate enough > buffer for retry > > This is just like SetVariable()'s implementation. Yes, and because that is SetVariable's implementation, we have library functions to make it less error-prone and more convenient [1]. As a matter of fact, we have a (semi-lax) policy in our codebases to avoid such functions like the plague and use those library wrappers where-ever it can make sense. The only super-rare exceptions I can think of are when we know the size of the element ahead of time. Also SetVariable has no arbitrary constraint on when it may work the first time, and there is code that will fail when the first return is not EFI_BUFFER_TOO_SMALL. This solution honestly yields even more problems, because it introduces a Status return which was not there before. For common code safety and quality policy, this requires the value *must* be retrieved and checked in some fashion. So all callers, no matter the prior knowledge of the element size, now need either a runtime check and handling for a status that they (may) know can never be returned, or ASSERTs if the function spec really imposes the arbitrary 256 Bytes constraint. Latter doesn't really work I think. What if someone wants to sort in SEC and noticed they only have 64 Bytes on the stack to work with, realistically? Any code depending on the 256 Byte constraint, passing NULL and not doing additional handling, would seize to work. Former is too complicated, see wrappers. In my opinion, the memory must *either* be fully managed by the caller *or* the callee (and you may have both in separate functions, as I suggested), but not sometimes here, sometimes there. Best regards, Marvin [1] https://github.com/tianocore/edk2/blob/46b4606ba23498d3d0e66b53e498eb3d5d592586/MdePkg/Library/UefiLib/UefiLib.c#L1309-L1360 > > ------------------------------------------------------------------------ > Jeff > fanjianfeng@byosoft.com.cn > > *From:* Marvin Häuser <mailto:mhaeuser@posteo.de> > *Date:* 2021-09-26 19:20 > *To:* devel <mailto:devel@edk2.groups.io>; ray.ni > <mailto:ray.ni@intel.com>; gaoliming > <mailto:gaoliming@byosoft.com.cn>; Chan, Amy > <mailto:amy.chan@intel.com>; 'Andrew Fish' <mailto:afish@apple.com> > *CC:* Kinney, Michael D <mailto:michael.d.kinney@intel.com>; 'Gao, > Liming' <mailto:liming.gao@intel.com>; Liu, Zhiguang > <mailto:zhiguang.liu@intel.com>; Wang, Jian J > <mailto:jian.j.wang@intel.com>; Gao, Zhichao > <mailto:zhichao.gao@intel.com> > *Subject:* Re: [edk2-devel] RFC: Add BaseLib/QuickSort in MdePkg > Hey Ray, > In my opinion that spec is too complicated. For some cases it is > obvious, but I think the last anyone wants to see is a > (STATIC_)ASSERT > before most QuickSort calls to ensure the element size *really* is <= > 256 Bytes. In my opinion, there are two roads: > 1) Make the parameter required (I think this is what Liming > suggested). > The caller would always need to provide said buffer, and it can do > as it > sees fit - on the stack, in a pool, in a page, who knows. > 2) Remove the parameter entirely. The library would depend on > MemoryAllocationLib again, but also would have an optimisation by > choosing stack vs pool based on ElementSize. > Usually I would prefer 2), as it is less prone to caller errors, but > considering the low-level nature of edk2, I can totally see the > point to > allow the caller to control whether there are dynamic memory > allocations > made or not as possible with 1). 2) could technically also be a > wrapper > for 1) if you want granular control and convenience/safety (why not > actually?). > Both approaches have the advantage that it is crystal-clear what the > caller's job is - to always or to never allocate the buffer. > Best regards, > Marvin > On 26/09/2021 04:24, Ni, Ray wrote: > > > > Liming, > > > > The purpose of the optional BufferOneElement is to ease consumer’s > > life assuming most of the time the element size should be > smaller than > > 256. > > > > Are you saying that it’s a bit hard to calculate the actual > value of > > sizeof (Element) when writing code? > > > > I recommend consumer always allocates memory if it’s hard to judge > > sizeof (Element) < 256. > > > > Searching edk2 code, I can find below code using PerformQuickSort(): > > > > 1. ShellPkg/UefiShellCommandLib: It’s sorting array of > > (EFI_DEVICE_PATH_PROTOCOL *). > > 2. UefiCpuPkg/CpuCacheInfoLib: It’s sorting array of > CPU_CACHE_INFO. > > 3. MinPlatformPkg/AcpiTables: It’s sorting array of > EFI_CPU_ID_ORDER_MAP. > > 4. MdeModulePkg/UefiBootManagerLib: It’s sorting array of > > EFI_BOOT_MANAGER_LOAD_OPTION. > > 5. MdeModulePkg/CapsuleApp: It’s sorting array of (EFI_FILE_INFO *) > > 6. CryptoPkg/CrtWrapper: It’s sorting array of (unknown type). > > 7. RedfishPkg/RedfishCrtLib: It’s sorting array of (unknown type). > > > > For 1~5, it’s easy to know that the size of the element is smaller > > than 256. The AllocatePool() can be skipped. > > > > Thanks, > > > > Ray > > > > *From:*gaoliming <gaoliming@byosoft.com.cn> > > *Sent:* Sunday, September 26, 2021 10:01 AM > > *To:* Ni, Ray <ray.ni@intel.com>; devel@edk2.groups.io; Chan, Amy > > <amy.chan@intel.com>; 'Andrew Fish' <afish@apple.com> > > *Cc:* Kinney, Michael D <michael.d.kinney@intel.com>; 'Gao, Liming' > > <liming.gao@intel.com>; Liu, Zhiguang <zhiguang.liu@intel.com>; > Wang, > > Jian J <jian.j.wang@intel.com>; Gao, Zhichao <zhichao.gao@intel.com> > > *Subject:* 回复: [edk2-devel] RFC: Add BaseLib/QuickSort in MdePkg > > > > Ray: > > > > I may suggest to always require BufferOneElement. The consumer code > > may not know ElementSize. To avoid the error, the consumer must > > allocate buffer for BufferOneElement. If so, BufferOneElement is > the > > required parameter. > > > > Thanks > > > > Liming > > > > *发件人**:*Ni, Ray <ray.ni@intel.com <mailto:ray.ni@intel.com>> > > *发送时间:* 2021年9月24日 11:53 > > *收件人:* devel@edk2.groups.io <mailto:devel@edk2.groups.io>; Ni, > Ray > > <ray.ni@intel.com <mailto:ray.ni@intel.com>>; Chan, Amy > > <amy.chan@intel.com <mailto:amy.chan@intel.com>>; gaoliming > > <gaoliming@byosoft.com.cn <mailto:gaoliming@byosoft.com.cn>>; > 'Andrew > > Fish' <afish@apple.com <mailto:afish@apple.com>> > > *抄送:* Kinney, Michael D <michael.d.kinney@intel.com > > <mailto:michael.d.kinney@intel.com>>; 'Gao, Liming' > > <liming.gao@intel.com <mailto:liming.gao@intel.com>>; Liu, Zhiguang > > <zhiguang.liu@intel.com <mailto:zhiguang.liu@intel.com>>; Wang, > Jian J > > <jian.j.wang@intel.com <mailto:jian.j.wang@intel.com>>; Gao, > Zhichao > > <zhichao.gao@intel.com <mailto:zhichao.gao@intel.com>> > > *主题:* RE: [edk2-devel] RFC: Add BaseLib/QuickSort in MdePkg > > > > More details on new QuickSort() API: > > > > The new API needs to carry additional parameter “BufferOneElement”. > > > > This parameter gives QuickSort() the temporary buffer for > swapping in > > sorting. > > > > It’s to avoid BaseLib depends on MemoryAllocationLib. > > > > … > > > > @param [in] BufferOneElement When ElementSize > 256, caller > needs to > > provide a buffer whose size > > equals to ElementSize. It’s used by > > QuickSort() for swapping in sorting. > > > > When ElementSize <= 256, QuickSort() uses a local stack 256-byte > buffer. > > > > @retval EFI_INVALID_PARAMETER When (ElementSize > 256) and > > (BufferOneElement == NULL). > > > > … > > > > VOID > > > > EFIAPI > > > > QuickSort ( > > > > IN OUT VOID *BufferToSort, > > > > IN CONST UINTN ElementCount, > > > > IN CONST UINTN ElementSize, > > > > IN SORT_COMPARE CompareFunction, > > > > IN VOID *BufferOneElement OPTIONAL > > > > ); > > > > Any comments? > > > > *From:*devel@edk2.groups.io <mailto:devel@edk2.groups.io> > > <devel@edk2.groups.io <mailto:devel@edk2.groups.io>> *On Behalf Of > > *Ni, Ray > > *Sent:* Wednesday, September 22, 2021 2:04 PM > > *To:* Chan, Amy <amy.chan@intel.com <mailto:amy.chan@intel.com>>; > > gaoliming <gaoliming@byosoft.com.cn > > <mailto:gaoliming@byosoft.com.cn>>; 'Andrew Fish' <afish@apple.com > > <mailto:afish@apple.com>>; 'edk2-devel-groups-io' > > <devel@edk2.groups.io <mailto:devel@edk2.groups.io>> > > *Cc:* Kinney, Michael D <michael.d.kinney@intel.com > > <mailto:michael.d.kinney@intel.com>>; 'Gao, Liming' > > <liming.gao@intel.com <mailto:liming.gao@intel.com>>; Liu, Zhiguang > > <zhiguang.liu@intel.com <mailto:zhiguang.liu@intel.com>>; Wang, > Jian J > > <jian.j.wang@intel.com <mailto:jian.j.wang@intel.com>>; Gao, > Zhichao > > <zhichao.gao@intel.com <mailto:zhichao.gao@intel.com>> > > *Subject:* Re: [edk2-devel] RFC: Add BaseLib/QuickSort in MdePkg > > > > I don’t see objection so far. > > > > So, the final solution is: > > > > 1. Add QuickSort() API to BaseLib in MdePkg. > > 2. Update existing MdeModulePkg/SortLib to use QuickSort() in the > > implementation (proposed by Andrew Fish and Liming Gao) > > 3. Update UefiCpuPkg to use QuickSortLib to remove improper > > dependency on MdeModulePkg > > > > Thanks, > > > > Ray > > > > *From:*Ni, Ray > > *Sent:* Thursday, September 16, 2021 10:48 AM > > *To:* Chan, Amy <amy.chan@intel.com <mailto:amy.chan@intel.com>>; > > gaoliming <gaoliming@byosoft.com.cn > > <mailto:gaoliming@byosoft.com.cn>>; 'Andrew Fish' <afish@apple.com > > <mailto:afish@apple.com>>; 'edk2-devel-groups-io' > > <devel@edk2.groups.io <mailto:devel@edk2.groups.io>> > > *Cc:* Kinney, Michael D <michael.d.kinney@intel.com > > <mailto:michael.d.kinney@intel.com>>; 'Gao, Liming' > > <liming.gao@intel.com <mailto:liming.gao@intel.com>>; Liu, Zhiguang > > <Zhiguang.Liu@intel.com <mailto:Zhiguang.Liu@intel.com>>; Wang, > Jian J > > <jian.j.wang@intel.com <mailto:jian.j.wang@intel.com>>; Gao, > Zhichao > > <zhichao.gao@intel.com <mailto:zhichao.gao@intel.com>> > > *Subject:* RE: [edk2-devel] RFC: Add BaseLib/QuickSort in MdePkg > > > > Amy, > > > > No. We only Add QuickSort() function API into BaseLib.h. > > > > *From:*Chan, Amy <amy.chan@intel.com <mailto:amy.chan@intel.com>> > > *Sent:* Thursday, September 16, 2021 10:46 AM > > *To:* gaoliming <gaoliming@byosoft.com.cn > > <mailto:gaoliming@byosoft.com.cn>>; 'Andrew Fish' <afish@apple.com > > <mailto:afish@apple.com>>; 'edk2-devel-groups-io' > > <devel@edk2.groups.io <mailto:devel@edk2.groups.io>> > > *Cc:* Ni, Ray <ray.ni@intel.com <mailto:ray.ni@intel.com>>; Kinney, > > Michael D <michael.d.kinney@intel.com > > <mailto:michael.d.kinney@intel.com>>; 'Gao, Liming' > > <liming.gao@intel.com <mailto:liming.gao@intel.com>>; Liu, Zhiguang > > <zhiguang.liu@intel.com <mailto:zhiguang.liu@intel.com>>; Wang, > Jian J > > <jian.j.wang@intel.com <mailto:jian.j.wang@intel.com>>; Gao, > Zhichao > > <zhichao.gao@intel.com <mailto:zhichao.gao@intel.com>> > > *Subject:* RE: [edk2-devel] RFC: Add BaseLib/QuickSort in MdePkg > > > > Just to double confirm, will we have the null instance of > QuickSort in > > MdePkg? > > > > Regards, > > > > Amy > > > > *From:*gaoliming <gaoliming@byosoft.com.cn > > <mailto:gaoliming@byosoft.com.cn>> > > *Sent:* Thursday, September 16, 2021 10:23 AM > > *To:* 'Andrew Fish' <afish@apple.com <mailto:afish@apple.com>>; > > 'edk2-devel-groups-io' <devel@edk2.groups.io > > <mailto:devel@edk2.groups.io>> > > *Cc:* Ni, Ray <ray.ni@intel.com <mailto:ray.ni@intel.com>>; Kinney, > > Michael D <michael.d.kinney@intel.com > > <mailto:michael.d.kinney@intel.com>>; 'Gao, Liming' > > <liming.gao@intel.com <mailto:liming.gao@intel.com>>; Liu, Zhiguang > > <zhiguang.liu@intel.com <mailto:zhiguang.liu@intel.com>>; Wang, > Jian J > > <jian.j.wang@intel.com <mailto:jian.j.wang@intel.com>>; Gao, > Zhichao > > <zhichao.gao@intel.com <mailto:zhichao.gao@intel.com>>; Chan, Amy > > <amy.chan@intel.com <mailto:amy.chan@intel.com>> > > *Subject:* 回复: [edk2-devel] RFC: Add BaseLib/QuickSort in MdePkg > > > > Andrew: > > > > Thanks for your suggestion. I think your idea is better. We add new > > QuickSort() API to BaseLib, and update SortLib library instance to > > consume BaseLib QuickSort() API. This way has no change in current > > SortLib library class. It is the compatible solution. > > > > Thanks > > > > Liming > > > > *发件人**:*Andrew Fish <afish@apple.com <mailto:afish@apple.com>> > > *发送时间:* 2021年9月16日 10:13 > > *收件人:* edk2-devel-groups-io <devel@edk2.groups.io > > <mailto:devel@edk2.groups.io>>; Liming Gao > <gaoliming@byosoft.com.cn > > <mailto:gaoliming@byosoft.com.cn>> > > *抄送:* Ni, Ray <ray.ni@intel.com <mailto:ray.ni@intel.com>>; Mike > > Kinney <michael.d.kinney@intel.com > > <mailto:michael.d.kinney@intel.com>>; Gao, Liming > > <liming.gao@intel.com <mailto:liming.gao@intel.com>>; Liu, Zhiguang > > <zhiguang.liu@intel.com <mailto:zhiguang.liu@intel.com>>; Wang, > Jian J > > <jian.j.wang@intel.com <mailto:jian.j.wang@intel.com>>; Gao, > Zhichao > > <zhichao.gao@intel.com <mailto:zhichao.gao@intel.com>>; Chan, Amy > > <amy.chan@intel.com <mailto:amy.chan@intel.com>> > > *主题:* Re: [edk2-devel] RFC: Add BaseLib/QuickSort in MdePkg > > > > On Sep 15, 2021, at 6:26 PM, gaoliming <gaoliming@byosoft.com.cn > > <mailto:gaoliming@byosoft.com.cn>> wrote: > > > > Ray: > > > > SortLib has been added since 2015. I would suggest to still keep > > this library class. To resolve the package dependency, my > proposal > > is to move the library class header file SortLib.h from > > MdeModulePkg to MdePkg, and still keep the library instance in > > MdeModulePkg. This proposal has no impact on the existing > platform. > > > > If we add QuickSort() API to the BaseLib can we not just port the > > existing MdeModulePkg/SortLib to use QuickSort() in the > > implementation? Or is there some other way to add the new thing > in a > > backward compatible way. > > > > Thanks, > > > > Andrew Fish > > > > Thanks > > > > Liming > > > > *发件人**:*devel@edk2.groups.io > > <mailto:devel@edk2.groups.io><devel@edk2.groups.io > > <mailto:devel@edk2.groups.io>>*代表***Ni, Ray > > *发送时间:*2021年9月14日14:15 > > *收件人:*Kinney, Michael D <michael.d.kinney@intel.com > > <mailto:michael.d.kinney@intel.com>>; Gao, Liming > > <liming.gao@intel.com <mailto:liming.gao@intel.com>>; Liu, > > Zhiguang <zhiguang.liu@intel.com > <mailto:zhiguang.liu@intel.com>>; > > Wang, Jian J <jian.j.wang@intel.com > > <mailto:jian.j.wang@intel.com>>; Gao, Zhichao > > <zhichao.gao@intel.com <mailto:zhichao.gao@intel.com>> > > *抄送:*devel@edk2.groups.io <mailto:devel@edk2.groups.io>; > Chan, Amy > > <amy.chan@intel.com <mailto:amy.chan@intel.com>> > > *主题:*[edk2-devel] RFC: Add BaseLib/QuickSort in MdePkg > > > > Hi package maintainers of MdePkg, MdeModulePkg and ShellPkg, > > community, > > > > A commit (UefiCpuPkg/CpuCacheInfoLib: Sort CpuCacheInfo array > > > <https://github.com/tianocore/edk2/commit/4de77ae9890d241271f543e9195ab3516f3abec6>) > > to UefiCpuPkg let > > UefiCpuPkg depend on MdeModulePkg because the SortLib class and > > instances are all in MdeModulePkg. > > > > UefiCpuPkg depending on MdeModulePkg breaks the rule that > > “UefiCpuPkg should ONLY depend on MdePkg”. > > > > To address this issue, there are two approaches: > > > > 1. Duplicate the sort logic in UefiCpuPkg to not depend on > > MdeModulePkg/SortLib > > 2. Add QuickSort() API to BaseLib in MdePkg. > > > > Approach #2 (MdePkg/BaseLib/QuickSort) makes more sense because > > quick sort is a standard algorithm. > > > > We encourage consumers to update their code to use the quick > sort > > in MdePkg and gradually deprecate today’s MdeModulePkg/SortLib. > > > > If you don’t have concerns, I plan to: > > > > 1. “Add QuickSort() to BaseLib” and update all existing > consumers > > to use this API instead. > > > > VOID > > > > EFIAPI > > > > QuickSort ( > > > > IN OUT VOID *BufferToSort, > > > > IN CONST UINTN Count, > > > > IN CONST UINTN ElementSize, > > > > IN SORT_COMPARE CompareFunction > > > > ); > > > > 2. “Add new ShellPkg/SortCompareLib” > > > > Background: ShellPkg requires to sort devicepath/string so 3 > APIs > > in UefiSortLib (DevicePathCompare, StringNoCaseCompare, > > StringCompare) are provided for Shell usage. we can move the 3 > > APIs to the SortCompareLib and update Shell code to use > > BaseLib/QuickSort directly, with the sort compare function from > > SortCompareLib. > > > > Any concerns? > > > > Thanks, > > > > Ray > > > > > > ^ permalink raw reply [flat|nested] 21+ messages in thread
* Re: [edk2-devel] RFC: Add BaseLib/QuickSort in MdePkg 2021-09-27 8:14 ` Marvin Häuser @ 2021-09-27 8:50 ` Jeff Fan 2021-09-27 9:09 ` Marvin Häuser [not found] ` <16A8A1ADDB4E97C4.26412@groups.io> 1 sibling, 1 reply; 21+ messages in thread From: Jeff Fan @ 2021-09-27 8:50 UTC (permalink / raw) To: devel@edk2.groups.io, mhaeuser, Ni, Ray, 'gaoliming', Chan, Amy, 'Andrew Fish' Cc: Kinney, Michael D, 'Gao, Liming', Liu, Zhiguang, Wang, Jian J, Gao, Zhichao [-- Attachment #1: Type: text/plain, Size: 20286 bytes --] For former caller, they could still keep as is to call the old API in MdeModulePkg. I think Ray's design is compatible change for existing code. Only when the existing code wants to remove the dependency on MdeModuelPkg, they could migrate to the new API in baselib. I agree with one split-API desgin what you mentioned. But my point is to define one API in baselib and to make the baselib not depend on memory allocation. And another wrapper API could be designed to be placed in any other class. Jeff fanjianfeng@byosoft.com.cn From: Marvin Häuser Date: 2021-09-27 16:14 To: fanjianfeng@byosoft.com.cn; devel@edk2.groups.io; Ni, Ray; 'gaoliming'; Chan, Amy; 'Andrew Fish' CC: Kinney, Michael D; 'Gao, Liming'; Liu, Zhiguang; Wang, Jian J; Gao, Zhichao Subject: Re: [edk2-devel] RFC: Add BaseLib/QuickSort in MdePkg On 27/09/2021 02:45, fanjianfeng@byosoft.com.cn wrote: > Making baselib implementation depend on MemoryAllocationLib > (indirectly on Pei Service and gBS), it may prevent > this base API using at some seneraio. i don't think it's better. That is why I asked about a split-API scenario, one of which does not depend on dynamic memory allocation (SetVariable-like) and one does (wrapper-like). > Add this parameter and make this parameter is optional, > 1, when NULL, use the local 256 bytes stack > 2, if 256 bytes stack is not enough, return RETURE_BUFFER_TOO_SAMLL, > 3, caller check the return status, to do nothing or to allocate enough > buffer for retry > > This is just like SetVariable()'s implementation. Yes, and because that is SetVariable's implementation, we have library functions to make it less error-prone and more convenient [1]. As a matter of fact, we have a (semi-lax) policy in our codebases to avoid such functions like the plague and use those library wrappers where-ever it can make sense. The only super-rare exceptions I can think of are when we know the size of the element ahead of time. Also SetVariable has no arbitrary constraint on when it may work the first time, and there is code that will fail when the first return is not EFI_BUFFER_TOO_SMALL. This solution honestly yields even more problems, because it introduces a Status return which was not there before. For common code safety and quality policy, this requires the value *must* be retrieved and checked in some fashion. So all callers, no matter the prior knowledge of the element size, now need either a runtime check and handling for a status that they (may) know can never be returned, or ASSERTs if the function spec really imposes the arbitrary 256 Bytes constraint. Latter doesn't really work I think. What if someone wants to sort in SEC and noticed they only have 64 Bytes on the stack to work with, realistically? Any code depending on the 256 Byte constraint, passing NULL and not doing additional handling, would seize to work. Former is too complicated, see wrappers. In my opinion, the memory must *either* be fully managed by the caller *or* the callee (and you may have both in separate functions, as I suggested), but not sometimes here, sometimes there. Best regards, Marvin [1] https://github.com/tianocore/edk2/blob/46b4606ba23498d3d0e66b53e498eb3d5d592586/MdePkg/Library/UefiLib/UefiLib.c#L1309-L1360 > > ------------------------------------------------------------------------ > Jeff > fanjianfeng@byosoft.com.cn > > *From:* Marvin Häuser <mailto:mhaeuser@posteo.de> > *Date:* 2021-09-26 19:20 > *To:* devel <mailto:devel@edk2.groups.io>; ray.ni > <mailto:ray.ni@intel.com>; gaoliming > <mailto:gaoliming@byosoft.com.cn>; Chan, Amy > <mailto:amy.chan@intel.com>; 'Andrew Fish' <mailto:afish@apple.com> > *CC:* Kinney, Michael D <mailto:michael.d.kinney@intel.com>; 'Gao, > Liming' <mailto:liming.gao@intel.com>; Liu, Zhiguang > <mailto:zhiguang.liu@intel.com>; Wang, Jian J > <mailto:jian.j.wang@intel.com>; Gao, Zhichao > <mailto:zhichao.gao@intel.com> > *Subject:* Re: [edk2-devel] RFC: Add BaseLib/QuickSort in MdePkg > Hey Ray, > In my opinion that spec is too complicated. For some cases it is > obvious, but I think the last anyone wants to see is a > (STATIC_)ASSERT > before most QuickSort calls to ensure the element size *really* is <= > 256 Bytes. In my opinion, there are two roads: > 1) Make the parameter required (I think this is what Liming > suggested). > The caller would always need to provide said buffer, and it can do > as it > sees fit - on the stack, in a pool, in a page, who knows. > 2) Remove the parameter entirely. The library would depend on > MemoryAllocationLib again, but also would have an optimisation by > choosing stack vs pool based on ElementSize. > Usually I would prefer 2), as it is less prone to caller errors, but > considering the low-level nature of edk2, I can totally see the > point to > allow the caller to control whether there are dynamic memory > allocations > made or not as possible with 1). 2) could technically also be a > wrapper > for 1) if you want granular control and convenience/safety (why not > actually?). > Both approaches have the advantage that it is crystal-clear what the > caller's job is - to always or to never allocate the buffer. > Best regards, > Marvin > On 26/09/2021 04:24, Ni, Ray wrote: > > > > Liming, > > > > The purpose of the optional BufferOneElement is to ease consumer’s > > life assuming most of the time the element size should be > smaller than > > 256. > > > > Are you saying that it’s a bit hard to calculate the actual > value of > > sizeof (Element) when writing code? > > > > I recommend consumer always allocates memory if it’s hard to judge > > sizeof (Element) < 256. > > > > Searching edk2 code, I can find below code using PerformQuickSort(): > > > > 1. ShellPkg/UefiShellCommandLib: It’s sorting array of > > (EFI_DEVICE_PATH_PROTOCOL *). > > 2. UefiCpuPkg/CpuCacheInfoLib: It’s sorting array of > CPU_CACHE_INFO. > > 3. MinPlatformPkg/AcpiTables: It’s sorting array of > EFI_CPU_ID_ORDER_MAP. > > 4. MdeModulePkg/UefiBootManagerLib: It’s sorting array of > > EFI_BOOT_MANAGER_LOAD_OPTION. > > 5. MdeModulePkg/CapsuleApp: It’s sorting array of (EFI_FILE_INFO *) > > 6. CryptoPkg/CrtWrapper: It’s sorting array of (unknown type). > > 7. RedfishPkg/RedfishCrtLib: It’s sorting array of (unknown type). > > > > For 1~5, it’s easy to know that the size of the element is smaller > > than 256. The AllocatePool() can be skipped. > > > > Thanks, > > > > Ray > > > > *From:*gaoliming <gaoliming@byosoft.com.cn> > > *Sent:* Sunday, September 26, 2021 10:01 AM > > *To:* Ni, Ray <ray.ni@intel.com>; devel@edk2.groups.io; Chan, Amy > > <amy.chan@intel.com>; 'Andrew Fish' <afish@apple.com> > > *Cc:* Kinney, Michael D <michael.d.kinney@intel.com>; 'Gao, Liming' > > <liming.gao@intel.com>; Liu, Zhiguang <zhiguang.liu@intel.com>; > Wang, > > Jian J <jian.j.wang@intel.com>; Gao, Zhichao <zhichao.gao@intel.com> > > *Subject:* 回复: [edk2-devel] RFC: Add BaseLib/QuickSort in MdePkg > > > > Ray: > > > > I may suggest to always require BufferOneElement. The consumer code > > may not know ElementSize. To avoid the error, the consumer must > > allocate buffer for BufferOneElement. If so, BufferOneElement is > the > > required parameter. > > > > Thanks > > > > Liming > > > > *发件人**:*Ni, Ray <ray.ni@intel.com <mailto:ray.ni@intel.com>> > > *发送时间:* 2021年9月24日 11:53 > > *收件人:* devel@edk2.groups.io <mailto:devel@edk2.groups.io>; Ni, > Ray > > <ray.ni@intel.com <mailto:ray.ni@intel.com>>; Chan, Amy > > <amy.chan@intel.com <mailto:amy.chan@intel.com>>; gaoliming > > <gaoliming@byosoft.com.cn <mailto:gaoliming@byosoft.com.cn>>; > 'Andrew > > Fish' <afish@apple.com <mailto:afish@apple.com>> > > *抄送:* Kinney, Michael D <michael.d.kinney@intel.com > > <mailto:michael.d.kinney@intel.com>>; 'Gao, Liming' > > <liming.gao@intel.com <mailto:liming.gao@intel.com>>; Liu, Zhiguang > > <zhiguang.liu@intel.com <mailto:zhiguang.liu@intel.com>>; Wang, > Jian J > > <jian.j.wang@intel.com <mailto:jian.j.wang@intel.com>>; Gao, > Zhichao > > <zhichao.gao@intel.com <mailto:zhichao.gao@intel.com>> > > *主题:* RE: [edk2-devel] RFC: Add BaseLib/QuickSort in MdePkg > > > > More details on new QuickSort() API: > > > > The new API needs to carry additional parameter “BufferOneElement”. > > > > This parameter gives QuickSort() the temporary buffer for > swapping in > > sorting. > > > > It’s to avoid BaseLib depends on MemoryAllocationLib. > > > > … > > > > @param [in] BufferOneElement When ElementSize > 256, caller > needs to > > provide a buffer whose size > > equals to ElementSize. It’s used by > > QuickSort() for swapping in sorting. > > > > When ElementSize <= 256, QuickSort() uses a local stack 256-byte > buffer. > > > > @retval EFI_INVALID_PARAMETER When (ElementSize > 256) and > > (BufferOneElement == NULL). > > > > … > > > > VOID > > > > EFIAPI > > > > QuickSort ( > > > > IN OUT VOID *BufferToSort, > > > > IN CONST UINTN ElementCount, > > > > IN CONST UINTN ElementSize, > > > > IN SORT_COMPARE CompareFunction, > > > > IN VOID *BufferOneElement OPTIONAL > > > > ); > > > > Any comments? > > > > *From:*devel@edk2.groups.io <mailto:devel@edk2.groups.io> > > <devel@edk2.groups.io <mailto:devel@edk2.groups.io>> *On Behalf Of > > *Ni, Ray > > *Sent:* Wednesday, September 22, 2021 2:04 PM > > *To:* Chan, Amy <amy.chan@intel.com <mailto:amy.chan@intel.com>>; > > gaoliming <gaoliming@byosoft.com.cn > > <mailto:gaoliming@byosoft.com.cn>>; 'Andrew Fish' <afish@apple.com > > <mailto:afish@apple.com>>; 'edk2-devel-groups-io' > > <devel@edk2.groups.io <mailto:devel@edk2.groups.io>> > > *Cc:* Kinney, Michael D <michael.d.kinney@intel.com > > <mailto:michael.d.kinney@intel.com>>; 'Gao, Liming' > > <liming.gao@intel.com <mailto:liming.gao@intel.com>>; Liu, Zhiguang > > <zhiguang.liu@intel.com <mailto:zhiguang.liu@intel.com>>; Wang, > Jian J > > <jian.j.wang@intel.com <mailto:jian.j.wang@intel.com>>; Gao, > Zhichao > > <zhichao.gao@intel.com <mailto:zhichao.gao@intel.com>> > > *Subject:* Re: [edk2-devel] RFC: Add BaseLib/QuickSort in MdePkg > > > > I don’t see objection so far. > > > > So, the final solution is: > > > > 1. Add QuickSort() API to BaseLib in MdePkg. > > 2. Update existing MdeModulePkg/SortLib to use QuickSort() in the > > implementation (proposed by Andrew Fish and Liming Gao) > > 3. Update UefiCpuPkg to use QuickSortLib to remove improper > > dependency on MdeModulePkg > > > > Thanks, > > > > Ray > > > > *From:*Ni, Ray > > *Sent:* Thursday, September 16, 2021 10:48 AM > > *To:* Chan, Amy <amy.chan@intel.com <mailto:amy.chan@intel.com>>; > > gaoliming <gaoliming@byosoft.com.cn > > <mailto:gaoliming@byosoft.com.cn>>; 'Andrew Fish' <afish@apple.com > > <mailto:afish@apple.com>>; 'edk2-devel-groups-io' > > <devel@edk2.groups.io <mailto:devel@edk2.groups.io>> > > *Cc:* Kinney, Michael D <michael.d.kinney@intel.com > > <mailto:michael.d.kinney@intel.com>>; 'Gao, Liming' > > <liming.gao@intel.com <mailto:liming.gao@intel.com>>; Liu, Zhiguang > > <Zhiguang.Liu@intel.com <mailto:Zhiguang.Liu@intel.com>>; Wang, > Jian J > > <jian.j.wang@intel.com <mailto:jian.j.wang@intel.com>>; Gao, > Zhichao > > <zhichao.gao@intel.com <mailto:zhichao.gao@intel.com>> > > *Subject:* RE: [edk2-devel] RFC: Add BaseLib/QuickSort in MdePkg > > > > Amy, > > > > No. We only Add QuickSort() function API into BaseLib.h. > > > > *From:*Chan, Amy <amy.chan@intel.com <mailto:amy.chan@intel.com>> > > *Sent:* Thursday, September 16, 2021 10:46 AM > > *To:* gaoliming <gaoliming@byosoft.com.cn > > <mailto:gaoliming@byosoft.com.cn>>; 'Andrew Fish' <afish@apple.com > > <mailto:afish@apple.com>>; 'edk2-devel-groups-io' > > <devel@edk2.groups.io <mailto:devel@edk2.groups.io>> > > *Cc:* Ni, Ray <ray.ni@intel.com <mailto:ray.ni@intel.com>>; Kinney, > > Michael D <michael.d.kinney@intel.com > > <mailto:michael.d.kinney@intel.com>>; 'Gao, Liming' > > <liming.gao@intel.com <mailto:liming.gao@intel.com>>; Liu, Zhiguang > > <zhiguang.liu@intel.com <mailto:zhiguang.liu@intel.com>>; Wang, > Jian J > > <jian.j.wang@intel.com <mailto:jian.j.wang@intel.com>>; Gao, > Zhichao > > <zhichao.gao@intel.com <mailto:zhichao.gao@intel.com>> > > *Subject:* RE: [edk2-devel] RFC: Add BaseLib/QuickSort in MdePkg > > > > Just to double confirm, will we have the null instance of > QuickSort in > > MdePkg? > > > > Regards, > > > > Amy > > > > *From:*gaoliming <gaoliming@byosoft.com.cn > > <mailto:gaoliming@byosoft.com.cn>> > > *Sent:* Thursday, September 16, 2021 10:23 AM > > *To:* 'Andrew Fish' <afish@apple.com <mailto:afish@apple.com>>; > > 'edk2-devel-groups-io' <devel@edk2.groups.io > > <mailto:devel@edk2.groups.io>> > > *Cc:* Ni, Ray <ray.ni@intel.com <mailto:ray.ni@intel.com>>; Kinney, > > Michael D <michael.d.kinney@intel.com > > <mailto:michael.d.kinney@intel.com>>; 'Gao, Liming' > > <liming.gao@intel.com <mailto:liming.gao@intel.com>>; Liu, Zhiguang > > <zhiguang.liu@intel.com <mailto:zhiguang.liu@intel.com>>; Wang, > Jian J > > <jian.j.wang@intel.com <mailto:jian.j.wang@intel.com>>; Gao, > Zhichao > > <zhichao.gao@intel.com <mailto:zhichao.gao@intel.com>>; Chan, Amy > > <amy.chan@intel.com <mailto:amy.chan@intel.com>> > > *Subject:* 回复: [edk2-devel] RFC: Add BaseLib/QuickSort in MdePkg > > > > Andrew: > > > > Thanks for your suggestion. I think your idea is better. We add new > > QuickSort() API to BaseLib, and update SortLib library instance to > > consume BaseLib QuickSort() API. This way has no change in current > > SortLib library class. It is the compatible solution. > > > > Thanks > > > > Liming > > > > *发件人**:*Andrew Fish <afish@apple.com <mailto:afish@apple.com>> > > *发送时间:* 2021年9月16日 10:13 > > *收件人:* edk2-devel-groups-io <devel@edk2.groups.io > > <mailto:devel@edk2.groups.io>>; Liming Gao > <gaoliming@byosoft.com.cn > > <mailto:gaoliming@byosoft.com.cn>> > > *抄送:* Ni, Ray <ray.ni@intel.com <mailto:ray.ni@intel.com>>; Mike > > Kinney <michael.d.kinney@intel.com > > <mailto:michael.d.kinney@intel.com>>; Gao, Liming > > <liming.gao@intel.com <mailto:liming.gao@intel.com>>; Liu, Zhiguang > > <zhiguang.liu@intel.com <mailto:zhiguang.liu@intel.com>>; Wang, > Jian J > > <jian.j.wang@intel.com <mailto:jian.j.wang@intel.com>>; Gao, > Zhichao > > <zhichao.gao@intel.com <mailto:zhichao.gao@intel.com>>; Chan, Amy > > <amy.chan@intel.com <mailto:amy.chan@intel.com>> > > *主题:* Re: [edk2-devel] RFC: Add BaseLib/QuickSort in MdePkg > > > > On Sep 15, 2021, at 6:26 PM, gaoliming <gaoliming@byosoft.com.cn > > <mailto:gaoliming@byosoft.com.cn>> wrote: > > > > Ray: > > > > SortLib has been added since 2015. I would suggest to still keep > > this library class. To resolve the package dependency, my > proposal > > is to move the library class header file SortLib.h from > > MdeModulePkg to MdePkg, and still keep the library instance in > > MdeModulePkg. This proposal has no impact on the existing > platform. > > > > If we add QuickSort() API to the BaseLib can we not just port the > > existing MdeModulePkg/SortLib to use QuickSort() in the > > implementation? Or is there some other way to add the new thing > in a > > backward compatible way. > > > > Thanks, > > > > Andrew Fish > > > > Thanks > > > > Liming > > > > *发件人**:*devel@edk2.groups.io > > <mailto:devel@edk2.groups.io><devel@edk2.groups.io > > <mailto:devel@edk2.groups.io>>*代表***Ni, Ray > > *发送时间:*2021年9月14日14:15 > > *收件人:*Kinney, Michael D <michael.d.kinney@intel.com > > <mailto:michael.d.kinney@intel.com>>; Gao, Liming > > <liming.gao@intel.com <mailto:liming.gao@intel.com>>; Liu, > > Zhiguang <zhiguang.liu@intel.com > <mailto:zhiguang.liu@intel.com>>; > > Wang, Jian J <jian.j.wang@intel.com > > <mailto:jian.j.wang@intel.com>>; Gao, Zhichao > > <zhichao.gao@intel.com <mailto:zhichao.gao@intel.com>> > > *抄送:*devel@edk2.groups.io <mailto:devel@edk2.groups.io>; > Chan, Amy > > <amy.chan@intel.com <mailto:amy.chan@intel.com>> > > *主题:*[edk2-devel] RFC: Add BaseLib/QuickSort in MdePkg > > > > Hi package maintainers of MdePkg, MdeModulePkg and ShellPkg, > > community, > > > > A commit (UefiCpuPkg/CpuCacheInfoLib: Sort CpuCacheInfo array > > > <https://github.com/tianocore/edk2/commit/4de77ae9890d241271f543e9195ab3516f3abec6>) > > to UefiCpuPkg let > > UefiCpuPkg depend on MdeModulePkg because the SortLib class and > > instances are all in MdeModulePkg. > > > > UefiCpuPkg depending on MdeModulePkg breaks the rule that > > “UefiCpuPkg should ONLY depend on MdePkg”. > > > > To address this issue, there are two approaches: > > > > 1. Duplicate the sort logic in UefiCpuPkg to not depend on > > MdeModulePkg/SortLib > > 2. Add QuickSort() API to BaseLib in MdePkg. > > > > Approach #2 (MdePkg/BaseLib/QuickSort) makes more sense because > > quick sort is a standard algorithm. > > > > We encourage consumers to update their code to use the quick > sort > > in MdePkg and gradually deprecate today’s MdeModulePkg/SortLib. > > > > If you don’t have concerns, I plan to: > > > > 1. “Add QuickSort() to BaseLib” and update all existing > consumers > > to use this API instead. > > > > VOID > > > > EFIAPI > > > > QuickSort ( > > > > IN OUT VOID *BufferToSort, > > > > IN CONST UINTN Count, > > > > IN CONST UINTN ElementSize, > > > > IN SORT_COMPARE CompareFunction > > > > ); > > > > 2. “Add new ShellPkg/SortCompareLib” > > > > Background: ShellPkg requires to sort devicepath/string so 3 > APIs > > in UefiSortLib (DevicePathCompare, StringNoCaseCompare, > > StringCompare) are provided for Shell usage. we can move the 3 > > APIs to the SortCompareLib and update Shell code to use > > BaseLib/QuickSort directly, with the sort compare function from > > SortCompareLib. > > > > Any concerns? > > > > Thanks, > > > > Ray > > > > > > [-- Attachment #2: Type: text/html, Size: 40805 bytes --] ^ permalink raw reply [flat|nested] 21+ messages in thread
* Re: [edk2-devel] RFC: Add BaseLib/QuickSort in MdePkg 2021-09-27 8:50 ` Jeff Fan @ 2021-09-27 9:09 ` Marvin Häuser 2021-09-28 1:49 ` Ni, Ray 0 siblings, 1 reply; 21+ messages in thread From: Marvin Häuser @ 2021-09-27 9:09 UTC (permalink / raw) To: fanjianfeng@byosoft.com.cn, devel@edk2.groups.io, Ni, Ray, 'gaoliming', Chan, Amy, 'Andrew Fish' Cc: Kinney, Michael D, 'Gao, Liming', Liu, Zhiguang, Wang, Jian J, Gao, Zhichao On 27/09/2021 10:50, fanjianfeng@byosoft.com.cn wrote: > For former caller, they could still keep as is to call the old API in > MdeModulePkg. I think Ray's design is compatible change for existing code. > Only when the existing code wants to remove the dependency on > MdeModuelPkg, they could migrate to the new API in baselib. > > I agree with one split-API desgin what you mentioned. > But my point is to define one API in baselib and to make the baselib > not depend on memory allocation. And another wrapper API could be > designed to be placed in any other class. Oh sure, it could totally live in another class. I'd just like to have those two models (caller- and callee-owned buffer) strictly separate, I personally do not mind where exactly they are implemented. Thanks! Best regards, Marvin > > ------------------------------------------------------------------------ > Jeff > fanjianfeng@byosoft.com.cn > > *From:* Marvin Häuser <mailto:mhaeuser@posteo.de> > *Date:* 2021-09-27 16:14 > *To:* fanjianfeng@byosoft.com.cn > <mailto:fanjianfeng@byosoft.com.cn>; devel@edk2.groups.io > <mailto:devel@edk2.groups.io>; Ni, Ray <mailto:ray.ni@intel.com>; > 'gaoliming' <mailto:gaoliming@byosoft.com.cn>; Chan, Amy > <mailto:amy.chan@intel.com>; 'Andrew Fish' <mailto:afish@apple.com> > *CC:* Kinney, Michael D <mailto:michael.d.kinney@intel.com>; 'Gao, > Liming' <mailto:liming.gao@intel.com>; Liu, Zhiguang > <mailto:zhiguang.liu@intel.com>; Wang, Jian J > <mailto:jian.j.wang@intel.com>; Gao, Zhichao > <mailto:zhichao.gao@intel.com> > *Subject:* Re: [edk2-devel] RFC: Add BaseLib/QuickSort in MdePkg > On 27/09/2021 02:45, fanjianfeng@byosoft.com.cn wrote: > > Making baselib implementation depend on MemoryAllocationLib > > (indirectly on Pei Service and gBS), it may prevent > > this base API using at some seneraio. i don't think it's better. > That is why I asked about a split-API scenario, one of which does not > depend on dynamic memory allocation (SetVariable-like) and one does > (wrapper-like). > > Add this parameter and make this parameter is optional, > > 1, when NULL, use the local 256 bytes stack > > 2, if 256 bytes stack is not enough, return RETURE_BUFFER_TOO_SAMLL, > > 3, caller check the return status, to do nothing or to allocate > enough > > buffer for retry > > > > This is just like SetVariable()'s implementation. > Yes, and because that is SetVariable's implementation, we have > library > functions to make it less error-prone and more convenient [1]. As a > matter of fact, we have a (semi-lax) policy in our codebases to avoid > such functions like the plague and use those library wrappers > where-ever > it can make sense. The only super-rare exceptions I can think of are > when we know the size of the element ahead of time. Also > SetVariable has > no arbitrary constraint on when it may work the first time, and > there is > code that will fail when the first return is not EFI_BUFFER_TOO_SMALL. > This solution honestly yields even more problems, because it > introduces > a Status return which was not there before. For common code safety > and > quality policy, this requires the value *must* be retrieved and > checked > in some fashion. So all callers, no matter the prior knowledge of the > element size, now need either a runtime check and handling for a > status > that they (may) know can never be returned, or ASSERTs if the > function > spec really imposes the arbitrary 256 Bytes constraint. Latter > doesn't > really work I think. What if someone wants to sort in SEC and noticed > they only have 64 Bytes on the stack to work with, realistically? Any > code depending on the 256 Byte constraint, passing NULL and not doing > additional handling, would seize to work. Former is too > complicated, see > wrappers. In my opinion, the memory must *either* be fully managed by > the caller *or* the callee (and you may have both in separate > functions, > as I suggested), but not sometimes here, sometimes there. > Best regards, > Marvin > [1] > https://github.com/tianocore/edk2/blob/46b4606ba23498d3d0e66b53e498eb3d5d592586/MdePkg/Library/UefiLib/UefiLib.c#L1309-L1360 > > > > > ------------------------------------------------------------------------ > > Jeff > > fanjianfeng@byosoft.com.cn > > > > *From:* Marvin Häuser <mailto:mhaeuser@posteo.de> > > *Date:* 2021-09-26 19:20 > > *To:* devel <mailto:devel@edk2.groups.io>; ray.ni > > <mailto:ray.ni@intel.com>; gaoliming > > <mailto:gaoliming@byosoft.com.cn>; Chan, Amy > > <mailto:amy.chan@intel.com>; 'Andrew Fish' > <mailto:afish@apple.com> > > *CC:* Kinney, Michael D <mailto:michael.d.kinney@intel.com>; > 'Gao, > > Liming' <mailto:liming.gao@intel.com>; Liu, Zhiguang > > <mailto:zhiguang.liu@intel.com>; Wang, Jian J > > <mailto:jian.j.wang@intel.com>; Gao, Zhichao > > <mailto:zhichao.gao@intel.com> > > *Subject:* Re: [edk2-devel] RFC: Add BaseLib/QuickSort in MdePkg > > Hey Ray, > > In my opinion that spec is too complicated. For some cases it is > > obvious, but I think the last anyone wants to see is a > > (STATIC_)ASSERT > > before most QuickSort calls to ensure the element size > *really* is <= > > 256 Bytes. In my opinion, there are two roads: > > 1) Make the parameter required (I think this is what Liming > > suggested). > > The caller would always need to provide said buffer, and it > can do > > as it > > sees fit - on the stack, in a pool, in a page, who knows. > > 2) Remove the parameter entirely. The library would depend on > > MemoryAllocationLib again, but also would have an > optimisation by > > choosing stack vs pool based on ElementSize. > > Usually I would prefer 2), as it is less prone to caller > errors, but > > considering the low-level nature of edk2, I can totally see the > > point to > > allow the caller to control whether there are dynamic memory > > allocations > > made or not as possible with 1). 2) could technically also be a > > wrapper > > for 1) if you want granular control and convenience/safety > (why not > > actually?). > > Both approaches have the advantage that it is crystal-clear > what the > > caller's job is - to always or to never allocate the buffer. > > Best regards, > > Marvin > > On 26/09/2021 04:24, Ni, Ray wrote: > > > > > > Liming, > > > > > > The purpose of the optional BufferOneElement is to ease > consumer’s > > > life assuming most of the time the element size should be > > smaller than > > > 256. > > > > > > Are you saying that it’s a bit hard to calculate the actual > > value of > > > sizeof (Element) when writing code? > > > > > > I recommend consumer always allocates memory if it’s hard > to judge > > > sizeof (Element) < 256. > > > > > > Searching edk2 code, I can find below code using > PerformQuickSort(): > > > > > > 1. ShellPkg/UefiShellCommandLib: It’s sorting array of > > > (EFI_DEVICE_PATH_PROTOCOL *). > > > 2. UefiCpuPkg/CpuCacheInfoLib: It’s sorting array of > > CPU_CACHE_INFO. > > > 3. MinPlatformPkg/AcpiTables: It’s sorting array of > > EFI_CPU_ID_ORDER_MAP. > > > 4. MdeModulePkg/UefiBootManagerLib: It’s sorting array of > > > EFI_BOOT_MANAGER_LOAD_OPTION. > > > 5. MdeModulePkg/CapsuleApp: It’s sorting array of > (EFI_FILE_INFO *) > > > 6. CryptoPkg/CrtWrapper: It’s sorting array of (unknown > type). > > > 7. RedfishPkg/RedfishCrtLib: It’s sorting array of > (unknown type). > > > > > > For 1~5, it’s easy to know that the size of the element is > smaller > > > than 256. The AllocatePool() can be skipped. > > > > > > Thanks, > > > > > > Ray > > > > > > *From:*gaoliming <gaoliming@byosoft.com.cn> > > > *Sent:* Sunday, September 26, 2021 10:01 AM > > > *To:* Ni, Ray <ray.ni@intel.com>; devel@edk2.groups.io; > Chan, Amy > > > <amy.chan@intel.com>; 'Andrew Fish' <afish@apple.com> > > > *Cc:* Kinney, Michael D <michael.d.kinney@intel.com>; > 'Gao, Liming' > > > <liming.gao@intel.com>; Liu, Zhiguang > <zhiguang.liu@intel.com>; > > Wang, > > > Jian J <jian.j.wang@intel.com>; Gao, Zhichao > <zhichao.gao@intel.com> > > > *Subject:* 回复: [edk2-devel] RFC: Add BaseLib/QuickSort in > MdePkg > > > > > > Ray: > > > > > > I may suggest to always require BufferOneElement. The > consumer code > > > may not know ElementSize. To avoid the error, the consumer > must > > > allocate buffer for BufferOneElement. If so, > BufferOneElement is > > the > > > required parameter. > > > > > > Thanks > > > > > > Liming > > > > > > *发件人**:*Ni, Ray <ray.ni@intel.com > <mailto:ray.ni@intel.com>> > > > *发送时间:* 2021年9月24日 11:53 > > > *收件人:* devel@edk2.groups.io <mailto:devel@edk2.groups.io>; > Ni, > > Ray > > > <ray.ni@intel.com <mailto:ray.ni@intel.com>>; Chan, Amy > > > <amy.chan@intel.com <mailto:amy.chan@intel.com>>; gaoliming > > > <gaoliming@byosoft.com.cn <mailto:gaoliming@byosoft.com.cn>>; > > 'Andrew > > > Fish' <afish@apple.com <mailto:afish@apple.com>> > > > *抄送:* Kinney, Michael D <michael.d.kinney@intel.com > > > <mailto:michael.d.kinney@intel.com>>; 'Gao, Liming' > > > <liming.gao@intel.com <mailto:liming.gao@intel.com>>; Liu, > Zhiguang > > > <zhiguang.liu@intel.com <mailto:zhiguang.liu@intel.com>>; > Wang, > > Jian J > > > <jian.j.wang@intel.com <mailto:jian.j.wang@intel.com>>; Gao, > > Zhichao > > > <zhichao.gao@intel.com <mailto:zhichao.gao@intel.com>> > > > *主题:* RE: [edk2-devel] RFC: Add BaseLib/QuickSort in MdePkg > > > > > > More details on new QuickSort() API: > > > > > > The new API needs to carry additional parameter > “BufferOneElement”. > > > > > > This parameter gives QuickSort() the temporary buffer for > > swapping in > > > sorting. > > > > > > It’s to avoid BaseLib depends on MemoryAllocationLib. > > > > > > … > > > > > > @param [in] BufferOneElement When ElementSize > 256, caller > > needs to > > > provide a buffer whose size > > > equals to ElementSize. It’s > used by > > > QuickSort() for swapping in sorting. > > > > > > When ElementSize <= 256, QuickSort() uses a local stack > 256-byte > > buffer. > > > > > > @retval EFI_INVALID_PARAMETER When (ElementSize > 256) and > > > (BufferOneElement == NULL). > > > > > > … > > > > > > VOID > > > > > > EFIAPI > > > > > > QuickSort ( > > > > > > IN OUT VOID *BufferToSort, > > > > > > IN CONST UINTN ElementCount, > > > > > > IN CONST UINTN ElementSize, > > > > > > IN SORT_COMPARE CompareFunction, > > > > > > IN VOID *BufferOneElement OPTIONAL > > > > > > ); > > > > > > Any comments? > > > > > > *From:*devel@edk2.groups.io <mailto:devel@edk2.groups.io> > > > <devel@edk2.groups.io <mailto:devel@edk2.groups.io>> *On > Behalf Of > > > *Ni, Ray > > > *Sent:* Wednesday, September 22, 2021 2:04 PM > > > *To:* Chan, Amy <amy.chan@intel.com > <mailto:amy.chan@intel.com>>; > > > gaoliming <gaoliming@byosoft.com.cn > > > <mailto:gaoliming@byosoft.com.cn>>; 'Andrew Fish' > <afish@apple.com > > > <mailto:afish@apple.com>>; 'edk2-devel-groups-io' > > > <devel@edk2.groups.io <mailto:devel@edk2.groups.io>> > > > *Cc:* Kinney, Michael D <michael.d.kinney@intel.com > > > <mailto:michael.d.kinney@intel.com>>; 'Gao, Liming' > > > <liming.gao@intel.com <mailto:liming.gao@intel.com>>; Liu, > Zhiguang > > > <zhiguang.liu@intel.com <mailto:zhiguang.liu@intel.com>>; > Wang, > > Jian J > > > <jian.j.wang@intel.com <mailto:jian.j.wang@intel.com>>; Gao, > > Zhichao > > > <zhichao.gao@intel.com <mailto:zhichao.gao@intel.com>> > > > *Subject:* Re: [edk2-devel] RFC: Add BaseLib/QuickSort in > MdePkg > > > > > > I don’t see objection so far. > > > > > > So, the final solution is: > > > > > > 1. Add QuickSort() API to BaseLib in MdePkg. > > > 2. Update existing MdeModulePkg/SortLib to use > QuickSort() in the > > > implementation (proposed by Andrew Fish and Liming Gao) > > > 3. Update UefiCpuPkg to use QuickSortLib to remove improper > > > dependency on MdeModulePkg > > > > > > Thanks, > > > > > > Ray > > > > > > *From:*Ni, Ray > > > *Sent:* Thursday, September 16, 2021 10:48 AM > > > *To:* Chan, Amy <amy.chan@intel.com > <mailto:amy.chan@intel.com>>; > > > gaoliming <gaoliming@byosoft.com.cn > > > <mailto:gaoliming@byosoft.com.cn>>; 'Andrew Fish' > <afish@apple.com > > > <mailto:afish@apple.com>>; 'edk2-devel-groups-io' > > > <devel@edk2.groups.io <mailto:devel@edk2.groups.io>> > > > *Cc:* Kinney, Michael D <michael.d.kinney@intel.com > > > <mailto:michael.d.kinney@intel.com>>; 'Gao, Liming' > > > <liming.gao@intel.com <mailto:liming.gao@intel.com>>; Liu, > Zhiguang > > > <Zhiguang.Liu@intel.com <mailto:Zhiguang.Liu@intel.com>>; > Wang, > > Jian J > > > <jian.j.wang@intel.com <mailto:jian.j.wang@intel.com>>; Gao, > > Zhichao > > > <zhichao.gao@intel.com <mailto:zhichao.gao@intel.com>> > > > *Subject:* RE: [edk2-devel] RFC: Add BaseLib/QuickSort in > MdePkg > > > > > > Amy, > > > > > > No. We only Add QuickSort() function API into BaseLib.h. > > > > > > *From:*Chan, Amy <amy.chan@intel.com > <mailto:amy.chan@intel.com>> > > > *Sent:* Thursday, September 16, 2021 10:46 AM > > > *To:* gaoliming <gaoliming@byosoft.com.cn > > > <mailto:gaoliming@byosoft.com.cn>>; 'Andrew Fish' > <afish@apple.com > > > <mailto:afish@apple.com>>; 'edk2-devel-groups-io' > > > <devel@edk2.groups.io <mailto:devel@edk2.groups.io>> > > > *Cc:* Ni, Ray <ray.ni@intel.com > <mailto:ray.ni@intel.com>>; Kinney, > > > Michael D <michael.d.kinney@intel.com > > > <mailto:michael.d.kinney@intel.com>>; 'Gao, Liming' > > > <liming.gao@intel.com <mailto:liming.gao@intel.com>>; Liu, > Zhiguang > > > <zhiguang.liu@intel.com <mailto:zhiguang.liu@intel.com>>; > Wang, > > Jian J > > > <jian.j.wang@intel.com <mailto:jian.j.wang@intel.com>>; Gao, > > Zhichao > > > <zhichao.gao@intel.com <mailto:zhichao.gao@intel.com>> > > > *Subject:* RE: [edk2-devel] RFC: Add BaseLib/QuickSort in > MdePkg > > > > > > Just to double confirm, will we have the null instance of > > QuickSort in > > > MdePkg? > > > > > > Regards, > > > > > > Amy > > > > > > *From:*gaoliming <gaoliming@byosoft.com.cn > > > <mailto:gaoliming@byosoft.com.cn>> > > > *Sent:* Thursday, September 16, 2021 10:23 AM > > > *To:* 'Andrew Fish' <afish@apple.com > <mailto:afish@apple.com>>; > > > 'edk2-devel-groups-io' <devel@edk2.groups.io > > > <mailto:devel@edk2.groups.io>> > > > *Cc:* Ni, Ray <ray.ni@intel.com > <mailto:ray.ni@intel.com>>; Kinney, > > > Michael D <michael.d.kinney@intel.com > > > <mailto:michael.d.kinney@intel.com>>; 'Gao, Liming' > > > <liming.gao@intel.com <mailto:liming.gao@intel.com>>; Liu, > Zhiguang > > > <zhiguang.liu@intel.com <mailto:zhiguang.liu@intel.com>>; > Wang, > > Jian J > > > <jian.j.wang@intel.com <mailto:jian.j.wang@intel.com>>; Gao, > > Zhichao > > > <zhichao.gao@intel.com <mailto:zhichao.gao@intel.com>>; > Chan, Amy > > > <amy.chan@intel.com <mailto:amy.chan@intel.com>> > > > *Subject:* 回复: [edk2-devel] RFC: Add BaseLib/QuickSort in > MdePkg > > > > > > Andrew: > > > > > > Thanks for your suggestion. I think your idea is better. > We add new > > > QuickSort() API to BaseLib, and update SortLib library > instance to > > > consume BaseLib QuickSort() API. This way has no change in > current > > > SortLib library class. It is the compatible solution. > > > > > > Thanks > > > > > > Liming > > > > > > *发件人**:*Andrew Fish <afish@apple.com > <mailto:afish@apple.com>> > > > *发送时间:* 2021年9月16日 10:13 > > > *收件人:* edk2-devel-groups-io <devel@edk2.groups.io > > > <mailto:devel@edk2.groups.io>>; Liming Gao > > <gaoliming@byosoft.com.cn > > > <mailto:gaoliming@byosoft.com.cn>> > > > *抄送:* Ni, Ray <ray.ni@intel.com > <mailto:ray.ni@intel.com>>; Mike > > > Kinney <michael.d.kinney@intel.com > > > <mailto:michael.d.kinney@intel.com>>; Gao, Liming > > > <liming.gao@intel.com <mailto:liming.gao@intel.com>>; Liu, > Zhiguang > > > <zhiguang.liu@intel.com <mailto:zhiguang.liu@intel.com>>; > Wang, > > Jian J > > > <jian.j.wang@intel.com <mailto:jian.j.wang@intel.com>>; Gao, > > Zhichao > > > <zhichao.gao@intel.com <mailto:zhichao.gao@intel.com>>; > Chan, Amy > > > <amy.chan@intel.com <mailto:amy.chan@intel.com>> > > > *主题:* Re: [edk2-devel] RFC: Add BaseLib/QuickSort in MdePkg > > > > > > On Sep 15, 2021, at 6:26 PM, gaoliming > <gaoliming@byosoft.com.cn > > > <mailto:gaoliming@byosoft.com.cn>> wrote: > > > > > > Ray: > > > > > > SortLib has been added since 2015. I would suggest to > still keep > > > this library class. To resolve the package dependency, my > > proposal > > > is to move the library class header file SortLib.h from > > > MdeModulePkg to MdePkg, and still keep the library > instance in > > > MdeModulePkg. This proposal has no impact on the existing > > platform. > > > > > > If we add QuickSort() API to the BaseLib can we not just > port the > > > existing MdeModulePkg/SortLib to use QuickSort() in the > > > implementation? Or is there some other way to add the new > thing > > in a > > > backward compatible way. > > > > > > Thanks, > > > > > > Andrew Fish > > > > > > Thanks > > > > > > Liming > > > > > > *发件人**:*devel@edk2.groups.io > > > <mailto:devel@edk2.groups.io><devel@edk2.groups.io > > > <mailto:devel@edk2.groups.io>>*代表***Ni, Ray > > > *发送时间:*2021年9月14日14:15 > > > *收件人:*Kinney, Michael D <michael.d.kinney@intel.com > > > <mailto:michael.d.kinney@intel.com>>; Gao, Liming > > > <liming.gao@intel.com <mailto:liming.gao@intel.com>>; Liu, > > > Zhiguang <zhiguang.liu@intel.com > > <mailto:zhiguang.liu@intel.com>>; > > > Wang, Jian J <jian.j.wang@intel.com > > > <mailto:jian.j.wang@intel.com>>; Gao, Zhichao > > > <zhichao.gao@intel.com <mailto:zhichao.gao@intel.com>> > > > *抄送:*devel@edk2.groups.io <mailto:devel@edk2.groups.io>; > > Chan, Amy > > > <amy.chan@intel.com <mailto:amy.chan@intel.com>> > > > *主题:*[edk2-devel] RFC: Add BaseLib/QuickSort in MdePkg > > > > > > Hi package maintainers of MdePkg, MdeModulePkg and > ShellPkg, > > > community, > > > > > > A commit (UefiCpuPkg/CpuCacheInfoLib: Sort > CpuCacheInfo array > > > > > > <https://github.com/tianocore/edk2/commit/4de77ae9890d241271f543e9195ab3516f3abec6>) > > > to UefiCpuPkg let > > > UefiCpuPkg depend on MdeModulePkg because the SortLib > class and > > > instances are all in MdeModulePkg. > > > > > > UefiCpuPkg depending on MdeModulePkg breaks the rule that > > > “UefiCpuPkg should ONLY depend on MdePkg”. > > > > > > To address this issue, there are two approaches: > > > > > > 1. Duplicate the sort logic in UefiCpuPkg to not > depend on > > > MdeModulePkg/SortLib > > > 2. Add QuickSort() API to BaseLib in MdePkg. > > > > > > Approach #2 (MdePkg/BaseLib/QuickSort) makes more > sense because > > > quick sort is a standard algorithm. > > > > > > We encourage consumers to update their code to use the > quick > > sort > > > in MdePkg and gradually deprecate today’s > MdeModulePkg/SortLib. > > > > > > If you don’t have concerns, I plan to: > > > > > > 1. “Add QuickSort() to BaseLib” and update all existing > > consumers > > > to use this API instead. > > > > > > VOID > > > > > > EFIAPI > > > > > > QuickSort ( > > > > > > IN OUT VOID *BufferToSort, > > > > > > IN CONST UINTN Count, > > > > > > IN CONST UINTN ElementSize, > > > > > > IN SORT_COMPARE CompareFunction > > > > > > ); > > > > > > 2. “Add new ShellPkg/SortCompareLib” > > > > > > Background: ShellPkg requires to sort > devicepath/string so 3 > > APIs > > > in UefiSortLib (DevicePathCompare, StringNoCaseCompare, > > > StringCompare) are provided for Shell usage. we can > move the 3 > > > APIs to the SortCompareLib and update Shell code to use > > > BaseLib/QuickSort directly, with the sort compare > function from > > > SortCompareLib. > > > > > > Any concerns? > > > > > > Thanks, > > > > > > Ray > > > > > > > > > > > > ^ permalink raw reply [flat|nested] 21+ messages in thread
* Re: [edk2-devel] RFC: Add BaseLib/QuickSort in MdePkg 2021-09-27 9:09 ` Marvin Häuser @ 2021-09-28 1:49 ` Ni, Ray 2021-09-28 22:25 ` Brian J. Johnson 0 siblings, 1 reply; 21+ messages in thread From: Ni, Ray @ 2021-09-28 1:49 UTC (permalink / raw) To: Marvin Häuser, fanjianfeng@byosoft.com.cn, devel@edk2.groups.io, 'gaoliming', Chan, Amy, 'Andrew Fish' Cc: Kinney, Michael D, 'Gao, Liming', Liu, Zhiguang, Wang, Jian J, Gao, Zhichao Marvin, I agree with your concerns, in a certain level. But I didn't treat it as a very big problem of having caller pass the BufferOneElement "intelligently". I am ok to use your option 1), making BufferOneElement mandatory. Caller should always supply the buffer that's sufficient to hold one element. By the way, I don't want to propose "swap-without-using-temporary-value" method to avoid using the "BufferOneElement"? Because that makes the simple thing complicated! Thanks, Ray > -----Original Message----- > From: Marvin Häuser <mhaeuser@posteo.de> > Sent: Monday, September 27, 2021 5:09 PM > To: fanjianfeng@byosoft.com.cn; devel@edk2.groups.io; Ni, Ray <ray.ni@intel.com>; 'gaoliming' > <gaoliming@byosoft.com.cn>; Chan, Amy <amy.chan@intel.com>; 'Andrew Fish' <afish@apple.com> > Cc: Kinney, Michael D <michael.d.kinney@intel.com>; 'Gao, Liming' <liming.gao@intel.com>; Liu, Zhiguang > <zhiguang.liu@intel.com>; Wang, Jian J <jian.j.wang@intel.com>; Gao, Zhichao <zhichao.gao@intel.com> > Subject: Re: [edk2-devel] RFC: Add BaseLib/QuickSort in MdePkg > > On 27/09/2021 10:50, fanjianfeng@byosoft.com.cn wrote: > > For former caller, they could still keep as is to call the old API in > > MdeModulePkg. I think Ray's design is compatible change for existing code. > > Only when the existing code wants to remove the dependency on > > MdeModuelPkg, they could migrate to the new API in baselib. > > > > I agree with one split-API desgin what you mentioned. > > But my point is to define one API in baselib and to make the baselib > > not depend on memory allocation. And another wrapper API could be > > designed to be placed in any other class. > > Oh sure, it could totally live in another class. I'd just like to have > those two models (caller- and callee-owned buffer) strictly separate, I > personally do not mind where exactly they are implemented. Thanks! > > Best regards, > Marvin > > > > > ------------------------------------------------------------------------ > > Jeff > > fanjianfeng@byosoft.com.cn > > > > *From:* Marvin Häuser <mailto:mhaeuser@posteo.de> > > *Date:* 2021-09-27 16:14 > > *To:* fanjianfeng@byosoft.com.cn > > <mailto:fanjianfeng@byosoft.com.cn>; devel@edk2.groups.io > > <mailto:devel@edk2.groups.io>; Ni, Ray <mailto:ray.ni@intel.com>; > > 'gaoliming' <mailto:gaoliming@byosoft.com.cn>; Chan, Amy > > <mailto:amy.chan@intel.com>; 'Andrew Fish' <mailto:afish@apple.com> > > *CC:* Kinney, Michael D <mailto:michael.d.kinney@intel.com>; 'Gao, > > Liming' <mailto:liming.gao@intel.com>; Liu, Zhiguang > > <mailto:zhiguang.liu@intel.com>; Wang, Jian J > > <mailto:jian.j.wang@intel.com>; Gao, Zhichao > > <mailto:zhichao.gao@intel.com> > > *Subject:* Re: [edk2-devel] RFC: Add BaseLib/QuickSort in MdePkg > > On 27/09/2021 02:45, fanjianfeng@byosoft.com.cn wrote: > > > Making baselib implementation depend on MemoryAllocationLib > > > (indirectly on Pei Service and gBS), it may prevent > > > this base API using at some seneraio. i don't think it's better. > > That is why I asked about a split-API scenario, one of which does not > > depend on dynamic memory allocation (SetVariable-like) and one does > > (wrapper-like). > > > Add this parameter and make this parameter is optional, > > > 1, when NULL, use the local 256 bytes stack > > > 2, if 256 bytes stack is not enough, return RETURE_BUFFER_TOO_SAMLL, > > > 3, caller check the return status, to do nothing or to allocate > > enough > > > buffer for retry > > > > > > This is just like SetVariable()'s implementation. > > Yes, and because that is SetVariable's implementation, we have > > library > > functions to make it less error-prone and more convenient [1]. As a > > matter of fact, we have a (semi-lax) policy in our codebases to avoid > > such functions like the plague and use those library wrappers > > where-ever > > it can make sense. The only super-rare exceptions I can think of are > > when we know the size of the element ahead of time. Also > > SetVariable has > > no arbitrary constraint on when it may work the first time, and > > there is > > code that will fail when the first return is not EFI_BUFFER_TOO_SMALL. > > This solution honestly yields even more problems, because it > > introduces > > a Status return which was not there before. For common code safety > > and > > quality policy, this requires the value *must* be retrieved and > > checked > > in some fashion. So all callers, no matter the prior knowledge of the > > element size, now need either a runtime check and handling for a > > status > > that they (may) know can never be returned, or ASSERTs if the > > function > > spec really imposes the arbitrary 256 Bytes constraint. Latter > > doesn't > > really work I think. What if someone wants to sort in SEC and noticed > > they only have 64 Bytes on the stack to work with, realistically? Any > > code depending on the 256 Byte constraint, passing NULL and not doing > > additional handling, would seize to work. Former is too > > complicated, see > > wrappers. In my opinion, the memory must *either* be fully managed by > > the caller *or* the callee (and you may have both in separate > > functions, > > as I suggested), but not sometimes here, sometimes there. > > Best regards, > > Marvin > > [1] > > > https://github.com/tianocore/edk2/blob/46b4606ba23498d3d0e66b53e498eb3d5d592586/MdePkg/Library/UefiLib/UefiLib.c#L > 1309-L1360 > > > > > > > > ------------------------------------------------------------------------ > > > Jeff > > > fanjianfeng@byosoft.com.cn > > > > > > *From:* Marvin Häuser <mailto:mhaeuser@posteo.de> > > > *Date:* 2021-09-26 19:20 > > > *To:* devel <mailto:devel@edk2.groups.io>; ray.ni > > > <mailto:ray.ni@intel.com>; gaoliming > > > <mailto:gaoliming@byosoft.com.cn>; Chan, Amy > > > <mailto:amy.chan@intel.com>; 'Andrew Fish' > > <mailto:afish@apple.com> > > > *CC:* Kinney, Michael D <mailto:michael.d.kinney@intel.com>; > > 'Gao, > > > Liming' <mailto:liming.gao@intel.com>; Liu, Zhiguang > > > <mailto:zhiguang.liu@intel.com>; Wang, Jian J > > > <mailto:jian.j.wang@intel.com>; Gao, Zhichao > > > <mailto:zhichao.gao@intel.com> > > > *Subject:* Re: [edk2-devel] RFC: Add BaseLib/QuickSort in MdePkg > > > Hey Ray, > > > In my opinion that spec is too complicated. For some cases it is > > > obvious, but I think the last anyone wants to see is a > > > (STATIC_)ASSERT > > > before most QuickSort calls to ensure the element size > > *really* is <= > > > 256 Bytes. In my opinion, there are two roads: > > > 1) Make the parameter required (I think this is what Liming > > > suggested). > > > The caller would always need to provide said buffer, and it > > can do > > > as it > > > sees fit - on the stack, in a pool, in a page, who knows. > > > 2) Remove the parameter entirely. The library would depend on > > > MemoryAllocationLib again, but also would have an > > optimisation by > > > choosing stack vs pool based on ElementSize. > > > Usually I would prefer 2), as it is less prone to caller > > errors, but > > > considering the low-level nature of edk2, I can totally see the > > > point to > > > allow the caller to control whether there are dynamic memory > > > allocations > > > made or not as possible with 1). 2) could technically also be a > > > wrapper > > > for 1) if you want granular control and convenience/safety > > (why not > > > actually?). > > > Both approaches have the advantage that it is crystal-clear > > what the > > > caller's job is - to always or to never allocate the buffer. > > > Best regards, > > > Marvin > > > On 26/09/2021 04:24, Ni, Ray wrote: > > > > > > > > Liming, > > > > > > > > The purpose of the optional BufferOneElement is to ease > > consumer’s > > > > life assuming most of the time the element size should be > > > smaller than > > > > 256. > > > > > > > > Are you saying that it’s a bit hard to calculate the actual > > > value of > > > > sizeof (Element) when writing code? > > > > > > > > I recommend consumer always allocates memory if it’s hard > > to judge > > > > sizeof (Element) < 256. > > > > > > > > Searching edk2 code, I can find below code using > > PerformQuickSort(): > > > > > > > > 1. ShellPkg/UefiShellCommandLib: It’s sorting array of > > > > (EFI_DEVICE_PATH_PROTOCOL *). > > > > 2. UefiCpuPkg/CpuCacheInfoLib: It’s sorting array of > > > CPU_CACHE_INFO. > > > > 3. MinPlatformPkg/AcpiTables: It’s sorting array of > > > EFI_CPU_ID_ORDER_MAP. > > > > 4. MdeModulePkg/UefiBootManagerLib: It’s sorting array of > > > > EFI_BOOT_MANAGER_LOAD_OPTION. > > > > 5. MdeModulePkg/CapsuleApp: It’s sorting array of > > (EFI_FILE_INFO *) > > > > 6. CryptoPkg/CrtWrapper: It’s sorting array of (unknown > > type). > > > > 7. RedfishPkg/RedfishCrtLib: It’s sorting array of > > (unknown type). > > > > > > > > For 1~5, it’s easy to know that the size of the element is > > smaller > > > > than 256. The AllocatePool() can be skipped. > > > > > > > > Thanks, > > > > > > > > Ray > > > > > > > > *From:*gaoliming <gaoliming@byosoft.com.cn> > > > > *Sent:* Sunday, September 26, 2021 10:01 AM > > > > *To:* Ni, Ray <ray.ni@intel.com>; devel@edk2.groups.io; > > Chan, Amy > > > > <amy.chan@intel.com>; 'Andrew Fish' <afish@apple.com> > > > > *Cc:* Kinney, Michael D <michael.d.kinney@intel.com>; > > 'Gao, Liming' > > > > <liming.gao@intel.com>; Liu, Zhiguang > > <zhiguang.liu@intel.com>; > > > Wang, > > > > Jian J <jian.j.wang@intel.com>; Gao, Zhichao > > <zhichao.gao@intel.com> > > > > *Subject:* 回复: [edk2-devel] RFC: Add BaseLib/QuickSort in > > MdePkg > > > > > > > > Ray: > > > > > > > > I may suggest to always require BufferOneElement. The > > consumer code > > > > may not know ElementSize. To avoid the error, the consumer > > must > > > > allocate buffer for BufferOneElement. If so, > > BufferOneElement is > > > the > > > > required parameter. > > > > > > > > Thanks > > > > > > > > Liming > > > > > > > > *发件人**:*Ni, Ray <ray.ni@intel.com > > <mailto:ray.ni@intel.com>> > > > > *发送时间:* 2021年9月24日 11:53 > > > > *收件人:* devel@edk2.groups.io <mailto:devel@edk2.groups.io>; > > Ni, > > > Ray > > > > <ray.ni@intel.com <mailto:ray.ni@intel.com>>; Chan, Amy > > > > <amy.chan@intel.com <mailto:amy.chan@intel.com>>; gaoliming > > > > <gaoliming@byosoft.com.cn <mailto:gaoliming@byosoft.com.cn>>; > > > 'Andrew > > > > Fish' <afish@apple.com <mailto:afish@apple.com>> > > > > *抄送:* Kinney, Michael D <michael.d.kinney@intel.com > > > > <mailto:michael.d.kinney@intel.com>>; 'Gao, Liming' > > > > <liming.gao@intel.com <mailto:liming.gao@intel.com>>; Liu, > > Zhiguang > > > > <zhiguang.liu@intel.com <mailto:zhiguang.liu@intel.com>>; > > Wang, > > > Jian J > > > > <jian.j.wang@intel.com <mailto:jian.j.wang@intel.com>>; Gao, > > > Zhichao > > > > <zhichao.gao@intel.com <mailto:zhichao.gao@intel.com>> > > > > *主题:* RE: [edk2-devel] RFC: Add BaseLib/QuickSort in MdePkg > > > > > > > > More details on new QuickSort() API: > > > > > > > > The new API needs to carry additional parameter > > “BufferOneElement”. > > > > > > > > This parameter gives QuickSort() the temporary buffer for > > > swapping in > > > > sorting. > > > > > > > > It’s to avoid BaseLib depends on MemoryAllocationLib. > > > > > > > > … > > > > > > > > @param [in] BufferOneElement When ElementSize > 256, caller > > > needs to > > > > provide a buffer whose size > > > > equals to ElementSize. It’s > > used by > > > > QuickSort() for swapping in sorting. > > > > > > > > When ElementSize <= 256, QuickSort() uses a local stack > > 256-byte > > > buffer. > > > > > > > > @retval EFI_INVALID_PARAMETER When (ElementSize > 256) and > > > > (BufferOneElement == NULL). > > > > > > > > … > > > > > > > > VOID > > > > > > > > EFIAPI > > > > > > > > QuickSort ( > > > > > > > > IN OUT VOID *BufferToSort, > > > > > > > > IN CONST UINTN ElementCount, > > > > > > > > IN CONST UINTN ElementSize, > > > > > > > > IN SORT_COMPARE CompareFunction, > > > > > > > > IN VOID *BufferOneElement OPTIONAL > > > > > > > > ); > > > > > > > > Any comments? > > > > > > > > *From:*devel@edk2.groups.io <mailto:devel@edk2.groups.io> > > > > <devel@edk2.groups.io <mailto:devel@edk2.groups.io>> *On > > Behalf Of > > > > *Ni, Ray > > > > *Sent:* Wednesday, September 22, 2021 2:04 PM > > > > *To:* Chan, Amy <amy.chan@intel.com > > <mailto:amy.chan@intel.com>>; > > > > gaoliming <gaoliming@byosoft.com.cn > > > > <mailto:gaoliming@byosoft.com.cn>>; 'Andrew Fish' > > <afish@apple.com > > > > <mailto:afish@apple.com>>; 'edk2-devel-groups-io' > > > > <devel@edk2.groups.io <mailto:devel@edk2.groups.io>> > > > > *Cc:* Kinney, Michael D <michael.d.kinney@intel.com > > > > <mailto:michael.d.kinney@intel.com>>; 'Gao, Liming' > > > > <liming.gao@intel.com <mailto:liming.gao@intel.com>>; Liu, > > Zhiguang > > > > <zhiguang.liu@intel.com <mailto:zhiguang.liu@intel.com>>; > > Wang, > > > Jian J > > > > <jian.j.wang@intel.com <mailto:jian.j.wang@intel.com>>; Gao, > > > Zhichao > > > > <zhichao.gao@intel.com <mailto:zhichao.gao@intel.com>> > > > > *Subject:* Re: [edk2-devel] RFC: Add BaseLib/QuickSort in > > MdePkg > > > > > > > > I don’t see objection so far. > > > > > > > > So, the final solution is: > > > > > > > > 1. Add QuickSort() API to BaseLib in MdePkg. > > > > 2. Update existing MdeModulePkg/SortLib to use > > QuickSort() in the > > > > implementation (proposed by Andrew Fish and Liming Gao) > > > > 3. Update UefiCpuPkg to use QuickSortLib to remove improper > > > > dependency on MdeModulePkg > > > > > > > > Thanks, > > > > > > > > Ray > > > > > > > > *From:*Ni, Ray > > > > *Sent:* Thursday, September 16, 2021 10:48 AM > > > > *To:* Chan, Amy <amy.chan@intel.com > > <mailto:amy.chan@intel.com>>; > > > > gaoliming <gaoliming@byosoft.com.cn > > > > <mailto:gaoliming@byosoft.com.cn>>; 'Andrew Fish' > > <afish@apple.com > > > > <mailto:afish@apple.com>>; 'edk2-devel-groups-io' > > > > <devel@edk2.groups.io <mailto:devel@edk2.groups.io>> > > > > *Cc:* Kinney, Michael D <michael.d.kinney@intel.com > > > > <mailto:michael.d.kinney@intel.com>>; 'Gao, Liming' > > > > <liming.gao@intel.com <mailto:liming.gao@intel.com>>; Liu, > > Zhiguang > > > > <Zhiguang.Liu@intel.com <mailto:Zhiguang.Liu@intel.com>>; > > Wang, > > > Jian J > > > > <jian.j.wang@intel.com <mailto:jian.j.wang@intel.com>>; Gao, > > > Zhichao > > > > <zhichao.gao@intel.com <mailto:zhichao.gao@intel.com>> > > > > *Subject:* RE: [edk2-devel] RFC: Add BaseLib/QuickSort in > > MdePkg > > > > > > > > Amy, > > > > > > > > No. We only Add QuickSort() function API into BaseLib.h. > > > > > > > > *From:*Chan, Amy <amy.chan@intel.com > > <mailto:amy.chan@intel.com>> > > > > *Sent:* Thursday, September 16, 2021 10:46 AM > > > > *To:* gaoliming <gaoliming@byosoft.com.cn > > > > <mailto:gaoliming@byosoft.com.cn>>; 'Andrew Fish' > > <afish@apple.com > > > > <mailto:afish@apple.com>>; 'edk2-devel-groups-io' > > > > <devel@edk2.groups.io <mailto:devel@edk2.groups.io>> > > > > *Cc:* Ni, Ray <ray.ni@intel.com > > <mailto:ray.ni@intel.com>>; Kinney, > > > > Michael D <michael.d.kinney@intel.com > > > > <mailto:michael.d.kinney@intel.com>>; 'Gao, Liming' > > > > <liming.gao@intel.com <mailto:liming.gao@intel.com>>; Liu, > > Zhiguang > > > > <zhiguang.liu@intel.com <mailto:zhiguang.liu@intel.com>>; > > Wang, > > > Jian J > > > > <jian.j.wang@intel.com <mailto:jian.j.wang@intel.com>>; Gao, > > > Zhichao > > > > <zhichao.gao@intel.com <mailto:zhichao.gao@intel.com>> > > > > *Subject:* RE: [edk2-devel] RFC: Add BaseLib/QuickSort in > > MdePkg > > > > > > > > Just to double confirm, will we have the null instance of > > > QuickSort in > > > > MdePkg? > > > > > > > > Regards, > > > > > > > > Amy > > > > > > > > *From:*gaoliming <gaoliming@byosoft.com.cn > > > > <mailto:gaoliming@byosoft.com.cn>> > > > > *Sent:* Thursday, September 16, 2021 10:23 AM > > > > *To:* 'Andrew Fish' <afish@apple.com > > <mailto:afish@apple.com>>; > > > > 'edk2-devel-groups-io' <devel@edk2.groups.io > > > > <mailto:devel@edk2.groups.io>> > > > > *Cc:* Ni, Ray <ray.ni@intel.com > > <mailto:ray.ni@intel.com>>; Kinney, > > > > Michael D <michael.d.kinney@intel.com > > > > <mailto:michael.d.kinney@intel.com>>; 'Gao, Liming' > > > > <liming.gao@intel.com <mailto:liming.gao@intel.com>>; Liu, > > Zhiguang > > > > <zhiguang.liu@intel.com <mailto:zhiguang.liu@intel.com>>; > > Wang, > > > Jian J > > > > <jian.j.wang@intel.com <mailto:jian.j.wang@intel.com>>; Gao, > > > Zhichao > > > > <zhichao.gao@intel.com <mailto:zhichao.gao@intel.com>>; > > Chan, Amy > > > > <amy.chan@intel.com <mailto:amy.chan@intel.com>> > > > > *Subject:* 回复: [edk2-devel] RFC: Add BaseLib/QuickSort in > > MdePkg > > > > > > > > Andrew: > > > > > > > > Thanks for your suggestion. I think your idea is better. > > We add new > > > > QuickSort() API to BaseLib, and update SortLib library > > instance to > > > > consume BaseLib QuickSort() API. This way has no change in > > current > > > > SortLib library class. It is the compatible solution. > > > > > > > > Thanks > > > > > > > > Liming > > > > > > > > *发件人**:*Andrew Fish <afish@apple.com > > <mailto:afish@apple.com>> > > > > *发送时间:* 2021年9月16日 10:13 > > > > *收件人:* edk2-devel-groups-io <devel@edk2.groups.io > > > > <mailto:devel@edk2.groups.io>>; Liming Gao > > > <gaoliming@byosoft.com.cn > > > > <mailto:gaoliming@byosoft.com.cn>> > > > > *抄送:* Ni, Ray <ray.ni@intel.com > > <mailto:ray.ni@intel.com>>; Mike > > > > Kinney <michael.d.kinney@intel.com > > > > <mailto:michael.d.kinney@intel.com>>; Gao, Liming > > > > <liming.gao@intel.com <mailto:liming.gao@intel.com>>; Liu, > > Zhiguang > > > > <zhiguang.liu@intel.com <mailto:zhiguang.liu@intel.com>>; > > Wang, > > > Jian J > > > > <jian.j.wang@intel.com <mailto:jian.j.wang@intel.com>>; Gao, > > > Zhichao > > > > <zhichao.gao@intel.com <mailto:zhichao.gao@intel.com>>; > > Chan, Amy > > > > <amy.chan@intel.com <mailto:amy.chan@intel.com>> > > > > *主题:* Re: [edk2-devel] RFC: Add BaseLib/QuickSort in MdePkg > > > > > > > > On Sep 15, 2021, at 6:26 PM, gaoliming > > <gaoliming@byosoft.com.cn > > > > <mailto:gaoliming@byosoft.com.cn>> wrote: > > > > > > > > Ray: > > > > > > > > SortLib has been added since 2015. I would suggest to > > still keep > > > > this library class. To resolve the package dependency, my > > > proposal > > > > is to move the library class header file SortLib.h from > > > > MdeModulePkg to MdePkg, and still keep the library > > instance in > > > > MdeModulePkg. This proposal has no impact on the existing > > > platform. > > > > > > > > If we add QuickSort() API to the BaseLib can we not just > > port the > > > > existing MdeModulePkg/SortLib to use QuickSort() in the > > > > implementation? Or is there some other way to add the new > > thing > > > in a > > > > backward compatible way. > > > > > > > > Thanks, > > > > > > > > Andrew Fish > > > > > > > > Thanks > > > > > > > > Liming > > > > > > > > *发件人**:*devel@edk2.groups.io > > > > <mailto:devel@edk2.groups.io><devel@edk2.groups.io > > > > <mailto:devel@edk2.groups.io>>*代表***Ni, Ray > > > > *发送时间:*2021年9月14日14:15 > > > > *收件人:*Kinney, Michael D <michael.d.kinney@intel.com > > > > <mailto:michael.d.kinney@intel.com>>; Gao, Liming > > > > <liming.gao@intel.com <mailto:liming.gao@intel.com>>; Liu, > > > > Zhiguang <zhiguang.liu@intel.com > > > <mailto:zhiguang.liu@intel.com>>; > > > > Wang, Jian J <jian.j.wang@intel.com > > > > <mailto:jian.j.wang@intel.com>>; Gao, Zhichao > > > > <zhichao.gao@intel.com <mailto:zhichao.gao@intel.com>> > > > > *抄送:*devel@edk2.groups.io <mailto:devel@edk2.groups.io>; > > > Chan, Amy > > > > <amy.chan@intel.com <mailto:amy.chan@intel.com>> > > > > *主题:*[edk2-devel] RFC: Add BaseLib/QuickSort in MdePkg > > > > > > > > Hi package maintainers of MdePkg, MdeModulePkg and > > ShellPkg, > > > > community, > > > > > > > > A commit (UefiCpuPkg/CpuCacheInfoLib: Sort > > CpuCacheInfo array > > > > > > > > > <https://github.com/tianocore/edk2/commit/4de77ae9890d241271f543e9195ab3516f3abec6>) > > > > to UefiCpuPkg let > > > > UefiCpuPkg depend on MdeModulePkg because the SortLib > > class and > > > > instances are all in MdeModulePkg. > > > > > > > > UefiCpuPkg depending on MdeModulePkg breaks the rule that > > > > “UefiCpuPkg should ONLY depend on MdePkg”. > > > > > > > > To address this issue, there are two approaches: > > > > > > > > 1. Duplicate the sort logic in UefiCpuPkg to not > > depend on > > > > MdeModulePkg/SortLib > > > > 2. Add QuickSort() API to BaseLib in MdePkg. > > > > > > > > Approach #2 (MdePkg/BaseLib/QuickSort) makes more > > sense because > > > > quick sort is a standard algorithm. > > > > > > > > We encourage consumers to update their code to use the > > quick > > > sort > > > > in MdePkg and gradually deprecate today’s > > MdeModulePkg/SortLib. > > > > > > > > If you don’t have concerns, I plan to: > > > > > > > > 1. “Add QuickSort() to BaseLib” and update all existing > > > consumers > > > > to use this API instead. > > > > > > > > VOID > > > > > > > > EFIAPI > > > > > > > > QuickSort ( > > > > > > > > IN OUT VOID *BufferToSort, > > > > > > > > IN CONST UINTN Count, > > > > > > > > IN CONST UINTN ElementSize, > > > > > > > > IN SORT_COMPARE CompareFunction > > > > > > > > ); > > > > > > > > 2. “Add new ShellPkg/SortCompareLib” > > > > > > > > Background: ShellPkg requires to sort > > devicepath/string so 3 > > > APIs > > > > in UefiSortLib (DevicePathCompare, StringNoCaseCompare, > > > > StringCompare) are provided for Shell usage. we can > > move the 3 > > > > APIs to the SortCompareLib and update Shell code to use > > > > BaseLib/QuickSort directly, with the sort compare > > function from > > > > SortCompareLib. > > > > > > > > Any concerns? > > > > > > > > Thanks, > > > > > > > > Ray > > > > > > > > > > > > > > > > > > ^ permalink raw reply [flat|nested] 21+ messages in thread
* Re: [edk2-devel] RFC: Add BaseLib/QuickSort in MdePkg 2021-09-28 1:49 ` Ni, Ray @ 2021-09-28 22:25 ` Brian J. Johnson 2021-09-29 0:51 ` 回复: " gaoliming 0 siblings, 1 reply; 21+ messages in thread From: Brian J. Johnson @ 2021-09-28 22:25 UTC (permalink / raw) To: devel, ray.ni, Marvin Häuser, fanjianfeng@byosoft.com.cn, 'gaoliming', Chan, Amy, 'Andrew Fish' Cc: Kinney, Michael D, 'Gao, Liming', Liu, Zhiguang, Wang, Jian J, Gao, Zhichao I'll add my agreement to Marvin and Jeff: a low-level sort routine like this should let the caller be in charge of memory allocation, so it can be used in the widest variety of contexts (SEC, exception handlers, APs, etc.) So let's make the BufferOneElement parameter mandatory. Brian J. Johnson -------- Original Message -------- From: Ni, Ray [mailto:ray.ni@intel.com] Sent: Monday, September 27, 2021, 8:49 PM To: Marvin Häuser <mhaeuser@posteo.de>, fanjianfeng@byosoft.com.cn <fanjianfeng@byosoft.com.cn>, devel@edk2.groups.io <devel@edk2.groups.io>, 'gaoliming' <gaoliming@byosoft.com.cn>, Chan, Amy <amy.chan@intel.com>, 'Andrew Fish' <afish@apple.com> Cc: Kinney, Michael D <michael.d.kinney@intel.com>, 'Gao, Liming' <liming.gao@intel.com>, Liu, Zhiguang <zhiguang.liu@intel.com>, Wang, Jian J <jian.j.wang@intel.com>, Gao, Zhichao <zhichao.gao@intel.com> Subject: [edk2-devel] RFC: Add BaseLib/QuickSort in MdePkg Marvin, I agree with your concerns, in a certain level. But I didn't treat it as a very big problem of having caller pass the BufferOneElement "intelligently". I am ok to use your option 1), making BufferOneElement mandatory. Caller should always supply the buffer that's sufficient to hold one element. By the way, I don't want to propose "swap-without-using-temporary-value" method to avoid using the "BufferOneElement"? Because that makes the simple thing complicated! Thanks, Ray > -----Original Message----- > From: Marvin Häuser <mhaeuser@posteo.de> > Sent: Monday, September 27, 2021 5:09 PM > To: fanjianfeng@byosoft.com.cn; devel@edk2.groups.io; Ni, Ray <ray.ni@intel.com>; 'gaoliming' > <gaoliming@byosoft.com.cn>; Chan, Amy <amy.chan@intel.com>; 'Andrew Fish' <afish@apple.com> > Cc: Kinney, Michael D <michael.d.kinney@intel.com>; 'Gao, Liming' <liming.gao@intel.com>; Liu, Zhiguang > <zhiguang.liu@intel.com>; Wang, Jian J <jian.j.wang@intel.com>; Gao, Zhichao <zhichao.gao@intel.com> > Subject: Re: [edk2-devel] RFC: Add BaseLib/QuickSort in MdePkg > > On 27/09/2021 10:50, fanjianfeng@byosoft.com.cn wrote: >> For former caller, they could still keep as is to call the old API in >> MdeModulePkg. I think Ray's design is compatible change for existing code. >> Only when the existing code wants to remove the dependency on >> MdeModuelPkg, they could migrate to the new API in baselib. >> >> I agree with one split-API desgin what you mentioned. >> But my point is to define one API in baselib and to make the baselib >> not depend on memory allocation. And another wrapper API could be >> designed to be placed in any other class. > > Oh sure, it could totally live in another class. I'd just like to have > those two models (caller- and callee-owned buffer) strictly separate, I > personally do not mind where exactly they are implemented. Thanks! > > Best regards, > Marvin > >> >> ------------------------------------------------------------------------ >> Jeff >> fanjianfeng@byosoft.com.cn >> >> *From:* Marvin Häuser <mailto:mhaeuser@posteo.de> >> *Date:* 2021-09-27 16:14 >> *To:* fanjianfeng@byosoft.com.cn >> <mailto:fanjianfeng@byosoft.com.cn>; devel@edk2.groups.io >> <mailto:devel@edk2.groups.io>; Ni, Ray <mailto:ray.ni@intel.com>; >> 'gaoliming' <mailto:gaoliming@byosoft.com.cn>; Chan, Amy >> <mailto:amy.chan@intel.com>; 'Andrew Fish' <mailto:afish@apple.com> >> *CC:* Kinney, Michael D <mailto:michael.d.kinney@intel.com>; 'Gao, >> Liming' <mailto:liming.gao@intel.com>; Liu, Zhiguang >> <mailto:zhiguang.liu@intel.com>; Wang, Jian J >> <mailto:jian.j.wang@intel.com>; Gao, Zhichao >> <mailto:zhichao.gao@intel.com> >> *Subject:* Re: [edk2-devel] RFC: Add BaseLib/QuickSort in MdePkg >> On 27/09/2021 02:45, fanjianfeng@byosoft.com.cn wrote: >> > Making baselib implementation depend on MemoryAllocationLib >> > (indirectly on Pei Service and gBS), it may prevent >> > this base API using at some seneraio. i don't think it's better. >> That is why I asked about a split-API scenario, one of which does not >> depend on dynamic memory allocation (SetVariable-like) and one does >> (wrapper-like). >> > Add this parameter and make this parameter is optional, >> > 1, when NULL, use the local 256 bytes stack >> > 2, if 256 bytes stack is not enough, return RETURE_BUFFER_TOO_SAMLL, >> > 3, caller check the return status, to do nothing or to allocate >> enough >> > buffer for retry >> > >> > This is just like SetVariable()'s implementation. >> Yes, and because that is SetVariable's implementation, we have >> library >> functions to make it less error-prone and more convenient [1]. As a >> matter of fact, we have a (semi-lax) policy in our codebases to avoid >> such functions like the plague and use those library wrappers >> where-ever >> it can make sense. The only super-rare exceptions I can think of are >> when we know the size of the element ahead of time. Also >> SetVariable has >> no arbitrary constraint on when it may work the first time, and >> there is >> code that will fail when the first return is not EFI_BUFFER_TOO_SMALL. >> This solution honestly yields even more problems, because it >> introduces >> a Status return which was not there before. For common code safety >> and >> quality policy, this requires the value *must* be retrieved and >> checked >> in some fashion. So all callers, no matter the prior knowledge of the >> element size, now need either a runtime check and handling for a >> status >> that they (may) know can never be returned, or ASSERTs if the >> function >> spec really imposes the arbitrary 256 Bytes constraint. Latter >> doesn't >> really work I think. What if someone wants to sort in SEC and noticed >> they only have 64 Bytes on the stack to work with, realistically? Any >> code depending on the 256 Byte constraint, passing NULL and not doing >> additional handling, would seize to work. Former is too >> complicated, see >> wrappers. In my opinion, the memory must *either* be fully managed by >> the caller *or* the callee (and you may have both in separate >> functions, >> as I suggested), but not sometimes here, sometimes there. >> Best regards, >> Marvin >> [1] >> > https://github.com/tianocore/edk2/blob/46b4606ba23498d3d0e66b53e498eb3d5d592586/MdePkg/Library/UefiLib/UefiLib.c#L > 1309-L1360 >> > >> > >> ------------------------------------------------------------------------ >> > Jeff >> > fanjianfeng@byosoft.com.cn >> > >> > *From:* Marvin Häuser <mailto:mhaeuser@posteo.de> >> > *Date:* 2021-09-26 19:20 >> > *To:* devel <mailto:devel@edk2.groups.io>; ray.ni >> > <mailto:ray.ni@intel.com>; gaoliming >> > <mailto:gaoliming@byosoft.com.cn>; Chan, Amy >> > <mailto:amy.chan@intel.com>; 'Andrew Fish' >> <mailto:afish@apple.com> >> > *CC:* Kinney, Michael D <mailto:michael.d.kinney@intel.com>; >> 'Gao, >> > Liming' <mailto:liming.gao@intel.com>; Liu, Zhiguang >> > <mailto:zhiguang.liu@intel.com>; Wang, Jian J >> > <mailto:jian.j.wang@intel.com>; Gao, Zhichao >> > <mailto:zhichao.gao@intel.com> >> > *Subject:* Re: [edk2-devel] RFC: Add BaseLib/QuickSort in MdePkg >> > Hey Ray, >> > In my opinion that spec is too complicated. For some cases it is >> > obvious, but I think the last anyone wants to see is a >> > (STATIC_)ASSERT >> > before most QuickSort calls to ensure the element size >> *really* is <= >> > 256 Bytes. In my opinion, there are two roads: >> > 1) Make the parameter required (I think this is what Liming >> > suggested). >> > The caller would always need to provide said buffer, and it >> can do >> > as it >> > sees fit - on the stack, in a pool, in a page, who knows. >> > 2) Remove the parameter entirely. The library would depend on >> > MemoryAllocationLib again, but also would have an >> optimisation by >> > choosing stack vs pool based on ElementSize. >> > Usually I would prefer 2), as it is less prone to caller >> errors, but >> > considering the low-level nature of edk2, I can totally see the >> > point to >> > allow the caller to control whether there are dynamic memory >> > allocations >> > made or not as possible with 1). 2) could technically also be a >> > wrapper >> > for 1) if you want granular control and convenience/safety >> (why not >> > actually?). >> > Both approaches have the advantage that it is crystal-clear >> what the >> > caller's job is - to always or to never allocate the buffer. >> > Best regards, >> > Marvin >> > On 26/09/2021 04:24, Ni, Ray wrote: >> > > >> > > Liming, >> > > >> > > The purpose of the optional BufferOneElement is to ease >> consumer’s >> > > life assuming most of the time the element size should be >> > smaller than >> > > 256. >> > > >> > > Are you saying that it’s a bit hard to calculate the actual >> > value of >> > > sizeof (Element) when writing code? >> > > >> > > I recommend consumer always allocates memory if it’s hard >> to judge >> > > sizeof (Element) < 256. >> > > >> > > Searching edk2 code, I can find below code using >> PerformQuickSort(): >> > > >> > > 1. ShellPkg/UefiShellCommandLib: It’s sorting array of >> > > (EFI_DEVICE_PATH_PROTOCOL *). >> > > 2. UefiCpuPkg/CpuCacheInfoLib: It’s sorting array of >> > CPU_CACHE_INFO. >> > > 3. MinPlatformPkg/AcpiTables: It’s sorting array of >> > EFI_CPU_ID_ORDER_MAP. >> > > 4. MdeModulePkg/UefiBootManagerLib: It’s sorting array of >> > > EFI_BOOT_MANAGER_LOAD_OPTION. >> > > 5. MdeModulePkg/CapsuleApp: It’s sorting array of >> (EFI_FILE_INFO *) >> > > 6. CryptoPkg/CrtWrapper: It’s sorting array of (unknown >> type). >> > > 7. RedfishPkg/RedfishCrtLib: It’s sorting array of >> (unknown type). >> > > >> > > For 1~5, it’s easy to know that the size of the element is >> smaller >> > > than 256. The AllocatePool() can be skipped. >> > > >> > > Thanks, >> > > >> > > Ray >> > > >> > > *From:*gaoliming <gaoliming@byosoft.com.cn> >> > > *Sent:* Sunday, September 26, 2021 10:01 AM >> > > *To:* Ni, Ray <ray.ni@intel.com>; devel@edk2.groups.io; >> Chan, Amy >> > > <amy.chan@intel.com>; 'Andrew Fish' <afish@apple.com> >> > > *Cc:* Kinney, Michael D <michael.d.kinney@intel.com>; >> 'Gao, Liming' >> > > <liming.gao@intel.com>; Liu, Zhiguang >> <zhiguang.liu@intel.com>; >> > Wang, >> > > Jian J <jian.j.wang@intel.com>; Gao, Zhichao >> <zhichao.gao@intel.com> >> > > *Subject:* 回复: [edk2-devel] RFC: Add BaseLib/QuickSort in >> MdePkg >> > > >> > > Ray: >> > > >> > > I may suggest to always require BufferOneElement. The >> consumer code >> > > may not know ElementSize. To avoid the error, the consumer >> must >> > > allocate buffer for BufferOneElement. If so, >> BufferOneElement is >> > the >> > > required parameter. >> > > >> > > Thanks >> > > >> > > Liming >> > > >> > > *发件人**:*Ni, Ray <ray.ni@intel.com >> <mailto:ray.ni@intel.com>> >> > > *发送时间:* 2021年9月24日 11:53 >> > > *收件人:* devel@edk2.groups.io <mailto:devel@edk2.groups.io>; >> Ni, >> > Ray >> > > <ray.ni@intel.com <mailto:ray.ni@intel.com>>; Chan, Amy >> > > <amy.chan@intel.com <mailto:amy.chan@intel.com>>; gaoliming >> > > <gaoliming@byosoft.com.cn <mailto:gaoliming@byosoft.com.cn>>; >> > 'Andrew >> > > Fish' <afish@apple.com <mailto:afish@apple.com>> >> > > *抄送:* Kinney, Michael D <michael.d.kinney@intel.com >> > > <mailto:michael.d.kinney@intel.com>>; 'Gao, Liming' >> > > <liming.gao@intel.com <mailto:liming.gao@intel.com>>; Liu, >> Zhiguang >> > > <zhiguang.liu@intel.com <mailto:zhiguang.liu@intel.com>>; >> Wang, >> > Jian J >> > > <jian.j.wang@intel.com <mailto:jian.j.wang@intel.com>>; Gao, >> > Zhichao >> > > <zhichao.gao@intel.com <mailto:zhichao.gao@intel.com>> >> > > *主题:* RE: [edk2-devel] RFC: Add BaseLib/QuickSort in MdePkg >> > > >> > > More details on new QuickSort() API: >> > > >> > > The new API needs to carry additional parameter >> “BufferOneElement”. >> > > >> > > This parameter gives QuickSort() the temporary buffer for >> > swapping in >> > > sorting. >> > > >> > > It’s to avoid BaseLib depends on MemoryAllocationLib. >> > > >> > > … >> > > >> > > @param [in] BufferOneElement When ElementSize > 256, caller >> > needs to >> > > provide a buffer whose size >> > > equals to ElementSize. It’s >> used by >> > > QuickSort() for swapping in sorting. >> > > >> > > When ElementSize <= 256, QuickSort() uses a local stack >> 256-byte >> > buffer. >> > > >> > > @retval EFI_INVALID_PARAMETER When (ElementSize > 256) and >> > > (BufferOneElement == NULL). >> > > >> > > … >> > > >> > > VOID >> > > >> > > EFIAPI >> > > >> > > QuickSort ( >> > > >> > > IN OUT VOID *BufferToSort, >> > > >> > > IN CONST UINTN ElementCount, >> > > >> > > IN CONST UINTN ElementSize, >> > > >> > > IN SORT_COMPARE CompareFunction, >> > > >> > > IN VOID *BufferOneElement OPTIONAL >> > > >> > > ); >> > > >> > > Any comments? >> > > >> > > *From:*devel@edk2.groups.io <mailto:devel@edk2.groups.io> >> > > <devel@edk2.groups.io <mailto:devel@edk2.groups.io>> *On >> Behalf Of >> > > *Ni, Ray >> > > *Sent:* Wednesday, September 22, 2021 2:04 PM >> > > *To:* Chan, Amy <amy.chan@intel.com >> <mailto:amy.chan@intel.com>>; >> > > gaoliming <gaoliming@byosoft.com.cn >> > > <mailto:gaoliming@byosoft.com.cn>>; 'Andrew Fish' >> <afish@apple.com >> > > <mailto:afish@apple.com>>; 'edk2-devel-groups-io' >> > > <devel@edk2.groups.io <mailto:devel@edk2.groups.io>> >> > > *Cc:* Kinney, Michael D <michael.d.kinney@intel.com >> > > <mailto:michael.d.kinney@intel.com>>; 'Gao, Liming' >> > > <liming.gao@intel.com <mailto:liming.gao@intel.com>>; Liu, >> Zhiguang >> > > <zhiguang.liu@intel.com <mailto:zhiguang.liu@intel.com>>; >> Wang, >> > Jian J >> > > <jian.j.wang@intel.com <mailto:jian.j.wang@intel.com>>; Gao, >> > Zhichao >> > > <zhichao.gao@intel.com <mailto:zhichao.gao@intel.com>> >> > > *Subject:* Re: [edk2-devel] RFC: Add BaseLib/QuickSort in >> MdePkg >> > > >> > > I don’t see objection so far. >> > > >> > > So, the final solution is: >> > > >> > > 1. Add QuickSort() API to BaseLib in MdePkg. >> > > 2. Update existing MdeModulePkg/SortLib to use >> QuickSort() in the >> > > implementation (proposed by Andrew Fish and Liming Gao) >> > > 3. Update UefiCpuPkg to use QuickSortLib to remove improper >> > > dependency on MdeModulePkg >> > > >> > > Thanks, >> > > >> > > Ray >> > > >> > > *From:*Ni, Ray >> > > *Sent:* Thursday, September 16, 2021 10:48 AM >> > > *To:* Chan, Amy <amy.chan@intel.com >> <mailto:amy.chan@intel.com>>; >> > > gaoliming <gaoliming@byosoft.com.cn >> > > <mailto:gaoliming@byosoft.com.cn>>; 'Andrew Fish' >> <afish@apple.com >> > > <mailto:afish@apple.com>>; 'edk2-devel-groups-io' >> > > <devel@edk2.groups.io <mailto:devel@edk2.groups.io>> >> > > *Cc:* Kinney, Michael D <michael.d.kinney@intel.com >> > > <mailto:michael.d.kinney@intel.com>>; 'Gao, Liming' >> > > <liming.gao@intel.com <mailto:liming.gao@intel.com>>; Liu, >> Zhiguang >> > > <Zhiguang.Liu@intel.com <mailto:Zhiguang.Liu@intel.com>>; >> Wang, >> > Jian J >> > > <jian.j.wang@intel.com <mailto:jian.j.wang@intel.com>>; Gao, >> > Zhichao >> > > <zhichao.gao@intel.com <mailto:zhichao.gao@intel.com>> >> > > *Subject:* RE: [edk2-devel] RFC: Add BaseLib/QuickSort in >> MdePkg >> > > >> > > Amy, >> > > >> > > No. We only Add QuickSort() function API into BaseLib.h. >> > > >> > > *From:*Chan, Amy <amy.chan@intel.com >> <mailto:amy.chan@intel.com>> >> > > *Sent:* Thursday, September 16, 2021 10:46 AM >> > > *To:* gaoliming <gaoliming@byosoft.com.cn >> > > <mailto:gaoliming@byosoft.com.cn>>; 'Andrew Fish' >> <afish@apple.com >> > > <mailto:afish@apple.com>>; 'edk2-devel-groups-io' >> > > <devel@edk2.groups.io <mailto:devel@edk2.groups.io>> >> > > *Cc:* Ni, Ray <ray.ni@intel.com >> <mailto:ray.ni@intel.com>>; Kinney, >> > > Michael D <michael.d.kinney@intel.com >> > > <mailto:michael.d.kinney@intel.com>>; 'Gao, Liming' >> > > <liming.gao@intel.com <mailto:liming.gao@intel.com>>; Liu, >> Zhiguang >> > > <zhiguang.liu@intel.com <mailto:zhiguang.liu@intel.com>>; >> Wang, >> > Jian J >> > > <jian.j.wang@intel.com <mailto:jian.j.wang@intel.com>>; Gao, >> > Zhichao >> > > <zhichao.gao@intel.com <mailto:zhichao.gao@intel.com>> >> > > *Subject:* RE: [edk2-devel] RFC: Add BaseLib/QuickSort in >> MdePkg >> > > >> > > Just to double confirm, will we have the null instance of >> > QuickSort in >> > > MdePkg? >> > > >> > > Regards, >> > > >> > > Amy >> > > >> > > *From:*gaoliming <gaoliming@byosoft.com.cn >> > > <mailto:gaoliming@byosoft.com.cn>> >> > > *Sent:* Thursday, September 16, 2021 10:23 AM >> > > *To:* 'Andrew Fish' <afish@apple.com >> <mailto:afish@apple.com>>; >> > > 'edk2-devel-groups-io' <devel@edk2.groups.io >> > > <mailto:devel@edk2.groups.io>> >> > > *Cc:* Ni, Ray <ray.ni@intel.com >> <mailto:ray.ni@intel.com>>; Kinney, >> > > Michael D <michael.d.kinney@intel.com >> > > <mailto:michael.d.kinney@intel.com>>; 'Gao, Liming' >> > > <liming.gao@intel.com <mailto:liming.gao@intel.com>>; Liu, >> Zhiguang >> > > <zhiguang.liu@intel.com <mailto:zhiguang.liu@intel.com>>; >> Wang, >> > Jian J >> > > <jian.j.wang@intel.com <mailto:jian.j.wang@intel.com>>; Gao, >> > Zhichao >> > > <zhichao.gao@intel.com <mailto:zhichao.gao@intel.com>>; >> Chan, Amy >> > > <amy.chan@intel.com <mailto:amy.chan@intel.com>> >> > > *Subject:* 回复: [edk2-devel] RFC: Add BaseLib/QuickSort in >> MdePkg >> > > >> > > Andrew: >> > > >> > > Thanks for your suggestion. I think your idea is better. >> We add new >> > > QuickSort() API to BaseLib, and update SortLib library >> instance to >> > > consume BaseLib QuickSort() API. This way has no change in >> current >> > > SortLib library class. It is the compatible solution. >> > > >> > > Thanks >> > > >> > > Liming >> > > >> > > *发件人**:*Andrew Fish <afish@apple.com >> <mailto:afish@apple.com>> >> > > *发送时间:* 2021年9月16日 10:13 >> > > *收件人:* edk2-devel-groups-io <devel@edk2.groups.io >> > > <mailto:devel@edk2.groups.io>>; Liming Gao >> > <gaoliming@byosoft.com.cn >> > > <mailto:gaoliming@byosoft.com.cn>> >> > > *抄送:* Ni, Ray <ray.ni@intel.com >> <mailto:ray.ni@intel.com>>; Mike >> > > Kinney <michael.d.kinney@intel.com >> > > <mailto:michael.d.kinney@intel.com>>; Gao, Liming >> > > <liming.gao@intel.com <mailto:liming.gao@intel.com>>; Liu, >> Zhiguang >> > > <zhiguang.liu@intel.com <mailto:zhiguang.liu@intel.com>>; >> Wang, >> > Jian J >> > > <jian.j.wang@intel.com <mailto:jian.j.wang@intel.com>>; Gao, >> > Zhichao >> > > <zhichao.gao@intel.com <mailto:zhichao.gao@intel.com>>; >> Chan, Amy >> > > <amy.chan@intel.com <mailto:amy.chan@intel.com>> >> > > *主题:* Re: [edk2-devel] RFC: Add BaseLib/QuickSort in MdePkg >> > > >> > > On Sep 15, 2021, at 6:26 PM, gaoliming >> <gaoliming@byosoft.com.cn >> > > <mailto:gaoliming@byosoft.com.cn>> wrote: >> > > >> > > Ray: >> > > >> > > SortLib has been added since 2015. I would suggest to >> still keep >> > > this library class. To resolve the package dependency, my >> > proposal >> > > is to move the library class header file SortLib.h from >> > > MdeModulePkg to MdePkg, and still keep the library >> instance in >> > > MdeModulePkg. This proposal has no impact on the existing >> > platform. >> > > >> > > If we add QuickSort() API to the BaseLib can we not just >> port the >> > > existing MdeModulePkg/SortLib to use QuickSort() in the >> > > implementation? Or is there some other way to add the new >> thing >> > in a >> > > backward compatible way. >> > > >> > > Thanks, >> > > >> > > Andrew Fish >> > > >> > > Thanks >> > > >> > > Liming >> > > >> > > *发件人**:*devel@edk2.groups.io >> > > <mailto:devel@edk2.groups.io><devel@edk2.groups.io >> > > <mailto:devel@edk2.groups.io>>*代表***Ni, Ray >> > > *发送时间:*2021年9月14日14:15 >> > > *收件人:*Kinney, Michael D <michael.d.kinney@intel.com >> > > <mailto:michael.d.kinney@intel.com>>; Gao, Liming >> > > <liming.gao@intel.com <mailto:liming.gao@intel.com>>; Liu, >> > > Zhiguang <zhiguang.liu@intel.com >> > <mailto:zhiguang.liu@intel.com>>; >> > > Wang, Jian J <jian.j.wang@intel.com >> > > <mailto:jian.j.wang@intel.com>>; Gao, Zhichao >> > > <zhichao.gao@intel.com <mailto:zhichao.gao@intel.com>> >> > > *抄送:*devel@edk2.groups.io <mailto:devel@edk2.groups.io>; >> > Chan, Amy >> > > <amy.chan@intel.com <mailto:amy.chan@intel.com>> >> > > *主题:*[edk2-devel] RFC: Add BaseLib/QuickSort in MdePkg >> > > >> > > Hi package maintainers of MdePkg, MdeModulePkg and >> ShellPkg, >> > > community, >> > > >> > > A commit (UefiCpuPkg/CpuCacheInfoLib: Sort >> CpuCacheInfo array >> > > >> > >> <https://github.com/tianocore/edk2/commit/4de77ae9890d241271f543e9195ab3516f3abec6>) >> > > to UefiCpuPkg let >> > > UefiCpuPkg depend on MdeModulePkg because the SortLib >> class and >> > > instances are all in MdeModulePkg. >> > > >> > > UefiCpuPkg depending on MdeModulePkg breaks the rule that >> > > “UefiCpuPkg should ONLY depend on MdePkg”. >> > > >> > > To address this issue, there are two approaches: >> > > >> > > 1. Duplicate the sort logic in UefiCpuPkg to not >> depend on >> > > MdeModulePkg/SortLib >> > > 2. Add QuickSort() API to BaseLib in MdePkg. >> > > >> > > Approach #2 (MdePkg/BaseLib/QuickSort) makes more >> sense because >> > > quick sort is a standard algorithm. >> > > >> > > We encourage consumers to update their code to use the >> quick >> > sort >> > > in MdePkg and gradually deprecate today’s >> MdeModulePkg/SortLib. >> > > >> > > If you don’t have concerns, I plan to: >> > > >> > > 1. “Add QuickSort() to BaseLib” and update all existing >> > consumers >> > > to use this API instead. >> > > >> > > VOID >> > > >> > > EFIAPI >> > > >> > > QuickSort ( >> > > >> > > IN OUT VOID *BufferToSort, >> > > >> > > IN CONST UINTN Count, >> > > >> > > IN CONST UINTN ElementSize, >> > > >> > > IN SORT_COMPARE CompareFunction >> > > >> > > ); >> > > >> > > 2. “Add new ShellPkg/SortCompareLib” >> > > >> > > Background: ShellPkg requires to sort >> devicepath/string so 3 >> > APIs >> > > in UefiSortLib (DevicePathCompare, StringNoCaseCompare, >> > > StringCompare) are provided for Shell usage. we can >> move the 3 >> > > APIs to the SortCompareLib and update Shell code to use >> > > BaseLib/QuickSort directly, with the sort compare >> function from >> > > SortCompareLib. >> > > >> > > Any concerns? >> > > >> > > Thanks, >> > > >> > > Ray >> > > >> > > >> > >> > >> >> -- Brian -------------------------------------------------------------------- "Remember that ignorance is expensive." -- From LLIB ^ permalink raw reply [flat|nested] 21+ messages in thread
* 回复: [edk2-devel] RFC: Add BaseLib/QuickSort in MdePkg 2021-09-28 22:25 ` Brian J. Johnson @ 2021-09-29 0:51 ` gaoliming 2021-09-29 2:42 ` Ni, Ray 0 siblings, 1 reply; 21+ messages in thread From: gaoliming @ 2021-09-29 0:51 UTC (permalink / raw) To: 'Brian J. Johnson', devel, ray.ni, 'Marvin Häuser', fanjianfeng, 'Chan, Amy', 'Andrew Fish' Cc: 'Kinney, Michael D', 'Gao, Liming', 'Liu, Zhiguang', 'Wang, Jian J', 'Gao, Zhichao' Johnson: I also agree this proposal to make BufferOneElement parameter mandatory. Thanks Liming > -----邮件原件----- > 发件人: Brian J. Johnson <brian.johnson@hpe.com> > 发送时间: 2021年9月29日 6:26 > 收件人: devel@edk2.groups.io; ray.ni@intel.com; Marvin Häuser > <mhaeuser@posteo.de>; fanjianfeng@byosoft.com.cn; 'gaoliming' > <gaoliming@byosoft.com.cn>; Chan, Amy <amy.chan@intel.com>; 'Andrew > Fish' <afish@apple.com> > 抄送: Kinney, Michael D <michael.d.kinney@intel.com>; 'Gao, Liming' > <liming.gao@intel.com>; Liu, Zhiguang <zhiguang.liu@intel.com>; Wang, Jian > J <jian.j.wang@intel.com>; Gao, Zhichao <zhichao.gao@intel.com> > 主题: Re: [edk2-devel] RFC: Add BaseLib/QuickSort in MdePkg > > I'll add my agreement to Marvin and Jeff: a low-level sort routine like > this should let the caller be in charge of memory allocation, so it can > be used in the widest variety of contexts (SEC, exception handlers, APs, > etc.) So let's make the BufferOneElement parameter mandatory. > > Brian J. Johnson > > -------- Original Message -------- > From: Ni, Ray [mailto:ray.ni@intel.com] > Sent: Monday, September 27, 2021, 8:49 PM > To: Marvin Häuser <mhaeuser@posteo.de>, fanjianfeng@byosoft.com.cn > <fanjianfeng@byosoft.com.cn>, devel@edk2.groups.io > <devel@edk2.groups.io>, 'gaoliming' <gaoliming@byosoft.com.cn>, Chan, > Amy <amy.chan@intel.com>, 'Andrew Fish' <afish@apple.com> > Cc: Kinney, Michael D <michael.d.kinney@intel.com>, 'Gao, Liming' > <liming.gao@intel.com>, Liu, Zhiguang <zhiguang.liu@intel.com>, Wang, > Jian J <jian.j.wang@intel.com>, Gao, Zhichao <zhichao.gao@intel.com> > Subject: [edk2-devel] RFC: Add BaseLib/QuickSort in MdePkg > > Marvin, > I agree with your concerns, in a certain level. But I didn't treat it > as a very big problem of having caller pass the BufferOneElement > "intelligently". > > I am ok to use your option 1), making BufferOneElement mandatory. > Caller should always supply the buffer that's sufficient to hold one > element. > > By the way, I don't want to propose "swap-without-using-temporary-value" > method to avoid using the "BufferOneElement"? > Because that makes the simple thing complicated! > > Thanks, > Ray > > > -----Original Message----- > > From: Marvin Häuser <mhaeuser@posteo.de> > > Sent: Monday, September 27, 2021 5:09 PM > > To: fanjianfeng@byosoft.com.cn; devel@edk2.groups.io; Ni, Ray > <ray.ni@intel.com>; 'gaoliming' > > <gaoliming@byosoft.com.cn>; Chan, Amy <amy.chan@intel.com>; 'Andrew > Fish' <afish@apple.com> > > Cc: Kinney, Michael D <michael.d.kinney@intel.com>; 'Gao, Liming' > <liming.gao@intel.com>; Liu, Zhiguang > > <zhiguang.liu@intel.com>; Wang, Jian J <jian.j.wang@intel.com>; Gao, > Zhichao <zhichao.gao@intel.com> > > Subject: Re: [edk2-devel] RFC: Add BaseLib/QuickSort in MdePkg > > > > On 27/09/2021 10:50, fanjianfeng@byosoft.com.cn wrote: > >> For former caller, they could still keep as is to call the old API in > >> MdeModulePkg. I think Ray's design is compatible change for existing code. > >> Only when the existing code wants to remove the dependency on > >> MdeModuelPkg, they could migrate to the new API in baselib. > >> > >> I agree with one split-API desgin what you mentioned. > >> But my point is to define one API in baselib and to make the baselib > >> not depend on memory allocation. And another wrapper API could be > >> designed to be placed in any other class. > > > > Oh sure, it could totally live in another class. I'd just like to have > > those two models (caller- and callee-owned buffer) strictly separate, I > > personally do not mind where exactly they are implemented. Thanks! > > > > Best regards, > > Marvin > > > >> > >> ------------------------------------------------------------------------ > >> Jeff > >> fanjianfeng@byosoft.com.cn > >> > >> *From:* Marvin Häuser <mailto:mhaeuser@posteo.de> > >> *Date:* 2021-09-27 16:14 > >> *To:* fanjianfeng@byosoft.com.cn > >> <mailto:fanjianfeng@byosoft.com.cn>; devel@edk2.groups.io > >> <mailto:devel@edk2.groups.io>; Ni, Ray <mailto:ray.ni@intel.com>; > >> 'gaoliming' <mailto:gaoliming@byosoft.com.cn>; Chan, Amy > >> <mailto:amy.chan@intel.com>; 'Andrew Fish' > <mailto:afish@apple.com> > >> *CC:* Kinney, Michael D <mailto:michael.d.kinney@intel.com>; > 'Gao, > >> Liming' <mailto:liming.gao@intel.com>; Liu, Zhiguang > >> <mailto:zhiguang.liu@intel.com>; Wang, Jian J > >> <mailto:jian.j.wang@intel.com>; Gao, Zhichao > >> <mailto:zhichao.gao@intel.com> > >> *Subject:* Re: [edk2-devel] RFC: Add BaseLib/QuickSort in > MdePkg > >> On 27/09/2021 02:45, fanjianfeng@byosoft.com.cn wrote: > >> > Making baselib implementation depend on MemoryAllocationLib > >> > (indirectly on Pei Service and gBS), it may prevent > >> > this base API using at some seneraio. i don't think it's better. > >> That is why I asked about a split-API scenario, one of which does > not > >> depend on dynamic memory allocation (SetVariable-like) and one > does > >> (wrapper-like). > >> > Add this parameter and make this parameter is optional, > >> > 1, when NULL, use the local 256 bytes stack > >> > 2, if 256 bytes stack is not enough, return > RETURE_BUFFER_TOO_SAMLL, > >> > 3, caller check the return status, to do nothing or to allocate > >> enough > >> > buffer for retry > >> > > >> > This is just like SetVariable()'s implementation. > >> Yes, and because that is SetVariable's implementation, we have > >> library > >> functions to make it less error-prone and more convenient [1]. As a > >> matter of fact, we have a (semi-lax) policy in our codebases to avoid > >> such functions like the plague and use those library wrappers > >> where-ever > >> it can make sense. The only super-rare exceptions I can think of are > >> when we know the size of the element ahead of time. Also > >> SetVariable has > >> no arbitrary constraint on when it may work the first time, and > >> there is > >> code that will fail when the first return is not > EFI_BUFFER_TOO_SMALL. > >> This solution honestly yields even more problems, because it > >> introduces > >> a Status return which was not there before. For common code > safety > >> and > >> quality policy, this requires the value *must* be retrieved and > >> checked > >> in some fashion. So all callers, no matter the prior knowledge of the > >> element size, now need either a runtime check and handling for a > >> status > >> that they (may) know can never be returned, or ASSERTs if the > >> function > >> spec really imposes the arbitrary 256 Bytes constraint. Latter > >> doesn't > >> really work I think. What if someone wants to sort in SEC and > noticed > >> they only have 64 Bytes on the stack to work with, realistically? Any > >> code depending on the 256 Byte constraint, passing NULL and not > doing > >> additional handling, would seize to work. Former is too > >> complicated, see > >> wrappers. In my opinion, the memory must *either* be fully > managed by > >> the caller *or* the callee (and you may have both in separate > >> functions, > >> as I suggested), but not sometimes here, sometimes there. > >> Best regards, > >> Marvin > >> [1] > >> > > > https://github.com/tianocore/edk2/blob/46b4606ba23498d3d0e66b53e498e > b3d5d592586/MdePkg/Library/UefiLib/UefiLib.c#L > > 1309-L1360 > >> > > >> > > >> ------------------------------------------------------------------------ > >> > Jeff > >> > fanjianfeng@byosoft.com.cn > >> > > >> > *From:* Marvin Häuser <mailto:mhaeuser@posteo.de> > >> > *Date:* 2021-09-26 19:20 > >> > *To:* devel <mailto:devel@edk2.groups.io>; ray.ni > >> > <mailto:ray.ni@intel.com>; gaoliming > >> > <mailto:gaoliming@byosoft.com.cn>; Chan, Amy > >> > <mailto:amy.chan@intel.com>; 'Andrew Fish' > >> <mailto:afish@apple.com> > >> > *CC:* Kinney, Michael D > <mailto:michael.d.kinney@intel.com>; > >> 'Gao, > >> > Liming' <mailto:liming.gao@intel.com>; Liu, Zhiguang > >> > <mailto:zhiguang.liu@intel.com>; Wang, Jian J > >> > <mailto:jian.j.wang@intel.com>; Gao, Zhichao > >> > <mailto:zhichao.gao@intel.com> > >> > *Subject:* Re: [edk2-devel] RFC: Add BaseLib/QuickSort > in MdePkg > >> > Hey Ray, > >> > In my opinion that spec is too complicated. For some cases > it is > >> > obvious, but I think the last anyone wants to see is a > >> > (STATIC_)ASSERT > >> > before most QuickSort calls to ensure the element size > >> *really* is <= > >> > 256 Bytes. In my opinion, there are two roads: > >> > 1) Make the parameter required (I think this is what Liming > >> > suggested). > >> > The caller would always need to provide said buffer, and it > >> can do > >> > as it > >> > sees fit - on the stack, in a pool, in a page, who knows. > >> > 2) Remove the parameter entirely. The library would > depend on > >> > MemoryAllocationLib again, but also would have an > >> optimisation by > >> > choosing stack vs pool based on ElementSize. > >> > Usually I would prefer 2), as it is less prone to caller > >> errors, but > >> > considering the low-level nature of edk2, I can totally see > the > >> > point to > >> > allow the caller to control whether there are dynamic > memory > >> > allocations > >> > made or not as possible with 1). 2) could technically also be > a > >> > wrapper > >> > for 1) if you want granular control and convenience/safety > >> (why not > >> > actually?). > >> > Both approaches have the advantage that it is crystal-clear > >> what the > >> > caller's job is - to always or to never allocate the buffer. > >> > Best regards, > >> > Marvin > >> > On 26/09/2021 04:24, Ni, Ray wrote: > >> > > > >> > > Liming, > >> > > > >> > > The purpose of the optional BufferOneElement is to ease > >> consumer’s > >> > > life assuming most of the time the element size should be > >> > smaller than > >> > > 256. > >> > > > >> > > Are you saying that it’s a bit hard to calculate the actual > >> > value of > >> > > sizeof (Element) when writing code? > >> > > > >> > > I recommend consumer always allocates memory if it’s > hard > >> to judge > >> > > sizeof (Element) < 256. > >> > > > >> > > Searching edk2 code, I can find below code using > >> PerformQuickSort(): > >> > > > >> > > 1. ShellPkg/UefiShellCommandLib: It’s sorting array of > >> > > (EFI_DEVICE_PATH_PROTOCOL *). > >> > > 2. UefiCpuPkg/CpuCacheInfoLib: It’s sorting array of > >> > CPU_CACHE_INFO. > >> > > 3. MinPlatformPkg/AcpiTables: It’s sorting array of > >> > EFI_CPU_ID_ORDER_MAP. > >> > > 4. MdeModulePkg/UefiBootManagerLib: It’s sorting > array of > >> > > EFI_BOOT_MANAGER_LOAD_OPTION. > >> > > 5. MdeModulePkg/CapsuleApp: It’s sorting array of > >> (EFI_FILE_INFO *) > >> > > 6. CryptoPkg/CrtWrapper: It’s sorting array of > (unknown > >> type). > >> > > 7. RedfishPkg/RedfishCrtLib: It’s sorting array of > >> (unknown type). > >> > > > >> > > For 1~5, it’s easy to know that the size of the element is > >> smaller > >> > > than 256. The AllocatePool() can be skipped. > >> > > > >> > > Thanks, > >> > > > >> > > Ray > >> > > > >> > > *From:*gaoliming <gaoliming@byosoft.com.cn> > >> > > *Sent:* Sunday, September 26, 2021 10:01 AM > >> > > *To:* Ni, Ray <ray.ni@intel.com>; devel@edk2.groups.io; > >> Chan, Amy > >> > > <amy.chan@intel.com>; 'Andrew Fish' > <afish@apple.com> > >> > > *Cc:* Kinney, Michael D <michael.d.kinney@intel.com>; > >> 'Gao, Liming' > >> > > <liming.gao@intel.com>; Liu, Zhiguang > >> <zhiguang.liu@intel.com>; > >> > Wang, > >> > > Jian J <jian.j.wang@intel.com>; Gao, Zhichao > >> <zhichao.gao@intel.com> > >> > > *Subject:* 回复: [edk2-devel] RFC: Add > BaseLib/QuickSort in > >> MdePkg > >> > > > >> > > Ray: > >> > > > >> > > I may suggest to always require BufferOneElement. The > >> consumer code > >> > > may not know ElementSize. To avoid the error, the > consumer > >> must > >> > > allocate buffer for BufferOneElement. If so, > >> BufferOneElement is > >> > the > >> > > required parameter. > >> > > > >> > > Thanks > >> > > > >> > > Liming > >> > > > >> > > *发件人**:*Ni, Ray <ray.ni@intel.com > >> <mailto:ray.ni@intel.com>> > >> > > *发送时间:* 2021年9月24日 11:53 > >> > > *收件人:* devel@edk2.groups.io > <mailto:devel@edk2.groups.io>; > >> Ni, > >> > Ray > >> > > <ray.ni@intel.com <mailto:ray.ni@intel.com>>; Chan, > Amy > >> > > <amy.chan@intel.com <mailto:amy.chan@intel.com>>; > gaoliming > >> > > <gaoliming@byosoft.com.cn > <mailto:gaoliming@byosoft.com.cn>>; > >> > 'Andrew > >> > > Fish' <afish@apple.com <mailto:afish@apple.com>> > >> > > *抄送:* Kinney, Michael D <michael.d.kinney@intel.com > >> > > <mailto:michael.d.kinney@intel.com>>; 'Gao, Liming' > >> > > <liming.gao@intel.com <mailto:liming.gao@intel.com>>; > Liu, > >> Zhiguang > >> > > <zhiguang.liu@intel.com > <mailto:zhiguang.liu@intel.com>>; > >> Wang, > >> > Jian J > >> > > <jian.j.wang@intel.com <mailto:jian.j.wang@intel.com>>; > Gao, > >> > Zhichao > >> > > <zhichao.gao@intel.com > <mailto:zhichao.gao@intel.com>> > >> > > *主题:* RE: [edk2-devel] RFC: Add BaseLib/QuickSort in > MdePkg > >> > > > >> > > More details on new QuickSort() API: > >> > > > >> > > The new API needs to carry additional parameter > >> “BufferOneElement”. > >> > > > >> > > This parameter gives QuickSort() the temporary buffer for > >> > swapping in > >> > > sorting. > >> > > > >> > > It’s to avoid BaseLib depends on MemoryAllocationLib. > >> > > > >> > > … > >> > > > >> > > @param [in] BufferOneElement When ElementSize > > 256, caller > >> > needs to > >> > > provide a buffer whose size > >> > > equals to > ElementSize. It’s > >> used by > >> > > QuickSort() for swapping in sorting. > >> > > > >> > > When ElementSize <= 256, QuickSort() uses a local stack > >> 256-byte > >> > buffer. > >> > > > >> > > @retval EFI_INVALID_PARAMETER When (ElementSize > > 256) and > >> > > (BufferOneElement == NULL). > >> > > > >> > > … > >> > > > >> > > VOID > >> > > > >> > > EFIAPI > >> > > > >> > > QuickSort ( > >> > > > >> > > IN OUT > VOID *BufferToSort, > >> > > > >> > > IN CONST UINTN ElementCount, > >> > > > >> > > IN CONST UINTN ElementSize, > >> > > > >> > > IN SORT_COMPARE CompareFunction, > >> > > > >> > > IN VOID *BufferOneElement OPTIONAL > >> > > > >> > > ); > >> > > > >> > > Any comments? > >> > > > >> > > *From:*devel@edk2.groups.io > <mailto:devel@edk2.groups.io> > >> > > <devel@edk2.groups.io <mailto:devel@edk2.groups.io>> > *On > >> Behalf Of > >> > > *Ni, Ray > >> > > *Sent:* Wednesday, September 22, 2021 2:04 PM > >> > > *To:* Chan, Amy <amy.chan@intel.com > >> <mailto:amy.chan@intel.com>>; > >> > > gaoliming <gaoliming@byosoft.com.cn > >> > > <mailto:gaoliming@byosoft.com.cn>>; 'Andrew Fish' > >> <afish@apple.com > >> > > <mailto:afish@apple.com>>; 'edk2-devel-groups-io' > >> > > <devel@edk2.groups.io <mailto:devel@edk2.groups.io>> > >> > > *Cc:* Kinney, Michael D <michael.d.kinney@intel.com > >> > > <mailto:michael.d.kinney@intel.com>>; 'Gao, Liming' > >> > > <liming.gao@intel.com <mailto:liming.gao@intel.com>>; > Liu, > >> Zhiguang > >> > > <zhiguang.liu@intel.com > <mailto:zhiguang.liu@intel.com>>; > >> Wang, > >> > Jian J > >> > > <jian.j.wang@intel.com <mailto:jian.j.wang@intel.com>>; > Gao, > >> > Zhichao > >> > > <zhichao.gao@intel.com > <mailto:zhichao.gao@intel.com>> > >> > > *Subject:* Re: [edk2-devel] RFC: Add BaseLib/QuickSort > in > >> MdePkg > >> > > > >> > > I don’t see objection so far. > >> > > > >> > > So, the final solution is: > >> > > > >> > > 1. Add QuickSort() API to BaseLib in MdePkg. > >> > > 2. Update existing MdeModulePkg/SortLib to use > >> QuickSort() in the > >> > > implementation (proposed by Andrew Fish and > Liming Gao) > >> > > 3. Update UefiCpuPkg to use QuickSortLib to remove > improper > >> > > dependency on MdeModulePkg > >> > > > >> > > Thanks, > >> > > > >> > > Ray > >> > > > >> > > *From:*Ni, Ray > >> > > *Sent:* Thursday, September 16, 2021 10:48 AM > >> > > *To:* Chan, Amy <amy.chan@intel.com > >> <mailto:amy.chan@intel.com>>; > >> > > gaoliming <gaoliming@byosoft.com.cn > >> > > <mailto:gaoliming@byosoft.com.cn>>; 'Andrew Fish' > >> <afish@apple.com > >> > > <mailto:afish@apple.com>>; 'edk2-devel-groups-io' > >> > > <devel@edk2.groups.io <mailto:devel@edk2.groups.io>> > >> > > *Cc:* Kinney, Michael D <michael.d.kinney@intel.com > >> > > <mailto:michael.d.kinney@intel.com>>; 'Gao, Liming' > >> > > <liming.gao@intel.com <mailto:liming.gao@intel.com>>; > Liu, > >> Zhiguang > >> > > <Zhiguang.Liu@intel.com > <mailto:Zhiguang.Liu@intel.com>>; > >> Wang, > >> > Jian J > >> > > <jian.j.wang@intel.com <mailto:jian.j.wang@intel.com>>; > Gao, > >> > Zhichao > >> > > <zhichao.gao@intel.com > <mailto:zhichao.gao@intel.com>> > >> > > *Subject:* RE: [edk2-devel] RFC: Add BaseLib/QuickSort > in > >> MdePkg > >> > > > >> > > Amy, > >> > > > >> > > No. We only Add QuickSort() function API into BaseLib.h. > >> > > > >> > > *From:*Chan, Amy <amy.chan@intel.com > >> <mailto:amy.chan@intel.com>> > >> > > *Sent:* Thursday, September 16, 2021 10:46 AM > >> > > *To:* gaoliming <gaoliming@byosoft.com.cn > >> > > <mailto:gaoliming@byosoft.com.cn>>; 'Andrew Fish' > >> <afish@apple.com > >> > > <mailto:afish@apple.com>>; 'edk2-devel-groups-io' > >> > > <devel@edk2.groups.io <mailto:devel@edk2.groups.io>> > >> > > *Cc:* Ni, Ray <ray.ni@intel.com > >> <mailto:ray.ni@intel.com>>; Kinney, > >> > > Michael D <michael.d.kinney@intel.com > >> > > <mailto:michael.d.kinney@intel.com>>; 'Gao, Liming' > >> > > <liming.gao@intel.com <mailto:liming.gao@intel.com>>; > Liu, > >> Zhiguang > >> > > <zhiguang.liu@intel.com > <mailto:zhiguang.liu@intel.com>>; > >> Wang, > >> > Jian J > >> > > <jian.j.wang@intel.com <mailto:jian.j.wang@intel.com>>; > Gao, > >> > Zhichao > >> > > <zhichao.gao@intel.com > <mailto:zhichao.gao@intel.com>> > >> > > *Subject:* RE: [edk2-devel] RFC: Add BaseLib/QuickSort > in > >> MdePkg > >> > > > >> > > Just to double confirm, will we have the null instance of > >> > QuickSort in > >> > > MdePkg? > >> > > > >> > > Regards, > >> > > > >> > > Amy > >> > > > >> > > *From:*gaoliming <gaoliming@byosoft.com.cn > >> > > <mailto:gaoliming@byosoft.com.cn>> > >> > > *Sent:* Thursday, September 16, 2021 10:23 AM > >> > > *To:* 'Andrew Fish' <afish@apple.com > >> <mailto:afish@apple.com>>; > >> > > 'edk2-devel-groups-io' <devel@edk2.groups.io > >> > > <mailto:devel@edk2.groups.io>> > >> > > *Cc:* Ni, Ray <ray.ni@intel.com > >> <mailto:ray.ni@intel.com>>; Kinney, > >> > > Michael D <michael.d.kinney@intel.com > >> > > <mailto:michael.d.kinney@intel.com>>; 'Gao, Liming' > >> > > <liming.gao@intel.com <mailto:liming.gao@intel.com>>; > Liu, > >> Zhiguang > >> > > <zhiguang.liu@intel.com > <mailto:zhiguang.liu@intel.com>>; > >> Wang, > >> > Jian J > >> > > <jian.j.wang@intel.com <mailto:jian.j.wang@intel.com>>; > Gao, > >> > Zhichao > >> > > <zhichao.gao@intel.com > <mailto:zhichao.gao@intel.com>>; > >> Chan, Amy > >> > > <amy.chan@intel.com <mailto:amy.chan@intel.com>> > >> > > *Subject:* 回复: [edk2-devel] RFC: Add > BaseLib/QuickSort in > >> MdePkg > >> > > > >> > > Andrew: > >> > > > >> > > Thanks for your suggestion. I think your idea is better. > >> We add new > >> > > QuickSort() API to BaseLib, and update SortLib library > >> instance to > >> > > consume BaseLib QuickSort() API. This way has no change > in > >> current > >> > > SortLib library class. It is the compatible solution. > >> > > > >> > > Thanks > >> > > > >> > > Liming > >> > > > >> > > *发件人**:*Andrew Fish <afish@apple.com > >> <mailto:afish@apple.com>> > >> > > *发送时间:* 2021年9月16日 10:13 > >> > > *收件人:* edk2-devel-groups-io <devel@edk2.groups.io > >> > > <mailto:devel@edk2.groups.io>>; Liming Gao > >> > <gaoliming@byosoft.com.cn > >> > > <mailto:gaoliming@byosoft.com.cn>> > >> > > *抄送:* Ni, Ray <ray.ni@intel.com > >> <mailto:ray.ni@intel.com>>; Mike > >> > > Kinney <michael.d.kinney@intel.com > >> > > <mailto:michael.d.kinney@intel.com>>; Gao, Liming > >> > > <liming.gao@intel.com <mailto:liming.gao@intel.com>>; > Liu, > >> Zhiguang > >> > > <zhiguang.liu@intel.com > <mailto:zhiguang.liu@intel.com>>; > >> Wang, > >> > Jian J > >> > > <jian.j.wang@intel.com <mailto:jian.j.wang@intel.com>>; > Gao, > >> > Zhichao > >> > > <zhichao.gao@intel.com > <mailto:zhichao.gao@intel.com>>; > >> Chan, Amy > >> > > <amy.chan@intel.com <mailto:amy.chan@intel.com>> > >> > > *主题:* Re: [edk2-devel] RFC: Add BaseLib/QuickSort in > MdePkg > >> > > > >> > > On Sep 15, 2021, at 6:26 PM, gaoliming > >> <gaoliming@byosoft.com.cn > >> > > <mailto:gaoliming@byosoft.com.cn>> wrote: > >> > > > >> > > Ray: > >> > > > >> > > SortLib has been added since 2015. I would > suggest to > >> still keep > >> > > this library class. To resolve the package > dependency, my > >> > proposal > >> > > is to move the library class header file SortLib.h > from > >> > > MdeModulePkg to MdePkg, and still keep the > library > >> instance in > >> > > MdeModulePkg. This proposal has no impact on > the existing > >> > platform. > >> > > > >> > > If we add QuickSort() API to the BaseLib can we not just > >> port the > >> > > existing MdeModulePkg/SortLib to use QuickSort() in the > >> > > implementation? Or is there some other way to add the > new > >> thing > >> > in a > >> > > backward compatible way. > >> > > > >> > > Thanks, > >> > > > >> > > Andrew Fish > >> > > > >> > > Thanks > >> > > > >> > > Liming > >> > > > >> > > *发件人**:*devel@edk2.groups.io > >> > > <mailto:devel@edk2.groups.io><devel@edk2.groups.io > >> > > <mailto:devel@edk2.groups.io>>*代表***Ni, Ray > >> > > *发送时间:*2021年9月14日14:15 > >> > > *收件人:*Kinney, Michael D > <michael.d.kinney@intel.com > >> > > <mailto:michael.d.kinney@intel.com>>; Gao, Liming > >> > > <liming.gao@intel.com > <mailto:liming.gao@intel.com>>; Liu, > >> > > Zhiguang <zhiguang.liu@intel.com > >> > <mailto:zhiguang.liu@intel.com>>; > >> > > Wang, Jian J <jian.j.wang@intel.com > >> > > <mailto:jian.j.wang@intel.com>>; Gao, Zhichao > >> > > <zhichao.gao@intel.com > <mailto:zhichao.gao@intel.com>> > >> > > *抄送:*devel@edk2.groups.io > <mailto:devel@edk2.groups.io>; > >> > Chan, Amy > >> > > <amy.chan@intel.com > <mailto:amy.chan@intel.com>> > >> > > *主题:*[edk2-devel] RFC: Add BaseLib/QuickSort > in MdePkg > >> > > > >> > > Hi package maintainers of MdePkg, > MdeModulePkg and > >> ShellPkg, > >> > > community, > >> > > > >> > > A commit (UefiCpuPkg/CpuCacheInfoLib: Sort > >> CpuCacheInfo array > >> > > > >> > > >> > <https://github.com/tianocore/edk2/commit/4de77ae9890d241271f543e919 > 5ab3516f3abec6>) > >> > > to UefiCpuPkg let > >> > > UefiCpuPkg depend on MdeModulePkg because > the SortLib > >> class and > >> > > instances are all in MdeModulePkg. > >> > > > >> > > UefiCpuPkg depending on MdeModulePkg breaks > the rule that > >> > > “UefiCpuPkg should ONLY depend on MdePkg”. > >> > > > >> > > To address this issue, there are two approaches: > >> > > > >> > > 1. Duplicate the sort logic in UefiCpuPkg to not > >> depend on > >> > > MdeModulePkg/SortLib > >> > > 2. Add QuickSort() API to BaseLib in MdePkg. > >> > > > >> > > Approach #2 (MdePkg/BaseLib/QuickSort) makes > more > >> sense because > >> > > quick sort is a standard algorithm. > >> > > > >> > > We encourage consumers to update their code to > use the > >> quick > >> > sort > >> > > in MdePkg and gradually deprecate today’s > >> MdeModulePkg/SortLib. > >> > > > >> > > If you don’t have concerns, I plan to: > >> > > > >> > > 1. “Add QuickSort() to BaseLib” and update all > existing > >> > consumers > >> > > to use this API instead. > >> > > > >> > > VOID > >> > > > >> > > EFIAPI > >> > > > >> > > QuickSort ( > >> > > > >> > > IN OUT VOID *BufferT > oSort, > >> > > > >> > > IN CONST UINTN Count, > >> > > > >> > > IN CONST UINTN ElementSize, > >> > > > >> > > IN SORT_COMPARE Compare > Function > >> > > > >> > > ); > >> > > > >> > > 2. “Add new ShellPkg/SortCompareLib” > >> > > > >> > > Background: ShellPkg requires to sort > >> devicepath/string so 3 > >> > APIs > >> > > in UefiSortLib (DevicePathCompare, > StringNoCaseCompare, > >> > > StringCompare) are provided for Shell usage. we > can > >> move the 3 > >> > > APIs to the SortCompareLib and update Shell code > to use > >> > > BaseLib/QuickSort directly, with the sort compare > >> function from > >> > > SortCompareLib. > >> > > > >> > > Any concerns? > >> > > > >> > > Thanks, > >> > > > >> > > Ray > >> > > > >> > > > >> > > >> > > >> > >> > > > > > > > > > -- > > Brian > > -------------------------------------------------------------------- > > "Remember that ignorance is expensive." > -- From LLIB > ^ permalink raw reply [flat|nested] 21+ messages in thread
* Re: [edk2-devel] RFC: Add BaseLib/QuickSort in MdePkg 2021-09-29 0:51 ` 回复: " gaoliming @ 2021-09-29 2:42 ` Ni, Ray 0 siblings, 0 replies; 21+ messages in thread From: Ni, Ray @ 2021-09-29 2:42 UTC (permalink / raw) To: devel@edk2.groups.io, gaoliming@byosoft.com.cn, 'Brian J. Johnson', 'Marvin Häuser', fanjianfeng@byosoft.com.cn, Chan, Amy, 'Andrew Fish' Cc: Kinney, Michael D, 'Gao, Liming', Liu, Zhiguang, Wang, Jian J, Gao, Zhichao Thanks everyone. We will post patches to this mailing list that aligns to this proposal. Thanks, Ray -----Original Message----- From: devel@edk2.groups.io <devel@edk2.groups.io> On Behalf Of gaoliming Sent: Wednesday, September 29, 2021 8:51 AM To: 'Brian J. Johnson' <brian.johnson@hpe.com>; devel@edk2.groups.io; Ni, Ray <ray.ni@intel.com>; 'Marvin Häuser' <mhaeuser@posteo.de>; fanjianfeng@byosoft.com.cn; Chan, Amy <amy.chan@intel.com>; 'Andrew Fish' <afish@apple.com> Cc: Kinney, Michael D <michael.d.kinney@intel.com>; 'Gao, Liming' <liming.gao@intel.com>; Liu, Zhiguang <zhiguang.liu@intel.com>; Wang, Jian J <jian.j.wang@intel.com>; Gao, Zhichao <zhichao.gao@intel.com> Subject: 回复: [edk2-devel] RFC: Add BaseLib/QuickSort in MdePkg Johnson: I also agree this proposal to make BufferOneElement parameter mandatory. Thanks Liming > -----邮件原件----- > 发件人: Brian J. Johnson <brian.johnson@hpe.com> > 发送时间: 2021年9月29日 6:26 > 收件人: devel@edk2.groups.io; ray.ni@intel.com; Marvin Häuser > <mhaeuser@posteo.de>; fanjianfeng@byosoft.com.cn; 'gaoliming' > <gaoliming@byosoft.com.cn>; Chan, Amy <amy.chan@intel.com>; 'Andrew > Fish' <afish@apple.com> > 抄送: Kinney, Michael D <michael.d.kinney@intel.com>; 'Gao, Liming' > <liming.gao@intel.com>; Liu, Zhiguang <zhiguang.liu@intel.com>; Wang, > Jian J <jian.j.wang@intel.com>; Gao, Zhichao <zhichao.gao@intel.com> > 主题: Re: [edk2-devel] RFC: Add BaseLib/QuickSort in MdePkg > > I'll add my agreement to Marvin and Jeff: a low-level sort routine > like this should let the caller be in charge of memory allocation, so > it can be used in the widest variety of contexts (SEC, exception > handlers, APs, > etc.) So let's make the BufferOneElement parameter mandatory. > > Brian J. Johnson > > -------- Original Message -------- > From: Ni, Ray [mailto:ray.ni@intel.com] > Sent: Monday, September 27, 2021, 8:49 PM > To: Marvin Häuser <mhaeuser@posteo.de>, fanjianfeng@byosoft.com.cn > <fanjianfeng@byosoft.com.cn>, devel@edk2.groups.io > <devel@edk2.groups.io>, 'gaoliming' <gaoliming@byosoft.com.cn>, Chan, > Amy <amy.chan@intel.com>, 'Andrew Fish' <afish@apple.com> > Cc: Kinney, Michael D <michael.d.kinney@intel.com>, 'Gao, Liming' > <liming.gao@intel.com>, Liu, Zhiguang <zhiguang.liu@intel.com>, Wang, > Jian J <jian.j.wang@intel.com>, Gao, Zhichao <zhichao.gao@intel.com> > Subject: [edk2-devel] RFC: Add BaseLib/QuickSort in MdePkg > > Marvin, > I agree with your concerns, in a certain level. But I didn't treat it > as a very big problem of having caller pass the BufferOneElement > "intelligently". > > I am ok to use your option 1), making BufferOneElement mandatory. > Caller should always supply the buffer that's sufficient to hold one > element. > > By the way, I don't want to propose "swap-without-using-temporary-value" > method to avoid using the "BufferOneElement"? > Because that makes the simple thing complicated! > > Thanks, > Ray > > > -----Original Message----- > > From: Marvin Häuser <mhaeuser@posteo.de> > > Sent: Monday, September 27, 2021 5:09 PM > > To: fanjianfeng@byosoft.com.cn; devel@edk2.groups.io; Ni, Ray > <ray.ni@intel.com>; 'gaoliming' > > <gaoliming@byosoft.com.cn>; Chan, Amy <amy.chan@intel.com>; 'Andrew > Fish' <afish@apple.com> > > Cc: Kinney, Michael D <michael.d.kinney@intel.com>; 'Gao, Liming' > <liming.gao@intel.com>; Liu, Zhiguang > > <zhiguang.liu@intel.com>; Wang, Jian J <jian.j.wang@intel.com>; Gao, > Zhichao <zhichao.gao@intel.com> > > Subject: Re: [edk2-devel] RFC: Add BaseLib/QuickSort in MdePkg > > > > On 27/09/2021 10:50, fanjianfeng@byosoft.com.cn wrote: > >> For former caller, they could still keep as is to call the old API > >> in MdeModulePkg. I think Ray's design is compatible change for existing code. > >> Only when the existing code wants to remove the dependency on > >> MdeModuelPkg, they could migrate to the new API in baselib. > >> > >> I agree with one split-API desgin what you mentioned. > >> But my point is to define one API in baselib and to make the > >> baselib not depend on memory allocation. And another wrapper API > >> could be designed to be placed in any other class. > > > > Oh sure, it could totally live in another class. I'd just like to > > have those two models (caller- and callee-owned buffer) strictly > > separate, I personally do not mind where exactly they are implemented. Thanks! > > > > Best regards, > > Marvin > > > >> > >> ------------------------------------------------------------------- > >> ----- > >> Jeff > >> fanjianfeng@byosoft.com.cn > >> > >> *From:* Marvin Häuser <mailto:mhaeuser@posteo.de> > >> *Date:* 2021-09-27 16:14 > >> *To:* fanjianfeng@byosoft.com.cn > >> <mailto:fanjianfeng@byosoft.com.cn>; devel@edk2.groups.io > >> <mailto:devel@edk2.groups.io>; Ni, Ray <mailto:ray.ni@intel.com>; > >> 'gaoliming' <mailto:gaoliming@byosoft.com.cn>; Chan, Amy > >> <mailto:amy.chan@intel.com>; 'Andrew Fish' > <mailto:afish@apple.com> > >> *CC:* Kinney, Michael D <mailto:michael.d.kinney@intel.com>; > 'Gao, > >> Liming' <mailto:liming.gao@intel.com>; Liu, Zhiguang > >> <mailto:zhiguang.liu@intel.com>; Wang, Jian J > >> <mailto:jian.j.wang@intel.com>; Gao, Zhichao > >> <mailto:zhichao.gao@intel.com> > >> *Subject:* Re: [edk2-devel] RFC: Add BaseLib/QuickSort in > MdePkg > >> On 27/09/2021 02:45, fanjianfeng@byosoft.com.cn wrote: > >> > Making baselib implementation depend on MemoryAllocationLib > >> > (indirectly on Pei Service and gBS), it may prevent > >> > this base API using at some seneraio. i don't think it's better. > >> That is why I asked about a split-API scenario, one of which > >> does > not > >> depend on dynamic memory allocation (SetVariable-like) and one > does > >> (wrapper-like). > >> > Add this parameter and make this parameter is optional, > >> > 1, when NULL, use the local 256 bytes stack > >> > 2, if 256 bytes stack is not enough, return > RETURE_BUFFER_TOO_SAMLL, > >> > 3, caller check the return status, to do nothing or to allocate > >> enough > >> > buffer for retry > >> > > >> > This is just like SetVariable()'s implementation. > >> Yes, and because that is SetVariable's implementation, we have > >> library > >> functions to make it less error-prone and more convenient [1]. As a > >> matter of fact, we have a (semi-lax) policy in our codebases to avoid > >> such functions like the plague and use those library wrappers > >> where-ever > >> it can make sense. The only super-rare exceptions I can think of are > >> when we know the size of the element ahead of time. Also > >> SetVariable has > >> no arbitrary constraint on when it may work the first time, and > >> there is > >> code that will fail when the first return is not > EFI_BUFFER_TOO_SMALL. > >> This solution honestly yields even more problems, because it > >> introduces > >> a Status return which was not there before. For common code > safety > >> and > >> quality policy, this requires the value *must* be retrieved and > >> checked > >> in some fashion. So all callers, no matter the prior knowledge of the > >> element size, now need either a runtime check and handling for a > >> status > >> that they (may) know can never be returned, or ASSERTs if the > >> function > >> spec really imposes the arbitrary 256 Bytes constraint. Latter > >> doesn't > >> really work I think. What if someone wants to sort in SEC and > noticed > >> they only have 64 Bytes on the stack to work with, realistically? Any > >> code depending on the 256 Byte constraint, passing NULL and > >> not > doing > >> additional handling, would seize to work. Former is too > >> complicated, see > >> wrappers. In my opinion, the memory must *either* be fully > managed by > >> the caller *or* the callee (and you may have both in separate > >> functions, > >> as I suggested), but not sometimes here, sometimes there. > >> Best regards, > >> Marvin > >> [1] > >> > > > https://github.com/tianocore/edk2/blob/46b4606ba23498d3d0e66b53e498e > b3d5d592586/MdePkg/Library/UefiLib/UefiLib.c#L > > 1309-L1360 > >> > > >> > > >> ------------------------------------------------------------------------ > >> > Jeff > >> > fanjianfeng@byosoft.com.cn > >> > > >> > *From:* Marvin Häuser <mailto:mhaeuser@posteo.de> > >> > *Date:* 2021-09-26 19:20 > >> > *To:* devel <mailto:devel@edk2.groups.io>; ray.ni > >> > <mailto:ray.ni@intel.com>; gaoliming > >> > <mailto:gaoliming@byosoft.com.cn>; Chan, Amy > >> > <mailto:amy.chan@intel.com>; 'Andrew Fish' > >> <mailto:afish@apple.com> > >> > *CC:* Kinney, Michael D > <mailto:michael.d.kinney@intel.com>; > >> 'Gao, > >> > Liming' <mailto:liming.gao@intel.com>; Liu, Zhiguang > >> > <mailto:zhiguang.liu@intel.com>; Wang, Jian J > >> > <mailto:jian.j.wang@intel.com>; Gao, Zhichao > >> > <mailto:zhichao.gao@intel.com> > >> > *Subject:* Re: [edk2-devel] RFC: Add BaseLib/QuickSort > in MdePkg > >> > Hey Ray, > >> > In my opinion that spec is too complicated. For some cases > it is > >> > obvious, but I think the last anyone wants to see is a > >> > (STATIC_)ASSERT > >> > before most QuickSort calls to ensure the element size > >> *really* is <= > >> > 256 Bytes. In my opinion, there are two roads: > >> > 1) Make the parameter required (I think this is what Liming > >> > suggested). > >> > The caller would always need to provide said buffer, and it > >> can do > >> > as it > >> > sees fit - on the stack, in a pool, in a page, who knows. > >> > 2) Remove the parameter entirely. The library would > depend on > >> > MemoryAllocationLib again, but also would have an > >> optimisation by > >> > choosing stack vs pool based on ElementSize. > >> > Usually I would prefer 2), as it is less prone to caller > >> errors, but > >> > considering the low-level nature of edk2, I can totally see > the > >> > point to > >> > allow the caller to control whether there are dynamic > memory > >> > allocations > >> > made or not as possible with 1). 2) could technically also be > a > >> > wrapper > >> > for 1) if you want granular control and convenience/safety > >> (why not > >> > actually?). > >> > Both approaches have the advantage that it is crystal-clear > >> what the > >> > caller's job is - to always or to never allocate the buffer. > >> > Best regards, > >> > Marvin > >> > On 26/09/2021 04:24, Ni, Ray wrote: > >> > > > >> > > Liming, > >> > > > >> > > The purpose of the optional BufferOneElement is to ease > >> consumer’s > >> > > life assuming most of the time the element size should be > >> > smaller than > >> > > 256. > >> > > > >> > > Are you saying that it’s a bit hard to calculate the actual > >> > value of > >> > > sizeof (Element) when writing code? > >> > > > >> > > I recommend consumer always allocates memory if it’s > hard > >> to judge > >> > > sizeof (Element) < 256. > >> > > > >> > > Searching edk2 code, I can find below code using > >> PerformQuickSort(): > >> > > > >> > > 1. ShellPkg/UefiShellCommandLib: It’s sorting array of > >> > > (EFI_DEVICE_PATH_PROTOCOL *). > >> > > 2. UefiCpuPkg/CpuCacheInfoLib: It’s sorting array of > >> > CPU_CACHE_INFO. > >> > > 3. MinPlatformPkg/AcpiTables: It’s sorting array of > >> > EFI_CPU_ID_ORDER_MAP. > >> > > 4. MdeModulePkg/UefiBootManagerLib: It’s sorting > array of > >> > > EFI_BOOT_MANAGER_LOAD_OPTION. > >> > > 5. MdeModulePkg/CapsuleApp: It’s sorting array of > >> (EFI_FILE_INFO *) > >> > > 6. CryptoPkg/CrtWrapper: It’s sorting array of > (unknown > >> type). > >> > > 7. RedfishPkg/RedfishCrtLib: It’s sorting array of > >> (unknown type). > >> > > > >> > > For 1~5, it’s easy to know that the size of the element is > >> smaller > >> > > than 256. The AllocatePool() can be skipped. > >> > > > >> > > Thanks, > >> > > > >> > > Ray > >> > > > >> > > *From:*gaoliming <gaoliming@byosoft.com.cn> > >> > > *Sent:* Sunday, September 26, 2021 10:01 AM > >> > > *To:* Ni, Ray <ray.ni@intel.com>; devel@edk2.groups.io; > >> Chan, Amy > >> > > <amy.chan@intel.com>; 'Andrew Fish' > <afish@apple.com> > >> > > *Cc:* Kinney, Michael D <michael.d.kinney@intel.com>; > >> 'Gao, Liming' > >> > > <liming.gao@intel.com>; Liu, Zhiguang > >> <zhiguang.liu@intel.com>; > >> > Wang, > >> > > Jian J <jian.j.wang@intel.com>; Gao, Zhichao > >> <zhichao.gao@intel.com> > >> > > *Subject:* 回复: [edk2-devel] RFC: Add > BaseLib/QuickSort in > >> MdePkg > >> > > > >> > > Ray: > >> > > > >> > > I may suggest to always require BufferOneElement. The > >> consumer code > >> > > may not know ElementSize. To avoid the error, the > consumer > >> must > >> > > allocate buffer for BufferOneElement. If so, > >> BufferOneElement is > >> > the > >> > > required parameter. > >> > > > >> > > Thanks > >> > > > >> > > Liming > >> > > > >> > > *发件人**:*Ni, Ray <ray.ni@intel.com > >> <mailto:ray.ni@intel.com>> > >> > > *发送时间:* 2021年9月24日 11:53 > >> > > *收件人:* devel@edk2.groups.io > <mailto:devel@edk2.groups.io>; > >> Ni, > >> > Ray > >> > > <ray.ni@intel.com <mailto:ray.ni@intel.com>>; Chan, > Amy > >> > > <amy.chan@intel.com <mailto:amy.chan@intel.com>>; > gaoliming > >> > > <gaoliming@byosoft.com.cn > <mailto:gaoliming@byosoft.com.cn>>; > >> > 'Andrew > >> > > Fish' <afish@apple.com <mailto:afish@apple.com>> > >> > > *抄送:* Kinney, Michael D <michael.d.kinney@intel.com > >> > > <mailto:michael.d.kinney@intel.com>>; 'Gao, Liming' > >> > > <liming.gao@intel.com <mailto:liming.gao@intel.com>>; > Liu, > >> Zhiguang > >> > > <zhiguang.liu@intel.com > <mailto:zhiguang.liu@intel.com>>; > >> Wang, > >> > Jian J > >> > > <jian.j.wang@intel.com <mailto:jian.j.wang@intel.com>>; > Gao, > >> > Zhichao > >> > > <zhichao.gao@intel.com > <mailto:zhichao.gao@intel.com>> > >> > > *主题:* RE: [edk2-devel] RFC: Add BaseLib/QuickSort in > MdePkg > >> > > > >> > > More details on new QuickSort() API: > >> > > > >> > > The new API needs to carry additional parameter > >> “BufferOneElement”. > >> > > > >> > > This parameter gives QuickSort() the temporary buffer for > >> > swapping in > >> > > sorting. > >> > > > >> > > It’s to avoid BaseLib depends on MemoryAllocationLib. > >> > > > >> > > … > >> > > > >> > > @param [in] BufferOneElement When ElementSize > > 256, caller > >> > needs to > >> > > provide a buffer whose size > >> > > equals to > ElementSize. It’s > >> used by > >> > > QuickSort() for swapping in sorting. > >> > > > >> > > When ElementSize <= 256, QuickSort() uses a local stack > >> 256-byte > >> > buffer. > >> > > > >> > > @retval EFI_INVALID_PARAMETER When (ElementSize > > 256) and > >> > > (BufferOneElement == NULL). > >> > > > >> > > … > >> > > > >> > > VOID > >> > > > >> > > EFIAPI > >> > > > >> > > QuickSort ( > >> > > > >> > > IN OUT > VOID *BufferToSort, > >> > > > >> > > IN CONST UINTN ElementCount, > >> > > > >> > > IN CONST UINTN ElementSize, > >> > > > >> > > IN SORT_COMPARE CompareFunction, > >> > > > >> > > IN VOID *BufferOneElement OPTIONAL > >> > > > >> > > ); > >> > > > >> > > Any comments? > >> > > > >> > > *From:*devel@edk2.groups.io > <mailto:devel@edk2.groups.io> > >> > > <devel@edk2.groups.io <mailto:devel@edk2.groups.io>> > *On > >> Behalf Of > >> > > *Ni, Ray > >> > > *Sent:* Wednesday, September 22, 2021 2:04 PM > >> > > *To:* Chan, Amy <amy.chan@intel.com > >> <mailto:amy.chan@intel.com>>; > >> > > gaoliming <gaoliming@byosoft.com.cn > >> > > <mailto:gaoliming@byosoft.com.cn>>; 'Andrew Fish' > >> <afish@apple.com > >> > > <mailto:afish@apple.com>>; 'edk2-devel-groups-io' > >> > > <devel@edk2.groups.io <mailto:devel@edk2.groups.io>> > >> > > *Cc:* Kinney, Michael D <michael.d.kinney@intel.com > >> > > <mailto:michael.d.kinney@intel.com>>; 'Gao, Liming' > >> > > <liming.gao@intel.com <mailto:liming.gao@intel.com>>; > Liu, > >> Zhiguang > >> > > <zhiguang.liu@intel.com > <mailto:zhiguang.liu@intel.com>>; > >> Wang, > >> > Jian J > >> > > <jian.j.wang@intel.com <mailto:jian.j.wang@intel.com>>; > Gao, > >> > Zhichao > >> > > <zhichao.gao@intel.com > <mailto:zhichao.gao@intel.com>> > >> > > *Subject:* Re: [edk2-devel] RFC: Add BaseLib/QuickSort > in > >> MdePkg > >> > > > >> > > I don’t see objection so far. > >> > > > >> > > So, the final solution is: > >> > > > >> > > 1. Add QuickSort() API to BaseLib in MdePkg. > >> > > 2. Update existing MdeModulePkg/SortLib to use > >> QuickSort() in the > >> > > implementation (proposed by Andrew Fish and > Liming Gao) > >> > > 3. Update UefiCpuPkg to use QuickSortLib to remove > improper > >> > > dependency on MdeModulePkg > >> > > > >> > > Thanks, > >> > > > >> > > Ray > >> > > > >> > > *From:*Ni, Ray > >> > > *Sent:* Thursday, September 16, 2021 10:48 AM > >> > > *To:* Chan, Amy <amy.chan@intel.com > >> <mailto:amy.chan@intel.com>>; > >> > > gaoliming <gaoliming@byosoft.com.cn > >> > > <mailto:gaoliming@byosoft.com.cn>>; 'Andrew Fish' > >> <afish@apple.com > >> > > <mailto:afish@apple.com>>; 'edk2-devel-groups-io' > >> > > <devel@edk2.groups.io <mailto:devel@edk2.groups.io>> > >> > > *Cc:* Kinney, Michael D <michael.d.kinney@intel.com > >> > > <mailto:michael.d.kinney@intel.com>>; 'Gao, Liming' > >> > > <liming.gao@intel.com <mailto:liming.gao@intel.com>>; > Liu, > >> Zhiguang > >> > > <Zhiguang.Liu@intel.com > <mailto:Zhiguang.Liu@intel.com>>; > >> Wang, > >> > Jian J > >> > > <jian.j.wang@intel.com <mailto:jian.j.wang@intel.com>>; > Gao, > >> > Zhichao > >> > > <zhichao.gao@intel.com > <mailto:zhichao.gao@intel.com>> > >> > > *Subject:* RE: [edk2-devel] RFC: Add BaseLib/QuickSort > in > >> MdePkg > >> > > > >> > > Amy, > >> > > > >> > > No. We only Add QuickSort() function API into BaseLib.h. > >> > > > >> > > *From:*Chan, Amy <amy.chan@intel.com > >> <mailto:amy.chan@intel.com>> > >> > > *Sent:* Thursday, September 16, 2021 10:46 AM > >> > > *To:* gaoliming <gaoliming@byosoft.com.cn > >> > > <mailto:gaoliming@byosoft.com.cn>>; 'Andrew Fish' > >> <afish@apple.com > >> > > <mailto:afish@apple.com>>; 'edk2-devel-groups-io' > >> > > <devel@edk2.groups.io <mailto:devel@edk2.groups.io>> > >> > > *Cc:* Ni, Ray <ray.ni@intel.com > >> <mailto:ray.ni@intel.com>>; Kinney, > >> > > Michael D <michael.d.kinney@intel.com > >> > > <mailto:michael.d.kinney@intel.com>>; 'Gao, Liming' > >> > > <liming.gao@intel.com <mailto:liming.gao@intel.com>>; > Liu, > >> Zhiguang > >> > > <zhiguang.liu@intel.com > <mailto:zhiguang.liu@intel.com>>; > >> Wang, > >> > Jian J > >> > > <jian.j.wang@intel.com <mailto:jian.j.wang@intel.com>>; > Gao, > >> > Zhichao > >> > > <zhichao.gao@intel.com > <mailto:zhichao.gao@intel.com>> > >> > > *Subject:* RE: [edk2-devel] RFC: Add BaseLib/QuickSort > in > >> MdePkg > >> > > > >> > > Just to double confirm, will we have the null instance of > >> > QuickSort in > >> > > MdePkg? > >> > > > >> > > Regards, > >> > > > >> > > Amy > >> > > > >> > > *From:*gaoliming <gaoliming@byosoft.com.cn > >> > > <mailto:gaoliming@byosoft.com.cn>> > >> > > *Sent:* Thursday, September 16, 2021 10:23 AM > >> > > *To:* 'Andrew Fish' <afish@apple.com > >> <mailto:afish@apple.com>>; > >> > > 'edk2-devel-groups-io' <devel@edk2.groups.io > >> > > <mailto:devel@edk2.groups.io>> > >> > > *Cc:* Ni, Ray <ray.ni@intel.com > >> <mailto:ray.ni@intel.com>>; Kinney, > >> > > Michael D <michael.d.kinney@intel.com > >> > > <mailto:michael.d.kinney@intel.com>>; 'Gao, Liming' > >> > > <liming.gao@intel.com <mailto:liming.gao@intel.com>>; > Liu, > >> Zhiguang > >> > > <zhiguang.liu@intel.com > <mailto:zhiguang.liu@intel.com>>; > >> Wang, > >> > Jian J > >> > > <jian.j.wang@intel.com <mailto:jian.j.wang@intel.com>>; > Gao, > >> > Zhichao > >> > > <zhichao.gao@intel.com > <mailto:zhichao.gao@intel.com>>; > >> Chan, Amy > >> > > <amy.chan@intel.com <mailto:amy.chan@intel.com>> > >> > > *Subject:* 回复: [edk2-devel] RFC: Add > BaseLib/QuickSort in > >> MdePkg > >> > > > >> > > Andrew: > >> > > > >> > > Thanks for your suggestion. I think your idea is better. > >> We add new > >> > > QuickSort() API to BaseLib, and update SortLib library > >> instance to > >> > > consume BaseLib QuickSort() API. This way has no change > in > >> current > >> > > SortLib library class. It is the compatible solution. > >> > > > >> > > Thanks > >> > > > >> > > Liming > >> > > > >> > > *发件人**:*Andrew Fish <afish@apple.com > >> <mailto:afish@apple.com>> > >> > > *发送时间:* 2021年9月16日 10:13 > >> > > *收件人:* edk2-devel-groups-io <devel@edk2.groups.io > >> > > <mailto:devel@edk2.groups.io>>; Liming Gao > >> > <gaoliming@byosoft.com.cn > >> > > <mailto:gaoliming@byosoft.com.cn>> > >> > > *抄送:* Ni, Ray <ray.ni@intel.com > >> <mailto:ray.ni@intel.com>>; Mike > >> > > Kinney <michael.d.kinney@intel.com > >> > > <mailto:michael.d.kinney@intel.com>>; Gao, Liming > >> > > <liming.gao@intel.com <mailto:liming.gao@intel.com>>; > Liu, > >> Zhiguang > >> > > <zhiguang.liu@intel.com > <mailto:zhiguang.liu@intel.com>>; > >> Wang, > >> > Jian J > >> > > <jian.j.wang@intel.com <mailto:jian.j.wang@intel.com>>; > Gao, > >> > Zhichao > >> > > <zhichao.gao@intel.com > <mailto:zhichao.gao@intel.com>>; > >> Chan, Amy > >> > > <amy.chan@intel.com <mailto:amy.chan@intel.com>> > >> > > *主题:* Re: [edk2-devel] RFC: Add BaseLib/QuickSort in > MdePkg > >> > > > >> > > On Sep 15, 2021, at 6:26 PM, gaoliming > >> <gaoliming@byosoft.com.cn > >> > > <mailto:gaoliming@byosoft.com.cn>> wrote: > >> > > > >> > > Ray: > >> > > > >> > > SortLib has been added since 2015. I would > suggest to > >> still keep > >> > > this library class. To resolve the package > dependency, my > >> > proposal > >> > > is to move the library class header file SortLib.h > from > >> > > MdeModulePkg to MdePkg, and still keep the > library > >> instance in > >> > > MdeModulePkg. This proposal has no impact on > the existing > >> > platform. > >> > > > >> > > If we add QuickSort() API to the BaseLib can we not just > >> port the > >> > > existing MdeModulePkg/SortLib to use QuickSort() in the > >> > > implementation? Or is there some other way to add the > new > >> thing > >> > in a > >> > > backward compatible way. > >> > > > >> > > Thanks, > >> > > > >> > > Andrew Fish > >> > > > >> > > Thanks > >> > > > >> > > Liming > >> > > > >> > > *发件人**:*devel@edk2.groups.io > >> > > <mailto:devel@edk2.groups.io><devel@edk2.groups.io > >> > > <mailto:devel@edk2.groups.io>>*代表***Ni, Ray > >> > > *发送时间:*2021年9月14日14:15 > >> > > *收件人:*Kinney, Michael D > <michael.d.kinney@intel.com > >> > > <mailto:michael.d.kinney@intel.com>>; Gao, Liming > >> > > <liming.gao@intel.com > <mailto:liming.gao@intel.com>>; Liu, > >> > > Zhiguang <zhiguang.liu@intel.com > >> > <mailto:zhiguang.liu@intel.com>>; > >> > > Wang, Jian J <jian.j.wang@intel.com > >> > > <mailto:jian.j.wang@intel.com>>; Gao, Zhichao > >> > > <zhichao.gao@intel.com > <mailto:zhichao.gao@intel.com>> > >> > > *抄送:*devel@edk2.groups.io > <mailto:devel@edk2.groups.io>; > >> > Chan, Amy > >> > > <amy.chan@intel.com > <mailto:amy.chan@intel.com>> > >> > > *主题:*[edk2-devel] RFC: Add BaseLib/QuickSort > in MdePkg > >> > > > >> > > Hi package maintainers of MdePkg, > MdeModulePkg and > >> ShellPkg, > >> > > community, > >> > > > >> > > A commit (UefiCpuPkg/CpuCacheInfoLib: Sort > >> CpuCacheInfo array > >> > > > >> > > >> > <https://github.com/tianocore/edk2/commit/4de77ae9890d241271f543e919 > 5ab3516f3abec6>) > >> > > to UefiCpuPkg let > >> > > UefiCpuPkg depend on MdeModulePkg because > the SortLib > >> class and > >> > > instances are all in MdeModulePkg. > >> > > > >> > > UefiCpuPkg depending on MdeModulePkg breaks > the rule that > >> > > “UefiCpuPkg should ONLY depend on MdePkg”. > >> > > > >> > > To address this issue, there are two approaches: > >> > > > >> > > 1. Duplicate the sort logic in UefiCpuPkg to not > >> depend on > >> > > MdeModulePkg/SortLib > >> > > 2. Add QuickSort() API to BaseLib in MdePkg. > >> > > > >> > > Approach #2 (MdePkg/BaseLib/QuickSort) makes > more > >> sense because > >> > > quick sort is a standard algorithm. > >> > > > >> > > We encourage consumers to update their code to > use the > >> quick > >> > sort > >> > > in MdePkg and gradually deprecate today’s > >> MdeModulePkg/SortLib. > >> > > > >> > > If you don’t have concerns, I plan to: > >> > > > >> > > 1. “Add QuickSort() to BaseLib” and update all > existing > >> > consumers > >> > > to use this API instead. > >> > > > >> > > VOID > >> > > > >> > > EFIAPI > >> > > > >> > > QuickSort ( > >> > > > >> > > IN OUT VOID *BufferT > oSort, > >> > > > >> > > IN CONST UINTN Count, > >> > > > >> > > IN CONST UINTN ElementSize, > >> > > > >> > > IN SORT_COMPARE Compare > Function > >> > > > >> > > ); > >> > > > >> > > 2. “Add new ShellPkg/SortCompareLib” > >> > > > >> > > Background: ShellPkg requires to sort > >> devicepath/string so 3 > >> > APIs > >> > > in UefiSortLib (DevicePathCompare, > StringNoCaseCompare, > >> > > StringCompare) are provided for Shell usage. we > can > >> move the 3 > >> > > APIs to the SortCompareLib and update Shell code > to use > >> > > BaseLib/QuickSort directly, with the sort compare > >> function from > >> > > SortCompareLib. > >> > > > >> > > Any concerns? > >> > > > >> > > Thanks, > >> > > > >> > > Ray > >> > > > >> > > > >> > > >> > > >> > >> > > > > > > > > > -- > > Brian > > -------------------------------------------------------------------- > > "Remember that ignorance is expensive." > -- From LLIB > ^ permalink raw reply [flat|nested] 21+ messages in thread
[parent not found: <16A8A1ADDB4E97C4.26412@groups.io>]
* Re: [edk2-devel] RFC: Add BaseLib/QuickSort in MdePkg [not found] ` <16A8A1ADDB4E97C4.26412@groups.io> @ 2021-09-27 9:06 ` Jeff Fan 0 siblings, 0 replies; 21+ messages in thread From: Jeff Fan @ 2021-09-27 9:06 UTC (permalink / raw) To: devel@edk2.groups.io, fanjianfeng, mhaeuser, Ni, Ray, 'gaoliming', Chan, Amy, 'Andrew Fish' Cc: Kinney, Michael D, 'Gao, Liming', Liu, Zhiguang, Wang, Jian J, Gao, Zhichao [-- Attachment #1: Type: text/plain, Size: 20871 bytes --] In fact, my concern is that making BaseLib's APIs depend on PeiService & Boot Services is not good. For a instance, AP functions by MP service are not allowed to invoke any PeriServices and Boot Services. And exception handlers cannot invoke those services either. Jeff fanjianfeng@byosoft.com.cn From: Jeff Fan Date: 2021-09-27 16:50 To: devel@edk2.groups.io; mhaeuser; Ni, Ray; 'gaoliming'; Chan, Amy; 'Andrew Fish' CC: Kinney, Michael D; 'Gao, Liming'; Liu, Zhiguang; Wang, Jian J; Gao, Zhichao Subject: Re: [edk2-devel] RFC: Add BaseLib/QuickSort in MdePkg For former caller, they could still keep as is to call the old API in MdeModulePkg. I think Ray's design is compatible change for existing code. Only when the existing code wants to remove the dependency on MdeModuelPkg, they could migrate to the new API in baselib. I agree with one split-API desgin what you mentioned. But my point is to define one API in baselib and to make the baselib not depend on memory allocation. And another wrapper API could be designed to be placed in any other class. Jeff fanjianfeng@byosoft.com.cn From: Marvin Häuser Date: 2021-09-27 16:14 To: fanjianfeng@byosoft.com.cn; devel@edk2.groups.io; Ni, Ray; 'gaoliming'; Chan, Amy; 'Andrew Fish' CC: Kinney, Michael D; 'Gao, Liming'; Liu, Zhiguang; Wang, Jian J; Gao, Zhichao Subject: Re: [edk2-devel] RFC: Add BaseLib/QuickSort in MdePkg On 27/09/2021 02:45, fanjianfeng@byosoft.com.cn wrote: > Making baselib implementation depend on MemoryAllocationLib > (indirectly on Pei Service and gBS), it may prevent > this base API using at some seneraio. i don't think it's better. That is why I asked about a split-API scenario, one of which does not depend on dynamic memory allocation (SetVariable-like) and one does (wrapper-like). > Add this parameter and make this parameter is optional, > 1, when NULL, use the local 256 bytes stack > 2, if 256 bytes stack is not enough, return RETURE_BUFFER_TOO_SAMLL, > 3, caller check the return status, to do nothing or to allocate enough > buffer for retry > > This is just like SetVariable()'s implementation. Yes, and because that is SetVariable's implementation, we have library functions to make it less error-prone and more convenient [1]. As a matter of fact, we have a (semi-lax) policy in our codebases to avoid such functions like the plague and use those library wrappers where-ever it can make sense. The only super-rare exceptions I can think of are when we know the size of the element ahead of time. Also SetVariable has no arbitrary constraint on when it may work the first time, and there is code that will fail when the first return is not EFI_BUFFER_TOO_SMALL. This solution honestly yields even more problems, because it introduces a Status return which was not there before. For common code safety and quality policy, this requires the value *must* be retrieved and checked in some fashion. So all callers, no matter the prior knowledge of the element size, now need either a runtime check and handling for a status that they (may) know can never be returned, or ASSERTs if the function spec really imposes the arbitrary 256 Bytes constraint. Latter doesn't really work I think. What if someone wants to sort in SEC and noticed they only have 64 Bytes on the stack to work with, realistically? Any code depending on the 256 Byte constraint, passing NULL and not doing additional handling, would seize to work. Former is too complicated, see wrappers. In my opinion, the memory must *either* be fully managed by the caller *or* the callee (and you may have both in separate functions, as I suggested), but not sometimes here, sometimes there. Best regards, Marvin [1] https://github.com/tianocore/edk2/blob/46b4606ba23498d3d0e66b53e498eb3d5d592586/MdePkg/Library/UefiLib/UefiLib.c#L1309-L1360 > > ------------------------------------------------------------------------ > Jeff > fanjianfeng@byosoft.com.cn > > *From:* Marvin Häuser <mailto:mhaeuser@posteo.de> > *Date:* 2021-09-26 19:20 > *To:* devel <mailto:devel@edk2.groups.io>; ray.ni > <mailto:ray.ni@intel.com>; gaoliming > <mailto:gaoliming@byosoft.com.cn>; Chan, Amy > <mailto:amy.chan@intel.com>; 'Andrew Fish' <mailto:afish@apple.com> > *CC:* Kinney, Michael D <mailto:michael.d.kinney@intel.com>; 'Gao, > Liming' <mailto:liming.gao@intel.com>; Liu, Zhiguang > <mailto:zhiguang.liu@intel.com>; Wang, Jian J > <mailto:jian.j.wang@intel.com>; Gao, Zhichao > <mailto:zhichao.gao@intel.com> > *Subject:* Re: [edk2-devel] RFC: Add BaseLib/QuickSort in MdePkg > Hey Ray, > In my opinion that spec is too complicated. For some cases it is > obvious, but I think the last anyone wants to see is a > (STATIC_)ASSERT > before most QuickSort calls to ensure the element size *really* is <= > 256 Bytes. In my opinion, there are two roads: > 1) Make the parameter required (I think this is what Liming > suggested). > The caller would always need to provide said buffer, and it can do > as it > sees fit - on the stack, in a pool, in a page, who knows. > 2) Remove the parameter entirely. The library would depend on > MemoryAllocationLib again, but also would have an optimisation by > choosing stack vs pool based on ElementSize. > Usually I would prefer 2), as it is less prone to caller errors, but > considering the low-level nature of edk2, I can totally see the > point to > allow the caller to control whether there are dynamic memory > allocations > made or not as possible with 1). 2) could technically also be a > wrapper > for 1) if you want granular control and convenience/safety (why not > actually?). > Both approaches have the advantage that it is crystal-clear what the > caller's job is - to always or to never allocate the buffer. > Best regards, > Marvin > On 26/09/2021 04:24, Ni, Ray wrote: > > > > Liming, > > > > The purpose of the optional BufferOneElement is to ease consumer’s > > life assuming most of the time the element size should be > smaller than > > 256. > > > > Are you saying that it’s a bit hard to calculate the actual > value of > > sizeof (Element) when writing code? > > > > I recommend consumer always allocates memory if it’s hard to judge > > sizeof (Element) < 256. > > > > Searching edk2 code, I can find below code using PerformQuickSort(): > > > > 1. ShellPkg/UefiShellCommandLib: It’s sorting array of > > (EFI_DEVICE_PATH_PROTOCOL *). > > 2. UefiCpuPkg/CpuCacheInfoLib: It’s sorting array of > CPU_CACHE_INFO. > > 3. MinPlatformPkg/AcpiTables: It’s sorting array of > EFI_CPU_ID_ORDER_MAP. > > 4. MdeModulePkg/UefiBootManagerLib: It’s sorting array of > > EFI_BOOT_MANAGER_LOAD_OPTION. > > 5. MdeModulePkg/CapsuleApp: It’s sorting array of (EFI_FILE_INFO *) > > 6. CryptoPkg/CrtWrapper: It’s sorting array of (unknown type). > > 7. RedfishPkg/RedfishCrtLib: It’s sorting array of (unknown type). > > > > For 1~5, it’s easy to know that the size of the element is smaller > > than 256. The AllocatePool() can be skipped. > > > > Thanks, > > > > Ray > > > > *From:*gaoliming <gaoliming@byosoft.com.cn> > > *Sent:* Sunday, September 26, 2021 10:01 AM > > *To:* Ni, Ray <ray.ni@intel.com>; devel@edk2.groups.io; Chan, Amy > > <amy.chan@intel.com>; 'Andrew Fish' <afish@apple.com> > > *Cc:* Kinney, Michael D <michael.d.kinney@intel.com>; 'Gao, Liming' > > <liming.gao@intel.com>; Liu, Zhiguang <zhiguang.liu@intel.com>; > Wang, > > Jian J <jian.j.wang@intel.com>; Gao, Zhichao <zhichao.gao@intel.com> > > *Subject:* 回复: [edk2-devel] RFC: Add BaseLib/QuickSort in MdePkg > > > > Ray: > > > > I may suggest to always require BufferOneElement. The consumer code > > may not know ElementSize. To avoid the error, the consumer must > > allocate buffer for BufferOneElement. If so, BufferOneElement is > the > > required parameter. > > > > Thanks > > > > Liming > > > > *发件人**:*Ni, Ray <ray.ni@intel.com <mailto:ray.ni@intel.com>> > > *发送时间:* 2021年9月24日 11:53 > > *收件人:* devel@edk2.groups.io <mailto:devel@edk2.groups.io>; Ni, > Ray > > <ray.ni@intel.com <mailto:ray.ni@intel.com>>; Chan, Amy > > <amy.chan@intel.com <mailto:amy.chan@intel.com>>; gaoliming > > <gaoliming@byosoft.com.cn <mailto:gaoliming@byosoft.com.cn>>; > 'Andrew > > Fish' <afish@apple.com <mailto:afish@apple.com>> > > *抄送:* Kinney, Michael D <michael.d.kinney@intel.com > > <mailto:michael.d.kinney@intel.com>>; 'Gao, Liming' > > <liming.gao@intel.com <mailto:liming.gao@intel.com>>; Liu, Zhiguang > > <zhiguang.liu@intel.com <mailto:zhiguang.liu@intel.com>>; Wang, > Jian J > > <jian.j.wang@intel.com <mailto:jian.j.wang@intel.com>>; Gao, > Zhichao > > <zhichao.gao@intel.com <mailto:zhichao.gao@intel.com>> > > *主题:* RE: [edk2-devel] RFC: Add BaseLib/QuickSort in MdePkg > > > > More details on new QuickSort() API: > > > > The new API needs to carry additional parameter “BufferOneElement”. > > > > This parameter gives QuickSort() the temporary buffer for > swapping in > > sorting. > > > > It’s to avoid BaseLib depends on MemoryAllocationLib. > > > > … > > > > @param [in] BufferOneElement When ElementSize > 256, caller > needs to > > provide a buffer whose size > > equals to ElementSize. It’s used by > > QuickSort() for swapping in sorting. > > > > When ElementSize <= 256, QuickSort() uses a local stack 256-byte > buffer. > > > > @retval EFI_INVALID_PARAMETER When (ElementSize > 256) and > > (BufferOneElement == NULL). > > > > … > > > > VOID > > > > EFIAPI > > > > QuickSort ( > > > > IN OUT VOID *BufferToSort, > > > > IN CONST UINTN ElementCount, > > > > IN CONST UINTN ElementSize, > > > > IN SORT_COMPARE CompareFunction, > > > > IN VOID *BufferOneElement OPTIONAL > > > > ); > > > > Any comments? > > > > *From:*devel@edk2.groups.io <mailto:devel@edk2.groups.io> > > <devel@edk2.groups.io <mailto:devel@edk2.groups.io>> *On Behalf Of > > *Ni, Ray > > *Sent:* Wednesday, September 22, 2021 2:04 PM > > *To:* Chan, Amy <amy.chan@intel.com <mailto:amy.chan@intel.com>>; > > gaoliming <gaoliming@byosoft.com.cn > > <mailto:gaoliming@byosoft.com.cn>>; 'Andrew Fish' <afish@apple.com > > <mailto:afish@apple.com>>; 'edk2-devel-groups-io' > > <devel@edk2.groups.io <mailto:devel@edk2.groups.io>> > > *Cc:* Kinney, Michael D <michael.d.kinney@intel.com > > <mailto:michael.d.kinney@intel.com>>; 'Gao, Liming' > > <liming.gao@intel.com <mailto:liming.gao@intel.com>>; Liu, Zhiguang > > <zhiguang.liu@intel.com <mailto:zhiguang.liu@intel.com>>; Wang, > Jian J > > <jian.j.wang@intel.com <mailto:jian.j.wang@intel.com>>; Gao, > Zhichao > > <zhichao.gao@intel.com <mailto:zhichao.gao@intel.com>> > > *Subject:* Re: [edk2-devel] RFC: Add BaseLib/QuickSort in MdePkg > > > > I don’t see objection so far. > > > > So, the final solution is: > > > > 1. Add QuickSort() API to BaseLib in MdePkg. > > 2. Update existing MdeModulePkg/SortLib to use QuickSort() in the > > implementation (proposed by Andrew Fish and Liming Gao) > > 3. Update UefiCpuPkg to use QuickSortLib to remove improper > > dependency on MdeModulePkg > > > > Thanks, > > > > Ray > > > > *From:*Ni, Ray > > *Sent:* Thursday, September 16, 2021 10:48 AM > > *To:* Chan, Amy <amy.chan@intel.com <mailto:amy.chan@intel.com>>; > > gaoliming <gaoliming@byosoft.com.cn > > <mailto:gaoliming@byosoft.com.cn>>; 'Andrew Fish' <afish@apple.com > > <mailto:afish@apple.com>>; 'edk2-devel-groups-io' > > <devel@edk2.groups.io <mailto:devel@edk2.groups.io>> > > *Cc:* Kinney, Michael D <michael.d.kinney@intel.com > > <mailto:michael.d.kinney@intel.com>>; 'Gao, Liming' > > <liming.gao@intel.com <mailto:liming.gao@intel.com>>; Liu, Zhiguang > > <Zhiguang.Liu@intel.com <mailto:Zhiguang.Liu@intel.com>>; Wang, > Jian J > > <jian.j.wang@intel.com <mailto:jian.j.wang@intel.com>>; Gao, > Zhichao > > <zhichao.gao@intel.com <mailto:zhichao.gao@intel.com>> > > *Subject:* RE: [edk2-devel] RFC: Add BaseLib/QuickSort in MdePkg > > > > Amy, > > > > No. We only Add QuickSort() function API into BaseLib.h. > > > > *From:*Chan, Amy <amy.chan@intel.com <mailto:amy.chan@intel.com>> > > *Sent:* Thursday, September 16, 2021 10:46 AM > > *To:* gaoliming <gaoliming@byosoft.com.cn > > <mailto:gaoliming@byosoft.com.cn>>; 'Andrew Fish' <afish@apple.com > > <mailto:afish@apple.com>>; 'edk2-devel-groups-io' > > <devel@edk2.groups.io <mailto:devel@edk2.groups.io>> > > *Cc:* Ni, Ray <ray.ni@intel.com <mailto:ray.ni@intel.com>>; Kinney, > > Michael D <michael.d.kinney@intel.com > > <mailto:michael.d.kinney@intel.com>>; 'Gao, Liming' > > <liming.gao@intel.com <mailto:liming.gao@intel.com>>; Liu, Zhiguang > > <zhiguang.liu@intel.com <mailto:zhiguang.liu@intel.com>>; Wang, > Jian J > > <jian.j.wang@intel.com <mailto:jian.j.wang@intel.com>>; Gao, > Zhichao > > <zhichao.gao@intel.com <mailto:zhichao.gao@intel.com>> > > *Subject:* RE: [edk2-devel] RFC: Add BaseLib/QuickSort in MdePkg > > > > Just to double confirm, will we have the null instance of > QuickSort in > > MdePkg? > > > > Regards, > > > > Amy > > > > *From:*gaoliming <gaoliming@byosoft.com.cn > > <mailto:gaoliming@byosoft.com.cn>> > > *Sent:* Thursday, September 16, 2021 10:23 AM > > *To:* 'Andrew Fish' <afish@apple.com <mailto:afish@apple.com>>; > > 'edk2-devel-groups-io' <devel@edk2.groups.io > > <mailto:devel@edk2.groups.io>> > > *Cc:* Ni, Ray <ray.ni@intel.com <mailto:ray.ni@intel.com>>; Kinney, > > Michael D <michael.d.kinney@intel.com > > <mailto:michael.d.kinney@intel.com>>; 'Gao, Liming' > > <liming.gao@intel.com <mailto:liming.gao@intel.com>>; Liu, Zhiguang > > <zhiguang.liu@intel.com <mailto:zhiguang.liu@intel.com>>; Wang, > Jian J > > <jian.j.wang@intel.com <mailto:jian.j.wang@intel.com>>; Gao, > Zhichao > > <zhichao.gao@intel.com <mailto:zhichao.gao@intel.com>>; Chan, Amy > > <amy.chan@intel.com <mailto:amy.chan@intel.com>> > > *Subject:* 回复: [edk2-devel] RFC: Add BaseLib/QuickSort in MdePkg > > > > Andrew: > > > > Thanks for your suggestion. I think your idea is better. We add new > > QuickSort() API to BaseLib, and update SortLib library instance to > > consume BaseLib QuickSort() API. This way has no change in current > > SortLib library class. It is the compatible solution. > > > > Thanks > > > > Liming > > > > *发件人**:*Andrew Fish <afish@apple.com <mailto:afish@apple.com>> > > *发送时间:* 2021年9月16日 10:13 > > *收件人:* edk2-devel-groups-io <devel@edk2.groups.io > > <mailto:devel@edk2.groups.io>>; Liming Gao > <gaoliming@byosoft.com.cn > > <mailto:gaoliming@byosoft.com.cn>> > > *抄送:* Ni, Ray <ray.ni@intel.com <mailto:ray.ni@intel.com>>; Mike > > Kinney <michael.d.kinney@intel.com > > <mailto:michael.d.kinney@intel.com>>; Gao, Liming > > <liming.gao@intel.com <mailto:liming.gao@intel.com>>; Liu, Zhiguang > > <zhiguang.liu@intel.com <mailto:zhiguang.liu@intel.com>>; Wang, > Jian J > > <jian.j.wang@intel.com <mailto:jian.j.wang@intel.com>>; Gao, > Zhichao > > <zhichao.gao@intel.com <mailto:zhichao.gao@intel.com>>; Chan, Amy > > <amy.chan@intel.com <mailto:amy.chan@intel.com>> > > *主题:* Re: [edk2-devel] RFC: Add BaseLib/QuickSort in MdePkg > > > > On Sep 15, 2021, at 6:26 PM, gaoliming <gaoliming@byosoft.com.cn > > <mailto:gaoliming@byosoft.com.cn>> wrote: > > > > Ray: > > > > SortLib has been added since 2015. I would suggest to still keep > > this library class. To resolve the package dependency, my > proposal > > is to move the library class header file SortLib.h from > > MdeModulePkg to MdePkg, and still keep the library instance in > > MdeModulePkg. This proposal has no impact on the existing > platform. > > > > If we add QuickSort() API to the BaseLib can we not just port the > > existing MdeModulePkg/SortLib to use QuickSort() in the > > implementation? Or is there some other way to add the new thing > in a > > backward compatible way. > > > > Thanks, > > > > Andrew Fish > > > > Thanks > > > > Liming > > > > *发件人**:*devel@edk2.groups.io > > <mailto:devel@edk2.groups.io><devel@edk2.groups.io > > <mailto:devel@edk2.groups.io>>*代表***Ni, Ray > > *发送时间:*2021年9月14日14:15 > > *收件人:*Kinney, Michael D <michael.d.kinney@intel.com > > <mailto:michael.d.kinney@intel.com>>; Gao, Liming > > <liming.gao@intel.com <mailto:liming.gao@intel.com>>; Liu, > > Zhiguang <zhiguang.liu@intel.com > <mailto:zhiguang.liu@intel.com>>; > > Wang, Jian J <jian.j.wang@intel.com > > <mailto:jian.j.wang@intel.com>>; Gao, Zhichao > > <zhichao.gao@intel.com <mailto:zhichao.gao@intel.com>> > > *抄送:*devel@edk2.groups.io <mailto:devel@edk2.groups.io>; > Chan, Amy > > <amy.chan@intel.com <mailto:amy.chan@intel.com>> > > *主题:*[edk2-devel] RFC: Add BaseLib/QuickSort in MdePkg > > > > Hi package maintainers of MdePkg, MdeModulePkg and ShellPkg, > > community, > > > > A commit (UefiCpuPkg/CpuCacheInfoLib: Sort CpuCacheInfo array > > > <https://github.com/tianocore/edk2/commit/4de77ae9890d241271f543e9195ab3516f3abec6>) > > to UefiCpuPkg let > > UefiCpuPkg depend on MdeModulePkg because the SortLib class and > > instances are all in MdeModulePkg. > > > > UefiCpuPkg depending on MdeModulePkg breaks the rule that > > “UefiCpuPkg should ONLY depend on MdePkg”. > > > > To address this issue, there are two approaches: > > > > 1. Duplicate the sort logic in UefiCpuPkg to not depend on > > MdeModulePkg/SortLib > > 2. Add QuickSort() API to BaseLib in MdePkg. > > > > Approach #2 (MdePkg/BaseLib/QuickSort) makes more sense because > > quick sort is a standard algorithm. > > > > We encourage consumers to update their code to use the quick > sort > > in MdePkg and gradually deprecate today’s MdeModulePkg/SortLib. > > > > If you don’t have concerns, I plan to: > > > > 1. “Add QuickSort() to BaseLib” and update all existing > consumers > > to use this API instead. > > > > VOID > > > > EFIAPI > > > > QuickSort ( > > > > IN OUT VOID *BufferToSort, > > > > IN CONST UINTN Count, > > > > IN CONST UINTN ElementSize, > > > > IN SORT_COMPARE CompareFunction > > > > ); > > > > 2. “Add new ShellPkg/SortCompareLib” > > > > Background: ShellPkg requires to sort devicepath/string so 3 > APIs > > in UefiSortLib (DevicePathCompare, StringNoCaseCompare, > > StringCompare) are provided for Shell usage. we can move the 3 > > APIs to the SortCompareLib and update Shell code to use > > BaseLib/QuickSort directly, with the sort compare function from > > SortCompareLib. > > > > Any concerns? > > > > Thanks, > > > > Ray > > > > > > [-- Attachment #2: Type: text/html, Size: 42857 bytes --] ^ permalink raw reply [flat|nested] 21+ messages in thread
* Re: [edk2-devel] RFC: Add BaseLib/QuickSort in MdePkg 2021-09-16 2:23 ` 回复: " gaoliming 2021-09-16 2:45 ` Chan, Amy @ 2021-09-16 2:47 ` Ni, Ray 1 sibling, 0 replies; 21+ messages in thread From: Ni, Ray @ 2021-09-16 2:47 UTC (permalink / raw) To: devel@edk2.groups.io, gaoliming@byosoft.com.cn, 'Andrew Fish' Cc: Kinney, Michael D, 'Gao, Liming', Liu, Zhiguang, Wang, Jian J, Gao, Zhichao, Chan, Amy [-- Attachment #1: Type: text/plain, Size: 4885 bytes --] Andrew, Liming, I think your idea works better. UefiCpuPkg --> MdePkg (BaseLib) xxxPkg --> MdeModulePkg (SortLib) --> MdePkg (BaseLib) Gradually we will eliminate the MdeModulePkg (SortLib) layer. From: devel@edk2.groups.io <devel@edk2.groups.io> On Behalf Of gaoliming Sent: Thursday, September 16, 2021 10:23 AM To: 'Andrew Fish' <afish@apple.com>; 'edk2-devel-groups-io' <devel@edk2.groups.io> Cc: Ni, Ray <ray.ni@intel.com>; Kinney, Michael D <michael.d.kinney@intel.com>; 'Gao, Liming' <liming.gao@intel.com>; Liu, Zhiguang <zhiguang.liu@intel.com>; Wang, Jian J <jian.j.wang@intel.com>; Gao, Zhichao <zhichao.gao@intel.com>; Chan, Amy <amy.chan@intel.com> Subject: 回复: [edk2-devel] RFC: Add BaseLib/QuickSort in MdePkg Andrew: Thanks for your suggestion. I think your idea is better. We add new QuickSort() API to BaseLib, and update SortLib library instance to consume BaseLib QuickSort() API. This way has no change in current SortLib library class. It is the compatible solution. Thanks Liming 发件人: Andrew Fish <afish@apple.com<mailto:afish@apple.com>> 发送时间: 2021年9月16日 10:13 收件人: edk2-devel-groups-io <devel@edk2.groups.io<mailto:devel@edk2.groups.io>>; Liming Gao <gaoliming@byosoft.com.cn<mailto:gaoliming@byosoft.com.cn>> 抄送: Ni, Ray <ray.ni@intel.com<mailto:ray.ni@intel.com>>; Mike Kinney <michael.d.kinney@intel.com<mailto:michael.d.kinney@intel.com>>; Gao, Liming <liming.gao@intel.com<mailto:liming.gao@intel.com>>; Liu, Zhiguang <zhiguang.liu@intel.com<mailto:zhiguang.liu@intel.com>>; Wang, Jian J <jian.j.wang@intel.com<mailto:jian.j.wang@intel.com>>; Gao, Zhichao <zhichao.gao@intel.com<mailto:zhichao.gao@intel.com>>; Chan, Amy <amy.chan@intel.com<mailto:amy.chan@intel.com>> 主题: Re: [edk2-devel] RFC: Add BaseLib/QuickSort in MdePkg On Sep 15, 2021, at 6:26 PM, gaoliming <gaoliming@byosoft.com.cn<mailto:gaoliming@byosoft.com.cn>> wrote: Ray: SortLib has been added since 2015. I would suggest to still keep this library class. To resolve the package dependency, my proposal is to move the library class header file SortLib.h from MdeModulePkg to MdePkg, and still keep the library instance in MdeModulePkg. This proposal has no impact on the existing platform. If we add QuickSort() API to the BaseLib can we not just port the existing MdeModulePkg/SortLib to use QuickSort() in the implementation? Or is there some other way to add the new thing in a backward compatible way. Thanks, Andrew Fish Thanks Liming 发件人: devel@edk2.groups.io<mailto:devel@edk2.groups.io> <devel@edk2.groups.io<mailto:devel@edk2.groups.io>> 代表 Ni, Ray 发送时间: 2021年9月14日 14:15 收件人: Kinney, Michael D <michael.d.kinney@intel.com<mailto:michael.d.kinney@intel.com>>; Gao, Liming <liming.gao@intel.com<mailto:liming.gao@intel.com>>; Liu, Zhiguang <zhiguang.liu@intel.com<mailto:zhiguang.liu@intel.com>>; Wang, Jian J <jian.j.wang@intel.com<mailto:jian.j.wang@intel.com>>; Gao, Zhichao <zhichao.gao@intel.com<mailto:zhichao.gao@intel.com>> 抄送: devel@edk2.groups.io<mailto:devel@edk2.groups.io>; Chan, Amy <amy.chan@intel.com<mailto:amy.chan@intel.com>> 主题: [edk2-devel] RFC: Add BaseLib/QuickSort in MdePkg Hi package maintainers of MdePkg, MdeModulePkg and ShellPkg, community, A commit (UefiCpuPkg/CpuCacheInfoLib: Sort CpuCacheInfo array<https://github.com/tianocore/edk2/commit/4de77ae9890d241271f543e9195ab3516f3abec6>) to UefiCpuPkg let UefiCpuPkg depend on MdeModulePkg because the SortLib class and instances are all in MdeModulePkg. UefiCpuPkg depending on MdeModulePkg breaks the rule that “UefiCpuPkg should ONLY depend on MdePkg”. To address this issue, there are two approaches: 1. Duplicate the sort logic in UefiCpuPkg to not depend on MdeModulePkg/SortLib 2. Add QuickSort() API to BaseLib in MdePkg. Approach #2 (MdePkg/BaseLib/QuickSort) makes more sense because quick sort is a standard algorithm. We encourage consumers to update their code to use the quick sort in MdePkg and gradually deprecate today’s MdeModulePkg/SortLib. If you don’t have concerns, I plan to: 1. “Add QuickSort() to BaseLib” and update all existing consumers to use this API instead. VOID EFIAPI QuickSort ( IN OUT VOID *BufferToSort, IN CONST UINTN Count, IN CONST UINTN ElementSize, IN SORT_COMPARE CompareFunction ); 1. “Add new ShellPkg/SortCompareLib” Background: ShellPkg requires to sort devicepath/string so 3 APIs in UefiSortLib (DevicePathCompare, StringNoCaseCompare, StringCompare) are provided for Shell usage. we can move the 3 APIs to the SortCompareLib and update Shell code to use BaseLib/QuickSort directly, with the sort compare function from SortCompareLib. Any concerns? Thanks, Ray [-- Attachment #2: Type: text/html, Size: 24859 bytes --] ^ permalink raw reply [flat|nested] 21+ messages in thread
end of thread, other threads:[~2021-09-29 2:42 UTC | newest]
Thread overview: 21+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2021-09-14 6:15 RFC: Add BaseLib/QuickSort in MdePkg Ni, Ray
2021-09-16 1:26 ` 回复: [edk2-devel] " gaoliming
2021-09-16 2:13 ` Andrew Fish
2021-09-16 2:23 ` 回复: " gaoliming
2021-09-16 2:45 ` Chan, Amy
2021-09-16 2:47 ` Ni, Ray
2021-09-22 6:03 ` Ni, Ray
[not found] ` <16A70FAC1585C7C1.27516@groups.io>
2021-09-24 3:53 ` Ni, Ray
2021-09-26 2:00 ` 回复: " gaoliming
2021-09-26 2:24 ` Ni, Ray
2021-09-26 11:20 ` Marvin Häuser
2021-09-27 0:45 ` Jeff Fan
2021-09-27 8:14 ` Marvin Häuser
2021-09-27 8:50 ` Jeff Fan
2021-09-27 9:09 ` Marvin Häuser
2021-09-28 1:49 ` Ni, Ray
2021-09-28 22:25 ` Brian J. Johnson
2021-09-29 0:51 ` 回复: " gaoliming
2021-09-29 2:42 ` Ni, Ray
[not found] ` <16A8A1ADDB4E97C4.26412@groups.io>
2021-09-27 9:06 ` Jeff Fan
2021-09-16 2:47 ` Ni, Ray
This is a public inbox, see mirroring instructions for how to clone and mirror all data and code used for this inbox