summaryrefslogtreecommitdiffstats
path: root/README
diff options
context:
space:
mode:
Diffstat (limited to 'README')
-rw-r--r--README39
1 files changed, 39 insertions, 0 deletions
diff --git a/README b/README
new file mode 100644
index 0000000..6ab58c2
--- /dev/null
+++ b/README
@@ -0,0 +1,39 @@
+dwarf-extract-struct
+====================
+
+Simple utility to extract struct as header file from binary
+debug informations
+
+
+Usage
+=====
+
+There's a trivial Makefile for now, just run `make` and run the program.
+
+Once built, `dwarf-extract-struct` takes for arguments:
+ - path to the binary you want to extract debug informations from
+(must be built with -g and not stripped, alternatively it can be a
+'.debug' file)
+ - the name of the struct you want to mimic
+ - the name of the fields you want to extract
+
+For example, on itself:
+```
+$ ./dwarf-extract-struct dwarf-extract-struct _IO_FILE _markers _IO_buf_base
+struct _IO_FILE {
+ union {
+ char whole_struct[216];
+ struct {
+ char padding0[56];
+ char *_IO_buf_base;
+ };
+ struct {
+ char padding1[96];
+ struct _IO_marker *_markers;
+ };
+ };
+};
+```
+
+
+This is work in progress, interface will likely change.