blob: a3e0b5e5bcd1f11cd26f1730217b6cec983a8922 [file] [log] [blame]
Junxiao Shi770f9042017-07-13 13:30:53 +00001/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
2/*
Davide Pesavento21b7f1b2023-04-28 23:21:02 -04003 * Copyright (c) 2013-2023 Regents of the University of California.
Junxiao Shi770f9042017-07-13 13:30:53 +00004 *
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 Shi770f9042017-07-13 13:30:53 +000022#define BOOST_TEST_MODULE ndn-cxx Encoding Benchmark
Davide Pesavento7e780642018-11-24 15:51:34 -050023#include "tests/boost-test.hpp"
Junxiao Shi770f9042017-07-13 13:30:53 +000024
Davide Pesavento7e780642018-11-24 15:51:34 -050025#include "ndn-cxx/encoding/tlv.hpp"
Davide Pesavento394977c2020-04-25 21:40:31 -040026#include "tests/benchmarks/timed-execute.hpp"
Davide Pesaventocdcde902017-08-23 15:40:22 -040027
Junxiao Shi770f9042017-07-13 13:30:53 +000028#include <boost/mpl/vector.hpp>
29#include <boost/mpl/vector_c.hpp>
30
Davide Pesaventocdcde902017-08-23 15:40:22 -040031#include <iostream>
32
Davide Pesavento47ce2ee2023-05-09 01:33:33 -040033namespace ndn::tests {
Junxiao Shi770f9042017-07-13 13:30:53 +000034
35template<size_t WIRE_SIZE>
36struct ReadVarNumberTest;
37
38template<>
39struct ReadVarNumberTest<1>
40{
Davide Pesavento21b7f1b2023-04-28 23:21:02 -040041 static constexpr uint8_t WIRE[] = {0xfc};
42 static constexpr uint64_t VALUE = 252;
Junxiao Shi770f9042017-07-13 13:30:53 +000043};
Junxiao Shi770f9042017-07-13 13:30:53 +000044
45template<>
46struct ReadVarNumberTest<3>
47{
Davide Pesavento21b7f1b2023-04-28 23:21:02 -040048 static constexpr uint8_t WIRE[] = {0xfd, 0x00, 0xfd};
49 static constexpr uint64_t VALUE = 253;
Junxiao Shi770f9042017-07-13 13:30:53 +000050};
Junxiao Shi770f9042017-07-13 13:30:53 +000051
52template<>
53struct ReadVarNumberTest<5>
54{
Davide Pesavento21b7f1b2023-04-28 23:21:02 -040055 static constexpr uint8_t WIRE[] = {0xfe, 0x00, 0x01, 0x00, 0x00};
56 static constexpr uint64_t VALUE = 65536;
Junxiao Shi770f9042017-07-13 13:30:53 +000057};
Junxiao Shi770f9042017-07-13 13:30:53 +000058
59template<>
60struct ReadVarNumberTest<9>
61{
Davide Pesavento21b7f1b2023-04-28 23:21:02 -040062 static constexpr uint8_t WIRE[] = {0xff, 0x00, 0x00, 0x00, 0x01, 0x00, 0x00, 0x00, 0x00};
63 static constexpr uint64_t VALUE = 4294967296;
Junxiao Shi770f9042017-07-13 13:30:53 +000064};
Junxiao Shi770f9042017-07-13 13:30:53 +000065
66template<size_t WIRE_SIZE, size_t ALIGNMENT_OFFSET>
67struct ReadVarNumberAlignTest : public ReadVarNumberTest<WIRE_SIZE>
68{
69 using AlignmentOffset = std::integral_constant<size_t, ALIGNMENT_OFFSET>;
70
71 static_assert(sizeof(ReadVarNumberTest<WIRE_SIZE>::WIRE) == WIRE_SIZE, "");
72};
73
74using ReadVarNumberTests = boost::mpl::vector<
75 ReadVarNumberAlignTest<1, 0>,
76 ReadVarNumberAlignTest<3, 0>,
77 ReadVarNumberAlignTest<3, 1>,
78 ReadVarNumberAlignTest<5, 0>,
79 ReadVarNumberAlignTest<5, 1>,
80 ReadVarNumberAlignTest<5, 2>,
81 ReadVarNumberAlignTest<5, 3>,
82 ReadVarNumberAlignTest<9, 0>,
83 ReadVarNumberAlignTest<9, 1>,
84 ReadVarNumberAlignTest<9, 2>,
85 ReadVarNumberAlignTest<9, 3>,
86 ReadVarNumberAlignTest<9, 4>,
87 ReadVarNumberAlignTest<9, 5>,
88 ReadVarNumberAlignTest<9, 6>,
89 ReadVarNumberAlignTest<9, 7>
90>;
91
92// Benchmark of ndn::tlv::readVarNumber with different number lengths and alignments.
Junxiao Shi770f9042017-07-13 13:30:53 +000093// For accurate results, it is required to compile ndn-cxx in release mode.
94// It is recommended to run the benchmark multiple times and take the average.
95BOOST_AUTO_TEST_CASE_TEMPLATE(ReadVarNumber, Test, ReadVarNumberTests)
96{
Davide Pesavento21b7f1b2023-04-28 23:21:02 -040097 constexpr int N_ITERATIONS = 100000000;
Junxiao Shi770f9042017-07-13 13:30:53 +000098
99 alignas(8) uint8_t buffer[16];
100 static_assert(Test::AlignmentOffset::value + sizeof(Test::WIRE) <= sizeof(buffer), "");
101 uint8_t* const begin = buffer + Test::AlignmentOffset::value;
102 std::memcpy(begin, Test::WIRE, sizeof(Test::WIRE));
103 const uint8_t* const end = begin + sizeof(Test::WIRE);
104
105 int nOks = 0;
106 int nCorrects = 0;
107 auto d = timedExecute([&] {
108 uint64_t number = 0;
109 for (int i = 0; i < N_ITERATIONS; ++i) {
110 const uint8_t* begin2 = begin; // make a copy because readVarNumber increments the pointer
Davide Pesavento47ce2ee2023-05-09 01:33:33 -0400111 nOks += tlv::readVarNumber(begin2, end, number);
Junxiao Shi770f9042017-07-13 13:30:53 +0000112 nCorrects += number == Test::VALUE;
113 // use the number and the return value, so compiler won't optimize out their computation
114 }
115 });
116 BOOST_CHECK_EQUAL(nOks, N_ITERATIONS);
117 BOOST_CHECK_EQUAL(nCorrects, N_ITERATIONS);
118 std::cout << "size=" << sizeof(Test::WIRE)
119 << " offset=" << Test::AlignmentOffset::value
120 << " " << d << std::endl;
121}
122
Davide Pesavento47ce2ee2023-05-09 01:33:33 -0400123} // namespace ndn::tests