]> git.ipfire.org Git - thirdparty/dovecot/core.git/commitdiff
lib: import byte swapping & endian converting functions
authorJosef 'Jeff' Sipek <jeff.sipek@dovecot.fi>
Thu, 8 Jun 2017 10:20:18 +0000 (13:20 +0300)
committerJosef 'Jeff' Sipek <jeff.sipek@dovecot.fi>
Tue, 1 Aug 2017 12:48:59 +0000 (15:48 +0300)
src/lib/Makefile.am
src/lib/byteorder.h [new file with mode: 0644]
src/lib/lib.h
src/lib/test-byteorder.c [new file with mode: 0644]
src/lib/test-lib.c
src/lib/test-lib.h

index ab28400c31f7755bedd9696242843c01210eb580..693d522fc3f6520d708589287e414b54fe9c535d 100644 (file)
@@ -167,6 +167,7 @@ headers = \
        bits.h \
        bsearch-insert-pos.h \
        buffer.h \
+       byteorder.h \
        child-wait.h \
        compat.h \
        connection.h \
@@ -317,6 +318,7 @@ test_lib_SOURCES = \
        test-bits.c \
        test-bsearch-insert-pos.c \
        test-buffer.c \
+       test-byteorder.c \
        test-crc32.c \
        test-data-stack.c \
        test-failures.c \
diff --git a/src/lib/byteorder.h b/src/lib/byteorder.h
new file mode 100644 (file)
index 0000000..ff9986e
--- /dev/null
@@ -0,0 +1,268 @@
+/*
+ * Copyright (c) 2016-2017 Josef 'Jeff' Sipek <jeffpc@josefsipek.net>
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+
+#ifndef BYTEORDER_H
+#define BYTEORDER_H
+
+/*
+ * These prototypes exist to catch bugs in the code generating macros below.
+ */
+/* return byte swapped input */
+static inline uint64_t bswap_64(uint64_t in);
+static inline uint32_t bswap_32(uint32_t in);
+static inline uint16_t bswap_16(uint16_t in);
+static inline uint8_t bswap_8(uint8_t in);
+
+/* load an unaligned cpu native endian number from memory */
+static inline uint64_t cpu64_to_cpu_unaligned(const void *in);
+static inline uint32_t cpu32_to_cpu_unaligned(const void *in);
+static inline uint16_t cpu16_to_cpu_unaligned(const void *in);
+static inline uint8_t cpu8_to_cpu_unaligned(const void *in);
+
+/* load an unaligned big endian number from memory */
+static inline uint64_t be64_to_cpu_unaligned(const void *in);
+static inline uint32_t be32_to_cpu_unaligned(const void *in);
+static inline uint16_t be16_to_cpu_unaligned(const void *in);
+static inline uint8_t be8_to_cpu_unaligned(const void *in);
+
+/* load an unaligned little endian number from memory */
+static inline uint64_t le64_to_cpu_unaligned(const void *in);
+static inline uint32_t le32_to_cpu_unaligned(const void *in);
+static inline uint16_t le16_to_cpu_unaligned(const void *in);
+static inline uint8_t le8_to_cpu_unaligned(const void *in);
+
+/* store into memory a cpu native endian number as a big endian number */
+static inline void cpu64_to_be_unaligned(uint64_t in, void *out);
+static inline void cpu32_to_be_unaligned(uint32_t in, void *out);
+static inline void cpu16_to_be_unaligned(uint16_t in, void *out);
+static inline void cpu8_to_be_unaligned(uint8_t in, void *out);
+
+/* store into memory a cpu native endian number as a little endian number */
+static inline void cpu64_to_le_unaligned(uint64_t in, void *out);
+static inline void cpu32_to_le_unaligned(uint32_t in, void *out);
+static inline void cpu16_to_le_unaligned(uint16_t in, void *out);
+static inline void cpu8_to_le_unaligned(uint8_t in, void *out);
+
+/* convert a big endian input into cpu native endian */
+static inline uint64_t be64_to_cpu(uint64_t in);
+static inline uint32_t be32_to_cpu(uint32_t in);
+static inline uint16_t be16_to_cpu(uint16_t in);
+static inline uint8_t be8_to_cpu(uint8_t in);
+
+/* convert a cpu native endian input into big endian */
+static inline uint64_t cpu64_to_be(uint64_t in);
+static inline uint32_t cpu32_to_be(uint32_t in);
+static inline uint16_t cpu16_to_be(uint16_t in);
+static inline uint8_t cpu8_to_be(uint8_t in);
+
+/* convert a little endian input into cpu native endian */
+static inline uint64_t le64_to_cpu(uint64_t in);
+static inline uint32_t le32_to_cpu(uint32_t in);
+static inline uint16_t le16_to_cpu(uint16_t in);
+static inline uint8_t le8_to_cpu(uint8_t in);
+
+/* convert a cpu native endian input into little endian */
+static inline uint64_t cpu64_to_le(uint64_t in);
+static inline uint32_t cpu32_to_le(uint32_t in);
+static inline uint16_t cpu16_to_le(uint16_t in);
+static inline uint8_t cpu8_to_le(uint8_t in);
+
+/*
+ * byte swapping
+ */
+static inline uint64_t bswap_64(uint64_t in)
+{
+       return ((in & 0xff00000000000000) >> 56) |
+              ((in & 0x00ff000000000000) >> 40) |
+              ((in & 0x0000ff0000000000) >> 24) |
+              ((in & 0x000000ff00000000) >> 8) |
+              ((in & 0x00000000ff000000) << 8) |
+              ((in & 0x0000000000ff0000) << 24) |
+              ((in & 0x000000000000ff00) << 40) |
+              ((in & 0x00000000000000ff) << 56);
+}
+
+static inline uint32_t bswap_32(uint32_t in)
+{
+       return ((in & 0xff000000) >> 24) |
+              ((in & 0x00ff0000) >> 8) |
+              ((in & 0x0000ff00) << 8) |
+              ((in & 0x000000ff) << 24);
+}
+
+static inline uint16_t bswap_16(uint16_t in)
+{
+       return ((in & 0xff00) >> 8) |
+              ((in & 0x00ff) << 8);
+}
+
+static inline uint8_t bswap_8(uint8_t in)
+{
+       return (in & 0xff);
+}
+
+/*
+ * unaligned big-endian integer
+ */
+static inline uint64_t be64_to_cpu_unaligned(const void *in)
+{
+       const uint8_t *p = in;
+
+       return (((uint64_t) p[0] << 56) |
+               ((uint64_t) p[1] << 48) |
+               ((uint64_t) p[2] << 40) |
+               ((uint64_t) p[3] << 32) |
+               ((uint64_t) p[4] << 24) |
+               ((uint64_t) p[5] << 16) |
+               ((uint64_t) p[6] << 8) |
+               ((uint64_t) p[7]));
+}
+
+static inline void cpu64_to_be_unaligned(uint64_t in, void *out)
+{
+       uint8_t *p = out;
+
+       p[0] = (in >> 56) & 0xff;
+       p[1] = (in >> 48) & 0xff;
+       p[2] = (in >> 40) & 0xff;
+       p[3] = (in >> 32) & 0xff;
+       p[4] = (in >> 24) & 0xff;
+       p[5] = (in >> 16) & 0xff;
+       p[6] = (in >> 8) & 0xff;
+       p[7] = in & 0xff;
+}
+
+static inline uint32_t be32_to_cpu_unaligned(const void *in)
+{
+       const uint8_t *p = in;
+
+       return (((uint32_t) p[0] << 24) |
+               ((uint32_t) p[1] << 16) |
+               ((uint32_t) p[2] << 8) |
+               ((uint32_t) p[3]));
+}
+
+static inline void cpu32_to_be_unaligned(uint32_t in, void *out)
+{
+       uint8_t *p = out;
+
+       p[0] = (in >> 24) & 0xff;
+       p[1] = (in >> 16) & 0xff;
+       p[2] = (in >> 8) & 0xff;
+       p[3] = in & 0xff;
+}
+
+static inline uint16_t be16_to_cpu_unaligned(const void *in)
+{
+       const uint8_t *p = in;
+
+       return (((uint16_t) p[0] << 8) |
+               ((uint16_t) p[1]));
+}
+
+static inline void cpu16_to_be_unaligned(uint16_t in, void *out)
+{
+       uint8_t *p = out;
+
+       p[0] = (in >> 8) & 0xff;
+       p[1] = in & 0xff;
+}
+
+static inline uint8_t be8_to_cpu_unaligned(const void *in)
+{
+       return *((const uint8_t *) in);
+}
+
+static inline void cpu8_to_be_unaligned(uint8_t in, void *out)
+{
+       uint8_t *p = out;
+
+       *p = in;
+}
+
+/*
+ * unaligned little-endian & cpu-endian integers
+ */
+#define __GEN(size, bswap)                                             \
+static inline uint##size##_t le##size##_to_cpu_unaligned(const void *in)\
+{                                                                      \
+       uint##size##_t x = be##size##_to_cpu_unaligned(in);             \
+       /* we read a LE int as BE, so we always have to byte swap */    \
+       return bswap_##size(x);                                         \
+}                                                                      \
+static inline void cpu##size##_to_le_unaligned(uint##size##_t in,      \
+                                              void *out)               \
+{                                                                      \
+       /* we'll be writing in BE, so we always have to byte swap */    \
+       cpu##size##_to_be_unaligned(bswap_##size(in), out);             \
+}                                                                      \
+static inline uint##size##_t cpu##size##_to_cpu_unaligned(const void *in)\
+{                                                                      \
+       uint##size##_t x = be##size##_to_cpu_unaligned(in);             \
+       return bswap;                                                   \
+}
+
+#if WORDS_BIGENDIAN
+#define GEN(size)      __GEN(size, x)
+#else
+#define GEN(size)      __GEN(size, bswap_##size(x))
+#endif
+
+GEN(64)
+GEN(32)
+GEN(16)
+GEN(8)
+
+#undef __GEN
+#undef GEN
+
+/*
+ * byte ordering
+ */
+#define ___GEN(from, size, to, bswap)                                  \
+static inline uint##size##_t from##size##_to_##to(uint##size##_t x)    \
+{                                                                      \
+       return bswap;                                                   \
+}
+
+#if WORDS_BIGENDIAN
+#define __GEN(from, size, to, be, le) ___GEN(from, size, to, be)
+#else
+#define __GEN(from, size, to, be, le) ___GEN(from, size, to, le)
+#endif
+
+#define GEN(size)                                                      \
+       __GEN(be,  size, cpu, x, bswap_##size(x))                       \
+       __GEN(cpu, size, be,  x, bswap_##size(x))                       \
+       __GEN(le,  size, cpu, bswap_##size(x), x)                       \
+       __GEN(cpu, size, le,  bswap_##size(x), x)
+
+GEN(64)
+GEN(32)
+GEN(16)
+GEN(8)
+
+#undef ___GEN
+#undef __GEN
+#undef GEN
+
+#endif
index 672ce446ce49d62d321d63a4fc7f4937744d82d2..b672ad576c24c3bd51150b55eda2a88dcc0acf78 100644 (file)
@@ -30,6 +30,7 @@
 #include "data-stack.h"
 #include "mempool.h"
 #include "imem.h"
+#include "byteorder.h"
 #include "rand.h"
 
 typedef struct buffer buffer_t;
diff --git a/src/lib/test-byteorder.c b/src/lib/test-byteorder.c
new file mode 100644 (file)
index 0000000..157493c
--- /dev/null
@@ -0,0 +1,251 @@
+/*
+ * Copyright (c) 2016-2017 Josef 'Jeff' Sipek <jeffpc@josefsipek.net>
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+
+#include "test-lib.h"
+#include "byteorder.h"
+
+struct bswap_run {
+       uint64_t in;
+       uint8_t out8;
+       uint16_t out16;
+       uint32_t out32;
+       uint64_t out64;
+};
+
+static const struct bswap_run runs[] = {
+       {
+               .in     = 0,
+               .out8   = 0,
+               .out16  = 0,
+               .out32  = 0,
+               .out64  = 0,
+       },
+       {
+               .in     = 0xffffffffffffffff,
+               .out8   = 0xff,
+               .out16  = 0xffff,
+               .out32  = 0xffffffff,
+               .out64  = 0xffffffffffffffff,
+       },
+       {
+               .in     = 0x123456789abcdef0,
+               .out8   = 0xf0,
+               .out16  = 0xf0de,
+               .out32  = 0xf0debc9a,
+               .out64  = 0xf0debc9a78563412,
+       },
+       {
+               .in     = 0x8080808080808080,
+               .out8   = 0x80,
+               .out16  = 0x8080,
+               .out32  = 0x80808080,
+               .out64  = 0x8080808080808080,
+       },
+};
+
+#define CHECK(iter, size, in, exp)                                     \
+       do {                                                            \
+               uint##size##_t got = bswap_##size(in);                  \
+                                                                       \
+               test_begin(t_strdup_printf("byteorder - bswap "         \
+                                          "(size:%-2u iter:%u)",       \
+                                          size, iter));                \
+               test_assert(got == exp);                                \
+               test_end();                                             \
+       } while (0)
+
+static void __test(int iter, const struct bswap_run *run)
+{
+       CHECK(iter, 8, run->in & 0xff, run->out8);
+       CHECK(iter, 16, run->in & 0xffff, run->out16);
+       CHECK(iter, 32, run->in & 0xffffffff, run->out32);
+       CHECK(iter, 64, run->in, run->out64);
+}
+
+static void test_bswap(void)
+{
+       unsigned int i;
+
+       for (i = 0; i < N_ELEMENTS(runs) ; i++)
+               __test(i, &runs[i]);
+}
+
+struct unaligned_run {
+       uint8_t in[8];
+
+       /* outputs */
+       uint8_t be8;
+       uint16_t be16;
+       uint32_t be32;
+       uint64_t be64;
+
+       uint8_t le8;
+       uint16_t le16;
+       uint32_t le32;
+       uint64_t le64;
+
+#if WORDS_BIGENDIAN
+#define cpu8 be8
+#define cpu16 be16
+#define cpu32 be32
+#define cpu64 be64
+#else
+#define cpu8 le8
+#define cpu16 le16
+#define cpu32 le32
+#define cpu64 le64
+#endif
+};
+
+static const struct unaligned_run uruns[] = {
+       {
+               .in     = {
+                       0x00, 0x00, 0x00, 0x00,
+                       0x00, 0x00, 0x00, 0x00,
+               },
+               .be8    = 0,
+               .be16   = 0,
+               .be32   = 0,
+               .be64   = 0,
+               .le8    = 0,
+               .le16   = 0,
+               .le32   = 0,
+               .le64   = 0,
+       },
+       {
+               .in     = {
+                       0xff, 0xff, 0xff, 0xff,
+                       0xff, 0xff, 0xff, 0xff,
+               },
+               .be8    = 0xff,
+               .be16   = 0xffff,
+               .be32   = 0xffffffff,
+               .be64   = 0xffffffffffffffff,
+               .le8    = 0xff,
+               .le16   = 0xffff,
+               .le32   = 0xffffffff,
+               .le64   = 0xffffffffffffffff,
+       },
+       {
+               .in     = {
+                       0x12, 0x34, 0x56, 0x78,
+                       0x9a, 0xbc, 0xde, 0xf0,
+               },
+               .be8    = 0x12,
+               .be16   = 0x1234,
+               .be32   = 0x12345678,
+               .be64   = 0x123456789abcdef0,
+               .le8    = 0x12,
+               .le16   = 0x3412,
+               .le32   = 0x78563412,
+               .le64   = 0xf0debc9a78563412,
+       },
+       {
+               .in     = {
+                       0x80, 0x80, 0x80, 0x80,
+                       0x80, 0x80, 0x80, 0x80,
+               },
+               .be8    = 0x80,
+               .be16   = 0x8080,
+               .be32   = 0x80808080,
+               .be64   = 0x8080808080808080,
+               .le8    = 0x80,
+               .le16   = 0x8080,
+               .le32   = 0x80808080,
+               .le64   = 0x8080808080808080,
+       },
+};
+
+#define __CHECK_READ(iter, size, pfx, in, fxn, exp)                    \
+       do {                                                            \
+               uint##size##_t got = fxn(in);                           \
+                                                                       \
+               test_begin(t_strdup_printf("byteorder - unaligned read "\
+                                          "(%-3s size:%-2u iter:%u)",  \
+                                          pfx, size, iter));           \
+               test_assert(got == exp);                                \
+               test_end();                                             \
+       } while (0)
+
+#define CHECK_READ(iter, size, in, be_exp, le_exp, cpu_exp)            \
+       do {                                                            \
+               __CHECK_READ(iter, size, "BE", in,                      \
+                            be##size##_to_cpu_unaligned, be_exp);      \
+               __CHECK_READ(iter, size, "LE", in,                      \
+                            le##size##_to_cpu_unaligned, le_exp);      \
+               __CHECK_READ(iter, size, "CPU", in,                     \
+                            cpu##size##_to_cpu_unaligned, cpu_exp);    \
+       } while (0)
+
+static void __test_read(int iter, const struct unaligned_run *run)
+{
+       CHECK_READ(iter, 8, run->in, run->be8, run->le8, run->cpu8);
+       CHECK_READ(iter, 16, run->in, run->be16, run->le16, run->cpu16);
+       CHECK_READ(iter, 32, run->in, run->be32, run->le32, run->cpu32);
+       CHECK_READ(iter, 64, run->in, run->be64, run->le64, run->cpu64);
+}
+
+#define __CHECK_WRITE(iter, size, pfx, in, fxn, exp)                   \
+       do {                                                            \
+               uint8_t got[size / 8];                                  \
+                                                                       \
+               fxn(in, got);                                           \
+                                                                       \
+               test_begin(t_strdup_printf("byteorder - unaligned write "\
+                                          "(%-3s size:%-2u iter:%u)",  \
+                                          pfx, size, iter));           \
+               test_assert(memcmp(got, exp, sizeof(got)) == 0);        \
+               test_end();                                             \
+       } while (0)
+
+#define CHECK_WRITE(iter, size, out, be_in, le_in)                     \
+       do {                                                            \
+               __CHECK_WRITE(iter, size, "BE", be_in,                  \
+                             cpu##size##_to_be_unaligned, out);        \
+               __CHECK_WRITE(iter, size, "LE", le_in,                  \
+                             cpu##size##_to_le_unaligned, out);        \
+       } while (0)
+
+static void __test_write(int iter, const struct unaligned_run *run)
+{
+       CHECK_WRITE(iter, 8, run->in, run->be8, run->le8);
+       CHECK_WRITE(iter, 16, run->in, run->be16, run->le16);
+       CHECK_WRITE(iter, 32, run->in, run->be32, run->le32);
+       CHECK_WRITE(iter, 64, run->in, run->be64, run->le64);
+}
+
+static void test_unaligned(void)
+{
+       unsigned int i;
+
+       for (i = 0; i < N_ELEMENTS(uruns) ; i++)
+               __test_read(i, &uruns[i]);
+
+       for (i = 0; i < N_ELEMENTS(uruns) ; i++)
+               __test_write(i, &uruns[i]);
+}
+
+void test_byteorder(void)
+{
+       test_bswap();
+       test_unaligned();
+}
index aea8a47a7a9536b21c152b859947b696795f73a4..9a1c44f8fd79b282fa848f86bf3c92a506bfdd33 100644 (file)
@@ -12,6 +12,7 @@ int main(void)
                test_bits,
                test_bsearch_insert_pos,
                test_buffer,
+               test_byteorder,
                test_crc32,
                test_data_stack,
                test_failures,
index 3b96e4bd5851da924409c10cb64bed45743205de..142b2f5359bbcec26a8526a6b2d657e8da3a987d 100644 (file)
@@ -12,6 +12,7 @@ void test_base64(void);
 void test_bits(void);
 void test_bsearch_insert_pos(void);
 void test_buffer(void);
+void test_byteorder(void);
 void test_crc32(void);
 void test_data_stack(void);
 enum fatal_test_state fatal_data_stack(unsigned int);