ivampiresp/Spdk
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
dd2c08d2d1
Spdk/lib/util/base64.c
Jim Harris 488570ebd4 Replace most BSD 3-clause license text with SPDX identifier. 
Many open source projects have moved to using SPDX identifiers
to specify license information, reducing the amount of
boilerplate code in every source file.  This patch replaces
the bulk of SPDK .c, .cpp and Makefiles with the BSD-3-Clause
identifier.

Almost all of these files share the exact same license text,
and this patch only modifies the files that contain the
most common license text.  There can be slight variations
because the third clause contains company names - most say
"Intel Corporation", but there are instances for Nvidia,
Samsung, Eideticom and even "the copyright holder".

Used a bash script to automate replacement of the license text
with SPDX identifier which is checked into scripts/spdx.sh.

Signed-off-by: Jim Harris <james.r.harris@intel.com>
Change-Id: Iaa88ab5e92ea471691dc298cfe41ebfb5d169780
Reviewed-on: https://review.spdk.io/gerrit/c/spdk/spdk/+/12904
Community-CI: Broadcom CI <spdk-ci.pdl@broadcom.com>
Community-CI: Mellanox Build Bot
Tested-by: SPDK CI Jenkins <sys_sgci@intel.com>
Reviewed-by: Aleksey Marchuk <alexeymar@nvidia.com>
Reviewed-by: Changpeng Liu <changpeng.liu@intel.com>
Reviewed-by: Dong Yi <dongx.yi@intel.com>
Reviewed-by: Konrad Sztyber <konrad.sztyber@intel.com>
Reviewed-by: Paul Luse <paul.e.luse@intel.com>
Reviewed-by: <qun.wan@intel.com>
2022-06-09 07:35:12 +00:00

251 lines
7.4 KiB
C
Raw Blame History

/* SPDX-License-Identifier: BSD-3-Clause
* Copyright(c) Intel Corporation. All rights reserved.
* Copyright(c) ARM Limited. 2021 All rights reserved.
* All rights reserved.
*/
#include "spdk/stdinc.h"
#include "spdk/endian.h"
#include "spdk/base64.h"
#ifdef __aarch64__
#ifdef __ARM_FEATURE_SVE
#include "base64_sve.c"
#else
#include "base64_neon.c"
#endif
#endif
#define BASE64_ENC_BITMASK 0x3FUL
#define BASE64_PADDING_CHAR '='
static const char base64_enc_table[] =
"ABCDEFGHIJKLMNOPQRSTUVWXYZ"
"abcdefghijklmnopqrstuvwxyz"
"0123456789+/";
static const char base64_urlsafe_enc_table[] =
"ABCDEFGHIJKLMNOPQRSTUVWXYZ"
"abcdefghijklmnopqrstuvwxyz"
"0123456789-_";
static const uint8_t
base64_dec_table[] = {
255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255,
255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255,
255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 62, 255, 255, 255, 63,
52, 53, 54, 55, 56, 57, 58, 59, 60, 61, 255, 255, 255, 255, 255, 255,
255, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14,
15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 255, 255, 255, 255, 255,
255, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40,
41, 42, 43, 44, 45, 46, 47, 48, 49, 50, 51, 255, 255, 255, 255, 255,
255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255,
255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255,
255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255,
255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255,
255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255,
255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255,
255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255,
255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255,
};
static const uint8_t
base64_urlsafe_dec_table[] = {
255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255,
255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255,
255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 62, 255, 255,
52, 53, 54, 55, 56, 57, 58, 59, 60, 61, 255, 255, 255, 255, 255, 255,
255, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14,
15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 255, 255, 255, 255, 63,
255, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40,
41, 42, 43, 44, 45, 46, 47, 48, 49, 50, 51, 255, 255, 255, 255, 255,
255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255,
255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255,
255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255,
255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255,
255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255,
255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255,
255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255,
255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255,
};
static int
base64_encode(char *dst, const char *enc_table, const void *src, size_t src_len)
{
uint32_t raw_u32;
if (!dst || !src || src_len <= 0) {
return -EINVAL;
}
#ifdef __aarch64__
#ifdef __ARM_FEATURE_SVE
base64_encode_sve(&dst, enc_table, &src, &src_len);
#else
base64_encode_neon64(&dst, enc_table, &src, &src_len);
#endif
#endif
while (src_len >= 4) {
raw_u32 = from_be32(src);
*dst++ = enc_table[(raw_u32 >> 26) & BASE64_ENC_BITMASK];
*dst++ = enc_table[(raw_u32 >> 20) & BASE64_ENC_BITMASK];
*dst++ = enc_table[(raw_u32 >> 14) & BASE64_ENC_BITMASK];
*dst++ = enc_table[(raw_u32 >> 8) & BASE64_ENC_BITMASK];
src_len -= 3;
src += 3;
}
if (src_len == 0) {
goto out;
}
raw_u32 = 0;
memcpy(&raw_u32, src, src_len);
raw_u32 = from_be32(&raw_u32);
*dst++ = enc_table[(raw_u32 >> 26) & BASE64_ENC_BITMASK];
*dst++ = enc_table[(raw_u32 >> 20) & BASE64_ENC_BITMASK];
*dst++ = (src_len >= 2) ? enc_table[(raw_u32 >> 14) & BASE64_ENC_BITMASK] : BASE64_PADDING_CHAR;
*dst++ = (src_len == 3) ? enc_table[(raw_u32 >> 8) & BASE64_ENC_BITMASK] : BASE64_PADDING_CHAR;
out:
*dst = '\0';
return 0;
}
int
spdk_base64_encode(char *dst, const void *src, size_t src_len)
{
return base64_encode(dst, base64_enc_table, src, src_len);
}
int
spdk_base64_urlsafe_encode(char *dst, const void *src, size_t src_len)
{
return base64_encode(dst, base64_urlsafe_enc_table, src, src_len);
}
#if defined(__aarch64__) && !defined(__ARM_FEATURE_SVE)
static int
base64_decode(void *dst, size_t *_dst_len, const uint8_t *dec_table,
const uint8_t *dec_table_opt, const char *src)
#else
static int
base64_decode(void *dst, size_t *_dst_len, const uint8_t *dec_table, const char *src)
#endif
{
size_t src_strlen;
size_t tail_len = 0;
const uint8_t *src_in;
uint32_t tmp[4];
int i;
if (!src) {
return -EINVAL;
}
src_strlen = strlen(src);
/* strlen of src should be 4n */
if (src_strlen == 0 || src_strlen % 4 != 0) {
return -EINVAL;
}
/* Consider Base64 padding, it at most has 2 padding characters. */
for (i = 0; i < 2; i++) {
if (src[src_strlen - 1] != BASE64_PADDING_CHAR) {
break;
}
src_strlen--;
}
/* strlen of src without padding shouldn't be 4n+1 */
if (src_strlen == 0 || src_strlen % 4 == 1) {
return -EINVAL;
}
if (_dst_len) {
*_dst_len = spdk_base64_get_decoded_len(src_strlen);
}
/* If dst is NULL, the client is only concerned w/ _dst_len, return */
if (!dst) {
return 0;
}
src_in = (const uint8_t *) src;
#ifdef __aarch64__
#ifdef __ARM_FEATURE_SVE
base64_decode_sve(&dst, dec_table, &src_in, &src_strlen);
#else
base64_decode_neon64(&dst, dec_table_opt, &src_in, &src_strlen);
#endif
if (src_strlen == 0) {
return 0;
}
#endif
/* space of dst can be used by to_be32 */
while (src_strlen > 4) {
tmp[0] = dec_table[*src_in++];
tmp[1] = dec_table[*src_in++];
tmp[2] = dec_table[*src_in++];
tmp[3] = dec_table[*src_in++];
if (tmp[0] == 255 || tmp[1] == 255 || tmp[2] == 255 || tmp[3] == 255) {
return -EINVAL;
}
to_be32(dst, tmp[3] << 8 | tmp[2] << 14 | tmp[1] << 20 | tmp[0] << 26);
dst += 3;
src_strlen -= 4;
}
/* space of dst is not enough to be used by to_be32 */
tmp[0] = dec_table[src_in[0]];
tmp[1] = dec_table[src_in[1]];
tmp[2] = (src_strlen >= 3) ? dec_table[src_in[2]] : 0;
tmp[3] = (src_strlen == 4) ? dec_table[src_in[3]] : 0;
tail_len = src_strlen - 1;
if (tmp[0] == 255 || tmp[1] == 255 || tmp[2] == 255 || tmp[3] == 255) {
return -EINVAL;
}
to_be32(&tmp[3], tmp[3] << 8 | tmp[2] << 14 | tmp[1] << 20 | tmp[0] << 26);
memcpy(dst, (uint8_t *)&tmp[3], tail_len);
return 0;
}
int
spdk_base64_decode(void *dst, size_t *dst_len, const char *src)
{
#if defined(__aarch64__) && !defined(__ARM_FEATURE_SVE)
return base64_decode(dst, dst_len, base64_dec_table, base64_dec_table_neon64, src);
#else
return base64_decode(dst, dst_len, base64_dec_table, src);
#endif
}
int
spdk_base64_urlsafe_decode(void *dst, size_t *dst_len, const char *src)
{
#if defined(__aarch64__) && !defined(__ARM_FEATURE_SVE)
return base64_decode(dst, dst_len, base64_urlsafe_dec_table, base64_urlsafe_dec_table_neon64,
src);
#else
return base64_decode(dst, dst_len, base64_urlsafe_dec_table, src);
#endif
}
Reference in New Issue View Git Blame Copy Permalink