milvus/internal/core/src/storage/MinioChunkManager.cpp
zhagnlu 02a8a07322
Fix BucketExists bug in minio chunk manager (#19548) (#19854)
Signed-off-by: zhagnlu <lu.zhang@zilliz.com>

Signed-off-by: zhagnlu <lu.zhang@zilliz.com>
Co-authored-by: zhagnlu <lu.zhang@zilliz.com>
2022-10-20 10:23:27 +08:00

351 lines
12 KiB
C++

// Licensed to the LF AI & Data foundation under one
// or more contributor license agreements. See the NOTICE file
// distributed with this work for additional information
// regarding copyright ownership. The ASF licenses this file
// to you under the Apache License, Version 2.0 (the
// "License"); you may not use this file except in compliance
// with the License. You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
#include <fstream>
#include <aws/core/auth/AWSCredentials.h>
#include <aws/core/auth/AWSCredentialsProviderChain.h>
#include <aws/core/auth/STSCredentialsProvider.h>
#include <aws/s3/model/CreateBucketRequest.h>
#include <aws/s3/model/DeleteBucketRequest.h>
#include <aws/s3/model/HeadBucketRequest.h>
#include <aws/s3/model/DeleteObjectRequest.h>
#include <aws/s3/model/HeadObjectRequest.h>
#include <aws/s3/model/ListObjectsRequest.h>
#include <aws/s3/model/GetObjectRequest.h>
#include <aws/s3/model/PutObjectRequest.h>
#include "MinioChunkManager.h"
#include "log/Log.h"
#define THROWS3ERROR(FUNCTION) \
do { \
auto& err = outcome.GetError(); \
std::stringstream err_msg; \
err_msg << "Error:" << #FUNCTION << ":" << err.GetExceptionName() << " " << err.GetMessage(); \
throw S3ErrorException(err_msg.str()); \
} while (0)
#define S3NoSuchBucket "NoSuchBucket"
namespace milvus::storage {
std::atomic<size_t> MinioChunkManager::init_count_(0);
/**
* @brief convert std::string to Aws::String
* because Aws has String type internally
* but has a copy of string content unfortunately
* TODO: remove this convert
* @param str
* @return Aws::String
*/
inline Aws::String
ConvertToAwsString(const std::string& str) {
return Aws::String(str.c_str(), str.size());
}
/**
* @brief convert Aws::string to std::string
* @param aws_str
* @return std::string
*/
inline std::string
ConvertFromAwsString(const Aws::String& aws_str) {
return std::string(aws_str.c_str(), aws_str.size());
}
MinioChunkManager::MinioChunkManager(const StorageConfig& storage_config)
: default_bucket_name_(storage_config.bucket_name) {
const size_t initCount = init_count_++;
if (initCount == 0) {
Aws::InitAPI(sdk_options_);
}
Aws::Client::ClientConfiguration config;
config.endpointOverride = ConvertToAwsString(storage_config.address);
if (storage_config.useSSL) {
config.scheme = Aws::Http::Scheme::HTTPS;
config.verifySSL = true;
} else {
config.scheme = Aws::Http::Scheme::HTTP;
config.verifySSL = false;
}
if (storage_config.useIAM) {
auto provider = std::make_shared<Aws::Auth::DefaultAWSCredentialsProviderChain>();
client_ = std::make_shared<Aws::S3::S3Client>(provider, config,
Aws::Client::AWSAuthV4Signer::PayloadSigningPolicy::Never, false);
LOG_SEGCORE_INFO_C << "use iam mode, credentials{ access_id:"
<< provider->GetAWSCredentials().GetAWSAccessKeyId()
<< " access_key:" << provider->GetAWSCredentials().GetAWSSecretKey()
<< " token:" << provider->GetAWSCredentials().GetSessionToken() << "}";
} else {
client_ = std::make_shared<Aws::S3::S3Client>(
Aws::Auth::AWSCredentials(ConvertToAwsString(storage_config.access_key_id),
ConvertToAwsString(storage_config.access_key_value)),
config, Aws::Client::AWSAuthV4Signer::PayloadSigningPolicy::Never, false);
}
if (!BucketExists(storage_config.bucket_name)) {
CreateBucket(storage_config.bucket_name);
}
LOG_SEGCORE_INFO_C << "init MinioChunkManager with parameter[endpoint: '" << storage_config.address
<< "', access_key:'" << storage_config.access_key_id << "', access_value:'"
<< storage_config.access_key_value << "', default_bucket_name:'" << storage_config.bucket_name
<< "', use_secure:'" << std::boolalpha << storage_config.useSSL << "']";
}
MinioChunkManager::~MinioChunkManager() {
const size_t initCount = --init_count_;
if (initCount == 0) {
Aws::ShutdownAPI(sdk_options_);
}
client_.reset();
}
uint64_t
MinioChunkManager::Size(const std::string& filepath) {
return GetObjectSize(default_bucket_name_, filepath);
}
bool
MinioChunkManager::Exist(const std::string& filepath) {
return ObjectExists(default_bucket_name_, filepath);
}
void
MinioChunkManager::Remove(const std::string& filepath) {
DeleteObject(default_bucket_name_, filepath);
}
std::vector<std::string>
MinioChunkManager::ListWithPrefix(const std::string& filepath) {
return ListObjects(default_bucket_name_.c_str(), filepath.c_str());
}
uint64_t
MinioChunkManager::Read(const std::string& filepath, void* buf, uint64_t size) {
if (!ObjectExists(default_bucket_name_, filepath)) {
std::stringstream err_msg;
err_msg << "object('" << default_bucket_name_ << "', " << filepath << "') not exists";
throw ObjectNotExistException(err_msg.str());
}
return GetObjectBuffer(default_bucket_name_, filepath, buf, size);
}
void
MinioChunkManager::Write(const std::string& filepath, void* buf, uint64_t size) {
PutObjectBuffer(default_bucket_name_, filepath, buf, size);
}
bool
MinioChunkManager::BucketExists(const std::string& bucket_name) {
// auto outcome = client_->ListBuckets();
// if (!outcome.IsSuccess()) {
// THROWS3ERROR(BucketExists);
// }
// for (auto&& b : outcome.GetResult().GetBuckets()) {
// if (ConvertFromAwsString(b.GetName()) == bucket_name) {
// return true;
// }
// }
Aws::S3::Model::HeadBucketRequest request;
request.SetBucket(bucket_name.c_str());
auto outcome = client_->HeadBucket(request);
if (!outcome.IsSuccess()) {
auto error = outcome.GetError();
if (!error.GetExceptionName().empty()) {
std::stringstream err_msg;
err_msg << "Error: BucketExists: " << error.GetExceptionName() + " - " + error.GetMessage();
throw S3ErrorException(err_msg.str());
}
return false;
}
return true;
}
std::vector<std::string>
MinioChunkManager::ListBuckets() {
std::vector<std::string> buckets;
auto outcome = client_->ListBuckets();
if (!outcome.IsSuccess()) {
THROWS3ERROR(CreateBucket);
}
for (auto&& b : outcome.GetResult().GetBuckets()) {
buckets.emplace_back(b.GetName().c_str());
}
return buckets;
}
bool
MinioChunkManager::CreateBucket(const std::string& bucket_name) {
Aws::S3::Model::CreateBucketRequest request;
request.SetBucket(bucket_name.c_str());
auto outcome = client_->CreateBucket(request);
if (!outcome.IsSuccess() &&
Aws::S3::S3Errors(outcome.GetError().GetErrorType()) != Aws::S3::S3Errors::BUCKET_ALREADY_OWNED_BY_YOU) {
THROWS3ERROR(CreateBucket);
}
return true;
}
bool
MinioChunkManager::DeleteBucket(const std::string& bucket_name) {
Aws::S3::Model::DeleteBucketRequest request;
request.SetBucket(bucket_name.c_str());
auto outcome = client_->DeleteBucket(request);
if (!outcome.IsSuccess()) {
auto err = outcome.GetError();
if (err.GetExceptionName() != S3NoSuchBucket) {
THROWS3ERROR(DeleteBucket);
}
return false;
}
return true;
}
bool
MinioChunkManager::ObjectExists(const std::string& bucket_name, const std::string& object_name) {
Aws::S3::Model::HeadObjectRequest request;
request.SetBucket(bucket_name.c_str());
request.SetKey(object_name.c_str());
auto outcome = client_->HeadObject(request);
if (!outcome.IsSuccess()) {
auto& err = outcome.GetError();
if (!err.GetExceptionName().empty()) {
std::stringstream err_msg;
err_msg << "Error: ObjectExists: " << err.GetMessage();
throw S3ErrorException(err_msg.str());
}
return false;
}
return true;
}
int64_t
MinioChunkManager::GetObjectSize(const std::string& bucket_name, const std::string& object_name) {
Aws::S3::Model::HeadObjectRequest request;
request.SetBucket(bucket_name.c_str());
request.SetKey(object_name.c_str());
auto outcome = client_->HeadObject(request);
if (!outcome.IsSuccess()) {
THROWS3ERROR(GetObjectSize);
}
return outcome.GetResult().GetContentLength();
}
bool
MinioChunkManager::DeleteObject(const std::string& bucket_name, const std::string& object_name) {
Aws::S3::Model::DeleteObjectRequest request;
request.SetBucket(bucket_name.c_str());
request.SetKey(object_name.c_str());
auto outcome = client_->DeleteObject(request);
if (!outcome.IsSuccess()) {
// auto err = outcome.GetError();
// std::stringstream err_msg;
// err_msg << "Error: DeleteObject:" << err.GetMessage();
// throw S3ErrorException(err_msg.str());
THROWS3ERROR(DeleteObject);
}
return true;
}
bool
MinioChunkManager::PutObjectBuffer(const std::string& bucket_name,
const std::string& object_name,
void* buf,
uint64_t size) {
Aws::S3::Model::PutObjectRequest request;
request.SetBucket(bucket_name.c_str());
request.SetKey(object_name.c_str());
const std::shared_ptr<Aws::IOStream> input_data = Aws::MakeShared<Aws::StringStream>("");
input_data->write(reinterpret_cast<char*>(buf), size);
request.SetBody(input_data);
auto outcome = client_->PutObject(request);
if (!outcome.IsSuccess()) {
THROWS3ERROR(PutObjectBuffer);
}
return true;
}
uint64_t
MinioChunkManager::GetObjectBuffer(const std::string& bucket_name,
const std::string& object_name,
void* buf,
uint64_t size) {
Aws::S3::Model::GetObjectRequest request;
request.SetBucket(bucket_name.c_str());
request.SetKey(object_name.c_str());
auto outcome = client_->GetObject(request);
if (!outcome.IsSuccess()) {
THROWS3ERROR(GetObjectBuffer);
}
std::stringstream ss;
ss << outcome.GetResultWithOwnership().GetBody().rdbuf();
uint64_t realSize = size;
if (ss.str().size() <= size) {
memcpy(buf, ss.str().data(), ss.str().size());
realSize = ss.str().size();
} else {
memcpy(buf, ss.str().data(), size);
}
return realSize;
}
std::vector<std::string>
MinioChunkManager::ListObjects(const char* bucket_name, const char* prefix) {
std::vector<std::string> objects_vec;
Aws::S3::Model::ListObjectsRequest request;
request.WithBucket(bucket_name);
if (prefix != NULL) {
request.SetPrefix(prefix);
}
auto outcome = client_->ListObjects(request);
if (!outcome.IsSuccess()) {
THROWS3ERROR(ListObjects);
}
auto objects = outcome.GetResult().GetContents();
for (auto& obj : objects) {
objects_vec.emplace_back(obj.GetKey().c_str());
}
return objects_vec;
}
} // namespace milvus::storage