| commit | 39ee1f4b336c7e6b25be0df6375c18dcbd577c09 | [log] [tgz] |
|---|---|---|
| author | armvixl <armvixl@arm.com> | Wed Oct 01 15:30:17 2014 +0100 |
| committer | Alexandre Rames <alexandre.rames@arm.com> | Wed Oct 01 15:30:17 2014 +0100 |
| tree | 8d0e0064a18cd3bd1aa3d6929803a5ce8732a19a | |
| parent | e1ab25cde167109efb28fa6a86d5c2c80b762d58 [diff] |
VIXL Release 1.6 Refer to the README.md and LICENCE files for details. Change-Id: Ieefe83cf5cf5e1ab8c924b0e7dc03af6a55053ae Signed-off-by: Alexandre Rames <alexandre.rames@arm.com>
Contents:
To build VIXL the following software is required:
A 64-bit host machine is required, implementing an LP64 data model. VIXL has only been tested using GCC on AArch64 Debian and amd64 Ubuntu systems.
To run the linter stage of the tests, the following software is also required:
Refer to the ‘Usage’ section for details.
VIXL is made of three components.
The VIXL git repository can be found on GitHub.
Changes from previous versions of VIXL can be found in the Changelog.
VIXL was developed to target JavaScript engines so a number of features from A64 were deemed unnecessary:
The VIXL simulator supports only those instructions that the VIXL assembler can generate. The doc directory contains a list of supported instructions.
The VIXL simulator was developed to run on 64-bit amd64 platforms. Whilst it builds and mostly works for 32-bit x86 platforms, there are a number of floating-point operations which do not work correctly, and a number of tests fail as a result.
All exclusive-access instructions are supported, but the simulator cannot accurately simulate their behaviour as described in the ARMv8 ARM.
__sync_synchronize() is used for this purpose.The simulator tries to be strict, and implements the following restrictions that the ARMv8 ARM allows:
Instructions affected by these limitations: stxrb, stxrh, stxr, ldxrb, ldxrh, ldxr, stxp, ldxp, stlxrb, stlxrh, stlxr, ldaxrb, ldaxrh, ldaxr, stlxp, ldaxp, stlrb, stlrh, stlr, ldarb, ldarh, ldar, clrex.
The helper script tools/presubmit.py will build and run every test that is provided with VIXL, in both release and debug mode. It is a useful script for verifying that all of VIXL's dependencies are in place and that VIXL is working as it should.
By default, the tools/presubmit.py script runs a linter to check that the source code conforms with the code style guide, and to detect several common errors that the compiler may not warn about. This is most useful for VIXL developers. The linter has the following dependencies:
git clone.cpplint.py, as provided by Google, must be available (and executable) on the PATH. Only revision 104 has been tested with VIXL.It is possible to tell tools/presubmit.py to skip the linter stage by passing --nolint. This removes the dependency on cpplint.py and Git. The --nolint option is implied if the VIXL project is a snapshot (with no .git directory).
There are three very basic benchmarks provided with VIXL:
Build these benchmarks using scons bench-dataop, scons bench-branch and scons bench-branch-link. This will produce binaries called bench-dataop_sim, bench-branch_sim and bench-branch-link_sim. Run these with an iteration count argument, for example ./bench-dataop_sim 10000000. The benchmarks do not report a result; time them using the UNIX time command.
Build the benchmarks natively for execution on an AArch64 target using scons <benchmark name> simulator=off. This will produce binaries called bench-dataop, bench-branch and bench-branch-link. Run and time these in the same way as the simulator versions.
A short introduction to using VIXL can be found here. Example source code is provided in the examples directory. You can build all the examples with scons examples from the root directory, or use scons --help to get a detailed list of available build targets.
On top of the here page and the examples, you can find documentation and guides on various topics that may be of help here.