From d9e2d23b754c0a3a6ccfdaee423065e4a1cd7784 Mon Sep 17 00:00:00 2001 From: Denys Vlasenko Date: Wed, 1 Dec 2010 17:40:44 +0100 Subject: 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 --- src/include/Makefile.am | 5 ++- src/include/abrt_crash_dump.h | 42 +++---------------------- src/include/abrtlib.h | 20 ++---------- src/include/crash_dump.h | 72 +++++++++++++++++++++++++++++++++++++++++++ src/include/dump_dir.h | 4 +++ src/include/run_event.h | 48 +++++++++++++++++++++++++++++ 6 files changed, 134 insertions(+), 57 deletions(-) create mode 100644 src/include/crash_dump.h create mode 100644 src/include/run_event.h (limited to 'src/include') diff --git a/src/include/Makefile.am b/src/include/Makefile.am index 3716d19e..c035aaa9 100644 --- a/src/include/Makefile.am +++ b/src/include/Makefile.am @@ -1,11 +1,14 @@ HEADER_FILES = \ + crash_dump.h \ + dump_dir.h \ + run_event.h \ + \ abrt_exception.h \ abrtlib.h \ abrt_types.h \ comm_layer_inner.h \ abrt_crash_dump.h \ dbus_common.h \ - dump_dir.h \ observer.h \ plugin.h \ action.h \ diff --git a/src/include/abrt_crash_dump.h b/src/include/abrt_crash_dump.h index ed7ffe95..fe924256 100644 --- a/src/include/abrt_crash_dump.h +++ b/src/include/abrt_crash_dump.h @@ -19,8 +19,12 @@ #ifndef ABRT_CRASH_DUMP_H_ #define ABRT_CRASH_DUMP_H_ +#include "crash_dump.h" #include "abrt_types.h" +// Text bigger than this usually is attached, not added inline +#define CD_TEXT_ATT_SIZE (2*1024) + // Keep in sync with CCDump.py: // Filenames in dump directory: @@ -67,30 +71,10 @@ #define CD_EVENTS "Events" -// 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" -// Text bigger than this usually is attached, not added inline -#define CD_TEXT_ATT_SIZE (2*1024) - -#define CD_ISEDITABLE "y" -#define CD_ISNOTEDITABLE "n" - - #ifdef __cplusplus extern "C" { #endif -extern const char *const must_have_files[]; - bool is_editable_file(const char *file_name); #ifdef __cplusplus @@ -100,26 +84,8 @@ bool is_editable_file(const char *file_name); #ifdef __cplusplus -// -typedef map_vector_string_t map_crash_data_t; typedef std::vector vector_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); - -void load_crash_data_from_crash_dump_dir(struct dump_dir *dd, map_crash_data_t& data); - -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); - void log_map_crash_data(const map_crash_data_t& data, const char *name); #endif /* __cplusplus */ diff --git a/src/include/abrtlib.h b/src/include/abrtlib.h index 8cd0664a..cb2755b0 100644 --- a/src/include/abrtlib.h +++ b/src/include/abrtlib.h @@ -78,8 +78,9 @@ int vdprintf(int d, const char *format, va_list ap); #include "hash_md5.h" #include "abrt_crash_dump.h" -#include "dump_dir.h" #include "abrt_types.h" +#include "dump_dir.h" +#include "run_event.h" #ifdef __cplusplus @@ -216,23 +217,6 @@ char* get_cmdline(pid_t pid); /* Returns 1 if abrtd daemon is running, 0 otherwise. */ int daemon_is_ok(); -struct run_event_state { - int (*post_run_callback)(const char *dump_dir_name, void *param); - void *post_run_param; - char* (*logging_callback)(char *log_line, void *param); - void *logging_param; -}; -static inline struct run_event_state *new_run_event_state() - { return (struct run_event_state*)xzalloc(sizeof(struct run_event_state)); } -static inline void free_run_event_state(struct run_event_state *state) - { free(state); } -/* Returns exitcode of first failed action, or first nonzero return value - * of post_run_callback. If all actions are successful, returns 0. - * If no actions were run for the event, returns -1. - */ -int run_event(struct run_event_state *state, const char *dump_dir_name, const char *event); -char *list_possible_events(struct dump_dir *dd, const char *dump_dir_name, const char *pfx); - #ifdef __cplusplus } #endif 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 +#include +#include + +/* In-memory crash data structure and accessors */ + +typedef std::map > 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 diff --git a/src/include/dump_dir.h b/src/include/dump_dir.h index 7a38f1e4..8cec9459 100644 --- a/src/include/dump_dir.h +++ b/src/include/dump_dir.h @@ -21,6 +21,10 @@ #ifndef DUMP_DIR_H_ #define DUMP_DIR_H_ +/* For DIR */ +#include +#include + #ifdef __cplusplus extern "C" { #endif diff --git a/src/include/run_event.h b/src/include/run_event.h new file mode 100644 index 00000000..c2e34650 --- /dev/null +++ b/src/include/run_event.h @@ -0,0 +1,48 @@ +/* + 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 RUN_EVENT_H_ +#define RUN_EVENT_H_ + +#ifdef __cplusplus +extern "C" { +#endif + +struct dump_dir; + +struct run_event_state { + int (*post_run_callback)(const char *dump_dir_name, void *param); + void *post_run_param; + char* (*logging_callback)(char *log_line, void *param); + void *logging_param; +}; +struct run_event_state *new_run_event_state(void); +void free_run_event_state(struct run_event_state *state); + +/* Returns exitcode of first failed action, or first nonzero return value + * of post_run_callback. If all actions are successful, returns 0. + * If no actions were run for the event, returns -1. + */ +int run_event(struct run_event_state *state, const char *dump_dir_name, const char *event); +char *list_possible_events(struct dump_dir *dd, const char *dump_dir_name, const char *pfx); + +#ifdef __cplusplus +} +#endif + +#endif -- cgit