Skip to content

Commit

Permalink
Added README section about supported platforms
Browse files Browse the repository at this point in the history
  • Loading branch information
apangin committed Oct 8, 2017
1 parent b7c1c46 commit 48c836c
Showing 1 changed file with 7 additions and 4 deletions.
11 changes: 7 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,10 +37,6 @@ names.
* Does not require writing out a perf.data file for further processing in
user space scripts.

Because of the requirement for `perf_events`, this tool works only on Linux
platforms. Additionally, on some Linux versions, two runtime variables need to
be tuned in order to allow non-root users to use `perf_events`.

## HEAP profiling

Instead of detecting CPU-consuming code, the profiler can be configured
Expand Down Expand Up @@ -76,6 +72,13 @@ Debian / Ubuntu, run
# apt-get install openjdk-8-dbg
```

## Supported platforms

- **Linux** / x64 / x86 / ARM / AArch64
- **macOS** / x64

Note: macOS profiling is limited only to Java code, since native stack walking relies on `perf_events` API which is available only on Linux platforms.

## Building

Build status: [![Build Status](https://travis-ci.org/jvm-profiling-tools/async-profiler.svg?branch=master)](https://travis-ci.org/jvm-profiling-tools/async-profiler)
Expand Down

0 comments on commit 48c836c

Please sign in to comment.