blob: d19607af6c25543df661843cc90591690ef2b8fa [file] [log] [blame]
A. Unique TensorFlower73ea2872017-07-25 13:30:03 -07001# Copyright 2017 The TensorFlow Authors. All Rights Reserved.
2#
3# Licensed under the Apache License, Version 2.0 (the "License");
4# you may not use this file except in compliance with the License.
5# You may obtain a copy of the License at
6#
7# http://www.apache.org/licenses/LICENSE-2.0
8#
9# Unless required by applicable law or agreed to in writing, software
10# distributed under the License is distributed on an "AS IS" BASIS,
11# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12# See the License for the specific language governing permissions and
13# limitations under the License.
14# ==============================================================================
15"""configure script to get build parameters from user."""
16
17from __future__ import absolute_import
18from __future__ import division
19from __future__ import print_function
20
Shanqing Cai71445712018-03-12 19:33:52 -070021import argparse
A. Unique TensorFlower73ea2872017-07-25 13:30:03 -070022import errno
23import os
24import platform
25import re
A. Unique TensorFlower73ea2872017-07-25 13:30:03 -070026import subprocess
27import sys
28
Andrew Sellec9885ea2017-11-06 09:37:03 -080029# pylint: disable=g-import-not-at-top
Jonathan Hseu008910f2017-08-25 14:01:05 -070030try:
31 from shutil import which
32except ImportError:
33 from distutils.spawn import find_executable as which
Andrew Sellec9885ea2017-11-06 09:37:03 -080034# pylint: enable=g-import-not-at-top
Jonathan Hseu008910f2017-08-25 14:01:05 -070035
Dandelion Man?90e42f32017-12-15 18:15:07 -080036_DEFAULT_CUDA_VERSION = '9.0'
37_DEFAULT_CUDNN_VERSION = '7'
Smit Hinsufe7d1d92018-07-14 13:16:58 -070038_DEFAULT_CUDA_COMPUTE_CAPABILITIES = '3.5,7.0'
A. Unique TensorFlower73ea2872017-07-25 13:30:03 -070039_DEFAULT_CUDA_PATH = '/usr/local/cuda'
40_DEFAULT_CUDA_PATH_LINUX = '/opt/cuda'
41_DEFAULT_CUDA_PATH_WIN = ('C:/Program Files/NVIDIA GPU Computing '
42 'Toolkit/CUDA/v%s' % _DEFAULT_CUDA_VERSION)
43_TF_OPENCL_VERSION = '1.2'
44_DEFAULT_COMPUTECPP_TOOLKIT_PATH = '/usr/local/computecpp'
Yifei Fengb1d8c592017-11-22 13:42:21 -080045_DEFAULT_TRISYCL_INCLUDE_DIR = '/usr/local/triSYCL/include'
A. Unique TensorFlower82820ef2018-11-12 13:22:13 -080046_SUPPORTED_ANDROID_NDK_VERSIONS = [10, 11, 12, 13, 14, 15, 16, 17, 18]
Austin Anderson6afface2017-12-05 11:59:17 -080047
48_DEFAULT_PROMPT_ASK_ATTEMPTS = 10
49
Shanqing Cai71445712018-03-12 19:33:52 -070050_TF_BAZELRC_FILENAME = '.tf_configure.bazelrc'
A. Unique TensorFlower7c5eb352018-10-01 07:15:23 -070051_TF_WORKSPACE_ROOT = ''
52_TF_BAZELRC = ''
Shanqing Cai71445712018-03-12 19:33:52 -070053
Jason Furmanek7c234152018-09-26 04:44:12 +000054NCCL_LIB_PATHS = [
TensorFlower Gardenerea5c5292018-10-01 17:28:26 -070055 'lib64/', 'lib/powerpc64le-linux-gnu/', 'lib/x86_64-linux-gnu/', ''
Jason Furmanek7c234152018-09-26 04:44:12 +000056]
Austin Anderson6afface2017-12-05 11:59:17 -080057
Gunhan Gulsoyffa90fc2018-09-26 01:38:55 -070058if platform.machine() == 'ppc64le':
59 _DEFAULT_TENSORRT_PATH_LINUX = '/usr/lib/powerpc64le-linux-gnu/'
60else:
61 _DEFAULT_TENSORRT_PATH_LINUX = '/usr/lib/%s-linux-gnu' % platform.machine()
62
Austin Anderson6afface2017-12-05 11:59:17 -080063
64class UserInputError(Exception):
65 pass
A. Unique TensorFlower73ea2872017-07-25 13:30:03 -070066
67
68def is_windows():
69 return platform.system() == 'Windows'
70
71
72def is_linux():
73 return platform.system() == 'Linux'
74
75
76def is_macos():
77 return platform.system() == 'Darwin'
78
79
80def is_ppc64le():
81 return platform.machine() == 'ppc64le'
82
83
Jonathan Hseu008910f2017-08-25 14:01:05 -070084def is_cygwin():
85 return platform.system().startswith('CYGWIN_NT')
86
87
A. Unique TensorFlower73ea2872017-07-25 13:30:03 -070088def get_input(question):
89 try:
90 try:
91 answer = raw_input(question)
92 except NameError:
93 answer = input(question) # pylint: disable=bad-builtin
94 except EOFError:
95 answer = ''
96 return answer
97
98
99def symlink_force(target, link_name):
100 """Force symlink, equivalent of 'ln -sf'.
101
102 Args:
103 target: items to link to.
104 link_name: name of the link.
105 """
106 try:
107 os.symlink(target, link_name)
108 except OSError as e:
109 if e.errno == errno.EEXIST:
110 os.remove(link_name)
111 os.symlink(target, link_name)
112 else:
113 raise e
114
115
116def sed_in_place(filename, old, new):
117 """Replace old string with new string in file.
118
119 Args:
120 filename: string for filename.
121 old: string to replace.
122 new: new string to replace to.
123 """
124 with open(filename, 'r') as f:
125 filedata = f.read()
126 newdata = filedata.replace(old, new)
127 with open(filename, 'w') as f:
128 f.write(newdata)
129
130
A. Unique TensorFlower73ea2872017-07-25 13:30:03 -0700131def write_to_bazelrc(line):
132 with open(_TF_BAZELRC, 'a') as f:
133 f.write(line + '\n')
134
135
136def write_action_env_to_bazelrc(var_name, var):
137 write_to_bazelrc('build --action_env %s="%s"' % (var_name, str(var)))
138
139
Jonathan Hseu008910f2017-08-25 14:01:05 -0700140def run_shell(cmd, allow_non_zero=False):
141 if allow_non_zero:
142 try:
143 output = subprocess.check_output(cmd)
144 except subprocess.CalledProcessError as e:
145 output = e.output
146 else:
147 output = subprocess.check_output(cmd)
148 return output.decode('UTF-8').strip()
A. Unique TensorFlower73ea2872017-07-25 13:30:03 -0700149
150
151def cygpath(path):
152 """Convert path from posix to windows."""
Martin Wicked57572e2017-09-02 19:21:45 -0700153 return os.path.abspath(path).replace('\\', '/')
A. Unique TensorFlower73ea2872017-07-25 13:30:03 -0700154
155
Andrew Harp6e3e7d12017-08-21 12:10:44 -0700156def get_python_path(environ_cp, python_bin_path):
A. Unique TensorFlower73ea2872017-07-25 13:30:03 -0700157 """Get the python site package paths."""
158 python_paths = []
159 if environ_cp.get('PYTHONPATH'):
160 python_paths = environ_cp.get('PYTHONPATH').split(':')
161 try:
Gunhan Gulsoyffa90fc2018-09-26 01:38:55 -0700162 library_paths = run_shell([
163 python_bin_path, '-c',
164 'import site; print("\\n".join(site.getsitepackages()))'
165 ]).split('\n')
Andrew Harp6e3e7d12017-08-21 12:10:44 -0700166 except subprocess.CalledProcessError:
Gunhan Gulsoyffa90fc2018-09-26 01:38:55 -0700167 library_paths = [
168 run_shell([
169 python_bin_path, '-c',
170 'from distutils.sysconfig import get_python_lib;'
171 'print(get_python_lib())'
172 ])
173 ]
Andrew Harp6e3e7d12017-08-21 12:10:44 -0700174
A. Unique TensorFlower73ea2872017-07-25 13:30:03 -0700175 all_paths = set(python_paths + library_paths)
176
177 paths = []
178 for path in all_paths:
179 if os.path.isdir(path):
180 paths.append(path)
181 return paths
182
183
Andrew Harp6e3e7d12017-08-21 12:10:44 -0700184def get_python_major_version(python_bin_path):
185 """Get the python major version."""
Jonathan Hseu008910f2017-08-25 14:01:05 -0700186 return run_shell([python_bin_path, '-c', 'import sys; print(sys.version[0])'])
Andrew Harp6e3e7d12017-08-21 12:10:44 -0700187
188
Gunhan Gulsoyed89a2b2017-09-19 18:36:26 -0700189def setup_python(environ_cp):
A. Unique TensorFlower73ea2872017-07-25 13:30:03 -0700190 """Setup python related env variables."""
191 # Get PYTHON_BIN_PATH, default is the current running python.
192 default_python_bin_path = sys.executable
193 ask_python_bin_path = ('Please specify the location of python. [Default is '
194 '%s]: ') % default_python_bin_path
195 while True:
196 python_bin_path = get_from_env_or_user_or_default(
197 environ_cp, 'PYTHON_BIN_PATH', ask_python_bin_path,
198 default_python_bin_path)
199 # Check if the path is valid
Gunhan Gulsoyffa90fc2018-09-26 01:38:55 -0700200 if os.path.isfile(python_bin_path) and os.access(python_bin_path, os.X_OK):
A. Unique TensorFlower73ea2872017-07-25 13:30:03 -0700201 break
202 elif not os.path.exists(python_bin_path):
203 print('Invalid python path: %s cannot be found.' % python_bin_path)
204 else:
205 print('%s is not executable. Is it the python binary?' % python_bin_path)
206 environ_cp['PYTHON_BIN_PATH'] = ''
207
Andrew Harp6e3e7d12017-08-21 12:10:44 -0700208 # Convert python path to Windows style before checking lib and version
Martin Wicked57572e2017-09-02 19:21:45 -0700209 if is_windows() or is_cygwin():
Andrew Harp6e3e7d12017-08-21 12:10:44 -0700210 python_bin_path = cygpath(python_bin_path)
211
A. Unique TensorFlower73ea2872017-07-25 13:30:03 -0700212 # Get PYTHON_LIB_PATH
213 python_lib_path = environ_cp.get('PYTHON_LIB_PATH')
214 if not python_lib_path:
Andrew Harp6e3e7d12017-08-21 12:10:44 -0700215 python_lib_paths = get_python_path(environ_cp, python_bin_path)
A. Unique TensorFlower73ea2872017-07-25 13:30:03 -0700216 if environ_cp.get('USE_DEFAULT_PYTHON_LIB_PATH') == '1':
Vijay Vasudevana1fba7f2017-07-28 10:58:56 -0700217 python_lib_path = python_lib_paths[0]
A. Unique TensorFlower73ea2872017-07-25 13:30:03 -0700218 else:
Jonathan Hseu008910f2017-08-25 14:01:05 -0700219 print('Found possible Python library paths:\n %s' %
220 '\n '.join(python_lib_paths))
A. Unique TensorFlower73ea2872017-07-25 13:30:03 -0700221 default_python_lib_path = python_lib_paths[0]
222 python_lib_path = get_input(
Jonathan Hseu008910f2017-08-25 14:01:05 -0700223 'Please input the desired Python library path to use. '
224 'Default is [%s]\n' % python_lib_paths[0])
A. Unique TensorFlower73ea2872017-07-25 13:30:03 -0700225 if not python_lib_path:
226 python_lib_path = default_python_lib_path
Vijay Vasudevana1fba7f2017-07-28 10:58:56 -0700227 environ_cp['PYTHON_LIB_PATH'] = python_lib_path
A. Unique TensorFlower73ea2872017-07-25 13:30:03 -0700228
TensorFlower Gardener61a87202018-10-01 12:25:39 -0700229 _ = get_python_major_version(python_bin_path)
Andrew Harp6e3e7d12017-08-21 12:10:44 -0700230
A. Unique TensorFlower73ea2872017-07-25 13:30:03 -0700231 # Convert python path to Windows style before writing into bazel.rc
Martin Wicked57572e2017-09-02 19:21:45 -0700232 if is_windows() or is_cygwin():
A. Unique TensorFlower73ea2872017-07-25 13:30:03 -0700233 python_lib_path = cygpath(python_lib_path)
234
235 # Set-up env variables used by python_configure.bzl
236 write_action_env_to_bazelrc('PYTHON_BIN_PATH', python_bin_path)
237 write_action_env_to_bazelrc('PYTHON_LIB_PATH', python_lib_path)
Gunhan Gulsoyed89a2b2017-09-19 18:36:26 -0700238 write_to_bazelrc('build --python_path=\"%s"' % python_bin_path)
A. Unique TensorFlower73ea2872017-07-25 13:30:03 -0700239 environ_cp['PYTHON_BIN_PATH'] = python_bin_path
240
William D. Ironsdcc76a52018-11-20 10:35:18 -0600241 # If choosen python_lib_path is from a path specified in the PYTHONPATH
242 # variable, need to tell bazel to include PYTHONPATH
243 if environ_cp.get('PYTHONPATH'):
244 python_paths = environ_cp.get('PYTHONPATH').split(':')
245 if python_lib_path in python_paths:
TensorFlower Gardener968cd182018-11-28 11:33:16 -0800246 write_action_env_to_bazelrc('PYTHONPATH', environ_cp.get('PYTHONPATH'))
William D. Ironsdcc76a52018-11-20 10:35:18 -0600247
A. Unique TensorFlower73ea2872017-07-25 13:30:03 -0700248 # Write tools/python_bin_path.sh
Gunhan Gulsoyffa90fc2018-09-26 01:38:55 -0700249 with open(
250 os.path.join(_TF_WORKSPACE_ROOT, 'tools', 'python_bin_path.sh'),
251 'w') as f:
A. Unique TensorFlower73ea2872017-07-25 13:30:03 -0700252 f.write('export PYTHON_BIN_PATH="%s"' % python_bin_path)
253
254
A. Unique TensorFlower7c5eb352018-10-01 07:15:23 -0700255def reset_tf_configure_bazelrc():
A. Unique TensorFlower73ea2872017-07-25 13:30:03 -0700256 """Reset file that contains customized config settings."""
257 open(_TF_BAZELRC, 'w').close()
A. Unique TensorFlower73ea2872017-07-25 13:30:03 -0700258
A. Unique TensorFlower73ea2872017-07-25 13:30:03 -0700259def cleanup_makefile():
260 """Delete any leftover BUILD files from the Makefile build.
261
262 These files could interfere with Bazel parsing.
263 """
Gunhan Gulsoyffa90fc2018-09-26 01:38:55 -0700264 makefile_download_dir = os.path.join(_TF_WORKSPACE_ROOT, 'tensorflow',
265 'contrib', 'makefile', 'downloads')
A. Unique TensorFlower73ea2872017-07-25 13:30:03 -0700266 if os.path.isdir(makefile_download_dir):
267 for root, _, filenames in os.walk(makefile_download_dir):
268 for f in filenames:
269 if f.endswith('BUILD'):
270 os.remove(os.path.join(root, f))
271
272
273def get_var(environ_cp,
274 var_name,
275 query_item,
276 enabled_by_default,
277 question=None,
278 yes_reply=None,
279 no_reply=None):
280 """Get boolean input from user.
281
282 If var_name is not set in env, ask user to enable query_item or not. If the
283 response is empty, use the default.
284
285 Args:
286 environ_cp: copy of the os.environ.
287 var_name: string for name of environment variable, e.g. "TF_NEED_HDFS".
288 query_item: string for feature related to the variable, e.g. "Hadoop File
289 System".
290 enabled_by_default: boolean for default behavior.
291 question: optional string for how to ask for user input.
Michael Cased90054e2018-02-07 14:36:00 -0800292 yes_reply: optional string for reply when feature is enabled.
A. Unique TensorFlower73ea2872017-07-25 13:30:03 -0700293 no_reply: optional string for reply when feature is disabled.
294
295 Returns:
296 boolean value of the variable.
Frank Chenc4ef9272018-01-10 11:36:52 -0800297
298 Raises:
299 UserInputError: if an environment variable is set, but it cannot be
300 interpreted as a boolean indicator, assume that the user has made a
301 scripting error, and will continue to provide invalid input.
302 Raise the error to avoid infinitely looping.
A. Unique TensorFlower73ea2872017-07-25 13:30:03 -0700303 """
304 if not question:
305 question = 'Do you wish to build TensorFlow with %s support?' % query_item
306 if not yes_reply:
307 yes_reply = '%s support will be enabled for TensorFlow.' % query_item
308 if not no_reply:
309 no_reply = 'No %s' % yes_reply
310
311 yes_reply += '\n'
312 no_reply += '\n'
313
314 if enabled_by_default:
315 question += ' [Y/n]: '
316 else:
317 question += ' [y/N]: '
318
319 var = environ_cp.get(var_name)
Frank Chenc4ef9272018-01-10 11:36:52 -0800320 if var is not None:
321 var_content = var.strip().lower()
322 true_strings = ('1', 't', 'true', 'y', 'yes')
323 false_strings = ('0', 'f', 'false', 'n', 'no')
324 if var_content in true_strings:
325 var = True
326 elif var_content in false_strings:
327 var = False
328 else:
329 raise UserInputError(
330 'Environment variable %s must be set as a boolean indicator.\n'
331 'The following are accepted as TRUE : %s.\n'
332 'The following are accepted as FALSE: %s.\n'
Gunhan Gulsoyffa90fc2018-09-26 01:38:55 -0700333 'Current value is %s.' % (var_name, ', '.join(true_strings),
334 ', '.join(false_strings), var))
Frank Chenc4ef9272018-01-10 11:36:52 -0800335
A. Unique TensorFlower73ea2872017-07-25 13:30:03 -0700336 while var is None:
337 user_input_origin = get_input(question)
338 user_input = user_input_origin.strip().lower()
339 if user_input == 'y':
340 print(yes_reply)
341 var = True
342 elif user_input == 'n':
343 print(no_reply)
344 var = False
345 elif not user_input:
346 if enabled_by_default:
347 print(yes_reply)
348 var = True
349 else:
350 print(no_reply)
351 var = False
352 else:
353 print('Invalid selection: %s' % user_input_origin)
354 return var
355
356
Gunhan Gulsoyffa90fc2018-09-26 01:38:55 -0700357def set_build_var(environ_cp,
358 var_name,
359 query_item,
360 option_name,
361 enabled_by_default,
362 bazel_config_name=None):
A. Unique TensorFlower73ea2872017-07-25 13:30:03 -0700363 """Set if query_item will be enabled for the build.
364
365 Ask user if query_item will be enabled. Default is used if no input is given.
366 Set subprocess environment variable and write to .bazelrc if enabled.
367
368 Args:
369 environ_cp: copy of the os.environ.
370 var_name: string for name of environment variable, e.g. "TF_NEED_HDFS".
371 query_item: string for feature related to the variable, e.g. "Hadoop File
372 System".
373 option_name: string for option to define in .bazelrc.
374 enabled_by_default: boolean for default behavior.
Michael Case98850a52017-09-14 13:35:57 -0700375 bazel_config_name: Name for Bazel --config argument to enable build feature.
A. Unique TensorFlower73ea2872017-07-25 13:30:03 -0700376 """
377
378 var = str(int(get_var(environ_cp, var_name, query_item, enabled_by_default)))
379 environ_cp[var_name] = var
380 if var == '1':
Yifei Fengec451f52018-10-05 12:53:50 -0700381 write_to_bazelrc(
382 'build:%s --define %s=true' % (bazel_config_name, option_name))
383 write_to_bazelrc('build --config=%s' % bazel_config_name)
Michael Case98850a52017-09-14 13:35:57 -0700384 elif bazel_config_name is not None:
385 # TODO(mikecase): Migrate all users of configure.py to use --config Bazel
386 # options and not to set build configs through environment variables.
Gunhan Gulsoyffa90fc2018-09-26 01:38:55 -0700387 write_to_bazelrc(
388 'build:%s --define %s=true' % (bazel_config_name, option_name))
A. Unique TensorFlower73ea2872017-07-25 13:30:03 -0700389
390
391def set_action_env_var(environ_cp,
392 var_name,
393 query_item,
394 enabled_by_default,
395 question=None,
396 yes_reply=None,
397 no_reply=None):
398 """Set boolean action_env variable.
399
400 Ask user if query_item will be enabled. Default is used if no input is given.
401 Set environment variable and write to .bazelrc.
402
403 Args:
404 environ_cp: copy of the os.environ.
405 var_name: string for name of environment variable, e.g. "TF_NEED_HDFS".
406 query_item: string for feature related to the variable, e.g. "Hadoop File
407 System".
408 enabled_by_default: boolean for default behavior.
409 question: optional string for how to ask for user input.
Michael Cased90054e2018-02-07 14:36:00 -0800410 yes_reply: optional string for reply when feature is enabled.
A. Unique TensorFlower73ea2872017-07-25 13:30:03 -0700411 no_reply: optional string for reply when feature is disabled.
412 """
413 var = int(
414 get_var(environ_cp, var_name, query_item, enabled_by_default, question,
415 yes_reply, no_reply))
416
417 write_action_env_to_bazelrc(var_name, var)
418 environ_cp[var_name] = str(var)
419
420
A. Unique TensorFlower6252d292017-08-04 00:52:34 -0700421def convert_version_to_int(version):
422 """Convert a version number to a integer that can be used to compare.
423
A. Unique TensorFlower28ce1d12017-08-15 12:08:29 -0700424 Version strings of the form X.YZ and X.Y.Z-xxxxx are supported. The
425 'xxxxx' part, for instance 'homebrew' on OS/X, is ignored.
426
A. Unique TensorFlower6252d292017-08-04 00:52:34 -0700427 Args:
A. Unique TensorFlower28ce1d12017-08-15 12:08:29 -0700428 version: a version to be converted
A. Unique TensorFlower6252d292017-08-04 00:52:34 -0700429
430 Returns:
431 An integer if converted successfully, otherwise return None.
432 """
A. Unique TensorFlower28ce1d12017-08-15 12:08:29 -0700433 version = version.split('-')[0]
A. Unique TensorFlower6252d292017-08-04 00:52:34 -0700434 version_segments = version.split('.')
435 for seg in version_segments:
436 if not seg.isdigit():
437 return None
438
439 version_str = ''.join(['%03d' % int(seg) for seg in version_segments])
440 return int(version_str)
441
442
Mihai Maruseace7a123f2018-11-30 13:33:25 -0800443def check_bazel_version(min_version, max_version):
444 """Check installed bazel version is between min_version and max_version.
A. Unique TensorFlower73ea2872017-07-25 13:30:03 -0700445
446 Args:
447 min_version: string for minimum bazel version.
Mihai Maruseace7a123f2018-11-30 13:33:25 -0800448 max_version: string for maximum bazel version.
A. Unique TensorFlower6252d292017-08-04 00:52:34 -0700449
450 Returns:
451 The bazel version detected.
A. Unique TensorFlower73ea2872017-07-25 13:30:03 -0700452 """
Jonathan Hseu008910f2017-08-25 14:01:05 -0700453 if which('bazel') is None:
A. Unique TensorFlower73ea2872017-07-25 13:30:03 -0700454 print('Cannot find bazel. Please install bazel.')
455 sys.exit(0)
Gunhan Gulsoyffa90fc2018-09-26 01:38:55 -0700456 curr_version = run_shell(
457 ['bazel', '--batch', '--bazelrc=/dev/null', 'version'])
A. Unique TensorFlower73ea2872017-07-25 13:30:03 -0700458
459 for line in curr_version.split('\n'):
460 if 'Build label: ' in line:
461 curr_version = line.split('Build label: ')[1]
462 break
463
A. Unique TensorFlower6252d292017-08-04 00:52:34 -0700464 min_version_int = convert_version_to_int(min_version)
465 curr_version_int = convert_version_to_int(curr_version)
Mihai Maruseace7a123f2018-11-30 13:33:25 -0800466 max_version_int = convert_version_to_int(max_version)
A. Unique TensorFlower73ea2872017-07-25 13:30:03 -0700467
468 # Check if current bazel version can be detected properly.
A. Unique TensorFlower6252d292017-08-04 00:52:34 -0700469 if not curr_version_int:
470 print('WARNING: current bazel installation is not a release version.')
471 print('Make sure you are running at least bazel %s' % min_version)
472 return curr_version
A. Unique TensorFlower73ea2872017-07-25 13:30:03 -0700473
Michael Cased94271a2017-08-22 17:26:52 -0700474 print('You have bazel %s installed.' % curr_version)
A. Unique TensorFlower28ce1d12017-08-15 12:08:29 -0700475
A. Unique TensorFlower6252d292017-08-04 00:52:34 -0700476 if curr_version_int < min_version_int:
A. Unique TensorFlower73ea2872017-07-25 13:30:03 -0700477 print('Please upgrade your bazel installation to version %s or higher to '
478 'build TensorFlow!' % min_version)
Jason Zamanb41761c2018-10-14 11:28:53 +0800479 sys.exit(1)
480 if curr_version_int > max_version_int and not 'TF_IGNORE_MAX_BAZEL_VERSION' in os.environ:
Mihai Maruseace7a123f2018-11-30 13:33:25 -0800481 print('Please downgrade your bazel installation to version %s or lower to '
Mihai Maruseac3360c722018-12-03 10:41:16 -0800482 'build TensorFlow!' % max_version)
Jason Zamanb41761c2018-10-14 11:28:53 +0800483 sys.exit(1)
A. Unique TensorFlower6252d292017-08-04 00:52:34 -0700484 return curr_version
A. Unique TensorFlower73ea2872017-07-25 13:30:03 -0700485
486
487def set_cc_opt_flags(environ_cp):
488 """Set up architecture-dependent optimization flags.
489
490 Also append CC optimization flags to bazel.rc..
491
492 Args:
493 environ_cp: copy of the os.environ.
494 """
495 if is_ppc64le():
496 # gcc on ppc64le does not support -march, use mcpu instead
497 default_cc_opt_flags = '-mcpu=native'
A. Unique TensorFlower1bba94a2018-04-04 15:45:20 -0700498 elif is_windows():
499 default_cc_opt_flags = '/arch:AVX'
A. Unique TensorFlower73ea2872017-07-25 13:30:03 -0700500 else:
Justin Lebar9ef04f52018-10-10 18:52:45 -0700501 default_cc_opt_flags = '-march=native -Wno-sign-compare'
A. Unique TensorFlower73ea2872017-07-25 13:30:03 -0700502 question = ('Please specify optimization flags to use during compilation when'
503 ' bazel option "--config=opt" is specified [Default is %s]: '
504 ) % default_cc_opt_flags
505 cc_opt_flags = get_from_env_or_user_or_default(environ_cp, 'CC_OPT_FLAGS',
506 question, default_cc_opt_flags)
507 for opt in cc_opt_flags.split():
Michael Case00177422017-11-10 13:14:03 -0800508 write_to_bazelrc('build:opt --copt=%s' % opt)
509 # It should be safe on the same build host.
A. Unique TensorFlower1bba94a2018-04-04 15:45:20 -0700510 if not is_ppc64le() and not is_windows():
Shanqing Cai71445712018-03-12 19:33:52 -0700511 write_to_bazelrc('build:opt --host_copt=-march=native')
Michael Casebb3355d2017-11-09 08:46:31 -0800512 write_to_bazelrc('build:opt --define with_default_optimizations=true')
A. Unique TensorFlower73ea2872017-07-25 13:30:03 -0700513
Gunhan Gulsoyffa90fc2018-09-26 01:38:55 -0700514
A. Unique TensorFlower73ea2872017-07-25 13:30:03 -0700515def set_tf_cuda_clang(environ_cp):
516 """set TF_CUDA_CLANG action_env.
517
518 Args:
519 environ_cp: copy of the os.environ.
520 """
521 question = 'Do you want to use clang as CUDA compiler?'
522 yes_reply = 'Clang will be used as CUDA compiler.'
523 no_reply = 'nvcc will be used as CUDA compiler.'
524 set_action_env_var(
525 environ_cp,
526 'TF_CUDA_CLANG',
527 None,
528 False,
529 question=question,
530 yes_reply=yes_reply,
531 no_reply=no_reply)
532
533
A. Unique TensorFlowerfd29e952017-12-22 03:07:51 -0800534def set_tf_download_clang(environ_cp):
535 """Set TF_DOWNLOAD_CLANG action_env."""
Ilya Biryukov9e651e42018-03-22 05:33:42 -0700536 question = 'Do you wish to download a fresh release of clang? (Experimental)'
A. Unique TensorFlowerfd29e952017-12-22 03:07:51 -0800537 yes_reply = 'Clang will be downloaded and used to compile tensorflow.'
538 no_reply = 'Clang will not be downloaded.'
539 set_action_env_var(
540 environ_cp,
541 'TF_DOWNLOAD_CLANG',
542 None,
543 False,
544 question=question,
545 yes_reply=yes_reply,
546 no_reply=no_reply)
547
548
A. Unique TensorFlower73ea2872017-07-25 13:30:03 -0700549def get_from_env_or_user_or_default(environ_cp, var_name, ask_for_var,
550 var_default):
551 """Get var_name either from env, or user or default.
552
553 If var_name has been set as environment variable, use the preset value, else
554 ask for user input. If no input is provided, the default is used.
555
556 Args:
557 environ_cp: copy of the os.environ.
558 var_name: string for name of environment variable, e.g. "TF_NEED_HDFS".
559 ask_for_var: string for how to ask for user input.
560 var_default: default value string.
561
562 Returns:
563 string value for var_name
564 """
565 var = environ_cp.get(var_name)
566 if not var:
567 var = get_input(ask_for_var)
Michael Cased94271a2017-08-22 17:26:52 -0700568 print('\n')
A. Unique TensorFlower73ea2872017-07-25 13:30:03 -0700569 if not var:
570 var = var_default
571 return var
572
573
574def set_clang_cuda_compiler_path(environ_cp):
575 """Set CLANG_CUDA_COMPILER_PATH."""
Jonathan Hseu008910f2017-08-25 14:01:05 -0700576 default_clang_path = which('clang') or ''
A. Unique TensorFlower73ea2872017-07-25 13:30:03 -0700577 ask_clang_path = ('Please specify which clang should be used as device and '
578 'host compiler. [Default is %s]: ') % default_clang_path
579
580 while True:
581 clang_cuda_compiler_path = get_from_env_or_user_or_default(
582 environ_cp, 'CLANG_CUDA_COMPILER_PATH', ask_clang_path,
583 default_clang_path)
584 if os.path.exists(clang_cuda_compiler_path):
585 break
586
587 # Reset and retry
588 print('Invalid clang path: %s cannot be found.' % clang_cuda_compiler_path)
589 environ_cp['CLANG_CUDA_COMPILER_PATH'] = ''
590
591 # Set CLANG_CUDA_COMPILER_PATH
592 environ_cp['CLANG_CUDA_COMPILER_PATH'] = clang_cuda_compiler_path
593 write_action_env_to_bazelrc('CLANG_CUDA_COMPILER_PATH',
594 clang_cuda_compiler_path)
595
596
Gunhan Gulsoyffa90fc2018-09-26 01:38:55 -0700597def prompt_loop_or_load_from_env(environ_cp,
598 var_name,
599 var_default,
600 ask_for_var,
601 check_success,
602 error_msg,
603 suppress_default_error=False,
604 n_ask_attempts=_DEFAULT_PROMPT_ASK_ATTEMPTS):
Austin Anderson6afface2017-12-05 11:59:17 -0800605 """Loop over user prompts for an ENV param until receiving a valid response.
606
607 For the env param var_name, read from the environment or verify user input
608 until receiving valid input. When done, set var_name in the environ_cp to its
609 new value.
610
611 Args:
612 environ_cp: (Dict) copy of the os.environ.
613 var_name: (String) string for name of environment variable, e.g. "TF_MYVAR".
614 var_default: (String) default value string.
615 ask_for_var: (String) string for how to ask for user input.
616 check_success: (Function) function that takes one argument and returns a
617 boolean. Should return True if the value provided is considered valid. May
618 contain a complex error message if error_msg does not provide enough
619 information. In that case, set suppress_default_error to True.
620 error_msg: (String) String with one and only one '%s'. Formatted with each
621 invalid response upon check_success(input) failure.
622 suppress_default_error: (Bool) Suppress the above error message in favor of
623 one from the check_success function.
624 n_ask_attempts: (Integer) Number of times to query for valid input before
625 raising an error and quitting.
626
627 Returns:
628 [String] The value of var_name after querying for input.
629
630 Raises:
631 UserInputError: if a query has been attempted n_ask_attempts times without
Frank Chenc4ef9272018-01-10 11:36:52 -0800632 success, assume that the user has made a scripting error, and will
633 continue to provide invalid input. Raise the error to avoid infinitely
634 looping.
Austin Anderson6afface2017-12-05 11:59:17 -0800635 """
636 default = environ_cp.get(var_name) or var_default
637 full_query = '%s [Default is %s]: ' % (
638 ask_for_var,
639 default,
640 )
641
642 for _ in range(n_ask_attempts):
Gunhan Gulsoyffa90fc2018-09-26 01:38:55 -0700643 val = get_from_env_or_user_or_default(environ_cp, var_name, full_query,
Austin Anderson6afface2017-12-05 11:59:17 -0800644 default)
645 if check_success(val):
646 break
647 if not suppress_default_error:
648 print(error_msg % val)
649 environ_cp[var_name] = ''
650 else:
Gunhan Gulsoyffa90fc2018-09-26 01:38:55 -0700651 raise UserInputError(
652 'Invalid %s setting was provided %d times in a row. '
653 'Assuming to be a scripting mistake.' % (var_name, n_ask_attempts))
Austin Anderson6afface2017-12-05 11:59:17 -0800654
655 environ_cp[var_name] = val
656 return val
657
658
659def create_android_ndk_rule(environ_cp):
660 """Set ANDROID_NDK_HOME and write Android NDK WORKSPACE rule."""
661 if is_windows() or is_cygwin():
Gunhan Gulsoyffa90fc2018-09-26 01:38:55 -0700662 default_ndk_path = cygpath(
663 '%s/Android/Sdk/ndk-bundle' % environ_cp['APPDATA'])
Austin Anderson6afface2017-12-05 11:59:17 -0800664 elif is_macos():
665 default_ndk_path = '%s/library/Android/Sdk/ndk-bundle' % environ_cp['HOME']
666 else:
667 default_ndk_path = '%s/Android/Sdk/ndk-bundle' % environ_cp['HOME']
668
669 def valid_ndk_path(path):
670 return (os.path.exists(path) and
671 os.path.exists(os.path.join(path, 'source.properties')))
672
673 android_ndk_home_path = prompt_loop_or_load_from_env(
674 environ_cp,
675 var_name='ANDROID_NDK_HOME',
676 var_default=default_ndk_path,
677 ask_for_var='Please specify the home path of the Android NDK to use.',
678 check_success=valid_ndk_path,
679 error_msg=('The path %s or its child file "source.properties" '
Gunhan Gulsoyffa90fc2018-09-26 01:38:55 -0700680 'does not exist.'))
Michael Case51053502018-06-05 17:47:19 -0700681 write_action_env_to_bazelrc('ANDROID_NDK_HOME', android_ndk_home_path)
682 write_action_env_to_bazelrc('ANDROID_NDK_API_LEVEL',
683 check_ndk_level(android_ndk_home_path))
Austin Anderson6afface2017-12-05 11:59:17 -0800684
685
686def create_android_sdk_rule(environ_cp):
687 """Set Android variables and write Android SDK WORKSPACE rule."""
688 if is_windows() or is_cygwin():
689 default_sdk_path = cygpath('%s/Android/Sdk' % environ_cp['APPDATA'])
690 elif is_macos():
Shashi Shekharc0ff0cc2018-07-17 09:00:24 -0700691 default_sdk_path = '%s/library/Android/Sdk' % environ_cp['HOME']
Austin Anderson6afface2017-12-05 11:59:17 -0800692 else:
693 default_sdk_path = '%s/Android/Sdk' % environ_cp['HOME']
694
695 def valid_sdk_path(path):
696 return (os.path.exists(path) and
697 os.path.exists(os.path.join(path, 'platforms')) and
698 os.path.exists(os.path.join(path, 'build-tools')))
699
700 android_sdk_home_path = prompt_loop_or_load_from_env(
701 environ_cp,
702 var_name='ANDROID_SDK_HOME',
703 var_default=default_sdk_path,
704 ask_for_var='Please specify the home path of the Android SDK to use.',
705 check_success=valid_sdk_path,
706 error_msg=('Either %s does not exist, or it does not contain the '
707 'subdirectories "platforms" and "build-tools".'))
708
709 platforms = os.path.join(android_sdk_home_path, 'platforms')
710 api_levels = sorted(os.listdir(platforms))
711 api_levels = [x.replace('android-', '') for x in api_levels]
712
713 def valid_api_level(api_level):
Gunhan Gulsoyffa90fc2018-09-26 01:38:55 -0700714 return os.path.exists(
715 os.path.join(android_sdk_home_path, 'platforms',
716 'android-' + api_level))
Austin Anderson6afface2017-12-05 11:59:17 -0800717
718 android_api_level = prompt_loop_or_load_from_env(
719 environ_cp,
720 var_name='ANDROID_API_LEVEL',
721 var_default=api_levels[-1],
722 ask_for_var=('Please specify the Android SDK API level to use. '
723 '[Available levels: %s]') % api_levels,
724 check_success=valid_api_level,
725 error_msg='Android-%s is not present in the SDK path.')
726
727 build_tools = os.path.join(android_sdk_home_path, 'build-tools')
728 versions = sorted(os.listdir(build_tools))
729
730 def valid_build_tools(version):
Gunhan Gulsoyffa90fc2018-09-26 01:38:55 -0700731 return os.path.exists(
732 os.path.join(android_sdk_home_path, 'build-tools', version))
Austin Anderson6afface2017-12-05 11:59:17 -0800733
734 android_build_tools_version = prompt_loop_or_load_from_env(
735 environ_cp,
736 var_name='ANDROID_BUILD_TOOLS_VERSION',
737 var_default=versions[-1],
738 ask_for_var=('Please specify an Android build tools version to use. '
739 '[Available versions: %s]') % versions,
740 check_success=valid_build_tools,
741 error_msg=('The selected SDK does not have build-tools version %s '
742 'available.'))
743
Michael Case51053502018-06-05 17:47:19 -0700744 write_action_env_to_bazelrc('ANDROID_BUILD_TOOLS_VERSION',
745 android_build_tools_version)
Gunhan Gulsoyffa90fc2018-09-26 01:38:55 -0700746 write_action_env_to_bazelrc('ANDROID_SDK_API_LEVEL', android_api_level)
747 write_action_env_to_bazelrc('ANDROID_SDK_HOME', android_sdk_home_path)
Austin Anderson6afface2017-12-05 11:59:17 -0800748
749
750def check_ndk_level(android_ndk_home_path):
751 """Check the revision number of an Android NDK path."""
752 properties_path = '%s/source.properties' % android_ndk_home_path
753 if is_windows() or is_cygwin():
754 properties_path = cygpath(properties_path)
755 with open(properties_path, 'r') as f:
756 filedata = f.read()
757
758 revision = re.search(r'Pkg.Revision = (\d+)', filedata)
759 if revision:
Michael Case51053502018-06-05 17:47:19 -0700760 ndk_api_level = revision.group(1)
761 else:
762 raise Exception('Unable to parse NDK revision.')
763 if int(ndk_api_level) not in _SUPPORTED_ANDROID_NDK_VERSIONS:
764 print('WARNING: The API level of the NDK in %s is %s, which is not '
765 'supported by Bazel (officially supported versions: %s). Please use '
766 'another version. Compiling Android targets may result in confusing '
767 'errors.\n' % (android_ndk_home_path, ndk_api_level,
768 _SUPPORTED_ANDROID_NDK_VERSIONS))
769 return ndk_api_level
Austin Anderson6afface2017-12-05 11:59:17 -0800770
771
A. Unique TensorFlower73ea2872017-07-25 13:30:03 -0700772def set_gcc_host_compiler_path(environ_cp):
773 """Set GCC_HOST_COMPILER_PATH."""
Jonathan Hseu008910f2017-08-25 14:01:05 -0700774 default_gcc_host_compiler_path = which('gcc') or ''
A. Unique TensorFlower73ea2872017-07-25 13:30:03 -0700775 cuda_bin_symlink = '%s/bin/gcc' % environ_cp.get('CUDA_TOOLKIT_PATH')
776
777 if os.path.islink(cuda_bin_symlink):
778 # os.readlink is only available in linux
Jonathan Hseu008910f2017-08-25 14:01:05 -0700779 default_gcc_host_compiler_path = os.path.realpath(cuda_bin_symlink)
A. Unique TensorFlower73ea2872017-07-25 13:30:03 -0700780
Austin Anderson6afface2017-12-05 11:59:17 -0800781 gcc_host_compiler_path = prompt_loop_or_load_from_env(
782 environ_cp,
783 var_name='GCC_HOST_COMPILER_PATH',
784 var_default=default_gcc_host_compiler_path,
785 ask_for_var=
786 'Please specify which gcc should be used by nvcc as the host compiler.',
787 check_success=os.path.exists,
788 error_msg='Invalid gcc path. %s cannot be found.',
789 )
A. Unique TensorFlower73ea2872017-07-25 13:30:03 -0700790
A. Unique TensorFlower73ea2872017-07-25 13:30:03 -0700791 write_action_env_to_bazelrc('GCC_HOST_COMPILER_PATH', gcc_host_compiler_path)
792
793
Ankur Taly0e6f39d2018-02-16 18:22:55 -0800794def reformat_version_sequence(version_str, sequence_count):
795 """Reformat the version string to have the given number of sequences.
796
797 For example:
798 Given (7, 2) -> 7.0
799 (7.0.1, 2) -> 7.0
800 (5, 1) -> 5
801 (5.0.3.2, 1) -> 5
802
803 Args:
804 version_str: String, the version string.
805 sequence_count: int, an integer.
Gunhan Gulsoyffa90fc2018-09-26 01:38:55 -0700806
Ankur Taly0e6f39d2018-02-16 18:22:55 -0800807 Returns:
808 string, reformatted version string.
809 """
810 v = version_str.split('.')
811 if len(v) < sequence_count:
812 v = v + (['0'] * (sequence_count - len(v)))
813
814 return '.'.join(v[:sequence_count])
815
816
A. Unique TensorFlower73ea2872017-07-25 13:30:03 -0700817def set_tf_cuda_version(environ_cp):
818 """Set CUDA_TOOLKIT_PATH and TF_CUDA_VERSION."""
819 ask_cuda_version = (
A. Unique TensorFlowerb15500b2018-05-08 12:04:38 -0700820 'Please specify the CUDA SDK version you want to use. '
821 '[Leave empty to default to CUDA %s]: ') % _DEFAULT_CUDA_VERSION
A. Unique TensorFlower73ea2872017-07-25 13:30:03 -0700822
Austin Andersonf9a88f82017-12-13 11:49:40 -0800823 for _ in range(_DEFAULT_PROMPT_ASK_ATTEMPTS):
A. Unique TensorFlower73ea2872017-07-25 13:30:03 -0700824 # Configure the Cuda SDK version to use.
825 tf_cuda_version = get_from_env_or_user_or_default(
826 environ_cp, 'TF_CUDA_VERSION', ask_cuda_version, _DEFAULT_CUDA_VERSION)
Ankur Taly0e6f39d2018-02-16 18:22:55 -0800827 tf_cuda_version = reformat_version_sequence(str(tf_cuda_version), 2)
A. Unique TensorFlower73ea2872017-07-25 13:30:03 -0700828
829 # Find out where the CUDA toolkit is installed
830 default_cuda_path = _DEFAULT_CUDA_PATH
Martin Wicked57572e2017-09-02 19:21:45 -0700831 if is_windows() or is_cygwin():
A. Unique TensorFlower73ea2872017-07-25 13:30:03 -0700832 default_cuda_path = cygpath(
833 environ_cp.get('CUDA_PATH', _DEFAULT_CUDA_PATH_WIN))
834 elif is_linux():
835 # If the default doesn't exist, try an alternative default.
836 if (not os.path.exists(default_cuda_path)
837 ) and os.path.exists(_DEFAULT_CUDA_PATH_LINUX):
838 default_cuda_path = _DEFAULT_CUDA_PATH_LINUX
839 ask_cuda_path = ('Please specify the location where CUDA %s toolkit is'
840 ' installed. Refer to README.md for more details. '
841 '[Default is %s]: ') % (tf_cuda_version, default_cuda_path)
842 cuda_toolkit_path = get_from_env_or_user_or_default(
843 environ_cp, 'CUDA_TOOLKIT_PATH', ask_cuda_path, default_cuda_path)
A. Unique TensorFlower02f17fe2018-07-07 06:59:19 -0700844 if is_windows() or is_cygwin():
845 cuda_toolkit_path = cygpath(cuda_toolkit_path)
A. Unique TensorFlower73ea2872017-07-25 13:30:03 -0700846
847 if is_windows():
Niall Moranb7d97e82018-08-09 00:29:49 +0100848 cuda_rt_lib_paths = ['lib/x64/cudart.lib']
A. Unique TensorFlower73ea2872017-07-25 13:30:03 -0700849 elif is_linux():
Gunhan Gulsoyffa90fc2018-09-26 01:38:55 -0700850 cuda_rt_lib_paths = [
851 '%s/libcudart.so.%s' % (x, tf_cuda_version) for x in [
852 'lib64',
853 'lib/powerpc64le-linux-gnu',
854 'lib/x86_64-linux-gnu',
855 ]
856 ]
A. Unique TensorFlower73ea2872017-07-25 13:30:03 -0700857 elif is_macos():
Niall Moranb7d97e82018-08-09 00:29:49 +0100858 cuda_rt_lib_paths = ['lib/libcudart.%s.dylib' % tf_cuda_version]
A. Unique TensorFlower73ea2872017-07-25 13:30:03 -0700859
Gunhan Gulsoyffa90fc2018-09-26 01:38:55 -0700860 cuda_toolkit_paths_full = [
861 os.path.join(cuda_toolkit_path, x) for x in cuda_rt_lib_paths
862 ]
Sergei Lebedev95d7bbb2018-11-21 10:40:10 -0800863 if any(os.path.exists(x) for x in cuda_toolkit_paths_full):
Yifei Feng5198cb82018-08-17 13:53:06 -0700864 break
A. Unique TensorFlower73ea2872017-07-25 13:30:03 -0700865
866 # Reset and retry
867 print('Invalid path to CUDA %s toolkit. %s cannot be found' %
hellcom9a13fc32018-09-12 10:58:24 +0300868 (tf_cuda_version, cuda_toolkit_paths_full))
A. Unique TensorFlower73ea2872017-07-25 13:30:03 -0700869 environ_cp['TF_CUDA_VERSION'] = ''
870 environ_cp['CUDA_TOOLKIT_PATH'] = ''
871
Austin Andersonf9a88f82017-12-13 11:49:40 -0800872 else:
873 raise UserInputError('Invalid TF_CUDA_SETTING setting was provided %d '
874 'times in a row. Assuming to be a scripting mistake.' %
875 _DEFAULT_PROMPT_ASK_ATTEMPTS)
876
A. Unique TensorFlower73ea2872017-07-25 13:30:03 -0700877 # Set CUDA_TOOLKIT_PATH and TF_CUDA_VERSION
878 environ_cp['CUDA_TOOLKIT_PATH'] = cuda_toolkit_path
879 write_action_env_to_bazelrc('CUDA_TOOLKIT_PATH', cuda_toolkit_path)
880 environ_cp['TF_CUDA_VERSION'] = tf_cuda_version
881 write_action_env_to_bazelrc('TF_CUDA_VERSION', tf_cuda_version)
882
883
Yifei Fengb1d8c592017-11-22 13:42:21 -0800884def set_tf_cudnn_version(environ_cp):
A. Unique TensorFlower73ea2872017-07-25 13:30:03 -0700885 """Set CUDNN_INSTALL_PATH and TF_CUDNN_VERSION."""
886 ask_cudnn_version = (
Jonathan Hseu008910f2017-08-25 14:01:05 -0700887 'Please specify the cuDNN version you want to use. '
A. Unique TensorFlower44acd832018-10-01 13:42:40 -0700888 '[Leave empty to default to cuDNN %s]: ') % _DEFAULT_CUDNN_VERSION
A. Unique TensorFlower73ea2872017-07-25 13:30:03 -0700889
Austin Andersonf9a88f82017-12-13 11:49:40 -0800890 for _ in range(_DEFAULT_PROMPT_ASK_ATTEMPTS):
A. Unique TensorFlower73ea2872017-07-25 13:30:03 -0700891 tf_cudnn_version = get_from_env_or_user_or_default(
892 environ_cp, 'TF_CUDNN_VERSION', ask_cudnn_version,
893 _DEFAULT_CUDNN_VERSION)
Ankur Taly0e6f39d2018-02-16 18:22:55 -0800894 tf_cudnn_version = reformat_version_sequence(str(tf_cudnn_version), 1)
A. Unique TensorFlower73ea2872017-07-25 13:30:03 -0700895
896 default_cudnn_path = environ_cp.get('CUDA_TOOLKIT_PATH')
897 ask_cudnn_path = (r'Please specify the location where cuDNN %s library is '
898 'installed. Refer to README.md for more details. [Default'
A. Unique TensorFlower1b212352018-07-19 13:48:50 -0700899 ' is %s]: ') % (tf_cudnn_version, default_cudnn_path)
A. Unique TensorFlower73ea2872017-07-25 13:30:03 -0700900 cudnn_install_path = get_from_env_or_user_or_default(
901 environ_cp, 'CUDNN_INSTALL_PATH', ask_cudnn_path, default_cudnn_path)
902
903 # Result returned from "read" will be used unexpanded. That make "~"
904 # unusable. Going through one more level of expansion to handle that.
905 cudnn_install_path = os.path.realpath(
906 os.path.expanduser(cudnn_install_path))
Martin Wicked57572e2017-09-02 19:21:45 -0700907 if is_windows() or is_cygwin():
A. Unique TensorFlower73ea2872017-07-25 13:30:03 -0700908 cudnn_install_path = cygpath(cudnn_install_path)
909
910 if is_windows():
911 cuda_dnn_lib_path = 'lib/x64/cudnn.lib'
912 cuda_dnn_lib_alt_path = 'lib/x64/cudnn.lib'
913 elif is_linux():
914 cuda_dnn_lib_path = 'lib64/libcudnn.so.%s' % tf_cudnn_version
915 cuda_dnn_lib_alt_path = 'libcudnn.so.%s' % tf_cudnn_version
916 elif is_macos():
917 cuda_dnn_lib_path = 'lib/libcudnn.%s.dylib' % tf_cudnn_version
918 cuda_dnn_lib_alt_path = 'libcudnn.%s.dylib' % tf_cudnn_version
919
920 cuda_dnn_lib_path_full = os.path.join(cudnn_install_path, cuda_dnn_lib_path)
921 cuda_dnn_lib_alt_path_full = os.path.join(cudnn_install_path,
922 cuda_dnn_lib_alt_path)
923 if os.path.exists(cuda_dnn_lib_path_full) or os.path.exists(
924 cuda_dnn_lib_alt_path_full):
925 break
926
927 # Try another alternative for Linux
928 if is_linux():
Jonathan Hseu008910f2017-08-25 14:01:05 -0700929 ldconfig_bin = which('ldconfig') or '/sbin/ldconfig'
930 cudnn_path_from_ldconfig = run_shell([ldconfig_bin, '-p'])
931 cudnn_path_from_ldconfig = re.search('.*libcudnn.so .* => (.*)',
A. Unique TensorFlowere7223582017-09-06 17:57:04 -0700932 cudnn_path_from_ldconfig)
933 if cudnn_path_from_ldconfig:
934 cudnn_path_from_ldconfig = cudnn_path_from_ldconfig.group(1)
Gunhan Gulsoyffa90fc2018-09-26 01:38:55 -0700935 if os.path.exists(
936 '%s.%s' % (cudnn_path_from_ldconfig, tf_cudnn_version)):
A. Unique TensorFlowere7223582017-09-06 17:57:04 -0700937 cudnn_install_path = os.path.dirname(cudnn_path_from_ldconfig)
938 break
A. Unique TensorFlower73ea2872017-07-25 13:30:03 -0700939
940 # Reset and Retry
941 print(
942 'Invalid path to cuDNN %s toolkit. None of the following files can be '
943 'found:' % tf_cudnn_version)
944 print(cuda_dnn_lib_path_full)
945 print(cuda_dnn_lib_alt_path_full)
946 if is_linux():
947 print('%s.%s' % (cudnn_path_from_ldconfig, tf_cudnn_version))
948
949 environ_cp['TF_CUDNN_VERSION'] = ''
Austin Andersonf9a88f82017-12-13 11:49:40 -0800950 else:
951 raise UserInputError('Invalid TF_CUDNN setting was provided %d '
952 'times in a row. Assuming to be a scripting mistake.' %
953 _DEFAULT_PROMPT_ASK_ATTEMPTS)
A. Unique TensorFlower73ea2872017-07-25 13:30:03 -0700954
955 # Set CUDNN_INSTALL_PATH and TF_CUDNN_VERSION
956 environ_cp['CUDNN_INSTALL_PATH'] = cudnn_install_path
957 write_action_env_to_bazelrc('CUDNN_INSTALL_PATH', cudnn_install_path)
958 environ_cp['TF_CUDNN_VERSION'] = tf_cudnn_version
959 write_action_env_to_bazelrc('TF_CUDNN_VERSION', tf_cudnn_version)
960
961
Mingxing Tan1e7b0e42018-06-28 19:13:20 -0700962def is_cuda_compatible(lib, cuda_ver, cudnn_ver):
963 """Check compatibility between given library and cudnn/cudart libraries."""
964 ldd_bin = which('ldd') or '/usr/bin/ldd'
965 ldd_out = run_shell([ldd_bin, lib], True)
966 ldd_out = ldd_out.split(os.linesep)
967 cudnn_pattern = re.compile('.*libcudnn.so\\.?(.*) =>.*$')
968 cuda_pattern = re.compile('.*libcudart.so\\.?(.*) =>.*$')
969 cudnn = None
970 cudart = None
971 cudnn_ok = True # assume no cudnn dependency by default
972 cuda_ok = True # assume no cuda dependency by default
973 for line in ldd_out:
974 if 'libcudnn.so' in line:
975 cudnn = cudnn_pattern.search(line)
976 cudnn_ok = False
977 elif 'libcudart.so' in line:
978 cudart = cuda_pattern.search(line)
979 cuda_ok = False
980 if cudnn and len(cudnn.group(1)):
981 cudnn = convert_version_to_int(cudnn.group(1))
982 if cudart and len(cudart.group(1)):
983 cudart = convert_version_to_int(cudart.group(1))
984 if cudnn is not None:
985 cudnn_ok = (cudnn == cudnn_ver)
986 if cudart is not None:
987 cuda_ok = (cudart == cuda_ver)
988 return cudnn_ok and cuda_ok
989
990
Guangda Lai76f69382018-01-25 23:59:19 -0800991def set_tf_tensorrt_install_path(environ_cp):
992 """Set TENSORRT_INSTALL_PATH and TF_TENSORRT_VERSION.
993
994 Adapted from code contributed by Sami Kama (https://github.com/samikama).
995
996 Args:
997 environ_cp: copy of the os.environ.
998
999 Raises:
1000 ValueError: if this method was called under non-Linux platform.
1001 UserInputError: if user has provided invalid input multiple times.
1002 """
1003 if not is_linux():
1004 raise ValueError('Currently TensorRT is only supported on Linux platform.')
1005
1006 # Ask user whether to add TensorRT support.
Mingxing Tan1e7b0e42018-06-28 19:13:20 -07001007 if str(int(get_var(environ_cp, 'TF_NEED_TENSORRT', 'TensorRT',
1008 False))) != '1':
Guangda Lai76f69382018-01-25 23:59:19 -08001009 return
1010
1011 for _ in range(_DEFAULT_PROMPT_ASK_ATTEMPTS):
1012 ask_tensorrt_path = (r'Please specify the location where TensorRT is '
1013 'installed. [Default is %s]:') % (
1014 _DEFAULT_TENSORRT_PATH_LINUX)
1015 trt_install_path = get_from_env_or_user_or_default(
1016 environ_cp, 'TENSORRT_INSTALL_PATH', ask_tensorrt_path,
1017 _DEFAULT_TENSORRT_PATH_LINUX)
1018
1019 # Result returned from "read" will be used unexpanded. That make "~"
1020 # unusable. Going through one more level of expansion to handle that.
Mingxing Tan1e7b0e42018-06-28 19:13:20 -07001021 trt_install_path = os.path.realpath(os.path.expanduser(trt_install_path))
Guangda Lai76f69382018-01-25 23:59:19 -08001022
1023 def find_libs(search_path):
1024 """Search for libnvinfer.so in "search_path"."""
1025 fl = set()
1026 if os.path.exists(search_path) and os.path.isdir(search_path):
Mingxing Tan1e7b0e42018-06-28 19:13:20 -07001027 fl.update([
1028 os.path.realpath(os.path.join(search_path, x))
1029 for x in os.listdir(search_path)
1030 if 'libnvinfer.so' in x
1031 ])
Guangda Lai76f69382018-01-25 23:59:19 -08001032 return fl
1033
1034 possible_files = find_libs(trt_install_path)
1035 possible_files.update(find_libs(os.path.join(trt_install_path, 'lib')))
1036 possible_files.update(find_libs(os.path.join(trt_install_path, 'lib64')))
Guangda Lai76f69382018-01-25 23:59:19 -08001037 cuda_ver = convert_version_to_int(environ_cp['TF_CUDA_VERSION'])
1038 cudnn_ver = convert_version_to_int(environ_cp['TF_CUDNN_VERSION'])
1039 nvinfer_pattern = re.compile('.*libnvinfer.so.?(.*)$')
1040 highest_ver = [0, None, None]
1041
1042 for lib_file in possible_files:
Mingxing Tan1e7b0e42018-06-28 19:13:20 -07001043 if is_cuda_compatible(lib_file, cuda_ver, cudnn_ver):
Jacques Pienaar2d0531d2018-03-21 12:07:51 -07001044 matches = nvinfer_pattern.search(lib_file)
TensorFlower Gardener61a87202018-10-01 12:25:39 -07001045 if not matches.groups():
Jacques Pienaar2d0531d2018-03-21 12:07:51 -07001046 continue
1047 ver_str = matches.group(1)
Guangda Lai76f69382018-01-25 23:59:19 -08001048 ver = convert_version_to_int(ver_str) if len(ver_str) else 0
1049 if ver > highest_ver[0]:
1050 highest_ver = [ver, ver_str, lib_file]
1051 if highest_ver[1] is not None:
1052 trt_install_path = os.path.dirname(highest_ver[2])
1053 tf_tensorrt_version = highest_ver[1]
1054 break
1055
1056 # Try another alternative from ldconfig.
1057 ldconfig_bin = which('ldconfig') or '/sbin/ldconfig'
1058 ldconfig_output = run_shell([ldconfig_bin, '-p'])
Mingxing Tan1e7b0e42018-06-28 19:13:20 -07001059 search_result = re.search('.*libnvinfer.so\\.?([0-9.]*).* => (.*)',
1060 ldconfig_output)
Guangda Lai76f69382018-01-25 23:59:19 -08001061 if search_result:
1062 libnvinfer_path_from_ldconfig = search_result.group(2)
1063 if os.path.exists(libnvinfer_path_from_ldconfig):
Mingxing Tan1e7b0e42018-06-28 19:13:20 -07001064 if is_cuda_compatible(libnvinfer_path_from_ldconfig, cuda_ver,
1065 cudnn_ver):
Guangda Lai76f69382018-01-25 23:59:19 -08001066 trt_install_path = os.path.dirname(libnvinfer_path_from_ldconfig)
1067 tf_tensorrt_version = search_result.group(1)
1068 break
1069
1070 # Reset and Retry
Yifei Fengdce9a492018-02-22 14:24:57 -08001071 if possible_files:
1072 print('TensorRT libraries found in one the following directories',
1073 'are not compatible with selected cuda and cudnn installations')
1074 print(trt_install_path)
1075 print(os.path.join(trt_install_path, 'lib'))
1076 print(os.path.join(trt_install_path, 'lib64'))
1077 if search_result:
1078 print(libnvinfer_path_from_ldconfig)
1079 else:
1080 print(
1081 'Invalid path to TensorRT. None of the following files can be found:')
1082 print(trt_install_path)
1083 print(os.path.join(trt_install_path, 'lib'))
1084 print(os.path.join(trt_install_path, 'lib64'))
1085 if search_result:
1086 print(libnvinfer_path_from_ldconfig)
Guangda Lai76f69382018-01-25 23:59:19 -08001087
1088 else:
1089 raise UserInputError('Invalid TF_TENSORRT setting was provided %d '
1090 'times in a row. Assuming to be a scripting mistake.' %
1091 _DEFAULT_PROMPT_ASK_ATTEMPTS)
1092
1093 # Set TENSORRT_INSTALL_PATH and TF_TENSORRT_VERSION
1094 environ_cp['TENSORRT_INSTALL_PATH'] = trt_install_path
1095 write_action_env_to_bazelrc('TENSORRT_INSTALL_PATH', trt_install_path)
1096 environ_cp['TF_TENSORRT_VERSION'] = tf_tensorrt_version
1097 write_action_env_to_bazelrc('TF_TENSORRT_VERSION', tf_tensorrt_version)
1098
1099
A. Unique TensorFlower1fda7642018-04-05 03:09:27 -07001100def set_tf_nccl_install_path(environ_cp):
Jason Furmanek7c234152018-09-26 04:44:12 +00001101 """Set NCCL_INSTALL_PATH, NCCL_HDR_PATH and TF_NCCL_VERSION.
A. Unique TensorFlower1fda7642018-04-05 03:09:27 -07001102
1103 Args:
1104 environ_cp: copy of the os.environ.
1105
1106 Raises:
1107 ValueError: if this method was called under non-Linux platform.
1108 UserInputError: if user has provided invalid input multiple times.
1109 """
1110 if not is_linux():
1111 raise ValueError('Currently NCCL is only supported on Linux platforms.')
1112
1113 ask_nccl_version = (
A. Unique TensorFlower53faa312018-10-05 08:46:54 -07001114 'Please specify the locally installed NCCL version you want to use. '
1115 '[Default is to use https://github.com/nvidia/nccl]: ')
A. Unique TensorFlower1fda7642018-04-05 03:09:27 -07001116
1117 for _ in range(_DEFAULT_PROMPT_ASK_ATTEMPTS):
1118 tf_nccl_version = get_from_env_or_user_or_default(
A. Unique TensorFlower53faa312018-10-05 08:46:54 -07001119 environ_cp, 'TF_NCCL_VERSION', ask_nccl_version, '')
A. Unique TensorFlower1fda7642018-04-05 03:09:27 -07001120
A. Unique TensorFlower53faa312018-10-05 08:46:54 -07001121 if not tf_nccl_version:
1122 break # No need to get install path, building the open source code.
1123
1124 tf_nccl_version = reformat_version_sequence(str(tf_nccl_version), 1)
A. Unique TensorFlower1fda7642018-04-05 03:09:27 -07001125
Jason Furmanek7c234152018-09-26 04:44:12 +00001126 # Look with ldconfig first if we can find the library in paths
A. Unique TensorFlower1fda7642018-04-05 03:09:27 -07001127 # like /usr/lib/x86_64-linux-gnu and the header file in the corresponding
1128 # include directory. This is where the NCCL .deb packages install them.
A. Unique TensorFlower1fda7642018-04-05 03:09:27 -07001129
Jason Furmanek7c234152018-09-26 04:44:12 +00001130 # First check to see if NCCL is in the ldconfig.
1131 # If its found, use that location.
1132 if is_linux():
1133 ldconfig_bin = which('ldconfig') or '/sbin/ldconfig'
1134 nccl2_path_from_ldconfig = run_shell([ldconfig_bin, '-p'])
1135 nccl2_path_from_ldconfig = re.search('.*libnccl.so .* => (.*)',
1136 nccl2_path_from_ldconfig)
1137 if nccl2_path_from_ldconfig:
1138 nccl2_path_from_ldconfig = nccl2_path_from_ldconfig.group(1)
1139 if os.path.exists('%s.%s' % (nccl2_path_from_ldconfig, tf_nccl_version)):
1140 nccl_install_path = os.path.dirname(nccl2_path_from_ldconfig)
1141 print('NCCL libraries found in ' + nccl2_path_from_ldconfig)
A. Unique TensorFlower1fda7642018-04-05 03:09:27 -07001142
Jason Furmanek7c234152018-09-26 04:44:12 +00001143 # Check if this is the main system lib location
1144 if re.search('.*linux-gnu', nccl_install_path):
TensorFlower Gardenerea5c5292018-10-01 17:28:26 -07001145 trunc_nccl_install_path = '/usr'
1146 print('This looks like a system path.')
Jason Furmanek7c234152018-09-26 04:44:12 +00001147 else:
TensorFlower Gardenerea5c5292018-10-01 17:28:26 -07001148 trunc_nccl_install_path = nccl_install_path + '/..'
A. Unique TensorFlower1fda7642018-04-05 03:09:27 -07001149
Jason Furmanek7c234152018-09-26 04:44:12 +00001150 # Look for header
TensorFlower Gardenerea5c5292018-10-01 17:28:26 -07001151 nccl_hdr_path = trunc_nccl_install_path + '/include'
1152 print('Assuming NCCL header path is ' + nccl_hdr_path)
1153 if os.path.exists(nccl_hdr_path + '/nccl.h'):
Jason Furmanek7c234152018-09-26 04:44:12 +00001154 # Set NCCL_INSTALL_PATH
1155 environ_cp['NCCL_INSTALL_PATH'] = nccl_install_path
1156 write_action_env_to_bazelrc('NCCL_INSTALL_PATH', nccl_install_path)
A. Unique TensorFlower1fda7642018-04-05 03:09:27 -07001157
Jason Furmanek7c234152018-09-26 04:44:12 +00001158 # Set NCCL_HDR_PATH
1159 environ_cp['NCCL_HDR_PATH'] = nccl_hdr_path
1160 write_action_env_to_bazelrc('NCCL_HDR_PATH', nccl_hdr_path)
1161 break
1162 else:
TensorFlower Gardenerea5c5292018-10-01 17:28:26 -07001163 print(
1164 'The header for NCCL2 cannot be found. Please install the libnccl-dev package.'
1165 )
Jason Furmanek7c234152018-09-26 04:44:12 +00001166 else:
TensorFlower Gardenerea5c5292018-10-01 17:28:26 -07001167 print('NCCL2 is listed by ldconfig but the library is not found. '
1168 'Your ldconfig is out of date. Please run sudo ldconfig.')
Jason Furmanek7c234152018-09-26 04:44:12 +00001169 else:
1170 # NCCL is not found in ldconfig. Ask the user for the location.
1171 default_nccl_path = environ_cp.get('CUDA_TOOLKIT_PATH')
TensorFlower Gardenerea5c5292018-10-01 17:28:26 -07001172 ask_nccl_path = (
1173 r'Please specify the location where NCCL %s library is '
1174 'installed. Refer to README.md for more details. [Default '
1175 'is %s]:') % (tf_nccl_version, default_nccl_path)
Jason Furmanek7c234152018-09-26 04:44:12 +00001176 nccl_install_path = get_from_env_or_user_or_default(
TensorFlower Gardenerea5c5292018-10-01 17:28:26 -07001177 environ_cp, 'NCCL_INSTALL_PATH', ask_nccl_path, default_nccl_path)
A. Unique TensorFlower1fda7642018-04-05 03:09:27 -07001178
Jason Furmanek7c234152018-09-26 04:44:12 +00001179 # Result returned from "read" will be used unexpanded. That make "~"
1180 # unusable. Going through one more level of expansion to handle that.
TensorFlower Gardenerea5c5292018-10-01 17:28:26 -07001181 nccl_install_path = os.path.realpath(
1182 os.path.expanduser(nccl_install_path))
Jason Furmanek7c234152018-09-26 04:44:12 +00001183 if is_windows() or is_cygwin():
1184 nccl_install_path = cygpath(nccl_install_path)
A. Unique TensorFlower1fda7642018-04-05 03:09:27 -07001185
Guangda Lai62ebf622018-10-23 07:44:13 -07001186 nccl_lib_path = ''
Jason Furmanek7c234152018-09-26 04:44:12 +00001187 if is_windows():
1188 nccl_lib_path = 'lib/x64/nccl.lib'
1189 elif is_linux():
1190 nccl_lib_filename = 'libnccl.so.%s' % tf_nccl_version
1191 nccl_lpath = '%s/lib/%s' % (nccl_install_path, nccl_lib_filename)
1192 if not os.path.exists(nccl_lpath):
1193 for relative_path in NCCL_LIB_PATHS:
TensorFlower Gardenerea5c5292018-10-01 17:28:26 -07001194 path = '%s/%s%s' % (nccl_install_path, relative_path,
1195 nccl_lib_filename)
Jason Furmanek7c234152018-09-26 04:44:12 +00001196 if os.path.exists(path):
TensorFlower Gardenerea5c5292018-10-01 17:28:26 -07001197 print('NCCL found at ' + path)
Jason Furmanek7c234152018-09-26 04:44:12 +00001198 nccl_lib_path = path
1199 break
1200 else:
1201 nccl_lib_path = nccl_lpath
1202 elif is_macos():
1203 nccl_lib_path = 'lib/libnccl.%s.dylib' % tf_nccl_version
A. Unique TensorFlower1fda7642018-04-05 03:09:27 -07001204
Jason Furmanek7c234152018-09-26 04:44:12 +00001205 nccl_lib_path = os.path.join(nccl_install_path, nccl_lib_path)
TensorFlower Gardenerea5c5292018-10-01 17:28:26 -07001206 nccl_hdr_path = os.path.join(
1207 os.path.dirname(nccl_lib_path), '../include/nccl.h')
1208 print('Assuming NCCL header path is ' + nccl_hdr_path)
Jason Furmanek7c234152018-09-26 04:44:12 +00001209 if os.path.exists(nccl_lib_path) and os.path.exists(nccl_hdr_path):
1210 # Set NCCL_INSTALL_PATH
1211 environ_cp['NCCL_INSTALL_PATH'] = os.path.dirname(nccl_lib_path)
TensorFlower Gardenerea5c5292018-10-01 17:28:26 -07001212 write_action_env_to_bazelrc('NCCL_INSTALL_PATH',
1213 os.path.dirname(nccl_lib_path))
A. Unique TensorFlower1fda7642018-04-05 03:09:27 -07001214
Jason Furmanek7c234152018-09-26 04:44:12 +00001215 # Set NCCL_HDR_PATH
1216 environ_cp['NCCL_HDR_PATH'] = os.path.dirname(nccl_hdr_path)
TensorFlower Gardenerea5c5292018-10-01 17:28:26 -07001217 write_action_env_to_bazelrc('NCCL_HDR_PATH',
1218 os.path.dirname(nccl_hdr_path))
Jason Furmanek7c234152018-09-26 04:44:12 +00001219 break
1220
1221 # Reset and Retry
TensorFlower Gardenerea5c5292018-10-01 17:28:26 -07001222 print(
1223 'Invalid path to NCCL %s toolkit, %s or %s not found. Please use the '
A. Unique TensorFlower1fda7642018-04-05 03:09:27 -07001224 'O/S agnostic package of NCCL 2' % (tf_nccl_version, nccl_lib_path,
1225 nccl_hdr_path))
1226
Jason Furmanek7c234152018-09-26 04:44:12 +00001227 environ_cp['TF_NCCL_VERSION'] = ''
A. Unique TensorFlower1fda7642018-04-05 03:09:27 -07001228 else:
1229 raise UserInputError('Invalid TF_NCCL setting was provided %d '
1230 'times in a row. Assuming to be a scripting mistake.' %
1231 _DEFAULT_PROMPT_ASK_ATTEMPTS)
1232
1233 # Set TF_NCCL_VERSION
1234 environ_cp['TF_NCCL_VERSION'] = tf_nccl_version
1235 write_action_env_to_bazelrc('TF_NCCL_VERSION', tf_nccl_version)
1236
A. Unique TensorFlower73ea2872017-07-25 13:30:03 -07001237def get_native_cuda_compute_capabilities(environ_cp):
1238 """Get native cuda compute capabilities.
1239
1240 Args:
1241 environ_cp: copy of the os.environ.
Gunhan Gulsoyffa90fc2018-09-26 01:38:55 -07001242
A. Unique TensorFlower73ea2872017-07-25 13:30:03 -07001243 Returns:
1244 string of native cuda compute capabilities, separated by comma.
1245 """
1246 device_query_bin = os.path.join(
1247 environ_cp.get('CUDA_TOOLKIT_PATH'), 'extras/demo_suite/deviceQuery')
Jonathan Hseu008910f2017-08-25 14:01:05 -07001248 if os.path.isfile(device_query_bin) and os.access(device_query_bin, os.X_OK):
1249 try:
1250 output = run_shell(device_query_bin).split('\n')
1251 pattern = re.compile('[0-9]*\\.[0-9]*')
1252 output = [pattern.search(x) for x in output if 'Capability' in x]
1253 output = ','.join(x.group() for x in output if x is not None)
1254 except subprocess.CalledProcessError:
1255 output = ''
1256 else:
A. Unique TensorFlower73ea2872017-07-25 13:30:03 -07001257 output = ''
1258 return output
1259
1260
1261def set_tf_cuda_compute_capabilities(environ_cp):
1262 """Set TF_CUDA_COMPUTE_CAPABILITIES."""
1263 while True:
1264 native_cuda_compute_capabilities = get_native_cuda_compute_capabilities(
1265 environ_cp)
1266 if not native_cuda_compute_capabilities:
1267 default_cuda_compute_capabilities = _DEFAULT_CUDA_COMPUTE_CAPABILITIES
1268 else:
1269 default_cuda_compute_capabilities = native_cuda_compute_capabilities
1270
1271 ask_cuda_compute_capabilities = (
1272 'Please specify a list of comma-separated '
1273 'Cuda compute capabilities you want to '
1274 'build with.\nYou can find the compute '
1275 'capability of your device at: '
1276 'https://developer.nvidia.com/cuda-gpus.\nPlease'
1277 ' note that each additional compute '
1278 'capability significantly increases your '
A. Unique TensorFlower1b212352018-07-19 13:48:50 -07001279 'build time and binary size. [Default is: %s]: ' %
A. Unique TensorFlower73ea2872017-07-25 13:30:03 -07001280 default_cuda_compute_capabilities)
1281 tf_cuda_compute_capabilities = get_from_env_or_user_or_default(
1282 environ_cp, 'TF_CUDA_COMPUTE_CAPABILITIES',
1283 ask_cuda_compute_capabilities, default_cuda_compute_capabilities)
1284 # Check whether all capabilities from the input is valid
1285 all_valid = True
Maciejd0f5bc12018-04-30 22:30:58 -05001286 # Remove all whitespace characters before splitting the string
Michael Case51053502018-06-05 17:47:19 -07001287 # that users may insert by accident, as this will result in error
Maciejd0f5bc12018-04-30 22:30:58 -05001288 tf_cuda_compute_capabilities = ''.join(tf_cuda_compute_capabilities.split())
A. Unique TensorFlower73ea2872017-07-25 13:30:03 -07001289 for compute_capability in tf_cuda_compute_capabilities.split(','):
Andrew Harp6e3e7d12017-08-21 12:10:44 -07001290 m = re.match('[0-9]+.[0-9]+', compute_capability)
1291 if not m:
A. Unique TensorFlower73ea2872017-07-25 13:30:03 -07001292 print('Invalid compute capability: ' % compute_capability)
1293 all_valid = False
Andrew Harp6e3e7d12017-08-21 12:10:44 -07001294 else:
1295 ver = int(m.group(0).split('.')[0])
1296 if ver < 3:
1297 print('Only compute capabilities 3.0 or higher are supported.')
1298 all_valid = False
A. Unique TensorFlower73ea2872017-07-25 13:30:03 -07001299
1300 if all_valid:
1301 break
1302
1303 # Reset and Retry
1304 environ_cp['TF_CUDA_COMPUTE_CAPABILITIES'] = ''
1305
1306 # Set TF_CUDA_COMPUTE_CAPABILITIES
1307 environ_cp['TF_CUDA_COMPUTE_CAPABILITIES'] = tf_cuda_compute_capabilities
1308 write_action_env_to_bazelrc('TF_CUDA_COMPUTE_CAPABILITIES',
1309 tf_cuda_compute_capabilities)
1310
1311
1312def set_other_cuda_vars(environ_cp):
1313 """Set other CUDA related variables."""
A. Unique TensorFlowerab391982018-07-11 04:52:49 -07001314 # If CUDA is enabled, always use GPU during build and test.
1315 if environ_cp.get('TF_CUDA_CLANG') == '1':
1316 write_to_bazelrc('build --config=cuda_clang')
1317 write_to_bazelrc('test --config=cuda_clang')
A. Unique TensorFlower73ea2872017-07-25 13:30:03 -07001318 else:
A. Unique TensorFlowerab391982018-07-11 04:52:49 -07001319 write_to_bazelrc('build --config=cuda')
1320 write_to_bazelrc('test --config=cuda')
A. Unique TensorFlower73ea2872017-07-25 13:30:03 -07001321
1322
1323def set_host_cxx_compiler(environ_cp):
1324 """Set HOST_CXX_COMPILER."""
Jonathan Hseu008910f2017-08-25 14:01:05 -07001325 default_cxx_host_compiler = which('g++') or ''
A. Unique TensorFlower73ea2872017-07-25 13:30:03 -07001326
Austin Anderson6afface2017-12-05 11:59:17 -08001327 host_cxx_compiler = prompt_loop_or_load_from_env(
1328 environ_cp,
1329 var_name='HOST_CXX_COMPILER',
1330 var_default=default_cxx_host_compiler,
1331 ask_for_var=('Please specify which C++ compiler should be used as the '
1332 'host C++ compiler.'),
1333 check_success=os.path.exists,
1334 error_msg='Invalid C++ compiler path. %s cannot be found.',
1335 )
A. Unique TensorFlower73ea2872017-07-25 13:30:03 -07001336
A. Unique TensorFlower73ea2872017-07-25 13:30:03 -07001337 write_action_env_to_bazelrc('HOST_CXX_COMPILER', host_cxx_compiler)
1338
1339
1340def set_host_c_compiler(environ_cp):
1341 """Set HOST_C_COMPILER."""
Jonathan Hseu008910f2017-08-25 14:01:05 -07001342 default_c_host_compiler = which('gcc') or ''
A. Unique TensorFlower73ea2872017-07-25 13:30:03 -07001343
Austin Anderson6afface2017-12-05 11:59:17 -08001344 host_c_compiler = prompt_loop_or_load_from_env(
1345 environ_cp,
1346 var_name='HOST_C_COMPILER',
1347 var_default=default_c_host_compiler,
Shanqing Cai71445712018-03-12 19:33:52 -07001348 ask_for_var=('Please specify which C compiler should be used as the host '
Austin Anderson6afface2017-12-05 11:59:17 -08001349 'C compiler.'),
1350 check_success=os.path.exists,
1351 error_msg='Invalid C compiler path. %s cannot be found.',
1352 )
A. Unique TensorFlower73ea2872017-07-25 13:30:03 -07001353
A. Unique TensorFlower73ea2872017-07-25 13:30:03 -07001354 write_action_env_to_bazelrc('HOST_C_COMPILER', host_c_compiler)
1355
1356
1357def set_computecpp_toolkit_path(environ_cp):
1358 """Set COMPUTECPP_TOOLKIT_PATH."""
A. Unique TensorFlower73ea2872017-07-25 13:30:03 -07001359
Austin Anderson6afface2017-12-05 11:59:17 -08001360 def toolkit_exists(toolkit_path):
1361 """Check if a computecpp toolkit path is valid."""
A. Unique TensorFlower73ea2872017-07-25 13:30:03 -07001362 if is_linux():
1363 sycl_rt_lib_path = 'lib/libComputeCpp.so'
1364 else:
1365 sycl_rt_lib_path = ''
1366
Gunhan Gulsoyffa90fc2018-09-26 01:38:55 -07001367 sycl_rt_lib_path_full = os.path.join(toolkit_path, sycl_rt_lib_path)
Austin Anderson6afface2017-12-05 11:59:17 -08001368 exists = os.path.exists(sycl_rt_lib_path_full)
1369 if not exists:
1370 print('Invalid SYCL %s library path. %s cannot be found' %
1371 (_TF_OPENCL_VERSION, sycl_rt_lib_path_full))
1372 return exists
A. Unique TensorFlower73ea2872017-07-25 13:30:03 -07001373
Austin Anderson6afface2017-12-05 11:59:17 -08001374 computecpp_toolkit_path = prompt_loop_or_load_from_env(
1375 environ_cp,
1376 var_name='COMPUTECPP_TOOLKIT_PATH',
1377 var_default=_DEFAULT_COMPUTECPP_TOOLKIT_PATH,
1378 ask_for_var=(
1379 'Please specify the location where ComputeCpp for SYCL %s is '
1380 'installed.' % _TF_OPENCL_VERSION),
1381 check_success=toolkit_exists,
1382 error_msg='Invalid SYCL compiler path. %s cannot be found.',
1383 suppress_default_error=True)
A. Unique TensorFlower73ea2872017-07-25 13:30:03 -07001384
A. Unique TensorFlower73ea2872017-07-25 13:30:03 -07001385 write_action_env_to_bazelrc('COMPUTECPP_TOOLKIT_PATH',
1386 computecpp_toolkit_path)
1387
Michael Cased31531a2018-01-05 14:09:41 -08001388
Dandelion Man?90e42f32017-12-15 18:15:07 -08001389def set_trisycl_include_dir(environ_cp):
Michael Cased31531a2018-01-05 14:09:41 -08001390 """Set TRISYCL_INCLUDE_DIR."""
Frank Chenc4ef9272018-01-10 11:36:52 -08001391
Dandelion Man?90e42f32017-12-15 18:15:07 -08001392 ask_trisycl_include_dir = ('Please specify the location of the triSYCL '
1393 'include directory. (Use --config=sycl_trisycl '
1394 'when building with Bazel) '
Gunhan Gulsoyffa90fc2018-09-26 01:38:55 -07001395 '[Default is %s]: ') % (
1396 _DEFAULT_TRISYCL_INCLUDE_DIR)
Frank Chenc4ef9272018-01-10 11:36:52 -08001397
Dandelion Man?90e42f32017-12-15 18:15:07 -08001398 while True:
1399 trisycl_include_dir = get_from_env_or_user_or_default(
Michael Cased31531a2018-01-05 14:09:41 -08001400 environ_cp, 'TRISYCL_INCLUDE_DIR', ask_trisycl_include_dir,
1401 _DEFAULT_TRISYCL_INCLUDE_DIR)
Dandelion Man?90e42f32017-12-15 18:15:07 -08001402 if os.path.exists(trisycl_include_dir):
1403 break
1404
Gunhan Gulsoyffa90fc2018-09-26 01:38:55 -07001405 print('Invalid triSYCL include directory, %s cannot be found' %
1406 (trisycl_include_dir))
Dandelion Man?90e42f32017-12-15 18:15:07 -08001407
1408 # Set TRISYCL_INCLUDE_DIR
1409 environ_cp['TRISYCL_INCLUDE_DIR'] = trisycl_include_dir
Gunhan Gulsoyffa90fc2018-09-26 01:38:55 -07001410 write_action_env_to_bazelrc('TRISYCL_INCLUDE_DIR', trisycl_include_dir)
A. Unique TensorFlower73ea2872017-07-25 13:30:03 -07001411
Yifei Fengb1d8c592017-11-22 13:42:21 -08001412
A. Unique TensorFlower73ea2872017-07-25 13:30:03 -07001413def set_mpi_home(environ_cp):
1414 """Set MPI_HOME."""
Austin Anderson6afface2017-12-05 11:59:17 -08001415
Jonathan Hseu008910f2017-08-25 14:01:05 -07001416 default_mpi_home = which('mpirun') or which('mpiexec') or ''
1417 default_mpi_home = os.path.dirname(os.path.dirname(default_mpi_home))
1418
Austin Anderson6afface2017-12-05 11:59:17 -08001419 def valid_mpi_path(mpi_home):
Gunhan Gulsoyffa90fc2018-09-26 01:38:55 -07001420 exists = (
1421 os.path.exists(os.path.join(mpi_home, 'include')) and
TensorFlower Gardenerf7c861f2018-11-01 11:29:40 -07001422 (os.path.exists(os.path.join(mpi_home, 'lib')) or
1423 os.path.exists(os.path.join(mpi_home, 'lib64')) or
1424 os.path.exists(os.path.join(mpi_home, 'lib32'))))
Austin Anderson6afface2017-12-05 11:59:17 -08001425 if not exists:
TensorFlower Gardenerf7c861f2018-11-01 11:29:40 -07001426 print(
1427 'Invalid path to the MPI Toolkit. %s or %s or %s or %s cannot be found'
1428 % (os.path.join(mpi_home, 'include'),
Christian Gollba95d092018-10-04 17:06:23 +02001429 os.path.exists(os.path.join(mpi_home, 'lib')),
1430 os.path.exists(os.path.join(mpi_home, 'lib64')),
1431 os.path.exists(os.path.join(mpi_home, 'lib32'))))
Austin Anderson6afface2017-12-05 11:59:17 -08001432 return exists
A. Unique TensorFlower73ea2872017-07-25 13:30:03 -07001433
Austin Anderson6afface2017-12-05 11:59:17 -08001434 _ = prompt_loop_or_load_from_env(
1435 environ_cp,
1436 var_name='MPI_HOME',
1437 var_default=default_mpi_home,
1438 ask_for_var='Please specify the MPI toolkit folder.',
1439 check_success=valid_mpi_path,
1440 error_msg='',
1441 suppress_default_error=True)
A. Unique TensorFlower73ea2872017-07-25 13:30:03 -07001442
1443
1444def set_other_mpi_vars(environ_cp):
1445 """Set other MPI related variables."""
1446 # Link the MPI header files
1447 mpi_home = environ_cp.get('MPI_HOME')
1448 symlink_force('%s/include/mpi.h' % mpi_home, 'third_party/mpi/mpi.h')
1449
1450 # Determine if we use OpenMPI or MVAPICH, these require different header files
1451 # to be included here to make bazel dependency checker happy
1452 if os.path.exists(os.path.join(mpi_home, 'include/mpi_portable_platform.h')):
1453 symlink_force(
1454 os.path.join(mpi_home, 'include/mpi_portable_platform.h'),
1455 'third_party/mpi/mpi_portable_platform.h')
1456 # TODO(gunan): avoid editing files in configure
1457 sed_in_place('third_party/mpi/mpi.bzl', 'MPI_LIB_IS_OPENMPI=False',
1458 'MPI_LIB_IS_OPENMPI=True')
1459 else:
1460 # MVAPICH / MPICH
1461 symlink_force(
1462 os.path.join(mpi_home, 'include/mpio.h'), 'third_party/mpi/mpio.h')
1463 symlink_force(
1464 os.path.join(mpi_home, 'include/mpicxx.h'), 'third_party/mpi/mpicxx.h')
1465 # TODO(gunan): avoid editing files in configure
1466 sed_in_place('third_party/mpi/mpi.bzl', 'MPI_LIB_IS_OPENMPI=True',
1467 'MPI_LIB_IS_OPENMPI=False')
1468
1469 if os.path.exists(os.path.join(mpi_home, 'lib/libmpi.so')):
1470 symlink_force(
1471 os.path.join(mpi_home, 'lib/libmpi.so'), 'third_party/mpi/libmpi.so')
Christian Gollba95d092018-10-04 17:06:23 +02001472 elif os.path.exists(os.path.join(mpi_home, 'lib64/libmpi.so')):
1473 symlink_force(
1474 os.path.join(mpi_home, 'lib64/libmpi.so'), 'third_party/mpi/libmpi.so')
1475 elif os.path.exists(os.path.join(mpi_home, 'lib32/libmpi.so')):
1476 symlink_force(
1477 os.path.join(mpi_home, 'lib32/libmpi.so'), 'third_party/mpi/libmpi.so')
1478
A. Unique TensorFlower73ea2872017-07-25 13:30:03 -07001479 else:
TensorFlower Gardenerf7c861f2018-11-01 11:29:40 -07001480 raise ValueError(
1481 'Cannot find the MPI library file in %s/lib or %s/lib64 or %s/lib32' %
1482 mpi_home, mpi_home, mpi_home)
A. Unique TensorFlower73ea2872017-07-25 13:30:03 -07001483
1484
Yifei Feng5198cb82018-08-17 13:53:06 -07001485def set_system_libs_flag(environ_cp):
1486 syslibs = environ_cp.get('TF_SYSTEM_LIBS', '')
TensorFlower Gardener61a87202018-10-01 12:25:39 -07001487 if syslibs:
Jason Zaman5fc39bd2018-09-16 01:38:55 +08001488 if ',' in syslibs:
1489 syslibs = ','.join(sorted(syslibs.split(',')))
1490 else:
1491 syslibs = ','.join(sorted(syslibs.split()))
Yifei Feng5198cb82018-08-17 13:53:06 -07001492 write_action_env_to_bazelrc('TF_SYSTEM_LIBS', syslibs)
1493
Jason Zaman5fc39bd2018-09-16 01:38:55 +08001494 if 'PREFIX' in environ_cp:
1495 write_to_bazelrc('build --define=PREFIX=%s' % environ_cp['PREFIX'])
1496 if 'LIBDIR' in environ_cp:
1497 write_to_bazelrc('build --define=LIBDIR=%s' % environ_cp['LIBDIR'])
1498 if 'INCLUDEDIR' in environ_cp:
1499 write_to_bazelrc('build --define=INCLUDEDIR=%s' % environ_cp['INCLUDEDIR'])
1500
Yifei Feng5198cb82018-08-17 13:53:06 -07001501
A. Unique TensorFlower1b212352018-07-19 13:48:50 -07001502def set_windows_build_flags(environ_cp):
1503 """Set Windows specific build options."""
1504 # The non-monolithic build is not supported yet
1505 write_to_bazelrc('build --config monolithic')
1506 # Suppress warning messages
1507 write_to_bazelrc('build --copt=-w --host_copt=-w')
1508 # Output more verbose information when something goes wrong
1509 write_to_bazelrc('build --verbose_failures')
1510 # The host and target platforms are the same in Windows build. So we don't
1511 # have to distinct them. This avoids building the same targets twice.
1512 write_to_bazelrc('build --distinct_host_configuration=false')
1513 # Enable short object file path to avoid long path issue on Windows.
1514 # TODO(pcloudy): Remove this flag when upgrading Bazel to 0.16.0
1515 # Short object file path will be enabled by default.
1516 write_to_bazelrc('build --experimental_shortened_obj_file_path=true')
1517
1518 if get_var(
1519 environ_cp, 'TF_OVERRIDE_EIGEN_STRONG_INLINE', 'Eigen strong inline',
Gunhan Gulsoyffa90fc2018-09-26 01:38:55 -07001520 True, ('Would you like to override eigen strong inline for some C++ '
1521 'compilation to reduce the compilation time?'),
1522 'Eigen strong inline overridden.', 'Not overriding eigen strong inline, '
A. Unique TensorFlower1b212352018-07-19 13:48:50 -07001523 'some compilations could take more than 20 mins.'):
1524 # Due to a known MSVC compiler issue
1525 # https://github.com/tensorflow/tensorflow/issues/10521
1526 # Overriding eigen strong inline speeds up the compiling of
1527 # conv_grad_ops_3d.cc and conv_ops_3d.cc by 20 minutes,
1528 # but this also hurts the performance. Let users decide what they want.
1529 write_to_bazelrc('build --define=override_eigen_strong_inline=true')
Dandelion Man?90e42f32017-12-15 18:15:07 -08001530
A. Unique TensorFlower061c3592017-11-13 14:21:04 -08001531
Michael Cased31531a2018-01-05 14:09:41 -08001532def config_info_line(name, help_text):
1533 """Helper function to print formatted help text for Bazel config options."""
1534 print('\t--config=%-12s\t# %s' % (name, help_text))
1535
1536
A. Unique TensorFlower73ea2872017-07-25 13:30:03 -07001537def main():
A. Unique TensorFlower7c5eb352018-10-01 07:15:23 -07001538 global _TF_WORKSPACE_ROOT
1539 global _TF_BAZELRC
1540
Shanqing Cai71445712018-03-12 19:33:52 -07001541 parser = argparse.ArgumentParser()
Gunhan Gulsoyffa90fc2018-09-26 01:38:55 -07001542 parser.add_argument(
1543 '--workspace',
1544 type=str,
A. Unique TensorFlower7c5eb352018-10-01 07:15:23 -07001545 default=os.path.abspath(os.path.dirname(__file__)),
Gunhan Gulsoyffa90fc2018-09-26 01:38:55 -07001546 help='The absolute path to your active Bazel workspace.')
Shanqing Cai71445712018-03-12 19:33:52 -07001547 args = parser.parse_args()
1548
A. Unique TensorFlower7c5eb352018-10-01 07:15:23 -07001549 _TF_WORKSPACE_ROOT = args.workspace
1550 _TF_BAZELRC = os.path.join(_TF_WORKSPACE_ROOT, _TF_BAZELRC_FILENAME)
1551
A. Unique TensorFlower73ea2872017-07-25 13:30:03 -07001552 # Make a copy of os.environ to be clear when functions and getting and setting
1553 # environment variables.
1554 environ_cp = dict(os.environ)
1555
Jason Zamanb41761c2018-10-14 11:28:53 +08001556 check_bazel_version('0.18.0', '0.20.0')
A. Unique TensorFlower73ea2872017-07-25 13:30:03 -07001557
A. Unique TensorFlower7c5eb352018-10-01 07:15:23 -07001558 reset_tf_configure_bazelrc()
Yun Peng03e63a22018-11-07 11:18:53 +01001559
A. Unique TensorFlower73ea2872017-07-25 13:30:03 -07001560 cleanup_makefile()
Gunhan Gulsoyed89a2b2017-09-19 18:36:26 -07001561 setup_python(environ_cp)
A. Unique TensorFlower73ea2872017-07-25 13:30:03 -07001562
1563 if is_windows():
Yifei Fengb1d8c592017-11-22 13:42:21 -08001564 environ_cp['TF_NEED_OPENCL_SYCL'] = '0'
1565 environ_cp['TF_NEED_COMPUTECPP'] = '0'
A. Unique TensorFlower73ea2872017-07-25 13:30:03 -07001566 environ_cp['TF_NEED_OPENCL'] = '0'
1567 environ_cp['TF_CUDA_CLANG'] = '0'
Guangda Lai76f69382018-01-25 23:59:19 -08001568 environ_cp['TF_NEED_TENSORRT'] = '0'
Ilya Biryukov9e651e42018-03-22 05:33:42 -07001569 # TODO(ibiryukov): Investigate using clang as a cpu or cuda compiler on
1570 # Windows.
1571 environ_cp['TF_DOWNLOAD_CLANG'] = '0'
A. Unique TensorFlower6e97fb32018-07-16 14:07:29 -07001572 environ_cp['TF_NEED_MPI'] = '0'
1573 environ_cp['TF_SET_ANDROID_WORKSPACE'] = '0'
A. Unique TensorFlower73ea2872017-07-25 13:30:03 -07001574
1575 if is_macos():
Guangda Lai76f69382018-01-25 23:59:19 -08001576 environ_cp['TF_NEED_TENSORRT'] = '0'
A. Unique TensorFlower73ea2872017-07-25 13:30:03 -07001577
Jon Triebenbach6896a742018-06-27 13:29:53 -05001578 # The numpy package on ppc64le uses OpenBLAS which has multi-threading
1579 # issues that lead to incorrect answers. Set OMP_NUM_THREADS=1 at
1580 # runtime to allow the Tensorflow testcases which compare numpy
1581 # results to Tensorflow results to succeed.
1582 if is_ppc64le():
Gunhan Gulsoyffa90fc2018-09-26 01:38:55 -07001583 write_action_env_to_bazelrc('OMP_NUM_THREADS', 1)
Jon Triebenbach6896a742018-06-27 13:29:53 -05001584
Grzegorz Pawelczakec82efd2018-10-09 15:03:46 +01001585 xla_enabled_by_default = is_linux()
A. Unique TensorFlower73ea2872017-07-25 13:30:03 -07001586 set_build_var(environ_cp, 'TF_ENABLE_XLA', 'XLA JIT', 'with_xla_support',
Grzegorz Pawelczakec82efd2018-10-09 15:03:46 +01001587 xla_enabled_by_default, 'xla')
Gunhan Gulsoy3da0dff2018-09-26 11:55:50 -07001588
Yifei Fengb1d8c592017-11-22 13:42:21 -08001589 set_action_env_var(environ_cp, 'TF_NEED_OPENCL_SYCL', 'OpenCL SYCL', False)
1590 if environ_cp.get('TF_NEED_OPENCL_SYCL') == '1':
A. Unique TensorFlower73ea2872017-07-25 13:30:03 -07001591 set_host_cxx_compiler(environ_cp)
1592 set_host_c_compiler(environ_cp)
Yifei Fengb1d8c592017-11-22 13:42:21 -08001593 set_action_env_var(environ_cp, 'TF_NEED_COMPUTECPP', 'ComputeCPP', True)
1594 if environ_cp.get('TF_NEED_COMPUTECPP') == '1':
1595 set_computecpp_toolkit_path(environ_cp)
1596 else:
1597 set_trisycl_include_dir(environ_cp)
A. Unique TensorFlower73ea2872017-07-25 13:30:03 -07001598
Wen-Heng (Jack) Chung69d3b8f2018-06-22 23:09:43 -05001599 set_action_env_var(environ_cp, 'TF_NEED_ROCM', 'ROCm', False)
1600 if (environ_cp.get('TF_NEED_ROCM') == '1' and
TensorFlower Gardener62e60162018-09-27 10:22:55 -07001601 'LD_LIBRARY_PATH' in environ_cp and
1602 environ_cp.get('LD_LIBRARY_PATH') != '1'):
1603 write_action_env_to_bazelrc('LD_LIBRARY_PATH',
1604 environ_cp.get('LD_LIBRARY_PATH'))
Wen-Heng (Jack) Chung69d3b8f2018-06-22 23:09:43 -05001605
A. Unique TensorFlower73ea2872017-07-25 13:30:03 -07001606 set_action_env_var(environ_cp, 'TF_NEED_CUDA', 'CUDA', False)
A. Unique TensorFlower24cbb2a2017-09-08 07:45:44 -07001607 if (environ_cp.get('TF_NEED_CUDA') == '1' and
1608 'TF_CUDA_CONFIG_REPO' not in environ_cp):
A. Unique TensorFlower73ea2872017-07-25 13:30:03 -07001609 set_tf_cuda_version(environ_cp)
Yifei Fengb1d8c592017-11-22 13:42:21 -08001610 set_tf_cudnn_version(environ_cp)
Guangda Lai76f69382018-01-25 23:59:19 -08001611 if is_linux():
1612 set_tf_tensorrt_install_path(environ_cp)
Michael Case0073d132018-04-11 09:34:44 -07001613 set_tf_nccl_install_path(environ_cp)
1614
A. Unique TensorFlower73ea2872017-07-25 13:30:03 -07001615 set_tf_cuda_compute_capabilities(environ_cp)
Ankur Taly0e6f39d2018-02-16 18:22:55 -08001616 if 'LD_LIBRARY_PATH' in environ_cp and environ_cp.get(
1617 'LD_LIBRARY_PATH') != '1':
1618 write_action_env_to_bazelrc('LD_LIBRARY_PATH',
1619 environ_cp.get('LD_LIBRARY_PATH'))
A. Unique TensorFlower73ea2872017-07-25 13:30:03 -07001620
1621 set_tf_cuda_clang(environ_cp)
1622 if environ_cp.get('TF_CUDA_CLANG') == '1':
Ilya Biryukov9e651e42018-03-22 05:33:42 -07001623 # Ask whether we should download the clang toolchain.
1624 set_tf_download_clang(environ_cp)
A. Unique TensorFlowerfd29e952017-12-22 03:07:51 -08001625 if environ_cp.get('TF_DOWNLOAD_CLANG') != '1':
1626 # Set up which clang we should use as the cuda / host compiler.
1627 set_clang_cuda_compiler_path(environ_cp)
Ilya Biryukov1c3d02e2018-09-04 03:09:52 -07001628 else:
1629 # Use downloaded LLD for linking.
1630 write_to_bazelrc('build:cuda_clang --config=download_clang_use_lld')
1631 write_to_bazelrc('test:cuda_clang --config=download_clang_use_lld')
A. Unique TensorFlower73ea2872017-07-25 13:30:03 -07001632 else:
1633 # Set up which gcc nvcc should use as the host compiler
1634 # No need to set this on Windows
1635 if not is_windows():
1636 set_gcc_host_compiler_path(environ_cp)
1637 set_other_cuda_vars(environ_cp)
Ilya Biryukov9e651e42018-03-22 05:33:42 -07001638 else:
1639 # CUDA not required. Ask whether we should download the clang toolchain and
1640 # use it for the CPU build.
1641 set_tf_download_clang(environ_cp)
1642 if environ_cp.get('TF_DOWNLOAD_CLANG') == '1':
1643 write_to_bazelrc('build --config=download_clang')
1644 write_to_bazelrc('test --config=download_clang')
A. Unique TensorFlower73ea2872017-07-25 13:30:03 -07001645
Wen-Heng (Jack) Chung69d3b8f2018-06-22 23:09:43 -05001646 # SYCL / ROCm / CUDA are mutually exclusive.
1647 # At most 1 GPU platform can be configured.
1648 gpu_platform_count = 0
1649 if environ_cp.get('TF_NEED_OPENCL_SYCL') == '1':
1650 gpu_platform_count += 1
1651 if environ_cp.get('TF_NEED_ROCM') == '1':
1652 gpu_platform_count += 1
1653 if environ_cp.get('TF_NEED_CUDA') == '1':
1654 gpu_platform_count += 1
1655 if gpu_platform_count >= 2:
1656 raise UserInputError('SYCL / CUDA / ROCm are mututally exclusive. '
1657 'At most 1 GPU platform can be configured.')
1658
A. Unique TensorFlower73ea2872017-07-25 13:30:03 -07001659 set_build_var(environ_cp, 'TF_NEED_MPI', 'MPI', 'with_mpi_support', False)
1660 if environ_cp.get('TF_NEED_MPI') == '1':
1661 set_mpi_home(environ_cp)
1662 set_other_mpi_vars(environ_cp)
1663
1664 set_cc_opt_flags(environ_cp)
Yifei Feng5198cb82018-08-17 13:53:06 -07001665 set_system_libs_flag(environ_cp)
A. Unique TensorFlower1b212352018-07-19 13:48:50 -07001666 if is_windows():
1667 set_windows_build_flags(environ_cp)
A. Unique TensorFlower73ea2872017-07-25 13:30:03 -07001668
Anna Ra9a1d5a2018-09-14 12:44:31 -07001669 # Add a config option to build TensorFlow 2.0 API.
1670 write_to_bazelrc('build:v2 --define=tf_api_version=2')
1671
Gunhan Gulsoyffa90fc2018-09-26 01:38:55 -07001672 if get_var(environ_cp, 'TF_SET_ANDROID_WORKSPACE', 'android workspace', False,
1673 ('Would you like to interactively configure ./WORKSPACE for '
1674 'Android builds?'), 'Searching for NDK and SDK installations.',
1675 'Not configuring the WORKSPACE for Android builds.'):
Michael Case51053502018-06-05 17:47:19 -07001676 create_android_ndk_rule(environ_cp)
1677 create_android_sdk_rule(environ_cp)
Austin Anderson6afface2017-12-05 11:59:17 -08001678
Gunhan Gulsoy34370982018-10-12 15:26:01 -07001679 print('Preconfigured Bazel build configs. You can use any of the below by '
1680 'adding "--config=<>" to your build command. See .bazelrc for more '
1681 'details.')
1682 config_info_line('mkl', 'Build with MKL support.')
1683 config_info_line('monolithic', 'Config for mostly static monolithic build.')
1684 config_info_line('gdr', 'Build with GDR support.')
1685 config_info_line('verbs', 'Build with libverbs support.')
1686 config_info_line('ngraph', 'Build with Intel nGraph support.')
Gunhan Gulsoy594aae22018-10-18 14:48:00 -07001687 config_info_line('dynamic_kernels',
1688 '(Experimental) Build kernels into separate shared objects.')
Gunhan Gulsoy34370982018-10-12 15:26:01 -07001689
1690 print('Preconfigured Bazel build configs to DISABLE default on features:')
1691 config_info_line('noaws', 'Disable AWS S3 filesystem support.')
1692 config_info_line('nogcp', 'Disable GCP support.')
1693 config_info_line('nohdfs', 'Disable HDFS support.')
1694 config_info_line('noignite', 'Disable Apacha Ignite support.')
1695 config_info_line('nokafka', 'Disable Apache Kafka support.')
Gunhan Gulsoyeea81682018-11-26 16:51:23 -08001696 config_info_line('nonccl', 'Disable NVIDIA NCCL support.')
Austin Anderson6afface2017-12-05 11:59:17 -08001697
Gunhan Gulsoyffa90fc2018-09-26 01:38:55 -07001698
A. Unique TensorFlower73ea2872017-07-25 13:30:03 -07001699if __name__ == '__main__':
1700 main()