Skip to content

Optimize mixer client by using protobuf arena allocator. #1977

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
istio-testing merged 4 commits into from
Sep 17, 2018
Merged

Optimize mixer client by using protobuf arena allocator. #1977

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
54aa6ea
use arena 1st draft
qiwzhang Sep 14, 2018
c9ed067
use arena for check proto
qiwzhang Sep 15, 2018
918d553
use arena for report proto
qiwzhang Sep 15, 2018
9ac573f
update api sha
qiwzhang Sep 17, 2018
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
2 changes: 1 addition & 1 deletion repositories.bzl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -113,7 +113,7 @@ cc_library(
actual = "@googletest_git//:googletest_prod",
)

ISTIO_API = "214c7598afb74f7f4dea49f77e45832c49382a15"
ISTIO_API = "62c345bd6d6e4c2047dd2dee128b7413231be7b4"

def mixerapi_repositories(bind=True):
BUILD = """
Expand Down
10 changes: 5 additions & 5 deletions src/istio/control/client_context_base.cc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,7 @@ CancelFunc ClientContextBase::SendCheck(TransportCheckFunc transport,
// save the check status code
request->check_status = check_response_info.response_status;

utils::AttributesBuilder builder(&request->attributes);
utils::AttributesBuilder builder(request->attributes);
builder.AddBool(utils::AttributeName::kCheckCacheHit,
check_response_info.is_check_cache_hit);
builder.AddBool(utils::AttributeName::kQuotaCacheHit,
Expand All @@ -100,16 +100,16 @@ CancelFunc ClientContextBase::SendCheck(TransportCheckFunc transport,

// TODO: add debug message
// GOOGLE_LOG(INFO) << "Check attributes: " <<
// request->attributes.DebugString();
return mixer_client_->Check(request->attributes, request->quotas, transport,
// request->attributes->DebugString();
return mixer_client_->Check(*request->attributes, request->quotas, transport,
local_on_done);
}

void ClientContextBase::SendReport(const RequestContext& request) {
// TODO: add debug message
// GOOGLE_LOG(INFO) << "Report attributes: " <<
// request.attributes.DebugString();
mixer_client_->Report(request.attributes);
// request.attributes->DebugString();
mixer_client_->Report(*request.attributes);
}

void ClientContextBase::GetStatistics(Statistics* stat) const {
Expand Down
10 changes: 5 additions & 5 deletions src/istio/control/http/attributes_builder.cc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ const std::set<std::string> kGrpcContentTypes{
} // namespace

void AttributesBuilder::ExtractRequestHeaderAttributes(CheckData *check_data) {
utils::AttributesBuilder builder(&request_->attributes);
utils::AttributesBuilder builder(request_->attributes);
std::map<std::string, std::string> headers = check_data->GetRequestHeaders();
builder.AddStringMap(utils::AttributeName::kRequestHeaders, headers);

Expand Down Expand Up @@ -79,7 +79,7 @@ void AttributesBuilder::ExtractRequestHeaderAttributes(CheckData *check_data) {
}

void AttributesBuilder::ExtractAuthAttributes(CheckData *check_data) {
utils::AttributesBuilder builder(&request_->attributes);
utils::AttributesBuilder builder(request_->attributes);

std::string destination_principal;
if (check_data->GetPrincipal(false, &destination_principal)) {
Expand Down Expand Up @@ -132,7 +132,7 @@ void AttributesBuilder::ExtractForwardedAttributes(CheckData *check_data) {
}
Attributes v2_format;
if (v2_format.ParseFromString(forwarded_data)) {
request_->attributes.MergeFrom(v2_format);
request_->attributes->MergeFrom(v2_format);
return;
}
}
Expand All @@ -141,7 +141,7 @@ void AttributesBuilder::ExtractCheckAttributes(CheckData *check_data) {
ExtractRequestHeaderAttributes(check_data);
ExtractAuthAttributes(check_data);

utils::AttributesBuilder builder(&request_->attributes);
utils::AttributesBuilder builder(request_->attributes);

// connection remote IP is always reported as origin IP
std::string source_ip;
Expand Down Expand Up @@ -181,7 +181,7 @@ void AttributesBuilder::ForwardAttributes(const Attributes &forward_attributes,
}

void AttributesBuilder::ExtractReportAttributes(ReportData *report_data) {
utils::AttributesBuilder builder(&request_->attributes);
utils::AttributesBuilder builder(request_->attributes);

std::string dest_ip;
int dest_port;
Expand Down
14 changes: 7 additions & 7 deletions src/istio/control/http/attributes_builder_test.cc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -517,13 +517,13 @@ fields {

void ClearContextTime(const std::string &name, RequestContext *request) {
// Override timestamp with -
utils::AttributesBuilder builder(&request->attributes);
utils::AttributesBuilder builder(request->attributes);
std::chrono::time_point<std::chrono::system_clock> time0;
builder.AddTimestamp(name, time0);
}

void SetDestinationIp(RequestContext *request, const std::string &ip) {
utils::AttributesBuilder builder(&request->attributes);
utils::AttributesBuilder builder(request->attributes);
builder.AddBytes(utils::AttributeName::kDestinationIp, ip);
}

Expand All @@ -541,7 +541,7 @@ TEST(AttributesBuilderTest, TestExtractForwardedAttributes) {
RequestContext request;
AttributesBuilder builder(&request);
builder.ExtractForwardedAttributes(&mock_data);
EXPECT_THAT(request.attributes, EqualsAttribute(attr));
EXPECT_THAT(*request.attributes, EqualsAttribute(attr));
}

TEST(AttributesBuilderTest, TestForwardAttributes) {
Expand Down Expand Up @@ -631,7 +631,7 @@ TEST(AttributesBuilderTest, TestCheckAttributesWithoutAuthnFilter) {
Attributes expected_attributes;
ASSERT_TRUE(TextFormat::ParseFromString(kCheckAttributesWithoutAuthnFilter,
&expected_attributes));
EXPECT_THAT(request.attributes, EqualsAttribute(expected_attributes));
EXPECT_THAT(*request.attributes, EqualsAttribute(expected_attributes));
}

TEST(AttributesBuilderTest, TestCheckAttributes) {
Expand Down Expand Up @@ -705,7 +705,7 @@ TEST(AttributesBuilderTest, TestCheckAttributes) {
Attributes expected_attributes;
ASSERT_TRUE(
TextFormat::ParseFromString(kCheckAttributes, &expected_attributes));
EXPECT_THAT(request.attributes, EqualsAttribute(expected_attributes));
EXPECT_THAT(*request.attributes, EqualsAttribute(expected_attributes));
}

TEST(AttributesBuilderTest, TestReportAttributes) {
Expand Down Expand Up @@ -769,7 +769,7 @@ TEST(AttributesBuilderTest, TestReportAttributes) {
(*expected_attributes
.mutable_attributes())[utils::AttributeName::kResponseGrpcMessage]
.set_string_value("grpc-message");
EXPECT_THAT(request.attributes, EqualsAttribute(expected_attributes));
EXPECT_THAT(*request.attributes, EqualsAttribute(expected_attributes));
}

TEST(AttributesBuilderTest, TestReportAttributesWithDestIP) {
Expand Down Expand Up @@ -816,7 +816,7 @@ TEST(AttributesBuilderTest, TestReportAttributesWithDestIP) {
Attributes expected_attributes;
ASSERT_TRUE(
TextFormat::ParseFromString(kReportAttributes, &expected_attributes));
EXPECT_THAT(request.attributes, EqualsAttribute(expected_attributes));
EXPECT_THAT(*request.attributes, EqualsAttribute(expected_attributes));
}

} // namespace
Expand Down
13 changes: 7 additions & 6 deletions src/istio/control/http/service_context.cc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,13 +52,14 @@ void ServiceContext::BuildParsers() {

// Add static mixer attributes.
void ServiceContext::AddStaticAttributes(RequestContext *request) const {
client_context_->AddLocalNodeAttributes(&request->attributes);
client_context_->AddLocalNodeAttributes(request->attributes);

if (client_context_->config().has_mixer_attributes()) {
request->attributes.MergeFrom(client_context_->config().mixer_attributes());
request->attributes->MergeFrom(
client_context_->config().mixer_attributes());
}
if (service_config_ && service_config_->has_mixer_attributes()) {
request->attributes.MergeFrom(service_config_->mixer_attributes());
request->attributes->MergeFrom(service_config_->mixer_attributes());
}
}

Expand Down Expand Up @@ -90,21 +91,21 @@ void ServiceContext::AddApiAttributes(CheckData *check_data,
std::string path;
if (check_data->FindHeaderByType(CheckData::HEADER_METHOD, &http_method) &&
check_data->FindHeaderByType(CheckData::HEADER_PATH, &path)) {
api_spec_parser_->AddAttributes(http_method, path, &request->attributes);
api_spec_parser_->AddAttributes(http_method, path, request->attributes);
}

std::string api_key;
if (api_spec_parser_->ExtractApiKey(check_data, &api_key)) {
(*request->attributes
.mutable_attributes())[utils::AttributeName::kRequestApiKey]
->mutable_attributes())[utils::AttributeName::kRequestApiKey]
.set_string_value(api_key);
}
}

// Add quota requirements from quota configs.
void ServiceContext::AddQuotas(RequestContext *request) const {
for (const auto &parser : quota_parsers_) {
parser->GetRequirements(request->attributes, &request->quotas);
parser->GetRequirements(*request->attributes, &request->quotas);
}
}

Expand Down
10 changes: 9 additions & 1 deletion src/istio/control/request_context.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@
#ifndef ISTIO_CONTROL_REQUEST_CONTEXT_H
#define ISTIO_CONTROL_REQUEST_CONTEXT_H

#include "google/protobuf/arena.h"
#include "google/protobuf/stubs/status.h"
#include "include/istio/quota_config/requirement.h"
#include "mixer/v1/attributes.pb.h"
Expand All @@ -27,8 +28,15 @@ namespace control {

// The context to hold request data for both HTTP and TCP.
struct RequestContext {
RequestContext() {
attributes =
google::protobuf::Arena::CreateMessage<::istio::mixer::v1::Attributes>(
&arena_);
}
// protobuf arena
google::protobuf::Arena arena_;
// The attributes for both Check and Report.
::istio::mixer::v1::Attributes attributes;
::istio::mixer::v1::Attributes* attributes;
// The quota requirements
std::vector<::istio::quota_config::Requirement> quotas;
// The check status.
Expand Down
4 changes: 2 additions & 2 deletions src/istio/control/tcp/attributes_builder.cc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ const std::string kConnectionClose("close");
} // namespace

void AttributesBuilder::ExtractCheckAttributes(CheckData* check_data) {
utils::AttributesBuilder builder(&request_->attributes);
utils::AttributesBuilder builder(request_->attributes);

std::string source_ip;
int source_port;
Expand Down Expand Up @@ -83,7 +83,7 @@ void AttributesBuilder::ExtractCheckAttributes(CheckData* check_data) {
void AttributesBuilder::ExtractReportAttributes(
ReportData* report_data, ReportData::ConnectionEvent event,
ReportData::ReportInfo* last_report_info) {
utils::AttributesBuilder builder(&request_->attributes);
utils::AttributesBuilder builder(request_->attributes);

ReportData::ReportInfo info;
report_data->GetReportInfo(&info);
Expand Down
24 changes: 12 additions & 12 deletions src/istio/control/tcp/attributes_builder_test.cc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -360,7 +360,7 @@ attributes {

void ClearContextTime(RequestContext* request) {
// Override timestamp with -
utils::AttributesBuilder builder(&request->attributes);
utils::AttributesBuilder builder(request->attributes);
std::chrono::time_point<std::chrono::system_clock> time0;
builder.AddTimestamp(utils::AttributeName::kContextTime, time0);
}
Expand Down Expand Up @@ -398,14 +398,14 @@ TEST(AttributesBuilderTest, TestCheckAttributes) {
ClearContextTime(&request);

std::string out_str;
TextFormat::PrintToString(request.attributes, &out_str);
TextFormat::PrintToString(*request.attributes, &out_str);
GOOGLE_LOG(INFO) << "===" << out_str << "===";

::istio::mixer::v1::Attributes expected_attributes;
ASSERT_TRUE(
TextFormat::ParseFromString(kCheckAttributes, &expected_attributes));
EXPECT_TRUE(
MessageDifferencer::Equals(request.attributes, expected_attributes));
MessageDifferencer::Equals(*request.attributes, expected_attributes));
}

TEST(AttributesBuilderTest, TestReportAttributes) {
Expand Down Expand Up @@ -459,14 +459,14 @@ TEST(AttributesBuilderTest, TestReportAttributes) {
ClearContextTime(&request);

std::string out_str;
TextFormat::PrintToString(request.attributes, &out_str);
TextFormat::PrintToString(*request.attributes, &out_str);
GOOGLE_LOG(INFO) << "===" << out_str << "===";

::istio::mixer::v1::Attributes expected_open_attributes;
ASSERT_TRUE(TextFormat::ParseFromString(kFirstReportAttributes,
&expected_open_attributes));
EXPECT_TRUE(
MessageDifferencer::Equals(request.attributes, expected_open_attributes));
EXPECT_TRUE(MessageDifferencer::Equals(*request.attributes,
expected_open_attributes));
EXPECT_EQ(0, last_report_info.received_bytes);
EXPECT_EQ(0, last_report_info.send_bytes);

Expand All @@ -475,13 +475,13 @@ TEST(AttributesBuilderTest, TestReportAttributes) {
&mock_data, ReportData::ConnectionEvent::CONTINUE, &last_report_info);
ClearContextTime(&request);

TextFormat::PrintToString(request.attributes, &out_str);
TextFormat::PrintToString(*request.attributes, &out_str);
GOOGLE_LOG(INFO) << "===" << out_str << "===";

::istio::mixer::v1::Attributes expected_delta_attributes;
ASSERT_TRUE(TextFormat::ParseFromString(kDeltaOneReportAttributes,
&expected_delta_attributes));
EXPECT_TRUE(MessageDifferencer::Equals(request.attributes,
EXPECT_TRUE(MessageDifferencer::Equals(*request.attributes,
expected_delta_attributes));
EXPECT_EQ(100, last_report_info.received_bytes);
EXPECT_EQ(200, last_report_info.send_bytes);
Expand All @@ -492,13 +492,13 @@ TEST(AttributesBuilderTest, TestReportAttributes) {
ClearContextTime(&request);

out_str.clear();
TextFormat::PrintToString(request.attributes, &out_str);
TextFormat::PrintToString(*request.attributes, &out_str);
GOOGLE_LOG(INFO) << "===" << out_str << "===";

expected_delta_attributes.Clear();
ASSERT_TRUE(TextFormat::ParseFromString(kDeltaTwoReportAttributes,
&expected_delta_attributes));
EXPECT_TRUE(MessageDifferencer::Equals(request.attributes,
EXPECT_TRUE(MessageDifferencer::Equals(*request.attributes,
expected_delta_attributes));
EXPECT_EQ(201, last_report_info.received_bytes);
EXPECT_EQ(404, last_report_info.send_bytes);
Expand All @@ -509,13 +509,13 @@ TEST(AttributesBuilderTest, TestReportAttributes) {
ClearContextTime(&request);

out_str.clear();
TextFormat::PrintToString(request.attributes, &out_str);
TextFormat::PrintToString(*request.attributes, &out_str);
GOOGLE_LOG(INFO) << "===" << out_str << "===";

::istio::mixer::v1::Attributes expected_final_attributes;
ASSERT_TRUE(TextFormat::ParseFromString(kReportAttributes,
&expected_final_attributes));
EXPECT_TRUE(MessageDifferencer::Equals(request.attributes,
EXPECT_TRUE(MessageDifferencer::Equals(*request.attributes,
expected_final_attributes));
}

Expand Down
6 changes: 3 additions & 3 deletions src/istio/control/tcp/client_context.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,17 +52,17 @@ class ClientContext : public ClientContextBase {

// Add static mixer attributes.
void AddStaticAttributes(RequestContext* request) const {
AddLocalNodeAttributes(&request->attributes);
AddLocalNodeAttributes(request->attributes);

if (config_.has_mixer_attributes()) {
request->attributes.MergeFrom(config_.mixer_attributes());
request->attributes->MergeFrom(config_.mixer_attributes());
}
}

// Add quota requirements from quota configs.
void AddQuotas(RequestContext* request) const {
if (quota_parser_) {
quota_parser_->GetRequirements(request->attributes, &request->quotas);
quota_parser_->GetRequirements(*request->attributes, &request->quotas);
}
}

Expand Down
22 changes: 14 additions & 8 deletions src/istio/mixerclient/attribute_compressor.cc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@
*/

#include "src/istio/mixerclient/attribute_compressor.h"
#include "google/protobuf/arena.h"
#include "include/istio/utils/protobuf.h"
#include "src/istio/mixerclient/global_dictionary.h"

Expand Down Expand Up @@ -126,31 +127,36 @@ void CompressByDict(const Attributes& attributes, MessageDictionary& dict,
class BatchCompressorImpl : public BatchCompressor {
public:
BatchCompressorImpl(const GlobalDictionary& global_dict)
: global_dict_(global_dict), dict_(global_dict) {}
: global_dict_(global_dict), dict_(global_dict) {
report_ = google::protobuf::Arena::CreateMessage<
::istio::mixer::v1::ReportRequest>(&arena_);
}

void Add(const Attributes& attributes) override {
CompressByDict(attributes, dict_, report_.add_attributes());
CompressByDict(attributes, dict_, report_->add_attributes());
}

int size() const override { return report_.attributes_size(); }
int size() const override { return report_->attributes_size(); }

const ::istio::mixer::v1::ReportRequest& Finish() override {
for (const std::string& word : dict_.GetWords()) {
report_.add_default_words(word);
report_->add_default_words(word);
}
report_.set_global_word_count(global_dict_.size());
return report_;
report_->set_global_word_count(global_dict_.size());
return *report_;
}

void Clear() override {
dict_.Clear();
report_.Clear();
report_->Clear();
}

private:
const GlobalDictionary& global_dict_;
// protobuf arena
google::protobuf::Arena arena_;
MessageDictionary dict_;
::istio::mixer::v1::ReportRequest report_;
::istio::mixer::v1::ReportRequest* report_;
};

} // namespace
Expand Down
Loading