libreport  2.2.2
A tool to inform users about various problems on the running system
internal_libreport.h
1 /*
2  Copyright (C) 2010 ABRT team
3  Copyright (C) 2010 RedHat Inc
4 
5  This program is free software; you can redistribute it and/or modify
6  it under the terms of the GNU General Public License as published by
7  the Free Software Foundation; either version 2 of the License, or
8  (at your option) any later version.
9 
10  This program is distributed in the hope that it will be useful,
11  but WITHOUT ANY WARRANTY; without even the implied warranty of
12  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13  GNU General Public License for more details.
14 
15  You should have received a copy of the GNU General Public License along
16  with this program; if not, write to the Free Software Foundation, Inc.,
17  51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
18 */
19 
20 #ifndef LIBREPORT_INTERNAL_H_
21 #define LIBREPORT_INTERNAL_H_
22 
23 #include <assert.h>
24 #include <ctype.h>
25 #include <dirent.h>
26 #include <errno.h>
27 #include <fcntl.h>
28 #include <inttypes.h>
29 #include <setjmp.h>
30 #include <signal.h>
31 #include <stdio.h>
32 #include <stdlib.h>
33 #include <stdarg.h>
34 #include <stddef.h>
35 #include <string.h>
36 #include <syslog.h>
37 #include <sys/poll.h>
38 #include <sys/mman.h>
39 #include <sys/socket.h>
40 #include <sys/stat.h>
41 #include <sys/time.h>
42 #include <sys/types.h>
43 #include <sys/wait.h>
44 #include <arpa/inet.h> /* sockaddr_in, sockaddr_in6 etc */
45 #include <termios.h>
46 #include <time.h>
47 #include <unistd.h>
48 #include <stdbool.h>
49 /* Try to pull in PATH_MAX */
50 #include <limits.h>
51 #include <sys/param.h>
52 #ifndef PATH_MAX
53 # define PATH_MAX 256
54 #endif
55 #include <pwd.h>
56 #include <grp.h>
57 
58 #ifdef HAVE_CONFIG_H
59 # include "config.h"
60 #endif
61 
62 /* Must be after #include "config.h" */
63 #if ENABLE_NLS
64 # include <libintl.h>
65 # define _(S) dgettext(PACKAGE, S)
66 #else
67 # define _(S) (S)
68 #endif
69 
70 #if HAVE_LOCALE_H
71 # include <locale.h>
72 #endif /* HAVE_LOCALE_H */
73 
74 /* Some libc's forget to declare these, do it ourself */
75 extern char **environ;
76 #if defined(__GLIBC__) && __GLIBC__ < 2
77 int vdprintf(int d, const char *format, va_list ap);
78 #endif
79 
80 #undef NORETURN
81 #define NORETURN __attribute__ ((noreturn))
82 
83 #undef ERR_PTR
84 #define ERR_PTR ((void*)(uintptr_t)1)
85 
86 #undef ARRAY_SIZE
87 #define ARRAY_SIZE(x) ((unsigned)(sizeof(x) / sizeof((x)[0])))
88 
89 /* consts used across whole libreport */
90 #define CREATE_PRIVATE_TICKET "ABRT_CREATE_PRIVATE_TICKET"
91 
92 /* Pull in entire public libreport API */
93 #include "dump_dir.h"
94 #include "event_config.h"
95 #include "problem_data.h"
96 #include "report.h"
97 #include "run_event.h"
98 #include "workflow.h"
99 #include "file_obj.h"
100 #include "libreport_types.h"
101 
102 #ifdef __cplusplus
103 extern "C" {
104 #endif
105 
106 #define prefixcmp libreport_prefixcmp
107 int prefixcmp(const char *str, const char *prefix);
108 #define suffixcmp libreport_suffixcmp
109 int suffixcmp(const char *str, const char *suffix);
110 #define strtrim libreport_strtrim
111 char *strtrim(char *str);
112 #define strtrimch libreport_strtrimch
113 char *strtrimch(char *str, int ch);
114 #define append_to_malloced_string libreport_append_to_malloced_string
115 char *append_to_malloced_string(char *mstr, const char *append);
116 #define skip_whitespace libreport_skip_whitespace
117 char* skip_whitespace(const char *s);
118 #define skip_non_whitespace libreport_skip_non_whitespace
119 char* skip_non_whitespace(const char *s);
120 /* Like strcpy but can copy overlapping strings. */
121 #define overlapping_strcpy libreport_overlapping_strcpy
122 void overlapping_strcpy(char *dst, const char *src);
123 
124 #define concat_path_file libreport_concat_path_file
125 char *concat_path_file(const char *path, const char *filename);
126 /*
127  * Used to construct a name in a different directory with the basename
128  * similar to the old name, if possible.
129  */
130 #define concat_path_basename libreport_concat_path_basename
131 char *concat_path_basename(const char *path, const char *filename);
132 
133 /* A-la fgets, but malloced and of unlimited size */
134 #define xmalloc_fgets libreport_xmalloc_fgets
135 char *xmalloc_fgets(FILE *file);
136 /* Similar, but removes trailing \n */
137 #define xmalloc_fgetline libreport_xmalloc_fgetline
138 char *xmalloc_fgetline(FILE *file);
139 /* Useful for easy reading of various /proc files */
140 #define xmalloc_fopen_fgetline_fclose libreport_xmalloc_fopen_fgetline_fclose
141 char *xmalloc_fopen_fgetline_fclose(const char *filename);
142 
143 
144 /* On error, copyfd_XX prints error messages and returns -1 */
145 enum {
146  COPYFD_SPARSE = 1 << 0,
147 };
148 #define copyfd_eof libreport_copyfd_eof
149 off_t copyfd_eof(int src_fd, int dst_fd, int flags);
150 #define copyfd_size libreport_copyfd_size
151 off_t copyfd_size(int src_fd, int dst_fd, off_t size, int flags);
152 #define copyfd_exact_size libreport_copyfd_exact_size
153 void copyfd_exact_size(int src_fd, int dst_fd, off_t size);
154 #define copy_file libreport_copy_file
155 off_t copy_file(const char *src_name, const char *dst_name, int mode);
156 #define copy_file_recursive libreport_copy_file_recursive
157 int copy_file_recursive(const char *source, const char *dest);
158 
159 // NB: will return short read on error, not -1,
160 // if some data was read before error occurred
161 #define xread libreport_xread
162 void xread(int fd, void *buf, size_t count);
163 #define safe_read libreport_safe_read
164 ssize_t safe_read(int fd, void *buf, size_t count);
165 #define safe_write libreport_safe_write
166 ssize_t safe_write(int fd, const void *buf, size_t count);
167 #define full_read libreport_full_read
168 ssize_t full_read(int fd, void *buf, size_t count);
169 #define full_write libreport_full_write
170 ssize_t full_write(int fd, const void *buf, size_t count);
171 #define full_write_str libreport_full_write_str
172 ssize_t full_write_str(int fd, const char *buf);
173 #define xmalloc_read libreport_xmalloc_read
174 void* xmalloc_read(int fd, size_t *maxsz_p);
175 #define xmalloc_open_read_close libreport_xmalloc_open_read_close
176 void* xmalloc_open_read_close(const char *filename, size_t *maxsz_p);
177 #define xmalloc_xopen_read_close libreport_xmalloc_xopen_read_close
178 void* xmalloc_xopen_read_close(const char *filename, size_t *maxsz_p);
179 
180 
181 /* Returns malloc'ed block */
182 #define encode_base64 libreport_encode_base64
183 char *encode_base64(const void *src, int length);
184 
185 /* Returns NULL if the string needs no sanitizing.
186  * control_chars_to_sanitize is a bit mask.
187  * If Nth bit is set, Nth control char will be sanitized (replaced by [XX]).
188  */
189 #define sanitize_utf8 libreport_sanitize_utf8
190 char *sanitize_utf8(const char *src, uint32_t control_chars_to_sanitize);
191 enum {
192  SANITIZE_ALL = 0xffffffff,
193  SANITIZE_TAB = (1 << 9),
194  SANITIZE_LF = (1 << 10),
195  SANITIZE_CR = (1 << 13),
196 };
197 
198 #define SHA1_RESULT_LEN (5 * 4)
199 typedef struct sha1_ctx_t {
200  uint8_t wbuffer[64]; /* always correctly aligned for uint64_t */
201  /* for sha256: void (*process_block)(struct md5_ctx_t*); */
202  uint64_t total64; /* must be directly before hash[] */
203  uint32_t hash[8]; /* 4 elements for md5, 5 for sha1, 8 for sha256 */
204 } sha1_ctx_t;
205 #define sha1_begin libreport_sha1_begin
206 void sha1_begin(sha1_ctx_t *ctx);
207 #define sha1_hash libreport_sha1_hash
208 void sha1_hash(sha1_ctx_t *ctx, const void *buffer, size_t len);
209 #define sha1_end libreport_sha1_end
210 void sha1_end(sha1_ctx_t *ctx, void *resbuf);
211 
212 /* Helpers to hash a string: */
213 #define str_to_sha1 libreport_str_to_sha1
214 const uint8_t *str_to_sha1(uint8_t result[SHA1_RESULT_LEN], const char *str);
215 #define str_to_sha1str libreport_str_to_sha1str
216 const char *str_to_sha1str(char result[SHA1_RESULT_LEN*2 + 1], const char *str);
217 
218 
219 #define xatou libreport_xatou
220 unsigned xatou(const char *numstr);
221 #define xatoi libreport_xatoi
222 int xatoi(const char *numstr);
223 /* Using xatoi() instead of naive atoi() is not always convenient -
224  * in many places people want *non-negative* values, but store them
225  * in signed int. Therefore we need this one:
226  * dies if input is not in [0, INT_MAX] range. Also will reject '-0' etc.
227  * It should really be named xatoi_nonnegative (since it allows 0),
228  * but that would be too long.
229  */
230 #define xatoi_positive libreport_xatoi_positive
231 int xatoi_positive(const char *numstr);
232 
233 //unused for now
234 //unsigned long long monotonic_ns(void);
235 //unsigned long long monotonic_us(void);
236 //unsigned monotonic_sec(void);
237 
238 #define safe_waitpid libreport_safe_waitpid
239 pid_t safe_waitpid(pid_t pid, int *wstat, int options);
240 
241 enum {
242  /* on return, pipefds[1] is fd to which parent may write
243  * and deliver data to child's stdin: */
244  EXECFLG_INPUT = 1 << 0,
245  /* on return, pipefds[0] is fd from which parent may read
246  * child's stdout: */
247  EXECFLG_OUTPUT = 1 << 1,
248  /* open child's stdin to /dev/null: */
249  EXECFLG_INPUT_NUL = 1 << 2,
250  /* open child's stdout to /dev/null: */
251  EXECFLG_OUTPUT_NUL = 1 << 3,
252  /* redirect child's stderr to stdout: */
253  EXECFLG_ERR2OUT = 1 << 4,
254  /* open child's stderr to /dev/null: */
255  EXECFLG_ERR_NUL = 1 << 5,
256  /* suppress perror_msg("Can't execute 'foo'") if exec fails */
257  EXECFLG_QUIET = 1 << 6,
258  EXECFLG_SETGUID = 1 << 7,
259  EXECFLG_SETSID = 1 << 8,
260  EXECFLG_SETPGID = 1 << 9,
261 };
262 /*
263  * env_vec: list of variables to set in environment (if string has
264  * "VAR=VAL" form) or unset in environment (if string has no '=' char).
265  *
266  * Returns pid.
267  */
268 #define fork_execv_on_steroids libreport_fork_execv_on_steroids
269 pid_t fork_execv_on_steroids(int flags,
270  char **argv,
271  int *pipefds,
272  char **env_vec,
273  const char *dir,
274  uid_t uid);
275 /* Returns malloc'ed string. NULs are retained, and extra one is appended
276  * after the last byte (this NUL is not accounted for in *size_p) */
277 #define run_in_shell_and_save_output libreport_run_in_shell_and_save_output
278 char *run_in_shell_and_save_output(int flags,
279  const char *cmd,
280  const char *dir,
281  size_t *size_p);
282 
283 /* Random utility functions */
284 
285 #define is_in_string_list libreport_is_in_string_list
286 bool is_in_string_list(const char *name, char **v);
287 
288 #define is_in_comma_separated_list libreport_is_in_comma_separated_list
289 bool is_in_comma_separated_list(const char *value, const char *list);
290 #define is_in_comma_separated_list_of_glob_patterns libreport_is_in_comma_separated_list_of_glob_patterns
291 bool is_in_comma_separated_list_of_glob_patterns(const char *value, const char *list);
292 
293 /* Calls GLib version appropriate initialization function.
294  */
295 #define glib_init libreport_glib_init
296 void glib_init(void);
297 
298 /* Frees every element'd data using free(),
299  * then frees list itself using g_list_free(list):
300  */
301 #define list_free_with_free libreport_list_free_with_free
302 void list_free_with_free(GList *list);
303 
304 #define get_dirsize libreport_get_dirsize
305 double get_dirsize(const char *pPath);
306 #define get_dirsize_find_largest_dir libreport_get_dirsize_find_largest_dir
307 double get_dirsize_find_largest_dir(
308  const char *pPath,
309  char **worst_dir, /* can be NULL */
310  const char *excluded /* can be NULL */
311 );
312 
313 #define ndelay_on libreport_ndelay_on
314 int ndelay_on(int fd);
315 #define ndelay_off libreport_ndelay_off
316 int ndelay_off(int fd);
317 #define close_on_exec_on libreport_close_on_exec_on
318 int close_on_exec_on(int fd);
319 
320 #define xmalloc libreport_xmalloc
321 void* xmalloc(size_t size);
322 #define xrealloc libreport_xrealloc
323 void* xrealloc(void *ptr, size_t size);
324 #define xzalloc libreport_xzalloc
325 void* xzalloc(size_t size);
326 #define xstrdup libreport_xstrdup
327 char* xstrdup(const char *s);
328 #define xstrndup libreport_xstrndup
329 char* xstrndup(const char *s, int n);
330 
331 #define xpipe libreport_xpipe
332 void xpipe(int filedes[2]);
333 #define xdup libreport_xdup
334 int xdup(int from);
335 #define xdup2 libreport_xdup2
336 void xdup2(int from, int to);
337 #define xmove_fd libreport_xmove_fd
338 void xmove_fd(int from, int to);
339 
340 #define xwrite libreport_xwrite
341 void xwrite(int fd, const void *buf, size_t count);
342 #define xwrite_str libreport_xwrite_str
343 void xwrite_str(int fd, const char *str);
344 
345 #define xlseek libreport_xlseek
346 off_t xlseek(int fd, off_t offset, int whence);
347 
348 #define xchdir libreport_xchdir
349 void xchdir(const char *path);
350 
351 #define xvasprintf libreport_xvasprintf
352 char* xvasprintf(const char *format, va_list p);
353 #define xasprintf libreport_xasprintf
354 char* xasprintf(const char *format, ...);
355 
356 #define xsetenv libreport_xsetenv
357 void xsetenv(const char *key, const char *value);
358 /*
359  * Utility function to unsetenv a string which was possibly putenv'ed.
360  * The problem here is that "natural" optimization:
361  * strchrnul(var_val, '=')[0] = '\0';
362  * unsetenv(var_val);
363  * is BUGGY: if string was put into environment via putenv,
364  * its modification (s/=/NUL/) is illegal, and unsetenv will fail to unset it.
365  * Of course, saving/restoring the char wouldn't work either.
366  * This helper creates a copy up to '=', unsetenv's it, and frees:
367  */
368 #define safe_unsetenv libreport_safe_unsetenv
369 void safe_unsetenv(const char *var_val);
370 
371 #define xsocket libreport_xsocket
372 int xsocket(int domain, int type, int protocol);
373 #define xbind libreport_xbind
374 void xbind(int sockfd, struct sockaddr *my_addr, socklen_t addrlen);
375 #define xlisten libreport_xlisten
376 void xlisten(int s, int backlog);
377 #define xsendto libreport_xsendto
378 ssize_t xsendto(int s, const void *buf, size_t len,
379  const struct sockaddr *to, socklen_t tolen);
380 
381 #define xstat libreport_xstat
382 void xstat(const char *name, struct stat *stat_buf);
383 #define fstat_st_size_or_die libreport_fstat_st_size_or_die
384 off_t fstat_st_size_or_die(int fd);
385 #define stat_st_size_or_die libreport_stat_st_size_or_die
386 off_t stat_st_size_or_die(const char *filename);
387 
388 #define xopen3 libreport_xopen3
389 int xopen3(const char *pathname, int flags, int mode);
390 #define xopen libreport_xopen
391 int xopen(const char *pathname, int flags);
392 #define xunlink libreport_xunlink
393 void xunlink(const char *pathname);
394 
395 /* Just testing dent->d_type == DT_REG is wrong: some filesystems
396  * do not report the type, they report DT_UNKNOWN for every dirent
397  * (and this is not a bug in filesystem, this is allowed by standards).
398  * This function handles this case. Note: it returns 0 on symlinks
399  * even if they point to regular files.
400  */
401 #define is_regular_file libreport_is_regular_file
402 int is_regular_file(struct dirent *dent, const char *dirname);
403 
404 #define dot_or_dotdot libreport_dot_or_dotdot
405 bool dot_or_dotdot(const char *filename);
406 #define last_char_is libreport_last_char_is
407 char *last_char_is(const char *s, int c);
408 
409 #define string_to_bool libreport_string_to_bool
410 bool string_to_bool(const char *s);
411 
412 #define xseteuid libreport_xseteuid
413 void xseteuid(uid_t euid);
414 #define xsetegid libreport_xsetegid
415 void xsetegid(gid_t egid);
416 #define xsetreuid libreport_xsetreuid
417 void xsetreuid(uid_t ruid, uid_t euid);
418 #define xsetregid libreport_xsetregid
419 void xsetregid(gid_t rgid, gid_t egid);
420 
421 
422 /* Emit a string of hex representation of bytes */
423 #define bin2hex libreport_bin2hex
424 char* bin2hex(char *dst, const char *str, int count);
425 /* Convert "xxxxxxxx" hex string to binary, no more than COUNT bytes */
426 #define hex2bin libreport_hex2bin
427 char* hex2bin(char *dst, const char *str, int count);
428 
429 
430 enum {
431  LOGMODE_NONE = 0,
432  LOGMODE_STDIO = (1 << 0),
433  LOGMODE_SYSLOG = (1 << 1),
434  LOGMODE_BOTH = LOGMODE_SYSLOG + LOGMODE_STDIO,
435  LOGMODE_CUSTOM = (1 << 2),
436  LOGMODE_JOURNAL = (1 << 3),
437 };
438 
439 #define g_custom_logger libreport_g_custom_logger
440 extern void (*g_custom_logger)(const char*);
441 #define msg_prefix libreport_msg_prefix
442 extern const char *msg_prefix;
443 #define msg_eol libreport_msg_eol
444 extern const char *msg_eol;
445 #define logmode libreport_logmode
446 extern int logmode;
447 #define xfunc_error_retval libreport_xfunc_error_retval
448 extern int xfunc_error_retval;
449 
450 /* A few magic exit codes */
451 #define EXIT_CANCEL_BY_USER 69
452 #define EXIT_STOP_EVENT_RUN 70
453 
454 #define set_xfunc_error_retval libreport_set_xfunc_error_retval
455 void set_xfunc_error_retval(int retval);
456 
457 /* Verbosity level */
458 #define g_verbose libreport_g_verbose
459 extern int g_verbose;
460 /* VERB1 log("what you sometimes want to see, even on a production box") */
461 #define VERB1 if (g_verbose >= 1)
462 /* VERB2 log("debug message, not going into insanely small details") */
463 #define VERB2 if (g_verbose >= 2)
464 /* VERB3 log("lots and lots of details") */
465 #define VERB3 if (g_verbose >= 3)
466 /* there is no level > 3 */
467 
468 #define libreport_
469 #define xfunc_die libreport_xfunc_die
470 void xfunc_die(void) NORETURN;
471 
472 #define die_out_of_memory libreport_die_out_of_memory
473 void die_out_of_memory(void) NORETURN;
474 
475 /* It's a macro, not function, since it collides with log() from math.h */
476 #undef log
477 #define log(...) log_standard(LOG_WARNING, __FILE__, __LINE__, __func__, __VA_ARGS__)
478 #define log_debug(...) log_standard(LOG_DEBUG, __FILE__, __LINE__, __func__, __VA_ARGS__)
479 #define log_info(...) log_standard(LOG_INFO, __FILE__, __LINE__, __func__, __VA_ARGS__)
480 #define log_notice(...) log_standard(LOG_NOTICE, __FILE__, __LINE__, __func__, __VA_ARGS__)
481 #define log_warning(...) log_standard(LOG_WARNING, __FILE__, __LINE__, __func__, __VA_ARGS__)
482 #define log_error(...) log_standard(LOG_ERR, __FILE__, __LINE__, __func__, __VA_ARGS__)
483 
484 #define log_standard(level, file, line, func, ...) log_wrapper(level, __FILE__, __LINE__, __func__, false, false, __VA_ARGS__)
485 
486 // level, file, line, func, perror, custom logger, format & args
487 #define log_error_and_die(...) log_wrapper(LOG_ERR, __FILE__, __LINE__, __func__, false, false,__VA_ARGS__)
488 #define log_perror(...) log_wrapper(LOG_ERR, __FILE__, __LINE__, __func__, true, false, __VA_ARGS__)
489 #define log_perror_and_die(...) log_wrapper(LOG_ERR, __FILE__, __LINE__, __func__, true, false, __VA_ARGS__)
490 
491 #define error_msg(...) log_wrapper(LOG_ERR, __FILE__, __LINE__, __func__, false, true, __VA_ARGS__)
492 #define perror_msg(...) log_wrapper(LOG_ERR, __FILE__, __LINE__, __func__, true, true, __VA_ARGS__)
493 #define warn_msg(...) log_wrapper(LOG_WARNING, __FILE__, __LINE__, __func__, false, true, __VA_ARGS__)
494 #define pwarn_msg(...) log_wrapper(LOG_WARNING, __FILE__, __LINE__, __func__, true, true, __VA_ARGS__)
495 #define error_msg_and_die(...) log_and_die_wrapper(LOG_ERR, __FILE__, __LINE__, __func__, false, true, __VA_ARGS__)
496 #define perror_msg_and_die(...) log_and_die_wrapper(LOG_ERR, __FILE__, __LINE__, __func__, true, true, __VA_ARGS__)
497 
498 
499 void log_wrapper(int level,
500  const char *file,
501  int line,
502  const char *func,
503  bool process_perror,
504  bool use_custom_logger,
505  const char *format, ...) __attribute__ ((format (printf, 7,8)));
506 
507 void log_and_die_wrapper(int level,
508  const char *file,
509  int line,
510  const char *func,
511  bool process_perror,
512  bool use_custom_logger,
513  const char *format, ...) __attribute__ ((noreturn, format (printf, 7,8)));
514 
515 struct strbuf
516 {
517  /* Size of the allocated buffer. Always > 0. */
518  int alloc;
519  /* Length of the string, without the ending \0. */
520  int len;
521  char *buf;
522 };
523 
530 #define strbuf_new libreport_strbuf_new
531 struct strbuf *strbuf_new(void);
532 
538 #define strbuf_free libreport_strbuf_free
539 void strbuf_free(struct strbuf *strbuf);
540 
546 #define strbuf_free_nobuf libreport_strbuf_free_nobuf
547 char* strbuf_free_nobuf(struct strbuf *strbuf);
548 
553 #define strbuf_clear libreport_strbuf_clear
554 void strbuf_clear(struct strbuf *strbuf);
555 
560 #define strbuf_append_char libreport_strbuf_append_char
561 struct strbuf *strbuf_append_char(struct strbuf *strbuf, char c);
562 
567 #define strbuf_append_str libreport_strbuf_append_str
568 struct strbuf *strbuf_append_str(struct strbuf *strbuf,
569  const char *str);
570 
575 #define strbuf_prepend_str libreport_strbuf_prepend_str
576 struct strbuf *strbuf_prepend_str(struct strbuf *strbuf,
577  const char *str);
578 
583 #define strbuf_append_strf libreport_strbuf_append_strf
584 struct strbuf *strbuf_append_strf(struct strbuf *strbuf,
585  const char *format, ...);
586 
591 #define strbuf_append_strfv libreport_strbuf_append_strfv
592 struct strbuf *strbuf_append_strfv(struct strbuf *strbuf,
593  const char *format, va_list p);
594 
600 #define strbuf_prepend_strf libreport_strbuf_prepend_strf
601 struct strbuf *strbuf_prepend_strf(struct strbuf *strbuf,
602  const char *format, ...);
603 
608 #define strbuf_prepend_strfv libreport_strbuf_prepend_strfv
609 struct strbuf *strbuf_prepend_strfv(struct strbuf *strbuf,
610  const char *format, va_list p);
611 
612 /* Returns command line of running program.
613  * Caller is responsible to free() the returned value.
614  * If the pid is not valid or command line can not be obtained,
615  * empty string is returned.
616  */
617 #define get_cmdline libreport_get_cmdline
618 char* get_cmdline(pid_t pid);
619 #define get_environ libreport_get_environ
620 char* get_environ(pid_t pid);
621 
622 /* Takes ptr to time_t, or NULL if you want to use current time.
623  * Returns "YYYY-MM-DD-hh:mm:ss" string.
624  */
625 #define iso_date_string libreport_iso_date_string
626 char *iso_date_string(const time_t *pt);
627 #define LIBREPORT_ISO_DATE_STRING_SAMPLE "YYYY-MM-DD-hh:mm:ss"
628 
629 enum {
630  MAKEDESC_SHOW_FILES = (1 << 0),
631  MAKEDESC_SHOW_MULTILINE = (1 << 1),
632  MAKEDESC_SHOW_ONLY_LIST = (1 << 2),
633  MAKEDESC_WHITELIST = (1 << 3),
634  /* Include all URLs from FILENAME_REPORTED_TO element in the description text */
635  MAKEDESC_SHOW_URLS = (1 << 4),
636 };
637 #define make_description libreport_make_description
638 char *make_description(problem_data_t *problem_data, char **names_to_skip, unsigned max_text_size, unsigned desc_flags);
639 #define make_description_bz libreport_make_description_bz
640 char* make_description_bz(problem_data_t *problem_data, unsigned max_text_size);
641 #define make_description_logger libreport_make_description_logger
642 char* make_description_logger(problem_data_t *problem_data, unsigned max_text_size);
643 #define make_description_mailx libreport_make_description_mailx
644 char* make_description_mailx(problem_data_t *problem_data, unsigned max_text_size);
645 
646 /* See man os-release(5) for details */
647 #define OSINFO_ID "ID"
648 #define OSINFO_NAME "NAME"
649 #define OSINFO_VERSION_ID "VERSION_ID"
650 #define OSINFO_PRETTY_NAME "PRETTY_NAME"
651 
652 /* @brief Loads a text in format of os-release(5) in to a map
653  *
654  * Function doesn't check for format errors much. It just tries to avoid
655  * program errors. In case of error the function prints out a log message and
656  * continues in parsing.
657  *
658  * @param osinfo_bytes Non-NULL pointer to osinfo bytes.
659  * @param osinfo The map where result is stored
660  */
661 #define parse_osinfo libreport_parse_osinfo
662 void parse_osinfo(const char *osinfo_bytes, map_string_t *osinfo);
663 
664 /* @brief Builds product string and product's version string for Bugzilla
665  *
666  * At first tries to get strings from the os specific variables
667  * (REDHAT_BUGZILLA_PRODUCT, REDHAT_BUGZILLA_PRODUCT_VERSION) if no such
668  * variables are found, uses NAME key for the product and VERSION_ID key for
669  * the product's version. If neither NAME nor VERSION_ID are provided fallbacks
670  * to parsing of os_release which should be stored under PRETTY_NAME key.
671  *
672  * https://bugzilla.redhat.com/show_bug.cgi?id=950373
673  *
674  * @param osinfo Input data from which the values are built
675  * @param produc Non-NULL pointer where pointer to malloced string will be stored. Memory must be released by free()
676  * @param version Non-NULL pointer where pointer to malloced string will be stored. Memory must be released by free()
677  */
678 #define parse_osinfo_for_bz libreport_parse_osinfo_for_bz
679 void parse_osinfo_for_bz(map_string_t *osinfo, char **product, char **version);
680 
681 /* @brief Builds product string and product's version string for Red Hat Support
682  *
683  * At first tries to get strings from the os specific variables
684  * (REDHAT_SUPPORT_PRODUCT, REDHAT_SUPPORT_PRODUCT_VERSION) if no such
685  * variables are found, uses NAME key for the product and VERSION_ID key for
686  * the product's version. If no NAME nor VERSION_ID are provided fallbacks to
687  * parsing of os_release which should be stored under PRETTY_NAME key.
688  *
689  * https://bugzilla.redhat.com/show_bug.cgi?id=950373
690  *
691  * @param osinfo Input data from which the values are built
692  * @param produc Non-NULL pointer where pointer to malloced string will be stored. Memory must be released by free()
693  * @param version Non-NULL pointer where pointer to malloced string will be stored. Memory must be released by free()
694  */
695 #define parse_osinfo_for_rhts libreport_parse_osinfo_for_rhts
696 void parse_osinfo_for_rhts(map_string_t *osinfo, char **product, char **version);
697 
698 #define parse_release_for_bz libreport_parse_release_for_bz
699 void parse_release_for_bz(const char *pRelease, char **product, char **version);
700 #define parse_release_for_rhts libreport_parse_release_for_rhts
701 void parse_release_for_rhts(const char *pRelease, char **product, char **version);
702 
717 #define load_conf_file libreport_load_conf_file
718 bool load_conf_file(const char *pPath, map_string_t *settings, bool skipKeysWithoutValue);
719 
720 #define load_conf_file_from_dirs libreport_load_conf_file_from_dirs
721 bool load_conf_file_from_dirs(const char *base_name, const char *const *directories, map_string_t *settings, bool skipKeysWithoutValue);
722 
723 #define save_conf_file libreport_save_conf_file
724 bool save_conf_file(const char *path, map_string_t *settings);
725 
726 #define save_app_conf_file libreport_save_app_conf_file
727 bool save_app_conf_file(const char* application_name, map_string_t *settings);
728 #define load_app_conf_file libreport_load_app_conf_file
729 bool load_app_conf_file(const char *application_name, map_string_t *settings);
730 #define set_app_user_setting libreport_set_app_user_setting
731 void set_app_user_setting(map_string_t *settings, const char *name, const char *value);
732 #define get_app_user_setting libreport_get_app_user_setting
733 const char *get_app_user_setting(map_string_t *settings, const char *name);
734 
735 #define save_user_settings libreport_save_user_settings
736 bool save_user_settings();
737 #define load_user_settings libreport_load_user_settings
738 bool load_user_settings(const char *application_name);
739 #define set_user_setting libreport_set_user_setting
740 void set_user_setting(const char *name, const char *value);
741 #define get_user_setting libreport_get_user_setting
742 const char *get_user_setting(const char *name);
743 
744 /* filename is expected to exist in CONF_DIR
745  * usually /etc/libreport
746  */
747 #define load_forbidden_words libreport_load_forbidden_words
748 GList *load_words_from_file(const char *filename);
749 #define get_file_list libreport_get_file_list
750 GList *get_file_list(const char *path, const char *ext);
751 #define free_file_list libreport_free_file_list
752 void free_file_list(GList *filelist);
753 #define new_file_obj libreport_new_file_obj
754 file_obj_t *new_file_obj(const char* fullpath, const char* filename);
755 #define free_file_obj libreport_free_file_obj
756 void free_file_obj(file_obj_t *f);
757 #define load_workflow_config_data libreport_load_workflow_config_data
758 GHashTable *load_workflow_config_data(const char* path);
759 #define parse_list libreport_parse_list
760 GList *parse_list(const char* list);
761 
762 /* Connect to abrtd over unix domain socket, issue DELETE command */
763 int delete_dump_dir_possibly_using_abrtd(const char *dump_dir_name);
764 
765 /* Tries to create a copy of dump_dir_name in base_dir, with same or similar basename.
766  * Returns NULL if copying failed. In this case, logs a message before returning. */
767 #define steal_directory libreport_steal_directory
768 struct dump_dir *steal_directory(const char *base_dir, const char *dump_dir_name);
769 
770 /* Tries to open dump_dir_name with writing access. If function needs to steal
771  * directory calls ask_continue(new base dir, dump dir) callback to ask user
772  * for permission. If ask_continue param is NULL the function thinks that an
773  * answer is positive and steals directory.
774  * Returns NULL if opening failed or if stealing was dismissed. In this case,
775  * logs a message before returning. */
776 #define open_directory_for_writing libreport_open_directory_for_writing
777 struct dump_dir *open_directory_for_writing(
778  const char *dump_dir_name,
779  bool (*ask_continue)(const char *, const char *));
780 
781 // Files bigger than this are never considered to be text.
782 //
783 // Started at 64k limit. But _some_ limit is necessary:
784 // fields declared "text" may end up in editing fields and such.
785 // We don't want to accidentally end up with 100meg text in a textbox!
786 // So, don't remove this. If you really need to, raise the limit.
787 //
788 // Bumped up to 200k: saw 124740 byte /proc/PID/smaps file
789 // Bumped up to 500k: saw 375252 byte anaconda traceback file
790 // Bumped up to 1M: bugzilla.redhat.com/show_bug.cgi?id=746727
791 // mentions 853646 byte anaconda-tb-* file.
792 // Bumped up to 8M: bugzilla.redhat.com/show_bug.cgi?id=887570
793 // (anaconda-tb file of 1.38 MBytes)
794 //
795 #define CD_MAX_TEXT_SIZE (8*1024*1024)
796 
797 // Text bigger than this usually is attached, not added inline
798 // was 2k, 20kb is too much, let's try 4kb
799 //
800 // For bug databases
801 #define CD_TEXT_ATT_SIZE_BZ (4*1024)
802 // For dumping problem data into a text file, email, etc
803 #define CD_TEXT_ATT_SIZE_LOGGER (CD_MAX_TEXT_SIZE)
804 
805 // Filenames in problem directory:
806 // filled by a hook:
807 #define FILENAME_TIME "time" /* mandatory */
808 #define FILENAME_LAST_OCCURRENCE "last_occurrence" /* optional */
809 #define FILENAME_REASON "reason" /* mandatory? */
810 #define FILENAME_UID "uid" /* mandatory? */
811 /*
812  * "analyzer" is to be gradually changed to "type":
813  * For now, we fetch and look at "analyzer" element,
814  * but we always save both "analyzer" and "type" (with same contents).
815  * By 2013, we switch to looking at "type". Then we will stop generating
816  * "analyzer" element.
817  */
818 #define FILENAME_ANALYZER "analyzer"
819 #define FILENAME_TYPE "type"
820 #define FILENAME_EXECUTABLE "executable"
821 #define FILENAME_PID "pid"
822 #define FILENAME_PWD "pwd"
823 #define FILENAME_ROOTDIR "rootdir"
824 #define FILENAME_BINARY "binary"
825 #define FILENAME_CMDLINE "cmdline"
826 #define FILENAME_COREDUMP "coredump"
827 #define FILENAME_CGROUP "cgroup"
828 #define FILENAME_BACKTRACE "backtrace"
829 #define FILENAME_MAPS "maps"
830 #define FILENAME_SMAPS "smaps"
831 #define FILENAME_PROC_PID_STATUS "proc_pid_status"
832 #define FILENAME_ENVIRON "environ"
833 #define FILENAME_LIMITS "limits"
834 #define FILENAME_OPEN_FDS "open_fds"
835 
836 /* Global problem identifier which is usually generated by some "analyze_*"
837  * event because it may take a lot of time to obtain strong problem
838  * identification */
839 #define FILENAME_DUPHASH "duphash"
840 
841 // Name of the function where the application crashed.
842 // Optional.
843 #define FILENAME_CRASH_FUNCTION "crash_function"
844 #define FILENAME_ARCHITECTURE "architecture"
845 #define FILENAME_KERNEL "kernel"
846 /*
847  * From /etc/os-release
848  * os_release filename name is alredy occupied by /etc/redhat-release (see
849  * below) in sake of backward compatibility /etc/os-release is stored in
850  * os_info file
851  */
852 #define FILENAME_OS_INFO "os_info"
853 #define FILENAME_OS_INFO_IN_ROOTDIR "os_info_in_rootdir"
854 // From /etc/system-release or /etc/redhat-release
855 #define FILENAME_OS_RELEASE "os_release"
856 #define FILENAME_OS_RELEASE_IN_ROOTDIR "os_release_in_rootdir"
857 // Filled by <what?>
858 #define FILENAME_PACKAGE "package"
859 #define FILENAME_COMPONENT "component"
860 #define FILENAME_COMMENT "comment"
861 #define FILENAME_RATING "backtrace_rating"
862 #define FILENAME_HOSTNAME "hostname"
863 // Optional. Set to "1" by abrt-handle-upload for every unpacked dump
864 #define FILENAME_REMOTE "remote"
865 #define FILENAME_TAINTED "kernel_tainted"
866 #define FILENAME_TAINTED_SHORT "kernel_tainted_short"
867 #define FILENAME_TAINTED_LONG "kernel_tainted_long"
868 #define FILENAME_VMCORE "vmcore"
869 #define FILENAME_KERNEL_LOG "kernel_log"
870 // File created by createAlertSignature() from libreport's python module
871 // The file should contain a description of an alert
872 #define FILENAME_DESCRIPTION "description"
873 
874 /* Local problem identifier (weaker than global identifier) designed for fast
875  * local for fast local duplicate identification. This file is usually provided
876  * by crashed application (problem creator).
877  */
878 #define FILENAME_UUID "uuid"
879 
880 #define FILENAME_COUNT "count"
881 /* Multi-line list of places problem was reported.
882  * Recommended line format:
883  * "Reporter: VAR=VAL VAR=VAL"
884  * Use add_reported_to(dd, "line_without_newline"): it adds line
885  * only if it is not already there.
886  */
887 #define FILENAME_REPORTED_TO "reported_to"
888 #define FILENAME_EVENT_LOG "event_log"
889 /*
890  * If exists, should contain a full sentence (with trailing period)
891  * which describes why this problem should not be reported.
892  * Example: "Your laptop firmware 1.9a is buggy, version 1.10 contains the fix."
893  */
894 #define FILENAME_NOT_REPORTABLE "not-reportable"
895 #define FILENAME_CORE_BACKTRACE "core_backtrace"
896 #define FILENAME_REMOTE_RESULT "remote_result"
897 #define FILENAME_PKG_EPOCH "pkg_epoch"
898 #define FILENAME_PKG_NAME "pkg_name"
899 #define FILENAME_PKG_VERSION "pkg_version"
900 #define FILENAME_PKG_RELEASE "pkg_release"
901 #define FILENAME_PKG_ARCH "pkg_arch"
902 #define FILENAME_USERNAME "username"
903 #define FILENAME_ABRT_VERSION "abrt_version"
904 #define FILENAME_EXPLOITABLE "exploitable"
905 
906 // Not stored as files, added "on the fly":
907 #define CD_DUMPDIR "Directory"
908 
909 #define cmp_problem_data libreport_cmp_problem_data
910 gint cmp_problem_data(gconstpointer a, gconstpointer b, gpointer filename);
911 
912 //UNUSED:
915 //#define CD_EVENTS "Events"
916 
917 /* FILENAME_EVENT_LOG is trimmed to below LOW_WATERMARK
918  * when it reaches HIGH_WATERMARK size
919  */
920 enum {
921  EVENT_LOG_HIGH_WATERMARK = 30 * 1024,
922  EVENT_LOG_LOW_WATERMARK = 20 * 1024,
923 };
924 
925 #define log_problem_data libreport_log_problem_data
926 void log_problem_data(problem_data_t *problem_data, const char *pfx);
927 
928 extern int g_libreport_inited;
929 void libreport_init(void);
930 
931 #define INITIALIZE_LIBREPORT() \
932  do \
933  { \
934  if (!g_libreport_inited) \
935  { \
936  g_libreport_inited = 1; \
937  libreport_init(); \
938  } \
939  } \
940  while (0)
941 
942 const char *abrt_init(char **argv);
943 #define export_abrt_envvars libreport_export_abrt_envvars
944 void export_abrt_envvars(int pfx);
945 #define g_progname libreport_g_progname
946 extern const char *g_progname;
947 
948 enum parse_opt_type {
949  OPTION_BOOL,
950  OPTION_GROUP,
951  OPTION_STRING,
952  OPTION_INTEGER,
953  OPTION_OPTSTRING,
954  OPTION_LIST,
955  OPTION_END,
956 };
957 
958 struct options {
959  enum parse_opt_type type;
960  int short_name;
961  const char *long_name;
962  void *value;
963  const char *argh;
964  const char *help;
965 };
966 
967 /*
968  * s - short_name
969  * l - long_name
970  * v - value
971  * a - option parameter name (for help text)
972  * h - help
973  */
974 #define OPT_END() { OPTION_END }
975 #define OPT_GROUP(h) { OPTION_GROUP, 0, NULL, NULL, NULL, (h) }
976 #define OPT_BOOL( s, l, v, h) { OPTION_BOOL , (s), (l), (v), NULL , (h) }
977 #define OPT_INTEGER( s, l, v, h) { OPTION_INTEGER , (s), (l), (v), "NUM", (h) }
978 #define OPT_STRING( s, l, v, a, h) { OPTION_STRING , (s), (l), (v), (a) , (h) }
979 #define OPT_OPTSTRING(s, l, v, a, h) { OPTION_OPTSTRING, (s), (l), (v), (a) , (h) }
980 #define OPT_LIST( s, l, v, a, h) { OPTION_LIST , (s), (l), (v), (a) , (h) }
981 
982 #define OPT__VERBOSE(v) OPT_BOOL('v', "verbose", (v), _("Be verbose"))
983 #define OPT__DUMP_DIR(v) OPT_STRING('d', "problem-dir", (v), "DIR", _("Problem directory"))
984 
985 #define parse_opts libreport_parse_opts
986 unsigned parse_opts(int argc, char **argv, const struct options *opt,
987  const char *usage);
988 
989 #define show_usage_and_die libreport_show_usage_and_die
990 void show_usage_and_die(const char *usage, const struct options *opt) NORETURN;
991 
992 /* Can't include "abrt_curl.h", it's not a public API.
993  * Resorting to just forward-declaring the struct we need.
994  */
995 struct abrt_post_state;
996 
997 #ifdef __cplusplus
998 }
999 #endif
1000 
1001 #endif