mirror of
https://github.com/monero-project/monero.git
synced 2025-01-09 17:09:29 -05:00
98 lines
4.2 KiB
C++
98 lines
4.2 KiB
C++
// Copyright (c) 2014, The Monero Project
|
|
//
|
|
// All rights reserved.
|
|
//
|
|
// Redistribution and use in source and binary forms, with or without modification, are
|
|
// permitted provided that the following conditions are met:
|
|
//
|
|
// 1. Redistributions of source code must retain the above copyright notice, this list of
|
|
// conditions and the following disclaimer.
|
|
//
|
|
// 2. 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.
|
|
//
|
|
// 3. Neither the name of the copyright holder 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 HOLDER OR CONTRIBUTORS 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 "fcmp/curve_trees.h"
|
|
#include "fcmp/tower_cycle.h"
|
|
|
|
using Helios = fcmp::curve_trees::Helios;
|
|
using Selene = fcmp::curve_trees::Selene;
|
|
using CurveTreesV1 = fcmp::curve_trees::CurveTreesV1;
|
|
|
|
// Helper class to read/write a global tree in memory. It's only used in testing because normally the tree isn't kept
|
|
// in memory (it's stored in the db)
|
|
class CurveTreesGlobalTree
|
|
{
|
|
public:
|
|
CurveTreesGlobalTree(CurveTreesV1 &curve_trees): m_curve_trees(curve_trees) {};
|
|
|
|
//member structs
|
|
public:
|
|
template<typename C>
|
|
using Layer = std::vector<typename C::Point>;
|
|
|
|
// A complete tree, useful for testing (don't want to keep the whole tree in memory during normal operation)
|
|
struct Tree final
|
|
{
|
|
std::vector<CurveTreesV1::LeafTuple> leaves;
|
|
std::vector<Layer<Helios>> c1_layers;
|
|
std::vector<Layer<Selene>> c2_layers;
|
|
};
|
|
|
|
//public member functions
|
|
public:
|
|
// Read the in-memory tree and get the number of leaf tuples
|
|
std::size_t get_num_leaf_tuples() const;
|
|
|
|
// Read the in-memory tree and get the last hashes from each layer in the tree
|
|
CurveTreesV1::LastHashes get_last_hashes() const;
|
|
|
|
// Use the tree extension to extend the in-memory tree
|
|
void extend_tree(const CurveTreesV1::TreeExtension &tree_extension);
|
|
|
|
// Use the tree reduction to reduce the in-memory tree
|
|
void reduce_tree(const CurveTreesV1::TreeReduction &tree_reduction);
|
|
|
|
// Trim the provided number of leaf tuples from the tree
|
|
void trim_tree(const std::size_t trim_n_leaf_tuples);
|
|
|
|
// Validate the in-memory tree by re-hashing every layer, starting from root and working down to leaf layer
|
|
bool audit_tree(const std::size_t expected_n_leaf_tuples);
|
|
|
|
// logging helpers
|
|
void log_last_hashes(const CurveTreesV1::LastHashes &last_hashes);
|
|
void log_tree_extension(const CurveTreesV1::TreeExtension &tree_extension);
|
|
void log_tree();
|
|
|
|
// Read the in-memory tree and get data from what will be the last chunks after trimming the tree to the provided
|
|
// number of leaves
|
|
// - This function is useful to collect all tree data necessary to perform the actual trim operation
|
|
// - This function can return elems from each last chunk that will need to be trimmed
|
|
CurveTreesV1::LastHashes get_last_hashes_to_trim(
|
|
const std::vector<fcmp::curve_trees::TrimLayerInstructions> &trim_instructions) const;
|
|
|
|
CurveTreesV1::LastChunkChildrenToTrim get_all_last_chunk_children_to_trim(
|
|
const std::vector<fcmp::curve_trees::TrimLayerInstructions> &trim_instructions);
|
|
|
|
private:
|
|
CurveTreesV1 &m_curve_trees;
|
|
Tree m_tree = Tree{};
|
|
};
|
|
|