Skip to contentSkip to conversation

xen: Build fixes related to Python3

PATCH Superseded Andrew Cooper 7 participants 16 messages Dec 7, 2019 – Dec 10, 2019

lore
Share & tools
lore
#0 lore raw

v3 cover xen: Build fixes related to Python3

Patch 3 is a fix for a problem reported on IRC. It is a very-nice-to-have considering our attempt to make Xen 4.13 Py3-clean.

While testing patch 3, it became apparent that XSM/Flask isn't Py3-clean, and this is a blocker. It is addressed in patch 1.

Patch 2 addresses a bug spotted by Gitlab while testing v1 of this series. It isn't strictly a Py3 bug, but is a build system robustness fix.

v3 of this series fixes all Travis and Gitlab identified issues:
https://travis-ci.org/andyhhp/xen/builds/622092503
https://gitlab.com/xen-project/people/andyhhp/xen/pipelines/101417861

Andrew Cooper (3):
xen/flask: Drop the gen-policy.py script xen/banner: Drop the fig-to-oct.py script xen/build: Automatically locate a suitable python interpreter

 xen/Makefile                 |  7 ++++++-
 xen/tools/fig-to-oct.py      | 18 ------------------
 xen/tools/process-banner.sed | 14 ++++++++++++++
 xen/xsm/flask/Makefile       |  6 ++----
 xen/xsm/flask/flask-policy.S | 20 ++++++++++++++++++++
 xen/xsm/flask/gen-policy.py  | 23 -----------------------
 6 files changed, 42 insertions(+), 46 deletions(-)
 delete mode 100644 xen/tools/fig-to-oct.py
 create mode 100755 xen/tools/process-banner.sed
 create mode 100644 xen/xsm/flask/flask-policy.S
 delete mode 100644 xen/xsm/flask/gen-policy.py
Signature · 7 lines
2.11.0


_______________________________________________
Xen-devel mailing list
[email protected]
https://lists.xenproject.org/mailman/listinfo/xen-devel
#1 lore raw

PATCH v3 1/3 xen/flask: Drop the gen-policy.py script

The script is Python 2 specific, and fails with string/binary issues with Python 3:

Traceback (most recent call last):
File "gen-policy.py", line 14, in <module>
for char in sys.stdin.read():
File "/usr/lib/python3.5/codecs.py", line 321, in decode
(result, consumed) = self._buffer_decode(data, self.errors, final)
UnicodeDecodeError: 'utf-8' codec can't decode byte 0x8c in position 0: invalid start byte

Fixing the script to be compatible isn't hard, but using python here is wasteful. Drop the script entirely, and write a short flask-policy.S instead.

---
CC: Daniel De Graaf <[email protected]>
CC: Juergen Gross <[email protected]>

v2:
* Fix tabs vs spaces issues
v3:
* Use % rather than @ for progbits/object, for Arm32 build.
* Spotted by https://travis-ci.org/andyhhp/xen/builds/622085138

For 4.13. This is a blocker to our intent to by Py3-clean in this release.

Discovered entirely accidently when testing the final patch.

---
 xen/xsm/flask/Makefile       |  6 ++----
 xen/xsm/flask/flask-policy.S | 20 ++++++++++++++++++++
 xen/xsm/flask/gen-policy.py  | 23 -----------------------
 3 files changed, 22 insertions(+), 27 deletions(-)
 create mode 100644 xen/xsm/flask/flask-policy.S
 delete mode 100644 xen/xsm/flask/gen-policy.py
xen/xsm/flask/Makefile +2 -4
index f5ffab1226..7c3f381287 100644
@@ -27,7 +27,8 @@ $(FLASK_H_FILES): $(FLASK_H_DEPEND)
 $(AV_H_FILES): $(AV_H_DEPEND)
 	$(CONFIG_SHELL) policy/mkaccess_vector.sh $(AWK) $(AV_H_DEPEND)
 
-obj-$(CONFIG_XSM_FLASK_POLICY) += policy.o
+obj-bin-$(CONFIG_XSM_FLASK_POLICY) += flask-policy.o
+flask-policy.o: policy.bin
 
 FLASK_BUILD_DIR := $(CURDIR)
 POLICY_SRC := $(FLASK_BUILD_DIR)/xenpolicy-$(XEN_FULLVERSION)
@@ -36,9 +37,6 @@ policy.bin: FORCE
 	$(MAKE) -f $(XEN_ROOT)/tools/flask/policy/Makefile.common -C $(XEN_ROOT)/tools/flask/policy FLASK_BUILD_DIR=$(FLASK_BUILD_DIR)
 	cmp -s $(POLICY_SRC) $@ || cp $(POLICY_SRC) $@
 
-policy.c: policy.bin gen-policy.py
-	$(PYTHON) gen-policy.py < $< > $@
-
 .PHONY: clean
 clean::
 	rm -f $(ALL_H_FILES) *.o $(DEPS_RM) policy.* $(POLICY_SRC)
xen/xsm/flask/flask-policy.S new file +20 -0
new file mode 100644
index 0000000000..81bfc09ec2
@@ -0,0 +1,20 @@
+        .section .init.rodata, "a", %progbits
+
+/* const unsigned char xsm_flask_init_policy[] __initconst */
+        .align 4
+        .global xsm_flask_init_policy
+xsm_flask_init_policy:
+        .incbin "policy.bin"
+.Lend:
+
+        .type xsm_flask_init_policy, %object
+        .size xsm_flask_init_policy, . - xsm_flask_init_policy
+
+/* const unsigned int __initconst xsm_flask_init_policy_size */
+        .align 4
+        .global xsm_flask_init_policy_size
+xsm_flask_init_policy_size:
+        .long .Lend - xsm_flask_init_policy
+
+        .type xsm_flask_init_policy_size, %object
+        .size xsm_flask_init_policy_size, . - xsm_flask_init_policy_size
xen/xsm/flask/gen-policy.py deleted +0 -23
deleted file mode 100644
index c7501e4614..0000000000
@@ -1,23 +0,0 @@
-#!/usr/bin/env python
-import sys
-
-policy_size = 0
-
-sys.stdout.write("""
-/* This file is autogenerated by gen_policy.py */
-#include <xen/init.h>
-#include <xsm/xsm.h>
-
-const unsigned char xsm_flask_init_policy[] __initconst = {
-""")
-
-for char in sys.stdin.read():
-    sys.stdout.write(" 0x%02x," % ord(char))
-    policy_size = policy_size + 1
-    if policy_size % 13 == 0:
-        sys.stdout.write("\n")
-
-sys.stdout.write("""
-};
-const unsigned int __initconst xsm_flask_init_policy_size = %d;
-""" % policy_size)
Signature · 7 lines
2.11.0


_______________________________________________
Xen-devel mailing list
[email protected]
https://lists.xenproject.org/mailman/listinfo/xen-devel
#2 lore raw

Re: [Xen-devel] [PATCH v3 1/3] xen/flask: Drop the gen-policy.py script

Quoted 11 lines · Andrew Cooper

The script is Python 2 specific, and fails with string/binary issues with Python 3:

Traceback (most recent call last):
File "gen-policy.py", line 14, in <module>
for char in sys.stdin.read():
File "/usr/lib/python3.5/codecs.py", line 321, in decode
(result, consumed) = self._buffer_decode(data, self.errors, final)
UnicodeDecodeError: 'utf-8' codec can't decode byte 0x8c in position 0: invalid start byte

Quoted 2 lines

Fixing the script to be compatible isn't hard, but using python here is wasteful. Drop the script entirely, and write a short flask-policy.S instead.

It might be helpful for casual reviewers to have a slightly better explanation of what the change is; namely:

- The end goal is to have a .o file exporting one variable containing the contents of policy.bin, and another containing its size.

- gen-policy.py generates a C file which contains the bytes of policy.bin (and its size). This means running python, and then a c compiler.

- The replacement use a .S file to "include" the binary directly. This involves only running an assembler, but has the same end effect.

This looks like a good change; but I don't know assembler well enough to give it an R-b.

-George

_______________________________________________
Xen-devel mailing list
[email protected]
https://lists.xenproject.org/mailman/listinfo/xen-devel

#3 lore raw

Re: [Xen-devel] [PATCH v3 1/3] xen/flask: Drop the gen-policy.py script

In reply to Andrew Cooper

xen/xsm/flask/flask-policy.S line 4

Quoted 7 lines · Andrew Cooper
xen/xsm/flask/flask-policy.S new file +4 -0
@@ -0,0 +1,20 @@
+        .section .init.rodata, "a", %progbits
+
+/* const unsigned char xsm_flask_init_policy[] __initconst */
+        .align 4

I'm afraid .align is not universal enough to be used here - iirc some architectures have it alias .p2align rather than (how e.g. x86 behaves) .balign. Looks like .p2align is available in all binutils versions we claim to be able to be built with. (I'm not sure the one here is needed anyway, but the one below we surely want.)

xen/xsm/flask/flask-policy.S line 17

Quoted 13 lines
xen/xsm/flask/flask-policy.S new file +13 -0
+        .global xsm_flask_init_policy
+xsm_flask_init_policy:
+        .incbin "policy.bin"
+.Lend:
+
+        .type xsm_flask_init_policy, %object
+        .size xsm_flask_init_policy, . - xsm_flask_init_policy
+
+/* const unsigned int __initconst xsm_flask_init_policy_size */
+        .align 4
+        .global xsm_flask_init_policy_size
+xsm_flask_init_policy_size:
+        .long .Lend - xsm_flask_init_policy

Similarly .long isn't really universal (various arches override it in gas). Aiui .dc.l is intended to be portable (despite still carrying the 'l' in its name, and despite even this one getting overridden by two arches). But perhaps best to ask on the binutils list.

Jan

_______________________________________________
Xen-devel mailing list
[email protected]
https://lists.xenproject.org/mailman/listinfo/xen-devel

#4 lore raw

Re: [Xen-devel] [PATCH v3 1/3] xen/flask: Drop the gen-policy.py script

Quoted 14 lines · Jan Beulich

xen/xsm/flask/flask-policy.S line 4

Quoted 7 lines · Andrew Cooper
xen/xsm/flask/flask-policy.S new file +4 -0
@@ -0,0 +1,20 @@
+        .section .init.rodata, "a", %progbits
+
+/* const unsigned char xsm_flask_init_policy[] __initconst */
+        .align 4

I'm afraid .align is not universal enough to be used here - iirc some architectures have it alias .p2align rather than (how e.g. x86 behaves) .balign. Looks like .p2align is available in all binutils versions we claim to be able to be built with. (I'm not sure the one here is needed anyway, but the one below we surely want.)

I can switch to p2align, but...

Quoted 11 lines
Quoted 11 lines
xen/xsm/flask/flask-policy.S new file +10 -0
+        .global xsm_flask_init_policy
+xsm_flask_init_policy:
+        .incbin "policy.bin"
+.Lend:
+
+        .type xsm_flask_init_policy, %object
+        .size xsm_flask_init_policy, . - xsm_flask_init_policy
+
+/* const unsigned int __initconst xsm_flask_init_policy_size */
+        .align 4
Quoted 8 lines

xen/xsm/flask/flask-policy.S line 17

Quoted 3 lines
xen/xsm/flask/flask-policy.S new file +3 -0
+        .global xsm_flask_init_policy_size
+xsm_flask_init_policy_size:
+        .long .Lend - xsm_flask_init_policy

Similarly .long isn't really universal (various arches override it in gas). Aiui .dc.l is intended to be portable (despite still carrying the 'l' in its name, and despite even this one getting overridden by two arches). But perhaps best to ask on the binutils list.

... this is not a clear or obvious way to go, not least because it makes a different expectation that int will never change from being 32 bits. At least .long will work even if it becomes longer in a future toolchain.

What is used here doesn't need to be universal - it only needs to work for the architectures we support.

If hand writing an asm file isn't considered good enough, then the other options are a C file with inline asm incbin, or objdump --rename-section.  The latter one would require a few changes elsewhere in the code, but only for linkage purposes.

~Andrew

_______________________________________________
Xen-devel mailing list
[email protected]
https://lists.xenproject.org/mailman/listinfo/xen-devel

#5 lore raw

Re: [Xen-devel] [PATCH v3 1/3] xen/flask: Drop the gen-policy.py script

Quoted 38 lines · Andrew Cooper
Quoted 14 lines · Jan Beulich

xen/xsm/flask/flask-policy.S line 4

Quoted 7 lines · Andrew Cooper
xen/xsm/flask/flask-policy.S new file +4 -0
@@ -0,0 +1,20 @@
+        .section .init.rodata, "a", %progbits
+
+/* const unsigned char xsm_flask_init_policy[] __initconst */
+        .align 4

I'm afraid .align is not universal enough to be used here - iirc some architectures have it alias .p2align rather than (how e.g. x86 behaves) .balign. Looks like .p2align is available in all binutils versions we claim to be able to be built with. (I'm not sure the one here is needed anyway, but the one below we surely want.)

I can switch to p2align, but...

Quoted 11 lines
Quoted 11 lines
xen/xsm/flask/flask-policy.S new file +10 -0
+        .global xsm_flask_init_policy
+xsm_flask_init_policy:
+        .incbin "policy.bin"
+.Lend:
+
+        .type xsm_flask_init_policy, %object
+        .size xsm_flask_init_policy, . - xsm_flask_init_policy
+
+/* const unsigned int __initconst xsm_flask_init_policy_size */
+        .align 4
Quoted 8 lines

xen/xsm/flask/flask-policy.S line 17

Quoted 3 lines
xen/xsm/flask/flask-policy.S new file +3 -0
+        .global xsm_flask_init_policy_size
+xsm_flask_init_policy_size:
+        .long .Lend - xsm_flask_init_policy

Similarly .long isn't really universal (various arches override it in gas). Aiui .dc.l is intended to be portable (despite still carrying the 'l' in its name, and despite even this one getting overridden by two arches). But perhaps best to ask on the binutils list.

Quoted 3 lines

... this is not a clear or obvious way to go, not least because it makes a different expectation that int will never change from being 32 bits. At least .long will work even if it becomes longer in a future toolchain.

There are a few targets where .long (and .int) appear to produce 2-byte values (at the first glance, i.e. without checking very closely).

Quoted 2 lines

What is used here doesn't need to be universal - it only needs to work for the architectures we support.

But it also would better not break silently for some future port. How about an equivalent to Linux'es _ASM_PTR() (say ASM_WORD()), which each architecture has to supply explicitly?

Quoted 4 lines

If hand writing an asm file isn't considered good enough, then the other options are a C file with inline asm incbin, or objdump --rename-section.  The latter one would require a few changes elsewhere in the code, but only for linkage purposes.

I'm entirely fine with an assembler source here, it just needs a little more polishing imo.

Jan

_______________________________________________
Xen-devel mailing list
[email protected]
https://lists.xenproject.org/mailman/listinfo/xen-devel

Acked-by on v3 1/3
#6 lore raw

Re: [Xen-devel] [PATCH v3 1/3] xen/flask: Drop the gen-policy.py script

In reply to Andrew Cooper
Quoted 10 lines · Andrew Cooper

The script is Python 2 specific, and fails with string/binary issues with Python 3:

Traceback (most recent call last):
File "gen-policy.py", line 14, in <module>
for char in sys.stdin.read():
File "/usr/lib/python3.5/codecs.py", line 321, in decode
(result, consumed) = self._buffer_decode(data, self.errors, final)
UnicodeDecodeError: 'utf-8' codec can't decode byte 0x8c in position 0: invalid start byte

Quoted 4 lines

Fixing the script to be compatible isn't hard, but using python here is wasteful. Drop the script entirely, and write a short flask-policy.S instead.

With either .align or .p2align as appropriate for more assemblers.

_______________________________________________
Xen-devel mailing list
[email protected]
https://lists.xenproject.org/mailman/listinfo/xen-devel

#7 lore raw

PATCH v4 1/3 xen/flask: Drop the gen-policy.py script

In reply to Andrew Cooper

The script is Python 2 specific, and fails with string/binary issues with Python 3:

Traceback (most recent call last):
File "gen-policy.py", line 14, in <module>
for char in sys.stdin.read():
File "/usr/lib/python3.5/codecs.py", line 321, in decode
(result, consumed) = self._buffer_decode(data, self.errors, final)
UnicodeDecodeError: 'utf-8' codec can't decode byte 0x8c in position 0: invalid start byte

Fixing the script to be compatible isn't hard, but using python here is wasteful. Drop the script entirely, and write an equivelent flask-policy.S instead. This removes the need for a $(PYTHON) and $(CC) pass.

---
CC: Daniel De Graaf <[email protected]>
CC: Juergen Gross <[email protected]>
CC: Jan Beulich <[email protected]>
CC: Wei Liu <[email protected]>
CC: Roger Pau Monné <[email protected]>
CC: Stefano Stabellini <[email protected]>
CC: Julien Grall <[email protected]>
CC: Volodymyr Babchuk <[email protected]>

v2:
* Fix tabs vs spaces issues
v3:
* Use % rather than @ for progbits/object, for Arm32 build.
* Spotted by https://travis-ci.org/andyhhp/xen/builds/622085138
v4:
* Introduce and use ASM_INT() to declare something compatible with int
* Drop .align

For 4.13. This is a blocker to our intent to by Py3-clean in this release.

Discovered entirely accidently when testing the final patch.

---
 xen/include/asm-arm/asm_defns.h |  6 ++++++
 xen/include/asm-x86/asm_defns.h |  6 ++++++
 xen/xsm/flask/Makefile          |  6 ++----
 xen/xsm/flask/flask-policy.S    | 16 ++++++++++++++++
 xen/xsm/flask/gen-policy.py     | 23 -----------------------
 5 files changed, 30 insertions(+), 27 deletions(-)
 create mode 100644 xen/xsm/flask/flask-policy.S
 delete mode 100644 xen/xsm/flask/gen-policy.py
xen/include/asm-arm/asm_defns.h +6 -0
index 3f21def0ab..b4fbcdae1d 100644
@@ -21,6 +21,12 @@
 label:  .asciz msg;                             \
 .popsection
 
+#define ASM_INT(label, val)                 \
+    .p2align 2;                             \
+label: .long (val);                         \
+    .size label, . - label;                 \
+    .type label, %object
+
 #endif /* __ARM_ASM_DEFNS_H__ */
 /*
  * Local variables:
xen/include/asm-x86/asm_defns.h +6 -0
index c4f49a35d3..370f239c50 100644
@@ -386,4 +386,10 @@ static always_inline void stac(void)
 4:  .p2align 2                            ; \
     .popsection
 
+#define ASM_INT(label, val)                 \
+    .p2align 2;                             \
+label: .long (val);                         \
+    .size label, . - label;                 \
+    .type label, @object
+
 #endif /* __X86_ASM_DEFNS_H__ */
xen/xsm/flask/Makefile +2 -4
index f5ffab1226..7c3f381287 100644
@@ -27,7 +27,8 @@ $(FLASK_H_FILES): $(FLASK_H_DEPEND)
 $(AV_H_FILES): $(AV_H_DEPEND)
 	$(CONFIG_SHELL) policy/mkaccess_vector.sh $(AWK) $(AV_H_DEPEND)
 
-obj-$(CONFIG_XSM_FLASK_POLICY) += policy.o
+obj-bin-$(CONFIG_XSM_FLASK_POLICY) += flask-policy.o
+flask-policy.o: policy.bin
 
 FLASK_BUILD_DIR := $(CURDIR)
 POLICY_SRC := $(FLASK_BUILD_DIR)/xenpolicy-$(XEN_FULLVERSION)
@@ -36,9 +37,6 @@ policy.bin: FORCE
 	$(MAKE) -f $(XEN_ROOT)/tools/flask/policy/Makefile.common -C $(XEN_ROOT)/tools/flask/policy FLASK_BUILD_DIR=$(FLASK_BUILD_DIR)
 	cmp -s $(POLICY_SRC) $@ || cp $(POLICY_SRC) $@
 
-policy.c: policy.bin gen-policy.py
-	$(PYTHON) gen-policy.py < $< > $@
-
 .PHONY: clean
 clean::
 	rm -f $(ALL_H_FILES) *.o $(DEPS_RM) policy.* $(POLICY_SRC)
xen/xsm/flask/flask-policy.S new file +16 -0
new file mode 100644
index 0000000000..e9308aa175
@@ -0,0 +1,16 @@
+#include <asm/asm_defns.h>
+
+        .section .init.rodata, "a", %progbits
+
+/* const unsigned char xsm_flask_init_policy[] __initconst */
+        .global xsm_flask_init_policy
+xsm_flask_init_policy:
+        .incbin "policy.bin"
+.Lend:
+
+        .type xsm_flask_init_policy, %object
+        .size xsm_flask_init_policy, . - xsm_flask_init_policy
+
+/* const unsigned int __initconst xsm_flask_init_policy_size */
+ 	.global xsm_flask_init_policy_size
+        ASM_INT(xsm_flask_init_policy_size, .Lend - xsm_flask_init_policy)
xen/xsm/flask/gen-policy.py deleted +0 -23
deleted file mode 100644
index c7501e4614..0000000000
@@ -1,23 +0,0 @@
-#!/usr/bin/env python
-import sys
-
-policy_size = 0
-
-sys.stdout.write("""
-/* This file is autogenerated by gen_policy.py */
-#include <xen/init.h>
-#include <xsm/xsm.h>
-
-const unsigned char xsm_flask_init_policy[] __initconst = {
-""")
-
-for char in sys.stdin.read():
-    sys.stdout.write(" 0x%02x," % ord(char))
-    policy_size = policy_size + 1
-    if policy_size % 13 == 0:
-        sys.stdout.write("\n")
-
-sys.stdout.write("""
-};
-const unsigned int __initconst xsm_flask_init_policy_size = %d;
-""" % policy_size)
Signature · 7 lines
2.11.0


_______________________________________________
Xen-devel mailing list
[email protected]
https://lists.xenproject.org/mailman/listinfo/xen-devel
#8 lore raw

Re: [Xen-devel] [PATCH for-4.13 v4 1/3] xen/flask: Drop the gen-policy.py script

Quoted 10 lines · Andrew Cooper

The script is Python 2 specific, and fails with string/binary issues with Python 3:

Traceback (most recent call last):
File "gen-policy.py", line 14, in <module>
for char in sys.stdin.read():
File "/usr/lib/python3.5/codecs.py", line 321, in decode
(result, consumed) = self._buffer_decode(data, self.errors, final)
UnicodeDecodeError: 'utf-8' codec can't decode byte 0x8c in position 0: invalid start byte

Quoted 6 lines

Fixing the script to be compatible isn't hard, but using python here is wasteful. Drop the script entirely, and write an equivelent flask-policy.S instead. This removes the need for a $(PYTHON) and $(CC) pass.

Juergen

_______________________________________________
Xen-devel mailing list
[email protected]
https://lists.xenproject.org/mailman/listinfo/xen-devel

Reviewed-by on v4 1/3
#9 lore raw

Re: [Xen-devel] [PATCH for-4.13 v4 1/3] xen/flask: Drop the gen-policy.py script

In reply to Andrew Cooper
Quoted 10 lines · Andrew Cooper

The script is Python 2 specific, and fails with string/binary issues with Python 3:

Traceback (most recent call last):
File "gen-policy.py", line 14, in <module>
for char in sys.stdin.read():
File "/usr/lib/python3.5/codecs.py", line 321, in decode
(result, consumed) = self._buffer_decode(data, self.errors, final)
UnicodeDecodeError: 'utf-8' codec can't decode byte 0x8c in position 0: invalid start byte

Quoted 6 lines

Fixing the script to be compatible isn't hard, but using python here is wasteful. Drop the script entirely, and write an equivelent flask-policy.S instead. This removes the need for a $(PYTHON) and $(CC) pass.

_______________________________________________
Xen-devel mailing list
[email protected]
https://lists.xenproject.org/mailman/listinfo/xen-devel

Acked-by on v4 1/3
#10 lore raw

Re: [Xen-devel] [PATCH for-4.13 v4 1/3] xen/flask: Drop the gen-policy.py script

In reply to Andrew Cooper

Hi,

Quoted 26 lines · Andrew Cooper

The script is Python 2 specific, and fails with string/binary issues with Python 3:

Traceback (most recent call last):
File "gen-policy.py", line 14, in <module>
for char in sys.stdin.read():
File "/usr/lib/python3.5/codecs.py", line 321, in decode
(result, consumed) = self._buffer_decode(data, self.errors, final)
UnicodeDecodeError: 'utf-8' codec can't decode byte 0x8c in position 0: invalid start byte

Fixing the script to be compatible isn't hard, but using python here is wasteful. Drop the script entirely, and write an equivelent flask-policy.S instead. This removes the need for a $(PYTHON) and $(CC) pass.

---
CC: Daniel De Graaf <[email protected]>
CC: Juergen Gross <[email protected]>
CC: Jan Beulich <[email protected]>
CC: Wei Liu <[email protected]>
CC: Roger Pau Monné <[email protected]>
CC: Stefano Stabellini <[email protected]>
CC: Julien Grall <[email protected]>
CC: Volodymyr Babchuk <[email protected]>

Quoted 4 lines

v2:
* Fix tabs vs spaces issues
v3:
* Use % rather than @ for progbits/object, for Arm32 build.

How to make developper life more exciting...

Cheers,

Signature · 6 lines
Julien Grall

_______________________________________________
Xen-devel mailing list
[email protected]
https://lists.xenproject.org/mailman/listinfo/xen-devel
#11 lore raw

PATCH v3 2/3 xen/banner: Drop the fig-to-oct.py script

In reply to Andrew Cooper

The script is 664 rather than 775, so the banner conversion doesn't actually work if $(PYTHON) is empty:

/bin/sh: tools/fig-to-oct.py: Permission denied
make[3]: *** [include/xen/compile.h] Error 126
make[3]: Leaving directory `/builds/xen-project/people/andyhhp/xen/xen'

Fixing this is easy, but using python here is wasteful. compile.h doesn't need XEN_BANNER rendering in octal, and text is much more simple to handle. Replace fig-to-oct.py with a smaller sed script. This could be a shell one-liner, but it is much more simple to comment sensibly, and doesn't need to include the added cognative load of makefile and shell escaping.

While changing this logic, take the opportunity to optimise the banner space (and time on the serial port) by dropping trailing whitespace, which is 84 characters for current staging.

---
CC: George Dunlap <[email protected]>
CC: Ian Jackson <[email protected]>
CC: Jan Beulich <[email protected]>
CC: Konrad Rzeszutek Wilk <[email protected]>
CC: Stefano Stabellini <[email protected]>
CC: Wei Liu <[email protected]>
CC: Julien Grall <[email protected]>
CC: Juergen Gross <[email protected]>

v2:
* New
v3:
* Fix error: backslash-newline at end of file [-Werror]
* Implement as a sed script.

This (v3) is how happy in the CI:
https://gitlab.com/xen-project/people/andyhhp/xen/pipelines/101409945

Spotted by Gitlab CI, caused by which not being present in some of the CentOS containers. While this is more of a container bug than anything else, it does highlight that the build ought to cope.

---
 xen/Makefile                 |  2 +-
 xen/tools/fig-to-oct.py      | 18 ------------------
 xen/tools/process-banner.sed | 14 ++++++++++++++
 3 files changed, 15 insertions(+), 19 deletions(-)
 delete mode 100644 xen/tools/fig-to-oct.py
 create mode 100755 xen/tools/process-banner.sed
xen/Makefile +1 -1
index 99701e3165..949ca6eb03 100644
@@ -176,7 +176,7 @@ include/xen/compile.h: include/xen/compile.h.in .banner
 	    -e 's!@@changeset@@!$(shell tools/scmversion $(XEN_ROOT) || echo "unavailable")!g' \
 	    < include/xen/compile.h.in > [email protected]
 	@cat .banner
-	@$(PYTHON) tools/fig-to-oct.py < .banner >> [email protected]
+	@sed -rf tools/process-banner.sed < .banner >> [email protected]
 	@mv -f [email protected] $@
 
 include/asm-$(TARGET_ARCH)/asm-offsets.h: arch/$(TARGET_ARCH)/asm-offsets.s
xen/tools/fig-to-oct.py deleted +0 -18
deleted file mode 100644
index db4fd32159..0000000000
@@ -1,18 +0,0 @@
-#!/usr/bin/env python
-import sys
-
-chars_per_line = 18
-chars_so_far = 0
-
-sys.stdout.write('"')
-
-for char in sys.stdin.read():
-
-    sys.stdout.write("\\%03o" % ord(char))
-    chars_so_far = chars_so_far + 1
-
-    if chars_so_far == chars_per_line:
-        chars_so_far = 0
-        sys.stdout.write('" \\\n"')
-
-sys.stdout.write('"\n')
xen/tools/process-banner.sed new file +14 -0
new file mode 100755
index 0000000000..56c76558bc
@@ -0,0 +1,14 @@
+#!/bin/sed -rf
+# Process a text input, to turn it into a C string for the XEN_BANNER macro.
+
+# Strip trailing whitespace.
+s_ *$__
+
+# Escape backslashes.
+s_\\_\\\\_g
+
+# Enclose the line in "...\n".
+s_(.*)_"\1\\n"_
+
+# Trailing \ on all but the final line.
+$!s_$_ \\_
Signature · 7 lines
2.11.0


_______________________________________________
Xen-devel mailing list
[email protected]
https://lists.xenproject.org/mailman/listinfo/xen-devel
Acked-by on v3 2/3
#12 lore raw

Re: [Xen-devel] [PATCH v3 2/3] xen/banner: Drop the fig-to-oct.py script

Quoted 13 lines · Andrew Cooper

The script is 664 rather than 775, so the banner conversion doesn't actually work if $(PYTHON) is empty:

/bin/sh: tools/fig-to-oct.py: Permission denied
make[3]: *** [include/xen/compile.h] Error 126
make[3]: Leaving directory `/builds/xen-project/people/andyhhp/xen/xen'

Fixing this is easy, but using python here is wasteful. compile.h doesn't need XEN_BANNER rendering in octal, and text is much more simple to handle. Replace fig-to-oct.py with a smaller sed script. This could be a shell one-liner, but it is much more simple to comment sensibly, and doesn't need to include the added cognative load of makefile and shell escaping.

Quoted 5 lines

While changing this logic, take the opportunity to optimise the banner space (and time on the serial port) by dropping trailing whitespace, which is 84 characters for current staging.

It's more work than I would have put into it. :-) But since it's already done:

_______________________________________________
Xen-devel mailing list
[email protected]
https://lists.xenproject.org/mailman/listinfo/xen-devel

#13 lore raw

PATCH v3 3/3 xen/build: Automatically locate a suitable python interpreter

In reply to Andrew Cooper

Needing to pass PYTHON=python3 into hypervisor builds is irritating and unnecessary. Locate a suitable interpreter automatically, defaulting to Py3 if it is available.

---
CC: George Dunlap <[email protected]>
CC: Ian Jackson <[email protected]>
CC: Jan Beulich <[email protected]>
CC: Konrad Rzeszutek Wilk <[email protected]>
CC: Stefano Stabellini <[email protected]>
CC: Wei Liu <[email protected]>
CC: Julien Grall <[email protected]>
CC: Steven Haigh <[email protected]>
CC: Juergen Gross <[email protected]>

v2:
* Cope with which not being present in the system.
* Only evaulate the shell command one, rather than once per $(PTHON) usage

For 4.13. This is a very-nice-to-have WRT our Py3-clean intention.

---
 xen/Makefile | 5 +++++
 1 file changed, 5 insertions(+)
xen/Makefile +5 -0
index 949ca6eb03..f36a5bc6c0 100644
@@ -13,6 +13,11 @@ export XEN_BUILD_TIME	?= $(shell LC_ALL=C date +%T)
 export XEN_BUILD_HOST	?= $(shell hostname)
 export XEN_CONFIG_EXPERT ?= n
 
+# Best effort attempt to find a python interpreter, defaulting to Python 3 if
+# available.  Fall back to just `python` if `which` is nowhere to be found.
+PYTHON_INTERPRETER	:= $(word 1,$(shell which python3 python python2 2>/dev/null) python)
+export PYTHON		?= $(PYTHON_INTERPRETER)
+
 export BASEDIR := $(CURDIR)
 export XEN_ROOT := $(BASEDIR)/..
 
Signature · 7 lines
2.11.0


_______________________________________________
Xen-devel mailing list
[email protected]
https://lists.xenproject.org/mailman/listinfo/xen-devel
Acked-by on v3 3/3
#14 lore raw

Re: [Xen-devel] [PATCH v3 3/3] xen/build: Automatically locate a suitable python interpreter

Quoted 31 lines · Andrew Cooper

Needing to pass PYTHON=python3 into hypervisor builds is irritating and unnecessary. Locate a suitable interpreter automatically, defaulting to Py3 if it is available.

---
CC: George Dunlap <[email protected]>
CC: Ian Jackson <[email protected]>
CC: Jan Beulich <[email protected]>
CC: Konrad Rzeszutek Wilk <[email protected]>
CC: Stefano Stabellini <[email protected]>
CC: Wei Liu <[email protected]>
CC: Julien Grall <[email protected]>
CC: Steven Haigh <[email protected]>
CC: Juergen Gross <[email protected]>

v2:
* Cope with which not being present in the system.
* Only evaulate the shell command one, rather than once per $(PTHON) usage

For 4.13. This is a very-nice-to-have WRT our Py3-clean intention.

---
 xen/Makefile | 5 +++++
 1 file changed, 5 insertions(+)
xen/Makefile +0 -0
index 949ca6eb03..f36a5bc6c0 100644

xen/Makefile export XEN_BUILD_TIME ?= $(shell LC_ALL=C date +%T) · line 19

Quoted 7 lines
xen/Makefile +4 -0
@@ -13,6 +13,11 @@ export XEN_BUILD_TIME	?= $(shell LC_ALL=C date +%T)
 export XEN_BUILD_HOST	?= $(shell hostname)
 export XEN_CONFIG_EXPERT ?= n
 
+# Best effort attempt to find a python interpreter, defaulting to Python 3 if
+# available.  Fall back to just `python` if `which` is nowhere to be found.
+PYTHON_INTERPRETER	:= $(word 1,$(shell which python3 python python2 2>/dev/null) python)
+export PYTHON		?= $(PYTHON_INTERPRETER)

_______________________________________________
Xen-devel mailing list
[email protected]
https://lists.xenproject.org/mailman/listinfo/xen-devel

#15 lore raw

Re: [Xen-devel] [PATCH v3 3/3] xen/build: Automatically locate a suitable python interpreter

In reply to Andrew Cooper
Quoted 6 lines · Andrew Cooper

Needing to pass PYTHON=python3 into hypervisor builds is irritating and unnecessary. Locate a suitable interpreter automatically, defaulting to Py3 if it is available.

Juergen

_______________________________________________
Xen-devel mailing list
[email protected]
https://lists.xenproject.org/mailman/listinfo/xen-devel