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.
15
"google.golang.org/protobuf/internal/genid"
16
"google.golang.org/protobuf/reflect/protoreflect"
17
"google.golang.org/protobuf/reflect/protoregistry"
20
// MessageInfo provides protobuf related functionality for a given Go type
21
// that represents a message. A given instance of MessageInfo is tied to
22
// exactly one Go type, which must be a pointer to a struct type.
24
// The exported fields must be populated before any methods are called
25
// and cannot be mutated after set.
26
type MessageInfo struct {
27
// GoReflectType is the underlying message Go type and must be populated.
28
GoReflectType reflect.Type // pointer to struct
30
// Desc is the underlying message descriptor type and must be populated.
31
Desc protoreflect.MessageDescriptor
33
// Exporter must be provided in a purego environment in order to provide
34
// access to unexported fields.
37
// OneofWrappers is list of pointers to oneof wrapper struct types.
38
OneofWrappers []interface{}
40
initMu sync.Mutex // protects all unexported fields
43
reflectMessageInfo // for reflection implementation
44
coderMessageInfo // for fast-path method implementations
47
// exporter is a function that returns a reference to the ith field of v,
48
// where v is a pointer to a struct. It returns nil if it does not support
49
// exporting the requested field (e.g., already exported).
50
type exporter func(v interface{}, i int) interface{}
52
// getMessageInfo returns the MessageInfo for any message type that
53
// is generated by our implementation of protoc-gen-go (for v2 and on).
54
// If it is unable to obtain a MessageInfo, it returns nil.
55
func getMessageInfo(mt reflect.Type) *MessageInfo {
56
m, ok := reflect.Zero(mt).Interface().(protoreflect.ProtoMessage)
60
mr, ok := m.ProtoReflect().(interface{ ProtoMessageInfo() *MessageInfo })
64
return mr.ProtoMessageInfo()
67
func (mi *MessageInfo) init() {
68
// This function is called in the hot path. Inline the sync.Once logic,
69
// since allocating a closure for Once.Do is expensive.
70
// Keep init small to ensure that it can be inlined.
71
if atomic.LoadUint32(&mi.initDone) == 0 {
76
func (mi *MessageInfo) initOnce() {
78
defer mi.initMu.Unlock()
84
if t.Kind() != reflect.Ptr && t.Elem().Kind() != reflect.Struct {
85
panic(fmt.Sprintf("got %v, want *struct kind", t))
89
si := mi.makeStructInfo(t)
90
mi.makeReflectFuncs(t, si)
91
mi.makeCoderMethods(t, si)
93
atomic.StoreUint32(&mi.initDone, 1)
96
// getPointer returns the pointer for a message, which should be of
97
// the type of the MessageInfo. If the message is of a different type,
98
// it returns ok==false.
99
func (mi *MessageInfo) getPointer(m protoreflect.Message) (p pointer, ok bool) {
100
switch m := m.(type) {
102
return m.pointer(), m.messageInfo() == mi
103
case *messageReflectWrapper:
104
return m.pointer(), m.messageInfo() == mi
106
return pointer{}, false
111
WeakFields = map[int32]protoreflect.ProtoMessage
112
UnknownFields = unknownFieldsA // TODO: switch to unknownFieldsB
113
unknownFieldsA = []byte
114
unknownFieldsB = *[]byte
115
ExtensionFields = map[int32]ExtensionField
119
sizecacheType = reflect.TypeOf(SizeCache(0))
120
weakFieldsType = reflect.TypeOf(WeakFields(nil))
121
unknownFieldsAType = reflect.TypeOf(unknownFieldsA(nil))
122
unknownFieldsBType = reflect.TypeOf(unknownFieldsB(nil))
123
extensionFieldsType = reflect.TypeOf(ExtensionFields(nil))
126
type structInfo struct {
127
sizecacheOffset offset
128
sizecacheType reflect.Type
130
weakType reflect.Type
132
unknownType reflect.Type
133
extensionOffset offset
134
extensionType reflect.Type
136
fieldsByNumber map[protoreflect.FieldNumber]reflect.StructField
137
oneofsByName map[protoreflect.Name]reflect.StructField
138
oneofWrappersByType map[reflect.Type]protoreflect.FieldNumber
139
oneofWrappersByNumber map[protoreflect.FieldNumber]reflect.Type
142
func (mi *MessageInfo) makeStructInfo(t reflect.Type) structInfo {
144
sizecacheOffset: invalidOffset,
145
weakOffset: invalidOffset,
146
unknownOffset: invalidOffset,
147
extensionOffset: invalidOffset,
149
fieldsByNumber: map[protoreflect.FieldNumber]reflect.StructField{},
150
oneofsByName: map[protoreflect.Name]reflect.StructField{},
151
oneofWrappersByType: map[reflect.Type]protoreflect.FieldNumber{},
152
oneofWrappersByNumber: map[protoreflect.FieldNumber]reflect.Type{},
156
for i := 0; i < t.NumField(); i++ {
157
switch f := t.Field(i); f.Name {
158
case genid.SizeCache_goname, genid.SizeCacheA_goname:
159
if f.Type == sizecacheType {
160
si.sizecacheOffset = offsetOf(f, mi.Exporter)
161
si.sizecacheType = f.Type
163
case genid.WeakFields_goname, genid.WeakFieldsA_goname:
164
if f.Type == weakFieldsType {
165
si.weakOffset = offsetOf(f, mi.Exporter)
168
case genid.UnknownFields_goname, genid.UnknownFieldsA_goname:
169
if f.Type == unknownFieldsAType || f.Type == unknownFieldsBType {
170
si.unknownOffset = offsetOf(f, mi.Exporter)
171
si.unknownType = f.Type
173
case genid.ExtensionFields_goname, genid.ExtensionFieldsA_goname, genid.ExtensionFieldsB_goname:
174
if f.Type == extensionFieldsType {
175
si.extensionOffset = offsetOf(f, mi.Exporter)
176
si.extensionType = f.Type
179
for _, s := range strings.Split(f.Tag.Get("protobuf"), ",") {
180
if len(s) > 0 && strings.Trim(s, "0123456789") == "" {
181
n, _ := strconv.ParseUint(s, 10, 64)
182
si.fieldsByNumber[protoreflect.FieldNumber(n)] = f
186
if s := f.Tag.Get("protobuf_oneof"); len(s) > 0 {
187
si.oneofsByName[protoreflect.Name(s)] = f
193
// Derive a mapping of oneof wrappers to fields.
194
oneofWrappers := mi.OneofWrappers
195
methods := make([]reflect.Method, 0, 2)
196
if m, ok := reflect.PtrTo(t).MethodByName("XXX_OneofFuncs"); ok {
197
methods = append(methods, m)
199
if m, ok := reflect.PtrTo(t).MethodByName("XXX_OneofWrappers"); ok {
200
methods = append(methods, m)
202
for _, fn := range methods {
203
for _, v := range fn.Func.Call([]reflect.Value{reflect.Zero(fn.Type.In(0))}) {
204
if vs, ok := v.Interface().([]interface{}); ok {
209
for _, v := range oneofWrappers {
210
tf := reflect.TypeOf(v).Elem()
212
for _, s := range strings.Split(f.Tag.Get("protobuf"), ",") {
213
if len(s) > 0 && strings.Trim(s, "0123456789") == "" {
214
n, _ := strconv.ParseUint(s, 10, 64)
215
si.oneofWrappersByType[tf] = protoreflect.FieldNumber(n)
216
si.oneofWrappersByNumber[protoreflect.FieldNumber(n)] = tf
225
func (mi *MessageInfo) New() protoreflect.Message {
226
m := reflect.New(mi.GoReflectType.Elem()).Interface()
227
if r, ok := m.(protoreflect.ProtoMessage); ok {
228
return r.ProtoReflect()
230
return mi.MessageOf(m)
232
func (mi *MessageInfo) Zero() protoreflect.Message {
233
return mi.MessageOf(reflect.Zero(mi.GoReflectType).Interface())
235
func (mi *MessageInfo) Descriptor() protoreflect.MessageDescriptor {
238
func (mi *MessageInfo) Enum(i int) protoreflect.EnumType {
240
fd := mi.Desc.Fields().Get(i)
241
return Export{}.EnumTypeOf(mi.fieldTypes[fd.Number()])
243
func (mi *MessageInfo) Message(i int) protoreflect.MessageType {
245
fd := mi.Desc.Fields().Get(i)
248
mt, _ := protoregistry.GlobalTypes.FindMessageByName(fd.Message().FullName())
251
return mapEntryType{fd.Message(), mi.fieldTypes[fd.Number()]}
253
return Export{}.MessageTypeOf(mi.fieldTypes[fd.Number()])
257
type mapEntryType struct {
258
desc protoreflect.MessageDescriptor
259
valType interface{} // zero value of enum or message type
262
func (mt mapEntryType) New() protoreflect.Message {
265
func (mt mapEntryType) Zero() protoreflect.Message {
268
func (mt mapEntryType) Descriptor() protoreflect.MessageDescriptor {
271
func (mt mapEntryType) Enum(i int) protoreflect.EnumType {
272
fd := mt.desc.Fields().Get(i)
273
if fd.Enum() == nil {
276
return Export{}.EnumTypeOf(mt.valType)
278
func (mt mapEntryType) Message(i int) protoreflect.MessageType {
279
fd := mt.desc.Fields().Get(i)
280
if fd.Message() == nil {
283
return Export{}.MessageTypeOf(mt.valType)