ext.go 4.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244
  1. package msgpack
  2. import (
  3. "bytes"
  4. "fmt"
  5. "reflect"
  6. "sync"
  7. "github.com/vmihailenco/msgpack/codes"
  8. )
  9. type extInfo struct {
  10. Type reflect.Type
  11. Decoder decoderFunc
  12. }
  13. var extTypes = make(map[int8]extInfo)
  14. var bufferPool = &sync.Pool{
  15. New: func() interface{} {
  16. return new(bytes.Buffer)
  17. },
  18. }
  19. // RegisterExt records a type, identified by a value for that type,
  20. // under the provided id. That id will identify the concrete type of a value
  21. // sent or received as an interface variable. Only types that will be
  22. // transferred as implementations of interface values need to be registered.
  23. // Expecting to be used only during initialization, it panics if the mapping
  24. // between types and ids is not a bijection.
  25. func RegisterExt(id int8, value interface{}) {
  26. typ := reflect.TypeOf(value)
  27. if typ.Kind() == reflect.Ptr {
  28. typ = typ.Elem()
  29. }
  30. ptr := reflect.PtrTo(typ)
  31. if _, ok := extTypes[id]; ok {
  32. panic(fmt.Errorf("msgpack: ext with id=%d is already registered", id))
  33. }
  34. registerExt(id, ptr, getEncoder(ptr), getDecoder(ptr))
  35. registerExt(id, typ, getEncoder(typ), getDecoder(typ))
  36. }
  37. func registerExt(id int8, typ reflect.Type, enc encoderFunc, dec decoderFunc) {
  38. if enc != nil {
  39. typEncMap[typ] = makeExtEncoder(id, enc)
  40. }
  41. if dec != nil {
  42. extTypes[id] = extInfo{
  43. Type: typ,
  44. Decoder: dec,
  45. }
  46. typDecMap[typ] = makeExtDecoder(id, dec)
  47. }
  48. }
  49. func (e *Encoder) EncodeExtHeader(typeId int8, length int) error {
  50. if err := e.encodeExtLen(length); err != nil {
  51. return err
  52. }
  53. if err := e.w.WriteByte(byte(typeId)); err != nil {
  54. return err
  55. }
  56. return nil
  57. }
  58. func makeExtEncoder(typeId int8, enc encoderFunc) encoderFunc {
  59. return func(e *Encoder, v reflect.Value) error {
  60. buf := bufferPool.Get().(*bytes.Buffer)
  61. defer bufferPool.Put(buf)
  62. buf.Reset()
  63. oldw := e.w
  64. e.w = buf
  65. err := enc(e, v)
  66. e.w = oldw
  67. if err != nil {
  68. return err
  69. }
  70. err = e.EncodeExtHeader(typeId, buf.Len())
  71. if err != nil {
  72. return err
  73. }
  74. return e.write(buf.Bytes())
  75. }
  76. }
  77. func makeExtDecoder(typeId int8, dec decoderFunc) decoderFunc {
  78. return func(d *Decoder, v reflect.Value) error {
  79. c, err := d.PeekCode()
  80. if err != nil {
  81. return err
  82. }
  83. if !codes.IsExt(c) {
  84. return dec(d, v)
  85. }
  86. id, extLen, err := d.DecodeExtHeader()
  87. if err != nil {
  88. return err
  89. }
  90. if int8(id) != typeId {
  91. return fmt.Errorf("msgpack: got ext type=%d, wanted %d", int8(id), typeId)
  92. }
  93. d.extLen = extLen
  94. return dec(d, v)
  95. }
  96. }
  97. func (e *Encoder) encodeExtLen(l int) error {
  98. switch l {
  99. case 1:
  100. return e.writeCode(codes.FixExt1)
  101. case 2:
  102. return e.writeCode(codes.FixExt2)
  103. case 4:
  104. return e.writeCode(codes.FixExt4)
  105. case 8:
  106. return e.writeCode(codes.FixExt8)
  107. case 16:
  108. return e.writeCode(codes.FixExt16)
  109. }
  110. if l < 256 {
  111. return e.write1(codes.Ext8, uint8(l))
  112. }
  113. if l < 65536 {
  114. return e.write2(codes.Ext16, uint16(l))
  115. }
  116. return e.write4(codes.Ext32, uint32(l))
  117. }
  118. func (d *Decoder) parseExtLen(c codes.Code) (int, error) {
  119. switch c {
  120. case codes.FixExt1:
  121. return 1, nil
  122. case codes.FixExt2:
  123. return 2, nil
  124. case codes.FixExt4:
  125. return 4, nil
  126. case codes.FixExt8:
  127. return 8, nil
  128. case codes.FixExt16:
  129. return 16, nil
  130. case codes.Ext8:
  131. n, err := d.uint8()
  132. return int(n), err
  133. case codes.Ext16:
  134. n, err := d.uint16()
  135. return int(n), err
  136. case codes.Ext32:
  137. n, err := d.uint32()
  138. return int(n), err
  139. default:
  140. return 0, fmt.Errorf("msgpack: invalid code=%x decoding ext length", c)
  141. }
  142. }
  143. func (d *Decoder) decodeExtHeader(c codes.Code) (int8, int, error) {
  144. length, err := d.parseExtLen(c)
  145. if err != nil {
  146. return 0, 0, err
  147. }
  148. typeId, err := d.readCode()
  149. if err != nil {
  150. return 0, 0, err
  151. }
  152. return int8(typeId), length, nil
  153. }
  154. func (d *Decoder) DecodeExtHeader() (typeId int8, length int, err error) {
  155. c, err := d.readCode()
  156. if err != nil {
  157. return
  158. }
  159. return d.decodeExtHeader(c)
  160. }
  161. func (d *Decoder) extInterface(c codes.Code) (interface{}, error) {
  162. extId, extLen, err := d.decodeExtHeader(c)
  163. if err != nil {
  164. return nil, err
  165. }
  166. info, ok := extTypes[extId]
  167. if !ok {
  168. return nil, fmt.Errorf("msgpack: unknown ext id=%d", extId)
  169. }
  170. v := reflect.New(info.Type)
  171. d.extLen = extLen
  172. err = info.Decoder(d, v.Elem())
  173. d.extLen = 0
  174. if err != nil {
  175. return nil, err
  176. }
  177. return v.Interface(), nil
  178. }
  179. func (d *Decoder) skipExt(c codes.Code) error {
  180. n, err := d.parseExtLen(c)
  181. if err != nil {
  182. return err
  183. }
  184. return d.skipN(n + 1)
  185. }
  186. func (d *Decoder) skipExtHeader(c codes.Code) error {
  187. // Read ext type.
  188. _, err := d.readCode()
  189. if err != nil {
  190. return err
  191. }
  192. // Read ext body len.
  193. for i := 0; i < extHeaderLen(c); i++ {
  194. _, err := d.readCode()
  195. if err != nil {
  196. return err
  197. }
  198. }
  199. return nil
  200. }
  201. func extHeaderLen(c codes.Code) int {
  202. switch c {
  203. case codes.Ext8:
  204. return 1
  205. case codes.Ext16:
  206. return 2
  207. case codes.Ext32:
  208. return 4
  209. }
  210. return 0
  211. }