registry.go 24 KB

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