contrib/arm-optimized-routines/README

   1 Arm Optimized Routines
   2 ----------------------
   3
   4 This repository contains implementations of library functions
   5 provided by Arm. The outbound license is available under a dual
   6 license, at the user’s election, as reflected in the LICENSE file.
   7 Contributions to this project are accepted, but Contributors have
   8 to sign an Assignment Agreement, please follow the instructions in
   9 contributor-agreement.pdf. This is needed so upstreaming code
  10 to projects that require copyright assignment is possible. Further
  11 contribution requirements are documented in README.contributors of
  12 the appropriate subdirectory.
  13
  14 Regular quarterly releases are tagged as vYY.MM, the latest
  15 release is v23.01.
  16
  17 Source code layout:
  18
  19 build/          - build directory (created by make).
  20 math/           - math subproject sources.
  21 math/include/   - math library public headers.
  22 math/test/      - math test and benchmark related sources.
  23 math/tools/     - tools used for designing the algorithms.
  24 networking/     - networking subproject sources.
  25 networking/include/ - networking library public headers.
  26 networking/test/ - networking test and benchmark related sources.
  27 string/         - string routines subproject sources.
  28 string/include/ - string library public headers.
  29 string/test/    - string test and benchmark related sources.
  30 pl/...          - separately maintained performance library code.
  31
  32 The steps to build the target libraries and run the tests:
  33
  34 cp config.mk.dist config.mk
  35 # edit config.mk if necessary ...
  36 make
  37 make check
  38
  39 Or building outside of the source directory:
  40
  41 ln -s path/to/src/Makefile Makefile
  42 cp path/to/src/config.mk.dist config.mk
  43 echo 'srcdir = path/to/src' >> config.mk
  44 # further edits to config.mk
  45 make
  46 make check
  47
  48 Or building and testing the math subproject only:
  49
  50 make all-math
  51 make check-math
  52
  53 The test system requires libmpfr and libmpc.
  54 For example on debian linux they can be installed as:
  55
  56 sudo apt-get install libmpfr-dev libmpc-dev
  57
  58 For cross build, CROSS_COMPILE should be set in config.mk and EMULATOR
  59 should be set for cross testing (e.g. using qemu-user or remote access
  60 to a target machine), see the examples in config.mk.dist.