Skip to contentSkip to conversation

flex_array: add helpers to get and put to make pointers easy to use

PATCH In review Eric Paris 3 participants 5 messages Aug 3, 2010

Subsystems (2)
lore
Share & tools
lore

Eric Paris

author
#0 lore raw

PATCH 1/1 flex_array: add helpers to get and put to make pointers easy to use

Getting and putting arrays of pointers with flex arrays is a PITA. You have to remember to pass &ptr to the _put and you have to do weird and wacky casting to get the ptr back from the _get. Add two functions flex_array_get_ptr() and flex_array_put_ptr() to handle all of the magic.

---

 include/linux/flex_array.h |    6 ++++++
 lib/flex_array.c           |   25 ++++++++++++++++++++++++-
 2 files changed, 30 insertions(+), 1 deletions(-)
include/linux/flex_array.h +6 -0
index 1d747f7..f4e4eb2 100644
@@ -70,4 +70,10 @@ int flex_array_clear(struct flex_array *fa, unsigned int element_nr);
 void *flex_array_get(struct flex_array *fa, unsigned int element_nr);
 int flex_array_shrink(struct flex_array *fa);
 
+#define flex_array_put_ptr(fa, nr, src, gfp)	({						\
+						 void *_src = (src);				\
+						 flex_array_put((fa), (nr), &_src, (gfp));	\
+						})
+void *flex_array_get_ptr(struct flex_array *fa, unsigned int element_nr);
+
 #endif /* _FLEX_ARRAY_H */
lib/flex_array.c +24 -1
index 41b1804..77a6fea 100644
@@ -171,6 +171,8 @@ __fa_get_part(struct flex_array *fa, int part_nr, gfp_t flags)
  * Note that this *copies* the contents of @src into
  * the array.  If you are trying to store an array of
  * pointers, make sure to pass in &ptr instead of ptr.
+ * You may instead wish to use the flex_array_put_ptr()
+ * helper function.
  *
  * Locking must be provided by the caller.
  */
@@ -265,7 +267,8 @@ int flex_array_prealloc(struct flex_array *fa, unsigned int start,
  *
  * Returns a pointer to the data at index @element_nr.  Note
  * that this is a copy of the data that was passed in.  If you
- * are using this to store pointers, you'll get back &ptr.
+ * are using this to store pointers, you'll get back &ptr.  You
+ * may instead wish to use the flex_array_get_ptr helper.
  *
  * Locking must be provided by the caller.
  */
@@ -286,6 +289,26 @@ void *flex_array_get(struct flex_array *fa, unsigned int element_nr)
 	return &part->elements[index_inside_part(fa, element_nr)];
 }
 
+/**
+ * flex_array_get_ptr - pull a ptr back out of the array
+ * @fa:		the flex array from which to extract data
+ * @element_nr:	index of the element to fetch from the array
+ *
+ * Returns the pointer placed in the flex array at element_nr using
+ * flex_array_put_ptr().  This function should not be called if the
+ * element in question was not set using the _put_ptr() helper.
+ */
+void *flex_array_get_ptr(struct flex_array *fa, unsigned int element_nr)
+{
+	void **tmp;
+
+	tmp = flex_array_get(fa, element_nr);
+	if (!tmp)
+		return NULL;
+
+	return *tmp;
+}
+
 static int part_is_free(struct flex_array_part *part)
 {
 	int i;

--
This message was distributed to subscribers of the selinux mailing list. If you no longer wish to subscribe, send mail to [email protected] with the words "unsubscribe selinux" without quotes as the message.

#1 lore raw
Quoted 17 lines · Eric Paris

Getting and putting arrays of pointers with flex arrays is a PITA. You have to remember to pass &ptr to the _put and you have to do weird and wacky casting to get the ptr back from the _get. Add two functions flex_array_get_ptr() and flex_array_put_ptr() to handle all of the magic.

---

 include/linux/flex_array.h |    6 ++++++
 lib/flex_array.c           |   25 ++++++++++++++++++++++++-
 2 files changed, 30 insertions(+), 1 deletions(-)
include/linux/flex_array.h +0 -0
index 1d747f7..f4e4eb2 100644

include/linux/flex_array.h int flex_array_clear(struct flex_array *fa, unsigned int element_nr); · line 76

Quoted 7 lines
include/linux/flex_array.h +4 -0
@@ -70,4 +70,10 @@ int flex_array_clear(struct flex_array *fa, unsigned int element_nr);
 void *flex_array_get(struct flex_array *fa, unsigned int element_nr);
 int flex_array_shrink(struct flex_array *fa);
 
+#define flex_array_put_ptr(fa, nr, src, gfp)	({						\
+						 void *_src = (src);				\
+						 flex_array_put((fa), (nr), &_src, (gfp));	\
+						})

Might be nicer to use fewer indents.
Isn't this equivalent?

#define flex_array_put_ptr(fa, nr, src, gfp)			\
	flex_array_put(fa, nr, &(void *)(src), gfp)
#2 lore raw
In reply to Eric Paris
Quoted 5 lines · Eric Paris

Getting and putting arrays of pointers with flex arrays is a PITA. You have to remember to pass &ptr to the _put and you have to do weird and wacky casting to get the ptr back from the _get. Add two functions flex_array_get_ptr() and flex_array_put_ptr() to handle all of the magic.

There's no code currently in the tree that uses the flex array interface, so is this something that you've encountered in practice or only by inspection? If it's the former, is that code on its way for 2.6.36?

I'm hoping distros aren't creating internal dependencies on this interface that could practically be removed from upstream at any time given its lack of popularity.

author
#3 lore raw
Quoted 11 lines · David Rientjes
Quoted 5 lines · Eric Paris

Getting and putting arrays of pointers with flex arrays is a PITA. You have to remember to pass &ptr to the _put and you have to do weird and wacky casting to get the ptr back from the _get. Add two functions flex_array_get_ptr() and flex_array_put_ptr() to handle all of the magic.

There's no code currently in the tree that uses the flex array interface, so is this something that you've encountered in practice or only by inspection? If it's the former, is that code on its way for 2.6.36?

I did decide to use flex_arrays on code intended for .36
http://git.kernel.org/?p=linux/kernel/git/jmorris/security-testing-2.6.git;a=commitdiff;h=6371dcd36f649d9d07823f31400618155a20dde1

Quoted 3 lines

I'm hoping distros aren't creating internal dependencies on this interface that could practically be removed from upstream at any time given its lack of popularity.

I've got some more patches that I'm looking towards .37 which would use the _ptr helpers I suggested:

http://marc.info/?l=selinux&m=128086475312322&w=2
http://marc.info/?l=selinux&m=128086558513723&w=2

--
This message was distributed to subscribers of the selinux mailing list. If you no longer wish to subscribe, send mail to [email protected] with the words "unsubscribe selinux" without quotes as the message.

#4 lore raw
Quoted 6 lines · Eric Paris
Quoted 6 lines
Quoted 5 lines

Getting and putting arrays of pointers with flex arrays is a PITA. You have to remember to pass &ptr to the _put and you have to do weird and wacky casting to get the ptr back from the _get. Add two functions flex_array_get_ptr() and flex_array_put_ptr() to handle all of the magic.

Quoted 7 lines
Quoted 3 lines

There's no code currently in the tree that uses the flex array interface, so is this something that you've encountered in practice or only by inspection? If it's the former, is that code on its way for 2.6.36?

I did decide to use flex_arrays on code intended for .36
http://git.kernel.org/?p=linux/kernel/git/jmorris/security-testing-2.6.git;a=commitdiff;h=6371dcd36f649d9d07823f31400618155a20dde1

Great, a user! I'm hoping that more people will adopt this interface but I can't think of anything that could currently be converted. Maybe we can find opportunities in patches as they're proposed to the list.

Thanks.