In TSan mode, detect concurrent mutations of repeated/map fields.

PiperOrigin-RevId: 538573264
protocolbuffers · Jun 7, 2023 · d800c5f · d800c5f
1 parent 87a601e
commit d800c5f
Show file tree

Hide file tree

Showing 11 changed files with 127 additions and 0 deletions.
diff --git a/src/google/protobuf/compiler/cpp/field.cc b/src/google/protobuf/compiler/cpp/field.cc
@@ -85,6 +85,11 @@ std::vector<Sub> FieldVars(const FieldDescriptor* field, const Options& opts) {
       {"{", ""},
       {"}", ""},
 
+      // For TSan validation.
+      {"TsanDetectConcurrentMutation",
+       "PROTOBUF_TSAN_WRITE(&_internal_metadata_)"},
+      {"TsanDetectConcurrentRead", "PROTOBUF_TSAN_READ(&_internal_metadata_)"},
+
       // Old-style names.
       {"field", FieldMemberName(field, split)},
       {"declared_type", DeclaredTypeMethodName(field->type())},

diff --git a/src/google/protobuf/compiler/cpp/field_generators/enum_field.cc b/src/google/protobuf/compiler/cpp/field_generators/enum_field.cc
@@ -388,9 +388,11 @@ void RepeatedEnum::GenerateInlineAccessorDefinitions(io::Printer* p) const {
       return _internal_mutable_$name$();
     }
     inline const $pb$::RepeatedField<int>& $Msg$::_internal_$name$() const {
+      $TsanDetectConcurrentRead$;
       return $field_$;
     }
     inline $pb$::RepeatedField<int>* $Msg$::_internal_mutable_$name$() {
+      $TsanDetectConcurrentMutation$;
       return &$field_$;
     }
   )cc");

diff --git a/src/google/protobuf/compiler/cpp/field_generators/map_field.cc b/src/google/protobuf/compiler/cpp/field_generators/map_field.cc
@@ -218,6 +218,7 @@ void Map::GenerateAccessorDeclarations(io::Printer* p) const {
 void Map::GenerateInlineAccessorDefinitions(io::Printer* p) const {
   p->Emit(R"cc(
     inline const $Map$& $Msg$::_internal_$name$() const {
+      $TsanDetectConcurrentRead$;
       return $field_$.GetMap();
     }
     inline const $Map$& $Msg$::$name$() const {
@@ -227,6 +228,7 @@ void Map::GenerateInlineAccessorDefinitions(io::Printer* p) const {
     }
     inline $Map$* $Msg$::_internal_mutable_$name$() {
       $PrepareSplitMessageForWrite$;
+      $TsanDetectConcurrentMutation$;
       return $field_$.MutableMap();
     }
     inline $Map$* $Msg$::mutable_$name$() {

diff --git a/src/google/protobuf/compiler/cpp/field_generators/message_field.cc b/src/google/protobuf/compiler/cpp/field_generators/message_field.cc
@@ -826,21 +826,25 @@ void RepeatedMessage::GenerateInlineAccessorDefinitions(io::Printer* p) const {
   p->Emit(R"cc(
     inline const $pb$::RepeatedPtrField<$Submsg$>&
     $classname$::_internal_$name$() const {
+      $TsanDetectConcurrentRead$;
       return $field$$.weak$;
     }
     inline $pb$::RepeatedPtrField<$Submsg$>*
     $classname$::_internal_mutable_$name$() {
+      $TsanDetectConcurrentMutation$;
       return &$field$$.weak$;
     }
   )cc");
   if (weak_) {
     p->Emit(R"cc(
       inline const $pb$::WeakRepeatedPtrField<$Submsg$>&
       $Msg$::_internal_weak_$name$() const {
+        $TsanDetectConcurrentRead$;
         return $field$;
       }
       inline $pb$::WeakRepeatedPtrField<$Submsg$>*
       $Msg$::_internal_mutable_weak_$name$() {
+        $TsanDetectConcurrentMutation$;
         return &$field$;
       }
     )cc");

diff --git a/src/google/protobuf/compiler/cpp/field_generators/primitive_field.cc b/src/google/protobuf/compiler/cpp/field_generators/primitive_field.cc
@@ -455,9 +455,11 @@ void RepeatedPrimitive::GenerateInlineAccessorDefinitions(
     }
 
     inline const $pb$::RepeatedField<$Type$>& $Msg$::_internal_$name$() const {
+      $TsanDetectConcurrentRead$;
       return $field_$;
     }
     inline $pb$::RepeatedField<$Type$>* $Msg$::_internal_mutable_$name$() {
+      $TsanDetectConcurrentMutation$;
       return &$field_$;
     }
   )cc");

diff --git a/src/google/protobuf/compiler/cpp/field_generators/string_field.cc b/src/google/protobuf/compiler/cpp/field_generators/string_field.cc
@@ -893,10 +893,12 @@ void RepeatedString::GenerateInlineAccessorDefinitions(io::Printer* p) const {
             }
             inline const ::$proto_ns$::RepeatedPtrField<std::string>&
             $Msg$::_internal_$name$() const {
+              $TsanDetectConcurrentRead$;
               return $field_$;
             }
             inline ::$proto_ns$::RepeatedPtrField<std::string>*
             $Msg$::_internal_mutable_$name$() {
+              $TsanDetectConcurrentMutation$;
               return &$field_$;
             }
           )cc");

diff --git a/src/google/protobuf/compiler/plugin.pb.h b/src/google/protobuf/compiler/plugin.pb.h