-
Notifications
You must be signed in to change notification settings - Fork 1.2k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Introduce utility class for encoding
- Loading branch information
1 parent
58434fc
commit ed5a652
Showing
5 changed files
with
198 additions
and
72 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,117 @@ | ||
| /* | ||
| * Copyright (c) Facebook, Inc. and its affiliates. | ||
| * | ||
| * Licensed under the Apache License, Version 2.0 (the "License"); | ||
| * you may not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| */ | ||
| #pragma once | ||
|
|
||
| #include <exception> | ||
| #include <map> | ||
| #include <string> | ||
|
|
||
| #include <folly/Range.h> | ||
|
|
||
| #include "velox/common/base/Exceptions.h" | ||
|
|
||
| namespace facebook::velox::encoding { | ||
|
|
||
| const size_t kCharsetSize = 64; | ||
| const size_t kReverseIndexSize = 256; | ||
|
|
||
| /// Character set used for encoding purposes. | ||
| /// Contains specific characters that form the encoding scheme. | ||
| using Charset = std::array<char, kCharsetSize>; | ||
|
|
||
| /// Reverse lookup table for decoding purposes. | ||
| /// Maps each possible encoded character to its corresponding numeric value | ||
| /// within the encoding base. | ||
| using ReverseIndex = std::array<uint8_t, kReverseIndexSize>; | ||
|
|
||
| /// Padding character used in encoding. | ||
| const static char kPadding = '='; | ||
| /// Checks if there is padding in encoded data. | ||
| static inline bool isPadded(const char* data, size_t len) { | ||
| return (len > 0 && data[len - 1] == kPadding) ? true : false; | ||
| } | ||
|
|
||
| /// Counts the number of padding characters in encoded data. | ||
| static inline size_t numPadding(const char* src, size_t len) { | ||
| size_t numPadding{0}; | ||
| while (len > 0 && src[len - 1] == kPadding) { | ||
| numPadding++; | ||
| len--; | ||
| } | ||
| return numPadding; | ||
| } | ||
| /// Performs a reverse lookup in the reverse index to retrieve the original | ||
| /// index of a character in the base. | ||
| inline uint8_t | ||
| baseReverseLookup(int base, char p, const ReverseIndex& reverseIndex) { | ||
| auto curr = reverseIndex[(uint8_t)p]; | ||
| if (curr >= base) { | ||
| VELOX_USER_FAIL("decode() - invalid input string: invalid characters"); | ||
| } | ||
| return curr; | ||
| } | ||
|
|
||
| // Validate the character in charset with ReverseIndex table | ||
| static constexpr bool checkForwardIndex( | ||
| uint8_t idx, | ||
| const Charset& charset, | ||
| const ReverseIndex& reverseIndex) { | ||
| for (uint8_t i = 0; i <= idx; ++i) { | ||
| if (!(reverseIndex[static_cast<uint8_t>(charset[i])] == i)) { | ||
| return false; | ||
| } | ||
| } | ||
| return true; | ||
| } | ||
|
|
||
| /// Searches for a character within a charset up to a certain index. | ||
| static const bool findCharacterInCharSet( | ||
| const Charset& charset, | ||
| int base, | ||
| uint8_t idx, | ||
| const char c) { | ||
| for (; idx < base; ++idx) { | ||
| if (charset[idx] == c) { | ||
| return true; | ||
| } | ||
| } | ||
| return false; | ||
| } | ||
|
|
||
| /// Checks the consistency of a reverse index mapping for a given character | ||
| /// set. | ||
| static constexpr bool checkReverseIndex( | ||
| uint8_t idx, | ||
| const Charset& charset, | ||
| int base, | ||
| const ReverseIndex& reverseIndex) { | ||
| for (uint8_t currentIdx = idx; currentIdx != static_cast<uint8_t>(-1); | ||
| --currentIdx) { | ||
| if (reverseIndex[currentIdx] == 255) { | ||
| if (findCharacterInCharSet( | ||
| charset, base, 0, static_cast<char>(currentIdx))) { | ||
| return false; | ||
| } | ||
| } else { | ||
| if (!(charset[reverseIndex[currentIdx]] == currentIdx)) { | ||
| return false; | ||
| } | ||
| } | ||
| } | ||
| return true; | ||
| } | ||
|
|
||
| } // namespace facebook::velox::encoding |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,76 @@ | ||
| /* | ||
| * Copyright (c) Facebook, Inc. and its affiliates. | ||
| * | ||
| * Licensed under the Apache License, Version 2.0 (the "License"); | ||
| * you may not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| */ | ||
|
|
||
| #include <gtest/gtest.h> | ||
| #include "velox/common/base/tests/GTestUtils.h" | ||
| #include "velox/common/encode/EncoderUtils.h" | ||
|
|
||
| namespace facebook::velox::encoding { | ||
| class EncoderUtilsTest : public ::testing::Test {}; | ||
|
|
||
| TEST_F(EncoderUtilsTest, isPadded) { | ||
| EXPECT_TRUE(isPadded("ABC=", 4)); | ||
| EXPECT_FALSE(isPadded("ABC", 3)); | ||
| } | ||
|
|
||
| TEST_F(EncoderUtilsTest, numPadding) { | ||
| EXPECT_EQ(0, numPadding("ABC", 3)); | ||
| EXPECT_EQ(1, numPadding("ABC=", 4)); | ||
| EXPECT_EQ(2, numPadding("AB==", 4)); | ||
| } | ||
|
|
||
| constexpr Charset testCharset = { | ||
| 'A', 'B', 'C', 'D', 'E', 'F', 'G', 'H', 'I', 'J', 'K', 'L', 'M', | ||
| 'N', 'O', 'P', 'Q', 'R', 'S', 'T', 'U', 'V', 'W', 'X', 'Y', 'Z', | ||
| 'a', 'b', 'c', 'd', 'e', 'f', 'g', 'h', 'i', 'j', 'k', 'l', 'm', | ||
| 'n', 'o', 'p', 'q', 'r', 's', 't', 'u', 'v', 'w', 'x', 'y', 'z', | ||
| '0', '1', '2', '3', '4', '5', '6', '7', '8', '9', '+', '/'}; | ||
|
|
||
| constexpr ReverseIndex testReverseIndex = { | ||
| 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, | ||
| 255, 255, 255, 255, 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}; | ||
|
|
||
| TEST_F(EncoderUtilsTest, baseReverseLookup) { | ||
| int base = 64; | ||
| EXPECT_NO_THROW(baseReverseLookup(base, 'A', testReverseIndex)); | ||
| EXPECT_THROW(baseReverseLookup(base, '=', testReverseIndex), std::exception); | ||
| } | ||
|
|
||
| TEST_F(EncoderUtilsTest, checkForwardIndex) { | ||
| EXPECT_TRUE(checkForwardIndex(63, testCharset, testReverseIndex)); | ||
| } | ||
|
|
||
| TEST_F(EncoderUtilsTest, checkReverseIndex) { | ||
| EXPECT_TRUE(checkReverseIndex(255, testCharset, 64, testReverseIndex)); | ||
| } | ||
|
|
||
| } // namespace facebook::velox::encoding |