Skip to content

Commit f2e969b

Browse files
chai2010chai2010
committed
添加第三方的purego包, 用于提供不依赖cgo的环境调用动态库能力
1 parent 9b1eb27 commit f2e969b

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

79 files changed

+13224
-0
lines changed

‎internal/3rdparty/purego/LICENSE

+201
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,201 @@
1+
Apache License
2+
Version 2.0, January 2004
3+
http://www.apache.org/licenses/
4+
5+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6+
7+
1. Definitions.
8+
9+
"License" shall mean the terms and conditions for use, reproduction,
10+
and distribution as defined by Sections 1 through 9 of this document.
11+
12+
"Licensor" shall mean the copyright owner or entity authorized by
13+
the copyright owner that is granting the License.
14+
15+
"Legal Entity" shall mean the union of the acting entity and all
16+
other entities that control, are controlled by, or are under common
17+
control with that entity. For the purposes of this definition,
18+
"control" means (i) the power, direct or indirect, to cause the
19+
direction or management of such entity, whether by contract or
20+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
21+
outstanding shares, or (iii) beneficial ownership of such entity.
22+
23+
"You" (or "Your") shall mean an individual or Legal Entity
24+
exercising permissions granted by this License.
25+
26+
"Source" form shall mean the preferred form for making modifications,
27+
including but not limited to software source code, documentation
28+
source, and configuration files.
29+
30+
"Object" form shall mean any form resulting from mechanical
31+
transformation or translation of a Source form, including but
32+
not limited to compiled object code, generated documentation,
33+
and conversions to other media types.
34+
35+
"Work" shall mean the work of authorship, whether in Source or
36+
Object form, made available under the License, as indicated by a
37+
copyright notice that is included in or attached to the work
38+
(an example is provided in the Appendix below).
39+
40+
"Derivative Works" shall mean any work, whether in Source or Object
41+
form, that is based on (or derived from) the Work and for which the
42+
editorial revisions, annotations, elaborations, or other modifications
43+
represent, as a whole, an original work of authorship. For the purposes
44+
of this License, Derivative Works shall not include works that remain
45+
separable from, or merely link (or bind by name) to the interfaces of,
46+
the Work and Derivative Works thereof.
47+
48+
"Contribution" shall mean any work of authorship, including
49+
the original version of the Work and any modifications or additions
50+
to that Work or Derivative Works thereof, that is intentionally
51+
submitted to Licensor for inclusion in the Work by the copyright owner
52+
or by an individual or Legal Entity authorized to submit on behalf of
53+
the copyright owner. For the purposes of this definition, "submitted"
54+
means any form of electronic, verbal, or written communication sent
55+
to the Licensor or its representatives, including but not limited to
56+
communication on electronic mailing lists, source code control systems,
57+
and issue tracking systems that are managed by, or on behalf of, the
58+
Licensor for the purpose of discussing and improving the Work, but
59+
excluding communication that is conspicuously marked or otherwise
60+
designated in writing by the copyright owner as "Not a Contribution."
61+
62+
"Contributor" shall mean Licensor and any individual or Legal Entity
63+
on behalf of whom a Contribution has been received by Licensor and
64+
subsequently incorporated within the Work.
65+
66+
2. Grant of Copyright License. Subject to the terms and conditions of
67+
this License, each Contributor hereby grants to You a perpetual,
68+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69+
copyright license to reproduce, prepare Derivative Works of,
70+
publicly display, publicly perform, sublicense, and distribute the
71+
Work and such Derivative Works in Source or Object form.
72+
73+
3. Grant of Patent License. Subject to the terms and conditions of
74+
this License, each Contributor hereby grants to You a perpetual,
75+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76+
(except as stated in this section) patent license to make, have made,
77+
use, offer to sell, sell, import, and otherwise transfer the Work,
78+
where such license applies only to those patent claims licensable
79+
by such Contributor that are necessarily infringed by their
80+
Contribution(s) alone or by combination of their Contribution(s)
81+
with the Work to which such Contribution(s) was submitted. If You
82+
institute patent litigation against any entity (including a
83+
cross-claim or counterclaim in a lawsuit) alleging that the Work
84+
or a Contribution incorporated within the Work constitutes direct
85+
or contributory patent infringement, then any patent licenses
86+
granted to You under this License for that Work shall terminate
87+
as of the date such litigation is filed.
88+
89+
4. Redistribution. You may reproduce and distribute copies of the
90+
Work or Derivative Works thereof in any medium, with or without
91+
modifications, and in Source or Object form, provided that You
92+
meet the following conditions:
93+
94+
(a) You must give any other recipients of the Work or
95+
Derivative Works a copy of this License; and
96+
97+
(b) You must cause any modified files to carry prominent notices
98+
stating that You changed the files; and
99+
100+
(c) You must retain, in the Source form of any Derivative Works
101+
that You distribute, all copyright, patent, trademark, and
102+
attribution notices from the Source form of the Work,
103+
excluding those notices that do not pertain to any part of
104+
the Derivative Works; and
105+
106+
(d) If the Work includes a "NOTICE" text file as part of its
107+
distribution, then any Derivative Works that You distribute must
108+
include a readable copy of the attribution notices contained
109+
within such NOTICE file, excluding those notices that do not
110+
pertain to any part of the Derivative Works, in at least one
111+
of the following places: within a NOTICE text file distributed
112+
as part of the Derivative Works; within the Source form or
113+
documentation, if provided along with the Derivative Works; or,
114+
within a display generated by the Derivative Works, if and
115+
wherever such third-party notices normally appear. The contents
116+
of the NOTICE file are for informational purposes only and
117+
do not modify the License. You may add Your own attribution
118+
notices within Derivative Works that You distribute, alongside
119+
or as an addendum to the NOTICE text from the Work, provided
120+
that such additional attribution notices cannot be construed
121+
as modifying the License.
122+
123+
You may add Your own copyright statement to Your modifications and
124+
may provide additional or different license terms and conditions
125+
for use, reproduction, or distribution of Your modifications, or
126+
for any such Derivative Works as a whole, provided Your use,
127+
reproduction, and distribution of the Work otherwise complies with
128+
the conditions stated in this License.
129+
130+
5. Submission of Contributions. Unless You explicitly state otherwise,
131+
any Contribution intentionally submitted for inclusion in the Work
132+
by You to the Licensor shall be under the terms and conditions of
133+
this License, without any additional terms or conditions.
134+
Notwithstanding the above, nothing herein shall supersede or modify
135+
the terms of any separate license agreement you may have executed
136+
with Licensor regarding such Contributions.
137+
138+
6. Trademarks. This License does not grant permission to use the trade
139+
names, trademarks, service marks, or product names of the Licensor,
140+
except as required for reasonable and customary use in describing the
141+
origin of the Work and reproducing the content of the NOTICE file.
142+
143+
7. Disclaimer of Warranty. Unless required by applicable law or
144+
agreed to in writing, Licensor provides the Work (and each
145+
Contributor provides its Contributions) on an "AS IS" BASIS,
146+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147+
implied, including, without limitation, any warranties or conditions
148+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149+
PARTICULAR PURPOSE. You are solely responsible for determining the
150+
appropriateness of using or redistributing the Work and assume any
151+
risks associated with Your exercise of permissions under this License.
152+
153+
8. Limitation of Liability. In no event and under no legal theory,
154+
whether in tort (including negligence), contract, or otherwise,
155+
unless required by applicable law (such as deliberate and grossly
156+
negligent acts) or agreed to in writing, shall any Contributor be
157+
liable to You for damages, including any direct, indirect, special,
158+
incidental, or consequential damages of any character arising as a
159+
result of this License or out of the use or inability to use the
160+
Work (including but not limited to damages for loss of goodwill,
161+
work stoppage, computer failure or malfunction, or any and all
162+
other commercial damages or losses), even if such Contributor
163+
has been advised of the possibility of such damages.
164+
165+
9. Accepting Warranty or Additional Liability. While redistributing
166+
the Work or Derivative Works thereof, You may choose to offer,
167+
and charge a fee for, acceptance of support, warranty, indemnity,
168+
or other liability obligations and/or rights consistent with this
169+
License. However, in accepting such obligations, You may act only
170+
on Your own behalf and on Your sole responsibility, not on behalf
171+
of any other Contributor, and only if You agree to indemnify,
172+
defend, and hold each Contributor harmless for any liability
173+
incurred by, or claims asserted against, such Contributor by reason
174+
of your accepting any such warranty or additional liability.
175+
176+
END OF TERMS AND CONDITIONS
177+
178+
APPENDIX: How to apply the Apache License to your work.
179+
180+
To apply the Apache License to your work, attach the following
181+
boilerplate notice, with the fields enclosed by brackets "{}"
182+
replaced with your own identifying information. (Don't include
183+
the brackets!) The text should be enclosed in the appropriate
184+
comment syntax for the file format. We also recommend that a
185+
file or class name and description of purpose be included on the
186+
same "printed page" as the copyright notice for easier
187+
identification within third-party archives.
188+
189+
Copyright {yyyy} {name of copyright owner}
190+
191+
Licensed under the Apache License, Version 2.0 (the "License");
192+
you may not use this file except in compliance with the License.
193+
You may obtain a copy of the License at
194+
195+
http://www.apache.org/licenses/LICENSE-2.0
196+
197+
Unless required by applicable law or agreed to in writing, software
198+
distributed under the License is distributed on an "AS IS" BASIS,
199+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200+
See the License for the specific language governing permissions and
201+
limitations under the License.

‎internal/3rdparty/purego/README.md

+97
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,97 @@
1+
# purego
2+
[![Go Reference](https://pkg.go.dev/badge/github.com/ebitengine/purego?GOOS=darwin.svg)](https://pkg.go.dev/github.com/ebitengine/purego?GOOS=darwin)
3+
4+
A library for calling C functions from Go without Cgo.
5+
6+
> This is beta software so expect bugs and potentially API breaking changes
7+
> but each release will be tagged to avoid breaking people's code.
8+
> Bug reports are encouraged.
9+
10+
## Motivation
11+
12+
The [Ebitengine](https://github.com/hajimehoshi/ebiten) game engine was ported to use only Go on Windows. This enabled
13+
cross-compiling to Windows from any other operating system simply by setting `GOOS=windows`. The purego project was
14+
born to bring that same vision to the other platforms supported by Ebitengine.
15+
16+
## Benefits
17+
18+
- **Simple Cross-Compilation**: No C means you can build for other platforms easily without a C compiler.
19+
- **Faster Compilation**: Efficiently cache your entirely Go builds.
20+
- **Smaller Binaries**: Using Cgo generates a C wrapper function for each C function called. Purego doesn't!
21+
- **Dynamic Linking**: Load symbols at runtime and use it as a plugin system.
22+
- **Foreign Function Interface**: Call into other languages that are compiled into shared objects.
23+
- **Cgo Fallback**: Works even with CGO_ENABLED=1 so incremental porting is possible.
24+
This also means unsupported GOARCHs (freebsd/riscv64, linux/mips, etc.) will still work
25+
except for float arguments and return values.
26+
27+
## Supported Platforms
28+
29+
- **FreeBSD**: amd64, arm64
30+
- **Linux**: amd64, arm64
31+
- **macOS / iOS**: amd64, arm64
32+
- **Windows**: 386*, amd64, arm*, arm64
33+
34+
`*` These architectures only support SyscallN and NewCallback
35+
36+
## Example
37+
38+
The example below only showcases purego use for macOS and Linux. The other platforms require special handling which can
39+
be seen in the complete example at [examples/libc](https://github.com/ebitengine/purego/tree/main/examples/libc) which supports Windows and FreeBSD.
40+
41+
```go
42+
package main
43+
44+
import (
45+
"fmt"
46+
"runtime"
47+
48+
"github.com/ebitengine/purego"
49+
)
50+
51+
func getSystemLibrary() string {
52+
switch runtime.GOOS {
53+
case "darwin":
54+
return "/usr/lib/libSystem.B.dylib"
55+
case "linux":
56+
return "libc.so.6"
57+
default:
58+
panic(fmt.Errorf("GOOS=%s is not supported", runtime.GOOS))
59+
}
60+
}
61+
62+
func main() {
63+
libc, err := purego.Dlopen(getSystemLibrary(), purego.RTLD_NOW|purego.RTLD_GLOBAL)
64+
if err != nil {
65+
panic(err)
66+
}
67+
var puts func(string)
68+
purego.RegisterLibFunc(&puts, libc, "puts")
69+
puts("Calling C from Go without Cgo!")
70+
}
71+
```
72+
73+
Then to run: `CGO_ENABLED=0 go run main.go`
74+
75+
## Questions
76+
77+
If you have questions about how to incorporate purego in your project or want to discuss
78+
how it works join the [Discord](https://discord.gg/HzGZVD6BkY)!
79+
80+
### External Code
81+
82+
Purego uses code that originates from the Go runtime. These files are under the BSD-3
83+
License that can be found [in the Go Source](https://github.com/golang/go/blob/master/LICENSE).
84+
This is a list of the copied files:
85+
86+
* `abi_*.h` from package `runtime/cgo`
87+
* `zcallback_darwin_*.s` from package `runtime`
88+
* `internal/fakecgo/abi_*.h` from package `runtime/cgo`
89+
* `internal/fakecgo/asm_GOARCH.s` from package `runtime/cgo`
90+
* `internal/fakecgo/callbacks.go` from package `runtime/cgo`
91+
* `internal/fakecgo/go_GOOS_GOARCH.go` from package `runtime/cgo`
92+
* `internal/fakecgo/iscgo.go` from package `runtime/cgo`
93+
* `internal/fakecgo/setenv.go` from package `runtime/cgo`
94+
* `internal/fakecgo/freebsd.go` from package `runtime/cgo`
95+
96+
The files `abi_*.h` and `internal/fakecgo/abi_*.h` are the same because Bazel does not support cross-package use of
97+
`#include` so we need each one once per package. (cf. [issue](https://github.com/bazelbuild/rules_go/issues/3636))

‎internal/3rdparty/purego/abi_amd64.h

+99
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,99 @@
1+
// Copyright 2021 The Go Authors. All rights reserved.
2+
// Use of this source code is governed by a BSD-style
3+
// license that can be found in the LICENSE file.
4+
5+
// Macros for transitioning from the host ABI to Go ABI0.
6+
//
7+
// These save the frame pointer, so in general, functions that use
8+
// these should have zero frame size to suppress the automatic frame
9+
// pointer, though it's harmless to not do this.
10+
11+
#ifdef GOOS_windows
12+
13+
// REGS_HOST_TO_ABI0_STACK is the stack bytes used by
14+
// PUSH_REGS_HOST_TO_ABI0.
15+
#define REGS_HOST_TO_ABI0_STACK (28*8 + 8)
16+
17+
// PUSH_REGS_HOST_TO_ABI0 prepares for transitioning from
18+
// the host ABI to Go ABI0 code. It saves all registers that are
19+
// callee-save in the host ABI and caller-save in Go ABI0 and prepares
20+
// for entry to Go.
21+
//
22+
// Save DI SI BP BX R12 R13 R14 R15 X6-X15 registers and the DF flag.
23+
// Clear the DF flag for the Go ABI.
24+
// MXCSR matches the Go ABI, so we don't have to set that,
25+
// and Go doesn't modify it, so we don't have to save it.
26+
#define PUSH_REGS_HOST_TO_ABI0() \
27+
PUSHFQ \
28+
CLD \
29+
ADJSP $(REGS_HOST_TO_ABI0_STACK - 8) \
30+
MOVQ DI, (0*0)(SP) \
31+
MOVQ SI, (1*8)(SP) \
32+
MOVQ BP, (2*8)(SP) \
33+
MOVQ BX, (3*8)(SP) \
34+
MOVQ R12, (4*8)(SP) \
35+
MOVQ R13, (5*8)(SP) \
36+
MOVQ R14, (6*8)(SP) \
37+
MOVQ R15, (7*8)(SP) \
38+
MOVUPS X6, (8*8)(SP) \
39+
MOVUPS X7, (10*8)(SP) \
40+
MOVUPS X8, (12*8)(SP) \
41+
MOVUPS X9, (14*8)(SP) \
42+
MOVUPS X10, (16*8)(SP) \
43+
MOVUPS X11, (18*8)(SP) \
44+
MOVUPS X12, (20*8)(SP) \
45+
MOVUPS X13, (22*8)(SP) \
46+
MOVUPS X14, (24*8)(SP) \
47+
MOVUPS X15, (26*8)(SP)
48+
49+
#define POP_REGS_HOST_TO_ABI0() \
50+
MOVQ (0*0)(SP), DI \
51+
MOVQ (1*8)(SP), SI \
52+
MOVQ (2*8)(SP), BP \
53+
MOVQ (3*8)(SP), BX \
54+
MOVQ (4*8)(SP), R12 \
55+
MOVQ (5*8)(SP), R13 \
56+
MOVQ (6*8)(SP), R14 \
57+
MOVQ (7*8)(SP), R15 \
58+
MOVUPS (8*8)(SP), X6 \
59+
MOVUPS (10*8)(SP), X7 \
60+
MOVUPS (12*8)(SP), X8 \
61+
MOVUPS (14*8)(SP), X9 \
62+
MOVUPS (16*8)(SP), X10 \
63+
MOVUPS (18*8)(SP), X11 \
64+
MOVUPS (20*8)(SP), X12 \
65+
MOVUPS (22*8)(SP), X13 \
66+
MOVUPS (24*8)(SP), X14 \
67+
MOVUPS (26*8)(SP), X15 \
68+
ADJSP $-(REGS_HOST_TO_ABI0_STACK - 8) \
69+
POPFQ
70+
71+
#else
72+
// SysV ABI
73+
74+
#define REGS_HOST_TO_ABI0_STACK (6*8)
75+
76+
// SysV MXCSR matches the Go ABI, so we don't have to set that,
77+
// and Go doesn't modify it, so we don't have to save it.
78+
// Both SysV and Go require DF to be cleared, so that's already clear.
79+
// The SysV and Go frame pointer conventions are compatible.
80+
#define PUSH_REGS_HOST_TO_ABI0() \
81+
ADJSP $(REGS_HOST_TO_ABI0_STACK) \
82+
MOVQ BP, (5*8)(SP) \
83+
LEAQ (5*8)(SP), BP \
84+
MOVQ BX, (0*8)(SP) \
85+
MOVQ R12, (1*8)(SP) \
86+
MOVQ R13, (2*8)(SP) \
87+
MOVQ R14, (3*8)(SP) \
88+
MOVQ R15, (4*8)(SP)
89+
90+
#define POP_REGS_HOST_TO_ABI0() \
91+
MOVQ (0*8)(SP), BX \
92+
MOVQ (1*8)(SP), R12 \
93+
MOVQ (2*8)(SP), R13 \
94+
MOVQ (3*8)(SP), R14 \
95+
MOVQ (4*8)(SP), R15 \
96+
MOVQ (5*8)(SP), BP \
97+
ADJSP $-(REGS_HOST_TO_ABI0_STACK)
98+
99+
#endif

0 commit comments

Comments
 (0)