From mboxrd@z Thu Jan 1 00:00:00 1970 Received: from mx0a-0031df01.pphosted.com (mx0a-0031df01.pphosted.com [205.220.168.131]) by mx.groups.io with SMTP id smtpd.web10.138243.1680718627588209419 for ; Wed, 05 Apr 2023 11:17:07 -0700 Authentication-Results: mx.groups.io; dkim=pass header.i=@quicinc.com header.s=qcppdkim1 header.b=GUqg3c1q; spf=permerror, err=parse error for token &{10 18 %{ir}.%{v}.%{d}.spf.has.pphosted.com}: invalid domain name (domain: quicinc.com, ip: 205.220.168.131, mailfrom: quic_llindhol@quicinc.com) Received: from pps.filterd (m0279864.ppops.net [127.0.0.1]) by mx0a-0031df01.pphosted.com (8.17.1.19/8.17.1.19) with ESMTP id 335DfbbL011503; Wed, 5 Apr 2023 18:17:00 GMT DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=quicinc.com; h=date : from : to : cc : subject : message-id : references : mime-version : content-type : in-reply-to; s=qcppdkim1; bh=AQZfeLWVHj+OXNbzy879BuSbk8UhvuDOGLPjtJz88Xc=; b=GUqg3c1qL6+c2v7lBXzFDLPOxnZkZrJj5PQujKxrCs3l4PHe85ukXW8H3DIJk0+GBEin pipdNShhgW+fxJj6NRy0/sGmwM/Z563h+YUz7Ja7GtVAlHCjDVz5ZcusuQjOOOG0Cij6 dv6o7cgr0ibWHNUpPesIm44iNdQnCECh52JAg3MBgD9Gw300QVuPQLJlBS7InUApdSeH liOrDch20fDHMuej1pImMzy/MutZ2rsD+GMUAL9DZImGsjVrI8xlPRgahWHITbqAwibx 3ocdON+VgRmLqMK6xnl7sXpPq17hF/3lhM7uTLZYVHrWF6F4zUd9PPhYI88XUQ0hoVn2 tw== Received: from nasanppmta03.qualcomm.com (i-global254.qualcomm.com [199.106.103.254]) by mx0a-0031df01.pphosted.com (PPS) with ESMTPS id 3prgvevdec-1 (version=TLSv1.2 cipher=ECDHE-RSA-AES256-GCM-SHA384 bits=256 verify=NOT); Wed, 05 Apr 2023 18:16:59 +0000 Received: from nasanex01c.na.qualcomm.com (nasanex01c.na.qualcomm.com [10.45.79.139]) by NASANPPMTA03.qualcomm.com (8.17.1.5/8.17.1.5) with ESMTPS id 335IGxZW031684 (version=TLSv1.2 cipher=ECDHE-RSA-AES256-GCM-SHA384 bits=256 verify=NOT); Wed, 5 Apr 2023 18:16:59 GMT Received: from qc-i7.hemma.eciton.net (10.80.80.8) by nasanex01c.na.qualcomm.com (10.45.79.139) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.2.986.42; Wed, 5 Apr 2023 11:16:57 -0700 Date: Wed, 5 Apr 2023 19:16:54 +0100 From: "Leif Lindholm" To: , CC: Chris Johnson , Andrew Fish , Michael Kubacki , Sean Brogan Subject: Re: [edk2-devel] [Patch v2 01/12] UnitTestFrameworkPkg: Add subhook submodule required for gmock Message-ID: References: <20230404182220.688-1-michael.d.kinney@intel.com> <20230404182220.688-2-michael.d.kinney@intel.com> MIME-Version: 1.0 In-Reply-To: <20230404182220.688-2-michael.d.kinney@intel.com> X-Originating-IP: [10.80.80.8] X-ClientProxiedBy: nasanex01b.na.qualcomm.com (10.46.141.250) To nasanex01c.na.qualcomm.com (10.45.79.139) X-QCInternal: smtphost X-Proofpoint-Virus-Version: vendor=nai engine=6200 definitions=5800 signatures=585085 X-Proofpoint-ORIG-GUID: cNFIdNbNiXb4S8euh8AIIDbE28UXDK3B X-Proofpoint-GUID: cNFIdNbNiXb4S8euh8AIIDbE28UXDK3B X-Proofpoint-Virus-Version: vendor=baseguard engine=ICAP:2.0.254,Aquarius:18.0.942,Hydra:6.0.573,FMLib:17.11.170.22 definitions=2023-04-05_12,2023-04-05_01,2023-02-09_01 X-Proofpoint-Spam-Details: rule=outbound_notspam policy=outbound score=0 mlxscore=0 mlxlogscore=999 clxscore=1011 impostorscore=0 lowpriorityscore=0 adultscore=0 bulkscore=0 suspectscore=0 malwarescore=0 spamscore=0 priorityscore=1501 phishscore=0 classifier=spam adjust=0 reason=mlx scancount=1 engine=8.12.0-2303200000 definitions=main-2304050164 Content-Type: text/plain; charset="us-ascii" Content-Disposition: inline On Tue, Apr 04, 2023 at 11:22:09 -0700, Michael D Kinney wrote: > From: Chris Johnson > > REF: https://bugzilla.tianocore.org/show_bug.cgi?id=4389 > > Add subhook submodule that is required to hook internal functions > when using gmock. > > https://github.com/Zeex/subhook > > Add SubhookLib library class and SubhookLib library instance. > Include the SUBHOOK_STATIC define in the SubhookLib INF file so > it builds as a static library. Also include the SUBHOOK_STATIC > define in SubhookLib.h so all modules using SubhookLib properly > link SubhookLib as a static library. > > Cc: Andrew Fish > Cc: Leif Lindholm > Cc: Michael D Kinney > Cc: Michael Kubacki > Cc: Sean Brogan > Signed-off-by: Chris Johnson I have some nitpicks below, which you can take into account or not. Regardless: Reviewed-by: Leif Lindholm > --- > .gitmodules | 3 ++ > ReadMe.rst | 1 + > .../Include/Library/SubhookLib.h | 15 ++++++++ > .../Library/SubhookLib/SubhookLib.inf | 36 +++++++++++++++++++ > .../Library/SubhookLib/SubhookLib.uni | 11 ++++++ > .../Library/SubhookLib/subhook | 1 + > .../Test/UnitTestFrameworkPkgHostTest.dsc | 1 + > UnitTestFrameworkPkg/UnitTestFrameworkPkg.dec | 2 ++ > .../UnitTestFrameworkPkgHost.dsc.inc | 1 + > 9 files changed, 71 insertions(+) > create mode 100644 UnitTestFrameworkPkg/Include/Library/SubhookLib.h > create mode 100644 UnitTestFrameworkPkg/Library/SubhookLib/SubhookLib.inf > create mode 100644 UnitTestFrameworkPkg/Library/SubhookLib/SubhookLib.uni > create mode 160000 UnitTestFrameworkPkg/Library/SubhookLib/subhook > > diff --git a/.gitmodules b/.gitmodules > index 8011a88d9d25..fe8a43be93ba 100644 > --- a/.gitmodules > +++ b/.gitmodules > @@ -23,3 +23,6 @@ > [submodule "UnitTestFrameworkPkg/Library/GoogleTestLib/googletest"] > path = UnitTestFrameworkPkg/Library/GoogleTestLib/googletest > url = https://github.com/google/googletest.git > +[submodule "UnitTestFrameworkPkg/Library/SubhookLib/subhook"] > + path = UnitTestFrameworkPkg/Library/SubhookLib/subhook > + url = https://github.com/Zeex/subhook.git > diff --git a/ReadMe.rst b/ReadMe.rst > index 497d96355908..91b9cf3c5e50 100644 > --- a/ReadMe.rst > +++ b/ReadMe.rst > @@ -94,6 +94,7 @@ that are covered by additional licenses. > - `MdeModulePkg/Universal/RegularExpressionDxe/oniguruma `__ > - `UnitTestFrameworkPkg/Library/CmockaLib/cmocka `__ > - `UnitTestFrameworkPkg/Library/GoogleTestLib/googletest `__ > +- `UnitTestFrameworkPkg/Library/SubhookLib/subhook `__ > - `RedfishPkg/Library/JsonLib/jansson `__ > > The EDK II Project is composed of packages. The maintainers for each package > diff --git a/UnitTestFrameworkPkg/Include/Library/SubhookLib.h b/UnitTestFrameworkPkg/Include/Library/SubhookLib.h > new file mode 100644 > index 000000000000..46783adfccfb > --- /dev/null > +++ b/UnitTestFrameworkPkg/Include/Library/SubhookLib.h > @@ -0,0 +1,15 @@ > +/** @file > + SubhookLib class with APIs from the subhook project > + > + Copyright (c) 2022, Intel Corporation. All rights reserved.
2023? > + SPDX-License-Identifier: BSD-2-Clause-Patent > + > +**/ > + > +#ifndef SUBHOOK_LIB_H_ > +#define SUBHOOK_LIB_H_ > + > +#define SUBHOOK_STATIC > +#include > + > +#endif > diff --git a/UnitTestFrameworkPkg/Library/SubhookLib/SubhookLib.inf b/UnitTestFrameworkPkg/Library/SubhookLib/SubhookLib.inf > new file mode 100644 > index 000000000000..e8e8ffb90750 > --- /dev/null > +++ b/UnitTestFrameworkPkg/Library/SubhookLib/SubhookLib.inf > @@ -0,0 +1,36 @@ > +## @file > +# This module provides Subhook Library implementation. > +# > +# Copyright (c) 2022, Intel Corporation. All rights reserved.
2023? > +# SPDX-License-Identifier: BSD-2-Clause-Patent > +# > +## > + > +[Defines] > + INF_VERSION = 0x00010005 A bit ancient for a new module. > + BASE_NAME = SubhookLib > + MODULE_UNI_FILE = SubhookLib.uni > + FILE_GUID = 70E03378-E140-46A8-8E65-7719DA14A240 > + MODULE_TYPE = BASE > + VERSION_STRING = 0.1 > + LIBRARY_CLASS = SubhookLib|HOST_APPLICATION > + > +# > +# VALID_ARCHITECTURES = IA32 X64 Surely not true? > +# > + > +[Sources] > + subhook/subhook.c > + > +[Packages] > + UnitTestFrameworkPkg/UnitTestFrameworkPkg.dec > + > +[BuildOptions] > + MSFT:*_*_*_CC_FLAGS == /c /EHsc /Zi /DSUBHOOK_STATIC > + MSFT:NOOPT_*_*_CC_FLAGS = /Od > + > + GCC:*_*_*_CC_FLAGS == -g -c > + > + GCC:NOOPT_*_*_CC_FLAGS = -O0 Isn't this the default set in tools_def.template? > + GCC:*_*_IA32_CC_FLAGS = -m32 > + GCC:*_*_X64_CC_FLAGS = -m64 > diff --git a/UnitTestFrameworkPkg/Library/SubhookLib/SubhookLib.uni b/UnitTestFrameworkPkg/Library/SubhookLib/SubhookLib.uni > new file mode 100644 > index 000000000000..eb61f034047e > --- /dev/null > +++ b/UnitTestFrameworkPkg/Library/SubhookLib/SubhookLib.uni > @@ -0,0 +1,11 @@ > +// /** @file > +// This module provides Subhook Library implementation. > +// > +// Copyright (c) 2022, Intel Corporation. All rights reserved.
2023? > +// SPDX-License-Identifier: BSD-2-Clause-Patent > +// > +// **/ > + > +#string STR_MODULE_ABSTRACT #language en-US "Subhook Library implementation" > + > +#string STR_MODULE_DESCRIPTION #language en-US "This module provides Subhook Library implementation." > diff --git a/UnitTestFrameworkPkg/Library/SubhookLib/subhook b/UnitTestFrameworkPkg/Library/SubhookLib/subhook > new file mode 160000 > index 000000000000..83d4e1ebef35 > --- /dev/null > +++ b/UnitTestFrameworkPkg/Library/SubhookLib/subhook > @@ -0,0 +1 @@ > +Subproject commit 83d4e1ebef3588fae48b69a7352cc21801cb70bc > diff --git a/UnitTestFrameworkPkg/Test/UnitTestFrameworkPkgHostTest.dsc b/UnitTestFrameworkPkg/Test/UnitTestFrameworkPkgHostTest.dsc > index 708ef7f9ab35..722509c8f26f 100644 > --- a/UnitTestFrameworkPkg/Test/UnitTestFrameworkPkgHostTest.dsc > +++ b/UnitTestFrameworkPkg/Test/UnitTestFrameworkPkgHostTest.dsc > @@ -33,6 +33,7 @@ [Components] > # > UnitTestFrameworkPkg/Library/CmockaLib/CmockaLib.inf > UnitTestFrameworkPkg/Library/GoogleTestLib/GoogleTestLib.inf > + UnitTestFrameworkPkg/Library/SubhookLib/SubhookLib.inf Could we move this after Posix to keep the alphabetical sorting? / Leif > UnitTestFrameworkPkg/Library/Posix/DebugLibPosix/DebugLibPosix.inf > UnitTestFrameworkPkg/Library/Posix/MemoryAllocationLibPosix/MemoryAllocationLibPosix.inf > UnitTestFrameworkPkg/Library/UnitTestLib/UnitTestLibCmocka.inf > diff --git a/UnitTestFrameworkPkg/UnitTestFrameworkPkg.dec b/UnitTestFrameworkPkg/UnitTestFrameworkPkg.dec > index 14e387d63a0f..30b489915d4a 100644 > --- a/UnitTestFrameworkPkg/UnitTestFrameworkPkg.dec > +++ b/UnitTestFrameworkPkg/UnitTestFrameworkPkg.dec > @@ -20,6 +20,7 @@ [Includes] > Library/CmockaLib/cmocka/include > Library/GoogleTestLib/googletest/googletest/include > Library/GoogleTestLib/googletest/googlemock/include > + Library/SubhookLib/subhook > > [Includes.Common.Private] > PrivateInclude > @@ -34,6 +35,7 @@ [LibraryClasses] > ## @libraryclass GoogleTest infrastructure > # > GoogleTestLib|Include/Library/GoogleTestLib.h > + SubhookLib|Include/Library/SubhookLib.h > > [LibraryClasses.Common.Private] > ## @libraryclass Provides a unit test result report > diff --git a/UnitTestFrameworkPkg/UnitTestFrameworkPkgHost.dsc.inc b/UnitTestFrameworkPkg/UnitTestFrameworkPkgHost.dsc.inc > index 7f5dfa30ed60..e77897bd326f 100644 > --- a/UnitTestFrameworkPkg/UnitTestFrameworkPkgHost.dsc.inc > +++ b/UnitTestFrameworkPkg/UnitTestFrameworkPkgHost.dsc.inc > @@ -15,6 +15,7 @@ [LibraryClasses.common.HOST_APPLICATION] > CacheMaintenanceLib|MdePkg/Library/BaseCacheMaintenanceLibNull/BaseCacheMaintenanceLibNull.inf > CmockaLib|UnitTestFrameworkPkg/Library/CmockaLib/CmockaLib.inf > GoogleTestLib|UnitTestFrameworkPkg/Library/GoogleTestLib/GoogleTestLib.inf > + SubhookLib|UnitTestFrameworkPkg/Library/SubhookLib/SubhookLib.inf > UnitTestLib|UnitTestFrameworkPkg/Library/UnitTestLib/UnitTestLibCmocka.inf > DebugLib|UnitTestFrameworkPkg/Library/Posix/DebugLibPosix/DebugLibPosix.inf > MemoryAllocationLib|UnitTestFrameworkPkg/Library/Posix/MemoryAllocationLibPosix/MemoryAllocationLibPosix.inf > -- > 2.39.1.windows.1 > > > > > >