Skip to contentSkip to conversation

Add iterator for an entity's data links

PATCH Superseded Daniel Scally 3 participants 10 messages Jun 21, 2022 – Jun 22, 2022

Subsystems (2)

v1 of 2 Superseded Latest is v2 →

lore
Share & tools
lore
#0 lore raw

cover Add iterator for an entity's data links

There are a bunch of places in the kernel where code iterates over an entity's links to perform some action. Those almost invariably have the implicit assumption that those links are data links, which might not be true following the introduction of ancillary links. Add a dedicated iterator that skips any non data links for use instead, which will allow that assumption to hold true.

Daniel Scally (2):
media: media-entity.h: Add iterator for entity data links
media: entity: Use dedicated data link iterator

 drivers/media/mc/mc-entity.c |  6 +++---
 include/media/media-entity.h | 26 ++++++++++++++++++++++++++
 2 files changed, 29 insertions(+), 3 deletions(-)
Signature · 1 line
2.25.1
#1 lore raw

PATCH 1/2 media: media-entity.h: Add iterator for entity data links

Iterating over the links for an entity is a somewhat common need through the media subsystem, but generally the assumption is that they will all be data links. To meet that assumption add a new macro that iterates through an entity's links and skips non-data links.

---
 include/media/media-entity.h | 26 ++++++++++++++++++++++++++
 1 file changed, 26 insertions(+)
include/media/media-entity.h +26 -0
index a9a1c0ec5d1c..b13f67f33508 100644
@@ -550,6 +550,32 @@ static inline bool media_entity_enum_intersects(
 				 min(ent_enum1->idx_max, ent_enum2->idx_max));
 }
 
+static inline struct media_link *
+__media_entity_next_data_link(struct media_entity *entity,
+			      struct media_link *pos)
+{
+	if (!pos) {
+		list_for_each_entry(pos, &entity->links, list)
+			if ((pos->flags & MEDIA_LNK_FL_LINK_TYPE) ==
+			    MEDIA_LNK_FL_DATA_LINK)
+				return pos;
+
+		return NULL;
+	}
+
+	list_for_each_entry_continue(pos, &entity->links, list)
+		if ((pos->flags & MEDIA_LNK_FL_LINK_TYPE) ==
+		    MEDIA_LNK_FL_DATA_LINK)
+			return pos;
+
+	return NULL;
+}
+
+#define for_each_media_entity_data_link(entity, pos)		\
+	for (pos = __media_entity_next_data_link(entity, NULL);	\
+	     pos;						\
+	     pos = __media_entity_next_data_link(entity, pos))
+
 /**
  * gobj_to_entity - returns the struct &media_entity pointer from the
  *	@gobj contained on it.
Signature · 1 line
2.25.1
#2 lore raw

Re: [PATCH 1/2] media: media-entity.h: Add iterator for entity data links

Hi Dan

Quoted 4 lines · Daniel Scally

Iterating over the links for an entity is a somewhat common need through the media subsystem, but generally the assumption is that they will all be data links. To meet that assumption add a new macro that iterates through an entity's links and skips non-data links.

Do you foresee usages of a similar iterator but for ancillary (or interface) links ?

In that case you could add a 'link_type' flag to
__media_entity_next_data_link

Quoted 11 lines
---
 include/media/media-entity.h | 26 ++++++++++++++++++++++++++
 1 file changed, 26 insertions(+)
include/media/media-entity.h +0 -0
index a9a1c0ec5d1c..b13f67f33508 100644

include/media/media-entity.h static inline bool media_entity_enum_intersects( · line 553

Quoted 4 lines
include/media/media-entity.h +1 -0
@@ -550,6 +550,32 @@ static inline bool media_entity_enum_intersects(
 				 min(ent_enum1->idx_max, ent_enum2->idx_max));
 }
 
+static inline struct media_link *

Isn't this a bit too much for inlining ? Also I heard many times that it's not worth anymore trying to outsmart the compiler and inline is discouraged in most cases ? (and it kind of makes sense to me, but I sometimes wonder if that's some form of cargo cult..)

include/media/media-entity.h static inline bool media_entity_enum_intersects( · line 558

Quoted 5 lines
include/media/media-entity.h +5 -0
+__media_entity_next_data_link(struct media_entity *entity,
+			      struct media_link *pos)
+{
+	if (!pos) {
+		list_for_each_entry(pos, &entity->links, list)

nit: coding style requires you to have braces

------------------------------------------------------------------------------
from Documentation/process/coding-style.rst:
Also, use braces when a loop contains more than a single simple statement:

.. code-block:: c

	while (condition) {
		if (test)
			do_something();
	}

------------------------------------------------------------------------------

include/media/media-entity.h static inline bool media_entity_enum_intersects( · line 571

Quoted 13 lines
include/media/media-entity.h +13 -0
+			if ((pos->flags & MEDIA_LNK_FL_LINK_TYPE) ==
+			    MEDIA_LNK_FL_DATA_LINK)
+				return pos;
+
+		return NULL;
+	}
+
+	list_for_each_entry_continue(pos, &entity->links, list)
+		if ((pos->flags & MEDIA_LNK_FL_LINK_TYPE) ==
+		    MEDIA_LNK_FL_DATA_LINK)
+			return pos;
+
+	return NULL;

I wonder if the same could be achieved with list_for_each_entry_from() ?

	pos = pos ? list_next_entry(pos, list)
		  : list_first_entry(&entity->links, typeof(*pos), list);

        list_for_each_entry_from(pos, ...) {
                if (...)
                        return pos;

        }

        return NULL;

If I'm not mistaken the two versions are functionally equivalent..

The iterator seems a good idea. Do you plan to use it for "media: rkisp1: Don't create data links for non-sensor subdevs" too, or changing the list of subdevs to iterate is enough there ?

Thanks
j

Quoted 13 lines
include/media/media-entity.h +7 -1
+}
+
+#define for_each_media_entity_data_link(entity, pos)		\
+	for (pos = __media_entity_next_data_link(entity, NULL);	\
+	     pos;						\
+	     pos = __media_entity_next_data_link(entity, pos))
+
 /**
  * gobj_to_entity - returns the struct &media_entity pointer from the
  *	@gobj contained on it.
--

2.25.1

maintainer
#3 lore raw

Re: [PATCH 1/2] media: media-entity.h: Add iterator for entity data links

Quoted 28 lines · Jacopo Mondi

Hi Dan

Quoted 4 lines · Daniel Scally

Iterating over the links for an entity is a somewhat common need through the media subsystem, but generally the assumption is that they will all be data links. To meet that assumption add a new macro that iterates through an entity's links and skips non-data links.

Do you foresee usages of a similar iterator but for ancillary (or interface) links ?

In that case you could add a 'link_type' flag to
__media_entity_next_data_link

Quoted 14 lines
---
 include/media/media-entity.h | 26 ++++++++++++++++++++++++++
 1 file changed, 26 insertions(+)
include/media/media-entity.h +0 -0
index a9a1c0ec5d1c..b13f67f33508 100644
@@ -550,6 +550,32 @@ static inline bool media_entity_enum_intersects(
 				 min(ent_enum1->idx_max, ent_enum2->idx_max));
 }
 
Quoted 6 lines

include/media/media-entity.h static inline bool media_entity_enum_intersects( · line 553

Quoted 1 line
include/media/media-entity.h +1 -0
+static inline struct media_link *

Isn't this a bit too much for inlining ? Also I heard many times that it's not worth anymore trying to outsmart the compiler and inline is discouraged in most cases ? (and it kind of makes sense to me, but I sometimes wonder if that's some form of cargo cult..)

That's right, but in .h files you need to manually inline, otherwise you'll end up with one copy per compilation unit.

Quoted 36 lines

include/media/media-entity.h static inline bool media_entity_enum_intersects( · line 558

Quoted 5 lines
include/media/media-entity.h +5 -0
+__media_entity_next_data_link(struct media_entity *entity,
+			      struct media_link *pos)
+{
+	if (!pos) {
+		list_for_each_entry(pos, &entity->links, list)

nit: coding style requires you to have braces

------------------------------------------------------------------------------
from Documentation/process/coding-style.rst:
Also, use braces when a loop contains more than a single simple statement:

.. code-block:: c

	while (condition) {
		if (test)
			do_something();
	}

------------------------------------------------------------------------------

include/media/media-entity.h static inline bool media_entity_enum_intersects( · line 571

Quoted 13 lines
include/media/media-entity.h +13 -0
+			if ((pos->flags & MEDIA_LNK_FL_LINK_TYPE) ==
+			    MEDIA_LNK_FL_DATA_LINK)
+				return pos;
+
+		return NULL;
+	}
+
+	list_for_each_entry_continue(pos, &entity->links, list)
+		if ((pos->flags & MEDIA_LNK_FL_LINK_TYPE) ==
+		    MEDIA_LNK_FL_DATA_LINK)
+			return pos;
+
+	return NULL;

I wonder if the same could be achieved with list_for_each_entry_from() ?

Quoted 10 lines
	pos = pos ? list_next_entry(pos, list)
		  : list_first_entry(&entity->links, typeof(*pos), list);

        list_for_each_entry_from(pos, ...) {
                if (...)
                        return pos;

        }

        return NULL;

That's even better than what I've suggested.

Quoted 16 lines

If I'm not mistaken the two versions are functionally equivalent..

The iterator seems a good idea. Do you plan to use it for "media: rkisp1: Don't create data links for non-sensor subdevs" too, or changing the list of subdevs to iterate is enough there ?

Quoted 10 lines
include/media/media-entity.h +7 -0
+}
+
+#define for_each_media_entity_data_link(entity, pos)		\
+	for (pos = __media_entity_next_data_link(entity, NULL);	\
+	     pos;						\
+	     pos = __media_entity_next_data_link(entity, pos))
+
 /**
  * gobj_to_entity - returns the struct &media_entity pointer from the
  *	@gobj contained on it.
Signature · 3 lines
Regards,

Laurent Pinchart
#4 lore raw

Re: [PATCH 1/2] media: media-entity.h: Add iterator for entity data links

hi Laurent,

Quoted 36 lines · Laurent Pinchart
Quoted 28 lines · Jacopo Mondi

Hi Dan

Quoted 4 lines · Daniel Scally

Iterating over the links for an entity is a somewhat common need through the media subsystem, but generally the assumption is that they will all be data links. To meet that assumption add a new macro that iterates through an entity's links and skips non-data links.

Do you foresee usages of a similar iterator but for ancillary (or interface) links ?

In that case you could add a 'link_type' flag to
__media_entity_next_data_link

Quoted 14 lines
---
 include/media/media-entity.h | 26 ++++++++++++++++++++++++++
 1 file changed, 26 insertions(+)
include/media/media-entity.h +0 -0
index a9a1c0ec5d1c..b13f67f33508 100644
@@ -550,6 +550,32 @@ static inline bool media_entity_enum_intersects(
 				 min(ent_enum1->idx_max, ent_enum2->idx_max));
 }
 
Quoted 6 lines

include/media/media-entity.h static inline bool media_entity_enum_intersects( · line 553

Quoted 1 line
include/media/media-entity.h +1 -0
+static inline struct media_link *

Isn't this a bit too much for inlining ? Also I heard many times that it's not worth anymore trying to outsmart the compiler and inline is discouraged in most cases ? (and it kind of makes sense to me, but I sometimes wonder if that's some form of cargo cult..)

Quoted 3 lines

That's right, but in .h files you need to manually inline, otherwise you'll end up with one copy per compilation unit.

I was suggesting to move it to a .c file in facts, likely mc-entity.c

#5 lore raw

Re: [PATCH 1/2] media: media-entity.h: Add iterator for entity data links

Morning both

Quoted 35 lines · Jacopo Mondi

hi Laurent,

Quoted 32 lines · Laurent Pinchart
Quoted 31 lines · Jacopo Mondi

Hi Dan

Quoted 4 lines · Daniel Scally

Iterating over the links for an entity is a somewhat common need through the media subsystem, but generally the assumption is that they will all be data links. To meet that assumption add a new macro that iterates through an entity's links and skips non-data links.

Do you foresee usages of a similar iterator but for ancillary (or interface) links ?

In that case you could add a 'link_type' flag to
__media_entity_next_data_link

Quoted 10 lines
---
 include/media/media-entity.h | 26 ++++++++++++++++++++++++++
 1 file changed, 26 insertions(+)
include/media/media-entity.h +0 -0
index a9a1c0ec5d1c..b13f67f33508 100644

include/media/media-entity.h static inline bool media_entity_enum_intersects( · line 553

Quoted 4 lines
include/media/media-entity.h +1 -0
@@ -550,6 +550,32 @@ static inline bool media_entity_enum_intersects(
 				 min(ent_enum1->idx_max, ent_enum2->idx_max));
 }
 
+static inline struct media_link *

Isn't this a bit too much for inlining ? Also I heard many times that it's not worth anymore trying to outsmart the compiler and inline is discouraged in most cases ? (and it kind of makes sense to me, but I sometimes wonder if that's some form of cargo cult..)

Quoted 4 lines
Quoted 3 lines

That's right, but in .h files you need to manually inline, otherwise you'll end up with one copy per compilation unit.

I was suggesting to move it to a .c file in facts, likely mc-entity.c

The one copy per compilation unit problem spurred the inline indeed - but no problem, I'll move it to the .c

#6 lore raw

Re: [PATCH 1/2] media: media-entity.h: Add iterator for entity data links

In reply to Jacopo Mondi

Hi Jacopo

Quoted 7 lines · Jacopo Mondi

Hi Dan

Quoted 4 lines · Daniel Scally

Iterating over the links for an entity is a somewhat common need through the media subsystem, but generally the assumption is that they will all be data links. To meet that assumption add a new macro that iterates through an entity's links and skips non-data links.

Quoted 5 lines

Do you foresee usages of a similar iterator but for ancillary (or interface) links ?

In that case you could add a 'link_type' flag to
__media_entity_next_data_link

Ooh this is a great idea - I'm not sure we'd need it for the ancillary links right now but in the future when the flash gets linked then it could crop up. I'll add the flag, thanks.

Quoted 14 lines
Quoted 14 lines
---
 include/media/media-entity.h | 26 ++++++++++++++++++++++++++
 1 file changed, 26 insertions(+)
include/media/media-entity.h +0 -0
index a9a1c0ec5d1c..b13f67f33508 100644
@@ -550,6 +550,32 @@ static inline bool media_entity_enum_intersects(
 				 min(ent_enum1->idx_max, ent_enum2->idx_max));
 }
 
Quoted 5 lines

include/media/media-entity.h static inline bool media_entity_enum_intersects( · line 553

Quoted 1 line
include/media/media-entity.h +1 -0
+static inline struct media_link *

Isn't this a bit too much for inlining ? Also I heard many times that it's not worth anymore trying to outsmart the compiler and inline is discouraged in most cases ? (and it kind of makes sense to me, but I sometimes wonder if that's some form of cargo cult..)

Probably - I'll move the function to media-entity.c instead.

Quoted 12 lines

include/media/media-entity.h static inline bool media_entity_enum_intersects( · line 558

Quoted 6 lines
include/media/media-entity.h +5 -0
+__media_entity_next_data_link(struct media_entity *entity,
+			      struct media_link *pos)
+{
+	if (!pos) {
+		list_for_each_entry(pos, &entity->links, list)

nit: coding style requires you to have braces

------------------------------------------------------------------------------
from Documentation/process/coding-style.rst:
Also, use braces when a loop contains more than a single simple statement:

Quoted 7 lines

.. code-block:: c

	while (condition) {
		if (test)
			do_something();
	}

------------------------------------------------------------------------------

Good point, thanks :)

Quoted 26 lines

include/media/media-entity.h static inline bool media_entity_enum_intersects( · line 571

Quoted 13 lines
include/media/media-entity.h +13 -0
+			if ((pos->flags & MEDIA_LNK_FL_LINK_TYPE) ==
+			    MEDIA_LNK_FL_DATA_LINK)
+				return pos;
+
+		return NULL;
+	}
+
+	list_for_each_entry_continue(pos, &entity->links, list)
+		if ((pos->flags & MEDIA_LNK_FL_LINK_TYPE) ==
+		    MEDIA_LNK_FL_DATA_LINK)
+			return pos;
+
+	return NULL;

I wonder if the same could be achieved with list_for_each_entry_from() ?

	pos = pos ? list_next_entry(pos, list)
		  : list_first_entry(&entity->links, typeof(*pos), list);

        list_for_each_entry_from(pos, ...) {
                if (...)
                        return pos;

        }

        return NULL;
Quoted 1 line

If I'm not mistaken the two versions are functionally equivalent..

Yes that's much better - thanks!

Quoted 4 lines

The iterator seems a good idea. Do you plan to use it for "media: rkisp1: Don't create data links for non-sensor subdevs" too, or changing the list of subdevs to iterate is enough there ?

No it's a slightly different problem there actually, I'm going to switch that to the list of async subdevs in the same way the ipu3-cio2 works as you suggested instead.

Quoted 16 lines

Thanks
j

Quoted 13 lines
include/media/media-entity.h +7 -1
+}
+
+#define for_each_media_entity_data_link(entity, pos)		\
+	for (pos = __media_entity_next_data_link(entity, NULL);	\
+	     pos;						\
+	     pos = __media_entity_next_data_link(entity, pos))
+
 /**
  * gobj_to_entity - returns the struct &media_entity pointer from the
  *	@gobj contained on it.
--

2.25.1

maintainer
#7 lore raw

Re: [PATCH 1/2] media: media-entity.h: Add iterator for entity data links

In reply to Daniel Scally

Hi Daniel,

Thank you for the patch.

Quoted 15 lines · Daniel Scally

Iterating over the links for an entity is a somewhat common need through the media subsystem, but generally the assumption is that they will all be data links. To meet that assumption add a new macro that iterates through an entity's links and skips non-data links.

---
 include/media/media-entity.h | 26 ++++++++++++++++++++++++++
 1 file changed, 26 insertions(+)
include/media/media-entity.h +0 -0
index a9a1c0ec5d1c..b13f67f33508 100644

include/media/media-entity.h static inline bool media_entity_enum_intersects( · line 555

Quoted 6 lines
include/media/media-entity.h +3 -0
@@ -550,6 +550,32 @@ static inline bool media_entity_enum_intersects(
 				 min(ent_enum1->idx_max, ent_enum2->idx_max));
 }
 
+static inline struct media_link *
+__media_entity_next_data_link(struct media_entity *entity,
+			      struct media_link *pos)

We could make this more dynamic by passing the link type as an argument, adding more iteration macros for different link types in the future would then be easier. Up to you.

Quoted 4 lines
include/media/media-entity.h +4 -0
+{
+	if (!pos) {
+		list_for_each_entry(pos, &entity->links, list)
+			if ((pos->flags & MEDIA_LNK_FL_LINK_TYPE) ==

include/media/media-entity.h static inline bool media_entity_enum_intersects( · line 569

Quoted 10 lines
include/media/media-entity.h +10 -0
+			    MEDIA_LNK_FL_DATA_LINK)
+				return pos;
+
+		return NULL;
+	}
+
+	list_for_each_entry_continue(pos, &entity->links, list)
+		if ((pos->flags & MEDIA_LNK_FL_LINK_TYPE) ==
+		    MEDIA_LNK_FL_DATA_LINK)
+			return pos;

This could be simplified to

	if (!pos)
		pos = list_entry(&entity->links, struct media_link, list);

	list_for_each_entry_continue(pos, &entity->links, list) {
		if ((pos->flags & MEDIA_LNK_FL_LINK_TYPE) ==
		    MEDIA_LNK_FL_DATA_LINK)
			return pos;
	}

include/media/media-entity.h static inline bool media_entity_enum_intersects( · line 564

Quoted 3 lines
include/media/media-entity.h +3 -0
+
+	return NULL;
+}

This is a bit big for an inline function, could we move the implementation to the .c file ?

include/media/media-entity.h static inline bool media_entity_enum_intersects( · line 574

Quoted 2 lines
include/media/media-entity.h +2 -0
+
+#define for_each_media_entity_data_link(entity, pos)		\

s/pos/link/ ?

include/media/media-entity.h static inline bool media_entity_enum_intersects( · line 578

Quoted 4 lines
include/media/media-entity.h +4 -0
+	for (pos = __media_entity_next_data_link(entity, NULL);	\
+	     pos;						\
+	     pos = __media_entity_next_data_link(entity, pos))
+

I'm afraid this needs documentation :-)
(https://lore.kernel.org/linux-media/[email protected]/
can be used as an example)

Quoted 3 lines
include/media/media-entity.h +0 -0
 /**
  * gobj_to_entity - returns the struct &media_entity pointer from the
  *	@gobj contained on it.
Signature · 3 lines
Regards,

Laurent Pinchart
#8 lore raw

PATCH 2/2 media: entity: Use dedicated data link iterator

In reply to Daniel Scally

Where iteration over links for an entity is clearly assuming that all of those links are data links, use the new iterator to guarantee that that assumption is met.

---
 drivers/media/mc/mc-entity.c | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)
drivers/media/mc/mc-entity.c +3 -3
index 11f5207f73aa..f46690fd141d 100644
@@ -449,7 +449,7 @@ __must_check int __media_pipeline_start(struct media_entity *entity,
 		bitmap_zero(active, entity->num_pads);
 		bitmap_fill(has_no_links, entity->num_pads);
 
-		list_for_each_entry(link, &entity->links, list) {
+		for_each_media_entity_data_link(entity, link) {
 			struct media_pad *pad = link->sink->entity == entity
 						? link->sink : link->source;
 
@@ -888,7 +888,7 @@ media_entity_find_link(struct media_pad *source, struct media_pad *sink)
 {
 	struct media_link *link;
 
-	list_for_each_entry(link, &source->entity->links, list) {
+	for_each_media_entity_data_link(source->entity, link) {
 		if (link->source->entity == source->entity &&
 		    link->source->index == source->index &&
 		    link->sink->entity == sink->entity &&
@@ -904,7 +904,7 @@ struct media_pad *media_entity_remote_pad(const struct media_pad *pad)
 {
 	struct media_link *link;
 
-	list_for_each_entry(link, &pad->entity->links, list) {
+	for_each_media_entity_data_link(pad->entity, link) {
 		if (!(link->flags & MEDIA_LNK_FL_ENABLED))
 			continue;
 
Signature · 1 line
2.25.1
maintainer Reviewed-by on v1 2/2
#9 lore raw

Re: [PATCH 2/2] media: entity: Use dedicated data link iterator

Hi Dan,

Thank you for the patch.

Quoted 5 lines · Daniel Scally

Where iteration over links for an entity is clearly assuming that all of those links are data links, use the new iterator to guarantee that that assumption is met.

Quoted 35 lines
---
 drivers/media/mc/mc-entity.c | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)
drivers/media/mc/mc-entity.c +3 -3
index 11f5207f73aa..f46690fd141d 100644
@@ -449,7 +449,7 @@ __must_check int __media_pipeline_start(struct media_entity *entity,
 		bitmap_zero(active, entity->num_pads);
 		bitmap_fill(has_no_links, entity->num_pads);
 
-		list_for_each_entry(link, &entity->links, list) {
+		for_each_media_entity_data_link(entity, link) {
 			struct media_pad *pad = link->sink->entity == entity
 						? link->sink : link->source;
 
@@ -888,7 +888,7 @@ media_entity_find_link(struct media_pad *source, struct media_pad *sink)
 {
 	struct media_link *link;
 
-	list_for_each_entry(link, &source->entity->links, list) {
+	for_each_media_entity_data_link(source->entity, link) {
 		if (link->source->entity == source->entity &&
 		    link->source->index == source->index &&
 		    link->sink->entity == sink->entity &&
@@ -904,7 +904,7 @@ struct media_pad *media_entity_remote_pad(const struct media_pad *pad)
 {
 	struct media_link *link;
 
-	list_for_each_entry(link, &pad->entity->links, list) {
+	for_each_media_entity_data_link(pad->entity, link) {
 		if (!(link->flags & MEDIA_LNK_FL_ENABLED))
 			continue;
 
Signature · 3 lines
Regards,

Laurent Pinchart