diff --git a/ortools/julia/ORToolsBinaries.jl/LICENSE.md b/ortools/julia/ORToolsBinaries.jl/LICENSE.md new file mode 100644 index 0000000000..d645695673 --- /dev/null +++ b/ortools/julia/ORToolsBinaries.jl/LICENSE.md @@ -0,0 +1,202 @@ + + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/ortools/julia/ORToolsBinaries.jl/Project.toml b/ortools/julia/ORToolsBinaries.jl/Project.toml new file mode 100644 index 0000000000..6fca905e43 --- /dev/null +++ b/ortools/julia/ORToolsBinaries.jl/Project.toml @@ -0,0 +1,16 @@ +name = "ORToolsBinaries" +uuid = "594ad865-6a17-49ee-8f22-76ed020c7c08" +version = "0.0.1" + +[deps] +Downloads = "f43a241f-c20a-4ad4-852c-f6b1247861c6" +ZipArchives = "49080126-0e18-4c2a-b176-c102e4b3760c" +Tar = "a4e569a6-e804-4fa4-b0f3-eef7a1d5b13e" +CodecZlib = "944b1d66-785c-5afd-91f1-9de20f533193" + +[compat] +julia = "1.9" +Downloads = "1" +ZipArchives = "2" +Tar = "1" +CodecZlib = "0.7" diff --git a/ortools/julia/ORToolsBinaries.jl/README.md b/ortools/julia/ORToolsBinaries.jl/README.md new file mode 100644 index 0000000000..df304a7160 --- /dev/null +++ b/ortools/julia/ORToolsBinaries.jl/README.md @@ -0,0 +1,10 @@ +# ORToolsBinaries + +This package, upon installation, downloads the latest OR-Tools binaries from +GitHub. This is especially useful on platforms like Windows or ARM64/Aarch64 +because no JLL is available for them. + +This package otherwise provides the same interface as +[`ORTools_jll.jl`](https://github.com/JuliaBinaryWrappers/ORTools_jll.jl), +i.e. a global variable `libortools` that contains the path to the local copy +of OR-Tools. diff --git a/ortools/julia/ORToolsBinaries.jl/deps/build.jl b/ortools/julia/ORToolsBinaries.jl/deps/build.jl new file mode 100644 index 0000000000..27fc8c71f3 --- /dev/null +++ b/ortools/julia/ORToolsBinaries.jl/deps/build.jl @@ -0,0 +1,125 @@ +import Downloads +import ZipArchives +import Tar +import CodecZlib + +const BASE_URL = "https://github.com/google/or-tools/releases/download" +const ORTOOLS_MINOR_VERSION = "9.14" +const ORTOOLS_PATCH_VERSION = "9.14.6206" + +const PACKAGE_FILE_NAME_WITHOUT_EXTENSION = Dict{String, String}( + "linux_arm64" => "or-tools_aarch64_AlmaLinux-8.10_cpp_v$ORTOOLS_PATCH_VERSION", + "linux_x64" => "or-tools_amd64_almalinux-9_cpp_v$ORTOOLS_PATCH_VERSION", + "macos_arm64" => "or-tools_arm64_macOS-15.5_cpp_v$ORTOOLS_PATCH_VERSION", + "macos_x64" => "or-tools_x86_64_macOS-15.5_cpp_v$ORTOOLS_PATCH_VERSION", + "windows_x64" => "or-tools_x64_VisualStudio2022_cpp_v$ORTOOLS_PATCH_VERSION", +) + +const TARGET_PACKAGES = Dict{String, String}( + platform => "$BASE_URL/v$ORTOOLS_MINOR_VERSION/$name.$(ifelse(startswith(platform, "windows"), "zip", "tar.gz"))" + for (platform, name) in PACKAGE_FILE_NAME_WITHOUT_EXTENSION +) + +const DEPS_DIR = @__DIR__ + +println("WARNING: if ORTools_jll provides binaries for your platform, prefer using them rather than this package.") +println() +println("Downloading and installing a precompiled version of OR-Tools...") +println("BASE_URL: $BASE_URL, ORTOOLS_MINOR_VERSION: $ORTOOLS_MINOR_VERSION, ORTOOLS_PATCH_VERSION: $ORTOOLS_PATCH_VERSION") + +key = "unknown" +if Sys.islinux() + if Sys.ARCH === :x86_64 + key = "linux_x64" + elseif Sys.ARCH === :aarch64 + key = "linux_arm64" + else + key = "linux_unknown" + end +elseif Sys.isapple() + if Sys.ARCH === :x86_64 + key = "macos_x64" + elseif Sys.ARCH === :aarch64 + key = "macos_arm64" + else + key = "macos_unknown" + end +elseif Sys.iswindows() + if Sys.ARCH === :x86_64 + key = "windows_x64" + elseif Sys.ARCH === :aarch64 + key = "windows_arm64" + else + key = "windows_unknown" + end +end + +println("Sys.islinux: $(Sys.islinux()), Sys.isapple: $(Sys.isapple()), Sys.iswindows: $(Sys.iswindows()), Sys.ARCH: $(Sys.ARCH)") +println("Detected platform: $key") +if !(key in keys(TARGET_PACKAGES)) + error("No package found for $key. Known packages: $(keys(TARGET_PACKAGES)). Maybe ORTools_jll contains a package for your platform.") +end + +println("Downloading the following binary package:") +println(TARGET_PACKAGES[key]) +package = Downloads.download(TARGET_PACKAGES[key]) +println("Package downloaded. Size: $(filesize(package)) bytes, i.e. roughly $(round(Int, filesize(package) / 1024 / 1024)) MiB") +println("Local path (temporary): $package") + +dest_dir = joinpath(DEPS_DIR, "lib") +if isdir(dest_dir) + rm(dest_dir, recursive=true, force=true) +end +mkpath(dest_dir) + +count_files = 0 +if endswith(TARGET_PACKAGES[key], ".zip") + # Only for Windows. The ZIP archive contains a folder with the same name + # as the archive itself. We only need the DLLs in the `bin` folder. + zr = ZipArchives.ZipReader(read(package)) + for name in ZipArchives.zip_names(zr) + if startswith(name, PACKAGE_FILE_NAME_WITHOUT_EXTENSION[key]) && endswith(name, ".dll") + filename = basename(name) + println("Extracting: $filename (path in the ZIP archive: $name)") + + ZipArchives.zip_openentry(zr, name) do io + open(joinpath(dest_dir, filename), "w") do f + write(f, io) + end + end + global count_files + count_files += 1 + end + end +elseif endswith(TARGET_PACKAGES[key], ".tar.gz") + # For all other platforms. The TAR.GZ archives contains a folder with the + # same name as the archive itself. We need all the dynamic libraries in + # the `lib` or `lib64` folder (`lib` is for MacOS, `lib64` is for Linux). + open(package, "r") do tar_gz + tar_stream = CodecZlib.GzipDecompressorStream(tar_gz) + + Tar.extract(tar_stream, dest_dir) do header + name = header.path + should_extract = startswith(name, PACKAGE_FILE_NAME_WITHOUT_EXTENSION[key]) && + (endswith(name, ".so") || endswith(name, ".dylib")) + if should_extract + println("Extracting: $(basename(name)) (path in TAR.GZ archive: $(name))") + end + return should_extract + end + end + + # Flatten the output, because Tar.extract recreates whatever path it + # finds in the archive. + for (root, dirs, files) in walkdir(dest_dir) + for file in files + mv(joinpath(root, file), joinpath(dest_dir, file), force=true) + end + end + + # Clean up after flattening. + rm(joinpath(dest_dir, PACKAGE_FILE_NAME_WITHOUT_EXTENSION[key]), recursive=true) +else + error("Assertion failed: archive type not supported. Please report the problem to the maintainers of OR-Tools.") +end +println("Installed $count_files files in $dest_dir.") diff --git a/ortools/julia/ORToolsBinaries.jl/src/ORToolsBinaries.jl b/ortools/julia/ORToolsBinaries.jl/src/ORToolsBinaries.jl new file mode 100644 index 0000000000..b254befaaf --- /dev/null +++ b/ortools/julia/ORToolsBinaries.jl/src/ORToolsBinaries.jl @@ -0,0 +1,23 @@ +module ORToolsBinaries + +export libortools + +const _SRC_DIR = @__DIR__ +const _DEPS_DIR = joinpath(_SRC_DIR, "..", "deps") +const _LIB_DIR = joinpath(_DEPS_DIR, "lib") + +if Sys.islinux() + const libortools = joinpath(_LIB_DIR, "libortools.so") +elseif Sys.isapple() + const libortools = joinpath(_LIB_DIR, "libortools.dylib") +elseif Sys.iswindows() + const libortools = joinpath(_LIB_DIR, "ortools.dll") +else + @error "Platform not supported! If ORTools_jll provides binaries for your platform, prefer using them rather than this package." +end + +if !isfile(libortools) + @error "Installing ORToolsBinaries failed, the expected binary is not available at the expected path ($libortools)" +end + +end