From 8d87c66b481c7d447270be7238ad3c10e7ebc5e7 Mon Sep 17 00:00:00 2001 From: Garrett D'Amore Date: Thu, 12 Nov 2020 21:00:51 -0800 Subject: Base64 nits (code quality) fixed. This also contains the start of some CMakefile refactoring and clean ups. --- src/CMakeLists.txt | 28 +----------------- src/platform/windows/CMakeLists.txt | 34 +++++++++++++++++++++ src/supplemental/base64/CMakeLists.txt | 16 +++++----- src/supplemental/base64/base64.c | 54 +++++++++++++++++----------------- src/supplemental/base64/base64.h | 10 ++++--- src/supplemental/base64/base64_test.c | 28 ++++++++++-------- 6 files changed, 90 insertions(+), 80 deletions(-) create mode 100644 src/platform/windows/CMakeLists.txt diff --git a/src/CMakeLists.txt b/src/CMakeLists.txt index 3f5f148c..568ea7d0 100644 --- a/src/CMakeLists.txt +++ b/src/CMakeLists.txt @@ -148,33 +148,7 @@ if (NNG_PLATFORM_POSIX) endif () endif () -if (NNG_PLATFORM_WINDOWS) - set(NNG_SRCS ${NNG_SRCS} - platform/windows/win_impl.h - platform/windows/win_ipc.h - platform/windows/win_tcp.h - - platform/windows/win_clock.c - platform/windows/win_debug.c - platform/windows/win_file.c - platform/windows/win_io.c - platform/windows/win_ipcconn.c - platform/windows/win_ipcdial.c - platform/windows/win_ipclisten.c - platform/windows/win_pipe.c - platform/windows/win_rand.c - platform/windows/win_resolv.c - platform/windows/win_sockaddr.c - platform/windows/win_tcp.c - platform/windows/win_tcpconn.c - platform/windows/win_tcpdial.c - platform/windows/win_tcplisten.c - platform/windows/win_thread.c - platform/windows/win_udp.c - ) -endif () - - +add_subdirectory(platform/windows) add_subdirectory(compat/nanomsg) add_subdirectory(protocol/bus0) diff --git a/src/platform/windows/CMakeLists.txt b/src/platform/windows/CMakeLists.txt new file mode 100644 index 00000000..251011cf --- /dev/null +++ b/src/platform/windows/CMakeLists.txt @@ -0,0 +1,34 @@ +# +# Copyright 2020 Staysail Systems, Inc. +# +# This software is supplied under the terms of the MIT License, a +# copy of which should be located in the distribution where this +# file was obtained (LICENSE.txt). A copy of the license may also be +# found online at https://opensource.org/licenses/MIT. +# + +# Windows. + +nng_sources_if(NNG_PLATFORM_WINDOWS + win_impl.h + win_ipc.h + win_tcp.h + + win_clock.c + win_debug.c + win_file.c + win_io.c + win_ipcconn.c + win_ipcdial.c + win_ipclisten.c + win_pipe.c + win_rand.c + win_resolv.c + win_sockaddr.c + win_tcp.c + win_tcpconn.c + win_tcpdial.c + win_tcplisten.c + win_thread.c + win_udp.c + ) diff --git a/src/supplemental/base64/CMakeLists.txt b/src/supplemental/base64/CMakeLists.txt index b4c92e6a..653ea711 100644 --- a/src/supplemental/base64/CMakeLists.txt +++ b/src/supplemental/base64/CMakeLists.txt @@ -1,6 +1,5 @@ # -# Copyright 2017 Capitar IT Group BV -# Copyright 2018 Staysail Systems, Inc. +# Copyright 2020 Staysail Systems, Inc. # # This software is supplied under the terms of the MIT License, a # copy of which should be located in the distribution where this @@ -8,10 +7,9 @@ # found online at https://opensource.org/licenses/MIT. # -if (NNG_SUPP_BASE64) - set(_SRCS - supplemental/base64/base64.c - supplemental/base64/base64.h) - nng_test(base64_test) - set(NNG_SRCS ${NNG_SRCS} ${_SRCS} PARENT_SCOPE) -endif() +nng_sources_if(NNG_SUPP_BASE64 + base64.c + base64.h) + +nng_test_if(NNG_SUPP_BASE64 + base64_test) diff --git a/src/supplemental/base64/base64.c b/src/supplemental/base64/base64.c index 3f6d51b5..3c19ad8a 100644 --- a/src/supplemental/base64/base64.c +++ b/src/supplemental/base64/base64.c @@ -1,6 +1,6 @@ // // Copyright (c) 2014 Wirebird Labs LLC. All rights reserved. -// Copyright 2017 Staysail Systems, Inc. +// Copyright 2020 Staysail Systems, Inc. // // Permission is hereby granted, free of charge, to any person obtaining a copy // of this software and associated documentation files (the "Software"), @@ -25,30 +25,30 @@ #include -int +size_t nni_base64_decode(const char *in, size_t in_len, uint8_t *out, size_t out_len) { unsigned ii; - unsigned io; unsigned rem; uint32_t v; uint8_t ch; + size_t io; // Unrolled lookup of ASCII code points. // 0xFF represents a non-base64 valid character. - const uint8_t DECODEMAP[256] = { 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, + const uint8_t decode[256] = { 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, - 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0x3E, 0xFF, 0xFF, - 0xFF, 0x3F, 0x34, 0x35, 0x36, 0x37, 0x38, 0x39, 0x3A, 0x3B, - 0x3C, 0x3D, 0xFF, 0xFF, 0xFF, 0x3E, 0xFF, 0xFF, 0xFF, 0x00, - 0x01, 0x02, 0x03, 0x04, 0x05, 0x06, 0x07, 0x08, 0x09, 0x0A, - 0x0B, 0x0C, 0x0D, 0x0E, 0x0F, 0x10, 0x11, 0x12, 0x13, 0x14, - 0x15, 0x16, 0x17, 0x18, 0x19, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, - 0xFF, 0x1A, 0x1B, 0x1C, 0x1D, 0x1E, 0x1F, 0x20, 0x21, 0x22, - 0x23, 0x24, 0x25, 0x26, 0x27, 0x28, 0x29, 0x2A, 0x2B, 0x2C, - 0x2D, 0x2E, 0x2F, 0x30, 0x31, 0x32, 0x33, 0xFF, 0xFF, 0xFF, + 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0x3E, 0xFF, 0xFF, 0xFF, + 0x3F, 0x34, 0x35, 0x36, 0x37, 0x38, 0x39, 0x3A, 0x3B, 0x3C, + 0x3D, 0xFF, 0xFF, 0xFF, 0x3E, 0xFF, 0xFF, 0xFF, 0x00, 0x01, + 0x02, 0x03, 0x04, 0x05, 0x06, 0x07, 0x08, 0x09, 0x0A, 0x0B, + 0x0C, 0x0D, 0x0E, 0x0F, 0x10, 0x11, 0x12, 0x13, 0x14, 0x15, + 0x16, 0x17, 0x18, 0x19, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, + 0x1A, 0x1B, 0x1C, 0x1D, 0x1E, 0x1F, 0x20, 0x21, 0x22, 0x23, + 0x24, 0x25, 0x26, 0x27, 0x28, 0x29, 0x2A, 0x2B, 0x2C, 0x2D, + 0x2E, 0x2F, 0x30, 0x31, 0x32, 0x33, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, @@ -61,7 +61,7 @@ nni_base64_decode(const char *in, size_t in_len, uint8_t *out, size_t out_len) 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, - 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF }; + 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF }; for (io = 0, ii = 0, v = 0, rem = 0; ii < in_len; ii++) { if (isspace(in[ii])) { @@ -72,53 +72,53 @@ nni_base64_decode(const char *in, size_t in_len, uint8_t *out, size_t out_len) break; } - ch = DECODEMAP[(int) (in[ii])]; + ch = decode[(int) (in[ii])]; // Discard invalid characters as per RFC 2045. if (ch == 0xFF) { break; } - v = (v << 6) | ch; + v = (v << 6u) | ch; rem += 6; if (rem >= 8) { rem -= 8; if (io >= out_len) return (-1); - out[io++] = (v >> rem) & 255; + out[io++] = (v >> rem) & 255u; } } if (rem >= 8) { rem -= 8; if (io >= out_len) return (-1); - out[io++] = (v >> rem) & 255; + out[io++] = (v >> rem) & 255u; } return (io); } -int +size_t nni_base64_encode(const uint8_t *in, size_t in_len, char *out, size_t out_len) { unsigned ii; - unsigned io; unsigned rem; uint32_t v; + size_t io; - const uint8_t ENCODEMAP[65] = "ABCDEFGHIJKLMNOPQRSTUVWXYZ" - "abcdefghijklmnopqrstuvwxyz" - "0123456789+/"; + const uint8_t encode[65] = "ABCDEFGHIJKLMNOPQRSTUVWXYZ" + "abcdefghijklmnopqrstuvwxyz" + "0123456789+/"; for (io = 0, ii = 0, v = 0, rem = 0; ii < in_len; ii++) { uint8_t ch = in[ii]; - v = (v << 8) | ch; + v = (v << 8u) | ch; rem += 8; while (rem >= 6) { rem -= 6; if (io >= out_len) return (-1); - out[io++] = ENCODEMAP[(v >> rem) & 63]; + out[io++] = encode[(v >> rem) & 63u]; } } @@ -126,11 +126,11 @@ nni_base64_encode(const uint8_t *in, size_t in_len, char *out, size_t out_len) v <<= (6 - rem); if (io >= out_len) return (-1); - out[io++] = ENCODEMAP[v & 63]; + out[io++] = encode[v & 63u]; } // Pad to a multiple of 3. - while (io & 3) { + while (io & 3u) { if (io >= out_len) return (-1); out[io++] = '='; diff --git a/src/supplemental/base64/base64.h b/src/supplemental/base64/base64.h index 68346435..97ca8968 100644 --- a/src/supplemental/base64/base64.h +++ b/src/supplemental/base64/base64.h @@ -1,6 +1,6 @@ // // Copyright (c) 2014 Wirebird Labs LLC. All rights reserved. -// Copyright 2017 Staysail Systems, Inc. +// Copyright 2020 Staysail Systems, Inc. // // Permission is hereby granted, free of charge, to any person obtaining a copy // of this software and associated documentation files (the "Software"), @@ -31,10 +31,12 @@ // Base64 is defined in RFC 2045, section 6.8. // This function encodes an arbitrary byte array into base64 -// null-terminated string. -int nni_base64_encode(const uint8_t *, size_t, char *, size_t); +// null-terminated string. It returns the number of characters +// emitted. +size_t nni_base64_encode(const uint8_t *, size_t, char *, size_t); // This function decodes a base64 string into supplied buffer. -int nni_base64_decode(const char *, size_t, uint8_t *, size_t); +// It returns the number of bytes emitted. +size_t nni_base64_decode(const char *, size_t, uint8_t *, size_t); #endif diff --git a/src/supplemental/base64/base64_test.c b/src/supplemental/base64/base64_test.c index 2c79a243..44609c3e 100644 --- a/src/supplemental/base64/base64_test.c +++ b/src/supplemental/base64/base64_test.c @@ -60,17 +60,17 @@ test_decode(void) void *enc; for (i = 0; (enc = cases[i].encoded) != NULL; i++) { - char buf[1024]; - char name[8]; - int rv; + char buf[1024]; + char name[8]; + size_t sz; (void) snprintf(name, sizeof(name), "%d", i); TEST_CASE(name); - rv = nni_base64_decode(enc, strlen(enc), (void *) buf, 1024); - TEST_CHECK(rv >= 0); - TEST_CHECK(rv == (int) strlen(cases[i].decoded)); - buf[rv] = 0; + sz = nni_base64_decode(enc, strlen(enc), (void *) buf, 1024); + TEST_CHECK(sz >= 0); + TEST_CHECK(sz == strlen(cases[i].decoded)); + buf[sz] = 0; TEST_CHECK(strcmp(buf, cases[i].decoded) == 0); } } @@ -88,13 +88,15 @@ test_overflow(void) (void) snprintf(name, sizeof(name), "%d", i); TEST_CASE(name); - TEST_CHECK(nni_base64_encode( - dec, strlen(dec), buf, strlen(enc) - 1) == -1); - TEST_CHECK(nni_base64_encode(dec, strlen(dec), buf, 0) == -1); + TEST_CHECK(nni_base64_encode(dec, strlen(dec), buf, + strlen(enc) - 1) == (size_t) -1); + TEST_CHECK(nni_base64_encode(dec, strlen(dec), buf, 0) == + (size_t) -1); - TEST_CHECK(nni_base64_decode( - enc, strlen(enc), buf, strlen(dec) - 1) == -1); - TEST_CHECK(nni_base64_encode(enc, strlen(enc), buf, 0) == -1); + TEST_CHECK(nni_base64_decode(enc, strlen(enc), buf, + strlen(dec) - 1) == (size_t) -1); + TEST_CHECK(nni_base64_encode(enc, strlen(enc), buf, 0) == + (size_t) -1); } } -- cgit v1.2.3-70-g09d2