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.

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

Jump to bottom

fix(rest): promote buffer curl reads from to member variable #14732

Merged
merged 1 commit into from
Sep 26, 2024
Merged

fix(rest): promote buffer curl reads from to member variable #14732

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
43 changes: 8 additions & 35 deletions google/cloud/internal/curl_impl.cc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -114,12 +114,6 @@ static std::size_t ReadFunction( // NOLINT(misc-use-anonymous-namespace)
return writev->MoveTo(absl::MakeSpan(buffer, size * nitems));
}

// Instead of trying to send any more bytes from userdata, aborts.
static std::size_t ReadFunctionAbort( // NOLINT(misc-use-anonymous-namespace)
char*, std::size_t, std::size_t, void*) {
return CURL_READFUNC_ABORT;
}

static int SeekFunction( // NOLINT(misc-use-anonymous-namespace)
void* userdata, curl_off_t offset, int origin) {
auto* const writev = reinterpret_cast<WriteVector*>(userdata);
Expand Down Expand Up @@ -366,8 +360,8 @@ Status CurlImpl::MakeRequest(HttpMethod method, RestContext& context,
}

if (method == HttpMethod::kPost) {
WriteVector writev{std::move(request)};
curl_off_t const size = writev.size();
writev_ = WriteVector{std::move(request)};
curl_off_t const size = writev_.size();
status = handle_.SetOption(CURLOPT_POSTFIELDS, nullptr);
if (!status.ok()) return OnTransferError(context, std::move(status));
status = handle_.SetOption(CURLOPT_POST, 1L);
Expand All @@ -376,26 +370,26 @@ Status CurlImpl::MakeRequest(HttpMethod method, RestContext& context,
if (!status.ok()) return OnTransferError(context, std::move(status));
status = handle_.SetOption(CURLOPT_READFUNCTION, &ReadFunction);
if (!status.ok()) return OnTransferError(context, std::move(status));
status = handle_.SetOption(CURLOPT_READDATA, &writev);
status = handle_.SetOption(CURLOPT_READDATA, &writev_);
if (!status.ok()) return OnTransferError(context, std::move(status));
status = handle_.SetOption(CURLOPT_SEEKFUNCTION, &SeekFunction);
if (!status.ok()) return OnTransferError(context, std::move(status));
status = handle_.SetOption(CURLOPT_SEEKDATA, &writev);
status = handle_.SetOption(CURLOPT_SEEKDATA, &writev_);
if (!status.ok()) return OnTransferError(context, std::move(status));
SetHeader("Expect:");
return MakeRequestImpl(context);
}

if (method == HttpMethod::kPut || method == HttpMethod::kPatch) {
WriteVector writev{std::move(request)};
curl_off_t const size = writev.size();
writev_ = WriteVector{std::move(request)};
curl_off_t const size = writev_.size();
status = handle_.SetOption(CURLOPT_READFUNCTION, &ReadFunction);
if (!status.ok()) return OnTransferError(context, std::move(status));
status = handle_.SetOption(CURLOPT_READDATA, &writev);
status = handle_.SetOption(CURLOPT_READDATA, &writev_);
if (!status.ok()) return OnTransferError(context, std::move(status));
status = handle_.SetOption(CURLOPT_SEEKFUNCTION, &SeekFunction);
if (!status.ok()) return OnTransferError(context, std::move(status));
status = handle_.SetOption(CURLOPT_SEEKDATA, &writev);
status = handle_.SetOption(CURLOPT_SEEKDATA, &writev_);
if (!status.ok()) return OnTransferError(context, std::move(status));
status = handle_.SetOption(CURLOPT_UPLOAD, 1L);
if (!status.ok()) return OnTransferError(context, std::move(status));
Expand Down Expand Up @@ -487,22 +481,6 @@ std::size_t CurlImpl::HeaderCallback(absl::Span<char> response) {
response.size());
}

class CurlImpl::ReadFunctionAbortGuard {
public:
explicit ReadFunctionAbortGuard(CurlImpl& impl) : impl_(impl) {}
~ReadFunctionAbortGuard() {
// If curl_closed_ is true, then the handle has already been recycled and
// attempting to set an option on it will error.
if (!impl_.curl_closed_) {
impl_.handle_.SetOptionUnchecked(CURLOPT_READFUNCTION,
&ReadFunctionAbort);
}
}

private:
CurlImpl& impl_;
};

Status CurlImpl::MakeRequestImpl(RestContext& context) {
TRACE_STATE() << ", url_=" << url_;

Expand All @@ -525,11 +503,6 @@ Status CurlImpl::MakeRequestImpl(RestContext& context) {
handle_.SetOptionUnchecked(CURLOPT_HTTP_VERSION,
VersionToCurlCode(http_version_));

// All data in the WriteVector should be written after ReadImpl returns unless
// an error, typically a timeout, has occurred. Use ReadFunctionAbortGuard to
// leverage RAII to instruct curl to not attempt to send anymore data on this
// handle regardless if an error or exception is encountered.
ReadFunctionAbortGuard guard(*this);
auto error = curl_multi_add_handle(multi_.get(), handle_.handle_.get());

// This indicates that we are using the API incorrectly. The application
Expand Down
5 changes: 5 additions & 0 deletions google/cloud/internal/curl_impl.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@
#include "google/cloud/internal/curl_handle.h"
#include "google/cloud/internal/curl_handle_factory.h"
#include "google/cloud/internal/curl_wrappers.h"
#include "google/cloud/internal/curl_writev.h"
#include "google/cloud/internal/rest_context.h"
#include "google/cloud/internal/rest_request.h"
#include "google/cloud/internal/rest_response.h"
Expand Down Expand Up @@ -171,6 +172,10 @@ class CurlImpl {
// Track when status and headers from the response are received.
bool all_headers_received_ = false;

// writev_ is a member variable in order to ensure that its lifetime remains
// valid even if libcurl is interrupted when trying to send data.
WriteVector writev_;

// Track the unused portion of the output buffer provided to Read().
absl::Span<char> avail_;

Expand Down
1 change: 1 addition & 0 deletions google/cloud/internal/curl_writev.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@ GOOGLE_CLOUD_CPP_INLINE_NAMESPACE_BEGIN
// Vector of data chunks to satisfy requests from libcurl.
class WriteVector {
public:
WriteVector() = default;
explicit WriteVector(std::vector<absl::Span<char const>> v)
: original_(std::move(v)), writev_(original_.begin(), original_.end()) {}

Expand Down
Loading