From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received-SPF: Pass (sender SPF authorized) identity=mailfrom; client-ip=2607:f8b0:4001:c0b::241; helo=mail-it0-x241.google.com; envelope-from=ard.biesheuvel@linaro.org; receiver=edk2-devel@lists.01.org Received: from mail-it0-x241.google.com (mail-it0-x241.google.com [IPv6:2607:f8b0:4001:c0b::241]) (using TLSv1.2 with cipher ECDHE-RSA-AES128-GCM-SHA256 (128/128 bits)) (No client certificate requested) by ml01.01.org (Postfix) with ESMTPS id 6BCB02236BA8B for ; Thu, 4 Jan 2018 11:20:04 -0800 (PST) Received: by mail-it0-x241.google.com with SMTP id x28so3488941ita.0 for ; Thu, 04 Jan 2018 11:24:21 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=linaro.org; s=google; h=mime-version:in-reply-to:references:from:date:message-id:subject:to :cc; bh=j/VcJHYa4lKSwBkyrhuMycZUai8c3BPnG6Qx+nvRGIY=; b=X+WeLfh2u4RQ/Ti3O8cG+0A6+wQ2PfnyTzKDcEHGs4fuRSxUCpQOHGJHUgmZLzxuZh /SC4fOHrNUlSN/ihdfYEcEItfuf3iGbVMxDhga2z5tQb1CP0fVuuUI+IMPF0v/9/WpJX rmQl0KvpbEvD5FH+JLCGu8VIAnpLN5qsR531o= X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:mime-version:in-reply-to:references:from:date :message-id:subject:to:cc; bh=j/VcJHYa4lKSwBkyrhuMycZUai8c3BPnG6Qx+nvRGIY=; b=BtGyOxUIy19tdKb/iBMRc+qJ+JJ7NZxJh2+GUgEZqXf6TSe8K1Eu6GEcRE5tW8cw+n xdVzNvkwAA/VVmytscVljJeNob0Zba1jXZ3mNOm0g2gWopJJWxMk58AV9+PUd/zPH2qC tpxuJVivOceKYhyxPTgm3DlUf1Y6JXee9DO4YIXEseR+60A7XJ4KRyk3aZl3wpwGi5Aw xdUH1cskOW4hoqzrCCCrjwnh24qHSMqKgIWQZvh3hxT0mXZ3jf0RUFru5KDMMc5p4xsP C+5EZwZ5FLjh4zEAMIU/5V9l5OxQXquzo4Px2pYBgLqBuL406eEObmrZksOllojOppf6 BjRg== X-Gm-Message-State: AKGB3mLig75p+97rwHFe9cMaefnULBadOzksuXFoOx+pZQJuyDUF0Bso EPyB87i13dgmimXK42vmbSX8tgM5shA3L6JTdhgU+A== X-Google-Smtp-Source: ACJfBovaa/xnclMn+79U2ErznSnPD33h66RSHndz9mQxQqwVFM+Kd/0vWrrk1tLsvEj7Cm51Ajim811s7AcybcPBfS4= X-Received: by 10.36.246.8 with SMTP id u8mr603933ith.48.1515093860591; Thu, 04 Jan 2018 11:24:20 -0800 (PST) MIME-Version: 1.0 Received: by 10.107.37.197 with HTTP; Thu, 4 Jan 2018 11:24:20 -0800 (PST) In-Reply-To: References: <20171222190821.12440-1-evan.lloyd@arm.com> <20171222190821.12440-7-evan.lloyd@arm.com> From: Ard Biesheuvel Date: Thu, 4 Jan 2018 19:24:20 +0000 Message-ID: To: Girish Pathak Cc: Evan Lloyd , Matteo Carlini , nd , "edk2-devel@lists.01.org" , Thomas Abraham , Arvind Chauhan , "leif.lindholm@linaro.org" Subject: Re: [PATCH edk2-platforms v2 06/18] ARM/VExpressPkg: Add and update debug ASSERTS X-BeenThere: edk2-devel@lists.01.org X-Mailman-Version: 2.1.23 Precedence: list List-Id: EDK II Development List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Thu, 04 Jan 2018 19:20:04 -0000 Content-Type: text/plain; charset="UTF-8" On 4 January 2018 at 18:55, Girish Pathak wrote: > Hi Ard, > >> -----Original Message----- >> From: edk2-devel [mailto:edk2-devel-bounces@lists.01.org] On Behalf Of >> Ard Biesheuvel >> Sent: 23 December 2017 14:12 >> To: Evan Lloyd >> Cc: "Matteo.Carlini@arm.com"@arm.com; >> "leif.lindholm@linaro.org"@arm.com; "nd@arm.com"@arm.com; edk2- >> devel@lists.01.org; Thomas Abraham ; Arvind >> Chauhan ; >> "ard.biesheuvel@linaro.org"@arm.com >> Subject: Re: [edk2] [PATCH edk2-platforms v2 06/18] ARM/VExpressPkg: Add >> and update debug ASSERTS >> >> On 22 December 2017 at 19:08, wrote: >> > From: Girish Pathak >> > >> > This change adds some debug assertions e.g to catch NULL pointer >> > errors missing in PL11Lcd and HdLcd platform libraries. >> > >> > Contributed-under: TianoCore Contribution Agreement 1.1 >> > Signed-off-by: Girish Pathak >> > Signed-off-by: Evan Lloyd >> > --- >> > >> Platform/ARM/VExpressPkg/Library/HdLcdArmVExpressLib/HdLcdArmVExpr >> ess.c | 22 +++++++++++++++++- >> > >> > >> Platform/ARM/VExpressPkg/Library/PL111LcdArmVExpressLib/PL111LcdArm >> VEx >> > press.c | 24 +++++++++++++++++++- >> > 2 files changed, 44 insertions(+), 2 deletions(-) >> > >> > diff --git >> > >> a/Platform/ARM/VExpressPkg/Library/HdLcdArmVExpressLib/HdLcdArmVEx >> pres >> > s.c >> > >> b/Platform/ARM/VExpressPkg/Library/HdLcdArmVExpressLib/HdLcdArmVEx >> pres >> > s.c index >> > >> 6afd764897f49c64490ce891682f99bb0f5d993b..a8fe8696da0653017ce9fa6e4a >> 86 >> > caf283bc04c9 100644 >> > --- >> > >> a/Platform/ARM/VExpressPkg/Library/HdLcdArmVExpressLib/HdLcdArmVEx >> pres >> > s.c >> > +++ >> b/Platform/ARM/VExpressPkg/Library/HdLcdArmVExpressLib/HdLcdArmVEx >> > +++ press.c >> > @@ -153,6 +153,9 @@ LcdPlatformGetVram ( >> > EFI_STATUS Status; >> > EFI_ALLOCATE_TYPE AllocationType; >> > >> > + ASSERT (VramBaseAddress != NULL); >> > + ASSERT (VramSize != NULL); >> > + >> > // Set the vram size >> > *VramSize = LCD_VRAM_SIZE; >> > >> > @@ -171,6 +174,7 @@ LcdPlatformGetVram ( >> > VramBaseAddress >> > ); >> > if (EFI_ERROR (Status)) { >> > + ASSERT (FALSE); >> > return Status; >> > } >> > >> > @@ -181,8 +185,8 @@ LcdPlatformGetVram ( >> > *VramSize, >> > EFI_MEMORY_WC >> > ); >> > - ASSERT_EFI_ERROR (Status); >> > if (EFI_ERROR (Status)) { >> > + ASSERT (FALSE); >> >> As in the sibling patch against EDK2, this patch makes it more difficult to >> figure out what went wrong when you hit the ASSERT. >> ASSERT_EFI_ERROR prints the value of Status, ASSERT(FALSE) only prints >> '0 != 1' >> > > This change(and other similar changes) is in response to review comments on patch v1 > https://lists.01.org/pipermail/edk2-devel/2017-October/015995.html > > with above reference, Can you please confirm if we should revert to the patch v1 version ? > I guess Leif and I are in disagreement here. In particular, I think his comment """ ASSERT (FALSE)? (You already know Status is an EFI_ERROR, and a console message saying ASSERT (Status) is not getting you out of looking at the source code to find out what happened.) """ is misguided, given that ASSERT_EFI_ERROR (Status) will actually print the value of Status to the debug console. However, the objections against putting function calls in ASSERT()s are justified: ASSERT() should not have side effects if its condition is met, and function calls may have side effects. I suppose we should wait for Leif to return on the 22nd before proceeding with the review. Apologies for the confusion, and for the delay. >> > gBS->FreePages (*VramBaseAddress, EFI_SIZE_TO_PAGES (*VramSize)); >> > return Status; >> > } >> > @@ -221,6 +225,7 @@ LcdPlatformSetMode ( >> > EFI_STATUS Status; >> > >> > if (ModeNumber >= LcdPlatformGetMaxMode ()) { >> > + ASSERT (FALSE); >> >> These are fine: the code itself explains adequately which condition triggered >> the ASSERT to fire. >> >> > return EFI_INVALID_PARAMETER; >> > } >> > >> > @@ -279,7 +284,10 @@ LcdPlatformQueryMode ( >> > OUT EFI_GRAPHICS_OUTPUT_MODE_INFORMATION * CONST Info >> > ) >> > { >> > + ASSERT (Info != NULL); >> > + >> > if (ModeNumber >= LcdPlatformGetMaxMode ()) { >> > + ASSERT (FALSE); >> > return EFI_INVALID_PARAMETER; >> > } >> > >> > @@ -343,7 +351,18 @@ LcdPlatformGetTimings ( >> > OUT UINT32 * CONST VFrontPorch >> > ) >> > { >> > + // One of the pointers is NULL >> > + ASSERT (HRes != NULL); >> > + ASSERT (HSync != NULL); >> > + ASSERT (HBackPorch != NULL); >> > + ASSERT (HFrontPorch != NULL); >> > + ASSERT (VRes != NULL); >> > + ASSERT (VSync != NULL); >> > + ASSERT (VBackPorch != NULL); >> > + ASSERT (VFrontPorch != NULL); >> > + >> > if (ModeNumber >= LcdPlatformGetMaxMode ()) { >> > + ASSERT (FALSE); >> > return EFI_INVALID_PARAMETER; >> > } >> > >> > @@ -376,6 +395,7 @@ LcdPlatformGetBpp ( >> > ) >> > { >> > if (ModeNumber >= LcdPlatformGetMaxMode ()) { >> > + ASSERT (FALSE); >> > return EFI_INVALID_PARAMETER; >> > } >> > >> > diff --git >> > >> a/Platform/ARM/VExpressPkg/Library/PL111LcdArmVExpressLib/PL111LcdAr >> mV >> > Express.c >> > >> b/Platform/ARM/VExpressPkg/Library/PL111LcdArmVExpressLib/PL111LcdAr >> mV >> > Express.c index >> > >> 799fb3fc781ce04bb64cb1fa0b87f262a670ed78..fd4eea8f8e2397bc7d4ddf4cfe >> 3d >> > cc97a5109edb 100644 >> > --- >> > >> a/Platform/ARM/VExpressPkg/Library/PL111LcdArmVExpressLib/PL111LcdAr >> mV >> > Express.c >> > +++ >> b/Platform/ARM/VExpressPkg/Library/PL111LcdArmVExpressLib/PL111Lcd >> > +++ ArmVExpress.c >> > @@ -205,6 +205,9 @@ LcdPlatformGetVram ( >> > >> > Status = EFI_SUCCESS; >> > >> > + ASSERT (VramBaseAddress != NULL); >> > + ASSERT (VramSize != NULL); >> > + >> > // Is it on the motherboard or on the daughterboard? >> > switch (PL111_CLCD_SITE) { >> > >> > @@ -225,6 +228,7 @@ LcdPlatformGetVram ( >> > VramBaseAddress >> > ); >> > if (EFI_ERROR (Status)) { >> > + ASSERT (FALSE); >> > return Status; >> > } >> > >> > @@ -235,8 +239,8 @@ LcdPlatformGetVram ( >> > *VramSize, >> > EFI_MEMORY_WC >> > ); >> > - ASSERT_EFI_ERROR (Status); >> > if (EFI_ERROR (Status)) { >> > + ASSERT (FALSE); >> > gBS->FreePages (*VramBaseAddress, EFI_SIZE_TO_PAGES >> (*VramSize)); >> > return Status; >> > } >> > @@ -294,6 +298,7 @@ LcdPlatformSetMode ( >> > UINT32 SysId; >> > >> > if (ModeNumber >= LcdPlatformGetMaxMode ()) { >> > + ASSERT (FALSE); >> > return EFI_INVALID_PARAMETER; >> > } >> > >> > @@ -369,7 +374,10 @@ LcdPlatformQueryMode ( >> > OUT EFI_GRAPHICS_OUTPUT_MODE_INFORMATION * CONST Info >> > ) >> > { >> > + ASSERT (Info != NULL); >> > + >> > if (ModeNumber >= LcdPlatformGetMaxMode ()) { >> > + ASSERT (FALSE); >> > return EFI_INVALID_PARAMETER; >> > } >> > >> > @@ -433,7 +441,18 @@ LcdPlatformGetTimings ( >> > OUT UINT32 * CONST VFrontPorch >> > ) >> > { >> > + // One of the pointers is NULL >> > + ASSERT (HRes != NULL); >> > + ASSERT (HSync != NULL); >> > + ASSERT (HBackPorch != NULL); >> > + ASSERT (HFrontPorch != NULL); >> > + ASSERT (VRes != NULL); >> > + ASSERT (VSync != NULL); >> > + ASSERT (VBackPorch != NULL); >> > + ASSERT (VFrontPorch != NULL); >> > + >> > if (ModeNumber >= LcdPlatformGetMaxMode ()) { >> > + ASSERT (FALSE); >> > return EFI_INVALID_PARAMETER; >> > } >> > >> > @@ -465,7 +484,10 @@ LcdPlatformGetBpp ( >> > OUT LCD_BPP * CONST Bpp >> > ) >> > { >> > + ASSERT (Bpp != NULL); >> > + >> > if (ModeNumber >= LcdPlatformGetMaxMode ()) { >> > + ASSERT (FALSE); >> > return EFI_INVALID_PARAMETER; >> > } >> > >> > -- >> > Guid("CE165669-3EF3-493F-B85D-6190EE5B9759") >> > >> > _______________________________________________ >> > edk2-devel mailing list >> > edk2-devel@lists.01.org >> > https://lists.01.org/mailman/listinfo/edk2-devel >> _______________________________________________ >> edk2-devel mailing list >> edk2-devel@lists.01.org >> https://lists.01.org/mailman/listinfo/edk2-devel