pointer_unsafe.go 7.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218
  1. // Go support for Protocol Buffers - Google's data interchange format
  2. //
  3. // Copyright 2012 The Go Authors. All rights reserved.
  4. // http://code.google.com/p/goprotobuf/
  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. // * Neither the name of Google Inc. nor the names of its
  17. // contributors may be used to endorse or promote products derived from
  18. // this software without specific prior written permission.
  19. //
  20. // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  21. // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  22. // LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  23. // A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  24. // OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  25. // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  26. // LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  27. // DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  28. // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  29. // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  30. // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  31. // +build !appengine
  32. // This file contains the implementation of the proto field accesses using package unsafe.
  33. package proto
  34. import (
  35. "reflect"
  36. "unsafe"
  37. )
  38. // NOTE: These type_Foo functions would more idiomatically be methods,
  39. // but Go does not allow methods on pointer types, and we must preserve
  40. // some pointer type for the garbage collector. We use these
  41. // funcs with clunky names as our poor approximation to methods.
  42. //
  43. // An alternative would be
  44. // type structPointer struct { p unsafe.Pointer }
  45. // but that does not registerize as well.
  46. // A structPointer is a pointer to a struct.
  47. type structPointer unsafe.Pointer
  48. // toStructPointer returns a structPointer equivalent to the given reflect value.
  49. func toStructPointer(v reflect.Value) structPointer {
  50. return structPointer(unsafe.Pointer(v.Pointer()))
  51. }
  52. // IsNil reports whether p is nil.
  53. func structPointer_IsNil(p structPointer) bool {
  54. return p == nil
  55. }
  56. // Interface returns the struct pointer, assumed to have element type t,
  57. // as an interface value.
  58. func structPointer_Interface(p structPointer, t reflect.Type) interface{} {
  59. return reflect.NewAt(t, unsafe.Pointer(p)).Interface()
  60. }
  61. // A field identifies a field in a struct, accessible from a structPointer.
  62. // In this implementation, a field is identified by its byte offset from the start of the struct.
  63. type field uintptr
  64. // toField returns a field equivalent to the given reflect field.
  65. func toField(f *reflect.StructField) field {
  66. return field(f.Offset)
  67. }
  68. // invalidField is an invalid field identifier.
  69. const invalidField = ^field(0)
  70. // IsValid reports whether the field identifier is valid.
  71. func (f field) IsValid() bool {
  72. return f != ^field(0)
  73. }
  74. // Bytes returns the address of a []byte field in the struct.
  75. func structPointer_Bytes(p structPointer, f field) *[]byte {
  76. return (*[]byte)(unsafe.Pointer(uintptr(p) + uintptr(f)))
  77. }
  78. // BytesSlice returns the address of a [][]byte field in the struct.
  79. func structPointer_BytesSlice(p structPointer, f field) *[][]byte {
  80. return (*[][]byte)(unsafe.Pointer(uintptr(p) + uintptr(f)))
  81. }
  82. // Bool returns the address of a *bool field in the struct.
  83. func structPointer_Bool(p structPointer, f field) **bool {
  84. return (**bool)(unsafe.Pointer(uintptr(p) + uintptr(f)))
  85. }
  86. // BoolSlice returns the address of a []bool field in the struct.
  87. func structPointer_BoolSlice(p structPointer, f field) *[]bool {
  88. return (*[]bool)(unsafe.Pointer(uintptr(p) + uintptr(f)))
  89. }
  90. // String returns the address of a *string field in the struct.
  91. func structPointer_String(p structPointer, f field) **string {
  92. return (**string)(unsafe.Pointer(uintptr(p) + uintptr(f)))
  93. }
  94. // StringSlice returns the address of a []string field in the struct.
  95. func structPointer_StringSlice(p structPointer, f field) *[]string {
  96. return (*[]string)(unsafe.Pointer(uintptr(p) + uintptr(f)))
  97. }
  98. // ExtMap returns the address of an extension map field in the struct.
  99. func structPointer_ExtMap(p structPointer, f field) *map[int32]Extension {
  100. return (*map[int32]Extension)(unsafe.Pointer(uintptr(p) + uintptr(f)))
  101. }
  102. // SetStructPointer writes a *struct field in the struct.
  103. func structPointer_SetStructPointer(p structPointer, f field, q structPointer) {
  104. *(*structPointer)(unsafe.Pointer(uintptr(p) + uintptr(f))) = q
  105. }
  106. // GetStructPointer reads a *struct field in the struct.
  107. func structPointer_GetStructPointer(p structPointer, f field) structPointer {
  108. return *(*structPointer)(unsafe.Pointer(uintptr(p) + uintptr(f)))
  109. }
  110. // StructPointerSlice the address of a []*struct field in the struct.
  111. func structPointer_StructPointerSlice(p structPointer, f field) *structPointerSlice {
  112. return (*structPointerSlice)(unsafe.Pointer(uintptr(p) + uintptr(f)))
  113. }
  114. // A structPointerSlice represents a slice of pointers to structs (themselves submessages or groups).
  115. type structPointerSlice []structPointer
  116. func (v *structPointerSlice) Len() int { return len(*v) }
  117. func (v *structPointerSlice) Index(i int) structPointer { return (*v)[i] }
  118. func (v *structPointerSlice) Append(p structPointer) { *v = append(*v, p) }
  119. // A word32 is the address of a "pointer to 32-bit value" field.
  120. type word32 **uint32
  121. // IsNil reports whether *v is nil.
  122. func word32_IsNil(p word32) bool {
  123. return *p == nil
  124. }
  125. // Set sets *v to point at a newly allocated word set to x.
  126. func word32_Set(p word32, o *Buffer, x uint32) {
  127. if len(o.uint32s) == 0 {
  128. o.uint32s = make([]uint32, uint32PoolSize)
  129. }
  130. o.uint32s[0] = x
  131. *p = &o.uint32s[0]
  132. o.uint32s = o.uint32s[1:]
  133. }
  134. // Get gets the value pointed at by *v.
  135. func word32_Get(p word32) uint32 {
  136. return **p
  137. }
  138. // Word32 returns the address of a *int32, *uint32, *float32, or *enum field in the struct.
  139. func structPointer_Word32(p structPointer, f field) word32 {
  140. return word32((**uint32)(unsafe.Pointer(uintptr(p) + uintptr(f))))
  141. }
  142. // A word32Slice is a slice of 32-bit values.
  143. type word32Slice []uint32
  144. func (v *word32Slice) Append(x uint32) { *v = append(*v, x) }
  145. func (v *word32Slice) Len() int { return len(*v) }
  146. func (v *word32Slice) Index(i int) uint32 { return (*v)[i] }
  147. // Word32Slice returns the address of a []int32, []uint32, []float32, or []enum field in the struct.
  148. func structPointer_Word32Slice(p structPointer, f field) *word32Slice {
  149. return (*word32Slice)(unsafe.Pointer(uintptr(p) + uintptr(f)))
  150. }
  151. // word64 is like word32 but for 64-bit values.
  152. type word64 **uint64
  153. func word64_Set(p word64, o *Buffer, x uint64) {
  154. if len(o.uint64s) == 0 {
  155. o.uint64s = make([]uint64, uint64PoolSize)
  156. }
  157. o.uint64s[0] = x
  158. *p = &o.uint64s[0]
  159. o.uint64s = o.uint64s[1:]
  160. }
  161. func word64_IsNil(p word64) bool {
  162. return *p == nil
  163. }
  164. func word64_Get(p word64) uint64 {
  165. return **p
  166. }
  167. func structPointer_Word64(p structPointer, f field) word64 {
  168. return word64((**uint64)(unsafe.Pointer(uintptr(p) + uintptr(f))))
  169. }
  170. // word64Slice is like word32Slice but for 64-bit values.
  171. type word64Slice []uint64
  172. func (v *word64Slice) Append(x uint64) { *v = append(*v, x) }
  173. func (v *word64Slice) Len() int { return len(*v) }
  174. func (v *word64Slice) Index(i int) uint64 { return (*v)[i] }
  175. func structPointer_Word64Slice(p structPointer, f field) *word64Slice {
  176. return (*word64Slice)(unsafe.Pointer(uintptr(p) + uintptr(f)))
  177. }