couchbase 3.5.1 → 3.5.2

data/ext/couchbase/core/protocol/frame_info_utils.cxx

@@ -27,33 +27,36 @@ namespace couchbase::core::protocol
 {
 
 void
-add_durability_frame_info(std::vector<std::byte>& framing_extras, durability_level level, std::optional<std::uint16_t> timeout)
+add_durability_frame_info(std::vector<std::byte>& framing_extras,
+                          durability_level level,
+                          std::optional<std::uint16_t> timeout)
 {
-    const auto frame_id = static_cast<std::byte>(protocol::request_frame_info_id::durability_requirement);
-    const auto extras_old_size = framing_extras.size();
-    if (timeout) {
-        const std::byte frame_size{ 3 /* 1 for level + 2 for timeout */ };
-        framing_extras.resize(extras_old_size + 1 + static_cast<std::size_t>(frame_size));
-        framing_extras[extras_old_size + 0] = (frame_id << 4U) | frame_size;
-        framing_extras[extras_old_size + 1] = static_cast<std::byte>(level);
-        std::uint16_t val = utils::byte_swap(*timeout);
-        memcpy(framing_extras.data() + extras_old_size + 2, &val, sizeof(val));
-    } else {
-        const std::byte frame_size{ 1 /* 1 for level */ };
-        framing_extras.resize(extras_old_size + 1 + static_cast<std::size_t>(frame_size));
-        framing_extras[extras_old_size + 0] = (frame_id << 4U) | frame_size;
-        framing_extras[extras_old_size + 1] = static_cast<std::byte>(level);
-    }
+  const auto frame_id =
+    static_cast<std::byte>(protocol::request_frame_info_id::durability_requirement);
+  const auto extras_old_size = framing_extras.size();
+  if (timeout) {
+    const std::byte frame_size{ 3 /* 1 for level + 2 for timeout */ };
+    framing_extras.resize(extras_old_size + 1 + static_cast<std::size_t>(frame_size));
+    framing_extras[extras_old_size + 0] = (frame_id << 4U) | frame_size;
+    framing_extras[extras_old_size + 1] = static_cast<std::byte>(level);
+    std::uint16_t val = utils::byte_swap(*timeout);
+    memcpy(framing_extras.data() + extras_old_size + 2, &val, sizeof(val));
+  } else {
+    const std::byte frame_size{ 1 /* 1 for level */ };
+    framing_extras.resize(extras_old_size + 1 + static_cast<std::size_t>(frame_size));
+    framing_extras[extras_old_size + 0] = (frame_id << 4U) | frame_size;
+    framing_extras[extras_old_size + 1] = static_cast<std::byte>(level);
+  }
 }
 
 void
 add_preserve_expiry_frame_info(std::vector<std::byte>& framing_extras)
 {
-    const auto frame_id = static_cast<std::byte>(protocol::request_frame_info_id::preserve_ttl);
-    const std::byte frame_size{ 0 };
-    const auto extras_old_size = framing_extras.size();
+  const auto frame_id = static_cast<std::byte>(protocol::request_frame_info_id::preserve_ttl);
+  const std::byte frame_size{ 0 };
+  const auto extras_old_size = framing_extras.size();
 
-    framing_extras.resize(extras_old_size + 1);
-    framing_extras[extras_old_size + 0] = (frame_id << 4U) | frame_size;
+  framing_extras.resize(extras_old_size + 1);
+  framing_extras[extras_old_size + 0] = (frame_id << 4U) | frame_size;
 }
 } // namespace couchbase::core::protocol

data/ext/couchbase/core/protocol/frame_info_utils.hxx

@@ -37,7 +37,9 @@ namespace couchbase::core::protocol
  * @internal
  */
 void
-add_durability_frame_info(std::vector<std::byte>& framing_extras, durability_level level, std::optional<std::uint16_t> timeout);
+add_durability_frame_info(std::vector<std::byte>& framing_extras,
+                          durability_level level,
+                          std::optional<std::uint16_t> timeout);
 
 /**
  * Appends "preserve expiry" frame to @c framing_extras.

data/ext/couchbase/core/protocol/hello_feature.hxx

@@ -22,184 +22,220 @@
 namespace couchbase::core::protocol
 {
 enum class hello_feature : std::uint16_t {
-    /**
-     * The client wants to TLS and send STARTTLS
-     */
-    tls = 0x02,
-
-    /**
-     * The client requests the server to set TCP NODELAY on the socket used by this connection.
-     */
-    tcp_nodelay = 0x03,
-
-    /**
-     * The client requests the server to add the sequence number for a mutation to the response packet used in mutations.
-     */
-    mutation_seqno = 0x04,
-
-    /**
-     * The client requests the server to set TCP DELAY on the socket used by this connection
-     */
-    tcp_delay = 0x05,
-
-    /**
-     * The client requests the server to add XATTRs to the stream for commands where it makes sense (GetWithMeta, SetWithMeta, DcpMutation
-     * etc)
-     */
-    xattr = 0x06,
-
-    /**
-     * The client requests the server to send extended error codes instead of disconnecting the client when new errors occur (note that some
-     * errors may be remapped to more generic error codes instead of disconnecting)
-     */
-    xerror = 0x07,
-
-    /**
-     * This is purely informational (it does not enable/disable anything on the server). It may be used from the client to know if it should
-     * be able to run select bucket or not (select bucket was a privileged command pre-spock. In spock all users may run select bucket, but
-     * only to a bucket they have access to).
-     */
-    select_bucket = 0x08,
-
-    /**
-     * The client wants to enable support for Snappy compression. A client with support for Snappy compression must update the datatype
-     * filed in the requests with the bit representing SNAPPY when sending snappy compressed data to the server. It must be able to receive
-     * data from the server compressed with SNAPPY identified by the bit being set in the datatype field
-     */
-    snappy = 0x0a,
-
-    /**
-     * The client wants to enable support for JSON. The client must set this bit when storing JSON documents on the server. The server will
-     * set the appropriate bit in the datatype field when returning such documents to the client
-     */
-    json = 0x0b,
-
-    /**
-     * The client allows for full duplex on the socket. This means that the server may send requests back to the client. These messages is
-     * identified by the magic values of 0x82 (request) and 0x83 (response). See the document Duplex for more information.
-     *
-     * https://github.com/couchbase/kv_engine/blob/master/docs/Duplex.md
-     */
-    duplex = 0x0c,
-
-    /**
-     * The client wants the server to notify the client with new cluster maps whenever ns_server push them to memcached. (note that this
-     * notification is subject to deduplication of the vbucket map received as part of not my vbucket)
-     */
-    clustermap_change_notification = 0x0d,
-
-    /**
-     * The client allows the server to reorder the execution of commands. See the document UnorderedExecution for more information
-     *
-     * https://github.com/couchbase/kv_engine/blob/master/docs/UnorderedExecution.md
-     */
-    unordered_execution = 0x0e,
-
-    /**
-     * The client wants the server to include tracing information in the response packet
-     */
-    tracing = 0x0f,
-
-    /**
-     * This is purely informational (it does not enable/disable anything on the server). It may be used from the client to know if it may
-     * send the alternative request packet (magic 0x08) containing FrameInfo segments.
-     */
-    alt_request_support = 0x10,
-
-    /**
-     * This is purely informational (it does not enable/disable anything on the server). It may be used from the client to know if it may
-     * use synchronous replication tags in the mutation requests.
-     */
-    sync_replication = 0x11,
-
-    /**
-     * The client wants to enable support for Collections
-     */
-    collections = 0x12,
-
-    /**
-     * This is purely informational (it does not enable / disable anything on the server). It may be used from the client to figure out if
-     * the server supports OpenTracing or not.)
-     */
-    open_tracing = 0x13,
-
-    /**
-     * This is purely informational (it does not enable / disable anything on the server). It may be used from the client to know if it may
-     * use PreserveTtl in the operations who carries the TTL for a document
-     */
-    preserve_ttl = 0x14,
-
-    /**
-     * This is purely information (it does not enable / disable anything on the server). It may be used from the client to determine if the
-     * server supports VATTRs in a generic way (can request $ and will either succeed or fail with SubdocXattrUnknownVattr). Requires XATTR.
-     */
-    vattr = 0x15,
-
-    /**
-     * This is purely information (it does not enable / disable anything on the server). It may be used from the client to determine if the
-     * server supports Point in Time Recovery
-     */
-    point_in_time_recovery = 0x16,
-
-    /**
-     * Does the server support the subdoc mutation flag create_as_deleted
-     */
-    subdoc_create_as_deleted = 0x17,
-
-    /**
-     * Does the server support using the virtual $document attributes in macro expansion ("${document.CAS}" etc)
-     */
-    subdoc_document_macro_support = 0x18,
-
-    // indicates support for the replacing body with xattr feature.
-    replace_body_with_xattr = 0x19,
-
-    resource_units = 0x1a,
-
-    /**
-     * Indicates support for subdoc lookup operations on replicas
-     */
-    subdoc_replica_read = 0x1c,
-
-    /**
-     * The server will not send configuration body to the connections, that already has seen it.
-     */
-    deduplicate_not_my_vbucket_clustermap = 0x1e,
+  /**
+   * The client wants to TLS and send STARTTLS
+   */
+  tls = 0x02,
+
+  /**
+   * The client requests the server to set TCP NODELAY on the socket used by
+   * this connection.
+   */
+  tcp_nodelay = 0x03,
+
+  /**
+   * The client requests the server to add the sequence number for a mutation to
+   * the response packet used in mutations.
+   */
+  mutation_seqno = 0x04,
+
+  /**
+   * The client requests the server to set TCP DELAY on the socket used by this
+   * connection
+   */
+  tcp_delay = 0x05,
+
+  /**
+   * The client requests the server to add XATTRs to the stream for commands
+   * where it makes sense (GetWithMeta, SetWithMeta, DcpMutation etc)
+   */
+  xattr = 0x06,
+
+  /**
+   * The client requests the server to send extended error codes instead of
+   * disconnecting the client when new errors occur (note that some errors may
+   * be remapped to more generic error codes instead of disconnecting)
+   */
+  xerror = 0x07,
+
+  /**
+   * This is purely informational (it does not enable/disable anything on the
+   * server). It may be used from the client to know if it should be able to run
+   * select bucket or not (select bucket was a privileged command pre-spock. In
+   * spock all users may run select bucket, but only to a bucket they have
+   * access to).
+   */
+  select_bucket = 0x08,
+
+  /**
+   * The client wants to enable support for Snappy compression. A client with
+   * support for Snappy compression must update the datatype filed in the
+   * requests with the bit representing SNAPPY when sending snappy compressed
+   * data to the server. It must be able to receive data from the server
+   * compressed with SNAPPY identified by the bit being set in the datatype
+   * field
+   */
+  snappy = 0x0a,
+
+  /**
+   * The client wants to enable support for JSON. The client must set this bit
+   * when storing JSON documents on the server. The server will set the
+   * appropriate bit in the datatype field when returning such documents to the
+   * client
+   */
+  json = 0x0b,
+
+  /**
+   * The client allows for full duplex on the socket. This means that the server
+   * may send requests back to the client. These messages is identified by the
+   * magic values of 0x82 (request) and 0x83 (response). See the document Duplex
+   * for more information.
+   *
+   * https://github.com/couchbase/kv_engine/blob/master/docs/Duplex.md
+   */
+  duplex = 0x0c,
+
+  /**
+   * The client wants the server to notify the client with new cluster maps
+   * whenever ns_server push them to memcached. (note that this notification is
+   * subject to deduplication of the vbucket map received as part of not my
+   * vbucket)
+   */
+  clustermap_change_notification = 0x0d,
+
+  /**
+   * The client allows the server to reorder the execution of commands. See the
+   * document UnorderedExecution for more information
+   *
+   * https://github.com/couchbase/kv_engine/blob/master/docs/UnorderedExecution.md
+   */
+  unordered_execution = 0x0e,
+
+  /**
+   * The client wants the server to include tracing information in the response
+   * packet
+   */
+  tracing = 0x0f,
+
+  /**
+   * This is purely informational (it does not enable/disable anything on the
+   * server). It may be used from the client to know if it may send the
+   * alternative request packet (magic 0x08) containing FrameInfo segments.
+   */
+  alt_request_support = 0x10,
+
+  /**
+   * This is purely informational (it does not enable/disable anything on the
+   * server). It may be used from the client to know if it may use synchronous
+   * replication tags in the mutation requests.
+   */
+  sync_replication = 0x11,
+
+  /**
+   * The client wants to enable support for Collections
+   */
+  collections = 0x12,
+
+  /**
+   * This is purely informational (it does not enable / disable anything on the
+   * server). It may be used from the client to figure out if the server
+   * supports OpenTracing or not.)
+   */
+  open_tracing = 0x13,
+
+  /**
+   * This is purely informational (it does not enable / disable anything on the
+   * server). It may be used from the client to know if it may use PreserveTtl
+   * in the operations who carries the TTL for a document
+   */
+  preserve_ttl = 0x14,
+
+  /**
+   * This is purely information (it does not enable / disable anything on the
+   * server). It may be used from the client to determine if the server supports
+   * VATTRs in a generic way (can request $ and will either succeed or fail with
+   * SubdocXattrUnknownVattr). Requires XATTR.
+   */
+  vattr = 0x15,
+
+  /**
+   * This is purely information (it does not enable / disable anything on the
+   * server). It may be used from the client to determine if the server supports
+   * Point in Time Recovery
+   */
+  point_in_time_recovery = 0x16,
+
+  /**
+   * Does the server support the subdoc mutation flag create_as_deleted
+   */
+  subdoc_create_as_deleted = 0x17,
+
+  /**
+   * Does the server support using the virtual $document attributes in macro
+   * expansion
+   * ("${document.CAS}" etc)
+   */
+  subdoc_document_macro_support = 0x18,
+
+  // indicates support for the replacing body with xattr feature.
+  replace_body_with_xattr = 0x19,
+
+  resource_units = 0x1a,
+
+  /**
+   * Indicates support for subdoc lookup operations on replicas
+   */
+  subdoc_replica_read = 0x1c,
+
+  /**
+   * The server will not send configuration body to the connections, that
+   * already has seen it.
+   */
+  deduplicate_not_my_vbucket_clustermap = 0x1e,
+
+  /**
+   * The server allows:
+   *
+   * a) Binary xattr fields to be read and written.
+   * b) User flags to be sent in sub-document mutation requests.
+   */
+  subdoc_binary_xattr = 0x21,
 };
 
-constexpr bool
-is_valid_hello_feature(std::uint16_t code)
+constexpr auto
+is_valid_hello_feature(std::uint16_t code) -> bool
 {
-    switch (static_cast<hello_feature>(code)) {
-        case hello_feature::tls:
-        case hello_feature::tcp_nodelay:
-        case hello_feature::mutation_seqno:
-        case hello_feature::xattr:
-        case hello_feature::xerror:
-        case hello_feature::select_bucket:
-        case hello_feature::snappy:
-        case hello_feature::json:
-        case hello_feature::duplex:
-        case hello_feature::clustermap_change_notification:
-        case hello_feature::unordered_execution:
-        case hello_feature::alt_request_support:
-        case hello_feature::sync_replication:
-        case hello_feature::vattr:
-        case hello_feature::collections:
-        case hello_feature::open_tracing:
-        case hello_feature::preserve_ttl:
-        case hello_feature::point_in_time_recovery:
-        case hello_feature::tcp_delay:
-        case hello_feature::tracing:
-        case hello_feature::subdoc_create_as_deleted:
-        case hello_feature::subdoc_document_macro_support:
-        case hello_feature::replace_body_with_xattr:
-        case hello_feature::resource_units:
-        case hello_feature::subdoc_replica_read:
-        case hello_feature::deduplicate_not_my_vbucket_clustermap:
-            return true;
-    }
-    return false;
+  switch (static_cast<hello_feature>(code)) {
+    case hello_feature::tls:
+    case hello_feature::tcp_nodelay:
+    case hello_feature::mutation_seqno:
+    case hello_feature::xattr:
+    case hello_feature::xerror:
+    case hello_feature::select_bucket:
+    case hello_feature::snappy:
+    case hello_feature::json:
+    case hello_feature::duplex:
+    case hello_feature::clustermap_change_notification:
+    case hello_feature::unordered_execution:
+    case hello_feature::alt_request_support:
+    case hello_feature::sync_replication:
+    case hello_feature::vattr:
+    case hello_feature::collections:
+    case hello_feature::open_tracing:
+    case hello_feature::preserve_ttl:
+    case hello_feature::point_in_time_recovery:
+    case hello_feature::tcp_delay:
+    case hello_feature::tracing:
+    case hello_feature::subdoc_create_as_deleted:
+    case hello_feature::subdoc_document_macro_support:
+    case hello_feature::replace_body_with_xattr:
+    case hello_feature::resource_units:
+    case hello_feature::subdoc_replica_read:
+    case hello_feature::deduplicate_not_my_vbucket_clustermap:
+    case hello_feature::subdoc_binary_xattr:
+      return true;
+  }
+  return false;
 }
 
 } // namespace couchbase::core::protocol