desc_init.go 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289
  1. // Copyright 2019 The Go Authors. All rights reserved.
  2. // Use of this source code is governed by a BSD-style
  3. // license that can be found in the LICENSE file.
  4. package protodesc
  5. import (
  6. "google.golang.org/protobuf/internal/errors"
  7. "google.golang.org/protobuf/internal/filedesc"
  8. "google.golang.org/protobuf/internal/strs"
  9. "google.golang.org/protobuf/proto"
  10. "google.golang.org/protobuf/reflect/protoreflect"
  11. "google.golang.org/protobuf/types/descriptorpb"
  12. )
  13. type descsByName map[protoreflect.FullName]protoreflect.Descriptor
  14. func (r descsByName) initEnumDeclarations(eds []*descriptorpb.EnumDescriptorProto, parent protoreflect.Descriptor, sb *strs.Builder) (es []filedesc.Enum, err error) {
  15. es = make([]filedesc.Enum, len(eds)) // allocate up-front to ensure stable pointers
  16. for i, ed := range eds {
  17. e := &es[i]
  18. e.L2 = new(filedesc.EnumL2)
  19. if e.L0, err = r.makeBase(e, parent, ed.GetName(), i, sb); err != nil {
  20. return nil, err
  21. }
  22. if opts := ed.GetOptions(); opts != nil {
  23. opts = proto.Clone(opts).(*descriptorpb.EnumOptions)
  24. e.L2.Options = func() protoreflect.ProtoMessage { return opts }
  25. }
  26. e.L1.EditionFeatures = mergeEditionFeatures(parent, ed.GetOptions().GetFeatures())
  27. for _, s := range ed.GetReservedName() {
  28. e.L2.ReservedNames.List = append(e.L2.ReservedNames.List, protoreflect.Name(s))
  29. }
  30. for _, rr := range ed.GetReservedRange() {
  31. e.L2.ReservedRanges.List = append(e.L2.ReservedRanges.List, [2]protoreflect.EnumNumber{
  32. protoreflect.EnumNumber(rr.GetStart()),
  33. protoreflect.EnumNumber(rr.GetEnd()),
  34. })
  35. }
  36. if e.L2.Values.List, err = r.initEnumValuesFromDescriptorProto(ed.GetValue(), e, sb); err != nil {
  37. return nil, err
  38. }
  39. }
  40. return es, nil
  41. }
  42. func (r descsByName) initEnumValuesFromDescriptorProto(vds []*descriptorpb.EnumValueDescriptorProto, parent protoreflect.Descriptor, sb *strs.Builder) (vs []filedesc.EnumValue, err error) {
  43. vs = make([]filedesc.EnumValue, len(vds)) // allocate up-front to ensure stable pointers
  44. for i, vd := range vds {
  45. v := &vs[i]
  46. if v.L0, err = r.makeBase(v, parent, vd.GetName(), i, sb); err != nil {
  47. return nil, err
  48. }
  49. if opts := vd.GetOptions(); opts != nil {
  50. opts = proto.Clone(opts).(*descriptorpb.EnumValueOptions)
  51. v.L1.Options = func() protoreflect.ProtoMessage { return opts }
  52. }
  53. v.L1.Number = protoreflect.EnumNumber(vd.GetNumber())
  54. }
  55. return vs, nil
  56. }
  57. func (r descsByName) initMessagesDeclarations(mds []*descriptorpb.DescriptorProto, parent protoreflect.Descriptor, sb *strs.Builder) (ms []filedesc.Message, err error) {
  58. ms = make([]filedesc.Message, len(mds)) // allocate up-front to ensure stable pointers
  59. for i, md := range mds {
  60. m := &ms[i]
  61. m.L2 = new(filedesc.MessageL2)
  62. if m.L0, err = r.makeBase(m, parent, md.GetName(), i, sb); err != nil {
  63. return nil, err
  64. }
  65. m.L1.EditionFeatures = mergeEditionFeatures(parent, md.GetOptions().GetFeatures())
  66. if opts := md.GetOptions(); opts != nil {
  67. opts = proto.Clone(opts).(*descriptorpb.MessageOptions)
  68. m.L2.Options = func() protoreflect.ProtoMessage { return opts }
  69. m.L1.IsMapEntry = opts.GetMapEntry()
  70. m.L1.IsMessageSet = opts.GetMessageSetWireFormat()
  71. }
  72. for _, s := range md.GetReservedName() {
  73. m.L2.ReservedNames.List = append(m.L2.ReservedNames.List, protoreflect.Name(s))
  74. }
  75. for _, rr := range md.GetReservedRange() {
  76. m.L2.ReservedRanges.List = append(m.L2.ReservedRanges.List, [2]protoreflect.FieldNumber{
  77. protoreflect.FieldNumber(rr.GetStart()),
  78. protoreflect.FieldNumber(rr.GetEnd()),
  79. })
  80. }
  81. for _, xr := range md.GetExtensionRange() {
  82. m.L2.ExtensionRanges.List = append(m.L2.ExtensionRanges.List, [2]protoreflect.FieldNumber{
  83. protoreflect.FieldNumber(xr.GetStart()),
  84. protoreflect.FieldNumber(xr.GetEnd()),
  85. })
  86. var optsFunc func() protoreflect.ProtoMessage
  87. if opts := xr.GetOptions(); opts != nil {
  88. opts = proto.Clone(opts).(*descriptorpb.ExtensionRangeOptions)
  89. optsFunc = func() protoreflect.ProtoMessage { return opts }
  90. }
  91. m.L2.ExtensionRangeOptions = append(m.L2.ExtensionRangeOptions, optsFunc)
  92. }
  93. if m.L2.Fields.List, err = r.initFieldsFromDescriptorProto(md.GetField(), m, sb); err != nil {
  94. return nil, err
  95. }
  96. if m.L2.Oneofs.List, err = r.initOneofsFromDescriptorProto(md.GetOneofDecl(), m, sb); err != nil {
  97. return nil, err
  98. }
  99. if m.L1.Enums.List, err = r.initEnumDeclarations(md.GetEnumType(), m, sb); err != nil {
  100. return nil, err
  101. }
  102. if m.L1.Messages.List, err = r.initMessagesDeclarations(md.GetNestedType(), m, sb); err != nil {
  103. return nil, err
  104. }
  105. if m.L1.Extensions.List, err = r.initExtensionDeclarations(md.GetExtension(), m, sb); err != nil {
  106. return nil, err
  107. }
  108. }
  109. return ms, nil
  110. }
  111. // canBePacked returns whether the field can use packed encoding:
  112. // https://protobuf.dev/programming-guides/encoding/#packed
  113. func canBePacked(fd *descriptorpb.FieldDescriptorProto) bool {
  114. if fd.GetLabel() != descriptorpb.FieldDescriptorProto_LABEL_REPEATED {
  115. return false // not a repeated field
  116. }
  117. switch protoreflect.Kind(fd.GetType()) {
  118. case protoreflect.MessageKind, protoreflect.GroupKind:
  119. return false // not a scalar type field
  120. case protoreflect.StringKind, protoreflect.BytesKind:
  121. // string and bytes can explicitly not be declared as packed,
  122. // see https://protobuf.dev/programming-guides/encoding/#packed
  123. return false
  124. default:
  125. return true
  126. }
  127. }
  128. func (r descsByName) initFieldsFromDescriptorProto(fds []*descriptorpb.FieldDescriptorProto, parent protoreflect.Descriptor, sb *strs.Builder) (fs []filedesc.Field, err error) {
  129. fs = make([]filedesc.Field, len(fds)) // allocate up-front to ensure stable pointers
  130. for i, fd := range fds {
  131. f := &fs[i]
  132. if f.L0, err = r.makeBase(f, parent, fd.GetName(), i, sb); err != nil {
  133. return nil, err
  134. }
  135. f.L1.EditionFeatures = mergeEditionFeatures(parent, fd.GetOptions().GetFeatures())
  136. f.L1.IsProto3Optional = fd.GetProto3Optional()
  137. if opts := fd.GetOptions(); opts != nil {
  138. opts = proto.Clone(opts).(*descriptorpb.FieldOptions)
  139. f.L1.Options = func() protoreflect.ProtoMessage { return opts }
  140. f.L1.IsWeak = opts.GetWeak()
  141. f.L1.IsLazy = opts.GetLazy()
  142. if opts.Packed != nil {
  143. f.L1.EditionFeatures.IsPacked = opts.GetPacked()
  144. }
  145. }
  146. f.L1.Number = protoreflect.FieldNumber(fd.GetNumber())
  147. f.L1.Cardinality = protoreflect.Cardinality(fd.GetLabel())
  148. if fd.Type != nil {
  149. f.L1.Kind = protoreflect.Kind(fd.GetType())
  150. }
  151. if fd.JsonName != nil {
  152. f.L1.StringName.InitJSON(fd.GetJsonName())
  153. }
  154. if f.L1.EditionFeatures.IsLegacyRequired {
  155. f.L1.Cardinality = protoreflect.Required
  156. }
  157. if f.L1.Kind == protoreflect.MessageKind && f.L1.EditionFeatures.IsDelimitedEncoded {
  158. f.L1.Kind = protoreflect.GroupKind
  159. }
  160. }
  161. return fs, nil
  162. }
  163. func (r descsByName) initOneofsFromDescriptorProto(ods []*descriptorpb.OneofDescriptorProto, parent protoreflect.Descriptor, sb *strs.Builder) (os []filedesc.Oneof, err error) {
  164. os = make([]filedesc.Oneof, len(ods)) // allocate up-front to ensure stable pointers
  165. for i, od := range ods {
  166. o := &os[i]
  167. if o.L0, err = r.makeBase(o, parent, od.GetName(), i, sb); err != nil {
  168. return nil, err
  169. }
  170. o.L1.EditionFeatures = mergeEditionFeatures(parent, od.GetOptions().GetFeatures())
  171. if opts := od.GetOptions(); opts != nil {
  172. opts = proto.Clone(opts).(*descriptorpb.OneofOptions)
  173. o.L1.Options = func() protoreflect.ProtoMessage { return opts }
  174. }
  175. }
  176. return os, nil
  177. }
  178. func (r descsByName) initExtensionDeclarations(xds []*descriptorpb.FieldDescriptorProto, parent protoreflect.Descriptor, sb *strs.Builder) (xs []filedesc.Extension, err error) {
  179. xs = make([]filedesc.Extension, len(xds)) // allocate up-front to ensure stable pointers
  180. for i, xd := range xds {
  181. x := &xs[i]
  182. x.L2 = new(filedesc.ExtensionL2)
  183. if x.L0, err = r.makeBase(x, parent, xd.GetName(), i, sb); err != nil {
  184. return nil, err
  185. }
  186. x.L1.EditionFeatures = mergeEditionFeatures(parent, xd.GetOptions().GetFeatures())
  187. if opts := xd.GetOptions(); opts != nil {
  188. opts = proto.Clone(opts).(*descriptorpb.FieldOptions)
  189. x.L2.Options = func() protoreflect.ProtoMessage { return opts }
  190. if opts.Packed != nil {
  191. x.L1.EditionFeatures.IsPacked = opts.GetPacked()
  192. }
  193. }
  194. x.L1.Number = protoreflect.FieldNumber(xd.GetNumber())
  195. x.L1.Cardinality = protoreflect.Cardinality(xd.GetLabel())
  196. if xd.Type != nil {
  197. x.L1.Kind = protoreflect.Kind(xd.GetType())
  198. }
  199. if xd.JsonName != nil {
  200. x.L2.StringName.InitJSON(xd.GetJsonName())
  201. }
  202. if x.L1.Kind == protoreflect.MessageKind && x.L1.EditionFeatures.IsDelimitedEncoded {
  203. x.L1.Kind = protoreflect.GroupKind
  204. }
  205. }
  206. return xs, nil
  207. }
  208. func (r descsByName) initServiceDeclarations(sds []*descriptorpb.ServiceDescriptorProto, parent protoreflect.Descriptor, sb *strs.Builder) (ss []filedesc.Service, err error) {
  209. ss = make([]filedesc.Service, len(sds)) // allocate up-front to ensure stable pointers
  210. for i, sd := range sds {
  211. s := &ss[i]
  212. s.L2 = new(filedesc.ServiceL2)
  213. if s.L0, err = r.makeBase(s, parent, sd.GetName(), i, sb); err != nil {
  214. return nil, err
  215. }
  216. if opts := sd.GetOptions(); opts != nil {
  217. opts = proto.Clone(opts).(*descriptorpb.ServiceOptions)
  218. s.L2.Options = func() protoreflect.ProtoMessage { return opts }
  219. }
  220. if s.L2.Methods.List, err = r.initMethodsFromDescriptorProto(sd.GetMethod(), s, sb); err != nil {
  221. return nil, err
  222. }
  223. }
  224. return ss, nil
  225. }
  226. func (r descsByName) initMethodsFromDescriptorProto(mds []*descriptorpb.MethodDescriptorProto, parent protoreflect.Descriptor, sb *strs.Builder) (ms []filedesc.Method, err error) {
  227. ms = make([]filedesc.Method, len(mds)) // allocate up-front to ensure stable pointers
  228. for i, md := range mds {
  229. m := &ms[i]
  230. if m.L0, err = r.makeBase(m, parent, md.GetName(), i, sb); err != nil {
  231. return nil, err
  232. }
  233. if opts := md.GetOptions(); opts != nil {
  234. opts = proto.Clone(opts).(*descriptorpb.MethodOptions)
  235. m.L1.Options = func() protoreflect.ProtoMessage { return opts }
  236. }
  237. m.L1.IsStreamingClient = md.GetClientStreaming()
  238. m.L1.IsStreamingServer = md.GetServerStreaming()
  239. }
  240. return ms, nil
  241. }
  242. func (r descsByName) makeBase(child, parent protoreflect.Descriptor, name string, idx int, sb *strs.Builder) (filedesc.BaseL0, error) {
  243. if !protoreflect.Name(name).IsValid() {
  244. return filedesc.BaseL0{}, errors.New("descriptor %q has an invalid nested name: %q", parent.FullName(), name)
  245. }
  246. // Derive the full name of the child.
  247. // Note that enum values are a sibling to the enum parent in the namespace.
  248. var fullName protoreflect.FullName
  249. if _, ok := parent.(protoreflect.EnumDescriptor); ok {
  250. fullName = sb.AppendFullName(parent.FullName().Parent(), protoreflect.Name(name))
  251. } else {
  252. fullName = sb.AppendFullName(parent.FullName(), protoreflect.Name(name))
  253. }
  254. if _, ok := r[fullName]; ok {
  255. return filedesc.BaseL0{}, errors.New("descriptor %q already declared", fullName)
  256. }
  257. r[fullName] = child
  258. // TODO: Verify that the full name does not already exist in the resolver?
  259. // This is not as critical since most usages of NewFile will register
  260. // the created file back into the registry, which will perform this check.
  261. return filedesc.BaseL0{
  262. FullName: fullName,
  263. ParentFile: parent.ParentFile().(*filedesc.File),
  264. Parent: parent,
  265. Index: idx,
  266. }, nil
  267. }