From 8fc724470f782b4d69ac7e4b2fc3dbc14d03a93e Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Th=C3=A9ophile=20Bastian?= <contact@tobast.fr>
Date: Wed, 16 May 2018 16:56:39 +0200
Subject: [PATCH] Add basic README for libelfunwind

---
 libelfunwind/README.md | 29 +++++++++++++++++++++++++++++
 1 file changed, 29 insertions(+)
 create mode 100644 libelfunwind/README.md

diff --git a/libelfunwind/README.md b/libelfunwind/README.md
new file mode 100644
index 0000000..9cda074
--- /dev/null
+++ b/libelfunwind/README.md
@@ -0,0 +1,29 @@
+# libelfunwind
+
+Reproduces the interface of libunwind, and exports a `libunwind.so` binary, so
+that changing `LD_LIBRARY_PATH` makes it possible to use `dwarf-assembly`
+instead of `dwarf` as an unwinding process in eg. `perf`.
+
+## `perf` currently used libunwind features
+
+```
+  # Types
+  unw_accessors_t
+  unw_word_t
+  unw_regnum_t
+  unw_proc_info_t
+  unw_fpreg_t
+  unw_dyn_info_t
+  unw_addr_space_t
+  unw_cursor_t
+
+  # Functions
+  unw_create_addr_space
+  unw_destroy_addr_space
+  unw_flush_cache
+  unw_get_reg
+  unw_init_remote
+  unw_is_signal_frame
+  unw_set_caching_policy
+  unw_step
+```