blob: 370ec65a20b316b7ab266682330c826bcb4deb53 [file] [log] [blame]
Scott Baker105df152020-04-13 15:55:14 -07001// Copyright 2019 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
5package impl
6
7import (
8 "fmt"
9 "reflect"
10 "sort"
11
12 "google.golang.org/protobuf/encoding/protowire"
13 "google.golang.org/protobuf/internal/encoding/messageset"
14 "google.golang.org/protobuf/internal/fieldsort"
15 pref "google.golang.org/protobuf/reflect/protoreflect"
16 piface "google.golang.org/protobuf/runtime/protoiface"
17)
18
19// coderMessageInfo contains per-message information used by the fast-path functions.
20// This is a different type from MessageInfo to keep MessageInfo as general-purpose as
21// possible.
22type coderMessageInfo struct {
23 methods piface.Methods
24
25 orderedCoderFields []*coderFieldInfo
26 denseCoderFields []*coderFieldInfo
27 coderFields map[protowire.Number]*coderFieldInfo
28 sizecacheOffset offset
29 unknownOffset offset
30 extensionOffset offset
31 needsInitCheck bool
32 isMessageSet bool
33 numRequiredFields uint8
34}
35
36type coderFieldInfo struct {
37 funcs pointerCoderFuncs // fast-path per-field functions
38 mi *MessageInfo // field's message
39 ft reflect.Type
40 validation validationInfo // information used by message validation
41 num pref.FieldNumber // field number
42 offset offset // struct field offset
43 wiretag uint64 // field tag (number + wire type)
44 tagsize int // size of the varint-encoded tag
45 isPointer bool // true if IsNil may be called on the struct field
46 isRequired bool // true if field is required
47}
48
49func (mi *MessageInfo) makeCoderMethods(t reflect.Type, si structInfo) {
50 mi.sizecacheOffset = si.sizecacheOffset
51 mi.unknownOffset = si.unknownOffset
52 mi.extensionOffset = si.extensionOffset
53
54 mi.coderFields = make(map[protowire.Number]*coderFieldInfo)
55 fields := mi.Desc.Fields()
56 for i := 0; i < fields.Len(); i++ {
57 fd := fields.Get(i)
58
59 fs := si.fieldsByNumber[fd.Number()]
60 if fd.ContainingOneof() != nil {
61 fs = si.oneofsByName[fd.ContainingOneof().Name()]
62 }
63 ft := fs.Type
64 var wiretag uint64
65 if !fd.IsPacked() {
66 wiretag = protowire.EncodeTag(fd.Number(), wireTypes[fd.Kind()])
67 } else {
68 wiretag = protowire.EncodeTag(fd.Number(), protowire.BytesType)
69 }
70 var fieldOffset offset
71 var funcs pointerCoderFuncs
72 var childMessage *MessageInfo
73 switch {
74 case fd.ContainingOneof() != nil:
75 fieldOffset = offsetOf(fs, mi.Exporter)
76 case fd.IsWeak():
77 fieldOffset = si.weakOffset
78 funcs = makeWeakMessageFieldCoder(fd)
79 default:
80 fieldOffset = offsetOf(fs, mi.Exporter)
81 childMessage, funcs = fieldCoder(fd, ft)
82 }
83 cf := &coderFieldInfo{
84 num: fd.Number(),
85 offset: fieldOffset,
86 wiretag: wiretag,
87 ft: ft,
88 tagsize: protowire.SizeVarint(wiretag),
89 funcs: funcs,
90 mi: childMessage,
91 validation: newFieldValidationInfo(mi, si, fd, ft),
92 isPointer: (fd.Cardinality() == pref.Repeated ||
93 fd.Kind() == pref.MessageKind ||
94 fd.Kind() == pref.GroupKind ||
95 fd.Syntax() != pref.Proto3),
96 isRequired: fd.Cardinality() == pref.Required,
97 }
98 mi.orderedCoderFields = append(mi.orderedCoderFields, cf)
99 mi.coderFields[cf.num] = cf
100 }
101 for i, oneofs := 0, mi.Desc.Oneofs(); i < oneofs.Len(); i++ {
102 mi.initOneofFieldCoders(oneofs.Get(i), si)
103 }
104 if messageset.IsMessageSet(mi.Desc) {
105 if !mi.extensionOffset.IsValid() {
106 panic(fmt.Sprintf("%v: MessageSet with no extensions field", mi.Desc.FullName()))
107 }
108 if !mi.unknownOffset.IsValid() {
109 panic(fmt.Sprintf("%v: MessageSet with no unknown field", mi.Desc.FullName()))
110 }
111 mi.isMessageSet = true
112 }
113 sort.Slice(mi.orderedCoderFields, func(i, j int) bool {
114 return mi.orderedCoderFields[i].num < mi.orderedCoderFields[j].num
115 })
116
117 var maxDense pref.FieldNumber
118 for _, cf := range mi.orderedCoderFields {
119 if cf.num >= 16 && cf.num >= 2*maxDense {
120 break
121 }
122 maxDense = cf.num
123 }
124 mi.denseCoderFields = make([]*coderFieldInfo, maxDense+1)
125 for _, cf := range mi.orderedCoderFields {
126 if int(cf.num) > len(mi.denseCoderFields) {
127 break
128 }
129 mi.denseCoderFields[cf.num] = cf
130 }
131
132 // To preserve compatibility with historic wire output, marshal oneofs last.
133 if mi.Desc.Oneofs().Len() > 0 {
134 sort.Slice(mi.orderedCoderFields, func(i, j int) bool {
135 fi := fields.ByNumber(mi.orderedCoderFields[i].num)
136 fj := fields.ByNumber(mi.orderedCoderFields[j].num)
137 return fieldsort.Less(fi, fj)
138 })
139 }
140
141 mi.needsInitCheck = needsInitCheck(mi.Desc)
142 if mi.methods.Marshal == nil && mi.methods.Size == nil {
143 mi.methods.Flags |= piface.SupportMarshalDeterministic
144 mi.methods.Marshal = mi.marshal
145 mi.methods.Size = mi.size
146 }
147 if mi.methods.Unmarshal == nil {
148 mi.methods.Flags |= piface.SupportUnmarshalDiscardUnknown
149 mi.methods.Unmarshal = mi.unmarshal
150 }
151 if mi.methods.CheckInitialized == nil {
152 mi.methods.CheckInitialized = mi.checkInitialized
153 }
154 if mi.methods.Merge == nil {
155 mi.methods.Merge = mi.merge
156 }
157}