Added docs for external profiling #28538
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
vchuravy
reviewed
Aug 9, 2018
doc/src/manual/profile.md
Outdated
| Depending on the tool you choose, compile with `USE_INTEL_JITEVENTS`, `USE_OPROFILE_JITEVENTS` and | ||
| `USE_PERF_JITEVENTS` set to 1 in `Make.user`. Multiple flags are supported. | ||
|
|
||
| Also before running Julia set the environment variable `ENABLE_JITPROFILING` to 1. |
doc/src/manual/profile.md
Outdated
| # External Profiling | ||
|
|
||
| Currently Julia supports `Intel VTune`, `OProfile` and `perf` as external profiling tools. | ||
| The interfaces are all maintained as LLVM modules, and they support code annotations. |
There was a problem hiding this comment.
I think this sentence can be dropped
doc/src/manual/profile.md
Outdated
| For example with `OProfile` you can try a simple recording : | ||
|
|
||
| ``` | ||
| >sudo operf -Vdebug ./julia test/fastmath.jl |
There was a problem hiding this comment.
I think having the environment variables as part of the script so that copy-paste just works, would be good
doc/src/manual/profile.md
Outdated
| There are many more interesting things that you can measure about your program, to get a comprehensive list | ||
| please read the [Linux perf examples page](http:https://www.brendangregg.com/perf.html). | ||
|
|
||
| Rember that perf saves for each execution a `perf.data` file that, even for small programs, can get |
doc/src/manual/profile.md
Outdated
| please read the [Linux perf examples page](http:https://www.brendangregg.com/perf.html). | ||
|
|
||
| Rember that perf saves for each execution a `perf.data` file that, even for small programs, can get | ||
| a relevant size. Also the perf LLVM module saves temporarly debug objects in `~/.debug/jit`, remember |
There was a problem hiding this comment.
"temporarly" -> "temporary"?
fisiognomico
force-pushed
the
df/profile-docs
branch
from
91226ca
to
b1d6ed2
Compare
vchuravy
approved these changes
Aug 11, 2018
KristofferC
added
backport pending 1.0
domain:docs
KristofferC
pushed a commit
that referenced
this pull request
Oct 19, 2018
(cherry picked from commit 0d050ac)
KristofferC
pushed a commit
that referenced
this pull request
Oct 19, 2018
(cherry picked from commit 0d050ac)
KristofferC
pushed a commit
that referenced
this pull request
Feb 11, 2019
(cherry picked from commit 0d050ac)
KristofferC
pushed a commit
that referenced
this pull request
Feb 20, 2020
(cherry picked from commit 0d050ac)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.