Skip to content

Commit dd55eb5

Browse files
marcpruxmarcprux
committed
Add swift-jni README.md, CONTRIBUTING.md, and LICENSE.txt
1 parent b4b1966 commit dd55eb5

File tree

6 files changed

+352
-17
lines changed

6 files changed

+352
-17
lines changed

‎README.md‎

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,11 @@ The primary purpose of this repository is to create an environment for collabora
1919

2020
This project consists of different modules which have different Swift and Java runtime requirements.
2121

22+
### SwiftJNI
23+
24+
SwiftJava depends on the SwiftJNI module from the separate [swift-jni](https://github.com/swiftlang/swift-jni)
25+
package, which provides a standard interface to the Java Native Interface.
26+
2227
## SwiftJava macros
2328

2429
SwiftJava is a Swift library offering macros which simplify writing JNI code "by hand" but also calling Java code from Swift.
@@ -51,7 +56,7 @@ Required language/runtime versions:
5156
In this mode, the generated sources will use the legacy JNI approach to calling native code.
5257

5358
This mode is more limited in some performance and flexibility that it can offer, however it is the most compatible, since even very old JVM's as well as even Android systems can be supported by this mode.
54-
We recommend this mode when FFM is not available, or wide ranging deployment compatibility is your priority. When performance is paramaunt, we recommend the FFM mode instead.
59+
We recommend this mode when FFM is not available, or wide ranging deployment compatibility is your priority. When performance is paramount, we recommend the FFM mode instead.
5560

5661
Required language/runtime versions:
5762
- **Swift 6.1**, because of dependence on rich swift interface files

‎swift-jni/CONTRIBUTING.md‎

Lines changed: 109 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,109 @@
1+
## Legal
2+
3+
By submitting a pull request, you represent that you have the right to license
4+
your contribution to Apple and the community, and agree by submitting the patch
5+
that your contributions are licensed under the Apache 2.0 license (see
6+
`LICENSE.txt`).
7+
8+
## How to submit a bug report
9+
10+
Please ensure to specify the following:
11+
12+
* Commit hash
13+
* Contextual information (e.g. what you were trying to achieve with swift-jni)
14+
* Simplest possible steps to reproduce
15+
* More complex the steps are, lower the priority will be.
16+
* A pull request with failing test case is preferred, but it's just fine to paste the test case into the issue description.
17+
* Anything that might be relevant in your opinion, such as:
18+
* Swift version or the output of `swift --version`
19+
* OS version and the output of `uname -a`
20+
21+
### Example
22+
23+
```
24+
Commit hash: b17a8a9f0f814c01a56977680cb68d8a779c951f
25+
26+
Context:
27+
While testing my application that uses with swift-openapi-generator, I noticed that ...
28+
29+
Steps to reproduce:
30+
1. ...
31+
2. ...
32+
3. ...
33+
4. ...
34+
35+
$ swift --version
36+
Swift version 4.0.2 (swift-4.0.2-RELEASE)
37+
Target: x86_64-unknown-linux-gnu
38+
39+
Operating system: Ubuntu Linux 16.04 64-bit
40+
41+
$ uname -a
42+
Linux beefy.machine 4.4.0-101-generic #124-Ubuntu SMP Fri Nov 10 18:29:59 UTC 2017 x86_64 x86_64 x86_64 GNU/Linux
43+
44+
My system has IPv6 disabled.
45+
```
46+
47+
## Writing a Patch
48+
49+
A good patch is:
50+
51+
1. Concise, and contains as few changes as needed to achieve the end result.
52+
2. Tested, ensuring that any tests provided failed before the patch and pass after it.
53+
3. Documented, adding API documentation as needed to cover new functions and properties.
54+
4. Accompanied by a great commit message, using our commit message template.
55+
56+
### Run CI checks locally
57+
58+
You can run the Github Actions workflows locally using
59+
[act](https://github.com/nektos/act). To run all the jobs that run on a pull
60+
request, use the following command:
61+
62+
```
63+
% act pull_request
64+
```
65+
66+
To run just a single job, use `workflow_call -j <job>`, and specify the inputs
67+
the job expects. For example, to run just shellcheck:
68+
69+
```
70+
% act workflow_call -j soundness --input shell_check_enabled=true
71+
```
72+
73+
To bind-mount the working directory to the container, rather than a copy, use
74+
`--bind`. For example, to run just the formatting, and have the results
75+
reflected in your working directory:
76+
77+
```
78+
% act --bind workflow_call -j soundness --input format_check_enabled=true
79+
```
80+
81+
If you'd like `act` to always run with certain flags, these can be be placed in
82+
an `.actrc` file either in the current working directory or your home
83+
directory, for example:
84+
85+
```
86+
--container-architecture=linux/amd64
87+
--remote-name upstream
88+
--action-offline-mode
89+
```
90+
91+
For frequent contributors, we recommend adding the script as a [git pre-push hook](https://git-scm.com/book/en/v2/Customizing-Git-Git-Hooks), which you can do via executing the following command in the project root directory:
92+
93+
```bash
94+
cat << EOF > .git/hooks/pre-push
95+
96+
if [[ -f "scripts/soundness.sh" ]]; then
97+
scripts/soundness.sh
98+
fi
99+
EOF
100+
```
101+
102+
Which makes the script execute, and only allow the `git push` to complete if the check has passed.
103+
104+
In the case of formatting issues, you can then `git add` the formatting changes, and attempt the push again.
105+
106+
## How to contribute your work
107+
108+
Please open a pull request at https://github.com/swiftlang/swift-jni. Make sure the CI passes, and then wait for code review.
109+

‎swift-jni/LICENSE.txt‎

Lines changed: 211 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,211 @@
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.
202+
203+
204+
205+
## Runtime Library Exception to the Apache 2.0 License: ##
206+
207+
208+
As an exception, if you use this Software to compile your source code and
209+
portions of this Software are embedded into the binary product as a result,
210+
you may redistribute such product without providing attribution as would
211+
otherwise be required by Sections 4(a), 4(b) and 4(d) of the License.

‎swift-jni/README.md‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
# Swift JNI
2+
3+
The swift-jni package presents a low-level Swift-friendly interface to the Java Native Interface (JNI) specification, which is the universal set of data types and functions for interacting with a Java Virtual Machine and compatible derivatives, such as the Android Runtime (ART).
4+
5+
This package is designed to offer low-level zero-dependency support for higher-lever modules, such as [SwiftJava](https://github.com/swiftlang/swift-java) and other projects.
6+
7+
## Features
8+
9+
### JavaValue
10+
11+
A `JavaValue` describes a type that can be bridged with Java. `JavaValue` is the base protocol for bridging between Swift types and their Java counterparts via the Java Native Interface (JNI). It is suitable for describing both value types (such as `Int32` or `Bool`) and object types.
12+
13+
### JavaVirtualMachine
14+
15+
The `JavaVirtualMachine` provides access to a Java Virtual Machine (JVM), which can either be loaded from within a Swift process (via `JNI_CreateJavaVM`), or accessed from a pre-existing in-process handle (`JNI_GetCreatedJavaVMs`). The JavaVirtualMachine is the entry point to interfacing with the JVM, and handles finding and loading classes, looking up and invoking methods, and handling details like locking, threads, and references.
16+
17+
### CSwiftJavaJNI
18+
19+
This C module provides the standardized and implementation-agnostic headers for the Java Native Interface [specification](http://java.sun.com/javase/6/docs/technotes/guides/jni/spec/jniTOC.html). The shape of these structures and symbols are guaranteed to be ABI stable between any compatible Java implementation.

‎swift-jni/Sources/CSwiftJavaJNI/include/CSwiftJavaJNI.h‎

Lines changed: 0 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -12,22 +12,6 @@
1212
//
1313
//===----------------------------------------------------------------------===//
1414

15-
/*
16-
* Copyright (C) 2006 The Android Open Source Project
17-
*
18-
* Licensed under the Apache License, Version 2.0 (the "License");
19-
* you may not use this file except in compliance with the License.
20-
* You may obtain a copy of the License at
21-
*
22-
* http://www.apache.org/licenses/LICENSE-2.0
23-
*
24-
* Unless required by applicable law or agreed to in writing, software
25-
* distributed under the License is distributed on an "AS IS" BASIS,
26-
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
27-
* See the License for the specific language governing permissions and
28-
* limitations under the License.
29-
*/
30-
3115
/*
3216
* JNI specification, as defined by Sun:
3317
* http://java.sun.com/javase/6/docs/technotes/guides/jni/spec/jniTOC.html

‎swift-jni/Sources/SwiftJNI/VirtualMachine/JavaVirtualMachine.swift‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -343,3 +343,10 @@ extension JavaVirtualMachine {
343343
case classpathEntryNotFound(entry: String, classpath: [String])
344344
}
345345
}
346+
347+
// TODO: rather than linking to libjvm at build time, we can simply load these two functions at runtime based on the `JAVA_HOME` environment (and various heuristics), which will prevent the need for unsafe linker flags in Package.swift. This will be necessary for Android support, which doesn't expose `JNI_GetCreatedJavaVMs` as part of the NDK, but which is the only reliable way to obtain a handle to the ambient ART/JVM.
348+
349+
nonisolated(unsafe) private let JNI_CreateJavaVM_Dynamic: (_ pvm: UnsafeMutablePointer<JavaVMPointer?>, _ penv: UnsafeMutablePointer<UnsafeMutableRawPointer?>, _ args: UnsafeMutableRawPointer) -> jint = { fatalError("TODO") }()
350+
351+
nonisolated(unsafe) private let JNI_GetCreatedJavaVMs_Dynamic: (_: UnsafeMutablePointer<JavaVMPointer?>, _: jsize, _: UnsafeMutablePointer<jsize>) -> jint = { fatalError("TODO") }()
352+

0 commit comments

Comments
 (0)