Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit d1494b0f authored by Treehugger Robot's avatar Treehugger Robot Committed by Gerrit Code Review
Browse files

Merge changes If6909f59,Iede4f442

* changes:
  floss: Update README with newer build instructions
  floss: Add bootstrap script to simplify setup
parents 233951e4 13576354
Loading
Loading
Loading
Loading
+69 −21
Original line number Diff line number Diff line
@@ -13,17 +13,21 @@ Instructions for a Debian based distribution:
* Bison 3.x.x (tested with 3.0.x, 3.2.x and 3.7.x)

You'll want to download some pre-requisite packages as well. If you're currently
configured for AOSP development, you should have all required packages.
Otherwise, you can use the following apt-get list:
configured for AOSP development, you should have most required packages.
Otherwise, you can use the following apt-get list or use the bootstrap script
(see below) to get a list of packages missing on your system:

```sh
sudo apt-get install repo git-core gnupg flex bison gperf build-essential \
  zip curl zlib1g-dev gcc-multilib g++-multilib \
  x11proto-core-dev libx11-dev lib32z-dev libncurses5 \
  x11proto-core-dev libx11-dev libncurses5 \
  libgl1-mesa-dev libxml2-utils xsltproc unzip liblz4-tool libssl-dev \
  libc++-dev libevent-dev \
  flatbuffers-compiler libflatbuffers1 \
  openssl openssl-dev
  flatbuffers-compiler libflatbuffers1 openssl \
  libflatbuffers-dev libtinyxml2-dev \
  libglib2.0-dev libevent-dev libnss3-dev libdbus-1-dev \
  libprotobuf-dev ninja-build generate-ninja protobuf-compiler \
  libre2-9
```

You will also need a recent-ish version of Rust and Cargo. Please follow the
@@ -37,14 +41,20 @@ cd ~/fluoride
git clone https://android.googlesource.com/platform/packages/modules/Bluetooth/system
```

Install dependencies (require sudo access). This adds some Ubuntu dependencies
and also installs GN (which is the build tool we're using).
### Use bootstrap.py

`bootstrap.py` is a helper script provided to set up your build environment. It
will set up your build staging directory and also make sure you have all
required system packages to build (should work on Debian and Ubuntu). You will
still need to build some unpackaged dependencies.

To use it:
```sh
cd ~/fluoride/bt
build/install_deps.sh
./bootstrap.py --base-dir=path/to/staging/dir --bt-dir=path/to/bt/dir
```

### Build dependencies

The following third-party dependencies are necessary but currently unavailable
via a package manager. You may have to build these from source and install them
to your local environment.
@@ -52,24 +62,59 @@ to your local environment.
* libchrome
* modp_b64

We provide a script to produce debian packages for those components, please
follow the instructions in build/dpkg/README.txt.
We provide a script to produce debian packages for those components. Please
see the instructions in build/dpkg/README.txt for more details.

```sh
cd build/dpkg
mkdir -p outdir/{modp_b64,libchrome}

# Build and install modp_b64
pushd modp_b64
./gen-src-pkg.sh $(readlink -f ../outdir/modp_b64)
popd
sudo dpkg -i outdir/modp_b64/*.dpkg

# Build and install libchrome
pushd libchrome
./gen-src-pkg.sh $(readlink -f ../outdir/libchrome)
popd
sudo dpkg -i outdir/libchrome/*.dpkg
```

The googletest packages provided by Debian/Ubuntu (libgmock-dev and
libgtest-dev) do not provide pkg-config files, so you can build your own
googletest using the steps below:

```sh
git clone https://github.com/google/googletest.git -b release-1.10.0
cd googletest        # Main directory of the cloned repository.
mkdir build          # Create a directory to hold the build output.
cd build
cmake ..             # Generate native build scripts for GoogleTest.
sudo make install -DCMAKE_INSTALL_PREFIX=/usr

# Optional steps if pkgconfig isn't installed to desired location
# Modify the source (/usr/lib/x86_64-linux-gnu) and target (/usr/lib) based on
# your local installation.
for f in $(ls /usr/lib/x86_64-linux-gnu/pkgconfig/{gtest,gmock}*); do \
  ln -sf $f /usr/lib/pkgconfig/$(basename $f);
done
```
$ git clone https://github.com/google/googletest.git -b release-1.10.0
$ cd googletest        # Main directory of the cloned repository.
$ mkdir build          # Create a directory to hold the build output.
$ cd build
$ cmake ..             # Generate native build scripts for GoogleTest.
$ sudo make install -DCMAKE_INSTALL_PREFIX=/usr

### Rust dependencies

**Note**: Handled by bootstrap script.

Run the following to install Rust dependencies:
```
cargo install cxxbridge-cmd
```

### Stage your build environment

**Note**: Handled by bootstrap script.

For host build, we depend on a few other repositories:
* [Platform2](https://chromium.googlesource.com/chromiumos/platform2/)
* [Rust crates](https://chromium.googlesource.com/chromiumos/third_party/rust_crates/)
@@ -89,7 +134,10 @@ ln -s $(readlink -f ${PROTO_LOG_DIR}) ${STAGING_DIR}/external/proto_logging
### Build

We provide a build script to automate building assuming you've staged your build
environment already as above.
environment already as above. At this point, make sure you have all the
pre-requisites installed (i.e. bootstrap script and other dependencies above) or
you will see failures. In addition, you may need to set a `--libdir=` if your
libraries are not stored in `/usr/lib64` by default.


```sh
@@ -114,9 +162,9 @@ Currently, Rust builds are a separate stage that uses Cargo to build. See
### Run

By default on Linux, we statically link libbluetooth so you can just run the
binary directly:
binary directly. By default, it will try to run on hci0 but you can pass it
--hci=N, where N corresponds to /sys/class/bluetooth/hciN.

```sh
cd ~/fluoride/bt/out/Default
./bluetoothtbd -create-ipc-socket=fluoride
$OUTPUT_DIR/debug/btadapterd --hci=$HCI INIT_gd_hci=true
```

bootstrap.py

0 → 100755
+243 −0
Original line number Diff line number Diff line
#!/usr/bin/env python3

#  Copyright 2021 Google, Inc.
#
#  Licensed under the Apache License, Version 2.0 (the "License");
#  you may not use this file except in compliance with the License.
#  You may obtain a copy of the License at:
#
#  http://www.apache.org/licenses/LICENSE-2.0
#
#  Unless required by applicable law or agreed to in writing, software
#  distributed under the License is distributed on an "AS IS" BASIS,
#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
#  See the License for the specific language governing permissions and
#  limitations under the License.
""" Bootstrap script to help set up Linux build. """

import argparse
import os
import subprocess

PLATFORM2_GIT = 'https://chromium.googlesource.com/chromiumos/platform2'
RUST_CRATES_GIT = 'https://chromium.googlesource.com/chromiumos/third_party/rust_crates'
PROTO_LOGGING_GIT = 'https://android.googlesource.com/platform/frameworks/proto_logging'

# List of packages required for linux build
REQUIRED_APT_PACKAGES = [
    'bison',
    'build-essential',
    'curl',
    'flatbuffers-compiler',
    'flex',
    'g++-multilib',
    'gcc-multilib',
    'generate-ninja',
    'gnupg',
    'gperf',
    'libc++-dev',
    'libdbus-1-dev',
    'libevent-dev',
    'libevent-dev',
    'libflatbuffers-dev',
    'libflatbuffers1',
    'libgl1-mesa-dev',
    'libglib2.0-dev',
    'liblz4-tool',
    'libncurses5',
    'libnss3-dev',
    'libprotobuf-dev',
    'libre2-9',
    'libssl-dev',
    'libtinyxml2-dev',
    'libx11-dev',
    'libxml2-utils',
    'ninja-build',
    'openssl',
    'protobuf-compiler',
    'unzip',
    'x11proto-core-dev',
    'xsltproc',
    'zip',
    'zlib1g-dev',
]

# List of cargo packages required for linux build
REQUIRED_CARGO_PACKAGES = ['cxxbridge-cmd']

APT_PKG_LIST = ['apt', '-qq', 'list']
CARGO_PKG_LIST = ['cargo', 'install', '--list']


class Bootstrap():

    def __init__(self, base_dir, bt_dir):
        """ Construct bootstrapper.

        Args:
            base_dir: Where to stage everything.
            bt_dir: Where bluetooth source is kept (will be symlinked)
        """
        self.base_dir = os.path.abspath(base_dir)
        self.bt_dir = os.path.abspath(bt_dir)

        if not os.path.isdir(self.base_dir):
            raise Exception('{} is not a valid directory'.format(self.base_dir))

        if not os.path.isdir(self.bt_dir):
            raise Exception('{} is not a valid directory'.format(self.bt_dir))

        self.git_dir = os.path.join(self.base_dir, 'repos')
        self.staging_dir = os.path.join(self.base_dir, 'staging')
        self.output_dir = os.path.join(self.base_dir, 'output')
        self.external_dir = os.path.join(self.base_dir, 'staging', 'external')

        self.dir_setup_complete = os.path.join(self.base_dir, '.setup-complete')

    def _setup_platform2(self):
        """ Set up platform2.

        This will check out all the git repos and symlink everything correctly.
        """

        # If already set up, exit early
        if os.path.isfile(self.dir_setup_complete):
            print('{} is already set-up'.format(self.base_dir))
            return

        # Create all directories we will need to use
        for dirpath in [self.git_dir, self.staging_dir, self.output_dir, self.external_dir]:
            os.makedirs(dirpath)

        # Check out all repos in git directory
        for repo in [PLATFORM2_GIT, RUST_CRATES_GIT, PROTO_LOGGING_GIT]:
            subprocess.check_call(['git', 'clone', repo], cwd=self.git_dir)

        # Symlink things
        symlinks = [
            (os.path.join(self.git_dir, 'platform2', 'common-mk'), os.path.join(self.staging_dir, 'common-mk')),
            (os.path.join(self.git_dir, 'platform2', '.gn'), os.path.join(self.staging_dir, '.gn')),
            (os.path.join(self.bt_dir), os.path.join(self.staging_dir, 'bt')),
            (os.path.join(self.git_dir, 'rust_crates'), os.path.join(self.external_dir, 'rust')),
            (os.path.join(self.git_dir, 'proto_logging'), os.path.join(self.external_dir, 'proto_logging')),
        ]

        # Create symlinks
        for pairs in symlinks:
            (src, dst) = pairs
            os.symlink(src, dst)

        # Write to setup complete file so we don't repeat this step
        with open(self.dir_setup_complete, 'w') as f:
            f.write('Setup complete.')

    def _pretty_print_install(self, install_cmd, packages, line_limit=80):
        """ Pretty print an install command.

        Args:
            install_cmd: Prefixed install command.
            packages: Enumerate packages and append them to install command.
            line_limit: Number of characters per line.

        Return:
            Array of lines to join and print.
        """
        install = [install_cmd]
        line = '  '
        # Remainder needed = space + len(pkg) + space + \
        # Assuming 80 character lines, that's 80 - 3 = 77
        line_limit = line_limit - 3
        for pkg in packages:
            if len(line) + len(pkg) < line_limit:
                line = '{}{} '.format(line, pkg)
            else:
                install.append(line)
                line = '  {} '.format(pkg)

        if len(line) > 0:
            install.append(line)

        return install

    def _check_package_installed(self, package, cmd, predicate):
        """Check that the given package is installed.

        Args:
            package: Check that this package is installed.
            cmd: Command prefix to check if installed (package appended to end)
            predicate: Function/lambda to check if package is installed based
                       on output. Takes string output and returns boolean.

        Return:
            True if package is installed.
        """
        try:
            output = subprocess.check_output(cmd + [package], stderr=subprocess.STDOUT)
            is_installed = predicate(output.decode('utf-8'))
            print('  {} is {}'.format(package, 'installed' if is_installed else 'missing'))

            return is_installed
        except Exception as e:
            print(e)
            return False

    def _print_missing_packages(self):
        """Print any missing packages found via apt.

        This will find any missing packages necessary for build using apt and
        print it out as an apt-get install printf.
        """
        print('Checking for any missing packages...')
        need_packages = []
        for pkg in REQUIRED_APT_PACKAGES:
            if not self._check_package_installed(pkg, APT_PKG_LIST, lambda output: 'installed' in output):
                need_packages.append(pkg)

        # No packages need to be installed
        if len(need_packages) == 0:
            print('All required packages are installed')
            return

        install = self._pretty_print_install('sudo apt-get install', need_packages)

        # Print all lines so they can be run in cmdline
        print('Missing system packages. Run the following command: ')
        print(' \\\n'.join(install))

    def _print_missing_rust_packages(self):
        """Print any missing packages found via cargo.

        This will find any missing packages necessary for build using cargo and
        print it out as a cargo-install printf.
        """
        print('Checking for any missing cargo packages...')
        need_packages = []

        for pkg in REQUIRED_CARGO_PACKAGES:
            if not self._check_package_installed(pkg, CARGO_PKG_LIST, lambda output: pkg in output):
                need_packages.append(pkg)

        # No packages to be installed
        if len(need_packages) == 0:
            print('All required cargo packages are installed')
            return

        install = self._pretty_print_install('cargo install', need_packages)
        print('Missing cargo packages. Run the following command: ')
        print(' \\\n'.join(install))

    def bootstrap(self):
        """ Bootstrap the Linux build."""
        self._setup_platform2()
        self._print_missing_packages()
        self._print_missing_rust_packages()


if __name__ == '__main__':
    parser = argparse.ArgumentParser(description='Bootstrap Linux build')
    parser.add_argument('--base-dir', help='Where to create build directories.', required=True)
    parser.add_argument('--bt-dir', help='Path to packages/modules/Bluetooth/system', required=True)

    args = parser.parse_args()
    bootstrap = Bootstrap(args.base_dir, args.bt_dir)
    bootstrap.bootstrap()

system/build/install_deps.sh

deleted100755 → 0
+0 −58
Original line number Diff line number Diff line
#!/bin/bash
CLANG_PACKAGE=clang
GNSHA1_URL="https://chromium.googlesource.com/chromium/buildtools/\
  +/central/linux64/gn.sha1?format=TEXT"

# Check if clang is already installed on current system
clang_path=`which clang`
if [ -f "$clang_path" ]; then
  # if clang binary is avalable, check its version
  clang_version=$($clang_path --version | grep clang | sed "s/.*version\s*\([0-9]*\.[0-9]*\).*/\1/")
  IFS="." read -ra clang_version_array <<< "$clang_version"
  clang_version_major=${clang_version_array[0]}
  clang_version_minor=${clang_version_array[1]}
  # if the version is greater than 3.5 then do not install clang here
  if [ $clang_version_major -ge 3 ] && [ $clang_version_minor -ge 5 ]; then
    echo "Detected clang $clang_version"
    CLANG_PACKAGE=""
  fi
fi

if [ ! -z "$CLANG_PACKAGE" ]; then
  # Try to find clang from a known list
  for clang_version in 12.0 11.0
  do
    clang_path=`which clang-$clang_version`
    if [ -f "$clang_path" ]; then
      echo "Detected clang-$clang_version"
      CLANG_PACKAGE=""
      break
    fi
  done
fi

if [ ! -z "$CLANG_PACKAGE" ]; then
  echo "clang not found on current system, installing"
  if [ -f /etc/lsb-release ]; then
    # Ubuntu
    ubuntu_version=$(lsb_release --release --short)
    IFS="." read -ra ubuntu_version_array <<< "$ubuntu_version"
    ubuntu_version_major=${ubuntu_version_array[0]}
    ubuntu_version_minor=${ubuntu_version_array[1]}
    if [ $ubuntu_version_major -lt 15 ]; then
      echo "Choose clang-3.8 for Ubuntu 14 and below"
      CLANG_PACKAGE=clang-3.8
    fi
  fi
fi

sudo apt-get -y install $CLANG_PACKAGE libevent-dev libc++-dev libc++abi-dev \
  ninja-build libflatbuffers-dev libtinyxml2-dev

gn_path=`which gn`
if [ -z $gn_path ]; then
  gnsha1=$(curl $GNSHA1_URL | base64 -d)
  wget -O gn http://storage.googleapis.com/chromium-gn/$gnsha1
  chmod a+x ./gn
  sudo mv ./gn /usr/bin/
fi