tracing v2: Introduce handles for safe usage of ProtoZeroMessage

components/tracing/core/proto_zero_message.h

 // Copyright 2016 The Chromium Authors. All rights reserved.
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
 #ifndef COMPONENTS_TRACING_CORE_PROTO_ZERO_MESSAGE_H_
 #define COMPONENTS_TRACING_CORE_PROTO_ZERO_MESSAGE_H_
 
 #include <stdint.h>
 
 #include <type_traits>
 
 #include "base/compiler_specific.h"
 #include "base/gtest_prod_util.h"
 #include "base/logging.h"
 #include "base/macros.h"
 #include "base/template_util.h"
 #include "build/build_config.h"
 #include "components/tracing/core/scattered_stream_writer.h"
 #include "components/tracing/tracing_export.h"
 
 namespace tracing {
 namespace v2 {
 
+class ProtoZeroMessageHandleBase;
+
 // Base class extended by the proto C++ stubs generated by the ProtoZero
 // compiler (see //components/tracing/tools/). This class provides the minimal
 // runtime required to support append-only operations and is desiged for
 // performance. None of the methods require any dynamic memory allocation.
 class TRACING_EXPORT ProtoZeroMessage {
  public:
+  // Clears up the state, allowing the message to be reused as a fresh one.
+  void Reset(ScatteredStreamWriter*);
+
   // Commits all the changes to the buffer (backfills the size field of this and
   // all nested messages) and seals the message. Returns the size of the message
   // (and all nested sub-messages), without taking into account any chunking.
   // Finalize is idempotent and can be called several times w/o side effects.
   size_t Finalize();
 
   // Optional. If is_valid() == true, the corresponding memory region (its
   // length == proto::kMessageLengthFieldSize) is backfilled with the size of
   // this message (minus |size_already_written| below) when the message is
   // finalized. This is the mechanism used by messages to backfill their
   // corresponding size field in the parent message.
   ContiguousMemoryRange size_field() const { return size_field_; }
   void set_size_field(const ContiguousMemoryRange& reserved_range) {
     size_field_ = reserved_range;
   }
 
   // This is to deal with case of backfilling the size of a root (non-nested)
   // message which is split into multiple chunks. Upon finalization only the
   // partial size that lies in the last chunk has to be backfilled.
   void inc_size_already_written(size_t size) { size_already_written_ += size; }
 
+  // Only for ProtoZeroMessageHandleBase.
+  void set_handle(ProtoZeroMessageHandleBase* handle) {

[oystein (OOO til 10th of July), 2016/07/20 21:19:37]

Maybe wrap the whole function in DCHECK_IS_ON(), so that usages of this have to
do the same and make it clearer at the callsite that this is just there for
debugging/asserting purposes.

[Primiano Tucci (use gerrit), 2016/07/21 10:50:03]

Done.

+#if DCHECK_IS_ON()
+    handle_ = handle;
+#endif
+  }
+
  protected:
   ProtoZeroMessage();
 
-  // Clears up the state, allowing the message to be reused as a fresh one.
-  void Reset(ScatteredStreamWriter*);
-
   void AppendVarIntU64(uint32_t field_id, uint64_t value);
   void AppendVarIntU32(uint32_t field_id, uint32_t value);
   void AppendFloat(uint32_t field_id, float value);
   void AppendDouble(uint32_t field_id, double value);
   void AppendString(uint32_t field_id, const char* str);
   void AppendBytes(uint32_t field_id, const void* value, size_t size);
   // TODO(kraynov): implement AppendVarIntS32/64(...) w/ zig-zag encoding.
 
   // Begins a nested message, using the static storage provided by the parent
   // class (see comment in |nested_messages_arena_|). The nested message ends
@@ skipping 13 matching lines @@
     BeginNestedMessageInternal(field_id, message);
     return message;
   }
 
  private:
   friend class ProtoZeroMessageTest;
   FRIEND_TEST_ALL_PREFIXES(ProtoZeroMessageTest, BasicTypesNoNesting);
   FRIEND_TEST_ALL_PREFIXES(ProtoZeroMessageTest, BackfillSizeOnFinalization);
   FRIEND_TEST_ALL_PREFIXES(ProtoZeroMessageTest, NestedMessagesSimple);
   FRIEND_TEST_ALL_PREFIXES(ProtoZeroMessageTest, StressTest);
+  FRIEND_TEST_ALL_PREFIXES(ProtoZeroMessageTest, MessageHandle);
 
   enum : uint32_t { kMaxNestingDepth = 8 };
 
   void BeginNestedMessageInternal(uint32_t field_id, ProtoZeroMessage*);
 
   // Called by Finalize and Append* methods.
   void EndNestedMessage();
 
   void WriteToStream(const uint8_t* src_begin, const uint8_t* src_end) {
 #if DCHECK_IS_ON()
@@ skipping 18 matching lines @@
   size_t size_already_written_;
 
   // Used to detect attemps to create messages with a nesting level >
   // kMaxNestingDepth. |nesting_depth_| == 0 for root (non-nested) messages.
   uint32_t nesting_depth_;
 
 #if DCHECK_IS_ON()
   // When true, no more changes to the message are allowed. This is to DCHECK
   // attempts of writing to a message which has been Finalize()-d.
   bool sealed_;
+
+  ProtoZeroMessageHandleBase* handle_;
 #endif
 
   // Pointer to the last child message created through BeginNestedMessage(), if
   // any. nullptr otherwise. There is no need to keep track of more than one
   // message per nesting level as the proto-zero API contract mandates that
   // nested fields can be filled only in a stacked fashion. In other words,
   // nested messages are finalized and sealed when any other field is set in the
   // parent message (or the parent message itself is finalized) and cannot be
   // accessed anymore afterwards.
   ProtoZeroMessage* nested_message_;
 
   // The root message owns the storage for all its nested messages, up to a max
   // of kMaxNestingDepth levels (see the .cc file). Note that the boundaries of
   // the arena are meaningful only for the root message. The static_assert in
   // the .cc file guarantees that the sizeof(nested_messages_arena_) is enough
   // to contain up to kMaxNestingDepth messages.
   ALIGNAS(sizeof(void*)) uint8_t nested_messages_arena_[512];
 
   // DO NOT add any fields below |nested_messages_arena_|. The memory layout of
   // nested messages would overflow the storage allocated by the root message.
 
   DISALLOW_COPY_AND_ASSIGN(ProtoZeroMessage);
 };
 
 }  // namespace v2
 }  // namespace tracing
 
 #endif  // COMPONENTS_TRACING_CORE_PROTO_ZERO_MESSAGE_H_