From 1fda7645d132b71b9084b01945795e97e582adcd Mon Sep 17 00:00:00 2001 From: "A. Unique TensorFlower" Date: Thu, 5 Apr 2018 03:09:27 -0700 Subject: Add support for NCCL2. The configure script asks for what version of NCCL to use. The default is still NCCL 1 from GitHub. If the user chooses NCCL 2, it asks for the install directory. The nccl_configure.bzl generates two different BUILD files based on the chose NCCL version. For NCCL 1, it aliases to the existing 'nccl_archive' http_repo on GitHub. For NCCL 2, it creates a target containing the NCCL 2 library and headers from the chosen install directory. PiperOrigin-RevId: 191718007 --- third_party/nccl/LICENSE | 203 ++++++++++++++++++++++++++++++++++++ third_party/nccl/nccl_archive.BUILD | 68 ++++++++++++ third_party/nccl/nccl_configure.bzl | 172 ++++++++++++++++++++++++++++++ 3 files changed, 443 insertions(+) create mode 100644 third_party/nccl/LICENSE create mode 100644 third_party/nccl/nccl_archive.BUILD create mode 100644 third_party/nccl/nccl_configure.bzl (limited to 'third_party/nccl') diff --git a/third_party/nccl/LICENSE b/third_party/nccl/LICENSE new file mode 100644 index 0000000000..146d9b765c --- /dev/null +++ b/third_party/nccl/LICENSE @@ -0,0 +1,203 @@ +Copyright 2018 The TensorFlow Authors. All rights reserved. + + 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 2018, The TensorFlow Authors. + + 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/third_party/nccl/nccl_archive.BUILD b/third_party/nccl/nccl_archive.BUILD new file mode 100644 index 0000000000..a05899e38d --- /dev/null +++ b/third_party/nccl/nccl_archive.BUILD @@ -0,0 +1,68 @@ +# NVIDIA nccl +# A package of optimized primitives for collective multi-GPU communication. + +licenses(["notice"]) # BSD + +exports_files(["LICENSE.txt"]) + +load("@local_config_cuda//cuda:build_defs.bzl", "cuda_default_copts", "if_cuda") + +SRCS = [ + "src/all_gather.cu", + "src/all_reduce.cu", + "src/broadcast.cu", + "src/core.cu", + "src/libwrap.cu", + "src/reduce.cu", + "src/reduce_scatter.cu", +] + +# Copy .cu to .cu.cc so they can be in srcs of cc_library. +[ + genrule( + name = "gen_" + src, + srcs = [src], + outs = [src + ".cc"], + cmd = "cp $(location " + src + ") $(location " + src + ".cc)", + ) + for src in SRCS +] + +SRCS_CU_CC = [src + ".cc" for src in SRCS] + +cc_library( + name = "nccl", + srcs = if_cuda(SRCS_CU_CC + glob(["src/*.h"])), + hdrs = if_cuda(["src/nccl.h"]), + copts = [ + "-DCUDA_MAJOR=0", + "-DCUDA_MINOR=0", + "-DNCCL_MAJOR=0", + "-DNCCL_MINOR=0", + "-DNCCL_PATCH=0", + "-Iexternal/nccl_archive/src", + "-O3", + ] + cuda_default_copts(), + include_prefix = "third_party/nccl", + linkopts = select({ + "@org_tensorflow//tensorflow:android": [ + "-pie", + ], + "@org_tensorflow//tensorflow:darwin": [ + "-Wl,-framework", + "-Wl,CoreFoundation", + "-Wl,-framework", + "-Wl,Security", + ], + "@org_tensorflow//tensorflow:ios": [], + "@org_tensorflow//tensorflow:windows": [ + "-DEFAULTLIB:ws2_32.lib", + ], + "//conditions:default": [ + "-lrt", + ], + }), + strip_include_prefix = "src", + visibility = ["//visibility:public"], + deps = ["@local_config_cuda//cuda:cuda_headers"], +) diff --git a/third_party/nccl/nccl_configure.bzl b/third_party/nccl/nccl_configure.bzl new file mode 100644 index 0000000000..9dfcb18369 --- /dev/null +++ b/third_party/nccl/nccl_configure.bzl @@ -0,0 +1,172 @@ +# -*- Python -*- +"""Repository rule for NCCL configuration. + +`nccl_configure` depends on the following environment variables: + + * `TF_NCCL_VERSION`: The NCCL version. + * `NCCL_INSTALL_PATH`: The installation path of the NCCL library. +""" + +load( + "//third_party/gpus:cuda_configure.bzl", + "auto_configure_fail", + "find_cuda_define", + "matches_version", +) + +_NCCL_INSTALL_PATH = "NCCL_INSTALL_PATH" +_TF_NCCL_VERSION = "TF_NCCL_VERSION" + +_DEFINE_NCCL_MAJOR = "#define NCCL_MAJOR" +_DEFINE_NCCL_MINOR = "#define NCCL_MINOR" +_DEFINE_NCCL_PATCH = "#define NCCL_PATCH" + +_NCCL_DUMMY_BUILD_CONTENT = """ +filegroup( + name = "LICENSE", + visibility = ["//visibility:public"], +) + +cc_library( + name = "nccl", + visibility = ["//visibility:public"], +) +""" + +_NCCL_ARCHIVE_BUILD_CONTENT = """ +filegroup( + name = "LICENSE", + data = ["@nccl_archive//:LICENSE.txt"], + visibility = ["//visibility:public"], +) + +alias( + name = "nccl", + actual = "@nccl_archive//:nccl", + visibility = ["//visibility:public"], +) +""" + +_NCCL_LOCAL_BUILD_TEMPLATE = """ +filegroup( + name = "LICENSE", + data = ["nccl/NCCL-SLA.txt"], + visibility = ["//visibility:public"], +) + +cc_library( + name = "nccl", + srcs = ["nccl/lib/libnccl.so.%s"], + hdrs = ["nccl/include/nccl.h"], + include_prefix = "third_party/nccl", + strip_include_prefix = "nccl/include", + deps = [ + "@local_config_cuda//cuda:cuda_headers", + ], + visibility = ["//visibility:public"], +) +""" + + +def _find_nccl_header(repository_ctx, nccl_install_path): + """Finds the NCCL header on the system. + + Args: + repository_ctx: The repository context. + nccl_install_path: The NCCL library install directory. + + Returns: + The path to the NCCL header. + """ + header_path = repository_ctx.path("%s/include/nccl.h" % nccl_install_path) + if not header_path.exists: + auto_configure_fail("Cannot find %s" % str(header_path)) + return header_path + + +def _check_nccl_version(repository_ctx, nccl_install_path, nccl_version): + """Checks whether the header file matches the specified version of NCCL. + + Args: + repository_ctx: The repository context. + nccl_install_path: The NCCL library install directory. + nccl_version: The expected NCCL version. + + Returns: + A string containing the library version of NCCL. + """ + header_path = _find_nccl_header(repository_ctx, nccl_install_path) + header_dir = str(header_path.realpath.dirname) + major_version = find_cuda_define(repository_ctx, header_dir, "nccl.h", + _DEFINE_NCCL_MAJOR) + minor_version = find_cuda_define(repository_ctx, header_dir, "nccl.h", + _DEFINE_NCCL_MINOR) + patch_version = find_cuda_define(repository_ctx, header_dir, "nccl.h", + _DEFINE_NCCL_PATCH) + header_version = "%s.%s.%s" % (major_version, minor_version, patch_version) + if not matches_version(nccl_version, header_version): + auto_configure_fail( + ("NCCL library version detected from %s/nccl.h (%s) does not match " + + "TF_NCCL_VERSION (%s). To fix this rerun configure again.") % + (header_dir, header_version, nccl_version)) + + +def _find_nccl_lib(repository_ctx, nccl_install_path, nccl_version): + """Finds the given NCCL library on the system. + + Args: + repository_ctx: The repository context. + nccl_install_path: The NCCL library installation directory. + nccl_version: The version of NCCL library files as returned + by _nccl_version. + + Returns: + The path to the NCCL library. + """ + lib_path = repository_ctx.path("%s/lib/libnccl.so.%s" % (nccl_install_path, + nccl_version)) + if not lib_path.exists: + auto_configure_fail("Cannot find NCCL library %s" % str(lib_path)) + return lib_path + + +def _nccl_configure_impl(repository_ctx): + """Implementation of the nccl_configure repository rule.""" + if _TF_NCCL_VERSION not in repository_ctx.os.environ: + # Add a dummy build file to make bazel query happy. + repository_ctx.file("BUILD", _NCCL_DUMMY_BUILD_CONTENT) + return + + nccl_version = repository_ctx.os.environ[_TF_NCCL_VERSION].strip() + if matches_version("1", nccl_version): + # Alias to GitHub target from @nccl_archive. + if not matches_version(nccl_version, "1.3"): + auto_configure_fail( + "NCCL from GitHub must use version 1.3 (got %s)" % nccl_version) + repository_ctx.file("BUILD", _NCCL_ARCHIVE_BUILD_CONTENT) + else: + # Create target for locally installed NCCL. + nccl_install_path = repository_ctx.os.environ[_NCCL_INSTALL_PATH].strip() + _check_nccl_version(repository_ctx, nccl_install_path, nccl_version) + repository_ctx.symlink(nccl_install_path, "nccl") + repository_ctx.file("BUILD", _NCCL_LOCAL_BUILD_TEMPLATE % nccl_version) + + +nccl_configure = repository_rule( + implementation=_nccl_configure_impl, + environ=[ + _NCCL_INSTALL_PATH, + _TF_NCCL_VERSION, + ], +) +"""Detects and configures the NCCL configuration. + +Add the following to your WORKSPACE FILE: + +```python +nccl_configure(name = "local_config_nccl") +``` + +Args: + name: A unique name for this workspace rule. +""" -- cgit v1.2.3