Skip to contentSkip to conversation

qemu/bswap: Use compiler __builtin_bswap()

PATCH Superseded Philippe Mathieu-Daudé 3 participants 15 messages Sep 23, 2020 – Sep 25, 2020

v1 of 2 Superseded Latest is v2 →

lore
Share & tools
lore
#0 lore raw

cover qemu/bswap: Use compiler __builtin_bswap()

Implement Richard's suggestion to use __builtin_bswap().

const_XX() not updated. We could use le_bswap() definitions but they are undefined, not sure yet what is the best way. Meanwhile I figure this out, these patches are ready for review.

Philippe Mathieu-Daudé (4):
qemu/bswap: Remove unused qemu_bswap_len() qemu/bswap: Replace bswapXX() by compiler __builtin_bswap() qemu/bswap: Replace bswapXXs() by compiler __builtin_bswap() qemu/bswap: Remove <byteswap.h> dependency

 configure            | 13 ---------
 include/qemu/bswap.h | 69 +++++++++-----------------------------------
 2 files changed, 13 insertions(+), 69 deletions(-)
Signature · 1 line
2.26.2
#1 lore raw

PATCH 1/4 qemu/bswap: Remove unused qemu_bswap_len()

Last use of qemu_bswap_len() has been removed in commit e5fd1eb05ec ("apb: add busA qdev property to PBM PCI bridge").

---
 include/qemu/bswap.h | 6 ------
 1 file changed, 6 deletions(-)
include/qemu/bswap.h +0 -6
index 1d3e4c24e41..8b01c38040c 100644
@@ -169,12 +169,6 @@ CPU_CONVERT(le, 16, uint16_t)
 CPU_CONVERT(le, 32, uint32_t)
 CPU_CONVERT(le, 64, uint64_t)
 
-/* len must be one of 1, 2, 4 */
-static inline uint32_t qemu_bswap_len(uint32_t value, int len)
-{
-    return bswap32(value) >> (32 - 8 * len);
-}
-
 /*
  * Same as cpu_to_le{16,32}, except that gcc will figure the result is
  * a compile-time constant if you pass in a constant.  So this can be
Signature · 1 line
2.26.2
#3 lore raw

PATCH 2/4 qemu/bswap: Replace bswapXX() by compiler __builtin_bswap()

In reply to Philippe Mathieu-Daudé

Use the compiler built-in function to byte swap values, as the compiler is clever and will fold constants.

---
 include/qemu/bswap.h | 30 ++++--------------------------
 1 file changed, 4 insertions(+), 26 deletions(-)
include/qemu/bswap.h +4 -26
index 8b01c38040c..d1a2f700f2a 100644
@@ -27,32 +27,10 @@ static inline uint64_t bswap64(uint64_t x)
 {
     return bswap_64(x);
 }
-# else
-static inline uint16_t bswap16(uint16_t x)
-{
-    return (((x & 0x00ff) << 8) |
-            ((x & 0xff00) >> 8));
-}
-
-static inline uint32_t bswap32(uint32_t x)
-{
-    return (((x & 0x000000ffU) << 24) |
-            ((x & 0x0000ff00U) <<  8) |
-            ((x & 0x00ff0000U) >>  8) |
-            ((x & 0xff000000U) >> 24));
-}
-
-static inline uint64_t bswap64(uint64_t x)
-{
-    return (((x & 0x00000000000000ffULL) << 56) |
-            ((x & 0x000000000000ff00ULL) << 40) |
-            ((x & 0x0000000000ff0000ULL) << 24) |
-            ((x & 0x00000000ff000000ULL) <<  8) |
-            ((x & 0x000000ff00000000ULL) >>  8) |
-            ((x & 0x0000ff0000000000ULL) >> 24) |
-            ((x & 0x00ff000000000000ULL) >> 40) |
-            ((x & 0xff00000000000000ULL) >> 56));
-}
+#else
+# define bswap16(_x) __builtin_bswap16(_x)
+# define bswap32(_x) __builtin_bswap32(_x)
+# define bswap64(_x) __builtin_bswap64(_x)
 #endif /* ! CONFIG_MACHINE_BSWAP_H */
 
 static inline void bswap16s(uint16_t *s)
Signature · 1 line
2.26.2
Reviewed-by on v1 2/4
#4 lore raw

Re: [PATCH 2/4] qemu/bswap: Replace bswapXX() by compiler __builtin_bswap()

Quoted 8 lines · Philippe Mathieu-Daudé

Use the compiler built-in function to byte swap values, as the compiler is clever and will fold constants.

---
 include/qemu/bswap.h | 30 ++++--------------------------
 1 file changed, 4 insertions(+), 26 deletions(-)

r~

#5 lore raw

PATCH 3/4 qemu/bswap: Replace bswapXXs() by compiler __builtin_bswap()

In reply to Philippe Mathieu-Daudé
---
 include/qemu/bswap.h | 16 +++++++++-------
 1 file changed, 9 insertions(+), 7 deletions(-)
include/qemu/bswap.h +9 -7
index d1a2f700f2a..6875e48d617 100644
@@ -35,29 +35,31 @@ static inline uint64_t bswap64(uint64_t x)
 
 static inline void bswap16s(uint16_t *s)
 {
-    *s = bswap16(*s);
+    *s = __builtin_bswap16(*s);
 }
 
 static inline void bswap32s(uint32_t *s)
 {
-    *s = bswap32(*s);
+    *s = __builtin_bswap32(*s);
 }
 
 static inline void bswap64s(uint64_t *s)
 {
-    *s = bswap64(*s);
+    *s = __builtin_bswap64(*s);
 }
 
 #if defined(HOST_WORDS_BIGENDIAN)
 #define be_bswap(v, size) (v)
-#define le_bswap(v, size) glue(bswap, size)(v)
+#define le_bswap(v, size) glue(__builtin_bswap, size)(v)
 #define be_bswaps(v, size)
-#define le_bswaps(p, size) do { *p = glue(bswap, size)(*p); } while(0)
+#define le_bswaps(p, size) \
+            do { *p = glue(__builtin_bswap, size)(*p); } while (0)
 #else
 #define le_bswap(v, size) (v)
-#define be_bswap(v, size) glue(bswap, size)(v)
+#define be_bswap(v, size) glue(__builtin_bswap, size)(v)
 #define le_bswaps(v, size)
-#define be_bswaps(p, size) do { *p = glue(bswap, size)(*p); } while(0)
+#define be_bswaps(p, size) \
+            do { *p = glue(__builtin_bswap, size)(*p); } while (0)
 #endif
 
 /**
Signature · 1 line
2.26.2
#7 lore raw

PATCH 4/4 qemu/bswap: Remove <byteswap.h> dependency

In reply to Philippe Mathieu-Daudé

All our supported compilers provide the __builtin_bswap() functions. Drop the <byteswap.h> dependency.

---
 configure            | 13 -------------
 include/qemu/bswap.h | 17 -----------------
 2 files changed, 30 deletions(-)
configure +0 -13
index e8e8e984f24..bff787daea7 100755
@@ -4886,16 +4886,6 @@ if test "$docs" != "no" ; then
   fi
 fi
 
-# Search for bswap_32 function
-byteswap_h=no
-cat > $TMPC << EOF
-#include <byteswap.h>
-int main(void) { return bswap_32(0); }
-EOF
-if compile_prog "" "" ; then
-  byteswap_h=yes
-fi
-
 # Search for bswap32 function
 bswap_h=no
 cat > $TMPC << EOF
@@ -6789,9 +6779,6 @@ fi
 if test "$st_atim" = "yes" ; then
   echo "HAVE_STRUCT_STAT_ST_ATIM=y" >> $config_host_mak
 fi
-if test "$byteswap_h" = "yes" ; then
-  echo "CONFIG_BYTESWAP_H=y" >> $config_host_mak
-fi
 if test "$bswap_h" = "yes" ; then
   echo "CONFIG_MACHINE_BSWAP_H=y" >> $config_host_mak
 fi
include/qemu/bswap.h +0 -17
index 6875e48d617..c192a6ad3e7 100644
@@ -10,23 +10,6 @@
 # include <sys/endian.h>
 #elif defined(__HAIKU__)
 # include <endian.h>
-#elif defined(CONFIG_BYTESWAP_H)
-# include <byteswap.h>
-
-static inline uint16_t bswap16(uint16_t x)
-{
-    return bswap_16(x);
-}
-
-static inline uint32_t bswap32(uint32_t x)
-{
-    return bswap_32(x);
-}
-
-static inline uint64_t bswap64(uint64_t x)
-{
-    return bswap_64(x);
-}
 #else
 # define bswap16(_x) __builtin_bswap16(_x)
 # define bswap32(_x) __builtin_bswap32(_x)
Signature · 1 line
2.26.2
#8 lore raw

Re: [PATCH 4/4] qemu/bswap: Remove <byteswap.h> dependency

Quoted 24 lines · Philippe Mathieu-Daudé

All our supported compilers provide the __builtin_bswap() functions. Drop the <byteswap.h> dependency.

include/qemu/bswap.h +0 -10
index 6875e48d617..c192a6ad3e7 100644
@@ -10,23 +10,6 @@
 # include <sys/endian.h>
 #elif defined(__HAIKU__)
 # include <endian.h>
-#elif defined(CONFIG_BYTESWAP_H)
-# include <byteswap.h>
-
-static inline uint16_t bswap16(uint16_t x)
-{
-    return bswap_16(x);
-}
-
-static inline uint32_t bswap32(uint32_t x)
-{

include/qemu/bswap.h line 15

Quoted 10 lines
include/qemu/bswap.h +0 -7
-    return bswap_32(x);
-}
-
-static inline uint64_t bswap64(uint64_t x)
-{
-    return bswap_64(x);
-}
 #else
 # define bswap16(_x) __builtin_bswap16(_x)
 # define bswap32(_x) __builtin_bswap32(_x)

I suppose if we wanted to just use the __builtin_bswap* implementation on all hosts (ie drop the special casing of CONFIG_MACHINE_BSWAP_H/FreeBSD/Haiku) we'd need to rename our macros to avoid potential conflicts with the versions in the system headers there in case they were pulled in via some other path ?

thanks
-- PMM

#9 lore raw

Re: [PATCH 4/4] qemu/bswap: Remove <byteswap.h> dependency

Quoted 34 lines · Peter Maydell
Quoted 33 lines · Philippe Mathieu-Daudé

All our supported compilers provide the __builtin_bswap() functions. Drop the <byteswap.h> dependency.

include/qemu/bswap.h +0 -17
index 6875e48d617..c192a6ad3e7 100644
@@ -10,23 +10,6 @@
 # include <sys/endian.h>
 #elif defined(__HAIKU__)
 # include <endian.h>
-#elif defined(CONFIG_BYTESWAP_H)
-# include <byteswap.h>
-
-static inline uint16_t bswap16(uint16_t x)
-{
-    return bswap_16(x);
-}
-
-static inline uint32_t bswap32(uint32_t x)
-{
-    return bswap_32(x);
-}
-
-static inline uint64_t bswap64(uint64_t x)
-{
-    return bswap_64(x);
-}
 #else
 # define bswap16(_x) __builtin_bswap16(_x)
Quoted 8 lines

include/qemu/bswap.h line 15

Quoted 1 line
include/qemu/bswap.h +0 -0
 # define bswap32(_x) __builtin_bswap32(_x)

I suppose if we wanted to just use the __builtin_bswap* implementation on all hosts (ie drop the special casing of CONFIG_MACHINE_BSWAP_H/FreeBSD/Haiku) we'd need to rename our macros to avoid potential conflicts with the versions in the system headers there in case they were pulled in via some other path ?

Yes, this is why I couldn't get ride of everything

After reading Paolo's suggestion to use qatomic*, I am tempted to suggest qbswap* but I am still looking for better alternatives...

Quoted 4 lines

thanks
-- PMM

#10 lore raw

Re: [PATCH 4/4] qemu/bswap: Remove <byteswap.h> dependency

Quoted 8 lines · Philippe Mathieu-Daudé
Quoted 6 lines · Peter Maydell

I suppose if we wanted to just use the __builtin_bswap* implementation on all hosts (ie drop the special casing of CONFIG_MACHINE_BSWAP_H/FreeBSD/Haiku) we'd need to rename our macros to avoid potential conflicts with the versions in the system headers there in case they were pulled in via some other path ?

Quoted 5 lines

Yes, this is why I couldn't get ride of everything

After reading Paolo's suggestion to use qatomic*, I am tempted to suggest qbswap* but I am still looking for better alternatives...

Hum, maybe. It's pretty ugly. We could just leave those alone and hope the system version is decent enough.

r~

#11 lore raw

Re: [PATCH 4/4] qemu/bswap: Remove <byteswap.h> dependency

Quoted 10 lines · Richard Henderson
Quoted 8 lines · Philippe Mathieu-Daudé
Quoted 6 lines · Peter Maydell

I suppose if we wanted to just use the __builtin_bswap* implementation on all hosts (ie drop the special casing of CONFIG_MACHINE_BSWAP_H/FreeBSD/Haiku) we'd need to rename our macros to avoid potential conflicts with the versions in the system headers there in case they were pulled in via some other path ?

Quoted 8 lines
Quoted 5 lines

Yes, this is why I couldn't get ride of everything

After reading Paolo's suggestion to use qatomic*, I am tempted to suggest qbswap* but I am still looking for better alternatives...

Hum, maybe. It's pretty ugly. We could just leave those alone and hope the system version is decent enough.

Mostly what I would like is to be able to be rid of the configure machinery so we could just use a single portable implementation.

thanks
-- PMM

#12 lore raw

Re: [PATCH 4/4] qemu/bswap: Remove <byteswap.h> dependency

Quoted 18 lines · Peter Maydell
Quoted 16 lines · Richard Henderson
Quoted 13 lines · Philippe Mathieu-Daudé
Quoted 6 lines · Peter Maydell

I suppose if we wanted to just use the __builtin_bswap* implementation on all hosts (ie drop the special casing of CONFIG_MACHINE_BSWAP_H/FreeBSD/Haiku) we'd need to rename our macros to avoid potential conflicts with the versions in the system headers there in case they were pulled in via some other path ?

Yes, this is why I couldn't get ride of everything

After reading Paolo's suggestion to use qatomic*, I am tempted to suggest qbswap* but I am still looking for better alternatives...

Quoted 6 lines
Quoted 2 lines

Hum, maybe. It's pretty ugly. We could just leave those alone and hope the system version is decent enough.

Mostly what I would like is to be able to be rid of the configure machinery so we could just use a single portable implementation.

Good news. Using the Haiku image provided by Alexander, GCC is pretty recent and supports builtin atomic:

Quoted 1 line

uname -a

Haiku shredder 1 hrev54154+115 Jun 30 2020 15:20 x86_64 x86_64 Haiku

Quoted 1 line

gcc --version

gcc (2019_05_24) 8.3.0
Copyright (C) 2018 Free Software Foundation, Inc.

The <endian.h> include (/system/develop/headers/posix/endian.h) only defines BYTE_ORDER.

Looking at FreeBSD, bswap*() are defined as macro:
https://github.com/freebsd/freebsd/blob/master/sys/sys/endian.h#L58
So we could eventually undefine them... but the manpage describe them as functions [*]:

DESCRIPTION
The bswap16(), bswap32(), and bswap64() functions return a byte order swapped integer.

So theoretically they could change the prototype still respecting the documentation contract, and undefines wouldn't work anymore.

Would this be acceptable? Any clever idea?

[*] https://www.freebsd.org/cgi/man.cgi?query=bswap32&apropos=0&sektion=9

Quoted 4 lines

thanks
-- PMM

#13 lore raw

Re: [PATCH 4/4] qemu/bswap: Remove <byteswap.h> dependency

Quoted 2 lines · Philippe Mathieu-Daudé

Looking at FreeBSD, bswap*() are defined as macro:
https://github.com/freebsd/freebsd/blob/master/sys/sys/endian.h#L58

That works for me.

Quoted 2 lines

So theoretically they could change the prototype still respecting the documentation contract, and undefines wouldn't work anymore.

But we'd be #defining our own macros that would mean that the out-of-line functions would never be used. So it still works.

r~

Reviewed-by on v1 4/4
#14 lore raw

Re: [PATCH 4/4] qemu/bswap: Remove <byteswap.h> dependency

In reply to Philippe Mathieu-Daudé
Quoted 9 lines · Philippe Mathieu-Daudé

All our supported compilers provide the __builtin_bswap() functions. Drop the <byteswap.h> dependency.

---
 configure            | 13 -------------
 include/qemu/bswap.h | 17 -----------------
 2 files changed, 30 deletions(-)

r~