[v8] arm: rework id register storage

[PATCH v8 12/14] arm/cpu: Add sysreg generation scripts

Posted by Cornelia Huck 5 months ago

From: Eric Auger <eric.auger@redhat.com>

Introduce scripts that automate the generation of system register
definitions from a given linux source tree arch/arm64/tools/sysreg.

Invocation of
./update-aarch64-sysreg-code.sh $PATH_TO_LINUX_SOURCE_TREE
in scripts directory generates target/arm/cpu-sysregs.h.inc
containing defines for all system registers.

[CH: update to handle current kernel sysregs structure, and to emit
     the re-worked register structures; cpu properties will be added
     later]
Reviewed-by: Sebastian Ott <sebott@redhat.com>
Signed-off-by: Eric Auger <eric.auger@redhat.com>
Signed-off-by: Cornelia Huck <cohuck@redhat.com>
---
 MAINTAINERS                            |  1 +
 scripts/arm-gen-cpu-sysregs-header.awk | 37 ++++++++++++++++++++++++++
 scripts/update-aarch64-sysreg-code.sh  | 32 ++++++++++++++++++++++
 3 files changed, 70 insertions(+)
 create mode 100755 scripts/arm-gen-cpu-sysregs-header.awk
 create mode 100755 scripts/update-aarch64-sysreg-code.sh

diff --git a/MAINTAINERS b/MAINTAINERS
index 28b3dd2684b4..01334cb93ca1 100644
--- a/MAINTAINERS
+++ b/MAINTAINERS
@@ -443,6 +443,7 @@ M: Peter Maydell <peter.maydell@linaro.org>
 L: qemu-arm@nongnu.org
 S: Maintained
 F: target/arm/kvm.c
+F: scripts/*-sysreg*
 
 MIPS KVM CPUs
 M: Huacai Chen <chenhuacai@kernel.org>
diff --git a/scripts/arm-gen-cpu-sysregs-header.awk b/scripts/arm-gen-cpu-sysregs-header.awk
new file mode 100755
index 000000000000..f92bbbafa727
--- /dev/null
+++ b/scripts/arm-gen-cpu-sysregs-header.awk
@@ -0,0 +1,37 @@
+#!/bin/awk -f
+# SPDX-License-Identifier: GPL-2.0-or-later
+# arm-gen-cpu-sysregs-header.awk: arm64 sysreg header include generator
+#
+# Usage: awk -f arm-gen-cpu-sysregs-header.awk $LINUX_PATH/arch/arm64/tools/sysreg
+
+BEGIN {
+    print "/* SPDX-License-Identifier: GPL-2.0-or-later */"
+    print "/* GENERATED FILE, DO NOT EDIT */"
+    print "/* use arm-gen-cpu-sysregs-header.awk to regenerate */"
+} END {
+    print ""
+}
+
+# skip blank lines and comment lines
+/^$/ { next }
+/^[\t ]*#/ { next }
+
+/^Sysreg\t/ || /^Sysreg /{
+
+	reg = $2
+	op0 = $3
+	op1 = $4
+	crn = $5
+	crm = $6
+	op2 = $7
+
+	if (op0 == 3 && (op1==0 || op1==1 || op1==3) && crn==0 && (crm>=0 && crm<=7) && (op2>=0 && op2<=7)) {
+	    print "DEF("reg", "op0", "op1", "crn", "crm", "op2")"
+	}
+	next
+}
+
+{
+	/* skip all other lines */
+	next
+}
diff --git a/scripts/update-aarch64-sysreg-code.sh b/scripts/update-aarch64-sysreg-code.sh
new file mode 100755
index 000000000000..7bba0bcd6f66
--- /dev/null
+++ b/scripts/update-aarch64-sysreg-code.sh
@@ -0,0 +1,32 @@
+#!/bin/sh -e
+#
+# SPDX-License-Identifier: GPL-2.0-or-later
+# Update target/arm/cpu-sysregs.h
+# from a linux source tree (arch/arm64/tools/sysreg)
+#
+# Copyright Red Hat, Inc. 2024
+#
+# Authors:
+#          Eric Auger <eric.auger@redhat.com>
+#
+
+scripts="$(dirname "$0")"
+linux="$1"
+output="$2"
+
+if [ -z "$linux" ] || ! [ -d "$linux" ]; then
+    cat << EOF
+usage: update-aarch64-sysreg-code.sh LINUX_PATH [OUTPUT_PATH]
+
+LINUX_PATH      Linux kernel directory to obtain the register definitions from
+OUTPUT_PATH     output directory, usually the qemu source tree (default: $PWD)
+EOF
+    exit 1
+fi
+
+if [ -z "$output" ]; then
+    output="$PWD"
+fi
+
+awk -f $scripts/arm-gen-cpu-sysregs-header.awk \
+    $linux/arch/arm64/tools/sysreg > $output/target/arm/cpu-sysregs.h.inc
-- 
2.49.0

Re: [PATCH v8 12/14] arm/cpu: Add sysreg generation scripts

Posted by Cornelia Huck 5 months ago

On Tue, Jun 17 2025, Cornelia Huck <cohuck@redhat.com> wrote:

> diff --git a/scripts/arm-gen-cpu-sysregs-header.awk b/scripts/arm-gen-cpu-sysregs-header.awk
> new file mode 100755
> index 000000000000..f92bbbafa727
> --- /dev/null
> +++ b/scripts/arm-gen-cpu-sysregs-header.awk
> @@ -0,0 +1,37 @@
> +#!/bin/awk -f
> +# SPDX-License-Identifier: GPL-2.0-or-later
> +# arm-gen-cpu-sysregs-header.awk: arm64 sysreg header include generator
> +#
> +# Usage: awk -f arm-gen-cpu-sysregs-header.awk $LINUX_PATH/arch/arm64/tools/sysreg
> +
> +BEGIN {
> +    print "/* SPDX-License-Identifier: GPL-2.0-or-later */"

FWIW, checkpatch.pl chokes on this:

^* matches null string many times in regex; marked by <-- HERE in m/^* <-- HERE /"$/ at scripts/checkpatch.pl line 1389.
ERROR: Saw unacceptable licenses '*/"', valid choices for QEMU are:
GPL-2.0-or-later
GPL-2.0-only
LGPL-2.1-only
LGPL-2.1-or-later
BSD-2-Clause
BSD-3-Clause
MIT
total: 1 errors, 0 warnings, 76 lines checked

> +    print "/* GENERATED FILE, DO NOT EDIT */"
> +    print "/* use arm-gen-cpu-sysregs-header.awk to regenerate */"
> +} END {
> +    print ""
> +}
> +

Re: [PATCH v8 12/14] arm/cpu: Add sysreg generation scripts

Posted by Eric Auger 4 months, 3 weeks ago

Hi Connie,

On 6/17/25 5:45 PM, Cornelia Huck wrote:
> On Tue, Jun 17 2025, Cornelia Huck <cohuck@redhat.com> wrote:
>
>> diff --git a/scripts/arm-gen-cpu-sysregs-header.awk b/scripts/arm-gen-cpu-sysregs-header.awk
>> new file mode 100755
>> index 000000000000..f92bbbafa727
>> --- /dev/null
>> +++ b/scripts/arm-gen-cpu-sysregs-header.awk
>> @@ -0,0 +1,37 @@
>> +#!/bin/awk -f
>> +# SPDX-License-Identifier: GPL-2.0-or-later
>> +# arm-gen-cpu-sysregs-header.awk: arm64 sysreg header include generator
>> +#
>> +# Usage: awk -f arm-gen-cpu-sysregs-header.awk $LINUX_PATH/arch/arm64/tools/sysreg
>> +
>> +BEGIN {
>> +    print "/* SPDX-License-Identifier: GPL-2.0-or-later */"
> FWIW, checkpatch.pl chokes on this:
>
> ^* matches null string many times in regex; marked by <-- HERE in m/^* <-- HERE /"$/ at scripts/checkpatch.pl line 1389.
> ERROR: Saw unacceptable licenses '*/"', valid choices for QEMU are:
> GPL-2.0-or-later
> GPL-2.0-only
> LGPL-2.1-only
> LGPL-2.1-or-later
> BSD-2-Clause
> BSD-3-Clause
> MIT
> total: 1 errors, 0 warnings, 76 lines checked

so don't we need to improve checkpatch.pl to silence this error?

Cheers

Eric
>
>
>> +    print "/* GENERATED FILE, DO NOT EDIT */"
>> +    print "/* use arm-gen-cpu-sysregs-header.awk to regenerate */"
>> +} END {
>> +    print ""
>> +}
>> +

Re: [PATCH v8 12/14] arm/cpu: Add sysreg generation scripts

Posted by Cornelia Huck 4 months, 3 weeks ago

On Wed, Jun 25 2025, Eric Auger <eric.auger@redhat.com> wrote:

> Hi Connie,
>
> On 6/17/25 5:45 PM, Cornelia Huck wrote:
>> On Tue, Jun 17 2025, Cornelia Huck <cohuck@redhat.com> wrote:
>>
>>> diff --git a/scripts/arm-gen-cpu-sysregs-header.awk b/scripts/arm-gen-cpu-sysregs-header.awk
>>> new file mode 100755
>>> index 000000000000..f92bbbafa727
>>> --- /dev/null
>>> +++ b/scripts/arm-gen-cpu-sysregs-header.awk
>>> @@ -0,0 +1,37 @@
>>> +#!/bin/awk -f
>>> +# SPDX-License-Identifier: GPL-2.0-or-later
>>> +# arm-gen-cpu-sysregs-header.awk: arm64 sysreg header include generator
>>> +#
>>> +# Usage: awk -f arm-gen-cpu-sysregs-header.awk $LINUX_PATH/arch/arm64/tools/sysreg
>>> +
>>> +BEGIN {
>>> +    print "/* SPDX-License-Identifier: GPL-2.0-or-later */"
>> FWIW, checkpatch.pl chokes on this:
>>
>> ^* matches null string many times in regex; marked by <-- HERE in m/^* <-- HERE /"$/ at scripts/checkpatch.pl line 1389.
>> ERROR: Saw unacceptable licenses '*/"', valid choices for QEMU are:
>> GPL-2.0-or-later
>> GPL-2.0-only
>> LGPL-2.1-only
>> LGPL-2.1-or-later
>> BSD-2-Clause
>> BSD-3-Clause
>> MIT
>> total: 1 errors, 0 warnings, 76 lines checked
>
> so don't we need to improve checkpatch.pl to silence this error?

Yes, that would be good, but my perl-fu is basically nonexistant :(

Re: [PATCH v8 12/14] arm/cpu: Add sysreg generation scripts

Posted by Daniel P. Berrangé 4 months, 3 weeks ago

On Wed, Jun 25, 2025 at 11:16:22AM +0200, Eric Auger wrote:
> Hi Connie,
> 
> On 6/17/25 5:45 PM, Cornelia Huck wrote:
> > On Tue, Jun 17 2025, Cornelia Huck <cohuck@redhat.com> wrote:
> >
> >> diff --git a/scripts/arm-gen-cpu-sysregs-header.awk b/scripts/arm-gen-cpu-sysregs-header.awk
> >> new file mode 100755
> >> index 000000000000..f92bbbafa727
> >> --- /dev/null
> >> +++ b/scripts/arm-gen-cpu-sysregs-header.awk
> >> @@ -0,0 +1,37 @@
> >> +#!/bin/awk -f
> >> +# SPDX-License-Identifier: GPL-2.0-or-later
> >> +# arm-gen-cpu-sysregs-header.awk: arm64 sysreg header include generator
> >> +#
> >> +# Usage: awk -f arm-gen-cpu-sysregs-header.awk $LINUX_PATH/arch/arm64/tools/sysreg
> >> +
> >> +BEGIN {
> >> +    print "/* SPDX-License-Identifier: GPL-2.0-or-later */"
> > FWIW, checkpatch.pl chokes on this:
> >
> > ^* matches null string many times in regex; marked by <-- HERE in m/^* <-- HERE /"$/ at scripts/checkpatch.pl line 1389.
> > ERROR: Saw unacceptable licenses '*/"', valid choices for QEMU are:
> > GPL-2.0-or-later
> > GPL-2.0-only
> > LGPL-2.1-only
> > LGPL-2.1-or-later
> > BSD-2-Clause
> > BSD-3-Clause
> > MIT
> > total: 1 errors, 0 warnings, 76 lines checked
> 
> so don't we need to improve checkpatch.pl to silence this error?

Its regex gets confused by the trailing " after the comment end. We
could fix it, but ignoring the error is also valid as this is a
highly unusual file that's not likely to be common through our
source tree.


With regards,
Daniel
-- 
|: https://berrange.com      -o-    https://www.flickr.com/photos/dberrange :|
|: https://libvirt.org         -o-            https://fstop138.berrange.com :|
|: https://entangle-photo.org    -o-    https://www.instagram.com/dberrange :|

Re: [PATCH v8 12/14] arm/cpu: Add sysreg generation scripts

Posted by Eric Auger 4 months, 3 weeks ago

Hi Daniel,

On 6/25/25 11:23 AM, Daniel P. Berrangé wrote:
> On Wed, Jun 25, 2025 at 11:16:22AM +0200, Eric Auger wrote:
>> Hi Connie,
>>
>> On 6/17/25 5:45 PM, Cornelia Huck wrote:
>>> On Tue, Jun 17 2025, Cornelia Huck <cohuck@redhat.com> wrote:
>>>
>>>> diff --git a/scripts/arm-gen-cpu-sysregs-header.awk b/scripts/arm-gen-cpu-sysregs-header.awk
>>>> new file mode 100755
>>>> index 000000000000..f92bbbafa727
>>>> --- /dev/null
>>>> +++ b/scripts/arm-gen-cpu-sysregs-header.awk
>>>> @@ -0,0 +1,37 @@
>>>> +#!/bin/awk -f
>>>> +# SPDX-License-Identifier: GPL-2.0-or-later
>>>> +# arm-gen-cpu-sysregs-header.awk: arm64 sysreg header include generator
>>>> +#
>>>> +# Usage: awk -f arm-gen-cpu-sysregs-header.awk $LINUX_PATH/arch/arm64/tools/sysreg
>>>> +
>>>> +BEGIN {
>>>> +    print "/* SPDX-License-Identifier: GPL-2.0-or-later */"
>>> FWIW, checkpatch.pl chokes on this:
>>>
>>> ^* matches null string many times in regex; marked by <-- HERE in m/^* <-- HERE /"$/ at scripts/checkpatch.pl line 1389.
>>> ERROR: Saw unacceptable licenses '*/"', valid choices for QEMU are:
>>> GPL-2.0-or-later
>>> GPL-2.0-only
>>> LGPL-2.1-only
>>> LGPL-2.1-or-later
>>> BSD-2-Clause
>>> BSD-3-Clause
>>> MIT
>>> total: 1 errors, 0 warnings, 76 lines checked
>> so don't we need to improve checkpatch.pl to silence this error?
> Its regex gets confused by the trailing " after the comment end. We
> could fix it, but ignoring the error is also valid as this is a
> highly unusual file that's not likely to be common through our
> source tree.
Makes sense. We are good then.

Thanks!

Eric
>
>
> With regards,
> Daniel