Skip to content

Introducing index IO operations over char buffer #2

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.

Sign up for GitHub

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

Merged
abhinavdangeti merged 4 commits into from
Sep 13, 2023
Merged

Introducing index IO operations over char buffer #2

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
ecaa684
index io operations on char* buffer
Thejas-bhat Jul 21, 2023
b8e562c
bug fix: fill the index content to an unsigned char buf
Thejas-bhat Jul 24, 2023
20236cf
changes with respect to read API for index io
Thejas-bhat Jul 24, 2023
9a07475
Move read/write APIs from/to buffer to separate file
abhinavdangeti Aug 22, 2023
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
30 changes: 30 additions & 0 deletions c_api/index_io_c.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@

#include "index_io_c.h"
#include <faiss/index_io.h>
#include <faiss/impl/io.h>
#include "macros_impl.h"

using faiss::Index;
Expand All @@ -30,6 +31,23 @@ int faiss_write_index_fname(const FaissIndex* idx, const char* fname) {
CATCH_AND_HANDLE
}

int faiss_write_index_buf(const FaissIndex* idx, int* size, unsigned char** buf) {
try {
faiss::VectorIOWriter writer;

faiss::write_index(reinterpret_cast<const Index*>(idx), &writer);
unsigned char* tempBuf = (unsigned char*)malloc((writer.data.size() + 1) * sizeof(uint8_t));
std::copy(writer.data.begin(), writer.data.end(), tempBuf);
tempBuf[writer.data.size()] = 0;

// return the serialized index content to the passed buf
// furthermore, return its size (perhaps useful for memory management)
*buf = tempBuf;
*size = writer.data.size();
}
CATCH_AND_HANDLE
}

int faiss_read_index(FILE* f, int io_flags, FaissIndex** p_out) {
try {
auto out = faiss::read_index(f, io_flags);
Expand All @@ -49,6 +67,18 @@ int faiss_read_index_fname(
CATCH_AND_HANDLE
}

int faiss_read_index_buf(const unsigned char* buf, int size, int io_flags, FaissIndex** p_out) {
try {
faiss::VectorIOReader reader;
reader.data.resize(size);
memcpy(reader.data.data(), buf, size);

auto index = faiss::read_index(&reader, io_flags);
*p_out = reinterpret_cast<FaissIndex*>(index);
}
CATCH_AND_HANDLE
}

int faiss_write_index_binary(const FaissIndexBinary* idx, FILE* f) {
try {
faiss::write_index_binary(reinterpret_cast<const IndexBinary*>(idx), f);
Expand Down
5 changes: 5 additions & 0 deletions c_api/index_io_c.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,8 @@ int faiss_write_index(const FaissIndex* idx, FILE* f);
*/
int faiss_write_index_fname(const FaissIndex* idx, const char* fname);

int faiss_write_index_buf(const FaissIndex* idx, int* buf_size, unsigned char** buf);

#define FAISS_IO_FLAG_MMAP 1
#define FAISS_IO_FLAG_READ_ONLY 2

Expand All @@ -45,6 +47,9 @@ int faiss_read_index(FILE* f, int io_flags, FaissIndex** p_out);
*/
int faiss_read_index_fname(const char* fname, int io_flags, FaissIndex** p_out);

int faiss_read_index_buf(const unsigned char* buf, int limit, int io_flags,
FaissIndex** p_out);

/** Write index to a file.
* This is equivalent to `faiss::write_index_binary` when a file descriptor is
* provided.
Expand Down