You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 

883 lines
25 KiB

  1. // Copyright 2018 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 protoregistry provides data structures to register and lookup
  5. // protobuf descriptor types.
  6. //
  7. // The Files registry contains file descriptors and provides the ability
  8. // to iterate over the files or lookup a specific descriptor within the files.
  9. // Files only contains protobuf descriptors and has no understanding of Go
  10. // type information that may be associated with each descriptor.
  11. //
  12. // The Types registry contains descriptor types for which there is a known
  13. // Go type associated with that descriptor. It provides the ability to iterate
  14. // over the registered types or lookup a type by name.
  15. package protoregistry
  16. import (
  17. "fmt"
  18. "os"
  19. "strings"
  20. "sync"
  21. "google.golang.org/protobuf/internal/encoding/messageset"
  22. "google.golang.org/protobuf/internal/errors"
  23. "google.golang.org/protobuf/internal/flags"
  24. "google.golang.org/protobuf/reflect/protoreflect"
  25. )
  26. // conflictPolicy configures the policy for handling registration conflicts.
  27. //
  28. // It can be over-written at compile time with a linker-initialized variable:
  29. //
  30. // go build -ldflags "-X google.golang.org/protobuf/reflect/protoregistry.conflictPolicy=warn"
  31. //
  32. // It can be over-written at program execution with an environment variable:
  33. //
  34. // GOLANG_PROTOBUF_REGISTRATION_CONFLICT=warn ./main
  35. //
  36. // Neither of the above are covered by the compatibility promise and
  37. // may be removed in a future release of this module.
  38. var conflictPolicy = "panic" // "panic" | "warn" | "ignore"
  39. // ignoreConflict reports whether to ignore a registration conflict
  40. // given the descriptor being registered and the error.
  41. // It is a variable so that the behavior is easily overridden in another file.
  42. var ignoreConflict = func(d protoreflect.Descriptor, err error) bool {
  43. const env = "GOLANG_PROTOBUF_REGISTRATION_CONFLICT"
  44. const faq = "https://protobuf.dev/reference/go/faq#namespace-conflict"
  45. policy := conflictPolicy
  46. if v := os.Getenv(env); v != "" {
  47. policy = v
  48. }
  49. switch policy {
  50. case "panic":
  51. panic(fmt.Sprintf("%v\nSee %v\n", err, faq))
  52. case "warn":
  53. fmt.Fprintf(os.Stderr, "WARNING: %v\nSee %v\n\n", err, faq)
  54. return true
  55. case "ignore":
  56. return true
  57. default:
  58. panic("invalid " + env + " value: " + os.Getenv(env))
  59. }
  60. }
  61. var globalMutex sync.RWMutex
  62. // GlobalFiles is a global registry of file descriptors.
  63. var GlobalFiles *Files = new(Files)
  64. // GlobalTypes is the registry used by default for type lookups
  65. // unless a local registry is provided by the user.
  66. var GlobalTypes *Types = new(Types)
  67. // NotFound is a sentinel error value to indicate that the type was not found.
  68. //
  69. // Since registry lookup can happen in the critical performance path, resolvers
  70. // must return this exact error value, not an error wrapping it.
  71. var NotFound = errors.New("not found")
  72. // Files is a registry for looking up or iterating over files and the
  73. // descriptors contained within them.
  74. // The Find and Range methods are safe for concurrent use.
  75. type Files struct {
  76. // The map of descsByName contains:
  77. // EnumDescriptor
  78. // EnumValueDescriptor
  79. // MessageDescriptor
  80. // ExtensionDescriptor
  81. // ServiceDescriptor
  82. // *packageDescriptor
  83. //
  84. // Note that files are stored as a slice, since a package may contain
  85. // multiple files. Only top-level declarations are registered.
  86. // Note that enum values are in the top-level since that are in the same
  87. // scope as the parent enum.
  88. descsByName map[protoreflect.FullName]interface{}
  89. filesByPath map[string][]protoreflect.FileDescriptor
  90. numFiles int
  91. }
  92. type packageDescriptor struct {
  93. files []protoreflect.FileDescriptor
  94. }
  95. // RegisterFile registers the provided file descriptor.
  96. //
  97. // If any descriptor within the file conflicts with the descriptor of any
  98. // previously registered file (e.g., two enums with the same full name),
  99. // then the file is not registered and an error is returned.
  100. //
  101. // It is permitted for multiple files to have the same file path.
  102. func (r *Files) RegisterFile(file protoreflect.FileDescriptor) error {
  103. if r == GlobalFiles {
  104. globalMutex.Lock()
  105. defer globalMutex.Unlock()
  106. }
  107. if r.descsByName == nil {
  108. r.descsByName = map[protoreflect.FullName]interface{}{
  109. "": &packageDescriptor{},
  110. }
  111. r.filesByPath = make(map[string][]protoreflect.FileDescriptor)
  112. }
  113. path := file.Path()
  114. if prev := r.filesByPath[path]; len(prev) > 0 {
  115. r.checkGenProtoConflict(path)
  116. err := errors.New("file %q is already registered", file.Path())
  117. err = amendErrorWithCaller(err, prev[0], file)
  118. if !(r == GlobalFiles && ignoreConflict(file, err)) {
  119. return err
  120. }
  121. }
  122. for name := file.Package(); name != ""; name = name.Parent() {
  123. switch prev := r.descsByName[name]; prev.(type) {
  124. case nil, *packageDescriptor:
  125. default:
  126. err := errors.New("file %q has a package name conflict over %v", file.Path(), name)
  127. err = amendErrorWithCaller(err, prev, file)
  128. if r == GlobalFiles && ignoreConflict(file, err) {
  129. err = nil
  130. }
  131. return err
  132. }
  133. }
  134. var err error
  135. var hasConflict bool
  136. rangeTopLevelDescriptors(file, func(d protoreflect.Descriptor) {
  137. if prev := r.descsByName[d.FullName()]; prev != nil {
  138. hasConflict = true
  139. err = errors.New("file %q has a name conflict over %v", file.Path(), d.FullName())
  140. err = amendErrorWithCaller(err, prev, file)
  141. if r == GlobalFiles && ignoreConflict(d, err) {
  142. err = nil
  143. }
  144. }
  145. })
  146. if hasConflict {
  147. return err
  148. }
  149. for name := file.Package(); name != ""; name = name.Parent() {
  150. if r.descsByName[name] == nil {
  151. r.descsByName[name] = &packageDescriptor{}
  152. }
  153. }
  154. p := r.descsByName[file.Package()].(*packageDescriptor)
  155. p.files = append(p.files, file)
  156. rangeTopLevelDescriptors(file, func(d protoreflect.Descriptor) {
  157. r.descsByName[d.FullName()] = d
  158. })
  159. r.filesByPath[path] = append(r.filesByPath[path], file)
  160. r.numFiles++
  161. return nil
  162. }
  163. // Several well-known types were hosted in the google.golang.org/genproto module
  164. // but were later moved to this module. To avoid a weak dependency on the
  165. // genproto module (and its relatively large set of transitive dependencies),
  166. // we rely on a registration conflict to determine whether the genproto version
  167. // is too old (i.e., does not contain aliases to the new type declarations).
  168. func (r *Files) checkGenProtoConflict(path string) {
  169. if r != GlobalFiles {
  170. return
  171. }
  172. var prevPath string
  173. const prevModule = "google.golang.org/genproto"
  174. const prevVersion = "cb27e3aa (May 26th, 2020)"
  175. switch path {
  176. case "google/protobuf/field_mask.proto":
  177. prevPath = prevModule + "/protobuf/field_mask"
  178. case "google/protobuf/api.proto":
  179. prevPath = prevModule + "/protobuf/api"
  180. case "google/protobuf/type.proto":
  181. prevPath = prevModule + "/protobuf/ptype"
  182. case "google/protobuf/source_context.proto":
  183. prevPath = prevModule + "/protobuf/source_context"
  184. default:
  185. return
  186. }
  187. pkgName := strings.TrimSuffix(strings.TrimPrefix(path, "google/protobuf/"), ".proto")
  188. pkgName = strings.Replace(pkgName, "_", "", -1) + "pb" // e.g., "field_mask" => "fieldmaskpb"
  189. currPath := "google.golang.org/protobuf/types/known/" + pkgName
  190. panic(fmt.Sprintf(""+
  191. "duplicate registration of %q\n"+
  192. "\n"+
  193. "The generated definition for this file has moved:\n"+
  194. "\tfrom: %q\n"+
  195. "\tto: %q\n"+
  196. "A dependency on the %q module must\n"+
  197. "be at version %v or higher.\n"+
  198. "\n"+
  199. "Upgrade the dependency by running:\n"+
  200. "\tgo get -u %v\n",
  201. path, prevPath, currPath, prevModule, prevVersion, prevPath))
  202. }
  203. // FindDescriptorByName looks up a descriptor by the full name.
  204. //
  205. // This returns (nil, NotFound) if not found.
  206. func (r *Files) FindDescriptorByName(name protoreflect.FullName) (protoreflect.Descriptor, error) {
  207. if r == nil {
  208. return nil, NotFound
  209. }
  210. if r == GlobalFiles {
  211. globalMutex.RLock()
  212. defer globalMutex.RUnlock()
  213. }
  214. prefix := name
  215. suffix := nameSuffix("")
  216. for prefix != "" {
  217. if d, ok := r.descsByName[prefix]; ok {
  218. switch d := d.(type) {
  219. case protoreflect.EnumDescriptor:
  220. if d.FullName() == name {
  221. return d, nil
  222. }
  223. case protoreflect.EnumValueDescriptor:
  224. if d.FullName() == name {
  225. return d, nil
  226. }
  227. case protoreflect.MessageDescriptor:
  228. if d.FullName() == name {
  229. return d, nil
  230. }
  231. if d := findDescriptorInMessage(d, suffix); d != nil && d.FullName() == name {
  232. return d, nil
  233. }
  234. case protoreflect.ExtensionDescriptor:
  235. if d.FullName() == name {
  236. return d, nil
  237. }
  238. case protoreflect.ServiceDescriptor:
  239. if d.FullName() == name {
  240. return d, nil
  241. }
  242. if d := d.Methods().ByName(suffix.Pop()); d != nil && d.FullName() == name {
  243. return d, nil
  244. }
  245. }
  246. return nil, NotFound
  247. }
  248. prefix = prefix.Parent()
  249. suffix = nameSuffix(name[len(prefix)+len("."):])
  250. }
  251. return nil, NotFound
  252. }
  253. func findDescriptorInMessage(md protoreflect.MessageDescriptor, suffix nameSuffix) protoreflect.Descriptor {
  254. name := suffix.Pop()
  255. if suffix == "" {
  256. if ed := md.Enums().ByName(name); ed != nil {
  257. return ed
  258. }
  259. for i := md.Enums().Len() - 1; i >= 0; i-- {
  260. if vd := md.Enums().Get(i).Values().ByName(name); vd != nil {
  261. return vd
  262. }
  263. }
  264. if xd := md.Extensions().ByName(name); xd != nil {
  265. return xd
  266. }
  267. if fd := md.Fields().ByName(name); fd != nil {
  268. return fd
  269. }
  270. if od := md.Oneofs().ByName(name); od != nil {
  271. return od
  272. }
  273. }
  274. if md := md.Messages().ByName(name); md != nil {
  275. if suffix == "" {
  276. return md
  277. }
  278. return findDescriptorInMessage(md, suffix)
  279. }
  280. return nil
  281. }
  282. type nameSuffix string
  283. func (s *nameSuffix) Pop() (name protoreflect.Name) {
  284. if i := strings.IndexByte(string(*s), '.'); i >= 0 {
  285. name, *s = protoreflect.Name((*s)[:i]), (*s)[i+1:]
  286. } else {
  287. name, *s = protoreflect.Name((*s)), ""
  288. }
  289. return name
  290. }
  291. // FindFileByPath looks up a file by the path.
  292. //
  293. // This returns (nil, NotFound) if not found.
  294. // This returns an error if multiple files have the same path.
  295. func (r *Files) FindFileByPath(path string) (protoreflect.FileDescriptor, error) {
  296. if r == nil {
  297. return nil, NotFound
  298. }
  299. if r == GlobalFiles {
  300. globalMutex.RLock()
  301. defer globalMutex.RUnlock()
  302. }
  303. fds := r.filesByPath[path]
  304. switch len(fds) {
  305. case 0:
  306. return nil, NotFound
  307. case 1:
  308. return fds[0], nil
  309. default:
  310. return nil, errors.New("multiple files named %q", path)
  311. }
  312. }
  313. // NumFiles reports the number of registered files,
  314. // including duplicate files with the same name.
  315. func (r *Files) NumFiles() int {
  316. if r == nil {
  317. return 0
  318. }
  319. if r == GlobalFiles {
  320. globalMutex.RLock()
  321. defer globalMutex.RUnlock()
  322. }
  323. return r.numFiles
  324. }
  325. // RangeFiles iterates over all registered files while f returns true.
  326. // If multiple files have the same name, RangeFiles iterates over all of them.
  327. // The iteration order is undefined.
  328. func (r *Files) RangeFiles(f func(protoreflect.FileDescriptor) bool) {
  329. if r == nil {
  330. return
  331. }
  332. if r == GlobalFiles {
  333. globalMutex.RLock()
  334. defer globalMutex.RUnlock()
  335. }
  336. for _, files := range r.filesByPath {
  337. for _, file := range files {
  338. if !f(file) {
  339. return
  340. }
  341. }
  342. }
  343. }
  344. // NumFilesByPackage reports the number of registered files in a proto package.
  345. func (r *Files) NumFilesByPackage(name protoreflect.FullName) int {
  346. if r == nil {
  347. return 0
  348. }
  349. if r == GlobalFiles {
  350. globalMutex.RLock()
  351. defer globalMutex.RUnlock()
  352. }
  353. p, ok := r.descsByName[name].(*packageDescriptor)
  354. if !ok {
  355. return 0
  356. }
  357. return len(p.files)
  358. }
  359. // RangeFilesByPackage iterates over all registered files in a given proto package
  360. // while f returns true. The iteration order is undefined.
  361. func (r *Files) RangeFilesByPackage(name protoreflect.FullName, f func(protoreflect.FileDescriptor) bool) {
  362. if r == nil {
  363. return
  364. }
  365. if r == GlobalFiles {
  366. globalMutex.RLock()
  367. defer globalMutex.RUnlock()
  368. }
  369. p, ok := r.descsByName[name].(*packageDescriptor)
  370. if !ok {
  371. return
  372. }
  373. for _, file := range p.files {
  374. if !f(file) {
  375. return
  376. }
  377. }
  378. }
  379. // rangeTopLevelDescriptors iterates over all top-level descriptors in a file
  380. // which will be directly entered into the registry.
  381. func rangeTopLevelDescriptors(fd protoreflect.FileDescriptor, f func(protoreflect.Descriptor)) {
  382. eds := fd.Enums()
  383. for i := eds.Len() - 1; i >= 0; i-- {
  384. f(eds.Get(i))
  385. vds := eds.Get(i).Values()
  386. for i := vds.Len() - 1; i >= 0; i-- {
  387. f(vds.Get(i))
  388. }
  389. }
  390. mds := fd.Messages()
  391. for i := mds.Len() - 1; i >= 0; i-- {
  392. f(mds.Get(i))
  393. }
  394. xds := fd.Extensions()
  395. for i := xds.Len() - 1; i >= 0; i-- {
  396. f(xds.Get(i))
  397. }
  398. sds := fd.Services()
  399. for i := sds.Len() - 1; i >= 0; i-- {
  400. f(sds.Get(i))
  401. }
  402. }
  403. // MessageTypeResolver is an interface for looking up messages.
  404. //
  405. // A compliant implementation must deterministically return the same type
  406. // if no error is encountered.
  407. //
  408. // The Types type implements this interface.
  409. type MessageTypeResolver interface {
  410. // FindMessageByName looks up a message by its full name.
  411. // E.g., "google.protobuf.Any"
  412. //
  413. // This return (nil, NotFound) if not found.
  414. FindMessageByName(message protoreflect.FullName) (protoreflect.MessageType, error)
  415. // FindMessageByURL looks up a message by a URL identifier.
  416. // See documentation on google.protobuf.Any.type_url for the URL format.
  417. //
  418. // This returns (nil, NotFound) if not found.
  419. FindMessageByURL(url string) (protoreflect.MessageType, error)
  420. }
  421. // ExtensionTypeResolver is an interface for looking up extensions.
  422. //
  423. // A compliant implementation must deterministically return the same type
  424. // if no error is encountered.
  425. //
  426. // The Types type implements this interface.
  427. type ExtensionTypeResolver interface {
  428. // FindExtensionByName looks up a extension field by the field's full name.
  429. // Note that this is the full name of the field as determined by
  430. // where the extension is declared and is unrelated to the full name of the
  431. // message being extended.
  432. //
  433. // This returns (nil, NotFound) if not found.
  434. FindExtensionByName(field protoreflect.FullName) (protoreflect.ExtensionType, error)
  435. // FindExtensionByNumber looks up a extension field by the field number
  436. // within some parent message, identified by full name.
  437. //
  438. // This returns (nil, NotFound) if not found.
  439. FindExtensionByNumber(message protoreflect.FullName, field protoreflect.FieldNumber) (protoreflect.ExtensionType, error)
  440. }
  441. var (
  442. _ MessageTypeResolver = (*Types)(nil)
  443. _ ExtensionTypeResolver = (*Types)(nil)
  444. )
  445. // Types is a registry for looking up or iterating over descriptor types.
  446. // The Find and Range methods are safe for concurrent use.
  447. type Types struct {
  448. typesByName typesByName
  449. extensionsByMessage extensionsByMessage
  450. numEnums int
  451. numMessages int
  452. numExtensions int
  453. }
  454. type (
  455. typesByName map[protoreflect.FullName]interface{}
  456. extensionsByMessage map[protoreflect.FullName]extensionsByNumber
  457. extensionsByNumber map[protoreflect.FieldNumber]protoreflect.ExtensionType
  458. )
  459. // RegisterMessage registers the provided message type.
  460. //
  461. // If a naming conflict occurs, the type is not registered and an error is returned.
  462. func (r *Types) RegisterMessage(mt protoreflect.MessageType) error {
  463. // Under rare circumstances getting the descriptor might recursively
  464. // examine the registry, so fetch it before locking.
  465. md := mt.Descriptor()
  466. if r == GlobalTypes {
  467. globalMutex.Lock()
  468. defer globalMutex.Unlock()
  469. }
  470. if err := r.register("message", md, mt); err != nil {
  471. return err
  472. }
  473. r.numMessages++
  474. return nil
  475. }
  476. // RegisterEnum registers the provided enum type.
  477. //
  478. // If a naming conflict occurs, the type is not registered and an error is returned.
  479. func (r *Types) RegisterEnum(et protoreflect.EnumType) error {
  480. // Under rare circumstances getting the descriptor might recursively
  481. // examine the registry, so fetch it before locking.
  482. ed := et.Descriptor()
  483. if r == GlobalTypes {
  484. globalMutex.Lock()
  485. defer globalMutex.Unlock()
  486. }
  487. if err := r.register("enum", ed, et); err != nil {
  488. return err
  489. }
  490. r.numEnums++
  491. return nil
  492. }
  493. // RegisterExtension registers the provided extension type.
  494. //
  495. // If a naming conflict occurs, the type is not registered and an error is returned.
  496. func (r *Types) RegisterExtension(xt protoreflect.ExtensionType) error {
  497. // Under rare circumstances getting the descriptor might recursively
  498. // examine the registry, so fetch it before locking.
  499. //
  500. // A known case where this can happen: Fetching the TypeDescriptor for a
  501. // legacy ExtensionDesc can consult the global registry.
  502. xd := xt.TypeDescriptor()
  503. if r == GlobalTypes {
  504. globalMutex.Lock()
  505. defer globalMutex.Unlock()
  506. }
  507. field := xd.Number()
  508. message := xd.ContainingMessage().FullName()
  509. if prev := r.extensionsByMessage[message][field]; prev != nil {
  510. err := errors.New("extension number %d is already registered on message %v", field, message)
  511. err = amendErrorWithCaller(err, prev, xt)
  512. if !(r == GlobalTypes && ignoreConflict(xd, err)) {
  513. return err
  514. }
  515. }
  516. if err := r.register("extension", xd, xt); err != nil {
  517. return err
  518. }
  519. if r.extensionsByMessage == nil {
  520. r.extensionsByMessage = make(extensionsByMessage)
  521. }
  522. if r.extensionsByMessage[message] == nil {
  523. r.extensionsByMessage[message] = make(extensionsByNumber)
  524. }
  525. r.extensionsByMessage[message][field] = xt
  526. r.numExtensions++
  527. return nil
  528. }
  529. func (r *Types) register(kind string, desc protoreflect.Descriptor, typ interface{}) error {
  530. name := desc.FullName()
  531. prev := r.typesByName[name]
  532. if prev != nil {
  533. err := errors.New("%v %v is already registered", kind, name)
  534. err = amendErrorWithCaller(err, prev, typ)
  535. if !(r == GlobalTypes && ignoreConflict(desc, err)) {
  536. return err
  537. }
  538. }
  539. if r.typesByName == nil {
  540. r.typesByName = make(typesByName)
  541. }
  542. r.typesByName[name] = typ
  543. return nil
  544. }
  545. // FindEnumByName looks up an enum by its full name.
  546. // E.g., "google.protobuf.Field.Kind".
  547. //
  548. // This returns (nil, NotFound) if not found.
  549. func (r *Types) FindEnumByName(enum protoreflect.FullName) (protoreflect.EnumType, error) {
  550. if r == nil {
  551. return nil, NotFound
  552. }
  553. if r == GlobalTypes {
  554. globalMutex.RLock()
  555. defer globalMutex.RUnlock()
  556. }
  557. if v := r.typesByName[enum]; v != nil {
  558. if et, _ := v.(protoreflect.EnumType); et != nil {
  559. return et, nil
  560. }
  561. return nil, errors.New("found wrong type: got %v, want enum", typeName(v))
  562. }
  563. return nil, NotFound
  564. }
  565. // FindMessageByName looks up a message by its full name,
  566. // e.g. "google.protobuf.Any".
  567. //
  568. // This returns (nil, NotFound) if not found.
  569. func (r *Types) FindMessageByName(message protoreflect.FullName) (protoreflect.MessageType, error) {
  570. if r == nil {
  571. return nil, NotFound
  572. }
  573. if r == GlobalTypes {
  574. globalMutex.RLock()
  575. defer globalMutex.RUnlock()
  576. }
  577. if v := r.typesByName[message]; v != nil {
  578. if mt, _ := v.(protoreflect.MessageType); mt != nil {
  579. return mt, nil
  580. }
  581. return nil, errors.New("found wrong type: got %v, want message", typeName(v))
  582. }
  583. return nil, NotFound
  584. }
  585. // FindMessageByURL looks up a message by a URL identifier.
  586. // See documentation on google.protobuf.Any.type_url for the URL format.
  587. //
  588. // This returns (nil, NotFound) if not found.
  589. func (r *Types) FindMessageByURL(url string) (protoreflect.MessageType, error) {
  590. // This function is similar to FindMessageByName but
  591. // truncates anything before and including '/' in the URL.
  592. if r == nil {
  593. return nil, NotFound
  594. }
  595. if r == GlobalTypes {
  596. globalMutex.RLock()
  597. defer globalMutex.RUnlock()
  598. }
  599. message := protoreflect.FullName(url)
  600. if i := strings.LastIndexByte(url, '/'); i >= 0 {
  601. message = message[i+len("/"):]
  602. }
  603. if v := r.typesByName[message]; v != nil {
  604. if mt, _ := v.(protoreflect.MessageType); mt != nil {
  605. return mt, nil
  606. }
  607. return nil, errors.New("found wrong type: got %v, want message", typeName(v))
  608. }
  609. return nil, NotFound
  610. }
  611. // FindExtensionByName looks up a extension field by the field's full name.
  612. // Note that this is the full name of the field as determined by
  613. // where the extension is declared and is unrelated to the full name of the
  614. // message being extended.
  615. //
  616. // This returns (nil, NotFound) if not found.
  617. func (r *Types) FindExtensionByName(field protoreflect.FullName) (protoreflect.ExtensionType, error) {
  618. if r == nil {
  619. return nil, NotFound
  620. }
  621. if r == GlobalTypes {
  622. globalMutex.RLock()
  623. defer globalMutex.RUnlock()
  624. }
  625. if v := r.typesByName[field]; v != nil {
  626. if xt, _ := v.(protoreflect.ExtensionType); xt != nil {
  627. return xt, nil
  628. }
  629. // MessageSet extensions are special in that the name of the extension
  630. // is the name of the message type used to extend the MessageSet.
  631. // This naming scheme is used by text and JSON serialization.
  632. //
  633. // This feature is protected by the ProtoLegacy flag since MessageSets
  634. // are a proto1 feature that is long deprecated.
  635. if flags.ProtoLegacy {
  636. if _, ok := v.(protoreflect.MessageType); ok {
  637. field := field.Append(messageset.ExtensionName)
  638. if v := r.typesByName[field]; v != nil {
  639. if xt, _ := v.(protoreflect.ExtensionType); xt != nil {
  640. if messageset.IsMessageSetExtension(xt.TypeDescriptor()) {
  641. return xt, nil
  642. }
  643. }
  644. }
  645. }
  646. }
  647. return nil, errors.New("found wrong type: got %v, want extension", typeName(v))
  648. }
  649. return nil, NotFound
  650. }
  651. // FindExtensionByNumber looks up a extension field by the field number
  652. // within some parent message, identified by full name.
  653. //
  654. // This returns (nil, NotFound) if not found.
  655. func (r *Types) FindExtensionByNumber(message protoreflect.FullName, field protoreflect.FieldNumber) (protoreflect.ExtensionType, error) {
  656. if r == nil {
  657. return nil, NotFound
  658. }
  659. if r == GlobalTypes {
  660. globalMutex.RLock()
  661. defer globalMutex.RUnlock()
  662. }
  663. if xt, ok := r.extensionsByMessage[message][field]; ok {
  664. return xt, nil
  665. }
  666. return nil, NotFound
  667. }
  668. // NumEnums reports the number of registered enums.
  669. func (r *Types) NumEnums() int {
  670. if r == nil {
  671. return 0
  672. }
  673. if r == GlobalTypes {
  674. globalMutex.RLock()
  675. defer globalMutex.RUnlock()
  676. }
  677. return r.numEnums
  678. }
  679. // RangeEnums iterates over all registered enums while f returns true.
  680. // Iteration order is undefined.
  681. func (r *Types) RangeEnums(f func(protoreflect.EnumType) bool) {
  682. if r == nil {
  683. return
  684. }
  685. if r == GlobalTypes {
  686. globalMutex.RLock()
  687. defer globalMutex.RUnlock()
  688. }
  689. for _, typ := range r.typesByName {
  690. if et, ok := typ.(protoreflect.EnumType); ok {
  691. if !f(et) {
  692. return
  693. }
  694. }
  695. }
  696. }
  697. // NumMessages reports the number of registered messages.
  698. func (r *Types) NumMessages() int {
  699. if r == nil {
  700. return 0
  701. }
  702. if r == GlobalTypes {
  703. globalMutex.RLock()
  704. defer globalMutex.RUnlock()
  705. }
  706. return r.numMessages
  707. }
  708. // RangeMessages iterates over all registered messages while f returns true.
  709. // Iteration order is undefined.
  710. func (r *Types) RangeMessages(f func(protoreflect.MessageType) bool) {
  711. if r == nil {
  712. return
  713. }
  714. if r == GlobalTypes {
  715. globalMutex.RLock()
  716. defer globalMutex.RUnlock()
  717. }
  718. for _, typ := range r.typesByName {
  719. if mt, ok := typ.(protoreflect.MessageType); ok {
  720. if !f(mt) {
  721. return
  722. }
  723. }
  724. }
  725. }
  726. // NumExtensions reports the number of registered extensions.
  727. func (r *Types) NumExtensions() int {
  728. if r == nil {
  729. return 0
  730. }
  731. if r == GlobalTypes {
  732. globalMutex.RLock()
  733. defer globalMutex.RUnlock()
  734. }
  735. return r.numExtensions
  736. }
  737. // RangeExtensions iterates over all registered extensions while f returns true.
  738. // Iteration order is undefined.
  739. func (r *Types) RangeExtensions(f func(protoreflect.ExtensionType) bool) {
  740. if r == nil {
  741. return
  742. }
  743. if r == GlobalTypes {
  744. globalMutex.RLock()
  745. defer globalMutex.RUnlock()
  746. }
  747. for _, typ := range r.typesByName {
  748. if xt, ok := typ.(protoreflect.ExtensionType); ok {
  749. if !f(xt) {
  750. return
  751. }
  752. }
  753. }
  754. }
  755. // NumExtensionsByMessage reports the number of registered extensions for
  756. // a given message type.
  757. func (r *Types) NumExtensionsByMessage(message protoreflect.FullName) int {
  758. if r == nil {
  759. return 0
  760. }
  761. if r == GlobalTypes {
  762. globalMutex.RLock()
  763. defer globalMutex.RUnlock()
  764. }
  765. return len(r.extensionsByMessage[message])
  766. }
  767. // RangeExtensionsByMessage iterates over all registered extensions filtered
  768. // by a given message type while f returns true. Iteration order is undefined.
  769. func (r *Types) RangeExtensionsByMessage(message protoreflect.FullName, f func(protoreflect.ExtensionType) bool) {
  770. if r == nil {
  771. return
  772. }
  773. if r == GlobalTypes {
  774. globalMutex.RLock()
  775. defer globalMutex.RUnlock()
  776. }
  777. for _, xt := range r.extensionsByMessage[message] {
  778. if !f(xt) {
  779. return
  780. }
  781. }
  782. }
  783. func typeName(t interface{}) string {
  784. switch t.(type) {
  785. case protoreflect.EnumType:
  786. return "enum"
  787. case protoreflect.MessageType:
  788. return "message"
  789. case protoreflect.ExtensionType:
  790. return "extension"
  791. default:
  792. return fmt.Sprintf("%T", t)
  793. }
  794. }
  795. func amendErrorWithCaller(err error, prev, curr interface{}) error {
  796. prevPkg := goPackage(prev)
  797. currPkg := goPackage(curr)
  798. if prevPkg == "" || currPkg == "" || prevPkg == currPkg {
  799. return err
  800. }
  801. return errors.New("%s\n\tpreviously from: %q\n\tcurrently from: %q", err, prevPkg, currPkg)
  802. }
  803. func goPackage(v interface{}) string {
  804. switch d := v.(type) {
  805. case protoreflect.EnumType:
  806. v = d.Descriptor()
  807. case protoreflect.MessageType:
  808. v = d.Descriptor()
  809. case protoreflect.ExtensionType:
  810. v = d.TypeDescriptor()
  811. }
  812. if d, ok := v.(protoreflect.Descriptor); ok {
  813. v = d.ParentFile()
  814. }
  815. if d, ok := v.(interface{ GoPackagePath() string }); ok {
  816. return d.GoPackagePath()
  817. }
  818. return ""
  819. }