grpc 1.42.0 → 1.45.0

data/src/core/lib/channel/promise_based_filter.h

@@ -0,0 +1,423 @@
+// Copyright 2022 gRPC authors.
+//
+// Licensed 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.
+
+#ifndef GRPC_CORE_LIB_CHANNEL_PROMISE_BASED_FILTER_H
+#define GRPC_CORE_LIB_CHANNEL_PROMISE_BASED_FILTER_H
+
+// Scaffolding to allow the per-call part of a filter to be authored in a
+// promise-style. Most of this will be removed once the promises conversion is
+// completed.
+
+#include <grpc/support/port_platform.h>
+
+#include "absl/utility/utility.h"
+
+#include <grpc/status.h>
+#include <grpc/support/log.h>
+
+#include "src/core/lib/channel/call_finalization.h"
+#include "src/core/lib/channel/channel_stack.h"
+#include "src/core/lib/channel/context.h"
+#include "src/core/lib/gprpp/debug_location.h"
+#include "src/core/lib/iomgr/error.h"
+#include "src/core/lib/promise/arena_promise.h"
+#include "src/core/lib/promise/context.h"
+#include "src/core/lib/promise/promise.h"
+#include "src/core/lib/transport/error_utils.h"
+
+namespace grpc_core {
+
+class ChannelFilter {
+ public:
+  class Args {
+   public:
+    Args() : Args(nullptr) {}
+    explicit Args(grpc_channel_stack* channel_stack)
+        : channel_stack_(channel_stack) {}
+
+    grpc_channel_stack* channel_stack() const { return channel_stack_; }
+
+   private:
+    friend class ChannelFilter;
+    grpc_channel_stack* channel_stack_;
+  };
+
+  // Construct a promise for one call.
+  virtual ArenaPromise<TrailingMetadata> MakeCallPromise(
+      ClientInitialMetadata initial_metadata,
+      NextPromiseFactory next_promise_factory) = 0;
+
+  // Start a legacy transport op
+  // Return true if the op was handled, false if it should be passed to the
+  // next filter.
+  // TODO(ctiller): design a new API for this - we probably don't want big op
+  // structures going forward.
+  virtual bool StartTransportOp(grpc_transport_op*) { return false; }
+
+ protected:
+  virtual ~ChannelFilter() = default;
+};
+
+// Designator for whether a filter is client side or server side.
+// Please don't use this outside calls to MakePromiseBasedFilter - it's intended
+// to be deleted once the promise conversion is complete.
+enum class FilterEndpoint {
+  kClient,
+  kServer,
+};
+
+namespace promise_filter_detail {
+
+// Call data shared between all implementations of promise-based filters.
+class BaseCallData : public Activity, private Wakeable {
+ public:
+  BaseCallData(grpc_call_element* elem, const grpc_call_element_args* args)
+      : call_stack_(args->call_stack),
+        elem_(elem),
+        arena_(args->arena),
+        call_combiner_(args->call_combiner),
+        deadline_(args->deadline),
+        context_(args->context) {}
+
+  void set_pollent(grpc_polling_entity* pollent) { pollent_ = pollent; }
+
+  // Activity implementation (partial).
+  void Orphan() final;
+  Waker MakeNonOwningWaker() final;
+  Waker MakeOwningWaker() final;
+
+  void Finalize(const grpc_call_final_info* final_info) {
+    finalization_.Run(final_info);
+  }
+
+ protected:
+  class ScopedContext
+      : public promise_detail::Context<Arena>,
+        public promise_detail::Context<grpc_call_context_element>,
+        public promise_detail::Context<grpc_polling_entity>,
+        public promise_detail::Context<CallFinalization> {
+   public:
+    explicit ScopedContext(BaseCallData* call_data)
+        : promise_detail::Context<Arena>(call_data->arena_),
+          promise_detail::Context<grpc_call_context_element>(
+              call_data->context_),
+          promise_detail::Context<grpc_polling_entity>(call_data->pollent_),
+          promise_detail::Context<CallFinalization>(&call_data->finalization_) {
+    }
+  };
+
+  static MetadataHandle<grpc_metadata_batch> WrapMetadata(
+      grpc_metadata_batch* p) {
+    return MetadataHandle<grpc_metadata_batch>(p);
+  }
+
+  static grpc_metadata_batch* UnwrapMetadata(
+      MetadataHandle<grpc_metadata_batch> p) {
+    return p.Unwrap();
+  }
+
+  grpc_call_element* elem() const { return elem_; }
+  CallCombiner* call_combiner() const { return call_combiner_; }
+  Timestamp deadline() const { return deadline_; }
+  grpc_call_stack* call_stack() const { return call_stack_; }
+
+ private:
+  // Wakeable implementation.
+  void Wakeup() final;
+  void Drop() final;
+
+  virtual void OnWakeup() = 0;
+
+  grpc_call_stack* const call_stack_;
+  grpc_call_element* const elem_;
+  Arena* const arena_;
+  CallCombiner* const call_combiner_;
+  const Timestamp deadline_;
+  CallFinalization finalization_;
+  grpc_call_context_element* const context_;
+  grpc_polling_entity* pollent_ = nullptr;
+};
+
+class ClientCallData : public BaseCallData {
+ public:
+  ClientCallData(grpc_call_element* elem, const grpc_call_element_args* args);
+  ~ClientCallData() override;
+
+  // Activity implementation.
+  void ForceImmediateRepoll() final;
+  // Handle one grpc_transport_stream_op_batch
+  void StartBatch(grpc_transport_stream_op_batch* batch);
+
+ private:
+  // At what stage is our handling of send initial metadata?
+  enum class SendInitialState {
+    // Start state: no op seen
+    kInitial,
+    // We've seen the op, and started the promise in response to it, but have
+    // not yet sent the op to the next filter.
+    kQueued,
+    // We've sent the op to the next filter.
+    kForwarded,
+    // We were cancelled.
+    kCancelled
+  };
+  // At what stage is our handling of recv trailing metadata?
+  enum class RecvTrailingState {
+    // Start state: no op seen
+    kInitial,
+    // We saw the op, and since it was bundled with send initial metadata, we
+    // queued it until the send initial metadata can be sent to the next filter.
+    kQueued,
+    // We've forwarded the op to the next filter.
+    kForwarded,
+    // The op has completed from below, but we haven't yet forwarded it up (the
+    // promise gets to interject and mutate it).
+    kComplete,
+    // We've called the recv_metadata_ready callback from the original
+    // recv_trailing_metadata op that was presented to us.
+    kResponded,
+    // We've been cancelled and handled that locally.
+    // (i.e. whilst the recv_trailing_metadata op is queued in this filter).
+    kCancelled
+  };
+
+  // Handle cancellation.
+  void Cancel(grpc_error_handle error);
+  // Begin running the promise - which will ultimately take some initial
+  // metadata and return some trailing metadata.
+  void StartPromise();
+  // Interject our callback into the op batch for recv trailing metadata ready.
+  // Stash a pointer to the trailing metadata that will be filled in, so we can
+  // manipulate it later.
+  void HookRecvTrailingMetadata(grpc_transport_stream_op_batch* batch);
+  // Construct a promise that will "call" the next filter.
+  // Effectively:
+  //   - put the modified initial metadata into the batch to be sent down.
+  //   - return a wrapper around PollTrailingMetadata as the promise.
+  ArenaPromise<TrailingMetadata> MakeNextPromise(
+      ClientInitialMetadata initial_metadata);
+  // Wrapper to make it look like we're calling the next filter as a promise.
+  // First poll: send the send_initial_metadata op down the stack.
+  // All polls: await receiving the trailing metadata, then return it to the
+  // application.
+  Poll<TrailingMetadata> PollTrailingMetadata();
+  static void RecvTrailingMetadataReadyCallback(void* arg,
+                                                grpc_error_handle error);
+  void RecvTrailingMetadataReady(grpc_error_handle error);
+  // Given an error, fill in TrailingMetadata to represent that error.
+  void SetStatusFromError(grpc_metadata_batch* metadata,
+                          grpc_error_handle error);
+  // Wakeup and poll the promise if appropriate.
+  void WakeInsideCombiner();
+  void OnWakeup() override;
+
+  // Contained promise
+  ArenaPromise<TrailingMetadata> promise_;
+  // Queued batch containing at least a send_initial_metadata op.
+  grpc_transport_stream_op_batch* send_initial_metadata_batch_ = nullptr;
+  // Pointer to where trailing metadata will be stored.
+  grpc_metadata_batch* recv_trailing_metadata_ = nullptr;
+  // Closure to call when we're done with the trailing metadata.
+  grpc_closure* original_recv_trailing_metadata_ready_ = nullptr;
+  // Our closure pointing to RecvTrailingMetadataReadyCallback.
+  grpc_closure recv_trailing_metadata_ready_;
+  // Error received during cancellation.
+  grpc_error_handle cancelled_error_ = GRPC_ERROR_NONE;
+  // State of the send_initial_metadata op.
+  SendInitialState send_initial_state_ = SendInitialState::kInitial;
+  // State of the recv_trailing_metadata op.
+  RecvTrailingState recv_trailing_state_ = RecvTrailingState::kInitial;
+  // Whether we're currently polling the promise.
+  bool is_polling_ = false;
+  // Should we repoll after completing polling?
+  bool repoll_ = false;
+  // Whether we should forward send initial metadata after polling?
+  bool forward_send_initial_metadata_ = false;
+};
+
+class ServerCallData : public BaseCallData {
+ public:
+  ServerCallData(grpc_call_element* elem, const grpc_call_element_args* args);
+  ~ServerCallData() override;
+
+  // Activity implementation.
+  void ForceImmediateRepoll() final;
+  // Handle one grpc_transport_stream_op_batch
+  void StartBatch(grpc_transport_stream_op_batch* batch);
+
+ private:
+  // At what stage is our handling of recv initial metadata?
+  enum class RecvInitialState {
+    // Start state: no op seen
+    kInitial,
+    // Op seen, and forwarded to the next filter.
+    // Now waiting for the callback.
+    kForwarded,
+    // The op has completed from below, but we haven't yet forwarded it up
+    // (the promise gets to interject and mutate it).
+    kComplete,
+    // We've sent the response to the next filter up.
+    kResponded,
+  };
+  // At what stage is our handling of send trailing metadata?
+  enum class SendTrailingState {
+    // Start state: no op seen
+    kInitial,
+    // We saw the op, and are waiting for the promise to complete
+    // to forward it.
+    kQueued,
+    // We've forwarded the op to the next filter.
+    kForwarded,
+    // We were cancelled.
+    kCancelled
+  };
+
+  // Handle cancellation.
+  void Cancel(grpc_error_handle error);
+  // Construct a promise that will "call" the next filter.
+  // Effectively:
+  //   - put the modified initial metadata into the batch being sent up.
+  //   - return a wrapper around PollTrailingMetadata as the promise.
+  ArenaPromise<TrailingMetadata> MakeNextPromise(
+      ClientInitialMetadata initial_metadata);
+  // Wrapper to make it look like we're calling the next filter as a promise.
+  // All polls: await sending the trailing metadata, then foward it down the
+  // stack.
+  Poll<TrailingMetadata> PollTrailingMetadata();
+  static void RecvInitialMetadataReadyCallback(void* arg,
+                                               grpc_error_handle error);
+  void RecvInitialMetadataReady(grpc_error_handle error);
+  // Wakeup and poll the promise if appropriate.
+  void WakeInsideCombiner(absl::FunctionRef<void(grpc_error_handle)> cancel);
+  void OnWakeup() override;
+
+  // Contained promise
+  ArenaPromise<TrailingMetadata> promise_;
+  // Pointer to where initial metadata will be stored.
+  grpc_metadata_batch* recv_initial_metadata_ = nullptr;
+  // Closure to call when we're done with the trailing metadata.
+  grpc_closure* original_recv_initial_metadata_ready_ = nullptr;
+  // Our closure pointing to RecvInitialMetadataReadyCallback.
+  grpc_closure recv_initial_metadata_ready_;
+  // Error received during cancellation.
+  grpc_error_handle cancelled_error_ = GRPC_ERROR_NONE;
+  // Trailing metadata batch
+  grpc_transport_stream_op_batch* send_trailing_metadata_batch_ = nullptr;
+  // State of the send_initial_metadata op.
+  RecvInitialState recv_initial_state_ = RecvInitialState::kInitial;
+  // State of the recv_trailing_metadata op.
+  SendTrailingState send_trailing_state_ = SendTrailingState::kInitial;
+  // Whether we're currently polling the promise.
+  bool is_polling_ = false;
+  // Whether to forward the recv_initial_metadata op at the end of promise
+  // wakeup.
+  bool forward_recv_initial_metadata_callback_ = false;
+};
+
+// Specific call data per channel filter.
+// Note that we further specialize for clients and servers since their
+// implementations are very different.
+template <class ChannelFilter, FilterEndpoint endpoint>
+class CallData;
+
+// Client implementation of call data.
+template <class ChannelFilter>
+class CallData<ChannelFilter, FilterEndpoint::kClient> : public ClientCallData {
+ public:
+  using ClientCallData::ClientCallData;
+};
+
+// Server implementation of call data.
+template <class ChannelFilter>
+class CallData<ChannelFilter, FilterEndpoint::kServer> : public ServerCallData {
+ public:
+  using ServerCallData::ServerCallData;
+};
+
+}  // namespace promise_filter_detail
+
+// F implements ChannelFilter and :
+// class SomeChannelFilter : public ChannelFilter {
+//  public:
+//   static absl::StatusOr<SomeChannelFilter> Create(
+//       ChannelFilter::Args filter_args);
+// };
+// TODO(ctiller): allow implementing get_channel_info, start_transport_op in
+// some way on ChannelFilter.
+template <typename F, FilterEndpoint kEndpoint>
+absl::enable_if_t<std::is_base_of<ChannelFilter, F>::value, grpc_channel_filter>
+MakePromiseBasedFilter(const char* name) {
+  using CallData = promise_filter_detail::CallData<F, kEndpoint>;
+
+  return grpc_channel_filter{
+      // start_transport_stream_op_batch
+      [](grpc_call_element* elem, grpc_transport_stream_op_batch* batch) {
+        static_cast<CallData*>(elem->call_data)->StartBatch(batch);
+      },
+      // make_call_promise
+      [](grpc_channel_element* elem, ClientInitialMetadata initial_metadata,
+         NextPromiseFactory next_promise_factory) {
+        return static_cast<F*>(elem->channel_data)
+            ->MakeCallPromise(std::move(initial_metadata),
+                              std::move(next_promise_factory));
+      },
+      // start_transport_op
+      [](grpc_channel_element* elem, grpc_transport_op* op) {
+        if (!static_cast<F*>(elem->channel_data)->StartTransportOp(op)) {
+          grpc_channel_next_op(elem, op);
+        }
+      },
+      // sizeof_call_data
+      sizeof(CallData),
+      // init_call_elem
+      [](grpc_call_element* elem, const grpc_call_element_args* args) {
+        new (elem->call_data) CallData(elem, args);
+        return GRPC_ERROR_NONE;
+      },
+      // set_pollset_or_pollset_set
+      [](grpc_call_element* elem, grpc_polling_entity* pollent) {
+        static_cast<CallData*>(elem->call_data)->set_pollent(pollent);
+      },
+      // destroy_call_elem
+      [](grpc_call_element* elem, const grpc_call_final_info* final_info,
+         grpc_closure*) {
+        auto* cd = static_cast<CallData*>(elem->call_data);
+        cd->Finalize(final_info);
+        cd->~CallData();
+      },
+      // sizeof_channel_data
+      sizeof(F),
+      // init_channel_elem
+      [](grpc_channel_element* elem, grpc_channel_element_args* args) {
+        GPR_ASSERT(!args->is_last);
+        auto status = F::Create(args->channel_args,
+                                ChannelFilter::Args(args->channel_stack));
+        if (!status.ok()) return absl_status_to_grpc_error(status.status());
+        new (elem->channel_data) F(std::move(*status));
+        return GRPC_ERROR_NONE;
+      },
+      // destroy_channel_elem
+      [](grpc_channel_element* elem) {
+        static_cast<F*>(elem->channel_data)->~F();
+      },
+      // get_channel_info
+      grpc_channel_next_get_info,
+      // name
+      name,
+  };
+}
+
+}  // namespace grpc_core
+
+#endif  // GRPC_CORE_LIB_CHANNEL_PROMISE_BASED_FILTER_H

data/src/core/lib/compression/compression.cc

@@ -23,89 +23,47 @@
 
 #include <grpc/compression.h>
 
-#include "src/core/lib/compression/algorithm_metadata.h"
 #include "src/core/lib/compression/compression_internal.h"
 #include "src/core/lib/gpr/useful.h"
-#include "src/core/lib/slice/slice_utils.h"
+#include "src/core/lib/slice/slice_internal.h"
 #include "src/core/lib/surface/api_trace.h"
-#include "src/core/lib/transport/static_metadata.h"
 
-int grpc_compression_algorithm_is_message(
-    grpc_compression_algorithm algorithm) {
-  return (algorithm >= GRPC_COMPRESS_DEFLATE && algorithm <= GRPC_COMPRESS_GZIP)
-             ? 1
-             : 0;
+int grpc_compression_algorithm_is_message(grpc_compression_algorithm) {
+  return 1;
 }
 
-int grpc_compression_algorithm_is_stream(grpc_compression_algorithm algorithm) {
-  return (algorithm == GRPC_COMPRESS_STREAM_GZIP) ? 1 : 0;
+int grpc_compression_algorithm_is_stream(grpc_compression_algorithm) {
+  return 0;
 }
 
 int grpc_compression_algorithm_parse(grpc_slice name,
                                      grpc_compression_algorithm* algorithm) {
-  if (grpc_slice_eq_static_interned(name, GRPC_MDSTR_IDENTITY)) {
-    *algorithm = GRPC_COMPRESS_NONE;
-    return 1;
-  } else if (grpc_slice_eq_static_interned(name, GRPC_MDSTR_DEFLATE)) {
-    *algorithm = GRPC_COMPRESS_DEFLATE;
+  absl::optional<grpc_compression_algorithm> alg =
+      grpc_core::ParseCompressionAlgorithm(
+          grpc_core::StringViewFromSlice(name));
+  if (alg.has_value()) {
+    *algorithm = alg.value();
     return 1;
-  } else if (grpc_slice_eq_static_interned(name, GRPC_MDSTR_GZIP)) {
-    *algorithm = GRPC_COMPRESS_GZIP;
-    return 1;
-  } else if (grpc_slice_eq_static_interned(name,
-                                           GRPC_MDSTR_STREAM_SLASH_GZIP)) {
-    *algorithm = GRPC_COMPRESS_STREAM_GZIP;
-    return 1;
-  } else {
-    return 0;
   }
+  return 0;
 }
 
 int grpc_compression_algorithm_name(grpc_compression_algorithm algorithm,
                                     const char** name) {
   GRPC_API_TRACE("grpc_compression_algorithm_name(algorithm=%d, name=%p)", 2,
                  ((int)algorithm, name));
-  switch (algorithm) {
-    case GRPC_COMPRESS_NONE:
-      *name = "identity";
-      return 1;
-    case GRPC_COMPRESS_DEFLATE:
-      *name = "deflate";
-      return 1;
-    case GRPC_COMPRESS_GZIP:
-      *name = "gzip";
-      return 1;
-    case GRPC_COMPRESS_STREAM_GZIP:
-      *name = "stream/gzip";
-      return 1;
-    case GRPC_COMPRESS_ALGORITHMS_COUNT:
-      return 0;
+  const char* result = grpc_core::CompressionAlgorithmAsString(algorithm);
+  if (result != nullptr) {
+    *name = result;
+    return 1;
   }
   return 0;
 }
 
 grpc_compression_algorithm grpc_compression_algorithm_for_level(
     grpc_compression_level level, uint32_t accepted_encodings) {
-  grpc_compression_algorithm algo;
-  if (level == GRPC_COMPRESS_LEVEL_NONE) {
-    return GRPC_COMPRESS_NONE;
-  } else if (level <= GRPC_COMPRESS_LEVEL_HIGH) {
-    // TODO(mxyan): Design algorithm to select from all algorithms, including
-    // stream compression algorithm
-    if (!grpc_compression_algorithm_from_message_stream_compression_algorithm(
-            &algo,
-            grpc_message_compression_algorithm_for_level(
-                level,
-                grpc_compression_bitset_to_message_bitset(accepted_encodings)),
-            static_cast<grpc_stream_compression_algorithm>(0))) {
-      gpr_log(GPR_ERROR, "Parse compression level error");
-      return GRPC_COMPRESS_NONE;
-    }
-    return algo;
-  } else {
-    gpr_log(GPR_ERROR, "Unknown compression level: %d", level);
-    return GRPC_COMPRESS_NONE;
-  }
+  return grpc_core::CompressionAlgorithmSet::FromUint32(accepted_encodings)
+      .CompressionAlgorithmForLevel(level);
 }
 
 void grpc_compression_options_init(grpc_compression_options* opts) {
@@ -127,57 +85,7 @@ void grpc_compression_options_disable_algorithm(
 int grpc_compression_options_is_algorithm_enabled(
     const grpc_compression_options* opts,
     grpc_compression_algorithm algorithm) {
-  return grpc_compression_options_is_algorithm_enabled_internal(opts,
-                                                                algorithm);
-}
-
-grpc_slice grpc_compression_algorithm_slice(
-    grpc_compression_algorithm algorithm) {
-  switch (algorithm) {
-    case GRPC_COMPRESS_NONE:
-      return GRPC_MDSTR_IDENTITY;
-    case GRPC_COMPRESS_DEFLATE:
-      return GRPC_MDSTR_DEFLATE;
-    case GRPC_COMPRESS_GZIP:
-      return GRPC_MDSTR_GZIP;
-    case GRPC_COMPRESS_STREAM_GZIP:
-      return GRPC_MDSTR_STREAM_SLASH_GZIP;
-    case GRPC_COMPRESS_ALGORITHMS_COUNT:
-      return grpc_empty_slice();
-  }
-  return grpc_empty_slice();
-}
-
-grpc_compression_algorithm grpc_compression_algorithm_from_slice(
-    const grpc_slice& str) {
-  if (grpc_slice_eq_static_interned(str, GRPC_MDSTR_IDENTITY)) {
-    return GRPC_COMPRESS_NONE;
-  }
-  if (grpc_slice_eq_static_interned(str, GRPC_MDSTR_DEFLATE)) {
-    return GRPC_COMPRESS_DEFLATE;
-  }
-  if (grpc_slice_eq_static_interned(str, GRPC_MDSTR_GZIP)) {
-    return GRPC_COMPRESS_GZIP;
-  }
-  if (grpc_slice_eq_static_interned(str, GRPC_MDSTR_STREAM_SLASH_GZIP)) {
-    return GRPC_COMPRESS_STREAM_GZIP;
-  }
-  return GRPC_COMPRESS_ALGORITHMS_COUNT;
-}
-
-grpc_mdelem grpc_compression_encoding_mdelem(
-    grpc_compression_algorithm algorithm) {
-  switch (algorithm) {
-    case GRPC_COMPRESS_NONE:
-      return GRPC_MDELEM_GRPC_ENCODING_IDENTITY;
-    case GRPC_COMPRESS_DEFLATE:
-      return GRPC_MDELEM_GRPC_ENCODING_DEFLATE;
-    case GRPC_COMPRESS_GZIP:
-      return GRPC_MDELEM_GRPC_ENCODING_GZIP;
-    case GRPC_COMPRESS_STREAM_GZIP:
-      return GRPC_MDELEM_GRPC_ENCODING_GZIP;
-    default:
-      break;
-  }
-  return GRPC_MDNULL;
+  return grpc_core::CompressionAlgorithmSet::FromUint32(
+             opts->enabled_algorithms_bitset)
+      .IsSet(algorithm);
 }