Branch data     Line data    Source code

       1                 :            : // Copyright (c) 2016-2022 The Bitcoin Core developers
       2                 :            : // Distributed under the MIT software license, see the accompanying
       3                 :            : // file COPYING or http://www.opensource.org/licenses/mit-license.php.
       4                 :            : 
       5                 :            : #include <event2/event.h>
       6                 :            : 
       7                 :            : #include <cstdlib>
       8                 :            : #include <map>
       9                 :            : 
      10                 :            : #include <support/events.h>
      11                 :            : 
      12                 :            : #include <test/util/setup_common.h>
      13                 :            : 
      14                 :            : #include <boost/test/unit_test.hpp>
      15                 :            : 
      16                 :          0 : BOOST_FIXTURE_TEST_SUITE(raii_event_tests, BasicTestingSetup)
      17                 :            : 
      18                 :            : #ifdef EVENT_SET_MEM_FUNCTIONS_IMPLEMENTED
      19                 :            : 
      20                 :          0 : static std::map<void*, short> tags;
      21                 :          0 : static std::map<void*, uint16_t> orders;
      22                 :            : static uint16_t tagSequence = 0;
      23                 :            : 
      24                 :          0 : static void* tag_malloc(size_t sz) {
      25                 :          0 :     void* mem = malloc(sz);
      26                 :          0 :     if (!mem) return mem;
      27                 :          0 :     tags[mem]++;
      28                 :          0 :     orders[mem] = tagSequence++;
      29                 :          0 :     return mem;
      30                 :          0 : }
      31                 :            : 
      32                 :          0 : static void tag_free(void* mem) {
      33                 :          0 :     tags[mem]--;
      34                 :          0 :     orders[mem] = tagSequence++;
      35                 :          0 :     free(mem);
      36                 :          0 : }
      37                 :            : 
      38                 :          0 : BOOST_AUTO_TEST_CASE(raii_event_creation)
      39                 :            : {
      40                 :          0 :     event_set_mem_functions(tag_malloc, realloc, tag_free);
      41                 :            : 
      42                 :          0 :     void* base_ptr = nullptr;
      43                 :            :     {
      44                 :          0 :         auto base = obtain_event_base();
      45                 :          0 :         base_ptr = (void*)base.get();
      46                 :          0 :         BOOST_CHECK(tags[base_ptr] == 1);
      47                 :          0 :     }
      48                 :          0 :     BOOST_CHECK(tags[base_ptr] == 0);
      49                 :            : 
      50                 :          0 :     void* event_ptr = nullptr;
      51                 :            :     {
      52                 :          0 :         auto base = obtain_event_base();
      53                 :          0 :         auto event = obtain_event(base.get(), -1, 0, nullptr, nullptr);
      54                 :            : 
      55                 :          0 :         base_ptr = (void*)base.get();
      56                 :          0 :         event_ptr = (void*)event.get();
      57                 :            : 
      58                 :          0 :         BOOST_CHECK(tags[base_ptr] == 1);
      59                 :          0 :         BOOST_CHECK(tags[event_ptr] == 1);
      60                 :          0 :     }
      61                 :          0 :     BOOST_CHECK(tags[base_ptr] == 0);
      62                 :          0 :     BOOST_CHECK(tags[event_ptr] == 0);
      63                 :            : 
      64                 :          0 :     event_set_mem_functions(malloc, realloc, free);
      65                 :          0 : }
      66                 :            : 
      67                 :          0 : BOOST_AUTO_TEST_CASE(raii_event_order)
      68                 :            : {
      69                 :          0 :     event_set_mem_functions(tag_malloc, realloc, tag_free);
      70                 :            : 
      71                 :          0 :     void* base_ptr = nullptr;
      72                 :          0 :     void* event_ptr = nullptr;
      73                 :            :     {
      74                 :          0 :         auto base = obtain_event_base();
      75                 :          0 :         auto event = obtain_event(base.get(), -1, 0, nullptr, nullptr);
      76                 :            : 
      77                 :          0 :         base_ptr = (void*)base.get();
      78                 :          0 :         event_ptr = (void*)event.get();
      79                 :            : 
      80                 :            :         // base should have allocated before event
      81                 :          0 :         BOOST_CHECK(orders[base_ptr] < orders[event_ptr]);
      82                 :          0 :     }
      83                 :            :     // base should be freed after event
      84                 :          0 :     BOOST_CHECK(orders[base_ptr] > orders[event_ptr]);
      85                 :            : 
      86                 :          0 :     event_set_mem_functions(malloc, realloc, free);
      87                 :          0 : }
      88                 :            : 
      89                 :            : #else
      90                 :            : 
      91                 :            : BOOST_AUTO_TEST_CASE(raii_event_tests_SKIPPED)
      92                 :            : {
      93                 :            :     // It would probably be ideal to report skipped, but boost::test doesn't seem to make that practical (at least not in versions available with common distros)
      94                 :            :     BOOST_TEST_MESSAGE("Skipping raii_event_tess: libevent doesn't support event_set_mem_functions");
      95                 :            : }
      96                 :            : 
      97                 :            : #endif  // EVENT_SET_MEM_FUNCTIONS_IMPLEMENTED
      98                 :            : 
      99                 :          0 : BOOST_AUTO_TEST_SUITE_END()