[PATCH v2] scripts: add typdef removal tool

[PATCH v2] scripts: add typdef removal tool

[Luis R. Rodriguez]

If you are porting drivers and need to remove tydpefs you can use
this to help you port the driver faster. Until we don't have a fully
correct and complete way to do this through Coccinelle spatch we
might as well help developers porting drivers with something. spatch
also has a learning curve, people working on staging may not end
up using it for a while.

Cc: Julia Lawall <julia@diku.dk>
Cc: Joe Perches <joe@perches.com>
Cc: Nicolas Palix <npalix@diku.dk>
Cc: Yoann Padioleau <yoann.padioleau@gmail.com>
Signed-off-by: Luis R. Rodriguez <lrodriguez@atheros.com>
---

 scripts/remove-typedef |   70 ++++++++++++++++++++++++++++++++++++++++++++++++
 1 files changed, 70 insertions(+), 0 deletions(-)
 create mode 100755 scripts/remove-typedef

diff --git a/scripts/remove-typedef b/scripts/remove-typedef
new file mode 100755
index 0000000..17b8034
--- /dev/null
+++ b/scripts/remove-typedef
@@ -0,0 +1,70 @@
+#!/bin/bash
+#
+# Copyright 2009 Joe Perches <joe@perches.com>
+# Copyright 2009 Luis R. Rodriguez <mcgrof@gmail.com>
+#
+# Lets you remove typedefs from C/header files.
+#
+# We do simple sed substituation for logical places where you would
+# use the typedef, and also replace the typedef declaration to a simple
+# struct declaration.
+
+function usage()
+{
+	echo "Usage $0 <typedef-name> <struct-name> <paths>"
+	exit 1
+}
+
+function remove_typedef()
+{
+	if [ ! -f $1 ]; then
+		return;
+	fi
+
+	# This replaces the typedef usages with simple structs
+	sed -r -i -e "s/\b$from\b/struct $to/g" $1
+	sed -r -i -e "s/\bP$from\b/struct $to \*/g" $1
+	sed -r -i -e "s/struct $to\s*\*\s*\b/struct $to \*/g" $1
+	sed -r -i -e "s/\(struct $to\s*\*\)\s*/\(struct $to \*\)/g" $1
+
+	# This replaces the typedef declaration for a simple struct declaration - style 0
+	perl -i -e "local $/; while(<>) { s/\btypedef\s+struct\s+([\d\D]+?)\s*\{([\d\D]+?)\}\s*struct\s+$to\b[^;]*;/struct $to \{\2\};/g; print; }" $1
+
+	# This replaces the typedef declaration for a simple struct declaration - style 1
+	perl -i -e "local $/; while(<>) { s/\btypedef\s+struct\s+_$from\s*\{([\d\D]+?)\}\s*struct\s+$to\b[^;]*;/struct $to \{\1\};/g; print; }" $1
+
+	# This replaces the typedef declaration for a simple struct declaration - style 2
+	perl -i -e "local $/; while(<>) { s/\btypedef\s+struct\s+$to\s*\{([\d\D]+?)\}\s*$from\b[^;]*;/struct $to \{\1\};/g; print; }" $1
+
+}
+
+if [[ $# -lt 3 ]]; then
+	usage
+fi
+
+from=$1
+to=$2
+shift
+
+echo "Converting typedef $from to struct $to"
+
+while shift; do
+	REM_PATH=$1
+
+	if [ -z $REM_PATH ]; then
+		continue;
+	fi
+
+	if [ ! -d $REM_PATH ]; then
+		echo "No directory $REM_PATH";
+		continue;
+	fi
+
+	for i in $(find $REM_PATH -type f -name *.c); do
+		remove_typedef $i
+	done
+
+	for i in $(find $REM_PATH -type f -name *.h); do
+		remove_typedef $i
+	done
+done
-- 
1.6.3.3

Re: [PATCH v2] scripts: add typdef removal tool

[Amerigo Wang]

On Thu, Aug 13, 2009 at 10:39:44PM -0700, Luis R. Rodriguez wrote:
>If you are porting drivers and need to remove tydpefs you can use
>this to help you port the driver faster. Until we don't have a fully
>correct and complete way to do this through Coccinelle spatch we
>might as well help developers porting drivers with something. spatch
>also has a learning curve, people working on staging may not end
>up using it for a while.
>
>Cc: Julia Lawall <julia@diku.dk>
>Cc: Joe Perches <joe@perches.com>
>Cc: Nicolas Palix <npalix@diku.dk>
>Cc: Yoann Padioleau <yoann.padioleau@gmail.com>
>Signed-off-by: Luis R. Rodriguez <lrodriguez@atheros.com>
>---
>
> scripts/remove-typedef |   70 ++++++++++++++++++++++++++++++++++++++++++++++++
> 1 files changed, 70 insertions(+), 0 deletions(-)
> create mode 100755 scripts/remove-typedef
>
>diff --git a/scripts/remove-typedef b/scripts/remove-typedef
>new file mode 100755
>index 0000000..17b8034
>--- /dev/null
>+++ b/scripts/remove-typedef
>@@ -0,0 +1,70 @@
>+#!/bin/bash
>+#
>+# Copyright 2009 Joe Perches <joe@perches.com>
>+# Copyright 2009 Luis R. Rodriguez <mcgrof@gmail.com>
>+#
>+# Lets you remove typedefs from C/header files.
>+#
>+# We do simple sed substituation for logical places where you would
>+# use the typedef, and also replace the typedef declaration to a simple
>+# struct declaration.
>+
>+function usage()
>+{
>+	echo "Usage $0 <typedef-name> <struct-name> <paths>"
>+	exit 1
>+}
>+
>+function remove_typedef()
>+{
>+	if [ ! -f $1 ]; then
>+		return;
>+	fi
>+
>+	# This replaces the typedef usages with simple structs
>+	sed -r -i -e "s/\b$from\b/struct $to/g" $1
>+	sed -r -i -e "s/\bP$from\b/struct $to \*/g" $1
>+	sed -r -i -e "s/struct $to\s*\*\s*\b/struct $to \*/g" $1
>+	sed -r -i -e "s/\(struct $to\s*\*\)\s*/\(struct $to \*\)/g" $1
>+
>+	# This replaces the typedef declaration for a simple struct declaration - style 0
>+	perl -i -e "local $/; while(<>) { s/\btypedef\s+struct\s+([\d\D]+?)\s*\{([\d\D]+?)\}\s*struct\s+$to\b[^;]*;/struct $to \{\2\};/g; print; }" $1
>+
>+	# This replaces the typedef declaration for a simple struct declaration - style 1
>+	perl -i -e "local $/; while(<>) { s/\btypedef\s+struct\s+_$from\s*\{([\d\D]+?)\}\s*struct\s+$to\b[^;]*;/struct $to \{\1\};/g; print; }" $1
>+
>+	# This replaces the typedef declaration for a simple struct declaration - style 2
>+	perl -i -e "local $/; while(<>) { s/\btypedef\s+struct\s+$to\s*\{([\d\D]+?)\}\s*$from\b[^;]*;/struct $to \{\1\};/g; print; }" $1
>+
>+}
>+
>+if [[ $# -lt 3 ]]; then
>+	usage
>+fi
>+
>+from=$1
>+to=$2
>+shift
>+
>+echo "Converting typedef $from to struct $to"
>+
>+while shift; do
>+	REM_PATH=$1
>+
>+	if [ -z $REM_PATH ]; then
>+		continue;
>+	fi
>+
>+	if [ ! -d $REM_PATH ]; then
>+		echo "No directory $REM_PATH";
>+		continue;
>+	fi
>+
>+	for i in $(find $REM_PATH -type f -name *.c); do
>+		remove_typedef $i
>+	done
>+
>+	for i in $(find $REM_PATH -type f -name *.h); do
>+		remove_typedef $i
>+	done

These two 'find's can be merged:

  find $REM_PATH -type f -name '*.c' -o -name '*.h'


Thanks.

Re: [PATCH v2] scripts: add typdef removal tool

[Jiri Slaby]

Hi!

On 08/17/2009 08:02 AM, Amerigo Wang wrote:
...
>> --- /dev/null
>> +++ b/scripts/remove-typedef
>> @@ -0,0 +1,70 @@
>> +#!/bin/bash
>> +#
>> +# Copyright 2009 Joe Perches <joe@perches.com>
>> +# Copyright 2009 Luis R. Rodriguez <mcgrof@gmail.com>
>> +#
>> +# Lets you remove typedefs from C/header files.
>> +#
>> +# We do simple sed substituation for logical places where you would

substitution

>> +function remove_typedef()
>> +{
>> +	if [ ! -f $1 ]; then
>> +		return;
>> +	fi
>> +
>> +	# This replaces the typedef usages with simple structs
>> +	sed -r -i -e "s/\b$from\b/struct $to/g" $1
>> +	sed -r -i -e "s/\bP$from\b/struct $to \*/g" $1
>> +	sed -r -i -e "s/struct $to\s*\*\s*\b/struct $to \*/g" $1
>> +	sed -r -i -e "s/\(struct $to\s*\*\)\s*/\(struct $to \*\)/g" $1

Could that be one sed with multiple -e's?

>> +	# This replaces the typedef declaration for a simple struct declaration - style 0
>> +	perl -i -e "local $/; while(<>) { s/\btypedef\s+struct\s+([\d\D]+?)\s*\{([\d\D]+?)\}\s*struct\s+$to\b[^;]*;/struct $to \{\2\};/g; print; }" $1

This is safe until bash devs start to use $/ as something. It should be
escaped.

>> +	# This replaces the typedef declaration for a simple struct declaration - style 1
>> +	perl -i -e "local $/; while(<>) { s/\btypedef\s+struct\s+_$from\s*\{([\d\D]+?)\}\s*struct\s+$to\b[^;]*;/struct $to \{\1\};/g; print; }" $1
>> +
>> +	# This replaces the typedef declaration for a simple struct declaration - style 2
>> +	perl -i -e "local $/; while(<>) { s/\btypedef\s+struct\s+$to\s*\{([\d\D]+?)\}\s*$from\b[^;]*;/struct $to \{\1\};/g; print; }" $1

And possibly one
perl -ipe "BEGIN { \$/ = '' };
	s/x/y/g;
	s/y/z/g;"
?

Or do the sed work by perl too?

>> +}
>> +
>> +if [[ $# -lt 3 ]]; then

Could that be [ ] instead of [[ ]]?

>> +	usage
>> +fi
>> +
>> +from=$1
>> +to=$2
>> +shift
>> +echo "Converting typedef $from to struct $to"
>> +
>> +while shift; do
>> +	REM_PATH=$1
>> +
>> +	if [ -z $REM_PATH ]; then
>> +		continue;
>> +	fi
>> +
>> +	if [ ! -d $REM_PATH ]; then
>> +		echo "No directory $REM_PATH";
>> +		continue;
>> +	fi
>> +
>> +	for i in $(find $REM_PATH -type f -name *.c); do
>> +		remove_typedef $i
>> +	done
>> +
>> +	for i in $(find $REM_PATH -type f -name *.h); do
>> +		remove_typedef $i
>> +	done
> 
> These two 'find's can be merged:
> 
>   find $REM_PATH -type f -name '*.c' -o -name '*.h'

Yes, please enclose those wildcards into ''. Also REM_PATH can be with
spaces, use "" for it, $i and $1 etc.

Re: [PATCH v2] scripts: add typdef removal tool

[Matthias Urlichs]

[-- Attachment #1: Type: text/plain, Size: 184 bytes --]

On Fri, 2009-08-21 at 10:48 +0200, Jiri Slaby wrote:
> >> +if [[ $# -lt 3 ]]; then
> 
> Could that be [ ] instead of [[ ]]?
> 
Yes. In fact, it should be, as [[ ]] is a bashism.

[-- Attachment #2: This is a digitally signed message part --]
[-- Type: application/pgp-signature, Size: 197 bytes --]

Re: [PATCH v2] scripts: add typdef removal tool

[Américo Wang]

On Sun, Aug 23, 2009 at 03:09:10PM +0200, Matthias Urlichs wrote:
>On Fri, 2009-08-21 at 10:48 +0200, Jiri Slaby wrote:
>> >> +if [[ $# -lt 3 ]]; then
>> 
>> Could that be [ ] instead of [[ ]]?
>> 
>Yes. In fact, it should be, as [[ ]] is a bashism.

Also that the classic test command is enough here,
no need to bother conditional expression.


-- 
Live like a child, think like the god.
 

Re: [PATCH v2] scripts: add typdef removal tool

[Matthias Urlichs]

[-- Attachment #1: Type: text/plain, Size: 412 bytes --]

On Mon, 2009-08-17 at 14:02 +0800, Amerigo Wang wrote:
> These two 'find's can be merged:
> 
>   find $REM_PATH -type f -name '*.c' -o -name '*.h'
> 
You mean

find $REM_PATH -type f \( -name '*.c' -o -name '*.h' \)

or

find $REM_PATH -type f -name '*.[ch]'

Otherwise, directory names ending in .h will cause false postiives.
(Yes, I know that we don't have any of those at the moment, but …)

[-- Attachment #2: This is a digitally signed message part --]
[-- Type: application/pgp-signature, Size: 197 bytes --]

Re: [PATCH v2] scripts: add typdef removal tool

[Américo Wang]

On Sun, Aug 23, 2009 at 03:22:53PM +0200, Matthias Urlichs wrote:
>On Mon, 2009-08-17 at 14:02 +0800, Amerigo Wang wrote:
>> These two 'find's can be merged:
>> 
>>   find $REM_PATH -type f -name '*.c' -o -name '*.h'
>> 
>You mean
>
>find $REM_PATH -type f \( -name '*.c' -o -name '*.h' \)
>
>or
>
>find $REM_PATH -type f -name '*.[ch]'
>
>Otherwise, directory names ending in .h will cause false postiives.
>(Yes, I know that we don't have any of those at the moment, but …)

Yeah, sure. The latter one above is better.

-- 
Live like a child, think like the god.
 

Re: [PATCH v2] scripts: add typdef removal tool

[Jiri Slaby]

On 08/23/2009 03:22 PM, Matthias Urlichs wrote:
> Otherwise, directory names ending in .h will cause false postiives.
> (Yes, I know that we don't have any of those at the moment, but …)

-type f excludes directories. But people (me including) sometimes do
have .c files in the root kernel source directory.

Re: [PATCH v2] scripts: add typdef removal tool

[Matthias Urlichs]

[-- Attachment #1: Type: text/plain, Size: 422 bytes --]

On Sun, 2009-08-23 at 19:59 +0200, Jiri Slaby wrote:
> -type f excludes directories.

Yes, but -o binds more loosely.

$ mkdir bar
$ find . -type f -name foo -o -name bar
bar
$

I like to pay attention to correct idioms. There is no problem in this
case because there are no directories named *.h in the kernel tree — but
people read code like that, and then apply it to situations where it
_does_ matter.

[-- Attachment #2: This is a digitally signed message part --]
[-- Type: application/pgp-signature, Size: 197 bytes --]

Re: [PATCH v2] scripts: add typdef removal tool

[Pekka Enberg]

On Fri, Aug 14, 2009 at 8:39 AM, Luis R. Rodriguez
<lrodriguez@atheros.com> wrote:
> If you are porting drivers and need to remove tydpefs you can use
> this to help you port the driver faster. Until we don't have a fully
> correct and complete way to do this through Coccinelle spatch we
> might as well help developers porting drivers with something. spatch
> also has a learning curve, people working on staging may not end
> up using it for a while.
>
> Cc: Julia Lawall <julia@diku.dk>
> Cc: Joe Perches <joe@perches.com>
> Cc: Nicolas Palix <npalix@diku.dk>
> Cc: Yoann Padioleau <yoann.padioleau@gmail.com>
> Signed-off-by: Luis R. Rodriguez <lrodriguez@atheros.com>

How come this script never made it to the kernel tree?

Re: [PATCH v2] scripts: add typdef removal tool

[Joe Perches]

On Sun, 2010-09-19 at 11:19 +0300, Pekka Enberg wrote:
> On Fri, Aug 14, 2009 at 8:39 AM, Luis R. Rodriguez
> <lrodriguez@atheros.com> wrote:
> > If you are porting drivers and need to remove tydpefs you can use
> > this to help you port the driver faster. Until we don't have a fully
> > correct and complete way to do this through Coccinelle spatch we
> > might as well help developers porting drivers with something. spatch
> > also has a learning curve, people working on staging may not end
> > up using it for a while.
> How come this script never made it to the kernel tree?

General lack of interest?

Probably the same reason that similar patches didn't.
https://patchwork.kernel.org/patch/88026/

Re: [PATCH v2] scripts: add typdef removal tool

[Pekka Enberg]

  On 19.9.2010 11.49, Joe Perches wrote:
> On Sun, 2010-09-19 at 11:19 +0300, Pekka Enberg wrote:
>> On Fri, Aug 14, 2009 at 8:39 AM, Luis R. Rodriguez
>> <lrodriguez@atheros.com>  wrote:
>>> If you are porting drivers and need to remove tydpefs you can use
>>> this to help you port the driver faster. Until we don't have a fully
>>> correct and complete way to do this through Coccinelle spatch we
>>> might as well help developers porting drivers with something. spatch
>>> also has a learning curve, people working on staging may not end
>>> up using it for a while.
>> How come this script never made it to the kernel tree?
> General lack of interest?
>
> Probably the same reason that similar patches didn't.
> https://patchwork.kernel.org/patch/88026/
Scripts like these are sure handy when dealing with the crap in staging 
tree. Maybe we can convince Greg to take them in.

             Pekka

Re: [PATCH v2] scripts: add typdef removal tool

[Luis R. Rodriguez]

On Sun, Sep 19, 2010 at 2:30 AM, Pekka Enberg <penberg@kernel.org> wrote:
>  On 19.9.2010 11.49, Joe Perches wrote:
>>
>> On Sun, 2010-09-19 at 11:19 +0300, Pekka Enberg wrote:
>>>
>>> On Fri, Aug 14, 2009 at 8:39 AM, Luis R. Rodriguez
>>> <lrodriguez@atheros.com>  wrote:
>>>>
>>>> If you are porting drivers and need to remove tydpefs you can use
>>>> this to help you port the driver faster. Until we don't have a fully
>>>> correct and complete way to do this through Coccinelle spatch we
>>>> might as well help developers porting drivers with something. spatch
>>>> also has a learning curve, people working on staging may not end
>>>> up using it for a while.
>>>
>>> How come this script never made it to the kernel tree?
>>
>> General lack of interest?
>>
>> Probably the same reason that similar patches didn't.
>> https://patchwork.kernel.org/patch/88026/
>
> Scripts like these are sure handy when dealing with the crap in staging
> tree.

Or if you are trying to avoid staging by doing all the hard work yourself.

> Maybe we can convince Greg to take them in.

:)

  Luis