libbacktrace: Add support for NIX_DEBUG_INFO_DIRS #207611

jtojnar · 2022-12-24T19:48:52Z

Description of changes

Clean up the expression, update and apply some patches to fix tests and make it work better on NixOS.

ianlancetaylor/libbacktrace@9b7f216...da7eff2

Includes two unmerged upstream patchsets:

cc @Twey

Things done

jtojnar · 2022-12-24T19:54:15Z

Verified that this works well in conclusion with #200971.

By applying

preCheck = ''
  export NIX_DEBUG_INFO_DIRS=${glib.debug}/lib/debug:${gtk4.debug}/lib/debug
  export LD_PRELOAD=${libsegfault}/lib/libsegfault.so
  export SEGFAULT_SIGNALS=all
'';

I got

 0# (anonymous namespace)::segabort_handler(int) in /nix/store/qj2d2j1sl9qgfdj0yxdvwlxcq7l2sa2n-libsegfault-unstable-2022-11-13/lib/libsegfault.so
 1# 0x00007FFFF6E3DBF0 in /nix/store/ayfr5l52xkqqjn3n4h9jfacgnchz1z7s-glibc-2.35-224/lib/libc.so.6
 2# g_log_writer_default at ../glib/gmessages.c:2844
 3# g_log_structured_array at ../glib/gmessages.c:1967
 4# g_log_structured_standard at ../glib/gmessages.c:2053
 5# get_bus_address_dbus.constprop.0 at ../gtk/a11y/gtkatspicontext.c:1635
 6# get_bus_address.part.0 at ../gtk/a11y/gtkatspicontext.c:1715
 7# gtk_at_spi_create_context at ../gtk/a11y/gtkatspicontext.c:1760
 8# gtk_at_context_create at ../gtk/gtkatcontext.c:569
 9# gtk_widget_accessible_get_at_context at ../gtk/gtkwidget.c:8437
10# gtk_widget_init at ../gtk/gtkwidget.c:2368
11# g_type_create_instance at ../gobject/gtype.c:1917
12# g_object_new_internal at ../gobject/gobject.c:2228
13# g_object_new_valist at ../gobject/gobject.c:2567
14# g_object_new at ../gobject/gobject.c:2044
15# test_marker_layer_new in /build/source/build/tests/marker-layer
16# g_test_run_suite_internal at ../glib/gtestutils.c:3021
17# g_test_run_suite_internal at ../glib/gtestutils.c:3041
18# g_test_run_suite at ../glib/gtestutils.c:3115
19# g_test_run at ../glib/gtestutils.c:2234
20# main in /build/source/build/tests/marker-layer
21# __libc_start_call_main in /nix/store/ayfr5l52xkqqjn3n4h9jfacgnchz1z7s-glibc-2.35-224/lib/libc.so.6
22# __libc_start_main_impl in /nix/store/ayfr5l52xkqqjn3n4h9jfacgnchz1z7s-glibc-2.35-224/lib/libc.so.6
23# _start in /build/source/build/tests/marker-layer

compared to the following (without this patch set):

 0# (anonymous namespace)::segabort_handler(int) in /nix/store/qj2d2j1sl9qgfdj0yxdvwlxcq7l2sa2n-libsegfault-unstable-2022-11-13/lib/libsegfault.so
 1# 0x00007FFFF6E3DBF0 in /nix/store/ayfr5l52xkqqjn3n4h9jfacgnchz1z7s-glibc-2.35-224/lib/libc.so.6
 2# g_log_writer_default in /nix/store/61qy7d70070djqcg135l22v18a5py758-glib-2.74.3/lib/libglib-2.0.so.0
 3# g_log_structured_array in /nix/store/61qy7d70070djqcg135l22v18a5py758-glib-2.74.3/lib/libglib-2.0.so.0
 4# g_log_structured_standard in /nix/store/61qy7d70070djqcg135l22v18a5py758-glib-2.74.3/lib/libglib-2.0.so.0
 5# get_bus_address_dbus.constprop.0 in /nix/store/nxb37gpb5rikxrppjd72rc1d3x91w13l-gtk4-4.8.3/lib/libgtk-4.so.1
 6# get_bus_address.part.0 in /nix/store/nxb37gpb5rikxrppjd72rc1d3x91w13l-gtk4-4.8.3/lib/libgtk-4.so.1
 7# gtk_at_spi_create_context in /nix/store/nxb37gpb5rikxrppjd72rc1d3x91w13l-gtk4-4.8.3/lib/libgtk-4.so.1
 8# gtk_at_context_create in /nix/store/nxb37gpb5rikxrppjd72rc1d3x91w13l-gtk4-4.8.3/lib/libgtk-4.so.1
 9# gtk_widget_accessible_get_at_context in /nix/store/nxb37gpb5rikxrppjd72rc1d3x91w13l-gtk4-4.8.3/lib/libgtk-4.so.1
10# gtk_widget_init in /nix/store/nxb37gpb5rikxrppjd72rc1d3x91w13l-gtk4-4.8.3/lib/libgtk-4.so.1
11# g_type_create_instance in /nix/store/61qy7d70070djqcg135l22v18a5py758-glib-2.74.3/lib/libgobject-2.0.so.0
12# g_object_new_internal in /nix/store/61qy7d70070djqcg135l22v18a5py758-glib-2.74.3/lib/libgobject-2.0.so.0
13# g_object_new_with_properties in /nix/store/61qy7d70070djqcg135l22v18a5py758-glib-2.74.3/lib/libgobject-2.0.so.0
14# g_object_new in /nix/store/61qy7d70070djqcg135l22v18a5py758-glib-2.74.3/lib/libgobject-2.0.so.0
15# test_map_add_layers in /build/source/build/tests/map
16# g_test_run_suite_internal in /nix/store/61qy7d70070djqcg135l22v18a5py758-glib-2.74.3/lib/libglib-2.0.so.0
17# g_test_run_suite_internal in /nix/store/61qy7d70070djqcg135l22v18a5py758-glib-2.74.3/lib/libglib-2.0.so.0
18# g_test_run_suite in /nix/store/61qy7d70070djqcg135l22v18a5py758-glib-2.74.3/lib/libglib-2.0.so.0
19# g_test_run in /nix/store/61qy7d70070djqcg135l22v18a5py758-glib-2.74.3/lib/libglib-2.0.so.0
20# main in /build/source/build/tests/map
21# __libc_start_call_main in /nix/store/ayfr5l52xkqqjn3n4h9jfacgnchz1z7s-glibc-2.35-224/lib/libc.so.6
22# __libc_start_main_impl in /nix/store/ayfr5l52xkqqjn3n4h9jfacgnchz1z7s-glibc-2.35-224/lib/libc.so.6
23# _start in /build/source/build/tests/map

RaitoBezarius · 2022-12-24T20:36:43Z

This should target staging IMHO. Putting in draft to avoid mass pings.

jtojnar · 2022-12-24T21:13:53Z

Why do you want to target staging? It is not very many rebuilds.

RaitoBezarius · 2022-12-24T22:29:10Z

Why do you want to target staging? It is not very many rebuilds.

Sorry, confused 500+ and 101-500. Nevermind my comment.

pkgs/development/libraries/libbacktrace/default.nix

- Prefix version with “unstable-” as per contributing guide - Do not use rec pointlessly - Use `lib.enableFeature` - Add update script - Format the expression - Remove unused callPackage input

ianlancetaylor/libbacktrace@9b7f216...da7eff2

Only on Linux since they will fail on Darwin: dsymutil btest error: cannot parse the debug map for 'btest': The file was not recognized as a valid object file make[1]: *** [Makefile:2584: btest.dSYM] Error 1

Also fix tests.

Twey · 2023-03-08T13:03:49Z

pkgs/development/libraries/libbacktrace/default.nix

  pname = "libbacktrace";
-  version = "2020-05-13";
+  version = "unstable-2022-12-16";


I think this version is intended to be stable. I'm not sure exactly what to do about this as libbacktrace has weird version semantics: as the author said,

This is version 1.0. It is likely that this will always be version 1.0.

I'm not entirely sure how to fit this into the nixpkgs versioning scheme, but unstable doesn't seem to be it.

It is a nixpkgs convention: https://nixos.org/manual/nixpkgs/stable/#sec-package-naming

I think what I'm saying is that this is (notionally) a release. The initial release in that repository is release 1.0, and all commits on top of it are (unhelpfully named) patch versions of that release.

Twey · 2023-03-08T13:04:53Z

...pment/libraries/libbacktrace/0004-libbacktrace-Support-NIX_DEBUG_INFO_DIRS-environment.patch

@@ -0,0 +1,42 @@
+From a3b7510e4c9e7201a4301f2a45d8569b06354607 Mon Sep 17 00:00:00 2001


I haven't seen many patches in nixpkgs that include email metadata, but maybe someone else would like to weigh in on whether this is okay style or not. I don't really see the harm in it.

It’s just what Git spits out.

It looks like there are a fair few patches in nixpkgs with author metadata (about 15%), so I guess it's fine.

Twey · 2023-03-08T13:08:01Z

pkgs/development/libraries/libbacktrace/default.nix

+
+    # Support NIX_DEBUG_INFO_DIRS environment variable.
+    ./0004-libbacktrace-Support-NIX_DEBUG_INFO_DIRS-environment.patch
+  ];


While we're adding patches, could we include ianlancetaylor/libbacktrace#92? This would be helpful for other nixpkgs packages to depend on libbacktrace without relying on the cc-wrapper include path generation.

Would not other software need to rely on this for it to be useful? I would not expect other projects to rely on it until it is supported upstream (unless the developer does not realize they are relying on their distro’s patches).

In a non-Nix context pkgconfig is often not required because the libraries are in global directories, but within Nix I find that pkgconfig is very helpful to decouple packages' output structures.
I don't expect non-nixpkgs packages to expect pkgconfig for this, but rather it might be helpful for other nixpkgs packages that want to depend on libbacktrace. I've previously had to generate a pkgconfig manually for it and overrideAttrs.

In a non-Nix context pkgconfig is often not required because the libraries are in global directories

Right, and in Nixpkgs, the cc-wrapper plays a similar role.

I don't expect non-nixpkgs packages to expect pkgconfig for this, but rather it might be helpful for other nixpkgs packages that want to depend on libbacktrace.

We are usually trying to keep packages in Nixpkgs as close to upstream as possible. This typically means limiting patches to build or security fixes and Nix compatibility fixes.

Alright, seems sensible.

jtojnar · 2023-03-11T16:04:28Z

@ofborg eval

ofborg bot added 10.rebuild-darwin: 101-500 10.rebuild-linux: 101-500 labels Dec 24, 2022

RaitoBezarius marked this pull request as draft December 24, 2022 20:36

RaitoBezarius marked this pull request as ready for review December 24, 2022 22:29

jtojnar force-pushed the libbacktrace branch from deca8d7 to dffbaec Compare December 25, 2022 00:24

Artturin reviewed Jan 4, 2023

View reviewed changes

pkgs/development/libraries/libbacktrace/default.nix Outdated Show resolved Hide resolved

jtojnar added 2 commits March 5, 2023 01:42

libbacktrace: clean up

f37d97b

- Prefix version with “unstable-” as per contributing guide - Do not use rec pointlessly - Use `lib.enableFeature` - Add update script - Format the expression - Remove unused callPackage input

libbacktrace: unstable-2020-05-13 → unstable-2022-12-16

9cc45e1

ianlancetaylor/libbacktrace@9b7f216...da7eff2

jtojnar force-pushed the libbacktrace branch from dffbaec to 6afe5c2 Compare March 5, 2023 00:45

jtojnar added 2 commits March 5, 2023 01:46

libbacktrace: Enable tests

14c5fae

Only on Linux since they will fail on Darwin: dsymutil btest error: cannot parse the debug map for 'btest': The file was not recognized as a valid object file make[1]: *** [Makefile:2584: btest.dSYM] Error 1

libbacktrace: Add support for NIX_DEBUG_INFO_DIRS

1e03848

Also fix tests.

jtojnar force-pushed the libbacktrace branch from 6afe5c2 to 1e03848 Compare March 5, 2023 00:46

Twey reviewed Mar 8, 2023

View reviewed changes

ofborg bot requested a review from Twey March 11, 2023 16:19

jtojnar merged commit a6d96cc into NixOS:master Mar 23, 2023

jtojnar deleted the libbacktrace branch March 23, 2023 15:35

jtojnar mentioned this pull request Apr 16, 2023

valgrind: Support NIX_DEBUG_INFO_DIRS #226517

Open

12 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

libbacktrace: Add support for NIX_DEBUG_INFO_DIRS #207611

libbacktrace: Add support for NIX_DEBUG_INFO_DIRS #207611

jtojnar commented Dec 24, 2022 •

edited

Loading

jtojnar commented Dec 24, 2022

RaitoBezarius commented Dec 24, 2022

jtojnar commented Dec 24, 2022

RaitoBezarius commented Dec 24, 2022

Twey Mar 8, 2023

jtojnar Mar 8, 2023

Twey Mar 9, 2023 •

edited

Loading

Twey Mar 8, 2023

jtojnar Mar 8, 2023

Twey Mar 9, 2023

Twey Mar 8, 2023

jtojnar Mar 8, 2023 •

edited

Loading

Twey Mar 9, 2023

jtojnar Mar 9, 2023

Twey Mar 9, 2023

jtojnar commented Mar 11, 2023

		@@ -0,0 +1,42 @@
		From a3b7510e4c9e7201a4301f2a45d8569b06354607 Mon Sep 17 00:00:00 2001

libbacktrace: Add support for NIX_DEBUG_INFO_DIRS #207611

libbacktrace: Add support for NIX_DEBUG_INFO_DIRS #207611

Conversation

jtojnar commented Dec 24, 2022 • edited Loading

Description of changes

Things done

jtojnar commented Dec 24, 2022

RaitoBezarius commented Dec 24, 2022

jtojnar commented Dec 24, 2022

RaitoBezarius commented Dec 24, 2022

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Twey Mar 9, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jtojnar Mar 8, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jtojnar commented Mar 11, 2023

jtojnar commented Dec 24, 2022 •

edited

Loading

Twey Mar 9, 2023 •

edited

Loading

jtojnar Mar 8, 2023 •

edited

Loading