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