diff options
author | Denys Vlasenko <dvlasenk@redhat.com> | 2010-12-01 17:40:44 +0100 |
---|---|---|
committer | Denys Vlasenko <dvlasenk@redhat.com> | 2010-12-01 17:40:44 +0100 |
commit | d9e2d23b754c0a3a6ccfdaee423065e4a1cd7784 (patch) | |
tree | 7f62cf674e5c17910a70ca9fd48debb1697e4bba /src/include/crash_dump.h | |
parent | b808fc36602756d1c1495179331a4e92a7b094dc (diff) | |
download | abrt-d9e2d23b754c0a3a6ccfdaee423065e4a1cd7784.tar.gz abrt-d9e2d23b754c0a3a6ccfdaee423065e4a1cd7784.tar.xz abrt-d9e2d23b754c0a3a6ccfdaee423065e4a1cd7784.zip |
factor out headers so that "report lib" API is separated out of abrt API
This patch minimally affects code per se - it adds
create_crash_dump_dir() function which takes in-memory
representation of the dump (map_crash_data_t object)
and creates an on-disk representation.
Then it returns pointer to struct dump_dir.
With this function, it is possible to run an event
on a user-constructed map_crash_data_t:
map_crash_data_t cd;
add_to_crash_data(cd, "foo", "bar");
struct dump_dir *dd = create_crash_dump_dir(cd);
char *dir_name = strdup(dd->dd_dir);
dd_close(dd);
run_event(run_state, dir_name, event);
delete_crash_dump_dir(dir_name);
which is, basically, what report library is about.
The biggest part of the patch is reshuffling of
header files, with the following result: three header
files which are not cluttered by other ABRT stuff,
and expose the following API each:
crash_dump.h - in-memory crash dump data structs and ops
dump_dir.h - on-disk crash dump data structs and ops
run_event.h - run_event() and friends
These is a test application, test_report.cpp.cpp,
which demonstrates (and tests) usage of these headers.
(grep for "test-report" and enable it in build system
if you want it to be built).
It creates a temporary dump in
/var/run/abrt/tmp-NNNN-NNNNN and runs "report" event.
Deleting of temp dump is disabled for testing purposes -
you might want to see the contents.
Here is how the binary looks like:
text data bss dec hex filename
3730 668 48 4446 115e /usr/bin/test-report
linux-vdso.so.1 => (0x00007ffffa80f000)
libabrt.so.0 => /usr/lib64/libabrt.so.0 (0x00007fad1f35e000)
libglib-2.0.so.0 => /lib64/libglib-2.0.so.0 (0x0000003c1f200000)
libstdc++.so.6 => /usr/lib64/libstdc++.so.6 (0x0000003c2c200000)
libm.so.6 => /lib64/libm.so.6 (0x00007fad1f0da000)
libgcc_s.so.1 => /lib64/libgcc_s.so.1 (0x0000003c28e00000)
libc.so.6 => /lib64/libc.so.6 (0x00007fad1ed5b000)
/lib64/ld-linux-x86-64.so.2 (0x00007fad1f570000)
Next step would be to clean up the namespace,
then rename libabrt.so into libreport.so,
then split it into a separate package so that we can install it
without installing other two abrt .so files.
Signed-off-by: Denys Vlasenko <dvlasenk@redhat.com>
Diffstat (limited to 'src/include/crash_dump.h')
-rw-r--r-- | src/include/crash_dump.h | 72 |
1 files changed, 72 insertions, 0 deletions
diff --git a/src/include/crash_dump.h b/src/include/crash_dump.h new file mode 100644 index 00000000..ab7835b4 --- /dev/null +++ b/src/include/crash_dump.h @@ -0,0 +1,72 @@ +/* + Copyright (C) 2009 Abrt team. + Copyright (C) 2009 RedHat inc. + + This program is free software; you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation; either version 2 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License along + with this program; if not, write to the Free Software Foundation, Inc., + 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. +*/ +#ifndef CRASH_DUMP_H_ +#define CRASH_DUMP_H_ + + +// Crash data is a map of 3-element vectors of strings: type, editable, content +#define CD_TYPE 0 +#define CD_EDITABLE 1 +#define CD_CONTENT 2 + +// SYS - system value, should not be displayed +// BIN - binary data +// TXT - text data, can be displayed +#define CD_SYS "s" +#define CD_BIN "b" +#define CD_TXT "t" + +#define CD_ISEDITABLE "y" +#define CD_ISNOTEDITABLE "n" + +struct dump_dir; + +#ifdef __cplusplus + +#include <map> +#include <vector> +#include <string> + +/* In-memory crash data structure and accessors */ + +typedef std::map<std::string, std::vector<std::string> > map_crash_data_t; + +void add_to_crash_data_ext(map_crash_data_t& pCrashData, + const char *pItem, + const char *pType, + const char *pEditable, + const char *pContent); +/* Uses type:CD_TXT, editable:CD_ISNOTEDITABLE */ +void add_to_crash_data(map_crash_data_t& pCrashData, + const char *pItem, + const char *pContent); + +const char *get_crash_data_item_content_or_NULL(const map_crash_data_t& crash_data, const char *key); +/* Aborts if key is not found: */ +const std::string& get_crash_data_item_content(const map_crash_data_t& crash_data, const char *key); + + +/* Conversions between in-memory and on-disk formats */ + +void load_crash_data_from_crash_dump_dir(struct dump_dir *dd, map_crash_data_t& data); +struct dump_dir *create_crash_dump_dir(const map_crash_data_t& crash_data); + +#endif + +#endif |