Skip to content

Commit

Permalink
Add CMake support with a converter from Bazel (google#233)
Browse files Browse the repository at this point in the history
* Add CMake support with a converter from Bazel, update by running:

  cmake/bazel_to_cmake.sh

This supports building and running tests also on Android, e.g.

```
cmake ../ruy -G Ninja \
  -DCMAKE_TOOLCHAIN_FILE=~/android-ndk-r21d/build/cmake/android.toolchain.cmake \
  -DANDROID_ABI=arm64-v8a \
  -DANDROID_PLATFORM=android-29

cmake --build . -j12

ctest . -j12
```

Some parts of this were forked from IREE's cmake setup.
  • Loading branch information
bjacob authored Jan 20, 2021
1 parent fb9174e commit b87d6d2
Show file tree
Hide file tree
Showing 13 changed files with 2,413 additions and 0 deletions.
42 changes: 42 additions & 0 deletions CMakeLists.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
# Copyright 2021 Google LLC
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# https://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

cmake_policy(SET CMP0012 NEW)
cmake_policy(SET CMP0048 NEW)
project(ruy CXX)
cmake_minimum_required(VERSION 3.13) # Copied from IREE
set(CMAKE_CXX_STANDARD 14)

option(RUY_ENABLE_TESTS "Enable ruy's tests" ON)
if (RUY_ENABLE_TESTS)
enable_testing()
endif()

option(RUY_PROFILER "Enable ruy's built-in profiler (harms performance)" OFF)

include(cmake/ruy_add_all_subdirs.cmake)
include(cmake/ruy_cc_library.cmake)
include(cmake/ruy_cc_binary.cmake)
include(cmake/ruy_cc_test.cmake)

# Disabling cpuinfo's tests and benchmarks to prevent a copy of its
# googletest dependency getting downloaded into a 'deps' directory in the
# source tree!
set(CPUINFO_BUILD_BENCHMARKS OFF CACHE BOOL "" FORCE)
set(CPUINFO_BUILD_UNIT_TESTS OFF CACHE BOOL "" FORCE)
set(CPUINFO_BUILD_MOCK_TESTS OFF CACHE BOOL "" FORCE)
add_subdirectory("third_party/cpuinfo" EXCLUDE_FROM_ALL)
add_subdirectory("third_party/googletest" EXCLUDE_FROM_ALL)

ruy_add_all_subdirs()
279 changes: 279 additions & 0 deletions cmake/bazel_to_cmake.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,279 @@
#!/usr/bin/env python3
# Copyright 2021 Google LLC
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# https://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

"""This is yet another bazel-to-cmake converter. It's independently written from
scratch but relies on the same basic idea as others (including IREE's), namely:
to let the python interpreter do the bulk of the work, exploiting the fact that
both Bazel's BUILD syntax and Starlark (".bzl") languages are more or less
subsets of Python.
The main features that this converter supports and that others don't, justifying
its existence as of early 2021, are:
1. Ad-hoc support for select(), generating CMake if()...elseif()... chains
parsing the condition keys (e.g. anything ending in ":windows" is
interpreted as the condition "the target platform is Windows"). This allows
to just ignore config_setting, as we only care about the config_setting
names, not their actual implementation, as well as all the variants from
the Bazel 'selects' library.
2. Support for load(), loading macros from Starlark files.
"""

import re
import os
import os.path
import pickle
import sys
import datetime
import itertools

# Ruy's dependencies.
external_targets = ['gtest', 'gtest_main', 'cpuinfo']

# Text replacements [oldstring, newstring] pairs, applied on all BUILD and
# Starlark files that we load. Only used by preprocess_input_text.
replacements = [
['$(STACK_FRAME_UNLIMITED)', ''],
['native.cc_', 'cc_'],
['selects.config_setting_group', 'config_setting_group'],
['@com_google_googletest//:gtest', 'gtest'],
['@com_google_googletest//:gtest_main', 'gtest_main'],
['@cpuinfo//:cpuinfo_with_unstripped_include_path', 'cpuinfo'],
]


def preprocess_input_text(text):
result = text
for replacement in replacements:
result = result.replace(replacement[0], replacement[1])
return result


def set_cmake_list(list_name, values, indent):
semicolon_separated = ";".join(values)
print(f'{indent}set({list_name} "{semicolon_separated}")')


def generate_cmake_select(select_name, dict):
new_if_branch_keyword = 'if'
default_value = []
for key in dict:
condition = ''
if key == '//conditions:default':
default_value = dict[key]
continue
elif re.search(r':windows$', key):
condition = 'CMAKE_SYSTEM_NAME STREQUAL Windows'
elif re.search(r':ppc$', key):
condition = 'CMAKE_SYSTEM_PROCESSOR STREQUAL ppc64 OR CMAKE_SYSTEM_PROCESSOR STREQUAL ppc64le'
elif re.search(r':s390x$', key):
condition = 'CMAKE_SYSTEM_PROCESSOR STREQUAL s390 OR CMAKE_SYSTEM_PROCESSOR STREQUAL s390x'
elif re.search(r':fuchsia$', key):
condition = 'CMAKE_SYSTEM_NAME STREQUAL Fuchsia'
elif re.search(r':arm32_assuming_neon$', key):
condition = 'CMAKE_SYSTEM_PROCESSOR STREQUAL arm'
elif re.search(r':do_not_want_O3$', key):
# Ruy is a specialist library: we always want code to be compiled
# with -O3 unless the build type is Debug or the compiler does not
# support that flag syntax.
condition = '(CMAKE_BUILD_TYPE STREQUAL Debug) OR MSVC'
elif re.search(r':x86_64_and_not_msvc$', key):
condition = '(CMAKE_SYSTEM_PROCESSOR STREQUAL x86_64 OR CMAKE_SYSTEM_PROCESSOR STREQUAL amd64) AND NOT MSVC'
elif re.search(r':windows_msvc$', key):
condition = 'MSVC'
elif re.search(r':ruy_profiler$', key):
condition = '${RUY_PROFILER}'
else:
raise ValueError(f'Unhandled key in select: {key}')

print(f'{new_if_branch_keyword}({condition})')
set_cmake_list(select_name, dict[key], ' ')
new_if_branch_keyword = 'elseif'

print('else()')
set_cmake_list(select_name, default_value, ' ')

print('endif()\n')


def trim_multiple_ruy_prefixes(name):
return re.sub(r'(ruy_)+ruy', 'ruy', name)

def get_cmake_local_target_name(name):
global package_prefix
return trim_multiple_ruy_prefixes(f'ruy_{package_prefix}_{name}')


def get_cmake_dep_target_name(name):
if name in external_targets:
return name
if name.startswith('$'):
# Happens for deps that are the result of expanding a select() that we
# have compiled to expanding a variable.
return name
if name.startswith('//'):
after_last_slash = name.split('/')[-1]
if not ':' in after_last_slash:
name = f'{name}:{after_last_slash}'
raw=name[2:].replace('/', '_').replace(':', '_')
return trim_multiple_ruy_prefixes(raw)
if name.startswith(':'):
name = name[1:]
return get_cmake_local_target_name(name)


#
# Functions implementing BUILD functions
#


def package(**kwargs):
pass


def exports_files(*args):
pass


def load(filename, *args):
if filename.startswith('@'):
return
elif filename.startswith(':'):
filename = os.path.join(bazel_package_dir, filename[1:])
elif filename.startswith('//'):
split = filename[2:].split(':')
filename = os.path.join(bazel_workspace_dir, split[0], split[1])

src_file_content = open(filename).read()
processed_file_content = preprocess_input_text(src_file_content)
exec(processed_file_content, globals(), globals())


def config_setting(**kwargs):
# Nothing to do since our implementation of select() is based on parsing
# the names of config_settings, not looking deep into their actual
# implementation.
pass


def filegroup(**kwargs):
pass


def config_setting_group(**kwargs):
# See config_setting.
pass


def bzl_library(**kwargs):
pass


select_index = 0
select_cache = {}


def select(select_dict):
global select_index
global select_cache
global package_prefix
key = pickle.dumps(sorted(select_dict.items()))
if key in select_cache:
select_name = select_cache[key]
else:
unique_values = sorted(set(itertools.chain.from_iterable(select_dict.values()))) # sorting ensures determinism, no spurious diffs
description = '_'.join(unique_values)
select_name = f'{package_prefix}_{select_index}_{description}'
select_name = select_name.replace('c++', 'cxx')
select_name = re.sub(r'[^a-zA-Z0-9]+', '_', select_name)
select_index = select_index + 1
select_cache[key] = select_name
generate_cmake_select(select_name, select_dict)

return [f'${{{select_name}}}']


def generic_rule(rule_name, **kwargs):
print(f'{rule_name}(')
for key in kwargs.keys():
values = kwargs[key]
if type(values) is bool:
if values:
print(f' {key.upper()}')
continue
else:
raise ValueError(
'Cannot specify FALSE boolean args in CMake')
if key == 'visibility':
if values == ['//visibility:public']:
print(f' PUBLIC')
continue
if key == 'tags':
values = list(filter(lambda x : not x.startswith('req_dep'), values))
if not values:
continue
print(f' {key.upper()}')
if type(values) is list:
for value in values:
if key == 'deps':
target_name = get_cmake_dep_target_name(value)
print(f' {target_name}')
else:
print(f' {value}')
else:
if key == 'name':
target_name = get_cmake_local_target_name(values)
print(f' {target_name}')
else:
print(f' {values}')
print(')\n')


def cc_library(**kwargs):
generic_rule('ruy_cc_library', **kwargs)


def cc_test(**kwargs):
generic_rule('ruy_cc_test', **kwargs)


def cc_binary(**kwargs):
generic_rule('ruy_cc_binary', **kwargs)


#
# Program entry point.
#
if __name__ == "__main__":
if len(sys.argv) != 3:
print("Usage: bazel_to_cmake.py bazel_workspace_dir bazel_package_dir")
sys.exit(1)

bazel_workspace_dir = sys.argv[1]
bazel_package_dir = sys.argv[2]
bazel_package_relative_dir = os.path.relpath(
bazel_package_dir, bazel_workspace_dir)
package_prefix = bazel_package_relative_dir.replace(os.path.sep, '_')

print("""# This file is generated (whence no license header). Do not edit!
# To regenerate, run:
# cmake/bazel_to_cmake.sh
""")

src_build_file = os.path.join(bazel_package_dir, "BUILD")
src_build_content = open(src_build_file).read()
processed_build_content = preprocess_input_text(src_build_content)
exec(processed_build_content)

print("ruy_add_all_subdirs()")
35 changes: 35 additions & 0 deletions cmake/bazel_to_cmake.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
#!/bin/bash
# Copyright 2021 Google LLC
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# https://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

this_script_dir="$(dirname "$0")"

root_dir="$(git -C "${this_script_dir}" rev-parse --show-toplevel)"

build_files="$(find "${root_dir}" -type f -name BUILD)"

if ! command -v python3 &> /dev/null; then
python_command=python
else
python_command=python3
fi

for build_file in ${build_files}; do
package_dir="$(dirname "${build_file}")"
if [[ "${package_dir}" == "${root_dir}" ]]; then
# The root CMakeLists.txt is not generated.
continue
fi
"${python_command}" "${this_script_dir}/bazel_to_cmake.py" "${root_dir}" "${package_dir}" > "${package_dir}/CMakeLists.txt"
done
16 changes: 16 additions & 0 deletions cmake/run_android_test.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
#!/bin/bash

# Minimal script pushing and running a file on device!
# Contemporary versions of ADB properly propagate exit codes so nothing more
# is needed to let CTest report test success/failure.

# TODO: consider clearing temporary files after testing, although that will
# get in the way of debugging and will make code more complex... also,
# Ruy's test files aren't huge and people running these probably have
# bigger clutter issues in their /data/local/tmp anyway. Anyway, if we want
# to do this, we could copy IREE's code.

device_tmpdir=/data/local/tmp

adb push "$1" "${device_tmpdir}"
adb shell "${device_tmpdir}/$(basename "$1")"
Loading

0 comments on commit b87d6d2

Please sign in to comment.