struct_amd64.go 6.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260
  1. // SPDX-License-Identifier: Apache-2.0
  2. // SPDX-FileCopyrightText: 2024 The Ebitengine Authors
  3. package purego
  4. import (
  5. "math"
  6. "reflect"
  7. "unsafe"
  8. )
  9. func getStruct(outType reflect.Type, syscall syscall15Args) (v reflect.Value) {
  10. outSize := outType.Size()
  11. switch {
  12. case outSize == 0:
  13. return reflect.New(outType).Elem()
  14. case outSize <= 8:
  15. if isAllFloats(outType) {
  16. // 2 float32s or 1 float64s are return in the float register
  17. return reflect.NewAt(outType, unsafe.Pointer(&struct{ a uintptr }{syscall.f1})).Elem()
  18. }
  19. // up to 8 bytes is returned in RAX
  20. return reflect.NewAt(outType, unsafe.Pointer(&struct{ a uintptr }{syscall.a1})).Elem()
  21. case outSize <= 16:
  22. r1, r2 := syscall.a1, syscall.a2
  23. if isAllFloats(outType) {
  24. r1 = syscall.f1
  25. r2 = syscall.f2
  26. } else {
  27. // check first 8 bytes if it's floats
  28. hasFirstFloat := false
  29. f1 := outType.Field(0).Type
  30. if f1.Kind() == reflect.Float64 || f1.Kind() == reflect.Float32 && outType.Field(1).Type.Kind() == reflect.Float32 {
  31. r1 = syscall.f1
  32. hasFirstFloat = true
  33. }
  34. // find index of the field that starts the second 8 bytes
  35. var i int
  36. for i = 0; i < outType.NumField(); i++ {
  37. if outType.Field(i).Offset == 8 {
  38. break
  39. }
  40. }
  41. // check last 8 bytes if they are floats
  42. f1 = outType.Field(i).Type
  43. if f1.Kind() == reflect.Float64 || f1.Kind() == reflect.Float32 && i+1 == outType.NumField() {
  44. r2 = syscall.f1
  45. } else if hasFirstFloat {
  46. // if the first field was a float then that means the second integer field
  47. // comes from the first integer register
  48. r2 = syscall.a1
  49. }
  50. }
  51. return reflect.NewAt(outType, unsafe.Pointer(&struct{ a, b uintptr }{r1, r2})).Elem()
  52. default:
  53. // create struct from the Go pointer created above
  54. // weird pointer dereference to circumvent go vet
  55. return reflect.NewAt(outType, *(*unsafe.Pointer)(unsafe.Pointer(&syscall.a1))).Elem()
  56. }
  57. }
  58. func isAllFloats(ty reflect.Type) bool {
  59. for i := 0; i < ty.NumField(); i++ {
  60. f := ty.Field(i)
  61. switch f.Type.Kind() {
  62. case reflect.Float64, reflect.Float32:
  63. default:
  64. return false
  65. }
  66. }
  67. return true
  68. }
  69. // https://refspecs.linuxbase.org/elf/x86_64-abi-0.99.pdf
  70. // https://gitlab.com/x86-psABIs/x86-64-ABI
  71. // Class determines where the 8 byte value goes.
  72. // Higher value classes win over lower value classes
  73. const (
  74. _NO_CLASS = 0b0000
  75. _SSE = 0b0001
  76. _X87 = 0b0011 // long double not used in Go
  77. _INTEGER = 0b0111
  78. _MEMORY = 0b1111
  79. )
  80. func addStruct(v reflect.Value, numInts, numFloats, numStack *int, addInt, addFloat, addStack func(uintptr), keepAlive []interface{}) []interface{} {
  81. if v.Type().Size() == 0 {
  82. return keepAlive
  83. }
  84. // if greater than 64 bytes place on stack
  85. if v.Type().Size() > 8*8 {
  86. placeStack(v, addStack)
  87. return keepAlive
  88. }
  89. var (
  90. savedNumFloats = *numFloats
  91. savedNumInts = *numInts
  92. savedNumStack = *numStack
  93. )
  94. placeOnStack := postMerger(v.Type()) || !tryPlaceRegister(v, addFloat, addInt)
  95. if placeOnStack {
  96. // reset any values placed in registers
  97. *numFloats = savedNumFloats
  98. *numInts = savedNumInts
  99. *numStack = savedNumStack
  100. placeStack(v, addStack)
  101. }
  102. return keepAlive
  103. }
  104. func postMerger(t reflect.Type) (passInMemory bool) {
  105. // (c) If the size of the aggregate exceeds two eightbytes and the first eight- byte isn’t SSE or any other
  106. // eightbyte isn’t SSEUP, the whole argument is passed in memory.
  107. if t.Kind() != reflect.Struct {
  108. return false
  109. }
  110. if t.Size() <= 2*8 {
  111. return false
  112. }
  113. return true // Go does not have an SSE/SEEUP type so this is always true
  114. }
  115. func tryPlaceRegister(v reflect.Value, addFloat func(uintptr), addInt func(uintptr)) (ok bool) {
  116. ok = true
  117. var val uint64
  118. var shift byte // # of bits to shift
  119. var flushed bool
  120. class := _NO_CLASS
  121. flushIfNeeded := func() {
  122. if flushed {
  123. return
  124. }
  125. flushed = true
  126. if class == _SSE {
  127. addFloat(uintptr(val))
  128. } else {
  129. addInt(uintptr(val))
  130. }
  131. val = 0
  132. shift = 0
  133. class = _NO_CLASS
  134. }
  135. var place func(v reflect.Value)
  136. place = func(v reflect.Value) {
  137. var numFields int
  138. if v.Kind() == reflect.Struct {
  139. numFields = v.Type().NumField()
  140. } else {
  141. numFields = v.Type().Len()
  142. }
  143. for i := 0; i < numFields; i++ {
  144. flushed = false
  145. var f reflect.Value
  146. if v.Kind() == reflect.Struct {
  147. f = v.Field(i)
  148. } else {
  149. f = v.Index(i)
  150. }
  151. switch f.Kind() {
  152. case reflect.Struct:
  153. place(f)
  154. case reflect.Bool:
  155. if f.Bool() {
  156. val |= 1
  157. }
  158. shift += 8
  159. class |= _INTEGER
  160. case reflect.Pointer:
  161. ok = false
  162. return
  163. case reflect.Int8:
  164. val |= uint64(f.Int()&0xFF) << shift
  165. shift += 8
  166. class |= _INTEGER
  167. case reflect.Int16:
  168. val |= uint64(f.Int()&0xFFFF) << shift
  169. shift += 16
  170. class |= _INTEGER
  171. case reflect.Int32:
  172. val |= uint64(f.Int()&0xFFFF_FFFF) << shift
  173. shift += 32
  174. class |= _INTEGER
  175. case reflect.Int64, reflect.Int:
  176. val = uint64(f.Int())
  177. shift = 64
  178. class = _INTEGER
  179. case reflect.Uint8:
  180. val |= f.Uint() << shift
  181. shift += 8
  182. class |= _INTEGER
  183. case reflect.Uint16:
  184. val |= f.Uint() << shift
  185. shift += 16
  186. class |= _INTEGER
  187. case reflect.Uint32:
  188. val |= f.Uint() << shift
  189. shift += 32
  190. class |= _INTEGER
  191. case reflect.Uint64, reflect.Uint:
  192. val = f.Uint()
  193. shift = 64
  194. class = _INTEGER
  195. case reflect.Float32:
  196. val |= uint64(math.Float32bits(float32(f.Float()))) << shift
  197. shift += 32
  198. class |= _SSE
  199. case reflect.Float64:
  200. if v.Type().Size() > 16 {
  201. ok = false
  202. return
  203. }
  204. val = uint64(math.Float64bits(f.Float()))
  205. shift = 64
  206. class = _SSE
  207. case reflect.Array:
  208. place(f)
  209. default:
  210. panic("purego: unsupported kind " + f.Kind().String())
  211. }
  212. if shift == 64 {
  213. flushIfNeeded()
  214. } else if shift > 64 {
  215. // Should never happen, but may if we forget to reset shift after flush (or forget to flush),
  216. // better fall apart here, than corrupt arguments.
  217. panic("purego: tryPlaceRegisters shift > 64")
  218. }
  219. }
  220. }
  221. place(v)
  222. flushIfNeeded()
  223. return ok
  224. }
  225. func placeStack(v reflect.Value, addStack func(uintptr)) {
  226. for i := 0; i < v.Type().NumField(); i++ {
  227. f := v.Field(i)
  228. switch f.Kind() {
  229. case reflect.Pointer:
  230. addStack(f.Pointer())
  231. case reflect.Int, reflect.Int8, reflect.Int16, reflect.Int32, reflect.Int64:
  232. addStack(uintptr(f.Int()))
  233. case reflect.Uint, reflect.Uint8, reflect.Uint16, reflect.Uint32, reflect.Uint64:
  234. addStack(uintptr(f.Uint()))
  235. case reflect.Float32:
  236. addStack(uintptr(math.Float32bits(float32(f.Float()))))
  237. case reflect.Float64:
  238. addStack(uintptr(math.Float64bits(f.Float())))
  239. case reflect.Struct:
  240. placeStack(f, addStack)
  241. default:
  242. panic("purego: unsupported kind " + f.Kind().String())
  243. }
  244. }
  245. }