File 1208-compiler-Add-absolute_source-option.patch of Package erlang

Overview Repositories Revisions Requests Users Attributes Meta

File 1208-compiler-Add-absolute_source-option.patch of Package erlang (Revision 3568a86b92b30ede35d5250ff17067fe)

Currently displaying revision 3568a86b92b30ede35d5250ff17067fe , Show latest

From c6330eed865e9de7ff1ad0577aceef955a085382 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?John=20H=C3=B6gberg?= <john@erlang.org>
Date: Fri, 8 Oct 2021 16:03:04 +0200
Subject: [PATCH 8/9] compiler: Add +absolute_source option

This lets `perf` and `gdb` show Erlang source code instead of just
saying "file.erl:1234"

OTP can be built with this information by passing it in the
`ERL_COMPILER_OPTIONS` environment variable:

ERL_COMPILER_OPTIONS="[absolute_source]" ./otp_build setup -a
---
 erts/emulator/internal_doc/BeamAsm.md | 4 ++++
 lib/compiler/doc/src/compile.xml      | 8 ++++++++
 lib/compiler/src/compile.erl          | 9 +++++++--
 lib/compiler/test/compile_SUITE.erl   | 9 +++++++--
 4 files changed, 26 insertions(+), 4 deletions(-)

diff --git a/erts/emulator/internal_doc/BeamAsm.md b/erts/emulator/internal_doc/BeamAsm.md
index 44f2c758c5..8a74e22ee5 100644
--- a/erts/emulator/internal_doc/BeamAsm.md
+++ b/erts/emulator/internal_doc/BeamAsm.md
@@ -414,6 +414,10 @@ or by pressing `a` in the `perf report` ui. Then you get something like this:
 
 ![Linux Perf FlameGraph: dialyzer PLT build](figures/beamasm-perf-annotate.png)
 
+`perf annotate` will interleave the listing with the original source code
+whenever possible. You can use the `+{source,Filename}` or `+absolute_paths`
+compiler options to tell `perf` where to find the source code.
+
 > *WARNING*: Calling `perf inject --jit` will create a lot of files in `/tmp/`
 > and in `~/.debug/tmp/`. So make sure to cleanup in those directories from time to
 > time or you may run out of inodes.
diff --git a/lib/compiler/doc/src/compile.xml b/lib/compiler/doc/src/compile.xml
index 073d9b4c25..58fa04aaee 100644
--- a/lib/compiler/doc/src/compile.xml
+++ b/lib/compiler/doc/src/compile.xml
@@ -395,6 +395,14 @@ module.beam: module.erl \
               <c>module_info(compile)</c> and stack traces.</p>
           </item>
 
+	  <tag><c>absolute_source</c></tag>
+          <item>
+            <p>Turns the source file name (as presented in
+              <c>module_info(compile)</c> and stack traces) into an absolute
+              path, which helps external tools like <c>perf</c> and <c>gdb</c>
+              find Erlang source code.</p>
+          </item>
+
 	  <tag><c>{outdir,Dir}</c></tag>
           <item>
             <p>Sets a new directory for the object code. The current
diff --git a/lib/compiler/src/compile.erl b/lib/compiler/src/compile.erl
index 2eeff21714..894cc94c1d 100644
--- a/lib/compiler/src/compile.erl
+++ b/lib/compiler/src/compile.erl
@@ -1008,8 +1008,13 @@ parse_module(_Code, St) ->
 do_parse_module(DefEncoding, #compile{ifile=File,options=Opts,dir=Dir}=St) ->
     SourceName0 = proplists:get_value(source, Opts, File),
     SourceName = case member(deterministic, Opts) of
-                     true -> filename:basename(SourceName0);
-                     false -> SourceName0
+                     true ->
+                         filename:basename(SourceName0);
+                     false ->
+                         case member(absolute_source, Opts) of
+                             true -> paranoid_absname(SourceName0);
+                             false -> SourceName0
+                         end
                  end,
     StartLocation = case with_columns(Opts) of
                         true ->
diff --git a/lib/compiler/test/compile_SUITE.erl b/lib/compiler/test/compile_SUITE.erl
index 12fadd59d5..efee6b9674 100644
--- a/lib/compiler/test/compile_SUITE.erl
+++ b/lib/compiler/test/compile_SUITE.erl
@@ -1703,10 +1703,15 @@ forms_to_terms(Forms) ->
 other_options(Config) ->
     DataDir = proplists:get_value(data_dir, Config),
 
-    %% Smoke test of no_spawn_compiler_process and brief options.
+    %% Smoke test of no_spawn_compiler_process, brief, and absolute_source
+    %% options.
     Big = filename:join(DataDir, "big"),
     {ok,big,<<_/binary>>} =
-        compile:file(Big, [binary, no_spawn_compiler_process, brief, report]),
+        compile:file(Big, [binary,
+                           no_spawn_compiler_process,
+                           brief,
+                           absolute_source,
+                           report]),
 
     %% Test generating a compressed BEAM file. Also cover the redundant
     %% `beam` option and the `no_inline` option.
-- 
2.31.1

Places

File 1208-compiler-Add-absolute_source-option.patch of Package erlang (Revision 3568a86b92b30ede35d5250ff17067fe)

Places