extensions_gogo.go 9.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389
  1. // Protocol Buffers for Go with Gadgets
  2. //
  3. // Copyright (c) 2013, The GoGo Authors. All rights reserved.
  4. // http://github.com/gogo/protobuf
  5. //
  6. // Redistribution and use in source and binary forms, with or without
  7. // modification, are permitted provided that the following conditions are
  8. // met:
  9. //
  10. // * Redistributions of source code must retain the above copyright
  11. // notice, this list of conditions and the following disclaimer.
  12. // * Redistributions in binary form must reproduce the above
  13. // copyright notice, this list of conditions and the following disclaimer
  14. // in the documentation and/or other materials provided with the
  15. // distribution.
  16. //
  17. // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  18. // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  19. // LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  20. // A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  21. // OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  22. // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  23. // LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  24. // DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  25. // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  26. // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  27. // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  28. package proto
  29. import (
  30. "bytes"
  31. "errors"
  32. "fmt"
  33. "io"
  34. "reflect"
  35. "sort"
  36. "strings"
  37. "sync"
  38. )
  39. type extensionsBytes interface {
  40. Message
  41. ExtensionRangeArray() []ExtensionRange
  42. GetExtensions() *[]byte
  43. }
  44. type slowExtensionAdapter struct {
  45. extensionsBytes
  46. }
  47. func (s slowExtensionAdapter) extensionsWrite() map[int32]Extension {
  48. panic("Please report a bug to github.com/gogo/protobuf if you see this message: Writing extensions is not supported for extensions stored in a byte slice field.")
  49. }
  50. func (s slowExtensionAdapter) extensionsRead() (map[int32]Extension, sync.Locker) {
  51. b := s.GetExtensions()
  52. m, err := BytesToExtensionsMap(*b)
  53. if err != nil {
  54. panic(err)
  55. }
  56. return m, notLocker{}
  57. }
  58. func GetBoolExtension(pb Message, extension *ExtensionDesc, ifnotset bool) bool {
  59. if reflect.ValueOf(pb).IsNil() {
  60. return ifnotset
  61. }
  62. value, err := GetExtension(pb, extension)
  63. if err != nil {
  64. return ifnotset
  65. }
  66. if value == nil {
  67. return ifnotset
  68. }
  69. if value.(*bool) == nil {
  70. return ifnotset
  71. }
  72. return *(value.(*bool))
  73. }
  74. func (this *Extension) Equal(that *Extension) bool {
  75. if err := this.Encode(); err != nil {
  76. return false
  77. }
  78. if err := that.Encode(); err != nil {
  79. return false
  80. }
  81. return bytes.Equal(this.enc, that.enc)
  82. }
  83. func (this *Extension) Compare(that *Extension) int {
  84. if err := this.Encode(); err != nil {
  85. return 1
  86. }
  87. if err := that.Encode(); err != nil {
  88. return -1
  89. }
  90. return bytes.Compare(this.enc, that.enc)
  91. }
  92. func SizeOfInternalExtension(m extendableProto) (n int) {
  93. info := getMarshalInfo(reflect.TypeOf(m))
  94. return info.sizeV1Extensions(m.extensionsWrite())
  95. }
  96. type sortableMapElem struct {
  97. field int32
  98. ext Extension
  99. }
  100. func newSortableExtensionsFromMap(m map[int32]Extension) sortableExtensions {
  101. s := make(sortableExtensions, 0, len(m))
  102. for k, v := range m {
  103. s = append(s, &sortableMapElem{field: k, ext: v})
  104. }
  105. return s
  106. }
  107. type sortableExtensions []*sortableMapElem
  108. func (this sortableExtensions) Len() int { return len(this) }
  109. func (this sortableExtensions) Swap(i, j int) { this[i], this[j] = this[j], this[i] }
  110. func (this sortableExtensions) Less(i, j int) bool { return this[i].field < this[j].field }
  111. func (this sortableExtensions) String() string {
  112. sort.Sort(this)
  113. ss := make([]string, len(this))
  114. for i := range this {
  115. ss[i] = fmt.Sprintf("%d: %v", this[i].field, this[i].ext)
  116. }
  117. return "map[" + strings.Join(ss, ",") + "]"
  118. }
  119. func StringFromInternalExtension(m extendableProto) string {
  120. return StringFromExtensionsMap(m.extensionsWrite())
  121. }
  122. func StringFromExtensionsMap(m map[int32]Extension) string {
  123. return newSortableExtensionsFromMap(m).String()
  124. }
  125. func StringFromExtensionsBytes(ext []byte) string {
  126. m, err := BytesToExtensionsMap(ext)
  127. if err != nil {
  128. panic(err)
  129. }
  130. return StringFromExtensionsMap(m)
  131. }
  132. func EncodeInternalExtension(m extendableProto, data []byte) (n int, err error) {
  133. return EncodeExtensionMap(m.extensionsWrite(), data)
  134. }
  135. func EncodeInternalExtensionBackwards(m extendableProto, data []byte) (n int, err error) {
  136. return EncodeExtensionMapBackwards(m.extensionsWrite(), data)
  137. }
  138. func EncodeExtensionMap(m map[int32]Extension, data []byte) (n int, err error) {
  139. o := 0
  140. for _, e := range m {
  141. if err := e.Encode(); err != nil {
  142. return 0, err
  143. }
  144. n := copy(data[o:], e.enc)
  145. if n != len(e.enc) {
  146. return 0, io.ErrShortBuffer
  147. }
  148. o += n
  149. }
  150. return o, nil
  151. }
  152. func EncodeExtensionMapBackwards(m map[int32]Extension, data []byte) (n int, err error) {
  153. o := 0
  154. end := len(data)
  155. for _, e := range m {
  156. if err := e.Encode(); err != nil {
  157. return 0, err
  158. }
  159. n := copy(data[end-len(e.enc):], e.enc)
  160. if n != len(e.enc) {
  161. return 0, io.ErrShortBuffer
  162. }
  163. end -= n
  164. o += n
  165. }
  166. return o, nil
  167. }
  168. func GetRawExtension(m map[int32]Extension, id int32) ([]byte, error) {
  169. e := m[id]
  170. if err := e.Encode(); err != nil {
  171. return nil, err
  172. }
  173. return e.enc, nil
  174. }
  175. func size(buf []byte, wire int) (int, error) {
  176. switch wire {
  177. case WireVarint:
  178. _, n := DecodeVarint(buf)
  179. return n, nil
  180. case WireFixed64:
  181. return 8, nil
  182. case WireBytes:
  183. v, n := DecodeVarint(buf)
  184. return int(v) + n, nil
  185. case WireFixed32:
  186. return 4, nil
  187. case WireStartGroup:
  188. offset := 0
  189. for {
  190. u, n := DecodeVarint(buf[offset:])
  191. fwire := int(u & 0x7)
  192. offset += n
  193. if fwire == WireEndGroup {
  194. return offset, nil
  195. }
  196. s, err := size(buf[offset:], wire)
  197. if err != nil {
  198. return 0, err
  199. }
  200. offset += s
  201. }
  202. }
  203. return 0, fmt.Errorf("proto: can't get size for unknown wire type %d", wire)
  204. }
  205. func BytesToExtensionsMap(buf []byte) (map[int32]Extension, error) {
  206. m := make(map[int32]Extension)
  207. i := 0
  208. for i < len(buf) {
  209. tag, n := DecodeVarint(buf[i:])
  210. if n <= 0 {
  211. return nil, fmt.Errorf("unable to decode varint")
  212. }
  213. fieldNum := int32(tag >> 3)
  214. wireType := int(tag & 0x7)
  215. l, err := size(buf[i+n:], wireType)
  216. if err != nil {
  217. return nil, err
  218. }
  219. end := i + int(l) + n
  220. m[int32(fieldNum)] = Extension{enc: buf[i:end]}
  221. i = end
  222. }
  223. return m, nil
  224. }
  225. func NewExtension(e []byte) Extension {
  226. ee := Extension{enc: make([]byte, len(e))}
  227. copy(ee.enc, e)
  228. return ee
  229. }
  230. func AppendExtension(e Message, tag int32, buf []byte) {
  231. if ee, eok := e.(extensionsBytes); eok {
  232. ext := ee.GetExtensions()
  233. *ext = append(*ext, buf...)
  234. return
  235. }
  236. if ee, eok := e.(extendableProto); eok {
  237. m := ee.extensionsWrite()
  238. ext := m[int32(tag)] // may be missing
  239. ext.enc = append(ext.enc, buf...)
  240. m[int32(tag)] = ext
  241. }
  242. }
  243. func encodeExtension(extension *ExtensionDesc, value interface{}) ([]byte, error) {
  244. u := getMarshalInfo(reflect.TypeOf(extension.ExtendedType))
  245. ei := u.getExtElemInfo(extension)
  246. v := value
  247. p := toAddrPointer(&v, ei.isptr)
  248. siz := ei.sizer(p, SizeVarint(ei.wiretag))
  249. buf := make([]byte, 0, siz)
  250. return ei.marshaler(buf, p, ei.wiretag, false)
  251. }
  252. func decodeExtensionFromBytes(extension *ExtensionDesc, buf []byte) (interface{}, error) {
  253. o := 0
  254. for o < len(buf) {
  255. tag, n := DecodeVarint((buf)[o:])
  256. fieldNum := int32(tag >> 3)
  257. wireType := int(tag & 0x7)
  258. if o+n > len(buf) {
  259. return nil, fmt.Errorf("unable to decode extension")
  260. }
  261. l, err := size((buf)[o+n:], wireType)
  262. if err != nil {
  263. return nil, err
  264. }
  265. if int32(fieldNum) == extension.Field {
  266. if o+n+l > len(buf) {
  267. return nil, fmt.Errorf("unable to decode extension")
  268. }
  269. v, err := decodeExtension((buf)[o:o+n+l], extension)
  270. if err != nil {
  271. return nil, err
  272. }
  273. return v, nil
  274. }
  275. o += n + l
  276. }
  277. return defaultExtensionValue(extension)
  278. }
  279. func (this *Extension) Encode() error {
  280. if this.enc == nil {
  281. var err error
  282. this.enc, err = encodeExtension(this.desc, this.value)
  283. if err != nil {
  284. return err
  285. }
  286. }
  287. return nil
  288. }
  289. func (this Extension) GoString() string {
  290. if err := this.Encode(); err != nil {
  291. return fmt.Sprintf("error encoding extension: %v", err)
  292. }
  293. return fmt.Sprintf("proto.NewExtension(%#v)", this.enc)
  294. }
  295. func SetUnsafeExtension(pb Message, fieldNum int32, value interface{}) error {
  296. typ := reflect.TypeOf(pb).Elem()
  297. ext, ok := extensionMaps[typ]
  298. if !ok {
  299. return fmt.Errorf("proto: bad extended type; %s is not extendable", typ.String())
  300. }
  301. desc, ok := ext[fieldNum]
  302. if !ok {
  303. return errors.New("proto: bad extension number; not in declared ranges")
  304. }
  305. return SetExtension(pb, desc, value)
  306. }
  307. func GetUnsafeExtension(pb Message, fieldNum int32) (interface{}, error) {
  308. typ := reflect.TypeOf(pb).Elem()
  309. ext, ok := extensionMaps[typ]
  310. if !ok {
  311. return nil, fmt.Errorf("proto: bad extended type; %s is not extendable", typ.String())
  312. }
  313. desc, ok := ext[fieldNum]
  314. if !ok {
  315. return nil, fmt.Errorf("unregistered field number %d", fieldNum)
  316. }
  317. return GetExtension(pb, desc)
  318. }
  319. func NewUnsafeXXX_InternalExtensions(m map[int32]Extension) XXX_InternalExtensions {
  320. x := &XXX_InternalExtensions{
  321. p: new(struct {
  322. mu sync.Mutex
  323. extensionMap map[int32]Extension
  324. }),
  325. }
  326. x.p.extensionMap = m
  327. return *x
  328. }
  329. func GetUnsafeExtensionsMap(extendable Message) map[int32]Extension {
  330. pb := extendable.(extendableProto)
  331. return pb.extensionsWrite()
  332. }
  333. func deleteExtension(pb extensionsBytes, theFieldNum int32, offset int) int {
  334. ext := pb.GetExtensions()
  335. for offset < len(*ext) {
  336. tag, n1 := DecodeVarint((*ext)[offset:])
  337. fieldNum := int32(tag >> 3)
  338. wireType := int(tag & 0x7)
  339. n2, err := size((*ext)[offset+n1:], wireType)
  340. if err != nil {
  341. panic(err)
  342. }
  343. newOffset := offset + n1 + n2
  344. if fieldNum == theFieldNum {
  345. *ext = append((*ext)[:offset], (*ext)[newOffset:]...)
  346. return offset
  347. }
  348. offset = newOffset
  349. }
  350. return -1
  351. }