Re: [edk2] [PATCH v2 2/2] MdePkg/BaseLib: Update internal LinkedList verifications.

[Gao, Liming]

I have no preference. Please go ahead. 

> -Original Message-
> From: Marvin H?user [mailto:marvin.haeu...@outlook.com]
> Sent: Thursday, August 3, 2017 11:43 PM
> To: edk2-devel@lists.01.org
> Cc: Gao, Liming ; Kinney, Michael D 
> 
> Subject: RE: [PATCH v2 2/2] MdePkg/BaseLib: Update internal LinkedList 
> verifications.
> 
> Hey Liming,
> 
> I noticed that and assumed that a second call is not going to hurt much (only 
> used in DEBUG afterall).
> To work around that, the macro could be modified to either call 
> IsNodeInList() or InternalBaseLibIsListValid() based on the PCD value,
> though one would have to know/check the PCD's value to know what actually 
> triggered the ASSERT(), so I opted to separate the
> ASSERTs (this also looks cleaner in my opinion).
> The macro could also be modified to carry two separate ASSERT calls, which 
> would solve the issue above,
> though I would need to think of a proper name for a macro that checks list 
> membership *and* whether the list is valid.
> If you have a preference, please let me know, otherwise I'll come up with a 
> V3 soon.
> 
> Thanks and regards,
> Marvin.
> 
> > -Original Message-
> > From: Gao, Liming [mailto:liming@intel.com]
> > Sent: Thursday, August 3, 2017 5:28 PM
> > To: marvin.haeu...@outlook.com; edk2-devel@lists.01.org
> > Cc: Kinney, Michael D 
> > Subject: RE: [PATCH v2 2/2] MdePkg/BaseLib: Update internal LinkedList
> > verifications.
> >
> > Marvin:
> >   If PcdVerifyNodeInList is set TRUE, InternalBaseLibIsListValid() will be
> > checked twice in two ASSERT(). In the original logic, 
> > InternalBaseLibIsListValid
> > only runs once. Could we work out the same check logic?
> >
> > Thanks
> > Liming
> > > -Original Message-
> > > From: edk2-devel [mailto:edk2-devel-boun...@lists.01.org] On Behalf Of
> > > Marvin H?user
> > > Sent: Wednesday, August 2, 2017 9:12 PM
> > > To: edk2-devel@lists.01.org
> > > Cc: Kinney, Michael D ; Gao, Liming
> > > 
> > > Subject: [edk2] [PATCH v2 2/2] MdePkg/BaseLib: Update internal LinkedList
> > verifications.
> > >
> > > 1) Replace InternalBaseLibIsNodeInList() with
> > >InternalBaseLibIsListValid().
> > >- The verification whether Node is within the doubly-linked List
> > >  is now done by IsNodeInList().
> > >- Whether the list is valid is returned.
> > >
> > > 2) The comments within InsertHeadList() and InsertTailList() stated
> > >that it is checked whether Entry is not part of the doubly-linked
> > >list. This was not done as argument 3 of
> > >InternalBaseLibIsNodeInList() indicated whether the check is done,
> > >not whether to check if the node is or is not in the list. This
> > >has been fixed by using IsNodeInList() for the ASSERTs.
> > >
> > > V2:
> > >   - Fix IsListEmpty() to ASSERT when the passed list is invalid.
> > >   - Introduce the VERIFY_IS_NODE_IN_LIST() macro to only verify whether
> > the
> > > passed node is part of the list when PcdVerifyNodeInList is TRUE.
> > >
> > > Contributed-under: TianoCore Contribution Agreement 1.1
> > > Signed-off-by: Marvin Haeuser 
> > > ---
> > >  MdePkg/Library/BaseLib/LinkedList.c | 105 +---
> > >  1 file changed, 47 insertions(+), 58 deletions(-)
> > >
> > > diff --git a/MdePkg/Library/BaseLib/LinkedList.c
> > > b/MdePkg/Library/BaseLib/LinkedList.c
> > > index 484ee836b8c2..6864fae7d939 100644
> > > --- a/MdePkg/Library/BaseLib/LinkedList.c
> > > +++ b/MdePkg/Library/BaseLib/LinkedList.c
> > > @@ -15,25 +15,38 @@
> > >  #include "BaseLibInternals.h"
> > >
> > >  /**
> > > -  Worker function that locates the Node in the List.
> > > +  If PcdVerifyNodeInList is TRUE, checks whether FirstNode and
> > > + SecondNode are  part of the same doubly-linked list.
> > >
> > > -  By searching the List, finds the location of the Node in List. At
> > > the same time,
> > > -  verifies the validity of this list.
> > > +  If FirstEntry is NULL, then ASSERT().
> > > +  If FirstEntry->ForwardLink is NULL, then ASSERT().
> > > +  If FirstEntry->BackLink is NULL, then ASSERT().
> > > +  If SecondEntry is NULL, then ASSERT();  If
> > > + PcdMaximumLinkedListLength is not zero, and List contains more than
> > > + PcdMaximumLinkedListLength nodes, then ASSERT().
> > > +

Re: [edk2] [PATCH v2 2/2] MdePkg/BaseLib: Update internal LinkedList verifications.

[Marvin H?user]

Hey Liming,

I noticed that and assumed that a second call is not going to hurt much (only 
used in DEBUG afterall).
To work around that, the macro could be modified to either call IsNodeInList() 
or InternalBaseLibIsListValid() based on the PCD value,
though one would have to know/check the PCD's value to know what actually 
triggered the ASSERT(), so I opted to separate the ASSERTs (this also looks 
cleaner in my opinion).
The macro could also be modified to carry two separate ASSERT calls, which 
would solve the issue above,
though I would need to think of a proper name for a macro that checks list 
membership *and* whether the list is valid.
If you have a preference, please let me know, otherwise I'll come up with a V3 
soon.

Thanks and regards,
Marvin.

> -Original Message-
> From: Gao, Liming [mailto:liming@intel.com]
> Sent: Thursday, August 3, 2017 5:28 PM
> To: marvin.haeu...@outlook.com; edk2-devel@lists.01.org
> Cc: Kinney, Michael D 
> Subject: RE: [PATCH v2 2/2] MdePkg/BaseLib: Update internal LinkedList
> verifications.
> 
> Marvin:
>   If PcdVerifyNodeInList is set TRUE, InternalBaseLibIsListValid() will be
> checked twice in two ASSERT(). In the original logic, 
> InternalBaseLibIsListValid
> only runs once. Could we work out the same check logic?
> 
> Thanks
> Liming
> > -Original Message-
> > From: edk2-devel [mailto:edk2-devel-boun...@lists.01.org] On Behalf Of
> > Marvin H?user
> > Sent: Wednesday, August 2, 2017 9:12 PM
> > To: edk2-devel@lists.01.org
> > Cc: Kinney, Michael D ; Gao, Liming
> > 
> > Subject: [edk2] [PATCH v2 2/2] MdePkg/BaseLib: Update internal LinkedList
> verifications.
> >
> > 1) Replace InternalBaseLibIsNodeInList() with
> >InternalBaseLibIsListValid().
> >- The verification whether Node is within the doubly-linked List
> >  is now done by IsNodeInList().
> >- Whether the list is valid is returned.
> >
> > 2) The comments within InsertHeadList() and InsertTailList() stated
> >that it is checked whether Entry is not part of the doubly-linked
> >list. This was not done as argument 3 of
> >InternalBaseLibIsNodeInList() indicated whether the check is done,
> >not whether to check if the node is or is not in the list. This
> >has been fixed by using IsNodeInList() for the ASSERTs.
> >
> > V2:
> >   - Fix IsListEmpty() to ASSERT when the passed list is invalid.
> >   - Introduce the VERIFY_IS_NODE_IN_LIST() macro to only verify whether
> the
> > passed node is part of the list when PcdVerifyNodeInList is TRUE.
> >
> > Contributed-under: TianoCore Contribution Agreement 1.1
> > Signed-off-by: Marvin Haeuser 
> > ---
> >  MdePkg/Library/BaseLib/LinkedList.c | 105 +---
> >  1 file changed, 47 insertions(+), 58 deletions(-)
> >
> > diff --git a/MdePkg/Library/BaseLib/LinkedList.c
> > b/MdePkg/Library/BaseLib/LinkedList.c
> > index 484ee836b8c2..6864fae7d939 100644
> > --- a/MdePkg/Library/BaseLib/LinkedList.c
> > +++ b/MdePkg/Library/BaseLib/LinkedList.c
> > @@ -15,25 +15,38 @@
> >  #include "BaseLibInternals.h"
> >
> >  /**
> > -  Worker function that locates the Node in the List.
> > +  If PcdVerifyNodeInList is TRUE, checks whether FirstNode and
> > + SecondNode are  part of the same doubly-linked list.
> >
> > -  By searching the List, finds the location of the Node in List. At
> > the same time,
> > -  verifies the validity of this list.
> > +  If FirstEntry is NULL, then ASSERT().
> > +  If FirstEntry->ForwardLink is NULL, then ASSERT().
> > +  If FirstEntry->BackLink is NULL, then ASSERT().
> > +  If SecondEntry is NULL, then ASSERT();  If
> > + PcdMaximumLinkedListLength is not zero, and List contains more than
> > + PcdMaximumLinkedListLength nodes, then ASSERT().
> > +
> > +  @param  FirstEntry   A pointer to a node in a linked list.
> > +  @param  SecondEntry  A pointer to the node to locate.
> > +
> > +  @retval TRUE   SecondEntry is in the same doubly-linked list as 
> > FirstEntry
> > + or PcdVerifyNodeInList is FALSE.
> > +  @retval FALSE  SecondEntry isn't in the same doubly-linked list as
> FirstEntry,
> > + or FirstEntry is invalid.
> > +
> > +**/
> > +#define VERIFY_IS_NODE_IN_LIST(FirstEntry, SecondEntry)  \
> > +  (!FeaturePcdGet (PcdVerifyNodeInList) || IsNodeInList
> > +((FirstEntry), (SecondEntry)))
> > +
> > +/**
> > +  Worker function that verifies the validity of this list.
> >
> >If List is NULL, then ASSERT()

Re: [edk2] [PATCH v2 2/2] MdePkg/BaseLib: Update internal LinkedList verifications.

[Gao, Liming]

Marvin:
  If PcdVerifyNodeInList is set TRUE, InternalBaseLibIsListValid() will be 
checked twice in two ASSERT(). In the original logic, 
InternalBaseLibIsListValid only runs once. Could we work out the same check 
logic?

Thanks
Liming
> -Original Message-
> From: edk2-devel [mailto:edk2-devel-boun...@lists.01.org] On Behalf Of Marvin 
> H?user
> Sent: Wednesday, August 2, 2017 9:12 PM
> To: edk2-devel@lists.01.org
> Cc: Kinney, Michael D ; Gao, Liming 
> 
> Subject: [edk2] [PATCH v2 2/2] MdePkg/BaseLib: Update internal LinkedList 
> verifications.
> 
> 1) Replace InternalBaseLibIsNodeInList() with
>InternalBaseLibIsListValid().
>- The verification whether Node is within the doubly-linked List
>  is now done by IsNodeInList().
>- Whether the list is valid is returned.
> 
> 2) The comments within InsertHeadList() and InsertTailList() stated
>that it is checked whether Entry is not part of the doubly-linked
>list. This was not done as argument 3 of
>InternalBaseLibIsNodeInList() indicated whether the check is done,
>not whether to check if the node is or is not in the list. This
>has been fixed by using IsNodeInList() for the ASSERTs.
> 
> V2:
>   - Fix IsListEmpty() to ASSERT when the passed list is invalid.
>   - Introduce the VERIFY_IS_NODE_IN_LIST() macro to only verify whether the
> passed node is part of the list when PcdVerifyNodeInList is TRUE.
> 
> Contributed-under: TianoCore Contribution Agreement 1.1
> Signed-off-by: Marvin Haeuser 
> ---
>  MdePkg/Library/BaseLib/LinkedList.c | 105 +---
>  1 file changed, 47 insertions(+), 58 deletions(-)
> 
> diff --git a/MdePkg/Library/BaseLib/LinkedList.c 
> b/MdePkg/Library/BaseLib/LinkedList.c
> index 484ee836b8c2..6864fae7d939 100644
> --- a/MdePkg/Library/BaseLib/LinkedList.c
> +++ b/MdePkg/Library/BaseLib/LinkedList.c
> @@ -15,25 +15,38 @@
>  #include "BaseLibInternals.h"
> 
>  /**
> -  Worker function that locates the Node in the List.
> +  If PcdVerifyNodeInList is TRUE, checks whether FirstNode and SecondNode are
> +  part of the same doubly-linked list.
> 
> -  By searching the List, finds the location of the Node in List. At the same 
> time,
> -  verifies the validity of this list.
> +  If FirstEntry is NULL, then ASSERT().
> +  If FirstEntry->ForwardLink is NULL, then ASSERT().
> +  If FirstEntry->BackLink is NULL, then ASSERT().
> +  If SecondEntry is NULL, then ASSERT();
> +  If PcdMaximumLinkedListLength is not zero, and List contains more than
> +  PcdMaximumLinkedListLength nodes, then ASSERT().
> +
> +  @param  FirstEntry   A pointer to a node in a linked list.
> +  @param  SecondEntry  A pointer to the node to locate.
> +
> +  @retval TRUE   SecondEntry is in the same doubly-linked list as FirstEntry
> + or PcdVerifyNodeInList is FALSE.
> +  @retval FALSE  SecondEntry isn't in the same doubly-linked list as 
> FirstEntry,
> + or FirstEntry is invalid.
> +
> +**/
> +#define VERIFY_IS_NODE_IN_LIST(FirstEntry, SecondEntry)  \
> +  (!FeaturePcdGet (PcdVerifyNodeInList) || IsNodeInList ((FirstEntry), 
> (SecondEntry)))
> +
> +/**
> +  Worker function that verifies the validity of this list.
> 
>If List is NULL, then ASSERT().
>If List->ForwardLink is NULL, then ASSERT().
> -  If List->backLink is NULL, then ASSERT().
> -  If Node is NULL, then ASSERT().
> -  If PcdVerifyNodeInList is TRUE and DoMembershipCheck is TRUE and Node
> -  is in not a member of List, then return FALSE
> +  If List->BackLink is NULL, then ASSERT().
>If PcdMaximumLinkedListLength is not zero, and List contains more than
>PcdMaximumLinkedListLength nodes, then ASSERT().
> 
>@param  List  A pointer to a node in a linked list.
> -  @param  Node  A pointer to a node in a linked list.
> -  @param  VerifyNodeInList  TRUE if a check should be made to see if Node is 
> a
> -member of List.  FALSE if no membership test 
> should
> -be performed.
> 
>@retval   TRUE if PcdVerifyNodeInList is FALSE
>@retval   TRUE if DoMembershipCheck is FALSE
> @@ -45,10 +58,8 @@
>  **/
>  BOOLEAN
>  EFIAPI
> -InternalBaseLibIsNodeInList (
> -  IN CONST LIST_ENTRY  *List,
> -  IN CONST LIST_ENTRY  *Node,
> -  IN BOOLEAN   VerifyNodeInList
> +InternalBaseLibIsListValid (
> +  IN CONST LIST_ENTRY  *List
>)
>  {
>UINTN Count;
> @@ -60,40 +71,11 @@ InternalBaseLibIsNodeInList (
>ASSERT (List != NULL);
>ASSERT (List->ForwardLink != NULL);
>ASSERT (List->BackLink != NULL);
> -  ASSERT (Node != NU

[edk2] [PATCH v2 2/2] MdePkg/BaseLib: Update internal LinkedList verifications.

[Marvin Häuser]

1) Replace InternalBaseLibIsNodeInList() with
   InternalBaseLibIsListValid().
   - The verification whether Node is within the doubly-linked List
 is now done by IsNodeInList().
   - Whether the list is valid is returned.

2) The comments within InsertHeadList() and InsertTailList() stated
   that it is checked whether Entry is not part of the doubly-linked
   list. This was not done as argument 3 of
   InternalBaseLibIsNodeInList() indicated whether the check is done,
   not whether to check if the node is or is not in the list. This
   has been fixed by using IsNodeInList() for the ASSERTs.

V2:
  - Fix IsListEmpty() to ASSERT when the passed list is invalid.
  - Introduce the VERIFY_IS_NODE_IN_LIST() macro to only verify whether the
passed node is part of the list when PcdVerifyNodeInList is TRUE.

Contributed-under: TianoCore Contribution Agreement 1.1
Signed-off-by: Marvin Haeuser 
---
 MdePkg/Library/BaseLib/LinkedList.c | 105 +---
 1 file changed, 47 insertions(+), 58 deletions(-)

diff --git a/MdePkg/Library/BaseLib/LinkedList.c 
b/MdePkg/Library/BaseLib/LinkedList.c
index 484ee836b8c2..6864fae7d939 100644
--- a/MdePkg/Library/BaseLib/LinkedList.c
+++ b/MdePkg/Library/BaseLib/LinkedList.c
@@ -15,25 +15,38 @@
 #include "BaseLibInternals.h"
 
 /**
-  Worker function that locates the Node in the List.
+  If PcdVerifyNodeInList is TRUE, checks whether FirstNode and SecondNode are
+  part of the same doubly-linked list.
 
-  By searching the List, finds the location of the Node in List. At the same 
time,
-  verifies the validity of this list.
+  If FirstEntry is NULL, then ASSERT().
+  If FirstEntry->ForwardLink is NULL, then ASSERT().
+  If FirstEntry->BackLink is NULL, then ASSERT().
+  If SecondEntry is NULL, then ASSERT();
+  If PcdMaximumLinkedListLength is not zero, and List contains more than
+  PcdMaximumLinkedListLength nodes, then ASSERT().
+
+  @param  FirstEntry   A pointer to a node in a linked list.
+  @param  SecondEntry  A pointer to the node to locate.
+
+  @retval TRUE   SecondEntry is in the same doubly-linked list as FirstEntry
+ or PcdVerifyNodeInList is FALSE.
+  @retval FALSE  SecondEntry isn't in the same doubly-linked list as 
FirstEntry,
+ or FirstEntry is invalid.
+
+**/
+#define VERIFY_IS_NODE_IN_LIST(FirstEntry, SecondEntry)  \
+  (!FeaturePcdGet (PcdVerifyNodeInList) || IsNodeInList ((FirstEntry), 
(SecondEntry)))
+
+/**
+  Worker function that verifies the validity of this list.
 
   If List is NULL, then ASSERT().
   If List->ForwardLink is NULL, then ASSERT().
-  If List->backLink is NULL, then ASSERT().
-  If Node is NULL, then ASSERT().
-  If PcdVerifyNodeInList is TRUE and DoMembershipCheck is TRUE and Node 
-  is in not a member of List, then return FALSE
+  If List->BackLink is NULL, then ASSERT().
   If PcdMaximumLinkedListLength is not zero, and List contains more than
   PcdMaximumLinkedListLength nodes, then ASSERT().
 
   @param  List  A pointer to a node in a linked list.
-  @param  Node  A pointer to a node in a linked list.
-  @param  VerifyNodeInList  TRUE if a check should be made to see if Node is a 
-member of List.  FALSE if no membership test 
should 
-be performed.
 
   @retval   TRUE if PcdVerifyNodeInList is FALSE
   @retval   TRUE if DoMembershipCheck is FALSE
@@ -45,10 +58,8 @@
 **/
 BOOLEAN
 EFIAPI
-InternalBaseLibIsNodeInList (
-  IN CONST LIST_ENTRY  *List,
-  IN CONST LIST_ENTRY  *Node,
-  IN BOOLEAN   VerifyNodeInList
+InternalBaseLibIsListValid (
+  IN CONST LIST_ENTRY  *List
   )
 {
   UINTN Count;
@@ -60,40 +71,11 @@ InternalBaseLibIsNodeInList (
   ASSERT (List != NULL);
   ASSERT (List->ForwardLink != NULL);
   ASSERT (List->BackLink != NULL);
-  ASSERT (Node != NULL);
-
-  Count = 0;
-  Ptr   = List;
-
-  if (FeaturePcdGet (PcdVerifyNodeInList) && VerifyNodeInList) {
-//
-// Check to see if Node is a member of List.  
-// Exit early if the number of nodes in List >= PcdMaximumLinkedListLength
-//
-do {
-  Ptr = Ptr->ForwardLink;
-  if (PcdGet32 (PcdMaximumLinkedListLength) > 0) {
-Count++;
-//
-// ASSERT() if the linked list is too long
-//
-ASSERT (Count < PcdGet32 (PcdMaximumLinkedListLength));
-
-//
-// Return if the linked list is too long
-//
-if (Count >= PcdGet32 (PcdMaximumLinkedListLength)) {
-  return (BOOLEAN)(Ptr == Node);
-}
-  }
-} while ((Ptr != List) && (Ptr != Node)); 
-
-if (Ptr != Node) {
-  return FALSE;
-}
-  }
 
   if (PcdGet32 (PcdMaximumLinkedListLength) > 0) {
+Count = 0;
+Ptr   = List;
+
 //
 // Count the total number of nodes in List.
 // Exit early if the number of nodes in List >= PcdMaximumLinkedListLength
@@ -104,9 +86,9 @@ InternalBaseLibIsNodeInList (
 } while ((Ptr != List) && (Count < PcdGe