Junxiao Shi | 770f904 | 2017-07-13 13:30:53 +0000 | [diff] [blame] | 1 | /* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */ |
| 2 | /* |
Davide Pesavento | 21b7f1b | 2023-04-28 23:21:02 -0400 | [diff] [blame^] | 3 | * Copyright (c) 2013-2023 Regents of the University of California. |
Junxiao Shi | 770f904 | 2017-07-13 13:30:53 +0000 | [diff] [blame] | 4 | * |
| 5 | * This file is part of ndn-cxx library (NDN C++ library with eXperimental eXtensions). |
| 6 | * |
| 7 | * ndn-cxx library is free software: you can redistribute it and/or modify it under the |
| 8 | * terms of the GNU Lesser General Public License as published by the Free Software |
| 9 | * Foundation, either version 3 of the License, or (at your option) any later version. |
| 10 | * |
| 11 | * ndn-cxx library is distributed in the hope that it will be useful, but WITHOUT ANY |
| 12 | * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A |
| 13 | * PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details. |
| 14 | * |
| 15 | * You should have received copies of the GNU General Public License and GNU Lesser |
| 16 | * General Public License along with ndn-cxx, e.g., in COPYING.md file. If not, see |
| 17 | * <http://www.gnu.org/licenses/>. |
| 18 | * |
| 19 | * See AUTHORS.md for complete list of ndn-cxx authors and contributors. |
| 20 | */ |
| 21 | |
Junxiao Shi | 770f904 | 2017-07-13 13:30:53 +0000 | [diff] [blame] | 22 | #define BOOST_TEST_MODULE ndn-cxx Encoding Benchmark |
Davide Pesavento | 7e78064 | 2018-11-24 15:51:34 -0500 | [diff] [blame] | 23 | #include "tests/boost-test.hpp" |
Junxiao Shi | 770f904 | 2017-07-13 13:30:53 +0000 | [diff] [blame] | 24 | |
Davide Pesavento | 7e78064 | 2018-11-24 15:51:34 -0500 | [diff] [blame] | 25 | #include "ndn-cxx/encoding/tlv.hpp" |
Davide Pesavento | 394977c | 2020-04-25 21:40:31 -0400 | [diff] [blame] | 26 | #include "tests/benchmarks/timed-execute.hpp" |
Davide Pesavento | cdcde90 | 2017-08-23 15:40:22 -0400 | [diff] [blame] | 27 | |
Junxiao Shi | 770f904 | 2017-07-13 13:30:53 +0000 | [diff] [blame] | 28 | #include <boost/mpl/vector.hpp> |
| 29 | #include <boost/mpl/vector_c.hpp> |
| 30 | |
Davide Pesavento | cdcde90 | 2017-08-23 15:40:22 -0400 | [diff] [blame] | 31 | #include <iostream> |
| 32 | |
Junxiao Shi | 770f904 | 2017-07-13 13:30:53 +0000 | [diff] [blame] | 33 | namespace ndn { |
| 34 | namespace tlv { |
| 35 | namespace tests { |
| 36 | |
| 37 | using namespace ndn::tests; |
| 38 | |
| 39 | template<size_t WIRE_SIZE> |
| 40 | struct ReadVarNumberTest; |
| 41 | |
| 42 | template<> |
| 43 | struct ReadVarNumberTest<1> |
| 44 | { |
Davide Pesavento | 21b7f1b | 2023-04-28 23:21:02 -0400 | [diff] [blame^] | 45 | static constexpr uint8_t WIRE[] = {0xfc}; |
| 46 | static constexpr uint64_t VALUE = 252; |
Junxiao Shi | 770f904 | 2017-07-13 13:30:53 +0000 | [diff] [blame] | 47 | }; |
Junxiao Shi | 770f904 | 2017-07-13 13:30:53 +0000 | [diff] [blame] | 48 | |
| 49 | template<> |
| 50 | struct ReadVarNumberTest<3> |
| 51 | { |
Davide Pesavento | 21b7f1b | 2023-04-28 23:21:02 -0400 | [diff] [blame^] | 52 | static constexpr uint8_t WIRE[] = {0xfd, 0x00, 0xfd}; |
| 53 | static constexpr uint64_t VALUE = 253; |
Junxiao Shi | 770f904 | 2017-07-13 13:30:53 +0000 | [diff] [blame] | 54 | }; |
Junxiao Shi | 770f904 | 2017-07-13 13:30:53 +0000 | [diff] [blame] | 55 | |
| 56 | template<> |
| 57 | struct ReadVarNumberTest<5> |
| 58 | { |
Davide Pesavento | 21b7f1b | 2023-04-28 23:21:02 -0400 | [diff] [blame^] | 59 | static constexpr uint8_t WIRE[] = {0xfe, 0x00, 0x01, 0x00, 0x00}; |
| 60 | static constexpr uint64_t VALUE = 65536; |
Junxiao Shi | 770f904 | 2017-07-13 13:30:53 +0000 | [diff] [blame] | 61 | }; |
Junxiao Shi | 770f904 | 2017-07-13 13:30:53 +0000 | [diff] [blame] | 62 | |
| 63 | template<> |
| 64 | struct ReadVarNumberTest<9> |
| 65 | { |
Davide Pesavento | 21b7f1b | 2023-04-28 23:21:02 -0400 | [diff] [blame^] | 66 | static constexpr uint8_t WIRE[] = {0xff, 0x00, 0x00, 0x00, 0x01, 0x00, 0x00, 0x00, 0x00}; |
| 67 | static constexpr uint64_t VALUE = 4294967296; |
Junxiao Shi | 770f904 | 2017-07-13 13:30:53 +0000 | [diff] [blame] | 68 | }; |
Junxiao Shi | 770f904 | 2017-07-13 13:30:53 +0000 | [diff] [blame] | 69 | |
| 70 | template<size_t WIRE_SIZE, size_t ALIGNMENT_OFFSET> |
| 71 | struct ReadVarNumberAlignTest : public ReadVarNumberTest<WIRE_SIZE> |
| 72 | { |
| 73 | using AlignmentOffset = std::integral_constant<size_t, ALIGNMENT_OFFSET>; |
| 74 | |
| 75 | static_assert(sizeof(ReadVarNumberTest<WIRE_SIZE>::WIRE) == WIRE_SIZE, ""); |
| 76 | }; |
| 77 | |
| 78 | using ReadVarNumberTests = boost::mpl::vector< |
| 79 | ReadVarNumberAlignTest<1, 0>, |
| 80 | ReadVarNumberAlignTest<3, 0>, |
| 81 | ReadVarNumberAlignTest<3, 1>, |
| 82 | ReadVarNumberAlignTest<5, 0>, |
| 83 | ReadVarNumberAlignTest<5, 1>, |
| 84 | ReadVarNumberAlignTest<5, 2>, |
| 85 | ReadVarNumberAlignTest<5, 3>, |
| 86 | ReadVarNumberAlignTest<9, 0>, |
| 87 | ReadVarNumberAlignTest<9, 1>, |
| 88 | ReadVarNumberAlignTest<9, 2>, |
| 89 | ReadVarNumberAlignTest<9, 3>, |
| 90 | ReadVarNumberAlignTest<9, 4>, |
| 91 | ReadVarNumberAlignTest<9, 5>, |
| 92 | ReadVarNumberAlignTest<9, 6>, |
| 93 | ReadVarNumberAlignTest<9, 7> |
| 94 | >; |
| 95 | |
| 96 | // Benchmark of ndn::tlv::readVarNumber with different number lengths and alignments. |
Junxiao Shi | 770f904 | 2017-07-13 13:30:53 +0000 | [diff] [blame] | 97 | // For accurate results, it is required to compile ndn-cxx in release mode. |
| 98 | // It is recommended to run the benchmark multiple times and take the average. |
| 99 | BOOST_AUTO_TEST_CASE_TEMPLATE(ReadVarNumber, Test, ReadVarNumberTests) |
| 100 | { |
Davide Pesavento | 21b7f1b | 2023-04-28 23:21:02 -0400 | [diff] [blame^] | 101 | constexpr int N_ITERATIONS = 100000000; |
Junxiao Shi | 770f904 | 2017-07-13 13:30:53 +0000 | [diff] [blame] | 102 | |
| 103 | alignas(8) uint8_t buffer[16]; |
| 104 | static_assert(Test::AlignmentOffset::value + sizeof(Test::WIRE) <= sizeof(buffer), ""); |
| 105 | uint8_t* const begin = buffer + Test::AlignmentOffset::value; |
| 106 | std::memcpy(begin, Test::WIRE, sizeof(Test::WIRE)); |
| 107 | const uint8_t* const end = begin + sizeof(Test::WIRE); |
| 108 | |
| 109 | int nOks = 0; |
| 110 | int nCorrects = 0; |
| 111 | auto d = timedExecute([&] { |
| 112 | uint64_t number = 0; |
| 113 | for (int i = 0; i < N_ITERATIONS; ++i) { |
| 114 | const uint8_t* begin2 = begin; // make a copy because readVarNumber increments the pointer |
| 115 | nOks += readVarNumber(begin2, end, number); |
| 116 | nCorrects += number == Test::VALUE; |
| 117 | // use the number and the return value, so compiler won't optimize out their computation |
| 118 | } |
| 119 | }); |
| 120 | BOOST_CHECK_EQUAL(nOks, N_ITERATIONS); |
| 121 | BOOST_CHECK_EQUAL(nCorrects, N_ITERATIONS); |
| 122 | std::cout << "size=" << sizeof(Test::WIRE) |
| 123 | << " offset=" << Test::AlignmentOffset::value |
| 124 | << " " << d << std::endl; |
| 125 | } |
| 126 | |
| 127 | } // namespace tests |
| 128 | } // namespace tlv |
| 129 | } // namespace ndn |