Move copyable_atomic to be a sub-class of cryptonote_connection_context

epee::copyable_atomic was only be used by one struct, cryptonote_connection_context.
This should probably eventually factored out of that class, so I left the following comment:

This class was originally from the EPEE module. It is identical in function to std::atomic<uint32_t> except
that it has copy-construction and copy-assignment defined, which means that earliers devs didn't have to write
custom copy-contructors and copy-assingment operators for the outer class, cryptonote_connection_context.
cryptonote_connection_context should probably be refactored because it is both trying to be POD-like while
also (very loosely) controlling access to its atomic members.
This commit is contained in:
Jeffrey 2022-02-15 17:36:45 -06:00
parent bc6a7b6cbe
commit bd0a511995
2 changed files with 35 additions and 60 deletions

View File

@ -1,56 +0,0 @@
// Copyright (c) 2006-2013, Andrey N. Sabelnikov, www.sabelnikov.net
// All rights reserved.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are met:
// * Redistributions of source code must retain the above copyright
// notice, this list of conditions and the following disclaimer.
// * Redistributions in binary form must reproduce the above copyright
// notice, this list of conditions and the following disclaimer in the
// documentation and/or other materials provided with the distribution.
// * Neither the name of the Andrey N. Sabelnikov nor the
// names of its contributors may be used to endorse or promote products
// derived from this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
// ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
// WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
// DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER BE LIABLE FOR ANY
// DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
// (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
// LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
// ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
// SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
//
#pragma once
#include <atomic>
namespace epee
{
class copyable_atomic: public std::atomic<uint32_t>
{
public:
copyable_atomic()
{};
copyable_atomic(uint32_t value)
{ store(value); }
copyable_atomic(const copyable_atomic& a):std::atomic<uint32_t>(a.load())
{}
copyable_atomic& operator= (const copyable_atomic& a)
{
store(a.load());
return *this;
}
uint32_t operator++()
{
return std::atomic<uint32_t>::operator++();
}
uint32_t operator++(int fake)
{
return std::atomic<uint32_t>::operator++(fake);
}
};
}

View File

@ -27,6 +27,7 @@
// THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. // THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
// //
// Parts of this file are originally copyright (c) 2012-2013 The Cryptonote developers // Parts of this file are originally copyright (c) 2012-2013 The Cryptonote developers
// Parts of this file are originally copyright (c) 2006-2013, Andrey N. Sabelnikov, www.sabelnikov.net
#pragma once #pragma once
#include <unordered_set> #include <unordered_set>
@ -34,7 +35,6 @@
#include <algorithm> #include <algorithm>
#include <boost/date_time/posix_time/posix_time.hpp> #include <boost/date_time/posix_time/posix_time.hpp>
#include "net/net_utils_base.h" #include "net/net_utils_base.h"
#include "copyable_atomic.h"
#include "crypto/hash.h" #include "crypto/hash.h"
namespace cryptonote namespace cryptonote
@ -55,6 +55,37 @@ namespace cryptonote
state_normal state_normal
}; };
/*
This class was originally from the EPEE module. It is identical in function to std::atomic<uint32_t> except
that it has copy-construction and copy-assignment defined, which means that earliers devs didn't have to write
custom copy-contructors and copy-assingment operators for the outer class, cryptonote_connection_context.
cryptonote_connection_context should probably be refactored because it is both trying to be POD-like while
also (very loosely) controlling access to its atomic members.
*/
class copyable_atomic: public std::atomic<uint32_t>
{
public:
copyable_atomic()
{};
copyable_atomic(uint32_t value)
{ store(value); }
copyable_atomic(const copyable_atomic& a):std::atomic<uint32_t>(a.load())
{}
copyable_atomic& operator= (const copyable_atomic& a)
{
store(a.load());
return *this;
}
uint32_t operator++()
{
return std::atomic<uint32_t>::operator++();
}
uint32_t operator++(int fake)
{
return std::atomic<uint32_t>::operator++(fake);
}
};
static constexpr int handshake_command() noexcept { return 1001; } static constexpr int handshake_command() noexcept { return 1001; }
bool handshake_complete() const noexcept { return m_state != state_before_handshake; } bool handshake_complete() const noexcept { return m_state != state_before_handshake; }
@ -67,7 +98,7 @@ namespace cryptonote
uint64_t m_remote_blockchain_height; uint64_t m_remote_blockchain_height;
uint64_t m_last_response_height; uint64_t m_last_response_height;
boost::posix_time::ptime m_last_request_time; boost::posix_time::ptime m_last_request_time;
epee::copyable_atomic m_callback_request_count; //in debug purpose: problem with double callback rise copyable_atomic m_callback_request_count; //in debug purpose: problem with double callback rise
crypto::hash m_last_known_hash; crypto::hash m_last_known_hash;
uint32_t m_pruning_seed; uint32_t m_pruning_seed;
uint16_t m_rpc_port; uint16_t m_rpc_port;
@ -77,8 +108,8 @@ namespace cryptonote
int m_expect_response; int m_expect_response;
uint64_t m_expect_height; uint64_t m_expect_height;
size_t m_num_requested; size_t m_num_requested;
epee::copyable_atomic m_new_stripe_notification{0}; copyable_atomic m_new_stripe_notification{0};
epee::copyable_atomic m_idle_peer_notification{0}; copyable_atomic m_idle_peer_notification{0};
}; };
inline std::string get_protocol_state_string(cryptonote_connection_context::state s) inline std::string get_protocol_state_string(cryptonote_connection_context::state s)