1// SPDX-License-Identifier: Apache-2.0
2// SPDX-FileCopyrightText: 2022 The Ebitengine Authors
3
4//go:build !386 && !arm && (darwin || freebsd || linux || netbsd || windows)
5
6package purego
7
8// CDecl marks a function as being called using the __cdecl calling convention as defined in
9// the [MSDocs] when passed to NewCallback. It must be the first argument to the function.
10// This is only useful on 386 Windows, but it is safe to use on other platforms.
11//
12// [MSDocs]: https://learn.microsoft.com/en-us/cpp/cpp/cdecl?view=msvc-170
13type CDecl struct{}
14
15const (
16 maxArgs = 15
17)
18
19type syscall15Args struct {
20 _ hostLayout
21 fn, a1, a2, a3, a4, a5, a6, a7, a8, a9, a10, a11, a12, a13, a14, a15 uintptr
22 f1, f2, f3, f4, f5, f6, f7, f8 uintptr
23 arm64_r8 uintptr
24}
25
26func (s *syscall15Args) Set(fn uintptr, ints []uintptr, floats []uintptr, r8 uintptr) {
27 s.fn = fn
28 s.a1 = ints[0]
29 s.a2 = ints[1]
30 s.a3 = ints[2]
31 s.a4 = ints[3]
32 s.a5 = ints[4]
33 s.a6 = ints[5]
34 s.a7 = ints[6]
35 s.a8 = ints[7]
36 s.a9 = ints[8]
37 s.a10 = ints[9]
38 s.a11 = ints[10]
39 s.a12 = ints[11]
40 s.a13 = ints[12]
41 s.a14 = ints[13]
42 s.a15 = ints[14]
43 s.f1 = floats[0]
44 s.f2 = floats[1]
45 s.f3 = floats[2]
46 s.f4 = floats[3]
47 s.f5 = floats[4]
48 s.f6 = floats[5]
49 s.f7 = floats[6]
50 s.f8 = floats[7]
51 s.arm64_r8 = r8
52}
53
54// SyscallN takes fn, a C function pointer and a list of arguments as uintptr.
55// There is an internal maximum number of arguments that SyscallN can take.
56// On 386 and arm, SyscallN supports at most 15 uintptr arguments.
57// It panics when the maximum is exceeded. It returns the result and the libc error code if there is one.
58//
59// In order to call this function properly make sure to follow all the rules specified in [unsafe.Pointer]
60// especially point 4.
61//
62// NOTE: SyscallN does not properly call functions that have both integer and float parameters.
63// Use RegisterFunc instead when the target function mixes integer and floating-point arguments.
64// See discussion comment https://github.com/ebiten/purego/pull/1#issuecomment-1128057607
65// for an explanation of why that is.
66//
67// On amd64, if there are more than 8 floats the 9th and so on will be placed incorrectly on the
68// stack.
69//
70// The pragma go:nosplit is not needed at this function declaration because it uses go:uintptrescapes
71// which forces all the objects that the uintptrs point to onto the heap where a stack split won't affect
72// their memory location.
73//
74//go:uintptrescapes
75func SyscallN(fn uintptr, args ...uintptr) (r1, r2, err uintptr) {
76 if fn == 0 {
77 panic("purego: fn is nil")
78 }
79 if len(args) > maxArgs {
80 panic("purego: too many arguments to SyscallN")
81 }
82 // add padding so there is no out-of-bounds slicing
83 var tmp [maxArgs]uintptr
84 copy(tmp[:], args)
85 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])
86}
87
88// SyscallSelf is like SyscallN but efficiently prepends self to args without allocation.
89// It is designed for method-like calls where the first argument is always a receiver pointer.
90// It shares SyscallN's argument-placement limits and mixed integer/float restriction.
91// On 386 and arm, the total count including self is limited to 15 uintptr arguments.
92// This avoids the heap allocation that would occur with SyscallN(fn, append([]uintptr{self}, args...)...).
93//
94//go:uintptrescapes
95func SyscallSelf(fn, self uintptr, args ...uintptr) (r1, r2, err uintptr) {
96 if fn == 0 {
97 panic("purego: fn is nil")
98 }
99 if len(args) > maxArgs-1 {
100 panic("purego: too many arguments to SyscallSelf")
101 }
102 // Use a stack-allocated array to prepend self without heap allocation.
103 // self goes in tmp[0], remaining args follow.
104 var tmp [maxArgs]uintptr
105 tmp[0] = self
106 copy(tmp[1:], args)
107 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])
108}