syscall.go 2.7 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283
  1. // SPDX-License-Identifier: Apache-2.0
  2. // SPDX-FileCopyrightText: 2022 The Ebitengine Authors
  3. //go:build !386 && !arm && (darwin || freebsd || linux || netbsd || windows)
  4. package purego
  5. // CDecl marks a function as being called using the __cdecl calling convention as defined in
  6. // the [MSDocs] when passed to NewCallback. It must be the first argument to the function.
  7. // This is only useful on 386 Windows, but it is safe to use on other platforms.
  8. //
  9. // [MSDocs]: https://learn.microsoft.com/en-us/cpp/cpp/cdecl?view=msvc-170
  10. type CDecl struct{}
  11. const (
  12. maxArgs = 15
  13. )
  14. type syscall15Args struct {
  15. fn, a1, a2, a3, a4, a5, a6, a7, a8, a9, a10, a11, a12, a13, a14, a15 uintptr
  16. f1, f2, f3, f4, f5, f6, f7, f8 uintptr
  17. arm64_r8 uintptr
  18. }
  19. func (s *syscall15Args) Set(fn uintptr, ints []uintptr, floats []uintptr, r8 uintptr) {
  20. s.fn = fn
  21. s.a1 = ints[0]
  22. s.a2 = ints[1]
  23. s.a3 = ints[2]
  24. s.a4 = ints[3]
  25. s.a5 = ints[4]
  26. s.a6 = ints[5]
  27. s.a7 = ints[6]
  28. s.a8 = ints[7]
  29. s.a9 = ints[8]
  30. s.a10 = ints[9]
  31. s.a11 = ints[10]
  32. s.a12 = ints[11]
  33. s.a13 = ints[12]
  34. s.a14 = ints[13]
  35. s.a15 = ints[14]
  36. s.f1 = floats[0]
  37. s.f2 = floats[1]
  38. s.f3 = floats[2]
  39. s.f4 = floats[3]
  40. s.f5 = floats[4]
  41. s.f6 = floats[5]
  42. s.f7 = floats[6]
  43. s.f8 = floats[7]
  44. s.arm64_r8 = r8
  45. }
  46. // SyscallN takes fn, a C function pointer and a list of arguments as uintptr.
  47. // There is an internal maximum number of arguments that SyscallN can take. It panics
  48. // when the maximum is exceeded. It returns the result and the libc error code if there is one.
  49. //
  50. // In order to call this function properly make sure to follow all the rules specified in [unsafe.Pointer]
  51. // especially point 4.
  52. //
  53. // NOTE: SyscallN does not properly call functions that have both integer and float parameters.
  54. // See discussion comment https://github.com/ebiten/purego/pull/1#issuecomment-1128057607
  55. // for an explanation of why that is.
  56. //
  57. // On amd64, if there are more than 8 floats the 9th and so on will be placed incorrectly on the
  58. // stack.
  59. //
  60. // The pragma go:nosplit is not needed at this function declaration because it uses go:uintptrescapes
  61. // which forces all the objects that the uintptrs point to onto the heap where a stack split won't affect
  62. // their memory location.
  63. //
  64. //go:uintptrescapes
  65. func SyscallN(fn uintptr, args ...uintptr) (r1, r2, err uintptr) {
  66. if fn == 0 {
  67. panic("purego: fn is nil")
  68. }
  69. if len(args) > maxArgs {
  70. panic("purego: too many arguments to SyscallN")
  71. }
  72. // add padding so there is no out-of-bounds slicing
  73. var tmp [maxArgs]uintptr
  74. copy(tmp[:], args)
  75. return syscall_syscall15X(fn, tmp[0], tmp[1], tmp[2], tmp[3], tmp[4], tmp[5], tmp[6], tmp[7], tmp[8], tmp[9], tmp[10], tmp[11], tmp[12], tmp[13], tmp[14])
  76. }