libreport  2.5.1
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 /* Try to pull in PATH_MAX */
49 #include <limits.h>
50 #include <sys/param.h>
51 #ifndef PATH_MAX
52 # define PATH_MAX 256
53 #endif
54 #include <pwd.h>
55 #include <grp.h>
56 
57 #ifdef HAVE_CONFIG_H
58 # include "config.h"
59 #endif
60 
61 /* Must be after #include "config.h" */
62 #if ENABLE_NLS
63 # include <libintl.h>
64 # define _(S) dgettext(PACKAGE, S)
65 #else
66 # define _(S) (S)
67 #endif
68 
69 #if HAVE_LOCALE_H
70 # include <locale.h>
71 #endif /* HAVE_LOCALE_H */
72 
73 /* Some libc's forget to declare these, do it ourself */
74 extern char **environ;
75 #if defined(__GLIBC__) && __GLIBC__ < 2
76 int vdprintf(int d, const char *format, va_list ap);
77 #endif
78 
79 #undef NORETURN
80 #define NORETURN __attribute__ ((noreturn))
81 
82 #undef ERR_PTR
83 #define ERR_PTR ((void*)(uintptr_t)1)
84 
85 #undef ARRAY_SIZE
86 #define ARRAY_SIZE(x) ((unsigned)(sizeof(x) / sizeof((x)[0])))
87 
88 /* consts used across whole libreport */
89 #define CREATE_PRIVATE_TICKET "ABRT_CREATE_PRIVATE_TICKET"
90 
91 /* Pull in entire public libreport API */
92 #include "global_configuration.h"
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 #define decompress_fd libreport_decompress_fd
167 int decompress_fd(int fdi, int fdo);
168 #define decompress_file libreport_decompress_file
169 int decompress_file(const char *path_in, const char *path_out, mode_t mode_out);
170 
171 // NB: will return short read on error, not -1,
172 // if some data was read before error occurred
173 #define xread libreport_xread
174 void xread(int fd, void *buf, size_t count);
175 #define safe_read libreport_safe_read
176 ssize_t safe_read(int fd, void *buf, size_t count);
177 #define safe_write libreport_safe_write
178 ssize_t safe_write(int fd, const void *buf, size_t count);
179 #define full_read libreport_full_read
180 ssize_t full_read(int fd, void *buf, size_t count);
181 #define full_write libreport_full_write
182 ssize_t full_write(int fd, const void *buf, size_t count);
183 #define full_write_str libreport_full_write_str
184 ssize_t full_write_str(int fd, const char *buf);
185 #define xmalloc_read libreport_xmalloc_read
186 void* xmalloc_read(int fd, size_t *maxsz_p);
187 #define xmalloc_open_read_close libreport_xmalloc_open_read_close
188 void* xmalloc_open_read_close(const char *filename, size_t *maxsz_p);
189 #define xmalloc_xopen_read_close libreport_xmalloc_xopen_read_close
190 void* xmalloc_xopen_read_close(const char *filename, size_t *maxsz_p);
191 #define malloc_readlink libreport_malloc_readlink
192 char* malloc_readlink(const char *linkname);
193 #define malloc_readlinkat libreport_malloc_readlinkat
194 char* malloc_readlinkat(int dir_fd, const char *linkname);
195 
196 
197 /* Returns malloc'ed block */
198 #define encode_base64 libreport_encode_base64
199 char *encode_base64(const void *src, int length);
200 
201 /* Returns NULL if the string needs no sanitizing.
202  * control_chars_to_sanitize is a bit mask.
203  * If Nth bit is set, Nth control char will be sanitized (replaced by [XX]).
204  */
205 #define sanitize_utf8 libreport_sanitize_utf8
206 char *sanitize_utf8(const char *src, uint32_t control_chars_to_sanitize);
207 enum {
208  SANITIZE_ALL = 0xffffffff,
209  SANITIZE_TAB = (1 << 9),
210  SANITIZE_LF = (1 << 10),
211  SANITIZE_CR = (1 << 13),
212 };
213 
214 #define SHA1_RESULT_LEN (5 * 4)
215 typedef struct sha1_ctx_t {
216  uint8_t wbuffer[64]; /* always correctly aligned for uint64_t */
217  /* for sha256: void (*process_block)(struct md5_ctx_t*); */
218  uint64_t total64; /* must be directly before hash[] */
219  uint32_t hash[8]; /* 4 elements for md5, 5 for sha1, 8 for sha256 */
220 } sha1_ctx_t;
221 #define sha1_begin libreport_sha1_begin
222 void sha1_begin(sha1_ctx_t *ctx);
223 #define sha1_hash libreport_sha1_hash
224 void sha1_hash(sha1_ctx_t *ctx, const void *buffer, size_t len);
225 #define sha1_end libreport_sha1_end
226 void sha1_end(sha1_ctx_t *ctx, void *resbuf);
227 
228 /* Helpers to hash a string: */
229 #define str_to_sha1 libreport_str_to_sha1
230 const uint8_t *str_to_sha1(uint8_t result[SHA1_RESULT_LEN], const char *str);
231 #define str_to_sha1str libreport_str_to_sha1str
232 const char *str_to_sha1str(char result[SHA1_RESULT_LEN*2 + 1], const char *str);
233 
234 
235 #define xatou libreport_xatou
236 unsigned xatou(const char *numstr);
237 #define xatoi libreport_xatoi
238 int xatoi(const char *numstr);
239 /* Using xatoi() instead of naive atoi() is not always convenient -
240  * in many places people want *non-negative* values, but store them
241  * in signed int. Therefore we need this one:
242  * dies if input is not in [0, INT_MAX] range. Also will reject '-0' etc.
243  * It should really be named xatoi_nonnegative (since it allows 0),
244  * but that would be too long.
245  */
246 #define xatoi_positive libreport_xatoi_positive
247 int xatoi_positive(const char *numstr);
248 
249 //unused for now
250 //unsigned long long monotonic_ns(void);
251 //unsigned long long monotonic_us(void);
252 //unsigned monotonic_sec(void);
253 
254 #define safe_waitpid libreport_safe_waitpid
255 pid_t safe_waitpid(pid_t pid, int *wstat, int options);
256 
257 enum {
258  /* on return, pipefds[1] is fd to which parent may write
259  * and deliver data to child's stdin: */
260  EXECFLG_INPUT = 1 << 0,
261  /* on return, pipefds[0] is fd from which parent may read
262  * child's stdout: */
263  EXECFLG_OUTPUT = 1 << 1,
264  /* open child's stdin to /dev/null: */
265  EXECFLG_INPUT_NUL = 1 << 2,
266  /* open child's stdout to /dev/null: */
267  EXECFLG_OUTPUT_NUL = 1 << 3,
268  /* redirect child's stderr to stdout: */
269  EXECFLG_ERR2OUT = 1 << 4,
270  /* open child's stderr to /dev/null: */
271  EXECFLG_ERR_NUL = 1 << 5,
272  /* suppress perror_msg("Can't execute 'foo'") if exec fails */
273  EXECFLG_QUIET = 1 << 6,
274  EXECFLG_SETGUID = 1 << 7,
275  EXECFLG_SETSID = 1 << 8,
276  EXECFLG_SETPGID = 1 << 9,
277 };
278 /*
279  * env_vec: list of variables to set in environment (if string has
280  * "VAR=VAL" form) or unset in environment (if string has no '=' char).
281  *
282  * Returns pid.
283  */
284 #define fork_execv_on_steroids libreport_fork_execv_on_steroids
285 pid_t fork_execv_on_steroids(int flags,
286  char **argv,
287  int *pipefds,
288  char **env_vec,
289  const char *dir,
290  uid_t uid);
291 /* Returns malloc'ed string. NULs are retained, and extra one is appended
292  * after the last byte (this NUL is not accounted for in *size_p) */
293 #define run_in_shell_and_save_output libreport_run_in_shell_and_save_output
294 char *run_in_shell_and_save_output(int flags,
295  const char *cmd,
296  const char *dir,
297  size_t *size_p);
298 
299 /* Random utility functions */
300 
301 #define is_in_string_list libreport_is_in_string_list
302 bool is_in_string_list(const char *name, const char *const *v);
303 
304 #define index_of_string_in_list libreport_index_of_string_in_list
305 int index_of_string_in_list(const char *name, const char *const *v);
306 
307 #define is_in_comma_separated_list libreport_is_in_comma_separated_list
308 bool is_in_comma_separated_list(const char *value, const char *list);
309 #define is_in_comma_separated_list_of_glob_patterns libreport_is_in_comma_separated_list_of_glob_patterns
310 bool is_in_comma_separated_list_of_glob_patterns(const char *value, const char *list);
311 
312 /* Calls GLib version appropriate initialization function.
313  */
314 #define glib_init libreport_glib_init
315 void glib_init(void);
316 
317 /* Frees every element'd data using free(),
318  * then frees list itself using g_list_free(list):
319  */
320 #define list_free_with_free libreport_list_free_with_free
321 void list_free_with_free(GList *list);
322 
323 #define get_dirsize libreport_get_dirsize
324 double get_dirsize(const char *pPath);
325 #define get_dirsize_find_largest_dir libreport_get_dirsize_find_largest_dir
326 double get_dirsize_find_largest_dir(
327  const char *pPath,
328  char **worst_dir, /* can be NULL */
329  const char *excluded /* can be NULL */
330 );
331 
332 #define ndelay_on libreport_ndelay_on
333 int ndelay_on(int fd);
334 #define ndelay_off libreport_ndelay_off
335 int ndelay_off(int fd);
336 #define close_on_exec_on libreport_close_on_exec_on
337 int close_on_exec_on(int fd);
338 
339 #define xmalloc libreport_xmalloc
340 void* xmalloc(size_t size);
341 #define xrealloc libreport_xrealloc
342 void* xrealloc(void *ptr, size_t size);
343 #define xzalloc libreport_xzalloc
344 void* xzalloc(size_t size);
345 #define xstrdup libreport_xstrdup
346 char* xstrdup(const char *s);
347 #define xstrndup libreport_xstrndup
348 char* xstrndup(const char *s, int n);
349 #define xstrdup_between libreport_xstrdup_between
350 char* xstrdup_between(const char *s, const char *open, const char *close);
351 
352 #define xpipe libreport_xpipe
353 void xpipe(int filedes[2]);
354 #define xdup libreport_xdup
355 int xdup(int from);
356 #define xdup2 libreport_xdup2
357 void xdup2(int from, int to);
358 #define xmove_fd libreport_xmove_fd
359 void xmove_fd(int from, int to);
360 
361 #define xwrite libreport_xwrite
362 void xwrite(int fd, const void *buf, size_t count);
363 #define xwrite_str libreport_xwrite_str
364 void xwrite_str(int fd, const char *str);
365 
366 #define xlseek libreport_xlseek
367 off_t xlseek(int fd, off_t offset, int whence);
368 
369 #define xchdir libreport_xchdir
370 void xchdir(const char *path);
371 
372 #define xvasprintf libreport_xvasprintf
373 char* xvasprintf(const char *format, va_list p);
374 #define xasprintf libreport_xasprintf
375 char* xasprintf(const char *format, ...);
376 
377 #define xsetenv libreport_xsetenv
378 void xsetenv(const char *key, const char *value);
379 /*
380  * Utility function to unsetenv a string which was possibly putenv'ed.
381  * The problem here is that "natural" optimization:
382  * strchrnul(var_val, '=')[0] = '\0';
383  * unsetenv(var_val);
384  * is BUGGY: if string was put into environment via putenv,
385  * its modification (s/=/NUL/) is illegal, and unsetenv will fail to unset it.
386  * Of course, saving/restoring the char wouldn't work either.
387  * This helper creates a copy up to '=', unsetenv's it, and frees:
388  */
389 #define safe_unsetenv libreport_safe_unsetenv
390 void safe_unsetenv(const char *var_val);
391 
392 #define xsocket libreport_xsocket
393 int xsocket(int domain, int type, int protocol);
394 #define xbind libreport_xbind
395 void xbind(int sockfd, struct sockaddr *my_addr, socklen_t addrlen);
396 #define xlisten libreport_xlisten
397 void xlisten(int s, int backlog);
398 #define xsendto libreport_xsendto
399 ssize_t xsendto(int s, const void *buf, size_t len,
400  const struct sockaddr *to, socklen_t tolen);
401 
402 #define xstat libreport_xstat
403 void xstat(const char *name, struct stat *stat_buf);
404 #define fstat_st_size_or_die libreport_fstat_st_size_or_die
405 off_t fstat_st_size_or_die(int fd);
406 #define stat_st_size_or_die libreport_stat_st_size_or_die
407 off_t stat_st_size_or_die(const char *filename);
408 
409 #define xopen3 libreport_xopen3
410 int xopen3(const char *pathname, int flags, int mode);
411 #define xopen libreport_xopen
412 int xopen(const char *pathname, int flags);
413 #define xunlink libreport_xunlink
414 void xunlink(const char *pathname);
415 
416 /* Just testing dent->d_type == DT_REG is wrong: some filesystems
417  * do not report the type, they report DT_UNKNOWN for every dirent
418  * (and this is not a bug in filesystem, this is allowed by standards).
419  * This function handles this case. Note: it returns 0 on symlinks
420  * even if they point to regular files.
421  */
422 #define is_regular_file libreport_is_regular_file
423 int is_regular_file(struct dirent *dent, const char *dirname);
424 
425 #define dot_or_dotdot libreport_dot_or_dotdot
426 bool dot_or_dotdot(const char *filename);
427 #define last_char_is libreport_last_char_is
428 char *last_char_is(const char *s, int c);
429 
430 #define string_to_bool libreport_string_to_bool
431 bool string_to_bool(const char *s);
432 
433 #define xseteuid libreport_xseteuid
434 void xseteuid(uid_t euid);
435 #define xsetegid libreport_xsetegid
436 void xsetegid(gid_t egid);
437 #define xsetreuid libreport_xsetreuid
438 void xsetreuid(uid_t ruid, uid_t euid);
439 #define xsetregid libreport_xsetregid
440 void xsetregid(gid_t rgid, gid_t egid);
441 
442 
443 /* Emit a string of hex representation of bytes */
444 #define bin2hex libreport_bin2hex
445 char* bin2hex(char *dst, const char *str, int count);
446 /* Convert "xxxxxxxx" hex string to binary, no more than COUNT bytes */
447 #define hex2bin libreport_hex2bin
448 char* hex2bin(char *dst, const char *str, int count);
449 
450 
451 enum {
452  LOGMODE_NONE = 0,
453  LOGMODE_STDIO = (1 << 0),
454  LOGMODE_SYSLOG = (1 << 1),
455  LOGMODE_BOTH = LOGMODE_SYSLOG + LOGMODE_STDIO,
456  LOGMODE_CUSTOM = (1 << 2),
457  LOGMODE_JOURNAL = (1 << 3),
458 };
459 
460 #define g_custom_logger libreport_g_custom_logger
461 extern void (*g_custom_logger)(const char*);
462 #define msg_prefix libreport_msg_prefix
463 extern const char *msg_prefix;
464 #define msg_eol libreport_msg_eol
465 extern const char *msg_eol;
466 #define logmode libreport_logmode
467 extern int logmode;
468 #define xfunc_error_retval libreport_xfunc_error_retval
469 extern int xfunc_error_retval;
470 
471 /* A few magic exit codes */
472 #define EXIT_CANCEL_BY_USER 69
473 #define EXIT_STOP_EVENT_RUN 70
474 
475 #define set_xfunc_error_retval libreport_set_xfunc_error_retval
476 void set_xfunc_error_retval(int retval);
477 
478 /* Verbosity level */
479 #define g_verbose libreport_g_verbose
480 extern int g_verbose;
481 /* VERB1 log("what you sometimes want to see, even on a production box") */
482 #define VERB1 if (g_verbose >= 1)
483 /* VERB2 log("debug message, not going into insanely small details") */
484 #define VERB2 if (g_verbose >= 2)
485 /* VERB3 log("lots and lots of details") */
486 #define VERB3 if (g_verbose >= 3)
487 /* there is no level > 3 */
488 
489 #define libreport_
490 #define xfunc_die libreport_xfunc_die
491 void xfunc_die(void) NORETURN;
492 
493 #define die_out_of_memory libreport_die_out_of_memory
494 void die_out_of_memory(void) NORETURN;
495 
496 /* It's a macro, not function, since it collides with log() from math.h */
497 #undef log
498 #define log(...) log_standard(LOG_WARNING, __FILE__, __LINE__, __func__, __VA_ARGS__)
499 #define log_debug(...) log_standard(LOG_DEBUG, __FILE__, __LINE__, __func__, __VA_ARGS__)
500 #define log_info(...) log_standard(LOG_INFO, __FILE__, __LINE__, __func__, __VA_ARGS__)
501 #define log_notice(...) log_standard(LOG_NOTICE, __FILE__, __LINE__, __func__, __VA_ARGS__)
502 #define log_warning(...) log_standard(LOG_WARNING, __FILE__, __LINE__, __func__, __VA_ARGS__)
503 #define log_error(...) log_standard(LOG_ERR, __FILE__, __LINE__, __func__, __VA_ARGS__)
504 
505 #define log_standard(level, file, line, func, ...) log_wrapper(level, __FILE__, __LINE__, __func__, false, false, __VA_ARGS__)
506 
507 // level, file, line, func, perror, custom logger, format & args
508 #define log_error_and_die(...) log_wrapper(LOG_ERR, __FILE__, __LINE__, __func__, false, false,__VA_ARGS__)
509 #define log_perror(...) log_wrapper(LOG_ERR, __FILE__, __LINE__, __func__, true, false, __VA_ARGS__)
510 #define log_perror_and_die(...) log_wrapper(LOG_ERR, __FILE__, __LINE__, __func__, true, false, __VA_ARGS__)
511 
512 #define error_msg(...) log_wrapper(LOG_ERR, __FILE__, __LINE__, __func__, false, true, __VA_ARGS__)
513 #define perror_msg(...) log_wrapper(LOG_ERR, __FILE__, __LINE__, __func__, true, true, __VA_ARGS__)
514 #define warn_msg(...) log_wrapper(LOG_WARNING, __FILE__, __LINE__, __func__, false, true, __VA_ARGS__)
515 #define pwarn_msg(...) log_wrapper(LOG_WARNING, __FILE__, __LINE__, __func__, true, true, __VA_ARGS__)
516 #define error_msg_and_die(...) log_and_die_wrapper(LOG_ERR, __FILE__, __LINE__, __func__, false, true, __VA_ARGS__)
517 #define perror_msg_and_die(...) log_and_die_wrapper(LOG_ERR, __FILE__, __LINE__, __func__, true, true, __VA_ARGS__)
518 
519 
520 void log_wrapper(int level,
521  const char *file,
522  int line,
523  const char *func,
524  bool process_perror,
525  bool use_custom_logger,
526  const char *format, ...) __attribute__ ((format (printf, 7,8)));
527 
528 void log_and_die_wrapper(int level,
529  const char *file,
530  int line,
531  const char *func,
532  bool process_perror,
533  bool use_custom_logger,
534  const char *format, ...) __attribute__ ((noreturn, format (printf, 7,8)));
535 
536 struct strbuf
537 {
538  /* Size of the allocated buffer. Always > 0. */
539  int alloc;
540  /* Length of the string, without the ending \0. */
541  int len;
542  char *buf;
543 };
544 
551 #define strbuf_new libreport_strbuf_new
552 struct strbuf *strbuf_new(void);
553 
559 #define strbuf_free libreport_strbuf_free
560 void strbuf_free(struct strbuf *strbuf);
561 
567 #define strbuf_free_nobuf libreport_strbuf_free_nobuf
568 char* strbuf_free_nobuf(struct strbuf *strbuf);
569 
574 #define strbuf_clear libreport_strbuf_clear
575 void strbuf_clear(struct strbuf *strbuf);
576 
581 #define strbuf_append_char libreport_strbuf_append_char
582 struct strbuf *strbuf_append_char(struct strbuf *strbuf, char c);
583 
588 #define strbuf_append_str libreport_strbuf_append_str
589 struct strbuf *strbuf_append_str(struct strbuf *strbuf,
590  const char *str);
591 
596 #define strbuf_prepend_str libreport_strbuf_prepend_str
597 struct strbuf *strbuf_prepend_str(struct strbuf *strbuf,
598  const char *str);
599 
604 #define strbuf_append_strf libreport_strbuf_append_strf
605 struct strbuf *strbuf_append_strf(struct strbuf *strbuf,
606  const char *format, ...);
607 
612 #define strbuf_append_strfv libreport_strbuf_append_strfv
613 struct strbuf *strbuf_append_strfv(struct strbuf *strbuf,
614  const char *format, va_list p);
615 
621 #define strbuf_prepend_strf libreport_strbuf_prepend_strf
622 struct strbuf *strbuf_prepend_strf(struct strbuf *strbuf,
623  const char *format, ...);
624 
629 #define strbuf_prepend_strfv libreport_strbuf_prepend_strfv
630 struct strbuf *strbuf_prepend_strfv(struct strbuf *strbuf,
631  const char *format, va_list p);
632 
633 /* Returns command line of running program.
634  * Caller is responsible to free() the returned value.
635  * If the pid is not valid or command line can not be obtained,
636  * empty string is returned.
637  */
638 #define get_cmdline libreport_get_cmdline
639 char* get_cmdline(pid_t pid);
640 #define get_environ libreport_get_environ
641 char* get_environ(pid_t pid);
642 #define get_executable libreport_get_executable
643 char *get_executable(pid_t pid);
644 #define get_cwd libreport_get_cwd
645 char* get_cwd(pid_t pid);
646 #define get_rootdir libreport_get_rootdir
647 char* get_rootdir(pid_t pid);
648 #define get_fsuid libreport_get_fsuid
649 int get_fsuid(const char *proc_pid_status);
650 #define dump_fd_info libreport_dump_fd_info
651 int dump_fd_info(const char *dest_filename, const char *proc_pid_fd_path);
652 #define get_env_variable libreport_get_env_variable
653 int get_env_variable(pid_t pid, const char *name, char **value);
654 
655 #define PROC_NS_UNSUPPORTED ((ino_t)-1)
656 #define PROC_NS_ID_IPC 0
657 #define PROC_NS_ID_MNT 1
658 #define PROC_NS_ID_NET 2
659 #define PROC_NS_ID_PID 3
660 #define PROC_NS_ID_USER 4
661 #define PROC_NS_ID_UTS 5
662 static const char * libreport_proc_namespaces[] = { "ipc", "mnt", "net", "pid", "uts", "user" };
663 
664 struct ns_ids {
665  ino_t nsi_ids[ARRAY_SIZE(libreport_proc_namespaces)];
666 };
667 
668 #define get_ns_ids libreport_get_ns_ids
669 int get_ns_ids(pid_t pid, struct ns_ids *ids);
670 #define process_has_own_root libreport_process_has_own_root
671 int process_has_own_root(pid_t pid);
672 #define get_pid_of_container libreport_get_pid_of_container
673 int get_pid_of_container(pid_t pid, pid_t *init_pid);
674 #define dump_namespace_diff libreport_dump_namespace_diff
675 int dump_namespace_diff(const char *dest_filename, pid_t base_pid, pid_t tested_pid);
676 
677 #define MOUNTINFO_ROOT(val) (val.mntnf_items[3])
678 #define MOUNTINFO_MOUNT_POINT(val) (val.mntnf_items[4])
679 #define MOUNTINFO_MOUNT_SOURCE(val) (val.mntnf_items[8])
680 
681 struct mountinfo
682 {
683  /* 4 : root of the mount within the filesystem */
684  /* 5 : mount point relative to the process's root */
685  /* 10 : mount source: filesystem specific information or "none" */
686  /* but it mount source is preceded by 0 or more optional fields */
687  /* so the effective value is 9 */
688  char *mntnf_items[10];
689 };
690 #define mountinfo_destroy libreport_mountinfo_destroy
691 void mountinfo_destroy(struct mountinfo *mntnf);
692 #define get_mountinfo_for_mount_point libreport_get_mountinfo_for_mount_point
693 int get_mountinfo_for_mount_point(FILE *fin, struct mountinfo *mntnf, const char *mnt_point);
694 
695 /* Takes ptr to time_t, or NULL if you want to use current time.
696  * Returns "YYYY-MM-DD-hh:mm:ss" string.
697  */
698 #define iso_date_string libreport_iso_date_string
699 char *iso_date_string(const time_t *pt);
700 #define LIBREPORT_ISO_DATE_STRING_SAMPLE "YYYY-MM-DD-hh:mm:ss"
701 
702 enum {
703  MAKEDESC_SHOW_FILES = (1 << 0),
704  MAKEDESC_SHOW_MULTILINE = (1 << 1),
705  MAKEDESC_SHOW_ONLY_LIST = (1 << 2),
706  MAKEDESC_WHITELIST = (1 << 3),
707  /* Include all URLs from FILENAME_REPORTED_TO element in the description text */
708  MAKEDESC_SHOW_URLS = (1 << 4),
709 };
710 #define make_description libreport_make_description
711 char *make_description(problem_data_t *problem_data, char **names_to_skip, unsigned max_text_size, unsigned desc_flags);
712 #define make_description_bz libreport_make_description_bz
713 char* make_description_bz(problem_data_t *problem_data, unsigned max_text_size);
714 #define make_description_logger libreport_make_description_logger
715 char* make_description_logger(problem_data_t *problem_data, unsigned max_text_size);
716 #define make_description_mailx libreport_make_description_mailx
717 char* make_description_mailx(problem_data_t *problem_data, unsigned max_text_size);
718 
719 /* See man os-release(5) for details */
720 #define OSINFO_ID "ID"
721 #define OSINFO_NAME "NAME"
722 #define OSINFO_VERSION_ID "VERSION_ID"
723 #define OSINFO_PRETTY_NAME "PRETTY_NAME"
724 
725 /* @brief Loads a text in format of os-release(5) in to a map
726  *
727  * Function doesn't check for format errors much. It just tries to avoid
728  * program errors. In case of error the function prints out a log message and
729  * continues in parsing.
730  *
731  * @param osinfo_bytes Non-NULL pointer to osinfo bytes.
732  * @param osinfo The map where result is stored
733  */
734 #define parse_osinfo libreport_parse_osinfo
735 void parse_osinfo(const char *osinfo_bytes, map_string_t *osinfo);
736 
737 /* @brief Builds product string and product's version string for Bugzilla
738  *
739  * At first tries to get strings from the os specific variables
740  * (REDHAT_BUGZILLA_PRODUCT, REDHAT_BUGZILLA_PRODUCT_VERSION) if no such
741  * variables are found, uses NAME key for the product and VERSION_ID key for
742  * the product's version. If neither NAME nor VERSION_ID are provided fallbacks
743  * to parsing of os_release which should be stored under PRETTY_NAME key.
744  *
745  * https://bugzilla.redhat.com/show_bug.cgi?id=950373
746  *
747  * @param osinfo Input data from which the values are built
748  * @param produc Non-NULL pointer where pointer to malloced string will be stored. Memory must be released by free()
749  * @param version Non-NULL pointer where pointer to malloced string will be stored. Memory must be released by free()
750  */
751 #define parse_osinfo_for_bz libreport_parse_osinfo_for_bz
752 void parse_osinfo_for_bz(map_string_t *osinfo, char **product, char **version);
753 
754 /* @brief Builds product string and product's version string for Red Hat Support
755  *
756  * At first tries to get strings from the os specific variables
757  * (REDHAT_SUPPORT_PRODUCT, REDHAT_SUPPORT_PRODUCT_VERSION) if no such
758  * variables are found, uses NAME key for the product and VERSION_ID key for
759  * the product's version. If no NAME nor VERSION_ID are provided fallbacks to
760  * parsing of os_release which should be stored under PRETTY_NAME key.
761  *
762  * https://bugzilla.redhat.com/show_bug.cgi?id=950373
763  *
764  * @param osinfo Input data from which the values are built
765  * @param produc Non-NULL pointer where pointer to malloced string will be stored. Memory must be released by free()
766  * @param version Non-NULL pointer where pointer to malloced string will be stored. Memory must be released by free()
767  */
768 #define parse_osinfo_for_rhts libreport_parse_osinfo_for_rhts
769 void parse_osinfo_for_rhts(map_string_t *osinfo, char **product, char **version);
770 
771 #define parse_release_for_bz libreport_parse_release_for_bz
772 void parse_release_for_bz(const char *pRelease, char **product, char **version);
773 #define parse_release_for_rhts libreport_parse_release_for_rhts
774 void parse_release_for_rhts(const char *pRelease, char **product, char **version);
775 
790 #define load_conf_file libreport_load_conf_file
791 bool load_conf_file(const char *pPath, map_string_t *settings, bool skipKeysWithoutValue);
792 #define load_plugin_conf_file libreport_load_plugin_conf_file
793 bool load_plugin_conf_file(const char *name, map_string_t *settings, bool skipKeysWithoutValue);
794 
795 #define get_user_conf_base_dir libreport_get_user_conf_base_dir
796 const char *get_user_conf_base_dir(void);
797 
798 #define load_conf_file_from_dirs libreport_load_conf_file_from_dirs
799 bool load_conf_file_from_dirs(const char *base_name, const char *const *directories, map_string_t *settings, bool skipKeysWithoutValue);
800 
801 enum {
802  CONF_DIR_FLAG_NONE = 0,
803  CONF_DIR_FLAG_OPTIONAL = 1,
804 };
805 
806 #define load_conf_file_from_dirs_ext libreport_load_conf_file_from_dirs_ext
807 bool load_conf_file_from_dirs_ext(const char *base_name, const char *const *directories,
808  const int * dir_flags, map_string_t *settings,
809  bool skipKeysWithoutValue);
810 
811 #define save_conf_file libreport_save_conf_file
812 bool save_conf_file(const char *path, map_string_t *settings);
813 #define save_plugin_conf_file libreport_save_plugin_conf_file
814 bool save_plugin_conf_file(const char *name, map_string_t *settings);
815 
816 #define save_app_conf_file libreport_save_app_conf_file
817 bool save_app_conf_file(const char* application_name, map_string_t *settings);
818 #define load_app_conf_file libreport_load_app_conf_file
819 bool load_app_conf_file(const char *application_name, map_string_t *settings);
820 #define set_app_user_setting libreport_set_app_user_setting
821 void set_app_user_setting(map_string_t *settings, const char *name, const char *value);
822 #define get_app_user_setting libreport_get_app_user_setting
823 const char *get_app_user_setting(map_string_t *settings, const char *name);
824 
825 #define save_user_settings libreport_save_user_settings
826 bool save_user_settings();
827 #define load_user_settings libreport_load_user_settings
828 bool load_user_settings(const char *application_name);
829 #define set_user_setting libreport_set_user_setting
830 void set_user_setting(const char *name, const char *value);
831 #define get_user_setting libreport_get_user_setting
832 const char *get_user_setting(const char *name);
833 
834 /* filename is expected to exist in CONF_DIR
835  * usually /etc/libreport
836  */
837 #define load_forbidden_words libreport_load_forbidden_words
838 GList *load_words_from_file(const char *filename);
839 #define get_file_list libreport_get_file_list
840 GList *get_file_list(const char *path, const char *ext);
841 #define free_file_list libreport_free_file_list
842 void free_file_list(GList *filelist);
843 #define new_file_obj libreport_new_file_obj
844 file_obj_t *new_file_obj(const char* fullpath, const char* filename);
845 #define free_file_obj libreport_free_file_obj
846 void free_file_obj(file_obj_t *f);
847 #define load_workflow_config_data libreport_load_workflow_config_data
848 GHashTable *load_workflow_config_data(const char* path);
849 #define parse_list libreport_parse_list
850 GList *parse_list(const char* list);
851 
852 /* Connect to abrtd over unix domain socket, issue DELETE command */
853 int delete_dump_dir_possibly_using_abrtd(const char *dump_dir_name);
854 
855 /* Tries to create a copy of dump_dir_name in base_dir, with same or similar basename.
856  * Returns NULL if copying failed. In this case, logs a message before returning. */
857 #define steal_directory libreport_steal_directory
858 struct dump_dir *steal_directory(const char *base_dir, const char *dump_dir_name);
859 
860 /* Tries to open dump_dir_name with writing access. If function needs to steal
861  * directory calls ask_continue(new base dir, dump dir) callback to ask user
862  * for permission. If ask_continue param is NULL the function thinks that an
863  * answer is positive and steals directory.
864  * Returns NULL if opening failed or if stealing was dismissed. In this case,
865  * logs a message before returning. */
866 #define open_directory_for_writing libreport_open_directory_for_writing
867 struct dump_dir *open_directory_for_writing(
868  const char *dump_dir_name,
869  bool (*ask_continue)(const char *, const char *));
870 
871 // Files bigger than this are never considered to be text.
872 //
873 // Started at 64k limit. But _some_ limit is necessary:
874 // fields declared "text" may end up in editing fields and such.
875 // We don't want to accidentally end up with 100meg text in a textbox!
876 // So, don't remove this. If you really need to, raise the limit.
877 //
878 // Bumped up to 200k: saw 124740 byte /proc/PID/smaps file
879 // Bumped up to 500k: saw 375252 byte anaconda traceback file
880 // Bumped up to 1M: bugzilla.redhat.com/show_bug.cgi?id=746727
881 // mentions 853646 byte anaconda-tb-* file.
882 // Bumped up to 8M: bugzilla.redhat.com/show_bug.cgi?id=887570
883 // (anaconda-tb file of 1.38 MBytes)
884 //
885 #define CD_MAX_TEXT_SIZE (8*1024*1024)
886 
887 // Text bigger than this usually is attached, not added inline
888 // was 2k, 20kb is too much, let's try 4kb
889 //
890 // For bug databases
891 #define CD_TEXT_ATT_SIZE_BZ (4*1024)
892 // For dumping problem data into a text file, email, etc
893 #define CD_TEXT_ATT_SIZE_LOGGER (CD_MAX_TEXT_SIZE)
894 
895 // Filenames in problem directory:
896 // filled by a hook:
897 #define FILENAME_TIME "time" /* mandatory */
898 #define FILENAME_LAST_OCCURRENCE "last_occurrence" /* optional */
899 #define FILENAME_REASON "reason" /* mandatory? */
900 #define FILENAME_UID "uid" /* mandatory? */
901 
902 /*
903  * "analyzer" is to be gradually changed to "type":
904  * For now, we fetch and look at "analyzer" element,
905  * but we always save both "analyzer" and "type" (with same contents).
906  * By 2013, we switch to looking at "type". Then we will stop generating
907  * "analyzer" element.
908  * ----
909  * Update 2015: based on the recent changes where we have introduced several
910  * tools generating one problem type, we have decided to retain 'analyzer'
911  * file, but it shall contain string identifier of a tool that created the
912  * problem.
913  */
914 #define FILENAME_ANALYZER "analyzer"
915 #define FILENAME_TYPE "type"
916 #define FILENAME_EXECUTABLE "executable"
917 #define FILENAME_PID "pid"
918 #define FILENAME_GLOBAL_PID "global_pid"
919 #define FILENAME_PWD "pwd"
920 #define FILENAME_ROOTDIR "rootdir"
921 #define FILENAME_BINARY "binary"
922 #define FILENAME_CMDLINE "cmdline"
923 #define FILENAME_COREDUMP "coredump"
924 #define FILENAME_CGROUP "cgroup"
925 #define FILENAME_BACKTRACE "backtrace"
926 #define FILENAME_MAPS "maps"
927 #define FILENAME_SMAPS "smaps"
928 #define FILENAME_PROC_PID_STATUS "proc_pid_status"
929 #define FILENAME_ENVIRON "environ"
930 #define FILENAME_LIMITS "limits"
931 #define FILENAME_OPEN_FDS "open_fds"
932 #define FILENAME_MOUNTINFO "mountinfo"
933 #define FILENAME_NAMESPACES "namespaces"
934 
935 /* Global problem identifier which is usually generated by some "analyze_*"
936  * event because it may take a lot of time to obtain strong problem
937  * identification */
938 #define FILENAME_DUPHASH "duphash"
939 
940 // Name of the function where the application crashed.
941 // Optional.
942 #define FILENAME_CRASH_FUNCTION "crash_function"
943 #define FILENAME_ARCHITECTURE "architecture"
944 #define FILENAME_KERNEL "kernel"
945 /*
946  * From /etc/os-release
947  * os_release filename name is alredy occupied by /etc/redhat-release (see
948  * below) in sake of backward compatibility /etc/os-release is stored in
949  * os_info file
950  */
951 #define FILENAME_OS_INFO "os_info"
952 #define FILENAME_OS_INFO_IN_ROOTDIR "os_info_in_rootdir"
953 // From /etc/system-release or /etc/redhat-release
954 #define FILENAME_OS_RELEASE "os_release"
955 #define FILENAME_OS_RELEASE_IN_ROOTDIR "os_release_in_rootdir"
956 // Filled by <what?>
957 #define FILENAME_PACKAGE "package"
958 #define FILENAME_COMPONENT "component"
959 #define FILENAME_COMMENT "comment"
960 #define FILENAME_RATING "backtrace_rating"
961 #define FILENAME_HOSTNAME "hostname"
962 // Optional. Set to "1" by abrt-handle-upload for every unpacked dump
963 #define FILENAME_REMOTE "remote"
964 #define FILENAME_TAINTED "kernel_tainted"
965 #define FILENAME_TAINTED_SHORT "kernel_tainted_short"
966 #define FILENAME_TAINTED_LONG "kernel_tainted_long"
967 #define FILENAME_VMCORE "vmcore"
968 #define FILENAME_KERNEL_LOG "kernel_log"
969 // File created by createAlertSignature() from libreport's python module
970 // The file should contain a description of an alert
971 #define FILENAME_DESCRIPTION "description"
972 
973 /* Local problem identifier (weaker than global identifier) designed for fast
974  * local for fast local duplicate identification. This file is usually provided
975  * by crashed application (problem creator).
976  */
977 #define FILENAME_UUID "uuid"
978 
979 #define FILENAME_COUNT "count"
980 /* Multi-line list of places problem was reported.
981  * Recommended line format:
982  * "Reporter: VAR=VAL VAR=VAL"
983  * Use add_reported_to(dd, "line_without_newline"): it adds line
984  * only if it is not already there.
985  */
986 #define FILENAME_REPORTED_TO "reported_to"
987 #define FILENAME_EVENT_LOG "event_log"
988 /*
989  * If exists, should contain a full sentence (with trailing period)
990  * which describes why this problem should not be reported.
991  * Example: "Your laptop firmware 1.9a is buggy, version 1.10 contains the fix."
992  */
993 #define FILENAME_NOT_REPORTABLE "not-reportable"
994 #define FILENAME_CORE_BACKTRACE "core_backtrace"
995 #define FILENAME_REMOTE_RESULT "remote_result"
996 #define FILENAME_PKG_EPOCH "pkg_epoch"
997 #define FILENAME_PKG_NAME "pkg_name"
998 #define FILENAME_PKG_VERSION "pkg_version"
999 #define FILENAME_PKG_RELEASE "pkg_release"
1000 #define FILENAME_PKG_ARCH "pkg_arch"
1001 #define FILENAME_USERNAME "username"
1002 #define FILENAME_ABRT_VERSION "abrt_version"
1003 #define FILENAME_EXPLOITABLE "exploitable"
1004 
1005 /* File names related to Anaconda problems
1006  */
1007 #define FILENAME_KICKSTART_CFG "ks.cfg"
1008 #define FILENAME_ANACONDA_TB "anaconda-tb"
1009 
1010 /* Containers
1011  */
1012 #define FILENAME_CONTAINER "container"
1013 #define FILENAME_CONTAINER_ID "container_id"
1014 #define FILENAME_CONTAINER_UUID "container_uuid"
1015 #define FILENAME_CONTAINER_IMAGE "container_image"
1016 #define FILENAME_CONTAINER_CMDLINE "container_cmdline"
1017 #define FILENAME_DOCKER_INSPECT "docker_inspect"
1018 
1019 // Not stored as files, added "on the fly":
1020 #define CD_DUMPDIR "Directory"
1021 
1022 #define cmp_problem_data libreport_cmp_problem_data
1023 gint cmp_problem_data(gconstpointer a, gconstpointer b, gpointer filename);
1024 
1025 //UNUSED:
1028 //#define CD_EVENTS "Events"
1029 
1030 /* FILENAME_EVENT_LOG is trimmed to below LOW_WATERMARK
1031  * when it reaches HIGH_WATERMARK size
1032  */
1033 enum {
1034  EVENT_LOG_HIGH_WATERMARK = 30 * 1024,
1035  EVENT_LOG_LOW_WATERMARK = 20 * 1024,
1036 };
1037 
1038 #define log_problem_data libreport_log_problem_data
1039 void log_problem_data(problem_data_t *problem_data, const char *pfx);
1040 
1041 extern int g_libreport_inited;
1042 void libreport_init(void);
1043 
1044 #define INITIALIZE_LIBREPORT() \
1045  do \
1046  { \
1047  if (!g_libreport_inited) \
1048  { \
1049  g_libreport_inited = 1; \
1050  libreport_init(); \
1051  } \
1052  } \
1053  while (0)
1054 
1055 const char *abrt_init(char **argv);
1056 #define export_abrt_envvars libreport_export_abrt_envvars
1057 void export_abrt_envvars(int pfx);
1058 #define g_progname libreport_g_progname
1059 extern const char *g_progname;
1060 
1061 enum parse_opt_type {
1062  OPTION_BOOL,
1063  OPTION_GROUP,
1064  OPTION_STRING,
1065  OPTION_INTEGER,
1066  OPTION_OPTSTRING,
1067  OPTION_LIST,
1068  OPTION_END,
1069 };
1070 
1071 struct options {
1072  enum parse_opt_type type;
1073  int short_name;
1074  const char *long_name;
1075  void *value;
1076  const char *argh;
1077  const char *help;
1078 };
1079 
1080 /*
1081  * s - short_name
1082  * l - long_name
1083  * v - value
1084  * a - option parameter name (for help text)
1085  * h - help
1086  */
1087 #define OPT_END() { OPTION_END }
1088 #define OPT_GROUP(h) { OPTION_GROUP, 0, NULL, NULL, NULL, (h) }
1089 #define OPT_BOOL( s, l, v, h) { OPTION_BOOL , (s), (l), (v), NULL , (h) }
1090 #define OPT_INTEGER( s, l, v, h) { OPTION_INTEGER , (s), (l), (v), "NUM", (h) }
1091 #define OPT_STRING( s, l, v, a, h) { OPTION_STRING , (s), (l), (v), (a) , (h) }
1092 #define OPT_OPTSTRING(s, l, v, a, h) { OPTION_OPTSTRING, (s), (l), (v), (a) , (h) }
1093 #define OPT_LIST( s, l, v, a, h) { OPTION_LIST , (s), (l), (v), (a) , (h) }
1094 
1095 #define OPT__VERBOSE(v) OPT_BOOL('v', "verbose", (v), _("Be verbose"))
1096 #define OPT__DUMP_DIR(v) OPT_STRING('d', "problem-dir", (v), "DIR", _("Problem directory"))
1097 
1098 #define parse_opts libreport_parse_opts
1099 unsigned parse_opts(int argc, char **argv, const struct options *opt,
1100  const char *usage);
1101 
1102 #define show_usage_and_die libreport_show_usage_and_die
1103 void show_usage_and_die(const char *usage, const struct options *opt) NORETURN;
1104 
1105 /* Can't include "abrt_curl.h", it's not a public API.
1106  * Resorting to just forward-declaring the struct we need.
1107  */
1108 struct abrt_post_state;
1109 
1110 #ifdef __cplusplus
1111 }
1112 #endif
1113 
1114 #endif