blob: c95b57fecd533597a75e21d05dd3044ae9dc7237 [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
Gunhan Gulsoyc59db932018-12-28 16:32:01 -080036_DEFAULT_CUDA_VERSION = '10.0'
Dandelion Man?90e42f32017-12-15 18:15:07 -080037_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 = ''
A. Unique TensorFlowered297342019-03-15 11:25:28 -070053_TF_CURRENT_BAZEL_VERSION = None
Shanqing Cai71445712018-03-12 19:33:52 -070054
Jason Furmanek7c234152018-09-26 04:44:12 +000055NCCL_LIB_PATHS = [
TensorFlower Gardenerea5c5292018-10-01 17:28:26 -070056 'lib64/', 'lib/powerpc64le-linux-gnu/', 'lib/x86_64-linux-gnu/', ''
Jason Furmanek7c234152018-09-26 04:44:12 +000057]
Austin Anderson6afface2017-12-05 11:59:17 -080058
A. Unique TensorFlower76e879d2019-03-22 00:25:36 -070059# List of files to configure when building Bazel on Apple platforms.
A. Unique TensorFlower93e70732019-02-14 16:45:32 -080060APPLE_BAZEL_FILES = [
A. Unique TensorFlower6a059c02019-04-05 14:28:27 -070061 'tensorflow/lite/experimental/ios/BUILD',
A. Unique TensorFlower93e70732019-02-14 16:45:32 -080062 'tensorflow/lite/experimental/objc/BUILD',
63 'tensorflow/lite/experimental/swift/BUILD'
64]
65
A. Unique TensorFlower76e879d2019-03-22 00:25:36 -070066# List of files to move when building for iOS.
67IOS_FILES = [
68 'tensorflow/lite/experimental/objc/TensorFlowLiteObjC.podspec',
69 'tensorflow/lite/experimental/swift/TensorFlowLiteSwift.podspec',
70]
71
Gunhan Gulsoyffa90fc2018-09-26 01:38:55 -070072if platform.machine() == 'ppc64le':
73 _DEFAULT_TENSORRT_PATH_LINUX = '/usr/lib/powerpc64le-linux-gnu/'
74else:
75 _DEFAULT_TENSORRT_PATH_LINUX = '/usr/lib/%s-linux-gnu' % platform.machine()
76
Austin Anderson6afface2017-12-05 11:59:17 -080077
78class UserInputError(Exception):
79 pass
A. Unique TensorFlower73ea2872017-07-25 13:30:03 -070080
81
82def is_windows():
83 return platform.system() == 'Windows'
84
85
86def is_linux():
87 return platform.system() == 'Linux'
88
89
90def is_macos():
91 return platform.system() == 'Darwin'
92
93
94def is_ppc64le():
95 return platform.machine() == 'ppc64le'
96
97
Jonathan Hseu008910f2017-08-25 14:01:05 -070098def is_cygwin():
99 return platform.system().startswith('CYGWIN_NT')
100
101
A. Unique TensorFlower73ea2872017-07-25 13:30:03 -0700102def get_input(question):
103 try:
104 try:
105 answer = raw_input(question)
106 except NameError:
107 answer = input(question) # pylint: disable=bad-builtin
108 except EOFError:
109 answer = ''
110 return answer
111
112
113def symlink_force(target, link_name):
114 """Force symlink, equivalent of 'ln -sf'.
115
116 Args:
117 target: items to link to.
118 link_name: name of the link.
119 """
120 try:
121 os.symlink(target, link_name)
122 except OSError as e:
123 if e.errno == errno.EEXIST:
124 os.remove(link_name)
125 os.symlink(target, link_name)
126 else:
127 raise e
128
129
130def sed_in_place(filename, old, new):
131 """Replace old string with new string in file.
132
133 Args:
134 filename: string for filename.
135 old: string to replace.
136 new: new string to replace to.
137 """
138 with open(filename, 'r') as f:
139 filedata = f.read()
140 newdata = filedata.replace(old, new)
141 with open(filename, 'w') as f:
142 f.write(newdata)
143
144
A. Unique TensorFlower73ea2872017-07-25 13:30:03 -0700145def write_to_bazelrc(line):
146 with open(_TF_BAZELRC, 'a') as f:
147 f.write(line + '\n')
148
149
150def write_action_env_to_bazelrc(var_name, var):
151 write_to_bazelrc('build --action_env %s="%s"' % (var_name, str(var)))
152
153
Jonathan Hseu008910f2017-08-25 14:01:05 -0700154def run_shell(cmd, allow_non_zero=False):
155 if allow_non_zero:
156 try:
157 output = subprocess.check_output(cmd)
158 except subprocess.CalledProcessError as e:
159 output = e.output
160 else:
161 output = subprocess.check_output(cmd)
162 return output.decode('UTF-8').strip()
A. Unique TensorFlower73ea2872017-07-25 13:30:03 -0700163
164
165def cygpath(path):
166 """Convert path from posix to windows."""
Martin Wicked57572e2017-09-02 19:21:45 -0700167 return os.path.abspath(path).replace('\\', '/')
A. Unique TensorFlower73ea2872017-07-25 13:30:03 -0700168
169
Andrew Harp6e3e7d12017-08-21 12:10:44 -0700170def get_python_path(environ_cp, python_bin_path):
A. Unique TensorFlower73ea2872017-07-25 13:30:03 -0700171 """Get the python site package paths."""
172 python_paths = []
173 if environ_cp.get('PYTHONPATH'):
174 python_paths = environ_cp.get('PYTHONPATH').split(':')
175 try:
Gunhan Gulsoyffa90fc2018-09-26 01:38:55 -0700176 library_paths = run_shell([
177 python_bin_path, '-c',
178 'import site; print("\\n".join(site.getsitepackages()))'
179 ]).split('\n')
Andrew Harp6e3e7d12017-08-21 12:10:44 -0700180 except subprocess.CalledProcessError:
Gunhan Gulsoyffa90fc2018-09-26 01:38:55 -0700181 library_paths = [
182 run_shell([
183 python_bin_path, '-c',
184 'from distutils.sysconfig import get_python_lib;'
185 'print(get_python_lib())'
186 ])
187 ]
Andrew Harp6e3e7d12017-08-21 12:10:44 -0700188
A. Unique TensorFlower73ea2872017-07-25 13:30:03 -0700189 all_paths = set(python_paths + library_paths)
190
191 paths = []
192 for path in all_paths:
193 if os.path.isdir(path):
194 paths.append(path)
195 return paths
196
197
Andrew Harp6e3e7d12017-08-21 12:10:44 -0700198def get_python_major_version(python_bin_path):
199 """Get the python major version."""
Jonathan Hseu008910f2017-08-25 14:01:05 -0700200 return run_shell([python_bin_path, '-c', 'import sys; print(sys.version[0])'])
Andrew Harp6e3e7d12017-08-21 12:10:44 -0700201
202
Gunhan Gulsoyed89a2b2017-09-19 18:36:26 -0700203def setup_python(environ_cp):
A. Unique TensorFlower73ea2872017-07-25 13:30:03 -0700204 """Setup python related env variables."""
205 # Get PYTHON_BIN_PATH, default is the current running python.
206 default_python_bin_path = sys.executable
207 ask_python_bin_path = ('Please specify the location of python. [Default is '
208 '%s]: ') % default_python_bin_path
209 while True:
A. Unique TensorFlower5001ac02019-04-03 11:59:08 -0700210 python_bin_path = get_from_env_or_user_or_default(environ_cp,
211 'PYTHON_BIN_PATH',
212 ask_python_bin_path,
213 default_python_bin_path)
A. Unique TensorFlower73ea2872017-07-25 13:30:03 -0700214 # Check if the path is valid
Gunhan Gulsoyffa90fc2018-09-26 01:38:55 -0700215 if os.path.isfile(python_bin_path) and os.access(python_bin_path, os.X_OK):
A. Unique TensorFlower73ea2872017-07-25 13:30:03 -0700216 break
217 elif not os.path.exists(python_bin_path):
218 print('Invalid python path: %s cannot be found.' % python_bin_path)
219 else:
220 print('%s is not executable. Is it the python binary?' % python_bin_path)
221 environ_cp['PYTHON_BIN_PATH'] = ''
222
Andrew Harp6e3e7d12017-08-21 12:10:44 -0700223 # Convert python path to Windows style before checking lib and version
Martin Wicked57572e2017-09-02 19:21:45 -0700224 if is_windows() or is_cygwin():
Andrew Harp6e3e7d12017-08-21 12:10:44 -0700225 python_bin_path = cygpath(python_bin_path)
226
A. Unique TensorFlower73ea2872017-07-25 13:30:03 -0700227 # Get PYTHON_LIB_PATH
228 python_lib_path = environ_cp.get('PYTHON_LIB_PATH')
229 if not python_lib_path:
Andrew Harp6e3e7d12017-08-21 12:10:44 -0700230 python_lib_paths = get_python_path(environ_cp, python_bin_path)
A. Unique TensorFlower73ea2872017-07-25 13:30:03 -0700231 if environ_cp.get('USE_DEFAULT_PYTHON_LIB_PATH') == '1':
Vijay Vasudevana1fba7f2017-07-28 10:58:56 -0700232 python_lib_path = python_lib_paths[0]
A. Unique TensorFlower73ea2872017-07-25 13:30:03 -0700233 else:
Jonathan Hseu008910f2017-08-25 14:01:05 -0700234 print('Found possible Python library paths:\n %s' %
235 '\n '.join(python_lib_paths))
A. Unique TensorFlower73ea2872017-07-25 13:30:03 -0700236 default_python_lib_path = python_lib_paths[0]
237 python_lib_path = get_input(
Jonathan Hseu008910f2017-08-25 14:01:05 -0700238 'Please input the desired Python library path to use. '
239 'Default is [%s]\n' % python_lib_paths[0])
A. Unique TensorFlower73ea2872017-07-25 13:30:03 -0700240 if not python_lib_path:
241 python_lib_path = default_python_lib_path
Vijay Vasudevana1fba7f2017-07-28 10:58:56 -0700242 environ_cp['PYTHON_LIB_PATH'] = python_lib_path
A. Unique TensorFlower73ea2872017-07-25 13:30:03 -0700243
TensorFlower Gardener61a87202018-10-01 12:25:39 -0700244 _ = get_python_major_version(python_bin_path)
Andrew Harp6e3e7d12017-08-21 12:10:44 -0700245
A. Unique TensorFlower73ea2872017-07-25 13:30:03 -0700246 # Convert python path to Windows style before writing into bazel.rc
Martin Wicked57572e2017-09-02 19:21:45 -0700247 if is_windows() or is_cygwin():
A. Unique TensorFlower73ea2872017-07-25 13:30:03 -0700248 python_lib_path = cygpath(python_lib_path)
249
250 # Set-up env variables used by python_configure.bzl
251 write_action_env_to_bazelrc('PYTHON_BIN_PATH', python_bin_path)
252 write_action_env_to_bazelrc('PYTHON_LIB_PATH', python_lib_path)
Gunhan Gulsoyed89a2b2017-09-19 18:36:26 -0700253 write_to_bazelrc('build --python_path=\"%s"' % python_bin_path)
A. Unique TensorFlower73ea2872017-07-25 13:30:03 -0700254 environ_cp['PYTHON_BIN_PATH'] = python_bin_path
255
William D. Ironsdcc76a52018-11-20 10:35:18 -0600256 # If choosen python_lib_path is from a path specified in the PYTHONPATH
257 # variable, need to tell bazel to include PYTHONPATH
258 if environ_cp.get('PYTHONPATH'):
259 python_paths = environ_cp.get('PYTHONPATH').split(':')
260 if python_lib_path in python_paths:
TensorFlower Gardener968cd182018-11-28 11:33:16 -0800261 write_action_env_to_bazelrc('PYTHONPATH', environ_cp.get('PYTHONPATH'))
William D. Ironsdcc76a52018-11-20 10:35:18 -0600262
A. Unique TensorFlower73ea2872017-07-25 13:30:03 -0700263 # Write tools/python_bin_path.sh
Gunhan Gulsoyffa90fc2018-09-26 01:38:55 -0700264 with open(
265 os.path.join(_TF_WORKSPACE_ROOT, 'tools', 'python_bin_path.sh'),
266 'w') as f:
A. Unique TensorFlower73ea2872017-07-25 13:30:03 -0700267 f.write('export PYTHON_BIN_PATH="%s"' % python_bin_path)
268
269
A. Unique TensorFlower7c5eb352018-10-01 07:15:23 -0700270def reset_tf_configure_bazelrc():
A. Unique TensorFlower73ea2872017-07-25 13:30:03 -0700271 """Reset file that contains customized config settings."""
272 open(_TF_BAZELRC, 'w').close()
A. Unique TensorFlower73ea2872017-07-25 13:30:03 -0700273
TensorFlower Gardenerabb763b2019-02-06 16:23:03 -0800274
A. Unique TensorFlower73ea2872017-07-25 13:30:03 -0700275def cleanup_makefile():
276 """Delete any leftover BUILD files from the Makefile build.
277
278 These files could interfere with Bazel parsing.
279 """
Gunhan Gulsoyffa90fc2018-09-26 01:38:55 -0700280 makefile_download_dir = os.path.join(_TF_WORKSPACE_ROOT, 'tensorflow',
281 'contrib', 'makefile', 'downloads')
A. Unique TensorFlower73ea2872017-07-25 13:30:03 -0700282 if os.path.isdir(makefile_download_dir):
283 for root, _, filenames in os.walk(makefile_download_dir):
284 for f in filenames:
285 if f.endswith('BUILD'):
286 os.remove(os.path.join(root, f))
287
288
289def get_var(environ_cp,
290 var_name,
291 query_item,
292 enabled_by_default,
293 question=None,
294 yes_reply=None,
295 no_reply=None):
296 """Get boolean input from user.
297
298 If var_name is not set in env, ask user to enable query_item or not. If the
299 response is empty, use the default.
300
301 Args:
302 environ_cp: copy of the os.environ.
303 var_name: string for name of environment variable, e.g. "TF_NEED_HDFS".
304 query_item: string for feature related to the variable, e.g. "Hadoop File
305 System".
306 enabled_by_default: boolean for default behavior.
307 question: optional string for how to ask for user input.
Michael Cased90054e2018-02-07 14:36:00 -0800308 yes_reply: optional string for reply when feature is enabled.
A. Unique TensorFlower73ea2872017-07-25 13:30:03 -0700309 no_reply: optional string for reply when feature is disabled.
310
311 Returns:
312 boolean value of the variable.
Frank Chenc4ef9272018-01-10 11:36:52 -0800313
314 Raises:
315 UserInputError: if an environment variable is set, but it cannot be
316 interpreted as a boolean indicator, assume that the user has made a
317 scripting error, and will continue to provide invalid input.
318 Raise the error to avoid infinitely looping.
A. Unique TensorFlower73ea2872017-07-25 13:30:03 -0700319 """
320 if not question:
321 question = 'Do you wish to build TensorFlow with %s support?' % query_item
322 if not yes_reply:
323 yes_reply = '%s support will be enabled for TensorFlow.' % query_item
324 if not no_reply:
325 no_reply = 'No %s' % yes_reply
326
327 yes_reply += '\n'
328 no_reply += '\n'
329
330 if enabled_by_default:
331 question += ' [Y/n]: '
332 else:
333 question += ' [y/N]: '
334
335 var = environ_cp.get(var_name)
Frank Chenc4ef9272018-01-10 11:36:52 -0800336 if var is not None:
337 var_content = var.strip().lower()
338 true_strings = ('1', 't', 'true', 'y', 'yes')
339 false_strings = ('0', 'f', 'false', 'n', 'no')
340 if var_content in true_strings:
341 var = True
342 elif var_content in false_strings:
343 var = False
344 else:
345 raise UserInputError(
346 'Environment variable %s must be set as a boolean indicator.\n'
347 'The following are accepted as TRUE : %s.\n'
348 'The following are accepted as FALSE: %s.\n'
A. Unique TensorFlowered297342019-03-15 11:25:28 -0700349 'Current value is %s.' %
350 (var_name, ', '.join(true_strings), ', '.join(false_strings), var))
Frank Chenc4ef9272018-01-10 11:36:52 -0800351
A. Unique TensorFlower73ea2872017-07-25 13:30:03 -0700352 while var is None:
353 user_input_origin = get_input(question)
354 user_input = user_input_origin.strip().lower()
355 if user_input == 'y':
356 print(yes_reply)
357 var = True
358 elif user_input == 'n':
359 print(no_reply)
360 var = False
361 elif not user_input:
362 if enabled_by_default:
363 print(yes_reply)
364 var = True
365 else:
366 print(no_reply)
367 var = False
368 else:
369 print('Invalid selection: %s' % user_input_origin)
370 return var
371
372
Gunhan Gulsoyffa90fc2018-09-26 01:38:55 -0700373def set_build_var(environ_cp,
374 var_name,
375 query_item,
376 option_name,
377 enabled_by_default,
378 bazel_config_name=None):
A. Unique TensorFlower73ea2872017-07-25 13:30:03 -0700379 """Set if query_item will be enabled for the build.
380
381 Ask user if query_item will be enabled. Default is used if no input is given.
382 Set subprocess environment variable and write to .bazelrc if enabled.
383
384 Args:
385 environ_cp: copy of the os.environ.
386 var_name: string for name of environment variable, e.g. "TF_NEED_HDFS".
387 query_item: string for feature related to the variable, e.g. "Hadoop File
388 System".
389 option_name: string for option to define in .bazelrc.
390 enabled_by_default: boolean for default behavior.
Michael Case98850a52017-09-14 13:35:57 -0700391 bazel_config_name: Name for Bazel --config argument to enable build feature.
A. Unique TensorFlower73ea2872017-07-25 13:30:03 -0700392 """
393
394 var = str(int(get_var(environ_cp, var_name, query_item, enabled_by_default)))
395 environ_cp[var_name] = var
396 if var == '1':
A. Unique TensorFlower5001ac02019-04-03 11:59:08 -0700397 write_to_bazelrc('build:%s --define %s=true' %
398 (bazel_config_name, option_name))
Yifei Fengec451f52018-10-05 12:53:50 -0700399 write_to_bazelrc('build --config=%s' % bazel_config_name)
Michael Case98850a52017-09-14 13:35:57 -0700400 elif bazel_config_name is not None:
401 # TODO(mikecase): Migrate all users of configure.py to use --config Bazel
402 # options and not to set build configs through environment variables.
A. Unique TensorFlower5001ac02019-04-03 11:59:08 -0700403 write_to_bazelrc('build:%s --define %s=true' %
404 (bazel_config_name, option_name))
A. Unique TensorFlower73ea2872017-07-25 13:30:03 -0700405
406
407def set_action_env_var(environ_cp,
408 var_name,
409 query_item,
410 enabled_by_default,
411 question=None,
412 yes_reply=None,
413 no_reply=None):
414 """Set boolean action_env variable.
415
416 Ask user if query_item will be enabled. Default is used if no input is given.
417 Set environment variable and write to .bazelrc.
418
419 Args:
420 environ_cp: copy of the os.environ.
421 var_name: string for name of environment variable, e.g. "TF_NEED_HDFS".
422 query_item: string for feature related to the variable, e.g. "Hadoop File
423 System".
424 enabled_by_default: boolean for default behavior.
425 question: optional string for how to ask for user input.
Michael Cased90054e2018-02-07 14:36:00 -0800426 yes_reply: optional string for reply when feature is enabled.
A. Unique TensorFlower73ea2872017-07-25 13:30:03 -0700427 no_reply: optional string for reply when feature is disabled.
428 """
429 var = int(
430 get_var(environ_cp, var_name, query_item, enabled_by_default, question,
431 yes_reply, no_reply))
432
433 write_action_env_to_bazelrc(var_name, var)
434 environ_cp[var_name] = str(var)
435
436
A. Unique TensorFlower6252d292017-08-04 00:52:34 -0700437def convert_version_to_int(version):
438 """Convert a version number to a integer that can be used to compare.
439
A. Unique TensorFlower28ce1d12017-08-15 12:08:29 -0700440 Version strings of the form X.YZ and X.Y.Z-xxxxx are supported. The
441 'xxxxx' part, for instance 'homebrew' on OS/X, is ignored.
442
A. Unique TensorFlower6252d292017-08-04 00:52:34 -0700443 Args:
A. Unique TensorFlower28ce1d12017-08-15 12:08:29 -0700444 version: a version to be converted
A. Unique TensorFlower6252d292017-08-04 00:52:34 -0700445
446 Returns:
447 An integer if converted successfully, otherwise return None.
448 """
A. Unique TensorFlower28ce1d12017-08-15 12:08:29 -0700449 version = version.split('-')[0]
A. Unique TensorFlower6252d292017-08-04 00:52:34 -0700450 version_segments = version.split('.')
Austin Anderson87ea41d2019-04-04 10:03:50 -0700451 # Treat "0.24" as "0.24.0"
452 if len(version_segments) == 2:
453 version_segments.append('0')
A. Unique TensorFlower6252d292017-08-04 00:52:34 -0700454 for seg in version_segments:
455 if not seg.isdigit():
456 return None
457
458 version_str = ''.join(['%03d' % int(seg) for seg in version_segments])
459 return int(version_str)
460
461
Mihai Maruseace7a123f2018-11-30 13:33:25 -0800462def check_bazel_version(min_version, max_version):
463 """Check installed bazel version is between min_version and max_version.
A. Unique TensorFlower73ea2872017-07-25 13:30:03 -0700464
465 Args:
466 min_version: string for minimum bazel version.
Mihai Maruseace7a123f2018-11-30 13:33:25 -0800467 max_version: string for maximum bazel version.
A. Unique TensorFlower6252d292017-08-04 00:52:34 -0700468
469 Returns:
470 The bazel version detected.
A. Unique TensorFlower73ea2872017-07-25 13:30:03 -0700471 """
Jonathan Hseu008910f2017-08-25 14:01:05 -0700472 if which('bazel') is None:
A. Unique TensorFlower73ea2872017-07-25 13:30:03 -0700473 print('Cannot find bazel. Please install bazel.')
474 sys.exit(0)
Gunhan Gulsoyffa90fc2018-09-26 01:38:55 -0700475 curr_version = run_shell(
476 ['bazel', '--batch', '--bazelrc=/dev/null', 'version'])
A. Unique TensorFlower73ea2872017-07-25 13:30:03 -0700477
478 for line in curr_version.split('\n'):
479 if 'Build label: ' in line:
480 curr_version = line.split('Build label: ')[1]
481 break
482
A. Unique TensorFlower6252d292017-08-04 00:52:34 -0700483 min_version_int = convert_version_to_int(min_version)
484 curr_version_int = convert_version_to_int(curr_version)
Mihai Maruseace7a123f2018-11-30 13:33:25 -0800485 max_version_int = convert_version_to_int(max_version)
A. Unique TensorFlower73ea2872017-07-25 13:30:03 -0700486
487 # Check if current bazel version can be detected properly.
A. Unique TensorFlower6252d292017-08-04 00:52:34 -0700488 if not curr_version_int:
489 print('WARNING: current bazel installation is not a release version.')
490 print('Make sure you are running at least bazel %s' % min_version)
491 return curr_version
A. Unique TensorFlower73ea2872017-07-25 13:30:03 -0700492
Michael Cased94271a2017-08-22 17:26:52 -0700493 print('You have bazel %s installed.' % curr_version)
A. Unique TensorFlower28ce1d12017-08-15 12:08:29 -0700494
A. Unique TensorFlower6252d292017-08-04 00:52:34 -0700495 if curr_version_int < min_version_int:
A. Unique TensorFlower73ea2872017-07-25 13:30:03 -0700496 print('Please upgrade your bazel installation to version %s or higher to '
497 'build TensorFlow!' % min_version)
Jason Zamanb41761c2018-10-14 11:28:53 +0800498 sys.exit(1)
TensorFlower Gardener78c246b2018-12-13 12:37:42 -0800499 if (curr_version_int > max_version_int and
500 'TF_IGNORE_MAX_BAZEL_VERSION' not in os.environ):
Mihai Maruseace7a123f2018-11-30 13:33:25 -0800501 print('Please downgrade your bazel installation to version %s or lower to '
Mihai Maruseace0963c42018-12-20 14:27:40 -0800502 'build TensorFlow! To downgrade: download the installer for the old '
503 'version (from https://github.com/bazelbuild/bazel/releases) then '
504 'run the installer.' % max_version)
Jason Zamanb41761c2018-10-14 11:28:53 +0800505 sys.exit(1)
A. Unique TensorFlower6252d292017-08-04 00:52:34 -0700506 return curr_version
A. Unique TensorFlower73ea2872017-07-25 13:30:03 -0700507
508
509def set_cc_opt_flags(environ_cp):
510 """Set up architecture-dependent optimization flags.
511
512 Also append CC optimization flags to bazel.rc..
513
514 Args:
515 environ_cp: copy of the os.environ.
516 """
517 if is_ppc64le():
518 # gcc on ppc64le does not support -march, use mcpu instead
519 default_cc_opt_flags = '-mcpu=native'
A. Unique TensorFlower1bba94a2018-04-04 15:45:20 -0700520 elif is_windows():
521 default_cc_opt_flags = '/arch:AVX'
A. Unique TensorFlower73ea2872017-07-25 13:30:03 -0700522 else:
Justin Lebar9ef04f52018-10-10 18:52:45 -0700523 default_cc_opt_flags = '-march=native -Wno-sign-compare'
A. Unique TensorFlower73ea2872017-07-25 13:30:03 -0700524 question = ('Please specify optimization flags to use during compilation when'
525 ' bazel option "--config=opt" is specified [Default is %s]: '
526 ) % default_cc_opt_flags
527 cc_opt_flags = get_from_env_or_user_or_default(environ_cp, 'CC_OPT_FLAGS',
528 question, default_cc_opt_flags)
529 for opt in cc_opt_flags.split():
Michael Case00177422017-11-10 13:14:03 -0800530 write_to_bazelrc('build:opt --copt=%s' % opt)
531 # It should be safe on the same build host.
A. Unique TensorFlower1bba94a2018-04-04 15:45:20 -0700532 if not is_ppc64le() and not is_windows():
Shanqing Cai71445712018-03-12 19:33:52 -0700533 write_to_bazelrc('build:opt --host_copt=-march=native')
Michael Casebb3355d2017-11-09 08:46:31 -0800534 write_to_bazelrc('build:opt --define with_default_optimizations=true')
A. Unique TensorFlower73ea2872017-07-25 13:30:03 -0700535
Gunhan Gulsoyffa90fc2018-09-26 01:38:55 -0700536
A. Unique TensorFlower73ea2872017-07-25 13:30:03 -0700537def set_tf_cuda_clang(environ_cp):
538 """set TF_CUDA_CLANG action_env.
539
540 Args:
541 environ_cp: copy of the os.environ.
542 """
543 question = 'Do you want to use clang as CUDA compiler?'
544 yes_reply = 'Clang will be used as CUDA compiler.'
545 no_reply = 'nvcc will be used as CUDA compiler.'
546 set_action_env_var(
547 environ_cp,
548 'TF_CUDA_CLANG',
549 None,
550 False,
551 question=question,
552 yes_reply=yes_reply,
553 no_reply=no_reply)
554
555
A. Unique TensorFlowerfd29e952017-12-22 03:07:51 -0800556def set_tf_download_clang(environ_cp):
557 """Set TF_DOWNLOAD_CLANG action_env."""
Ilya Biryukov9e651e42018-03-22 05:33:42 -0700558 question = 'Do you wish to download a fresh release of clang? (Experimental)'
A. Unique TensorFlowerfd29e952017-12-22 03:07:51 -0800559 yes_reply = 'Clang will be downloaded and used to compile tensorflow.'
560 no_reply = 'Clang will not be downloaded.'
561 set_action_env_var(
562 environ_cp,
563 'TF_DOWNLOAD_CLANG',
564 None,
565 False,
566 question=question,
567 yes_reply=yes_reply,
568 no_reply=no_reply)
569
570
A. Unique TensorFlower73ea2872017-07-25 13:30:03 -0700571def get_from_env_or_user_or_default(environ_cp, var_name, ask_for_var,
572 var_default):
573 """Get var_name either from env, or user or default.
574
575 If var_name has been set as environment variable, use the preset value, else
576 ask for user input. If no input is provided, the default is used.
577
578 Args:
579 environ_cp: copy of the os.environ.
580 var_name: string for name of environment variable, e.g. "TF_NEED_HDFS".
581 ask_for_var: string for how to ask for user input.
582 var_default: default value string.
583
584 Returns:
585 string value for var_name
586 """
587 var = environ_cp.get(var_name)
588 if not var:
589 var = get_input(ask_for_var)
Michael Cased94271a2017-08-22 17:26:52 -0700590 print('\n')
A. Unique TensorFlower73ea2872017-07-25 13:30:03 -0700591 if not var:
592 var = var_default
593 return var
594
595
596def set_clang_cuda_compiler_path(environ_cp):
597 """Set CLANG_CUDA_COMPILER_PATH."""
Jonathan Hseu008910f2017-08-25 14:01:05 -0700598 default_clang_path = which('clang') or ''
A. Unique TensorFlower73ea2872017-07-25 13:30:03 -0700599 ask_clang_path = ('Please specify which clang should be used as device and '
600 'host compiler. [Default is %s]: ') % default_clang_path
601
602 while True:
603 clang_cuda_compiler_path = get_from_env_or_user_or_default(
604 environ_cp, 'CLANG_CUDA_COMPILER_PATH', ask_clang_path,
605 default_clang_path)
606 if os.path.exists(clang_cuda_compiler_path):
607 break
608
609 # Reset and retry
610 print('Invalid clang path: %s cannot be found.' % clang_cuda_compiler_path)
611 environ_cp['CLANG_CUDA_COMPILER_PATH'] = ''
612
613 # Set CLANG_CUDA_COMPILER_PATH
614 environ_cp['CLANG_CUDA_COMPILER_PATH'] = clang_cuda_compiler_path
615 write_action_env_to_bazelrc('CLANG_CUDA_COMPILER_PATH',
616 clang_cuda_compiler_path)
617
618
Gunhan Gulsoyffa90fc2018-09-26 01:38:55 -0700619def prompt_loop_or_load_from_env(environ_cp,
620 var_name,
621 var_default,
622 ask_for_var,
623 check_success,
624 error_msg,
625 suppress_default_error=False,
626 n_ask_attempts=_DEFAULT_PROMPT_ASK_ATTEMPTS):
Austin Anderson6afface2017-12-05 11:59:17 -0800627 """Loop over user prompts for an ENV param until receiving a valid response.
628
629 For the env param var_name, read from the environment or verify user input
630 until receiving valid input. When done, set var_name in the environ_cp to its
631 new value.
632
633 Args:
634 environ_cp: (Dict) copy of the os.environ.
635 var_name: (String) string for name of environment variable, e.g. "TF_MYVAR".
636 var_default: (String) default value string.
637 ask_for_var: (String) string for how to ask for user input.
638 check_success: (Function) function that takes one argument and returns a
639 boolean. Should return True if the value provided is considered valid. May
640 contain a complex error message if error_msg does not provide enough
641 information. In that case, set suppress_default_error to True.
642 error_msg: (String) String with one and only one '%s'. Formatted with each
643 invalid response upon check_success(input) failure.
644 suppress_default_error: (Bool) Suppress the above error message in favor of
645 one from the check_success function.
646 n_ask_attempts: (Integer) Number of times to query for valid input before
647 raising an error and quitting.
648
649 Returns:
650 [String] The value of var_name after querying for input.
651
652 Raises:
653 UserInputError: if a query has been attempted n_ask_attempts times without
Frank Chenc4ef9272018-01-10 11:36:52 -0800654 success, assume that the user has made a scripting error, and will
655 continue to provide invalid input. Raise the error to avoid infinitely
656 looping.
Austin Anderson6afface2017-12-05 11:59:17 -0800657 """
658 default = environ_cp.get(var_name) or var_default
659 full_query = '%s [Default is %s]: ' % (
660 ask_for_var,
661 default,
662 )
663
664 for _ in range(n_ask_attempts):
Gunhan Gulsoyffa90fc2018-09-26 01:38:55 -0700665 val = get_from_env_or_user_or_default(environ_cp, var_name, full_query,
Austin Anderson6afface2017-12-05 11:59:17 -0800666 default)
667 if check_success(val):
668 break
669 if not suppress_default_error:
670 print(error_msg % val)
671 environ_cp[var_name] = ''
672 else:
A. Unique TensorFlower5001ac02019-04-03 11:59:08 -0700673 raise UserInputError('Invalid %s setting was provided %d times in a row. '
674 'Assuming to be a scripting mistake.' %
675 (var_name, n_ask_attempts))
Austin Anderson6afface2017-12-05 11:59:17 -0800676
677 environ_cp[var_name] = val
678 return val
679
680
681def create_android_ndk_rule(environ_cp):
682 """Set ANDROID_NDK_HOME and write Android NDK WORKSPACE rule."""
683 if is_windows() or is_cygwin():
A. Unique TensorFlower5001ac02019-04-03 11:59:08 -0700684 default_ndk_path = cygpath('%s/Android/Sdk/ndk-bundle' %
685 environ_cp['APPDATA'])
Austin Anderson6afface2017-12-05 11:59:17 -0800686 elif is_macos():
687 default_ndk_path = '%s/library/Android/Sdk/ndk-bundle' % environ_cp['HOME']
688 else:
689 default_ndk_path = '%s/Android/Sdk/ndk-bundle' % environ_cp['HOME']
690
691 def valid_ndk_path(path):
692 return (os.path.exists(path) and
693 os.path.exists(os.path.join(path, 'source.properties')))
694
695 android_ndk_home_path = prompt_loop_or_load_from_env(
696 environ_cp,
697 var_name='ANDROID_NDK_HOME',
698 var_default=default_ndk_path,
699 ask_for_var='Please specify the home path of the Android NDK to use.',
700 check_success=valid_ndk_path,
701 error_msg=('The path %s or its child file "source.properties" '
Gunhan Gulsoyffa90fc2018-09-26 01:38:55 -0700702 'does not exist.'))
Michael Case51053502018-06-05 17:47:19 -0700703 write_action_env_to_bazelrc('ANDROID_NDK_HOME', android_ndk_home_path)
Jared Dukea0104b72019-04-04 12:23:58 -0700704 write_action_env_to_bazelrc(
705 'ANDROID_NDK_API_LEVEL',
706 get_ndk_api_level(environ_cp, android_ndk_home_path))
Austin Anderson6afface2017-12-05 11:59:17 -0800707
708
709def create_android_sdk_rule(environ_cp):
710 """Set Android variables and write Android SDK WORKSPACE rule."""
711 if is_windows() or is_cygwin():
712 default_sdk_path = cygpath('%s/Android/Sdk' % environ_cp['APPDATA'])
713 elif is_macos():
Shashi Shekharc0ff0cc2018-07-17 09:00:24 -0700714 default_sdk_path = '%s/library/Android/Sdk' % environ_cp['HOME']
Austin Anderson6afface2017-12-05 11:59:17 -0800715 else:
716 default_sdk_path = '%s/Android/Sdk' % environ_cp['HOME']
717
718 def valid_sdk_path(path):
719 return (os.path.exists(path) and
720 os.path.exists(os.path.join(path, 'platforms')) and
721 os.path.exists(os.path.join(path, 'build-tools')))
722
723 android_sdk_home_path = prompt_loop_or_load_from_env(
724 environ_cp,
725 var_name='ANDROID_SDK_HOME',
726 var_default=default_sdk_path,
727 ask_for_var='Please specify the home path of the Android SDK to use.',
728 check_success=valid_sdk_path,
729 error_msg=('Either %s does not exist, or it does not contain the '
730 'subdirectories "platforms" and "build-tools".'))
731
732 platforms = os.path.join(android_sdk_home_path, 'platforms')
733 api_levels = sorted(os.listdir(platforms))
734 api_levels = [x.replace('android-', '') for x in api_levels]
735
736 def valid_api_level(api_level):
Gunhan Gulsoyffa90fc2018-09-26 01:38:55 -0700737 return os.path.exists(
738 os.path.join(android_sdk_home_path, 'platforms',
739 'android-' + api_level))
Austin Anderson6afface2017-12-05 11:59:17 -0800740
741 android_api_level = prompt_loop_or_load_from_env(
742 environ_cp,
743 var_name='ANDROID_API_LEVEL',
744 var_default=api_levels[-1],
745 ask_for_var=('Please specify the Android SDK API level to use. '
746 '[Available levels: %s]') % api_levels,
747 check_success=valid_api_level,
748 error_msg='Android-%s is not present in the SDK path.')
749
750 build_tools = os.path.join(android_sdk_home_path, 'build-tools')
751 versions = sorted(os.listdir(build_tools))
752
753 def valid_build_tools(version):
Gunhan Gulsoyffa90fc2018-09-26 01:38:55 -0700754 return os.path.exists(
755 os.path.join(android_sdk_home_path, 'build-tools', version))
Austin Anderson6afface2017-12-05 11:59:17 -0800756
757 android_build_tools_version = prompt_loop_or_load_from_env(
758 environ_cp,
759 var_name='ANDROID_BUILD_TOOLS_VERSION',
760 var_default=versions[-1],
761 ask_for_var=('Please specify an Android build tools version to use. '
762 '[Available versions: %s]') % versions,
763 check_success=valid_build_tools,
764 error_msg=('The selected SDK does not have build-tools version %s '
765 'available.'))
766
Michael Case51053502018-06-05 17:47:19 -0700767 write_action_env_to_bazelrc('ANDROID_BUILD_TOOLS_VERSION',
768 android_build_tools_version)
Gunhan Gulsoyffa90fc2018-09-26 01:38:55 -0700769 write_action_env_to_bazelrc('ANDROID_SDK_API_LEVEL', android_api_level)
770 write_action_env_to_bazelrc('ANDROID_SDK_HOME', android_sdk_home_path)
Austin Anderson6afface2017-12-05 11:59:17 -0800771
772
Jared Dukea0104b72019-04-04 12:23:58 -0700773def get_ndk_api_level(environ_cp, android_ndk_home_path):
774 """Gets the appropriate NDK API level to use for the provided Android NDK path."""
775
776 # First check to see if we're using a blessed version of the NDK.
Austin Anderson6afface2017-12-05 11:59:17 -0800777 properties_path = '%s/source.properties' % android_ndk_home_path
778 if is_windows() or is_cygwin():
779 properties_path = cygpath(properties_path)
780 with open(properties_path, 'r') as f:
781 filedata = f.read()
782
783 revision = re.search(r'Pkg.Revision = (\d+)', filedata)
784 if revision:
Jared Dukea0104b72019-04-04 12:23:58 -0700785 ndk_version = revision.group(1)
Michael Case51053502018-06-05 17:47:19 -0700786 else:
787 raise Exception('Unable to parse NDK revision.')
Jared Dukea0104b72019-04-04 12:23:58 -0700788 if int(ndk_version) not in _SUPPORTED_ANDROID_NDK_VERSIONS:
789 print('WARNING: The NDK version in %s is %s, which is not '
790 'supported by Bazel (officially supported versions: %s). Please use '
791 'another version. Compiling Android targets may result in confusing '
792 'errors.\n' % (android_ndk_home_path, ndk_version,
793 _SUPPORTED_ANDROID_NDK_VERSIONS))
794
795 # Now grab the NDK API level to use. Note that this is different from the
796 # SDK API level, as the NDK API level is effectively the *min* target SDK
797 # version.
798 platforms = os.path.join(android_ndk_home_path, 'platforms')
799 api_levels = sorted(os.listdir(platforms))
800 api_levels = [
801 x.replace('android-', '') for x in api_levels if 'android-' in x
802 ]
803
804 def valid_api_level(api_level):
805 return os.path.exists(
806 os.path.join(android_ndk_home_path, 'platforms',
807 'android-' + api_level))
808
809 android_ndk_api_level = prompt_loop_or_load_from_env(
810 environ_cp,
811 var_name='ANDROID_NDK_API_LEVEL',
812 var_default='18', # 18 is required for GPU acceleration.
813 ask_for_var=('Please specify the (min) Android NDK API level to use. '
814 '[Available levels: %s]') % api_levels,
815 check_success=valid_api_level,
816 error_msg='Android-%s is not present in the NDK path.')
817
818 return android_ndk_api_level
Austin Anderson6afface2017-12-05 11:59:17 -0800819
820
A. Unique TensorFlower73ea2872017-07-25 13:30:03 -0700821def set_gcc_host_compiler_path(environ_cp):
822 """Set GCC_HOST_COMPILER_PATH."""
Jonathan Hseu008910f2017-08-25 14:01:05 -0700823 default_gcc_host_compiler_path = which('gcc') or ''
A. Unique TensorFlower73ea2872017-07-25 13:30:03 -0700824 cuda_bin_symlink = '%s/bin/gcc' % environ_cp.get('CUDA_TOOLKIT_PATH')
825
826 if os.path.islink(cuda_bin_symlink):
827 # os.readlink is only available in linux
Jonathan Hseu008910f2017-08-25 14:01:05 -0700828 default_gcc_host_compiler_path = os.path.realpath(cuda_bin_symlink)
A. Unique TensorFlower73ea2872017-07-25 13:30:03 -0700829
Austin Anderson6afface2017-12-05 11:59:17 -0800830 gcc_host_compiler_path = prompt_loop_or_load_from_env(
831 environ_cp,
832 var_name='GCC_HOST_COMPILER_PATH',
833 var_default=default_gcc_host_compiler_path,
TensorFlower Gardenerabb763b2019-02-06 16:23:03 -0800834 ask_for_var='Please specify which gcc should be used by nvcc as the host compiler.',
Austin Anderson6afface2017-12-05 11:59:17 -0800835 check_success=os.path.exists,
836 error_msg='Invalid gcc path. %s cannot be found.',
837 )
A. Unique TensorFlower73ea2872017-07-25 13:30:03 -0700838
A. Unique TensorFlower73ea2872017-07-25 13:30:03 -0700839 write_action_env_to_bazelrc('GCC_HOST_COMPILER_PATH', gcc_host_compiler_path)
840
841
Ankur Taly0e6f39d2018-02-16 18:22:55 -0800842def reformat_version_sequence(version_str, sequence_count):
843 """Reformat the version string to have the given number of sequences.
844
845 For example:
846 Given (7, 2) -> 7.0
847 (7.0.1, 2) -> 7.0
848 (5, 1) -> 5
849 (5.0.3.2, 1) -> 5
850
851 Args:
852 version_str: String, the version string.
853 sequence_count: int, an integer.
Gunhan Gulsoyffa90fc2018-09-26 01:38:55 -0700854
Ankur Taly0e6f39d2018-02-16 18:22:55 -0800855 Returns:
856 string, reformatted version string.
857 """
858 v = version_str.split('.')
859 if len(v) < sequence_count:
860 v = v + (['0'] * (sequence_count - len(v)))
861
862 return '.'.join(v[:sequence_count])
863
864
A. Unique TensorFlower8e9ca662019-04-15 12:47:11 -0700865def set_tf_cuda_paths(environ_cp):
866 """Set TF_CUDA_PATHS."""
867 ask_cuda_paths = (
868 'Please specify the comma-separated list of base paths to look for CUDA '
869 'libraries and headers. [Leave empty to use the default]: '
870 )
871 tf_cuda_paths = get_from_env_or_user_or_default(environ_cp, 'TF_CUDA_PATHS',
872 ask_cuda_paths,
873 '')
874 if tf_cuda_paths:
875 environ_cp['TF_CUDA_PATHS'] = tf_cuda_paths
876
877
A. Unique TensorFlower73ea2872017-07-25 13:30:03 -0700878def set_tf_cuda_version(environ_cp):
A. Unique TensorFlower8e9ca662019-04-15 12:47:11 -0700879 """Set TF_CUDA_VERSION."""
A. Unique TensorFlower73ea2872017-07-25 13:30:03 -0700880 ask_cuda_version = (
A. Unique TensorFlowerb15500b2018-05-08 12:04:38 -0700881 'Please specify the CUDA SDK version you want to use. '
882 '[Leave empty to default to CUDA %s]: ') % _DEFAULT_CUDA_VERSION
A. Unique TensorFlower8e9ca662019-04-15 12:47:11 -0700883 tf_cuda_version = get_from_env_or_user_or_default(environ_cp,
884 'TF_CUDA_VERSION',
885 ask_cuda_version,
886 _DEFAULT_CUDA_VERSION)
A. Unique TensorFlower73ea2872017-07-25 13:30:03 -0700887 environ_cp['TF_CUDA_VERSION'] = tf_cuda_version
A. Unique TensorFlower73ea2872017-07-25 13:30:03 -0700888
889
Yifei Fengb1d8c592017-11-22 13:42:21 -0800890def set_tf_cudnn_version(environ_cp):
A. Unique TensorFlower8e9ca662019-04-15 12:47:11 -0700891 """Set TF_CUDNN_VERSION."""
A. Unique TensorFlower73ea2872017-07-25 13:30:03 -0700892 ask_cudnn_version = (
Jonathan Hseu008910f2017-08-25 14:01:05 -0700893 'Please specify the cuDNN version you want to use. '
A. Unique TensorFlower44acd832018-10-01 13:42:40 -0700894 '[Leave empty to default to cuDNN %s]: ') % _DEFAULT_CUDNN_VERSION
A. Unique TensorFlower8e9ca662019-04-15 12:47:11 -0700895 tf_cudnn_version = get_from_env_or_user_or_default(environ_cp,
896 'TF_CUDNN_VERSION',
897 ask_cudnn_version,
898 _DEFAULT_CUDNN_VERSION)
A. Unique TensorFlower73ea2872017-07-25 13:30:03 -0700899 environ_cp['TF_CUDNN_VERSION'] = tf_cudnn_version
A. Unique TensorFlower73ea2872017-07-25 13:30:03 -0700900
901
Mingxing Tan1e7b0e42018-06-28 19:13:20 -0700902def is_cuda_compatible(lib, cuda_ver, cudnn_ver):
903 """Check compatibility between given library and cudnn/cudart libraries."""
904 ldd_bin = which('ldd') or '/usr/bin/ldd'
905 ldd_out = run_shell([ldd_bin, lib], True)
906 ldd_out = ldd_out.split(os.linesep)
907 cudnn_pattern = re.compile('.*libcudnn.so\\.?(.*) =>.*$')
908 cuda_pattern = re.compile('.*libcudart.so\\.?(.*) =>.*$')
909 cudnn = None
910 cudart = None
911 cudnn_ok = True # assume no cudnn dependency by default
912 cuda_ok = True # assume no cuda dependency by default
913 for line in ldd_out:
914 if 'libcudnn.so' in line:
915 cudnn = cudnn_pattern.search(line)
916 cudnn_ok = False
917 elif 'libcudart.so' in line:
918 cudart = cuda_pattern.search(line)
919 cuda_ok = False
920 if cudnn and len(cudnn.group(1)):
921 cudnn = convert_version_to_int(cudnn.group(1))
922 if cudart and len(cudart.group(1)):
923 cudart = convert_version_to_int(cudart.group(1))
924 if cudnn is not None:
925 cudnn_ok = (cudnn == cudnn_ver)
926 if cudart is not None:
927 cuda_ok = (cudart == cuda_ver)
928 return cudnn_ok and cuda_ok
929
930
A. Unique TensorFlower8e9ca662019-04-15 12:47:11 -0700931def set_tf_tensorrt_version(environ_cp):
932 """Set TF_TENSORRT_VERSION."""
Guangda Lai76f69382018-01-25 23:59:19 -0800933 if not is_linux():
934 raise ValueError('Currently TensorRT is only supported on Linux platform.')
935
A. Unique TensorFlower8e9ca662019-04-15 12:47:11 -0700936 # Backwards compatibility: early-out when TF_NEED_TENSORRT=0.
Mingxing Tan1e7b0e42018-06-28 19:13:20 -0700937 if str(int(get_var(environ_cp, 'TF_NEED_TENSORRT', 'TensorRT',
938 False))) != '1':
Guangda Lai76f69382018-01-25 23:59:19 -0800939 return
940
A. Unique TensorFlower8e9ca662019-04-15 12:47:11 -0700941 ask_tensorrt_version = (
942 'Please specify the TensorRT version you want to use. '
943 '[Leave empty to not use a specific version]: ')
944 tf_tensorrt_version = get_from_env_or_user_or_default(environ_cp,
945 'TF_TENSORRT_VERSION',
946 ask_tensorrt_version,
947 '')
Guangda Lai76f69382018-01-25 23:59:19 -0800948 environ_cp['TF_TENSORRT_VERSION'] = tf_tensorrt_version
Guangda Lai76f69382018-01-25 23:59:19 -0800949
950
A. Unique TensorFlower8e9ca662019-04-15 12:47:11 -0700951def set_tf_nccl_version(environ_cp):
952 """Set TF_NCCL_VERSION."""
A. Unique TensorFlower1fda7642018-04-05 03:09:27 -0700953 if not is_linux():
A. Unique TensorFlower8e9ca662019-04-15 12:47:11 -0700954 raise ValueError('Currently NCCL is only supported on Linux platform.')
A. Unique TensorFlower1fda7642018-04-05 03:09:27 -0700955
956 ask_nccl_version = (
A. Unique TensorFlower53faa312018-10-05 08:46:54 -0700957 'Please specify the locally installed NCCL version you want to use. '
A. Unique TensorFlower8e9ca662019-04-15 12:47:11 -0700958 '[Leave empty to use https://github.com/nvidia/nccl]: ')
959 tf_nccl_version = get_from_env_or_user_or_default(environ_cp,
960 'TF_NCCL_VERSION',
961 ask_nccl_version, '')
A. Unique TensorFlower1fda7642018-04-05 03:09:27 -0700962 environ_cp['TF_NCCL_VERSION'] = tf_nccl_version
TensorFlower Gardenerabb763b2019-02-06 16:23:03 -0800963
A. Unique TensorFlower73ea2872017-07-25 13:30:03 -0700964def get_native_cuda_compute_capabilities(environ_cp):
965 """Get native cuda compute capabilities.
966
967 Args:
968 environ_cp: copy of the os.environ.
Gunhan Gulsoyffa90fc2018-09-26 01:38:55 -0700969
A. Unique TensorFlower73ea2872017-07-25 13:30:03 -0700970 Returns:
971 string of native cuda compute capabilities, separated by comma.
972 """
973 device_query_bin = os.path.join(
974 environ_cp.get('CUDA_TOOLKIT_PATH'), 'extras/demo_suite/deviceQuery')
Jonathan Hseu008910f2017-08-25 14:01:05 -0700975 if os.path.isfile(device_query_bin) and os.access(device_query_bin, os.X_OK):
976 try:
977 output = run_shell(device_query_bin).split('\n')
978 pattern = re.compile('[0-9]*\\.[0-9]*')
979 output = [pattern.search(x) for x in output if 'Capability' in x]
980 output = ','.join(x.group() for x in output if x is not None)
981 except subprocess.CalledProcessError:
982 output = ''
983 else:
A. Unique TensorFlower73ea2872017-07-25 13:30:03 -0700984 output = ''
985 return output
986
987
988def set_tf_cuda_compute_capabilities(environ_cp):
989 """Set TF_CUDA_COMPUTE_CAPABILITIES."""
990 while True:
991 native_cuda_compute_capabilities = get_native_cuda_compute_capabilities(
992 environ_cp)
993 if not native_cuda_compute_capabilities:
994 default_cuda_compute_capabilities = _DEFAULT_CUDA_COMPUTE_CAPABILITIES
995 else:
996 default_cuda_compute_capabilities = native_cuda_compute_capabilities
997
998 ask_cuda_compute_capabilities = (
999 'Please specify a list of comma-separated '
P Sudeepam52093562019-02-17 17:34:01 +05301000 'CUDA compute capabilities you want to '
A. Unique TensorFlower73ea2872017-07-25 13:30:03 -07001001 'build with.\nYou can find the compute '
1002 'capability of your device at: '
1003 'https://developer.nvidia.com/cuda-gpus.\nPlease'
1004 ' note that each additional compute '
1005 'capability significantly increases your '
P Sudeepam52093562019-02-17 17:34:01 +05301006 'build time and binary size, and that '
1007 'TensorFlow only supports compute '
P Sudeepam765ceda2019-02-17 17:39:08 +05301008 'capabilities >= 3.5 [Default is: %s]: ' %
A. Unique TensorFlower73ea2872017-07-25 13:30:03 -07001009 default_cuda_compute_capabilities)
1010 tf_cuda_compute_capabilities = get_from_env_or_user_or_default(
1011 environ_cp, 'TF_CUDA_COMPUTE_CAPABILITIES',
1012 ask_cuda_compute_capabilities, default_cuda_compute_capabilities)
1013 # Check whether all capabilities from the input is valid
1014 all_valid = True
Maciejd0f5bc12018-04-30 22:30:58 -05001015 # Remove all whitespace characters before splitting the string
Michael Case51053502018-06-05 17:47:19 -07001016 # that users may insert by accident, as this will result in error
Maciejd0f5bc12018-04-30 22:30:58 -05001017 tf_cuda_compute_capabilities = ''.join(tf_cuda_compute_capabilities.split())
A. Unique TensorFlower73ea2872017-07-25 13:30:03 -07001018 for compute_capability in tf_cuda_compute_capabilities.split(','):
Andrew Harp6e3e7d12017-08-21 12:10:44 -07001019 m = re.match('[0-9]+.[0-9]+', compute_capability)
1020 if not m:
Austin Anderson32202dc2019-02-19 10:46:27 -08001021 print('Invalid compute capability: %s' % compute_capability)
A. Unique TensorFlower73ea2872017-07-25 13:30:03 -07001022 all_valid = False
Andrew Harp6e3e7d12017-08-21 12:10:44 -07001023 else:
P Sudeepam52093562019-02-17 17:34:01 +05301024 ver = float(m.group(0))
A. Unique TensorFlower8dc2d0e2019-03-12 01:41:05 -07001025 if ver < 3.0:
1026 print('ERROR: TensorFlow only supports CUDA compute capabilities 3.0 '
Austin Anderson32202dc2019-02-19 10:46:27 -08001027 'and higher. Please re-specify the list of compute '
1028 'capabilities excluding version %s.' % ver)
Andrew Harp6e3e7d12017-08-21 12:10:44 -07001029 all_valid = False
A. Unique TensorFlower8dc2d0e2019-03-12 01:41:05 -07001030 if ver < 3.5:
1031 print('WARNING: XLA does not support CUDA compute capabilities '
1032 'lower than 3.5. Disable XLA when running on older GPUs.')
P Sudeepam765ceda2019-02-17 17:39:08 +05301033
A. Unique TensorFlower73ea2872017-07-25 13:30:03 -07001034 if all_valid:
1035 break
1036
1037 # Reset and Retry
1038 environ_cp['TF_CUDA_COMPUTE_CAPABILITIES'] = ''
1039
1040 # Set TF_CUDA_COMPUTE_CAPABILITIES
1041 environ_cp['TF_CUDA_COMPUTE_CAPABILITIES'] = tf_cuda_compute_capabilities
1042 write_action_env_to_bazelrc('TF_CUDA_COMPUTE_CAPABILITIES',
1043 tf_cuda_compute_capabilities)
1044
1045
1046def set_other_cuda_vars(environ_cp):
1047 """Set other CUDA related variables."""
A. Unique TensorFlowerab391982018-07-11 04:52:49 -07001048 # If CUDA is enabled, always use GPU during build and test.
1049 if environ_cp.get('TF_CUDA_CLANG') == '1':
1050 write_to_bazelrc('build --config=cuda_clang')
1051 write_to_bazelrc('test --config=cuda_clang')
A. Unique TensorFlower73ea2872017-07-25 13:30:03 -07001052 else:
A. Unique TensorFlowerab391982018-07-11 04:52:49 -07001053 write_to_bazelrc('build --config=cuda')
1054 write_to_bazelrc('test --config=cuda')
A. Unique TensorFlower73ea2872017-07-25 13:30:03 -07001055
1056
1057def set_host_cxx_compiler(environ_cp):
1058 """Set HOST_CXX_COMPILER."""
Jonathan Hseu008910f2017-08-25 14:01:05 -07001059 default_cxx_host_compiler = which('g++') or ''
A. Unique TensorFlower73ea2872017-07-25 13:30:03 -07001060
Austin Anderson6afface2017-12-05 11:59:17 -08001061 host_cxx_compiler = prompt_loop_or_load_from_env(
1062 environ_cp,
1063 var_name='HOST_CXX_COMPILER',
1064 var_default=default_cxx_host_compiler,
1065 ask_for_var=('Please specify which C++ compiler should be used as the '
1066 'host C++ compiler.'),
1067 check_success=os.path.exists,
1068 error_msg='Invalid C++ compiler path. %s cannot be found.',
1069 )
A. Unique TensorFlower73ea2872017-07-25 13:30:03 -07001070
A. Unique TensorFlower73ea2872017-07-25 13:30:03 -07001071 write_action_env_to_bazelrc('HOST_CXX_COMPILER', host_cxx_compiler)
1072
1073
1074def set_host_c_compiler(environ_cp):
1075 """Set HOST_C_COMPILER."""
Jonathan Hseu008910f2017-08-25 14:01:05 -07001076 default_c_host_compiler = which('gcc') or ''
A. Unique TensorFlower73ea2872017-07-25 13:30:03 -07001077
Austin Anderson6afface2017-12-05 11:59:17 -08001078 host_c_compiler = prompt_loop_or_load_from_env(
1079 environ_cp,
1080 var_name='HOST_C_COMPILER',
1081 var_default=default_c_host_compiler,
Shanqing Cai71445712018-03-12 19:33:52 -07001082 ask_for_var=('Please specify which C compiler should be used as the host '
Austin Anderson6afface2017-12-05 11:59:17 -08001083 'C compiler.'),
1084 check_success=os.path.exists,
1085 error_msg='Invalid C compiler path. %s cannot be found.',
1086 )
A. Unique TensorFlower73ea2872017-07-25 13:30:03 -07001087
A. Unique TensorFlower73ea2872017-07-25 13:30:03 -07001088 write_action_env_to_bazelrc('HOST_C_COMPILER', host_c_compiler)
1089
1090
1091def set_computecpp_toolkit_path(environ_cp):
1092 """Set COMPUTECPP_TOOLKIT_PATH."""
A. Unique TensorFlower73ea2872017-07-25 13:30:03 -07001093
Austin Anderson6afface2017-12-05 11:59:17 -08001094 def toolkit_exists(toolkit_path):
1095 """Check if a computecpp toolkit path is valid."""
A. Unique TensorFlower73ea2872017-07-25 13:30:03 -07001096 if is_linux():
1097 sycl_rt_lib_path = 'lib/libComputeCpp.so'
1098 else:
1099 sycl_rt_lib_path = ''
1100
Gunhan Gulsoyffa90fc2018-09-26 01:38:55 -07001101 sycl_rt_lib_path_full = os.path.join(toolkit_path, sycl_rt_lib_path)
Austin Anderson6afface2017-12-05 11:59:17 -08001102 exists = os.path.exists(sycl_rt_lib_path_full)
1103 if not exists:
1104 print('Invalid SYCL %s library path. %s cannot be found' %
1105 (_TF_OPENCL_VERSION, sycl_rt_lib_path_full))
1106 return exists
A. Unique TensorFlower73ea2872017-07-25 13:30:03 -07001107
Austin Anderson6afface2017-12-05 11:59:17 -08001108 computecpp_toolkit_path = prompt_loop_or_load_from_env(
1109 environ_cp,
1110 var_name='COMPUTECPP_TOOLKIT_PATH',
1111 var_default=_DEFAULT_COMPUTECPP_TOOLKIT_PATH,
1112 ask_for_var=(
1113 'Please specify the location where ComputeCpp for SYCL %s is '
1114 'installed.' % _TF_OPENCL_VERSION),
1115 check_success=toolkit_exists,
1116 error_msg='Invalid SYCL compiler path. %s cannot be found.',
1117 suppress_default_error=True)
A. Unique TensorFlower73ea2872017-07-25 13:30:03 -07001118
A. Unique TensorFlower73ea2872017-07-25 13:30:03 -07001119 write_action_env_to_bazelrc('COMPUTECPP_TOOLKIT_PATH',
1120 computecpp_toolkit_path)
1121
Michael Cased31531a2018-01-05 14:09:41 -08001122
Dandelion Man?90e42f32017-12-15 18:15:07 -08001123def set_trisycl_include_dir(environ_cp):
Michael Cased31531a2018-01-05 14:09:41 -08001124 """Set TRISYCL_INCLUDE_DIR."""
Frank Chenc4ef9272018-01-10 11:36:52 -08001125
Dandelion Man?90e42f32017-12-15 18:15:07 -08001126 ask_trisycl_include_dir = ('Please specify the location of the triSYCL '
1127 'include directory. (Use --config=sycl_trisycl '
1128 'when building with Bazel) '
Gunhan Gulsoyffa90fc2018-09-26 01:38:55 -07001129 '[Default is %s]: ') % (
1130 _DEFAULT_TRISYCL_INCLUDE_DIR)
Frank Chenc4ef9272018-01-10 11:36:52 -08001131
Dandelion Man?90e42f32017-12-15 18:15:07 -08001132 while True:
1133 trisycl_include_dir = get_from_env_or_user_or_default(
Michael Cased31531a2018-01-05 14:09:41 -08001134 environ_cp, 'TRISYCL_INCLUDE_DIR', ask_trisycl_include_dir,
1135 _DEFAULT_TRISYCL_INCLUDE_DIR)
Dandelion Man?90e42f32017-12-15 18:15:07 -08001136 if os.path.exists(trisycl_include_dir):
1137 break
1138
Gunhan Gulsoyffa90fc2018-09-26 01:38:55 -07001139 print('Invalid triSYCL include directory, %s cannot be found' %
1140 (trisycl_include_dir))
Dandelion Man?90e42f32017-12-15 18:15:07 -08001141
1142 # Set TRISYCL_INCLUDE_DIR
1143 environ_cp['TRISYCL_INCLUDE_DIR'] = trisycl_include_dir
Gunhan Gulsoyffa90fc2018-09-26 01:38:55 -07001144 write_action_env_to_bazelrc('TRISYCL_INCLUDE_DIR', trisycl_include_dir)
A. Unique TensorFlower73ea2872017-07-25 13:30:03 -07001145
Yifei Fengb1d8c592017-11-22 13:42:21 -08001146
A. Unique TensorFlower73ea2872017-07-25 13:30:03 -07001147def set_mpi_home(environ_cp):
1148 """Set MPI_HOME."""
Austin Anderson6afface2017-12-05 11:59:17 -08001149
Jonathan Hseu008910f2017-08-25 14:01:05 -07001150 default_mpi_home = which('mpirun') or which('mpiexec') or ''
1151 default_mpi_home = os.path.dirname(os.path.dirname(default_mpi_home))
1152
Austin Anderson6afface2017-12-05 11:59:17 -08001153 def valid_mpi_path(mpi_home):
Gunhan Gulsoyffa90fc2018-09-26 01:38:55 -07001154 exists = (
1155 os.path.exists(os.path.join(mpi_home, 'include')) and
TensorFlower Gardenerf7c861f2018-11-01 11:29:40 -07001156 (os.path.exists(os.path.join(mpi_home, 'lib')) or
1157 os.path.exists(os.path.join(mpi_home, 'lib64')) or
1158 os.path.exists(os.path.join(mpi_home, 'lib32'))))
Austin Anderson6afface2017-12-05 11:59:17 -08001159 if not exists:
TensorFlower Gardenerf7c861f2018-11-01 11:29:40 -07001160 print(
1161 'Invalid path to the MPI Toolkit. %s or %s or %s or %s cannot be found'
1162 % (os.path.join(mpi_home, 'include'),
Christian Gollba95d092018-10-04 17:06:23 +02001163 os.path.exists(os.path.join(mpi_home, 'lib')),
1164 os.path.exists(os.path.join(mpi_home, 'lib64')),
1165 os.path.exists(os.path.join(mpi_home, 'lib32'))))
Austin Anderson6afface2017-12-05 11:59:17 -08001166 return exists
A. Unique TensorFlower73ea2872017-07-25 13:30:03 -07001167
Austin Anderson6afface2017-12-05 11:59:17 -08001168 _ = prompt_loop_or_load_from_env(
1169 environ_cp,
1170 var_name='MPI_HOME',
1171 var_default=default_mpi_home,
1172 ask_for_var='Please specify the MPI toolkit folder.',
1173 check_success=valid_mpi_path,
1174 error_msg='',
1175 suppress_default_error=True)
A. Unique TensorFlower73ea2872017-07-25 13:30:03 -07001176
1177
1178def set_other_mpi_vars(environ_cp):
1179 """Set other MPI related variables."""
1180 # Link the MPI header files
1181 mpi_home = environ_cp.get('MPI_HOME')
1182 symlink_force('%s/include/mpi.h' % mpi_home, 'third_party/mpi/mpi.h')
1183
1184 # Determine if we use OpenMPI or MVAPICH, these require different header files
1185 # to be included here to make bazel dependency checker happy
1186 if os.path.exists(os.path.join(mpi_home, 'include/mpi_portable_platform.h')):
1187 symlink_force(
1188 os.path.join(mpi_home, 'include/mpi_portable_platform.h'),
1189 'third_party/mpi/mpi_portable_platform.h')
1190 # TODO(gunan): avoid editing files in configure
1191 sed_in_place('third_party/mpi/mpi.bzl', 'MPI_LIB_IS_OPENMPI=False',
1192 'MPI_LIB_IS_OPENMPI=True')
1193 else:
1194 # MVAPICH / MPICH
1195 symlink_force(
1196 os.path.join(mpi_home, 'include/mpio.h'), 'third_party/mpi/mpio.h')
1197 symlink_force(
1198 os.path.join(mpi_home, 'include/mpicxx.h'), 'third_party/mpi/mpicxx.h')
1199 # TODO(gunan): avoid editing files in configure
1200 sed_in_place('third_party/mpi/mpi.bzl', 'MPI_LIB_IS_OPENMPI=True',
1201 'MPI_LIB_IS_OPENMPI=False')
1202
1203 if os.path.exists(os.path.join(mpi_home, 'lib/libmpi.so')):
1204 symlink_force(
1205 os.path.join(mpi_home, 'lib/libmpi.so'), 'third_party/mpi/libmpi.so')
Christian Gollba95d092018-10-04 17:06:23 +02001206 elif os.path.exists(os.path.join(mpi_home, 'lib64/libmpi.so')):
1207 symlink_force(
1208 os.path.join(mpi_home, 'lib64/libmpi.so'), 'third_party/mpi/libmpi.so')
1209 elif os.path.exists(os.path.join(mpi_home, 'lib32/libmpi.so')):
1210 symlink_force(
1211 os.path.join(mpi_home, 'lib32/libmpi.so'), 'third_party/mpi/libmpi.so')
1212
A. Unique TensorFlower73ea2872017-07-25 13:30:03 -07001213 else:
TensorFlower Gardenerf7c861f2018-11-01 11:29:40 -07001214 raise ValueError(
1215 'Cannot find the MPI library file in %s/lib or %s/lib64 or %s/lib32' %
Mihai Maruseac91ebeec2019-01-29 17:07:38 -08001216 (mpi_home, mpi_home, mpi_home))
A. Unique TensorFlower73ea2872017-07-25 13:30:03 -07001217
A. Unique TensorFlowered297342019-03-15 11:25:28 -07001218
A. Unique TensorFlowere9797fd2019-03-22 11:02:40 -07001219def system_specific_test_config(env):
A. Unique TensorFlower7bd86372019-03-21 15:19:30 -07001220 """Add default build and test flags required for TF tests to bazelrc."""
Gunhan Gulsoyfff66962019-02-20 15:28:43 -08001221 write_to_bazelrc('test --flaky_test_attempts=3')
1222 write_to_bazelrc('test --test_size_filters=small,medium')
1223 write_to_bazelrc(
1224 'test --test_tag_filters=-benchmark-test,-no_oss,-oss_serial')
1225 write_to_bazelrc('test --build_tag_filters=-benchmark-test,-no_oss')
1226 if is_windows():
Guangda Laibcd701a2019-03-12 21:04:51 -07001227 if env.get('TF_NEED_CUDA', None) == '1':
Gunhan Gulsoyfff66962019-02-20 15:28:43 -08001228 write_to_bazelrc(
1229 'test --test_tag_filters=-no_windows,-no_windows_gpu,-no_gpu')
1230 write_to_bazelrc(
1231 'test --build_tag_filters=-no_windows,-no_windows_gpu,-no_gpu')
1232 else:
1233 write_to_bazelrc('test --test_tag_filters=-no_windows,-gpu')
1234 write_to_bazelrc('test --build_tag_filters=-no_windows,-gpu')
1235 elif is_macos():
1236 write_to_bazelrc('test --test_tag_filters=-gpu,-nomac,-no_mac')
1237 write_to_bazelrc('test --build_tag_filters=-gpu,-nomac,-no_mac')
1238 elif is_linux():
Guangda Laibcd701a2019-03-12 21:04:51 -07001239 if env.get('TF_NEED_CUDA', None) == '1':
Gunhan Gulsoyfff66962019-02-20 15:28:43 -08001240 write_to_bazelrc('test --test_tag_filters=-no_gpu')
1241 write_to_bazelrc('test --build_tag_filters=-no_gpu')
1242 write_to_bazelrc('test --test_env=LD_LIBRARY_PATH')
1243 else:
1244 write_to_bazelrc('test --test_tag_filters=-gpu')
1245 write_to_bazelrc('test --build_tag_filters=-gpu')
1246
A. Unique TensorFlower73ea2872017-07-25 13:30:03 -07001247
Yifei Feng5198cb82018-08-17 13:53:06 -07001248def set_system_libs_flag(environ_cp):
1249 syslibs = environ_cp.get('TF_SYSTEM_LIBS', '')
TensorFlower Gardener61a87202018-10-01 12:25:39 -07001250 if syslibs:
Jason Zaman5fc39bd2018-09-16 01:38:55 +08001251 if ',' in syslibs:
1252 syslibs = ','.join(sorted(syslibs.split(',')))
1253 else:
1254 syslibs = ','.join(sorted(syslibs.split()))
Yifei Feng5198cb82018-08-17 13:53:06 -07001255 write_action_env_to_bazelrc('TF_SYSTEM_LIBS', syslibs)
1256
Jason Zaman5fc39bd2018-09-16 01:38:55 +08001257 if 'PREFIX' in environ_cp:
1258 write_to_bazelrc('build --define=PREFIX=%s' % environ_cp['PREFIX'])
1259 if 'LIBDIR' in environ_cp:
1260 write_to_bazelrc('build --define=LIBDIR=%s' % environ_cp['LIBDIR'])
1261 if 'INCLUDEDIR' in environ_cp:
1262 write_to_bazelrc('build --define=INCLUDEDIR=%s' % environ_cp['INCLUDEDIR'])
1263
Yifei Feng5198cb82018-08-17 13:53:06 -07001264
A. Unique TensorFlower1b212352018-07-19 13:48:50 -07001265def set_windows_build_flags(environ_cp):
1266 """Set Windows specific build options."""
1267 # The non-monolithic build is not supported yet
1268 write_to_bazelrc('build --config monolithic')
1269 # Suppress warning messages
1270 write_to_bazelrc('build --copt=-w --host_copt=-w')
Loo Rong Jie31f10d22019-02-02 10:03:20 +08001271 # Fix winsock2.h conflicts
TensorFlower Gardener345cccf2019-02-28 15:22:59 -08001272 write_to_bazelrc(
1273 'build --copt=-DWIN32_LEAN_AND_MEAN --host_copt=-DWIN32_LEAN_AND_MEAN')
A. Unique TensorFlower1b212352018-07-19 13:48:50 -07001274 # Output more verbose information when something goes wrong
1275 write_to_bazelrc('build --verbose_failures')
1276 # The host and target platforms are the same in Windows build. So we don't
1277 # have to distinct them. This avoids building the same targets twice.
1278 write_to_bazelrc('build --distinct_host_configuration=false')
A. Unique TensorFlower1b212352018-07-19 13:48:50 -07001279
1280 if get_var(
1281 environ_cp, 'TF_OVERRIDE_EIGEN_STRONG_INLINE', 'Eigen strong inline',
Gunhan Gulsoyffa90fc2018-09-26 01:38:55 -07001282 True, ('Would you like to override eigen strong inline for some C++ '
1283 'compilation to reduce the compilation time?'),
1284 'Eigen strong inline overridden.', 'Not overriding eigen strong inline, '
A. Unique TensorFlower1b212352018-07-19 13:48:50 -07001285 'some compilations could take more than 20 mins.'):
1286 # Due to a known MSVC compiler issue
1287 # https://github.com/tensorflow/tensorflow/issues/10521
1288 # Overriding eigen strong inline speeds up the compiling of
1289 # conv_grad_ops_3d.cc and conv_ops_3d.cc by 20 minutes,
1290 # but this also hurts the performance. Let users decide what they want.
1291 write_to_bazelrc('build --define=override_eigen_strong_inline=true')
Dandelion Man?90e42f32017-12-15 18:15:07 -08001292
A. Unique TensorFlower061c3592017-11-13 14:21:04 -08001293
Michael Cased31531a2018-01-05 14:09:41 -08001294def config_info_line(name, help_text):
1295 """Helper function to print formatted help text for Bazel config options."""
1296 print('\t--config=%-12s\t# %s' % (name, help_text))
1297
1298
A. Unique TensorFlower76e879d2019-03-22 00:25:36 -07001299def configure_ios():
1300 """Configures TensorFlow for iOS builds.
A. Unique TensorFlower93e70732019-02-14 16:45:32 -08001301
A. Unique TensorFlower76e879d2019-03-22 00:25:36 -07001302 This function will only be executed if `is_macos()` is true.
A. Unique TensorFlower93e70732019-02-14 16:45:32 -08001303 """
1304 if not is_macos():
1305 return
A. Unique TensorFlowered297342019-03-15 11:25:28 -07001306 if _TF_CURRENT_BAZEL_VERSION is None or _TF_CURRENT_BAZEL_VERSION < 23000:
1307 print(
1308 'Building Bazel rules on Apple platforms requires Bazel 0.23 or later.')
A. Unique TensorFlower76e879d2019-03-22 00:25:36 -07001309 for filepath in APPLE_BAZEL_FILES:
1310 existing_filepath = os.path.join(_TF_WORKSPACE_ROOT, filepath + '.apple')
1311 renamed_filepath = os.path.join(_TF_WORKSPACE_ROOT, filepath)
1312 symlink_force(existing_filepath, renamed_filepath)
1313 for filepath in IOS_FILES:
1314 filename = os.path.basename(filepath)
1315 new_filepath = os.path.join(_TF_WORKSPACE_ROOT, filename)
1316 symlink_force(filepath, new_filepath)
A. Unique TensorFlower93e70732019-02-14 16:45:32 -08001317
1318
A. Unique TensorFlower73ea2872017-07-25 13:30:03 -07001319def main():
A. Unique TensorFlower7c5eb352018-10-01 07:15:23 -07001320 global _TF_WORKSPACE_ROOT
1321 global _TF_BAZELRC
A. Unique TensorFlowered297342019-03-15 11:25:28 -07001322 global _TF_CURRENT_BAZEL_VERSION
A. Unique TensorFlower7c5eb352018-10-01 07:15:23 -07001323
Shanqing Cai71445712018-03-12 19:33:52 -07001324 parser = argparse.ArgumentParser()
Gunhan Gulsoyffa90fc2018-09-26 01:38:55 -07001325 parser.add_argument(
1326 '--workspace',
1327 type=str,
A. Unique TensorFlower7c5eb352018-10-01 07:15:23 -07001328 default=os.path.abspath(os.path.dirname(__file__)),
Gunhan Gulsoyffa90fc2018-09-26 01:38:55 -07001329 help='The absolute path to your active Bazel workspace.')
Shanqing Cai71445712018-03-12 19:33:52 -07001330 args = parser.parse_args()
1331
A. Unique TensorFlower7c5eb352018-10-01 07:15:23 -07001332 _TF_WORKSPACE_ROOT = args.workspace
1333 _TF_BAZELRC = os.path.join(_TF_WORKSPACE_ROOT, _TF_BAZELRC_FILENAME)
1334
A. Unique TensorFlower73ea2872017-07-25 13:30:03 -07001335 # Make a copy of os.environ to be clear when functions and getting and setting
1336 # environment variables.
1337 environ_cp = dict(os.environ)
1338
A. Unique TensorFlower2b9c2992019-04-04 10:30:19 -07001339 current_bazel_version = check_bazel_version('0.22.0', '0.24.1')
A. Unique TensorFlowered297342019-03-15 11:25:28 -07001340 _TF_CURRENT_BAZEL_VERSION = convert_version_to_int(current_bazel_version)
A. Unique TensorFlower73ea2872017-07-25 13:30:03 -07001341
A. Unique TensorFlower7c5eb352018-10-01 07:15:23 -07001342 reset_tf_configure_bazelrc()
Yun Peng03e63a22018-11-07 11:18:53 +01001343
A. Unique TensorFlower73ea2872017-07-25 13:30:03 -07001344 cleanup_makefile()
Gunhan Gulsoyed89a2b2017-09-19 18:36:26 -07001345 setup_python(environ_cp)
A. Unique TensorFlower73ea2872017-07-25 13:30:03 -07001346
1347 if is_windows():
Yifei Fengb1d8c592017-11-22 13:42:21 -08001348 environ_cp['TF_NEED_OPENCL_SYCL'] = '0'
1349 environ_cp['TF_NEED_COMPUTECPP'] = '0'
A. Unique TensorFlower73ea2872017-07-25 13:30:03 -07001350 environ_cp['TF_NEED_OPENCL'] = '0'
1351 environ_cp['TF_CUDA_CLANG'] = '0'
Guangda Lai76f69382018-01-25 23:59:19 -08001352 environ_cp['TF_NEED_TENSORRT'] = '0'
Ilya Biryukov9e651e42018-03-22 05:33:42 -07001353 # TODO(ibiryukov): Investigate using clang as a cpu or cuda compiler on
1354 # Windows.
1355 environ_cp['TF_DOWNLOAD_CLANG'] = '0'
A. Unique TensorFlower6e97fb32018-07-16 14:07:29 -07001356 environ_cp['TF_NEED_MPI'] = '0'
1357 environ_cp['TF_SET_ANDROID_WORKSPACE'] = '0'
A. Unique TensorFlower73ea2872017-07-25 13:30:03 -07001358
1359 if is_macos():
Guangda Lai76f69382018-01-25 23:59:19 -08001360 environ_cp['TF_NEED_TENSORRT'] = '0'
A. Unique TensorFlower93e70732019-02-14 16:45:32 -08001361 else:
A. Unique TensorFlower76e879d2019-03-22 00:25:36 -07001362 environ_cp['TF_CONFIGURE_IOS'] = '0'
A. Unique TensorFlower73ea2872017-07-25 13:30:03 -07001363
Jon Triebenbach6896a742018-06-27 13:29:53 -05001364 # The numpy package on ppc64le uses OpenBLAS which has multi-threading
1365 # issues that lead to incorrect answers. Set OMP_NUM_THREADS=1 at
1366 # runtime to allow the Tensorflow testcases which compare numpy
1367 # results to Tensorflow results to succeed.
1368 if is_ppc64le():
Gunhan Gulsoyffa90fc2018-09-26 01:38:55 -07001369 write_action_env_to_bazelrc('OMP_NUM_THREADS', 1)
Jon Triebenbach6896a742018-06-27 13:29:53 -05001370
Grzegorz Pawelczakec82efd2018-10-09 15:03:46 +01001371 xla_enabled_by_default = is_linux()
A. Unique TensorFlower73ea2872017-07-25 13:30:03 -07001372 set_build_var(environ_cp, 'TF_ENABLE_XLA', 'XLA JIT', 'with_xla_support',
Grzegorz Pawelczakec82efd2018-10-09 15:03:46 +01001373 xla_enabled_by_default, 'xla')
Gunhan Gulsoy3da0dff2018-09-26 11:55:50 -07001374
Yifei Fengb1d8c592017-11-22 13:42:21 -08001375 set_action_env_var(environ_cp, 'TF_NEED_OPENCL_SYCL', 'OpenCL SYCL', False)
1376 if environ_cp.get('TF_NEED_OPENCL_SYCL') == '1':
A. Unique TensorFlower73ea2872017-07-25 13:30:03 -07001377 set_host_cxx_compiler(environ_cp)
1378 set_host_c_compiler(environ_cp)
Yifei Fengb1d8c592017-11-22 13:42:21 -08001379 set_action_env_var(environ_cp, 'TF_NEED_COMPUTECPP', 'ComputeCPP', True)
1380 if environ_cp.get('TF_NEED_COMPUTECPP') == '1':
1381 set_computecpp_toolkit_path(environ_cp)
1382 else:
1383 set_trisycl_include_dir(environ_cp)
A. Unique TensorFlower73ea2872017-07-25 13:30:03 -07001384
Wen-Heng (Jack) Chung69d3b8f2018-06-22 23:09:43 -05001385 set_action_env_var(environ_cp, 'TF_NEED_ROCM', 'ROCm', False)
1386 if (environ_cp.get('TF_NEED_ROCM') == '1' and
TensorFlower Gardener62e60162018-09-27 10:22:55 -07001387 'LD_LIBRARY_PATH' in environ_cp and
1388 environ_cp.get('LD_LIBRARY_PATH') != '1'):
1389 write_action_env_to_bazelrc('LD_LIBRARY_PATH',
1390 environ_cp.get('LD_LIBRARY_PATH'))
Wen-Heng (Jack) Chung69d3b8f2018-06-22 23:09:43 -05001391
A. Unique TensorFlower73ea2872017-07-25 13:30:03 -07001392 set_action_env_var(environ_cp, 'TF_NEED_CUDA', 'CUDA', False)
A. Unique TensorFlower24cbb2a2017-09-08 07:45:44 -07001393 if (environ_cp.get('TF_NEED_CUDA') == '1' and
1394 'TF_CUDA_CONFIG_REPO' not in environ_cp):
A. Unique TensorFlower8e9ca662019-04-15 12:47:11 -07001395 for _ in range(_DEFAULT_PROMPT_ASK_ATTEMPTS):
1396 set_tf_cuda_version(environ_cp)
1397 set_tf_cudnn_version(environ_cp)
1398 cuda_libraries = ['cuda', 'cudnn']
1399 if is_linux():
1400 set_tf_tensorrt_version(environ_cp)
1401 if 'TF_TENSORRT_VERSION' in environ_cp: # if env variable exists
1402 cuda_libraries.append('tensorrt')
1403 set_tf_nccl_version(environ_cp)
1404 if environ_cp['TF_NCCL_VERSION']: # if env variable not empty
1405 cuda_libraries.append('nccl')
1406
1407 def maybe_encode_env(env):
1408 """Encodes unicode in env to str on Windows python 2.x."""
1409 if not is_windows() or sys.version_info[0] != 2:
1410 return env
1411 for k, v in env.items():
1412 if isinstance(k, unicode):
1413 k = k.encode('ascii')
1414 if isinstance(v, unicode):
1415 v = v.encode('ascii')
1416 env[k] = v
1417 return env
1418
1419 # Verify CUDA configuration by calling find_cuda_config.py.
1420 proc = subprocess.Popen(
1421 [
1422 environ_cp['PYTHON_BIN_PATH'],
1423 'third_party/gpus/find_cuda_config.py'
1424 ] + cuda_libraries,
1425 stdout=subprocess.PIPE,
1426 env=maybe_encode_env(environ_cp))
1427
1428 cuda_env_variable_names = [
1429 'TF_CUDA_VERSION', 'TF_CUBLAS_VERSION', 'TF_CUDNN_VERSION',
1430 'TF_TENSORRT_VERSION', 'TF_NCCL_VERSION', 'TF_CUDA_PATHS'
1431 ]
1432
1433 if proc.wait():
1434 print('\nCould not find all requested CUDA libraries or headers.\n')
1435 for name in cuda_env_variable_names:
1436 if name in environ_cp:
1437 del environ_cp[name]
1438 set_tf_cuda_paths(environ_cp)
1439 continue
1440
1441 for line in proc.stdout:
1442 match = re.match('cuda_toolkit_path: (.*)', line.decode('ascii'))
1443 if match:
1444 cuda_toolkit_path = match.group(1)
1445
1446 for name in cuda_env_variable_names:
1447 if name in environ_cp:
1448 write_action_env_to_bazelrc(name, environ_cp[name])
1449
1450 break
1451 else:
1452 raise UserInputError(
1453 'Invalid CUDA setting were provided %d '
1454 'times in a row. Assuming to be a scripting mistake.' %
1455 _DEFAULT_PROMPT_ASK_ATTEMPTS)
1456
1457 environ_cp['CUDA_TOOLKIT_PATH'] = cuda_toolkit_path
Michael Case0073d132018-04-11 09:34:44 -07001458
A. Unique TensorFlower73ea2872017-07-25 13:30:03 -07001459 set_tf_cuda_compute_capabilities(environ_cp)
Ankur Taly0e6f39d2018-02-16 18:22:55 -08001460 if 'LD_LIBRARY_PATH' in environ_cp and environ_cp.get(
1461 'LD_LIBRARY_PATH') != '1':
1462 write_action_env_to_bazelrc('LD_LIBRARY_PATH',
1463 environ_cp.get('LD_LIBRARY_PATH'))
A. Unique TensorFlower73ea2872017-07-25 13:30:03 -07001464
1465 set_tf_cuda_clang(environ_cp)
1466 if environ_cp.get('TF_CUDA_CLANG') == '1':
Ilya Biryukov9e651e42018-03-22 05:33:42 -07001467 # Ask whether we should download the clang toolchain.
1468 set_tf_download_clang(environ_cp)
A. Unique TensorFlowerfd29e952017-12-22 03:07:51 -08001469 if environ_cp.get('TF_DOWNLOAD_CLANG') != '1':
1470 # Set up which clang we should use as the cuda / host compiler.
1471 set_clang_cuda_compiler_path(environ_cp)
Ilya Biryukov1c3d02e2018-09-04 03:09:52 -07001472 else:
1473 # Use downloaded LLD for linking.
1474 write_to_bazelrc('build:cuda_clang --config=download_clang_use_lld')
1475 write_to_bazelrc('test:cuda_clang --config=download_clang_use_lld')
A. Unique TensorFlower73ea2872017-07-25 13:30:03 -07001476 else:
1477 # Set up which gcc nvcc should use as the host compiler
1478 # No need to set this on Windows
1479 if not is_windows():
1480 set_gcc_host_compiler_path(environ_cp)
1481 set_other_cuda_vars(environ_cp)
Ilya Biryukov9e651e42018-03-22 05:33:42 -07001482 else:
1483 # CUDA not required. Ask whether we should download the clang toolchain and
1484 # use it for the CPU build.
1485 set_tf_download_clang(environ_cp)
1486 if environ_cp.get('TF_DOWNLOAD_CLANG') == '1':
1487 write_to_bazelrc('build --config=download_clang')
1488 write_to_bazelrc('test --config=download_clang')
A. Unique TensorFlower73ea2872017-07-25 13:30:03 -07001489
Wen-Heng (Jack) Chung69d3b8f2018-06-22 23:09:43 -05001490 # SYCL / ROCm / CUDA are mutually exclusive.
1491 # At most 1 GPU platform can be configured.
1492 gpu_platform_count = 0
1493 if environ_cp.get('TF_NEED_OPENCL_SYCL') == '1':
1494 gpu_platform_count += 1
1495 if environ_cp.get('TF_NEED_ROCM') == '1':
1496 gpu_platform_count += 1
1497 if environ_cp.get('TF_NEED_CUDA') == '1':
1498 gpu_platform_count += 1
1499 if gpu_platform_count >= 2:
1500 raise UserInputError('SYCL / CUDA / ROCm are mututally exclusive. '
1501 'At most 1 GPU platform can be configured.')
1502
A. Unique TensorFlower73ea2872017-07-25 13:30:03 -07001503 set_build_var(environ_cp, 'TF_NEED_MPI', 'MPI', 'with_mpi_support', False)
1504 if environ_cp.get('TF_NEED_MPI') == '1':
1505 set_mpi_home(environ_cp)
1506 set_other_mpi_vars(environ_cp)
1507
1508 set_cc_opt_flags(environ_cp)
Yifei Feng5198cb82018-08-17 13:53:06 -07001509 set_system_libs_flag(environ_cp)
A. Unique TensorFlower1b212352018-07-19 13:48:50 -07001510 if is_windows():
1511 set_windows_build_flags(environ_cp)
A. Unique TensorFlower73ea2872017-07-25 13:30:03 -07001512
Anna Ra9a1d5a2018-09-14 12:44:31 -07001513 # Add a config option to build TensorFlow 2.0 API.
1514 write_to_bazelrc('build:v2 --define=tf_api_version=2')
1515
Gunhan Gulsoyffa90fc2018-09-26 01:38:55 -07001516 if get_var(environ_cp, 'TF_SET_ANDROID_WORKSPACE', 'android workspace', False,
1517 ('Would you like to interactively configure ./WORKSPACE for '
1518 'Android builds?'), 'Searching for NDK and SDK installations.',
1519 'Not configuring the WORKSPACE for Android builds.'):
Michael Case51053502018-06-05 17:47:19 -07001520 create_android_ndk_rule(environ_cp)
1521 create_android_sdk_rule(environ_cp)
Austin Anderson6afface2017-12-05 11:59:17 -08001522
A. Unique TensorFlowere9797fd2019-03-22 11:02:40 -07001523 system_specific_test_config(os.environ)
Gunhan Gulsoyfff66962019-02-20 15:28:43 -08001524
A. Unique TensorFlower5001ac02019-04-03 11:59:08 -07001525 set_action_env_var(environ_cp, 'TF_CONFIGURE_IOS', 'iOS', False)
1526 if environ_cp.get('TF_CONFIGURE_IOS') == '1':
A. Unique TensorFlower76e879d2019-03-22 00:25:36 -07001527 configure_ios()
A. Unique TensorFlowere9797fd2019-03-22 11:02:40 -07001528 else:
1529 # TODO(pcloudy): Remove BAZEL_USE_CPP_ONLY_TOOLCHAIN after Bazel is upgraded
1530 # to 0.24.0.
1531 # For working around https://github.com/bazelbuild/bazel/issues/7607
1532 if is_macos():
1533 write_to_bazelrc('build --action_env=BAZEL_USE_CPP_ONLY_TOOLCHAIN=1')
A. Unique TensorFlower93e70732019-02-14 16:45:32 -08001534
Gunhan Gulsoy34370982018-10-12 15:26:01 -07001535 print('Preconfigured Bazel build configs. You can use any of the below by '
1536 'adding "--config=<>" to your build command. See .bazelrc for more '
1537 'details.')
1538 config_info_line('mkl', 'Build with MKL support.')
1539 config_info_line('monolithic', 'Config for mostly static monolithic build.')
1540 config_info_line('gdr', 'Build with GDR support.')
1541 config_info_line('verbs', 'Build with libverbs support.')
1542 config_info_line('ngraph', 'Build with Intel nGraph support.')
A. Unique TensorFlowera6bf9c82019-02-26 10:08:35 -08001543 config_info_line('numa', 'Build with NUMA support.')
TensorFlower Gardenerabb763b2019-02-06 16:23:03 -08001544 config_info_line(
1545 'dynamic_kernels',
1546 '(Experimental) Build kernels into separate shared objects.')
Gunhan Gulsoy34370982018-10-12 15:26:01 -07001547
1548 print('Preconfigured Bazel build configs to DISABLE default on features:')
1549 config_info_line('noaws', 'Disable AWS S3 filesystem support.')
1550 config_info_line('nogcp', 'Disable GCP support.')
1551 config_info_line('nohdfs', 'Disable HDFS support.')
Penporn Koanantakool489f1dc2019-01-10 22:07:22 -08001552 config_info_line('noignite', 'Disable Apache Ignite support.')
Gunhan Gulsoy34370982018-10-12 15:26:01 -07001553 config_info_line('nokafka', 'Disable Apache Kafka support.')
Gunhan Gulsoyeea81682018-11-26 16:51:23 -08001554 config_info_line('nonccl', 'Disable NVIDIA NCCL support.')
Austin Anderson6afface2017-12-05 11:59:17 -08001555
Gunhan Gulsoyffa90fc2018-09-26 01:38:55 -07001556
A. Unique TensorFlower73ea2872017-07-25 13:30:03 -07001557if __name__ == '__main__':
1558 main()