Skip to content

Commit 29a2cbf

Browse files
MizuxMizux
committed
julia: add first version of ORToolsBinaries.jl
1 parent 642c19b commit 29a2cbf

File tree

5 files changed

+376
-0
lines changed

5 files changed

+376
-0
lines changed

‎ortools/julia/ORToolsBinaries.jl/LICENSE.md‎

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

‎ortools/julia/ORToolsBinaries.jl/Project.toml‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
name = "ORToolsBinaries"
2+
uuid = "594ad865-6a17-49ee-8f22-76ed020c7c08"
3+
version = "0.0.1"
4+
5+
[deps]
6+
Downloads = "f43a241f-c20a-4ad4-852c-f6b1247861c6"
7+
ZipArchives = "49080126-0e18-4c2a-b176-c102e4b3760c"
8+
Tar = "a4e569a6-e804-4fa4-b0f3-eef7a1d5b13e"
9+
CodecZlib = "944b1d66-785c-5afd-91f1-9de20f533193"
10+
11+
[compat]
12+
julia = "1.9"
13+
Downloads = "1"
14+
ZipArchives = "2"
15+
Tar = "1"
16+
CodecZlib = "0.7"

‎ortools/julia/ORToolsBinaries.jl/README.md‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# ORToolsBinaries
2+
3+
This package, upon installation, downloads the latest OR-Tools binaries from
4+
GitHub. This is especially useful on platforms like Windows or ARM64/Aarch64
5+
because no JLL is available for them.
6+
7+
This package otherwise provides the same interface as
8+
[`ORTools_jll.jl`](https://github.com/JuliaBinaryWrappers/ORTools_jll.jl),
9+
i.e. a global variable `libortools` that contains the path to the local copy
10+
of OR-Tools.

‎ortools/julia/ORToolsBinaries.jl/deps/build.jl‎

Lines changed: 125 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,125 @@
1+
import Downloads
2+
import ZipArchives
3+
import Tar
4+
import CodecZlib
5+
6+
const BASE_URL = "https://github.com/google/or-tools/releases/download"
7+
const ORTOOLS_MINOR_VERSION = "9.14"
8+
const ORTOOLS_PATCH_VERSION = "9.14.6206"
9+
10+
const PACKAGE_FILE_NAME_WITHOUT_EXTENSION = Dict{String, String}(
11+
"linux_arm64" => "or-tools_aarch64_AlmaLinux-8.10_cpp_v$ORTOOLS_PATCH_VERSION",
12+
"linux_x64" => "or-tools_amd64_almalinux-9_cpp_v$ORTOOLS_PATCH_VERSION",
13+
"macos_arm64" => "or-tools_arm64_macOS-15.5_cpp_v$ORTOOLS_PATCH_VERSION",
14+
"macos_x64" => "or-tools_x86_64_macOS-15.5_cpp_v$ORTOOLS_PATCH_VERSION",
15+
"windows_x64" => "or-tools_x64_VisualStudio2022_cpp_v$ORTOOLS_PATCH_VERSION",
16+
)
17+
18+
const TARGET_PACKAGES = Dict{String, String}(
19+
platform => "$BASE_URL/v$ORTOOLS_MINOR_VERSION/$name.$(ifelse(startswith(platform, "windows"), "zip", "tar.gz"))"
20+
for (platform, name) in PACKAGE_FILE_NAME_WITHOUT_EXTENSION
21+
)
22+
23+
const DEPS_DIR = @__DIR__
24+
25+
println("WARNING: if ORTools_jll provides binaries for your platform, prefer using them rather than this package.")
26+
println()
27+
println("Downloading and installing a precompiled version of OR-Tools...")
28+
println("BASE_URL: $BASE_URL, ORTOOLS_MINOR_VERSION: $ORTOOLS_MINOR_VERSION, ORTOOLS_PATCH_VERSION: $ORTOOLS_PATCH_VERSION")
29+
30+
key = "unknown"
31+
if Sys.islinux()
32+
if Sys.ARCH === :x86_64
33+
key = "linux_x64"
34+
elseif Sys.ARCH === :aarch64
35+
key = "linux_arm64"
36+
else
37+
key = "linux_unknown"
38+
end
39+
elseif Sys.isapple()
40+
if Sys.ARCH === :x86_64
41+
key = "macos_x64"
42+
elseif Sys.ARCH === :aarch64
43+
key = "macos_arm64"
44+
else
45+
key = "macos_unknown"
46+
end
47+
elseif Sys.iswindows()
48+
if Sys.ARCH === :x86_64
49+
key = "windows_x64"
50+
elseif Sys.ARCH === :aarch64
51+
key = "windows_arm64"
52+
else
53+
key = "windows_unknown"
54+
end
55+
end
56+
57+
println("Sys.islinux: $(Sys.islinux()), Sys.isapple: $(Sys.isapple()), Sys.iswindows: $(Sys.iswindows()), Sys.ARCH: $(Sys.ARCH)")
58+
println("Detected platform: $key")
59+
if !(key in keys(TARGET_PACKAGES))
60+
error("No package found for $key. Known packages: $(keys(TARGET_PACKAGES)). Maybe ORTools_jll contains a package for your platform.")
61+
end
62+
63+
println("Downloading the following binary package:")
64+
println(TARGET_PACKAGES[key])
65+
package = Downloads.download(TARGET_PACKAGES[key])
66+
println("Package downloaded. Size: $(filesize(package)) bytes, i.e. roughly $(round(Int, filesize(package) / 1024 / 1024)) MiB")
67+
println("Local path (temporary): $package")
68+
69+
dest_dir = joinpath(DEPS_DIR, "lib")
70+
if isdir(dest_dir)
71+
rm(dest_dir, recursive=true, force=true)
72+
end
73+
mkpath(dest_dir)
74+
75+
count_files = 0
76+
if endswith(TARGET_PACKAGES[key], ".zip")
77+
# Only for Windows. The ZIP archive contains a folder with the same name
78+
# as the archive itself. We only need the DLLs in the `bin` folder.
79+
zr = ZipArchives.ZipReader(read(package))
80+
for name in ZipArchives.zip_names(zr)
81+
if startswith(name, PACKAGE_FILE_NAME_WITHOUT_EXTENSION[key]) && endswith(name, ".dll")
82+
filename = basename(name)
83+
println("Extracting: $filename (path in the ZIP archive: $name)")
84+
85+
ZipArchives.zip_openentry(zr, name) do io
86+
open(joinpath(dest_dir, filename), "w") do f
87+
write(f, io)
88+
end
89+
end
90+
global count_files
91+
count_files += 1
92+
end
93+
end
94+
elseif endswith(TARGET_PACKAGES[key], ".tar.gz")
95+
# For all other platforms. The TAR.GZ archives contains a folder with the
96+
# same name as the archive itself. We need all the dynamic libraries in
97+
# the `lib` or `lib64` folder (`lib` is for MacOS, `lib64` is for Linux).
98+
open(package, "r") do tar_gz
99+
tar_stream = CodecZlib.GzipDecompressorStream(tar_gz)
100+
101+
Tar.extract(tar_stream, dest_dir) do header
102+
name = header.path
103+
should_extract = startswith(name, PACKAGE_FILE_NAME_WITHOUT_EXTENSION[key]) &&
104+
(endswith(name, ".so") || endswith(name, ".dylib"))
105+
if should_extract
106+
println("Extracting: $(basename(name)) (path in TAR.GZ archive: $(name))")
107+
end
108+
return should_extract
109+
end
110+
end
111+
112+
# Flatten the output, because Tar.extract recreates whatever path it
113+
# finds in the archive.
114+
for (root, dirs, files) in walkdir(dest_dir)
115+
for file in files
116+
mv(joinpath(root, file), joinpath(dest_dir, file), force=true)
117+
end
118+
end
119+
120+
# Clean up after flattening.
121+
rm(joinpath(dest_dir, PACKAGE_FILE_NAME_WITHOUT_EXTENSION[key]), recursive=true)
122+
else
123+
error("Assertion failed: archive type not supported. Please report the problem to the maintainers of OR-Tools.")
124+
end
125+
println("Installed $count_files files in $dest_dir.")

‎ortools/julia/ORToolsBinaries.jl/src/ORToolsBinaries.jl‎

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
module ORToolsBinaries
2+
3+
export libortools
4+
5+
const _SRC_DIR = @__DIR__
6+
const _DEPS_DIR = joinpath(_SRC_DIR, "..", "deps")
7+
const _LIB_DIR = joinpath(_DEPS_DIR, "lib")
8+
9+
if Sys.islinux()
10+
const libortools = joinpath(_LIB_DIR, "libortools.so")
11+
elseif Sys.isapple()
12+
const libortools = joinpath(_LIB_DIR, "libortools.dylib")
13+
elseif Sys.iswindows()
14+
const libortools = joinpath(_LIB_DIR, "ortools.dll")
15+
else
16+
@error "Platform not supported! If ORTools_jll provides binaries for your platform, prefer using them rather than this package."
17+
end
18+
19+
if !isfile(libortools)
20+
@error "Installing ORToolsBinaries failed, the expected binary is not available at the expected path ($libortools)"
21+
end
22+
23+
end

0 commit comments

Comments
 (0)