google-protobuf 4.27.2 → 4.35.1

data/ext/google/protobuf_c/extconf.rb

@@ -6,23 +6,33 @@ ext_name = "google/protobuf_c"
 
 dir_config(ext_name)
 
-if RUBY_PLATFORM =~ /darwin/ || RUBY_PLATFORM =~ /linux/ || RUBY_PLATFORM =~ /freebsd/
-  $CFLAGS += " -std=gnu99 -O3 -DNDEBUG -fvisibility=hidden -Wall -Wsign-compare -Wno-declaration-after-statement"
-else
-  $CFLAGS += " -std=gnu99 -O3 -DNDEBUG"
+if ENV["CC"]
+  RbConfig::CONFIG["CC"] = RbConfig::MAKEFILE_CONFIG["CC"] = ENV["CC"]
+end
+
+if ENV["CXX"]
+  RbConfig::CONFIG["CXX"] = RbConfig::MAKEFILE_CONFIG["CXX"] = ENV["CXX"]
+end
+
+if ENV["LD"]
+  RbConfig::CONFIG["LD"] = RbConfig::MAKEFILE_CONFIG["LD"] = ENV["LD"]
 end
 
-if RUBY_PLATFORM =~ /linux/
-  # Instruct the linker to point memcpy calls at our __wrap_memcpy wrapper.
-  $LDFLAGS += " -Wl,-wrap,memcpy"
+debug_enabled = ENV["PROTOBUF_CONFIG"] == "dbg"
+
+additional_c_flags = debug_enabled ? "-O0 -fno-omit-frame-pointer -fvisibility=default -g" : "-O3 -DNDEBUG -fvisibility=hidden"
+
+if RUBY_PLATFORM =~ /darwin/ || RUBY_PLATFORM =~ /linux/ || RUBY_PLATFORM =~ /freebsd/
+  $CFLAGS += " -std=gnu99 -Wall -Wsign-compare -Wno-declaration-after-statement #{additional_c_flags}"
+else
+  $CFLAGS += " -std=gnu99 #{additional_c_flags}"
 end
 
 $VPATH << "$(srcdir)/third_party/utf8_range"
 $INCFLAGS += " -I$(srcdir)/third_party/utf8_range"
 
-$srcs = ["protobuf.c", "convert.c", "defs.c", "message.c",
-         "repeated_field.c", "map.c", "ruby-upb.c", "wrap_memcpy.c",
-         "utf8_range.c", "shared_convert.c",
+$srcs = ["protobuf.c", "convert.c", "defs.c", "message.c", "repeated_field.c",
+         "map.c", "ruby-upb.c", "utf8_range.c", "shared_convert.c",
          "shared_message.c"]
 
 create_makefile(ext_name)

data/ext/google/protobuf_c/glue.c

@@ -26,6 +26,15 @@ char* EnumDescriptor_serialized_options(const upb_EnumDef* enumdef,
   return serialized;
 }
 
+char* EnumDescriptor_serialized_to_proto(const upb_EnumDef* enumdef,
+                                         size_t* size, upb_Arena* arena) {
+  const google_protobuf_EnumDescriptorProto* file_proto =
+      upb_EnumDef_ToProto(enumdef, arena);
+  char* serialized =
+      google_protobuf_EnumDescriptorProto_serialize(file_proto, arena, size);
+  return serialized;
+}
+
 char* FileDescriptor_serialized_options(const upb_FileDef* filedef,
                                         size_t* size, upb_Arena* arena) {
   const google_protobuf_FileOptions* opts = upb_FileDef_Options(filedef);
@@ -33,6 +42,15 @@ char* FileDescriptor_serialized_options(const upb_FileDef* filedef,
   return serialized;
 }
 
+char* FileDescriptor_serialized_to_proto(const upb_FileDef* filedef,
+                                         size_t* size, upb_Arena* arena) {
+  const google_protobuf_FileDescriptorProto* file_proto =
+      upb_FileDef_ToProto(filedef, arena);
+  char* serialized =
+      google_protobuf_FileDescriptorProto_serialize(file_proto, arena, size);
+  return serialized;
+}
+
 char* Descriptor_serialized_options(const upb_MessageDef* msgdef, size_t* size,
                                     upb_Arena* arena) {
   const google_protobuf_MessageOptions* opts = upb_MessageDef_Options(msgdef);
@@ -41,6 +59,15 @@ char* Descriptor_serialized_options(const upb_MessageDef* msgdef, size_t* size,
   return serialized;
 }
 
+char* Descriptor_serialized_to_proto(const upb_MessageDef* msgdef, size_t* size,
+                                     upb_Arena* arena) {
+  const google_protobuf_DescriptorProto* proto =
+      upb_MessageDef_ToProto(msgdef, arena);
+  char* serialized =
+      google_protobuf_DescriptorProto_serialize(proto, arena, size);
+  return serialized;
+}
+
 char* OneOfDescriptor_serialized_options(const upb_OneofDef* oneofdef,
                                          size_t* size, upb_Arena* arena) {
   const google_protobuf_OneofOptions* opts = upb_OneofDef_Options(oneofdef);
@@ -48,6 +75,15 @@ char* OneOfDescriptor_serialized_options(const upb_OneofDef* oneofdef,
   return serialized;
 }
 
+char* OneOfDescriptor_serialized_to_proto(const upb_OneofDef* oneofdef,
+                                          size_t* size, upb_Arena* arena) {
+  const google_protobuf_OneofDescriptorProto* proto =
+      upb_OneofDef_ToProto(oneofdef, arena);
+  char* serialized =
+      google_protobuf_OneofDescriptorProto_serialize(proto, arena, size);
+  return serialized;
+}
+
 char* FieldDescriptor_serialized_options(const upb_FieldDef* fielddef,
                                          size_t* size, upb_Arena* arena) {
   const google_protobuf_FieldOptions* opts = upb_FieldDef_Options(fielddef);
@@ -55,6 +91,15 @@ char* FieldDescriptor_serialized_options(const upb_FieldDef* fielddef,
   return serialized;
 }
 
+char* FieldDescriptor_serialized_to_proto(const upb_FieldDef* fieldef,
+                                          size_t* size, upb_Arena* arena) {
+  const google_protobuf_FieldDescriptorProto* proto =
+      upb_FieldDef_ToProto(fieldef, arena);
+  char* serialized =
+      google_protobuf_FieldDescriptorProto_serialize(proto, arena, size);
+  return serialized;
+}
+
 char* ServiceDescriptor_serialized_options(const upb_ServiceDef* servicedef,
                                            size_t* size, upb_Arena* arena) {
   const google_protobuf_ServiceOptions* opts =
@@ -64,9 +109,27 @@ char* ServiceDescriptor_serialized_options(const upb_ServiceDef* servicedef,
   return serialized;
 }
 
+char* ServiceDescriptor_serialized_to_proto(const upb_ServiceDef* servicedef,
+                                            size_t* size, upb_Arena* arena) {
+  const google_protobuf_ServiceDescriptorProto* proto =
+      upb_ServiceDef_ToProto(servicedef, arena);
+  char* serialized =
+      google_protobuf_ServiceDescriptorProto_serialize(proto, arena, size);
+  return serialized;
+}
+
 char* MethodDescriptor_serialized_options(const upb_MethodDef* methoddef,
                                           size_t* size, upb_Arena* arena) {
   const google_protobuf_MethodOptions* opts = upb_MethodDef_Options(methoddef);
   char* serialized = google_protobuf_MethodOptions_serialize(opts, arena, size);
   return serialized;
 }
+
+char* MethodDescriptor_serialized_to_proto(const upb_MethodDef* methodef,
+                                           size_t* size, upb_Arena* arena) {
+  const google_protobuf_MethodDescriptorProto* proto =
+      upb_MethodDef_ToProto(methodef, arena);
+  char* serialized =
+      google_protobuf_MethodDescriptorProto_serialize(proto, arena, size);
+  return serialized;
+}

data/ext/google/protobuf_c/map.c

@@ -63,9 +63,10 @@ static VALUE Map_alloc(VALUE klass) {
   return TypedData_Wrap_Struct(klass, &Map_type, self);
 }
 
-VALUE Map_GetRubyWrapper(upb_Map* map, upb_CType key_type, TypeInfo value_type,
-                         VALUE arena) {
+VALUE Map_GetRubyWrapper(const upb_Map* map, upb_CType key_type,
+                         TypeInfo value_type, VALUE arena) {
   PBRUBY_ASSERT(map);
+  PBRUBY_ASSERT(arena != Qnil);
 
   VALUE val = ObjectCache_Get(map);
 
@@ -83,7 +84,6 @@ VALUE Map_GetRubyWrapper(upb_Map* map, upb_CType key_type, TypeInfo value_type,
     }
     return ObjectCache_TryAdd(map, val);
   }
-
   return val;
 }
 
@@ -105,8 +105,9 @@ static TypeInfo Map_keyinfo(Map* self) {
 }
 
 static upb_Map* Map_GetMutable(VALUE _self) {
-  rb_check_frozen(_self);
-  return (upb_Map*)ruby_to_Map(_self)->map;
+  const upb_Map* map = ruby_to_Map(_self)->map;
+  Protobuf_CheckNotFrozen(_self, upb_Map_IsFrozen(map));
+  return (upb_Map*)map;
 }
 
 VALUE Map_CreateHash(const upb_Map* map, upb_CType key_type,
@@ -235,10 +236,15 @@ static VALUE Map_merge_into_self(VALUE _self, VALUE hashmap) {
   return _self;
 }
 
+/**
+ * ruby-doc: Map
+ *
+ * This class represents a Protobuf Map. It is largely automatically transformed
+ * to and from a Ruby hash.
+ */
+
 /*
- * call-seq:
- *     Map.new(key_type, value_type, value_typeclass = nil, init_hashmap = {})
- *     => new map
+ * ruby-doc: Map#initialize
  *
  * Allocates a new Map container. This constructor may be called with 2, 3, or 4
  * arguments. The first two arguments are always present and are symbols (taking
@@ -264,6 +270,13 @@ static VALUE Map_merge_into_self(VALUE _self, VALUE hashmap) {
  * shallow-copied into the new Map: the original map is unmodified, but
  * references to underlying objects will be shared if the value type is a
  * message type.
+ *
+ * @param key_type [Symbol]
+ * @param value_type [Symbol]
+ * @param value_typeclass [Class<AbstractMessage>,Module]
+ * @paramdefault value_typeclass nil
+ * @param init_hashmap [Hash,Map]
+ * @paramdefault init_hashmap {}
  */
 static VALUE Map_init(int argc, VALUE* argv, VALUE _self) {
   Map* self = ruby_to_Map(_self);
@@ -310,12 +323,14 @@ static VALUE Map_init(int argc, VALUE* argv, VALUE _self) {
 }
 
 /*
- * call-seq:
- *     Map.each(&block)
+ * ruby-doc: Map#each
  *
  * Invokes &block on each |key, value| pair in the map, in unspecified order.
  * Note that Map also includes Enumerable; map thus acts like a normal Ruby
  * sequence.
+ *
+ * @yield [Object, Object]
+ * @return [nil]
  */
 static VALUE Map_each(VALUE _self) {
   Map* self = ruby_to_Map(_self);
@@ -332,10 +347,11 @@ static VALUE Map_each(VALUE _self) {
 }
 
 /*
- * call-seq:
- *     Map.keys => [list_of_keys]
+ * ruby-doc: Map#keys
  *
  * Returns the list of keys contained in the map, in unspecified order.
+ *
+ * @return [Array<Object>]
  */
 static VALUE Map_keys(VALUE _self) {
   Map* self = ruby_to_Map(_self);
@@ -352,10 +368,11 @@ static VALUE Map_keys(VALUE _self) {
 }
 
 /*
- * call-seq:
- *     Map.values => [list_of_values]
+ * ruby-doc: Map#values
  *
  * Returns the list of values contained in the map, in unspecified order.
+ *
+ * @return [Array<Object>]
  */
 static VALUE Map_values(VALUE _self) {
   Map* self = ruby_to_Map(_self);
@@ -372,11 +389,13 @@ static VALUE Map_values(VALUE _self) {
 }
 
 /*
- * call-seq:
- *     Map.[](key) => value
+ * ruby-doc: Map#[]
  *
  * Accesses the element at the given key. Throws an exception if the key type is
  * incorrect. Returns nil when the key is not present in the map.
+ *
+ * @param key [Object]
+ * @return [Object]
  */
 static VALUE Map_index(VALUE _self, VALUE key) {
   Map* self = ruby_to_Map(_self);
@@ -392,12 +411,15 @@ static VALUE Map_index(VALUE _self, VALUE key) {
 }
 
 /*
- * call-seq:
- *     Map.[]=(key, value) => value
+ * ruby-doc: Map#[]=
  *
  * Inserts or overwrites the value at the given key with the given new value.
  * Throws an exception if the key type is incorrect. Returns the new value that
  * was just inserted.
+ *
+ * @param key [Object]
+ * @param value [Object]
+ * @return [Object]
  */
 static VALUE Map_index_set(VALUE _self, VALUE key, VALUE val) {
   Map* self = ruby_to_Map(_self);
@@ -413,11 +435,13 @@ static VALUE Map_index_set(VALUE _self, VALUE key, VALUE val) {
 }
 
 /*
- * call-seq:
- *     Map.has_key?(key) => bool
+ * ruby-doc: Map#has_key?
  *
  * Returns true if the given key is present in the map. Throws an exception if
  * the key has the wrong type.
+ *
+ * @param key [Object]
+ * @return [Boolean]
  */
 static VALUE Map_has_key(VALUE _self, VALUE key) {
   Map* self = ruby_to_Map(_self);
@@ -432,21 +456,23 @@ static VALUE Map_has_key(VALUE _self, VALUE key) {
 }
 
 /*
- * call-seq:
- *     Map.delete(key) => old_value
+ * ruby-doc: Map#delete
  *
  * Deletes the value at the given key, if any, returning either the old value or
  * nil if none was present. Throws an exception if the key is of the wrong type.
+ *
+ * @param key [Object]
+ * @return [Object]
  */
 static VALUE Map_delete(VALUE _self, VALUE key) {
+  upb_Map* map = Map_GetMutable(_self);
   Map* self = ruby_to_Map(_self);
-  rb_check_frozen(_self);
 
   upb_MessageValue key_upb =
       Convert_RubyToUpb(key, "", Map_keyinfo(self), NULL);
   upb_MessageValue val_upb;
 
-  if (upb_Map_Delete(Map_GetMutable(_self), key_upb, &val_upb)) {
+  if (upb_Map_Delete(map, key_upb, &val_upb)) {
     return Convert_UpbToRuby(val_upb, self->value_type_info, self->arena);
   } else {
     return Qnil;
@@ -454,10 +480,11 @@ static VALUE Map_delete(VALUE _self, VALUE key) {
 }
 
 /*
- * call-seq:
- *     Map.clear
+ * ruby-doc: Map#clear
  *
  * Removes all entries from the map.
+ *
+ * @return [nil]
  */
 static VALUE Map_clear(VALUE _self) {
   upb_Map_Clear(Map_GetMutable(_self));
@@ -465,10 +492,11 @@ static VALUE Map_clear(VALUE _self) {
 }
 
 /*
- * call-seq:
- *     Map.length
+ * ruby-doc: Map#length
  *
  * Returns the number of entries (key-value pairs) in the map.
+ *
+ * @return [Integer]
  */
 static VALUE Map_length(VALUE _self) {
   Map* self = ruby_to_Map(_self);
@@ -476,11 +504,12 @@ static VALUE Map_length(VALUE _self) {
 }
 
 /*
- * call-seq:
- *     Map.dup => new_map
+ * ruby-doc: Map#dup
  *
  * Duplicates this map with a shallow copy. References to all non-primitive
  * element objects (e.g., submessages) are shared.
+ *
+ * @return [Map]
  */
 static VALUE Map_dup(VALUE _self) {
   Map* self = ruby_to_Map(_self);
@@ -501,8 +530,7 @@ static VALUE Map_dup(VALUE _self) {
 }
 
 /*
- * call-seq:
- *     Map.==(other) => boolean
+ * ruby-doc: Map#==
  *
  * Compares this map to another. Maps are equal if they have identical key sets,
  * and for each key, the values in both maps compare equal. Elements are
@@ -512,6 +540,9 @@ static VALUE Map_dup(VALUE _self) {
  * Maps with dissimilar key types or value types/typeclasses are never equal,
  * even if value comparison (for example, between integers and floats) would
  * have otherwise indicated that every element has equal value.
+ *
+ * @param other [Map]
+ * @return [Boolean]
  */
 VALUE Map_eq(VALUE _self, VALUE _other) {
   Map* self = ruby_to_Map(_self);
@@ -559,37 +590,90 @@ VALUE Map_eq(VALUE _self, VALUE _other) {
 }
 
 /*
- * call-seq:
- *     Message.freeze => self
+ * ruby-doc: Map#frozen?
+ *
+ * Returns true if the map is frozen in either Ruby or the underlying
+ * representation. Freezes the Ruby map object if it is not already frozen in
+ * Ruby but it is frozen in the underlying representation.
  *
- * Freezes the message object. We have to intercept this so we can pin the
- * Ruby object into memory so we don't forget it's frozen.
+ * @return [Boolean]
+ */
+VALUE Map_frozen(VALUE _self) {
+  Map* self = ruby_to_Map(_self);
+  if (!upb_Map_IsFrozen(self->map)) {
+    PBRUBY_ASSERT(!RB_OBJ_FROZEN(_self));
+    return Qfalse;
+  }
+
+  // Lazily freeze the Ruby wrapper.
+  if (!RB_OBJ_FROZEN(_self)) RB_OBJ_FREEZE(_self);
+  return Qtrue;
+}
+
+/*
+ * ruby-doc: Map#freeze
+ *
+ * Freezes the map object. We have to intercept this so we can freeze the
+ * underlying representation, not just the Ruby wrapper.
+ *
+ * @return [self]
  */
 VALUE Map_freeze(VALUE _self) {
   Map* self = ruby_to_Map(_self);
+  if (RB_OBJ_FROZEN(_self)) {
+    PBRUBY_ASSERT(upb_Map_IsFrozen(self->map));
+    return _self;
+  }
+
+  if (!upb_Map_IsFrozen(self->map)) {
+    if (self->value_type_info.type == kUpb_CType_Message) {
+      upb_Map_Freeze(
+          Map_GetMutable(_self),
+          upb_MessageDef_MiniTable(self->value_type_info.def.msgdef));
+    } else {
+      upb_Map_Freeze(Map_GetMutable(_self), NULL);
+    }
+  }
 
-  if (RB_OBJ_FROZEN(_self)) return _self;
-  Arena_Pin(self->arena, _self);
   RB_OBJ_FREEZE(_self);
 
-  if (self->value_type_info.type == kUpb_CType_Message) {
-    size_t iter = kUpb_Map_Begin;
-    upb_MessageValue key, val;
+  return _self;
+}
+
+VALUE Map_EmptyFrozen(const upb_FieldDef* f) {
+  PBRUBY_ASSERT(upb_FieldDef_IsMap(f));
+  VALUE val = ObjectCache_Get(f);
 
-    while (upb_Map_Next(self->map, &key, &val, &iter)) {
-      VALUE val_val =
-          Convert_UpbToRuby(val, self->value_type_info, self->arena);
-      Message_freeze(val_val);
+  if (val == Qnil) {
+    const upb_FieldDef* key_f = map_field_key(f);
+    const upb_FieldDef* val_f = map_field_value(f);
+    upb_CType key_type = upb_FieldDef_CType(key_f);
+    TypeInfo value_type_info = TypeInfo_get(val_f);
+    val = Map_alloc(cMap);
+    Map* self;
+    TypedData_Get_Struct(val, Map, &Map_type, self);
+    self->arena = Arena_new();
+    self->map =
+        upb_Map_New(Arena_get(self->arena), key_type, value_type_info.type);
+    self->key_type = key_type;
+    self->value_type_info = value_type_info;
+    if (self->value_type_info.type == kUpb_CType_Message) {
+      const upb_MessageDef* val_m = value_type_info.def.msgdef;
+      self->value_type_class = Descriptor_DefToClass(val_m);
     }
+    return ObjectCache_TryAdd(f, Map_freeze(val));
   }
-  return _self;
+  PBRUBY_ASSERT(RB_OBJ_FROZEN(val));
+  PBRUBY_ASSERT(upb_Map_IsFrozen(ruby_to_Map(val)->map));
+  return val;
 }
 
 /*
- * call-seq:
- *     Map.hash => hash_value
+ * ruby-doc: Map#hash
  *
  * Returns a hash value based on this map's contents.
+ *
+ * @return [Integer]
  */
 VALUE Map_hash(VALUE _self) {
   Map* self = ruby_to_Map(_self);
@@ -599,18 +683,19 @@ VALUE Map_hash(VALUE _self) {
   TypeInfo key_info = {self->key_type};
   upb_MessageValue key, val;
   while (upb_Map_Next(self->map, &key, &val, &iter)) {
-    hash = Msgval_GetHash(key, key_info, hash);
-    hash = Msgval_GetHash(val, self->value_type_info, hash);
+    hash += Msgval_GetHash(key, key_info, 0);
+    hash += Msgval_GetHash(val, self->value_type_info, 0);
   }
 
   return LL2NUM(hash);
 }
 
 /*
- * call-seq:
- *     Map.to_h => {}
+ * ruby-doc: Map#to_h
  *
  * Returns a Ruby Hash object containing all the values within the map
+ *
+ * @return [Hash]
  */
 VALUE Map_to_h(VALUE _self) {
   Map* self = ruby_to_Map(_self);
@@ -618,12 +703,13 @@ VALUE Map_to_h(VALUE _self) {
 }
 
 /*
- * call-seq:
- *     Map.inspect => string
+ * ruby-doc: Map#inspect
  *
  * Returns a string representing this map's elements. It will be formatted as
  * "{key => value, key => value, ...}", with each key and value string
  * representation computed by its own #inspect method.
+ *
+ * @return [String]
  */
 VALUE Map_inspect(VALUE _self) {
   Map* self = ruby_to_Map(_self);
@@ -636,13 +722,15 @@ VALUE Map_inspect(VALUE _self) {
 }
 
 /*
- * call-seq:
- *     Map.merge(other_map) => map
+ * ruby-doc: Map#merge
  *
  * Copies key/value pairs from other_map into a copy of this map. If a key is
  * set in other_map and this map, the value from other_map overwrites the value
  * in the new copy of this map. Returns the new copy of this map with merged
  * contents.
+ *
+ * @param other_map [Map]
+ * @return [Map]
  */
 static VALUE Map_merge(VALUE _self, VALUE hashmap) {
   VALUE dupped = Map_dup(_self);
@@ -671,6 +759,7 @@ void Map_register(VALUE module) {
   rb_define_method(klass, "clone", Map_dup, 0);
   rb_define_method(klass, "==", Map_eq, 1);
   rb_define_method(klass, "freeze", Map_freeze, 0);
+  rb_define_method(klass, "frozen?", Map_frozen, 0);
   rb_define_method(klass, "hash", Map_hash, 0);
   rb_define_method(klass, "to_h", Map_to_h, 0);
   rb_define_method(klass, "inspect", Map_inspect, 0);

data/ext/google/protobuf_c/map.h

@@ -11,10 +11,14 @@
 #include "protobuf.h"
 #include "ruby-upb.h"
 
+// Returns a frozen sentinel Ruby wrapper object for an empty upb_Map with the
+// key and value types specified by the field. Creates one if it doesn't exist.
+VALUE Map_EmptyFrozen(const upb_FieldDef* f);
+
 // Returns a Ruby wrapper object for the given map, which will be created if
 // one does not exist already.
-VALUE Map_GetRubyWrapper(upb_Map *map, upb_CType key_type, TypeInfo value_type,
-                         VALUE arena);
+VALUE Map_GetRubyWrapper(const upb_Map *map, upb_CType key_type,
+                         TypeInfo value_type, VALUE arena);
 
 // Gets the underlying upb_Map for this Ruby map object, which must have
 // key/value type that match |field|. If this is not a map or the type doesn't