Commit graph

41 commits

Author SHA1 Message Date
Elliott Hughes
e6d6efdb67 Add another link to the benchmark docs.
There is one at the top of the main readme, but multiple people have
failed to find that, so add another link in the part of the doc they are
looking at instead...

Test: treehugger
Change-Id: I953f95a6cfcea079110923d58b60a4f7ff9b8ed2
2024-02-21 15:52:10 +00:00
Elliott Hughes
cfc3090868 Give a bit more background on "uapi headers".
Not everyone knows what these are, and we don't otherwise explain it.

Test: N/A
Change-Id: Ic28e4fd0f8584f5e808ab60f0c2e68dd0cf30088
2024-01-11 00:09:25 +00:00
Elliott Hughes
7468ac257a Clarify what's in the upstream- directories...
...and how they got that way.

Test: treehugger
Change-Id: I07e2881781224f9b698008bd165b28a89b620dac
2024-01-10 00:25:30 +00:00
Elliott Hughes
9c06d16ca3 s/master/main/
Test: treehugger
Change-Id: I2c975b2f5f92f23c7357b6f7e785578504298cc6
2023-10-04 23:36:48 +00:00
Dan Albert
b9bc50910e Add musl handling in run-on-host.sh.
Bug: None
Test: ./tests/run-on-host.sh glibc
Test: ./tests/run-on-host.sh musl
Change-Id: I4f85310750402e1187358aeb4a585f26092b97ac
2023-07-19 21:53:11 +00:00
Elliott Hughes
31fc69f67f Fix tzalloc(nullptr) and add a test.
This works (by reading /etc/localtime) on NetBSD, but not on Android
since we have no such file. Fix that by using our equivalent system
property instead.

Also s/time zone/timezone/ in documentation and comments. We've always
been inconsistent about this (as is upstream in code comments and
documentation) but it seems especially odd now we expose a _type_ that
spells it "timezone" to talk of "time zone" even as we're describing
that type and its associated functions.

Bug: https://github.com/chronotope/chrono/issues/499
Test: treehugger
Change-Id: I142995a3ab4deff1073a0aa9e63ce8eac850b93d
2023-06-22 09:51:01 -07:00
Elliott Hughes
32c9572424 Explain the header tests better.
Bug: https://github.com/google/android-riscv64/issues/88
Test: N/A
Change-Id: Ia2a8673e96eb7aeb795fb7158f4814e5af9c8e94
2023-05-08 19:14:28 +00:00
zijunzhao
a3696c13cf Update the README.md
1. Update the link for device test.

2. Reformat the file.

Bugs: None
Test: None
Change-Id: I88b928d7b2247fb31e8adbd92a19f944cf0bafd4
2022-11-10 00:01:15 +00:00
zijunzhao
e5e1e4e55a Improve the "how to add a system call" doc
Test: None
Bug: None
Change-Id: Ie4212956836ae057009e6985812efcbbb7859dea
2022-05-10 22:07:31 +00:00
Elliott Hughes
6b8b22c7d1 Improve the "how to add a system call" documentation.
A few more clarifications based on experience...

Test: N/A
Change-Id: I74ffd89f5f2ac1266b057803c555cd7f7cb59128
2022-04-22 16:12:21 -07:00
Elliott Hughes
4ece2d6183 Polish the syscall docs a bit more.
Test: N/A
Change-Id: Ic408e82721bd0446ea99884dc149af4a8ceaa492
2022-04-11 13:36:18 -07:00
Elliott Hughes
a96306c60d Improve the documentation about adding trivial syscall wrappers.
Test: treehugger
Change-Id: I49040d0284e1d1254b8571a699a44b43ea8d911b
2022-04-01 15:56:31 -07:00
Dan Albert
837b683b46 Update bionic coverage docs.
These docs refer to the old coverage workflow from the Android.mk
build.

AFAIK there's no way to get coverage for the host tests, so that part
was removed.

Test: followed the docs, got coverage data
Bug: None
Change-Id: Ibef5ae2d354296a77b752d3b7c9c48cf7a34ef98
2021-10-18 16:32:53 -07:00
Elliott Hughes
56a9fda610 Remove dead code.
We haven't built any of this for years.

Test: treehugger
Change-Id: I3f8a85e9530af68587f47931d850eb60631a9481
2020-02-13 22:25:02 -08:00
Elliott Hughes
7ac0023c2d Remove reference to obsolete script.
Test: N/A
Change-Id: I3f4b8574d82cf6b2faedd03a256bc75130f3c016
2019-06-17 13:16:45 -07:00
Neil Fuller
a7db90f32d Move /system dependency on tz_version to bionic
Move /system dependency on tz_version to bionic from core-libart.

The file is not used by code but is useful on device to identify
the format / version / origin of the tzdata file. The
tz_version file identifies the Android release (e.g. 3.1 == Q), which
implies the version of zic used to generate tzdata, and any Android
revision of the tzdata (e.g. 2019a v2) that may have taken place. The
file was previously used by by the tzdatacheck binary but it has since
switched to using the copy in the runtime module.

The bionic README.md is also updated here to reflect latest locations of
scripts.

Bug: 131239046
Test: make installclean / make droid / inspect /system
Change-Id: Ib142f98aa30c8c9d5eda33df55d4191478570ced
2019-04-25 09:35:58 +01:00
Elliott Hughes
782c485880 Generate assembler system call stubs via genrule.
There's no need to check in generated code.

Test: builds & boots
Change-Id: Ife368bca4349d4adeb0666db590356196b4fbd63
2019-04-16 12:31:00 -07:00
Elliott Hughes
84941fe1e5 Explain up-front what bionic actually _is_.
Also fix formatting of "What's in libc/?" section, and remove obsolete
include/machine.

Also unify # vs --- syntax.

Bug: N/A
Test: N/A
Change-Id: I6a7a2828e700d5e03c7209f55691278326230bd1
2018-09-04 13:37:25 -07:00
Elliott Hughes
1a1b57cb83 Document the rules of thumb for "should I add a syscall wrapper?".
This isn't well known, and causes confusion for at least a couple of
people each year.

Bug: N/A
Test: N/A
Change-Id: I43127d937ee81d0c79bbc496638a1b1b6003dd80
2018-02-08 09:53:59 -08:00
Sergii Piatakov
c3e30604b4 test: trivial fixes in documentation
Fix wrong names of test binaries in README.md.

Test: bionic device tests
Change-Id: Ie96d8edb7e2aa85f3c690e0f92064b37f66debfd
Signed-off-by: Sergii Piatakov <sergii.piatakov@globallogic.com>
2017-11-03 10:33:56 +02:00
Elliott Hughes
0bfcbaf4d0 Add new status document, based on internal wiki.
Also start breaking up the monolithic top level README.md, pulling the
32-bit ABI stuff out into its own file, and moving the remaining benchmark
documentation in with the rest of the benchmark documentation.

Bug: N/A
Test: N/A
Change-Id: Ic1b9995e27b5044199ed34883cc0b8faa894df0e
2017-08-29 11:07:36 -07:00
Anders Lewis
814359a880 Update the bionic benchmarks documentation.
Test: NA
Change-Id: I6b804a1655b5cb76f189366070d478680f40c5d1
2017-08-25 10:41:38 -07:00
Elliott Hughes
a57c87827c Explain how to handle device-specific headers.
Bug: N/A
Test: N/A
Change-Id: I12c41fcb4839ad86f5a1f62153a3348c3e40f90f
2017-07-20 10:36:27 -07:00
Elliott Hughes
9ada00a82c Document the intricacies of _FILE_OFFSET_BITS=32 for LP32.
Bug: https://github.com/android-ndk/ndk/issues/453
Test: N/A
Change-Id: I5c00e63c861b19071229d2eae737dfbeb550e7e8
2017-07-17 15:00:41 -07:00
Elliott Hughes
0e8804e154 Document how to run CTS in the public documentation too.
Bug: N/A
Test: N/A
Change-Id: Ib9f46d09b56795d5202ec7167328042381cdc667
2016-12-05 13:48:04 -08:00
Josh Gao
6cd1c92dc9 Add note about pid_max to host test documentation.
Bug: none
Test: none
Change-Id: I3e446744076131329201543fa29b71fc4f843728
2016-11-17 18:52:09 -08:00
Elliott Hughes
9163d846d6 Document how to run the benchmarks.
Test: N/A
Change-Id: I13bf4f1b5a218e06e68ff8eb8156843175f2648a
2016-11-08 15:41:02 -08:00
Elliott Hughes
86f1e04e01 Update testing docs.
Change-Id: Ic0e1c3105d1cf8e73c0fbfd51052895beed76227
2016-08-01 13:16:37 -07:00
Elliott Hughes
20758d58dd Expand the testing docs slightly.
Change-Id: I4b172eefd8f456a62b24520a9f04f500a1d6bc85
2016-07-19 14:09:10 -07:00
Elliott Hughes
e2bfe2afaf Update the "adding a syscall" docs.
Change-Id: I78adafb1c1c491f641a82a02ad7f03cd3f8c7d1e
2016-05-26 13:55:37 -07:00
Christopher Ferris
63860cb8fd Malloc debug rewrite.
The major components of the rewrite:

- Completely remove the qemu shared library code. Nobody was using it
  and it appears to have broken at some point.
- Adds the ability to enable/disable different options independently.
- Adds a new option that can enable the backtrace on alloc/free when
  a process gets a specific signal.
- Adds a new way to enable malloc debug. If a special property is
  set, and the process has an environment variable set, then debug
  malloc will be enabled. This allows something that might be
  a derivative of app_process to be started with an environment variable
  being enabled.
- get_malloc_leak_info() used to return one element for each pointer that
  had the exact same backtrace. The new version returns information for
  every one of the pointers with same backtrace. It turns out ddms already
  automatically coalesces these, so the old method simply hid the fact
  that there where multiple pointers with the same amount of backtrace.
- Moved all of the malloc debug specific code into the library.
  Nothing related to the malloc debug data structures remains in libc.
- Removed the calls to the debug malloc cleanup routine. Instead, I
  added an atexit call with the debug malloc cleanup routine. This gets
  around most problems related to the timing of doing the cleanup.

The new properties and environment variables:

libc.debug.malloc.options
  Set by option name (such as "backtrace"). Setting this to a bad value
  will cause a usage statement to be printed to the log.

libc.debug.malloc.program
  Same as before. If this is set, then only the program named will
  be launched with malloc debug enabled. This is not a complete match,
  but if any part of the property is in the program name, malloc debug is
  enabled.

libc.debug.malloc.env_enabled
  If set, then malloc debug is only enabled if the running process has the
  environment variable LIBC_DEBUG_MALLOC_ENABLE set.

Bug: 19145921

Change-Id: I7b0e58cc85cc6d4118173fe1f8627a391b64c0d7
2016-01-25 10:54:21 -08:00
Josh Gao
0ac0cee0d1 Remove dlmalloc.
Bug: http://b/17207577
Change-Id: Ie009badca6deb1f91b27a4340b70cdd6bedff893
2016-01-25 10:14:35 -08:00
Elliott Hughes
59fc2e8557 Improve the 32-bit ABI documentation.
Change-Id: Ie5bfc8d6f7f3946100f653de0e006072e56e18d6
2015-12-19 09:36:16 -08:00
Dan Albert
1af434cc02 Add a hint about using --no-isolate for GDB.
Change-Id: Ib9df5ed986a1c4082c9c7cd793a4d670be21ca66
2015-09-18 13:17:02 -07:00
Duane Sand
a40a21110d Fix test steps for 64-bit bionic
Change-Id: Ibe76f22cdb5c0dbc69a24ffd0acffff89686ca35
2015-08-11 17:21:27 -07:00
Elliott Hughes
d3d018b2b4 Update README.md for running tests on the host.
Change-Id: Ib360d91bffd269e7acdb20ad33a7bd85345a1475
2015-04-01 12:16:56 -07:00
Dan Albert
79b9830b1d Markdown-ify 5137db3.
Most of these are just aesthetic, but the `_FILE_OFFSET_BITS` probably
would have rendered partly as italics and skipped some underscores.

GitHub's Markdown also doesn't identify our bug URLs as links, so mark
them explicitly.

Change-Id: I62be7542aa43929d847de2bad7d8d1ed3aaa640c
2015-01-09 15:29:46 -08:00
Elliott Hughes
0b1de06910 Add our LP32 ABI defects to the readme.
Change-Id: Id77a3dbf6b91243c57528ed86ca24100d8795907
2015-01-09 12:21:24 -08:00
Dan Albert
e66d57f532 Add documentation about checkbuild.
Change-Id: I2c2d06bc0dc3cdc58b5563f62889122b76f3c469
2014-11-12 17:08:38 -08:00
Dan Albert
472cce5c98 Fix some formatting so GitHub displays it nicely.
Change-Id: Id6ce9a61bebd98544c85e5780147715c73d0e78b
2014-10-10 17:14:37 -07:00
Dan Albert
efee1ce46a Improve documentation for testing and coverage.
Also rename HACKING.txt to README.md so it will display on the GitHub
mirror.

Change-Id: I70157a4ad262700212bf9afd87253d195c7013a9
2014-10-10 11:45:19 -07:00
Renamed from HACKING.txt (Browse further)