registry.go 24 KB

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