Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jegao/index destruct temp fix #573

Merged
merged 3 commits into from
Jul 29, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion include/abstract_graph_store.h
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@
#include <string>
#include <vector>
#include "types.h"
#include "neighbor_list.h"

namespace diskann
{
Expand All @@ -27,7 +28,7 @@ class AbstractGraphStore
const uint32_t start) = 0;

// not synchronised, user should use lock when necvessary.
virtual const std::vector<location_t> &get_neighbours(const location_t i) const = 0;
virtual const NeighborList get_neighbours(const location_t i) const = 0;
virtual void add_neighbour(const location_t i, location_t neighbour_id) = 0;
virtual void clear_neighbours(const location_t i) = 0;
virtual void swap_neighbours(const location_t a, location_t b) = 0;
Expand Down
2 changes: 1 addition & 1 deletion include/in_mem_graph_store.h
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ class InMemGraphStore : public AbstractGraphStore
virtual int store(const std::string &index_path_prefix, const size_t num_points, const size_t num_frozen_points,
const uint32_t start) override;

virtual const std::vector<location_t> &get_neighbours(const location_t i) const override;
virtual const NeighborList get_neighbours(const location_t i) const override;
virtual void add_neighbour(const location_t i, location_t neighbour_id) override;
virtual void clear_neighbours(const location_t i) override;
virtual void swap_neighbours(const location_t a, location_t b) override;
Expand Down
78 changes: 78 additions & 0 deletions include/in_mem_static_graph_store.h
Original file line number Diff line number Diff line change
@@ -0,0 +1,78 @@
// Copyright (c) Microsoft Corporation. All rights reserved.
// Licensed under the MIT license.

#pragma once

#include "abstract_graph_store.h"

namespace diskann
{

class InMemStaticGraphStore : public AbstractGraphStore
{
public:
InMemStaticGraphStore(const size_t total_pts, const size_t reserve_graph_degree);

// returns tuple of <nodes_read, start, num_frozen_points>
virtual std::tuple<uint32_t, uint32_t, size_t> load(const std::string& index_path_prefix,
const size_t num_points) override;

virtual int store(const std::string& /*index_path_prefix*/, const size_t /*num_points*/, const size_t /*num_frozen_points*/,
const uint32_t /*start*/) override
{
throw std::runtime_error("static memory graph only use for searching");
}

virtual const NeighborList get_neighbours(const location_t i) const override;

virtual void add_neighbour(const location_t /*i*/, location_t /*neighbour_id*/) override
{
throw std::runtime_error("static memory graph only use for searching");
}

virtual void clear_neighbours(const location_t /*i*/) override
{
throw std::runtime_error("static memory graph only use for searching");
}

virtual void swap_neighbours(const location_t /*a*/, location_t /*b*/) override
{
throw std::runtime_error("static memory graph only use for searching");
}

virtual void set_neighbours(const location_t /*i*/, std::vector<location_t>& /*neighbors*/) override
{
throw std::runtime_error("static memory graph only use for searching");
}

virtual size_t resize_graph(const size_t new_size) override
{
// not action taken, the graph is initialized in loading
return new_size;
}

virtual void clear_graph() override
{
throw std::runtime_error("static memory graph only use for searching");
}

virtual size_t get_max_range_of_graph() override;
virtual uint32_t get_max_observed_degree() override;

protected:
virtual std::tuple<uint32_t, uint32_t, size_t> load_impl(const std::string& filename, size_t expected_num_points);
#ifdef EXEC_ENV_OLS
virtual std::tuple<uint32_t, uint32_t, size_t> load_impl(AlignedFileReader& reader, size_t expected_num_points);
#endif


private:
size_t _max_range_of_graph = 0;
uint32_t _max_observed_degree = 0;

std::vector<size_t> _node_index;
std::vector<std::uint32_t> _graph;
// std::vector<std::vector<uint32_t>> _graph;
};

} // namespace diskann
5 changes: 3 additions & 2 deletions include/index_config.h
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,8 @@ enum class DataStoreStrategy

enum class GraphStoreStrategy
{
MEMORY
MEMORY,
STATICMEMORY
};

struct IndexConfig
Expand Down Expand Up @@ -228,7 +229,7 @@ class IndexConfigBuilder

private:
DataStoreStrategy _data_strategy;
GraphStoreStrategy _graph_strategy;
GraphStoreStrategy _graph_strategy = GraphStoreStrategy::MEMORY;

Metric _metric;
size_t _dimension;
Expand Down
48 changes: 48 additions & 0 deletions include/neighbor_list.h
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
#pragma once
#include <cstdint>
#include <vector>
#include "types.h"

namespace diskann
{

class NeighborList
{
public:
NeighborList(const location_t* data, size_t size);

const location_t* data() const;
size_t size() const;
bool empty() const;

// compatable with current interface, need deprecate later
void convert_to_vector(std::vector<location_t>& vector_copy) const;

class Iterator
{
public:
Iterator(const location_t* index);

const location_t& operator*() const;

const Iterator& operator++();

bool operator==(const Iterator& other) const;

bool operator!=(const Iterator& other) const;

private:
const location_t* _index;
};

// Iterator begin() = 0;
Iterator begin() const;
// Iterator end() = 0;
Iterator end() const;

private:
const location_t* _data;
size_t _size;
};

}
6 changes: 4 additions & 2 deletions src/in_mem_graph_store.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@

namespace diskann
{

InMemGraphStore::InMemGraphStore(const size_t total_pts, const size_t reserve_graph_degree)
: AbstractGraphStore(total_pts, reserve_graph_degree)
{
Expand All @@ -26,9 +27,10 @@ int InMemGraphStore::store(const std::string &index_path_prefix, const size_t nu
{
return save_graph(index_path_prefix, num_points, num_frozen_points, start);
}
const std::vector<location_t> &InMemGraphStore::get_neighbours(const location_t i) const
const NeighborList InMemGraphStore::get_neighbours(const location_t i) const
{
return _graph.at(i);
auto& neighbor_vector = _graph.at(i);
return NeighborList(neighbor_vector.data(), neighbor_vector.size());
}

void InMemGraphStore::add_neighbour(const location_t i, location_t neighbour_id)
Expand Down
198 changes: 198 additions & 0 deletions src/in_mem_static_graph_store.cpp
Original file line number Diff line number Diff line change
@@ -0,0 +1,198 @@
// Copyright (c) Microsoft Corporation. All rights reserved.
// Licensed under the MIT license.

#include "in_mem_static_graph_store.h"
#include "utils.h"

namespace diskann
{

InMemStaticGraphStore::InMemStaticGraphStore(const size_t total_pts, const size_t reserve_graph_degree)
: AbstractGraphStore(total_pts, reserve_graph_degree)
{
}

std::tuple<uint32_t, uint32_t, size_t> InMemStaticGraphStore::load(const std::string& index_path_prefix,
const size_t num_points)
{
return load_impl(index_path_prefix, num_points);
}

const NeighborList InMemStaticGraphStore::get_neighbours(const location_t i) const
{
assert(i < _node_index.size() - 1);
size_t start_index = _node_index[i];
size_t end_index = _node_index[i + 1];
size_t size = end_index - start_index;
const location_t* neighbor_start = _graph.data() + start_index;
return NeighborList(neighbor_start, size);
}

#ifdef EXEC_ENV_OLS
std::tuple<uint32_t, uint32_t, size_t> InMemGraphStore::load_impl(AlignedFileReader& reader, size_t expected_num_points)
{
size_t expected_file_size;
size_t file_frozen_pts;
uint32_t start;

auto max_points = get_max_points();
int header_size = 2 * sizeof(size_t) + 2 * sizeof(uint32_t);
std::unique_ptr<char[]> header = std::make_unique<char[]>(header_size);
read_array(reader, header.get(), header_size);

expected_file_size = *((size_t*)header.get());
_max_observed_degree = *((uint32_t*)(header.get() + sizeof(size_t)));
start = *((uint32_t*)(header.get() + sizeof(size_t) + sizeof(uint32_t)));
file_frozen_pts = *((size_t*)(header.get() + sizeof(size_t) + sizeof(uint32_t) + sizeof(uint32_t)));

diskann::cout << "From graph header, expected_file_size: " << expected_file_size
<< ", _max_observed_degree: " << _max_observed_degree << ", _start: " << start
<< ", file_frozen_pts: " << file_frozen_pts << std::endl;

diskann::cout << "Loading vamana graph from reader..." << std::flush;

// If user provides more points than max_points
// resize the _graph to the larger size.
if (get_total_points() < expected_num_points)
{
diskann::cout << "resizing graph to " << expected_num_points << std::endl;
this->resize_graph(expected_num_points);
}

uint32_t nodes_read = 0;
size_t cc = 0;
size_t graph_offset = header_size;
while (nodes_read < expected_num_points)
{
uint32_t k;
read_value(reader, k, graph_offset);
graph_offset += sizeof(uint32_t);
std::vector<uint32_t> tmp(k);
tmp.reserve(k);
read_array(reader, tmp.data(), k, graph_offset);
graph_offset += k * sizeof(uint32_t);
cc += k;
_graph[nodes_read].swap(tmp);
nodes_read++;
if (nodes_read % 1000000 == 0)
{
diskann::cout << "." << std::flush;
}
if (k > _max_range_of_graph)
{
_max_range_of_graph = k;
}
}

diskann::cout << "done. Index has " << nodes_read << " nodes and " << cc << " out-edges, _start is set to " << start
<< std::endl;
return std::make_tuple(nodes_read, start, file_frozen_pts);
}
#endif

std::tuple<uint32_t, uint32_t, size_t> InMemStaticGraphStore::load_impl(const std::string& filename,
size_t expected_num_points)
{
size_t expected_file_size;
size_t file_frozen_pts;
uint32_t start;
size_t file_offset = 0; // will need this for single file format support

std::ifstream in;
in.exceptions(std::ios::badbit | std::ios::failbit);
in.open(filename, std::ios::binary);
in.seekg(file_offset, in.beg);
in.read((char*)&expected_file_size, sizeof(size_t));
in.read((char*)&_max_observed_degree, sizeof(uint32_t));
in.read((char*)&start, sizeof(uint32_t));
in.read((char*)&file_frozen_pts, sizeof(size_t));
size_t vamana_metadata_size = sizeof(size_t) + sizeof(uint32_t) + sizeof(uint32_t) + sizeof(size_t);

diskann::cout << "From graph header, expected_file_size: " << expected_file_size
<< ", _max_observed_degree: " << _max_observed_degree << ", _start: " << start
<< ", file_frozen_pts: " << file_frozen_pts << std::endl;

diskann::cout << "Loading vamana graph " << filename << "..." << std::flush;

std::vector<char> buffer;
size_t graph_size = expected_file_size - vamana_metadata_size;
buffer.resize(graph_size);

in.read(buffer.data(), graph_size);
in.close();

size_t cc = 0;
uint32_t nodes_read = 0;

// first round to calculate memory size needed.
size_t cur_index = 0;
while (cur_index + sizeof(uint32_t) < graph_size)
{
uint32_t k;
memcpy((char*)&k, buffer.data() + cur_index, sizeof(uint32_t));
cur_index += sizeof(uint32_t);
size_t neighbor_size = k * sizeof(uint32_t);
if (cur_index + neighbor_size > graph_size)
{
break;
}
cur_index += neighbor_size;

cc += k;
++nodes_read;
}

// resize graph
_node_index.resize(nodes_read + 1);
_node_index[0] = 0;
_graph.resize(cc);

// second round to insert graph data
nodes_read = 0;
cur_index = 0;
while (cur_index + sizeof(uint32_t) < graph_size)
{
uint32_t k;
memcpy((char*)&k, buffer.data() + cur_index, sizeof(uint32_t));
cur_index += sizeof(uint32_t);
size_t neighbor_size = k * sizeof(uint32_t);
if (cur_index + neighbor_size > graph_size)
{
break;
}

size_t offset = _node_index[nodes_read];
std::uint32_t* neighborPtr = &_graph[offset];

memcpy(neighborPtr, buffer.data() + cur_index, neighbor_size);
_node_index[nodes_read + 1] = offset + k;

cur_index += neighbor_size;

if (nodes_read % 10000000 == 0)
std::cout << "." << std::flush;

++nodes_read;

if (k > _max_range_of_graph)
{
_max_range_of_graph = k;
}
}

diskann::cout << "done. Index has " << nodes_read << " nodes and " << cc << " out-edges, _start is set to " << start
<< std::endl;
return std::make_tuple(nodes_read, start, file_frozen_pts);
}

size_t InMemStaticGraphStore::get_max_range_of_graph()
{
return _max_range_of_graph;
}

uint32_t InMemStaticGraphStore::get_max_observed_degree()
{
return _max_observed_degree;
}

} // namespace diskann
Loading
Loading