| khenaidoo | 0927c72 | 2021-12-15 16:49:32 -0500 | [diff] [blame] | 1 | package desc |
| 2 | |
| 3 | import ( |
| Abhay Kumar | 40252eb | 2025-10-13 13:25:53 +0000 | [diff] [blame^] | 4 | "errors" |
| khenaidoo | 0927c72 | 2021-12-15 16:49:32 -0500 | [diff] [blame] | 5 | "fmt" |
| 6 | "reflect" |
| 7 | "sync" |
| 8 | |
| 9 | "github.com/golang/protobuf/proto" |
| Abhay Kumar | 40252eb | 2025-10-13 13:25:53 +0000 | [diff] [blame^] | 10 | "google.golang.org/protobuf/reflect/protoreflect" |
| 11 | "google.golang.org/protobuf/reflect/protoregistry" |
| 12 | "google.golang.org/protobuf/types/descriptorpb" |
| khenaidoo | 0927c72 | 2021-12-15 16:49:32 -0500 | [diff] [blame] | 13 | |
| Abhay Kumar | 40252eb | 2025-10-13 13:25:53 +0000 | [diff] [blame^] | 14 | "github.com/jhump/protoreflect/desc/sourceinfo" |
| khenaidoo | 0927c72 | 2021-12-15 16:49:32 -0500 | [diff] [blame] | 15 | "github.com/jhump/protoreflect/internal" |
| 16 | ) |
| 17 | |
| Abhay Kumar | 40252eb | 2025-10-13 13:25:53 +0000 | [diff] [blame^] | 18 | // The global cache is used to store descriptors that wrap items in |
| 19 | // protoregistry.GlobalTypes and protoregistry.GlobalFiles. This prevents |
| 20 | // repeating work to re-wrap underlying global descriptors. |
| khenaidoo | 0927c72 | 2021-12-15 16:49:32 -0500 | [diff] [blame] | 21 | var ( |
| Abhay Kumar | 40252eb | 2025-10-13 13:25:53 +0000 | [diff] [blame^] | 22 | // We put all wrapped file and message descriptors in this cache. |
| 23 | loadedDescriptors = lockingCache{cache: mapCache{}} |
| 24 | |
| 25 | // Unfortunately, we need a different mechanism for enums for |
| 26 | // compatibility with old APIs, which required that they were |
| 27 | // registered in a different way :( |
| 28 | loadedEnumsMu sync.RWMutex |
| 29 | loadedEnums = map[reflect.Type]*EnumDescriptor{} |
| khenaidoo | 0927c72 | 2021-12-15 16:49:32 -0500 | [diff] [blame] | 30 | ) |
| 31 | |
| 32 | // LoadFileDescriptor creates a file descriptor using the bytes returned by |
| 33 | // proto.FileDescriptor. Descriptors are cached so that they do not need to be |
| 34 | // re-processed if the same file is fetched again later. |
| 35 | func LoadFileDescriptor(file string) (*FileDescriptor, error) { |
| Abhay Kumar | 40252eb | 2025-10-13 13:25:53 +0000 | [diff] [blame^] | 36 | d, err := sourceinfo.GlobalFiles.FindFileByPath(file) |
| 37 | if errors.Is(err, protoregistry.NotFound) { |
| 38 | // for backwards compatibility, see if this matches a known old |
| 39 | // alias for the file (older versions of libraries that registered |
| 40 | // the files using incorrect/non-canonical paths) |
| 41 | if alt := internal.StdFileAliases[file]; alt != "" { |
| 42 | d, err = sourceinfo.GlobalFiles.FindFileByPath(alt) |
| khenaidoo | 0927c72 | 2021-12-15 16:49:32 -0500 | [diff] [blame] | 43 | } |
| 44 | } |
| Abhay Kumar | 40252eb | 2025-10-13 13:25:53 +0000 | [diff] [blame^] | 45 | if err != nil { |
| 46 | if !errors.Is(err, protoregistry.NotFound) { |
| 47 | return nil, internal.ErrNoSuchFile(file) |
| 48 | } |
| 49 | return nil, err |
| khenaidoo | 0927c72 | 2021-12-15 16:49:32 -0500 | [diff] [blame] | 50 | } |
| Abhay Kumar | 40252eb | 2025-10-13 13:25:53 +0000 | [diff] [blame^] | 51 | if fd := loadedDescriptors.get(d); fd != nil { |
| 52 | return fd.(*FileDescriptor), nil |
| 53 | } |
| khenaidoo | 0927c72 | 2021-12-15 16:49:32 -0500 | [diff] [blame] | 54 | |
| Abhay Kumar | 40252eb | 2025-10-13 13:25:53 +0000 | [diff] [blame^] | 55 | var fd *FileDescriptor |
| 56 | loadedDescriptors.withLock(func(cache descriptorCache) { |
| 57 | fd, err = wrapFile(d, cache) |
| 58 | }) |
| 59 | return fd, err |
| khenaidoo | 0927c72 | 2021-12-15 16:49:32 -0500 | [diff] [blame] | 60 | } |
| 61 | |
| 62 | // LoadMessageDescriptor loads descriptor using the encoded descriptor proto returned by |
| 63 | // Message.Descriptor() for the given message type. If the given type is not recognized, |
| 64 | // then a nil descriptor is returned. |
| 65 | func LoadMessageDescriptor(message string) (*MessageDescriptor, error) { |
| Abhay Kumar | 40252eb | 2025-10-13 13:25:53 +0000 | [diff] [blame^] | 66 | mt, err := sourceinfo.GlobalTypes.FindMessageByName(protoreflect.FullName(message)) |
| 67 | if err != nil { |
| 68 | if errors.Is(err, protoregistry.NotFound) { |
| 69 | return nil, nil |
| 70 | } |
| 71 | return nil, err |
| 72 | } |
| 73 | return loadMessageDescriptor(mt.Descriptor()) |
| khenaidoo | 0927c72 | 2021-12-15 16:49:32 -0500 | [diff] [blame] | 74 | } |
| 75 | |
| Abhay Kumar | 40252eb | 2025-10-13 13:25:53 +0000 | [diff] [blame^] | 76 | func loadMessageDescriptor(md protoreflect.MessageDescriptor) (*MessageDescriptor, error) { |
| 77 | d := loadedDescriptors.get(md) |
| 78 | if d != nil { |
| 79 | return d.(*MessageDescriptor), nil |
| khenaidoo | 0927c72 | 2021-12-15 16:49:32 -0500 | [diff] [blame] | 80 | } |
| 81 | |
| Abhay Kumar | 40252eb | 2025-10-13 13:25:53 +0000 | [diff] [blame^] | 82 | var err error |
| 83 | loadedDescriptors.withLock(func(cache descriptorCache) { |
| 84 | d, err = wrapMessage(md, cache) |
| 85 | }) |
| khenaidoo | 0927c72 | 2021-12-15 16:49:32 -0500 | [diff] [blame] | 86 | if err != nil { |
| 87 | return nil, err |
| 88 | } |
| Abhay Kumar | 40252eb | 2025-10-13 13:25:53 +0000 | [diff] [blame^] | 89 | return d.(*MessageDescriptor), err |
| khenaidoo | 0927c72 | 2021-12-15 16:49:32 -0500 | [diff] [blame] | 90 | } |
| 91 | |
| 92 | // LoadMessageDescriptorForType loads descriptor using the encoded descriptor proto returned |
| 93 | // by message.Descriptor() for the given message type. If the given type is not recognized, |
| 94 | // then a nil descriptor is returned. |
| 95 | func LoadMessageDescriptorForType(messageType reflect.Type) (*MessageDescriptor, error) { |
| khenaidoo | 0927c72 | 2021-12-15 16:49:32 -0500 | [diff] [blame] | 96 | m, err := messageFromType(messageType) |
| 97 | if err != nil { |
| 98 | return nil, err |
| 99 | } |
| Abhay Kumar | 40252eb | 2025-10-13 13:25:53 +0000 | [diff] [blame^] | 100 | return LoadMessageDescriptorForMessage(m) |
| khenaidoo | 0927c72 | 2021-12-15 16:49:32 -0500 | [diff] [blame] | 101 | } |
| 102 | |
| 103 | // LoadMessageDescriptorForMessage loads descriptor using the encoded descriptor proto |
| 104 | // returned by message.Descriptor(). If the given type is not recognized, then a nil |
| 105 | // descriptor is returned. |
| 106 | func LoadMessageDescriptorForMessage(message proto.Message) (*MessageDescriptor, error) { |
| khenaidoo | 0927c72 | 2021-12-15 16:49:32 -0500 | [diff] [blame] | 107 | // efficiently handle dynamic messages |
| 108 | type descriptorable interface { |
| 109 | GetMessageDescriptor() *MessageDescriptor |
| 110 | } |
| 111 | if d, ok := message.(descriptorable); ok { |
| 112 | return d.GetMessageDescriptor(), nil |
| 113 | } |
| 114 | |
| Abhay Kumar | 40252eb | 2025-10-13 13:25:53 +0000 | [diff] [blame^] | 115 | var md protoreflect.MessageDescriptor |
| 116 | if m, ok := message.(protoreflect.ProtoMessage); ok { |
| 117 | md = m.ProtoReflect().Descriptor() |
| 118 | } else { |
| 119 | md = proto.MessageReflect(message).Descriptor() |
| khenaidoo | 0927c72 | 2021-12-15 16:49:32 -0500 | [diff] [blame] | 120 | } |
| Abhay Kumar | 40252eb | 2025-10-13 13:25:53 +0000 | [diff] [blame^] | 121 | return loadMessageDescriptor(sourceinfo.WrapMessage(md)) |
| khenaidoo | 0927c72 | 2021-12-15 16:49:32 -0500 | [diff] [blame] | 122 | } |
| 123 | |
| Abhay Kumar | 40252eb | 2025-10-13 13:25:53 +0000 | [diff] [blame^] | 124 | func messageFromType(mt reflect.Type) (proto.Message, error) { |
| khenaidoo | 0927c72 | 2021-12-15 16:49:32 -0500 | [diff] [blame] | 125 | if mt.Kind() != reflect.Ptr { |
| 126 | mt = reflect.PtrTo(mt) |
| 127 | } |
| Abhay Kumar | 40252eb | 2025-10-13 13:25:53 +0000 | [diff] [blame^] | 128 | m, ok := reflect.Zero(mt).Interface().(proto.Message) |
| khenaidoo | 0927c72 | 2021-12-15 16:49:32 -0500 | [diff] [blame] | 129 | if !ok { |
| 130 | return nil, fmt.Errorf("failed to create message from type: %v", mt) |
| 131 | } |
| 132 | return m, nil |
| 133 | } |
| 134 | |
| khenaidoo | 0927c72 | 2021-12-15 16:49:32 -0500 | [diff] [blame] | 135 | // interface implemented by all generated enums |
| 136 | type protoEnum interface { |
| 137 | EnumDescriptor() ([]byte, []int) |
| 138 | } |
| 139 | |
| 140 | // NB: There is no LoadEnumDescriptor that takes a fully-qualified enum name because |
| 141 | // it is not useful since protoc-gen-go does not expose the name anywhere in generated |
| 142 | // code or register it in a way that is it accessible for reflection code. This also |
| 143 | // means we have to cache enum descriptors differently -- we can only cache them as |
| 144 | // they are requested, as opposed to caching all enum types whenever a file descriptor |
| 145 | // is cached. This is because we need to know the generated type of the enums, and we |
| 146 | // don't know that at the time of caching file descriptors. |
| 147 | |
| 148 | // LoadEnumDescriptorForType loads descriptor using the encoded descriptor proto returned |
| 149 | // by enum.EnumDescriptor() for the given enum type. |
| 150 | func LoadEnumDescriptorForType(enumType reflect.Type) (*EnumDescriptor, error) { |
| khenaidoo | 0927c72 | 2021-12-15 16:49:32 -0500 | [diff] [blame] | 151 | // we cache descriptors using non-pointer type |
| 152 | if enumType.Kind() == reflect.Ptr { |
| 153 | enumType = enumType.Elem() |
| 154 | } |
| 155 | e := getEnumFromCache(enumType) |
| 156 | if e != nil { |
| 157 | return e, nil |
| 158 | } |
| 159 | enum, err := enumFromType(enumType) |
| 160 | if err != nil { |
| 161 | return nil, err |
| 162 | } |
| 163 | |
| Abhay Kumar | 40252eb | 2025-10-13 13:25:53 +0000 | [diff] [blame^] | 164 | return loadEnumDescriptor(enumType, enum) |
| 165 | } |
| 166 | |
| 167 | func getEnumFromCache(t reflect.Type) *EnumDescriptor { |
| 168 | loadedEnumsMu.RLock() |
| 169 | defer loadedEnumsMu.RUnlock() |
| 170 | return loadedEnums[t] |
| 171 | } |
| 172 | |
| 173 | func putEnumInCache(t reflect.Type, d *EnumDescriptor) { |
| 174 | loadedEnumsMu.Lock() |
| 175 | defer loadedEnumsMu.Unlock() |
| 176 | loadedEnums[t] = d |
| khenaidoo | 0927c72 | 2021-12-15 16:49:32 -0500 | [diff] [blame] | 177 | } |
| 178 | |
| 179 | // LoadEnumDescriptorForEnum loads descriptor using the encoded descriptor proto |
| 180 | // returned by enum.EnumDescriptor(). |
| 181 | func LoadEnumDescriptorForEnum(enum protoEnum) (*EnumDescriptor, error) { |
| khenaidoo | 0927c72 | 2021-12-15 16:49:32 -0500 | [diff] [blame] | 182 | et := reflect.TypeOf(enum) |
| 183 | // we cache descriptors using non-pointer type |
| 184 | if et.Kind() == reflect.Ptr { |
| 185 | et = et.Elem() |
| 186 | enum = reflect.Zero(et).Interface().(protoEnum) |
| 187 | } |
| 188 | e := getEnumFromCache(et) |
| 189 | if e != nil { |
| 190 | return e, nil |
| 191 | } |
| 192 | |
| Abhay Kumar | 40252eb | 2025-10-13 13:25:53 +0000 | [diff] [blame^] | 193 | return loadEnumDescriptor(et, enum) |
| khenaidoo | 0927c72 | 2021-12-15 16:49:32 -0500 | [diff] [blame] | 194 | } |
| 195 | |
| 196 | func enumFromType(et reflect.Type) (protoEnum, error) { |
| khenaidoo | 0927c72 | 2021-12-15 16:49:32 -0500 | [diff] [blame] | 197 | e, ok := reflect.Zero(et).Interface().(protoEnum) |
| 198 | if !ok { |
| Abhay Kumar | 40252eb | 2025-10-13 13:25:53 +0000 | [diff] [blame^] | 199 | if et.Kind() != reflect.Ptr { |
| 200 | et = et.Elem() |
| 201 | } |
| 202 | e, ok = reflect.Zero(et).Interface().(protoEnum) |
| 203 | } |
| 204 | if !ok { |
| khenaidoo | 0927c72 | 2021-12-15 16:49:32 -0500 | [diff] [blame] | 205 | return nil, fmt.Errorf("failed to create enum from type: %v", et) |
| 206 | } |
| 207 | return e, nil |
| 208 | } |
| 209 | |
| Abhay Kumar | 40252eb | 2025-10-13 13:25:53 +0000 | [diff] [blame^] | 210 | func getDescriptorForEnum(enum protoEnum) (*descriptorpb.FileDescriptorProto, []int, error) { |
| khenaidoo | 0927c72 | 2021-12-15 16:49:32 -0500 | [diff] [blame] | 211 | fdb, path := enum.EnumDescriptor() |
| Abhay Kumar | 40252eb | 2025-10-13 13:25:53 +0000 | [diff] [blame^] | 212 | name := fmt.Sprintf("%T", enum) |
| khenaidoo | 0927c72 | 2021-12-15 16:49:32 -0500 | [diff] [blame] | 213 | fd, err := internal.DecodeFileDescriptor(name, fdb) |
| Abhay Kumar | 40252eb | 2025-10-13 13:25:53 +0000 | [diff] [blame^] | 214 | return fd, path, err |
| 215 | } |
| 216 | |
| 217 | func loadEnumDescriptor(et reflect.Type, enum protoEnum) (*EnumDescriptor, error) { |
| 218 | fdp, path, err := getDescriptorForEnum(enum) |
| khenaidoo | 0927c72 | 2021-12-15 16:49:32 -0500 | [diff] [blame] | 219 | if err != nil { |
| 220 | return nil, err |
| 221 | } |
| Abhay Kumar | 40252eb | 2025-10-13 13:25:53 +0000 | [diff] [blame^] | 222 | |
| 223 | fd, err := LoadFileDescriptor(fdp.GetName()) |
| 224 | if err != nil { |
| 225 | return nil, err |
| khenaidoo | 0927c72 | 2021-12-15 16:49:32 -0500 | [diff] [blame] | 226 | } |
| 227 | |
| Abhay Kumar | 40252eb | 2025-10-13 13:25:53 +0000 | [diff] [blame^] | 228 | ed := findEnum(fd, path) |
| 229 | putEnumInCache(et, ed) |
| khenaidoo | 0927c72 | 2021-12-15 16:49:32 -0500 | [diff] [blame] | 230 | return ed, nil |
| 231 | } |
| 232 | |
| khenaidoo | 0927c72 | 2021-12-15 16:49:32 -0500 | [diff] [blame] | 233 | func findEnum(fd *FileDescriptor, path []int) *EnumDescriptor { |
| 234 | if len(path) == 1 { |
| 235 | return fd.GetEnumTypes()[path[0]] |
| 236 | } |
| 237 | md := fd.GetMessageTypes()[path[0]] |
| 238 | for _, i := range path[1 : len(path)-1] { |
| 239 | md = md.GetNestedMessageTypes()[i] |
| 240 | } |
| 241 | return md.GetNestedEnumTypes()[path[len(path)-1]] |
| 242 | } |
| 243 | |
| 244 | // LoadFieldDescriptorForExtension loads the field descriptor that corresponds to the given |
| 245 | // extension description. |
| 246 | func LoadFieldDescriptorForExtension(ext *proto.ExtensionDesc) (*FieldDescriptor, error) { |
| Abhay Kumar | 40252eb | 2025-10-13 13:25:53 +0000 | [diff] [blame^] | 247 | file, err := LoadFileDescriptor(ext.Filename) |
| khenaidoo | 0927c72 | 2021-12-15 16:49:32 -0500 | [diff] [blame] | 248 | if err != nil { |
| 249 | return nil, err |
| 250 | } |
| 251 | field, ok := file.FindSymbol(ext.Name).(*FieldDescriptor) |
| 252 | // make sure descriptor agrees with attributes of the ExtensionDesc |
| 253 | if !ok || !field.IsExtension() || field.GetOwner().GetFullyQualifiedName() != proto.MessageName(ext.ExtendedType) || |
| 254 | field.GetNumber() != ext.Field { |
| 255 | return nil, fmt.Errorf("file descriptor contained unexpected object with name %s", ext.Name) |
| 256 | } |
| 257 | return field, nil |
| 258 | } |