Skip to contentSkip to conversation

RFC: kernel coding style: prefer array to &array[0] ?

PATCH Joe Perches 5 participants 9 messages Jun 30, 2015 – Jul 5, 2015 Checkpatch

lore
Share & tools
lore

Joe Perches

author maintainer
#0 lore raw

It seems most in-kernel uses are 'array' rather than '&array[0]'

Most of the time, using array is simpler to read than &array[0].

Exceptions exists when addresses for consecutive members are used like func(&array[0], &array[1]);

Should this preference be put into checkpatch and/or CodingStyle?

Here's a possible checkpatch --strict addition

---
 scripts/checkpatch.pl | 6 ++++++
 1 file changed, 6 insertions(+)
scripts/checkpatch.pl +6 -0
index 90e1edc..362a9d8 100755
@@ -5492,6 +5492,12 @@ sub process {
 			}
 		}
 
+# check for address of array[0] (not '&& array[0]' or &array[0].member)
+		if ($sline =~ /[^\&]&\s*($Ident\s*(?:(?:\-\>|\.)\s*$Ident\s*)*)\s*\[\s*0\s*\]\s*(?!\[|\.|\-\>)/) {
+			CHK("ADDRESSOF_ARRAY",
+			    "Using addressof array '$1' index [0] may be simpler as '$1'\n" . $herecurr);
+		}
+
 # check for semaphores initialized locked
 		if ($line =~ /^.\s*sema_init.+,\W?0\W?\)/) {
 			WARN("CONSIDER_COMPLETION",
#1 lore raw
Quoted 8 lines · Joe Perches

It seems most in-kernel uses are 'array' rather than '&array[0]'

Most of the time, using array is simpler to read than &array[0].

Exceptions exists when addresses for consecutive members are used like func(&array[0], &array[1]);

Should this preference be put into checkpatch and/or CodingStyle?

&array[0] looks complicated to me.

julia

Quoted 25 lines

Here's a possible checkpatch --strict addition

---
 scripts/checkpatch.pl | 6 ++++++
 1 file changed, 6 insertions(+)
scripts/checkpatch.pl +6 -0
index 90e1edc..362a9d8 100755
@@ -5492,6 +5492,12 @@ sub process {
 			}
 		}
 
+# check for address of array[0] (not '&& array[0]' or &array[0].member)
+		if ($sline =~ /[^\&]&\s*($Ident\s*(?:(?:\-\>|\.)\s*$Ident\s*)*)\s*\[\s*0\s*\]\s*(?!\[|\.|\-\>)/) {
+			CHK("ADDRESSOF_ARRAY",
+			    "Using addressof array '$1' index [0] may be simpler as '$1'\n" . $herecurr);
+		}
+
 # check for semaphores initialized locked
 		if ($line =~ /^.\s*sema_init.+,\W?0\W?\)/) {
 			WARN("CONSIDER_COMPLETION",
#2 lore raw
In reply to Joe Perches
Quoted 6 lines · Joe Perches

It seems most in-kernel uses are 'array' rather than '&array[0]'

Most of the time, using array is simpler to read than &array[0].

Exceptions exists when addresses for consecutive members are used like func(&array[0], &array[1]);

I use '&array[0]' when I want to get a pointer to a single object that happens to be the first one in an array.

Quoted 1 line

Should this preference be put into checkpatch and/or CodingStyle?

How about the following low-hanging fruit?

foo(..., &array[0], ARRAY_SIZE(array), ...)

Regards,
Clemens

#3 lore raw
Quoted 10 lines · Clemens Ladisch
Quoted 6 lines · Joe Perches

It seems most in-kernel uses are 'array' rather than '&array[0]'

Most of the time, using array is simpler to read than &array[0].

Exceptions exists when addresses for consecutive members are used like func(&array[0], &array[1]);

I use '&array[0]' when I want to get a pointer to a single object that happens to be the first one in an array.

Yeah. Of course, you're right. Otherwise it ends up confusing static checkers if you want the first element or the whole array.

Quoted 6 lines
Quoted 2 lines

Should this preference be put into checkpatch and/or CodingStyle?

How about the following low-hanging fruit?

foo(..., &array[0], ARRAY_SIZE(array), ...)

Yes, to this also. I doubt checkpatch.pl will find a meaningful number of these but doing that is annoying thing.

regards,
dan carpenter

#4 lore raw
Quoted 16 lines · Dan Carpenter
Quoted 10 lines · Clemens Ladisch
Quoted 6 lines · Joe Perches

It seems most in-kernel uses are 'array' rather than '&array[0]'

Most of the time, using array is simpler to read than &array[0].

Exceptions exists when addresses for consecutive members are used like func(&array[0], &array[1]);

I use '&array[0]' when I want to get a pointer to a single object that happens to be the first one in an array.

Yeah. Of course, you're right. Otherwise it ends up confusing static checkers if you want the first element or the whole array.

Quoted 1 line
Quoted 8 lines
Quoted 5 lines
Quoted 1 line

Should this preference be put into checkpatch and/or CodingStyle?

How about the following low-hanging fruit?

foo(..., &array[0], ARRAY_SIZE(array), ...)

Yes, to this also. I doubt checkpatch.pl will find a meaningful number of these but doing that is annoying thing.

Atcually, I find 236 of them, in 48 files.

julia

author maintainer
#5 lore raw
Quoted 7 lines · Julia Lawall
Quoted 6 lines · Dan Carpenter
Quoted 5 lines · Clemens Ladisch
Quoted 4 lines · Joe Perches

It seems most in-kernel uses are 'array' rather than '&array[0]'

Most of the time, using array is simpler to read than &array[0].

Quoted 8 lines
Quoted 8 lines
Quoted 5 lines
Quoted 2 lines

Exceptions exists when addresses for consecutive members are used like func(&array[0], &array[1]);

I use '&array[0]' when I want to get a pointer to a single object that happens to be the first one in an array.

Yeah. Of course, you're right. Otherwise it ends up confusing static checkers if you want the first element or the whole array.

Right.

Quoted 1 line
Quoted 1 line
Quoted 1 line
Quoted 1 line

Should this preference be put into checkpatch and/or CodingStyle?

And checkpatch will have no idea what the prototype for any function is, so this transform is better left for smarter tools like coccinelle.

The proper answer here is no.

Quoted 8 lines
Quoted 6 lines
Quoted 3 lines

How about the following low-hanging fruit?

foo(..., &array[0], ARRAY_SIZE(array), ...)

Yes, to this also. I doubt checkpatch.pl will find a meaningful number of these but doing that is annoying thing.

Atcually, I find 236 of them, in 48 files.

The uses I found:

drivers/input/touchscreen nas a few

There are some inconsistent uses of 1 vs ARRAY_SIZE in drivers/mfd/ for "struct mfc_cell" arrays uses for
mfd_add_devices()

2 in net/netfilter/xt_l2tp.c that could be changed

sound/pci has a couple

sound/soc/codecs has the rest. These are all the same form where a macro like SND_SOC_DAPM_MIXER is used.

An example:

#define SND_SOC_DAPM_MIXER(wname, wreg, wshift, winvert, \
	 wcontrols, wncontrols)\
{	.id = snd_soc_dapm_mixer, .name = wname, \
	SND_SOC_DAPM_INIT_REG_VAL(wreg, wshift, winvert), \
	.kcontrol_news = wcontrols, .num_kcontrols = wncontrols}

but is used with wcontrols as either NULL or an array and ARRAY_SIZE can't be used on NULL.

Perhaps it's appropriate to change the macro (and uses) removing the last wncontrols argument. Something like:

#define SND_SOC_DAPM_MIXER(wname, wreg, wshift, winvert, wcontrols) \

{									\
	.id = snd_soc_dapm_mixer,					\
	.name = wname, 							\
	SND_SOC_DAPM_INIT_REG_VAL(wreg, wshift, winvert),		\
	.kcontrol_news = wcontrols,					\
	.num_kcontrols = (wcontrols) ? ARRAY_SIZE(wcontrols) : 0,	\
}

for example, the uses change from:

	SND_SOC_DAPM_MIXER("HPOut Mix", SND_SOC_NOPM, 0, 0, NULL, 0),
to:
	SND_SOC_DAPM_MIXER("HPOut Mix", SND_SOC_NOPM, 0, 0, NULL),

and from:

	SND_SOC_DAPM_MIXER("Mono Mixer", SND_SOC_NOPM, 0, 0,
			   da7210_dapm_monomix_controls, ARRAY_SIZE(da7210_dapm_monomix_controls)),
to:
	SND_SOC_DAPM_MIXER("Mono Mixer", SND_SOC_NOPM, 0, 0,
			   da7210_dapm_monomix_controls),

or just leave them as-is.

#6 lore raw
Quoted 31 lines · Joe Perches
Quoted 7 lines · Julia Lawall
Quoted 6 lines · Dan Carpenter
Quoted 5 lines · Clemens Ladisch
Quoted 4 lines · Joe Perches

It seems most in-kernel uses are 'array' rather than '&array[0]'

Most of the time, using array is simpler to read than &array[0].

Quoted 8 lines
Quoted 8 lines
Quoted 5 lines
Quoted 2 lines

Exceptions exists when addresses for consecutive members are used like func(&array[0], &array[1]);

I use '&array[0]' when I want to get a pointer to a single object that happens to be the first one in an array.

Yeah. Of course, you're right. Otherwise it ends up confusing static checkers if you want the first element or the whole array.

Right.

Quoted 1 line
Quoted 1 line
Quoted 1 line
Quoted 1 line

Should this preference be put into checkpatch and/or CodingStyle?

And checkpatch will have no idea what the prototype for any function is, so this transform is better left for smarter tools like coccinelle.

The proper answer here is no.

Quoted 4 lines
Quoted 4 lines
Quoted 3 lines

How about the following low-hanging fruit?

foo(..., &array[0], ARRAY_SIZE(array), ...)

Quoted 8 lines
Quoted 4 lines
Quoted 2 lines

Yes, to this also. I doubt checkpatch.pl will find a meaningful number of these but doing that is annoying thing.

Atcually, I find 236 of them, in 48 files.

The uses I found:

drivers/input/touchscreen nas a few

I got curious so I ran the proposed patch over drivers/input/touchscreen and it produced the following gems:

CHECK: Using addressof array 'data' index [0] may be simpler as 'data' #49: FILE: drivers/input/touchscreen/dynapro.c:49:
+#define DYNAPRO_GET_TOUCHED(data) (DYNAPRO_FORMAT_TOUCH_BIT & data[0])

CHECK: Using addressof array 'mtouch->data' index [0] may be simpler as 'mtouch->data'
#97: FILE: drivers/input/touchscreen/mtouch.c:97:
+ if (MTOUCH_FORMAT_TABLET_STATUS_BIT & mtouch->data[0])

... etc.

While below can be written as just "msg" in many cases when you parse several fields in the structure the original is actually cleaner:

CHECK: Using addressof array 'msg' index [0] may be simpler as 'msg' #38: FILE: drivers/input/touchscreen/ipaq-micro-ts.c:38:
+ be16_to_cpup((__be16 *) &msg[0]));

I'd be OK with changing cases like:

CHECK: Using addressof array 'buf' index [0] may be simpler as 'buf' #232: FILE: drivers/input/touchscreen/zforce_ts.c:232:
+ return zforce_send_wait(ts, &buf[0], ARRAY_SIZE(buf));

Thanks.

Signature · 1 line
Dmitry
author maintainer
#7 lore raw
Quoted 20 lines · Dmitry Torokhov
Quoted 19 lines · Joe Perches
Quoted 7 lines · Julia Lawall
Quoted 6 lines · Dan Carpenter
Quoted 5 lines · Clemens Ladisch
Quoted 4 lines · Joe Perches

It seems most in-kernel uses are 'array' rather than '&array[0]'

Most of the time, using array is simpler to read than &array[0].

Quoted 8 lines
Quoted 8 lines
Quoted 5 lines
Quoted 2 lines

Exceptions exists when addresses for consecutive members are used like func(&array[0], &array[1]);

I use '&array[0]' when I want to get a pointer to a single object that happens to be the first one in an array.

Yeah. Of course, you're right. Otherwise it ends up confusing static checkers if you want the first element or the whole array.

Right.

Quoted 7 lines
Quoted 7 lines
Quoted 1 line
Quoted 1 line
Quoted 1 line
Quoted 1 line

Should this preference be put into checkpatch and/or CodingStyle?

And checkpatch will have no idea what the prototype for any function is, so this transform is better left for smarter tools like coccinelle.

The proper answer here is no.

[]

Quoted 4 lines

CHECK: Using addressof array 'mtouch->data' index [0] may be simpler as 'mtouch->data'
#97: FILE: drivers/input/touchscreen/mtouch.c:97:
+ if (MTOUCH_FORMAT_TABLET_STATUS_BIT & mtouch->data[0])

The joys of perl parsing.

Quoted 3 lines

CHECK: Using addressof array 'msg' index [0] may be simpler as 'msg' #38: FILE: drivers/input/touchscreen/ipaq-micro-ts.c:38:
+ be16_to_cpup((__be16 *) &msg[0]));

That's using the first member in an array.

Quoted 5 lines

I'd be OK with changing cases like:

CHECK: Using addressof array 'buf' index [0] may be simpler as 'buf' #232: FILE: drivers/input/touchscreen/zforce_ts.c:232:
+ return zforce_send_wait(ts, &buf[0], ARRAY_SIZE(buf));

I think cases like those are sensible to change.

cheers, Joe